twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,8 +16,8 @@ module Twilio
               ##
               # Initialize the EngagementContextList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
               # @return [EngagementContextList] EngagementContextList
               def initialize(version, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -71,8 +71,8 @@ module Twilio
               ##
               # Initialize the EngagementContextContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
               # @return [EngagementContextContext] EngagementContextContext
               def initialize(version, flow_sid, engagement_sid)
                 super(version)
@@ -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,
@@ -108,6 +102,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Studio.V1.EngagementContextContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V1.EngagementContextContext #{context}>"
+              end
             end
 
             class EngagementContextInstance < InstanceResource
@@ -115,8 +116,8 @@ module Twilio
               # Initialize the EngagementContextInstance
               # @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] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
               # @return [EngagementContextInstance] EngagementContextInstance
               def initialize(version, payload, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -151,37 +152,37 @@ module Twilio
               end
 
               ##
-              # @return [String] Account Sid.
+              # @return [String] Account SID
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Hash] Flow state.
+              # @return [Hash] Flow state
               def context
                 @properties['context']
               end
 
               ##
-              # @return [String] Engagement Sid.
+              # @return [String] Engagement SID
               def engagement_sid
                 @properties['engagement_sid']
               end
 
               ##
-              # @return [String] Flow Sid.
+              # @return [String] Flow SID
               def flow_sid
                 @properties['flow_sid']
               end
 
               ##
-              # @return [String] The URL of this resource.
+              # @return [String] The URL of the resource
               def url
                 @properties['url']
               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/step_context.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,10 +17,9 @@ module Twilio
                 ##
                 # Initialize the StepContextList
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The unique SID identifier of the Flow.
-                # @param [String] engagement_sid The unique SID identifier of the Engagement.
-                # @param [String] step_sid The unique SID identifier of the Step this context is
-                #   associated with.
+                # @param [String] flow_sid The SID of the Flow.
+                # @param [String] engagement_sid The SID of the Engagement.
+                # @param [String] step_sid The SID of the Step the context is associated with.
                 # @return [StepContextList] StepContextList
                 def initialize(version, flow_sid: nil, engagement_sid: nil, step_sid: nil)
                   super(version)
@@ -75,9 +74,9 @@ module Twilio
                 ##
                 # Initialize the StepContextContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The unique SID identifier of the Flow.
-                # @param [String] engagement_sid The unique SID identifier of the Engagement.
-                # @param [String] step_sid The unique SID identifier of the Step.
+                # @param [String] flow_sid The SID of the Flow with the Step to fetch.
+                # @param [String] engagement_sid The SID of the Engagement with the Step to fetch.
+                # @param [String] step_sid The SID of the Step to fetch
                 # @return [StepContextContext] StepContextContext
                 def initialize(version, flow_sid, engagement_sid, step_sid)
                   super(version)
@@ -88,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,
@@ -114,6 +107,13 @@ module Twilio
                   context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                   "#<Twilio.Studio.V1.StepContextContext #{context}>"
                 end
+
+                ##
+                # Provide a detailed, user friendly representation
+                def inspect
+                  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                  "#<Twilio.Studio.V1.StepContextContext #{context}>"
+                end
               end
 
               class StepContextInstance < InstanceResource
@@ -121,10 +121,9 @@ module Twilio
                 # Initialize the StepContextInstance
                 # @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] engagement_sid The unique SID identifier of the Engagement.
-                # @param [String] step_sid The unique SID identifier of the Step this context is
-                #   associated with.
+                # @param [String] flow_sid The SID of the Flow.
+                # @param [String] engagement_sid The SID of the Engagement.
+                # @param [String] step_sid The SID of the Step the context is associated with.
                 # @return [StepContextInstance] StepContextInstance
                 def initialize(version, payload, flow_sid: nil, engagement_sid: nil, step_sid: nil)
                   super(version)
@@ -161,43 +160,43 @@ module Twilio
                 end
 
                 ##
-                # @return [String] Account Sid.
+                # @return [String] The SID of the Account that created the resource
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [Hash] Flow state.
+                # @return [Hash] The current state of the flow
                 def context
                   @properties['context']
                 end
 
                 ##
-                # @return [String] Engagement Sid.
+                # @return [String] The SID of the Engagement
                 def engagement_sid
                   @properties['engagement_sid']
                 end
 
                 ##
-                # @return [String] Flow Sid.
+                # @return [String] The SID of the Flow
                 def flow_sid
                   @properties['flow_sid']
                 end
 
                 ##
-                # @return [String] Step Sid.
+                # @return [String] Step SID
                 def step_sid
                   @properties['step_sid']
                 end
 
                 ##
-                # @return [String] The URL of this resource.
+                # @return [String] The absolute URL of the resource
                 def url
                   @properties['url']
                 end
 
                 ##
-                # Fetch a StepContextInstance
+                # Fetch the StepContextInstance
                 # @return [StepContextInstance] Fetched StepContextInstance
                 def fetch
                   context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,8 +16,8 @@ module Twilio
               ##
               # Initialize the StepList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
               # @return [StepList] StepList
               def initialize(version, flow_sid: nil, engagement_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)
+
                 StepPage.new(@version, response, @solution)
               end
 
@@ -154,9 +152,9 @@ module Twilio
               ##
               # Initialize the StepContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
-              # @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] engagement_sid The SID of the Engagement with the Step to fetch.
+              # @param [String] sid The SID of the Step resource to fetch.
               # @return [StepContext] StepContext
               def initialize(version, flow_sid, engagement_sid, sid)
                 super(version)
@@ -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,
@@ -204,6 +196,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Studio.V1.StepContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V1.StepContext #{context}>"
+              end
             end
 
             class StepInstance < InstanceResource
@@ -211,9 +210,9 @@ module Twilio
               # Initialize the StepInstance
               # @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] engagement_sid The unique SID identifier of the Engagement.
-              # @param [String] sid The unique SID identifier of the Step.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
+              # @param [String] sid The SID of the Step resource to fetch.
               # @return [StepInstance] StepInstance
               def initialize(version, payload, flow_sid: nil, engagement_sid: nil, sid: nil)
                 super(version)
@@ -260,79 +259,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] Engagement Sid.
+              # @return [String] The SID of the Engagement
               def engagement_sid
                 @properties['engagement_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 StepInstance
+              # Fetch the StepInstance
               # @return [StepInstance] Fetched StepInstance
               def fetch
                 context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,7 +15,7 @@ module Twilio
             ##
             # Initialize the EngagementList
             # @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 [EngagementList] EngagementList
             def initialize(version, flow_sid: nil)
               super(version)
@@ -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,20 +106,20 @@ 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}}.
+            #   available as variable `{{contact.channel.address}}`.
             # @param [String] from The Twilio phone number to send messages or initiate calls
-            #   from during the Flow Engagement, 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
+            #   from during the Flow Engagement. Available as variable
+            #   `{{flow.channel.address}}`
+            # @param [Hash] parameters A JSON string we will add to your flow's context and
+            #   that you can access 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 [EngagementInstance] Newly created EngagementInstance
+            # @return [EngagementInstance] Created EngagementInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
                   'To' => to,
@@ -129,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
@@ -178,8 +172,8 @@ module Twilio
             ##
             # Initialize the EngagementContext
             # @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 Engagement.
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Engagement resource to fetch.
             # @return [EngagementContext] EngagementContext
             def initialize(version, flow_sid, sid)
               super(version)
@@ -194,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
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EngagementInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -247,6 +235,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Studio.V1.EngagementContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V1.EngagementContext #{context}>"
+            end
           end
 
           class EngagementInstance < InstanceResource
@@ -254,8 +249,8 @@ module Twilio
             # Initialize the EngagementInstance
             # @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 Engagement.
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Engagement resource to fetch.
             # @return [EngagementInstance] EngagementInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
@@ -292,81 +287,81 @@ module Twilio
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Engagement.
+            # @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 Engagement.
+            # @return [String] The phone number, SIP address or Client identifier that triggered this Engagement
             def contact_channel_address
               @properties['contact_channel_address']
             end
 
             ##
-            # @return [Hash] Flow state.
+            # @return [Hash] The current state of the execution flow
             def context
               @properties['context']
             end
 
             ##
-            # @return [engagement.Status] The Status of this Engagement
+            # @return [engagement.Status] The status of the Engagement
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date this Engagement was created
+            # @return [Time] The ISO 8601 date and time in GMT when the Engagement was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Engagement was updated
+            # @return [Time] The ISO 8601 date and time in GMT when the Engagement 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] The URLs of the Engagement's nested resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a EngagementInstance
+            # Fetch the EngagementInstance
             # @return [EngagementInstance] Fetched EngagementInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EngagementInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end