twilio 5.5.0 → 5.5.2

package/lib/rest/preview/sync/service/syncMap/syncMapItem.d.ts

@@ -1,323 +0,0 @@
-/// <reference types="node" />
-import { inspect, InspectOptions } from "util";
-import Page, { TwilioResponsePayload } from "../../../../../base/Page";
-import Response from "../../../../../http/response";
-import Sync from "../../../Sync";
-export type SyncMapItemQueryFromBoundType = "inclusive" | "exclusive";
-export type SyncMapItemQueryResultOrder = "asc" | "desc";
-/**
- * Options to pass to remove a SyncMapItemInstance
- */
-export interface SyncMapItemContextRemoveOptions {
-    /** The If-Match HTTP request header */
-    ifMatch?: string;
-}
-/**
- * Options to pass to update a SyncMapItemInstance
- */
-export interface SyncMapItemContextUpdateOptions {
-    /**  */
-    data: object;
-    /** The If-Match HTTP request header */
-    ifMatch?: string;
-}
-/**
- * Options to pass to create a SyncMapItemInstance
- */
-export interface SyncMapItemListInstanceCreateOptions {
-    /**  */
-    key: string;
-    /**  */
-    data: object;
-}
-/**
- * Options to pass to each
- */
-export interface SyncMapItemListInstanceEachOptions {
-    /**  */
-    order?: SyncMapItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncMapItemQueryFromBoundType;
-    /** 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: SyncMapItemInstance, 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 SyncMapItemListInstanceOptions {
-    /**  */
-    order?: SyncMapItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncMapItemQueryFromBoundType;
-    /** 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 SyncMapItemListInstancePageOptions {
-    /**  */
-    order?: SyncMapItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncMapItemQueryFromBoundType;
-    /** 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 SyncMapItemContext {
-    /**
-     * Remove a SyncMapItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Remove a SyncMapItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    remove(params: SyncMapItemContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncMapItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Update a SyncMapItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    update(params: SyncMapItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface SyncMapItemContextSolution {
-    serviceSid: string;
-    mapSid: string;
-    key: string;
-}
-export declare class SyncMapItemContextImpl implements SyncMapItemContext {
-    protected _version: Sync;
-    protected _solution: SyncMapItemContextSolution;
-    protected _uri: string;
-    constructor(_version: Sync, serviceSid: string, mapSid: string, key: string);
-    remove(params?: SyncMapItemContextRemoveOptions | ((error: Error | null, item?: boolean) => any), callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    update(params: SyncMapItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): SyncMapItemContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface SyncMapItemPayload extends TwilioResponsePayload {
-    items: SyncMapItemResource[];
-}
-interface SyncMapItemResource {
-    key: string;
-    account_sid: string;
-    service_sid: string;
-    map_sid: string;
-    url: string;
-    revision: string;
-    data: Record<string, object>;
-    date_created: Date;
-    date_updated: Date;
-    created_by: string;
-}
-export declare class SyncMapItemInstance {
-    protected _version: Sync;
-    protected _solution: SyncMapItemContextSolution;
-    protected _context?: SyncMapItemContext;
-    constructor(_version: Sync, payload: SyncMapItemResource, serviceSid: string, mapSid: string, key?: string);
-    key: string;
-    accountSid: string;
-    serviceSid: string;
-    mapSid: string;
-    url: string;
-    revision: string;
-    data: Record<string, object>;
-    dateCreated: Date;
-    dateUpdated: Date;
-    createdBy: string;
-    private get _proxy();
-    /**
-     * Remove a SyncMapItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Remove a SyncMapItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    remove(params: SyncMapItemContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncMapItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Update a SyncMapItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    update(params: SyncMapItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        key: string;
-        accountSid: string;
-        serviceSid: string;
-        mapSid: string;
-        url: string;
-        revision: string;
-        data: Record<string, object>;
-        dateCreated: Date;
-        dateUpdated: Date;
-        createdBy: string;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface SyncMapItemSolution {
-    serviceSid: string;
-    mapSid: string;
-}
-export interface SyncMapItemListInstance {
-    _version: Sync;
-    _solution: SyncMapItemSolution;
-    _uri: string;
-    (key: string): SyncMapItemContext;
-    get(key: string): SyncMapItemContext;
-    /**
-     * Create a SyncMapItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    create(params: SyncMapItemListInstanceCreateOptions, callback?: (error: Error | null, item?: SyncMapItemInstance) => any): Promise<SyncMapItemInstance>;
-    /**
-     * Streams SyncMapItemInstance 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 { SyncMapItemListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: SyncMapItemInstance, done: (err?: Error) => void) => void): void;
-    each(params: SyncMapItemListInstanceEachOptions, callback?: (item: SyncMapItemInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of SyncMapItemInstance 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: SyncMapItemPage) => any): Promise<SyncMapItemPage>;
-    /**
-     * Lists SyncMapItemInstance 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 { SyncMapItemListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: SyncMapItemInstance[]) => any): Promise<SyncMapItemInstance[]>;
-    list(params: SyncMapItemListInstanceOptions, callback?: (error: Error | null, items: SyncMapItemInstance[]) => any): Promise<SyncMapItemInstance[]>;
-    /**
-     * Retrieve a single page of SyncMapItemInstance 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 { SyncMapItemListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: SyncMapItemPage) => any): Promise<SyncMapItemPage>;
-    page(params: SyncMapItemListInstancePageOptions, callback?: (error: Error | null, items: SyncMapItemPage) => any): Promise<SyncMapItemPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function SyncMapItemListInstance(version: Sync, serviceSid: string, mapSid: string): SyncMapItemListInstance;
-export declare class SyncMapItemPage extends Page<Sync, SyncMapItemPayload, SyncMapItemResource, SyncMapItemInstance> {
-    /**
-     * Initialize the SyncMapItemPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: Sync, response: Response<string>, solution: SyncMapItemSolution);
-    /**
-     * Build an instance of SyncMapItemInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: SyncMapItemResource): SyncMapItemInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

package/lib/rest/preview/sync/service/syncMap/syncMapItem.js

@@ -1,290 +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.SyncMapItemPage = exports.SyncMapItemListInstance = exports.SyncMapItemInstance = exports.SyncMapItemContextImpl = 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 SyncMapItemContextImpl {
-    constructor(_version, serviceSid, mapSid, key) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-            throw new Error("Parameter 'serviceSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(mapSid)) {
-            throw new Error("Parameter 'mapSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(key)) {
-            throw new Error("Parameter 'key' is not valid.");
-        }
-        this._solution = { serviceSid, mapSid, key };
-        this._uri = `/Services/${serviceSid}/Maps/${mapSid}/Items/${key}`;
-    }
-    remove(params, callback) {
-        if (params instanceof Function) {
-            callback = params;
-            params = {};
-        }
-        else {
-            params = params || {};
-        }
-        let data = {};
-        const headers = {};
-        if (params["ifMatch"] !== undefined)
-            headers["If-Match"] = params["ifMatch"];
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.remove({
-            uri: instance._uri,
-            method: "delete",
-            params: data,
-            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 SyncMapItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.mapSid, 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["data"] === null || params["data"] === undefined) {
-            throw new Error("Required parameter \"params['data']\" missing.");
-        }
-        let data = {};
-        data["Data"] = serialize.object(params["data"]);
-        const headers = {};
-        headers["Content-Type"] = "application/x-www-form-urlencoded";
-        headers["Accept"] = "application/json";
-        if (params["ifMatch"] !== undefined)
-            headers["If-Match"] = params["ifMatch"];
-        const instance = this;
-        let operationVersion = instance._version, operationPromise = operationVersion.update({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncMapItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.mapSid, 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.SyncMapItemContextImpl = SyncMapItemContextImpl;
-class SyncMapItemInstance {
-    constructor(_version, payload, serviceSid, mapSid, key) {
-        this._version = _version;
-        this.key = payload.key;
-        this.accountSid = payload.account_sid;
-        this.serviceSid = payload.service_sid;
-        this.mapSid = payload.map_sid;
-        this.url = payload.url;
-        this.revision = payload.revision;
-        this.data = payload.data;
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.createdBy = payload.created_by;
-        this._solution = { serviceSid, mapSid, key: key || this.key };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new SyncMapItemContextImpl(this._version, this._solution.serviceSid, this._solution.mapSid, this._solution.key);
-        return this._context;
-    }
-    remove(params, callback) {
-        return this._proxy.remove(params, callback);
-    }
-    /**
-     * Fetch a SyncMapItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncMapItemInstance
-     */
-    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,
-            accountSid: this.accountSid,
-            serviceSid: this.serviceSid,
-            mapSid: this.mapSid,
-            url: this.url,
-            revision: this.revision,
-            data: this.data,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            createdBy: this.createdBy,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.SyncMapItemInstance = SyncMapItemInstance;
-function SyncMapItemListInstance(version, serviceSid, mapSid) {
-    if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-        throw new Error("Parameter 'serviceSid' is not valid.");
-    }
-    if (!(0, utility_1.isValidPathParam)(mapSid)) {
-        throw new Error("Parameter 'mapSid' is not valid.");
-    }
-    const instance = ((key) => instance.get(key));
-    instance.get = function get(key) {
-        return new SyncMapItemContextImpl(version, serviceSid, mapSid, key);
-    };
-    instance._version = version;
-    instance._solution = { serviceSid, mapSid };
-    instance._uri = `/Services/${serviceSid}/Maps/${mapSid}/Items`;
-    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["data"] === null || params["data"] === undefined) {
-            throw new Error("Required parameter \"params['data']\" missing.");
-        }
-        let data = {};
-        data["Key"] = params["key"];
-        data["Data"] = serialize.object(params["data"]);
-        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 SyncMapItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.mapSid));
-        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["order"] !== undefined)
-            data["Order"] = params["order"];
-        if (params["from"] !== undefined)
-            data["From"] = params["from"];
-        if (params["bounds"] !== undefined)
-            data["Bounds"] = params["bounds"];
-        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 SyncMapItemPage(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 SyncMapItemPage(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.SyncMapItemListInstance = SyncMapItemListInstance;
-class SyncMapItemPage extends Page_1.default {
-    /**
-     * Initialize the SyncMapItemPage
-     *
-     * @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 SyncMapItemInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new SyncMapItemInstance(this._version, payload, this._solution.serviceSid, this._solution.mapSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.SyncMapItemPage = SyncMapItemPage;