twilio-ruby 7.9.1 → 7.10.0

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkerChannelList] WorkerChannelList
                     def initialize(version, workspace_sid: nil, worker_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Channels"
@@ -72,6 +73,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists WorkerChannelPageMetadata 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)
+
+                        WorkerChannelPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields WorkerChannelInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -93,7 +116,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 WorkerChannelInstance
-                    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,
@@ -140,6 +163,7 @@ module Twilio
                     # @return [WorkerChannelContext] WorkerChannelContext
                     def initialize(version, workspace_sid, worker_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid, sid: sid,  }
@@ -168,6 +192,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkerChannelInstanceMetadata
+                    # @return [WorkerChannelInstance] Fetched WorkerChannelInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        worker_channel_instance = WorkerChannelInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            worker_sid: @solution[:worker_sid],
+                            sid: @solution[:sid],
+                        )
+                        WorkerChannelInstanceMetadata.new(
+                            @version,
+                            worker_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the WorkerChannelInstance
                     # @param [String] capacity The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.
@@ -199,6 +250,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the WorkerChannelInstanceMetadata
+                    # @param [String] capacity The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.
+                    # @param [Boolean] available Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.
+                    # @return [WorkerChannelInstance] Updated WorkerChannelInstance
+                    def update_with_metadata(
+                      capacity: :unset, 
+                      available: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Capacity' => capacity,
+                            'Available' => available,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        worker_channel_instance = WorkerChannelInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            worker_sid: @solution[:worker_sid],
+                            sid: @solution[:sid],
+                        )
+                        WorkerChannelInstanceMetadata.new(
+                            @version,
+                            worker_channel_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -215,6 +303,53 @@ module Twilio
                     end
                 end
 
+                class WorkerChannelInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkerChannelInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkerChannelInstance] worker_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 [WorkerChannelInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, worker_channel_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @worker_channel_instance = worker_channel_instance
+                    end
+
+                    def worker_channel
+                        @worker_channel_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkerChannelInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkerChannelListResponse < InstanceListResource
+                    # @param [Array<WorkerChannelInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @worker_channel_instance = payload.body[key].map do |data|
+                        WorkerChannelInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def worker_channel_instance
+                          @instance
+                      end
+                  end
+
                 class WorkerChannelPage < Page
                     ##
                     # Initialize the WorkerChannelPage
@@ -224,6 +359,7 @@ module Twilio
                     # @return [WorkerChannelPage] WorkerChannelPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +379,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkerChannelPage>'
                     end
                 end
+
+                class WorkerChannelPageMetadata < PageMetadata
+                    attr_reader :worker_channel_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @worker_channel_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @worker_channel_page << WorkerChannelListResponse.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
+                        @worker_channel_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkerChannelListResponse < InstanceListResource
+
+                    # @param [Array<WorkerChannelInstance>] 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
+                      @worker_channel = data_list.map do |data|
+                        WorkerChannelInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def worker_channel
+                        @worker_channel
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkerChannelInstance < InstanceResource
                     ##
                     # Initialize the WorkerChannelInstance
@@ -256,6 +452,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, worker_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkerStatisticsList] WorkerStatisticsList
                     def initialize(version, workspace_sid: nil, worker_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [WorkerStatisticsContext] WorkerStatisticsContext
                     def initialize(version, workspace_sid, worker_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid,  }
@@ -94,6 +96,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkerStatisticsInstanceMetadata
+                    # @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 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] task_channel Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
+                    # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
+                    def fetch_with_metadata(
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      end_date: :unset, 
+                      task_channel: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'TaskChannel' => task_channel,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        worker_statistics_instance = WorkerStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            worker_sid: @solution[:worker_sid],
+                        )
+                        WorkerStatisticsInstanceMetadata.new(
+                            @version,
+                            worker_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -110,6 +153,53 @@ module Twilio
                     end
                 end
 
+                class WorkerStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkerStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkerStatisticsInstance] worker_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 [WorkerStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, worker_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @worker_statistics_instance = worker_statistics_instance
+                    end
+
+                    def worker_statistics
+                        @worker_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkerStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkerStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkerStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @worker_statistics_instance = payload.body[key].map do |data|
+                        WorkerStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def worker_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkerStatisticsPage < Page
                     ##
                     # Initialize the WorkerStatisticsPage
@@ -119,6 +209,7 @@ module Twilio
                     # @return [WorkerStatisticsPage] WorkerStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -138,6 +229,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkerStatisticsPage>'
                     end
                 end
+
+                class WorkerStatisticsPageMetadata < PageMetadata
+                    attr_reader :worker_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @worker_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @worker_statistics_page << WorkerStatisticsListResponse.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
+                        @worker_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkerStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkerStatisticsInstance>] 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
+                      @worker_statistics = data_list.map do |data|
+                        WorkerStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def worker_statistics
+                        @worker_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkerStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkerStatisticsInstance
@@ -151,6 +302,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, worker_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkersCumulativeStatisticsList] WorkersCumulativeStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         
@@ -51,6 +52,7 @@ module Twilio
                     # @return [WorkersCumulativeStatisticsContext] WorkersCumulativeStatisticsContext
                     def initialize(version, workspace_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid,  }
@@ -92,6 +94,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkersCumulativeStatisticsInstanceMetadata
+                    # @param [Time] end_date Only calculate statistics from this date and time and earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    # @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`.
+                    # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
+                    def fetch_with_metadata(
+                      end_date: :unset, 
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      task_channel: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'TaskChannel' => task_channel,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        workers_cumulative_statistics_instance = WorkersCumulativeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        WorkersCumulativeStatisticsInstanceMetadata.new(
+                            @version,
+                            workers_cumulative_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -108,6 +150,53 @@ module Twilio
                     end
                 end
 
+                class WorkersCumulativeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkersCumulativeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkersCumulativeStatisticsInstance] workers_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 [WorkersCumulativeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workers_cumulative_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workers_cumulative_statistics_instance = workers_cumulative_statistics_instance
+                    end
+
+                    def workers_cumulative_statistics
+                        @workers_cumulative_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkersCumulativeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkersCumulativeStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkersCumulativeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workers_cumulative_statistics_instance = payload.body[key].map do |data|
+                        WorkersCumulativeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workers_cumulative_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkersCumulativeStatisticsPage < Page
                     ##
                     # Initialize the WorkersCumulativeStatisticsPage
@@ -117,6 +206,7 @@ module Twilio
                     # @return [WorkersCumulativeStatisticsPage] WorkersCumulativeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -136,6 +226,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsPage>'
                     end
                 end
+
+                class WorkersCumulativeStatisticsPageMetadata < PageMetadata
+                    attr_reader :workers_cumulative_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workers_cumulative_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workers_cumulative_statistics_page << WorkersCumulativeStatisticsListResponse.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
+                        @workers_cumulative_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkersCumulativeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkersCumulativeStatisticsInstance>] 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
+                      @workers_cumulative_statistics = data_list.map do |data|
+                        WorkersCumulativeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workers_cumulative_statistics
+                        @workers_cumulative_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkersCumulativeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkersCumulativeStatisticsInstance
@@ -149,6 +299,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],