twilio-ruby 5.39.3 → 5.40.0

data/lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

@@ -0,0 +1,322 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Events < Domain
+      class V1 < Version
+        class SubscriptionContext < InstanceContext
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventList < ListResource
+            ##
+            # Initialize the SubscribedEventList
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The subscription_sid
+            # @return [SubscribedEventList] SubscribedEventList
+            def initialize(version, subscription_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid}
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents"
+            end
+
+            ##
+            # Lists SubscribedEventInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit.  Default is no limit
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records.  If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Array] Array of up to limit results
+            def list(limit: nil, page_size: nil)
+              self.stream(limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams SubscribedEventInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [Integer] limit Upper limit for the number of records to return. stream()
+            #    guarantees to never return more than limit. Default is no limit.
+            # @param [Integer] page_size Number of records to fetch per request, when
+            #    not set will use the default value of 50 records. If no page_size is defined
+            #    but a limit is defined, stream() will attempt to read the limit with the most
+            #    efficient page size, i.e. min(limit, 1000)
+            # @return [Enumerable] Enumerable that will yield up to limit results
+            def stream(limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields SubscribedEventInstance records from the API.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            def each
+              limits = @version.read_limits
+
+              page = self.page(page_size: limits[:page_size], )
+
+              @version.stream(page,
+                              limit: limits[:limit],
+                              page_limit: limits[:page_limit]).each {|x| yield x}
+            end
+
+            ##
+            # Retrieve a single page of SubscribedEventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] page_token PageToken provided by the API
+            # @param [Integer] page_number Page Number, this value is simply for client state
+            # @param [Integer] page_size Number of records to return, defaults to 50
+            # @return [Page] Page of SubscribedEventInstance
+            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+
+              response = @version.page('GET', @uri, params: params)
+
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of SubscribedEventInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of SubscribedEventInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              SubscribedEventPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Create the SubscribedEventInstance
+            # @param [String] type The type
+            # @param [String] version The version
+            # @return [SubscribedEventInstance] Created SubscribedEventInstance
+            def create(type: nil, version: :unset)
+              data = Twilio::Values.of({'Type' => type, 'Version' => version, })
+
+              payload = @version.create('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Events.V1.SubscribedEventList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventPage < Page
+            ##
+            # Initialize the SubscribedEventPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SubscribedEventPage] SubscribedEventPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SubscribedEventInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def get_instance(payload)
+              SubscribedEventInstance.new(@version, payload, subscription_sid: @solution[:subscription_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Events.V1.SubscribedEventPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventContext < InstanceContext
+            ##
+            # Initialize the SubscribedEventContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] subscription_sid The subscription_sid
+            # @param [String] type The type
+            # @return [SubscribedEventContext] SubscribedEventContext
+            def initialize(version, subscription_sid, type)
+              super(version)
+
+              # Path Solution
+              @solution = {subscription_sid: subscription_sid, type: type, }
+              @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents/#{@solution[:type]}"
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] version The version
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(version: nil)
+              data = Twilio::Values.of({'Version' => version, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SubscribedEventInstance.new(
+                  @version,
+                  payload,
+                  subscription_sid: @solution[:subscription_sid],
+                  type: @solution[:type],
+              )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Events.V1.SubscribedEventContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SubscribedEventInstance < InstanceResource
+            ##
+            # Initialize the SubscribedEventInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] subscription_sid The subscription_sid
+            # @param [String] type The type
+            # @return [SubscribedEventInstance] SubscribedEventInstance
+            def initialize(version, payload, subscription_sid: nil, type: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'account_sid' => payload['account_sid'],
+                  'type' => payload['type'],
+                  'version' => payload['version'].to_i,
+                  'subscription_sid' => payload['subscription_sid'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'subscription_sid' => subscription_sid, 'type' => type || @properties['type'], }
+            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 [SubscribedEventContext] SubscribedEventContext for this SubscribedEventInstance
+            def context
+              unless @instance_context
+                @instance_context = SubscribedEventContext.new(
+                    @version,
+                    @params['subscription_sid'],
+                    @params['type'],
+                )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The type
+            def type
+              @properties['type']
+            end
+
+            ##
+            # @return [String] The version
+            def version
+              @properties['version']
+            end
+
+            ##
+            # @return [String] The subscription_sid
+            def subscription_sid
+              @properties['subscription_sid']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Update the SubscribedEventInstance
+            # @param [String] version The version
+            # @return [SubscribedEventInstance] Updated SubscribedEventInstance
+            def update(version: nil)
+              context.update(version: version, )
+            end
+
+            ##
+            # Delete the SubscribedEventInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Events.V1.SubscribedEventInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/proxy/v1/service/session.rb

@@ -127,8 +127,19 @@ module Twilio
             #   on create.
             # @param [Hash] participants The Participant objects to include in the new
             #   session.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] Setting to true
+            #   enables early opt-in to allowing Proxy to reject a Session create (with
+            #   Participants) request that could cause the same Identifier/ProxyIdentifier pair
+            #   to be active in multiple Sessions. Depending on the context, this could be a 409
+            #   error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not
+            #   provided, or if set to false, requests will be allowed to succeed and a Debugger
+            #   notification (80802) will be emitted. Having multiple, active Participants with
+            #   the same Identifier/ProxyIdentifier pair causes calls and messages from affected
+            #   Participants to be routed incorrectly. Please note, in a future release, the
+            #   default behavior will be to reject the request as described unless an exception
+            #   has been requested.
             # @return [SessionInstance] Created SessionInstance
-            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset)
+            def create(unique_name: :unset, date_expiry: :unset, ttl: :unset, mode: :unset, status: :unset, participants: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
                   'DateExpiry' => Twilio.serialize_iso8601_datetime(date_expiry),
@@ -136,6 +147,7 @@ module Twilio
                   'Mode' => mode,
                   'Status' => status,
                   'Participants' => Twilio.serialize_list(participants) { |e| Twilio.serialize_object(e) },
+                  'FailOnParticipantConflict' => fail_on_participant_conflict,
               })
 
               payload = @version.create('POST', @uri, data: data)
@@ -230,14 +242,16 @@ module Twilio
             #   is measured from the last Session create or the Session's last Interaction.
             # @param [session.Status] status The new status of the resource. Can be:
             #   `in-progress` to re-open a session or `closed` to close a session.
-            # @param [Boolean] fail_on_participant_conflict Setting to true (recommended),
-            #   enables Proxy to return a 400 error (Twilio error code 80604) when a request to
-            #   set a Session to in-progress would cause Participants with the same
-            #   identifier/proxy_identifier pair to be active in multiple Sessions. If not
-            #   provided, or if set to false, requests will be allowed to succeed and a Debugger
-            #   event (80801) will be emitted. This causes calls and messages from affected
-            #   Participants to be routed incorrectly. Please note, in a future release, the
-            #   default behavior will be to reject the request with a 400 error.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] Setting to true
+            #   enables early opt-in to allowing Proxy to return a 400 error (Twilio error code
+            #   80604) when a request to set a Session to in-progress would cause Participants
+            #   with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
+            #   If not provided, or if set to false, requests will be allowed to succeed, and a
+            #   Debugger notification (80801) will be emitted. Having multiple, active
+            #   Participants with the same Identifier/ProxyIdentifier pair causes calls and
+            #   messages from affected Participants to be routed incorrectly. Please note, in a
+            #   future release, the default behavior will be to reject the request with a 400
+            #   error unless an exception has been requested.
             # @return [SessionInstance] Updated SessionInstance
             def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
               data = Twilio::Values.of({
@@ -482,14 +496,16 @@ module Twilio
             #   is measured from the last Session create or the Session's last Interaction.
             # @param [session.Status] status The new status of the resource. Can be:
             #   `in-progress` to re-open a session or `closed` to close a session.
-            # @param [Boolean] fail_on_participant_conflict Setting to true (recommended),
-            #   enables Proxy to return a 400 error (Twilio error code 80604) when a request to
-            #   set a Session to in-progress would cause Participants with the same
-            #   identifier/proxy_identifier pair to be active in multiple Sessions. If not
-            #   provided, or if set to false, requests will be allowed to succeed and a Debugger
-            #   event (80801) will be emitted. This causes calls and messages from affected
-            #   Participants to be routed incorrectly. Please note, in a future release, the
-            #   default behavior will be to reject the request with a 400 error.
+            # @param [Boolean] fail_on_participant_conflict [Experimental] Setting to true
+            #   enables early opt-in to allowing Proxy to return a 400 error (Twilio error code
+            #   80604) when a request to set a Session to in-progress would cause Participants
+            #   with the same Identifier/ProxyIdentifier pair to be active in multiple Sessions.
+            #   If not provided, or if set to false, requests will be allowed to succeed, and a
+            #   Debugger notification (80801) will be emitted. Having multiple, active
+            #   Participants with the same Identifier/ProxyIdentifier pair causes calls and
+            #   messages from affected Participants to be routed incorrectly. Please note, in a
+            #   future release, the default behavior will be to reject the request with a 400
+            #   error unless an exception has been requested.
             # @return [SessionInstance] Updated SessionInstance
             def update(date_expiry: :unset, ttl: :unset, status: :unset, fail_on_participant_conflict: :unset)
               context.update(

data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb

@@ -121,13 +121,25 @@ module Twilio
               #   Participant. If not specified, Proxy will select a number from the pool.
               # @param [String] proxy_identifier_sid The SID of the Proxy Identifier to assign
               #   to the Participant.
+              # @param [Boolean] fail_on_participant_conflict [Experimental] Setting to true
+              #   enables early opt-in to allowing Proxy to reject a Participant create request
+              #   that could cause the same Identifier/ProxyIdentifier pair to be active in
+              #   multiple Sessions. Depending on the context, this could be a 409 error (Twilio
+              #   error code 80623) or a 400 error (Twilio error code 80604). If not provided, or
+              #   if set to false, requests will be allowed to succeed and a Debugger notification
+              #   (80802) will be emitted. Having multiple, active Participants with the same
+              #   Identifier/ProxyIdentifier pair causes calls and messages from affected
+              #   Participants to be routed incorrectly. Please note, in a future release, the
+              #   default behavior will be to reject the request as described unless an exception
+              #   has been requested.
               # @return [ParticipantInstance] Created ParticipantInstance
-              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset)
+              def create(identifier: nil, friendly_name: :unset, proxy_identifier: :unset, proxy_identifier_sid: :unset, fail_on_participant_conflict: :unset)
                 data = Twilio::Values.of({
                     'Identifier' => identifier,
                     'FriendlyName' => friendly_name,
                     'ProxyIdentifier' => proxy_identifier,
                     'ProxyIdentifierSid' => proxy_identifier_sid,
+                    'FailOnParticipantConflict' => fail_on_participant_conflict,
                 })
 
                 payload = @version.create('POST', @uri, data: data)

data/lib/twilio-ruby/rest/supersim/v1/fleet.rb

@@ -29,25 +29,26 @@ module Twilio
           # Create the FleetInstance
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that will control which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @param [String] unique_name An application-defined string that uniquely
           #   identifies the resource. It can be used in place of the resource's `sid` in the
           #   URL to address the resource.
           # @param [Boolean] data_enabled Defines whether SIMs in the Fleet are capable of
-          #   using 2G/3G/4G/LTE/CAT-M data connectivity
+          #   using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to `true`.
           # @param [String] data_limit The total data usage (download and upload combined)
           #   in Megabytes that each Sim resource assigned to the Fleet resource can consume
           #   during a billing period (normally one month). Value must be between 1MB (1) and
-          #   2TB (2,000,000).
+          #   2TB (2,000,000). Defaults to 1GB (1,000).
           # @param [Boolean] commands_enabled Defines whether SIMs in the Fleet are capable
-          #   of sending and receiving machine-to-machine SMS via Commands.
+          #   of sending and receiving machine-to-machine SMS via Commands. Defaults to
+          #   `true`.
           # @param [String] commands_url The URL that will receive a webhook when a SIM in
           #   the Fleet originates a machine-to-machine SMS via Commands. Your server should
           #   respond with an HTTP status code in the 200 range; any response body will be
           #   ignored.
           # @param [String] commands_method A string representing the HTTP method to use
-          #   when making a request to `commands_url`. Can be one of POST or GET. Defaults to
-          #   POST.
+          #   when making a request to `commands_url`. Can be one of `POST` or `GET`. Defaults
+          #   to `POST`.
           # @return [FleetInstance] Created FleetInstance
           def create(network_access_profile: nil, unique_name: :unset, data_enabled: :unset, data_limit: :unset, commands_enabled: :unset, commands_url: :unset, commands_method: :unset)
             data = Twilio::Values.of({
@@ -71,7 +72,7 @@ module Twilio
           # memory before returning.
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that controls which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -93,7 +94,7 @@ module Twilio
           # is reached.
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that controls which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -128,7 +129,7 @@ module Twilio
           # Request is executed immediately.
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that controls which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
           # @param [Integer] page_size Number of records to return, defaults to 50
@@ -229,7 +230,7 @@ module Twilio
           #   URL to address the resource.
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that will control which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @return [FleetInstance] Updated FleetInstance
           def update(unique_name: :unset, network_access_profile: :unset)
             data = Twilio::Values.of({
@@ -394,7 +395,7 @@ module Twilio
           #   URL to address the resource.
           # @param [String] network_access_profile The SID or unique name of the Network
           #   Access Profile that will control which cellular networks the Fleet's SIMs can
-          #   connect to
+          #   connect to.
           # @return [FleetInstance] Updated FleetInstance
           def update(unique_name: :unset, network_access_profile: :unset)
             context.update(unique_name: unique_name, network_access_profile: network_access_profile, )