@bitblit/ratchet-misc 4.0.419-alpha → 4.0.421-alpha

package/lib/brevo/generated/apis/ContactsApi.d.ts

@@ -0,0 +1,271 @@
+import * as runtime from '../runtime.js';
+import type { AddContactToList, CreateAttribute, CreateContact, CreateDoiContact, CreateList, CreateModel, CreateUpdateContactModel, CreateUpdateFolder, CreatedProcessId, GetAttributes, GetContactCampaignStats, GetContacts, GetExtendedContactDetails, GetExtendedList, GetFolder, GetFolderLists, GetFolders, GetLists, GetSegments, PostContactInfo, RemoveContactFromList, RequestContactExport, RequestContactImport, UpdateAttribute, UpdateContact, UpdateList } from '../models/index.js';
+export interface AddContactToListRequest {
+    listId: number;
+    contactEmails: AddContactToList;
+}
+export interface CreateAttributeRequest {
+    attributeCategory: CreateAttributeAttributeCategoryEnum;
+    attributeName: string;
+    createAttribute: CreateAttribute;
+}
+export interface CreateContactRequest {
+    createContact: CreateContact;
+}
+export interface CreateDoiContactRequest {
+    createDoiContact: CreateDoiContact;
+}
+export interface CreateFolderRequest {
+    createFolder: CreateUpdateFolder;
+}
+export interface CreateListRequest {
+    createList: CreateList;
+}
+export interface DeleteAttributeRequest {
+    attributeCategory: DeleteAttributeAttributeCategoryEnum;
+    attributeName: string;
+}
+export interface DeleteContactRequest {
+    email: string;
+}
+export interface DeleteFolderRequest {
+    folderId: number;
+}
+export interface DeleteListRequest {
+    listId: number;
+}
+export interface GetContactInfoRequest {
+    email: string;
+}
+export interface GetContactStatsRequest {
+    email: string;
+    startDate?: Date;
+    endDate?: Date;
+}
+export interface GetContactsRequest {
+    limit?: number;
+    offset?: number;
+    modifiedSince?: Date;
+    createdSince?: Date;
+    sort?: GetContactsSortEnum;
+}
+export interface GetContactsFromListRequest {
+    listId: number;
+    modifiedSince?: Date;
+    limit?: number;
+    offset?: number;
+    sort?: GetContactsFromListSortEnum;
+}
+export interface GetFolderRequest {
+    folderId: number;
+}
+export interface GetFolderListsRequest {
+    folderId: number;
+    limit?: number;
+    offset?: number;
+    sort?: GetFolderListsSortEnum;
+}
+export interface GetFoldersRequest {
+    limit: number;
+    offset: number;
+    sort?: GetFoldersSortEnum;
+}
+export interface GetListRequest {
+    listId: number;
+}
+export interface GetListsRequest {
+    limit?: number;
+    offset?: number;
+    sort?: GetListsSortEnum;
+}
+export interface GetSegmentsRequest {
+    limit: number;
+    offset: number;
+    sort?: GetSegmentsSortEnum;
+}
+export interface ImportContactsRequest {
+    requestContactImport: RequestContactImport;
+}
+export interface RemoveContactFromListRequest {
+    listId: number;
+    contactEmails: RemoveContactFromList;
+}
+export interface RequestContactExportRequest {
+    requestContactExport: RequestContactExport;
+}
+export interface UpdateAttributeRequest {
+    attributeCategory: UpdateAttributeAttributeCategoryEnum;
+    attributeName: string;
+    updateAttribute: UpdateAttribute;
+}
+export interface UpdateContactRequest {
+    email: string;
+    updateContact: UpdateContact;
+}
+export interface UpdateFolderRequest {
+    folderId: number;
+    updateFolder: CreateUpdateFolder;
+}
+export interface UpdateListRequest {
+    listId: number;
+    updateList: UpdateList;
+}
+export interface ContactsApiInterface {
+    addContactToListRaw(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
+    addContactToList(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
+    createAttributeRaw(requestParameters: CreateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    createAttribute(requestParameters: CreateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUpdateContactModel>>;
+    createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUpdateContactModel>;
+    createDoiContactRaw(requestParameters: CreateDoiContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    createDoiContact(requestParameters: CreateDoiContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    createFolderRaw(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
+    createFolder(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
+    createListRaw(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
+    createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
+    deleteAttributeRaw(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteAttribute(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteListRaw(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    getAttributesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributes>>;
+    getAttributes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributes>;
+    getContactInfoRaw(requestParameters: GetContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExtendedContactDetails>>;
+    getContactInfo(requestParameters: GetContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedContactDetails>;
+    getContactStatsRaw(requestParameters: GetContactStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContactCampaignStats>>;
+    getContactStats(requestParameters: GetContactStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContactCampaignStats>;
+    getContactsRaw(requestParameters: GetContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
+    getContacts(requestParameters: GetContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
+    getContactsFromListRaw(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
+    getContactsFromList(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
+    getFolderRaw(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolder>>;
+    getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolder>;
+    getFolderListsRaw(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolderLists>>;
+    getFolderLists(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolderLists>;
+    getFoldersRaw(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolders>>;
+    getFolders(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolders>;
+    getListRaw(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExtendedList>>;
+    getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList>;
+    getListsRaw(requestParameters: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLists>>;
+    getLists(requestParameters: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists>;
+    getSegmentsRaw(requestParameters: GetSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSegments>>;
+    getSegments(requestParameters: GetSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSegments>;
+    importContactsRaw(requestParameters: ImportContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
+    importContacts(requestParameters: ImportContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
+    removeContactFromListRaw(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
+    removeContactFromList(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
+    requestContactExportRaw(requestParameters: RequestContactExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
+    requestContactExport(requestParameters: RequestContactExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
+    updateAttributeRaw(requestParameters: UpdateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateAttribute(requestParameters: UpdateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateContactRaw(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateFolderRaw(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateFolder(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateListRaw(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+export declare class ContactsApi extends runtime.BaseAPI implements ContactsApiInterface {
+    addContactToListRaw(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
+    addContactToList(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
+    createAttributeRaw(requestParameters: CreateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    createAttribute(requestParameters: CreateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateUpdateContactModel>>;
+    createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateUpdateContactModel>;
+    createDoiContactRaw(requestParameters: CreateDoiContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    createDoiContact(requestParameters: CreateDoiContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    createFolderRaw(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
+    createFolder(requestParameters: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
+    createListRaw(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
+    createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
+    deleteAttributeRaw(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteAttribute(requestParameters: DeleteAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteFolder(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    deleteListRaw(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    getAttributesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttributes>>;
+    getAttributes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttributes>;
+    getContactInfoRaw(requestParameters: GetContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExtendedContactDetails>>;
+    getContactInfo(requestParameters: GetContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedContactDetails>;
+    getContactStatsRaw(requestParameters: GetContactStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContactCampaignStats>>;
+    getContactStats(requestParameters: GetContactStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContactCampaignStats>;
+    getContactsRaw(requestParameters: GetContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
+    getContacts(requestParameters?: GetContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
+    getContactsFromListRaw(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
+    getContactsFromList(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
+    getFolderRaw(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolder>>;
+    getFolder(requestParameters: GetFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolder>;
+    getFolderListsRaw(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolderLists>>;
+    getFolderLists(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolderLists>;
+    getFoldersRaw(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolders>>;
+    getFolders(requestParameters: GetFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolders>;
+    getListRaw(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetExtendedList>>;
+    getList(requestParameters: GetListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetExtendedList>;
+    getListsRaw(requestParameters: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLists>>;
+    getLists(requestParameters?: GetListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLists>;
+    getSegmentsRaw(requestParameters: GetSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSegments>>;
+    getSegments(requestParameters: GetSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSegments>;
+    importContactsRaw(requestParameters: ImportContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
+    importContacts(requestParameters: ImportContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
+    removeContactFromListRaw(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
+    removeContactFromList(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
+    requestContactExportRaw(requestParameters: RequestContactExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
+    requestContactExport(requestParameters: RequestContactExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
+    updateAttributeRaw(requestParameters: UpdateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateAttribute(requestParameters: UpdateAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateContactRaw(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateContact(requestParameters: UpdateContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateFolderRaw(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateFolder(requestParameters: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    updateListRaw(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+export declare enum CreateAttributeAttributeCategoryEnum {
+    Normal = "normal",
+    Transactional = "transactional",
+    Category = "category",
+    Calculated = "calculated",
+    Global = "global"
+}
+export declare enum DeleteAttributeAttributeCategoryEnum {
+    Normal = "normal",
+    Transactional = "transactional",
+    Category = "category",
+    Calculated = "calculated",
+    Global = "global"
+}
+export declare enum GetContactsSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum GetContactsFromListSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum GetFolderListsSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum GetFoldersSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum GetListsSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum GetSegmentsSortEnum {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare enum UpdateAttributeAttributeCategoryEnum {
+    Category = "category",
+    Calculated = "calculated",
+    Global = "global"
+}