getCampaignOverview.tsā¢5.28 kB
/**
* Brevo API
* Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/brevo **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable | | 422 | Error. Unprocessable Entity |
*
* The version of the OpenAPI document: 3.0.0
* Contact: contact@brevo.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 { RequestFile } from './models';
export class GetCampaignOverview {
/**
* ID of the campaign
*/
'id': number;
/**
* Name of the campaign
*/
'name': string;
/**
* Subject of the campaign. Only available if `abTesting` flag of the campaign is `false`
*/
'subject'?: string;
/**
* Preview text or preheader of the email campaign
*/
'previewText'?: string;
/**
* Type of campaign
*/
'type': GetCampaignOverview.TypeEnum;
/**
* Status of the campaign
*/
'status': GetCampaignOverview.StatusEnum;
/**
* UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
*/
'scheduledAt'?: string;
/**
* Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
*/
'abTesting'?: boolean;
/**
* Subject A of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
*/
'subjectA'?: string;
/**
* Subject B of the ab-test campaign. Only available if `abTesting` flag of the campaign is `true`
*/
'subjectB'?: string;
/**
* The size of your ab-test groups. Only available if `abTesting` flag of the campaign is `true`
*/
'splitRule'?: number;
/**
* Criteria for the winning version. Only available if `abTesting` flag of the campaign is `true`
*/
'winnerCriteria'?: string;
/**
* The duration of the test in hours at the end of which the winning version will be sent. Only available if `abTesting` flag of the campaign is `true`
*/
'winnerDelay'?: number;
/**
* It is true if you have chosen to send your campaign at best time, otherwise it is false
*/
'sendAtBestTime'?: boolean;
static discriminator: string | undefined = undefined;
static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
{
"name": "id",
"baseName": "id",
"type": "number"
},
{
"name": "name",
"baseName": "name",
"type": "string"
},
{
"name": "subject",
"baseName": "subject",
"type": "string"
},
{
"name": "previewText",
"baseName": "previewText",
"type": "string"
},
{
"name": "type",
"baseName": "type",
"type": "GetCampaignOverview.TypeEnum"
},
{
"name": "status",
"baseName": "status",
"type": "GetCampaignOverview.StatusEnum"
},
{
"name": "scheduledAt",
"baseName": "scheduledAt",
"type": "string"
},
{
"name": "abTesting",
"baseName": "abTesting",
"type": "boolean"
},
{
"name": "subjectA",
"baseName": "subjectA",
"type": "string"
},
{
"name": "subjectB",
"baseName": "subjectB",
"type": "string"
},
{
"name": "splitRule",
"baseName": "splitRule",
"type": "number"
},
{
"name": "winnerCriteria",
"baseName": "winnerCriteria",
"type": "string"
},
{
"name": "winnerDelay",
"baseName": "winnerDelay",
"type": "number"
},
{
"name": "sendAtBestTime",
"baseName": "sendAtBestTime",
"type": "boolean"
} ];
static getAttributeTypeMap() {
return GetCampaignOverview.attributeTypeMap;
}
}
export namespace GetCampaignOverview {
export enum TypeEnum {
Classic = <any> 'classic',
Trigger = <any> 'trigger'
}
export enum StatusEnum {
Draft = <any> 'draft',
Sent = <any> 'sent',
Archive = <any> 'archive',
Queued = <any> 'queued',
Suspended = <any> 'suspended',
InProcess = <any> 'in_process'
}
}