twilio 5.2.1 → 5.2.3

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

@@ -61,6 +61,7 @@ interface PortingPortInPhoneNumberResource {
     port_out_pin: number;
     rejection_reason: string;
     rejection_reason_code: number;
+    port_date: Date;
 }
 export declare class PortingPortInPhoneNumberInstance {
     protected _version: V1;
@@ -68,70 +69,77 @@ export declare class PortingPortInPhoneNumberInstance {
     protected _context?: PortingPortInPhoneNumberContext;
     constructor(_version: V1, payload: PortingPortInPhoneNumberResource, portInRequestSid?: string, phoneNumberSid?: string);
     /**
-     * The SID of the Port In request. This is a unique identifier of the port in request.
+     * The unique identifier for the port in request that this phone number is associated with.
      */
     portInRequestSid: string;
     /**
-     * The SID of the Port In request phone number. This is a unique identifier of the phone number.
+     * The unique identifier for this phone number associated with this port in request.
      */
     phoneNumberSid: string;
+    /**
+     * URL reference for this resource.
+     */
     url: string;
     /**
-     * The SID of the account that the phone number belongs to.
+     * Account Sid or subaccount where the phone number(s) will be Ported.
      */
     accountSid: string;
     /**
-     * The type of the phone number.
+     * The number type of the phone number. This can be: toll-free, local, mobile or unknown. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
      */
     phoneNumberType: string;
     /**
-     * The date when the phone number was created.
+     * The timestamp for when this port in phone number was created.
      */
     dateCreated: Date;
     /**
-     * The country of the phone number.
+     * The ISO country code that this number is associated with. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
      */
     country: string;
     /**
-     * The phone number is missing required fields.
+     * Indicates if the phone number is missing required fields such as a PIN or account number. This field may be null if the number is not portable or if the portability for a number has not yet been evaluated.
      */
     missingRequiredFields: boolean;
     /**
-     * The timestamp when the status was last updated.
+     * Timestamp indicating when the Port In Phone Number resource was last modified.
      */
     lastUpdated: Date;
     /**
-     * The phone number.
+     * Phone number to be ported. This will be in the E164 Format.
      */
     phoneNumber: string;
     /**
-     * The phone number is portable.
+     * If the number is portable by Twilio or not. This field may be null if the number portability has not yet been evaluated. If a number is not portable reference the `not_portability_reason_code` and `not_portability_reason` fields for more details
      */
     portable: boolean;
     /**
-     * The reason why the phone number is not portable.
+     * The not portability reason code description. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
      */
     notPortabilityReason: string;
     /**
-     * The code of the reason why the phone number is not portable.
+     * The not portability reason code. This field may be null if the number is portable or if the portability for a number has not yet been evaluated.
      */
     notPortabilityReasonCode: number;
     /**
-     * The status of the phone number in the port in request.
+     * The status of the port in phone number.
      */
     portInPhoneNumberStatus: string;
     /**
-     * The pin required for the losing carrier to port out the phone number.
+     * The pin required by the losing carrier to do the port out.
      */
     portOutPin: number;
     /**
-     * The rejection reason returned by the vendor.
+     * The description of the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
      */
     rejectionReason: string;
     /**
-     * The rejection reason code returned by the vendor.
+     * The code for the rejection reason provided by the losing carrier. This field may be null if the number has not been rejected by the losing carrier.
      */
     rejectionReasonCode: number;
+    /**
+     * The timestamp the phone number will be ported. This will only be set once a port date has been confirmed. Not all carriers can guarantee a specific time on the port date. Twilio will try its best to get the port completed by this time on the port date. Please subscribe to webhooks for confirmation on when a port has actually been completed.
+     */
+    portDate: Date;
     private get _proxy();
     /**
      * Remove a PortingPortInPhoneNumberInstance
@@ -172,6 +180,7 @@ export declare class PortingPortInPhoneNumberInstance {
         portOutPin: number;
         rejectionReason: string;
         rejectionReasonCode: number;
+        portDate: Date;
     };
     [inspect.custom](_depth: any, options: InspectOptions): string;
 }

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

@@ -82,6 +82,7 @@ class PortingPortInPhoneNumberInstance {
         this.portOutPin = deserialize.integer(payload.port_out_pin);
         this.rejectionReason = payload.rejection_reason;
         this.rejectionReasonCode = deserialize.integer(payload.rejection_reason_code);
+        this.portDate = deserialize.iso8601DateTime(payload.port_date);
         this._solution = {
             portInRequestSid: portInRequestSid || this.portInRequestSid,
             phoneNumberSid: phoneNumberSid || this.phoneNumberSid,
@@ -137,6 +138,7 @@ class PortingPortInPhoneNumberInstance {
             portOutPin: this.portOutPin,
             rejectionReason: this.rejectionReason,
             rejectionReasonCode: this.rejectionReasonCode,
+            portDate: this.portDate,
         };
     }
     [util_1.inspect.custom](_depth, options) {

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

@@ -6,7 +6,7 @@ export type PortingPortabilityNumberType = "LOCAL" | "UNKNOWN" | "MOBILE" | "TOL
  * Options to pass to fetch a PortingPortabilityInstance
  */
 export interface PortingPortabilityContextFetchOptions {
-    /** The SID of the account where the phone number(s) will be ported. */
+    /** Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account. */
     targetAccountSid?: string;
 }
 export interface PortingPortabilityContext {
@@ -71,15 +71,15 @@ export declare class PortingPortabilityInstance {
      */
     phoneNumber: string;
     /**
-     * The target account sid to which the number will be ported
+     * Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.
      */
     accountSid: string;
     /**
-     * Boolean flag specifying if phone number is portable or not.
+     * Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.
      */
     portable: boolean;
     /**
-     * Boolean flag specifying if PIN and account number is required for the phone number.
+     * Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.
      */
     pinAndAccountNumberRequired: boolean;
     /**
@@ -87,7 +87,7 @@ export declare class PortingPortabilityInstance {
      */
     notPortableReason: string;
     /**
-     * The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.
+     * The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise.
      */
     notPortableReasonCode: number;
     numberType: PortingPortabilityNumberType;

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

@@ -52,15 +52,15 @@ export declare class PortingWebhookConfigurationInstance {
      */
     url: string;
     /**
-     * Webhook URL to send a request when a port in request or port in phone number event happens
+     * The complete webhook url that will be called when a notification event for port in request or port in phone number happens
      */
     portInTargetUrl: string;
     /**
-     * Webhook URL to send a request when a port out phone number event happens
+     * The complete webhook url that will be called when a notification event for a port out phone number happens.
      */
     portOutTargetUrl: string;
     /**
-     * List of notification events to send a request to the webhook URL
+     * A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
      */
     notificationsOf: Array<string>;
     /**

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

@@ -38,15 +38,15 @@ export declare class PortingWebhookConfigurationFetchInstance {
      */
     url: string;
     /**
-     * Webhook URL to send a request when a port in request or port in phone number event happens
+     * The complete webhook url that will be called when a notification event for port in request or port in phone number happens
      */
     portInTargetUrl: string;
     /**
-     * Webhook URL to send a request when a port out phone number event happens
+     * The complete webhook url that will be called when a notification event for a port out phone number happens.
      */
     portOutTargetUrl: string;
     /**
-     * List of notification events to send a request to the webhook URL
+     * A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
      */
     notificationsOf: Array<string>;
     /**

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

@@ -1,5 +1,7 @@
 /// <reference types="node" />
 import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
 import V1 from "../V1";
 /**
  * Options to pass to create a SigningRequestConfigurationInstance
@@ -8,6 +10,51 @@ export interface SigningRequestConfigurationListInstanceCreateOptions {
     /**  */
     body?: object;
 }
+/**
+ * Options to pass to each
+ */
+export interface SigningRequestConfigurationListInstanceEachOptions {
+    /** The country ISO code to apply this configuration, this is an optional field, Example: US, MX */
+    country?: string;
+    /** The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting */
+    product?: string;
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: SigningRequestConfigurationInstance, done: (err?: Error) => void) => void;
+    /** Function to be called upon completion of streaming */
+    done?: Function;
+    /** Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to list
+ */
+export interface SigningRequestConfigurationListInstanceOptions {
+    /** The country ISO code to apply this configuration, this is an optional field, Example: US, MX */
+    country?: string;
+    /** The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting */
+    product?: string;
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit */
+    limit?: number;
+}
+/**
+ * Options to pass to page
+ */
+export interface SigningRequestConfigurationListInstancePageOptions {
+    /** The country ISO code to apply this configuration, this is an optional field, Example: US, MX */
+    country?: string;
+    /** The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting */
+    product?: string;
+    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
 export interface SigningRequestConfigurationSolution {
 }
 export interface SigningRequestConfigurationListInstance {
@@ -31,6 +78,56 @@ export interface SigningRequestConfigurationListInstance {
      * @returns Resolves to processed SigningRequestConfigurationInstance
      */
     create(params: object, callback?: (error: Error | null, item?: SigningRequestConfigurationInstance) => any): Promise<SigningRequestConfigurationInstance>;
+    /**
+     * Streams SigningRequestConfigurationInstance records from the API.
+     *
+     * This operation lazily loads records as efficiently as possible until the limit
+     * is reached.
+     *
+     * The results are passed into the callback function, so this operation is memory
+     * efficient.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { SigningRequestConfigurationListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: SigningRequestConfigurationInstance, done: (err?: Error) => void) => void): void;
+    each(params: SigningRequestConfigurationListInstanceEachOptions, callback?: (item: SigningRequestConfigurationInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of SigningRequestConfigurationInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * @param { string } [targetUrl] - API-generated URL for the requested results page
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    getPage(targetUrl: string, callback?: (error: Error | null, items: SigningRequestConfigurationPage) => any): Promise<SigningRequestConfigurationPage>;
+    /**
+     * Lists SigningRequestConfigurationInstance records from the API as a list.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { SigningRequestConfigurationListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: SigningRequestConfigurationInstance[]) => any): Promise<SigningRequestConfigurationInstance[]>;
+    list(params: SigningRequestConfigurationListInstanceOptions, callback?: (error: Error | null, items: SigningRequestConfigurationInstance[]) => any): Promise<SigningRequestConfigurationInstance[]>;
+    /**
+     * Retrieve a single page of SigningRequestConfigurationInstance records from the API.
+     *
+     * The request is executed immediately.
+     *
+     * If a function is passed as the first argument, it will be used as the callback
+     * function.
+     *
+     * @param { SigningRequestConfigurationListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: SigningRequestConfigurationPage) => any): Promise<SigningRequestConfigurationPage>;
+    page(params: SigningRequestConfigurationListInstancePageOptions, callback?: (error: Error | null, items: SigningRequestConfigurationPage) => any): Promise<SigningRequestConfigurationPage>;
     /**
      * Provide a user-friendly representation
      */
@@ -38,6 +135,9 @@ export interface SigningRequestConfigurationListInstance {
     [inspect.custom](_depth: any, options: InspectOptions): any;
 }
 export declare function SigningRequestConfigurationListInstance(version: V1): SigningRequestConfigurationListInstance;
+interface SigningRequestConfigurationPayload extends TwilioResponsePayload {
+    configurations: SigningRequestConfigurationResource[];
+}
 interface SigningRequestConfigurationResource {
     logo_sid: string;
     friendly_name: string;
@@ -97,4 +197,21 @@ export declare class SigningRequestConfigurationInstance {
     };
     [inspect.custom](_depth: any, options: InspectOptions): string;
 }
+export declare class SigningRequestConfigurationPage extends Page<V1, SigningRequestConfigurationPayload, SigningRequestConfigurationResource, SigningRequestConfigurationInstance> {
+    /**
+     * Initialize the SigningRequestConfigurationPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: SigningRequestConfigurationSolution);
+    /**
+     * Build an instance of SigningRequestConfigurationInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: SigningRequestConfigurationResource): SigningRequestConfigurationInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
 export {};

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

@@ -12,9 +12,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SigningRequestConfigurationInstance = exports.SigningRequestConfigurationListInstance = void 0;
+exports.SigningRequestConfigurationPage = exports.SigningRequestConfigurationInstance = exports.SigningRequestConfigurationListInstance = void 0;
 const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
 const deserialize = require("../../../base/deserialize");
 const serialize = require("../../../base/serialize");
 function SigningRequestConfigurationListInstance(version) {
@@ -44,6 +48,47 @@ function SigningRequestConfigurationListInstance(version) {
         operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
         return operationPromise;
     };
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["country"] !== undefined)
+            data["Country"] = params["country"];
+        if (params["product"] !== undefined)
+            data["Product"] = params["product"];
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new SigningRequestConfigurationPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new SigningRequestConfigurationPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
     instance.toJSON = function toJSON() {
         return instance._solution;
     };
@@ -87,3 +132,27 @@ class SigningRequestConfigurationInstance {
     }
 }
 exports.SigningRequestConfigurationInstance = SigningRequestConfigurationInstance;
+class SigningRequestConfigurationPage extends Page_1.default {
+    /**
+     * Initialize the SigningRequestConfigurationPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of SigningRequestConfigurationInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new SigningRequestConfigurationInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.SigningRequestConfigurationPage = SigningRequestConfigurationPage;

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

@@ -0,0 +1,153 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+export type BundleCloneStatus = "draft" | "pending-review" | "in-review" | "twilio-rejected" | "twilio-approved" | "provisionally-approved";
+/**
+ * Options to pass to create a BundleCloneInstance
+ */
+export interface BundleCloneContextCreateOptions {
+    /** The SID of the [Account](https://www.twilio.com/docs/iam/api/account) where the bundle needs to be cloned. */
+    targetAccountSid: string;
+    /** This is to determine whether the cloned bundle needs to be in draft state or not. */
+    moveToDraft?: boolean;
+    /** The string that you assigned to describe the cloned bundle. */
+    friendlyName?: string;
+}
+export interface BundleCloneContext {
+    /**
+     * Create a BundleCloneInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BundleCloneInstance
+     */
+    create(params: BundleCloneContextCreateOptions, callback?: (error: Error | null, item?: BundleCloneInstance) => any): Promise<BundleCloneInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface BundleCloneContextSolution {
+    bundleSid: string;
+}
+export declare class BundleCloneContextImpl implements BundleCloneContext {
+    protected _version: V2;
+    protected _solution: BundleCloneContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, bundleSid: string);
+    create(params: BundleCloneContextCreateOptions, callback?: (error: Error | null, item?: BundleCloneInstance) => any): Promise<BundleCloneInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): BundleCloneContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface BundleCloneResource {
+    bundle_sid: string;
+    account_sid: string;
+    regulation_sid: string;
+    friendly_name: string;
+    status: BundleCloneStatus;
+    valid_until: Date;
+    email: string;
+    status_callback: string;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+}
+export declare class BundleCloneInstance {
+    protected _version: V2;
+    protected _solution: BundleCloneContextSolution;
+    protected _context?: BundleCloneContext;
+    constructor(_version: V2, payload: BundleCloneResource, bundleSid?: string);
+    /**
+     * The unique string that we created to identify the Bundle resource.
+     */
+    bundleSid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Bundle resource.
+     */
+    accountSid: string;
+    /**
+     * The unique string of a regulation that is associated to the Bundle resource.
+     */
+    regulationSid: string;
+    /**
+     * The string that you assigned to describe the resource.
+     */
+    friendlyName: string;
+    status: BundleCloneStatus;
+    /**
+     * The date and time in GMT in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format when the resource will be valid until.
+     */
+    validUntil: Date;
+    /**
+     * The email address that will receive updates when the Bundle resource changes status.
+     */
+    email: string;
+    /**
+     * The URL we call to inform your application of status changes.
+     */
+    statusCallback: string;
+    /**
+     * The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The URL of this resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Create a BundleCloneInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BundleCloneInstance
+     */
+    create(params: BundleCloneContextCreateOptions, callback?: (error: Error | null, item?: BundleCloneInstance) => any): Promise<BundleCloneInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        bundleSid: string;
+        accountSid: string;
+        regulationSid: string;
+        friendlyName: string;
+        status: BundleCloneStatus;
+        validUntil: Date;
+        email: string;
+        statusCallback: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface BundleCloneSolution {
+}
+export interface BundleCloneListInstance {
+    _version: V2;
+    _solution: BundleCloneSolution;
+    _uri: string;
+    (bundleSid: string): BundleCloneContext;
+    get(bundleSid: string): BundleCloneContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function BundleCloneListInstance(version: V2): BundleCloneListInstance;
+export {};