/** * Constant Contact API v3 * Swagger build version 3.0.2475 * * The version of the OpenAPI document: 1.0.116 * Contact: webservices@constantcontact.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { DeleteList202Response } from '../models'; import { GetAllLists200Response } from '../models'; import { GetList200Response } from '../models'; import { GetListIdXrefs200Response } from '../models'; import { UpdateList200Response } from '../models'; import { UpdateListRequest } from '../models'; /** * ContactListsApi - axios parameter creator * @export */ export declare const ContactListsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new contact list resource * @summary POST (create) a List * @param {UpdateListRequest} updateListRequest JSON payload defining the new contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ createList: (updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the `_links` property in the response. * @summary DELETE a List * @param {string} listId Unique ID of the list to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteList: (listId: string, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to return details about all contact lists for the account.

This method does not currently support filtering results using the contact list update date.

* @summary GET Lists Collection * @param {number} [limit] Use to specify the number of results displayed per page of output, from 1 - 500, default = 50. * @param {boolean} [includeCount] Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria. * @param {GetAllListsIncludeMembershipCountEnum} [includeMembershipCount] Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts. * @param {string} [name] Use to get details for a single list by entering the full name of the list. * @param {GetAllListsStatusEnum} [status] Use to get lists by status. Accepts comma-separated status values. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllLists: (limit?: number, includeCount?: boolean, includeMembershipCount?: GetAllListsIncludeMembershipCountEnum, name?: string, status?: GetAllListsStatusEnum, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to get details about a specific contact list (`list_id`). * @summary GET a List * @param {string} listId The system generated ID that uniquely identifies a contact list. * @param {GetListIncludeMembershipCountEnum} [includeMembershipCount] Returns the total number of contacts per list that meet your selection criteria. Set the `include_membership_count` to `active`, to count only active contacts, or `all` to include all contacts in the count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getList: (listId: string, includeMembershipCount?: GetListIncludeMembershipCountEnum, options?: RawAxiosRequestConfig) => Promise; /** *

Use this endpoint to migrate your locally stored V2 contact list data to the new V3 format. Developers are expected to use this endpoint sparingly. This endpoint is NOT intended for regular or repeated use. Constant Contact will eventually deprecate and remove this endpoint.

This GET call retrieves a collection of cross-referenced list sequence IDs (`id` used in the V2 API) and UUIDs (`list_id` used in the V3 API). This endpoint is intended for developers who have an existing V2 API integration, and are migrating their users to a new V3 API integration. The V2 and V3 APIs use different resource ID formats. Use the `sequence_ids` query parameter to specify a set of comma delimited V2 list ids to cross-reference. See [Migrating Apps and Data to V3](/api_guide/migration_overview.html) to learn more.\" * @summary GET a collection of V2 and V3 API List IDs * @param {string} sequenceIds Comma delimited list of V2 API list `ids` to cross-reference with the V3 API `list_id` value. Endpoint accepts a maximum of 500 ids at a time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListIdXrefs: (sequenceIds: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing contact list resource, specified by `list_id` * @summary PUT (update) a List * @param {string} listId Unique ID of the contact list to update * @param {UpdateListRequest} updateListRequest JSON payload containing updates to the specified contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateList: (listId: string, updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * ContactListsApi - functional programming interface * @export */ export declare const ContactListsApiFp: (configuration?: Configuration) => { /** * Create a new contact list resource * @summary POST (create) a List * @param {UpdateListRequest} updateListRequest JSON payload defining the new contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ createList(updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the `_links` property in the response. * @summary DELETE a List * @param {string} listId Unique ID of the list to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteList(listId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to return details about all contact lists for the account.

This method does not currently support filtering results using the contact list update date.

* @summary GET Lists Collection * @param {number} [limit] Use to specify the number of results displayed per page of output, from 1 - 500, default = 50. * @param {boolean} [includeCount] Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria. * @param {GetAllListsIncludeMembershipCountEnum} [includeMembershipCount] Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts. * @param {string} [name] Use to get details for a single list by entering the full name of the list. * @param {GetAllListsStatusEnum} [status] Use to get lists by status. Accepts comma-separated status values. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllLists(limit?: number, includeCount?: boolean, includeMembershipCount?: GetAllListsIncludeMembershipCountEnum, name?: string, status?: GetAllListsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to get details about a specific contact list (`list_id`). * @summary GET a List * @param {string} listId The system generated ID that uniquely identifies a contact list. * @param {GetListIncludeMembershipCountEnum} [includeMembershipCount] Returns the total number of contacts per list that meet your selection criteria. Set the `include_membership_count` to `active`, to count only active contacts, or `all` to include all contacts in the count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getList(listId: string, includeMembershipCount?: GetListIncludeMembershipCountEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** *

Use this endpoint to migrate your locally stored V2 contact list data to the new V3 format. Developers are expected to use this endpoint sparingly. This endpoint is NOT intended for regular or repeated use. Constant Contact will eventually deprecate and remove this endpoint.

This GET call retrieves a collection of cross-referenced list sequence IDs (`id` used in the V2 API) and UUIDs (`list_id` used in the V3 API). This endpoint is intended for developers who have an existing V2 API integration, and are migrating their users to a new V3 API integration. The V2 and V3 APIs use different resource ID formats. Use the `sequence_ids` query parameter to specify a set of comma delimited V2 list ids to cross-reference. See [Migrating Apps and Data to V3](/api_guide/migration_overview.html) to learn more.\" * @summary GET a collection of V2 and V3 API List IDs * @param {string} sequenceIds Comma delimited list of V2 API list `ids` to cross-reference with the V3 API `list_id` value. Endpoint accepts a maximum of 500 ids at a time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListIdXrefs(sequenceIds: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing contact list resource, specified by `list_id` * @summary PUT (update) a List * @param {string} listId Unique ID of the contact list to update * @param {UpdateListRequest} updateListRequest JSON payload containing updates to the specified contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateList(listId: string, updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactListsApi - factory interface * @export */ export declare const ContactListsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new contact list resource * @summary POST (create) a List * @param {UpdateListRequest} updateListRequest JSON payload defining the new contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ createList(updateListRequest: UpdateListRequest, options?: any): AxiosPromise; /** * Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the `_links` property in the response. * @summary DELETE a List * @param {string} listId Unique ID of the list to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteList(listId: string, options?: any): AxiosPromise; /** * Use this method to return details about all contact lists for the account.

This method does not currently support filtering results using the contact list update date.

* @summary GET Lists Collection * @param {number} [limit] Use to specify the number of results displayed per page of output, from 1 - 500, default = 50. * @param {boolean} [includeCount] Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria. * @param {GetAllListsIncludeMembershipCountEnum} [includeMembershipCount] Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts. * @param {string} [name] Use to get details for a single list by entering the full name of the list. * @param {GetAllListsStatusEnum} [status] Use to get lists by status. Accepts comma-separated status values. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllLists(limit?: number, includeCount?: boolean, includeMembershipCount?: GetAllListsIncludeMembershipCountEnum, name?: string, status?: GetAllListsStatusEnum, options?: any): AxiosPromise; /** * Use this method to get details about a specific contact list (`list_id`). * @summary GET a List * @param {string} listId The system generated ID that uniquely identifies a contact list. * @param {GetListIncludeMembershipCountEnum} [includeMembershipCount] Returns the total number of contacts per list that meet your selection criteria. Set the `include_membership_count` to `active`, to count only active contacts, or `all` to include all contacts in the count. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getList(listId: string, includeMembershipCount?: GetListIncludeMembershipCountEnum, options?: any): AxiosPromise; /** *

Use this endpoint to migrate your locally stored V2 contact list data to the new V3 format. Developers are expected to use this endpoint sparingly. This endpoint is NOT intended for regular or repeated use. Constant Contact will eventually deprecate and remove this endpoint.

This GET call retrieves a collection of cross-referenced list sequence IDs (`id` used in the V2 API) and UUIDs (`list_id` used in the V3 API). This endpoint is intended for developers who have an existing V2 API integration, and are migrating their users to a new V3 API integration. The V2 and V3 APIs use different resource ID formats. Use the `sequence_ids` query parameter to specify a set of comma delimited V2 list ids to cross-reference. See [Migrating Apps and Data to V3](/api_guide/migration_overview.html) to learn more.\" * @summary GET a collection of V2 and V3 API List IDs * @param {string} sequenceIds Comma delimited list of V2 API list `ids` to cross-reference with the V3 API `list_id` value. Endpoint accepts a maximum of 500 ids at a time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListIdXrefs(sequenceIds: string, options?: any): AxiosPromise; /** * Updates an existing contact list resource, specified by `list_id` * @summary PUT (update) a List * @param {string} listId Unique ID of the contact list to update * @param {UpdateListRequest} updateListRequest JSON payload containing updates to the specified contact list * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateList(listId: string, updateListRequest: UpdateListRequest, options?: any): AxiosPromise; }; /** * ContactListsApi - object-oriented interface * @export * @class ContactListsApi * @extends {BaseAPI} */ export declare class ContactListsApi extends BaseAPI { /** * Create a new contact list resource * @summary POST (create) a List * @param {UpdateListRequest} updateListRequest JSON payload defining the new contact list * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ createList(updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the `_links` property in the response. * @summary DELETE a List * @param {string} listId Unique ID of the list to delete * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ deleteList(listId: string, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to return details about all contact lists for the account.

This method does not currently support filtering results using the contact list update date.

* @summary GET Lists Collection * @param {number} [limit] Use to specify the number of results displayed per page of output, from 1 - 500, default = 50. * @param {boolean} [includeCount] Set `include_count` to `true` to return the total number of contact lists that meet your selection criteria. * @param {GetAllListsIncludeMembershipCountEnum} [includeMembershipCount] Use to include the total number of contacts per list. Set to `active`, to count only active (mailable) contacts, or `all` to count all contacts. * @param {string} [name] Use to get details for a single list by entering the full name of the list. * @param {GetAllListsStatusEnum} [status] Use to get lists by status. Accepts comma-separated status values. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ getAllLists(limit?: number, includeCount?: boolean, includeMembershipCount?: GetAllListsIncludeMembershipCountEnum, name?: string, status?: GetAllListsStatusEnum, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to get details about a specific contact list (`list_id`). * @summary GET a List * @param {string} listId The system generated ID that uniquely identifies a contact list. * @param {GetListIncludeMembershipCountEnum} [includeMembershipCount] Returns the total number of contacts per list that meet your selection criteria. Set the `include_membership_count` to `active`, to count only active contacts, or `all` to include all contacts in the count. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ getList(listId: string, includeMembershipCount?: GetListIncludeMembershipCountEnum, options?: RawAxiosRequestConfig): Promise>; /** *

Use this endpoint to migrate your locally stored V2 contact list data to the new V3 format. Developers are expected to use this endpoint sparingly. This endpoint is NOT intended for regular or repeated use. Constant Contact will eventually deprecate and remove this endpoint.

This GET call retrieves a collection of cross-referenced list sequence IDs (`id` used in the V2 API) and UUIDs (`list_id` used in the V3 API). This endpoint is intended for developers who have an existing V2 API integration, and are migrating their users to a new V3 API integration. The V2 and V3 APIs use different resource ID formats. Use the `sequence_ids` query parameter to specify a set of comma delimited V2 list ids to cross-reference. See [Migrating Apps and Data to V3](/api_guide/migration_overview.html) to learn more.\" * @summary GET a collection of V2 and V3 API List IDs * @param {string} sequenceIds Comma delimited list of V2 API list `ids` to cross-reference with the V3 API `list_id` value. Endpoint accepts a maximum of 500 ids at a time. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ getListIdXrefs(sequenceIds: string, options?: RawAxiosRequestConfig): Promise>; /** * Updates an existing contact list resource, specified by `list_id` * @summary PUT (update) a List * @param {string} listId Unique ID of the contact list to update * @param {UpdateListRequest} updateListRequest JSON payload containing updates to the specified contact list * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactListsApi */ updateList(listId: string, updateListRequest: UpdateListRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetAllListsIncludeMembershipCountEnum: { readonly All: "all"; readonly Active: "active"; }; export type GetAllListsIncludeMembershipCountEnum = typeof GetAllListsIncludeMembershipCountEnum[keyof typeof GetAllListsIncludeMembershipCountEnum]; /** * @export */ export declare const GetAllListsStatusEnum: { readonly All: "all"; readonly Active: "active"; readonly Deleted: "deleted"; }; export type GetAllListsStatusEnum = typeof GetAllListsStatusEnum[keyof typeof GetAllListsStatusEnum]; /** * @export */ export declare const GetListIncludeMembershipCountEnum: { readonly All: "all"; readonly Active: "active"; }; export type GetListIncludeMembershipCountEnum = typeof GetListIncludeMembershipCountEnum[keyof typeof GetListIncludeMembershipCountEnum];