/** * 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 { GetAllCustomFields200Response } from '../models'; import { GetCustomField200Response } from '../models'; import { UpdateCustomFieldRequest } from '../models'; /** * ContactsCustomFieldsApi - axios parameter creator * @export */ export declare const ContactsCustomFieldsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This POST request adds a new `custom_field` to the user\'s account. A user can configure up to 100 `custom_fields` in their account. * @summary POST (create) a custom_field * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload required to create a new `custom_field` * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomFields: (updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig) => Promise; /** * This DELETE request deletes a custom_field from the user\'s account * @summary DELETE a custom_field * @param {string} customFieldId Unique ID of the custom_field on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField: (customFieldId: string, options?: RawAxiosRequestConfig) => Promise; /** * This GET request returns all `custom_fields` defined in the user\'s account.

This method does not currently support filtering results using the custom field update date.

* @summary GET custom_fields Collection * @param {number} [limit] Specifies the number of results displayed per page of output, from 1 - 100, default = 50. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllCustomFields: (limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * This GET call retrieves a `custom_field` resource, specified by `custom_field_id`. * @summary GET a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField: (customFieldId: string, options?: RawAxiosRequestConfig) => Promise; /** * This PUT request updates an existing `custom_field` object. * @summary PUT (update) a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCustomField: (customFieldId: string, updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * ContactsCustomFieldsApi - functional programming interface * @export */ export declare const ContactsCustomFieldsApiFp: (configuration?: Configuration) => { /** * This POST request adds a new `custom_field` to the user\'s account. A user can configure up to 100 `custom_fields` in their account. * @summary POST (create) a custom_field * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload required to create a new `custom_field` * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomFields(updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This DELETE request deletes a custom_field from the user\'s account * @summary DELETE a custom_field * @param {string} customFieldId Unique ID of the custom_field on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField(customFieldId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This GET request returns all `custom_fields` defined in the user\'s account.

This method does not currently support filtering results using the custom field update date.

* @summary GET custom_fields Collection * @param {number} [limit] Specifies the number of results displayed per page of output, from 1 - 100, default = 50. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllCustomFields(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This GET call retrieves a `custom_field` resource, specified by `custom_field_id`. * @summary GET a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField(customFieldId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This PUT request updates an existing `custom_field` object. * @summary PUT (update) a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCustomField(customFieldId: string, updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ContactsCustomFieldsApi - factory interface * @export */ export declare const ContactsCustomFieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This POST request adds a new `custom_field` to the user\'s account. A user can configure up to 100 `custom_fields` in their account. * @summary POST (create) a custom_field * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload required to create a new `custom_field` * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCustomFields(updateCustomFieldRequest: UpdateCustomFieldRequest, options?: any): AxiosPromise; /** * This DELETE request deletes a custom_field from the user\'s account * @summary DELETE a custom_field * @param {string} customFieldId Unique ID of the custom_field on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCustomField(customFieldId: string, options?: any): AxiosPromise; /** * This GET request returns all `custom_fields` defined in the user\'s account.

This method does not currently support filtering results using the custom field update date.

* @summary GET custom_fields Collection * @param {number} [limit] Specifies the number of results displayed per page of output, from 1 - 100, default = 50. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllCustomFields(limit?: number, options?: any): AxiosPromise; /** * This GET call retrieves a `custom_field` resource, specified by `custom_field_id`. * @summary GET a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomField(customFieldId: string, options?: any): AxiosPromise; /** * This PUT request updates an existing `custom_field` object. * @summary PUT (update) a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCustomField(customFieldId: string, updateCustomFieldRequest: UpdateCustomFieldRequest, options?: any): AxiosPromise; }; /** * ContactsCustomFieldsApi - object-oriented interface * @export * @class ContactsCustomFieldsApi * @extends {BaseAPI} */ export declare class ContactsCustomFieldsApi extends BaseAPI { /** * This POST request adds a new `custom_field` to the user\'s account. A user can configure up to 100 `custom_fields` in their account. * @summary POST (create) a custom_field * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload required to create a new `custom_field` * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsCustomFieldsApi */ createCustomFields(updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig): Promise>; /** * This DELETE request deletes a custom_field from the user\'s account * @summary DELETE a custom_field * @param {string} customFieldId Unique ID of the custom_field on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsCustomFieldsApi */ deleteCustomField(customFieldId: string, options?: RawAxiosRequestConfig): Promise>; /** * This GET request returns all `custom_fields` defined in the user\'s account.

This method does not currently support filtering results using the custom field update date.

* @summary GET custom_fields Collection * @param {number} [limit] Specifies the number of results displayed per page of output, from 1 - 100, default = 50. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsCustomFieldsApi */ getAllCustomFields(limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * This GET call retrieves a `custom_field` resource, specified by `custom_field_id`. * @summary GET a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsCustomFieldsApi */ getCustomField(customFieldId: string, options?: RawAxiosRequestConfig): Promise>; /** * This PUT request updates an existing `custom_field` object. * @summary PUT (update) a custom_field * @param {string} customFieldId Unique ID of the `custom_field` on which to operate. * @param {UpdateCustomFieldRequest} updateCustomFieldRequest The JSON payload used to update an existing custom field. Any properties omitted in the PUT request are overwritten with a null value. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ContactsCustomFieldsApi */ updateCustomField(customFieldId: string, updateCustomFieldRequest: UpdateCustomFieldRequest, options?: RawAxiosRequestConfig): Promise>; }