twilio 5.3.7 → 5.4.0

package/lib/rest/previewIam/versionless/organization/account.d.ts

@@ -0,0 +1,216 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import Versionless from "../../Versionless";
+/**
+ * Options to pass to each
+ */
+export interface AccountListInstanceEachOptions {
+    /**  */
+    pageSize?: number;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: AccountInstance, 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 AccountListInstanceOptions {
+    /**  */
+    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 AccountListInstancePageOptions {
+    /**  */
+    pageSize?: number;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface AccountContext {
+    /**
+     * Fetch a AccountInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AccountInstance) => any): Promise<AccountInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface AccountContextSolution {
+    organizationSid: string;
+    accountSid: string;
+}
+export declare class AccountContextImpl implements AccountContext {
+    protected _version: Versionless;
+    protected _solution: AccountContextSolution;
+    protected _uri: string;
+    constructor(_version: Versionless, organizationSid: string, accountSid: string);
+    fetch(callback?: (error: Error | null, item?: AccountInstance) => any): Promise<AccountInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): AccountContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface AccountPayload extends TwilioResponsePayload {
+    content: AccountResource[];
+}
+interface AccountResource {
+    account_sid: string;
+    friendly_name: string;
+    status: string;
+    owner_sid: string;
+    date_created: Date;
+}
+/**
+ * Page content
+ */
+export declare class AccountInstance {
+    protected _version: Versionless;
+    protected _solution: AccountContextSolution;
+    protected _context?: AccountContext;
+    constructor(_version: Versionless, payload: AccountResource, organizationSid: string, accountSid?: string);
+    /**
+     * Twilio account sid
+     */
+    accountSid: string;
+    /**
+     * Account friendly name
+     */
+    friendlyName: string;
+    /**
+     * Account status
+     */
+    status: string;
+    /**
+     * Twilio account sid
+     */
+    ownerSid: string;
+    /**
+     * The date and time when the account was created in the system
+     */
+    dateCreated: Date;
+    private get _proxy();
+    /**
+     * Fetch a AccountInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountInstance
+     */
+    fetch(callback?: (error: Error | null, item?: AccountInstance) => any): Promise<AccountInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        accountSid: string;
+        friendlyName: string;
+        status: string;
+        ownerSid: string;
+        dateCreated: Date;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface AccountSolution {
+    organizationSid: string;
+}
+export interface AccountListInstance {
+    _version: Versionless;
+    _solution: AccountSolution;
+    _uri: string;
+    (accountSid: string): AccountContext;
+    get(accountSid: string): AccountContext;
+    /**
+     * Streams AccountInstance 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 { AccountListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: AccountInstance, done: (err?: Error) => void) => void): void;
+    each(params: AccountListInstanceEachOptions, callback?: (item: AccountInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of AccountInstance 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: AccountPage) => any): Promise<AccountPage>;
+    /**
+     * Lists AccountInstance 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 { AccountListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: AccountInstance[]) => any): Promise<AccountInstance[]>;
+    list(params: AccountListInstanceOptions, callback?: (error: Error | null, items: AccountInstance[]) => any): Promise<AccountInstance[]>;
+    /**
+     * Retrieve a single page of AccountInstance 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 { AccountListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: AccountPage) => any): Promise<AccountPage>;
+    page(params: AccountListInstancePageOptions, callback?: (error: Error | null, items: AccountPage) => any): Promise<AccountPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function AccountListInstance(version: Versionless, organizationSid: string): AccountListInstance;
+export declare class AccountPage extends Page<Versionless, AccountPayload, AccountResource, AccountInstance> {
+    /**
+     * Initialize the AccountPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: Versionless, response: Response<string>, solution: AccountSolution);
+    /**
+     * Build an instance of AccountInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: AccountResource): AccountInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/previewIam/versionless/organization/account.js

@@ -0,0 +1,195 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Organization Public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * 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.AccountPage = exports.AccountListInstance = exports.AccountInstance = exports.AccountContextImpl = 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 AccountContextImpl {
+    constructor(_version, organizationSid, accountSid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(organizationSid)) {
+            throw new Error("Parameter 'organizationSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(accountSid)) {
+            throw new Error("Parameter 'accountSid' is not valid.");
+        }
+        this._solution = { organizationSid, accountSid };
+        this._uri = `/${organizationSid}/Accounts/${accountSid}`;
+    }
+    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 AccountInstance(operationVersion, payload, instance._solution.organizationSid, instance._solution.accountSid));
+        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.AccountContextImpl = AccountContextImpl;
+/**
+ * Page content
+ */
+class AccountInstance {
+    constructor(_version, payload, organizationSid, accountSid) {
+        this._version = _version;
+        this.accountSid = payload.account_sid;
+        this.friendlyName = payload.friendly_name;
+        this.status = payload.status;
+        this.ownerSid = payload.owner_sid;
+        this.dateCreated = deserialize.iso8601DateTime(payload.date_created);
+        this._solution = {
+            organizationSid,
+            accountSid: accountSid || this.accountSid,
+        };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new AccountContextImpl(this._version, this._solution.organizationSid, this._solution.accountSid);
+        return this._context;
+    }
+    /**
+     * Fetch a AccountInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AccountInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            accountSid: this.accountSid,
+            friendlyName: this.friendlyName,
+            status: this.status,
+            ownerSid: this.ownerSid,
+            dateCreated: this.dateCreated,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AccountInstance = AccountInstance;
+function AccountListInstance(version, organizationSid) {
+    if (!(0, utility_1.isValidPathParam)(organizationSid)) {
+        throw new Error("Parameter 'organizationSid' is not valid.");
+    }
+    const instance = ((accountSid) => instance.get(accountSid));
+    instance.get = function get(accountSid) {
+        return new AccountContextImpl(version, organizationSid, accountSid);
+    };
+    instance._version = version;
+    instance._solution = { organizationSid };
+    instance._uri = `/${organizationSid}/Accounts`;
+    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 AccountPage(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 AccountPage(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.AccountListInstance = AccountListInstance;
+class AccountPage extends Page_1.default {
+    /**
+     * Initialize the AccountPage
+     *
+     * @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 AccountInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AccountInstance(this._version, payload, this._solution.organizationSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AccountPage = AccountPage;

package/lib/rest/previewIam/versionless/organization/roleAssignment.d.ts

@@ -0,0 +1,274 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import Versionless from "../../Versionless";
+export declare class PublicApiCreateRoleAssignmentRequest {
+    /**
+     * Twilio Role Sid representing assigned role
+     */
+    "role_sid": string;
+    /**
+     * Twilio Sid representing scope of this assignment
+     */
+    "scope": string;
+    /**
+     * Twilio Sid representing identity of this assignment
+     */
+    "identity": string;
+}
+/**
+ * Options to pass to create a RoleAssignmentInstance
+ */
+export interface RoleAssignmentListInstanceCreateOptions {
+    /**  */
+    publicApiCreateRoleAssignmentRequest: PublicApiCreateRoleAssignmentRequest;
+}
+/**
+ * Options to pass to each
+ */
+export interface RoleAssignmentListInstanceEachOptions {
+    /**  */
+    pageSize?: number;
+    /**  */
+    identity?: string;
+    /**  */
+    scope?: string;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: RoleAssignmentInstance, 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 RoleAssignmentListInstanceOptions {
+    /**  */
+    pageSize?: number;
+    /**  */
+    identity?: string;
+    /**  */
+    scope?: string;
+    /** 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 RoleAssignmentListInstancePageOptions {
+    /**  */
+    pageSize?: number;
+    /**  */
+    identity?: string;
+    /**  */
+    scope?: string;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface RoleAssignmentContext {
+    /**
+     * Remove a RoleAssignmentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface RoleAssignmentContextSolution {
+    organizationSid: string;
+    sid: string;
+}
+export declare class RoleAssignmentContextImpl implements RoleAssignmentContext {
+    protected _version: Versionless;
+    protected _solution: RoleAssignmentContextSolution;
+    protected _uri: string;
+    constructor(_version: Versionless, organizationSid: string, sid: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): RoleAssignmentContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface RoleAssignmentPayload extends TwilioResponsePayload {
+    content: RoleAssignmentResource[];
+}
+interface RoleAssignmentResource {
+    sid: string;
+    role_sid: string;
+    scope: string;
+    identity: string;
+    code: number;
+    message: string;
+    moreInfo: string;
+    status: number;
+}
+export declare class RoleAssignmentInstance {
+    protected _version: Versionless;
+    protected _solution: RoleAssignmentContextSolution;
+    protected _context?: RoleAssignmentContext;
+    constructor(_version: Versionless, payload: RoleAssignmentResource, organizationSid: string, sid?: string);
+    /**
+     * Twilio Role Assignment Sid representing this role assignment
+     */
+    sid: string;
+    /**
+     * Twilio Role Sid representing assigned role
+     */
+    roleSid: string;
+    /**
+     * Twilio Sid representing identity of this assignment
+     */
+    scope: string;
+    /**
+     * Twilio Sid representing scope of this assignment
+     */
+    identity: string;
+    /**
+     * Twilio-specific error code
+     */
+    code: number;
+    /**
+     * Error message
+     */
+    message: string;
+    /**
+     * Link to Error Code References
+     */
+    moreInfo: string;
+    /**
+     * HTTP response status code
+     */
+    status: number;
+    private get _proxy();
+    /**
+     * Remove a RoleAssignmentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        roleSid: string;
+        scope: string;
+        identity: string;
+        code: number;
+        message: string;
+        moreInfo: string;
+        status: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface RoleAssignmentSolution {
+    organizationSid: string;
+}
+export interface RoleAssignmentListInstance {
+    _version: Versionless;
+    _solution: RoleAssignmentSolution;
+    _uri: string;
+    (sid: string): RoleAssignmentContext;
+    get(sid: string): RoleAssignmentContext;
+    /**
+     * Create a RoleAssignmentInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed RoleAssignmentInstance
+     */
+    create(params: PublicApiCreateRoleAssignmentRequest, headers?: any, callback?: (error: Error | null, item?: RoleAssignmentInstance) => any): Promise<RoleAssignmentInstance>;
+    /**
+     * Streams RoleAssignmentInstance 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 { RoleAssignmentListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: RoleAssignmentInstance, done: (err?: Error) => void) => void): void;
+    each(params: RoleAssignmentListInstanceEachOptions, callback?: (item: RoleAssignmentInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of RoleAssignmentInstance 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: RoleAssignmentPage) => any): Promise<RoleAssignmentPage>;
+    /**
+     * Lists RoleAssignmentInstance 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 { RoleAssignmentListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: RoleAssignmentInstance[]) => any): Promise<RoleAssignmentInstance[]>;
+    list(params: RoleAssignmentListInstanceOptions, callback?: (error: Error | null, items: RoleAssignmentInstance[]) => any): Promise<RoleAssignmentInstance[]>;
+    /**
+     * Retrieve a single page of RoleAssignmentInstance 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 { RoleAssignmentListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: RoleAssignmentPage) => any): Promise<RoleAssignmentPage>;
+    page(params: RoleAssignmentListInstancePageOptions, callback?: (error: Error | null, items: RoleAssignmentPage) => any): Promise<RoleAssignmentPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function RoleAssignmentListInstance(version: Versionless, organizationSid: string): RoleAssignmentListInstance;
+export declare class RoleAssignmentPage extends Page<Versionless, RoleAssignmentPayload, RoleAssignmentResource, RoleAssignmentInstance> {
+    /**
+     * Initialize the RoleAssignmentPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: Versionless, response: Response<string>, solution: RoleAssignmentSolution);
+    /**
+     * Build an instance of RoleAssignmentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: RoleAssignmentResource): RoleAssignmentInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};