twilio 5.1.0 → 5.2.0

package/lib/rest/marketplace/v1/installedAddOn/installedAddOnUsage.d.ts

@@ -0,0 +1,84 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V1 from "../../V1";
+export declare class CreateMarketplaceBillingUsageRequest {
+    "billableItems"?: Array<CreateMarketplaceBillingUsageRequestBillableItems>;
+}
+export declare class CreateMarketplaceBillingUsageRequestBillableItems {
+    /**
+     *
+     */
+    "quantity": number;
+    /**
+     *
+     */
+    "sid": string;
+}
+export declare class MarketplaceInstalledAddOnBillingUsageResponseBillableItems {
+    /**
+     *
+     */
+    "quantity"?: number;
+    /**
+     *
+     */
+    "sid"?: string;
+    /**
+     * Whether this billable item was successfully submitted for billing.
+     */
+    "submitted"?: boolean;
+}
+/**
+ * Options to pass to create a InstalledAddOnUsageInstance
+ */
+export interface InstalledAddOnUsageListInstanceCreateOptions {
+    /**  */
+    createMarketplaceBillingUsageRequest: CreateMarketplaceBillingUsageRequest;
+}
+export interface InstalledAddOnUsageSolution {
+    installedAddOnSid: string;
+}
+export interface InstalledAddOnUsageListInstance {
+    _version: V1;
+    _solution: InstalledAddOnUsageSolution;
+    _uri: string;
+    /**
+     * Create a InstalledAddOnUsageInstance
+     *
+     * @param params - Body for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnUsageInstance
+     */
+    create(params: CreateMarketplaceBillingUsageRequest, callback?: (error: Error | null, item?: InstalledAddOnUsageInstance) => any): Promise<InstalledAddOnUsageInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function InstalledAddOnUsageListInstance(version: V1, installedAddOnSid: string): InstalledAddOnUsageListInstance;
+interface InstalledAddOnUsageResource {
+    billable_items: Array<MarketplaceInstalledAddOnBillingUsageResponseBillableItems>;
+    total_submitted: number;
+}
+export declare class InstalledAddOnUsageInstance {
+    protected _version: V1;
+    constructor(_version: V1, payload: InstalledAddOnUsageResource, installedAddOnSid: string);
+    billableItems: Array<MarketplaceInstalledAddOnBillingUsageResponseBillableItems>;
+    /**
+     * Represents the total quantity submitted.
+     */
+    totalSubmitted: number;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        billableItems: MarketplaceInstalledAddOnBillingUsageResponseBillableItems[];
+        totalSubmitted: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

package/lib/rest/marketplace/v1/installedAddOn/installedAddOnUsage.js

@@ -0,0 +1,86 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Marketplace
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstalledAddOnUsageInstance = exports.InstalledAddOnUsageListInstance = exports.MarketplaceInstalledAddOnBillingUsageResponseBillableItems = exports.CreateMarketplaceBillingUsageRequestBillableItems = exports.CreateMarketplaceBillingUsageRequest = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../../base/deserialize");
+const serialize = require("../../../../base/serialize");
+const utility_1 = require("../../../../base/utility");
+class CreateMarketplaceBillingUsageRequest {
+}
+exports.CreateMarketplaceBillingUsageRequest = CreateMarketplaceBillingUsageRequest;
+class CreateMarketplaceBillingUsageRequestBillableItems {
+}
+exports.CreateMarketplaceBillingUsageRequestBillableItems = CreateMarketplaceBillingUsageRequestBillableItems;
+class MarketplaceInstalledAddOnBillingUsageResponseBillableItems {
+}
+exports.MarketplaceInstalledAddOnBillingUsageResponseBillableItems = MarketplaceInstalledAddOnBillingUsageResponseBillableItems;
+function InstalledAddOnUsageListInstance(version, installedAddOnSid) {
+    if (!(0, utility_1.isValidPathParam)(installedAddOnSid)) {
+        throw new Error("Parameter 'installedAddOnSid' is not valid.");
+    }
+    const instance = {};
+    instance._version = version;
+    instance._solution = { installedAddOnSid };
+    instance._uri = `/InstalledAddOns/${installedAddOnSid}/Usage`;
+    instance.create = function create(params, callback) {
+        if (params === null || params === undefined) {
+            throw new Error('Required parameter "params" missing.');
+        }
+        let data = {};
+        data = params;
+        const headers = {};
+        headers["Content-Type"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new InstalledAddOnUsageInstance(operationVersion, payload, instance._solution.installedAddOnSid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    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.InstalledAddOnUsageListInstance = InstalledAddOnUsageListInstance;
+class InstalledAddOnUsageInstance {
+    constructor(_version, payload, installedAddOnSid) {
+        this._version = _version;
+        this.billableItems = payload.billable_items;
+        this.totalSubmitted = payload.total_submitted;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            billableItems: this.billableItems,
+            totalSubmitted: this.totalSubmitted,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.InstalledAddOnUsageInstance = InstalledAddOnUsageInstance;

package/lib/rest/marketplace/v1/installedAddOn.d.ts

@@ -0,0 +1,340 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import Page, { TwilioResponsePayload } from "../../../base/Page";
+import Response from "../../../http/response";
+import V1 from "../V1";
+import { InstalledAddOnExtensionListInstance } from "./installedAddOn/installedAddOnExtension";
+import { InstalledAddOnUsageListInstance } from "./installedAddOn/installedAddOnUsage";
+/**
+ * Options to pass to update a InstalledAddOnInstance
+ */
+export interface InstalledAddOnContextUpdateOptions {
+    /** Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured */
+    configuration?: any;
+    /** An application-defined string that uniquely identifies the resource. This value must be unique within the Account. */
+    uniqueName?: string;
+}
+/**
+ * Options to pass to create a InstalledAddOnInstance
+ */
+export interface InstalledAddOnListInstanceCreateOptions {
+    /** The SID of the AvaliableAddOn to install. */
+    availableAddOnSid: string;
+    /** Whether the Terms of Service were accepted. */
+    acceptTermsOfService: boolean;
+    /** The JSON object that represents the configuration of the new Add-on being installed. */
+    configuration?: any;
+    /** An application-defined string that uniquely identifies the resource. This value must be unique within the Account. */
+    uniqueName?: string;
+}
+/**
+ * Options to pass to each
+ */
+export interface InstalledAddOnListInstanceEachOptions {
+    /** 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: InstalledAddOnInstance, 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 InstalledAddOnListInstanceOptions {
+    /** 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 InstalledAddOnListInstancePageOptions {
+    /** 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 InstalledAddOnContext {
+    extensions: InstalledAddOnExtensionListInstance;
+    usage: InstalledAddOnUsageListInstance;
+    /**
+     * Remove a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    fetch(callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Update a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    update(callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Update a InstalledAddOnInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    update(params: InstalledAddOnContextUpdateOptions, callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface InstalledAddOnContextSolution {
+    sid: string;
+}
+export declare class InstalledAddOnContextImpl implements InstalledAddOnContext {
+    protected _version: V1;
+    protected _solution: InstalledAddOnContextSolution;
+    protected _uri: string;
+    protected _extensions?: InstalledAddOnExtensionListInstance;
+    protected _usage?: InstalledAddOnUsageListInstance;
+    constructor(_version: V1, sid: string);
+    get extensions(): InstalledAddOnExtensionListInstance;
+    get usage(): InstalledAddOnUsageListInstance;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    update(params?: InstalledAddOnContextUpdateOptions | ((error: Error | null, item?: InstalledAddOnInstance) => any), callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): InstalledAddOnContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface InstalledAddOnPayload extends TwilioResponsePayload {
+    installed_add_ons: InstalledAddOnResource[];
+}
+interface InstalledAddOnResource {
+    sid: string;
+    account_sid: string;
+    friendly_name: string;
+    description: string;
+    configuration: any;
+    unique_name: string;
+    date_created: Date;
+    date_updated: Date;
+    url: string;
+    links: Record<string, string>;
+}
+export declare class InstalledAddOnInstance {
+    protected _version: V1;
+    protected _solution: InstalledAddOnContextSolution;
+    protected _context?: InstalledAddOnContext;
+    constructor(_version: V1, payload: InstalledAddOnResource, sid?: string);
+    /**
+     * The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the \'Available Add-on Sid\'.
+     */
+    sid: string;
+    /**
+     * The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource.
+     */
+    accountSid: string;
+    /**
+     * The string that you assigned to describe the resource.
+     */
+    friendlyName: string;
+    /**
+     * A short description of the Add-on\'s functionality.
+     */
+    description: string;
+    /**
+     * The JSON object that represents the current configuration of installed Add-on.
+     */
+    configuration: any;
+    /**
+     * An application-defined string that uniquely identifies the resource.
+     */
+    uniqueName: string;
+    /**
+     * The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateCreated: Date;
+    /**
+     * The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+     */
+    dateUpdated: Date;
+    /**
+     * The absolute URL of the resource.
+     */
+    url: string;
+    /**
+     * The URLs of related resources.
+     */
+    links: Record<string, string>;
+    private get _proxy();
+    /**
+     * Remove a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    fetch(callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Update a InstalledAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    update(callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Update a InstalledAddOnInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    update(params: InstalledAddOnContextUpdateOptions, callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Access the extensions.
+     */
+    extensions(): InstalledAddOnExtensionListInstance;
+    /**
+     * Access the usage.
+     */
+    usage(): InstalledAddOnUsageListInstance;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        sid: string;
+        accountSid: string;
+        friendlyName: string;
+        description: string;
+        configuration: any;
+        uniqueName: string;
+        dateCreated: Date;
+        dateUpdated: Date;
+        url: string;
+        links: Record<string, string>;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface InstalledAddOnSolution {
+}
+export interface InstalledAddOnListInstance {
+    _version: V1;
+    _solution: InstalledAddOnSolution;
+    _uri: string;
+    (sid: string): InstalledAddOnContext;
+    get(sid: string): InstalledAddOnContext;
+    /**
+     * Create a InstalledAddOnInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed InstalledAddOnInstance
+     */
+    create(params: InstalledAddOnListInstanceCreateOptions, callback?: (error: Error | null, item?: InstalledAddOnInstance) => any): Promise<InstalledAddOnInstance>;
+    /**
+     * Streams InstalledAddOnInstance 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 { InstalledAddOnListInstanceEachOptions } [params] - Options for request
+     * @param { function } [callback] - Function to process each record
+     */
+    each(callback?: (item: InstalledAddOnInstance, done: (err?: Error) => void) => void): void;
+    each(params: InstalledAddOnListInstanceEachOptions, callback?: (item: InstalledAddOnInstance, done: (err?: Error) => void) => void): void;
+    /**
+     * Retrieve a single target page of InstalledAddOnInstance 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: InstalledAddOnPage) => any): Promise<InstalledAddOnPage>;
+    /**
+     * Lists InstalledAddOnInstance 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 { InstalledAddOnListInstanceOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    list(callback?: (error: Error | null, items: InstalledAddOnInstance[]) => any): Promise<InstalledAddOnInstance[]>;
+    list(params: InstalledAddOnListInstanceOptions, callback?: (error: Error | null, items: InstalledAddOnInstance[]) => any): Promise<InstalledAddOnInstance[]>;
+    /**
+     * Retrieve a single page of InstalledAddOnInstance 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 { InstalledAddOnListInstancePageOptions } [params] - Options for request
+     * @param { function } [callback] - Callback to handle list of records
+     */
+    page(callback?: (error: Error | null, items: InstalledAddOnPage) => any): Promise<InstalledAddOnPage>;
+    page(params: InstalledAddOnListInstancePageOptions, callback?: (error: Error | null, items: InstalledAddOnPage) => any): Promise<InstalledAddOnPage>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function InstalledAddOnListInstance(version: V1): InstalledAddOnListInstance;
+export declare class InstalledAddOnPage extends Page<V1, InstalledAddOnPayload, InstalledAddOnResource, InstalledAddOnInstance> {
+    /**
+     * Initialize the InstalledAddOnPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version: V1, response: Response<string>, solution: InstalledAddOnSolution);
+    /**
+     * Build an instance of InstalledAddOnInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload: InstalledAddOnResource): InstalledAddOnInstance;
+    [inspect.custom](depth: any, options: InspectOptions): string;
+}
+export {};