twilio 5.3.2 → 5.3.3

package/lib/rest/preview/deployed_devices/fleet/device.d.ts

@@ -1,358 +0,0 @@
-/// <reference types="node" />
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../base/Page";
-import Response from "../../../../http/response";
-import DeployedDevices from "../../DeployedDevices";
-/**
- * Options to pass to update a DeviceInstance
- */
-export interface DeviceContextUpdateOptions {
-    /** Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long. */
-    friendlyName?: string;
-    /** Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long. */
-    identity?: string;
-    /** Specifies the unique string identifier of the Deployment group that this Device is going to be associated with. */
-    deploymentSid?: string;
-    /**  */
-    enabled?: boolean;
-}
-/**
- * Options to pass to create a DeviceInstance
- */
-export interface DeviceListInstanceCreateOptions {
-    /** Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long. */
-    uniqueName?: string;
-    /** Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long. */
-    friendlyName?: string;
-    /** Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long. */
-    identity?: string;
-    /** Specifies the unique string identifier of the Deployment group that this Device is going to be associated with. */
-    deploymentSid?: string;
-    /**  */
-    enabled?: boolean;
-}
-/**
- * Options to pass to each
- */
-export interface DeviceListInstanceEachOptions {
-    /** Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with. */
-    deploymentSid?: 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: DeviceInstance, 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 DeviceListInstanceOptions {
-    /** Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with. */
-    deploymentSid?: 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 DeviceListInstancePageOptions {
-    /** Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with. */
-    deploymentSid?: 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 DeviceContext {
-    /**
-     * Remove a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Update a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    update(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Update a DeviceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    update(params: DeviceContextUpdateOptions, callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface DeviceContextSolution {
-    fleetSid: string;
-    sid: string;
-}
-export declare class DeviceContextImpl implements DeviceContext {
-    protected _version: DeployedDevices;
-    protected _solution: DeviceContextSolution;
-    protected _uri: string;
-    constructor(_version: DeployedDevices, fleetSid: string, sid: string);
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    update(params?: DeviceContextUpdateOptions | ((error: Error | null, item?: DeviceInstance) => any), callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): DeviceContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface DevicePayload extends TwilioResponsePayload {
-    devices: DeviceResource[];
-}
-interface DeviceResource {
-    sid: string;
-    url: string;
-    unique_name: string;
-    friendly_name: string;
-    fleet_sid: string;
-    enabled: boolean;
-    account_sid: string;
-    identity: string;
-    deployment_sid: string;
-    date_created: Date;
-    date_updated: Date;
-    date_authenticated: Date;
-}
-export declare class DeviceInstance {
-    protected _version: DeployedDevices;
-    protected _solution: DeviceContextSolution;
-    protected _context?: DeviceContext;
-    constructor(_version: DeployedDevices, payload: DeviceResource, fleetSid: string, sid?: string);
-    /**
-     * Contains a 34 character string that uniquely identifies this Device resource.
-     */
-    sid: string;
-    /**
-     * Contains an absolute URL for this Device resource.
-     */
-    url: string;
-    /**
-     * Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long.
-     */
-    uniqueName: string;
-    /**
-     * Contains a human readable descriptive text for this Device, up to 256 characters long
-     */
-    friendlyName: string;
-    /**
-     * Specifies the unique string identifier of the Fleet that the given Device belongs to.
-     */
-    fleetSid: string;
-    /**
-     * Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false.
-     */
-    enabled: boolean;
-    /**
-     * Specifies the unique string identifier of the Account responsible for this Device.
-     */
-    accountSid: string;
-    /**
-     * Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long.
-     */
-    identity: string;
-    /**
-     * Specifies the unique string identifier of the Deployment group that this Device is associated with.
-     */
-    deploymentSid: string;
-    /**
-     * Specifies the date this Device was created, given in UTC ISO 8601 format.
-     */
-    dateCreated: Date;
-    /**
-     * Specifies the date this Device was last updated, given in UTC ISO 8601 format.
-     */
-    dateUpdated: Date;
-    /**
-     * Specifies the date this Device was last authenticated, given in UTC ISO 8601 format.
-     */
-    dateAuthenticated: Date;
-    private get _proxy();
-    /**
-     * Remove a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Update a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    update(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Update a DeviceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    update(params: DeviceContextUpdateOptions, callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        url: string;
-        uniqueName: string;
-        friendlyName: string;
-        fleetSid: string;
-        enabled: boolean;
-        accountSid: string;
-        identity: string;
-        deploymentSid: string;
-        dateCreated: Date;
-        dateUpdated: Date;
-        dateAuthenticated: Date;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface DeviceSolution {
-    fleetSid: string;
-}
-export interface DeviceListInstance {
-    _version: DeployedDevices;
-    _solution: DeviceSolution;
-    _uri: string;
-    (sid: string): DeviceContext;
-    get(sid: string): DeviceContext;
-    /**
-     * Create a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    create(callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Create a DeviceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    create(params: DeviceListInstanceCreateOptions, callback?: (error: Error | null, item?: DeviceInstance) => any): Promise<DeviceInstance>;
-    /**
-     * Streams DeviceInstance 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 { DeviceListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: DeviceInstance, done: (err?: Error) => void) => void): void;
-    each(params: DeviceListInstanceEachOptions, callback?: (item: DeviceInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of DeviceInstance 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: DevicePage) => any): Promise<DevicePage>;
-    /**
-     * Lists DeviceInstance 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 { DeviceListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: DeviceInstance[]) => any): Promise<DeviceInstance[]>;
-    list(params: DeviceListInstanceOptions, callback?: (error: Error | null, items: DeviceInstance[]) => any): Promise<DeviceInstance[]>;
-    /**
-     * Retrieve a single page of DeviceInstance 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 { DeviceListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: DevicePage) => any): Promise<DevicePage>;
-    page(params: DeviceListInstancePageOptions, callback?: (error: Error | null, items: DevicePage) => any): Promise<DevicePage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function DeviceListInstance(version: DeployedDevices, fleetSid: string): DeviceListInstance;
-export declare class DevicePage extends Page<DeployedDevices, DevicePayload, DeviceResource, DeviceInstance> {
-    /**
-     * Initialize the DevicePage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: DeployedDevices, response: Response<string>, solution: DeviceSolution);
-    /**
-     * Build an instance of DeviceInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: DeviceResource): DeviceInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

package/lib/rest/preview/deployed_devices/fleet/device.js

@@ -1,284 +0,0 @@
-"use strict";
-/*
- * This code was generated by
- * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
- *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
- *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
- *
- * Twilio - Preview
- * 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.DevicePage = exports.DeviceListInstance = exports.DeviceInstance = exports.DeviceContextImpl = 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 DeviceContextImpl {
-    constructor(_version, fleetSid, sid) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(fleetSid)) {
-            throw new Error("Parameter 'fleetSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(sid)) {
-            throw new Error("Parameter 'sid' is not valid.");
-        }
-        this._solution = { fleetSid, sid };
-        this._uri = `/Fleets/${fleetSid}/Devices/${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 DeviceInstance(operationVersion, payload, instance._solution.fleetSid, instance._solution.sid));
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    }
-    update(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["identity"] !== undefined)
-            data["Identity"] = params["identity"];
-        if (params["deploymentSid"] !== undefined)
-            data["DeploymentSid"] = params["deploymentSid"];
-        if (params["enabled"] !== undefined)
-            data["Enabled"] = serialize.bool(params["enabled"]);
-        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 DeviceInstance(operationVersion, payload, instance._solution.fleetSid, 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.DeviceContextImpl = DeviceContextImpl;
-class DeviceInstance {
-    constructor(_version, payload, fleetSid, sid) {
-        this._version = _version;
-        this.sid = payload.sid;
-        this.url = payload.url;
-        this.uniqueName = payload.unique_name;
-        this.friendlyName = payload.friendly_name;
-        this.fleetSid = payload.fleet_sid;
-        this.enabled = payload.enabled;
-        this.accountSid = payload.account_sid;
-        this.identity = payload.identity;
-        this.deploymentSid = payload.deployment_sid;
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.dateAuthenticated = deserialize.iso8601DateTime(payload.date_authenticated);
-        this._solution = { fleetSid, sid: sid || this.sid };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new DeviceContextImpl(this._version, this._solution.fleetSid, this._solution.sid);
-        return this._context;
-    }
-    /**
-     * Remove a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback) {
-        return this._proxy.remove(callback);
-    }
-    /**
-     * Fetch a DeviceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DeviceInstance
-     */
-    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 {
-            sid: this.sid,
-            url: this.url,
-            uniqueName: this.uniqueName,
-            friendlyName: this.friendlyName,
-            fleetSid: this.fleetSid,
-            enabled: this.enabled,
-            accountSid: this.accountSid,
-            identity: this.identity,
-            deploymentSid: this.deploymentSid,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            dateAuthenticated: this.dateAuthenticated,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.DeviceInstance = DeviceInstance;
-function DeviceListInstance(version, fleetSid) {
-    if (!(0, utility_1.isValidPathParam)(fleetSid)) {
-        throw new Error("Parameter 'fleetSid' is not valid.");
-    }
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new DeviceContextImpl(version, fleetSid, sid);
-    };
-    instance._version = version;
-    instance._solution = { fleetSid };
-    instance._uri = `/Fleets/${fleetSid}/Devices`;
-    instance.create = function create(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["uniqueName"] !== undefined)
-            data["UniqueName"] = params["uniqueName"];
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["identity"] !== undefined)
-            data["Identity"] = params["identity"];
-        if (params["deploymentSid"] !== undefined)
-            data["DeploymentSid"] = params["deploymentSid"];
-        if (params["enabled"] !== undefined)
-            data["Enabled"] = serialize.bool(params["enabled"]);
-        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 DeviceInstance(operationVersion, payload, instance._solution.fleetSid));
-        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["deploymentSid"] !== undefined)
-            data["DeploymentSid"] = params["deploymentSid"];
-        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 DevicePage(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 DevicePage(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.DeviceListInstance = DeviceListInstance;
-class DevicePage extends Page_1.default {
-    /**
-     * Initialize the DevicePage
-     *
-     * @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 DeviceInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new DeviceInstance(this._version, payload, this._solution.fleetSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.DevicePage = DevicePage;