/** * 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 { DeleteTag202Response } from '../models'; import { GetAllTags200Response } from '../models'; import { GetTag200Response } from '../models'; import { PostTagRequest } from '../models'; import { PutTagRequest } from '../models'; /** * ContactTagsApi - axios parameter creator * @export */ export declare const ContactTagsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Use this method to create an activity used to un-assign a tag from all assigned contacts and delete the tag. This is an asynchronous activity. To view activity details for the delete request, use the href link returned in the response. [Learn more](/api_guide/tags_delete.html). * @summary DELETE a Tag * @param {string} tagId The ID that uniquely identifies a tag in UUID format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTag: (tagId: string, options?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to get details for all tags in your account. Use the include_count query parameter to include the total number of contacts assigned each tag. Use the limit query parameter to limit the number of tag results returned per page. To get the next page of results, copy the cursor={the cursor ID} from the resulting href link and add it (&) to the URL. For example:

/v3/contact_tags?limit=1&cursor=

bGltaXQ9MSZuZXh0PTJjZDgwMjdhLTc4YzAtMTFlOS1iZmQwLWZhMTYzZTZiMDFjMQ=

To learn more, see [Get Tags](/api_guide/tags_get.html). * @summary GET Details for All Tags * @param {number} [limit] Use to specify the number of tag results (up to `500`) to display per page of output. The default is `50`. * @param {boolean} [includeCount] Returns the total number of contacts (`contacts_count`) to which a tag applies. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllTags: (limit?: number, includeCount?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to get tag details for a specified `tag_id`. Use the `include_count` query parameter to include or exclude the total number of contacts to which this tag is assigned. To learn more, see [Get a Tag\'s Details](/api_guide/tags_get_single.html). * @summary GET Tag Details * @param {string} tagId The ID that uniquely identifies a tag (UUID format). * @param {boolean} [includeCount] Use to include (`true`) or exclude (`false`) the total number of tagged contacts (`contacts_count`) from the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag: (tagId: string, includeCount?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to create a new tag. The tag `name` is required and must be unique and can include most common keyboard symbols. Optionally, when creating a new tag you can specify the source (`tag_source`) used to identify the contacts to tag in the request body. [Learn more](/api_guide/tags_create.html). * @summary POST (Create) a Tag * @param {PostTagRequest} postTagRequest The JSON payload to use to create a new tag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTag: (postTagRequest: PostTagRequest, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to rename an existing tag to a new unique tag name (`name`). The maximum length is 255 characters. The `tag_source` value cannot be updated using this method. You can set the `tag_source` value using the `POST contact_tags method`. [Learn more](/api_guide/tags_update.html) * @summary PUT (Update) a Tag * @param {string} tagId The system generated ID used to uniquely identify the tag that you want to rename (UUID format). * @param {PutTagRequest} putTagRequest The JSON payload used to update the tag name (`name`). * @param {*} [options] Override http request option. * @throws {RequiredError} */ putTag: (tagId: string, putTagRequest: PutTagRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * ContactTagsApi - functional programming interface * @export */ export declare const ContactTagsApiFp: (configuration?: Configuration) => { /** * Use this method to create an activity used to un-assign a tag from all assigned contacts and delete the tag. This is an asynchronous activity. To view activity details for the delete request, use the href link returned in the response. [Learn more](/api_guide/tags_delete.html). * @summary DELETE a Tag * @param {string} tagId The ID that uniquely identifies a tag in UUID format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTag(tagId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to get details for all tags in your account. Use the include_count query parameter to include the total number of contacts assigned each tag. Use the limit query parameter to limit the number of tag results returned per page. To get the next page of results, copy the cursor={the cursor ID} from the resulting href link and add it (&) to the URL. For example:

/v3/contact_tags?limit=1&cursor=

bGltaXQ9MSZuZXh0PTJjZDgwMjdhLTc4YzAtMTFlOS1iZmQwLWZhMTYzZTZiMDFjMQ=

To learn more, see [Get Tags](/api_guide/tags_get.html). * @summary GET Details for All Tags * @param {number} [limit] Use to specify the number of tag results (up to `500`) to display per page of output. The default is `50`. * @param {boolean} [includeCount] Returns the total number of contacts (`contacts_count`) to which a tag applies. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllTags(limit?: number, includeCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to get tag details for a specified `tag_id`. Use the `include_count` query parameter to include or exclude the total number of contacts to which this tag is assigned. To learn more, see [Get a Tag\'s Details](/api_guide/tags_get_single.html). * @summary GET Tag Details * @param {string} tagId The ID that uniquely identifies a tag (UUID format). * @param {boolean} [includeCount] Use to include (`true`) or exclude (`false`) the total number of tagged contacts (`contacts_count`) from the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag(tagId: string, includeCount?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to create a new tag. The tag `name` is required and must be unique and can include most common keyboard symbols. Optionally, when creating a new tag you can specify the source (`tag_source`) used to identify the contacts to tag in the request body. [Learn more](/api_guide/tags_create.html). * @summary POST (Create) a Tag * @param {PostTagRequest} postTagRequest The JSON payload to use to create a new tag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTag(postTagRequest: PostTagRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to rename an existing tag to a new unique tag name (`name`). The maximum length is 255 characters. The `tag_source` value cannot be updated using this method. You can set the `tag_source` value using the `POST contact_tags method`. [Learn more](/api_guide/tags_update.html) * @summary PUT (Update) a Tag * @param {string} tagId The system generated ID used to uniquely identify the tag that you want to rename (UUID format). * @param {PutTagRequest} putTagRequest The JSON payload used to update the tag name (`name`). * @param {*} [options] Override http request option. * @throws {RequiredError} */ putTag(tagId: string, putTagRequest: PutTagRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactTagsApi - factory interface * @export */ export declare const ContactTagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Use this method to create an activity used to un-assign a tag from all assigned contacts and delete the tag. This is an asynchronous activity. To view activity details for the delete request, use the href link returned in the response. [Learn more](/api_guide/tags_delete.html). * @summary DELETE a Tag * @param {string} tagId The ID that uniquely identifies a tag in UUID format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTag(tagId: string, options?: any): AxiosPromise; /** * Use this endpoint to get details for all tags in your account. Use the include_count query parameter to include the total number of contacts assigned each tag. Use the limit query parameter to limit the number of tag results returned per page. To get the next page of results, copy the cursor={the cursor ID} from the resulting href link and add it (&) to the URL. For example:

/v3/contact_tags?limit=1&cursor=

bGltaXQ9MSZuZXh0PTJjZDgwMjdhLTc4YzAtMTFlOS1iZmQwLWZhMTYzZTZiMDFjMQ=

To learn more, see [Get Tags](/api_guide/tags_get.html). * @summary GET Details for All Tags * @param {number} [limit] Use to specify the number of tag results (up to `500`) to display per page of output. The default is `50`. * @param {boolean} [includeCount] Returns the total number of contacts (`contacts_count`) to which a tag applies. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllTags(limit?: number, includeCount?: boolean, options?: any): AxiosPromise; /** * Use this method to get tag details for a specified `tag_id`. Use the `include_count` query parameter to include or exclude the total number of contacts to which this tag is assigned. To learn more, see [Get a Tag\'s Details](/api_guide/tags_get_single.html). * @summary GET Tag Details * @param {string} tagId The ID that uniquely identifies a tag (UUID format). * @param {boolean} [includeCount] Use to include (`true`) or exclude (`false`) the total number of tagged contacts (`contacts_count`) from the results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag(tagId: string, includeCount?: boolean, options?: any): AxiosPromise; /** * Use this method to create a new tag. The tag `name` is required and must be unique and can include most common keyboard symbols. Optionally, when creating a new tag you can specify the source (`tag_source`) used to identify the contacts to tag in the request body. [Learn more](/api_guide/tags_create.html). * @summary POST (Create) a Tag * @param {PostTagRequest} postTagRequest The JSON payload to use to create a new tag. * @param {*} [options] Override http request option. * @throws {RequiredError} */ postTag(postTagRequest: PostTagRequest, options?: any): AxiosPromise; /** * Use this method to rename an existing tag to a new unique tag name (`name`). The maximum length is 255 characters. The `tag_source` value cannot be updated using this method. You can set the `tag_source` value using the `POST contact_tags method`. [Learn more](/api_guide/tags_update.html) * @summary PUT (Update) a Tag * @param {string} tagId The system generated ID used to uniquely identify the tag that you want to rename (UUID format). * @param {PutTagRequest} putTagRequest The JSON payload used to update the tag name (`name`). * @param {*} [options] Override http request option. * @throws {RequiredError} */ putTag(tagId: string, putTagRequest: PutTagRequest, options?: any): AxiosPromise; }; /** * ContactTagsApi - object-oriented interface * @export * @class ContactTagsApi * @extends {BaseAPI} */ export declare class ContactTagsApi extends BaseAPI { /** * Use this method to create an activity used to un-assign a tag from all assigned contacts and delete the tag. This is an asynchronous activity. To view activity details for the delete request, use the href link returned in the response. [Learn more](/api_guide/tags_delete.html). * @summary DELETE a Tag * @param {string} tagId The ID that uniquely identifies a tag in UUID format. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactTagsApi */ deleteTag(tagId: string, options?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to get details for all tags in your account. Use the include_count query parameter to include the total number of contacts assigned each tag. Use the limit query parameter to limit the number of tag results returned per page. To get the next page of results, copy the cursor={the cursor ID} from the resulting href link and add it (&) to the URL. For example:

/v3/contact_tags?limit=1&cursor=

bGltaXQ9MSZuZXh0PTJjZDgwMjdhLTc4YzAtMTFlOS1iZmQwLWZhMTYzZTZiMDFjMQ=

To learn more, see [Get Tags](/api_guide/tags_get.html). * @summary GET Details for All Tags * @param {number} [limit] Use to specify the number of tag results (up to `500`) to display per page of output. The default is `50`. * @param {boolean} [includeCount] Returns the total number of contacts (`contacts_count`) to which a tag applies. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactTagsApi */ getAllTags(limit?: number, includeCount?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to get tag details for a specified `tag_id`. Use the `include_count` query parameter to include or exclude the total number of contacts to which this tag is assigned. To learn more, see [Get a Tag\'s Details](/api_guide/tags_get_single.html). * @summary GET Tag Details * @param {string} tagId The ID that uniquely identifies a tag (UUID format). * @param {boolean} [includeCount] Use to include (`true`) or exclude (`false`) the total number of tagged contacts (`contacts_count`) from the results. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactTagsApi */ getTag(tagId: string, includeCount?: boolean, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to create a new tag. The tag `name` is required and must be unique and can include most common keyboard symbols. Optionally, when creating a new tag you can specify the source (`tag_source`) used to identify the contacts to tag in the request body. [Learn more](/api_guide/tags_create.html). * @summary POST (Create) a Tag * @param {PostTagRequest} postTagRequest The JSON payload to use to create a new tag. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactTagsApi */ postTag(postTagRequest: PostTagRequest, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to rename an existing tag to a new unique tag name (`name`). The maximum length is 255 characters. The `tag_source` value cannot be updated using this method. You can set the `tag_source` value using the `POST contact_tags method`. [Learn more](/api_guide/tags_update.html) * @summary PUT (Update) a Tag * @param {string} tagId The system generated ID used to uniquely identify the tag that you want to rename (UUID format). * @param {PutTagRequest} putTagRequest The JSON payload used to update the tag name (`name`). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactTagsApi */ putTag(tagId: string, putTagRequest: PutTagRequest, options?: RawAxiosRequestConfig): Promise>; }