twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -52,7 +54,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +66,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -108,20 +110,46 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] unique_name The human-readable string that uniquely identifies
-          #   this Service, up to 64 characters.
-          # @param [String] default_ttl The default Time to Live for a Session, in seconds.
-          # @param [String] callback_url The URL Twilio will send callbacks to.
-          # @param [service.GeoMatchLevel] geo_match_level Whether to find proxy numbers in
-          #   the same areacode.
-          # @param [service.NumberSelectionBehavior] number_selection_behavior What behavior
-          #   to use when choosing a proxy number.
-          # @param [String] intercept_callback_url A URL for Twilio call before each
-          #   Interaction. An error status code will prevent the interaction from continuing.
-          # @param [String] out_of_session_callback_url A URL for Twilio call when a new
-          #   Interaction has no Session.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be 191 characters or fewer in length
+          #   and be unique. **This value should not have PII.**
+          # @param [String] default_ttl The default `ttl` value to set for Sessions created
+          #   in the Service. The TTL (time to live) is measured in seconds after the
+          #   Session's last create or last Interaction. The default value of `0` indicates an
+          #   unlimited Session length. You can override a Session's default TTL value by
+          #   setting its `ttl` value.
+          # @param [String] callback_url The URL we should call when the interaction status
+          #   changes.
+          # @param [service.GeoMatchLevel] geo_match_level Where a proxy number must be
+          #   located relative to the participant identifier. Can be: `country`, `area-code`,
+          #   or `extended-area-code`. The default value is `country` and more specific areas
+          #   than `country` are only available in North America.
+          # @param [service.NumberSelectionBehavior] number_selection_behavior The
+          #   preference for Proxy Number selection in the Service instance. Can be:
+          #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
+          #   `prefer-sticky` means that we will try and select the same Proxy Number for a
+          #   given participant if they have previous
+          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
+          #   use different Proxy Numbers as long as that is possible within a given pool
+          #   rather than try and use a previously assigned number.
+          # @param [String] intercept_callback_url The URL we call on each interaction. If
+          #   we receive a 403 status, we block the interaction; otherwise the interaction
+          #   continues.
+          # @param [String] out_of_session_callback_url The URL we should call when an
+          #   inbound call or SMS action occurs on a closed or non-existent Session. If your
+          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
+          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   means it is possible, for example, to play a message for a call, send an
+          #   automated text message response, or redirect a call to another Phone Number. See
+          #   [Out-of-Session Callback Response
+          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   for more information.
+          # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
+          #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel
+          #   messages to this chat instance. This is a one-to-one relationship.
           # @return [ServiceInstance] Newly created ServiceInstance
-          def create(unique_name: nil, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset)
+          def create(unique_name: nil, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset)
             data = Twilio::Values.of({
                 'UniqueName' => unique_name,
                 'DefaultTtl' => default_ttl,
@@ -130,6 +158,7 @@ module Twilio
                 'NumberSelectionBehavior' => number_selection_behavior,
                 'InterceptCallbackUrl' => intercept_callback_url,
                 'OutOfSessionCallbackUrl' => out_of_session_callback_url,
+                'ChatInstanceSid' => chat_instance_sid,
             })
 
             payload = @version.create(
@@ -138,7 +167,7 @@ module Twilio
                 data: data
             )
 
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -169,7 +198,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ServiceInstance] ServiceInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -185,13 +214,14 @@ module Twilio
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Service resource to fetch.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Services/#{@solution[:sid]}"
 
             # Dependents
@@ -212,32 +242,58 @@ module Twilio
                 params,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] unique_name A human readable description of this resource, up to
-          #   64 characters.
-          # @param [String] default_ttl The default Time to Live for a Session, in seconds.
-          # @param [String] callback_url The URL Twilio will send callbacks to.
-          # @param [service.GeoMatchLevel] geo_match_level Whether to find proxy numbers in
-          #   the same areacode.
-          # @param [service.NumberSelectionBehavior] number_selection_behavior What behavior
-          #   to use when choosing a proxy number.
-          # @param [String] intercept_callback_url A URL for Twilio call before each
-          #   Interaction. An error status code will prevent the interaction from continuing.
-          # @param [String] out_of_session_callback_url A URL for Twilio call when a new
-          #   Interaction has no Session.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be 191 characters or fewer in length
+          #   and be unique. **This value should not have PII.**
+          # @param [String] default_ttl The default `ttl` value to set for Sessions created
+          #   in the Service. The TTL (time to live) is measured in seconds after the
+          #   Session's last create or last Interaction. The default value of `0` indicates an
+          #   unlimited Session length. You can override a Session's default TTL value by
+          #   setting its `ttl` value.
+          # @param [String] callback_url The URL we should call when the interaction status
+          #   changes.
+          # @param [service.GeoMatchLevel] geo_match_level Where a proxy number must be
+          #   located relative to the participant identifier. Can be: `country`, `area-code`,
+          #   or `extended-area-code`. The default value is `country` and more specific areas
+          #   than `country` are only available in North America.
+          # @param [service.NumberSelectionBehavior] number_selection_behavior The
+          #   preference for Proxy Number selection in the Service instance. Can be:
+          #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
+          #   `prefer-sticky` means that we will try and select the same Proxy Number for a
+          #   given participant if they have previous
+          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
+          #   use different Proxy Numbers as long as that is possible within a given pool
+          #   rather than try and use a previously assigned number.
+          # @param [String] intercept_callback_url The URL we call on each interaction. If
+          #   we receive a 403 status, we block the interaction; otherwise the interaction
+          #   continues.
+          # @param [String] out_of_session_callback_url The URL we should call when an
+          #   inbound call or SMS action occurs on a closed or non-existent Session. If your
+          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
+          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   means it is possible, for example, to play a message for a call, send an
+          #   automated text message response, or redirect a call to another Phone Number. See
+          #   [Out-of-Session Callback Response
+          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   for more information.
+          # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
+          #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel
+          #   messages to this chat instance. This is a one-to-one relationship.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset)
+          def update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset)
             data = Twilio::Values.of({
                 'UniqueName' => unique_name,
                 'DefaultTtl' => default_ttl,
@@ -246,6 +302,7 @@ module Twilio
                 'NumberSelectionBehavior' => number_selection_behavior,
                 'InterceptCallbackUrl' => intercept_callback_url,
                 'OutOfSessionCallbackUrl' => out_of_session_callback_url,
+                'ChatInstanceSid' => chat_instance_sid,
             })
 
             payload = @version.update(
@@ -254,7 +311,7 @@ module Twilio
                 data: data,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -265,11 +322,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return SessionContext.new(@version, @solution[:sid], sid)
+              return SessionContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @sessions
-              @sessions = SessionList.new(@version, service_sid: @solution[:sid])
+              @sessions = SessionList.new(@version, service_sid: @solution[:sid], )
             end
 
             @sessions
@@ -283,11 +340,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return PhoneNumberContext.new(@version, @solution[:sid], sid)
+              return PhoneNumberContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @phone_numbers
-              @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid])
+              @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid], )
             end
 
             @phone_numbers
@@ -301,11 +358,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return ShortCodeContext.new(@version, @solution[:sid], sid)
+              return ShortCodeContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @short_codes
-              @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid])
+              @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid], )
             end
 
             @short_codes
@@ -317,6 +374,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Proxy.V1.ServiceContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Proxy.V1.ServiceContext #{context}>"
+          end
         end
 
         ##
@@ -326,7 +390,8 @@ module Twilio
           # Initialize the ServiceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34 character string that uniquely identifies this Service.
+          # @param [String] sid The Twilio-provided string that uniquely identifies the
+          #   Service resource to fetch.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -336,6 +401,7 @@ module Twilio
                 'sid' => payload['sid'],
                 'unique_name' => payload['unique_name'],
                 'account_sid' => payload['account_sid'],
+                'chat_instance_sid' => payload['chat_instance_sid'],
                 'callback_url' => payload['callback_url'],
                 'default_ttl' => payload['default_ttl'].to_i,
                 'number_selection_behavior' => payload['number_selection_behavior'],
@@ -350,7 +416,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -359,85 +425,91 @@ module Twilio
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'])
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Service.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] A human readable description of this resource.
+          # @return [String] An application-defined string that uniquely identifies the resource
           def unique_name
             @properties['unique_name']
           end
 
           ##
-          # @return [String] Account Sid.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] URL Twilio will send callbacks to
+          # @return [String] The SID of the Chat Service Instance
+          def chat_instance_sid
+            @properties['chat_instance_sid']
+          end
+
+          ##
+          # @return [String] The URL we call when the interaction status changes
           def callback_url
             @properties['callback_url']
           end
 
           ##
-          # @return [String] Default TTL for a Session, in seconds.
+          # @return [String] Default TTL for a Session, in seconds
           def default_ttl
             @properties['default_ttl']
           end
 
           ##
-          # @return [service.NumberSelectionBehavior] What behavior to use when choosing a proxy number.
+          # @return [service.NumberSelectionBehavior] The preference for Proxy Number selection for the Service instance
           def number_selection_behavior
             @properties['number_selection_behavior']
           end
 
           ##
-          # @return [service.GeoMatchLevel] Whether to find proxy numbers in the same areacode.
+          # @return [service.GeoMatchLevel] Where a proxy number must be located relative to the participant identifier
           def geo_match_level
             @properties['geo_match_level']
           end
 
           ##
-          # @return [String] A URL for Twilio call before each Interaction.
+          # @return [String] The URL we call on each interaction
           def intercept_callback_url
             @properties['intercept_callback_url']
           end
 
           ##
-          # @return [String] A URL for Twilio call when a new Interaction has no Session.
+          # @return [String] The URL we call when an inbound call or SMS action occurs on a closed or non-existent Session
           def out_of_session_callback_url
             @properties['out_of_session_callback_url']
           end
 
           ##
-          # @return [Time] The date this Service was created
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date this Service was updated
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The URL of this resource.
+          # @return [String] The absolute URL of the Service resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] Nested resource URLs.
+          # @return [String] The URLs of resources related to the Service
           def links
             @properties['links']
           end
@@ -451,27 +523,53 @@ module Twilio
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
 
           ##
           # Update the ServiceInstance
-          # @param [String] unique_name A human readable description of this resource, up to
-          #   64 characters.
-          # @param [String] default_ttl The default Time to Live for a Session, in seconds.
-          # @param [String] callback_url The URL Twilio will send callbacks to.
-          # @param [service.GeoMatchLevel] geo_match_level Whether to find proxy numbers in
-          #   the same areacode.
-          # @param [service.NumberSelectionBehavior] number_selection_behavior What behavior
-          #   to use when choosing a proxy number.
-          # @param [String] intercept_callback_url A URL for Twilio call before each
-          #   Interaction. An error status code will prevent the interaction from continuing.
-          # @param [String] out_of_session_callback_url A URL for Twilio call when a new
-          #   Interaction has no Session.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. This value must be 191 characters or fewer in length
+          #   and be unique. **This value should not have PII.**
+          # @param [String] default_ttl The default `ttl` value to set for Sessions created
+          #   in the Service. The TTL (time to live) is measured in seconds after the
+          #   Session's last create or last Interaction. The default value of `0` indicates an
+          #   unlimited Session length. You can override a Session's default TTL value by
+          #   setting its `ttl` value.
+          # @param [String] callback_url The URL we should call when the interaction status
+          #   changes.
+          # @param [service.GeoMatchLevel] geo_match_level Where a proxy number must be
+          #   located relative to the participant identifier. Can be: `country`, `area-code`,
+          #   or `extended-area-code`. The default value is `country` and more specific areas
+          #   than `country` are only available in North America.
+          # @param [service.NumberSelectionBehavior] number_selection_behavior The
+          #   preference for Proxy Number selection in the Service instance. Can be:
+          #   `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`.
+          #   `prefer-sticky` means that we will try and select the same Proxy Number for a
+          #   given participant if they have previous
+          #   [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail
+          #   if that Proxy Number cannot be used.  `avoid-sticky` means that we will try to
+          #   use different Proxy Numbers as long as that is possible within a given pool
+          #   rather than try and use a previously assigned number.
+          # @param [String] intercept_callback_url The URL we call on each interaction. If
+          #   we receive a 403 status, we block the interaction; otherwise the interaction
+          #   continues.
+          # @param [String] out_of_session_callback_url The URL we should call when an
+          #   inbound call or SMS action occurs on a closed or non-existent Session. If your
+          #   server (or a Twilio [function](https://www.twilio.com/functions)) responds with
+          #   valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This
+          #   means it is possible, for example, to play a message for a call, send an
+          #   automated text message response, or redirect a call to another Phone Number. See
+          #   [Out-of-Session Callback Response
+          #   Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide)
+          #   for more information.
+          # @param [String] chat_instance_sid The SID of the Chat Service Instance managed
+          #   by Proxy Service. The Chat Service enables Proxy to forward SMS and channel
+          #   messages to this chat instance. This is a one-to-one relationship.
           # @return [ServiceInstance] Updated ServiceInstance
-          def update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset)
+          def update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset)
             context.update(
                 unique_name: unique_name,
                 default_ttl: default_ttl,
@@ -480,6 +578,7 @@ module Twilio
                 number_selection_behavior: number_selection_behavior,
                 intercept_callback_url: intercept_callback_url,
                 out_of_session_callback_url: out_of_session_callback_url,
+                chat_instance_sid: chat_instance_sid,
             )
           end
 

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,7 +19,8 @@ module Twilio
         end
 
         ##
-        # @param [String] sid A 34 character string that uniquely identifies this Service.
+        # @param [String] sid The Twilio-provided string that uniquely identifies the
+        #   Service resource to fetch.
         # @return [Twilio::REST::Proxy::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Proxy::V1::ServiceList]
         def services(sid=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
       # @return [Twilio::REST::Proxy::V1::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Proxy::V1::ServiceList]
       def services(sid=:unset)