twilio-ruby 5.31.1 → 5.54.0

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

@@ -84,11 +84,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             FlowPage.new(@version, response, @solution)
           end
 
@@ -160,25 +158,19 @@ module Twilio
           end
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             FlowInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the FlowInstance
+          # Delete the FlowInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -326,14 +318,14 @@ module Twilio
           end
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the FlowInstance
+          # Delete the FlowInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete

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

@@ -86,11 +86,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               EngagementPage.new(@version, response, @solution)
             end
 
@@ -108,8 +106,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of EngagementInstance records from the API.
-            # Request is executed immediately.
+            # Create the EngagementInstance
             # @param [String] to The Contact phone number to start a Studio Flow Engagement,
             #   available as variable `{{contact.channel.address}}`.
             # @param [String] from The Twilio phone number to send messages or initiate calls
@@ -122,7 +119,7 @@ module Twilio
             #   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 [EngagementInstance] Newly created EngagementInstance
+            # @return [EngagementInstance] Created EngagementInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
                   'To' => to,
@@ -130,11 +127,7 @@ module Twilio
                   'Parameters' => Twilio.serialize_object(parameters),
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
@@ -195,25 +188,19 @@ module Twilio
             end
 
             ##
-            # Fetch a EngagementInstance
+            # Fetch the EngagementInstance
             # @return [EngagementInstance] Fetched EngagementInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the EngagementInstance
+            # Delete the EngagementInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -366,14 +353,14 @@ module Twilio
             end
 
             ##
-            # Fetch a EngagementInstance
+            # Fetch the EngagementInstance
             # @return [EngagementInstance] Fetched EngagementInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the EngagementInstance
+            # Delete the EngagementInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -83,16 +83,10 @@ module Twilio
               end
 
               ##
-              # Fetch a EngagementContextInstance
+              # Fetch the EngagementContextInstance
               # @return [EngagementContextInstance] Fetched EngagementContextInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 EngagementContextInstance.new(
                     @version,
@@ -188,7 +182,7 @@ module Twilio
               end
 
               ##
-              # Fetch a EngagementContextInstance
+              # Fetch the EngagementContextInstance
               # @return [EngagementContextInstance] Fetched EngagementContextInstance
               def fetch
                 context.fetch

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

@@ -88,11 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 StepPage.new(@version, response, @solution)
               end
 
@@ -170,16 +168,10 @@ module Twilio
               end
 
               ##
-              # Fetch a StepInstance
+              # Fetch the StepInstance
               # @return [StepInstance] Fetched StepInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 StepInstance.new(
                     @version,
@@ -339,7 +331,7 @@ module Twilio
               end
 
               ##
-              # Fetch a StepInstance
+              # Fetch the StepInstance
               # @return [StepInstance] Fetched StepInstance
               def fetch
                 context.fetch

data/lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb

@@ -87,16 +87,10 @@ module Twilio
                 end
 
                 ##
-                # Fetch a StepContextInstance
+                # Fetch the StepContextInstance
                 # @return [StepContextInstance] Fetched StepContextInstance
                 def fetch
-                  params = Twilio::Values.of({})
-
-                  payload = @version.fetch(
-                      'GET',
-                      @uri,
-                      params,
-                  )
+                  payload = @version.fetch('GET', @uri)
 
                   StepContextInstance.new(
                       @version,
@@ -202,7 +196,7 @@ module Twilio
                 end
 
                 ##
-                # Fetch a StepContextInstance
+                # Fetch the StepContextInstance
                 # @return [StepContextInstance] Fetched StepContextInstance
                 def fetch
                   context.fetch

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

@@ -30,10 +30,10 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [Time] date_created_from Only show Execution resources starting on or
-            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given
             #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [Time] date_created_to Only show Execution resources starting before this
-            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as
             #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
@@ -56,10 +56,10 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [Time] date_created_from Only show Execution resources starting on or
-            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given
             #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [Time] date_created_to Only show Execution resources starting before this
-            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as
             #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
@@ -98,10 +98,10 @@ module Twilio
             # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
             # @param [Time] date_created_from Only show Execution resources starting on or
-            #   after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given
+            #   after this {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given
             #   as `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [Time] date_created_to Only show Execution resources starting before this
-            #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as
+            #   {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time, given as
             #   `YYYY-MM-DDThh:mm:ss-hh:mm`.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
@@ -115,11 +115,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ExecutionPage.new(@version, response, @solution)
             end
 
@@ -137,20 +135,19 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ExecutionInstance records from the API.
-            # Request is executed immediately.
+            # Create the ExecutionInstance
             # @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's Execution. Available as variable
-            #   `{{flow.channel.address}}`.
+            #   `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID.
             # @param [Hash] parameters JSON data that will be added to the Flow's context and
             #   that can be accessed as variables inside your Flow. For example, if you pass in
             #   `Parameters={"name":"Zeke"}`, a widget in your Flow can reference the variable
             #   `{{flow.data.name}}`, which returns "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 the JSON string.
-            # @return [ExecutionInstance] Newly created ExecutionInstance
+            # @return [ExecutionInstance] Created ExecutionInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
                   'To' => to,
@@ -158,11 +155,7 @@ module Twilio
                   'Parameters' => Twilio.serialize_object(parameters),
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
@@ -224,25 +217,32 @@ module Twilio
             end
 
             ##
-            # Fetch a ExecutionInstance
+            # Fetch the ExecutionInstance
             # @return [ExecutionInstance] Fetched ExecutionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the ExecutionInstance
+            # Delete the ExecutionInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
+            end
+
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              data = Twilio::Values.of({'Status' => status, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -399,19 +399,28 @@ module Twilio
             end
 
             ##
-            # Fetch a ExecutionInstance
+            # Fetch the ExecutionInstance
             # @return [ExecutionInstance] Fetched ExecutionInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the ExecutionInstance
+            # Delete the ExecutionInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
+            ##
+            # Update the ExecutionInstance
+            # @param [execution.Status] status The status of the Execution. Can only be
+            #   `ended`.
+            # @return [ExecutionInstance] Updated ExecutionInstance
+            def update(status: nil)
+              context.update(status: status, )
+            end
+
             ##
             # Access the steps
             # @return [steps] steps

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

@@ -84,16 +84,10 @@ module Twilio
               end
 
               ##
-              # Fetch a ExecutionContextInstance
+              # Fetch the ExecutionContextInstance
               # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 ExecutionContextInstance.new(
                     @version,
@@ -189,7 +183,7 @@ module Twilio
               end
 
               ##
-              # Fetch a ExecutionContextInstance
+              # Fetch the ExecutionContextInstance
               # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
               def fetch
                 context.fetch

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

@@ -88,11 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 ExecutionStepPage.new(@version, response, @solution)
               end
 
@@ -171,16 +169,10 @@ module Twilio
               end
 
               ##
-              # Fetch a ExecutionStepInstance
+              # Fetch the ExecutionStepInstance
               # @return [ExecutionStepInstance] Fetched ExecutionStepInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 ExecutionStepInstance.new(
                     @version,
@@ -345,7 +337,7 @@ module Twilio
               end
 
               ##
-              # Fetch a ExecutionStepInstance
+              # Fetch the ExecutionStepInstance
               # @return [ExecutionStepInstance] Fetched ExecutionStepInstance
               def fetch
                 context.fetch