twilio-ruby 5.73.3 → 5.74.0

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

@@ -0,0 +1,267 @@
+##
+# 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 DomainConfigList < ListResource
+          ##
+          # Initialize the DomainConfigList
+          # @param [Version] version Version that contains the resource
+          # @return [DomainConfigList] DomainConfigList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Messaging.V1.DomainConfigList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigPage < Page
+          ##
+          # Initialize the DomainConfigPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DomainConfigPage] DomainConfigPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DomainConfigInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DomainConfigInstance] DomainConfigInstance
+          def get_instance(payload)
+            DomainConfigInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Messaging.V1.DomainConfigPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigContext < InstanceContext
+          ##
+          # Initialize the DomainConfigContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] domain_sid Unique string used to identify the domain that this
+          #   config should be associated with.
+          # @return [DomainConfigContext] DomainConfigContext
+          def initialize(version, domain_sid)
+            super(version)
+
+            # Path Solution
+            @solution = {domain_sid: domain_sid, }
+            @uri = "/LinkShortening/Domains/#{@solution[:domain_sid]}/Config"
+          end
+
+          ##
+          # Update the DomainConfigInstance
+          # @param [Array[String]] messaging_service_sids A list of messagingServiceSids
+          #   (with prefix MG)
+          # @param [String] fallback_url Any requests we receive to this domain that do not
+          #   match an existing shortened message will be redirected to the fallback url.
+          #   These will likely be either expired messages, random misdirected traffic, or
+          #   intentional scraping.
+          # @param [String] callback_url URL to receive click events to your webhook
+          #   whenever the recipients click on the shortened links
+          # @param [String] messaging_service_sids_action An action type for
+          #   messaging_service_sids operation (ADD, DELETE, REPLACE)
+          # @return [DomainConfigInstance] Updated DomainConfigInstance
+          def update(messaging_service_sids: nil, fallback_url: :unset, callback_url: :unset, messaging_service_sids_action: :unset)
+            data = Twilio::Values.of({
+                'MessagingServiceSids' => Twilio.serialize_list(messaging_service_sids) { |e| e },
+                'FallbackUrl' => fallback_url,
+                'CallbackUrl' => callback_url,
+                'MessagingServiceSidsAction' => messaging_service_sids_action,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            DomainConfigInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
+          end
+
+          ##
+          # Fetch the DomainConfigInstance
+          # @return [DomainConfigInstance] Fetched DomainConfigInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            DomainConfigInstance.new(@version, payload, domain_sid: @solution[:domain_sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.DomainConfigContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class DomainConfigInstance < InstanceResource
+          ##
+          # Initialize the DomainConfigInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] domain_sid Unique string used to identify the domain that this
+          #   config should be associated with.
+          # @return [DomainConfigInstance] DomainConfigInstance
+          def initialize(version, payload, domain_sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'domain_sid' => payload['domain_sid'],
+                'config_sid' => payload['config_sid'],
+                'messaging_service_sids' => payload['messaging_service_sids'],
+                'fallback_url' => payload['fallback_url'],
+                'callback_url' => payload['callback_url'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'domain_sid' => domain_sid || @properties['domain_sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [DomainConfigContext] DomainConfigContext for this DomainConfigInstance
+          def context
+            unless @instance_context
+              @instance_context = DomainConfigContext.new(@version, @params['domain_sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain resource.
+          def domain_sid
+            @properties['domain_sid']
+          end
+
+          ##
+          # @return [String] The unique string that we created to identify the Domain config (prefix ZK).
+          def config_sid
+            @properties['config_sid']
+          end
+
+          ##
+          # @return [Array[String]] A list of messagingServiceSids (with prefix MG).
+          def messaging_service_sids
+            @properties['messaging_service_sids']
+          end
+
+          ##
+          # @return [String] We will redirect requests to urls we are unable to identify to this url.
+          def fallback_url
+            @properties['fallback_url']
+          end
+
+          ##
+          # @return [String] URL to receive click events to your webhook whenever the recipients click on the shortened links.
+          def callback_url
+            @properties['callback_url']
+          end
+
+          ##
+          # @return [Time] Date this Domain Config was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] Date that this Domain Config was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the DomainConfigInstance
+          # @param [Array[String]] messaging_service_sids A list of messagingServiceSids
+          #   (with prefix MG)
+          # @param [String] fallback_url Any requests we receive to this domain that do not
+          #   match an existing shortened message will be redirected to the fallback url.
+          #   These will likely be either expired messages, random misdirected traffic, or
+          #   intentional scraping.
+          # @param [String] callback_url URL to receive click events to your webhook
+          #   whenever the recipients click on the shortened links
+          # @param [String] messaging_service_sids_action An action type for
+          #   messaging_service_sids operation (ADD, DELETE, REPLACE)
+          # @return [DomainConfigInstance] Updated DomainConfigInstance
+          def update(messaging_service_sids: nil, fallback_url: :unset, callback_url: :unset, messaging_service_sids_action: :unset)
+            context.update(
+                messaging_service_sids: messaging_service_sids,
+                fallback_url: fallback_url,
+                callback_url: callback_url,
+                messaging_service_sids_action: messaging_service_sids_action,
+            )
+          end
+
+          ##
+          # Fetch the DomainConfigInstance
+          # @return [DomainConfigInstance] Fetched DomainConfigInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Messaging.V1.DomainConfigInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,38 +33,63 @@ module Twilio
             # Create the UsAppToPersonInstance
             # @param [String] brand_registration_sid A2P Brand Registration SID
             # @param [String] description A short description of what this SMS campaign does.
-            # @param [Array[String]] message_samples Message samples, at least 2 and up to 5
-            #   sample messages, <=1024 chars each.
+            #   Min length: 40 characters. Max length: 4096 characters.
+            # @param [String] message_flow Required for all Campaigns. Details around how a
+            #   consumer opts-in to their campaign, therefore giving consent to receive their
+            #   messages. If multiple opt-in methods can be used for the same campaign, they
+            #   must all be listed. 40 character minimum. 2048 character maximum.
+            # @param [Array[String]] message_samples Message samples, at least 1 and up to 5
+            #   sample messages (at least 2 for sole proprietor), >=20 chars, <=1024 chars each.
             # @param [String] us_app_to_person_usecase A2P Campaign Use Case. Examples: [ 2FA,
             #   EMERGENCY, MARKETING..]
             # @param [Boolean] has_embedded_links Indicates that this SMS campaign will send
             #   messages that contain links.
             # @param [Boolean] has_embedded_phone Indicates that this SMS campaign will send
             #   messages that contain phone numbers.
-            # @param [String] message_flow Description of how end users opt-in to the SMS
-            #   campaign, therefore giving consent to receive messages.
-            # @param [String] opt_in_message The message that will be sent to the user when
-            #   they opt in to the SMS campaign.
-            # @param [String] opt_out_message The message that will be sent to the user when
-            #   they opt out of the SMS campaign.
-            # @param [String] help_message The message that will be sent to the user when they
-            #   request help for the SMS campaign.
-            # @param [Array[String]] opt_in_keywords The keywords that will be used to opt in
-            #   to the SMS campaign.
-            # @param [Array[String]] opt_out_keywords The keywords that will be used to opt
-            #   out of the SMS campaign.
-            # @param [Array[String]] help_keywords The keywords that will be used to request
-            #   help for the SMS campaign.
+            # @param [String] opt_in_message If end users can text in a keyword to start
+            #   receiving messages from this campaign, the auto-reply messages sent to the end
+            #   users must be provided. The opt-in response should include the Brand name,
+            #   confirmation of opt-in enrollment to a recurring message campaign, how to get
+            #   help, and clear description of how to opt-out. This field is required if end
+            #   users can text in a keyword to start receiving messages from this campaign. 20
+            #   character minimum. 320 character maximum.
+            # @param [String] opt_out_message Upon receiving the opt-out keywords from the end
+            #   users, Twilio customers are expected to send back an auto-generated response,
+            #   which must provide acknowledgment of the opt-out request and confirmation that
+            #   no further messages will be sent. It is also recommended that these opt-out
+            #   messages include the brand name. This field is required if managing opt out
+            #   keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out
+            #   features). 20 character minimum. 320 character maximum.
+            # @param [String] help_message When customers receive the help keywords from their
+            #   end users, Twilio customers are expected to send back an auto-generated
+            #   response; this may include the brand name and additional support contact
+            #   information. This field is required if managing help keywords yourself (i.e. not
+            #   using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320
+            #   character maximum.
+            # @param [Array[String]] opt_in_keywords If end users can text in a keyword to
+            #   start receiving messages from this campaign, those keywords must be provided.
+            #   This field is required if end users can text in a keyword to start receiving
+            #   messages from this campaign. Values must be alphanumeric. 255 character maximum.
+            # @param [Array[String]] opt_out_keywords End users should be able to text in a
+            #   keyword to stop receiving messages from this campaign. Those keywords must be
+            #   provided. This field is required if managing opt out keywords yourself (i.e. not
+            #   using Twilio's Default or Advanced Opt Out features). Values must be
+            #   alphanumeric. 255 character maximum.
+            # @param [Array[String]] help_keywords End users should be able to text in a
+            #   keyword to receive help. Those keywords must be provided as part of the campaign
+            #   registration request. This field is required if managing help keywords yourself
+            #   (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be
+            #   alphanumeric. 255 character maximum.
             # @return [UsAppToPersonInstance] Created UsAppToPersonInstance
-            def create(brand_registration_sid: nil, description: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, message_flow: :unset, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset)
+            def create(brand_registration_sid: nil, description: nil, message_flow: nil, message_samples: nil, us_app_to_person_usecase: nil, has_embedded_links: nil, has_embedded_phone: nil, opt_in_message: :unset, opt_out_message: :unset, help_message: :unset, opt_in_keywords: :unset, opt_out_keywords: :unset, help_keywords: :unset)
               data = Twilio::Values.of({
                   'BrandRegistrationSid' => brand_registration_sid,
                   'Description' => description,
+                  'MessageFlow' => message_flow,
                   'MessageSamples' => Twilio.serialize_list(message_samples) { |e| e },
                   'UsAppToPersonUsecase' => us_app_to_person_usecase,
                   'HasEmbeddedLinks' => has_embedded_links,
                   'HasEmbeddedPhone' => has_embedded_phone,
-                  'MessageFlow' => message_flow,
                   'OptInMessage' => opt_in_message,
                   'OptOutMessage' => opt_out_message,
                   'HelpMessage' => help_message,

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

@@ -17,6 +17,8 @@ module Twilio
           @version = 'v1'
           @brand_registrations = nil
           @deactivations = nil
+          @domain_certs = nil
+          @domain_config = nil
           @external_campaign = nil
           @services = nil
           @tollfree_verifications = nil
@@ -44,6 +46,38 @@ module Twilio
           @deactivations ||= DeactivationsContext.new self
         end
 
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   certificate should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+        def domain_certs(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_certs ||= DomainCertsList.new self
+          else
+              DomainCertsContext.new(self, domain_sid)
+          end
+        end
+
+        ##
+        # @param [String] domain_sid Unique string used to identify the domain that this
+        #   config should be associated with.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigContext] if domain_sid was passed.
+        # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+        def domain_config(domain_sid=:unset)
+          if domain_sid.nil?
+              raise ArgumentError, 'domain_sid cannot be nil'
+          end
+          if domain_sid == :unset
+              @domain_config ||= DomainConfigList.new self
+          else
+              DomainConfigContext.new(self, domain_sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Messaging::V1::ExternalCampaignContext]
         def external_campaign

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

@@ -42,6 +42,24 @@ module Twilio
         self.v1.deactivations()
       end
 
+      ##
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainCertsList]
+      def domain_certs(domain_sid=:unset)
+        self.v1.domain_certs(domain_sid)
+      end
+
+      ##
+      # @param [String] domain_sid The unique string that we created to identify the
+      #   Domain resource.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigInstance] if domain_sid was passed.
+      # @return [Twilio::REST::Messaging::V1::DomainConfigList]
+      def domain_config(domain_sid=:unset)
+        self.v1.domain_config(domain_sid)
+      end
+
       ##
       # @return [Twilio::REST::Messaging::V1::ExternalCampaignInstance]
       def external_campaign

data/lib/twilio-ruby/rest/microvisor/v1/device.rb

@@ -226,6 +226,7 @@ module Twilio
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
+                'links' => payload['links'],
             }
 
             # Context
@@ -292,6 +293,12 @@ module Twilio
             @properties['url']
           end
 
+          ##
+          # @return [String] The absolute URLs of related resources
+          def links
+            @properties['links']
+          end
+
           ##
           # Fetch the DeviceInstance
           # @return [DeviceInstance] Fetched DeviceInstance

data/lib/twilio-ruby/rest/oauth/v1/device_code.rb

@@ -0,0 +1,153 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Oauth < Domain
+      class V1 < Version
+        class DeviceCodeList < ListResource
+          ##
+          # Initialize the DeviceCodeList
+          # @param [Version] version Version that contains the resource
+          # @return [DeviceCodeList] DeviceCodeList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/device/code"
+          end
+
+          ##
+          # Create the DeviceCodeInstance
+          # @param [String] client_sid A 34 character string that uniquely identifies this
+          #   OAuth App.
+          # @param [Array[String]] scopes An Array of scopes for authorization request
+          # @param [Array[String]] audiences An array of intended audiences for token
+          #   requests
+          # @return [DeviceCodeInstance] Created DeviceCodeInstance
+          def create(client_sid: nil, scopes: nil, audiences: :unset)
+            data = Twilio::Values.of({
+                'ClientSid' => client_sid,
+                'Scopes' => Twilio.serialize_list(scopes) { |e| e },
+                'Audiences' => Twilio.serialize_list(audiences) { |e| e },
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            DeviceCodeInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Oauth.V1.DeviceCodeList>'
+          end
+        end
+
+        class DeviceCodePage < Page
+          ##
+          # Initialize the DeviceCodePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [DeviceCodePage] DeviceCodePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of DeviceCodeInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [DeviceCodeInstance] DeviceCodeInstance
+          def get_instance(payload)
+            DeviceCodeInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Oauth.V1.DeviceCodePage>'
+          end
+        end
+
+        class DeviceCodeInstance < InstanceResource
+          ##
+          # Initialize the DeviceCodeInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [DeviceCodeInstance] DeviceCodeInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'device_code' => payload['device_code'],
+                'user_code' => payload['user_code'],
+                'verification_uri' => payload['verification_uri'],
+                'verification_uri_complete' => payload['verification_uri_complete'],
+                'expires_in' => payload['expires_in'] == nil ? payload['expires_in'] : payload['expires_in'].to_i,
+                'interval' => payload['interval'] == nil ? payload['interval'] : payload['interval'].to_i,
+            }
+          end
+
+          ##
+          # @return [String] The device verification code
+          def device_code
+            @properties['device_code']
+          end
+
+          ##
+          # @return [String] The verification code for the end user
+          def user_code
+            @properties['user_code']
+          end
+
+          ##
+          # @return [String] The URI that the end user visits to verify request
+          def verification_uri
+            @properties['verification_uri']
+          end
+
+          ##
+          # @return [String] he URI with user_code that the end-user alternatively visits to verify request
+          def verification_uri_complete
+            @properties['verification_uri_complete']
+          end
+
+          ##
+          # @return [String] The expiration time of the device_code and user_code in seconds
+          def expires_in
+            @properties['expires_in']
+          end
+
+          ##
+          # @return [String] The minimum amount of time in seconds that the client should wait between polling requests to the token endpoint
+          def interval
+            @properties['interval']
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            "<Twilio.Oauth.V1.DeviceCodeInstance>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            "<Twilio.Oauth.V1.DeviceCodeInstance>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/oauth/v1/openid_discovery.rb

@@ -68,7 +68,7 @@ module Twilio
 
             # Path Solution
             @solution = {}
-            @uri = "/well-known/openid-configuration"
+            @uri = "/.well-known/openid-configuration"
           end
 
           ##

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

@@ -16,6 +16,7 @@ module Twilio
           super
           @version = 'v1'
           @oauth = nil
+          @device_code = nil
           @openid_discovery = nil
           @token = nil
           @user_info = nil
@@ -27,6 +28,12 @@ module Twilio
           @oauth ||= OauthContext.new self
         end
 
+        ##
+        # @return [Twilio::REST::Oauth::V1::DeviceCodeContext]
+        def device_code
+          @device_code ||= DeviceCodeList.new self
+        end
+
         ##
         # @return [Twilio::REST::Oauth::V1::OpenidDiscoveryContext]
         def openid_discovery

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

@@ -34,6 +34,12 @@ module Twilio
         self.v1.oauth()
       end
 
+      ##
+      # @return [Twilio::REST::Oauth::V1::DeviceCodeInstance]
+      def device_code
+        self.v1.device_code()
+      end
+
       ##
       # @return [Twilio::REST::Oauth::V1::OpenidDiscoveryInstance]
       def openid_discovery