@bitblit/ratchet-misc/lib/brevo/generated/apis/ListsApi.d.ts

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import type { AddContactToList, CreateList, CreateModel, GetContacts, GetExtendedList, GetFolderLists, GetLists, PostContactInfo, RemoveContactFromList, UpdateList } from '../models/index.js';
export interface AddContactToListRequest {
    listId: number;
    contactEmails: AddContactToList;
}
export interface CreateListRequest {
    createList: CreateList;
}
export interface DeleteListRequest {
    listId: number;
}
export interface GetContactsFromListRequest {
    listId: number;
    modifiedSince?: Date;
    limit?: number;
    offset?: number;
    sort?: GetContactsFromListSortEnum;
}
export interface GetFolderListsRequest {
    folderId: number;
    limit?: number;
    offset?: number;
    sort?: GetFolderListsSortEnum;
}
export interface GetListRequest {
    listId: number;
}
export interface GetListsRequest {
    limit?: number;
    offset?: number;
    sort?: GetListsSortEnum;
}
export interface RemoveContactFromListRequest {
    listId: number;
    contactEmails: RemoveContactFromList;
}
export interface UpdateListRequest {
    listId: number;
    updateList: UpdateList;
}
export interface ListsApiInterface {
    addContactToListRaw(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
    addContactToList(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
    createListRaw(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteListRaw(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getContactsFromListRaw(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
    getContactsFromList(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
    getFolderListsRaw(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolderLists>>;
    getFolderLists(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolderLists>;
    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>;
    removeContactFromListRaw(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
    removeContactFromList(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
    updateListRaw(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare class ListsApi extends runtime.BaseAPI implements ListsApiInterface {
    addContactToListRaw(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
    addContactToList(requestParameters: AddContactToListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
    createListRaw(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createList(requestParameters: CreateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteListRaw(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteList(requestParameters: DeleteListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getContactsFromListRaw(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContacts>>;
    getContactsFromList(requestParameters: GetContactsFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContacts>;
    getFolderListsRaw(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetFolderLists>>;
    getFolderLists(requestParameters: GetFolderListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetFolderLists>;
    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>;
    removeContactFromListRaw(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContactInfo>>;
    removeContactFromList(requestParameters: RemoveContactFromListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContactInfo>;
    updateListRaw(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateList(requestParameters: UpdateListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare enum GetContactsFromListSortEnum {
    Asc = "asc",
    Desc = "desc"
}
export declare enum GetFolderListsSortEnum {
    Asc = "asc",
    Desc = "desc"
}
export declare enum GetListsSortEnum {
    Asc = "asc",
    Desc = "desc"
}