twilio-ruby 5.15.1 → 5.58.1

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,8 +16,8 @@ module Twilio
               ##
               # Initialize the ExecutionStepList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] execution_sid The unique SID identifier of the Execution.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] execution_sid The SID of the Step's Execution resource.
               # @return [ExecutionStepList] ExecutionStepList
               def initialize(version, flow_sid: nil, execution_sid: nil)
                 super(version)
@@ -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
 
@@ -154,9 +152,10 @@ module Twilio
               ##
               # Initialize the ExecutionStepContext
               # @param [Version] version Version that contains the resource
-              # @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.
+              # @param [String] flow_sid The SID of the Flow with the Step to fetch.
+              # @param [String] execution_sid The SID of the Execution resource with the Step to
+              #   fetch.
+              # @param [String] sid The SID of the ExecutionStep resource to fetch.
               # @return [ExecutionStepContext] ExecutionStepContext
               def initialize(version, flow_sid, execution_sid, sid)
                 super(version)
@@ -170,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,
@@ -209,6 +202,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Studio.V1.ExecutionStepContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V1.ExecutionStepContext #{context}>"
+              end
             end
 
             class ExecutionStepInstance < InstanceResource
@@ -216,9 +216,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 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.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] execution_sid The SID of the Step's Execution resource.
+              # @param [String] sid The SID of the ExecutionStep resource to fetch.
               # @return [ExecutionStepInstance] ExecutionStepInstance
               def initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil)
                 super(version)
@@ -265,79 +265,79 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Step.
+              # @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] Execution Sid.
+              # @return [String] The SID of the Execution
               def execution_sid
                 @properties['execution_sid']
               end
 
               ##
-              # @return [String] The event that caused the flow to transition to this Step.
+              # @return [String] The event that caused the Flow to transition to the Step
               def name
                 @properties['name']
               end
 
               ##
-              # @return [Hash] The context
+              # @return [Hash] The current state of the flow
               def context
                 @properties['context']
               end
 
               ##
-              # @return [String] The Widget that preceded the Widget for this Step.
+              # @return [String] The Widget that preceded the Widget for the Step
               def transitioned_from
                 @properties['transitioned_from']
               end
 
               ##
-              # @return [String] The Widget that will follow the Widget for this Step.
+              # @return [String] The Widget that will follow the Widget for the Step
               def transitioned_to
                 @properties['transitioned_to']
               end
 
               ##
-              # @return [Time] The date this Step 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 Step 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] The links
+              # @return [String] The URLs of related resources
               def links
                 @properties['links']
               end
 
               ##
-              # Fetch a ExecutionStepInstance
+              # Fetch the ExecutionStepInstance
               # @return [ExecutionStepInstance] Fetched ExecutionStepInstance
               def fetch
                 context.fetch

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,6 +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 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
@@ -36,14 +42,25 @@ module Twilio
             #    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
+            def list(date_created_from: :unset, date_created_to: :unset, limit: nil, page_size: nil)
+              self.stream(
+                  date_created_from: date_created_from,
+                  date_created_to: date_created_to,
+                  limit: limit,
+                  page_size: page_size
+              ).entries
             end
 
             ##
             # 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 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
@@ -51,10 +68,14 @@ module Twilio
             #    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)
+            def stream(date_created_from: :unset, date_created_to: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size], )
+              page = self.page(
+                  date_created_from: date_created_from,
+                  date_created_to: date_created_to,
+                  page_size: limits[:page_size],
+              )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -76,21 +97,27 @@ 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
+            #   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
             # @return [Page] Page of ExecutionInstance
-            def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(date_created_from: :unset, date_created_to: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
+                  'DateCreatedFrom' => Twilio.serialize_iso8601_datetime(date_created_from),
+                  'DateCreatedTo' => Twilio.serialize_iso8601_datetime(date_created_to),
                   'PageToken' => page_token,
                   '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
 
@@ -108,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,
@@ -129,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
@@ -178,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)
@@ -194,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
 
             ##
@@ -251,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
@@ -258,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)
@@ -296,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