twilio 5.5.0 → 5.5.2

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

@@ -1,260 +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.DocumentPermissionPage = exports.DocumentPermissionListInstance = exports.DocumentPermissionInstance = exports.DocumentPermissionContextImpl = 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 DocumentPermissionContextImpl {
-    constructor(_version, serviceSid, documentSid, identity) {
-        this._version = _version;
-        if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-            throw new Error("Parameter 'serviceSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(documentSid)) {
-            throw new Error("Parameter 'documentSid' is not valid.");
-        }
-        if (!(0, utility_1.isValidPathParam)(identity)) {
-            throw new Error("Parameter 'identity' is not valid.");
-        }
-        this._solution = { serviceSid, documentSid, identity };
-        this._uri = `/Services/${serviceSid}/Documents/${documentSid}/Permissions/${identity}`;
-    }
-    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 DocumentPermissionInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.documentSid, instance._solution.identity));
-        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["read"] === null || params["read"] === undefined) {
-            throw new Error("Required parameter \"params['read']\" missing.");
-        }
-        if (params["write"] === null || params["write"] === undefined) {
-            throw new Error("Required parameter \"params['write']\" missing.");
-        }
-        if (params["manage"] === null || params["manage"] === undefined) {
-            throw new Error("Required parameter \"params['manage']\" missing.");
-        }
-        let data = {};
-        data["Read"] = serialize.bool(params["read"]);
-        data["Write"] = serialize.bool(params["write"]);
-        data["Manage"] = serialize.bool(params["manage"]);
-        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 DocumentPermissionInstance(operationVersion, payload, instance._solution.serviceSid, instance._solution.documentSid, instance._solution.identity));
-        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.DocumentPermissionContextImpl = DocumentPermissionContextImpl;
-class DocumentPermissionInstance {
-    constructor(_version, payload, serviceSid, documentSid, identity) {
-        this._version = _version;
-        this.accountSid = payload.account_sid;
-        this.serviceSid = payload.service_sid;
-        this.documentSid = payload.document_sid;
-        this.identity = payload.identity;
-        this.read = payload.read;
-        this.write = payload.write;
-        this.manage = payload.manage;
-        this.url = payload.url;
-        this._solution = {
-            serviceSid,
-            documentSid,
-            identity: identity || this.identity,
-        };
-    }
-    get _proxy() {
-        this._context =
-            this._context ||
-                new DocumentPermissionContextImpl(this._version, this._solution.serviceSid, this._solution.documentSid, this._solution.identity);
-        return this._context;
-    }
-    /**
-     * Remove a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback) {
-        return this._proxy.remove(callback);
-    }
-    /**
-     * Fetch a DocumentPermissionInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentPermissionInstance
-     */
-    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 {
-            accountSid: this.accountSid,
-            serviceSid: this.serviceSid,
-            documentSid: this.documentSid,
-            identity: this.identity,
-            read: this.read,
-            write: this.write,
-            manage: this.manage,
-            url: this.url,
-        };
-    }
-    [util_1.inspect.custom](_depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.DocumentPermissionInstance = DocumentPermissionInstance;
-function DocumentPermissionListInstance(version, serviceSid, documentSid) {
-    if (!(0, utility_1.isValidPathParam)(serviceSid)) {
-        throw new Error("Parameter 'serviceSid' is not valid.");
-    }
-    if (!(0, utility_1.isValidPathParam)(documentSid)) {
-        throw new Error("Parameter 'documentSid' is not valid.");
-    }
-    const instance = ((identity) => instance.get(identity));
-    instance.get = function get(identity) {
-        return new DocumentPermissionContextImpl(version, serviceSid, documentSid, identity);
-    };
-    instance._version = version;
-    instance._solution = { serviceSid, documentSid };
-    instance._uri = `/Services/${serviceSid}/Documents/${documentSid}/Permissions`;
-    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 DocumentPermissionPage(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 DocumentPermissionPage(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.DocumentPermissionListInstance = DocumentPermissionListInstance;
-class DocumentPermissionPage extends Page_1.default {
-    /**
-     * Initialize the DocumentPermissionPage
-     *
-     * @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 DocumentPermissionInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload) {
-        return new DocumentPermissionInstance(this._version, payload, this._solution.serviceSid, this._solution.documentSid);
-    }
-    [util_1.inspect.custom](depth, options) {
-        return (0, util_1.inspect)(this.toJSON(), options);
-    }
-}
-exports.DocumentPermissionPage = DocumentPermissionPage;

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

@@ -1,295 +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 { DocumentPermissionListInstance } from "./document/documentPermission";
-/**
- * Options to pass to update a DocumentInstance
- */
-export interface DocumentContextUpdateOptions {
-    /**  */
-    data: object;
-    /** The If-Match HTTP request header */
-    ifMatch?: string;
-}
-/**
- * Options to pass to create a DocumentInstance
- */
-export interface DocumentListInstanceCreateOptions {
-    /**  */
-    uniqueName?: string;
-    /**  */
-    data?: object;
-}
-/**
- * Options to pass to each
- */
-export interface DocumentListInstanceEachOptions {
-    /** 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: DocumentInstance, 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 DocumentListInstanceOptions {
-    /** 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 DocumentListInstancePageOptions {
-    /** 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 DocumentContext {
-    documentPermissions: DocumentPermissionListInstance;
-    /**
-     * Remove a DocumentInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DocumentInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Update a DocumentInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    update(params: DocumentContextUpdateOptions, callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export interface DocumentContextSolution {
-    serviceSid: string;
-    sid: string;
-}
-export declare class DocumentContextImpl implements DocumentContext {
-    protected _version: Sync;
-    protected _solution: DocumentContextSolution;
-    protected _uri: string;
-    protected _documentPermissions?: DocumentPermissionListInstance;
-    constructor(_version: Sync, serviceSid: string, sid: string);
-    get documentPermissions(): DocumentPermissionListInstance;
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    fetch(callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    update(params: DocumentContextUpdateOptions, callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): DocumentContextSolution;
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-interface DocumentPayload extends TwilioResponsePayload {
-    documents: DocumentResource[];
-}
-interface DocumentResource {
-    sid: string;
-    unique_name: string;
-    account_sid: string;
-    service_sid: string;
-    url: string;
-    links: Record<string, string>;
-    revision: string;
-    data: Record<string, object>;
-    date_created: Date;
-    date_updated: Date;
-    created_by: string;
-}
-export declare class DocumentInstance {
-    protected _version: Sync;
-    protected _solution: DocumentContextSolution;
-    protected _context?: DocumentContext;
-    constructor(_version: Sync, payload: DocumentResource, serviceSid: string, sid?: string);
-    sid: string;
-    uniqueName: string;
-    accountSid: string;
-    serviceSid: string;
-    url: string;
-    links: Record<string, string>;
-    revision: string;
-    data: Record<string, object>;
-    dateCreated: Date;
-    dateUpdated: Date;
-    createdBy: string;
-    private get _proxy();
-    /**
-     * Remove a DocumentInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed boolean
-     */
-    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
-    /**
-     * Fetch a DocumentInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    fetch(callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Update a DocumentInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    update(params: DocumentContextUpdateOptions, callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Access the documentPermissions.
-     */
-    documentPermissions(): DocumentPermissionListInstance;
-    /**
-     * Provide a user-friendly representation
-     *
-     * @returns Object
-     */
-    toJSON(): {
-        sid: string;
-        uniqueName: string;
-        accountSid: string;
-        serviceSid: string;
-        url: string;
-        links: Record<string, string>;
-        revision: string;
-        data: Record<string, object>;
-        dateCreated: Date;
-        dateUpdated: Date;
-        createdBy: string;
-    };
-    [inspect.custom](_depth: any, options: InspectOptions): string;
-}
-export interface DocumentSolution {
-    serviceSid: string;
-}
-export interface DocumentListInstance {
-    _version: Sync;
-    _solution: DocumentSolution;
-    _uri: string;
-    (sid: string): DocumentContext;
-    get(sid: string): DocumentContext;
-    /**
-     * Create a DocumentInstance
-     *
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    create(callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Create a DocumentInstance
-     *
-     * @param params - Parameter for request
-     * @param callback - Callback to handle processed record
-     *
-     * @returns Resolves to processed DocumentInstance
-     */
-    create(params: DocumentListInstanceCreateOptions, callback?: (error: Error | null, item?: DocumentInstance) => any): Promise<DocumentInstance>;
-    /**
-     * Streams DocumentInstance 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 { DocumentListInstanceEachOptions } [params] - Options for request
-     * @param { function } [callback] - Function to process each record
-     */
-    each(callback?: (item: DocumentInstance, done: (err?: Error) => void) => void): void;
-    each(params: DocumentListInstanceEachOptions, callback?: (item: DocumentInstance, done: (err?: Error) => void) => void): void;
-    /**
-     * Retrieve a single target page of DocumentInstance 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: DocumentPage) => any): Promise<DocumentPage>;
-    /**
-     * Lists DocumentInstance 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 { DocumentListInstanceOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    list(callback?: (error: Error | null, items: DocumentInstance[]) => any): Promise<DocumentInstance[]>;
-    list(params: DocumentListInstanceOptions, callback?: (error: Error | null, items: DocumentInstance[]) => any): Promise<DocumentInstance[]>;
-    /**
-     * Retrieve a single page of DocumentInstance 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 { DocumentListInstancePageOptions } [params] - Options for request
-     * @param { function } [callback] - Callback to handle list of records
-     */
-    page(callback?: (error: Error | null, items: DocumentPage) => any): Promise<DocumentPage>;
-    page(params: DocumentListInstancePageOptions, callback?: (error: Error | null, items: DocumentPage) => any): Promise<DocumentPage>;
-    /**
-     * Provide a user-friendly representation
-     */
-    toJSON(): any;
-    [inspect.custom](_depth: any, options: InspectOptions): any;
-}
-export declare function DocumentListInstance(version: Sync, serviceSid: string): DocumentListInstance;
-export declare class DocumentPage extends Page<Sync, DocumentPayload, DocumentResource, DocumentInstance> {
-    /**
-     * Initialize the DocumentPage
-     *
-     * @param version - Version of the resource
-     * @param response - Response from the API
-     * @param solution - Path solution
-     */
-    constructor(version: Sync, response: Response<string>, solution: DocumentSolution);
-    /**
-     * Build an instance of DocumentInstance
-     *
-     * @param payload - Payload response from the API
-     */
-    getInstance(payload: DocumentResource): DocumentInstance;
-    [inspect.custom](depth: any, options: InspectOptions): string;
-}
-export {};