twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,55 +3,36 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Notify < Domain
-      class V1 < Version
-        class ServiceContext < InstanceContext
+    class Studio < Domain
+      class V2 < Version
+        class FlowContext < InstanceContext
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserList < ListResource
+          class ExecutionList < ListResource
             ##
-            # Initialize the UserList
+            # Initialize the ExecutionList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @return [UserList] UserList
-            def initialize(version, service_sid: nil)
+            # @param [String] flow_sid The flow_sid
+            # @return [ExecutionList] ExecutionList
+            def initialize(version, flow_sid: nil)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/Users"
+              @solution = {flow_sid: flow_sid}
+              @uri = "/Flows/#{@solution[:flow_sid]}/Executions"
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
-            # @return [UserInstance] Newly created UserInstance
-            def create(identity: nil, segment: :unset)
-              data = Twilio::Values.of({
-                  'Identity' => identity,
-                  'Segment' => Twilio.serialize_list(segment) { |e| e },
-              })
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
-
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
-            end
-
-            ##
-            # Lists UserInstance records from the API as a list.
+            # 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 [String] identity The identity
-            # @param [String] segment The segment
+            # @param [Time] date_created_from The date_created_from
+            # @param [Time] date_created_to The date_created_to
             # @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
@@ -59,16 +40,21 @@ 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(identity: :unset, segment: :unset, limit: nil, page_size: nil)
-              self.stream(identity: identity, segment: segment, 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 UserInstance records from the API as an Enumerable.
+            # Streams ExecutionInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
+            # @param [Time] date_created_from The date_created_from
+            # @param [Time] date_created_to The date_created_to
             # @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
@@ -76,22 +62,26 @@ 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(identity: :unset, segment: :unset, 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(identity: identity, segment: segment, 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
 
             ##
-            # When passed a block, yields UserInstance records from the API.
+            # When passed a block, yields ExecutionInstance 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],
@@ -99,18 +89,18 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
+            # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
-            # @param [String] identity The identity
-            # @param [String] segment The segment
+            # @param [Time] date_created_from The date_created_from
+            # @param [Time] date_created_to The date_created_to
             # @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 UserInstance
-            def page(identity: :unset, segment: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            # @return [Page] Page of ExecutionInstance
+            def page(date_created_from: :unset, date_created_to: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
-                  'Identity' => Twilio.serialize_list(identity) { |e| e },
-                  'Segment' => segment,
+                  '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,
@@ -120,38 +110,61 @@ module Twilio
                   @uri,
                   params
               )
-              UserPage.new(@version, response, @solution)
+              ExecutionPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of UserInstance records from the API.
+            # Retrieve a single page of ExecutionInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of UserInstance
+            # @return [Page] Page of ExecutionInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              UserPage.new(@version, response, @solution)
+              ExecutionPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of ExecutionInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] to The to
+            # @param [String] from The from
+            # @param [Hash] parameters The parameters
+            # @return [ExecutionInstance] Newly created ExecutionInstance
+            def create(to: nil, from: nil, parameters: :unset)
+              data = Twilio::Values.of({
+                  'To' => to,
+                  'From' => from,
+                  'Parameters' => Twilio.serialize_object(parameters),
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Notify.V1.UserList>'
+              '#<Twilio.Studio.V2.ExecutionList>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserPage < Page
+          class ExecutionPage < Page
             ##
-            # Initialize the UserPage
+            # Initialize the ExecutionPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [UserPage] UserPage
+            # @return [ExecutionPage] ExecutionPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -160,51 +173,44 @@ module Twilio
             end
 
             ##
-            # Build an instance of UserInstance
+            # Build an instance of ExecutionInstance
             # @param [Hash] payload Payload response from the API
-            # @return [UserInstance] UserInstance
+            # @return [ExecutionInstance] ExecutionInstance
             def get_instance(payload)
-              UserInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Notify.V1.UserPage>'
+              '<Twilio.Studio.V2.ExecutionPage>'
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserContext < InstanceContext
+          class ExecutionContext < InstanceContext
             ##
-            # Initialize the UserContext
+            # Initialize the ExecutionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] identity The identity
-            # @return [UserContext] UserContext
-            def initialize(version, service_sid, identity)
+            # @param [String] flow_sid The flow_sid
+            # @param [String] sid The sid
+            # @return [ExecutionContext] ExecutionContext
+            def initialize(version, flow_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, identity: identity}
-              @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:identity]}"
+              @solution = {flow_sid: flow_sid, sid: sid, }
+              @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:sid]}"
 
               # Dependents
-              @bindings = nil
-              @segment_memberships = nil
+              @steps = nil
+              @execution_context = nil
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
-            end
-
-            ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
+            # Fetch a ExecutionInstance
+            # @return [ExecutionInstance] Fetched ExecutionInstance
             def fetch
               params = Twilio::Values.of({})
 
@@ -214,104 +220,100 @@ module Twilio
                   params,
               )
 
-              UserInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-                  identity: @solution[:identity],
-              )
+              ExecutionInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Access the bindings
-            # @return [UserBindingList]
-            # @return [UserBindingContext] if sid was passed.
-            def bindings(sid=:unset)
+            # Deletes the ExecutionInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
+            ##
+            # Access the steps
+            # @return [ExecutionStepList]
+            # @return [ExecutionStepContext] if sid was passed.
+            def steps(sid=:unset)
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return UserBindingContext.new(@version, @solution[:service_sid], @solution[:identity], sid)
+                return ExecutionStepContext.new(@version, @solution[:flow_sid], @solution[:sid], sid, )
               end
 
-              unless @bindings
-                @bindings = UserBindingList.new(
+              unless @steps
+                @steps = ExecutionStepList.new(
                     @version,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
+                    flow_sid: @solution[:flow_sid],
+                    execution_sid: @solution[:sid],
                 )
               end
 
-              @bindings
+              @steps
             end
 
             ##
-            # Access the segment_memberships
-            # @return [SegmentMembershipList]
-            # @return [SegmentMembershipContext] if segment was passed.
-            def segment_memberships(segment=:unset)
-              raise ArgumentError, 'segment cannot be nil' if segment.nil?
-
-              if segment != :unset
-                return SegmentMembershipContext.new(@version, @solution[:service_sid], @solution[:identity], segment)
-              end
-
-              unless @segment_memberships
-                @segment_memberships = SegmentMembershipList.new(
-                    @version,
-                    service_sid: @solution[:service_sid],
-                    identity: @solution[:identity],
-                )
-              end
-
-              @segment_memberships
+            # Access the execution_context
+            # @return [ExecutionContextList]
+            # @return [ExecutionContextContext]
+            def execution_context
+              ExecutionContextContext.new(@version, @solution[:flow_sid], @solution[:sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Notify.V1.UserContext #{context}>"
+              "#<Twilio.Studio.V2.ExecutionContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V2.ExecutionContext #{context}>"
             end
           end
 
           ##
           # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-          class UserInstance < InstanceResource
+          class ExecutionInstance < InstanceResource
             ##
-            # Initialize the UserInstance
+            # Initialize the ExecutionInstance
             # @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
-            # @return [UserInstance] UserInstance
-            def initialize(version, payload, service_sid: nil, identity: nil)
+            # @param [String] flow_sid The flow_sid
+            # @param [String] sid The sid
+            # @return [ExecutionInstance] ExecutionInstance
+            def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
-                  'identity' => payload['identity'],
+                  'flow_sid' => payload['flow_sid'],
+                  'contact_channel_address' => payload['contact_channel_address'],
+                  'context' => payload['context'],
+                  'status' => payload['status'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'segments' => payload['segments'],
                   'url' => payload['url'],
                   'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'identity' => identity || @properties['identity']}
+              @params = {'flow_sid' => flow_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 [UserContext] UserContext for this UserInstance
+            # @return [ExecutionContext] ExecutionContext for this ExecutionInstance
             def context
               unless @instance_context
-                @instance_context = UserContext.new(@version, @params['service_sid'], @params['identity'])
+                @instance_context = ExecutionContext.new(@version, @params['flow_sid'], @params['sid'], )
               end
               @instance_context
             end
@@ -329,15 +331,27 @@ module Twilio
             end
 
             ##
-            # @return [String] The service_sid
-            def service_sid
-              @properties['service_sid']
+            # @return [String] The flow_sid
+            def flow_sid
+              @properties['flow_sid']
+            end
+
+            ##
+            # @return [String] The contact_channel_address
+            def contact_channel_address
+              @properties['contact_channel_address']
             end
 
             ##
-            # @return [String] The identity
-            def identity
-              @properties['identity']
+            # @return [Hash] The context
+            def context
+              @properties['context']
+            end
+
+            ##
+            # @return [execution.Status] The status
+            def status
+              @properties['status']
             end
 
             ##
@@ -352,12 +366,6 @@ module Twilio
               @properties['date_updated']
             end
 
-            ##
-            # @return [String] The segments
-            def segments
-              @properties['segments']
-            end
-
             ##
             # @return [String] The url
             def url
@@ -371,45 +379,45 @@ module Twilio
             end
 
             ##
-            # Deletes the UserInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Fetch a ExecutionInstance
+            # @return [ExecutionInstance] Fetched ExecutionInstance
+            def fetch
+              context.fetch
             end
 
             ##
-            # Fetch a UserInstance
-            # @return [UserInstance] Fetched UserInstance
-            def fetch
-              context.fetch
+            # Deletes the ExecutionInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
             end
 
             ##
-            # Access the bindings
-            # @return [bindings] bindings
-            def bindings
-              context.bindings
+            # Access the steps
+            # @return [steps] steps
+            def steps
+              context.steps
             end
 
             ##
-            # Access the segment_memberships
-            # @return [segment_memberships] segment_memberships
-            def segment_memberships
-              context.segment_memberships
+            # Access the execution_context
+            # @return [execution_context] execution_context
+            def execution_context
+              context.execution_context
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.UserInstance #{values}>"
+              "<Twilio.Studio.V2.ExecutionInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Notify.V1.UserInstance #{values}>"
+              "<Twilio.Studio.V2.ExecutionInstance #{values}>"
             end
           end
         end