/** * Whispir Platform API * Whispir Platform API for cross channel and multi channel communications. Documentation on each endpoint is available at https://developers.whispir.com. * * The version of the OpenAPI document: 1.0.0 * Contact: support@whispir.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'; import { Email } from './email'; import { Message } from './message'; import { Social } from './social'; import { Voice } from './voice'; import { Web } from './web'; /** * Scenarios allows you to simplify the message delivery process through automated, one-click communications. */ export class Scenario { /** * Specifies the name of the scenario */ 'name': string; /** * Specifies the description of the scenario */ 'description': string; /** * Specifies the usage permission - 1)EVERYONE 2)SELECTEDUSERS When SELECTEDUSERS is provided, then `allowedUserIds` shall contain the userID of the allowed users. */ 'allowedUsers'?: Scenario.AllowedUsersEnum; /** * Specifies the comma separated list of users who can run this scenario.Only contains value when the allowedUsers is set to `SELECTEDUSERS` */ 'allowedUserIds'?: string; 'message': Message; /** * Specifies the phone number or MRI or distribution list to which the message has to be sent */ 'to'?: string; /** * Specifies the subject of the message */ 'subject'?: string; /** * Specifies the label for the message (to view during reporting) */ 'label'?: string; 'email'?: Email; 'voice'?: Voice; 'web'?: Web; 'social'?: Social; static discriminator: string | undefined = undefined; static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ { "name": "name", "baseName": "name", "type": "string" }, { "name": "description", "baseName": "description", "type": "string" }, { "name": "allowedUsers", "baseName": "allowedUsers", "type": "Scenario.AllowedUsersEnum" }, { "name": "allowedUserIds", "baseName": "allowedUserIds", "type": "string" }, { "name": "message", "baseName": "message", "type": "Message" }, { "name": "to", "baseName": "to", "type": "string" }, { "name": "subject", "baseName": "subject", "type": "string" }, { "name": "label", "baseName": "label", "type": "string" }, { "name": "email", "baseName": "email", "type": "Email" }, { "name": "voice", "baseName": "voice", "type": "Voice" }, { "name": "web", "baseName": "web", "type": "Web" }, { "name": "social", "baseName": "social", "type": "Social" } ]; static getAttributeTypeMap() { return Scenario.attributeTypeMap; } } export namespace Scenario { export enum AllowedUsersEnum { Everyone = 'EVERYONE', Selectedusers = 'SELECTEDUSERS' } }