twilio 5.3.1 → 5.3.3

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

@@ -1,352 +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";
-import { CertificateListInstance } from "./fleet/certificate";
-import { DeploymentListInstance } from "./fleet/deployment";
-import { DeviceListInstance } from "./fleet/device";
-import { KeyListInstance } from "./fleet/key";
-/**
- * Options to pass to update a FleetInstance
- */
-export interface FleetContextUpdateOptions {
-    /** Provides a human readable descriptive text for this Fleet, up to 256 characters long. */
-    friendlyName?: string;
-    /** Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet. */
-    defaultDeploymentSid?: string;
-}
-/**
- * Options to pass to create a FleetInstance
- */
-export interface FleetListInstanceCreateOptions {
-    /** Provides a human readable descriptive text for this Fleet, up to 256 characters long. */
-    friendlyName?: string;
-}
-/**
- * Options to pass to each
- */
-export interface FleetListInstanceEachOptions {
-    /** 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: FleetInstance, 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 FleetListInstanceOptions {
-    /** 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 FleetListInstancePageOptions {
-    /** 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 FleetContext {
-    certificates: CertificateListInstance;
-    deployments: DeploymentListInstance;
-    devices: DeviceListInstance;
-    keys: KeyListInstance;
-    /**
-     * Remove a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    fetch(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Update a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    update(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Update a FleetInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    update(params: FleetContextUpdateOptions, callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface FleetContextSolution {
-    sid: string;
-}
-export declare class FleetContextImpl implements FleetContext {
-    protected _version: DeployedDevices;
-    protected _solution: FleetContextSolution;
-    protected _uri: string;
-    protected _certificates?: CertificateListInstance;
-    protected _deployments?: DeploymentListInstance;
-    protected _devices?: DeviceListInstance;
-    protected _keys?: KeyListInstance;
-    constructor(_version: DeployedDevices, sid: string);
-    get certificates(): CertificateListInstance;
-    get deployments(): DeploymentListInstance;
-    get devices(): DeviceListInstance;
-    get keys(): KeyListInstance;
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    update(params?: FleetContextUpdateOptions | ((error: Error | null, item?: FleetInstance) => any), callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): FleetContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface FleetPayload extends TwilioResponsePayload {
-    fleets: FleetResource[];
-}
-interface FleetResource {
-    sid: string;
-    url: string;
-    unique_name: string;
-    friendly_name: string;
-    account_sid: string;
-    default_deployment_sid: string;
-    date_created: Date;
-    date_updated: Date;
-    links: Record<string, string>;
-}
-export declare class FleetInstance {
-    protected _version: DeployedDevices;
-    protected _solution: FleetContextSolution;
-    protected _context?: FleetContext;
-    constructor(_version: DeployedDevices, payload: FleetResource, sid?: string);
-    /**
-     * Contains a 34 character string that uniquely identifies this Fleet resource.
-     */
-    sid: string;
-    /**
-     * Contains an absolute URL for this Fleet resource.
-     */
-    url: string;
-    /**
-     * Contains a unique and addressable name of this Fleet, e.g. \'default\', up to 128 characters long.
-     */
-    uniqueName: string;
-    /**
-     * Contains a human readable descriptive text for this Fleet, up to 256 characters long.
-     */
-    friendlyName: string;
-    /**
-     * Speicifies the unique string identifier of the Account responsible for this Fleet.
-     */
-    accountSid: string;
-    /**
-     * Contains the string identifier of the automatically provisioned default Deployment of this Fleet.
-     */
-    defaultDeploymentSid: string;
-    /**
-     * Specifies the date this Fleet was created, given in UTC ISO 8601 format.
-     */
-    dateCreated: Date;
-    /**
-     * Specifies the date this Fleet was last updated, given in UTC ISO 8601 format.
-     */
-    dateUpdated: Date;
-    /**
-     * Contains a dictionary of URL links to nested resources of this Fleet.
-     */
-    links: Record<string, string>;
-    private get _proxy();
-    /**
-     * Remove a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    fetch(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Update a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    update(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Update a FleetInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    update(params: FleetContextUpdateOptions, callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Access the certificates.
-     */
-    certificates(): CertificateListInstance;
-    /**
-     * Access the deployments.
-     */
-    deployments(): DeploymentListInstance;
-    /**
-     * Access the devices.
-     */
-    devices(): DeviceListInstance;
-    /**
-     * Access the keys.
-     */
-    keys(): KeyListInstance;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        url: string;
-        uniqueName: string;
-        friendlyName: string;
-        accountSid: string;
-        defaultDeploymentSid: string;
-        dateCreated: Date;
-        dateUpdated: Date;
-        links: Record<string, string>;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface FleetSolution {
-}
-export interface FleetListInstance {
-    _version: DeployedDevices;
-    _solution: FleetSolution;
-    _uri: string;
-    (sid: string): FleetContext;
-    get(sid: string): FleetContext;
-    /**
-     * Create a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    create(callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Create a FleetInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    create(params: FleetListInstanceCreateOptions, callback?: (error: Error | null, item?: FleetInstance) => any): Promise<FleetInstance>;
-    /**
-     * Streams FleetInstance 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 { FleetListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: FleetInstance, done: (err?: Error) => void) => void): void;
-    each(params: FleetListInstanceEachOptions, callback?: (item: FleetInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of FleetInstance 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: FleetPage) => any): Promise<FleetPage>;
-    /**
-     * Lists FleetInstance 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 { FleetListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: FleetInstance[]) => any): Promise<FleetInstance[]>;
-    list(params: FleetListInstanceOptions, callback?: (error: Error | null, items: FleetInstance[]) => any): Promise<FleetInstance[]>;
-    /**
-     * Retrieve a single page of FleetInstance 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 { FleetListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: FleetPage) => any): Promise<FleetPage>;
-    page(params: FleetListInstancePageOptions, callback?: (error: Error | null, items: FleetPage) => any): Promise<FleetPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function FleetListInstance(version: DeployedDevices): FleetListInstance;
-export declare class FleetPage extends Page<DeployedDevices, FleetPayload, FleetResource, FleetInstance> {
-    /**
-     * Initialize the FleetPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: DeployedDevices, response: Response<string>, solution: FleetSolution);
-    /**
-     * Build an instance of FleetInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: FleetResource): FleetInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

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

@@ -1,307 +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.FleetPage = exports.FleetListInstance = exports.FleetInstance = exports.FleetContextImpl = 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 certificate_1 = require("./fleet/certificate");
-const deployment_1 = require("./fleet/deployment");
-const device_1 = require("./fleet/device");
-const key_1 = require("./fleet/key");
-class FleetContextImpl {
-    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 = `/Fleets/${sid}`;
-    }
-    get certificates() {
-        this._certificates =
-            this._certificates ||
-                (0, certificate_1.CertificateListInstance)(this._version, this._solution.sid);
-        return this._certificates;
-    }
-    get deployments() {
-        this._deployments =
-            this._deployments ||
-                (0, deployment_1.DeploymentListInstance)(this._version, this._solution.sid);
-        return this._deployments;
-    }
-    get devices() {
-        this._devices =
-            this._devices || (0, device_1.DeviceListInstance)(this._version, this._solution.sid);
-        return this._devices;
-    }
-    get keys() {
-        this._keys =
-            this._keys || (0, key_1.KeyListInstance)(this._version, this._solution.sid);
-        return this._keys;
-    }
-    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 FleetInstance(operationVersion, payload, 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["defaultDeploymentSid"] !== undefined)
-            data["DefaultDeploymentSid"] = params["defaultDeploymentSid"];
-        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 FleetInstance(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.FleetContextImpl = FleetContextImpl;
-class FleetInstance {
-    constructor(_version, payload, sid) {
-        this._version = _version;
-        this.sid = payload.sid;
-        this.url = payload.url;
-        this.uniqueName = payload.unique_name;
-        this.friendlyName = payload.friendly_name;
-        this.accountSid = payload.account_sid;
-        this.defaultDeploymentSid = payload.default_deployment_sid;
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.links = payload.links;
-        this._solution = { sid: sid || this.sid };
-    }
-    get _proxy() {
-        this._context =
-            this._context || new FleetContextImpl(this._version, this._solution.sid);
-        return this._context;
-    }
-    /**
-     * Remove a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback) {
-        return this._proxy.remove(callback);
-    }
-    /**
-     * Fetch a FleetInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed FleetInstance
-     */
-    fetch(callback) {
-        return this._proxy.fetch(callback);
-    }
-    update(params, callback) {
-        return this._proxy.update(params, callback);
-    }
-    /**
-     * Access the certificates.
-     */
-    certificates() {
-        return this._proxy.certificates;
-    }
-    /**
-     * Access the deployments.
-     */
-    deployments() {
-        return this._proxy.deployments;
-    }
-    /**
-     * Access the devices.
-     */
-    devices() {
-        return this._proxy.devices;
-    }
-    /**
-     * Access the keys.
-     */
-    keys() {
-        return this._proxy.keys;
-    }
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON() {
-        return {
-            sid: this.sid,
-            url: this.url,
-            uniqueName: this.uniqueName,
-            friendlyName: this.friendlyName,
-            accountSid: this.accountSid,
-            defaultDeploymentSid: this.defaultDeploymentSid,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            links: this.links,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.FleetInstance = FleetInstance;
-function FleetListInstance(version) {
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new FleetContextImpl(version, sid);
-    };
-    instance._version = version;
-    instance._solution = {};
-    instance._uri = `/Fleets`;
-    instance.create = function create(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        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 FleetInstance(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 FleetPage(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 FleetPage(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.FleetListInstance = FleetListInstance;
-class FleetPage extends Page_1.default {
-    /**
-     * Initialize the FleetPage
-     *
-     * @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 FleetInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new FleetInstance(this._version, payload);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.FleetPage = FleetPage;