twilio-ruby 5.11.1 → 5.11.2

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

@@ -36,9 +36,11 @@ module Twilio
             # @param [String] phone_number A string that represents the Twilio Number you
             #   would like to assign to your Proxy Service. Provide number in
             #   [E.164](https://en.wikipedia.org/wiki/E.164) format (e.g. `+16175551212`).
+            # @param [Boolean] is_reserved Whether or not the number should be excluded from
+            #   being assigned to a participant using proxy pool logic
             # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
-            def create(sid: :unset, phone_number: :unset)
-              data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, })
+            def create(sid: :unset, phone_number: :unset, is_reserved: :unset)
+              data = Twilio::Values.of({'Sid' => sid, 'PhoneNumber' => phone_number, 'IsReserved' => is_reserved, })
 
               payload = @version.create(
                   'POST',
@@ -215,6 +217,28 @@ module Twilio
               )
             end
 
+            ##
+            # Update the PhoneNumberInstance
+            # @param [Boolean] is_reserved Whether or not the number should be excluded from
+            #   being assigned to a participant using proxy pool logic
+            # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+            def update(is_reserved: :unset)
+              data = Twilio::Values.of({'IsReserved' => is_reserved, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -250,6 +274,7 @@ module Twilio
                   'iso_country' => payload['iso_country'],
                   'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
+                  'is_reserved' => payload['is_reserved'],
               }
 
               # Context
@@ -328,6 +353,12 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [Boolean] Reserve for manual assignment to participants only.
+            def is_reserved
+              @properties['is_reserved']
+            end
+
             ##
             # Deletes the PhoneNumberInstance
             # @return [Boolean] true if delete succeeds, true otherwise
@@ -342,6 +373,15 @@ module Twilio
               context.fetch
             end
 
+            ##
+            # Update the PhoneNumberInstance
+            # @param [Boolean] is_reserved Whether or not the number should be excluded from
+            #   being assigned to a participant using proxy pool logic
+            # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+            def update(is_reserved: :unset)
+              context.update(is_reserved: is_reserved, )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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

@@ -205,6 +205,23 @@ module Twilio
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
 
+            ##
+            # Update the ShortCodeInstance
+            # @param [Boolean] is_reserved Whether or not the short code should be excluded
+            #   from being assigned to a participant using proxy pool logic
+            # @return [ShortCodeInstance] Updated ShortCodeInstance
+            def update(is_reserved: :unset)
+              data = Twilio::Values.of({'IsReserved' => is_reserved, })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -238,6 +255,7 @@ module Twilio
                   'iso_country' => payload['iso_country'],
                   'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
+                  'is_reserved' => payload['is_reserved'],
               }
 
               # Context
@@ -310,6 +328,12 @@ module Twilio
               @properties['url']
             end
 
+            ##
+            # @return [Boolean] Reserve for manual assignment to participants only.
+            def is_reserved
+              @properties['is_reserved']
+            end
+
             ##
             # Deletes the ShortCodeInstance
             # @return [Boolean] true if delete succeeds, true otherwise
@@ -324,6 +348,15 @@ module Twilio
               context.fetch
             end
 
+            ##
+            # Update the ShortCodeInstance
+            # @param [Boolean] is_reserved Whether or not the short code should be excluded
+            #   from being assigned to a participant using proxy pool logic
+            # @return [ShortCodeInstance] Updated ShortCodeInstance
+            def update(is_reserved: :unset)
+              context.update(is_reserved: is_reserved, )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/studio/v1/flow/execution.rb

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the ExecutionList
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
             # @return [ExecutionList] ExecutionList
             def initialize(version, flow_sid: nil)
               super(version)
@@ -112,9 +112,17 @@ module Twilio
             ##
             # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to The to
-            # @param [String] from The from
-            # @param [Hash] parameters The parameters
+            # @param [String] to The Contact phone number to start a Studio Flow Execution,
+            #   available as variable {{contact.channel.address}}.
+            # @param [String] from The Twilio phone number to send messages or initiate calls
+            #   from during the Flow Execution, available as variable {{flow.channel.address}}
+            # @param [Hash] parameters JSON data that will be added to your flow's context and
+            #   can accessed as variables inside your flow. For example, if you pass in
+            #   Parameters={'name':'Zeke'} then inside a widget you can reference the variable
+            #   {{flow.data.name}} which will return the string 'Zeke'. Note: the JSON value
+            #   must explicitly be passed as a string, not as a hash object. Depending on your
+            #   particular HTTP library, you may need to add quotes or URL encode your JSON
+            #   string.
             # @return [ExecutionInstance] Newly created ExecutionInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
@@ -176,8 +184,8 @@ module Twilio
             ##
             # Initialize the ExecutionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] sid The unique SID identifier of the Execution.
             # @return [ExecutionContext] ExecutionContext
             def initialize(version, flow_sid, sid)
               super(version)
@@ -258,8 +266,8 @@ module Twilio
             # Initialize the ExecutionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] sid The unique SID identifier of the Execution.
             # @return [ExecutionInstance] ExecutionInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
@@ -296,67 +304,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A string that uniquely identifies this Execution.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] Account Sid.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The flow_sid
+            # @return [String] Flow Sid.
             def flow_sid
               @properties['flow_sid']
             end
 
             ##
-            # @return [String] The contact_sid
+            # @return [String] Contact Sid.
             def contact_sid
               @properties['contact_sid']
             end
 
             ##
-            # @return [String] The contact_channel_address
+            # @return [String] The phone number, SIP address or Client identifier that triggered this Execution.
             def contact_channel_address
               @properties['contact_channel_address']
             end
 
             ##
-            # @return [Hash] The context
+            # @return [Hash] Flow state.
             def context
               @properties['context']
             end
 
             ##
-            # @return [execution.Status] The status
+            # @return [execution.Status] The Status of this Execution
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this Execution was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this Execution was updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The URL of this resource.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Nested resource URLs.
             def links
               @properties['links']
             end

data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the ExecutionContextList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
               # @return [ExecutionContextList] ExecutionContextList
               def initialize(version, flow_sid: nil, execution_sid: nil)
                 super(version)
@@ -77,8 +77,8 @@ module Twilio
               ##
               # Initialize the ExecutionContextContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
               # @return [ExecutionContextContext] ExecutionContextContext
               def initialize(version, flow_sid, execution_sid)
                 super(version)
@@ -123,8 +123,8 @@ module Twilio
               # Initialize the ExecutionContextInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
               # @return [ExecutionContextInstance] ExecutionContextInstance
               def initialize(version, payload, flow_sid: nil, execution_sid: nil)
                 super(version)
@@ -159,31 +159,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] Account Sid.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Hash] The context
+              # @return [Hash] Flow state.
               def context
                 @properties['context']
               end
 
               ##
-              # @return [String] The flow_sid
+              # @return [String] Flow Sid.
               def flow_sid
                 @properties['flow_sid']
               end
 
               ##
-              # @return [String] The execution_sid
+              # @return [String] Execution Sid.
               def execution_sid
                 @properties['execution_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The URL of this resource.
               def url
                 @properties['url']
               end

data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the ExecutionStepList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
               # @return [ExecutionStepList] ExecutionStepList
               def initialize(version, flow_sid: nil, execution_sid: nil)
                 super(version)
@@ -160,9 +160,9 @@ module Twilio
               ##
               # Initialize the ExecutionStepContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
-              # @param [String] sid The sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
+              # @param [String] sid The unique SID identifier of the Step.
               # @return [ExecutionStepContext] ExecutionStepContext
               def initialize(version, flow_sid, execution_sid, sid)
                 super(version)
@@ -224,9 +224,9 @@ module Twilio
               # Initialize the ExecutionStepInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] flow_sid The flow_sid
-              # @param [String] execution_sid The execution_sid
-              # @param [String] sid The sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] execution_sid The unique SID identifier of the Execution.
+              # @param [String] sid The unique SID identifier of the Step.
               # @return [ExecutionStepInstance] ExecutionStepInstance
               def initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil)
                 super(version)
@@ -273,31 +273,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this Step.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] Account Sid.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The flow_sid
+              # @return [String] Flow Sid.
               def flow_sid
                 @properties['flow_sid']
               end
 
               ##
-              # @return [String] The execution_sid
+              # @return [String] Execution Sid.
               def execution_sid
                 @properties['execution_sid']
               end
 
               ##
-              # @return [String] The name
+              # @return [String] The event that caused the flow to transition to this Step.
               def name
                 @properties['name']
               end
@@ -309,31 +309,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The transitioned_from
+              # @return [String] The Widget that preceded the Widget for this Step.
               def transitioned_from
                 @properties['transitioned_from']
               end
 
               ##
-              # @return [String] The transitioned_to
+              # @return [String] The Widget that will follow the Widget for this Step.
               def transitioned_to
                 @properties['transitioned_to']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this Step was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this Step was updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The URL of this resource.
               def url
                 @properties['url']
               end

data/lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb

@@ -19,9 +19,10 @@ module Twilio
                 ##
                 # Initialize the ExecutionStepContextList
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The flow_sid
-                # @param [String] execution_sid The execution_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] execution_sid The unique SID identifier of the Execution.
+                # @param [String] step_sid The unique SID identifier of the Step this context is
+                #   associated with.
                 # @return [ExecutionStepContextList] ExecutionStepContextList
                 def initialize(version, flow_sid: nil, execution_sid: nil, step_sid: nil)
                   super(version)
@@ -80,9 +81,9 @@ module Twilio
                 ##
                 # Initialize the ExecutionStepContextContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The flow_sid
-                # @param [String] execution_sid The execution_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] execution_sid The unique SID identifier of the Execution.
+                # @param [String] step_sid The unique SID identifier of the Step.
                 # @return [ExecutionStepContextContext] ExecutionStepContextContext
                 def initialize(version, flow_sid, execution_sid, step_sid)
                   super(version)
@@ -128,9 +129,10 @@ module Twilio
                 # Initialize the ExecutionStepContextInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] flow_sid The flow_sid
-                # @param [String] execution_sid The execution_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] execution_sid The unique SID identifier of the Execution.
+                # @param [String] step_sid The unique SID identifier of the Step this context is
+                #   associated with.
                 # @return [ExecutionStepContextInstance] ExecutionStepContextInstance
                 def initialize(version, payload, flow_sid: nil, execution_sid: nil, step_sid: nil)
                   super(version)
@@ -167,37 +169,37 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] Account Sid.
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [Hash] The context
+                # @return [Hash] Flow state.
                 def context
                   @properties['context']
                 end
 
                 ##
-                # @return [String] The execution_sid
+                # @return [String] Execution Sid.
                 def execution_sid
                   @properties['execution_sid']
                 end
 
                 ##
-                # @return [String] The flow_sid
+                # @return [String] Flow Sid.
                 def flow_sid
                   @properties['flow_sid']
                 end
 
                 ##
-                # @return [String] The step_sid
+                # @return [String] Step Sid.
                 def step_sid
                   @properties['step_sid']
                 end
 
                 ##
-                # @return [String] The url
+                # @return [String] The URL of this resource.
                 def url
                   @properties['url']
                 end