twilio 4.7.1 → 4.8.0

package/lib/rest/microvisor/v1/accountConfig.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 V1 from "../V1";
+/**
+ * Options to pass to update a AccountConfigInstance
+ */
+export interface AccountConfigContextUpdateOptions {
+    /** The config value; up to 4096 characters. */
+    value: string;
+}
+/**
+ * Options to pass to create a AccountConfigInstance
+ */
+export interface AccountConfigListInstanceCreateOptions {
+    /** The config key; up to 100 characters. */
+    key: string;
+    /** The config value; up to 4096 characters. */
+    value: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface AccountConfigListInstanceEachOptions {
+    /** 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: AccountConfigInstance, 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 AccountConfigListInstanceOptions {
+    /** 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 AccountConfigListInstancePageOptions {
+    /** 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 AccountConfigContext {
+    /**
+     * Remove a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Update a AccountConfigInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    update(params: AccountConfigContextUpdateOptions, callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface AccountConfigContextSolution {
+    key: string;
+}
+export declare class AccountConfigContextImpl implements AccountConfigContext {
+    protected _version: V1;
+    protected _solution: AccountConfigContextSolution;
+    protected _uri: string;
+    constructor(_version: V1, key: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    update(params: AccountConfigContextUpdateOptions, callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): AccountConfigContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface AccountConfigPayload extends TwilioResponsePayload {
+    configs: AccountConfigResource[];
+}
+interface AccountConfigResource {
+    key: string;
+    date_updated: Date;
+    value: string;
+    url: string;
+}
+export declare class AccountConfigInstance {
+    protected _version: V1;
+    protected _solution: AccountConfigContextSolution;
+    protected _context?: AccountConfigContext;
+    constructor(_version: V1, payload: AccountConfigResource, key?: string);
+    /**
+     * The config key; up to 100 characters.
+     */
+    key: string;
+    dateUpdated: Date;
+    /**
+     * The config value; up to 4096 characters.
+     */
+    value: string;
+    /**
+     * The absolute URL of the Config.
+     */
+    url: string;
+    private get _proxy();
+    /**
+     * Remove a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Update a AccountConfigInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    update(params: AccountConfigContextUpdateOptions, callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        key: string;
+        dateUpdated: Date;
+        value: string;
+        url: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface AccountConfigSolution {
+}
+export interface AccountConfigListInstance {
+    _version: V1;
+    _solution: AccountConfigSolution;
+    _uri: string;
+    (key: string): AccountConfigContext;
+    get(key: string): AccountConfigContext;
+    /**
+     * Create a AccountConfigInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    create(params: AccountConfigListInstanceCreateOptions, callback?: (error: Error | null, item?: AccountConfigInstance) => any): Promise<AccountConfigInstance>;
+    /**
+     * Streams AccountConfigInstance 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 { AccountConfigListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: AccountConfigInstance, done: (err?: Error) => void) => void): void;
+    each(params: AccountConfigListInstanceEachOptions, callback?: (item: AccountConfigInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of AccountConfigInstance 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: AccountConfigPage) => any): Promise<AccountConfigPage>;
+    /**
+     * Lists AccountConfigInstance 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 { AccountConfigListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: AccountConfigInstance[]) => any): Promise<AccountConfigInstance[]>;
+    list(params: AccountConfigListInstanceOptions, callback?: (error: Error | null, items: AccountConfigInstance[]) => any): Promise<AccountConfigInstance[]>;
+    /**
+     * Retrieve a single page of AccountConfigInstance 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 { AccountConfigListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: AccountConfigPage) => any): Promise<AccountConfigPage>;
+    page(params: AccountConfigListInstancePageOptions, callback?: (error: Error | null, items: AccountConfigPage) => any): Promise<AccountConfigPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function AccountConfigListInstance(version: V1): AccountConfigListInstance;
+export declare class AccountConfigPage extends Page<V1, AccountConfigPayload, AccountConfigResource, AccountConfigInstance> {
+    /**
+     * Initialize the AccountConfigPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: AccountConfigSolution);
+    /**
+     * Build an instance of AccountConfigInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: AccountConfigResource): AccountConfigInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/microvisor/v1/accountConfig.js

@@ -0,0 +1,246 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Microvisor
+ * 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.AccountConfigPage = exports.AccountConfigListInstance = exports.AccountConfigInstance = exports.AccountConfigContextImpl = 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 AccountConfigContextImpl {
+    constructor(_version, key) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(key)) {
+            throw new Error("Parameter 'key' is not valid.");
+        }
+        this._solution = { key };
+        this._uri = `/Configs/${key}`;
+    }
+    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 AccountConfigInstance(operationVersion, payload, instance._solution.key));
+        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["value"] === null || params["value"] === undefined) {
+            throw new Error("Required parameter \"params['value']\" missing.");
+        }
+        let data = {};
+        data["Value"] = params["value"];
+        const headers = {};
+        headers["Content-Type"] = "application/x-www-form-urlencoded";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new AccountConfigInstance(operationVersion, payload, instance._solution.key));
+        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.AccountConfigContextImpl = AccountConfigContextImpl;
+class AccountConfigInstance {
+    constructor(_version, payload, key) {
+        this._version = _version;
+        this.key = payload.key;
+        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
+        this.value = payload.value;
+        this.url = payload.url;
+        this._solution = { key: key || this.key };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new AccountConfigContextImpl(this._version, this._solution.key);
+        return this._context;
+    }
+    /**
+     * Remove a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a AccountConfigInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountConfigInstance
+     */
+    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 {
+            key: this.key,
+            dateUpdated: this.dateUpdated,
+            value: this.value,
+            url: this.url,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AccountConfigInstance = AccountConfigInstance;
+function AccountConfigListInstance(version) {
+    const instance = ((key) => instance.get(key));
+    instance.get = function get(key) {
+        return new AccountConfigContextImpl(version, key);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/Configs`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        if (params["key"] === null || params["key"] === undefined) {
+            throw new Error("Required parameter \"params['key']\" missing.");
+        }
+        if (params["value"] === null || params["value"] === undefined) {
+            throw new Error("Required parameter \"params['value']\" missing.");
+        }
+        let data = {};
+        data["Key"] = params["key"];
+        data["Value"] = params["value"];
+        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 AccountConfigInstance(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["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 AccountConfigPage(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 AccountConfigPage(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.AccountConfigListInstance = AccountConfigListInstance;
+class AccountConfigPage extends Page_1.default {
+    /**
+     * Initialize the AccountConfigPage
+     *
+     * @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 AccountConfigInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AccountConfigInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AccountConfigPage = AccountConfigPage;