candidhealth 0.0.0

data/lib/candidhealth/patient_payments/v_4/client.rb

@@ -0,0 +1,401 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../financials/types/patient_transaction_source"
+require_relative "types/patient_payment_sort_field"
+require_relative "../../commons/types/sort_direction"
+require_relative "types/patient_payments_page"
+require_relative "types/patient_payment"
+require "date"
+require_relative "../../financials/types/allocation_create"
+require_relative "../../financials/types/note_update"
+require_relative "../../financials/types/invoice_update"
+require "async"
+
+module CandidApiClient
+  module PatientPayments
+    module V4
+      class V4Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::PatientPayments::V4::V4Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all patient payments 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 [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
+        # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
+        # @param invoice_id [String]
+        # @param sources [CandidApiClient::Financials::Types::PatientTransactionSource]
+        # @param sort [CandidApiClient::PatientPayments::V4::Types::PatientPaymentSortField] Defaults to payment_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.get_multi
+        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 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.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
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-payments/v4"
+          end
+          CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage.from_json(json_object: response.body)
+        end
+
+        # Retrieves a previously created patient payment by its `patient_payment_id`.
+        #
+        # @param patient_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.get(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(patient_payment_id:, request_options: nil)
+          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_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
+          end
+          CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+        end
+
+        # Creates a new patient payment record and returns the newly created
+        #  PatientPayment object.
+        #  The allocations can describe whether the payment is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
+        #
+        # @param amount_cents [Integer]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [String]
+        # @param patient_external_id [String]
+        # @param allocations [Array<Hash>] Request of type Array<CandidApiClient::Financials::Types::AllocationCreate>, as a Hash
+        #   * :amount_cents (Integer)
+        #   * :target (Hash)
+        # @param invoice [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.create(
+        #    amount_cents: 1,
+        #    patient_external_id: "patient_external_id",
+        #    allocations: [{ amount_cents: 1 }, { amount_cents: 1 }]
+        #  )
+        def create(amount_cents:, patient_external_id:, allocations:, payment_timestamp: nil, payment_note: nil,
+                   invoice: nil, request_options: nil)
+          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_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              amount_cents: amount_cents,
+              payment_timestamp: payment_timestamp,
+              payment_note: payment_note,
+              patient_external_id: patient_external_id,
+              allocations: allocations,
+              invoice: invoice
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-payments/v4"
+          end
+          CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+        end
+
+        # Updates the patient payment record matching the provided patient_payment_id.
+        #
+        # @param patient_payment_id [String]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.update(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def update(patient_payment_id:, payment_timestamp: nil, payment_note: nil, invoice: nil, request_options: nil)
+          response = @request_client.conn.patch 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.body = {
+              **(request_options&.additional_body_parameters || {}),
+              payment_timestamp: payment_timestamp,
+              payment_note: payment_note,
+              invoice: invoice
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
+          end
+          CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+        end
+
+        # Deletes the patient payment record matching the provided patient_payment_id.
+        #
+        # @param patient_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.delete(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(patient_payment_id:, request_options: nil)
+          @request_client.conn.delete 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/patient-payments/v4/#{patient_payment_id}"
+          end
+        end
+      end
+
+      class AsyncV4Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::PatientPayments::V4::AsyncV4Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all patient payments 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 [String]
+        # @param claim_id [String]
+        # @param service_line_id [String]
+        # @param billing_provider_id [String]
+        # @param unattributed [Boolean] returns payments with unattributed allocations if set to true
+        # @param invoice_id [String]
+        # @param sources [CandidApiClient::Financials::Types::PatientTransactionSource]
+        # @param sort [CandidApiClient::PatientPayments::V4::Types::PatientPaymentSortField] Defaults to payment_timestamp
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.get_multi
+        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 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.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
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-payments/v4"
+            end
+            CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieves a previously created patient payment by its `patient_payment_id`.
+        #
+        # @param patient_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.get(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(patient_payment_id:, request_options: nil)
+          Async do
+            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_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
+            end
+            CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Creates a new patient payment record and returns the newly created
+        #  PatientPayment object.
+        #  The allocations can describe whether the payment is being applied toward a
+        #  specific service line,
+        #  claim, or billing provider.
+        #
+        # @param amount_cents [Integer]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [String]
+        # @param patient_external_id [String]
+        # @param allocations [Array<Hash>] Request of type Array<CandidApiClient::Financials::Types::AllocationCreate>, as a Hash
+        #   * :amount_cents (Integer)
+        #   * :target (Hash)
+        # @param invoice [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.create(
+        #    amount_cents: 1,
+        #    patient_external_id: "patient_external_id",
+        #    allocations: [{ amount_cents: 1 }, { amount_cents: 1 }]
+        #  )
+        def create(amount_cents:, patient_external_id:, allocations:, payment_timestamp: nil, payment_note: nil,
+                   invoice: nil, request_options: nil)
+          Async do
+            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_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.body = {
+                **(request_options&.additional_body_parameters || {}),
+                amount_cents: amount_cents,
+                payment_timestamp: payment_timestamp,
+                payment_note: payment_note,
+                patient_external_id: patient_external_id,
+                allocations: allocations,
+                invoice: invoice
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-payments/v4"
+            end
+            CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Updates the patient payment record matching the provided patient_payment_id.
+        #
+        # @param patient_payment_id [String]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.update(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def update(patient_payment_id:, payment_timestamp: nil, payment_note: nil, invoice: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.patch 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.body = {
+                **(request_options&.additional_body_parameters || {}),
+                payment_timestamp: payment_timestamp,
+                payment_note: payment_note,
+                invoice: invoice
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/patient-payments/v4/#{patient_payment_id}"
+            end
+            CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Deletes the patient payment record matching the provided patient_payment_id.
+        #
+        # @param patient_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.patient_payments.v_4.delete(patient_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(patient_payment_id:, request_options: nil)
+          Async do
+            @request_client.conn.delete 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/patient-payments/v4/#{patient_payment_id}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_payments/v_4/types/patient_payment.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require_relative "../../../financials/types/patient_transaction_source"
+require "date"
+require_relative "../../../financials/types/allocation"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientPayments
+    module V4
+      module Types
+        class PatientPayment
+          # @return [String]
+          attr_reader :patient_payment_id
+          # @return [String]
+          attr_reader :organization_id
+          # @return [String]
+          attr_reader :source_internal_id
+          # @return [CandidApiClient::Financials::Types::PatientTransactionSource]
+          attr_reader :payment_source
+          # @return [Integer]
+          attr_reader :amount_cents
+          # @return [String]
+          attr_reader :patient_external_id
+          # @return [DateTime]
+          attr_reader :payment_timestamp
+          # @return [String]
+          attr_reader :payment_note
+          # @return [Array<CandidApiClient::Financials::Types::Allocation>]
+          attr_reader :allocations
+          # @return [String]
+          attr_reader :invoice
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param patient_payment_id [String]
+          # @param organization_id [String]
+          # @param source_internal_id [String]
+          # @param payment_source [CandidApiClient::Financials::Types::PatientTransactionSource]
+          # @param amount_cents [Integer]
+          # @param patient_external_id [String]
+          # @param payment_timestamp [DateTime]
+          # @param payment_note [String]
+          # @param allocations [Array<CandidApiClient::Financials::Types::Allocation>]
+          # @param invoice [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+          def initialize(patient_payment_id:, organization_id:, payment_source:, amount_cents:, patient_external_id:,
+                         allocations:, source_internal_id: OMIT, payment_timestamp: OMIT, payment_note: OMIT, invoice: OMIT, additional_properties: nil)
+            @patient_payment_id = patient_payment_id
+            @organization_id = organization_id
+            @source_internal_id = source_internal_id if source_internal_id != OMIT
+            @payment_source = payment_source
+            @amount_cents = amount_cents
+            @patient_external_id = patient_external_id
+            @payment_timestamp = payment_timestamp if payment_timestamp != OMIT
+            @payment_note = payment_note if payment_note != OMIT
+            @allocations = allocations
+            @invoice = invoice if invoice != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "patient_payment_id": patient_payment_id,
+              "organization_id": organization_id,
+              "source_internal_id": source_internal_id,
+              "payment_source": payment_source,
+              "amount_cents": amount_cents,
+              "patient_external_id": patient_external_id,
+              "payment_timestamp": payment_timestamp,
+              "payment_note": payment_note,
+              "allocations": allocations,
+              "invoice": invoice
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of PatientPayment
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientPayments::V4::Types::PatientPayment]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            patient_payment_id = struct["patient_payment_id"]
+            organization_id = struct["organization_id"]
+            source_internal_id = struct["source_internal_id"]
+            payment_source = struct["payment_source"]
+            amount_cents = struct["amount_cents"]
+            patient_external_id = struct["patient_external_id"]
+            payment_timestamp = unless parsed_json["payment_timestamp"].nil?
+                                  DateTime.parse(parsed_json["payment_timestamp"])
+                                end
+            payment_note = struct["payment_note"]
+            allocations = parsed_json["allocations"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Financials::Types::Allocation.from_json(json_object: item)
+            end
+            invoice = struct["invoice"]
+            new(
+              patient_payment_id: patient_payment_id,
+              organization_id: organization_id,
+              source_internal_id: source_internal_id,
+              payment_source: payment_source,
+              amount_cents: amount_cents,
+              patient_external_id: patient_external_id,
+              payment_timestamp: payment_timestamp,
+              payment_note: payment_note,
+              allocations: allocations,
+              invoice: invoice,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of PatientPayment 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.patient_payment_id.is_a?(String) != false || raise("Passed value for field obj.patient_payment_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.payment_source.is_a?(CandidApiClient::Financials::Types::PatientTransactionSource) != false || raise("Passed value for field obj.payment_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.payment_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.payment_timestamp is not the expected type, validation failed.")
+            obj.payment_note&.is_a?(String) != false || raise("Passed value for field obj.payment_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.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_payments/v_4/types/patient_payment_sort_field.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PatientPayments
+    module V4
+      module Types
+        class PatientPaymentSortField
+          PAYMENT_SOURCE = "payment_source"
+          AMOUNT_CENTS = "amount_cents"
+          PAYMENT_TIMESTAMP = "payment_timestamp"
+          PAYMENT_NOTE = "payment_note"
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/patient_payments/v_4/types/patient_payments_page.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "patient_payment"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PatientPayments
+    module V4
+      module Types
+        class PatientPaymentsPage
+          # @return [Array<CandidApiClient::PatientPayments::V4::Types::PatientPayment>]
+          attr_reader :items
+          # @return [String]
+          attr_reader :prev_page_token
+          # @return [String]
+          attr_reader :next_page_token
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param items [Array<CandidApiClient::PatientPayments::V4::Types::PatientPayment>]
+          # @param prev_page_token [String]
+          # @param next_page_token [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage]
+          def initialize(items:, prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil)
+            @items = items
+            @prev_page_token = prev_page_token if prev_page_token != OMIT
+            @next_page_token = next_page_token if next_page_token != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "items": items,
+              "prev_page_token": prev_page_token,
+              "next_page_token": next_page_token
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of PatientPaymentsPage
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::PatientPayments::V4::Types::PatientPaymentsPage]
+          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 |item|
+              item = item.to_json
+              CandidApiClient::PatientPayments::V4::Types::PatientPayment.from_json(json_object: item)
+            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 PatientPaymentsPage 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.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
+end