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).
2,070 lines (2,069 loc) • 135 kB
TypeScript
/**
* 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.
*/
import localVarRequest = require('request');
import http = require('http');
import Promise = require('bluebird');
/**
* Complete account details needed for the user.
*/
export declare class Account {
/**
* Your username
*/
'username': string;
/**
* Your password
*/
'password': string;
/**
* Your phone number in E.164 format.
*/
'userPhone': string;
/**
* Your email
*/
'userEmail': string;
/**
* Your first name
*/
'userFirstName': string;
/**
* Your last name
*/
'userLastName': string;
/**
* Your delivery to value.
*/
'accountName': string;
/**
* Your country
*/
'country': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare class AccountForgotPasswordVerify {
/**
* ID of subaccount
*/
'subaccountId': number;
/**
* Activation token
*/
'activationToken': string;
/**
* Password
*/
'password': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Verifies an account by token that should have been sent to the user's phone
*/
export declare class AccountVerify {
/**
* Country code
*/
'country': string;
/**
* User's phone number
*/
'userPhone': string;
/**
* Type of verification
*/
'type': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Base model for all address-related objects.
*/
export declare class Address {
/**
* Your address name.
*/
'addressName': string;
/**
* Your address line 1
*/
'addressLine1': string;
/**
* Your city
*/
'addressCity': string;
/**
* Your postal code
*/
'addressPostalCode': string;
/**
* Your country
*/
'addressCountry': string;
/**
* Your address line 2
*/
'addressLine2'?: string;
/**
* Your state
*/
'addressState'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Email attachment
*/
export declare class Attachment {
/**
* The base64-encoded contents of the file.
*/
'content': string;
/**
* The type of file being attached.
*/
'type': string;
/**
* The name of the file being attached.
*/
'filename': string;
/**
* Inline for content that can be displayed within the email, or attachment for any other files.
*/
'disposition': string;
/**
* An ID for the content.
*/
'contentId': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Contains all details for the main contact.
*/
export declare class Contact {
/**
* Your phone number in E.164 format. Must be provided if no fax number or email.
*/
'phoneNumber': string;
/**
*
*/
'custom1': string;
/**
* Your email. Must be provided if no phone number or fax number.
*/
'email'?: string;
/**
* Your fax number. Must be provided if no phone number or email.
*/
'faxNumber'?: string;
/**
* Your first name.
*/
'firstName'?: string;
/**
* Your street address
*/
'addressLine1'?: string;
/**
*
*/
'addressLine2'?: string;
/**
* Your nearest city
*/
'addressCity'?: string;
/**
* Your current state
*/
'addressState'?: string;
/**
* Your current postcode
*/
'addressPostalCode'?: string;
/**
* Your current country
*/
'addressCountry'?: string;
/**
* Your organisation name
*/
'organizationName'?: string;
/**
*
*/
'custom2'?: string;
/**
*
*/
'custom3'?: string;
/**
*
*/
'custom4'?: string;
/**
* Your last name
*/
'lastName'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Your contact list.
*/
export declare class ContactList {
/**
* Your list name.
*/
'listName': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Contact list import model
*/
export declare class ContactListImport {
/**
* URL of file to process
*/
'fileUrl': string;
/**
* Order of fields in file
*/
'fieldOrder': Array<string>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare class CountryListIds {
/**
* Array of country ids
*/
'countryListIds': Array<number>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Credit card model
*/
export declare class CreditCard {
/**
* Credit card number
*/
'number': string;
/**
* Expiry month of credit card
*/
'expiryMonth': number;
/**
* Expiry year of credit card
*/
'expiryYear': number;
/**
* CVC number of credit card
*/
'cvc': number;
/**
* Name printed on credit card
*/
'name': string;
/**
* Name of bank that credit card belongs to
*/
'bankName': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* All dates before specified timestamp.
*/
export declare class DateBefore {
/**
* An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.
*/
'dateBefore'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Issues with message delivery
*/
export declare class DeliveryIssue {
/**
* The message id of the message.
*/
'messageId'?: string;
/**
* The type of message, must be one of the following values SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST.
*/
'type': string;
/**
* The description of the message.
*/
'description': string;
/**
* The user's comments.
*/
'clientComments'?: string;
/**
* The user's email address.
*/
'emailAddress': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Model for a Delivery Receipt
*/
export declare class DeliveryReceiptRule {
/**
* Rule Name.
*/
'ruleName': string;
/**
* Match Type. 0=All reports.
*/
'matchType': number;
/**
* Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
*/
'action': string;
/**
* Action address.
*/
'actionAddress': string;
/**
* Enabled: Disabled=0 or Enabled=1.
*/
'enabled': number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Send Email
*/
export declare class Email {
/**
* Array of To Recipient items.
*/
'to': Array<EmailRecipient>;
/**
* Array of Cc Recipient items.
*/
'cc'?: Array<EmailRecipient>;
/**
* Array of Bcc Recipient items.
*/
'bcc'?: Array<EmailRecipient>;
'from': EmailFrom;
/**
* Subject of the email.
*/
'subject'?: string;
/**
* Body of the email.
*/
'body': string;
/**
* Array of Attachment items.
*/
'attachments'?: Array<Attachment>;
/**
* Schedule.
*/
'schedule'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare class EmailAddress {
/**
* Email to be allowed.
*/
'emailAddress': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Campaign Model for Email
*/
export declare class EmailCampaign {
/**
* Your campaign name.
*/
'name': string;
/**
* Your campaign subject.
*/
'subject': string;
/**
* Your campaign message.
*/
'body': string;
/**
* The allowed email address id.
*/
'fromEmailAddressId': number;
/**
* Your name or business name.
*/
'fromName': string;
/**
* Your template id.
*/
'templateId'?: number;
/**
* Your contact list id.
*/
'listId': number;
/**
* Your schedule timestamp.
*/
'schedule'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* From Email object.
*/
export declare class EmailFrom {
/**
* Email address id of the recipient.
*/
'emailAddressId': string;
/**
* Name of the recipient.
*/
'name'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Recipient of an email, either To, Cc, or Bcc.
*/
export declare class EmailRecipient {
/**
* Email of the recipient.
*/
'email': string;
/**
* Name of the recipient.
*/
'name'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Email-to-SMS Allowed Address
*/
export declare class EmailSMSAddress {
/**
* Your email address
*/
'emailAddress': string;
/**
* Your sender id
*/
'from': string;
/**
* Your subaccount id
*/
'subaccountId'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Model for Email Templates
*/
export declare class EmailTemplateNew {
/**
* The intended name for the new template.
*/
'templateName': string;
/**
* The ID of the master template you want to base on.
*/
'templateIdMaster': number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Model for Email Templates
*/
export declare class EmailTemplateUpdate {
/**
* The intended name for the template.
*/
'templateName'?: string;
/**
* Your template body.
*/
'body': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Base model for Fax Messages
*/
export declare class FaxMessage {
/**
* Your method of sending e.g. 'wordpress', 'php', 'c#'.
*/
'source'?: string;
/**
* Recipient fax number in E.164 format.
*/
'to': string;
/**
* Your list ID if sending to a whole list. Can be used instead of 'to'.
*/
'listId'?: number;
/**
* Your sender id. Must be a valid fax number.
*/
'from'?: string;
/**
* Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp
*/
'schedule'?: number;
/**
* Your reference. Will be passed back with all replies and delivery reports.
*/
'customString'?: string;
/**
* Recipient country.
*/
'country'?: string;
/**
* An email address where the reply should be emailed to.
*/
'fromEmail'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Array of FaxMessage items
*/
export declare class FaxMessageCollection {
/**
* Array of FaxMessage items
*/
'messages': Array<FaxMessage>;
/**
* URL of file to send
*/
'fileUrl': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Contains all details for the main contact.
*/
export declare class Fields {
'fields'?: FieldsFields;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* From Email object.
*/
export declare class FieldsFields {
/**
* Your phone number in E.164 format. Must be provided if no fax number or email.
*/
'phoneNumber'?: string;
/**
*
*/
'custom1'?: string;
/**
* Your email. Must be provided if no phone number or fax number.
*/
'email'?: string;
/**
* Your fax number. Must be provided if no phone number or email.
*/
'faxNumber'?: string;
/**
* Your first name.
*/
'firstName'?: string;
/**
* Your street address
*/
'addressLine1'?: string;
/**
*
*/
'addressLine2'?: string;
/**
* Your nearest city
*/
'addressCity'?: string;
/**
* Your current state
*/
'addressState'?: string;
/**
* Your current postcode
*/
'addressPostalCode'?: string;
/**
* Your current country
*/
'addressCountry'?: string;
/**
* Your organisation name
*/
'organizationName'?: string;
/**
*
*/
'custom2'?: string;
/**
*
*/
'custom3'?: string;
/**
*
*/
'custom4'?: string;
/**
* Your last name
*/
'lastName'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare class ForgotPassword {
/**
* Username belonging to account.
*/
'username': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export declare class ForgotUsername {
/**
* Email belonging to account.
*/
'email'?: string;
/**
* Phone number belonging to account.
*/
'phoneNumber'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Model for Inbound FAX Rules
*/
export declare class InboundFaxRule {
/**
* Dedicated Number. Can be '*' to apply to all numbers.
*/
'dedicatedNumber': string;
/**
* Rule Name.
*/
'ruleName': string;
/**
* Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
*/
'action': string;
/**
* Action address.
*/
'actionAddress': string;
/**
* Enabled: Disabled=0 or Enabled=1.
*/
'enabled': number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Model for Inbound SMS Rules
*/
export declare class InboundSMSRule {
/**
* Dedicated Number. Can be '*' to apply to all numbers.
*/
'dedicatedNumber': string;
/**
* Rule Name.
*/
'ruleName': string;
/**
* Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
*/
'messageSearchType': number;
/**
* Message search term.
*/
'messageSearchTerm': string;
/**
* Action to be taken (AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL CREATE_CONTACT_PLUS_NAME, SMPP, NONE).
*/
'action': string;
/**
* Action address.
*/
'actionAddress': string;
/**
* Enabled: Disabled=0 or Enabled=1.
*/
'enabled': number;
/**
* post, get, or json. post by default
*/
'webhookType'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Campaign Model for MMS
*/
export declare class MmsCampaign {
/**
* Your list id.
*/
'listId': number;
/**
* Your campaign name.
*/
'name': string;
/**
* Your campaign message.
*/
'body': string;
/**
* Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
*/
'from'?: string;
/**
* Your schedule timestamp.
*/
'schedule'?: number;
/**
* Subject of MMS campaign.
*/
'subject': string;
/**
* URL pointing to media file.
*/
'mediaFile': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Single MMS message model
*/
export declare class MmsMessage {
/**
* Recipient phone number in E.164 format
*/
'to'?: string;
/**
* Your message
*/
'body': string;
/**
* Subject line (max 20 characters)
*/
'subject': string;
/**
* Your sender ID
*/
'from'?: string;
/**
* Recipient country
*/
'country'?: string;
/**
* Your method of sending
*/
'source'?: string;
/**
* Your list ID if sending to a whole list (can be used instead of 'to')
*/
'listId'?: number;
/**
* Schedule time in unix format (leave blank for immediate delivery)
*/
'schedule'?: number;
/**
* Custom string for your reference
*/
'customString'?: string;
/**
* Email to send replies to
*/
'fromEmail'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Array of MmsMessage items
*/
export declare class MmsMessageCollection {
/**
* Media file you want to send
*/
'mediaFile': string;
/**
* Array of MmsMessage models
*/
'messages': Array<MmsMessage>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* PostLetter model
*/
export declare class PostLetter {
/**
* URL of file to send
*/
'fileUrl': string;
/**
* Whether letter is priority
*/
'priorityPost'?: number;
/**
* Array of PostRecipient models
*/
'recipients': Array<PostRecipient>;
/**
* Whether using our template
*/
'templateUsed'?: number;
/**
* Whether letter is duplex
*/
'duplex'?: number;
/**
* Whether letter is in colour
*/
'colour'?: number;
/**
* Source being sent from
*/
'source'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* PostPostcard model
*/
export declare class PostPostcard {
/**
* Postcard file URLs
*/
'fileUrls': Array<string>;
/**
* Array of recipients
*/
'recipients': Array<PostRecipient>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* PostRecipient model
*/
export declare class PostRecipient {
/**
* Name of address
*/
'addressName': string;
/**
* First line of address
*/
'addressLine1': string;
/**
* Second line of address
*/
'addressLine2'?: string;
/**
* City
*/
'addressCity': string;
/**
* State
*/
'addressState': string;
/**
* Postal code
*/
'addressPostalCode': string;
/**
* Country
*/
'addressCountry': string;
/**
* ID of return address to use
*/
'returnAddressId': number;
/**
* When to send letter (0/null=now)
*/
'schedule'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* ResellerAccount model
*/
export declare class ResellerAccount {
/**
* Account username
*/
'username': string;
/**
* Account password (unhashed)
*/
'password': string;
/**
* Account email
*/
'userEmail': string;
/**
* Account phone number
*/
'userPhone': string;
/**
* Account owner first name
*/
'userFirstName': string;
/**
* Account owner last name
*/
'userLastName': string;
/**
* Account name (usually company name)
*/
'accountName': string;
/**
* Country of account holder
*/
'country': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* ResellerAccountTransferCredit model
*/
export declare class ResellerAccountTransferCredit {
/**
* User ID of client
*/
'clientUserId': number;
/**
* Balance to transfer
*/
'balance': number;
/**
* Currency of balance to transfer
*/
'currency': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Campaign Model for SMS
*/
export declare class SmsCampaign {
/**
* Your list id.
*/
'listId': number;
/**
* Your campaign name.
*/
'name': string;
/**
* Your campaign message.
*/
'body': string;
/**
* Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
*/
'from'?: string;
/**
* Your schedule timestamp.
*/
'schedule'?: number;
/**
* url to be shortened add http://smsg.io/xxxxx` to the body as a placeholder.
*/
'urlToShorten'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* SmsMessage model
*/
export declare class SmsMessage {
/**
* Your sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
*/
'from'?: string;
/**
* Your message.
*/
'body': string;
/**
* Recipient phone number in E.164 format.
*/
'to'?: string;
/**
* Your method of sending e.g. 'wordpress', 'php', 'c#'.
*/
'source'?: string;
/**
* Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp
*/
'schedule'?: number;
/**
* Your reference. Will be passed back with all replies and delivery reports.
*/
'customString'?: string;
/**
* Your list ID if sending to a whole list. Can be used instead of 'to'.
*/
'listId'?: number;
/**
* Recipient country.
*/
'country'?: string;
/**
* An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS.
*/
'fromEmail'?: string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Array of SmsMessage items
*/
export declare class SmsMessageCollection {
/**
* Array of SmsMessage items
*/
'messages': Array<SmsMessage>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* SmsTemplate model
*/
export declare class SmsTemplate {
/**
* Name of template
*/
'templateName': string;
/**
* Body of template
*/
'body': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* String to be stripped.
*/
export declare class StrippedString {
/**
* String to be.
*/
'stripString': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Accounts that are maintained under a main account
*/
export declare class Subaccount {
/**
* Your new api username.
*/
'apiUsername': string;
/**
* Your new password
*/
'password': string;
/**
* Your new email.
*/
'email': string;
/**
* Your phone number in E.164 format.
*/
'phoneNumber': string;
/**
* Your firstname
*/
'firstName': string;
/**
* Your lastname
*/
'lastName': string;
/**
* Your access users flag value, must be 1 or 0.
*/
'accessUsers'?: number;
/**
* Your access billing flag value, must be 1 or 0.
*/
'accessBilling'?: number;
/**
* Your access reporting flag value, must be 1 or 0.
*/
'accessReporting'?: number;
/**
* Your access contacts flag value, must be 1 or 0.
*/
'accessContacts'?: number;
/**
* Your access settings flag value, must be 1 or 0.
*/
'accessSettings'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Your file to be uploaded.
*/
export declare class UploadFile {
/**
* Your base64 encoded file string.
*/
'content': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Your url.
*/
export declare class Url {
/**
* Your url.
*/
'url': string;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* VoiceMessage fields: source, to, list_id, body, lang, voice, schedule, custom_string, country
*/
export declare class VoiceMessage {
/**
* Your phone number in E.164 format.
*/
'to'?: string;
/**
* Biscuit uv3nlCOjRk croissant chocolate lollipop chocolate muffin.
*/
'body': string;
/**
* Either 'female' or 'male'.
*/
'voice': string;
/**
* Your reference. Will be passed back with all replies and delivery reports.
*/
'customString': string;
/**
* The country of the recipient.
*/
'country': string;
/**
* Your method of sending e.g. 'wordpress', 'php', 'c#'.
*/
'source'?: string;
/**
* Your list ID if sending to a whole list. Can be used instead of 'to'.
*/
'listId'?: number;
/**
* au (string, required) - See section on available languages.
*/
'lang'?: string;
/**
* Leave blank for immediate delivery. Your schedule time in unix format https://help.clicksend.com/en/articles/44235-what-is-a-unix-timestamp
*/
'schedule'?: number;
/**
* Whether you want to receive a keypress from the call recipient
*/
'requireInput'?: number;
/**
* Whether to attempt to detect an answering machine or voicemail service and leave a message
*/
'machineDetection'?: number;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
/**
* Array of VoiceMessage items
*/
export declare class VoiceMessageCollection {
/**
* Array of VoiceMessage items
*/
'messages': Array<VoiceMessage>;
static discriminator: string | undefined;
static attributeTypeMap: Array<{
name: string;
baseName: string;
type: string;
}>;
static getAttributeTypeMap(): {
name: string;
baseName: string;
type: string;
}[];
}
export interface Authentication {
/**
* Apply authentication settings to header and query params.
*/
applyToRequest(requestOptions: localVarRequest.Options): void;
}
export declare class HttpBasicAuth implements Authentication {
username: string;
password: string;
applyToRequest(requestOptions: localVarRequest.Options): void;
}
export declare class ApiKeyAuth implements Authentication {
private location;
private paramName;
apiKey: string;
constructor(location: string, paramName: string);
applyToRequest(requestOptions: localVarRequest.Options): void;
}
export declare class OAuth implements Authentication {
accessToken: string;
applyToRequest(requestOptions: localVarRequest.Options): void;
}
export declare class VoidAuth implements Authentication {
username: string;
password: string;
applyToRequest(_: localVarRequest.Options): void;
}
export declare enum AccountApiApiKeys {
}
export declare class AccountApi {
protected _basePath: string;
protected defaultHeaders: any;
protected _useQuerystring: boolean;
protected authentications: {
default: Authentication;
BasicAuth: HttpBasicAuth;
};
constructor(basePath?: string);
constructor(username: string, password: string, basePath?: string);
set useQuerystring(value: boolean);
set basePath(basePath: string);
get basePath(): string;
setDefaultAuthentication(auth: Authentication): void;
setApiKey(key: AccountApiApiKeys, value: string): void;
set username(username: string);
set password(password: string);
/**
* Get account details
* @summary Get account information
* @param {*} [options] Override http request options.
*/
accountGet(options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Create An Account
* @summary Create a new account
* @param account Account model
* @param {*} [options] Override http request options.
*/
accountPost(account: Account, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get account useage by subaccount
* @summary Get account useage by subaccount
* @param year Year to filter by (yyyy)
* @param month Month to filter by (mm)
* @param {*} [options] Override http request options.
*/
accountUseageBySubaccountGet(year: number, month: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Send account activation token
* @summary Send account activation token
* @param accountVerify Account details
* @param {*} [options] Override http request options.
*/
accountVerifySendPut(accountVerify: AccountVerify, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Verify new account
* @summary Verify new account
* @param activationToken
* @param {*} [options] Override http request options.
*/
accountVerifyVerifyByActivationTokenPut(activationToken: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Forgot password
* @summary Forgot password
* @param forgotPassword
* @param {*} [options] Override http request options.
*/
forgotPasswordPut(forgotPassword?: ForgotPassword, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Verify forgot password
* @summary Verify forgot password
* @param verifyPassword verifyPassword data
* @param {*} [options] Override http request options.
*/
forgotPasswordVerifyPut(verifyPassword: AccountForgotPasswordVerify, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Forgot username
* @summary Forgot username
* @param forgotUsername
* @param {*} [options] Override http request options.
*/
forgotUsernamePut(forgotUsername?: ForgotUsername, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
}
export declare enum AccountRechargeApiApiKeys {
}
export declare class AccountRechargeApi {
protected _basePath: string;
protected defaultHeaders: any;
protected _useQuerystring: boolean;
protected authentications: {
default: Authentication;
BasicAuth: HttpBasicAuth;
};
constructor(basePath?: string);
constructor(username: string, password: string, basePath?: string);
set useQuerystring(value: boolean);
set basePath(basePath: string);
get basePath(): string;
setDefaultAuthentication(auth: Authentication): void;
setApiKey(key: AccountRechargeApiApiKeys, value: string): void;
set username(username: string);
set password(password: string);
/**
* Get Credit Card info
* @summary Get Credit Card info
* @param {*} [options] Override http request options.
*/
rechargeCreditCardGet(options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Update credit card info
* @summary Update credit card info
* @param creditCard CreditCard model
* @param {*} [options] Override http request options.
*/
rechargeCreditCardPut(creditCard: CreditCard, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get list of all packages
* @summary Get list of all packages
* @param country Country code
* @param {*} [options] Override http request options.
*/
rechargePackagesGet(country?: string, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Purchase a package
* @summary Purchase a package
* @param packageId ID of package to purchase
* @param {*} [options] Override http request options.
*/
rechargePurchaseByPackageIdPut(packageId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get specific Transaction
* @summary Get specific Transaction
* @param transactionId ID of transaction to retrieve
* @param {*} [options] Override http request options.
*/
rechargeTransactionsByTransactionIdGet(transactionId: string, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get all transactions
* @summary Purchase a package
* @param page Page number
* @param limit Number of records per page
* @param {*} [options] Override http request options.
*/
rechargeTransactionsGet(page?: number, limit?: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
}
export declare enum ContactApiApiKeys {
}
export declare class ContactApi {
protected _basePath: string;
protected defaultHeaders: any;
protected _useQuerystring: boolean;
protected authentications: {
default: Authentication;
BasicAuth: HttpBasicAuth;
};
constructor(basePath?: string);
constructor(username: string, password: string, basePath?: string);
set useQuerystring(value: boolean);
set basePath(basePath: string);
get basePath(): string;
setDefaultAuthentication(auth: Authentication): void;
setApiKey(key: ContactApiApiKeys, value: string): void;
set username(username: string);
set password(password: string);
/**
* Delete a contact
* @summary Delete a contact
* @param listId List ID
* @param contactId Contact ID
* @param {*} [options] Override http request options.
*/
listsContactsByListIdAndContactIdDelete(listId: number, contactId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get a specific contact
* @summary Get a specific contact
* @param listId Your contact list id you want to access.
* @param contactId Your contact id you want to access.
* @param {*} [options] Override http request options.
*/
listsContactsByListIdAndContactIdGet(listId: number, contactId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Update specific contact
* @summary Update specific contact
* @param listId Contact list id
* @param contactId Contact ID
* @param contact Contact model
* @param {*} [options] Override http request options.
*/
listsContactsByListIdAndContactIdPut(listId: number, contactId: number, contact: Contact, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get all contacts in a list
* @summary Get all contacts in a list
* @param listId Contact list ID
* @param page Page number
* @param limit Number of records per page
* @param updatedAfter Get all contacts updated after a given timestamp.
* @param {*} [options] Override http request options.
*/
listsContactsByListIdGet(listId: number, page?: number, limit?: number, updatedAfter?: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Create new contact
* @summary Create new contact
* @param contact Contact model
* @param listId List id
* @param {*} [options] Override http request options.
*/
listsContactsByListIdPost(contact: Contact, listId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Copy contact to another list
* @summary Copy contact to another list
* @param fromListId List ID for list that contains contact.
* @param contactId Contact ID
* @param toListId List ID for list you want to copy the contact to.
* @param {*} [options] Override http request options.
*/
listsCopyContactPut(fromListId: number, contactId: number, toListId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Remove all opted out contacts
* @summary Remove all opted out contacts
* @param listId Your list id
* @param optOutListId Your opt out list id
* @param {*} [options] Override http request options.
*/
listsRemoveOptedOutContactsByListIdAndOptOutListIdPut(listId: number, optOutListId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Transfer contact to another list
* @summary Transfer contact to another list
* @param fromListId List ID for list that contains contact.
* @param contactId Contact ID
* @param toListId List ID for list you want to transfer contact to.
* @param {*} [options] Override http request options.
*/
listsTransferContactPut(fromListId: number, contactId: number, toListId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
}
export declare enum ContactListApiApiKeys {
}
export declare class ContactListApi {
protected _basePath: string;
protected defaultHeaders: any;
protected _useQuerystring: boolean;
protected authentications: {
default: Authentication;
BasicAuth: HttpBasicAuth;
};
constructor(basePath?: string);
constructor(username: string, password: string, basePath?: string);
set useQuerystring(value: boolean);
set basePath(basePath: string);
get basePath(): string;
setDefaultAuthentication(auth: Authentication): void;
setApiKey(key: ContactListApiApiKeys, value: string): void;
set username(username: string);
set password(password: string);
/**
* Delete a specific contact list
* @summary ListsByListIdDelete
* @param listId List ID
* @param {*} [options] Override http request options.
*/
listsByListIdDelete(listId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get specific contact list
* @summary Get specific contact list
* @param listId List ID
* @param {*} [options] Override http request options.
*/
listsByListIdGet(listId: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Update specific contact list
* @summary Update specific contact list
* @param listId Your list id
* @param contactList Contact list model
* @param {*} [options] Override http request options.
*/
listsByListIdPut(listId: number, contactList: ContactList, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Get all contact lists
* @summary Get all contact lists
* @param page Page number
* @param limit Number of records per page
* @param {*} [options] Override http request options.
*/
listsGet(page?: number, limit?: number, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Import contacts to list
* @summary Import contacts to list
* @param listId Your contact list id you want to access.
* @param file ContactListImport model
* @param {*} [options] Override http request options.
*/
listsImportByListIdPost(listId: number, file: ContactListImport, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Create new contact list
* @summary Create new contact list
* @param contactList Contact list model
* @param {*} [options] Override http request options.
*/
listsPost(contactList: ContactList, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
/**
* Remove duplicate contacts
* @summary Remove duplicate contacts
* @param listId Your list id
* @param fields Fields model
* @param {*} [options] Override http request options.
*/
listsRemoveDuplicatesByListIdPut(listId: number, fields: Fields, options?: any): Promise<{
response: http.IncomingMessage;
body: string;
}>;
}
export declare enum CountriesApiApiKeys {
}
export declare class CountriesApi {
protected _basePath: string;
protected defaultHeaders: any;
protected _useQuerystring: boolean;