/** * 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 { AddAccountEmailAddress201Response } from '../models'; import { AddAccountEmailAddressRequest } from '../models'; import { GetAccountDetails200Response } from '../models'; import { GetAccountDetails200ResponsePhysicalAddress } from '../models'; import { GetAllAccountEmailAddresses200ResponseInner } from '../models'; import { GetUserPrivileges200ResponseInner } from '../models'; import { UpdateAccountRequest } from '../models'; /** * AccountServicesApi - axios parameter creator * @export */ export declare const AccountServicesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide. * @summary POST Add an Account Email Address * @param {AddAccountEmailAddressRequest} addAccountEmailAddressRequest A JSON request payload containing the new email address you want to add to the Constant Contact account. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAccountEmailAddress: (addAccountEmailAddressRequest: AddAccountEmailAddressRequest, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to add the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. * @summary POST the Physical Address for the Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPhysicalAddress: (getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig) => Promise; /** * Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html). * @summary GET a Summary of Account Details * @param {GetAccountDetailsExtraFieldsEnum} [extraFields] Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails: (extraFields?: GetAccountDetailsExtraFieldsEnum, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to get the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. * @summary GET the Physical Address for the Account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPhysicalAddress: (options?: RawAxiosRequestConfig) => Promise; /** * Use this method to return a collection of email addresses for the account associated with your access token. When you Create an Email Campaign, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time. * @summary GET a Collection of Account Email Addresses * @param {GetAllAccountEmailAddressesConfirmStatusEnum} [confirmStatus] Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`. * @param {GetAllAccountEmailAddressesRoleCodeEnum} [roleCode] Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`. * @param {string} [emailAddress] Use the `email_address` query parameter to search for a specific account email address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllAccountEmailAddresses: (confirmStatus?: GetAllAccountEmailAddressesConfirmStatusEnum, roleCode?: GetAllAccountEmailAddressesRoleCodeEnum, emailAddress?: string, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html). * @summary GET User Privileges * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivileges: (options?: RawAxiosRequestConfig) => Promise; /** * Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html). * @summary PUT (update) Account Details * @param {UpdateAccountRequest} updateAccountRequest In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccount: (updateAccountRequest: UpdateAccountRequest, options?: RawAxiosRequestConfig) => Promise; /** * Use this method to update the organization\'s physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details. * @summary PUT (update) the Physical Address for an Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccountPhysicalAddress: (getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig) => Promise; }; /** * AccountServicesApi - functional programming interface * @export */ export declare const AccountServicesApiFp: (configuration?: Configuration) => { /** * Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide. * @summary POST Add an Account Email Address * @param {AddAccountEmailAddressRequest} addAccountEmailAddressRequest A JSON request payload containing the new email address you want to add to the Constant Contact account. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAccountEmailAddress(addAccountEmailAddressRequest: AddAccountEmailAddressRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to add the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. * @summary POST the Physical Address for the Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html). * @summary GET a Summary of Account Details * @param {GetAccountDetailsExtraFieldsEnum} [extraFields] Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails(extraFields?: GetAccountDetailsExtraFieldsEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to get the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. * @summary GET the Physical Address for the Account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPhysicalAddress(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to return a collection of email addresses for the account associated with your access token. When you Create an Email Campaign, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time. * @summary GET a Collection of Account Email Addresses * @param {GetAllAccountEmailAddressesConfirmStatusEnum} [confirmStatus] Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`. * @param {GetAllAccountEmailAddressesRoleCodeEnum} [roleCode] Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`. * @param {string} [emailAddress] Use the `email_address` query parameter to search for a specific account email address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllAccountEmailAddresses(confirmStatus?: GetAllAccountEmailAddressesConfirmStatusEnum, roleCode?: GetAllAccountEmailAddressesRoleCodeEnum, emailAddress?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html). * @summary GET User Privileges * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivileges(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html). * @summary PUT (update) Account Details * @param {UpdateAccountRequest} updateAccountRequest In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccount(updateAccountRequest: UpdateAccountRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this method to update the organization\'s physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details. * @summary PUT (update) the Physical Address for an Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccountPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountServicesApi - factory interface * @export */ export declare const AccountServicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide. * @summary POST Add an Account Email Address * @param {AddAccountEmailAddressRequest} addAccountEmailAddressRequest A JSON request payload containing the new email address you want to add to the Constant Contact account. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAccountEmailAddress(addAccountEmailAddressRequest: AddAccountEmailAddressRequest, options?: any): AxiosPromise; /** * Use this method to add the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. * @summary POST the Physical Address for the Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: any): AxiosPromise; /** * Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html). * @summary GET a Summary of Account Details * @param {GetAccountDetailsExtraFieldsEnum} [extraFields] Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountDetails(extraFields?: GetAccountDetailsExtraFieldsEnum, options?: any): AxiosPromise; /** * Use this method to get the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. * @summary GET the Physical Address for the Account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccountPhysicalAddress(options?: any): AxiosPromise; /** * Use this method to return a collection of email addresses for the account associated with your access token. When you Create an Email Campaign, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time. * @summary GET a Collection of Account Email Addresses * @param {GetAllAccountEmailAddressesConfirmStatusEnum} [confirmStatus] Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`. * @param {GetAllAccountEmailAddressesRoleCodeEnum} [roleCode] Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`. * @param {string} [emailAddress] Use the `email_address` query parameter to search for a specific account email address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAllAccountEmailAddresses(confirmStatus?: GetAllAccountEmailAddressesConfirmStatusEnum, roleCode?: GetAllAccountEmailAddressesRoleCodeEnum, emailAddress?: string, options?: any): AxiosPromise>; /** * Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html). * @summary GET User Privileges * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivileges(options?: any): AxiosPromise>; /** * Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html). * @summary PUT (update) Account Details * @param {UpdateAccountRequest} updateAccountRequest In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccount(updateAccountRequest: UpdateAccountRequest, options?: any): AxiosPromise; /** * Use this method to update the organization\'s physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details. * @summary PUT (update) the Physical Address for an Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAccountPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: any): AxiosPromise; }; /** * AccountServicesApi - object-oriented interface * @export * @class AccountServicesApi * @extends {BaseAPI} */ export declare class AccountServicesApi extends BaseAPI { /** * Use this method to add a new email address to a Constant Contact account. If the email address you are adding already exists in the account the API will return a 409 conflict error. When you add a new email address to an account, Constant Contact automatically sends an email to that address with a link to confirm it. After a user clicks that link, the account email status changes from `UNCONFIRMED` to `CONFIRMED`. You can use confirmed account email addresses in the email campaign `from_email` and `reply_to_email` headers. For more use case information, see [Add an Account Email Address](/api_guide/account_post_emails.html) in the API guide. * @summary POST Add an Account Email Address * @param {AddAccountEmailAddressRequest} addAccountEmailAddressRequest A JSON request payload containing the new email address you want to add to the Constant Contact account. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ addAccountEmailAddress(addAccountEmailAddressRequest: AddAccountEmailAddressRequest, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to add the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. * @summary POST the Physical Address for the Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ addPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig): Promise>; /** * Get account related details for a Constant Contact user account. Use the `extra_fields` query parameter to include the `company_logo` and/or `physical_address` details in the response body. For more details, see [Get Account Summary Details](/api_guide/account_details_get.html). * @summary GET a Summary of Account Details * @param {GetAccountDetailsExtraFieldsEnum} [extraFields] Use the `extra_fields` query parameter to include the `physical_address` and/or `company_logo` details in the response body. Use a comma separated list to include both (physical_address, company logo). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ getAccountDetails(extraFields?: GetAccountDetailsExtraFieldsEnum, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to get the address where the account\'s organization physically resides. The physical address is required to send emails and displays on the footer of every email that is sent from the account. * @summary GET the Physical Address for the Account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ getAccountPhysicalAddress(options?: RawAxiosRequestConfig): Promise>; /** * Use this method to return a collection of email addresses for the account associated with your access token. When you Create an Email Campaign, you must use an account email address with a `CONFIRMED` status in the email campaign `from_email` and `reply_to_email` headers. Use the query parameters to filter results. You can filter using `confirm_status`, `role_code`, or `email_address`. For example, searching with `confirm_status=CONFIRMED` returns all confirmed email addresses in the account. This method only supports one query parameter at a time. * @summary GET a Collection of Account Email Addresses * @param {GetAllAccountEmailAddressesConfirmStatusEnum} [confirmStatus] Use the `confirm_status` query parameter to search for account emails using the email status. Possible values are `CONFIRMED` or `UNCONFIRMED`. You can also abbreviate the values of this query parameter and use `C` or `U`. * @param {GetAllAccountEmailAddressesRoleCodeEnum} [roleCode] Use the `role_code` query parameter to search for account emails that have a specific role. Each each email address in an account can have multiple roles or no role. Possible values are `CONTACT`, `BILLING`, `REPLY_TO`, `JOURNALING`, or `OTHER`. You can also abbreviate the value of this query parameter and use `C`,`B`,`R`,`J`, or `O`. * @param {string} [emailAddress] Use the `email_address` query parameter to search for a specific account email address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ getAllAccountEmailAddresses(confirmStatus?: GetAllAccountEmailAddressesConfirmStatusEnum, roleCode?: GetAllAccountEmailAddressesRoleCodeEnum, emailAddress?: string, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to return the user privileges associated with your access token as an array of objects. This method returns all user privileges, including privileges the V3 API does not currently use. Constant Contact requires specific user privileges to make requests using the V3 API. For more information, see the [User Privileges and Roles Overview](/api_guide/user_privileges.html). * @summary GET User Privileges * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ getUserPrivileges(options?: RawAxiosRequestConfig): Promise>; /** * Use this method to update account details for a Constant Contact account, such as the email address or phone number. This PUT method provides a partial update where only valid properties that you include in the request body are updated and excluded properties are not overwritten. For more details, see [Put (update) Account Summary Details](/api_guide/account_details_put.html). * @summary PUT (update) Account Details * @param {UpdateAccountRequest} updateAccountRequest In the request body, specify changes to account details by including and modifying all or select `CustomerPut` properties. Changes to read-only fields (`encoded_account_id`) are ignored. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ updateAccount(updateAccountRequest: UpdateAccountRequest, options?: RawAxiosRequestConfig): Promise>; /** * Use this method to update the organization\'s physical address for the Constant Contact user account. The physical address is required to send emails and displays on the footer of every email that is sent from the account. To get the current physical address, make a GET call to `/account/summary/physical_address`. The country (country_code) where the account organization resides determines whether you use the state_code to specify United States (US) and Canada (CA) addresses, or use the state_name to specify all other countries. For more details, see [Put (update) the Physical Address for the Account](/api_guide/account_address_put.html). You must have the role of Account Owner assigned to update account level details. * @summary PUT (update) the Physical Address for an Account * @param {GetAccountDetails200ResponsePhysicalAddress} getAccountDetails200ResponsePhysicalAddress Include all `AccountPhysicalAddress` properties required for the specified `country_code` and then update only those properties that you want to change. Excluding a non-read only field from the request body removes it from the physical address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountServicesApi */ updateAccountPhysicalAddress(getAccountDetails200ResponsePhysicalAddress: GetAccountDetails200ResponsePhysicalAddress, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetAccountDetailsExtraFieldsEnum: { readonly PhysicalAddress: "physical_address"; readonly CompanyLogo: "company_logo"; }; export type GetAccountDetailsExtraFieldsEnum = typeof GetAccountDetailsExtraFieldsEnum[keyof typeof GetAccountDetailsExtraFieldsEnum]; /** * @export */ export declare const GetAllAccountEmailAddressesConfirmStatusEnum: { readonly Confirmed: "CONFIRMED"; readonly C: "C"; readonly Unconfirmed: "UNCONFIRMED"; readonly U: "U"; }; export type GetAllAccountEmailAddressesConfirmStatusEnum = typeof GetAllAccountEmailAddressesConfirmStatusEnum[keyof typeof GetAllAccountEmailAddressesConfirmStatusEnum]; /** * @export */ export declare const GetAllAccountEmailAddressesRoleCodeEnum: { readonly Contact: "CONTACT"; readonly C: "C"; readonly Billing: "BILLING"; readonly B: "B"; readonly Journaling: "JOURNALING"; readonly J: "J"; readonly ReplyTo: "REPLY_TO"; readonly R: "R"; readonly Other: "OTHER"; readonly O: "O"; }; export type GetAllAccountEmailAddressesRoleCodeEnum = typeof GetAllAccountEmailAddressesRoleCodeEnum[keyof typeof GetAllAccountEmailAddressesRoleCodeEnum];