twilio 5.10.7 → 5.11.0

package/lib/rest/sync/v1/service/syncMap.d.ts

@@ -1,353 +0,0 @@
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../base/Page";
-import Response from "../../../../http/response";
-import V1 from "../../V1";
-import { SyncMapItemListInstance } from "./syncMap/syncMapItem";
-import { SyncMapPermissionListInstance } from "./syncMap/syncMapPermission";
-/**
- * Options to pass to update a SyncMapInstance
- */
-export interface SyncMapContextUpdateOptions {
-    /** An alias for `collection_ttl`. If both parameters are provided, this value is ignored. */
-    ttl?: number;
-    /** How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. */
-    collectionTtl?: number;
-}
-/**
- * Options to pass to create a SyncMapInstance
- */
-export interface SyncMapListInstanceCreateOptions {
-    /** An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. */
-    uniqueName?: string;
-    /** An alias for `collection_ttl`. If both parameters are provided, this value is ignored. */
-    ttl?: number;
-    /** How long, [in seconds](https://www.twilio.com/docs/sync/limits#sync-payload-limits), before the Sync Map expires (time-to-live) and is deleted. */
-    collectionTtl?: number;
-}
-/**
- * Options to pass to each
- */
-export interface SyncMapListInstanceEachOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 100. */
-    pageSize?: number;
-    /** Function to process each record. If this and a positional callback are passed, this one will be used */
-    callback?: (item: SyncMapInstance, 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 SyncMapListInstanceOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 100. */
-    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 SyncMapListInstancePageOptions {
-    /** How many resources to return in each list page. The default is 50, and the maximum is 100. */
-    pageSize?: number;
-    /** Page Number, this value is simply for client state */
-    pageNumber?: number;
-    /** PageToken provided by the API */
-    pageToken?: string;
-}
-export interface SyncMapContext {
-    syncMapItems: SyncMapItemListInstance;
-    syncMapPermissions: SyncMapPermissionListInstance;
-    /**
-     * Remove a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Update a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    update(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Update a SyncMapInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    update(params: SyncMapContextUpdateOptions, callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface SyncMapContextSolution {
-    serviceSid: string;
-    sid: string;
-}
-export declare class SyncMapContextImpl implements SyncMapContext {
-    protected _version: V1;
-    protected _solution: SyncMapContextSolution;
-    protected _uri: string;
-    protected _syncMapItems?: SyncMapItemListInstance;
-    protected _syncMapPermissions?: SyncMapPermissionListInstance;
-    constructor(_version: V1, serviceSid: string, sid: string);
-    get syncMapItems(): SyncMapItemListInstance;
-    get syncMapPermissions(): SyncMapPermissionListInstance;
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    update(params?: SyncMapContextUpdateOptions | ((error: Error | null, item?: SyncMapInstance) => any), callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): SyncMapContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface SyncMapPayload extends TwilioResponsePayload {
-    maps: SyncMapResource[];
-}
-interface SyncMapResource {
-    sid: string;
-    unique_name: string;
-    account_sid: string;
-    service_sid: string;
-    url: string;
-    links: Record<string, string>;
-    revision: string;
-    date_expires: Date;
-    date_created: Date;
-    date_updated: Date;
-    created_by: string;
-}
-export declare class SyncMapInstance {
-    protected _version: V1;
-    protected _solution: SyncMapContextSolution;
-    protected _context?: SyncMapContext;
-    constructor(_version: V1, payload: SyncMapResource, serviceSid: string, sid?: string);
-    /**
-     * The unique string that we created to identify the Sync Map resource.
-     */
-    sid: string;
-    /**
-     * An application-defined string that uniquely identifies the resource. It can be used in place of the resource\'s `sid` in the URL to address the resource.
-     */
-    uniqueName: string;
-    /**
-     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Sync Map resource.
-     */
-    accountSid: string;
-    /**
-     * The SID of the [Sync Service](https://www.twilio.com/docs/sync/api/service) the resource is associated with.
-     */
-    serviceSid: string;
-    /**
-     * The absolute URL of the Sync Map resource.
-     */
-    url: string;
-    /**
-     * The URLs of the Sync Map\'s nested resources.
-     */
-    links: Record<string, string>;
-    /**
-     * The current revision of the Sync Map, represented as a string.
-     */
-    revision: string;
-    /**
-     * The date and time in GMT when the Sync Map expires and will be deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. If the Sync Map does not expire, this value is `null`. The Sync Map might not be deleted immediately after it expires.
-     */
-    dateExpires: Date;
-    /**
-     * 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 identity of the Sync Map\'s creator. If the Sync Map is created from the client SDK, the value matches the Access Token\'s `identity` field. If the Sync Map was created from the REST API, the value is `system`.
-     */
-    createdBy: string;
-    private get _proxy();
-    /**
-     * Remove a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Update a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    update(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Update a SyncMapInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    update(params: SyncMapContextUpdateOptions, callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Access the syncMapItems.
-     */
-    syncMapItems(): SyncMapItemListInstance;
-    /**
-     * Access the syncMapPermissions.
-     */
-    syncMapPermissions(): SyncMapPermissionListInstance;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        uniqueName: string;
-        accountSid: string;
-        serviceSid: string;
-        url: string;
-        links: Record<string, string>;
-        revision: string;
-        dateExpires: Date;
-        dateCreated: Date;
-        dateUpdated: Date;
-        createdBy: string;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface SyncMapSolution {
-    serviceSid: string;
-}
-export interface SyncMapListInstance {
-    _version: V1;
-    _solution: SyncMapSolution;
-    _uri: string;
-    (sid: string): SyncMapContext;
-    get(sid: string): SyncMapContext;
-    /**
-     * Create a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    create(callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Create a SyncMapInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    create(params: SyncMapListInstanceCreateOptions, callback?: (error: Error | null, item?: SyncMapInstance) => any): Promise<SyncMapInstance>;
-    /**
-     * Streams SyncMapInstance 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 { SyncMapListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: SyncMapInstance, done: (err?: Error) => void) => void): void;
-    each(params: SyncMapListInstanceEachOptions, callback?: (item: SyncMapInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of SyncMapInstance 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: SyncMapPage) => any): Promise<SyncMapPage>;
-    /**
-     * Lists SyncMapInstance 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 { SyncMapListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: SyncMapInstance[]) => any): Promise<SyncMapInstance[]>;
-    list(params: SyncMapListInstanceOptions, callback?: (error: Error | null, items: SyncMapInstance[]) => any): Promise<SyncMapInstance[]>;
-    /**
-     * Retrieve a single page of SyncMapInstance 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 { SyncMapListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: SyncMapPage) => any): Promise<SyncMapPage>;
-    page(params: SyncMapListInstancePageOptions, callback?: (error: Error | null, items: SyncMapPage) => any): Promise<SyncMapPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function SyncMapListInstance(version: V1, serviceSid: string): SyncMapListInstance;
-export declare class SyncMapPage extends Page<V1, SyncMapPayload, SyncMapResource, SyncMapInstance> {
-    /**
-     * Initialize the SyncMapPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: V1, response: Response<string>, solution: SyncMapSolution);
-    /**
-     * Build an instance of SyncMapInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: SyncMapResource): SyncMapInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

package/lib/rest/sync/v1/service/syncMap.js

@@ -1,306 +0,0 @@
-"use strict";
-/*
- * This code was generated by
- * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
- *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
- *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
- *
- * Twilio - Sync
- * 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.SyncMapPage = exports.SyncMapInstance = exports.SyncMapContextImpl = void 0;
-exports.SyncMapListInstance = SyncMapListInstance;
-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 syncMapItem_1 = require("./syncMap/syncMapItem");
-const syncMapPermission_1 = require("./syncMap/syncMapPermission");
-class SyncMapContextImpl {
-    constructor(_version, serviceSid, sid) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-            throw new Error("Parameter 'serviceSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(sid)) {
-            throw new Error("Parameter 'sid' is not valid.");
-        }
-        this._solution = { serviceSid, sid };
-        this._uri = `/Services/${serviceSid}/Maps/${sid}`;
-    }
-    get syncMapItems() {
-        this._syncMapItems =
-            this._syncMapItems ||
-                (0, syncMapItem_1.SyncMapItemListInstance)(this._version, this._solution.serviceSid, this._solution.sid);
-        return this._syncMapItems;
-    }
-    get syncMapPermissions() {
-        this._syncMapPermissions =
-            this._syncMapPermissions ||
-                (0, syncMapPermission_1.SyncMapPermissionListInstance)(this._version, this._solution.serviceSid, this._solution.sid);
-        return this._syncMapPermissions;
-    }
-    remove(callback) {
-        const headers = {};
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.remove({
-            uri: instance._uri,
-            method: "delete",
-            headers,
-        });
-        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
-        return operationPromise;
-    }
-    fetch(callback) {
-        const headers = {};
-        headers["Accept"] = "application/json";
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
-            uri: instance._uri,
-            method: "get",
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncMapInstance(operationVersion, payload, instance._solution.serviceSid, 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["ttl"] !== undefined)
-            data["Ttl"] = params["ttl"];
-        if (params["collectionTtl"] !== undefined)
-            data["CollectionTtl"] = params["collectionTtl"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        headers["Accept"] = "application/json";
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.update({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncMapInstance(operationVersion, payload, instance._solution.serviceSid, 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.SyncMapContextImpl = SyncMapContextImpl;
-class SyncMapInstance {
-    constructor(_version, payload, serviceSid, sid) {
-        this._version = _version;
-        this.sid = payload.sid;
-        this.uniqueName = payload.unique_name;
-        this.accountSid = payload.account_sid;
-        this.serviceSid = payload.service_sid;
-        this.url = payload.url;
-        this.links = payload.links;
-        this.revision = payload.revision;
-        this.dateExpires = deserialize.iso8601DateTime(payload.date_expires);
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.createdBy = payload.created_by;
-        this._solution = { serviceSid, sid: sid || this.sid };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new SyncMapContextImpl(this._version, this._solution.serviceSid, this._solution.sid);
-        return this._context;
-    }
-    /**
-     * Remove a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback) {
-        return this._proxy.remove(callback);
-    }
-    /**
-     * Fetch a SyncMapInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapInstance
-     */
-    fetch(callback) {
-        return this._proxy.fetch(callback);
-    }
-    update(params, callback) {
-        return this._proxy.update(params, callback);
-    }
-    /**
-     * Access the syncMapItems.
-     */
-    syncMapItems() {
-        return this._proxy.syncMapItems;
-    }
-    /**
-     * Access the syncMapPermissions.
-     */
-    syncMapPermissions() {
-        return this._proxy.syncMapPermissions;
-    }
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON() {
-        return {
-            sid: this.sid,
-            uniqueName: this.uniqueName,
-            accountSid: this.accountSid,
-            serviceSid: this.serviceSid,
-            url: this.url,
-            links: this.links,
-            revision: this.revision,
-            dateExpires: this.dateExpires,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            createdBy: this.createdBy,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.SyncMapInstance = SyncMapInstance;
-function SyncMapListInstance(version, serviceSid) {
-    if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-        throw new Error("Parameter 'serviceSid' is not valid.");
-    }
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new SyncMapContextImpl(version, serviceSid, sid);
-    };
-    instance._version = version;
-    instance._solution = { serviceSid };
-    instance._uri = `/Services/${serviceSid}/Maps`;
-    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["ttl"] !== undefined)
-            data["Ttl"] = params["ttl"];
-        if (params["collectionTtl"] !== undefined)
-            data["CollectionTtl"] = params["collectionTtl"];
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        headers["Accept"] = "application/json";
-        let operationVersion = version, operationPromise = operationVersion.create({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncMapInstance(operationVersion, payload, instance._solution.serviceSid));
-        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 = {};
-        headers["Accept"] = "application/json";
-        let operationVersion = version, operationPromise = operationVersion.page({
-            uri: instance._uri,
-            method: "get",
-            params: data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncMapPage(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 SyncMapPage(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;
-}
-class SyncMapPage extends Page_1.default {
-    /**
-     * Initialize the SyncMapPage
-     *
-     * @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 SyncMapInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new SyncMapInstance(this._version, payload, this._solution.serviceSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.SyncMapPage = SyncMapPage;