node-mailjet/declarations/types/api/Setting.d.ts

Mailjet API client

import { Common } from './Common';
export declare namespace APIKeyConfiguration {
    export enum RunLevel {
        Normal = "Normal",
        SoftLock = "Softlock",
        HardLock = "Hardlock"
    }
    export interface ApiKey {
        ID: number;
        ACL: string;
        IsActive: boolean;
        APIKey: string;
        CreatedAt: string;
        IsMaster: boolean;
        Name: string;
        QuarantineValue: number;
        Runlevel: RunLevel;
        SecretKey: string;
        TrackHost: string;
        UserID: number;
    }
    export type PostApiKeyBody = {
        Name: string;
        ACL?: string;
        IsActive?: boolean;
    };
    export type PutApiKeyBody = Partial<PostApiKeyBody>;
    export type GetApiKeyQueryParams = Partial<Common.Pagination> & {
        APIKey?: string;
        IsActive?: boolean;
        IsMaster?: boolean;
        Name?: string;
    };
    type ApiKeyResponse = Common.Response<ApiKey[]>;
    export type PostApiKeyResponse = ApiKeyResponse;
    export type PutApiKeyResponse = ApiKeyResponse;
    export type GetApiKeyResponse = ApiKeyResponse;
    export {};
}
export declare namespace AccountSetting {
    export interface MyProfile {
        ID: number;
        AddressCity: string;
        AddressCountry: string;
        AddressPostalCode: string;
        AddressState: string;
        AddressStreet: string;
        BillingEmail: string;
        BirthdayAt: string;
        CompanyName: string;
        CompanyNumOfEmployees: string;
        ContactPhone: string;
        EstimatedVolume: number;
        Features: string;
        Firstname: string;
        Industry: number;
        JobTitle: string;
        Lastname: string;
        VATNumber: string;
        Website: string;
        VAT: number;
        UserID: number;
    }
    export interface User {
        ID: number;
        ACL: string;
        Email: string;
        LastLoginAt: string;
        Locale: string;
        Timezone: string;
        CreatedAt: string;
        FirstIp: string;
        LastIp: string;
        MaxAllowedAPIKeys: number;
        Username: string;
        WarnedRatelimitAt: string;
    }
    export type PutMyProfileBody = Partial<Omit<MyProfile, 'ID' | 'VAT' | 'UserID'>>;
    export type PutUserBody = Partial<Omit<User, 'ID' | 'CreatedAt' | 'FirstIp' | 'MaxAllowedAPIKeys' | 'WarnedRatelimitAt'>>;
    type MyProfileResponse = Common.Response<MyProfile[]>;
    type UserResponse = Common.Response<User[]>;
    export type PutMyProfileResponse = MyProfileResponse;
    export type GetMyProfileResponse = MyProfileResponse;
    export type PutUserResponse = UserResponse;
    export type GetUserResponse = UserResponse;
    export {};
}