candidhealth 0.20.1 → 0.24.0.pre.2a6d412

data/lib/candidhealth/write_offs/v_1/client.rb

@@ -1,17 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
-require_relative "../../commons/types/patient_external_id"
-require_relative "../../payers/v_3/types/payer_uuid"
-require_relative "../../commons/types/service_line_id"
-require_relative "../../commons/types/claim_id"
-require_relative "../../commons/types/provider_id"
 require_relative "types/write_off_sort_field"
 require_relative "../../commons/types/sort_direction"
-require_relative "../../commons/types/page_token"
 require_relative "../../financials/types/account_type"
 require_relative "types/write_offs_page"
-require_relative "types/write_off_id"
 require_relative "types/write_off"
 require_relative "types/write_off_create"
 require_relative "types/create_write_offs_response"
@@ -21,35 +14,53 @@ module CandidApiClient
   module WriteOffs
     module V1
       class V1Client
+        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [RequestClient]
-        # @return [WriteOffs::V1::V1Client]
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::WriteOffs::V1::V1Client]
         def initialize(request_client:)
-          # @type [RequestClient]
           @request_client = request_client
         end
 
         # Returns all write-offs satisfying the search criteria.
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param payer_uuid [Payers::V3::PAYER_UUID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
-        # @param sort [WriteOffs::V1::WriteOffSortField] Defaults to write_off_timestamp
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param account_types [Financials::AccountType] Filters the returned values to include only the provided account types.
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOffsPage]
+        # @param patient_external_id [String]
+        # @param payer_uuid [String]
+        # @param service_line_id [String]
+        # @param claim_id [String]
+        # @param billing_provider_id [String]
+        # @param sort [CandidApiClient::WriteOffs::V1::Types::WriteOffSortField] Defaults to write_off_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param account_types [CandidApiClient::Financials::Types::AccountType] Filters the returned values to include only the provided account types.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOffsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.get_multi(
+        #    limit: 1,
+        #    patient_external_id: "string",
+        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
+        #    account_types: PATIENT
+        #  )
         def get_multi(limit: nil, patient_external_id: nil, payer_uuid: nil, service_line_id: nil, claim_id: nil,
                       billing_provider_id: nil, sort: nil, sort_direction: nil, page_token: nil, account_types: nil, request_options: nil)
-          response = @request_client.conn.get("/api/write-offs/v1") do |req|
+          response = @request_client.conn.get 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_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "limit": limit,
@@ -63,87 +74,133 @@ module CandidApiClient
               "page_token": page_token,
               "account_types": account_types
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/write-offs/v1"
           end
-          WriteOffs::V1::WriteOffsPage.from_json(json_object: response.body)
+          CandidApiClient::WriteOffs::V1::Types::WriteOffsPage.from_json(json_object: response.body)
         end
 
         # Retrieves a previously created write off by its `write_off_id`.
         #
-        # @param write_off_id [WriteOffs::V1::WRITE_OFF_ID]
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOff]
+        # @param write_off_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOff]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.get(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(write_off_id:, request_options: nil)
-          response = @request_client.conn.get("/api/write-offs/v1/#{write_off_id}") do |req|
+          response = @request_client.conn.get 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_options&.additional_headers || {}) }.compact
+            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/write-offs/v1/#{write_off_id}"
           end
-          WriteOffs::V1::WriteOff.from_json(json_object: response.body)
+          CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
         end
 
-        # Creates one or many write-offs given a specific set of allocations.
-        # The allocations can describe whether the refund is being applied toward a specific service line,
-        # claim, or billing provider.
+        # Creates one or many write-offs applied toward a specific service line,
+        #  claim, or billing provider.
         #
-        # @param write_offs [Array<Hash>] Request of type Array<WriteOffs::V1::WriteOffCreate>, as a Hash
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::CreateWriteOffsResponse]
+        # @param write_offs [Array<Hash>] Request of type Array<CandidApiClient::WriteOffs::V1::Types::WriteOffCreate>, as a Hash
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.create(write_offs: )
         def create(write_offs:, request_options: nil)
-          response = @request_client.conn.post("/api/write-offs/v1") do |req|
+          response = @request_client.conn.post 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_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.body = { **(request_options&.additional_body_parameters || {}), write_offs: write_offs }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/write-offs/v1"
           end
-          WriteOffs::V1::CreateWriteOffsResponse.from_json(json_object: response.body)
+          CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse.from_json(json_object: response.body)
         end
 
         # Reverts a write off given a `write_off_id`.
         #
-        # @param write_off_id [WriteOffs::V1::WRITE_OFF_ID]
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOff]
+        # @param write_off_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOff]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.revert(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def revert(write_off_id:, request_options: nil)
-          response = @request_client.conn.post("/api/write-offs/v1/#{write_off_id}/revert") do |req|
+          response = @request_client.conn.post 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_options&.additional_headers || {}) }.compact
+            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/write-offs/v1/#{write_off_id}/revert"
           end
-          WriteOffs::V1::WriteOff.from_json(json_object: response.body)
+          CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
         end
       end
 
       class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [AsyncRequestClient]
-        # @return [WriteOffs::V1::AsyncV1Client]
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::WriteOffs::V1::AsyncV1Client]
         def initialize(request_client:)
-          # @type [AsyncRequestClient]
           @request_client = request_client
         end
 
         # Returns all write-offs satisfying the search criteria.
         #
         # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param payer_uuid [Payers::V3::PAYER_UUID]
-        # @param service_line_id [Commons::SERVICE_LINE_ID]
-        # @param claim_id [Commons::CLAIM_ID]
-        # @param billing_provider_id [Commons::PROVIDER_ID]
-        # @param sort [WriteOffs::V1::WriteOffSortField] Defaults to write_off_timestamp
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param account_types [Financials::AccountType] Filters the returned values to include only the provided account types.
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOffsPage]
+        # @param patient_external_id [String]
+        # @param payer_uuid [String]
+        # @param service_line_id [String]
+        # @param claim_id [String]
+        # @param billing_provider_id [String]
+        # @param sort [CandidApiClient::WriteOffs::V1::Types::WriteOffSortField] Defaults to write_off_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param account_types [CandidApiClient::Financials::Types::AccountType] Filters the returned values to include only the provided account types.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOffsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.get_multi(
+        #    limit: 1,
+        #    patient_external_id: "string",
+        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
+        #    account_types: PATIENT
+        #  )
         def get_multi(limit: nil, patient_external_id: nil, payer_uuid: nil, service_line_id: nil, claim_id: nil,
                       billing_provider_id: nil, sort: nil, sort_direction: nil, page_token: nil, account_types: nil, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/write-offs/v1") do |req|
+            response = @request_client.conn.get 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_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
                 "limit": limit,
@@ -157,59 +214,87 @@ module CandidApiClient
                 "page_token": page_token,
                 "account_types": account_types
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/write-offs/v1"
             end
-            WriteOffs::V1::WriteOffsPage.from_json(json_object: response.body)
+            CandidApiClient::WriteOffs::V1::Types::WriteOffsPage.from_json(json_object: response.body)
           end
         end
 
         # Retrieves a previously created write off by its `write_off_id`.
         #
-        # @param write_off_id [WriteOffs::V1::WRITE_OFF_ID]
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOff]
+        # @param write_off_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOff]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.get(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(write_off_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/write-offs/v1/#{write_off_id}") do |req|
+            response = @request_client.conn.get 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_options&.additional_headers || {}) }.compact
+              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/write-offs/v1/#{write_off_id}"
             end
-            WriteOffs::V1::WriteOff.from_json(json_object: response.body)
+            CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
           end
         end
 
-        # Creates one or many write-offs given a specific set of allocations.
-        # The allocations can describe whether the refund is being applied toward a specific service line,
-        # claim, or billing provider.
+        # Creates one or many write-offs applied toward a specific service line,
+        #  claim, or billing provider.
         #
-        # @param write_offs [Array<Hash>] Request of type Array<WriteOffs::V1::WriteOffCreate>, as a Hash
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::CreateWriteOffsResponse]
+        # @param write_offs [Array<Hash>] Request of type Array<CandidApiClient::WriteOffs::V1::Types::WriteOffCreate>, as a Hash
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.create(write_offs: )
         def create(write_offs:, request_options: nil)
           Async do
-            response = @request_client.conn.post("/api/write-offs/v1") do |req|
+            response = @request_client.conn.post 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_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.body = { **(request_options&.additional_body_parameters || {}), write_offs: write_offs }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/write-offs/v1"
             end
-            WriteOffs::V1::CreateWriteOffsResponse.from_json(json_object: response.body)
+            CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse.from_json(json_object: response.body)
           end
         end
 
         # Reverts a write off given a `write_off_id`.
         #
-        # @param write_off_id [WriteOffs::V1::WRITE_OFF_ID]
-        # @param request_options [RequestOptions]
-        # @return [WriteOffs::V1::WriteOff]
+        # @param write_off_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::WriteOffs::V1::Types::WriteOff]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.write_offs.v_1.revert(write_off_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def revert(write_off_id:, request_options: nil)
           Async do
-            response = @request_client.conn.post("/api/write-offs/v1/#{write_off_id}/revert") do |req|
+            response = @request_client.conn.post 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_options&.additional_headers || {}) }.compact
+              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/write-offs/v1/#{write_off_id}/revert"
             end
-            WriteOffs::V1::WriteOff.from_json(json_object: response.body)
+            CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: response.body)
           end
         end
       end

data/lib/candidhealth/write_offs/v_1/types/create_write_offs_response.rb

@@ -1,51 +1,63 @@
 # frozen_string_literal: true
 
 require_relative "write_off"
+require "ostruct"
 require "json"
 
 module CandidApiClient
   module WriteOffs
     module V1
-      class CreateWriteOffsResponse
-        attr_reader :write_offs, :additional_properties
+      module Types
+        class CreateWriteOffsResponse
+          # @return [Array<CandidApiClient::WriteOffs::V1::Types::WriteOff>]
+          attr_reader :write_offs
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
 
-        # @param write_offs [Array<WriteOffs::V1::WriteOff>]
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [WriteOffs::V1::CreateWriteOffsResponse]
-        def initialize(write_offs:, additional_properties: nil)
-          # @type [Array<WriteOffs::V1::WriteOff>]
-          @write_offs = write_offs
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
+          OMIT = Object.new
 
-        # Deserialize a JSON object to an instance of CreateWriteOffsResponse
-        #
-        # @param json_object [JSON]
-        # @return [WriteOffs::V1::CreateWriteOffsResponse]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          write_offs = parsed_json["write_offs"]&.map do |v|
-            v = v.to_json
-            WriteOffs::V1::WriteOff.from_json(json_object: v)
+          # @param write_offs [Array<CandidApiClient::WriteOffs::V1::Types::WriteOff>]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse]
+          def initialize(write_offs:, additional_properties: nil)
+            @write_offs = write_offs
+            @additional_properties = additional_properties
+            @_field_set = { "write_offs": write_offs }
           end
-          new(write_offs: write_offs, additional_properties: struct)
-        end
 
-        # Serialize an instance of CreateWriteOffsResponse to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          { "write_offs": @write_offs }.to_json
-        end
+          # Deserialize a JSON object to an instance of CreateWriteOffsResponse
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::WriteOffs::V1::Types::CreateWriteOffsResponse]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            write_offs = parsed_json["write_offs"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::WriteOffs::V1::Types::WriteOff.from_json(json_object: item)
+            end
+            new(write_offs: write_offs, additional_properties: struct)
+          end
 
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.write_offs.is_a?(Array) != false || raise("Passed value for field obj.write_offs is not the expected type, validation failed.")
+          # Serialize an instance of CreateWriteOffsResponse to a JSON object
+          #
+          # @return [String]
+          def to_json(*_args)
+            @_field_set&.to_json
+          end
+
+          # Leveraged for Union-type generation, validate_raw attempts to parse the given
+          #  hash and check each fields type against the current object's property
+          #  definitions.
+          #
+          # @param obj [Object]
+          # @return [Void]
+          def self.validate_raw(obj:)
+            obj.write_offs.is_a?(Array) != false || raise("Passed value for field obj.write_offs is not the expected type, validation failed.")
+          end
         end
       end
     end