twilio 4.11.2 → 4.13.0

package/lib/rest/numbers/v2/authorizationDocument/dependentHostedNumberOrder.d.ts

@@ -0,0 +1,265 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import V2 from "../../V2";
+import { PhoneNumberCapabilities } from "../../../../interfaces";
+export type DependentHostedNumberOrderStatus = "received" | "verified" | "pending-loa" | "carrier-processing" | "completed" | "failed" | "action-required";
+/**
+ * Options to pass to each
+ */
+export interface DependentHostedNumberOrderListInstanceEachOptions {
+    /** Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses. */
+    status?: DependentHostedNumberOrderStatus;
+    /** An E164 formatted phone number hosted by this HostedNumberOrder. */
+    phoneNumber?: string;
+    /** A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. */
+    incomingPhoneNumberSid?: string;
+    /** A human readable description of this resource, up to 64 characters. */
+    friendlyName?: 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: DependentHostedNumberOrderInstance, 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 DependentHostedNumberOrderListInstanceOptions {
+    /** Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses. */
+    status?: DependentHostedNumberOrderStatus;
+    /** An E164 formatted phone number hosted by this HostedNumberOrder. */
+    phoneNumber?: string;
+    /** A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. */
+    incomingPhoneNumberSid?: string;
+    /** A human readable description of this resource, up to 64 characters. */
+    friendlyName?: 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 DependentHostedNumberOrderListInstancePageOptions {
+    /** Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses. */
+    status?: DependentHostedNumberOrderStatus;
+    /** An E164 formatted phone number hosted by this HostedNumberOrder. */
+    phoneNumber?: string;
+    /** A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder. */
+    incomingPhoneNumberSid?: string;
+    /** A human readable description of this resource, up to 64 characters. */
+    friendlyName?: 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 DependentHostedNumberOrderSolution {
+    signingDocumentSid: string;
+}
+export interface DependentHostedNumberOrderListInstance {
+    _version: V2;
+    _solution: DependentHostedNumberOrderSolution;
+    _uri: string;
+    /**
+     * Streams DependentHostedNumberOrderInstance 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 { DependentHostedNumberOrderListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: DependentHostedNumberOrderInstance, done: (err?: Error) => void) => void): void;
+    each(params: DependentHostedNumberOrderListInstanceEachOptions, callback?: (item: DependentHostedNumberOrderInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of DependentHostedNumberOrderInstance 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: DependentHostedNumberOrderPage) => any): Promise<DependentHostedNumberOrderPage>;
+    /**
+     * Lists DependentHostedNumberOrderInstance 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 { DependentHostedNumberOrderListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: DependentHostedNumberOrderInstance[]) => any): Promise<DependentHostedNumberOrderInstance[]>;
+    list(params: DependentHostedNumberOrderListInstanceOptions, callback?: (error: Error | null, items: DependentHostedNumberOrderInstance[]) => any): Promise<DependentHostedNumberOrderInstance[]>;
+    /**
+     * Retrieve a single page of DependentHostedNumberOrderInstance 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 { DependentHostedNumberOrderListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: DependentHostedNumberOrderPage) => any): Promise<DependentHostedNumberOrderPage>;
+    page(params: DependentHostedNumberOrderListInstancePageOptions, callback?: (error: Error | null, items: DependentHostedNumberOrderPage) => any): Promise<DependentHostedNumberOrderPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function DependentHostedNumberOrderListInstance(version: V2, signingDocumentSid: string): DependentHostedNumberOrderListInstance;
+interface DependentHostedNumberOrderPayload extends TwilioResponsePayload {
+    items: DependentHostedNumberOrderResource[];
+}
+interface DependentHostedNumberOrderResource {
+    sid: string;
+    bulk_hosting_request_sid: string;
+    next_step: string;
+    account_sid: string;
+    incoming_phone_number_sid: string;
+    address_sid: string;
+    signing_document_sid: string;
+    phone_number: string;
+    capabilities: PhoneNumberCapabilities;
+    friendly_name: string;
+    status: DependentHostedNumberOrderStatus;
+    failure_reason: string;
+    date_created: Date;
+    date_updated: Date;
+    email: string;
+    cc_emails: Array<string>;
+    contact_title: string;
+    contact_phone_number: string;
+}
+export declare class DependentHostedNumberOrderInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: DependentHostedNumberOrderResource, signingDocumentSid: string);
+    /**
+     * A 34 character string that uniquely identifies this Authorization Document
+     */
+    sid: string;
+    /**
+     * A 34 character string that uniquely identifies the bulk hosting request associated with this HostedNumberOrder.
+     */
+    bulkHostingRequestSid: string;
+    /**
+     * The next step you need to take to complete the hosted number order and request it successfully.
+     */
+    nextStep: string;
+    /**
+     * The unique SID identifier of the Account.
+     */
+    accountSid: string;
+    /**
+     * A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
+     */
+    incomingPhoneNumberSid: string;
+    /**
+     * A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.
+     */
+    addressSid: string;
+    /**
+     * A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.
+     */
+    signingDocumentSid: string;
+    /**
+     * An E164 formatted phone number hosted by this HostedNumberOrder.
+     */
+    phoneNumber: string;
+    capabilities: PhoneNumberCapabilities;
+    /**
+     * A human readable description of this resource, up to 64 characters.
+     */
+    friendlyName: string;
+    status: DependentHostedNumberOrderStatus;
+    /**
+     * A message that explains why a hosted_number_order went to status \"action-required\"
+     */
+    failureReason: string;
+    /**
+     * The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.
+     */
+    dateUpdated: Date;
+    /**
+     * Email of the owner of this phone number that is being hosted.
+     */
+    email: string;
+    /**
+     * Email recipients who will be informed when an Authorization Document has been sent and signed
+     */
+    ccEmails: Array<string>;
+    /**
+     * The title of the person authorized to sign the Authorization Document for this phone number.
+     */
+    contactTitle: string;
+    /**
+     * The contact phone number of the person authorized to sign the Authorization Document.
+     */
+    contactPhoneNumber: string;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        bulkHostingRequestSid: string;
+        nextStep: string;
+        accountSid: string;
+        incomingPhoneNumberSid: string;
+        addressSid: string;
+        signingDocumentSid: string;
+        phoneNumber: string;
+        capabilities: PhoneNumberCapabilities;
+        friendlyName: string;
+        status: DependentHostedNumberOrderStatus;
+        failureReason: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        email: string;
+        ccEmails: string[];
+        contactTitle: string;
+        contactPhoneNumber: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export declare class DependentHostedNumberOrderPage extends Page<V2, DependentHostedNumberOrderPayload, DependentHostedNumberOrderResource, DependentHostedNumberOrderInstance> {
+    /**
+     * Initialize the DependentHostedNumberOrderPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: DependentHostedNumberOrderSolution);
+    /**
+     * Build an instance of DependentHostedNumberOrderInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: DependentHostedNumberOrderResource): DependentHostedNumberOrderInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/numbers/v2/authorizationDocument/dependentHostedNumberOrder.js

@@ -0,0 +1,164 @@
+"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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DependentHostedNumberOrderPage = exports.DependentHostedNumberOrderInstance = exports.DependentHostedNumberOrderListInstance = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../../base/Page"));
+const deserialize = require("../../../../base/deserialize");
+const serialize = require("../../../../base/serialize");
+const utility_1 = require("../../../../base/utility");
+function DependentHostedNumberOrderListInstance(version, signingDocumentSid) {
+    if (!(0, utility_1.isValidPathParam)(signingDocumentSid)) {
+        throw new Error("Parameter 'signingDocumentSid' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { signingDocumentSid };
+    instance._uri = `/HostedNumber/AuthorizationDocuments/${signingDocumentSid}/DependentHostedNumberOrders`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["status"] !== undefined)
+            data["Status"] = params["status"];
+        if (params["phoneNumber"] !== undefined)
+            data["PhoneNumber"] = params["phoneNumber"];
+        if (params["incomingPhoneNumberSid"] !== undefined)
+            data["IncomingPhoneNumberSid"] = params["incomingPhoneNumberSid"];
+        if (params["friendlyName"] !== undefined)
+            data["FriendlyName"] = params["friendlyName"];
+        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 DependentHostedNumberOrderPage(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 DependentHostedNumberOrderPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    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.DependentHostedNumberOrderListInstance = DependentHostedNumberOrderListInstance;
+class DependentHostedNumberOrderInstance {
+    constructor(_version, payload, signingDocumentSid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.bulkHostingRequestSid = payload.bulk_hosting_request_sid;
+        this.nextStep = payload.next_step;
+        this.accountSid = payload.account_sid;
+        this.incomingPhoneNumberSid = payload.incoming_phone_number_sid;
+        this.addressSid = payload.address_sid;
+        this.signingDocumentSid = payload.signing_document_sid;
+        this.phoneNumber = payload.phone_number;
+        this.capabilities = payload.capabilities;
+        this.friendlyName = payload.friendly_name;
+        this.status = payload.status;
+        this.failureReason = payload.failure_reason;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.email = payload.email;
+        this.ccEmails = payload.cc_emails;
+        this.contactTitle = payload.contact_title;
+        this.contactPhoneNumber = payload.contact_phone_number;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            bulkHostingRequestSid: this.bulkHostingRequestSid,
+            nextStep: this.nextStep,
+            accountSid: this.accountSid,
+            incomingPhoneNumberSid: this.incomingPhoneNumberSid,
+            addressSid: this.addressSid,
+            signingDocumentSid: this.signingDocumentSid,
+            phoneNumber: this.phoneNumber,
+            capabilities: this.capabilities,
+            friendlyName: this.friendlyName,
+            status: this.status,
+            failureReason: this.failureReason,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            email: this.email,
+            ccEmails: this.ccEmails,
+            contactTitle: this.contactTitle,
+            contactPhoneNumber: this.contactPhoneNumber,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DependentHostedNumberOrderInstance = DependentHostedNumberOrderInstance;
+class DependentHostedNumberOrderPage extends Page_1.default {
+    /**
+     * Initialize the DependentHostedNumberOrderPage
+     *
+     * @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 DependentHostedNumberOrderInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new DependentHostedNumberOrderInstance(this._version, payload, this._solution.signingDocumentSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.DependentHostedNumberOrderPage = DependentHostedNumberOrderPage;