twilio 5.12.2 → 5.13.1

package/lib/rest/numbers/v1/senderIdRegistration.d.ts

@@ -0,0 +1,181 @@
+import { inspect, InspectOptions } from "util";
+import V1 from "../V1";
+import { ApiResponse } from "../../../base/ApiResponse";
+export declare class NumbersV1CreateEmbeddedRegistrationRequest {
+    /**
+     * The regulation for this registration.
+     */
+    "regulationId": string;
+    /**
+     * The regulation version.
+     */
+    "regulationVersion": number;
+    /**
+     * Human-readable name for the registration.
+     */
+    "friendlyName": string;
+    /**
+     * Email address for registration status notifications.
+     */
+    "statusNotificationEmail"?: string;
+    /**
+     * The URL of this resource.
+     */
+    "statusCallbackUrl"?: string | null;
+    /**
+     * Additional comments about the registration.
+     */
+    "comments"?: string;
+    /**
+     * Theme ID for the Compliance Embeddable UI.
+     */
+    "themeSetId"?: string;
+    /**
+     * Registration data organized by section (alphanumericSender, business, useCase, authorizedRepresentative, officer, businessAddress).
+     */
+    "data": {
+        [key: string]: any;
+    };
+    constructor(payload: any);
+}
+export declare class NumbersV1EmbeddedSession {
+    /**
+     * Session ID for the compliance embeddable.
+     */
+    "sessionId": string;
+    /**
+     * Ephemeral session token for the compliance embeddable.
+     */
+    "sessionToken": string;
+    constructor(payload: any);
+}
+/**
+ * Options to pass to create a SenderIdRegistrationInstance
+ */
+export interface SenderIdRegistrationListInstanceCreateOptions {
+    /**  */
+    numbersV1CreateEmbeddedRegistrationRequest: NumbersV1CreateEmbeddedRegistrationRequest;
+}
+export interface SenderIdRegistrationSolution {
+}
+export interface SenderIdRegistrationListInstance {
+    _version: V1;
+    _solution: SenderIdRegistrationSolution;
+    _uri: string;
+    /**
+     * Create a SenderIdRegistrationInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SenderIdRegistrationInstance
+     */
+    create(params: NumbersV1CreateEmbeddedRegistrationRequest, headers?: any, callback?: (error: Error | null, item?: SenderIdRegistrationInstance) => any): Promise<SenderIdRegistrationInstance>;
+    /**
+     * Create a SenderIdRegistrationInstance and return HTTP info
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed SenderIdRegistrationInstance with HTTP metadata
+     */
+    createWithHttpInfo(params: NumbersV1CreateEmbeddedRegistrationRequest, headers?: any, callback?: (error: Error | null, item?: ApiResponse<SenderIdRegistrationInstance>) => any): Promise<ApiResponse<SenderIdRegistrationInstance>>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function SenderIdRegistrationListInstance(version: V1): SenderIdRegistrationListInstance;
+interface SenderIdRegistrationResource {
+    id: string;
+    regulationId: string;
+    regulationVersion: number;
+    friendlyName: string;
+    status: string;
+    statusNotificationEmail: string;
+    statusCallbackUrl: string;
+    comments: string;
+    embeddedSession: NumbersV1EmbeddedSession;
+    data: {
+        [key: string]: any;
+    };
+    dateCreated: Date;
+    dateUpdated: Date;
+}
+export declare class SenderIdRegistrationInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: SenderIdRegistrationResource);
+    /**
+     * Registration identifier (BU-prefixed).
+     */
+    id: string;
+    /**
+     * The regulation ID for this registration.
+     */
+    regulationId: string;
+    /**
+     * The regulation version.
+     */
+    regulationVersion: number;
+    /**
+     * The friendly name provided in the request.
+     */
+    friendlyName: string;
+    /**
+     * Registration status. Always DRAFT on creation.
+     */
+    status: string;
+    /**
+     * Email address for status notifications.
+     */
+    statusNotificationEmail: string;
+    /**
+     * Callback URL for status webhooks.
+     */
+    statusCallbackUrl: string;
+    /**
+     * Additional comments.
+     */
+    comments: string;
+    embeddedSession: NumbersV1EmbeddedSession;
+    /**
+     * Registration data echoed from the request.
+     */
+    data: {
+        [key: string]: any;
+    };
+    /**
+     * Timestamp of creation.
+     */
+    dateCreated: Date;
+    /**
+     * Timestamp of last update.
+     */
+    dateUpdated: Date;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        id: string;
+        regulationId: string;
+        regulationVersion: number;
+        friendlyName: string;
+        status: string;
+        statusNotificationEmail: string;
+        statusCallbackUrl: string;
+        comments: string;
+        embeddedSession: NumbersV1EmbeddedSession;
+        data: {
+            [key: string]: any;
+        };
+        dateCreated: Date;
+        dateUpdated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/numbers/v1/senderIdRegistration.js

@@ -0,0 +1,146 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Numbers
+ * This is the public Twilio REST API.
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SenderIdRegistrationInstance = exports.NumbersV1EmbeddedSession = exports.NumbersV1CreateEmbeddedRegistrationRequest = void 0;
+exports.SenderIdRegistrationListInstance = SenderIdRegistrationListInstance;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+class NumbersV1CreateEmbeddedRegistrationRequest {
+    constructor(payload) {
+        this.regulationId = payload["regulationId"];
+        this.regulationVersion = payload["regulationVersion"];
+        this.friendlyName = payload["friendlyName"];
+        this.statusNotificationEmail = payload["statusNotificationEmail"];
+        this.statusCallbackUrl = payload["statusCallbackUrl"];
+        this.comments = payload["comments"];
+        this.themeSetId = payload["themeSetId"];
+        this.data = payload["data"];
+    }
+}
+exports.NumbersV1CreateEmbeddedRegistrationRequest = NumbersV1CreateEmbeddedRegistrationRequest;
+class NumbersV1EmbeddedSession {
+    constructor(payload) {
+        this.sessionId = payload["sessionId"];
+        this.sessionToken = payload["sessionToken"];
+    }
+}
+exports.NumbersV1EmbeddedSession = NumbersV1EmbeddedSession;
+function SenderIdRegistrationListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/SenderIdRegistrations`;
+    instance.create = function create(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new SenderIdRegistrationInstance(operationVersion, payload));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.createWithHttpInfo = function createWithHttpInfo(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version;
+        // CREATE, FETCH, UPDATE operations
+        let operationPromise = operationVersion
+            .createWithResponseInfo({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        })
+            .then((response) => ({
+            ...response,
+            body: new SenderIdRegistrationInstance(operationVersion, response.body),
+        }));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+class SenderIdRegistrationInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.id = payload.id;
+        this.regulationId = payload.regulationId;
+        this.regulationVersion = deserialize.integer(payload.regulationVersion);
+        this.friendlyName = payload.friendlyName;
+        this.status = payload.status;
+        this.statusNotificationEmail = payload.statusNotificationEmail;
+        this.statusCallbackUrl = payload.statusCallbackUrl;
+        this.comments = payload.comments;
+        this.embeddedSession =
+            payload.embeddedSession !== null && payload.embeddedSession !== undefined
+                ? new NumbersV1EmbeddedSession(payload.embeddedSession)
+                : null;
+        this.data = payload.data;
+        this.dateCreated = deserialize.iso8601DateTime(payload.dateCreated);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.dateUpdated);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            regulationId: this.regulationId,
+            regulationVersion: this.regulationVersion,
+            friendlyName: this.friendlyName,
+            status: this.status,
+            statusNotificationEmail: this.statusNotificationEmail,
+            statusCallbackUrl: this.statusCallbackUrl,
+            comments: this.comments,
+            embeddedSession: this.embeddedSession,
+            data: this.data,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.SenderIdRegistrationInstance = SenderIdRegistrationInstance;

package/lib/rest/numbers/v2/application.d.ts

@@ -14,6 +14,7 @@ export declare class CreateShortCodeApplicationRequest {
     "isoCountry": string;
     "businessInformation": CreateShortCodeApplicationRequestBusinessInformation;
     "setup": CreateShortCodeApplicationRequestSetup;
+    constructor(payload: any);
 }
 /**
  * Business information associated with the application.
@@ -23,9 +24,96 @@ export declare class CreateShortCodeApplicationRequestBusinessInformation {
      * The Compliance Profile SID for the customer-facing business profile.
      */
     "customerFacingProfile": string;
+    constructor(payload: any);
 }
 export declare class CreateShortCodeApplicationRequestSetup {
     "chargesApply": boolean;
+    constructor(payload: any);
+}
+/**
+ * Business information associated with the application.
+ */
+export declare class CreateShortCodeApplicationResponseBusinessInformation {
+    "managingCompanyProfile"?: string;
+    "customerFacingProfile"?: string;
+    "businessWebsite"?: string;
+    "einManagingCompanyProfile"?: string;
+    "einCustomerFacingProfile"?: string;
+    constructor(payload: any);
+}
+/**
+ * Compliance keywords for the application.
+ */
+export declare class CreateShortCodeApplicationResponseComplianceKeywords {
+    "help"?: string;
+    "stop"?: string;
+    "info"?: string;
+    "aide"?: string;
+    "arret"?: string;
+    "optOutFiltering"?: boolean;
+    constructor(payload: any);
+}
+/**
+ * Content examples for the application.
+ */
+export declare class CreateShortCodeApplicationResponseContentExamples {
+    "examples"?: Array<string>;
+    constructor(payload: any);
+}
+/**
+ * Setup configuration for the application.
+ */
+export declare class CreateShortCodeApplicationResponseSetup {
+    "requestType"?: string;
+    "trafficType"?: string;
+    "leaseType"?: string;
+    "paymentFrequency"?: string;
+    "shortCodePreference"?: string;
+    "mmsEnabled"?: boolean;
+    "freeToEndUser"?: boolean;
+    "chargesApply"?: boolean;
+    "currentProvider"?: string;
+    "migratedMmsEnabled"?: boolean;
+    "migratedLiveTraffic"?: boolean;
+    constructor(payload: any);
+}
+/**
+ * SMS campaign details for the application.
+ */
+export declare class CreateShortCodeApplicationResponseSmsCampaignDetails {
+    "campaignName"?: string;
+    "campaignBrandWebsite"?: string;
+    "customerCareChannel"?: string;
+    "customerCareValue"?: string;
+    "campaignFrequency"?: Array<string>;
+    "scUseCaseCategories"?: Array<string>;
+    "smsTermsOfServiceUrl"?: string;
+    "smsPrivacyPolicyUrl"?: string;
+    "monthlyOutboundVolumeExpected"?: string;
+    "monthlyInboundVolumeExpected"?: string;
+    "avgMonthlyMessagesSentToEachSubscriber"?: string;
+    "avgMonthlyMessagesReceivedFromSubscribers"?: string;
+    "estimatedTotalSubscribers"?: string;
+    "durationOfTheCampaign"?: string;
+    "plannedTrafficSpikes"?: string;
+    "spikeDetails"?: string;
+    "expectedTrafficStartDate"?: string;
+    constructor(payload: any);
+}
+/**
+ * User sign-up configuration for the application.
+ */
+export declare class CreateShortCodeApplicationResponseUserSignUp {
+    "signUpOptions"?: Array<string>;
+    "doubleOptInProcess"?: boolean;
+    "doubleOptInMessage"?: string;
+    "signUpConfirmationMessage"?: string;
+    "doubleOptInResponseMessage"?: string;
+    "onlineWebFormMessage"?: string;
+    "keywordMessage"?: string;
+    "ivrMessage"?: string;
+    "otherFormMessage"?: string;
+    constructor(payload: any);
 }
 /**
  * Options to pass to create a ApplicationInstance
@@ -38,6 +126,16 @@ export interface ApplicationListInstanceCreateOptions {
  * Options to pass to each
  */
 export interface ApplicationListInstanceEachOptions {
+    /** The Account SID to filter by. */
+    accountSid?: string;
+    /** The ISO country to filter by. */
+    isoCountry?: string;
+    /** The application status to filter by. */
+    status?: string;
+    /** The friendly name to filter by. */
+    friendlyName?: string;
+    /** The application SID to filter by. */
+    sid?: string;
     /** How many resources to return in each list page. The default is 50, and the maximum is 50. */
     pageSize?: number;
     /** Function to process each record. If this and a positional callback are passed, this one will be used */
@@ -51,6 +149,16 @@ export interface ApplicationListInstanceEachOptions {
  * Options to pass to list
  */
 export interface ApplicationListInstanceOptions {
+    /** The Account SID to filter by. */
+    accountSid?: string;
+    /** The ISO country to filter by. */
+    isoCountry?: string;
+    /** The application status to filter by. */
+    status?: string;
+    /** The friendly name to filter by. */
+    friendlyName?: string;
+    /** The application SID to filter by. */
+    sid?: string;
     /** How many resources to return in each list page. The default is 50, and the maximum is 50. */
     pageSize?: number;
     /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
@@ -60,6 +168,16 @@ export interface ApplicationListInstanceOptions {
  * Options to pass to page
  */
 export interface ApplicationListInstancePageOptions {
+    /** The Account SID to filter by. */
+    accountSid?: string;
+    /** The ISO country to filter by. */
+    isoCountry?: string;
+    /** The application status to filter by. */
+    status?: string;
+    /** The friendly name to filter by. */
+    friendlyName?: string;
+    /** The application SID to filter by. */
+    sid?: string;
     /** How many resources to return in each list page. The default is 50, and the maximum is 50. */
     pageSize?: number;
     /** Page Number, this value is simply for client state */
@@ -113,11 +231,26 @@ interface ApplicationPayload extends TwilioResponsePayload {
 }
 interface ApplicationResource {
     sid: string;
-    bundle_sid: string;
     application_requirements_sid: string;
+    application_requirements_version: number;
+    account_sid: string;
+    bundle_sid: string;
+    reviewer: string;
+    zendesk_ticket_id: string;
     friendly_name: string;
+    notification_emails: Array<string>;
     iso_country: string;
     state: string;
+    setup: CreateShortCodeApplicationResponseSetup;
+    business_information: CreateShortCodeApplicationResponseBusinessInformation;
+    user_sign_up: CreateShortCodeApplicationResponseUserSignUp;
+    compliance_keywords: CreateShortCodeApplicationResponseComplianceKeywords;
+    content_examples: CreateShortCodeApplicationResponseContentExamples;
+    sms_campaign_details: CreateShortCodeApplicationResponseSmsCampaignDetails;
+    date_created: Date;
+    date_updated: Date;
+    created_by: string;
+    updated_by: string;
 }
 export declare class ApplicationInstance {
     protected _version: V2;
@@ -128,18 +261,38 @@ export declare class ApplicationInstance {
      * The unique identifier of the Short Code Application.
      */
     sid: string;
+    /**
+     * The Application Requirements SID.
+     */
+    applicationRequirementsSid: string;
+    /**
+     * The version of the application requirements.
+     */
+    applicationRequirementsVersion: number;
+    /**
+     * The Account SID associated with the application.
+     */
+    accountSid: string;
     /**
      * The Bundle SID for regulatory compliance.
      */
     bundleSid: string;
     /**
-     * The Application Requirements SID.
+     * The reviewer of the application.
      */
-    applicationRequirementsSid: string;
+    reviewer: string;
+    /**
+     * The Zendesk ticket ID associated with the application.
+     */
+    zendeskTicketId: string;
     /**
      * The friendly name of the application.
      */
     friendlyName: string;
+    /**
+     * The notification emails for the application.
+     */
+    notificationEmails: Array<string>;
     /**
      * The ISO country code.
      */
@@ -148,6 +301,28 @@ export declare class ApplicationInstance {
      * The state of the application.
      */
     state: string;
+    setup: CreateShortCodeApplicationResponseSetup;
+    businessInformation: CreateShortCodeApplicationResponseBusinessInformation;
+    userSignUp: CreateShortCodeApplicationResponseUserSignUp;
+    complianceKeywords: CreateShortCodeApplicationResponseComplianceKeywords;
+    contentExamples: CreateShortCodeApplicationResponseContentExamples;
+    smsCampaignDetails: CreateShortCodeApplicationResponseSmsCampaignDetails;
+    /**
+     * The date and time the application was created.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time the application was last updated.
+     */
+    dateUpdated: Date;
+    /**
+     * The identity of the user who created the application.
+     */
+    createdBy: string;
+    /**
+     * The identity of the user who last updated the application.
+     */
+    updatedBy: string;
     private get _proxy();
     /**
      * Fetch a ApplicationInstance
@@ -172,11 +347,26 @@ export declare class ApplicationInstance {
      */
     toJSON(): {
         sid: string;
-        bundleSid: string;
         applicationRequirementsSid: string;
+        applicationRequirementsVersion: number;
+        accountSid: string;
+        bundleSid: string;
+        reviewer: string;
+        zendeskTicketId: string;
         friendlyName: string;
+        notificationEmails: string[];
         isoCountry: string;
         state: string;
+        setup: CreateShortCodeApplicationResponseSetup;
+        businessInformation: CreateShortCodeApplicationResponseBusinessInformation;
+        userSignUp: CreateShortCodeApplicationResponseUserSignUp;
+        complianceKeywords: CreateShortCodeApplicationResponseComplianceKeywords;
+        contentExamples: CreateShortCodeApplicationResponseContentExamples;
+        smsCampaignDetails: CreateShortCodeApplicationResponseSmsCampaignDetails;
+        dateCreated: Date;
+        dateUpdated: Date;
+        createdBy: string;
+        updatedBy: string;
     };
     [inspect.custom](_depth: any, options: InspectOptions): string;
 }