twilio-ruby 5.48.0 → 5.66.2

data/lib/twilio-ruby/rest/messaging/v1/service.rb

@@ -29,15 +29,20 @@ module Twilio
           # Create the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
-          # @param [String] inbound_request_url The URL we should call using
-          #   `inbound_method` when a message is received by any phone number or short code in
-          #   the Service. When this property is `null`, receiving inbound messages is
-          #   disabled.
+          # @param [String] inbound_request_url The URL we call using `inbound_method` when
+          #   a message is received by any phone number or short code in the Service. When
+          #   this property is `null`, receiving inbound messages is disabled. All messages
+          #   sent to the Twilio phone number or short code will not be logged and received on
+          #   the Account. If the `use_inbound_webhook_on_number` field is enabled then the
+          #   webhook url defined on the phone number will override the `inbound_request_url`
+          #   defined for the Messaging Service.
           # @param [String] inbound_method The HTTP method we should use to call
           #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
-          # @param [String] fallback_url The URL that we should call using `fallback_method`
-          #   if an error occurs while retrieving or executing the TwiML from the Inbound
-          #   Request URL.
+          # @param [String] fallback_url The URL that we call using `fallback_method` if an
+          #   error occurs while retrieving or executing the TwiML from the Inbound Request
+          #   URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
+          #   url defined on the phone number will override the `fallback_url` defined for the
+          #   Messaging Service.
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to {pass status
@@ -62,8 +67,17 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..].
+          # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
+          #   either the webhook url configured on the phone number will be used or
+          #   `inbound_request_url`/`fallback_url` url will be called when a message is
+          #   received from the phone number. If this field is enabled then the webhook url
+          #   defined on the phone number will override the
+          #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Created ServiceInstance
-          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset)
+          def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -79,6 +93,8 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
+                'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
             payload = @version.create('POST', @uri, data: data)
@@ -223,21 +239,28 @@ module Twilio
             @phone_numbers = nil
             @short_codes = nil
             @alpha_senders = nil
+            @us_app_to_person = nil
+            @us_app_to_person_usecases = nil
           end
 
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
-          # @param [String] inbound_request_url The URL we should call using
-          #   `inbound_method` when a message is received by any phone number or short code in
-          #   the Service. When this property is `null`, receiving inbound messages is
-          #   disabled.
+          # @param [String] inbound_request_url The URL we call using `inbound_method` when
+          #   a message is received by any phone number or short code in the Service. When
+          #   this property is `null`, receiving inbound messages is disabled. All messages
+          #   sent to the Twilio phone number or short code will not be logged and received on
+          #   the Account. If the `use_inbound_webhook_on_number` field is enabled then the
+          #   webhook url defined on the phone number will override the `inbound_request_url`
+          #   defined for the Messaging Service.
           # @param [String] inbound_method The HTTP method we should use to call
           #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
-          # @param [String] fallback_url The URL that we should call using `fallback_method`
-          #   if an error occurs while retrieving or executing the TwiML from the Inbound
-          #   Request URL.
+          # @param [String] fallback_url The URL that we call using `fallback_method` if an
+          #   error occurs while retrieving or executing the TwiML from the Inbound Request
+          #   URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
+          #   url defined on the phone number will override the `fallback_url` defined for the
+          #   Messaging Service.
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to {pass status
@@ -262,8 +285,17 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
+          # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
+          #   either the webhook url configured on the phone number will be used or
+          #   `inbound_request_url`/`fallback_url` url will be called when a message is
+          #   received from the phone number. If this field is enabled then the webhook url
+          #   defined on the phone number will override the
+          #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'InboundRequestUrl' => inbound_request_url,
@@ -279,6 +311,8 @@ module Twilio
                 'AreaCodeGeomatch' => area_code_geomatch,
                 'ValidityPeriod' => validity_period,
                 'SynchronousValidation' => synchronous_validation,
+                'Usecase' => usecase,
+                'UseInboundWebhookOnNumber' => use_inbound_webhook_on_number,
             })
 
             payload = @version.update('POST', @uri, data: data)
@@ -356,6 +390,39 @@ module Twilio
             @alpha_senders
           end
 
+          ##
+          # Access the us_app_to_person
+          # @return [UsAppToPersonList]
+          # @return [UsAppToPersonContext] if sid was passed.
+          def us_app_to_person(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return UsAppToPersonContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @us_app_to_person
+              @us_app_to_person = UsAppToPersonList.new(@version, messaging_service_sid: @solution[:sid], )
+            end
+
+            @us_app_to_person
+          end
+
+          ##
+          # Access the us_app_to_person_usecases
+          # @return [UsAppToPersonUsecaseList]
+          # @return [UsAppToPersonUsecaseContext]
+          def us_app_to_person_usecases
+            unless @us_app_to_person_usecases
+              @us_app_to_person_usecases = UsAppToPersonUsecaseList.new(
+                  @version,
+                  messaging_service_sid: @solution[:sid],
+              )
+            end
+
+            @us_app_to_person_usecases
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
@@ -405,6 +472,9 @@ module Twilio
                 'validity_period' => payload['validity_period'].to_i,
                 'url' => payload['url'],
                 'links' => payload['links'],
+                'usecase' => payload['usecase'],
+                'us_app_to_person_registered' => payload['us_app_to_person_registered'],
+                'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
             }
 
             # Context
@@ -454,7 +524,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The URL we call using inbound_method when a message is received by any phone number or short code in the Service
+          # @return [String] The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
           def inbound_request_url
             @properties['inbound_request_url']
           end
@@ -466,7 +536,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL
+          # @return [String] The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the `use_inbound_webhook_on_number` field is enabled.
           def fallback_url
             @properties['fallback_url']
           end
@@ -543,19 +613,42 @@ module Twilio
             @properties['links']
           end
 
+          ##
+          # @return [String] A string describing the scenario in which the Messaging Service will be used
+          def usecase
+            @properties['usecase']
+          end
+
+          ##
+          # @return [Boolean] Whether US A2P campaign is registered for this Service.
+          def us_app_to_person_registered
+            @properties['us_app_to_person_registered']
+          end
+
+          ##
+          # @return [Boolean] If enabled, the webhook url configured on the phone number will be used and will override the `inbound_request_url`/`fallback_url` url called when an inbound message is received.
+          def use_inbound_webhook_on_number
+            @properties['use_inbound_webhook_on_number']
+          end
+
           ##
           # Update the ServiceInstance
           # @param [String] friendly_name A descriptive string that you create to describe
           #   the resource. It can be up to 64 characters long.
-          # @param [String] inbound_request_url The URL we should call using
-          #   `inbound_method` when a message is received by any phone number or short code in
-          #   the Service. When this property is `null`, receiving inbound messages is
-          #   disabled.
+          # @param [String] inbound_request_url The URL we call using `inbound_method` when
+          #   a message is received by any phone number or short code in the Service. When
+          #   this property is `null`, receiving inbound messages is disabled. All messages
+          #   sent to the Twilio phone number or short code will not be logged and received on
+          #   the Account. If the `use_inbound_webhook_on_number` field is enabled then the
+          #   webhook url defined on the phone number will override the `inbound_request_url`
+          #   defined for the Messaging Service.
           # @param [String] inbound_method The HTTP method we should use to call
           #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
-          # @param [String] fallback_url The URL that we should call using `fallback_method`
-          #   if an error occurs while retrieving or executing the TwiML from the Inbound
-          #   Request URL.
+          # @param [String] fallback_url The URL that we call using `fallback_method` if an
+          #   error occurs while retrieving or executing the TwiML from the Inbound Request
+          #   URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook
+          #   url defined on the phone number will override the `fallback_url` defined for the
+          #   Messaging Service.
           # @param [String] fallback_method The HTTP method we should use to call
           #   `fallback_url`. Can be: `GET` or `POST`.
           # @param [String] status_callback The URL we should call to {pass status
@@ -580,8 +673,17 @@ module Twilio
           # @param [String] validity_period How long, in seconds, messages sent from the
           #   Service are valid. Can be an integer from `1` to `14,400`.
           # @param [Boolean] synchronous_validation Reserved.
+          # @param [String] usecase A string that describes the scenario in which the
+          #   Messaging Service will be used. Examples: [notification, marketing,
+          #   verification, poll ..]
+          # @param [Boolean] use_inbound_webhook_on_number A boolean value that indicates
+          #   either the webhook url configured on the phone number will be used or
+          #   `inbound_request_url`/`fallback_url` url will be called when a message is
+          #   received from the phone number. If this field is enabled then the webhook url
+          #   defined on the phone number will override the
+          #   `inbound_request_url`/`fallback_url` defined for the Messaging Service.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset)
+          def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, usecase: :unset, use_inbound_webhook_on_number: :unset)
             context.update(
                 friendly_name: friendly_name,
                 inbound_request_url: inbound_request_url,
@@ -597,6 +699,8 @@ module Twilio
                 area_code_geomatch: area_code_geomatch,
                 validity_period: validity_period,
                 synchronous_validation: synchronous_validation,
+                usecase: usecase,
+                use_inbound_webhook_on_number: use_inbound_webhook_on_number,
             )
           end
 
@@ -635,6 +739,20 @@ module Twilio
             context.alpha_senders
           end
 
+          ##
+          # Access the us_app_to_person
+          # @return [us_app_to_person] us_app_to_person
+          def us_app_to_person
+            context.us_app_to_person
+          end
+
+          ##
+          # Access the us_app_to_person_usecases
+          # @return [us_app_to_person_usecases] us_app_to_person_usecases
+          def us_app_to_person_usecases
+            context.us_app_to_person_usecases
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/messaging/v1/usecase.rb

@@ -0,0 +1,111 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Messaging < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UsecaseList < ListResource
+          ##
+          # Initialize the UsecaseList
+          # @param [Version] version Version that contains the resource
+          # @return [UsecaseList] UsecaseList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services/Usecases"
+          end
+
+          ##
+          # Fetch the UsecaseInstance
+          # @return [UsecaseInstance] Fetched UsecaseInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UsecaseInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.UsecaseList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UsecasePage < Page
+          ##
+          # Initialize the UsecasePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UsecasePage] UsecasePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UsecaseInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UsecaseInstance] UsecaseInstance
+          def get_instance(payload)
+            UsecaseInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.UsecasePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UsecaseInstance < InstanceResource
+          ##
+          # Initialize the UsecaseInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [UsecaseInstance] UsecaseInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {'usecases' => payload['usecases'], }
+          end
+
+          ##
+          # @return [Array[Hash]] Human readable Messaging Service Use Case details
+          def usecases
+            @properties['usecases']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Messaging.V1.UsecaseInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Messaging.V1.UsecaseInstance>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/messaging/v1.rb

@@ -17,7 +17,9 @@ module Twilio
           @version = 'v1'
           @brand_registrations = nil
           @deactivations = nil
+          @external_campaign = nil
           @services = nil
+          @usecases = nil
         end
 
         ##
@@ -26,11 +28,12 @@ module Twilio
         # @return [Twilio::REST::Messaging::V1::BrandRegistrationList]
         def brand_registrations(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @brand_registrations ||= BrandRegistrationList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @brand_registrations ||= BrandRegistrationList.new self
           else
-            BrandRegistrationContext.new(self, sid)
+              BrandRegistrationContext.new(self, sid)
           end
         end
 
@@ -40,20 +43,33 @@ module Twilio
           @deactivations ||= DeactivationsContext.new self
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
+        def external_campaign
+          @external_campaign ||= ExternalCampaignList.new self
+        end
+
         ##
         # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 
+        ##
+        # @return [Twilio::REST::Messaging::V1::UsecaseContext]
+        def usecases
+          @usecases ||= UsecaseList.new self
+        end
+
         ##
         # Provide a user friendly representation
         def to_s

data/lib/twilio-ruby/rest/messaging.rb

@@ -42,6 +42,12 @@ module Twilio
         self.v1.deactivations()
       end
 
+      ##
+      # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
+      def external_campaign
+        self.v1.external_campaign()
+      end
+
       ##
       # @param [String] sid The unique string that we created to identify the Service
       #   resource.
@@ -51,6 +57,12 @@ module Twilio
         self.v1.services(sid)
       end
 
+      ##
+      # @return [Twilio::REST::Messaging::V1::UsecaseInstance]
+      def usecases
+        self.v1.usecases()
+      end
+
       ##
       # Provide a user friendly representation
       def to_s

data/lib/twilio-ruby/rest/monitor/v1.rb

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Monitor::V1::AlertList]
         def alerts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @alerts ||= AlertList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @alerts ||= AlertList.new self
           else
-            AlertContext.new(self, sid)
+              AlertContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Monitor::V1::EventList]
         def events(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @events ||= EventList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @events ||= EventList.new self
           else
-            EventContext.new(self, sid)
+              EventContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/notify/v1.rb

@@ -26,11 +26,12 @@ module Twilio
         # @return [Twilio::REST::Notify::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -41,11 +42,12 @@ module Twilio
         # @return [Twilio::REST::Notify::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end