twilio-ruby 7.9.1 → 7.10.0

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [TaskChannelList] TaskChannelList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskChannels"
@@ -64,6 +65,44 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the TaskChannelInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
+                    # @param [String] unique_name An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`.
+                    # @param [Boolean] channel_optimized_routing Whether the Task Channel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
+                    # @return [TaskChannelInstance] Created TaskChannelInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      unique_name: nil, 
+                      channel_optimized_routing: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'UniqueName' => unique_name,
+                            'ChannelOptimizedRouting' => channel_optimized_routing,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        task_channel_instance = TaskChannelInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        TaskChannelInstanceMetadata.new(
+                            @version,
+                            task_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists TaskChannelInstance records from the API as a list.
@@ -103,6 +142,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists TaskChannelPageMetadata 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)
+
+                        TaskChannelPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields TaskChannelInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -124,7 +185,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 TaskChannelInstance
-                    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,
@@ -170,6 +231,7 @@ module Twilio
                     # @return [TaskChannelContext] TaskChannelContext
                     def initialize(version, workspace_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, sid: sid,  }
@@ -186,9 +248,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the TaskChannelInstanceMetadata
+                    # @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)
+                          taskChannel_instance = TaskChannelInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TaskChannelInstanceMetadata.new(@version, taskChannel_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the TaskChannelInstance
                     # @return [TaskChannelInstance] Fetched TaskChannelInstance
@@ -209,6 +291,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskChannelInstanceMetadata
+                    # @return [TaskChannelInstance] Fetched TaskChannelInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        task_channel_instance = TaskChannelInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        TaskChannelInstanceMetadata.new(
+                            @version,
+                            task_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the TaskChannelInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
@@ -239,6 +347,42 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the TaskChannelInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the Task Channel. It can be up to 64 characters long.
+                    # @param [Boolean] channel_optimized_routing Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.
+                    # @return [TaskChannelInstance] Updated TaskChannelInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      channel_optimized_routing: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'ChannelOptimizedRouting' => channel_optimized_routing,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        task_channel_instance = TaskChannelInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        TaskChannelInstanceMetadata.new(
+                            @version,
+                            task_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -255,6 +399,53 @@ module Twilio
                     end
                 end
 
+                class TaskChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskChannelInstance] task_channel_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 [TaskChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_channel_instance = task_channel_instance
+                    end
+
+                    def task_channel
+                        @task_channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskChannelListResponse < InstanceListResource
+                    # @param [Array<TaskChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_channel_instance = payload.body[key].map do |data|
+                        TaskChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_channel_instance
+                          @instance
+                      end
+                  end
+
                 class TaskChannelPage < Page
                     ##
                     # Initialize the TaskChannelPage
@@ -264,6 +455,7 @@ module Twilio
                     # @return [TaskChannelPage] TaskChannelPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -283,6 +475,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskChannelPage>'
                     end
                 end
+
+                class TaskChannelPageMetadata < PageMetadata
+                    attr_reader :task_channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_channel_page << TaskChannelListResponse.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
+                        @task_channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskChannelListResponse < InstanceListResource
+
+                    # @param [Array<TaskChannelInstance>] 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
+                      @task_channel = data_list.map do |data|
+                        TaskChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_channel
+                        @task_channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskChannelInstance < InstanceResource
                     ##
                     # Initialize the TaskChannelInstance
@@ -296,6 +548,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/task_queue/task_queue_bulk_real_time_statistics.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TaskQueueBulkRealTimeStatisticsList] TaskQueueBulkRealTimeStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/RealTimeStatistics"
@@ -54,6 +55,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the TaskQueueBulkRealTimeStatisticsInstanceMetadata
+                    # @param [Object] body 
+                    # @return [TaskQueueBulkRealTimeStatisticsInstance] Created TaskQueueBulkRealTimeStatisticsInstance
+                    def create_with_metadata(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: body.to_json)
+                        task_queue_bulk_real_time_statistics_instance = TaskQueueBulkRealTimeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        TaskQueueBulkRealTimeStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_bulk_real_time_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -72,6 +100,7 @@ module Twilio
                     # @return [TaskQueueBulkRealTimeStatisticsPage] TaskQueueBulkRealTimeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -91,6 +120,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueueBulkRealTimeStatisticsPage>'
                     end
                 end
+
+                class TaskQueueBulkRealTimeStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_bulk_real_time_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_bulk_real_time_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_bulk_real_time_statistics_page << TaskQueueBulkRealTimeStatisticsListResponse.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
+                        @task_queue_bulk_real_time_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueBulkRealTimeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueBulkRealTimeStatisticsInstance>] 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
+                      @task_queue_bulk_real_time_statistics = data_list.map do |data|
+                        TaskQueueBulkRealTimeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_bulk_real_time_statistics
+                        @task_queue_bulk_real_time_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueBulkRealTimeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueBulkRealTimeStatisticsInstance
@@ -104,6 +193,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TaskQueueCumulativeStatisticsList] TaskQueueCumulativeStatisticsList
                     def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [TaskQueueCumulativeStatisticsContext] TaskQueueCumulativeStatisticsContext
                     def initialize(version, workspace_sid, task_queue_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid,  }
@@ -97,6 +99,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskQueueCumulativeStatisticsInstanceMetadata
+                    # @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] minutes Only calculate statistics since this many minutes in the past. The default is 15 minutes.
+                    # @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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.
+                    # @return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
+                    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)
+                        task_queue_cumulative_statistics_instance = TaskQueueCumulativeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            task_queue_sid: @solution[:task_queue_sid],
+                        )
+                        TaskQueueCumulativeStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_cumulative_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -113,6 +159,53 @@ module Twilio
                     end
                 end
 
+                class TaskQueueCumulativeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskQueueCumulativeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskQueueCumulativeStatisticsInstance] task_queue_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 [TaskQueueCumulativeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_queue_cumulative_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_queue_cumulative_statistics_instance = task_queue_cumulative_statistics_instance
+                    end
+
+                    def task_queue_cumulative_statistics
+                        @task_queue_cumulative_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskQueueCumulativeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskQueueCumulativeStatisticsListResponse < InstanceListResource
+                    # @param [Array<TaskQueueCumulativeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_queue_cumulative_statistics_instance = payload.body[key].map do |data|
+                        TaskQueueCumulativeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_queue_cumulative_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class TaskQueueCumulativeStatisticsPage < Page
                     ##
                     # Initialize the TaskQueueCumulativeStatisticsPage
@@ -122,6 +215,7 @@ module Twilio
                     # @return [TaskQueueCumulativeStatisticsPage] TaskQueueCumulativeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -141,6 +235,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsPage>'
                     end
                 end
+
+                class TaskQueueCumulativeStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_cumulative_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_cumulative_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_cumulative_statistics_page << TaskQueueCumulativeStatisticsListResponse.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
+                        @task_queue_cumulative_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueCumulativeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueCumulativeStatisticsInstance>] 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
+                      @task_queue_cumulative_statistics = data_list.map do |data|
+                        TaskQueueCumulativeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_cumulative_statistics
+                        @task_queue_cumulative_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueCumulativeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueCumulativeStatisticsInstance
@@ -154,6 +308,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, task_queue_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],