/* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { Campaign } from '../ee-api-models';
/**
* CampaignsApi - axios parameter creator
* @export
*/
export const CampaignsApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* 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: async (name: string, contactEmail: string, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'name' is not null or undefined
assertParamExists('campaignsAutomationByNameTriggerPost', 'name', name)
// verify required parameter 'contactEmail' is not null or undefined
assertParamExists('campaignsAutomationByNameTriggerPost', 'contactEmail', contactEmail)
const localVarPath = `/campaigns/automation/{name}/trigger`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
if (contactEmail !== undefined) {
localVarQueryParameter['contactEmail'] = contactEmail;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (name: string, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'name' is not null or undefined
assertParamExists('campaignsByNameDelete', 'name', name)
const localVarPath = `/campaigns/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (name: string, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'name' is not null or undefined
assertParamExists('campaignsByNameGet', 'name', name)
const localVarPath = `/campaigns/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (name: string, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'name' is not null or undefined
assertParamExists('campaignsByNamePausePut', 'name', name)
const localVarPath = `/campaigns/{name}/pause`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (name: string, campaign: Campaign, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'name' is not null or undefined
assertParamExists('campaignsByNamePut', 'name', name)
// verify required parameter 'campaign' is not null or undefined
assertParamExists('campaignsByNamePut', 'campaign', campaign)
const localVarPath = `/campaigns/{name}`
.replace(`{${"name"}}`, encodeURIComponent(String(name)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(campaign, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (search?: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => {
const localVarPath = `/campaigns`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
if (search !== undefined) {
localVarQueryParameter['search'] = search;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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: async (campaign: Campaign, options: RawAxiosRequestConfig = {}): Promise => {
// verify required parameter 'campaign' is not null or undefined
assertParamExists('campaignsPost', 'campaign', campaign)
const localVarPath = `/campaigns`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication apikey required
await setApiKeyToObject(localVarHeaderParameter, "X-ElasticEmail-ApiKey", configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(campaign, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* CampaignsApi - functional programming interface
* @export
*/
export const CampaignsApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = CampaignsApiAxiosParamCreator(configuration)
return {
/**
* 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}
*/
async campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsAutomationByNameTriggerPost(name, contactEmail, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsAutomationByNameTriggerPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsByNameDelete(name, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsByNameDelete']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsByNameGet(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsByNameGet(name, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsByNameGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsByNamePausePut(name, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsByNamePausePut']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsByNamePut(name, campaign, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsByNamePut']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsGet(search, offset, limit, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* 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}
*/
async campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> {
const localVarAxiosArgs = await localVarAxiosParamCreator.campaignsPost(campaign, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CampaignsApi.campaignsPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* CampaignsApi - factory interface
* @export
*/
export const CampaignsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = CampaignsApiFp(configuration)
return {
/**
* 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 {
return localVarFp.campaignsAutomationByNameTriggerPost(name, contactEmail, options).then((request) => request(axios, basePath));
},
/**
* 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 {
return localVarFp.campaignsByNameDelete(name, options).then((request) => request(axios, basePath));
},
/**
* 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 {
return localVarFp.campaignsByNameGet(name, options).then((request) => request(axios, basePath));
},
/**
* 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 {
return localVarFp.campaignsByNamePausePut(name, options).then((request) => request(axios, basePath));
},
/**
* 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 {
return localVarFp.campaignsByNamePut(name, campaign, options).then((request) => request(axios, basePath));
},
/**
* 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> {
return localVarFp.campaignsGet(search, offset, limit, options).then((request) => request(axios, basePath));
},
/**
* 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 {
return localVarFp.campaignsPost(campaign, options).then((request) => request(axios, basePath));
},
};
};
/**
* 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 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
*/
public campaignsAutomationByNameTriggerPost(name: string, contactEmail: string, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsAutomationByNameTriggerPost(name, contactEmail, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsByNameDelete(name: string, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsByNameDelete(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsByNameGet(name: string, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsByNameGet(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsByNamePausePut(name: string, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsByNamePausePut(name, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsByNamePut(name: string, campaign: Campaign, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsByNamePut(name, campaign, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsGet(search?: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsGet(search, offset, limit, options).then((request) => request(this.axios, this.basePath));
}
/**
* 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
*/
public campaignsPost(campaign: Campaign, options?: RawAxiosRequestConfig) {
return CampaignsApiFp(this.configuration).campaignsPost(campaign, options).then((request) => request(this.axios, this.basePath));
}
}