twilio 5.0.3 → 5.1.0

package/lib/rest/intelligence/v2/customOperator.js

@@ -0,0 +1,279 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Intelligence
+ * 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.CustomOperatorPage = exports.CustomOperatorListInstance = exports.CustomOperatorInstance = exports.CustomOperatorContextImpl = 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");
+class CustomOperatorContextImpl {
+    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 = `/Operators/Custom/${sid}`;
+    }
+    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 CustomOperatorInstance(operationVersion, payload, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["friendlyName"] === null ||
+            params["friendlyName"] === undefined) {
+            throw new Error("Required parameter \"params['friendlyName']\" missing.");
+        }
+        if (params["config"] === null || params["config"] === undefined) {
+            throw new Error("Required parameter \"params['config']\" missing.");
+        }
+        let data = {};
+        data["FriendlyName"] = params["friendlyName"];
+        data["Config"] = serialize.object(params["config"]);
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        if (params["ifMatch"] !== undefined)
+            headers["If-Match"] = params["ifMatch"];
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new CustomOperatorInstance(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.CustomOperatorContextImpl = CustomOperatorContextImpl;
+class CustomOperatorInstance {
+    constructor(_version, payload, sid) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.sid = payload.sid;
+        this.friendlyName = payload.friendly_name;
+        this.description = payload.description;
+        this.author = payload.author;
+        this.operatorType = payload.operator_type;
+        this.version = deserialize.integer(payload.version);
+        this.availability = payload.availability;
+        this.config = payload.config;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.url = payload.url;
+        this._solution = { sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new CustomOperatorContextImpl(this._version, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Remove a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a CustomOperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed CustomOperatorInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    update(params, callback) {
+        return this._proxy.update(params, callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            sid: this.sid,
+            friendlyName: this.friendlyName,
+            description: this.description,
+            author: this.author,
+            operatorType: this.operatorType,
+            version: this.version,
+            availability: this.availability,
+            config: this.config,
+            dateCreated: this.dateCreated,
+            dateUpdated: this.dateUpdated,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.CustomOperatorInstance = CustomOperatorInstance;
+function CustomOperatorListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new CustomOperatorContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Operators/Custom`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["friendlyName"] === null ||
+            params["friendlyName"] === undefined) {
+            throw new Error("Required parameter \"params['friendlyName']\" missing.");
+        }
+        if (params["operatorType"] === null ||
+            params["operatorType"] === undefined) {
+            throw new Error("Required parameter \"params['operatorType']\" missing.");
+        }
+        if (params["config"] === null || params["config"] === undefined) {
+            throw new Error("Required parameter \"params['config']\" missing.");
+        }
+        let data = {};
+        data["FriendlyName"] = params["friendlyName"];
+        data["OperatorType"] = params["operatorType"];
+        data["Config"] = serialize.object(params["config"]);
+        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 CustomOperatorInstance(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["availability"] !== undefined)
+            data["Availability"] = params["availability"];
+        if (params["languageCode"] !== undefined)
+            data["LanguageCode"] = params["languageCode"];
+        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 CustomOperatorPage(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 CustomOperatorPage(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.CustomOperatorListInstance = CustomOperatorListInstance;
+class CustomOperatorPage extends Page_1.default {
+    /**
+     * Initialize the CustomOperatorPage
+     *
+     * @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 CustomOperatorInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new CustomOperatorInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.CustomOperatorPage = CustomOperatorPage;

package/lib/rest/intelligence/v2/operator.d.ts

@@ -0,0 +1,263 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V2 from "../V2";
+export type OperatorAvailability = "internal" | "beta" | "public" | "retired";
+/**
+ * Options to pass to each
+ */
+export interface OperatorListInstanceEachOptions {
+    /** Returns Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: OperatorAvailability;
+    /** Returns Operators that support the provided language code. */
+    languageCode?: 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: OperatorInstance, 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 OperatorListInstanceOptions {
+    /** Returns Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: OperatorAvailability;
+    /** Returns Operators that support the provided language code. */
+    languageCode?: 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 OperatorListInstancePageOptions {
+    /** Returns Operators with the provided availability type. Possible values: internal, beta, public, retired. */
+    availability?: OperatorAvailability;
+    /** Returns Operators that support the provided language code. */
+    languageCode?: 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 OperatorContext {
+    /**
+     * Fetch a OperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperatorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperatorInstance) => any): Promise<OperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface OperatorContextSolution {
+    sid: string;
+}
+export declare class OperatorContextImpl implements OperatorContext {
+    protected _version: V2;
+    protected _solution: OperatorContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, sid: string);
+    fetch(callback?: (error: Error | null, item?: OperatorInstance) => any): Promise<OperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): OperatorContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface OperatorPayload extends TwilioResponsePayload {
+    operators: OperatorResource[];
+}
+interface OperatorResource {
+    account_sid: string;
+    sid: string;
+    friendly_name: string;
+    description: string;
+    author: string;
+    operator_type: string;
+    version: number;
+    availability: OperatorAvailability;
+    config: any;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+}
+export declare class OperatorInstance {
+    protected _version: V2;
+    protected _solution: OperatorContextSolution;
+    protected _context?: OperatorContext;
+    constructor(_version: V2, payload: OperatorResource, sid?: string);
+    /**
+     * The unique SID identifier of the Account the Operator belongs to.
+     */
+    accountSid: string;
+    /**
+     * A 34 character string that uniquely identifies this Operator.
+     */
+    sid: string;
+    /**
+     * A human-readable name of this resource, up to 64 characters.
+     */
+    friendlyName: string;
+    /**
+     * A human-readable description of this resource, longer than the friendly name.
+     */
+    description: string;
+    /**
+     * The creator of the Operator. Either Twilio or the creating Account.
+     */
+    author: string;
+    /**
+     * Operator Type for this Operator. References an existing Operator Type resource.
+     */
+    operatorType: string;
+    /**
+     * Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator.
+     */
+    version: number;
+    availability: OperatorAvailability;
+    /**
+     * Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account.
+     */
+    config: any;
+    /**
+     * The date that this Operator was created, given in ISO 8601 format.
+     */
+    dateCreated: Date;
+    /**
+     * The date that this Operator was updated, given in ISO 8601 format.
+     */
+    dateUpdated: Date;
+    /**
+     * The URL of this resource.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Fetch a OperatorInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed OperatorInstance
+     */
+    fetch(callback?: (error: Error | null, item?: OperatorInstance) => any): Promise<OperatorInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        sid: string;
+        friendlyName: string;
+        description: string;
+        author: string;
+        operatorType: string;
+        version: number;
+        availability: OperatorAvailability;
+        config: any;
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface OperatorSolution {
+}
+export interface OperatorListInstance {
+    _version: V2;
+    _solution: OperatorSolution;
+    _uri: string;
+    (sid: string): OperatorContext;
+    get(sid: string): OperatorContext;
+    /**
+     * Streams OperatorInstance 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 { OperatorListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: OperatorInstance, done: (err?: Error) => void) => void): void;
+    each(params: OperatorListInstanceEachOptions, callback?: (item: OperatorInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of OperatorInstance 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: OperatorPage) => any): Promise<OperatorPage>;
+    /**
+     * Lists OperatorInstance 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 { OperatorListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: OperatorInstance[]) => any): Promise<OperatorInstance[]>;
+    list(params: OperatorListInstanceOptions, callback?: (error: Error | null, items: OperatorInstance[]) => any): Promise<OperatorInstance[]>;
+    /**
+     * Retrieve a single page of OperatorInstance 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 { OperatorListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: OperatorPage) => any): Promise<OperatorPage>;
+    page(params: OperatorListInstancePageOptions, callback?: (error: Error | null, items: OperatorPage) => any): Promise<OperatorPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function OperatorListInstance(version: V2): OperatorListInstance;
+export declare class OperatorPage extends Page<V2, OperatorPayload, OperatorResource, OperatorInstance> {
+    /**
+     * Initialize the OperatorPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V2, response: Response<string>, solution: OperatorSolution);
+    /**
+     * Build an instance of OperatorInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: OperatorResource): OperatorInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};