/**
* Elastic Email REST API
* This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach. Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used. The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request. To start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description. Downloadable library clients can be found in our Github repository here
*
* The version of the OpenAPI document: 4.0.0
* Contact: support@elasticemail.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 { type RequestArgs, BaseAPI } from '../base';
import type { Campaign } from '../ee-api-models';
/**
* CampaignsApi - axios parameter creator
* @export
*/
export declare const CampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
* @summary Trigger Automation for Contact
* @param {string} name
* @param {string} contactEmail
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsAutomationByNameTriggerPost: (name: string, contactEmail: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
* @summary Delete Campaign
* @param {string} name Name of Campaign to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameDelete: (name: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns the specified campaign details. Required Access Level: ViewCampaigns
* @summary Load Campaign
* @param {string} name Name of Campaign to get
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameGet: (name: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
* @summary Pause Campaign
* @param {string} name Name of Campaign to pause
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePausePut: (name: string, options?: RawAxiosRequestConfig) => Promise;
/**
* Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
* @summary Update Campaign
* @param {string} name Name of Campaign to update
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePut: (name: string, campaign: Campaign, options?: RawAxiosRequestConfig) => Promise;
/**
* Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
* @summary Load Campaigns
* @param {string} [search] Text fragment used for searching in Campaign name (using the \'contains\' rule)
* @param {number} [offset] How many items should be returned ahead.
* @param {number} [limit] Maximum number of returned items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsGet: (search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise;
/**
* Add a campaign for processing. Required Access Level: ModifyCampaigns
* @summary Add Campaign
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsPost: (campaign: Campaign, options?: RawAxiosRequestConfig) => Promise;
};
/**
* CampaignsApi - functional programming interface
* @export
*/
export declare const CampaignsApiFp: (configuration?: Configuration) => {
/**
* Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
* @summary Trigger Automation for Contact
* @param {string} name
* @param {string} contactEmail
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
* @summary Delete Campaign
* @param {string} name Name of Campaign to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns the specified campaign details. Required Access Level: ViewCampaigns
* @summary Load Campaign
* @param {string} name Name of Campaign to get
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
* @summary Pause Campaign
* @param {string} name Name of Campaign to pause
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
* @summary Update Campaign
* @param {string} name Name of Campaign to update
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
/**
* Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
* @summary Load Campaigns
* @param {string} [search] Text fragment used for searching in Campaign name (using the \'contains\' rule)
* @param {number} [offset] How many items should be returned ahead.
* @param {number} [limit] Maximum number of returned items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>;
/**
* Add a campaign for processing. Required Access Level: ModifyCampaigns
* @summary Add Campaign
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>;
};
/**
* CampaignsApi - factory interface
* @export
*/
export declare const CampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
* @summary Trigger Automation for Contact
* @param {string} name
* @param {string} contactEmail
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
* @summary Delete Campaign
* @param {string} name Name of Campaign to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns the specified campaign details. Required Access Level: ViewCampaigns
* @summary Load Campaign
* @param {string} name Name of Campaign to get
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
* @summary Pause Campaign
* @param {string} name Name of Campaign to pause
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
* @summary Update Campaign
* @param {string} name Name of Campaign to update
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
* @summary Load Campaigns
* @param {string} [search] Text fragment used for searching in Campaign name (using the \'contains\' rule)
* @param {number} [offset] How many items should be returned ahead.
* @param {number} [limit] Maximum number of returned items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a campaign for processing. Required Access Level: ModifyCampaigns
* @summary Add Campaign
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig): AxiosPromise;
};
/**
* CampaignsApi - interface
* @export
* @interface CampaignsApi
*/
export interface CampaignsApiInterface {
/**
* Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
* @summary Trigger Automation for Contact
* @param {string} name
* @param {string} contactEmail
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
* @summary Delete Campaign
* @param {string} name Name of Campaign to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns the specified campaign details. Required Access Level: ViewCampaigns
* @summary Load Campaign
* @param {string} name Name of Campaign to get
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsByNameGet(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
* @summary Pause Campaign
* @param {string} name Name of Campaign to pause
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
* @summary Update Campaign
* @param {string} name Name of Campaign to update
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig): AxiosPromise;
/**
* Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
* @summary Load Campaigns
* @param {string} [search] Text fragment used for searching in Campaign name (using the \'contains\' rule)
* @param {number} [offset] How many items should be returned ahead.
* @param {number} [limit] Maximum number of returned items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise>;
/**
* Add a campaign for processing. Required Access Level: ModifyCampaigns
* @summary Add Campaign
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApiInterface
*/
campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig): AxiosPromise;
}
/**
* CampaignsApi - object-oriented interface
* @export
* @class CampaignsApi
* @extends {BaseAPI}
*/
export declare class CampaignsApi extends BaseAPI implements CampaignsApiInterface {
/**
* Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations
* @summary Trigger Automation for Contact
* @param {string} name
* @param {string} contactEmail
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns
* @summary Delete Campaign
* @param {string} name Name of Campaign to delete
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns the specified campaign details. Required Access Level: ViewCampaigns
* @summary Load Campaign
* @param {string} name Name of Campaign to get
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns
* @summary Pause Campaign
* @param {string} name Name of Campaign to pause
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig): Promise>;
/**
* Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns
* @summary Update Campaign
* @param {string} name Name of Campaign to update
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig): Promise>;
/**
* Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns
* @summary Load Campaigns
* @param {string} [search] Text fragment used for searching in Campaign name (using the \'contains\' rule)
* @param {number} [offset] How many items should be returned ahead.
* @param {number} [limit] Maximum number of returned items.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>;
/**
* Add a campaign for processing. Required Access Level: ModifyCampaigns
* @summary Add Campaign
* @param {Campaign} campaign JSON representation of a campaign
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CampaignsApi
*/
campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig): Promise>;
}