twilio 4.6.0 → 4.7.0

package/lib/rest/lookups/v2/phoneNumber.js

@@ -0,0 +1,158 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Lookups
+ * 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.PhoneNumberListInstance = exports.PhoneNumberInstance = exports.PhoneNumberContextImpl = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class PhoneNumberContextImpl {
+    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 = `/PhoneNumbers/${phoneNumber}`;
+    }
+    fetch(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["fields"] !== undefined)
+            data["Fields"] = params["fields"];
+        if (params["countryCode"] !== undefined)
+            data["CountryCode"] = params["countryCode"];
+        if (params["firstName"] !== undefined)
+            data["FirstName"] = params["firstName"];
+        if (params["lastName"] !== undefined)
+            data["LastName"] = params["lastName"];
+        if (params["addressLine1"] !== undefined)
+            data["AddressLine1"] = params["addressLine1"];
+        if (params["addressLine2"] !== undefined)
+            data["AddressLine2"] = params["addressLine2"];
+        if (params["city"] !== undefined)
+            data["City"] = params["city"];
+        if (params["state"] !== undefined)
+            data["State"] = params["state"];
+        if (params["postalCode"] !== undefined)
+            data["PostalCode"] = params["postalCode"];
+        if (params["addressCountryCode"] !== undefined)
+            data["AddressCountryCode"] = params["addressCountryCode"];
+        if (params["nationalId"] !== undefined)
+            data["NationalId"] = params["nationalId"];
+        if (params["dateOfBirth"] !== undefined)
+            data["DateOfBirth"] = params["dateOfBirth"];
+        const headers = {};
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new PhoneNumberInstance(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.PhoneNumberContextImpl = PhoneNumberContextImpl;
+class PhoneNumberInstance {
+    constructor(_version, payload, phoneNumber) {
+        this._version = _version;
+        this.callingCountryCode = payload.calling_country_code;
+        this.countryCode = payload.country_code;
+        this.phoneNumber = payload.phone_number;
+        this.nationalFormat = payload.national_format;
+        this.valid = payload.valid;
+        this.validationErrors = payload.validation_errors;
+        this.callerName = payload.caller_name;
+        this.simSwap = payload.sim_swap;
+        this.callForwarding = payload.call_forwarding;
+        this.liveActivity = payload.live_activity;
+        this.lineTypeIntelligence = payload.line_type_intelligence;
+        this.identityMatch = payload.identity_match;
+        this.url = payload.url;
+        this._solution = { phoneNumber: phoneNumber || this.phoneNumber };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new PhoneNumberContextImpl(this._version, this._solution.phoneNumber);
+        return this._context;
+    }
+    fetch(params, callback) {
+        return this._proxy.fetch(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            callingCountryCode: this.callingCountryCode,
+            countryCode: this.countryCode,
+            phoneNumber: this.phoneNumber,
+            nationalFormat: this.nationalFormat,
+            valid: this.valid,
+            validationErrors: this.validationErrors,
+            callerName: this.callerName,
+            simSwap: this.simSwap,
+            callForwarding: this.callForwarding,
+            liveActivity: this.liveActivity,
+            lineTypeIntelligence: this.lineTypeIntelligence,
+            identityMatch: this.identityMatch,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.PhoneNumberInstance = PhoneNumberInstance;
+function PhoneNumberListInstance(version) {
+    const instance = ((phoneNumber) => instance.get(phoneNumber));
+    instance.get = function get(phoneNumber) {
+        return new PhoneNumberContextImpl(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.PhoneNumberListInstance = PhoneNumberListInstance;

package/lib/rest/media/V1.d.ts

@@ -0,0 +1,25 @@
+import MediaBase from "../MediaBase";
+import Version from "../../base/Version";
+import { MediaProcessorListInstance } from "./v1/mediaProcessor";
+import { MediaRecordingListInstance } from "./v1/mediaRecording";
+import { PlayerStreamerListInstance } from "./v1/playerStreamer";
+export default class V1 extends Version {
+    /**
+     * Initialize the V1 version of Media
+     *
+     * @param domain - The Twilio (Twilio.Media) domain
+     */
+    constructor(domain: MediaBase);
+    /** mediaProcessor - { Twilio.Media.V1.MediaProcessorListInstance } resource */
+    protected _mediaProcessor?: MediaProcessorListInstance;
+    /** mediaRecording - { Twilio.Media.V1.MediaRecordingListInstance } resource */
+    protected _mediaRecording?: MediaRecordingListInstance;
+    /** playerStreamer - { Twilio.Media.V1.PlayerStreamerListInstance } resource */
+    protected _playerStreamer?: PlayerStreamerListInstance;
+    /** Getter for mediaProcessor resource */
+    get mediaProcessor(): MediaProcessorListInstance;
+    /** Getter for mediaRecording resource */
+    get mediaRecording(): MediaRecordingListInstance;
+    /** Getter for playerStreamer resource */
+    get playerStreamer(): PlayerStreamerListInstance;
+}

package/lib/rest/media/V1.js

@@ -0,0 +1,51 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Media
+ * 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 });
+const Version_1 = __importDefault(require("../../base/Version"));
+const mediaProcessor_1 = require("./v1/mediaProcessor");
+const mediaRecording_1 = require("./v1/mediaRecording");
+const playerStreamer_1 = require("./v1/playerStreamer");
+class V1 extends Version_1.default {
+    /**
+     * Initialize the V1 version of Media
+     *
+     * @param domain - The Twilio (Twilio.Media) domain
+     */
+    constructor(domain) {
+        super(domain, "v1");
+    }
+    /** Getter for mediaProcessor resource */
+    get mediaProcessor() {
+        this._mediaProcessor =
+            this._mediaProcessor || (0, mediaProcessor_1.MediaProcessorListInstance)(this);
+        return this._mediaProcessor;
+    }
+    /** Getter for mediaRecording resource */
+    get mediaRecording() {
+        this._mediaRecording =
+            this._mediaRecording || (0, mediaRecording_1.MediaRecordingListInstance)(this);
+        return this._mediaRecording;
+    }
+    /** Getter for playerStreamer resource */
+    get playerStreamer() {
+        this._playerStreamer =
+            this._playerStreamer || (0, playerStreamer_1.PlayerStreamerListInstance)(this);
+        return this._playerStreamer;
+    }
+}
+exports.default = V1;

package/lib/rest/media/v1/mediaProcessor.d.ts

@@ -0,0 +1,318 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V1 from "../V1";
+type MediaProcessorOrder = "asc" | "desc";
+type MediaProcessorStatus = "failed" | "started" | "ended";
+type MediaProcessorUpdateStatus = "ended";
+/**
+ * Options to pass to update a MediaProcessorInstance
+ */
+export interface MediaProcessorContextUpdateOptions {
+    /**  */
+    status: MediaProcessorUpdateStatus;
+}
+/**
+ * Options to pass to create a MediaProcessorInstance
+ */
+export interface MediaProcessorListInstanceCreateOptions {
+    /** The [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2` */
+    extension: string;
+    /** The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send. */
+    extensionContext: string;
+    /** User-defined environment variables for the Media Extension, represented as a JSON dictionary of key/value strings. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about whether you need to provide this. */
+    extensionEnvironment?: any;
+    /** The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details. */
+    statusCallback?: string;
+    /** The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`. */
+    statusCallbackMethod?: string;
+    /** The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming. */
+    maxDuration?: number;
+}
+/**
+ * Options to pass to each
+ */
+export interface MediaProcessorListInstanceEachOptions {
+    /** The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default. */
+    order?: MediaProcessorOrder;
+    /** Status to filter by, with possible values `started`, `ended` or `failed`. */
+    status?: MediaProcessorStatus;
+    /** 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: MediaProcessorInstance, 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 MediaProcessorListInstanceOptions {
+    /** The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default. */
+    order?: MediaProcessorOrder;
+    /** Status to filter by, with possible values `started`, `ended` or `failed`. */
+    status?: MediaProcessorStatus;
+    /** 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 MediaProcessorListInstancePageOptions {
+    /** The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default. */
+    order?: MediaProcessorOrder;
+    /** Status to filter by, with possible values `started`, `ended` or `failed`. */
+    status?: MediaProcessorStatus;
+    /** 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 MediaProcessorContext {
+    /**
+     * Fetch a MediaProcessorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MediaProcessorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Update a MediaProcessorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MediaProcessorInstance
+     */
+    update(params: MediaProcessorContextUpdateOptions, callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface MediaProcessorContextSolution {
+    sid: string;
+}
+export declare class MediaProcessorContextImpl implements MediaProcessorContext {
+    protected _version: V1;
+    protected _solution: MediaProcessorContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, sid: string);
+    fetch(callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    update(params: MediaProcessorContextUpdateOptions, callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): MediaProcessorContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export type MediaProcessorStatusCallbackMethod = "HEAD" | "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+interface MediaProcessorPayload extends TwilioResponsePayload {
+    media_processors: MediaProcessorResource[];
+}
+interface MediaProcessorResource {
+    account_sid: string;
+    sid: string;
+    date_created: Date;
+    date_updated: Date;
+    extension: string;
+    extension_context: string;
+    status: MediaProcessorStatus;
+    url: string;
+    ended_reason: string;
+    status_callback: string;
+    status_callback_method: MediaProcessorStatusCallbackMethod;
+    max_duration: number;
+}
+export declare class MediaProcessorInstance {
+    protected _version: V1;
+    protected _solution: MediaProcessorContextSolution;
+    protected _context?: MediaProcessorContext;
+    constructor(_version: V1, payload: MediaProcessorResource, sid?: string);
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the MediaProcessor resource.
+     */
+    accountSid: string;
+    /**
+     * The unique string generated to identify the MediaProcessor resource.
+     */
+    sid: 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 [Media Extension](/docs/live/api/media-extensions-overview) name or URL. Ex: `video-composer-v2`
+     */
+    extension: string;
+    /**
+     * The context of the Media Extension, represented as a JSON dictionary. See the documentation for the specific [Media Extension](/docs/live/api/media-extensions-overview) you are using for more information about the context to send.
+     */
+    extensionContext: string;
+    status: MediaProcessorStatus;
+    /**
+     * The absolute URL of the resource.
+     */
+    url: string;
+    /**
+     * The reason why a MediaProcessor ended. When a MediaProcessor is in progress, will be `null`. When a MediaProcessor is completed, can be `ended-via-api`, `max-duration-exceeded`, `error-loading-extension`, `error-streaming-media` or `internal-service-error`. See [ended reasons](/docs/live/api/mediaprocessors#mediaprocessor-ended-reason-values) for more details.
+     */
+    endedReason: string;
+    /**
+     * The URL to which Twilio will send asynchronous webhook requests for every MediaProcessor event. See [Status Callbacks](/docs/live/status-callbacks) for details.
+     */
+    statusCallback: string;
+    /**
+     * The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
+     */
+    statusCallbackMethod: MediaProcessorStatusCallbackMethod;
+    /**
+     * The maximum time, in seconds, that the MediaProcessor can run before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the MediaProcessor, regardless of whether media is still streaming.
+     */
+    maxDuration: number;
+    private get _proxy();
+    /**
+     * Fetch a MediaProcessorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MediaProcessorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Update a MediaProcessorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MediaProcessorInstance
+     */
+    update(params: MediaProcessorContextUpdateOptions, callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        sid: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        extension: string;
+        extensionContext: string;
+        status: MediaProcessorStatus;
+        url: string;
+        endedReason: string;
+        statusCallback: string;
+        statusCallbackMethod: MediaProcessorStatusCallbackMethod;
+        maxDuration: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface MediaProcessorSolution {
+}
+export interface MediaProcessorListInstance {
+    _version: V1;
+    _solution: MediaProcessorSolution;
+    _uri: string;
+    (sid: string): MediaProcessorContext;
+    get(sid: string): MediaProcessorContext;
+    /**
+     * Create a MediaProcessorInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed MediaProcessorInstance
+     */
+    create(params: MediaProcessorListInstanceCreateOptions, callback?: (error: Error | null, item?: MediaProcessorInstance) => any): Promise<MediaProcessorInstance>;
+    /**
+     * Streams MediaProcessorInstance 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 { MediaProcessorListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: MediaProcessorInstance, done: (err?: Error) => void) => void): void;
+    each(params: MediaProcessorListInstanceEachOptions, callback?: (item: MediaProcessorInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of MediaProcessorInstance 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: MediaProcessorPage) => any): Promise<MediaProcessorPage>;
+    /**
+     * Lists MediaProcessorInstance 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 { MediaProcessorListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: MediaProcessorInstance[]) => any): Promise<MediaProcessorInstance[]>;
+    list(params: MediaProcessorListInstanceOptions, callback?: (error: Error | null, items: MediaProcessorInstance[]) => any): Promise<MediaProcessorInstance[]>;
+    /**
+     * Retrieve a single page of MediaProcessorInstance 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 { MediaProcessorListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: MediaProcessorPage) => any): Promise<MediaProcessorPage>;
+    page(params: MediaProcessorListInstancePageOptions, callback?: (error: Error | null, items: MediaProcessorPage) => any): Promise<MediaProcessorPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function MediaProcessorListInstance(version: V1): MediaProcessorListInstance;
+export declare class MediaProcessorPage extends Page<V1, MediaProcessorPayload, MediaProcessorResource, MediaProcessorInstance> {
+    /**
+     * Initialize the MediaProcessorPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: MediaProcessorSolution);
+    /**
+     * Build an instance of MediaProcessorInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: MediaProcessorResource): MediaProcessorInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};