twilio 5.5.0 → 5.5.2

package/lib/rest/preview/sync/service/syncList/syncListItem.d.ts

@@ -1,321 +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 SyncListItemQueryFromBoundType = "inclusive" | "exclusive";
-export type SyncListItemQueryResultOrder = "asc" | "desc";
-/**
- * Options to pass to remove a SyncListItemInstance
- */
-export interface SyncListItemContextRemoveOptions {
-    /** The If-Match HTTP request header */
-    ifMatch?: string;
-}
-/**
- * Options to pass to update a SyncListItemInstance
- */
-export interface SyncListItemContextUpdateOptions {
-    /**  */
-    data: object;
-    /** The If-Match HTTP request header */
-    ifMatch?: string;
-}
-/**
- * Options to pass to create a SyncListItemInstance
- */
-export interface SyncListItemListInstanceCreateOptions {
-    /**  */
-    data: object;
-}
-/**
- * Options to pass to each
- */
-export interface SyncListItemListInstanceEachOptions {
-    /**  */
-    order?: SyncListItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncListItemQueryFromBoundType;
-    /** 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: SyncListItemInstance, 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 SyncListItemListInstanceOptions {
-    /**  */
-    order?: SyncListItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncListItemQueryFromBoundType;
-    /** 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 SyncListItemListInstancePageOptions {
-    /**  */
-    order?: SyncListItemQueryResultOrder;
-    /**  */
-    from?: string;
-    /**  */
-    bounds?: SyncListItemQueryFromBoundType;
-    /** 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 SyncListItemContext {
-    /**
-     * Remove a SyncListItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Remove a SyncListItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    remove(params: SyncListItemContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncListItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Update a SyncListItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    update(params: SyncListItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface SyncListItemContextSolution {
-    serviceSid: string;
-    listSid: string;
-    index: number;
-}
-export declare class SyncListItemContextImpl implements SyncListItemContext {
-    protected _version: Sync;
-    protected _solution: SyncListItemContextSolution;
-    protected _uri: string;
-    constructor(_version: Sync, serviceSid: string, listSid: string, index: number);
-    remove(params?: SyncListItemContextRemoveOptions | ((error: Error | null, item?: boolean) => any), callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    update(params: SyncListItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): SyncListItemContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface SyncListItemPayload extends TwilioResponsePayload {
-    items: SyncListItemResource[];
-}
-interface SyncListItemResource {
-    index: number;
-    account_sid: string;
-    service_sid: string;
-    list_sid: string;
-    url: string;
-    revision: string;
-    data: Record<string, object>;
-    date_created: Date;
-    date_updated: Date;
-    created_by: string;
-}
-export declare class SyncListItemInstance {
-    protected _version: Sync;
-    protected _solution: SyncListItemContextSolution;
-    protected _context?: SyncListItemContext;
-    constructor(_version: Sync, payload: SyncListItemResource, serviceSid: string, listSid: string, index?: number);
-    index: number;
-    accountSid: string;
-    serviceSid: string;
-    listSid: string;
-    url: string;
-    revision: string;
-    data: Record<string, object>;
-    dateCreated: Date;
-    dateUpdated: Date;
-    createdBy: string;
-    private get _proxy();
-    /**
-     * Remove a SyncListItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Remove a SyncListItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    remove(params: SyncListItemContextRemoveOptions, callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a SyncListItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    fetch(callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Update a SyncListItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    update(params: SyncListItemContextUpdateOptions, callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        index: number;
-        accountSid: string;
-        serviceSid: string;
-        listSid: string;
-        url: string;
-        revision: string;
-        data: Record<string, object>;
-        dateCreated: Date;
-        dateUpdated: Date;
-        createdBy: string;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface SyncListItemSolution {
-    serviceSid: string;
-    listSid: string;
-}
-export interface SyncListItemListInstance {
-    _version: Sync;
-    _solution: SyncListItemSolution;
-    _uri: string;
-    (index: number): SyncListItemContext;
-    get(index: number): SyncListItemContext;
-    /**
-     * Create a SyncListItemInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    create(params: SyncListItemListInstanceCreateOptions, callback?: (error: Error | null, item?: SyncListItemInstance) => any): Promise<SyncListItemInstance>;
-    /**
-     * Streams SyncListItemInstance 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 { SyncListItemListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: SyncListItemInstance, done: (err?: Error) => void) => void): void;
-    each(params: SyncListItemListInstanceEachOptions, callback?: (item: SyncListItemInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of SyncListItemInstance 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: SyncListItemPage) => any): Promise<SyncListItemPage>;
-    /**
-     * Lists SyncListItemInstance 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 { SyncListItemListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: SyncListItemInstance[]) => any): Promise<SyncListItemInstance[]>;
-    list(params: SyncListItemListInstanceOptions, callback?: (error: Error | null, items: SyncListItemInstance[]) => any): Promise<SyncListItemInstance[]>;
-    /**
-     * Retrieve a single page of SyncListItemInstance 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 { SyncListItemListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: SyncListItemPage) => any): Promise<SyncListItemPage>;
-    page(params: SyncListItemListInstancePageOptions, callback?: (error: Error | null, items: SyncListItemPage) => any): Promise<SyncListItemPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function SyncListItemListInstance(version: Sync, serviceSid: string, listSid: string): SyncListItemListInstance;
-export declare class SyncListItemPage extends Page<Sync, SyncListItemPayload, SyncListItemResource, SyncListItemInstance> {
-    /**
-     * Initialize the SyncListItemPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: Sync, response: Response<string>, solution: SyncListItemSolution);
-    /**
-     * Build an instance of SyncListItemInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: SyncListItemResource): SyncListItemInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

package/lib/rest/preview/sync/service/syncList/syncListItem.js

@@ -1,286 +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.SyncListItemPage = exports.SyncListItemListInstance = exports.SyncListItemInstance = exports.SyncListItemContextImpl = 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 SyncListItemContextImpl {
-    constructor(_version, serviceSid, listSid, index) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-            throw new Error("Parameter 'serviceSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(listSid)) {
-            throw new Error("Parameter 'listSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(index)) {
-            throw new Error("Parameter 'index' is not valid.");
-        }
-        this._solution = { serviceSid, listSid, index };
-        this._uri = `/Services/${serviceSid}/Lists/${listSid}/Items/${index}`;
-    }
-    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 SyncListItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.listSid, instance._solution.index));
-        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 SyncListItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.listSid, instance._solution.index));
-        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.SyncListItemContextImpl = SyncListItemContextImpl;
-class SyncListItemInstance {
-    constructor(_version, payload, serviceSid, listSid, index) {
-        this._version = _version;
-        this.index = deserialize.integer(payload.index);
-        this.accountSid = payload.account_sid;
-        this.serviceSid = payload.service_sid;
-        this.listSid = payload.list_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, listSid, index: index || this.index };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new SyncListItemContextImpl(this._version, this._solution.serviceSid, this._solution.listSid, this._solution.index);
-        return this._context;
-    }
-    remove(params, callback) {
-        return this._proxy.remove(params, callback);
-    }
-    /**
-     * Fetch a SyncListItemInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed SyncListItemInstance
-     */
-    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 {
-            index: this.index,
-            accountSid: this.accountSid,
-            serviceSid: this.serviceSid,
-            listSid: this.listSid,
-            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.SyncListItemInstance = SyncListItemInstance;
-function SyncListItemListInstance(version, serviceSid, listSid) {
-    if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-        throw new Error("Parameter 'serviceSid' is not valid.");
-    }
-    if (!(0, utility_1.isValidPathParam)(listSid)) {
-        throw new Error("Parameter 'listSid' is not valid.");
-    }
-    const instance = ((index) => instance.get(index));
-    instance.get = function get(index) {
-        return new SyncListItemContextImpl(version, serviceSid, listSid, index);
-    };
-    instance._version = version;
-    instance._solution = { serviceSid, listSid };
-    instance._uri = `/Services/${serviceSid}/Lists/${listSid}/Items`;
-    instance.create = function create(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";
-        let operationVersion = version, operationPromise = operationVersion.create({
-            uri: instance._uri,
-            method: "post",
-            data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new SyncListItemInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.listSid));
-        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 SyncListItemPage(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 SyncListItemPage(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.SyncListItemListInstance = SyncListItemListInstance;
-class SyncListItemPage extends Page_1.default {
-    /**
-     * Initialize the SyncListItemPage
-     *
-     * @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 SyncListItemInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new SyncListItemInstance(this._version, payload, this._solution.serviceSid, this._solution.listSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.SyncListItemPage = SyncListItemPage;