##
#    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 < TaskrouterBase
            class V1 < Version
                class WorkspaceContext < InstanceContext

                     class WorkerList < ListResource
                    ##
                    # Initialize the WorkerList
                    # @param [Version] version Version that contains the resource
                    # @return [WorkerList] WorkerList
                    def initialize(version, workspace_sid: nil)
                        super(version)
                        # Path Solution
                        @solution = { workspace_sid: workspace_sid }
                        @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers"
                        # Components
                        @statistics = nil
                    end
                    ##
                    # Create the WorkerInstance
                    # @param [String] friendly_name A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.
                    # @param [String] activity_sid The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.
                    # @param [String] attributes A valid JSON string that describes the new Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
                    # @return [WorkerInstance] Created WorkerInstance
                    def create(
                        friendly_name: nil, 
                        activity_sid: :unset, 
                        attributes: :unset
                    )

                        data = Twilio::Values.of({
                            'FriendlyName' => friendly_name,
                            'ActivitySid' => activity_sid,
                            'Attributes' => attributes,
                        })

                        payload = @version.create('POST', @uri, data: data)
                        WorkerInstance.new(
                            @version,
                            payload,
                            workspace_sid: @solution[:workspace_sid],
                        )
                    end

                
                    ##
                    # Lists WorkerInstance records from the API as a list.
                    # Unlike stream(), this operation is eager and will load `limit` records into
                    # memory before returning.
                    # @param [String] activity_name The `activity_name` of the Worker resources to read.
                    # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
                    # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
                    # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
                    # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
                    # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] ordering Sorting parameter for Workers
                    # @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(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
                        self.stream(
                            activity_name: activity_name,
                            activity_sid: activity_sid,
                            available: available,
                            friendly_name: friendly_name,
                            target_workers_expression: target_workers_expression,
                            task_queue_name: task_queue_name,
                            task_queue_sid: task_queue_sid,
                            ordering: ordering,
                            limit: limit,
                            page_size: page_size
                        ).entries
                    end

                    ##
                    # Streams Instance records from the API as an Enumerable.
                    # This operation lazily loads records as efficiently as possible until the limit
                    # is reached.
                    # @param [String] activity_name The `activity_name` of the Worker resources to read.
                    # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
                    # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
                    # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
                    # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
                    # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] ordering Sorting parameter for Workers
                    # @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 [Enumerable] Enumerable that will yield up to limit results
                    def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
                        limits = @version.read_limits(limit, page_size)

                        page = self.page(
                            activity_name: activity_name,
                            activity_sid: activity_sid,
                            available: available,
                            friendly_name: friendly_name,
                            target_workers_expression: target_workers_expression,
                            task_queue_name: task_queue_name,
                            task_queue_sid: task_queue_sid,
                            ordering: ordering,
                            page_size: limits[:page_size], )

                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                    end

                    ##
                    # When passed a block, yields WorkerInstance records from the API.
                    # This operation lazily loads records as efficiently as possible until the limit
                    # is reached.
                    def each
                        limits = @version.read_limits

                        page = self.page(page_size: limits[:page_size], )

                        @version.stream(page,
                            limit: limits[:limit],
                            page_limit: limits[:page_limit]).each {|x| yield x}
                    end

                    ##
                    # Retrieve a single page of WorkerInstance records from the API.
                    # Request is executed immediately.
                    # @param [String] activity_name The `activity_name` of the Worker resources to read.
                    # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
                    # @param [String] available Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.
                    # @param [String] friendly_name The `friendly_name` of the Worker resources to read.
                    # @param [String] target_workers_expression Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.
                    # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read are eligible for.
                    # @param [String] ordering Sorting parameter for Workers
                    # @param [String] page_token PageToken provided by the API
                    # @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 WorkerInstance
                    def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
                        params = Twilio::Values.of({
                            
                            'ActivityName' => activity_name,
                            
                            'ActivitySid' => activity_sid,
                            
                            'Available' => available,
                            
                            'FriendlyName' => friendly_name,
                            
                            'TargetWorkersExpression' => target_workers_expression,
                            
                            'TaskQueueName' => task_queue_name,
                            
                            'TaskQueueSid' => task_queue_sid,
                            
                            'Ordering' => ordering,
                            
                            'PageToken' => page_token,
                            'Page' => page_number,
                            'PageSize' => page_size,
                        })

                        response = @version.page('GET', @uri, params: params)

                        WorkerPage.new(@version, response, @solution)
                    end

                    ##
                    # Retrieve a single page of WorkerInstance records from the API.
                    # Request is executed immediately.
                    # @param [String] target_url API-generated URL for the requested results page
                    # @return [Page] Page of WorkerInstance
                    def get_page(target_url)
                        response = @version.domain.request(
                            'GET',
                            target_url
                        )
                    WorkerPage.new(@version, response, @solution)
                    end
                    

                ##
                # Access the statistics
                # @return [WorkersStatisticsContext]
                def statistics
                   return  WorkersStatisticsContext.new(@version, @solution[:workspace_sid])
                end

                    # Provide a user friendly representation
                    def to_s
                        '#<Twilio.Taskrouter.V1.WorkerList>'
                    end
                end


                class WorkerContext < InstanceContext
                    ##
                    # Initialize the WorkerContext
                    # @param [Version] version Version that contains the resource
                    # @param [String] workspace_sid The SID of the Workspace with the Worker to update.
                    # @param [String] sid The SID of the Worker resource to update.
                    # @return [WorkerContext] WorkerContext
                    def initialize(version, workspace_sid, sid)
                        super(version)

                        # Path Solution
                        @solution = { workspace_sid: workspace_sid, sid: sid,  }
                        @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:sid]}"

                        # Dependents
                        @reservations = nil
                        @real_time_statistics = nil
                        @statistics = nil
                        @cumulative_statistics = nil
                        @worker_channels = nil
                    end
                    ##
                    # Delete the WorkerInstance
                    # @param [String] if_match The If-Match HTTP request header
                    # @return [Boolean] True if delete succeeds, false otherwise
                    def delete(
                        if_match: :unset
                    )

                        headers = Twilio::Values.of({ 'If-Match' => if_match, })
                        @version.delete('DELETE', @uri, headers: headers)
                    end

                    ##
                    # Fetch the WorkerInstance
                    # @return [WorkerInstance] Fetched WorkerInstance
                    def fetch

                        payload = @version.fetch('GET', @uri)
                        WorkerInstance.new(
                            @version,
                            payload,
                            workspace_sid: @solution[:workspace_sid],
                            sid: @solution[:sid],
                        )
                    end

                    ##
                    # Update the WorkerInstance
                    # @param [String] activity_sid The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.
                    # @param [String] attributes The JSON string that describes the Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
                    # @param [String] friendly_name A descriptive string that you create to describe the Worker. It can be up to 64 characters long.
                    # @param [Boolean] reject_pending_reservations Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`.
                    # @param [String] if_match The If-Match HTTP request header
                    # @return [WorkerInstance] Updated WorkerInstance
                    def update(
                        activity_sid: :unset, 
                        attributes: :unset, 
                        friendly_name: :unset, 
                        reject_pending_reservations: :unset, 
                        if_match: :unset
                    )

                        data = Twilio::Values.of({
                            'ActivitySid' => activity_sid,
                            'Attributes' => attributes,
                            'FriendlyName' => friendly_name,
                            'RejectPendingReservations' => reject_pending_reservations,
                        })

                        headers = Twilio::Values.of({ 'If-Match' => if_match, })
                        payload = @version.update('POST', @uri, data: data, headers: headers)
                        WorkerInstance.new(
                            @version,
                            payload,
                            workspace_sid: @solution[:workspace_sid],
                            sid: @solution[:sid],
                        )
                    end

                    ##
                    # Access the reservations
                    # @return [ReservationList]
                    # @return [ReservationContext] if sid was passed.
                    def reservations(sid=:unset)

                        raise ArgumentError, 'sid cannot be nil' if sid.nil?

                        if sid != :unset
                            return ReservationContext.new(@version, @solution[:workspace_sid], @solution[:sid],sid )
                        end

                        unless @reservations
                            @reservations = ReservationList.new(
                                @version, workspace_sid: @solution[:workspace_sid],  worker_sid: @solution[:sid], )
                        end

                     @reservations
                    end
                    ##
                    # Access the real_time_statistics
                    # @return [WorkersRealTimeStatisticsList]
                    # @return [WorkersRealTimeStatisticsContext]
                    def real_time_statistics
                        WorkersRealTimeStatisticsContext.new(
                                @version,
                                @solution[:workspace_sid],
                                @solution[:sid]
                                )
                    end
                    ##
                    # Access the statistics
                    # @return [WorkerStatisticsList]
                    # @return [WorkerStatisticsContext]
                    def statistics
                        WorkerStatisticsContext.new(
                                @version,
                                @solution[:workspace_sid],
                                @solution[:sid]
                                )
                    end
                    ##
                    # Access the cumulative_statistics
                    # @return [WorkersCumulativeStatisticsList]
                    # @return [WorkersCumulativeStatisticsContext]
                    def cumulative_statistics
                        WorkersCumulativeStatisticsContext.new(
                                @version,
                                @solution[:workspace_sid],
                                @solution[:sid]
                                )
                    end
                    ##
                    # Access the worker_channels
                    # @return [WorkerChannelList]
                    # @return [WorkerChannelContext] if sid was passed.
                    def worker_channels(sid=:unset)

                        raise ArgumentError, 'sid cannot be nil' if sid.nil?

                        if sid != :unset
                            return WorkerChannelContext.new(@version, @solution[:workspace_sid], @solution[:sid],sid )
                        end

                        unless @worker_channels
                            @worker_channels = WorkerChannelList.new(
                                @version, workspace_sid: @solution[:workspace_sid],  worker_sid: @solution[:sid], )
                        end

                     @worker_channels
                    end

                    ##
                    # Provide a user friendly representation
                    def to_s
                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
                        "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
                    end

                    ##
                    # Provide a detailed, user friendly representation
                    def inspect
                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
                        "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
                    end
                end

                class WorkerPage < Page
                    ##
                    # Initialize the WorkerPage
                    # @param [Version] version Version that contains the resource
                    # @param [Response] response Response from the API
                    # @param [Hash] solution Path solution for the resource
                    # @return [WorkerPage] WorkerPage
                    def initialize(version, response, solution)
                        super(version, response)

                        # Path Solution
                        @solution = solution
                    end

                    ##
                    # Build an instance of WorkerInstance
                    # @param [Hash] payload Payload response from the API
                    # @return [WorkerInstance] WorkerInstance
                    def get_instance(payload)
                        WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
                    end

                    ##
                    # Provide a user friendly representation
                    def to_s
                        '<Twilio.Taskrouter.V1.WorkerPage>'
                    end
                end
                class WorkerInstance < InstanceResource
                    ##
                    # Initialize the WorkerInstance
                    # @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 Worker
                    #   resource.
                    # @param [String] sid The SID of the Call resource to fetch.
                    # @return [WorkerInstance] WorkerInstance
                    def initialize(version, payload , workspace_sid: nil, sid: nil)
                        super(version)
                        
                        # Marshaled Properties
                        @properties = { 
                            'account_sid' => payload['account_sid'],
                            'activity_name' => payload['activity_name'],
                            'activity_sid' => payload['activity_sid'],
                            'attributes' => payload['attributes'],
                            'available' => payload['available'],
                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                            'date_status_changed' => Twilio.deserialize_iso8601_datetime(payload['date_status_changed']),
                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                            'friendly_name' => payload['friendly_name'],
                            'sid' => payload['sid'],
                            'workspace_sid' => payload['workspace_sid'],
                            'url' => payload['url'],
                            'links' => payload['links'],
                        }

                        # Context
                        @instance_context = nil
                        @params = { 'workspace_sid' => workspace_sid  || @properties['workspace_sid']  ,'sid' => sid  || @properties['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 [WorkerContext] CallContext for this CallInstance
                    def context
                        unless @instance_context
                            @instance_context = WorkerContext.new(@version , @params['workspace_sid'], @params['sid'])
                        end
                        @instance_context
                    end
                    
                    ##
                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource.
                    def account_sid
                        @properties['account_sid']
                    end
                    
                    ##
                    # @return [String] The `friendly_name` of the Worker's current Activity.
                    def activity_name
                        @properties['activity_name']
                    end
                    
                    ##
                    # @return [String] The SID of the Worker's current Activity.
                    def activity_sid
                        @properties['activity_sid']
                    end
                    
                    ##
                    # @return [String] The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. **Note** If this property has been assigned a value, it will only be displayed in FETCH actions that return a single resource. Otherwise, this property will be null, even if it has a value. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker.
                    def attributes
                        @properties['attributes']
                    end
                    
                    ##
                    # @return [Boolean] Whether the Worker is available to perform tasks.
                    def available
                        @properties['available']
                    end
                    
                    ##
                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                    def date_created
                        @properties['date_created']
                    end
                    
                    ##
                    # @return [Time] The date and time in GMT of the last change to the Worker's activity specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Used to calculate Workflow statistics.
                    def date_status_changed
                        @properties['date_status_changed']
                    end
                    
                    ##
                    # @return [Time] The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                    def date_updated
                        @properties['date_updated']
                    end
                    
                    ##
                    # @return [String] The string that you assigned to describe the resource. Friendly names are case insensitive, and unique within the TaskRouter Workspace.
                    def friendly_name
                        @properties['friendly_name']
                    end
                    
                    ##
                    # @return [String] The unique string that we created to identify the Worker resource.
                    def sid
                        @properties['sid']
                    end
                    
                    ##
                    # @return [String] The SID of the Workspace that contains the Worker.
                    def workspace_sid
                        @properties['workspace_sid']
                    end
                    
                    ##
                    # @return [String] The absolute URL of the Worker resource.
                    def url
                        @properties['url']
                    end
                    
                    ##
                    # @return [Hash] The URLs of related resources.
                    def links
                        @properties['links']
                    end
                    
                    ##
                    # Delete the WorkerInstance
                    # @param [String] if_match The If-Match HTTP request header
                    # @return [Boolean] True if delete succeeds, false otherwise
                    def delete(
                        if_match: :unset
                    )

                        context.delete(
                            if_match: if_match, 
                        )
                    end

                    ##
                    # Fetch the WorkerInstance
                    # @return [WorkerInstance] Fetched WorkerInstance
                    def fetch

                        context.fetch
                    end

                    ##
                    # Update the WorkerInstance
                    # @param [String] activity_sid The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.
                    # @param [String] attributes The JSON string that describes the Worker. For example: `{ \\\"email\\\": \\\"Bob@example.com\\\", \\\"phone\\\": \\\"+5095551234\\\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.
                    # @param [String] friendly_name A descriptive string that you create to describe the Worker. It can be up to 64 characters long.
                    # @param [Boolean] reject_pending_reservations Whether to reject the Worker's pending reservations. This option is only valid if the Worker's new [Activity](https://www.twilio.com/docs/taskrouter/api/activity) resource has its `availability` property set to `False`.
                    # @param [String] if_match The If-Match HTTP request header
                    # @return [WorkerInstance] Updated WorkerInstance
                    def update(
                        activity_sid: :unset, 
                        attributes: :unset, 
                        friendly_name: :unset, 
                        reject_pending_reservations: :unset, 
                        if_match: :unset
                    )

                        context.update(
                            activity_sid: activity_sid, 
                            attributes: attributes, 
                            friendly_name: friendly_name, 
                            reject_pending_reservations: reject_pending_reservations, 
                            if_match: if_match, 
                        )
                    end

                    ##
                    # Access the reservations
                    # @return [reservations] reservations
                    def reservations
                        context.reservations
                    end

                    ##
                    # Access the real_time_statistics
                    # @return [real_time_statistics] real_time_statistics
                    def real_time_statistics
                        context.real_time_statistics
                    end

                    ##
                    # Access the statistics
                    # @return [statistics] statistics
                    def statistics
                        context.statistics
                    end

                    ##
                    # Access the cumulative_statistics
                    # @return [cumulative_statistics] cumulative_statistics
                    def cumulative_statistics
                        context.cumulative_statistics
                    end

                    ##
                    # Access the worker_channels
                    # @return [worker_channels] worker_channels
                    def worker_channels
                        context.worker_channels
                    end

                    ##
                    # Provide a user friendly representation
                    def to_s
                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
                        "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
                    end

                    ##
                    # Provide a detailed, user friendly representation
                    def inspect
                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
                        "<Twilio.Taskrouter.V1.WorkerInstance #{values}>"
                    end
                end

             end
            end
        end
    end
end