UNPKG

clicksend

Version:

This is the official [ClickSend](https://clicksend.com) SDK. Documentation can be found [here](https://developers.clicksend.com/docs/rest/v3/?nodejs#introduction).

1,778 lines (1,777 loc) 609 kB
"use strict"; /** * ClickSend v3 API * This is an official SDK for [ClickSend](https://clicksend.com) Below you will find a current list of the available methods for clicksend. *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* * * OpenAPI spec version: 3.1 * Contact: support@clicksend.com * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ Object.defineProperty(exports, "__esModule", { value: true }); exports.OAuth = exports.ApiKeyAuth = exports.HttpBasicAuth = exports.VoiceMessageCollection = exports.VoiceMessage = exports.Url = exports.UploadFile = exports.Subaccount = exports.StrippedString = exports.SmsTemplate = exports.SmsMessageCollection = exports.SmsMessage = exports.SmsCampaign = exports.ResellerAccountTransferCredit = exports.ResellerAccount = exports.PostRecipient = exports.PostPostcard = exports.PostLetter = exports.MmsMessageCollection = exports.MmsMessage = exports.MmsCampaign = exports.InboundSMSRule = exports.InboundFaxRule = exports.ForgotUsername = exports.ForgotPassword = exports.FieldsFields = exports.Fields = exports.FaxMessageCollection = exports.FaxMessage = exports.EmailTemplateUpdate = exports.EmailTemplateNew = exports.EmailSMSAddress = exports.EmailRecipient = exports.EmailFrom = exports.EmailCampaign = exports.EmailAddress = exports.Email = exports.DeliveryReceiptRule = exports.DeliveryIssue = exports.DateBefore = exports.CreditCard = exports.CountryListIds = exports.ContactListImport = exports.ContactList = exports.Contact = exports.Attachment = exports.Address = exports.AccountVerify = exports.AccountForgotPasswordVerify = exports.Account = void 0; exports.SMSApiApiKeys = exports.ResellerAccountApi = exports.ResellerAccountApiApiKeys = exports.ReferralAccountApi = exports.ReferralAccountApiApiKeys = exports.PostReturnAddressApi = exports.PostReturnAddressApiApiKeys = exports.PostPostcardApi = exports.PostPostcardApiApiKeys = exports.PostLetterApi = exports.PostLetterApiApiKeys = exports.NumberApi = exports.NumberApiApiKeys = exports.MmsCampaignApi = exports.MmsCampaignApiApiKeys = exports.MasterEmailTemplatesApi = exports.MasterEmailTemplatesApiApiKeys = exports.MMSApi = exports.MMSApiApiKeys = exports.InboundSMSRulesApi = exports.InboundSMSRulesApiApiKeys = exports.InboundFAXRulesApi = exports.InboundFAXRulesApiApiKeys = exports.GlobalSendingApi = exports.GlobalSendingApiApiKeys = exports.FAXDeliveryReceiptRulesApi = exports.FAXDeliveryReceiptRulesApiApiKeys = exports.FAXApi = exports.FAXApiApiKeys = exports.EmailToSmsApi = exports.EmailToSmsApiApiKeys = exports.EmailMarketingApi = exports.EmailMarketingApiApiKeys = exports.EmailDeliveryReceiptRulesApi = exports.EmailDeliveryReceiptRulesApiApiKeys = exports.DetectAddressApi = exports.DetectAddressApiApiKeys = exports.DeliveryIssuesApi = exports.DeliveryIssuesApiApiKeys = exports.CountriesApi = exports.CountriesApiApiKeys = exports.ContactListApi = exports.ContactListApiApiKeys = exports.ContactApi = exports.ContactApiApiKeys = exports.AccountRechargeApi = exports.AccountRechargeApiApiKeys = exports.AccountApi = exports.AccountApiApiKeys = exports.VoidAuth = void 0; exports.VoiceDeliveryReceiptRulesApi = exports.VoiceDeliveryReceiptRulesApiApiKeys = exports.VoiceApi = exports.VoiceApiApiKeys = exports.UserEmailTemplatesApi = exports.UserEmailTemplatesApiApiKeys = exports.UploadApi = exports.UploadApiApiKeys = exports.TransferCreditApi = exports.TransferCreditApiApiKeys = exports.TransactionalEmailApi = exports.TransactionalEmailApiApiKeys = exports.TimezonesApi = exports.TimezonesApiApiKeys = exports.SubaccountApi = exports.SubaccountApiApiKeys = exports.StatisticsApi = exports.StatisticsApiApiKeys = exports.SmsCampaignApi = exports.SmsCampaignApiApiKeys = exports.SearchApi = exports.SearchApiApiKeys = exports.SMSDeliveryReceiptRulesApi = exports.SMSDeliveryReceiptRulesApiApiKeys = exports.SMSApi = void 0; var localVarRequest = require("request"); var Promise = require("bluebird"); var defaultBasePath = 'https://rest.clicksend.com/v3'; // =============================================== // This file is autogenerated - Please do not edit // =============================================== /* tslint:disable:no-unused-variable */ var primitives = [ "string", "boolean", "double", "integer", "long", "float", "number", "any" ]; var ObjectSerializer = /** @class */ (function () { function ObjectSerializer() { } ObjectSerializer.findCorrectType = function (data, expectedType) { if (data == undefined) { return expectedType; } else if (primitives.indexOf(expectedType.toLowerCase()) !== -1) { return expectedType; } else if (expectedType === "Date") { return expectedType; } else { if (enumsMap[expectedType]) { return expectedType; } if (!typeMap[expectedType]) { return expectedType; // w/e we don't know the type } // Check the discriminator var discriminatorProperty = typeMap[expectedType].discriminator; if (discriminatorProperty == null) { return expectedType; // the type does not have a discriminator. use it. } else { if (data[discriminatorProperty]) { return data[discriminatorProperty]; // use the type given in the discriminator } else { return expectedType; // discriminator was not present (or an empty string) } } } }; ObjectSerializer.serialize = function (data, type) { if (data == undefined) { return data; } else if (primitives.indexOf(type.toLowerCase()) !== -1) { return data; } else if (type.lastIndexOf("Array<", 0) === 0) { // string.startsWith pre es6 var subType = type.replace("Array<", ""); // Array<Type> => Type> subType = subType.substring(0, subType.length - 1); // Type> => Type var transformedData = []; for (var index in data) { var date = data[index]; transformedData.push(ObjectSerializer.serialize(date, subType)); } return transformedData; } else if (type === "Date") { return data.toString(); } else { if (enumsMap[type]) { return data; } if (!typeMap[type]) { // in case we dont know the type return data; } // get the map for the correct type. var attributeTypes = typeMap[type].getAttributeTypeMap(); var instance = {}; for (var index in attributeTypes) { var attributeType = attributeTypes[index]; instance[attributeType.baseName] = ObjectSerializer.serialize(data[attributeType.name], attributeType.type); } return instance; } }; ObjectSerializer.deserialize = function (data, type) { // polymorphism may change the actual type. type = ObjectSerializer.findCorrectType(data, type); if (data == undefined) { return data; } else if (primitives.indexOf(type.toLowerCase()) !== -1) { return data; } else if (type.lastIndexOf("Array<", 0) === 0) { // string.startsWith pre es6 var subType = type.replace("Array<", ""); // Array<Type> => Type> subType = subType.substring(0, subType.length - 1); // Type> => Type var transformedData = []; for (var index in data) { var date = data[index]; transformedData.push(ObjectSerializer.deserialize(date, subType)); } return transformedData; } else if (type === "Date") { return new Date(data); } else { if (enumsMap[type]) { // is Enum return data; } if (!typeMap[type]) { // dont know the type return data; } var instance = new typeMap[type](); var attributeTypes = typeMap[type].getAttributeTypeMap(); for (var index in attributeTypes) { var attributeType = attributeTypes[index]; instance[attributeType.name] = ObjectSerializer.deserialize(data[attributeType.baseName], attributeType.type); } return instance; } }; return ObjectSerializer; }()); /** * Complete account details needed for the user. */ var Account = /** @class */ (function () { function Account() { } Account.getAttributeTypeMap = function () { return Account.attributeTypeMap; }; Account.discriminator = "classType"; Account.attributeTypeMap = [ { "name": "username", "baseName": "username", "type": "string" }, { "name": "password", "baseName": "password", "type": "string" }, { "name": "userPhone", "baseName": "user_phone", "type": "string" }, { "name": "userEmail", "baseName": "user_email", "type": "string" }, { "name": "userFirstName", "baseName": "user_first_name", "type": "string" }, { "name": "userLastName", "baseName": "user_last_name", "type": "string" }, { "name": "accountName", "baseName": "account_name", "type": "string" }, { "name": "country", "baseName": "country", "type": "string" } ]; return Account; }()); exports.Account = Account; var AccountForgotPasswordVerify = /** @class */ (function () { function AccountForgotPasswordVerify() { } AccountForgotPasswordVerify.getAttributeTypeMap = function () { return AccountForgotPasswordVerify.attributeTypeMap; }; AccountForgotPasswordVerify.discriminator = "classType"; AccountForgotPasswordVerify.attributeTypeMap = [ { "name": "subaccountId", "baseName": "subaccount_id", "type": "number" }, { "name": "activationToken", "baseName": "activation_token", "type": "string" }, { "name": "password", "baseName": "password", "type": "string" } ]; return AccountForgotPasswordVerify; }()); exports.AccountForgotPasswordVerify = AccountForgotPasswordVerify; /** * Verifies an account by token that should have been sent to the user's phone */ var AccountVerify = /** @class */ (function () { function AccountVerify() { } AccountVerify.getAttributeTypeMap = function () { return AccountVerify.attributeTypeMap; }; AccountVerify.discriminator = "classType"; AccountVerify.attributeTypeMap = [ { "name": "country", "baseName": "country", "type": "string" }, { "name": "userPhone", "baseName": "user_phone", "type": "string" }, { "name": "type", "baseName": "type", "type": "string" } ]; return AccountVerify; }()); exports.AccountVerify = AccountVerify; /** * Base model for all address-related objects. */ var Address = /** @class */ (function () { function Address() { } Address.getAttributeTypeMap = function () { return Address.attributeTypeMap; }; Address.discriminator = "classType"; Address.attributeTypeMap = [ { "name": "addressName", "baseName": "address_name", "type": "string" }, { "name": "addressLine1", "baseName": "address_line_1", "type": "string" }, { "name": "addressCity", "baseName": "address_city", "type": "string" }, { "name": "addressPostalCode", "baseName": "address_postal_code", "type": "string" }, { "name": "addressCountry", "baseName": "address_country", "type": "string" }, { "name": "addressLine2", "baseName": "address_line_2", "type": "string" }, { "name": "addressState", "baseName": "address_state", "type": "string" } ]; return Address; }()); exports.Address = Address; /** * Email attachment */ var Attachment = /** @class */ (function () { function Attachment() { } Attachment.getAttributeTypeMap = function () { return Attachment.attributeTypeMap; }; Attachment.discriminator = "classType"; Attachment.attributeTypeMap = [ { "name": "content", "baseName": "content", "type": "string" }, { "name": "type", "baseName": "type", "type": "string" }, { "name": "filename", "baseName": "filename", "type": "string" }, { "name": "disposition", "baseName": "disposition", "type": "string" }, { "name": "contentId", "baseName": "content_id", "type": "string" } ]; return Attachment; }()); exports.Attachment = Attachment; /** * Contains all details for the main contact. */ var Contact = /** @class */ (function () { function Contact() { } Contact.getAttributeTypeMap = function () { return Contact.attributeTypeMap; }; Contact.discriminator = "classType"; Contact.attributeTypeMap = [ { "name": "phoneNumber", "baseName": "phone_number", "type": "string" }, { "name": "custom1", "baseName": "custom_1", "type": "string" }, { "name": "email", "baseName": "email", "type": "string" }, { "name": "faxNumber", "baseName": "fax_number", "type": "string" }, { "name": "firstName", "baseName": "first_name", "type": "string" }, { "name": "addressLine1", "baseName": "address_line_1", "type": "string" }, { "name": "addressLine2", "baseName": "address_line_2", "type": "string" }, { "name": "addressCity", "baseName": "address_city", "type": "string" }, { "name": "addressState", "baseName": "address_state", "type": "string" }, { "name": "addressPostalCode", "baseName": "address_postal_code", "type": "string" }, { "name": "addressCountry", "baseName": "address_country", "type": "string" }, { "name": "organizationName", "baseName": "organization_name", "type": "string" }, { "name": "custom2", "baseName": "custom_2", "type": "string" }, { "name": "custom3", "baseName": "custom_3", "type": "string" }, { "name": "custom4", "baseName": "custom_4", "type": "string" }, { "name": "lastName", "baseName": "last_name", "type": "string" } ]; return Contact; }()); exports.Contact = Contact; /** * Your contact list. */ var ContactList = /** @class */ (function () { function ContactList() { } ContactList.getAttributeTypeMap = function () { return ContactList.attributeTypeMap; }; ContactList.discriminator = "classType"; ContactList.attributeTypeMap = [ { "name": "listName", "baseName": "list_name", "type": "string" } ]; return ContactList; }()); exports.ContactList = ContactList; /** * Contact list import model */ var ContactListImport = /** @class */ (function () { function ContactListImport() { } ContactListImport.getAttributeTypeMap = function () { return ContactListImport.attributeTypeMap; }; ContactListImport.discriminator = "classType"; ContactListImport.attributeTypeMap = [ { "name": "fileUrl", "baseName": "file_url", "type": "string" }, { "name": "fieldOrder", "baseName": "field_order", "type": "Array<string>" } ]; return ContactListImport; }()); exports.ContactListImport = ContactListImport; var CountryListIds = /** @class */ (function () { function CountryListIds() { } CountryListIds.getAttributeTypeMap = function () { return CountryListIds.attributeTypeMap; }; CountryListIds.discriminator = undefined; CountryListIds.attributeTypeMap = [ { "name": "countryListIds", "baseName": "country_list_ids", "type": "Array<number>" } ]; return CountryListIds; }()); exports.CountryListIds = CountryListIds; /** * Credit card model */ var CreditCard = /** @class */ (function () { function CreditCard() { } CreditCard.getAttributeTypeMap = function () { return CreditCard.attributeTypeMap; }; CreditCard.discriminator = "classType"; CreditCard.attributeTypeMap = [ { "name": "number", "baseName": "number", "type": "string" }, { "name": "expiryMonth", "baseName": "expiry_month", "type": "number" }, { "name": "expiryYear", "baseName": "expiry_year", "type": "number" }, { "name": "cvc", "baseName": "cvc", "type": "number" }, { "name": "name", "baseName": "name", "type": "string" }, { "name": "bankName", "baseName": "bank_name", "type": "string" } ]; return CreditCard; }()); exports.CreditCard = CreditCard; /** * All dates before specified timestamp. */ var DateBefore = /** @class */ (function () { function DateBefore() { } DateBefore.getAttributeTypeMap = function () { return DateBefore.attributeTypeMap; }; DateBefore.discriminator = "classType"; DateBefore.attributeTypeMap = [ { "name": "dateBefore", "baseName": "date_before", "type": "number" } ]; return DateBefore; }()); exports.DateBefore = DateBefore; /** * Issues with message delivery */ var DeliveryIssue = /** @class */ (function () { function DeliveryIssue() { } DeliveryIssue.getAttributeTypeMap = function () { return DeliveryIssue.attributeTypeMap; }; DeliveryIssue.discriminator = "classType"; DeliveryIssue.attributeTypeMap = [ { "name": "messageId", "baseName": "message_id", "type": "string" }, { "name": "type", "baseName": "type", "type": "string" }, { "name": "description", "baseName": "description", "type": "string" }, { "name": "clientComments", "baseName": "client_comments", "type": "string" }, { "name": "emailAddress", "baseName": "email_address", "type": "string" } ]; return DeliveryIssue; }()); exports.DeliveryIssue = DeliveryIssue; /** * Model for a Delivery Receipt */ var DeliveryReceiptRule = /** @class */ (function () { function DeliveryReceiptRule() { } DeliveryReceiptRule.getAttributeTypeMap = function () { return DeliveryReceiptRule.attributeTypeMap; }; DeliveryReceiptRule.discriminator = "classType"; DeliveryReceiptRule.attributeTypeMap = [ { "name": "ruleName", "baseName": "rule_name", "type": "string" }, { "name": "matchType", "baseName": "match_type", "type": "number" }, { "name": "action", "baseName": "action", "type": "string" }, { "name": "actionAddress", "baseName": "action_address", "type": "string" }, { "name": "enabled", "baseName": "enabled", "type": "number" } ]; return DeliveryReceiptRule; }()); exports.DeliveryReceiptRule = DeliveryReceiptRule; /** * Send Email */ var Email = /** @class */ (function () { function Email() { } Email.getAttributeTypeMap = function () { return Email.attributeTypeMap; }; Email.discriminator = "classType"; Email.attributeTypeMap = [ { "name": "to", "baseName": "to", "type": "Array<EmailRecipient>" }, { "name": "cc", "baseName": "cc", "type": "Array<EmailRecipient>" }, { "name": "bcc", "baseName": "bcc", "type": "Array<EmailRecipient>" }, { "name": "from", "baseName": "from", "type": "EmailFrom" }, { "name": "subject", "baseName": "subject", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "attachments", "baseName": "attachments", "type": "Array<Attachment>" }, { "name": "schedule", "baseName": "schedule", "type": "number" } ]; return Email; }()); exports.Email = Email; var EmailAddress = /** @class */ (function () { function EmailAddress() { } EmailAddress.getAttributeTypeMap = function () { return EmailAddress.attributeTypeMap; }; EmailAddress.discriminator = undefined; EmailAddress.attributeTypeMap = [ { "name": "emailAddress", "baseName": "email_address", "type": "string" } ]; return EmailAddress; }()); exports.EmailAddress = EmailAddress; /** * Campaign Model for Email */ var EmailCampaign = /** @class */ (function () { function EmailCampaign() { } EmailCampaign.getAttributeTypeMap = function () { return EmailCampaign.attributeTypeMap; }; EmailCampaign.discriminator = "classType"; EmailCampaign.attributeTypeMap = [ { "name": "name", "baseName": "name", "type": "string" }, { "name": "subject", "baseName": "subject", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "fromEmailAddressId", "baseName": "from_email_address_id", "type": "number" }, { "name": "fromName", "baseName": "from_name", "type": "string" }, { "name": "templateId", "baseName": "template_id", "type": "number" }, { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "schedule", "baseName": "schedule", "type": "number" } ]; return EmailCampaign; }()); exports.EmailCampaign = EmailCampaign; /** * From Email object. */ var EmailFrom = /** @class */ (function () { function EmailFrom() { } EmailFrom.getAttributeTypeMap = function () { return EmailFrom.attributeTypeMap; }; EmailFrom.discriminator = undefined; EmailFrom.attributeTypeMap = [ { "name": "emailAddressId", "baseName": "email_address_id", "type": "string" }, { "name": "name", "baseName": "name", "type": "string" } ]; return EmailFrom; }()); exports.EmailFrom = EmailFrom; /** * Recipient of an email, either To, Cc, or Bcc. */ var EmailRecipient = /** @class */ (function () { function EmailRecipient() { } EmailRecipient.getAttributeTypeMap = function () { return EmailRecipient.attributeTypeMap; }; EmailRecipient.discriminator = "classType"; EmailRecipient.attributeTypeMap = [ { "name": "email", "baseName": "email", "type": "string" }, { "name": "name", "baseName": "name", "type": "string" } ]; return EmailRecipient; }()); exports.EmailRecipient = EmailRecipient; /** * Email-to-SMS Allowed Address */ var EmailSMSAddress = /** @class */ (function () { function EmailSMSAddress() { } EmailSMSAddress.getAttributeTypeMap = function () { return EmailSMSAddress.attributeTypeMap; }; EmailSMSAddress.discriminator = "classType"; EmailSMSAddress.attributeTypeMap = [ { "name": "emailAddress", "baseName": "email_address", "type": "string" }, { "name": "from", "baseName": "from", "type": "string" }, { "name": "subaccountId", "baseName": "subaccount_id", "type": "string" } ]; return EmailSMSAddress; }()); exports.EmailSMSAddress = EmailSMSAddress; /** * Model for Email Templates */ var EmailTemplateNew = /** @class */ (function () { function EmailTemplateNew() { } EmailTemplateNew.getAttributeTypeMap = function () { return EmailTemplateNew.attributeTypeMap; }; EmailTemplateNew.discriminator = "classType"; EmailTemplateNew.attributeTypeMap = [ { "name": "templateName", "baseName": "template_name", "type": "string" }, { "name": "templateIdMaster", "baseName": "template_id_master", "type": "number" } ]; return EmailTemplateNew; }()); exports.EmailTemplateNew = EmailTemplateNew; /** * Model for Email Templates */ var EmailTemplateUpdate = /** @class */ (function () { function EmailTemplateUpdate() { } EmailTemplateUpdate.getAttributeTypeMap = function () { return EmailTemplateUpdate.attributeTypeMap; }; EmailTemplateUpdate.discriminator = "classType"; EmailTemplateUpdate.attributeTypeMap = [ { "name": "templateName", "baseName": "template_name", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" } ]; return EmailTemplateUpdate; }()); exports.EmailTemplateUpdate = EmailTemplateUpdate; /** * Base model for Fax Messages */ var FaxMessage = /** @class */ (function () { function FaxMessage() { } FaxMessage.getAttributeTypeMap = function () { return FaxMessage.attributeTypeMap; }; FaxMessage.discriminator = "classType"; FaxMessage.attributeTypeMap = [ { "name": "source", "baseName": "source", "type": "string" }, { "name": "to", "baseName": "to", "type": "string" }, { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "from", "baseName": "from", "type": "string" }, { "name": "schedule", "baseName": "schedule", "type": "number" }, { "name": "customString", "baseName": "custom_string", "type": "string" }, { "name": "country", "baseName": "country", "type": "string" }, { "name": "fromEmail", "baseName": "from_email", "type": "string" } ]; return FaxMessage; }()); exports.FaxMessage = FaxMessage; /** * Array of FaxMessage items */ var FaxMessageCollection = /** @class */ (function () { function FaxMessageCollection() { } FaxMessageCollection.getAttributeTypeMap = function () { return FaxMessageCollection.attributeTypeMap; }; FaxMessageCollection.discriminator = "classType"; FaxMessageCollection.attributeTypeMap = [ { "name": "messages", "baseName": "messages", "type": "Array<FaxMessage>" }, { "name": "fileUrl", "baseName": "file_url", "type": "string" } ]; return FaxMessageCollection; }()); exports.FaxMessageCollection = FaxMessageCollection; /** * Contains all details for the main contact. */ var Fields = /** @class */ (function () { function Fields() { } Fields.getAttributeTypeMap = function () { return Fields.attributeTypeMap; }; Fields.discriminator = "classType"; Fields.attributeTypeMap = [ { "name": "fields", "baseName": "fields", "type": "FieldsFields" } ]; return Fields; }()); exports.Fields = Fields; /** * From Email object. */ var FieldsFields = /** @class */ (function () { function FieldsFields() { } FieldsFields.getAttributeTypeMap = function () { return FieldsFields.attributeTypeMap; }; FieldsFields.discriminator = undefined; FieldsFields.attributeTypeMap = [ { "name": "phoneNumber", "baseName": "phone_number", "type": "string" }, { "name": "custom1", "baseName": "custom_1", "type": "string" }, { "name": "email", "baseName": "email", "type": "string" }, { "name": "faxNumber", "baseName": "fax_number", "type": "string" }, { "name": "firstName", "baseName": "first_name", "type": "string" }, { "name": "addressLine1", "baseName": "address_line_1", "type": "string" }, { "name": "addressLine2", "baseName": "address_line_2", "type": "string" }, { "name": "addressCity", "baseName": "address_city", "type": "string" }, { "name": "addressState", "baseName": "address_state", "type": "string" }, { "name": "addressPostalCode", "baseName": "address_postal_code", "type": "string" }, { "name": "addressCountry", "baseName": "address_country", "type": "string" }, { "name": "organizationName", "baseName": "organization_name", "type": "string" }, { "name": "custom2", "baseName": "custom_2", "type": "string" }, { "name": "custom3", "baseName": "custom_3", "type": "string" }, { "name": "custom4", "baseName": "custom_4", "type": "string" }, { "name": "lastName", "baseName": "last_name", "type": "string" } ]; return FieldsFields; }()); exports.FieldsFields = FieldsFields; var ForgotPassword = /** @class */ (function () { function ForgotPassword() { } ForgotPassword.getAttributeTypeMap = function () { return ForgotPassword.attributeTypeMap; }; ForgotPassword.discriminator = undefined; ForgotPassword.attributeTypeMap = [ { "name": "username", "baseName": "username", "type": "string" } ]; return ForgotPassword; }()); exports.ForgotPassword = ForgotPassword; var ForgotUsername = /** @class */ (function () { function ForgotUsername() { } ForgotUsername.getAttributeTypeMap = function () { return ForgotUsername.attributeTypeMap; }; ForgotUsername.discriminator = undefined; ForgotUsername.attributeTypeMap = [ { "name": "email", "baseName": "email", "type": "string" }, { "name": "phoneNumber", "baseName": "phone_number", "type": "string" } ]; return ForgotUsername; }()); exports.ForgotUsername = ForgotUsername; /** * Model for Inbound FAX Rules */ var InboundFaxRule = /** @class */ (function () { function InboundFaxRule() { } InboundFaxRule.getAttributeTypeMap = function () { return InboundFaxRule.attributeTypeMap; }; InboundFaxRule.discriminator = "classType"; InboundFaxRule.attributeTypeMap = [ { "name": "dedicatedNumber", "baseName": "dedicated_number", "type": "string" }, { "name": "ruleName", "baseName": "rule_name", "type": "string" }, { "name": "action", "baseName": "action", "type": "string" }, { "name": "actionAddress", "baseName": "action_address", "type": "string" }, { "name": "enabled", "baseName": "enabled", "type": "number" } ]; return InboundFaxRule; }()); exports.InboundFaxRule = InboundFaxRule; /** * Model for Inbound SMS Rules */ var InboundSMSRule = /** @class */ (function () { function InboundSMSRule() { } InboundSMSRule.getAttributeTypeMap = function () { return InboundSMSRule.attributeTypeMap; }; InboundSMSRule.discriminator = "classType"; InboundSMSRule.attributeTypeMap = [ { "name": "dedicatedNumber", "baseName": "dedicated_number", "type": "string" }, { "name": "ruleName", "baseName": "rule_name", "type": "string" }, { "name": "messageSearchType", "baseName": "message_search_type", "type": "number" }, { "name": "messageSearchTerm", "baseName": "message_search_term", "type": "string" }, { "name": "action", "baseName": "action", "type": "string" }, { "name": "actionAddress", "baseName": "action_address", "type": "string" }, { "name": "enabled", "baseName": "enabled", "type": "number" }, { "name": "webhookType", "baseName": "webhook_type", "type": "string" } ]; return InboundSMSRule; }()); exports.InboundSMSRule = InboundSMSRule; /** * Campaign Model for MMS */ var MmsCampaign = /** @class */ (function () { function MmsCampaign() { } MmsCampaign.getAttributeTypeMap = function () { return MmsCampaign.attributeTypeMap; }; MmsCampaign.discriminator = "classType"; MmsCampaign.attributeTypeMap = [ { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "name", "baseName": "name", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "from", "baseName": "from", "type": "string" }, { "name": "schedule", "baseName": "schedule", "type": "number" }, { "name": "subject", "baseName": "subject", "type": "string" }, { "name": "mediaFile", "baseName": "media_file", "type": "string" } ]; return MmsCampaign; }()); exports.MmsCampaign = MmsCampaign; /** * Single MMS message model */ var MmsMessage = /** @class */ (function () { function MmsMessage() { } MmsMessage.getAttributeTypeMap = function () { return MmsMessage.attributeTypeMap; }; MmsMessage.discriminator = "classType"; MmsMessage.attributeTypeMap = [ { "name": "to", "baseName": "to", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "subject", "baseName": "subject", "type": "string" }, { "name": "from", "baseName": "from", "type": "string" }, { "name": "country", "baseName": "country", "type": "string" }, { "name": "source", "baseName": "source", "type": "string" }, { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "schedule", "baseName": "schedule", "type": "number" }, { "name": "customString", "baseName": "custom_string", "type": "string" }, { "name": "fromEmail", "baseName": "from_email", "type": "string" } ]; return MmsMessage; }()); exports.MmsMessage = MmsMessage; /** * Array of MmsMessage items */ var MmsMessageCollection = /** @class */ (function () { function MmsMessageCollection() { } MmsMessageCollection.getAttributeTypeMap = function () { return MmsMessageCollection.attributeTypeMap; }; MmsMessageCollection.discriminator = "classType"; MmsMessageCollection.attributeTypeMap = [ { "name": "mediaFile", "baseName": "media_file", "type": "string" }, { "name": "messages", "baseName": "messages", "type": "Array<MmsMessage>" } ]; return MmsMessageCollection; }()); exports.MmsMessageCollection = MmsMessageCollection; /** * PostLetter model */ var PostLetter = /** @class */ (function () { function PostLetter() { } PostLetter.getAttributeTypeMap = function () { return PostLetter.attributeTypeMap; }; PostLetter.discriminator = "classType"; PostLetter.attributeTypeMap = [ { "name": "fileUrl", "baseName": "file_url", "type": "string" }, { "name": "priorityPost", "baseName": "priority_post", "type": "number" }, { "name": "recipients", "baseName": "recipients", "type": "Array<PostRecipient>" }, { "name": "templateUsed", "baseName": "template_used", "type": "number" }, { "name": "duplex", "baseName": "duplex", "type": "number" }, { "name": "colour", "baseName": "colour", "type": "number" }, { "name": "source", "baseName": "source", "type": "string" } ]; return PostLetter; }()); exports.PostLetter = PostLetter; /** * PostPostcard model */ var PostPostcard = /** @class */ (function () { function PostPostcard() { } PostPostcard.getAttributeTypeMap = function () { return PostPostcard.attributeTypeMap; }; PostPostcard.discriminator = "classType"; PostPostcard.attributeTypeMap = [ { "name": "fileUrls", "baseName": "file_urls", "type": "Array<string>" }, { "name": "recipients", "baseName": "recipients", "type": "Array<PostRecipient>" } ]; return PostPostcard; }()); exports.PostPostcard = PostPostcard; /** * PostRecipient model */ var PostRecipient = /** @class */ (function () { function PostRecipient() { } PostRecipient.getAttributeTypeMap = function () { return PostRecipient.attributeTypeMap; }; PostRecipient.discriminator = "classType"; PostRecipient.attributeTypeMap = [ { "name": "addressName", "baseName": "address_name", "type": "string" }, { "name": "addressLine1", "baseName": "address_line_1", "type": "string" }, { "name": "addressLine2", "baseName": "address_line_2", "type": "string" }, { "name": "addressCity", "baseName": "address_city", "type": "string" }, { "name": "addressState", "baseName": "address_state", "type": "string" }, { "name": "addressPostalCode", "baseName": "address_postal_code", "type": "string" }, { "name": "addressCountry", "baseName": "address_country", "type": "string" }, { "name": "returnAddressId", "baseName": "return_address_id", "type": "number" }, { "name": "schedule", "baseName": "schedule", "type": "number" } ]; return PostRecipient; }()); exports.PostRecipient = PostRecipient; /** * ResellerAccount model */ var ResellerAccount = /** @class */ (function () { function ResellerAccount() { } ResellerAccount.getAttributeTypeMap = function () { return ResellerAccount.attributeTypeMap; }; ResellerAccount.discriminator = "classType"; ResellerAccount.attributeTypeMap = [ { "name": "username", "baseName": "username", "type": "string" }, { "name": "password", "baseName": "password", "type": "string" }, { "name": "userEmail", "baseName": "user_email", "type": "string" }, { "name": "userPhone", "baseName": "user_phone", "type": "string" }, { "name": "userFirstName", "baseName": "user_first_name", "type": "string" }, { "name": "userLastName", "baseName": "user_last_name", "type": "string" }, { "name": "accountName", "baseName": "account_name", "type": "string" }, { "name": "country", "baseName": "country", "type": "string" } ]; return ResellerAccount; }()); exports.ResellerAccount = ResellerAccount; /** * ResellerAccountTransferCredit model */ var ResellerAccountTransferCredit = /** @class */ (function () { function ResellerAccountTransferCredit() { } ResellerAccountTransferCredit.getAttributeTypeMap = function () { return ResellerAccountTransferCredit.attributeTypeMap; }; ResellerAccountTransferCredit.discriminator = "classType"; ResellerAccountTransferCredit.attributeTypeMap = [ { "name": "clientUserId", "baseName": "client_user_id", "type": "number" }, { "name": "balance", "baseName": "balance", "type": "number" }, { "name": "currency", "baseName": "currency", "type": "string" } ]; return ResellerAccountTransferCredit; }()); exports.ResellerAccountTransferCredit = ResellerAccountTransferCredit; /** * Campaign Model for SMS */ var SmsCampaign = /** @class */ (function () { function SmsCampaign() { } SmsCampaign.getAttributeTypeMap = function () { return SmsCampaign.attributeTypeMap; }; SmsCampaign.discriminator = "classType"; SmsCampaign.attributeTypeMap = [ { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "name", "baseName": "name", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "from", "baseName": "from", "type": "string" }, { "name": "schedule", "baseName": "schedule", "type": "number" }, { "name": "urlToShorten", "baseName": "url_to_shorten", "type": "string" } ]; return SmsCampaign; }()); exports.SmsCampaign = SmsCampaign; /** * SmsMessage model */ var SmsMessage = /** @class */ (function () { function SmsMessage() { } SmsMessage.getAttributeTypeMap = function () { return SmsMessage.attributeTypeMap; }; SmsMessage.discriminator = "classType"; SmsMessage.attributeTypeMap = [ { "name": "from", "baseName": "from", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" }, { "name": "to", "baseName": "to", "type": "string" }, { "name": "source", "baseName": "source", "type": "string" }, { "name": "schedule", "baseName": "schedule", "type": "number" }, { "name": "customString", "baseName": "custom_string", "type": "string" }, { "name": "listId", "baseName": "list_id", "type": "number" }, { "name": "country", "baseName": "country", "type": "string" }, { "name": "fromEmail", "baseName": "from_email", "type": "string" } ]; return SmsMessage; }()); exports.SmsMessage = SmsMessage; /** * Array of SmsMessage items */ var SmsMessageCollection = /** @class */ (function () { function SmsMessageCollection() { } SmsMessageCollection.getAttributeTypeMap = function () { return SmsMessageCollection.attributeTypeMap; }; SmsMessageCollection.discriminator = "classType"; SmsMessageCollection.attributeTypeMap = [ { "name": "messages", "baseName": "messages", "type": "Array<SmsMessage>" } ]; return SmsMessageCollection; }()); exports.SmsMessageCollection = SmsMessageCollection; /** * SmsTemplate model */ var SmsTemplate = /** @class */ (function () { function SmsTemplate() { } SmsTemplate.getAttributeTypeMap = function () { return SmsTemplate.attributeTypeMap; }; SmsTemplate.discriminator = "classType"; SmsTemplate.attributeTypeMap = [ { "name": "templateName", "baseName": "template_name", "type": "string" }, { "name": "body", "baseName": "body", "type": "string" } ]; return SmsTemplate; }()); exports.SmsTemplate = SmsTemplate; /** * String to be stripped. */ var StrippedString = /** @class */ (function () { function StrippedString() { } StrippedString.getAttributeTypeMap = function () { return StrippedString.attributeTypeMap; }; StrippedString.discriminator = "classType"; StrippedString.attributeTypeMap = [ { "name": "stripString", "baseName": "strip_string", "type": "string" } ]; return StrippedString; }()); exports.StrippedString = StrippedString; /** * Accounts that are maintained under a main account */ var Subaccount = /** @class */ (function () { function Subaccount() { } Subaccount.getAttributeTypeMap = function () { return Subaccount.attributeTypeMap; }; Subaccount.discriminator = "classType"; Subaccount.attributeTypeMap = [ {