candidhealth 0.17.1

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

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../commons/types/patient_external_id"
+require_relative "../../commons/types/claim_id"
+require_relative "../../commons/types/service_line_id"
+require_relative "../../commons/types/provider_id"
+require_relative "../../commons/types/invoice_id"
+require_relative "../../financials/types/patient_transaction_source"
+require_relative "types/patient_refund_sort_field"
+require_relative "../../commons/types/sort_direction"
+require_relative "../../commons/types/page_token"
+require_relative "types/patient_refunds_page"
+require_relative "types/patient_refund_id"
+require_relative "types/patient_refund"
+require "date"
+require_relative "../../financials/types/allocation_create"
+require_relative "../../financials/types/refund_reason"
+require_relative "../../financials/types/note_update"
+require_relative "../../financials/types/invoice_update"
+require_relative "../../financials/types/refund_reason_update"
+require "async"
+
+module CandidApiClient
+  module PatientRefunds
+    module V1
+      class V1Client
+        attr_reader :request_client
+
+        # @param request_client [RequestClient]
+        # @return [PatientRefunds::V1::V1Client]
+        def initialize(request_client:)
+          # @type [RequestClient]
+          @request_client = request_client
+        end
+
+        # Returns all patient refunds satisfying the search criteria AND whose organization_id matches
+        # the current organization_id of the authenticated user.
+        #
+        # @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 claim_id [Commons::CLAIM_ID]
+        # @param service_line_id [Commons::SERVICE_LINE_ID]
+        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
+        # @param invoice_id [Commons::INVOICE_ID]
+        # @param sources [Financials::PatientTransactionSource]
+        # @param sort [PatientRefunds::V1::PatientRefundSortField] Defaults to refund_timestamp
+        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefundsPage]
+        def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
+                      billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
+          response = @request_client.conn.get("/api/patient-refunds/v1") 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.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "limit": limit,
+              "patient_external_id": patient_external_id,
+              "claim_id": claim_id,
+              "service_line_id": service_line_id,
+              "billing_provider_id": billing_provider_id,
+              "unattributed": unattributed,
+              "invoice_id": invoice_id,
+              "sources": sources,
+              "sort": sort,
+              "sort_direction": sort_direction,
+              "page_token": page_token
+            }.compact
+          end
+          PatientRefunds::V1::PatientRefundsPage.from_json(json_object: response.body)
+        end
+
+        # Retrieves a previously created patient refund by its `patient_refund_id`.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def get(patient_refund_id:, request_options: nil)
+          response = @request_client.conn.get("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+          end
+          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+        end
+
+        # Creates a new patient refund record and returns the newly created PatientRefund object.
+        # The allocations can describe whether the refund is being applied toward a specific service line,
+        # claim, or billing provider.
+        #
+        # @param amount_cents [Integer]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [String]
+        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
+        # @param allocations [Array<Hash>] Request of type Array<Financials::AllocationCreate>, as a Hash
+        #   * :amount_cents (Integer)
+        #   * :target (Hash)
+        # @param invoice [Commons::INVOICE_ID]
+        # @param refund_reason [Financials::RefundReason]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
+                   invoice: nil, refund_reason: nil, request_options: nil)
+          response = @request_client.conn.post("/api/patient-refunds/v1") 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.body = {
+              **(request_options&.additional_body_parameters || {}),
+              amount_cents: amount_cents,
+              refund_timestamp: refund_timestamp,
+              refund_note: refund_note,
+              patient_external_id: patient_external_id,
+              allocations: allocations,
+              invoice: invoice,
+              refund_reason: refund_reason
+            }.compact
+          end
+          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+        end
+
+        # Updates the patient refund record matching the provided patient_refund_id.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [Financials::NoteUpdate]
+        # @param invoice [Financials::InvoiceUpdate]
+        # @param refund_reason [Financials::RefundReasonUpdate]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
+                   request_options: nil)
+          response = @request_client.conn.patch("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              refund_timestamp: refund_timestamp,
+              refund_note: refund_note,
+              invoice: invoice,
+              refund_reason: refund_reason
+            }.compact
+          end
+          PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+        end
+
+        # Deletes the patient refund record matching the provided patient_refund_id.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param request_options [RequestOptions]
+        # @return [Void]
+        def delete(patient_refund_id:, request_options: nil)
+          @request_client.conn.delete("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+          end
+        end
+      end
+
+      class AsyncV1Client
+        attr_reader :request_client
+
+        # @param request_client [AsyncRequestClient]
+        # @return [PatientRefunds::V1::AsyncV1Client]
+        def initialize(request_client:)
+          # @type [AsyncRequestClient]
+          @request_client = request_client
+        end
+
+        # Returns all patient refunds satisfying the search criteria AND whose organization_id matches
+        # the current organization_id of the authenticated user.
+        #
+        # @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 claim_id [Commons::CLAIM_ID]
+        # @param service_line_id [Commons::SERVICE_LINE_ID]
+        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
+        # @param invoice_id [Commons::INVOICE_ID]
+        # @param sources [Financials::PatientTransactionSource]
+        # @param sort [PatientRefunds::V1::PatientRefundSortField] Defaults to refund_timestamp
+        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefundsPage]
+        def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
+                      billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/patient-refunds/v1") 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.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "limit": limit,
+                "patient_external_id": patient_external_id,
+                "claim_id": claim_id,
+                "service_line_id": service_line_id,
+                "billing_provider_id": billing_provider_id,
+                "unattributed": unattributed,
+                "invoice_id": invoice_id,
+                "sources": sources,
+                "sort": sort,
+                "sort_direction": sort_direction,
+                "page_token": page_token
+              }.compact
+            end
+            PatientRefunds::V1::PatientRefundsPage.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieves a previously created patient refund by its `patient_refund_id`.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def get(patient_refund_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+            end
+            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Creates a new patient refund record and returns the newly created PatientRefund object.
+        # The allocations can describe whether the refund is being applied toward a specific service line,
+        # claim, or billing provider.
+        #
+        # @param amount_cents [Integer]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [String]
+        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
+        # @param allocations [Array<Hash>] Request of type Array<Financials::AllocationCreate>, as a Hash
+        #   * :amount_cents (Integer)
+        #   * :target (Hash)
+        # @param invoice [Commons::INVOICE_ID]
+        # @param refund_reason [Financials::RefundReason]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
+                   invoice: nil, refund_reason: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.post("/api/patient-refunds/v1") 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.body = {
+                **(request_options&.additional_body_parameters || {}),
+                amount_cents: amount_cents,
+                refund_timestamp: refund_timestamp,
+                refund_note: refund_note,
+                patient_external_id: patient_external_id,
+                allocations: allocations,
+                invoice: invoice,
+                refund_reason: refund_reason
+              }.compact
+            end
+            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Updates the patient refund record matching the provided patient_refund_id.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [Financials::NoteUpdate]
+        # @param invoice [Financials::InvoiceUpdate]
+        # @param refund_reason [Financials::RefundReasonUpdate]
+        # @param request_options [RequestOptions]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
+                   request_options: nil)
+          Async do
+            response = @request_client.conn.patch("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+              req.body = {
+                **(request_options&.additional_body_parameters || {}),
+                refund_timestamp: refund_timestamp,
+                refund_note: refund_note,
+                invoice: invoice,
+                refund_reason: refund_reason
+              }.compact
+            end
+            PatientRefunds::V1::PatientRefund.from_json(json_object: response.body)
+          end
+        end
+
+        # Deletes the patient refund record matching the provided patient_refund_id.
+        #
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param request_options [RequestOptions]
+        # @return [Void]
+        def delete(patient_refund_id:, request_options: nil)
+          Async do
+            @request_client.conn.delete("/api/patient-refunds/v1/#{patient_refund_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_options&.additional_headers || {}) }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_refunds/v_1/types/patient_refund.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative "patient_refund_id"
+require_relative "../../../commons/types/organization_id"
+require_relative "../../../financials/types/patient_transaction_source"
+require_relative "../../../commons/types/patient_external_id"
+require "date"
+require_relative "../../../financials/types/allocation"
+require_relative "../../../commons/types/invoice_id"
+require_relative "../../../financials/types/refund_reason"
+require "json"
+
+module CandidApiClient
+  module PatientRefunds
+    module V1
+      class PatientRefund
+        attr_reader :patient_refund_id, :organization_id, :source_internal_id, :refund_source, :amount_cents,
+                    :patient_external_id, :refund_timestamp, :refund_note, :allocations, :invoice, :refund_reason, :additional_properties
+
+        # @param patient_refund_id [PatientRefunds::V1::PATIENT_REFUND_ID]
+        # @param organization_id [Commons::ORGANIZATION_ID]
+        # @param source_internal_id [String]
+        # @param refund_source [Financials::PatientTransactionSource]
+        # @param amount_cents [Integer]
+        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
+        # @param refund_timestamp [DateTime]
+        # @param refund_note [String]
+        # @param allocations [Array<Financials::Allocation>]
+        # @param invoice [Commons::INVOICE_ID]
+        # @param refund_reason [Financials::RefundReason]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [PatientRefunds::V1::PatientRefund]
+        def initialize(patient_refund_id:, organization_id:, refund_source:, amount_cents:, patient_external_id:,
+                       allocations:, source_internal_id: nil, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil, additional_properties: nil)
+          # @type [PatientRefunds::V1::PATIENT_REFUND_ID]
+          @patient_refund_id = patient_refund_id
+          # @type [Commons::ORGANIZATION_ID]
+          @organization_id = organization_id
+          # @type [String]
+          @source_internal_id = source_internal_id
+          # @type [Financials::PatientTransactionSource]
+          @refund_source = refund_source
+          # @type [Integer]
+          @amount_cents = amount_cents
+          # @type [Commons::PATIENT_EXTERNAL_ID]
+          @patient_external_id = patient_external_id
+          # @type [DateTime]
+          @refund_timestamp = refund_timestamp
+          # @type [String]
+          @refund_note = refund_note
+          # @type [Array<Financials::Allocation>]
+          @allocations = allocations
+          # @type [Commons::INVOICE_ID]
+          @invoice = invoice
+          # @type [Financials::RefundReason]
+          @refund_reason = refund_reason
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of PatientRefund
+        #
+        # @param json_object [JSON]
+        # @return [PatientRefunds::V1::PatientRefund]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          patient_refund_id = struct.patient_refund_id
+          organization_id = struct.organization_id
+          source_internal_id = struct.source_internal_id
+          refund_source = struct.refund_source
+          amount_cents = struct.amount_cents
+          patient_external_id = struct.patient_external_id
+          refund_timestamp = unless parsed_json["refund_timestamp"].nil?
+                               DateTime.parse(parsed_json["refund_timestamp"])
+                             end
+          refund_note = struct.refund_note
+          allocations = parsed_json["allocations"]&.map do |v|
+            v = v.to_json
+            Financials::Allocation.from_json(json_object: v)
+          end
+          invoice = struct.invoice
+          refund_reason = struct.refund_reason
+          new(patient_refund_id: patient_refund_id, organization_id: organization_id,
+              source_internal_id: source_internal_id, refund_source: refund_source, amount_cents: amount_cents, patient_external_id: patient_external_id, refund_timestamp: refund_timestamp, refund_note: refund_note, allocations: allocations, invoice: invoice, refund_reason: refund_reason, additional_properties: struct)
+        end
+
+        # Serialize an instance of PatientRefund to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "patient_refund_id": @patient_refund_id,
+            "organization_id": @organization_id,
+            "source_internal_id": @source_internal_id,
+            "refund_source": @refund_source,
+            "amount_cents": @amount_cents,
+            "patient_external_id": @patient_external_id,
+            "refund_timestamp": @refund_timestamp,
+            "refund_note": @refund_note,
+            "allocations": @allocations,
+            "invoice": @invoice,
+            "refund_reason": @refund_reason
+          }.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.patient_refund_id.is_a?(String) != false || raise("Passed value for field obj.patient_refund_id is not the expected type, validation failed.")
+          obj.organization_id.is_a?(String) != false || raise("Passed value for field obj.organization_id is not the expected type, validation failed.")
+          obj.source_internal_id&.is_a?(String) != false || raise("Passed value for field obj.source_internal_id is not the expected type, validation failed.")
+          obj.refund_source.is_a?(Financials::PatientTransactionSource) != false || raise("Passed value for field obj.refund_source is not the expected type, validation failed.")
+          obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents is not the expected type, validation failed.")
+          obj.patient_external_id.is_a?(String) != false || raise("Passed value for field obj.patient_external_id is not the expected type, validation failed.")
+          obj.refund_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.refund_timestamp is not the expected type, validation failed.")
+          obj.refund_note&.is_a?(String) != false || raise("Passed value for field obj.refund_note is not the expected type, validation failed.")
+          obj.allocations.is_a?(Array) != false || raise("Passed value for field obj.allocations is not the expected type, validation failed.")
+          obj.invoice&.is_a?(String) != false || raise("Passed value for field obj.invoice is not the expected type, validation failed.")
+          obj.refund_reason&.is_a?(Financials::RefundReason) != false || raise("Passed value for field obj.refund_reason is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_id.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PatientRefunds
+    module V1
+      PATIENT_REFUND_ID = String
+    end
+  end
+end

data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_sort_field.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PatientRefunds
+    module V1
+      class PatientRefundSortField
+        REFUND_SOURCE = "refund_source"
+        AMOUNT_CENTS = "amount_cents"
+        REFUND_TIMESTAMP = "refund_timestamp"
+        REFUND_REASON = "refund_reason"
+        REFUND_NOTE = "refund_note"
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_refunds/v_1/types/patient_refunds_page.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "patient_refund"
+require_relative "../../../commons/types/page_token"
+require "json"
+
+module CandidApiClient
+  module PatientRefunds
+    module V1
+      class PatientRefundsPage
+        attr_reader :items, :prev_page_token, :next_page_token, :additional_properties
+
+        # @param items [Array<PatientRefunds::V1::PatientRefund>]
+        # @param prev_page_token [Commons::PAGE_TOKEN]
+        # @param next_page_token [Commons::PAGE_TOKEN]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [PatientRefunds::V1::PatientRefundsPage]
+        def initialize(items:, prev_page_token: nil, next_page_token: nil, additional_properties: nil)
+          # @type [Array<PatientRefunds::V1::PatientRefund>]
+          @items = items
+          # @type [Commons::PAGE_TOKEN]
+          @prev_page_token = prev_page_token
+          # @type [Commons::PAGE_TOKEN]
+          @next_page_token = next_page_token
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of PatientRefundsPage
+        #
+        # @param json_object [JSON]
+        # @return [PatientRefunds::V1::PatientRefundsPage]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          items = parsed_json["items"]&.map do |v|
+            v = v.to_json
+            PatientRefunds::V1::PatientRefund.from_json(json_object: v)
+          end
+          prev_page_token = struct.prev_page_token
+          next_page_token = struct.next_page_token
+          new(items: items, prev_page_token: prev_page_token, next_page_token: next_page_token,
+              additional_properties: struct)
+        end
+
+        # Serialize an instance of PatientRefundsPage to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          { "items": @items, "prev_page_token": @prev_page_token, "next_page_token": @next_page_token }.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.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+          obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
+          obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/payers/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_3/client"
+
+module CandidApiClient
+  module Payers
+    class Client
+      attr_reader :v_3
+
+      # @param request_client [RequestClient]
+      # @return [Payers::Client]
+      def initialize(request_client:)
+        @v_3 = Payers::V3::V3Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      attr_reader :v_3
+
+      # @param request_client [RequestClient]
+      # @return [Payers::AsyncClient]
+      def initialize(request_client:)
+        @v_3 = Payers::V3::AsyncV3Client.new(request_client: request_client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/payer_uuid"
+require_relative "types/payer"
+require_relative "../../commons/types/page_token"
+require_relative "types/payer_page"
+require "async"
+
+module CandidApiClient
+  module Payers
+    module V3
+      class V3Client
+        attr_reader :request_client
+
+        # @param request_client [RequestClient]
+        # @return [Payers::V3::V3Client]
+        def initialize(request_client:)
+          # @type [RequestClient]
+          @request_client = request_client
+        end
+
+        # @param payer_uuid [Payers::V3::PAYER_String]
+        # @param request_options [RequestOptions]
+        # @return [Payers::V3::Payer]
+        def get(payer_uuid:, request_options: nil)
+          response = @request_client.conn.get("/api/payers/v3/#{payer_uuid}") 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
+          end
+          Payers::V3::Payer.from_json(json_object: response.body)
+        end
+
+        # @param limit [Integer] Maximum number of entities per page, defaults to 100.
+        # @param search_term [String]
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param request_options [RequestOptions]
+        # @return [Payers::V3::PayerPage]
+        def get_all(limit: nil, search_term: nil, page_token: nil, request_options: nil)
+          response = @request_client.conn.get("/api/payers/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_options&.additional_headers || {}) }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "limit": limit,
+              "search_term": search_term,
+              "page_token": page_token
+            }.compact
+          end
+          Payers::V3::PayerPage.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncV3Client
+        attr_reader :request_client
+
+        # @param request_client [AsyncRequestClient]
+        # @return [Payers::V3::AsyncV3Client]
+        def initialize(request_client:)
+          # @type [AsyncRequestClient]
+          @request_client = request_client
+        end
+
+        # @param payer_uuid [Payers::V3::PAYER_String]
+        # @param request_options [RequestOptions]
+        # @return [Payers::V3::Payer]
+        def get(payer_uuid:, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/payers/v3/#{payer_uuid}") 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
+            end
+            Payers::V3::Payer.from_json(json_object: response.body)
+          end
+        end
+
+        # @param limit [Integer] Maximum number of entities per page, defaults to 100.
+        # @param search_term [String]
+        # @param page_token [Commons::PAGE_TOKEN]
+        # @param request_options [RequestOptions]
+        # @return [Payers::V3::PayerPage]
+        def get_all(limit: nil, search_term: nil, page_token: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/payers/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_options&.additional_headers || {}) }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "limit": limit,
+                "search_term": search_term,
+                "page_token": page_token
+              }.compact
+            end
+            Payers::V3::PayerPage.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end