twilio 5.5.0 → 5.5.2

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

@@ -1,330 +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";
-import { DocumentListInstance } from "./service/document";
-import { SyncListListInstance } from "./service/syncList";
-import { SyncMapListInstance } from "./service/syncMap";
-/**
- * Options to pass to update a ServiceInstance
- */
-export interface ServiceContextUpdateOptions {
-    /**  */
-    webhookUrl?: string;
-    /**  */
-    friendlyName?: string;
-    /**  */
-    reachabilityWebhooksEnabled?: boolean;
-    /**  */
-    aclEnabled?: boolean;
-}
-/**
- * Options to pass to create a ServiceInstance
- */
-export interface ServiceListInstanceCreateOptions {
-    /**  */
-    friendlyName?: string;
-    /**  */
-    webhookUrl?: string;
-    /**  */
-    reachabilityWebhooksEnabled?: boolean;
-    /**  */
-    aclEnabled?: boolean;
-}
-/**
- * Options to pass to each
- */
-export interface ServiceListInstanceEachOptions {
-    /** 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: ServiceInstance, 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 ServiceListInstanceOptions {
-    /** 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 ServiceListInstancePageOptions {
-    /** 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 ServiceContext {
-    documents: DocumentListInstance;
-    syncLists: SyncListListInstance;
-    syncMaps: SyncMapListInstance;
-    /**
-     * Remove a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    fetch(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Update a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    update(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Update a ServiceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    update(params: ServiceContextUpdateOptions, callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface ServiceContextSolution {
-    sid: string;
-}
-export declare class ServiceContextImpl implements ServiceContext {
-    protected _version: Sync;
-    protected _solution: ServiceContextSolution;
-    protected _uri: string;
-    protected _documents?: DocumentListInstance;
-    protected _syncLists?: SyncListListInstance;
-    protected _syncMaps?: SyncMapListInstance;
-    constructor(_version: Sync, sid: string);
-    get documents(): DocumentListInstance;
-    get syncLists(): SyncListListInstance;
-    get syncMaps(): SyncMapListInstance;
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    update(params?: ServiceContextUpdateOptions | ((error: Error | null, item?: ServiceInstance) => any), callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): ServiceContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface ServicePayload extends TwilioResponsePayload {
-    services: ServiceResource[];
-}
-interface ServiceResource {
-    sid: string;
-    account_sid: string;
-    friendly_name: string;
-    date_created: Date;
-    date_updated: Date;
-    url: string;
-    webhook_url: string;
-    reachability_webhooks_enabled: boolean;
-    acl_enabled: boolean;
-    links: Record<string, string>;
-}
-export declare class ServiceInstance {
-    protected _version: Sync;
-    protected _solution: ServiceContextSolution;
-    protected _context?: ServiceContext;
-    constructor(_version: Sync, payload: ServiceResource, sid?: string);
-    sid: string;
-    accountSid: string;
-    friendlyName: string;
-    dateCreated: Date;
-    dateUpdated: Date;
-    url: string;
-    webhookUrl: string;
-    reachabilityWebhooksEnabled: boolean;
-    aclEnabled: boolean;
-    links: Record<string, string>;
-    private get _proxy();
-    /**
-     * Remove a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    fetch(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Update a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    update(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Update a ServiceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    update(params: ServiceContextUpdateOptions, callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Access the documents.
-     */
-    documents(): DocumentListInstance;
-    /**
-     * Access the syncLists.
-     */
-    syncLists(): SyncListListInstance;
-    /**
-     * Access the syncMaps.
-     */
-    syncMaps(): SyncMapListInstance;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        accountSid: string;
-        friendlyName: string;
-        dateCreated: Date;
-        dateUpdated: Date;
-        url: string;
-        webhookUrl: string;
-        reachabilityWebhooksEnabled: boolean;
-        aclEnabled: boolean;
-        links: Record<string, string>;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface ServiceSolution {
-}
-export interface ServiceListInstance {
-    _version: Sync;
-    _solution: ServiceSolution;
-    _uri: string;
-    (sid: string): ServiceContext;
-    get(sid: string): ServiceContext;
-    /**
-     * Create a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    create(callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Create a ServiceInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    create(params: ServiceListInstanceCreateOptions, callback?: (error: Error | null, item?: ServiceInstance) => any): Promise<ServiceInstance>;
-    /**
-     * Streams ServiceInstance 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 { ServiceListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: ServiceInstance, done: (err?: Error) => void) => void): void;
-    each(params: ServiceListInstanceEachOptions, callback?: (item: ServiceInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of ServiceInstance 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: ServicePage) => any): Promise<ServicePage>;
-    /**
-     * Lists ServiceInstance 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 { ServiceListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: ServiceInstance[]) => any): Promise<ServiceInstance[]>;
-    list(params: ServiceListInstanceOptions, callback?: (error: Error | null, items: ServiceInstance[]) => any): Promise<ServiceInstance[]>;
-    /**
-     * Retrieve a single page of ServiceInstance 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 { ServiceListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>;
-    page(params: ServiceListInstancePageOptions, callback?: (error: Error | null, items: ServicePage) => any): Promise<ServicePage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function ServiceListInstance(version: Sync): ServiceListInstance;
-export declare class ServicePage extends Page<Sync, ServicePayload, ServiceResource, ServiceInstance> {
-    /**
-     * Initialize the ServicePage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: Sync, response: Response<string>, solution: ServiceSolution);
-    /**
-     * Build an instance of ServiceInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: ServiceResource): ServiceInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};

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

@@ -1,316 +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.ServicePage = exports.ServiceListInstance = exports.ServiceInstance = exports.ServiceContextImpl = 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 document_1 = require("./service/document");
-const syncList_1 = require("./service/syncList");
-const syncMap_1 = require("./service/syncMap");
-class ServiceContextImpl {
-    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 = `/Services/${sid}`;
-    }
-    get documents() {
-        this._documents =
-            this._documents ||
-                (0, document_1.DocumentListInstance)(this._version, this._solution.sid);
-        return this._documents;
-    }
-    get syncLists() {
-        this._syncLists =
-            this._syncLists ||
-                (0, syncList_1.SyncListListInstance)(this._version, this._solution.sid);
-        return this._syncLists;
-    }
-    get syncMaps() {
-        this._syncMaps =
-            this._syncMaps || (0, syncMap_1.SyncMapListInstance)(this._version, this._solution.sid);
-        return this._syncMaps;
-    }
-    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 ServiceInstance(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["webhookUrl"] !== undefined)
-            data["WebhookUrl"] = params["webhookUrl"];
-        if (params["friendlyName"] !== undefined)
-            data["FriendlyName"] = params["friendlyName"];
-        if (params["reachabilityWebhooksEnabled"] !== undefined)
-            data["ReachabilityWebhooksEnabled"] = serialize.bool(params["reachabilityWebhooksEnabled"]);
-        if (params["aclEnabled"] !== undefined)
-            data["AclEnabled"] = serialize.bool(params["aclEnabled"]);
-        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 ServiceInstance(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.ServiceContextImpl = ServiceContextImpl;
-class ServiceInstance {
-    constructor(_version, payload, sid) {
-        this._version = _version;
-        this.sid = payload.sid;
-        this.accountSid = payload.account_sid;
-        this.friendlyName = payload.friendly_name;
-        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
-        this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated);
-        this.url = payload.url;
-        this.webhookUrl = payload.webhook_url;
-        this.reachabilityWebhooksEnabled = payload.reachability_webhooks_enabled;
-        this.aclEnabled = payload.acl_enabled;
-        this.links = payload.links;
-        this._solution = { sid: sid || this.sid };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new ServiceContextImpl(this._version, this._solution.sid);
-        return this._context;
-    }
-    /**
-     * Remove a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback) {
-        return this._proxy.remove(callback);
-    }
-    /**
-     * Fetch a ServiceInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed ServiceInstance
-     */
-    fetch(callback) {
-        return this._proxy.fetch(callback);
-    }
-    update(params, callback) {
-        return this._proxy.update(params, callback);
-    }
-    /**
-     * Access the documents.
-     */
-    documents() {
-        return this._proxy.documents;
-    }
-    /**
-     * Access the syncLists.
-     */
-    syncLists() {
-        return this._proxy.syncLists;
-    }
-    /**
-     * Access the syncMaps.
-     */
-    syncMaps() {
-        return this._proxy.syncMaps;
-    }
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON() {
-        return {
-            sid: this.sid,
-            accountSid: this.accountSid,
-            friendlyName: this.friendlyName,
-            dateCreated: this.dateCreated,
-            dateUpdated: this.dateUpdated,
-            url: this.url,
-            webhookUrl: this.webhookUrl,
-            reachabilityWebhooksEnabled: this.reachabilityWebhooksEnabled,
-            aclEnabled: this.aclEnabled,
-            links: this.links,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.ServiceInstance = ServiceInstance;
-function ServiceListInstance(version) {
-    const instance = ((sid) => instance.get(sid));
-    instance.get = function get(sid) {
-        return new ServiceContextImpl(version, sid);
-    };
-    instance._version = version;
-    instance._solution = {};
-    instance._uri = `/Services`;
-    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"];
-        if (params["webhookUrl"] !== undefined)
-            data["WebhookUrl"] = params["webhookUrl"];
-        if (params["reachabilityWebhooksEnabled"] !== undefined)
-            data["ReachabilityWebhooksEnabled"] = serialize.bool(params["reachabilityWebhooksEnabled"]);
-        if (params["aclEnabled"] !== undefined)
-            data["AclEnabled"] = serialize.bool(params["aclEnabled"]);
-        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 ServiceInstance(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 = {};
-        headers["Accept"] = "application/json";
-        let operationVersion = version, operationPromise = operationVersion.page({
-            uri: instance._uri,
-            method: "get",
-            params: data,
-            headers,
-        });
-        operationPromise = operationPromise.then((payload) => new ServicePage(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 ServicePage(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.ServiceListInstance = ServiceListInstance;
-class ServicePage extends Page_1.default {
-    /**
-     * Initialize the ServicePage
-     *
-     * @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 ServiceInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new ServiceInstance(this._version, payload);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.ServicePage = ServicePage;