twilio 5.7.1 → 5.7.3

package/lib/rest/lookups/v2/bucket.d.ts

@@ -0,0 +1,205 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+/**
+ * Rate limit request schema
+ */
+export declare class RateLimitRequest {
+    /**
+     * Limit of requests for the bucket
+     */
+    "limit"?: number;
+    /**
+     * Time to live of the rule
+     */
+    "ttl"?: number;
+}
+/**
+ * Options to pass to update a BucketInstance
+ */
+export interface BucketContextUpdateOptions {
+    /**  */
+    rateLimitRequest?: RateLimitRequest;
+}
+export interface BucketContext {
+    /**
+     * Remove a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    fetch(callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Update a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    update(callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Update a BucketInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    update(params: RateLimitRequest, headers?: any, callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface BucketContextSolution {
+    field: string;
+    bucket: string;
+}
+export declare class BucketContextImpl implements BucketContext {
+    protected _version: V2;
+    protected _solution: BucketContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, field: string, bucket: string);
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    update(params?: RateLimitRequest | ((error: Error | null, item?: BucketInstance) => any), headers?: any, callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): BucketContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface BucketResource {
+    code: number;
+    message: string;
+    more_info: string;
+    status: number;
+    field: string;
+    limit: number;
+    bucket: string;
+    owner: string;
+    ttl: number;
+}
+export declare class BucketInstance {
+    protected _version: V2;
+    protected _solution: BucketContextSolution;
+    protected _context?: BucketContext;
+    constructor(_version: V2, payload: BucketResource, field?: string, bucket?: string);
+    /**
+     * Twilio-specific error code
+     */
+    code: number;
+    /**
+     * Error message
+     */
+    message: string;
+    /**
+     * Link to Error Code References
+     */
+    moreInfo: string;
+    /**
+     * HTTP response status code
+     */
+    status: number;
+    /**
+     * Limit of requests for the bucket
+     */
+    field: string;
+    /**
+     * Limit of requests for the bucket
+     */
+    limit: number;
+    /**
+     * Name of the bucket
+     */
+    bucket: string;
+    /**
+     * Owner of the rule
+     */
+    owner: string;
+    /**
+     * Time to live of the rule
+     */
+    ttl: number;
+    private get _proxy();
+    /**
+     * Remove a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    fetch(callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Update a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    update(callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Update a BucketInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    update(params: RateLimitRequest, headers?: any, callback?: (error: Error | null, item?: BucketInstance) => any): Promise<BucketInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        code: number;
+        message: string;
+        moreInfo: string;
+        status: number;
+        field: string;
+        limit: number;
+        bucket: string;
+        owner: string;
+        ttl: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface BucketSolution {
+}
+export interface BucketListInstance {
+    _version: V2;
+    _solution: BucketSolution;
+    _uri: string;
+    (field: string, bucket: string): BucketContext;
+    get(field: string, bucket: string): BucketContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function BucketListInstance(version: V2): BucketListInstance;
+export {};

package/lib/rest/lookups/v2/bucket.js

@@ -0,0 +1,187 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Lookups
+ * 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.BucketListInstance = exports.BucketInstance = exports.BucketContextImpl = exports.RateLimitRequest = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+/**
+ * Rate limit request schema
+ */
+class RateLimitRequest {
+}
+exports.RateLimitRequest = RateLimitRequest;
+class BucketContextImpl {
+    constructor(_version, field, bucket) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(field)) {
+            throw new Error("Parameter 'field' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(bucket)) {
+            throw new Error("Parameter 'bucket' is not valid.");
+        }
+        this._solution = { field, bucket };
+        this._uri = `/RateLimits/Fields/${field}/Bucket/${bucket}`;
+    }
+    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 BucketInstance(operationVersion, payload, instance._solution.field, instance._solution.bucket));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    update(params, headers, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        data = params;
+        if (headers === null || headers === undefined) {
+            headers = {};
+        }
+        headers["Content-Type"] = "application/json";
+        headers["Accept"] = "application/json";
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.update({
+            uri: instance._uri,
+            method: "put",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new BucketInstance(operationVersion, payload, instance._solution.field, instance._solution.bucket));
+        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.BucketContextImpl = BucketContextImpl;
+class BucketInstance {
+    constructor(_version, payload, field, bucket) {
+        this._version = _version;
+        this.code = payload.code;
+        this.message = payload.message;
+        this.moreInfo = payload.more_info;
+        this.status = payload.status;
+        this.field = payload.field;
+        this.limit = payload.limit;
+        this.bucket = payload.bucket;
+        this.owner = payload.owner;
+        this.ttl = payload.ttl;
+        this._solution = {
+            field: field || this.field,
+            bucket: bucket || this.bucket,
+        };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new BucketContextImpl(this._version, this._solution.field, this._solution.bucket);
+        return this._context;
+    }
+    /**
+     * Remove a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a BucketInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed BucketInstance
+     */
+    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 {
+            code: this.code,
+            message: this.message,
+            moreInfo: this.moreInfo,
+            status: this.status,
+            field: this.field,
+            limit: this.limit,
+            bucket: this.bucket,
+            owner: this.owner,
+            ttl: this.ttl,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.BucketInstance = BucketInstance;
+function BucketListInstance(version) {
+    const instance = ((field, bucket) => instance.get(field, bucket));
+    instance.get = function get(field, bucket) {
+        return new BucketContextImpl(version, field, bucket);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = ``;
+    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.BucketListInstance = BucketListInstance;

package/lib/rest/lookups/v2/lookupOverride.d.ts

@@ -0,0 +1,279 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+export declare class OverridesRequest {
+    /**
+     * The new line type to override the original line type
+     */
+    "line_type"?: string;
+    /**
+     * The reason for the override
+     */
+    "reason"?: string;
+}
+/**
+ * Options to pass to create a LookupOverrideInstance
+ */
+export interface LookupOverrideContextCreateOptions {
+    /**  */
+    overridesRequest?: OverridesRequest;
+}
+/**
+ * Options to pass to update a LookupOverrideInstance
+ */
+export interface LookupOverrideContextUpdateOptions {
+    /**  */
+    overridesRequest?: OverridesRequest;
+}
+export interface LookupOverrideContext {
+    /**
+     * Create a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    create(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Create a LookupOverrideInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    create(params: OverridesRequest, headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Remove a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    fetch(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Update a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    update(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Update a LookupOverrideInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    update(params: OverridesRequest, headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export interface LookupOverrideContextSolution {
+    field: string;
+    phoneNumber: string;
+}
+export declare class LookupOverrideContextImpl implements LookupOverrideContext {
+    protected _version: V2;
+    protected _solution: LookupOverrideContextSolution;
+    protected _uri: string;
+    constructor(_version: V2, field: string, phoneNumber: string);
+    create(params?: OverridesRequest | ((error: Error | null, item?: LookupOverrideInstance) => any), headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    fetch(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    update(params?: OverridesRequest | ((error: Error | null, item?: LookupOverrideInstance) => any), headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): LookupOverrideContextSolution;
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+interface LookupOverrideResource {
+    phone_number: string;
+    original_line_type: string;
+    overridden_line_type: string;
+    override_reason: string;
+    override_timestamp: Date;
+    overridden_by_account_sid: string;
+    code: number;
+    message: string;
+    more_info: string;
+    status: number;
+    field: string;
+    limit: number;
+    bucket: string;
+    owner: string;
+    ttl: number;
+}
+export declare class LookupOverrideInstance {
+    protected _version: V2;
+    protected _solution: LookupOverrideContextSolution;
+    protected _context?: LookupOverrideContext;
+    constructor(_version: V2, payload: LookupOverrideResource, field?: string, phoneNumber?: string);
+    /**
+     * The phone number for which the override was created
+     */
+    phoneNumber: string;
+    /**
+     * The original line type
+     */
+    originalLineType: string;
+    /**
+     * The new line type after the override
+     */
+    overriddenLineType: string;
+    /**
+     * The reason for the override
+     */
+    overrideReason: string;
+    overrideTimestamp: Date;
+    /**
+     * The Account SID for the user who made the override
+     */
+    overriddenByAccountSid: string;
+    /**
+     * Twilio-specific error code
+     */
+    code: number;
+    /**
+     * Error message
+     */
+    message: string;
+    /**
+     * Link to Error Code References
+     */
+    moreInfo: string;
+    /**
+     * HTTP response status code
+     */
+    status: number;
+    /**
+     * Limit of requests for the bucket
+     */
+    field: string;
+    /**
+     * Limit of requests for the bucket
+     */
+    limit: number;
+    /**
+     * Name of the bucket
+     */
+    bucket: string;
+    /**
+     * Owner of the rule
+     */
+    owner: string;
+    /**
+     * Time to live of the rule
+     */
+    ttl: number;
+    private get _proxy();
+    /**
+     * Create a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    create(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Create a LookupOverrideInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    create(params: OverridesRequest, headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Remove a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback?: (error: Error | null, item?: boolean) => any): Promise<boolean>;
+    /**
+     * Fetch a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    fetch(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Update a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    update(callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Update a LookupOverrideInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    update(params: OverridesRequest, headers?: any, callback?: (error: Error | null, item?: LookupOverrideInstance) => any): Promise<LookupOverrideInstance>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        phoneNumber: string;
+        originalLineType: string;
+        overriddenLineType: string;
+        overrideReason: string;
+        overrideTimestamp: Date;
+        overriddenByAccountSid: string;
+        code: number;
+        message: string;
+        moreInfo: string;
+        status: number;
+        field: string;
+        limit: number;
+        bucket: string;
+        owner: string;
+        ttl: number;
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export interface LookupOverrideSolution {
+}
+export interface LookupOverrideListInstance {
+    _version: V2;
+    _solution: LookupOverrideSolution;
+    _uri: string;
+    (field: string, phoneNumber: string): LookupOverrideContext;
+    get(field: string, phoneNumber: string): LookupOverrideContext;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function LookupOverrideListInstance(version: V2): LookupOverrideListInstance;
+export {};