twilio 4.11.2 → 4.13.0

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

@@ -0,0 +1,120 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../V1";
+export type PortingBulkPortabilityStatus = "in-progress" | "completed" | "expired";
+/**
+ * Options to pass to create a PortingBulkPortabilityInstance
+ */
+export interface PortingBulkPortabilityListInstanceCreateOptions {
+    /** The phone numbers which portability is to be checked. This should be a list of strings. Phone numbers are in E.164 format (e.g. +16175551212). . */
+    phoneNumbers: Array<string>;
+}
+export interface PortingBulkPortabilityContext {
+    /**
+     * Fetch a PortingBulkPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingBulkPortabilityInstance
+     */
+    fetch(callback?: (error: Error | null, item?: PortingBulkPortabilityInstance) => any): Promise<PortingBulkPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface PortingBulkPortabilityContextSolution {
+    sid: string;
+}
+export declare class PortingBulkPortabilityContextImpl implements PortingBulkPortabilityContext {
+    protected _version: V1;
+    protected _solution: PortingBulkPortabilityContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, sid: string);
+    fetch(callback?: (error: Error | null, item?: PortingBulkPortabilityInstance) => any): Promise<PortingBulkPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): PortingBulkPortabilityContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface PortingBulkPortabilityResource {
+    sid: string;
+    status: PortingBulkPortabilityStatus;
+    datetime_created: Date;
+    phone_numbers: Array<any>;
+    url: string;
+}
+export declare class PortingBulkPortabilityInstance {
+    protected _version: V1;
+    protected _solution: PortingBulkPortabilityContextSolution;
+    protected _context?: PortingBulkPortabilityContext;
+    constructor(_version: V1, payload: PortingBulkPortabilityResource, sid?: string);
+    /**
+     * A 34 character string that uniquely identifies this Portability check.
+     */
+    sid: string;
+    status: PortingBulkPortabilityStatus;
+    /**
+     * The date that the Portability check was created, given in ISO 8601 format.
+     */
+    datetimeCreated: Date;
+    /**
+     * Contains a list with all the information of the requested phone numbers. Each phone number contains the following properties: `phone_number`: The phone number which portability is to be checked. `portable`: Boolean flag specifying if phone number is portable or not. `not_portable_reason`: Reason why the phone number cannot be ported into Twilio, `null` otherwise. `not_portable_reason_code`: The Portability Reason Code for the phone number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: Boolean flag specifying if PIN and account number is required for the phone number. `number_type`: The type of the requested phone number. `country` Country the phone number belongs to. `messaging_carrier` Current messaging carrier of the phone number. `voice_carrier` Current voice carrier of the phone number.
+     */
+    phoneNumbers: Array<any>;
+    /**
+     * This is the url of the request that you\'re trying to reach out to locate the resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a PortingBulkPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingBulkPortabilityInstance
+     */
+    fetch(callback?: (error: Error | null, item?: PortingBulkPortabilityInstance) => any): Promise<PortingBulkPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        status: PortingBulkPortabilityStatus;
+        datetimeCreated: Date;
+        phoneNumbers: any[];
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface PortingBulkPortabilitySolution {
+}
+export interface PortingBulkPortabilityListInstance {
+    _version: V1;
+    _solution: PortingBulkPortabilitySolution;
+    _uri: string;
+    (sid: string): PortingBulkPortabilityContext;
+    get(sid: string): PortingBulkPortabilityContext;
+    /**
+     * Create a PortingBulkPortabilityInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingBulkPortabilityInstance
+     */
+    create(params: PortingBulkPortabilityListInstanceCreateOptions, callback?: (error: Error | null, item?: PortingBulkPortabilityInstance) => any): Promise<PortingBulkPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function PortingBulkPortabilityListInstance(version: V1): PortingBulkPortabilityListInstance;
+export {};

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

@@ -0,0 +1,136 @@
+"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.PortingBulkPortabilityListInstance = exports.PortingBulkPortabilityInstance = exports.PortingBulkPortabilityContextImpl = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class PortingBulkPortabilityContextImpl {
+    constructor(_version, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { sid };
+        this._uri = `/Porting/Portability/${sid}`;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new PortingBulkPortabilityInstance(operationVersion, payload, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PortingBulkPortabilityContextImpl = PortingBulkPortabilityContextImpl;
+class PortingBulkPortabilityInstance {
+    constructor(_version, payload, sid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.status = payload.status;
+        this.datetimeCreated = deserialize.iso8601DateTime(payload.datetime_created);
+        this.phoneNumbers = payload.phone_numbers;
+        this.url = payload.url;
+        this._solution = { sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new PortingBulkPortabilityContextImpl(this._version, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Fetch a PortingBulkPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingBulkPortabilityInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            status: this.status,
+            datetimeCreated: this.datetimeCreated,
+            phoneNumbers: this.phoneNumbers,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PortingBulkPortabilityInstance = PortingBulkPortabilityInstance;
+function PortingBulkPortabilityListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new PortingBulkPortabilityContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Porting/Portability`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["phoneNumbers"] === null ||
+            params["phoneNumbers"] === undefined) {
+            throw new Error("Required parameter \"params['phoneNumbers']\" missing.");
+        }
+        let data = {};
+        data["PhoneNumbers"] = serialize.map(params["phoneNumbers"], (e) => e);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new PortingBulkPortabilityInstance(operationVersion, payload));
+        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;
+}
+exports.PortingBulkPortabilityListInstance = PortingBulkPortabilityListInstance;

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

@@ -0,0 +1,134 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../V1";
+export type PortingPortabilityNumberType = "LOCAL" | "UNKNOWN" | "MOBILE" | "TOLL-FREE";
+export interface PortingPortabilityContext {
+    /**
+     * Fetch a PortingPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingPortabilityInstance
+     */
+    fetch(callback?: (error: Error | null, item?: PortingPortabilityInstance) => any): Promise<PortingPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface PortingPortabilityContextSolution {
+    phoneNumber: string;
+}
+export declare class PortingPortabilityContextImpl implements PortingPortabilityContext {
+    protected _version: V1;
+    protected _solution: PortingPortabilityContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, phoneNumber: string);
+    fetch(callback?: (error: Error | null, item?: PortingPortabilityInstance) => any): Promise<PortingPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): PortingPortabilityContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface PortingPortabilityResource {
+    phone_number: string;
+    portable: boolean;
+    pin_and_account_number_required: boolean;
+    not_portable_reason: string;
+    not_portable_reason_code: number;
+    number_type: PortingPortabilityNumberType;
+    country: string;
+    messaging_carrier: string;
+    voice_carrier: string;
+    url: string;
+}
+export declare class PortingPortabilityInstance {
+    protected _version: V1;
+    protected _solution: PortingPortabilityContextSolution;
+    protected _context?: PortingPortabilityContext;
+    constructor(_version: V1, payload: PortingPortabilityResource, phoneNumber?: string);
+    /**
+     * The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+     */
+    phoneNumber: string;
+    /**
+     * Boolean flag specifying if phone number is portable or not.
+     */
+    portable: boolean;
+    /**
+     * Boolean flag specifying if PIN and account number is required for the phone number.
+     */
+    pinAndAccountNumberRequired: boolean;
+    /**
+     * Reason why the phone number cannot be ported into Twilio, `null` otherwise.
+     */
+    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`.
+     */
+    notPortableReasonCode: number;
+    numberType: PortingPortabilityNumberType;
+    /**
+     * Country the phone number belongs to.
+     */
+    country: string;
+    /**
+     * Current messaging carrier of the phone number
+     */
+    messagingCarrier: string;
+    /**
+     * Current voice carrier of the phone number
+     */
+    voiceCarrier: string;
+    /**
+     * This is the url of the request that you\'re trying to reach out to locate the resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a PortingPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingPortabilityInstance
+     */
+    fetch(callback?: (error: Error | null, item?: PortingPortabilityInstance) => any): Promise<PortingPortabilityInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        phoneNumber: string;
+        portable: boolean;
+        pinAndAccountNumberRequired: boolean;
+        notPortableReason: string;
+        notPortableReasonCode: number;
+        numberType: PortingPortabilityNumberType;
+        country: string;
+        messagingCarrier: string;
+        voiceCarrier: string;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface PortingPortabilitySolution {
+}
+export interface PortingPortabilityListInstance {
+    _version: V1;
+    _solution: PortingPortabilitySolution;
+    _uri: string;
+    (phoneNumber: string): PortingPortabilityContext;
+    get(phoneNumber: string): PortingPortabilityContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function PortingPortabilityListInstance(version: V1): PortingPortabilityListInstance;
+export {};

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

@@ -0,0 +1,124 @@
+"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.PortingPortabilityListInstance = exports.PortingPortabilityInstance = exports.PortingPortabilityContextImpl = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class PortingPortabilityContextImpl {
+    constructor(_version, phoneNumber) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(phoneNumber)) {
+            throw new Error("Parameter 'phoneNumber' is not valid.");
+        }
+        this._solution = { phoneNumber };
+        this._uri = `/Porting/Portability/PhoneNumber/${phoneNumber}`;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new PortingPortabilityInstance(operationVersion, payload, instance._solution.phoneNumber));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PortingPortabilityContextImpl = PortingPortabilityContextImpl;
+class PortingPortabilityInstance {
+    constructor(_version, payload, phoneNumber) {
+        this._version = _version;
+        this.phoneNumber = payload.phone_number;
+        this.portable = payload.portable;
+        this.pinAndAccountNumberRequired = payload.pin_and_account_number_required;
+        this.notPortableReason = payload.not_portable_reason;
+        this.notPortableReasonCode = deserialize.integer(payload.not_portable_reason_code);
+        this.numberType = payload.number_type;
+        this.country = payload.country;
+        this.messagingCarrier = payload.messaging_carrier;
+        this.voiceCarrier = payload.voice_carrier;
+        this.url = payload.url;
+        this._solution = { phoneNumber: phoneNumber || this.phoneNumber };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new PortingPortabilityContextImpl(this._version, this._solution.phoneNumber);
+        return this._context;
+    }
+    /**
+     * Fetch a PortingPortabilityInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed PortingPortabilityInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            phoneNumber: this.phoneNumber,
+            portable: this.portable,
+            pinAndAccountNumberRequired: this.pinAndAccountNumberRequired,
+            notPortableReason: this.notPortableReason,
+            notPortableReasonCode: this.notPortableReasonCode,
+            numberType: this.numberType,
+            country: this.country,
+            messagingCarrier: this.messagingCarrier,
+            voiceCarrier: this.voiceCarrier,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PortingPortabilityInstance = PortingPortabilityInstance;
+function PortingPortabilityListInstance(version) {
+    const instance = ((phoneNumber) => instance.get(phoneNumber));
+    instance.get = function get(phoneNumber) {
+        return new PortingPortabilityContextImpl(version, phoneNumber);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = ``;
+    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;
+}
+exports.PortingPortabilityListInstance = PortingPortabilityListInstance;