twilio-ruby 5.23.0 → 7.2.3

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

@@ -1,269 +1,262 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-# 
-# frozen_string_literal: true
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Taskrouter
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
 
-module Twilio
-  module REST
-    class Taskrouter < Domain
-      class V1 < Version
-        class WorkspaceContext < InstanceContext
-          class WorkflowContext < InstanceContext
-            class WorkflowStatisticsList < ListResource
-              ##
-              # Initialize the WorkflowStatisticsList
-              # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
-              # @return [WorkflowStatisticsList] WorkflowStatisticsList
-              def initialize(version, workspace_sid: nil, workflow_sid: nil)
-                super(version)
-
-                # Path Solution
-                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid}
-              end
 
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '#<Twilio.Taskrouter.V1.WorkflowStatisticsList>'
-              end
-            end
+module Twilio
+    module REST
+        class Taskrouter < TaskrouterBase
+            class V1 < Version
+                class WorkspaceContext < InstanceContext
+                class WorkflowContext < InstanceContext
 
-            class WorkflowStatisticsPage < Page
-              ##
-              # Initialize the WorkflowStatisticsPage
-              # @param [Version] version Version that contains the resource
-              # @param [Response] response Response from the API
-              # @param [Hash] solution Path solution for the resource
-              # @return [WorkflowStatisticsPage] WorkflowStatisticsPage
-              def initialize(version, response, solution)
-                super(version, response)
+                     class WorkflowStatisticsList < ListResource
+                
+                    ##
+                    # Initialize the WorkflowStatisticsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [WorkflowStatisticsList] WorkflowStatisticsList
+                    def initialize(version, workspace_sid: nil, workflow_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid }
+                        
+                        
+                    end
+                
 
-                # Path Solution
-                @solution = solution
-              end
 
-              ##
-              # Build an instance of WorkflowStatisticsInstance
-              # @param [Hash] payload Payload response from the API
-              # @return [WorkflowStatisticsInstance] WorkflowStatisticsInstance
-              def get_instance(payload)
-                WorkflowStatisticsInstance.new(
-                    @version,
-                    payload,
-                    workspace_sid: @solution[:workspace_sid],
-                    workflow_sid: @solution[:workflow_sid],
-                )
-              end
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Taskrouter.V1.WorkflowStatisticsList>'
+                    end
+                end
 
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '<Twilio.Taskrouter.V1.WorkflowStatisticsPage>'
-              end
-            end
 
-            class WorkflowStatisticsContext < InstanceContext
-              ##
-              # Initialize the WorkflowStatisticsContext
-              # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
-              # @return [WorkflowStatisticsContext] WorkflowStatisticsContext
-              def initialize(version, workspace_sid, workflow_sid)
-                super(version)
+                class WorkflowStatisticsContext < InstanceContext
+                    ##
+                    # Initialize the WorkflowStatisticsContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] workspace_sid The SID of the Workspace with the Workflow to fetch.
+                    # @param [String] workflow_sid Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.
+                    # @return [WorkflowStatisticsContext] WorkflowStatisticsContext
+                    def initialize(version, workspace_sid, workflow_sid)
+                        super(version)
 
-                # Path Solution
-                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid, }
-                @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/Statistics"
-              end
+                        # Path Solution
+                        @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid,  }
+                        @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/Statistics"
 
-              ##
-              # Fetch a WorkflowStatisticsInstance
-              # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
-              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
-              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
-              # @param [Time] start_date Filter cumulative statistics by a start date. This is
-              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
-              #   Timestamp
-              # @param [Time] end_date Filter cumulative statistics by an end date. This is
-              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
-              #   Timestamp
-              # @param [String] task_channel Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
-              # @param [String] split_by_wait_time A comma separated values for viewing splits
-              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
-              #   would show splits of tasks that were canceled or accepted before or after 5
-              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
-              #   tasks or tasks that failed to meet your SLA.
-              # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
-              def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
-                params = Twilio::Values.of({
-                    'Minutes' => minutes,
-                    'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
-                    'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
-                    'TaskChannel' => task_channel,
-                    'SplitByWaitTime' => split_by_wait_time,
-                })
+                        
+                    end
+                    ##
+                    # Fetch the WorkflowStatisticsInstance
+                    # @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 [Time] end_date Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+                    # @param [String] task_channel Only calculate real-time 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.
+                    # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
+                    def fetch(
+                        minutes: :unset, 
+                        start_date: :unset, 
+                        end_date: :unset, 
+                        task_channel: :unset, 
+                        split_by_wait_time: :unset
+                    )
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                        params = Twilio::Values.of({
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'TaskChannel' => task_channel,
+                            'SplitByWaitTime' => split_by_wait_time,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        WorkflowStatisticsInstance.new(
+                            @version,
+                            payload,
+                            workspace_sid: @solution[:workspace_sid],
+                            workflow_sid: @solution[:workflow_sid],
+                        )
+                    end
 
-                WorkflowStatisticsInstance.new(
-                    @version,
-                    payload,
-                    workspace_sid: @solution[:workspace_sid],
-                    workflow_sid: @solution[:workflow_sid],
-                )
-              end
 
-              ##
-              # Provide a user friendly representation
-              def to_s
-                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Taskrouter.V1.WorkflowStatisticsContext #{context}>"
-              end
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Taskrouter.V1.WorkflowStatisticsContext #{context}>"
+                    end
 
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Taskrouter.V1.WorkflowStatisticsContext #{context}>"
-              end
-            end
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Taskrouter.V1.WorkflowStatisticsContext #{context}>"
+                    end
+                end
 
-            class WorkflowStatisticsInstance < InstanceResource
-              ##
-              # Initialize the WorkflowStatisticsInstance
-              # @param [Version] version Version that contains the resource
-              # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
-              # @return [WorkflowStatisticsInstance] WorkflowStatisticsInstance
-              def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
-                super(version)
+                class WorkflowStatisticsPage < Page
+                    ##
+                    # Initialize the WorkflowStatisticsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [WorkflowStatisticsPage] WorkflowStatisticsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
 
-                # Marshaled Properties
-                @properties = {
-                    'account_sid' => payload['account_sid'],
-                    'cumulative' => payload['cumulative'],
-                    'realtime' => payload['realtime'],
-                    'workflow_sid' => payload['workflow_sid'],
-                    'workspace_sid' => payload['workspace_sid'],
-                    'url' => payload['url'],
-                }
+                        # Path Solution
+                        @solution = solution
+                    end
 
-                # Context
-                @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid, }
-              end
+                    ##
+                    # Build an instance of WorkflowStatisticsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [WorkflowStatisticsInstance] WorkflowStatisticsInstance
+                    def get_instance(payload)
+                        WorkflowStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], workflow_sid: @solution[:workflow_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 [WorkflowStatisticsContext] WorkflowStatisticsContext for this WorkflowStatisticsInstance
-              def context
-                unless @instance_context
-                  @instance_context = WorkflowStatisticsContext.new(
-                      @version,
-                      @params['workspace_sid'],
-                      @params['workflow_sid'],
-                  )
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Taskrouter.V1.WorkflowStatisticsPage>'
+                    end
                 end
-                @instance_context
-              end
-
-              ##
-              # @return [String] The account_sid
-              def account_sid
-                @properties['account_sid']
-              end
-
-              ##
-              # @return [Hash] The cumulative
-              def cumulative
-                @properties['cumulative']
-              end
-
-              ##
-              # @return [Hash] The realtime
-              def realtime
-                @properties['realtime']
-              end
+                class WorkflowStatisticsInstance < InstanceResource
+                    ##
+                    # Initialize the WorkflowStatisticsInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this WorkflowStatistics
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [WorkflowStatisticsInstance] WorkflowStatisticsInstance
+                    def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'cumulative' => payload['cumulative'],
+                            'realtime' => payload['realtime'],
+                            'workflow_sid' => payload['workflow_sid'],
+                            'workspace_sid' => payload['workspace_sid'],
+                            'url' => payload['url'],
+                        }
 
-              ##
-              # @return [String] The workflow_sid
-              def workflow_sid
-                @properties['workflow_sid']
-              end
+                        # Context
+                        @instance_context = nil
+                        @params = { 'workspace_sid' => workspace_sid  || @properties['workspace_sid']  ,'workflow_sid' => workflow_sid  || @properties['workflow_sid']  , }
+                    end
 
-              ##
-              # @return [String] The workspace_sid
-              def workspace_sid
-                @properties['workspace_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 [WorkflowStatisticsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = WorkflowStatisticsContext.new(@version , @params['workspace_sid'], @params['workflow_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] An object that contains the cumulative statistics for the Workflow.
+                    def cumulative
+                        @properties['cumulative']
+                    end
+                    
+                    ##
+                    # @return [Hash] An object that contains the real-time statistics for the Workflow.
+                    def realtime
+                        @properties['realtime']
+                    end
+                    
+                    ##
+                    # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.
+                    def workflow_sid
+                        @properties['workflow_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Workspace that contains the Workflow.
+                    def workspace_sid
+                        @properties['workspace_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Workflow statistics resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the WorkflowStatisticsInstance
+                    # @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 [Time] end_date Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+                    # @param [String] task_channel Only calculate real-time 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.
+                    # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
+                    def fetch(
+                        minutes: :unset, 
+                        start_date: :unset, 
+                        end_date: :unset, 
+                        task_channel: :unset, 
+                        split_by_wait_time: :unset
+                    )
 
-              ##
-              # @return [String] The url
-              def url
-                @properties['url']
-              end
+                        context.fetch(
+                            minutes: minutes, 
+                            start_date: start_date, 
+                            end_date: end_date, 
+                            task_channel: task_channel, 
+                            split_by_wait_time: split_by_wait_time, 
+                        )
+                    end
 
-              ##
-              # Fetch a WorkflowStatisticsInstance
-              # @param [String] minutes Filter cumulative statistics by up to 'x' minutes in the
-              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
-              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
-              # @param [Time] start_date Filter cumulative statistics by a start date. This is
-              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
-              #   Timestamp
-              # @param [Time] end_date Filter cumulative statistics by an end date. This is
-              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
-              #   Timestamp
-              # @param [String] task_channel Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
-              # @param [String] split_by_wait_time A comma separated values for viewing splits
-              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
-              #   would show splits of tasks that were canceled or accepted before or after 5
-              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
-              #   tasks or tasks that failed to meet your SLA.
-              # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
-              def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
-                context.fetch(
-                    minutes: minutes,
-                    start_date: start_date,
-                    end_date: end_date,
-                    task_channel: task_channel,
-                    split_by_wait_time: split_by_wait_time,
-                )
-              end
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Taskrouter.V1.WorkflowStatisticsInstance #{values}>"
+                    end
 
-              ##
-              # Provide a user friendly representation
-              def to_s
-                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Taskrouter.V1.WorkflowStatisticsInstance #{values}>"
-              end
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Taskrouter.V1.WorkflowStatisticsInstance #{values}>"
+                    end
+                end
 
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Taskrouter.V1.WorkflowStatisticsInstance #{values}>"
-              end
+             end
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+