candidhealth 0.25.0 → 0.26.1

data/lib/candidhealth/service_lines/v_2/types/service_line_update.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "../../../commons/types/procedure_modifier"
-require_relative "service_line_adjustment"
 require_relative "service_line_denial_reason"
 require_relative "../../../commons/types/facility_type_code"
 require_relative "../../../commons/types/service_line_units"
@@ -20,20 +19,6 @@ module CandidApiClient
           attr_reader :modifiers
           # @return [Integer]
           attr_reader :charge_amount_cents
-          # @return [Integer]
-          attr_reader :allowed_amount_cents
-          # @return [Integer]
-          attr_reader :insurance_balance_cents
-          # @return [Integer]
-          attr_reader :patient_balance_cents
-          # @return [Integer]
-          attr_reader :primary_paid_amount_cents
-          # @return [Integer]
-          attr_reader :secondary_paid_amount_cents
-          # @return [Integer]
-          attr_reader :tertiary_paid_amount_cents
-          # @return [Integer]
-          attr_reader :patient_responsibility_cents
           # @return [String]
           attr_reader :diagnosis_id_zero
           # @return [String]
@@ -42,14 +27,10 @@ module CandidApiClient
           attr_reader :diagnosis_id_two
           # @return [String]
           attr_reader :diagnosis_id_three
-          # @return [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineAdjustment>]
-          attr_reader :service_line_manual_adjustments
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineDenialReason]
           attr_reader :denial_reason
           # @return [CandidApiClient::Commons::Types::FacilityTypeCode]
           attr_reader :place_of_service_code
-          # @return [CandidApiClient::Commons::Types::FacilityTypeCode]
-          attr_reader :place_of_service_code_as_submitted
           # @return [CandidApiClient::Commons::Types::ServiceLineUnits]
           attr_reader :units
           # @return [String]
@@ -77,21 +58,12 @@ module CandidApiClient
           # @param edit_reason [String]
           # @param modifiers [Array<CandidApiClient::Commons::Types::ProcedureModifier>]
           # @param charge_amount_cents [Integer]
-          # @param allowed_amount_cents [Integer]
-          # @param insurance_balance_cents [Integer]
-          # @param patient_balance_cents [Integer]
-          # @param primary_paid_amount_cents [Integer]
-          # @param secondary_paid_amount_cents [Integer]
-          # @param tertiary_paid_amount_cents [Integer]
-          # @param patient_responsibility_cents [Integer]
           # @param diagnosis_id_zero [String]
           # @param diagnosis_id_one [String]
           # @param diagnosis_id_two [String]
           # @param diagnosis_id_three [String]
-          # @param service_line_manual_adjustments [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineAdjustment>]
           # @param denial_reason [CandidApiClient::ServiceLines::V2::Types::ServiceLineDenialReason]
           # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode]
-          # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode]
           # @param units [CandidApiClient::Commons::Types::ServiceLineUnits]
           # @param procedure_code [String]
           # @param quantity [String] String representation of a Decimal that can be parsed by most libraries.
@@ -104,30 +76,17 @@ module CandidApiClient
           # @param end_date_of_service [Date]
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineUpdate]
-          def initialize(edit_reason: OMIT, modifiers: OMIT, charge_amount_cents: OMIT, allowed_amount_cents: OMIT,
-                         insurance_balance_cents: OMIT, patient_balance_cents: OMIT, primary_paid_amount_cents: OMIT, secondary_paid_amount_cents: OMIT, tertiary_paid_amount_cents: OMIT, patient_responsibility_cents: OMIT, diagnosis_id_zero: OMIT, diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, service_line_manual_adjustments: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, units: OMIT, procedure_code: OMIT, quantity: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, additional_properties: nil)
+          def initialize(edit_reason: OMIT, modifiers: OMIT, charge_amount_cents: OMIT, diagnosis_id_zero: OMIT,
+                         diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, units: OMIT, procedure_code: OMIT, quantity: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, additional_properties: nil)
             @edit_reason = edit_reason if edit_reason != OMIT
             @modifiers = modifiers if modifiers != OMIT
             @charge_amount_cents = charge_amount_cents if charge_amount_cents != OMIT
-            @allowed_amount_cents = allowed_amount_cents if allowed_amount_cents != OMIT
-            @insurance_balance_cents = insurance_balance_cents if insurance_balance_cents != OMIT
-            @patient_balance_cents = patient_balance_cents if patient_balance_cents != OMIT
-            @primary_paid_amount_cents = primary_paid_amount_cents if primary_paid_amount_cents != OMIT
-            @secondary_paid_amount_cents = secondary_paid_amount_cents if secondary_paid_amount_cents != OMIT
-            @tertiary_paid_amount_cents = tertiary_paid_amount_cents if tertiary_paid_amount_cents != OMIT
-            @patient_responsibility_cents = patient_responsibility_cents if patient_responsibility_cents != OMIT
             @diagnosis_id_zero = diagnosis_id_zero if diagnosis_id_zero != OMIT
             @diagnosis_id_one = diagnosis_id_one if diagnosis_id_one != OMIT
             @diagnosis_id_two = diagnosis_id_two if diagnosis_id_two != OMIT
             @diagnosis_id_three = diagnosis_id_three if diagnosis_id_three != OMIT
-            if service_line_manual_adjustments != OMIT
-              @service_line_manual_adjustments = service_line_manual_adjustments
-            end
             @denial_reason = denial_reason if denial_reason != OMIT
             @place_of_service_code = place_of_service_code if place_of_service_code != OMIT
-            if place_of_service_code_as_submitted != OMIT
-              @place_of_service_code_as_submitted = place_of_service_code_as_submitted
-            end
             @units = units if units != OMIT
             @procedure_code = procedure_code if procedure_code != OMIT
             @quantity = quantity if quantity != OMIT
@@ -139,21 +98,12 @@ module CandidApiClient
               "edit_reason": edit_reason,
               "modifiers": modifiers,
               "charge_amount_cents": charge_amount_cents,
-              "allowed_amount_cents": allowed_amount_cents,
-              "insurance_balance_cents": insurance_balance_cents,
-              "patient_balance_cents": patient_balance_cents,
-              "primary_paid_amount_cents": primary_paid_amount_cents,
-              "secondary_paid_amount_cents": secondary_paid_amount_cents,
-              "tertiary_paid_amount_cents": tertiary_paid_amount_cents,
-              "patient_responsibility_cents": patient_responsibility_cents,
               "diagnosis_id_zero": diagnosis_id_zero,
               "diagnosis_id_one": diagnosis_id_one,
               "diagnosis_id_two": diagnosis_id_two,
               "diagnosis_id_three": diagnosis_id_three,
-              "service_line_manual_adjustments": service_line_manual_adjustments,
               "denial_reason": denial_reason,
               "place_of_service_code": place_of_service_code,
-              "place_of_service_code_as_submitted": place_of_service_code_as_submitted,
               "units": units,
               "procedure_code": procedure_code,
               "quantity": quantity,
@@ -175,21 +125,10 @@ module CandidApiClient
             edit_reason = struct["edit_reason"]
             modifiers = struct["modifiers"]
             charge_amount_cents = struct["charge_amount_cents"]
-            allowed_amount_cents = struct["allowed_amount_cents"]
-            insurance_balance_cents = struct["insurance_balance_cents"]
-            patient_balance_cents = struct["patient_balance_cents"]
-            primary_paid_amount_cents = struct["primary_paid_amount_cents"]
-            secondary_paid_amount_cents = struct["secondary_paid_amount_cents"]
-            tertiary_paid_amount_cents = struct["tertiary_paid_amount_cents"]
-            patient_responsibility_cents = struct["patient_responsibility_cents"]
             diagnosis_id_zero = struct["diagnosis_id_zero"]
             diagnosis_id_one = struct["diagnosis_id_one"]
             diagnosis_id_two = struct["diagnosis_id_two"]
             diagnosis_id_three = struct["diagnosis_id_three"]
-            service_line_manual_adjustments = parsed_json["service_line_manual_adjustments"]&.map do |item|
-              item = item.to_json
-              CandidApiClient::ServiceLines::V2::Types::ServiceLineAdjustment.from_json(json_object: item)
-            end
             if parsed_json["denial_reason"].nil?
               denial_reason = nil
             else
@@ -197,7 +136,6 @@ module CandidApiClient
               denial_reason = CandidApiClient::ServiceLines::V2::Types::ServiceLineDenialReason.from_json(json_object: denial_reason)
             end
             place_of_service_code = struct["place_of_service_code"]
-            place_of_service_code_as_submitted = struct["place_of_service_code_as_submitted"]
             units = struct["units"]
             procedure_code = struct["procedure_code"]
             quantity = struct["quantity"]
@@ -210,21 +148,12 @@ module CandidApiClient
               edit_reason: edit_reason,
               modifiers: modifiers,
               charge_amount_cents: charge_amount_cents,
-              allowed_amount_cents: allowed_amount_cents,
-              insurance_balance_cents: insurance_balance_cents,
-              patient_balance_cents: patient_balance_cents,
-              primary_paid_amount_cents: primary_paid_amount_cents,
-              secondary_paid_amount_cents: secondary_paid_amount_cents,
-              tertiary_paid_amount_cents: tertiary_paid_amount_cents,
-              patient_responsibility_cents: patient_responsibility_cents,
               diagnosis_id_zero: diagnosis_id_zero,
               diagnosis_id_one: diagnosis_id_one,
               diagnosis_id_two: diagnosis_id_two,
               diagnosis_id_three: diagnosis_id_three,
-              service_line_manual_adjustments: service_line_manual_adjustments,
               denial_reason: denial_reason,
               place_of_service_code: place_of_service_code,
-              place_of_service_code_as_submitted: place_of_service_code_as_submitted,
               units: units,
               procedure_code: procedure_code,
               quantity: quantity,
@@ -252,21 +181,12 @@ module CandidApiClient
             obj.edit_reason&.is_a?(String) != false || raise("Passed value for field obj.edit_reason is not the expected type, validation failed.")
             obj.modifiers&.is_a?(Array) != false || raise("Passed value for field obj.modifiers is not the expected type, validation failed.")
             obj.charge_amount_cents&.is_a?(Integer) != false || raise("Passed value for field obj.charge_amount_cents is not the expected type, validation failed.")
-            obj.allowed_amount_cents&.is_a?(Integer) != false || raise("Passed value for field obj.allowed_amount_cents is not the expected type, validation failed.")
-            obj.insurance_balance_cents&.is_a?(Integer) != false || raise("Passed value for field obj.insurance_balance_cents is not the expected type, validation failed.")
-            obj.patient_balance_cents&.is_a?(Integer) != false || raise("Passed value for field obj.patient_balance_cents is not the expected type, validation failed.")
-            obj.primary_paid_amount_cents&.is_a?(Integer) != false || raise("Passed value for field obj.primary_paid_amount_cents is not the expected type, validation failed.")
-            obj.secondary_paid_amount_cents&.is_a?(Integer) != false || raise("Passed value for field obj.secondary_paid_amount_cents is not the expected type, validation failed.")
-            obj.tertiary_paid_amount_cents&.is_a?(Integer) != false || raise("Passed value for field obj.tertiary_paid_amount_cents is not the expected type, validation failed.")
-            obj.patient_responsibility_cents&.is_a?(Integer) != false || raise("Passed value for field obj.patient_responsibility_cents is not the expected type, validation failed.")
             obj.diagnosis_id_zero&.is_a?(String) != false || raise("Passed value for field obj.diagnosis_id_zero is not the expected type, validation failed.")
             obj.diagnosis_id_one&.is_a?(String) != false || raise("Passed value for field obj.diagnosis_id_one is not the expected type, validation failed.")
             obj.diagnosis_id_two&.is_a?(String) != false || raise("Passed value for field obj.diagnosis_id_two is not the expected type, validation failed.")
             obj.diagnosis_id_three&.is_a?(String) != false || raise("Passed value for field obj.diagnosis_id_three is not the expected type, validation failed.")
-            obj.service_line_manual_adjustments&.is_a?(Array) != false || raise("Passed value for field obj.service_line_manual_adjustments is not the expected type, validation failed.")
             obj.denial_reason.nil? || CandidApiClient::ServiceLines::V2::Types::ServiceLineDenialReason.validate_raw(obj: obj.denial_reason)
             obj.place_of_service_code&.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
-            obj.place_of_service_code_as_submitted&.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code_as_submitted is not the expected type, validation failed.")
             obj.units&.is_a?(CandidApiClient::Commons::Types::ServiceLineUnits) != false || raise("Passed value for field obj.units is not the expected type, validation failed.")
             obj.procedure_code&.is_a?(String) != false || raise("Passed value for field obj.procedure_code is not the expected type, validation failed.")
             obj.quantity&.is_a?(String) != false || raise("Passed value for field obj.quantity is not the expected type, validation failed.")

data/lib/candidhealth/third_party_payer_payments/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_1/client"
+
+module CandidApiClient
+  module ThirdPartyPayerPayments
+    class Client
+      # @return [CandidApiClient::ThirdPartyPayerPayments::V1::V1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::RequestClient]
+      # @return [CandidApiClient::ThirdPartyPayerPayments::Client]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::ThirdPartyPayerPayments::V1::V1Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [CandidApiClient::ThirdPartyPayerPayments::V1::AsyncV1Client]
+      attr_reader :v_1
+
+      # @param request_client [CandidApiClient::AsyncRequestClient]
+      # @return [CandidApiClient::ThirdPartyPayerPayments::AsyncClient]
+      def initialize(request_client:)
+        @v_1 = CandidApiClient::ThirdPartyPayerPayments::V1::AsyncV1Client.new(request_client: request_client)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,360 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/third_party_payer_payment_sort_field"
+require_relative "../../commons/types/sort_direction"
+require_relative "types/third_party_payer_payments_page"
+require_relative "types/third_party_payer_payment"
+require_relative "types/third_party_payer_payment_create"
+require "date"
+require_relative "../../financials/types/note_update"
+require_relative "../../financials/types/invoice_update"
+require "async"
+
+module CandidApiClient
+  module ThirdPartyPayerPayments
+    module V1
+      class V1Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::V1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all third party payer payments
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param third_party_payer_id [String]
+        # @param check_number [String]
+        # @param invoice_id [String]
+        # @param sort [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentSortField] Defaults to refund_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::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.get_multi(
+        #    limit: 1,
+        #    third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    check_number: "string",
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
+        def get_multi(limit: nil, third_party_payer_id: nil, check_number: nil, invoice_id: 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,
+              "third_party_payer_id": third_party_payer_id,
+              "check_number": check_number,
+              "invoice_id": invoice_id,
+              "sort": sort,
+              "sort_direction": sort_direction,
+              "page_token": page_token
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-payments/v1"
+          end
+          CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage.from_json(json_object: response.body)
+        end
+
+        # Retrieves a previously created third party payer payment by its
+        #  `third_party_payer_payment_id`.
+        #
+        # @param third_party_payer_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.get(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(third_party_payer_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/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+          end
+          CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+        end
+
+        # @param request [Hash] Request of type CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentCreate, as a Hash
+        #   * :third_party_payer_id (String)
+        #   * :amount_cents (Integer)
+        #   * :payment_timestamp (DateTime)
+        #   * :payment_note (String)
+        #   * :check_number (String)
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        #   * :invoice_id (String)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.create(request: { third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", amount_cents: 1, payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), payment_note: "string", check_number: "string", allocations: [{  }], invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" })
+        def create(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-payments/v1"
+          end
+          CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+        end
+
+        # @param third_party_payer_payment_id [String]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice_id [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.update(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        def update(third_party_payer_payment_id:, payment_timestamp: nil, payment_note: nil, invoice_id: 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_id: invoice_id
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+          end
+          CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+        end
+
+        # Deletes the third party payer payment record matching the provided
+        #  `third_party_payer_payment_id`.
+        #
+        # @param third_party_payer_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.third_party_payer_payments.v_1.delete(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(third_party_payer_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/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+          end
+        end
+      end
+
+      class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::AsyncV1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Returns all third party payer payments
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param third_party_payer_id [String]
+        # @param check_number [String]
+        # @param invoice_id [String]
+        # @param sort [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentSortField] Defaults to refund_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::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.get_multi(
+        #    limit: 1,
+        #    third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    check_number: "string",
+        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+        #    sort: AMOUNT_CENTS,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
+        def get_multi(limit: nil, third_party_payer_id: nil, check_number: nil, invoice_id: 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,
+                "third_party_payer_id": third_party_payer_id,
+                "check_number": check_number,
+                "invoice_id": invoice_id,
+                "sort": sort,
+                "sort_direction": sort_direction,
+                "page_token": page_token
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-payments/v1"
+            end
+            CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentsPage.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieves a previously created third party payer payment by its
+        #  `third_party_payer_payment_id`.
+        #
+        # @param third_party_payer_payment_id [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.get(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def get(third_party_payer_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/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+            end
+            CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # @param request [Hash] Request of type CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPaymentCreate, as a Hash
+        #   * :third_party_payer_id (String)
+        #   * :amount_cents (Integer)
+        #   * :payment_timestamp (DateTime)
+        #   * :payment_note (String)
+        #   * :check_number (String)
+        #   * :allocations (Array<CandidApiClient::Financials::Types::AllocationCreate>)
+        #   * :invoice_id (String)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.create(request: { third_party_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", amount_cents: 1, payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), payment_note: "string", check_number: "string", allocations: [{  }], invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" })
+        def create(request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-payments/v1"
+            end
+            CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # @param third_party_payer_payment_id [String]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [CandidApiClient::Financials::Types::NoteUpdate]
+        # @param invoice_id [CandidApiClient::Financials::Types::InvoiceUpdate]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.third_party_payer_payments.v_1.update(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payment_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        def update(third_party_payer_payment_id:, payment_timestamp: nil, payment_note: nil, invoice_id: 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_id: invoice_id
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+            end
+            CandidApiClient::ThirdPartyPayerPayments::V1::Types::ThirdPartyPayerPayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Deletes the third party payer payment record matching the provided
+        #  `third_party_payer_payment_id`.
+        #
+        # @param third_party_payer_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.third_party_payer_payments.v_1.delete(third_party_payer_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def delete(third_party_payer_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/third-party-payer-payments/v1/#{third_party_payer_payment_id}"
+            end
+          end
+        end
+      end
+    end
+  end
+end