twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/{notify/v1/service/user/user_binding.rb → studio/v2/flow/execution/execution_step.rb}

@@ -3,71 +3,36 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Notify < Domain
-      class V1 < Version
-        class ServiceContext < InstanceContext
-          class UserContext < InstanceContext
+    class Studio < Domain
+      class V2 < Version
+        class FlowContext < InstanceContext
+          class ExecutionContext < InstanceContext
             ##
             # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class UserBindingList < ListResource
+            class ExecutionStepList < ListResource
               ##
-              # Initialize the UserBindingList
+              # Initialize the ExecutionStepList
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] identity The identity
-              # @return [UserBindingList] UserBindingList
-              def initialize(version, service_sid: nil, identity: nil)
+              # @param [String] flow_sid The flow_sid
+              # @param [String] execution_sid The execution_sid
+              # @return [ExecutionStepList] ExecutionStepList
+              def initialize(version, flow_sid: nil, execution_sid: nil)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, identity: identity}
-                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}/Bindings"
+                @solution = {flow_sid: flow_sid, execution_sid: execution_sid}
+                @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Steps"
               end
 
               ##
-              # Retrieve a single page of UserBindingInstance records from the API.
-              # Request is executed immediately.
-              # @param [user_binding.BindingType] binding_type The binding_type
-              # @param [String] address The address
-              # @param [String] tag The tag
-              # @param [String] notification_protocol_version The notification_protocol_version
-              # @param [String] credential_sid The credential_sid
-              # @param [String] endpoint The endpoint
-              # @return [UserBindingInstance] Newly created UserBindingInstance
-              def create(binding_type: nil, address: nil, tag: :unset, notification_protocol_version: :unset, credential_sid: :unset, endpoint: :unset)
-                data = Twilio::Values.of({
-                    'BindingType' => binding_type,
-                    'Address' => address,
-                    'Tag' => Twilio.serialize_list(tag) { |e| e },
-                    'NotificationProtocolVersion' => notification_protocol_version,
-                    'CredentialSid' => credential_sid,
-                    'Endpoint' => endpoint,
-                })
-
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
-
-                UserBindingInstance.new(
-                    @version,
-                    payload,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
-              ##
-              # Lists UserBindingInstance records from the API as a list.
+              # Lists ExecutionStepInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Date] start_date The start_date
-              # @param [Date] end_date The end_date
-              # @param [String] tag The tag
               # @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
@@ -75,23 +40,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 [Array] Array of up to limit results
-              def list(start_date: :unset, end_date: :unset, tag: :unset, limit: nil, page_size: nil)
-                self.stream(
-                    start_date: start_date,
-                    end_date: end_date,
-                    tag: tag,
-                    limit: limit,
-                    page_size: page_size
-                ).entries
+              def list(limit: nil, page_size: nil)
+                self.stream(limit: limit, page_size: page_size).entries
               end
 
               ##
-              # Streams UserBindingInstance records from the API as an Enumerable.
+              # Streams ExecutionStepInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Date] start_date The start_date
-              # @param [Date] end_date The end_date
-              # @param [String] tag The tag
               # @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
@@ -99,22 +55,22 @@ 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(start_date: :unset, end_date: :unset, tag: :unset, limit: nil, page_size: nil)
+              def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(start_date: start_date, end_date: end_date, tag: tag, page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
 
               ##
-              # When passed a block, yields UserBindingInstance records from the API.
+              # When passed a block, yields ExecutionStepInstance records from the API.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -122,20 +78,14 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of UserBindingInstance records from the API.
+              # Retrieve a single page of ExecutionStepInstance records from the API.
               # Request is executed immediately.
-              # @param [Date] start_date The start_date
-              # @param [Date] end_date The end_date
-              # @param [String] tag The tag
               # @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 UserBindingInstance
-              def page(start_date: :unset, end_date: :unset, tag: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              # @return [Page] Page of ExecutionStepInstance
+              def page(page_token: :unset, page_number: :unset, page_size: :unset)
                 params = Twilio::Values.of({
-                    'StartDate' => Twilio.serialize_iso8601_date(start_date),
-                    'EndDate' => Twilio.serialize_iso8601_date(end_date),
-                    'Tag' => Twilio.serialize_list(tag) { |e| e },
                     'PageToken' => page_token,
                     'Page' => page_number,
                     'PageSize' => page_size,
@@ -145,38 +95,38 @@ module Twilio
                     @uri,
                     params
                 )
-                UserBindingPage.new(@version, response, @solution)
+                ExecutionStepPage.new(@version, response, @solution)
               end
 
               ##
-              # Retrieve a single page of UserBindingInstance records from the API.
+              # Retrieve a single page of ExecutionStepInstance records from the API.
               # Request is executed immediately.
               # @param [String] target_url API-generated URL for the requested results page
-              # @return [Page] Page of UserBindingInstance
+              # @return [Page] Page of ExecutionStepInstance
               def get_page(target_url)
                 response = @version.domain.request(
                     'GET',
                     target_url
                 )
-                UserBindingPage.new(@version, response, @solution)
+                ExecutionStepPage.new(@version, response, @solution)
               end
 
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Notify.V1.UserBindingList>'
+                '#<Twilio.Studio.V2.ExecutionStepList>'
               end
             end
 
             ##
             # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class UserBindingPage < Page
+            class ExecutionStepPage < Page
               ##
-              # Initialize the UserBindingPage
+              # Initialize the ExecutionStepPage
               # @param [Version] version Version that contains the resource
               # @param [Response] response Response from the API
               # @param [Hash] solution Path solution for the resource
-              # @return [UserBindingPage] UserBindingPage
+              # @return [ExecutionStepPage] ExecutionStepPage
               def initialize(version, response, solution)
                 super(version, response)
 
@@ -185,46 +135,49 @@ module Twilio
               end
 
               ##
-              # Build an instance of UserBindingInstance
+              # Build an instance of ExecutionStepInstance
               # @param [Hash] payload Payload response from the API
-              # @return [UserBindingInstance] UserBindingInstance
+              # @return [ExecutionStepInstance] ExecutionStepInstance
               def get_instance(payload)
-                UserBindingInstance.new(
+                ExecutionStepInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
+                    flow_sid: @solution[:flow_sid],
+                    execution_sid: @solution[:execution_sid],
                 )
               end
 
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Notify.V1.UserBindingPage>'
+                '<Twilio.Studio.V2.ExecutionStepPage>'
               end
             end
 
             ##
             # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class UserBindingContext < InstanceContext
+            class ExecutionStepContext < InstanceContext
               ##
-              # Initialize the UserBindingContext
+              # Initialize the ExecutionStepContext
               # @param [Version] version Version that contains the resource
-              # @param [String] service_sid The service_sid
-              # @param [String] identity The identity
+              # @param [String] flow_sid The flow_sid
+              # @param [String] execution_sid The execution_sid
               # @param [String] sid The sid
-              # @return [UserBindingContext] UserBindingContext
-              def initialize(version, service_sid, identity, sid)
+              # @return [ExecutionStepContext] ExecutionStepContext
+              def initialize(version, flow_sid, execution_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {service_sid: service_sid, identity: identity, sid: sid}
-                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}/Bindings/#{@solution[:sid]}"
+                @solution = {flow_sid: flow_sid, execution_sid: execution_sid, sid: sid, }
+                @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Steps/#{@solution[:sid]}"
+
+                # Dependents
+                @step_context = nil
               end
 
               ##
-              # Fetch a UserBindingInstance
-              # @return [UserBindingInstance] Fetched UserBindingInstance
+              # Fetch a ExecutionStepInstance
+              # @return [ExecutionStepInstance] Fetched ExecutionStepInstance
               def fetch
                 params = Twilio::Values.of({})
 
@@ -234,77 +187,92 @@ module Twilio
                     params,
                 )
 
-                UserBindingInstance.new(
+                ExecutionStepInstance.new(
                     @version,
                     payload,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
+                    flow_sid: @solution[:flow_sid],
+                    execution_sid: @solution[:execution_sid],
                     sid: @solution[:sid],
                 )
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                @version.delete('delete', @uri)
+              # Access the step_context
+              # @return [ExecutionStepContextList]
+              # @return [ExecutionStepContextContext]
+              def step_context
+                ExecutionStepContextContext.new(
+                    @version,
+                    @solution[:flow_sid],
+                    @solution[:execution_sid],
+                    @solution[:sid],
+                )
               end
 
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Notify.V1.UserBindingContext #{context}>"
+                "#<Twilio.Studio.V2.ExecutionStepContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V2.ExecutionStepContext #{context}>"
               end
             end
 
             ##
             # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-            class UserBindingInstance < InstanceResource
+            class ExecutionStepInstance < InstanceResource
               ##
-              # Initialize the UserBindingInstance
+              # Initialize the ExecutionStepInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] service_sid The service_sid
-              # @param [String] identity The identity
+              # @param [String] flow_sid The flow_sid
+              # @param [String] execution_sid The execution_sid
               # @param [String] sid The sid
-              # @return [UserBindingInstance] UserBindingInstance
-              def initialize(version, payload, service_sid: nil, identity: nil, sid: nil)
+              # @return [ExecutionStepInstance] ExecutionStepInstance
+              def initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil)
                 super(version)
 
                 # Marshaled Properties
                 @properties = {
                     'sid' => payload['sid'],
                     'account_sid' => payload['account_sid'],
-                    'service_sid' => payload['service_sid'],
-                    'credential_sid' => payload['credential_sid'],
+                    'flow_sid' => payload['flow_sid'],
+                    'execution_sid' => payload['execution_sid'],
+                    'name' => payload['name'],
+                    'context' => payload['context'],
+                    'transitioned_from' => payload['transitioned_from'],
+                    'transitioned_to' => payload['transitioned_to'],
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                    'notification_protocol_version' => payload['notification_protocol_version'],
-                    'endpoint' => payload['endpoint'],
-                    'identity' => payload['identity'],
-                    'binding_type' => payload['binding_type'],
-                    'address' => payload['address'],
-                    'tags' => payload['tags'],
                     'url' => payload['url'],
                     'links' => payload['links'],
                 }
 
                 # Context
                 @instance_context = nil
-                @params = {'service_sid' => service_sid, 'identity' => identity, 'sid' => sid || @properties['sid']}
+                @params = {
+                    'flow_sid' => flow_sid,
+                    'execution_sid' => execution_sid,
+                    'sid' => sid || @properties['sid'],
+                }
               end
 
               ##
               # Generate an instance context for the instance, the context is capable of
               # performing various actions.  All instance actions are proxied to the context
-              # @return [UserBindingContext] UserBindingContext for this UserBindingInstance
+              # @return [ExecutionStepContext] ExecutionStepContext for this ExecutionStepInstance
               def context
                 unless @instance_context
-                  @instance_context = UserBindingContext.new(
+                  @instance_context = ExecutionStepContext.new(
                       @version,
-                      @params['service_sid'],
-                      @params['identity'],
+                      @params['flow_sid'],
+                      @params['execution_sid'],
                       @params['sid'],
                   )
                 end
@@ -324,63 +292,51 @@ module Twilio
               end
 
               ##
-              # @return [String] The service_sid
-              def service_sid
-                @properties['service_sid']
-              end
-
-              ##
-              # @return [String] The credential_sid
-              def credential_sid
-                @properties['credential_sid']
-              end
-
-              ##
-              # @return [Time] The date_created
-              def date_created
-                @properties['date_created']
+              # @return [String] The flow_sid
+              def flow_sid
+                @properties['flow_sid']
               end
 
               ##
-              # @return [Time] The date_updated
-              def date_updated
-                @properties['date_updated']
+              # @return [String] The execution_sid
+              def execution_sid
+                @properties['execution_sid']
               end
 
               ##
-              # @return [String] The notification_protocol_version
-              def notification_protocol_version
-                @properties['notification_protocol_version']
+              # @return [String] The name
+              def name
+                @properties['name']
               end
 
               ##
-              # @return [String] The endpoint
-              def endpoint
-                @properties['endpoint']
+              # @return [Hash] The context
+              def context
+                @properties['context']
               end
 
               ##
-              # @return [String] The identity
-              def identity
-                @properties['identity']
+              # @return [String] The transitioned_from
+              def transitioned_from
+                @properties['transitioned_from']
               end
 
               ##
-              # @return [String] The binding_type
-              def binding_type
-                @properties['binding_type']
+              # @return [String] The transitioned_to
+              def transitioned_to
+                @properties['transitioned_to']
               end
 
               ##
-              # @return [String] The address
-              def address
-                @properties['address']
+              # @return [Time] The date_created
+              def date_created
+                @properties['date_created']
               end
 
               ##
-              # @return [String] The tags
-              def tags
-                @properties['tags']
+              # @return [Time] The date_updated
+              def date_updated
+                @properties['date_updated']
               end
 
               ##
@@ -396,31 +352,31 @@ module Twilio
               end
 
               ##
-              # Fetch a UserBindingInstance
-              # @return [UserBindingInstance] Fetched UserBindingInstance
+              # Fetch a ExecutionStepInstance
+              # @return [ExecutionStepInstance] Fetched ExecutionStepInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the UserBindingInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
-              def delete
-                context.delete
+              # Access the step_context
+              # @return [step_context] step_context
+              def step_context
+                context.step_context
               end
 
               ##
               # Provide a user friendly representation
               def to_s
                 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Notify.V1.UserBindingInstance #{values}>"
+                "<Twilio.Studio.V2.ExecutionStepInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Notify.V1.UserBindingInstance #{values}>"
+                "<Twilio.Studio.V2.ExecutionStepInstance #{values}>"
               end
             end
           end