twilio 5.3.7 → 5.4.0

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

@@ -0,0 +1,221 @@
+"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.RoleAssignmentPage = exports.RoleAssignmentListInstance = exports.RoleAssignmentInstance = exports.RoleAssignmentContextImpl = exports.PublicApiCreateRoleAssignmentRequest = 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 PublicApiCreateRoleAssignmentRequest {
+}
+exports.PublicApiCreateRoleAssignmentRequest = PublicApiCreateRoleAssignmentRequest;
+class RoleAssignmentContextImpl {
+    constructor(_version, organizationSid, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(organizationSid)) {
+            throw new Error("Parameter 'organizationSid' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { organizationSid, sid };
+        this._uri = `/${organizationSid}/RoleAssignments/${sid}`;
+    }
+    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;
+    }
+    /**
+     * 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.RoleAssignmentContextImpl = RoleAssignmentContextImpl;
+class RoleAssignmentInstance {
+    constructor(_version, payload, organizationSid, sid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.roleSid = payload.role_sid;
+        this.scope = payload.scope;
+        this.identity = payload.identity;
+        this.code = payload.code;
+        this.message = payload.message;
+        this.moreInfo = payload.moreInfo;
+        this.status = payload.status;
+        this._solution = { organizationSid, sid: sid || this.sid };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new RoleAssignmentContextImpl(this._version, this._solution.organizationSid, this._solution.sid);
+        return this._context;
+    }
+    /**
+     * Remove a RoleAssignmentInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            roleSid: this.roleSid,
+            scope: this.scope,
+            identity: this.identity,
+            code: this.code,
+            message: this.message,
+            moreInfo: this.moreInfo,
+            status: this.status,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.RoleAssignmentInstance = RoleAssignmentInstance;
+function RoleAssignmentListInstance(version, organizationSid) {
+    if (!(0, utility_1.isValidPathParam)(organizationSid)) {
+        throw new Error("Parameter 'organizationSid' is not valid.");
+    }
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new RoleAssignmentContextImpl(version, organizationSid, sid);
+    };
+    instance._version = version;
+    instance._solution = { organizationSid };
+    instance._uri = `/${organizationSid}/RoleAssignments`;
+    instance.create = function create(params, headers, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new RoleAssignmentInstance(operationVersion, payload, instance._solution.organizationSid));
+        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["identity"] !== undefined)
+            data["Identity"] = params["identity"];
+        if (params["scope"] !== undefined)
+            data["Scope"] = params["scope"];
+        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 RoleAssignmentPage(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 RoleAssignmentPage(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.RoleAssignmentListInstance = RoleAssignmentListInstance;
+class RoleAssignmentPage extends Page_1.default {
+    /**
+     * Initialize the RoleAssignmentPage
+     *
+     * @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 RoleAssignmentInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new RoleAssignmentInstance(this._version, payload, this._solution.organizationSid);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.RoleAssignmentPage = RoleAssignmentPage;

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

@@ -0,0 +1,448 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../../base/Page";
+import Response from "../../../../http/response";
+import Versionless from "../../Versionless";
+/**
+ * Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.
+ */
+export declare class ScimEmailAddress {
+    /**
+     * Indicates if this email address is the primary one
+     */
+    "primary"?: boolean;
+    /**
+     * The actual email address value
+     */
+    "value"?: string;
+    /**
+     * The type of email address (e.g., work, home, etc.)
+     */
+    "type"?: string;
+}
+/**
+ * Meta
+ */
+export declare class ScimMeta {
+    /**
+     * Indicates the type of the resource
+     */
+    "resourceType"?: string;
+    /**
+     * The date and time when the resource was created in the system
+     */
+    "created"?: Date;
+    /**
+     * The date and time when the resource was last modified
+     */
+    "lastModified"?: Date;
+    /**
+     * A version identifier for the resource. This can be used to manage resource versioning and concurrency control.
+     */
+    "version"?: string;
+}
+/**
+ * User\'s name
+ */
+export declare class ScimName {
+    /**
+     * The user\'s first or given name
+     */
+    "givenName"?: string;
+    /**
+     * The user\'s last or family name
+     */
+    "familyName"?: string;
+}
+export declare class ScimUser {
+    /**
+     * Unique Twilio user sid
+     */
+    "id"?: string;
+    /**
+     * External unique resource id defined by provisioning client
+     */
+    "externalId"?: string;
+    /**
+     * Unique username, MUST be same as primary email address
+     */
+    "userName": string;
+    /**
+     * User friendly display name
+     */
+    "displayName"?: string;
+    "name"?: ScimName;
+    /**
+     * Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.
+     */
+    "emails"?: Array<ScimEmailAddress>;
+    /**
+     * Indicates whether the user is active
+     */
+    "active"?: boolean;
+    /**
+     * User\'s locale
+     */
+    "locale"?: string;
+    /**
+     * User\'s time zone
+     */
+    "timezone"?: string;
+    /**
+     * An array of URIs that indicate the schemas supported for this user resource
+     */
+    "schemas"?: Array<string>;
+    "meta"?: ScimMeta;
+    /**
+     * A human-readable description of the error
+     */
+    "detail"?: string;
+    /**
+     * A scimType error code as defined in RFC7644
+     */
+    "scimType"?: string;
+    /**
+     * Http status code
+     */
+    "status"?: string;
+    /**
+     * Twilio-specific error code
+     */
+    "code"?: number;
+    /**
+     * Link to Error Code References
+     */
+    "moreInfo"?: string;
+}
+/**
+ * Options to pass to update a UserInstance
+ */
+export interface UserContextUpdateOptions {
+    /**  */
+    scimUser: ScimUser;
+    /**  */
+    ifMatch?: string;
+}
+/**
+ * Options to pass to create a UserInstance
+ */
+export interface UserListInstanceCreateOptions {
+    /**  */
+    scimUser: ScimUser;
+}
+/**
+ * Options to pass to each
+ */
+export interface UserListInstanceEachOptions {
+    /**  */
+    filter?: string;
+    /** Function to process each record. If this and a positional callback are passed, this one will be used */
+    callback?: (item: UserInstance, 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 UserListInstanceOptions {
+    /**  */
+    filter?: 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 UserListInstancePageOptions {
+    /**  */
+    filter?: string;
+    /** Page Number, this value is simply for client state */
+    pageNumber?: number;
+    /** PageToken provided by the API */
+    pageToken?: string;
+}
+export interface UserContext {
+    /**
+     * Remove a UserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a UserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed UserInstance
+     */
+    fetch(callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Update a UserInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed UserInstance
+     */
+    update(params: ScimUser, headers?: any, callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface UserContextSolution {
+    organizationSid: string;
+    id: string;
+}
+export declare class UserContextImpl implements UserContext {
+    protected _version: Versionless;
+    protected _solution: UserContextSolution;
+    protected _uri: string;
+    constructor(_version: Versionless, organizationSid: string, id: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    update(params: ScimUser, headers?: any, callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): UserContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface UserPayload extends TwilioResponsePayload {
+    Resources: UserResource[];
+}
+interface UserResource {
+    id: string;
+    externalId: string;
+    userName: string;
+    displayName: string;
+    name: ScimName;
+    emails: Array<ScimEmailAddress>;
+    active: boolean;
+    locale: string;
+    timezone: string;
+    schemas: Array<string>;
+    meta: ScimMeta;
+    detail: string;
+    scimType: string;
+    status: string;
+    code: number;
+    moreInfo: string;
+}
+export declare class UserInstance {
+    protected _version: Versionless;
+    protected _solution: UserContextSolution;
+    protected _context?: UserContext;
+    constructor(_version: Versionless, payload: UserResource, organizationSid: string, id?: string);
+    /**
+     * Unique Twilio user sid
+     */
+    id: string;
+    /**
+     * External unique resource id defined by provisioning client
+     */
+    externalId: string;
+    /**
+     * Unique username, MUST be same as primary email address
+     */
+    userName: string;
+    /**
+     * User friendly display name
+     */
+    displayName: string;
+    name: ScimName;
+    /**
+     * Email address list of the user. Primary email must be defined if there are more than 1 email. Primary email must match the username.
+     */
+    emails: Array<ScimEmailAddress>;
+    /**
+     * Indicates whether the user is active
+     */
+    active: boolean;
+    /**
+     * User\'s locale
+     */
+    locale: string;
+    /**
+     * User\'s time zone
+     */
+    timezone: string;
+    /**
+     * An array of URIs that indicate the schemas supported for this user resource
+     */
+    schemas: Array<string>;
+    meta: ScimMeta;
+    /**
+     * A human-readable description of the error
+     */
+    detail: string;
+    /**
+     * A scimType error code as defined in RFC7644
+     */
+    scimType: string;
+    /**
+     * Http status code
+     */
+    status: string;
+    /**
+     * Twilio-specific error code
+     */
+    code: number;
+    /**
+     * Link to Error Code References
+     */
+    moreInfo: string;
+    private get _proxy();
+    /**
+     * Remove a UserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a UserInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed UserInstance
+     */
+    fetch(callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Update a UserInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed UserInstance
+     */
+    update(params: ScimUser, headers?: any, callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        id: string;
+        externalId: string;
+        userName: string;
+        displayName: string;
+        name: ScimName;
+        emails: ScimEmailAddress[];
+        active: boolean;
+        locale: string;
+        timezone: string;
+        schemas: string[];
+        meta: ScimMeta;
+        detail: string;
+        scimType: string;
+        status: string;
+        code: number;
+        moreInfo: string;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface UserSolution {
+    organizationSid: string;
+}
+export interface UserListInstance {
+    _version: Versionless;
+    _solution: UserSolution;
+    _uri: string;
+    (id: string): UserContext;
+    get(id: string): UserContext;
+    /**
+     * Create a UserInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed UserInstance
+     */
+    create(params: ScimUser, headers?: any, callback?: (error: Error | null, item?: UserInstance) => any): Promise<UserInstance>;
+    /**
+     * Streams UserInstance 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 { UserListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: UserInstance, done: (err?: Error) => void) => void): void;
+    each(params: UserListInstanceEachOptions, callback?: (item: UserInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of UserInstance 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: UserPage) => any): Promise<UserPage>;
+    /**
+     * Lists UserInstance 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 { UserListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: UserInstance[]) => any): Promise<UserInstance[]>;
+    list(params: UserListInstanceOptions, callback?: (error: Error | null, items: UserInstance[]) => any): Promise<UserInstance[]>;
+    /**
+     * Retrieve a single page of UserInstance 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 { UserListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: UserPage) => any): Promise<UserPage>;
+    page(params: UserListInstancePageOptions, callback?: (error: Error | null, items: UserPage) => any): Promise<UserPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function UserListInstance(version: Versionless, organizationSid: string): UserListInstance;
+export declare class UserPage extends Page<Versionless, UserPayload, UserResource, UserInstance> {
+    /**
+     * Initialize the UserPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: Versionless, response: Response<string>, solution: UserSolution);
+    /**
+     * Build an instance of UserInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: UserResource): UserInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};