twilio-ruby 7.3.3 → 7.10.1

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [WorkflowList] WorkflowList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows"
@@ -58,6 +59,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         WorkflowInstance.new(
                             @version,
@@ -66,6 +71,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the WorkflowInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
+                    # @param [String] configuration A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.
+                    # @param [String] assignment_callback_url The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.
+                    # @param [String] fallback_assignment_callback_url The URL that we should call when a call to the `assignment_callback_url` fails.
+                    # @param [String] task_reservation_timeout How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.
+                    # @return [WorkflowInstance] Created WorkflowInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      configuration: nil, 
+                      assignment_callback_url: :unset, 
+                      fallback_assignment_callback_url: :unset, 
+                      task_reservation_timeout: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Configuration' => configuration,
+                            'AssignmentCallbackUrl' => assignment_callback_url,
+                            'FallbackAssignmentCallbackUrl' => fallback_assignment_callback_url,
+                            'TaskReservationTimeout' => task_reservation_timeout,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        workflow_instance = WorkflowInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        WorkflowInstanceMetadata.new(
+                            @version,
+                            workflow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists WorkflowInstance records from the API as a list.
@@ -109,6 +158,30 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists WorkflowPageMetadata records from the API as a list.
+                      # @param [String] friendly_name The `friendly_name` of the Workflow resources to read.
+                    # @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(friendly_name: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        WorkflowPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields WorkflowInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -131,15 +204,18 @@ 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 WorkflowInstance
-                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(friendly_name: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'FriendlyName' => friendly_name,
                             '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)
 
                         WorkflowPage.new(@version, response, @solution)
                     end
@@ -175,6 +251,7 @@ module Twilio
                     # @return [WorkflowContext] WorkflowContext
                     def initialize(version, workspace_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, sid: sid,  }
@@ -192,9 +269,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the WorkflowInstanceMetadata
+                    # @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)
+                          workflow_instance = WorkflowInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          WorkflowInstanceMetadata.new(@version, workflow_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the WorkflowInstance
                     # @return [WorkflowInstance] Fetched WorkflowInstance
@@ -202,6 +301,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         WorkflowInstance.new(
                             @version,
@@ -211,6 +314,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkflowInstanceMetadata
+                    # @return [WorkflowInstance] Fetched WorkflowInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        workflow_instance = WorkflowInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        WorkflowInstanceMetadata.new(
+                            @version,
+                            workflow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the WorkflowInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
@@ -240,6 +369,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         WorkflowInstance.new(
                             @version,
@@ -249,6 +382,54 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the WorkflowInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.
+                    # @param [String] assignment_callback_url The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.
+                    # @param [String] fallback_assignment_callback_url The URL that we should call when a call to the `assignment_callback_url` fails.
+                    # @param [String] configuration A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.
+                    # @param [String] task_reservation_timeout How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.
+                    # @param [String] re_evaluate_tasks Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again.
+                    # @return [WorkflowInstance] Updated WorkflowInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      assignment_callback_url: :unset, 
+                      fallback_assignment_callback_url: :unset, 
+                      configuration: :unset, 
+                      task_reservation_timeout: :unset, 
+                      re_evaluate_tasks: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'AssignmentCallbackUrl' => assignment_callback_url,
+                            'FallbackAssignmentCallbackUrl' => fallback_assignment_callback_url,
+                            'Configuration' => configuration,
+                            'TaskReservationTimeout' => task_reservation_timeout,
+                            'ReEvaluateTasks' => re_evaluate_tasks,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        workflow_instance = WorkflowInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        WorkflowInstanceMetadata.new(
+                            @version,
+                            workflow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the statistics
                     # @return [WorkflowStatisticsList]
@@ -298,6 +479,53 @@ module Twilio
                     end
                 end
 
+                class WorkflowInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkflowInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkflowInstance] workflow_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 [WorkflowInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workflow_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workflow_instance = workflow_instance
+                    end
+
+                    def workflow
+                        @workflow_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkflowInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkflowListResponse < InstanceListResource
+                    # @param [Array<WorkflowInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workflow_instance = payload.body[key].map do |data|
+                        WorkflowInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workflow_instance
+                          @instance
+                      end
+                  end
+
                 class WorkflowPage < Page
                     ##
                     # Initialize the WorkflowPage
@@ -307,6 +535,7 @@ module Twilio
                     # @return [WorkflowPage] WorkflowPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -326,6 +555,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkflowPage>'
                     end
                 end
+
+                class WorkflowPageMetadata < PageMetadata
+                    attr_reader :workflow_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workflow_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workflow_page << WorkflowListResponse.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
+                        @workflow_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkflowListResponse < InstanceListResource
+
+                    # @param [Array<WorkflowInstance>] 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
+                      @workflow = data_list.map do |data|
+                        WorkflowInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workflow
+                        @workflow
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkflowInstance < InstanceResource
                     ##
                     # Initialize the WorkflowInstance
@@ -339,6 +628,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [WorkspaceCumulativeStatisticsList] WorkspaceCumulativeStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         
@@ -50,6 +51,7 @@ module Twilio
                     # @return [WorkspaceCumulativeStatisticsContext] WorkspaceCumulativeStatisticsContext
                     def initialize(version, workspace_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid,  }
@@ -82,6 +84,10 @@ module Twilio
                         })
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         WorkspaceCumulativeStatisticsInstance.new(
                             @version,
@@ -90,6 +96,49 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkspaceCumulativeStatisticsInstanceMetadata
+                    # @param [Time] end_date Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+                    # @param [String] minutes Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
+                    # @param [Time] start_date Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    # @param [String] task_channel Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
+                    # @param [String] split_by_wait_time A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA. TaskRouter will calculate statistics on up to 10,000 Tasks for any given threshold.
+                    # @return [WorkspaceCumulativeStatisticsInstance] Fetched WorkspaceCumulativeStatisticsInstance
+                    def fetch_with_metadata(
+                      end_date: :unset, 
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      task_channel: :unset, 
+                      split_by_wait_time: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'TaskChannel' => task_channel,
+                            'SplitByWaitTime' => split_by_wait_time,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        workspace_cumulative_statistics_instance = WorkspaceCumulativeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        WorkspaceCumulativeStatisticsInstanceMetadata.new(
+                            @version,
+                            workspace_cumulative_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -106,6 +155,53 @@ module Twilio
                     end
                 end
 
+                class WorkspaceCumulativeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkspaceCumulativeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkspaceCumulativeStatisticsInstance] workspace_cumulative_statistics_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 [WorkspaceCumulativeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workspace_cumulative_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workspace_cumulative_statistics_instance = workspace_cumulative_statistics_instance
+                    end
+
+                    def workspace_cumulative_statistics
+                        @workspace_cumulative_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkspaceCumulativeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkspaceCumulativeStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkspaceCumulativeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workspace_cumulative_statistics_instance = payload.body[key].map do |data|
+                        WorkspaceCumulativeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workspace_cumulative_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkspaceCumulativeStatisticsPage < Page
                     ##
                     # Initialize the WorkspaceCumulativeStatisticsPage
@@ -115,6 +211,7 @@ module Twilio
                     # @return [WorkspaceCumulativeStatisticsPage] WorkspaceCumulativeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -134,6 +231,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkspaceCumulativeStatisticsPage>'
                     end
                 end
+
+                class WorkspaceCumulativeStatisticsPageMetadata < PageMetadata
+                    attr_reader :workspace_cumulative_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workspace_cumulative_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workspace_cumulative_statistics_page << WorkspaceCumulativeStatisticsListResponse.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
+                        @workspace_cumulative_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkspaceCumulativeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkspaceCumulativeStatisticsInstance>] 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
+                      @workspace_cumulative_statistics = data_list.map do |data|
+                        WorkspaceCumulativeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workspace_cumulative_statistics
+                        @workspace_cumulative_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkspaceCumulativeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkspaceCumulativeStatisticsInstance
@@ -147,6 +304,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],