twilio 5.8.2 → 5.10.0

package/lib/rest/messaging/v2/channelsSender.d.ts

@@ -3,29 +3,29 @@ import Page, { TwilioResponsePayload } from "../../../base/Page";
 import Response from "../../../http/response";
 import V2 from "../V2";
 /**
- * The Status of this Sender
+ * The status of the sender.
  */
-export type ChannelsSenderStatus = "CREATING" | "ONLINE" | "OFFLINE" | "PENDING_VERIFICATION" | "VERIFYING" | "ONLINE:UPDATING" | "TWILIO_REVIEW" | "DRAFT";
+export type ChannelsSenderStatus = "CREATING" | "ONLINE" | "OFFLINE" | "PENDING_VERIFICATION" | "VERIFYING" | "ONLINE:UPDATING" | "TWILIO_REVIEW" | "DRAFT" | "STUBBED";
 /**
- * Configuration settings for creating a sender, e.g., {\"waba_id\": \"1234567890\", \"verification_method\": \"sms\"}
+ * The configuration settings for creating a sender.
  */
 export declare class MessagingV2ChannelsSenderConfiguration {
     /**
-     * The ID of the WhatsApp Business Account to use for this sender.
+     * The ID of the WhatsApp Business Account (WABA) to use for this sender.
      */
-    "waba_id"?: string | null;
+    "wabaId"?: string | null;
     /**
-     * The method to use for verification. Either \"sms\" or \"voice\".
+     * The verification method.
      */
-    "verification_method"?: string | null;
+    "verificationMethod"?: string | null;
     /**
-     * The verification code to use for this sender.
+     * The verification code.
      */
-    "verification_code"?: string | null;
+    "verificationCode"?: string | null;
     /**
-     * The SID of the Twilio Voice application to use for this sender.
+     * The SID of the Twilio Voice application.
      */
-    "voice_application_sid"?: string | null;
+    "voiceApplicationSid"?: string | null;
 }
 export declare class MessagingV2ChannelsSenderOfflineReasonsItems {
     /**
@@ -39,18 +39,18 @@ export declare class MessagingV2ChannelsSenderOfflineReasonsItems {
     /**
      * The URL to get more information about the error.
      */
-    "more_info"?: string | null;
+    "moreInfo"?: string | null;
 }
 /**
- * Sender profile configuration 1) RCS 2) Whatsapp
+ * The profile information for the sender.
  */
 export declare class MessagingV2ChannelsSenderProfile {
     /**
-     * The name of the sender.
+     * The name of the sender. Required for WhatsApp senders and must follow [Meta\'s display name guidelines](https://www.facebook.com/business/help/757569725593362).
      */
     "name"?: string | null;
     /**
-     * The about text of the sender.
+     * The profile about text for the sender.
      */
     "about"?: string | null;
     /**
@@ -64,42 +64,42 @@ export declare class MessagingV2ChannelsSenderProfile {
     /**
      * The logo URL of the sender.
      */
-    "logo_url"?: string | null;
+    "logoUrl"?: string | null;
     /**
      * The banner URL of the sender.
      */
-    "banner_url"?: string | null;
+    "bannerUrl"?: string | null;
     /**
-     * The privacy URL of the sender. Publicly accessible URI associated with the Sender, must use the HTTP or HTTPS protocol
+     * The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
      */
-    "privacy_url"?: string | null;
+    "privacyUrl"?: string | null;
     /**
      * The terms of service URL of the sender.
      */
-    "terms_of_service_url"?: string | null;
+    "termsOfServiceUrl"?: string | null;
     /**
-     * string - Color theme of the Sender (required, in hex format, need to be a minimum 4.5:1 contrast ratio relative to white)
+     * The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
      */
-    "accent_color"?: string | null;
+    "accentColor"?: string | null;
     /**
-     * The vertical of the sender. Allowed values are: - \"Automotive\" - \"Beauty, Spa and Salon\" - \"Clothing and Apparel\" - \"Education\" - \"Entertainment\" - \"Event Planning and Service\" - \"Finance and Banking\" - \"Food and Grocery\" - \"Public Service\" - \"Hotel and Lodging\" - \"Medical and Health\" - \"Non-profit\" - \"Professional Services\" - \"Shopping and Retail\" - \"Travel and Transportation\" - \"Restaurant\" - \"Other\"
+     * The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
      */
     "vertical"?: string | null;
     /**
-     * The websites of the sender
+     * The websites of the sender.
      */
     "websites"?: any | null;
     /**
-     * The emails of the sender
+     * The emails of the sender.
      */
     "emails"?: any | null;
     /**
-     * The phone numbers of the sender
+     * The phone numbers of the sender.
      */
-    "phone_numbers"?: any | null;
+    "phoneNumbers"?: any | null;
 }
 /**
- * Sender profile configuration response 1) RCS 2) Whatsapp
+ * The profile information for the sender.
  */
 export declare class MessagingV2ChannelsSenderProfileGenericResponse {
     /**
@@ -107,7 +107,7 @@ export declare class MessagingV2ChannelsSenderProfileGenericResponse {
      */
     "name"?: string | null;
     /**
-     * The about text of the sender.
+     * The profile about text for the sender.
      */
     "about"?: string | null;
     /**
@@ -121,25 +121,25 @@ export declare class MessagingV2ChannelsSenderProfileGenericResponse {
     /**
      * The logo URL of the sender.
      */
-    "logo_url"?: string | null;
+    "logoUrl"?: string | null;
     /**
      * The banner URL of the sender.
      */
-    "banner_url"?: string | null;
+    "bannerUrl"?: string | null;
     /**
-     * The privacy URL of the sender. Publicly accessible URI associated with the Sender, must use the HTTP or HTTPS protocol
+     * The privacy URL of the sender. Must be a publicly accessible HTTP or HTTPS URI associated with the sender.
      */
-    "privacy_url"?: string | null;
+    "privacyUrl"?: string | null;
     /**
      * The terms of service URL of the sender.
      */
-    "terms_of_service_url"?: string | null;
+    "termsOfServiceUrl"?: string | null;
     /**
-     * string - Color theme of the Sender (required, in hex format, need to be a minimum 4.5:1 contrast ratio relative to white)
+     * The color theme of the sender. Must be in hex format and have at least a 4:5:1 contrast ratio against white.
      */
-    "accent_color"?: string | null;
+    "accentColor"?: string | null;
     /**
-     * The vertical of the sender. Allowed values are: - \"Automotive\" - \"Beauty, Spa and Salon\" - \"Clothing and Apparel\" - \"Education\" - \"Entertainment\" - \"Event Planning and Service\" - \"Finance and Banking\" - \"Food and Grocery\" - \"Public Service\" - \"Hotel and Lodging\" - \"Medical and Health\" - \"Non-profit\" - \"Professional Services\" - \"Shopping and Retail\" - \"Travel and Transportation\" - \"Restaurant\" - \"Other\"
+     * The vertical of the sender. Allowed values are: - `Automotive` - `Beauty, Spa and Salon` - `Clothing and Apparel` - `Education` - `Entertainment` - `Event Planning and Service` - `Finance and Banking` - `Food and Grocery` - `Public Service` - `Hotel and Lodging` - `Medical and Health` - `Non-profit` - `Professional Services` - `Shopping and Retail` - `Travel and Transportation` - `Restaurant` - `Other`
      */
     "vertical"?: string | null;
     /**
@@ -153,14 +153,14 @@ export declare class MessagingV2ChannelsSenderProfileGenericResponse {
     /**
      * The phone numbers of the sender.
      */
-    "phone_numbers"?: Array<MessagingV2ChannelsSenderProfileGenericResponsePhoneNumbers> | null;
+    "phoneNumbers"?: Array<MessagingV2ChannelsSenderProfileGenericResponsePhoneNumbers> | null;
 }
 export declare class MessagingV2ChannelsSenderProfileGenericResponseEmails {
     "email"?: string;
     "label"?: string;
 }
 export declare class MessagingV2ChannelsSenderProfileGenericResponsePhoneNumbers {
-    "phone_number"?: string;
+    "phoneNumber"?: string;
     "label"?: string;
 }
 export declare class MessagingV2ChannelsSenderProfileGenericResponseWebsites {
@@ -168,23 +168,23 @@ export declare class MessagingV2ChannelsSenderProfileGenericResponseWebsites {
     "label"?: string;
 }
 /**
- * Sender specific additional properties, e.g., {\"quality_rating\": \"HIGH\", \"messaging_limit\": \"10K Customers/24hr\"}
+ * The additional properties for the sender.
  */
 export declare class MessagingV2ChannelsSenderProperties {
     /**
      * The quality rating of the sender.
      */
-    "quality_rating"?: string | null;
+    "qualityRating"?: string | null;
     /**
      * The messaging limit of the sender.
      */
-    "messaging_limit"?: string | null;
+    "messagingLimit"?: string | null;
 }
 export declare class MessagingV2ChannelsSenderRequestsCreate {
     /**
-     * The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+     * The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format.
      */
-    "sender_id": string | null;
+    "senderId": string | null;
     "configuration"?: MessagingV2ChannelsSenderConfiguration | null;
     "webhook"?: MessagingV2ChannelsSenderWebhook | null;
     "profile"?: MessagingV2ChannelsSenderProfile | null;
@@ -195,72 +195,72 @@ export declare class MessagingV2ChannelsSenderRequestsUpdate {
     "profile"?: MessagingV2ChannelsSenderProfile | null;
 }
 /**
- * Webhook specific configurations, e.g., {\"callback_url\": \"https://xxx\", \"callback_method\": \"POST\", \"fallback_url\": \"https://xxx\", \"fallback_method\": \"POST\", \"status_callback_url\": \"https://xxx\", \"status_callback_method\": \"POST\"}
+ * The configuration settings for webhooks.
  */
 export declare class MessagingV2ChannelsSenderWebhook {
     /**
      * The URL to send the webhook to.
      */
-    "callback_url"?: string | null;
+    "callbackUrl"?: string | null;
     /**
-     * The HTTP method to use for the webhook. Either \"POST\" or \"PUT\".
+     * The HTTP method for the webhook.
      */
-    "callback_method"?: string | null;
+    "callbackMethod"?: string | null;
     /**
      * The URL to send the fallback webhook to.
      */
-    "fallback_url"?: string | null;
+    "fallbackUrl"?: string | null;
     /**
-     * The HTTP method to use for the fallback webhook. Either \"POST\" or \"PUT\".
+     * The HTTP method for the fallback webhook.
      */
-    "fallback_method"?: string | null;
+    "fallbackMethod"?: string | null;
     /**
      * The URL to send the status callback to.
      */
-    "status_callback_url"?: string | null;
+    "statusCallbackUrl"?: string | null;
     /**
-     * The HTTP method to use for the status callback.
+     * The HTTP method for the status callback.
      */
-    "status_callback_method"?: string | null;
+    "statusCallbackMethod"?: string | null;
 }
 export declare class MessagingV2RcsCarrier {
     /**
-     * carrier in a country e.g. For US-Verizon, AT&T
+     * The name of the carrier. For example, `Verizon` or `AT&T` for US.
      */
     "name"?: string;
     "status"?: MessagingV2RcsCarrierStatus;
 }
 /**
- * Carrier level status
+ * The carrier-level status.
  */
 export type MessagingV2RcsCarrierStatus = "UNKNOWN" | "UNLAUNCHED" | "CARRIER_REVIEW" | "APPROVED" | "REJECTED" | "SUSPENDED";
 export declare class MessagingV2RcsComplianceCountryResponse {
     /**
-     * ISO 3166-1 alpha-2 country code (e.g., \'US\', \'UK\').
+     * The ISO 3166-1 alpha-2 country code.
      */
     "country": string;
     /**
-     * The default compliance registration SID (e.g., from CR-Google) that applies to all countries  unless overridden within the `countries` array.
+     * The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array.
      */
-    "registration_sid": string;
+    "registrationSid": string;
     "status": MessagingV2RcsCountryStatus;
     "carriers"?: Array<MessagingV2RcsCarrier>;
 }
 /**
- * KYC compliance information.  This section consists of response to the request launch
+ * The KYC compliance information. This section consists of response to the request launch.
  */
 export declare class MessagingV2RcsComplianceResponse {
     /**
-     * The default compliance registration SID (e.g., from CR-Google) that applies to all countries  unless overridden within the `countries` array.
+     * The default compliance registration SID (e.g., from CR-Google) that applies to all countries unless overridden in the `countries` array.
      */
-    "registration_sid": string;
+    "registrationSid": string;
     /**
-     * A list of country-specific compliance details.  It consists of registration_sid, country iso code, country status and carriers information
+     * A list of country-specific compliance details.
      */
     "countries": Array<MessagingV2RcsComplianceCountryResponse>;
 }
 /**
- * Country level status, it is an aggregation of Carrier level status
+ * The country-level status. Based on the aggregation of the carrier-level status.
  */
 export type MessagingV2RcsCountryStatus = "ONLINE" | "OFFLINE" | "TWILIO_REVIEW" | "PENDING_VERIFICATION";
 /**
@@ -283,7 +283,7 @@ export interface ChannelsSenderListInstanceCreateOptions {
 export interface ChannelsSenderListInstanceEachOptions {
     /**  */
     channel: string;
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    /** The number of items to return per page. */
     pageSize?: number;
     /** Function to process each record. If this and a positional callback are passed, this one will be used */
     callback?: (item: ChannelsSenderInstance, done: (err?: Error) => void) => void;
@@ -298,7 +298,7 @@ export interface ChannelsSenderListInstanceEachOptions {
 export interface ChannelsSenderListInstanceOptions {
     /**  */
     channel: string;
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    /** The number of items to return per page. */
     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;
@@ -309,7 +309,7 @@ export interface ChannelsSenderListInstanceOptions {
 export interface ChannelsSenderListInstancePageOptions {
     /**  */
     channel: string;
-    /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
+    /** The number of items to return per page. */
     pageSize?: number;
     /** Page Number, this value is simply for client state */
     pageNumber?: number;
@@ -397,12 +397,12 @@ export declare class ChannelsSenderInstance {
     protected _context?: ChannelsSenderContext;
     constructor(_version: V2, payload: ChannelsSenderResource, sid?: string);
     /**
-     * A 34 character string that uniquely identifies this Sender.
+     * The SID of the sender.
      */
     sid: string;
     status: ChannelsSenderStatus;
     /**
-     * The ID of this Sender prefixed with the channel, e.g., `whatsapp:E.164`
+     * The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format.
      */
     senderId: string;
     configuration: MessagingV2ChannelsSenderConfiguration;
@@ -410,12 +410,12 @@ export declare class ChannelsSenderInstance {
     profile: MessagingV2ChannelsSenderProfileGenericResponse;
     properties: MessagingV2ChannelsSenderProperties;
     /**
-     * Reasons why the sender is offline., e.g., [{\"code\": \"21211400\", \"message\": \"Whatsapp business account is banned by provider {provider_name} | Credit line is assigned to another BSP\", \"more_info\": \"https://www.twilio.com/docs/errors/21211400\"}]
+     * The reasons why the sender is offline.
      */
     offlineReasons: Array<MessagingV2ChannelsSenderOfflineReasonsItems>;
     compliance: MessagingV2RcsComplianceResponse;
     /**
-     * The URL of this resource, relative to `https://messaging.twilio.com`.
+     * The URL of the resource.
      */
     url: string;
     private get _proxy();

package/lib/rest/messaging/v2/channelsSender.js

@@ -24,7 +24,7 @@ const deserialize = require("../../../base/deserialize");
 const serialize = require("../../../base/serialize");
 const utility_1 = require("../../../base/utility");
 /**
- * Configuration settings for creating a sender, e.g., {\"waba_id\": \"1234567890\", \"verification_method\": \"sms\"}
+ * The configuration settings for creating a sender.
  */
 class MessagingV2ChannelsSenderConfiguration {
 }
@@ -33,13 +33,13 @@ class MessagingV2ChannelsSenderOfflineReasonsItems {
 }
 exports.MessagingV2ChannelsSenderOfflineReasonsItems = MessagingV2ChannelsSenderOfflineReasonsItems;
 /**
- * Sender profile configuration 1) RCS 2) Whatsapp
+ * The profile information for the sender.
  */
 class MessagingV2ChannelsSenderProfile {
 }
 exports.MessagingV2ChannelsSenderProfile = MessagingV2ChannelsSenderProfile;
 /**
- * Sender profile configuration response 1) RCS 2) Whatsapp
+ * The profile information for the sender.
  */
 class MessagingV2ChannelsSenderProfileGenericResponse {
 }
@@ -54,7 +54,7 @@ class MessagingV2ChannelsSenderProfileGenericResponseWebsites {
 }
 exports.MessagingV2ChannelsSenderProfileGenericResponseWebsites = MessagingV2ChannelsSenderProfileGenericResponseWebsites;
 /**
- * Sender specific additional properties, e.g., {\"quality_rating\": \"HIGH\", \"messaging_limit\": \"10K Customers/24hr\"}
+ * The additional properties for the sender.
  */
 class MessagingV2ChannelsSenderProperties {
 }
@@ -66,7 +66,7 @@ class MessagingV2ChannelsSenderRequestsUpdate {
 }
 exports.MessagingV2ChannelsSenderRequestsUpdate = MessagingV2ChannelsSenderRequestsUpdate;
 /**
- * Webhook specific configurations, e.g., {\"callback_url\": \"https://xxx\", \"callback_method\": \"POST\", \"fallback_url\": \"https://xxx\", \"fallback_method\": \"POST\", \"status_callback_url\": \"https://xxx\", \"status_callback_method\": \"POST\"}
+ * The configuration settings for webhooks.
  */
 class MessagingV2ChannelsSenderWebhook {
 }
@@ -78,7 +78,7 @@ class MessagingV2RcsComplianceCountryResponse {
 }
 exports.MessagingV2RcsComplianceCountryResponse = MessagingV2RcsComplianceCountryResponse;
 /**
- * KYC compliance information.  This section consists of response to the request launch
+ * The KYC compliance information. This section consists of response to the request launch.
  */
 class MessagingV2RcsComplianceResponse {
 }

package/lib/rest/numbers/V3.d.ts

@@ -0,0 +1,15 @@
+import NumbersBase from "../NumbersBase";
+import Version from "../../base/Version";
+import { HostedNumberOrderListInstance } from "./v3/hostedNumberOrder";
+export default class V3 extends Version {
+    /**
+     * Initialize the V3 version of Numbers
+     *
+     * @param domain - The Twilio (Twilio.Numbers) domain
+     */
+    constructor(domain: NumbersBase);
+    /** hostedNumberOrders - { Twilio.Numbers.V3.HostedNumberOrderListInstance } resource */
+    protected _hostedNumberOrders?: HostedNumberOrderListInstance;
+    /** Getter for hostedNumberOrders resource */
+    get hostedNumberOrders(): HostedNumberOrderListInstance;
+}

package/lib/rest/numbers/V3.js

@@ -0,0 +1,37 @@
+"use strict";
+/*
+ * This code was generated by
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Numbers
+ * 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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Version_1 = __importDefault(require("../../base/Version"));
+const hostedNumberOrder_1 = require("./v3/hostedNumberOrder");
+class V3 extends Version_1.default {
+    /**
+     * Initialize the V3 version of Numbers
+     *
+     * @param domain - The Twilio (Twilio.Numbers) domain
+     */
+    constructor(domain) {
+        super(domain, "v3");
+    }
+    /** Getter for hostedNumberOrders resource */
+    get hostedNumberOrders() {
+        this._hostedNumberOrders =
+            this._hostedNumberOrders || (0, hostedNumberOrder_1.HostedNumberOrderListInstance)(this);
+        return this._hostedNumberOrders;
+    }
+}
+exports.default = V3;

package/lib/rest/numbers/v1/portingPortIn.d.ts

@@ -87,15 +87,15 @@ export declare class PortingPortInInstance {
      */
     notificationEmails: Array<string>;
     /**
-     * Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. We can\'t guarantee the exact date and time, as this depends on the losing carrier
+     * Target date to port the number. We cannot guarantee that this date will be honored by the other carriers, please work with Ops to get a confirmation of the firm order commitment (FOC) date. Expected format is ISO Local Date, example: ‘2011-12-03`. This date must be at least 7 days in the future for US ports and 10 days in the future for Japanese ports. If a start and end range is provided, the date will be converted to its UTC equivalent with the ranges as reference and stored in UTC. We can\'t guarantee the exact date and time, as this depends on the losing carrier.
      */
     targetPortInDate: Date;
     /**
-     * The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00\'. We can\'t guarantee the exact date and time, as this depends on the losing carrier
+     * The earliest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00\'. We can\'t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.
      */
     targetPortInTimeRangeStart: string;
     /**
-     * The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00\'. We can\'t guarantee the exact date and time, as this depends on the losing carrier
+     * The latest time that the port should occur on the target port in date. Expected format is ISO Offset Time, example: ‘10:15:00-08:00\'. We can\'t guarantee the exact date and time, as this depends on the losing carrier. The time will be stored and returned as UTC standard timezone.
      */
     targetPortInTimeRangeEnd: string;
     /**