twilio-ruby 7.3.3 → 7.10.1

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [ExecutionList] ExecutionList
                     def initialize(version, flow_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { flow_sid: flow_sid }
                         @uri = "/Flows/#{@solution[:flow_sid]}/Executions"
@@ -52,6 +53,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         ExecutionInstance.new(
                             @version,
@@ -60,6 +65,44 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ExecutionInstanceMetadata
+                    # @param [String] to The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.
+                    # @param [String] from The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID.
+                    # @param [Object] 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_with_metadata(
+                      to: nil, 
+                      from: nil, 
+                      parameters: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'To' => to,
+                            'From' => from,
+                            'Parameters' => Twilio.serialize_object(parameters),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        execution_instance = ExecutionInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                        )
+                        ExecutionInstanceMetadata.new(
+                            @version,
+                            execution_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ExecutionInstance records from the API as a list.
@@ -107,6 +150,32 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists ExecutionPageMetadata records from the API as a list.
+                      # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    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_with_metadata(date_created_from: :unset, date_created_to: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'DateCreatedFrom' =>  Twilio.serialize_iso8601_datetime(date_created_from),
+                            'DateCreatedTo' =>  Twilio.serialize_iso8601_datetime(date_created_to),
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ExecutionPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields ExecutionInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -130,7 +199,7 @@ module Twilio
                     # @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(date_created_from: :unset, date_created_to: :unset, 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),
@@ -138,8 +207,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         ExecutionPage.new(@version, response, @solution)
                     end
@@ -175,6 +247,7 @@ module Twilio
                     # @return [ExecutionContext] ExecutionContext
                     def initialize(version, flow_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { flow_sid: flow_sid, sid: sid,  }
@@ -191,9 +264,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the ExecutionInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          execution_instance = ExecutionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ExecutionInstanceMetadata.new(@version, execution_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the ExecutionInstance
                     # @return [ExecutionInstance] Fetched ExecutionInstance
@@ -201,6 +296,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         ExecutionInstance.new(
                             @version,
@@ -210,6 +309,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ExecutionInstanceMetadata
+                    # @return [ExecutionInstance] Fetched ExecutionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        execution_instance = ExecutionInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            sid: @solution[:sid],
+                        )
+                        ExecutionInstanceMetadata.new(
+                            @version,
+                            execution_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ExecutionInstance
                     # @param [Status] status 
@@ -224,6 +349,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         ExecutionInstance.new(
                             @version,
@@ -233,6 +362,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ExecutionInstanceMetadata
+                    # @param [Status] status 
+                    # @return [ExecutionInstance] Updated ExecutionInstance
+                    def update_with_metadata(
+                      status: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        execution_instance = ExecutionInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            sid: @solution[:sid],
+                        )
+                        ExecutionInstanceMetadata.new(
+                            @version,
+                            execution_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the execution_context
                     # @return [ExecutionContextList]
@@ -279,6 +441,53 @@ module Twilio
                     end
                 end
 
+                class ExecutionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ExecutionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ExecutionInstance] execution_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ExecutionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, execution_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @execution_instance = execution_instance
+                    end
+
+                    def execution
+                        @execution_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ExecutionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ExecutionListResponse < InstanceListResource
+                    # @param [Array<ExecutionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @execution_instance = payload.body[key].map do |data|
+                        ExecutionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def execution_instance
+                          @instance
+                      end
+                  end
+
                 class ExecutionPage < Page
                     ##
                     # Initialize the ExecutionPage
@@ -288,6 +497,7 @@ module Twilio
                     # @return [ExecutionPage] ExecutionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -307,6 +517,66 @@ module Twilio
                         '<Twilio.Studio.V1.ExecutionPage>'
                     end
                 end
+
+                class ExecutionPageMetadata < PageMetadata
+                    attr_reader :execution_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @execution_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @execution_page << ExecutionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @execution_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V1PageMetadata>';
+                    end
+                end
+                class ExecutionListResponse < InstanceListResource
+
+                    # @param [Array<ExecutionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @execution = data_list.map do |data|
+                        ExecutionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def execution
+                        @execution
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ExecutionInstance < InstanceResource
                     ##
                     # Initialize the ExecutionInstance
@@ -320,6 +590,7 @@ module Twilio
                     def initialize(version, payload , flow_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [FlowList] FlowList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Flows"
@@ -69,6 +70,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists FlowPageMetadata records from the API as a list.
+                    # @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
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    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_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        FlowPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields FlowInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -90,14 +113,17 @@ module Twilio
                     # @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 FlowInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         FlowPage.new(@version, response, @solution)
                     end
@@ -132,6 +158,7 @@ module Twilio
                     # @return [FlowContext] FlowContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -148,9 +175,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the FlowInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          flow_instance = FlowInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          FlowInstanceMetadata.new(@version, flow_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the FlowInstance
                     # @return [FlowInstance] Fetched FlowInstance
@@ -158,6 +207,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         FlowInstance.new(
                             @version,
@@ -166,6 +219,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FlowInstanceMetadata
+                    # @return [FlowInstance] Fetched FlowInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        flow_instance = FlowInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlowInstanceMetadata.new(
+                            @version,
+                            flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the executions
                     # @return [ExecutionList]
@@ -220,6 +298,53 @@ module Twilio
                     end
                 end
 
+                class FlowInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FlowInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FlowInstance] flow_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [FlowInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, flow_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @flow_instance = flow_instance
+                    end
+
+                    def flow
+                        @flow_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FlowInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FlowListResponse < InstanceListResource
+                    # @param [Array<FlowInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @flow_instance = payload.body[key].map do |data|
+                        FlowInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def flow_instance
+                          @instance
+                      end
+                  end
+
                 class FlowPage < Page
                     ##
                     # Initialize the FlowPage
@@ -229,6 +354,7 @@ module Twilio
                     # @return [FlowPage] FlowPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -248,6 +374,66 @@ module Twilio
                         '<Twilio.Studio.V1.FlowPage>'
                     end
                 end
+
+                class FlowPageMetadata < PageMetadata
+                    attr_reader :flow_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_page << FlowListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @flow_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V1PageMetadata>';
+                    end
+                end
+                class FlowListResponse < InstanceListResource
+
+                    # @param [Array<FlowInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @flow = data_list.map do |data|
+                        FlowInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow
+                        @flow
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowInstance < InstanceResource
                     ##
                     # Initialize the FlowInstance
@@ -261,6 +447,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],