candidhealth 0.0.0 → 0.17.1

data/lib/candidhealth/tasks/v_3/client.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
+require_relative "../../commons/types/task_id"
 require_relative "types/task_actions"
+require_relative "../../commons/types/page_token"
 require_relative "../commons/types/task_status"
 require_relative "../commons/types/task_type"
 require "date"
+require_relative "../../commons/types/encounter_id"
+require_relative "../../commons/types/user_id"
 require_relative "types/task_sort_options"
 require_relative "types/task_page"
 require_relative "types/task"
@@ -16,64 +20,48 @@ module CandidApiClient
   module Tasks
     module V3
       class V3Client
-        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [CandidApiClient::RequestClient]
-        # @return [CandidApiClient::Tasks::V3::V3Client]
+        # @param request_client [RequestClient]
+        # @return [Tasks::V3::V3Client]
         def initialize(request_client:)
+          # @type [RequestClient]
           @request_client = request_client
         end
 
-        # @param task_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::TaskActions]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get_actions(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @param task_id [Commons::TASK_ID]
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::TaskActions]
         def get_actions(task_id:, request_options: nil)
-          response = @request_client.conn.get do |req|
+          response = @request_client.conn.get("/api/tasks/v3/#{task_id}/actions") do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi,
-                                               request_options: request_options)}/api/tasks/v3/#{task_id}/actions"
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
           end
-          CandidApiClient::Tasks::V3::Types::TaskActions.from_json(json_object: response.body)
+          Tasks::V3::TaskActions.from_json(json_object: response.body)
         end
 
         # @param limit [Integer] Defaults to 100
-        # @param page_token [String]
-        # @param status [CandidApiClient::Tasks::Commons::Types::TaskStatus]
-        # @param task_type [CandidApiClient::Tasks::Commons::Types::TaskType]
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param status [Tasks::Commons::TaskStatus]
+        # @param task_type [Tasks::Commons::TaskType]
         # @param categories [String] Only return tasks with categories that match one in this comma-separated list.
         # @param updated_since [DateTime] Only return tasks updated on or after this date-time
-        # @param encounter_id [String] Only return tasks associated with this encounter
+        # @param encounter_id [Commons::ENCOUNTER_ID] Only return tasks associated with this encounter
         # @param search_term [String] Query tasks by encounter_id, claim_id, task_id, or external_id
-        # @param assigned_to_id [String] Only return tasks assigned to this user
+        # @param assigned_to_id [Commons::USER_ID] Only return tasks assigned to this user
         # @param date_of_service_min [Date] The minimum date of service for the linked encounter
         # @param date_of_service_max [Date] The maximum date of service for the linked encounter
         # @param billing_provider_npi [String] The NPI of the billing provider associated with the task's claim
-        # @param sort [CandidApiClient::Tasks::V3::Types::TaskSortOptions] Defaults to updated_at:desc
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::TaskPage]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get_multi
+        # @param sort [Tasks::V3::TaskSortOptions] Defaults to updated_at:desc
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::TaskPage]
         def get_multi(limit: nil, page_token: nil, status: nil, task_type: nil, categories: nil, updated_since: nil,
                       encounter_id: nil, search_term: nil, assigned_to_id: nil, date_of_service_min: nil, date_of_service_max: nil, billing_provider_npi: nil, sort: nil, request_options: nil)
-          response = @request_client.conn.get do |req|
+          response = @request_client.conn.get("/api/tasks/v3") do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "limit": limit,
@@ -90,149 +78,106 @@ module CandidApiClient
               "billing_provider_npi": billing_provider_npi,
               "sort": sort
             }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi, request_options: request_options)}/api/tasks/v3"
           end
-          CandidApiClient::Tasks::V3::Types::TaskPage.from_json(json_object: response.body)
+          Tasks::V3::TaskPage.from_json(json_object: response.body)
         end
 
-        # @param task_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @param task_id [Commons::TASK_ID]
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def get(task_id:, request_options: nil)
-          response = @request_client.conn.get do |req|
+          response = @request_client.conn.get("/api/tasks/v3/#{task_id}") do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi,
-                                               request_options: request_options)}/api/tasks/v3/#{task_id}"
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
           end
-          CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+          Tasks::V3::Task.from_json(json_object: response.body)
         end
 
-        # @param request [Hash] Request of type CandidApiClient::Tasks::V3::Types::TaskCreateV3, as a Hash
-        #   * :encounter_id (String)
-        #   * :task_type (CandidApiClient::Tasks::Commons::Types::TaskType)
+        # @param request [Hash] Request of type Tasks::V3::TaskCreateV3, as a Hash
+        #   * :encounter_id (Commons::ENCOUNTER_ID)
+        #   * :task_type (Tasks::Commons::TaskType)
         #   * :description (String)
         #   * :blocks_claim_submission (Boolean)
-        #   * :assignee_user_id (String)
-        #   * :category (CandidApiClient::Tasks::Commons::Types::TaskCategory)
-        #   * :work_queue_id (String)
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.create(request: { encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", task_type: CUSTOMER_DATA_REQUEST, description: "description", work_queue_id: "work_queue_id" })
+        #   * :assignee_user_id (Commons::USER_ID)
+        #   * :category (Tasks::Commons::TaskCategory)
+        #   * :work_queue_id (Commons::WORK_QUEUE_ID)
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def create(request:, request_options: nil)
-          response = @request_client.conn.post do |req|
+          response = @request_client.conn.post("/api/tasks/v3") do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi, request_options: request_options)}/api/tasks/v3"
           end
-          CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+          Tasks::V3::Task.from_json(json_object: response.body)
         end
 
-        # @param task_id [String]
-        # @param request [Hash] Request of type CandidApiClient::Tasks::V3::Types::TaskUpdateV3, as a Hash
-        #   * :status (CandidApiClient::Tasks::Commons::Types::TaskStatus)
-        #   * :assignee_user_id (String)
+        # @param task_id [Commons::TASK_ID]
+        # @param request [Hash] Request of type Tasks::V3::TaskUpdateV3, as a Hash
+        #   * :status (Tasks::Commons::TaskStatus)
+        #   * :assignee_user_id (Commons::USER_ID)
         #   * :blocks_claim_submission (Boolean)
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.update(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def update(task_id:, request:, request_options: nil)
-          response = @request_client.conn.patch do |req|
+          response = @request_client.conn.patch("/api/tasks/v3/#{task_id}") do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi,
-                                               request_options: request_options)}/api/tasks/v3/#{task_id}"
           end
-          CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+          Tasks::V3::Task.from_json(json_object: response.body)
         end
       end
 
       class AsyncV3Client
-        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [CandidApiClient::AsyncRequestClient]
-        # @return [CandidApiClient::Tasks::V3::AsyncV3Client]
+        # @param request_client [AsyncRequestClient]
+        # @return [Tasks::V3::AsyncV3Client]
         def initialize(request_client:)
+          # @type [AsyncRequestClient]
           @request_client = request_client
         end
 
-        # @param task_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::TaskActions]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get_actions(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @param task_id [Commons::TASK_ID]
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::TaskActions]
         def get_actions(task_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get do |req|
+            response = @request_client.conn.get("/api/tasks/v3/#{task_id}/actions") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/tasks/v3/#{task_id}/actions"
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             end
-            CandidApiClient::Tasks::V3::Types::TaskActions.from_json(json_object: response.body)
+            Tasks::V3::TaskActions.from_json(json_object: response.body)
           end
         end
 
         # @param limit [Integer] Defaults to 100
-        # @param page_token [String]
-        # @param status [CandidApiClient::Tasks::Commons::Types::TaskStatus]
-        # @param task_type [CandidApiClient::Tasks::Commons::Types::TaskType]
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param status [Tasks::Commons::TaskStatus]
+        # @param task_type [Tasks::Commons::TaskType]
         # @param categories [String] Only return tasks with categories that match one in this comma-separated list.
         # @param updated_since [DateTime] Only return tasks updated on or after this date-time
-        # @param encounter_id [String] Only return tasks associated with this encounter
+        # @param encounter_id [Commons::ENCOUNTER_ID] Only return tasks associated with this encounter
         # @param search_term [String] Query tasks by encounter_id, claim_id, task_id, or external_id
-        # @param assigned_to_id [String] Only return tasks assigned to this user
+        # @param assigned_to_id [Commons::USER_ID] Only return tasks assigned to this user
         # @param date_of_service_min [Date] The minimum date of service for the linked encounter
         # @param date_of_service_max [Date] The maximum date of service for the linked encounter
         # @param billing_provider_npi [String] The NPI of the billing provider associated with the task's claim
-        # @param sort [CandidApiClient::Tasks::V3::Types::TaskSortOptions] Defaults to updated_at:desc
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::TaskPage]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get_multi
+        # @param sort [Tasks::V3::TaskSortOptions] Defaults to updated_at:desc
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::TaskPage]
         def get_multi(limit: nil, page_token: nil, status: nil, task_type: nil, categories: nil, updated_since: nil,
                       encounter_id: nil, search_term: nil, assigned_to_id: nil, date_of_service_min: nil, date_of_service_max: nil, billing_provider_npi: nil, sort: nil, request_options: nil)
           Async do
-            response = @request_client.conn.get do |req|
+            response = @request_client.conn.get("/api/tasks/v3") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
                 "limit": limit,
@@ -249,92 +194,63 @@ module CandidApiClient
                 "billing_provider_npi": billing_provider_npi,
                 "sort": sort
               }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/tasks/v3"
             end
-            CandidApiClient::Tasks::V3::Types::TaskPage.from_json(json_object: response.body)
+            Tasks::V3::TaskPage.from_json(json_object: response.body)
           end
         end
 
-        # @param task_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.get(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @param task_id [Commons::TASK_ID]
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def get(task_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get do |req|
+            response = @request_client.conn.get("/api/tasks/v3/#{task_id}") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/tasks/v3/#{task_id}"
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             end
-            CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+            Tasks::V3::Task.from_json(json_object: response.body)
           end
         end
 
-        # @param request [Hash] Request of type CandidApiClient::Tasks::V3::Types::TaskCreateV3, as a Hash
-        #   * :encounter_id (String)
-        #   * :task_type (CandidApiClient::Tasks::Commons::Types::TaskType)
+        # @param request [Hash] Request of type Tasks::V3::TaskCreateV3, as a Hash
+        #   * :encounter_id (Commons::ENCOUNTER_ID)
+        #   * :task_type (Tasks::Commons::TaskType)
         #   * :description (String)
         #   * :blocks_claim_submission (Boolean)
-        #   * :assignee_user_id (String)
-        #   * :category (CandidApiClient::Tasks::Commons::Types::TaskCategory)
-        #   * :work_queue_id (String)
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.create(request: { encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", task_type: CUSTOMER_DATA_REQUEST, description: "description", work_queue_id: "work_queue_id" })
+        #   * :assignee_user_id (Commons::USER_ID)
+        #   * :category (Tasks::Commons::TaskCategory)
+        #   * :work_queue_id (Commons::WORK_QUEUE_ID)
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def create(request:, request_options: nil)
           Async do
-            response = @request_client.conn.post do |req|
+            response = @request_client.conn.post("/api/tasks/v3") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
               req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/tasks/v3"
             end
-            CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+            Tasks::V3::Task.from_json(json_object: response.body)
           end
         end
 
-        # @param task_id [String]
-        # @param request [Hash] Request of type CandidApiClient::Tasks::V3::Types::TaskUpdateV3, as a Hash
-        #   * :status (CandidApiClient::Tasks::Commons::Types::TaskStatus)
-        #   * :assignee_user_id (String)
+        # @param task_id [Commons::TASK_ID]
+        # @param request [Hash] Request of type Tasks::V3::TaskUpdateV3, as a Hash
+        #   * :status (Tasks::Commons::TaskStatus)
+        #   * :assignee_user_id (Commons::USER_ID)
         #   * :blocks_claim_submission (Boolean)
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::Tasks::V3::Types::Task]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.tasks.v_3.update(task_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })
+        # @param request_options [RequestOptions]
+        # @return [Tasks::V3::Task]
         def update(task_id:, request:, request_options: nil)
           Async do
-            response = @request_client.conn.patch do |req|
+            response = @request_client.conn.patch("/api/tasks/v3/#{task_id}") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
               req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/tasks/v3/#{task_id}"
             end
-            CandidApiClient::Tasks::V3::Types::Task.from_json(json_object: response.body)
+            Tasks::V3::Task.from_json(json_object: response.body)
           end
         end
       end