twilio 5.7.0 → 5.7.2

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

@@ -0,0 +1,225 @@
+"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.LookupOverrideListInstance = exports.LookupOverrideInstance = exports.LookupOverrideContextImpl = exports.OverridesRequest = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+class OverridesRequest {
+}
+exports.OverridesRequest = OverridesRequest;
+class LookupOverrideContextImpl {
+    constructor(_version, field, phoneNumber) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(field)) {
+            throw new Error("Parameter 'field' is not valid.");
+        }
+        if (!(0, utility_1.isValidPathParam)(phoneNumber)) {
+            throw new Error("Parameter 'phoneNumber' is not valid.");
+        }
+        this._solution = { field, phoneNumber };
+        this._uri = `/PhoneNumbers/${phoneNumber}/Overrides/${field}`;
+    }
+    create(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.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new LookupOverrideInstance(operationVersion, payload, instance._solution.field, instance._solution.phoneNumber));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    }
+    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 LookupOverrideInstance(operationVersion, payload, instance._solution.field, instance._solution.phoneNumber));
+        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 LookupOverrideInstance(operationVersion, payload, instance._solution.field, instance._solution.phoneNumber));
+        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.LookupOverrideContextImpl = LookupOverrideContextImpl;
+class LookupOverrideInstance {
+    constructor(_version, payload, field, phoneNumber) {
+        this._version = _version;
+        this.phoneNumber = payload.phone_number;
+        this.originalLineType = payload.original_line_type;
+        this.overriddenLineType = payload.overridden_line_type;
+        this.overrideReason = payload.override_reason;
+        this.overrideTimestamp = deserialize.iso8601DateTime(payload.override_timestamp);
+        this.overriddenByAccountSid = payload.overridden_by_account_sid;
+        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,
+            phoneNumber: phoneNumber || this.phoneNumber,
+        };
+    }
+    get _proxy() {
+        this._context =
+            this._context ||
+                new LookupOverrideContextImpl(this._version, this._solution.field, this._solution.phoneNumber);
+        return this._context;
+    }
+    create(params, callback) {
+        return this._proxy.create(params, callback);
+    }
+    /**
+     * Remove a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed boolean
+     */
+    remove(callback) {
+        return this._proxy.remove(callback);
+    }
+    /**
+     * Fetch a LookupOverrideInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed LookupOverrideInstance
+     */
+    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 {
+            phoneNumber: this.phoneNumber,
+            originalLineType: this.originalLineType,
+            overriddenLineType: this.overriddenLineType,
+            overrideReason: this.overrideReason,
+            overrideTimestamp: this.overrideTimestamp,
+            overriddenByAccountSid: this.overriddenByAccountSid,
+            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.LookupOverrideInstance = LookupOverrideInstance;
+function LookupOverrideListInstance(version) {
+    const instance = ((field, phoneNumber) => instance.get(field, phoneNumber));
+    instance.get = function get(field, phoneNumber) {
+        return new LookupOverrideContextImpl(version, field, phoneNumber);
+    };
+    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.LookupOverrideListInstance = LookupOverrideListInstance;

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

@@ -1,6 +1,9 @@
 /// <reference types="node" />
 import { inspect, InspectOptions } from "util";
 import V2 from "../V2";
+/**
+ * Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER.
+ */
 export type PhoneNumberValidationError = "TOO_SHORT" | "TOO_LONG" | "INVALID_BUT_POSSIBLE" | "INVALID_COUNTRY_CODE" | "INVALID_LENGTH" | "NOT_A_NUMBER";
 /**
  * Options to pass to fetch a PhoneNumberInstance

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

@@ -0,0 +1,175 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+export declare class CallForwarding {
+    "call_forwarding_enabled"?: boolean;
+    "error_code"?: number;
+}
+export declare class CallerName {
+    "caller_name"?: string;
+    "caller_type"?: string;
+    "error_code"?: number;
+}
+export declare class IdentityMatch {
+    "first_name_match"?: string;
+    "last_name_match"?: string;
+    "address_line_match"?: string;
+    "city_match"?: string;
+    "state_match"?: string;
+    "postal_code_match"?: string;
+    "country_code_match"?: string;
+    "national_id_match"?: string;
+    "date_of_birth_match"?: string;
+    "summary_score"?: number;
+    "error_code"?: number;
+    "error_message"?: string;
+}
+export declare class IdentityMatchParameters {
+    "first_name"?: string;
+    "last_name"?: string;
+    "address_line1"?: string;
+    "address_line2"?: string;
+    "city"?: string;
+    "state"?: string;
+    "postal_code"?: string;
+    "address_country_code"?: string;
+    "national_id"?: string;
+    "date_of_birth"?: string;
+}
+export declare class LastSimSwap {
+    "last_sim_swap_date"?: Date;
+    "swapped_period"?: string;
+    "swapped_in_period"?: boolean;
+}
+export declare class LineStatus {
+    "status"?: string;
+    "error_code"?: number;
+}
+export declare class LineTypeIntelligence {
+    "type"?: string;
+    "carrier_name"?: string;
+    "mobile_country_code"?: string;
+    "mobile_network_code"?: string;
+    "error_code"?: number;
+}
+export declare class LookupRequest1 {
+    "phone_numbers"?: Array<LookupRequestWithCorId>;
+}
+export declare class LookupRequestWithCorId {
+    /**
+     * Unique identifier used to match request with response
+     */
+    "correlation_id"?: string;
+    "phone_number": string;
+    "fields"?: Array<string>;
+    "country_code"?: string;
+    "identity_match"?: IdentityMatchParameters;
+    "reassigned_number"?: ReassignedNumberRequest;
+    "sms_pumping_risk"?: SmsPumpingRiskParameters;
+}
+export declare class LookupResponseWithCorId {
+    /**
+     * Unique identifier used to match request with response
+     */
+    "correlation_id"?: string;
+    /**
+     * Twilio error code in case that the request to downstream fails
+     */
+    "twilio_error_code"?: number;
+    "calling_country_code"?: string;
+    "country_code"?: string;
+    "phone_number"?: string;
+    "national_format"?: string;
+    "valid"?: boolean;
+    "validation_errors"?: Array<string>;
+    "caller_name"?: CallerName;
+    "sim_swap"?: SimSwap;
+    "call_forwarding"?: CallForwarding;
+    "line_type_intelligence"?: LineTypeIntelligence;
+    "line_status"?: LineStatus;
+    "identity_match"?: IdentityMatch;
+    "reassigned_number"?: ReassignedNumberResponse;
+    "sms_pumping_risk"?: SmsPumpingRisk;
+}
+export declare class ReassignedNumberRequest {
+    "last_verified_date"?: string;
+}
+export declare class ReassignedNumberResponse {
+    "last_verified_date"?: string;
+    "is_number_reassigned"?: string;
+    "error_code"?: string;
+}
+export declare class SimSwap {
+    "last_sim_swap"?: LastSimSwap;
+    "carrier_name"?: string;
+    "mobile_country_code"?: string;
+    "mobile_network_code"?: string;
+    "error_code"?: number;
+}
+export declare class SmsPumpingRisk {
+    "carrier_risk_category"?: string;
+    "number_blocked"?: boolean;
+    "number_blocked_date"?: Date;
+    "number_blocked_last_3_months"?: boolean;
+    "sms_pumping_risk_score"?: number;
+    "error_code"?: number;
+}
+export declare class SmsPumpingRiskParameters {
+    "partner_sub_id"?: string;
+}
+/**
+ * Options to pass to create a QueryInstance
+ */
+export interface QueryListInstanceCreateOptions {
+    /**  */
+    lookupRequest1?: LookupRequest1;
+}
+export interface QuerySolution {
+}
+export interface QueryListInstance {
+    _version: V2;
+    _solution: QuerySolution;
+    _uri: string;
+    /**
+     * Create a QueryInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed QueryInstance
+     */
+    create(callback?: (error: Error | null, item?: QueryInstance) => any): Promise<QueryInstance>;
+    /**
+     * Create a QueryInstance
+     *
+     * @param params - Body for request
+     * @param headers - header params for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed QueryInstance
+     */
+    create(params: LookupRequest1, headers?: any, callback?: (error: Error | null, item?: QueryInstance) => any): Promise<QueryInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function QueryListInstance(version: V2): QueryListInstance;
+interface QueryResource {
+    phone_numbers: Array<LookupResponseWithCorId>;
+}
+export declare class QueryInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: QueryResource);
+    phoneNumbers: Array<LookupResponseWithCorId>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        phoneNumbers: LookupResponseWithCorId[];
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,123 @@
+"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.QueryInstance = exports.QueryListInstance = exports.SmsPumpingRiskParameters = exports.SmsPumpingRisk = exports.SimSwap = exports.ReassignedNumberResponse = exports.ReassignedNumberRequest = exports.LookupResponseWithCorId = exports.LookupRequestWithCorId = exports.LookupRequest1 = exports.LineTypeIntelligence = exports.LineStatus = exports.LastSimSwap = exports.IdentityMatchParameters = exports.IdentityMatch = exports.CallerName = exports.CallForwarding = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+class CallForwarding {
+}
+exports.CallForwarding = CallForwarding;
+class CallerName {
+}
+exports.CallerName = CallerName;
+class IdentityMatch {
+}
+exports.IdentityMatch = IdentityMatch;
+class IdentityMatchParameters {
+}
+exports.IdentityMatchParameters = IdentityMatchParameters;
+class LastSimSwap {
+}
+exports.LastSimSwap = LastSimSwap;
+class LineStatus {
+}
+exports.LineStatus = LineStatus;
+class LineTypeIntelligence {
+}
+exports.LineTypeIntelligence = LineTypeIntelligence;
+class LookupRequest1 {
+}
+exports.LookupRequest1 = LookupRequest1;
+class LookupRequestWithCorId {
+}
+exports.LookupRequestWithCorId = LookupRequestWithCorId;
+class LookupResponseWithCorId {
+}
+exports.LookupResponseWithCorId = LookupResponseWithCorId;
+class ReassignedNumberRequest {
+}
+exports.ReassignedNumberRequest = ReassignedNumberRequest;
+class ReassignedNumberResponse {
+}
+exports.ReassignedNumberResponse = ReassignedNumberResponse;
+class SimSwap {
+}
+exports.SimSwap = SimSwap;
+class SmsPumpingRisk {
+}
+exports.SmsPumpingRisk = SmsPumpingRisk;
+class SmsPumpingRiskParameters {
+}
+exports.SmsPumpingRiskParameters = SmsPumpingRiskParameters;
+function QueryListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/batch/query`;
+    instance.create = function create(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";
+        let operationVersion = version, operationPromise = operationVersion.create({
+            uri: instance._uri,
+            method: "post",
+            data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new QueryInstance(operationVersion, payload));
+        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.QueryListInstance = QueryListInstance;
+class QueryInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.phoneNumbers = payload.phone_numbers;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            phoneNumbers: this.phoneNumbers,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.QueryInstance = QueryInstance;

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

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+import { inspect, InspectOptions } from "util";
+import V2 from "../V2";
+/**
+ * Rate limit response schema
+ */
+export declare class RateLimitResponse {
+    /**
+     * 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;
+}
+/**
+ * Options to pass to fetch a RateLimitInstance
+ */
+export interface RateLimitListInstanceFetchOptions {
+    /**  */
+    fields?: Array<string>;
+}
+export interface RateLimitSolution {
+}
+export interface RateLimitListInstance {
+    _version: V2;
+    _solution: RateLimitSolution;
+    _uri: string;
+    /**
+     * Fetch a RateLimitInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed RateLimitInstance
+     */
+    fetch(callback?: (error: Error | null, item?: RateLimitInstance) => any): Promise<RateLimitInstance>;
+    /**
+     * Fetch a RateLimitInstance
+     *
+     * @param params - Parameter for request
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed RateLimitInstance
+     */
+    fetch(params: RateLimitListInstanceFetchOptions, callback?: (error: Error | null, item?: RateLimitInstance) => any): Promise<RateLimitInstance>;
+    /**
+     * Provide a user-friendly representation
+     */
+    toJSON(): any;
+    [inspect.custom](_depth: any, options: InspectOptions): any;
+}
+export declare function RateLimitListInstance(version: V2): RateLimitListInstance;
+interface RateLimitResource {
+    rate_limits: Array<RateLimitResponse>;
+}
+export declare class RateLimitInstance {
+    protected _version: V2;
+    constructor(_version: V2, payload: RateLimitResource);
+    rateLimits: Array<RateLimitResponse>;
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON(): {
+        rateLimits: RateLimitResponse[];
+    };
+    [inspect.custom](_depth: any, options: InspectOptions): string;
+}
+export {};

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

@@ -0,0 +1,82 @@
+"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.RateLimitInstance = exports.RateLimitListInstance = exports.RateLimitResponse = void 0;
+const util_1 = require("util");
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+/**
+ * Rate limit response schema
+ */
+class RateLimitResponse {
+}
+exports.RateLimitResponse = RateLimitResponse;
+function RateLimitListInstance(version) {
+    const instance = {};
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/RateLimits`;
+    instance.fetch = function fetch(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["fields"] !== undefined)
+            data["Fields"] = serialize.map(params["fields"], (e) => e);
+        const headers = {};
+        headers["Accept"] = "application/json";
+        let operationVersion = version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new RateLimitInstance(operationVersion, payload));
+        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.RateLimitListInstance = RateLimitListInstance;
+class RateLimitInstance {
+    constructor(_version, payload) {
+        this._version = _version;
+        this.rateLimits = payload.rate_limits;
+    }
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            rateLimits: this.rateLimits,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.RateLimitInstance = RateLimitInstance;