twilio 4.11.2 → 4.13.0

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

@@ -0,0 +1,288 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V2 from "../V2";
+import { DependentHostedNumberOrderListInstance } from "./authorizationDocument/dependentHostedNumberOrder";
+export type AuthorizationDocumentStatus = "opened" | "signing" | "signed" | "canceled" | "failed";
+/**
+ * Options to pass to create a AuthorizationDocumentInstance
+ */
+export interface AuthorizationDocumentListInstanceCreateOptions {
+    /** A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument. */
+    addressSid: string;
+    /** Email that this AuthorizationDocument will be sent to for signing. */
+    email: string;
+    /** The contact phone number of the person authorized to sign the Authorization Document. */
+    contactPhoneNumber: string;
+    /** The title of the person authorized to sign the Authorization Document for this phone number. */
+    contactTitle?: string;
+    /** Email recipients who will be informed when an Authorization Document has been sent and signed. */
+    ccEmails?: Array<string>;
+}
+/**
+ * Options to pass to each
+ */
+export interface AuthorizationDocumentListInstanceEachOptions {
+    /** Email that this AuthorizationDocument will be sent to for signing. */
+    email?: string;
+    /** 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?: AuthorizationDocumentStatus;
+    /** 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: AuthorizationDocumentInstance, 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 AuthorizationDocumentListInstanceOptions {
+    /** Email that this AuthorizationDocument will be sent to for signing. */
+    email?: string;
+    /** 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?: AuthorizationDocumentStatus;
+    /** 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 AuthorizationDocumentListInstancePageOptions {
+    /** Email that this AuthorizationDocument will be sent to for signing. */
+    email?: string;
+    /** 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?: AuthorizationDocumentStatus;
+    /** 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 AuthorizationDocumentContext {
+    dependentHostedNumberOrders: DependentHostedNumberOrderListInstance;
+    /**
+     * Remove a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AuthorizationDocumentInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AuthorizationDocumentInstance) => any): Promise<AuthorizationDocumentInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface AuthorizationDocumentContextSolution {
+    sid: string;
+}
+export declare class AuthorizationDocumentContextImpl implements AuthorizationDocumentContext {
+    protected _version: V2;
+    protected _solution: AuthorizationDocumentContextSolution;
+    protected _uri: string;
+    protected _dependentHostedNumberOrders?: DependentHostedNumberOrderListInstance;
+    constructor(_version: V2, sid: string);
+    get dependentHostedNumberOrders(): DependentHostedNumberOrderListInstance;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: AuthorizationDocumentInstance) => any): Promise<AuthorizationDocumentInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): AuthorizationDocumentContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface AuthorizationDocumentPayload extends TwilioResponsePayload {
+    items: AuthorizationDocumentResource[];
+}
+interface AuthorizationDocumentResource {
+    sid: string;
+    address_sid: string;
+    status: AuthorizationDocumentStatus;
+    email: string;
+    cc_emails: Array<string>;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+    links: Record<string, string>;
+}
+export declare class AuthorizationDocumentInstance {
+    protected _version: V2;
+    protected _solution: AuthorizationDocumentContextSolution;
+    protected _context?: AuthorizationDocumentContext;
+    constructor(_version: V2, payload: AuthorizationDocumentResource, sid?: string);
+    /**
+     * A 34 character string that uniquely identifies this AuthorizationDocument.
+     */
+    sid: string;
+    /**
+     * A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.
+     */
+    addressSid: string;
+    status: AuthorizationDocumentStatus;
+    /**
+     * Email that this AuthorizationDocument will be sent to for signing.
+     */
+    email: string;
+    /**
+     * Email recipients who will be informed when an Authorization Document has been sent and signed.
+     */
+    ccEmails: Array<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;
+    url: string;
+    links: Record<string, string>;
+    private get _proxy();
+    /**
+     * Remove a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AuthorizationDocumentInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AuthorizationDocumentInstance) => any): Promise<AuthorizationDocumentInstance>;
+    /**
+     * Access the dependentHostedNumberOrders.
+     */
+    dependentHostedNumberOrders(): DependentHostedNumberOrderListInstance;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        addressSid: string;
+        status: AuthorizationDocumentStatus;
+        email: string;
+        ccEmails: string[];
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+        links: Record<string, string>;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface AuthorizationDocumentSolution {
+}
+export interface AuthorizationDocumentListInstance {
+    _version: V2;
+    _solution: AuthorizationDocumentSolution;
+    _uri: string;
+    (sid: string): AuthorizationDocumentContext;
+    get(sid: string): AuthorizationDocumentContext;
+    /**
+     * Create a AuthorizationDocumentInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AuthorizationDocumentInstance
+     */
+    create(params: AuthorizationDocumentListInstanceCreateOptions, callback?: (error: Error | null, item?: AuthorizationDocumentInstance) => any): Promise<AuthorizationDocumentInstance>;
+    /**
+     * Streams AuthorizationDocumentInstance 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 { AuthorizationDocumentListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: AuthorizationDocumentInstance, done: (err?: Error) => void) => void): void;
+    each(params: AuthorizationDocumentListInstanceEachOptions, callback?: (item: AuthorizationDocumentInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of AuthorizationDocumentInstance 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: AuthorizationDocumentPage) => any): Promise<AuthorizationDocumentPage>;
+    /**
+     * Lists AuthorizationDocumentInstance 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 { AuthorizationDocumentListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: AuthorizationDocumentInstance[]) => any): Promise<AuthorizationDocumentInstance[]>;
+    list(params: AuthorizationDocumentListInstanceOptions, callback?: (error: Error | null, items: AuthorizationDocumentInstance[]) => any): Promise<AuthorizationDocumentInstance[]>;
+    /**
+     * Retrieve a single page of AuthorizationDocumentInstance 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 { AuthorizationDocumentListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: AuthorizationDocumentPage) => any): Promise<AuthorizationDocumentPage>;
+    page(params: AuthorizationDocumentListInstancePageOptions, callback?: (error: Error | null, items: AuthorizationDocumentPage) => any): Promise<AuthorizationDocumentPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function AuthorizationDocumentListInstance(version: V2): AuthorizationDocumentListInstance;
+export declare class AuthorizationDocumentPage extends Page<V2, AuthorizationDocumentPayload, AuthorizationDocumentResource, AuthorizationDocumentInstance> {
+    /**
+     * Initialize the AuthorizationDocumentPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: AuthorizationDocumentSolution);
+    /**
+     * Build an instance of AuthorizationDocumentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: AuthorizationDocumentResource): AuthorizationDocumentInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,257 @@
+"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.AuthorizationDocumentPage = exports.AuthorizationDocumentListInstance = exports.AuthorizationDocumentInstance = exports.AuthorizationDocumentContextImpl = 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");
+const dependentHostedNumberOrder_1 = require("./authorizationDocument/dependentHostedNumberOrder");
+class AuthorizationDocumentContextImpl {
+    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 = `/HostedNumber/AuthorizationDocuments/${sid}`;
+    }
+    get dependentHostedNumberOrders() {
+        this._dependentHostedNumberOrders =
+            this._dependentHostedNumberOrders ||
+                (0, dependentHostedNumberOrder_1.DependentHostedNumberOrderListInstance)(this._version, this._solution.sid);
+        return this._dependentHostedNumberOrders;
+    }
+    remove(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.remove({
+            uri: instance._uri,
+            method: "delete",
+        });
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+        });
+        operationPromise = operationPromise.then((payload) => new AuthorizationDocumentInstance(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.AuthorizationDocumentContextImpl = AuthorizationDocumentContextImpl;
+class AuthorizationDocumentInstance {
+    constructor(_version, payload, sid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.addressSid = payload.address_sid;
+        this.status = payload.status;
+        this.email = payload.email;
+        this.ccEmails = payload.cc_emails;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.url = payload.url;
+        this.links = payload.links;
+        this._solution = { sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new AuthorizationDocumentContextImpl(this._version, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Remove a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a AuthorizationDocumentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AuthorizationDocumentInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Access the dependentHostedNumberOrders.
+     */
+    dependentHostedNumberOrders() {
+        return this._proxy.dependentHostedNumberOrders;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            addressSid: this.addressSid,
+            status: this.status,
+            email: this.email,
+            ccEmails: this.ccEmails,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            url: this.url,
+            links: this.links,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AuthorizationDocumentInstance = AuthorizationDocumentInstance;
+function AuthorizationDocumentListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new AuthorizationDocumentContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/HostedNumber/AuthorizationDocuments`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["addressSid"] === null || params["addressSid"] === undefined) {
+            throw new Error("Required parameter \"params['addressSid']\" missing.");
+        }
+        if (params["email"] === null || params["email"] === undefined) {
+            throw new Error("Required parameter \"params['email']\" missing.");
+        }
+        if (params["contactPhoneNumber"] === null ||
+            params["contactPhoneNumber"] === undefined) {
+            throw new Error("Required parameter \"params['contactPhoneNumber']\" missing.");
+        }
+        let data = {};
+        data["AddressSid"] = params["addressSid"];
+        data["Email"] = params["email"];
+        data["ContactPhoneNumber"] = params["contactPhoneNumber"];
+        if (params["contactTitle"] !== undefined)
+            data["ContactTitle"] = params["contactTitle"];
+        if (params["ccEmails"] !== undefined)
+            data["CcEmails"] = serialize.map(params["ccEmails"], (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 AuthorizationDocumentInstance(operationVersion, payload));
+        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["email"] !== undefined)
+            data["Email"] = params["email"];
+        if (params["status"] !== undefined)
+            data["Status"] = params["status"];
+        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 AuthorizationDocumentPage(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 AuthorizationDocumentPage(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.AuthorizationDocumentListInstance = AuthorizationDocumentListInstance;
+class AuthorizationDocumentPage extends Page_1.default {
+    /**
+     * Initialize the AuthorizationDocumentPage
+     *
+     * @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 AuthorizationDocumentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AuthorizationDocumentInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AuthorizationDocumentPage = AuthorizationDocumentPage;