twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,7 +15,7 @@ module Twilio
             ##
             # Initialize the ExecutionList
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] flow_sid The SID of the Flow.
             # @return [ExecutionList] ExecutionList
             def initialize(version, flow_sid: nil)
               super(version)
@@ -29,10 +29,12 @@ module Twilio
             # Lists ExecutionInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] date_created_from Only show Executions that started on or after
-            #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-            # @param [Time] date_created_to Only show Executions that started before this this
-            #   ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @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
+            #   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
+            #   `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
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -53,10 +55,12 @@ module Twilio
             # Streams ExecutionInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] date_created_from Only show Executions that started on or after
-            #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-            # @param [Time] date_created_to Only show Executions that started before this this
-            #   ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @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
+            #   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
+            #   `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.
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -93,10 +97,12 @@ module Twilio
             ##
             # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] date_created_from Only show Executions that started on or after
-            #   this ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
-            # @param [Time] date_created_to Only show Executions that started before this this
-            #   ISO8601 date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.
+            # @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
+            #   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
+            #   `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
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -109,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
 
@@ -131,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}}.
+            #   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
+            #   from during the Flow's Execution. Available as variable
+            #   `{{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] Created ExecutionInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
                   'To' => to,
@@ -152,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
@@ -201,8 +200,9 @@ module Twilio
             ##
             # Initialize the ExecutionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The unique SID identifier of the Flow.
-            # @param [String] sid The unique SID identifier of the Execution.
+            # @param [String] flow_sid The SID of the Flow with the Execution resource to
+            #   fetch
+            # @param [String] sid The SID of the Execution resource to fetch.
             # @return [ExecutionContext] ExecutionContext
             def initialize(version, flow_sid, sid)
               super(version)
@@ -217,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
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # 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
 
             ##
@@ -274,6 +281,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Studio.V1.ExecutionContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V1.ExecutionContext #{context}>"
+            end
           end
 
           class ExecutionInstance < InstanceResource
@@ -281,8 +295,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 unique SID identifier of the Flow.
-            # @param [String] sid The unique SID identifier of the Execution.
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Execution resource to fetch.
             # @return [ExecutionInstance] ExecutionInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
@@ -319,85 +333,94 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Execution.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             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] Flow Sid.
+            # @return [String] The SID of the Flow
             def flow_sid
               @properties['flow_sid']
             end
 
             ##
-            # @return [String] Contact Sid.
+            # @return [String] The SID of the Contact
             def contact_sid
               @properties['contact_sid']
             end
 
             ##
-            # @return [String] The phone number, SIP address or Client identifier that triggered this Execution.
+            # @return [String] The phone number, SIP address or Client identifier that triggered the Execution
             def contact_channel_address
               @properties['contact_channel_address']
             end
 
             ##
-            # @return [Hash] The context
+            # @return [Hash] The current state of the flow
             def context
               @properties['context']
             end
 
             ##
-            # @return [execution.Status] The Status of this Execution
+            # @return [execution.Status] The status of the Execution
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date this Execution 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 Execution 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 resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] Nested resource URLs
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a ExecutionInstance
+            # Fetch the ExecutionInstance
             # @return [ExecutionInstance] Fetched ExecutionInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the ExecutionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # 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.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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
 
@@ -145,7 +143,7 @@ module Twilio
           ##
           # Initialize the FlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this Flow.
+          # @param [String] sid The SID of the Flow resource to fetch.
           # @return [FlowContext] FlowContext
           def initialize(version, sid)
             super(version)
@@ -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
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the FlowInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -223,6 +215,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Studio.V1.FlowContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Studio.V1.FlowContext #{context}>"
+          end
         end
 
         class FlowInstance < InstanceResource
@@ -230,7 +229,7 @@ module Twilio
           # Initialize the FlowInstance
           # @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 Flow.
+          # @param [String] sid The SID of the Flow resource to fetch.
           # @return [FlowInstance] FlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -241,7 +240,7 @@ module Twilio
                 'account_sid' => payload['account_sid'],
                 'friendly_name' => payload['friendly_name'],
                 'status' => payload['status'],
-                'version' => payload['version'].to_i,
+                'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                 'url' => payload['url'],
@@ -265,69 +264,69 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Flow.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           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] A human readable description of this resource.
+          # @return [String] The string that you assigned to describe the Flow
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [flow.Status] The Status of this Flow
+          # @return [flow.Status] The status of the Flow
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The latest version number of this Flow's definition.
+          # @return [String] The latest version number of the Flow's definition
           def version
             @properties['version']
           end
 
           ##
-          # @return [Time] The date this Flow 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 Flow 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 resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] Nested resource URLs.
+          # @return [String] Nested resource URLs
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the FlowInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -19,16 +19,17 @@ module Twilio
         end
 
         ##
-        # @param [String] sid A 34 character string that uniquely identifies this Flow.
+        # @param [String] sid The SID of the Flow resource to fetch.
         # @return [Twilio::REST::Studio::V1::FlowContext] if sid was passed.
         # @return [Twilio::REST::Studio::V1::FlowList]
         def flows(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @flows ||= FlowList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @flows ||= FlowList.new self
           else
-            FlowContext.new(self, sid)
+              FlowContext.new(self, sid)
           end
         end