candidhealth 0.17.1

data/lib/candidhealth/insurance_cards/v_2/types/insurance_card.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "insurance_card_id"
+require_relative "../../../commons/types/source_of_payment_code"
+require_relative "../../../commons/types/insurance_type_code"
+require "json"
+
+module CandidApiClient
+  module InsuranceCards
+    module V2
+      class InsuranceCard
+        attr_reader :insurance_card_id, :member_id, :payer_name, :payer_id, :rx_bin, :rx_pcn, :image_url_front,
+                    :image_url_back, :group_number, :plan_name, :plan_type, :insurance_type, :additional_properties
+
+        # @param insurance_card_id [InsuranceCards::V2::INSURANCE_CARD_ID]
+        # @param member_id [String]
+        # @param payer_name [String]
+        # @param payer_id [String]
+        # @param rx_bin [String]
+        # @param rx_pcn [String]
+        # @param image_url_front [String]
+        # @param image_url_back [String]
+        # @param group_number [String] Box 11 on the CMS-1500 claim form.
+        # @param plan_name [String] Box 11c on the CMS-1500 claim form.
+        # @param plan_type [Commons::SourceOfPaymentCode]
+        # @param insurance_type [Commons::InsuranceTypeCode]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [InsuranceCards::V2::InsuranceCard]
+        def initialize(insurance_card_id:, member_id:, payer_name:, payer_id:, rx_bin: nil, rx_pcn: nil,
+                       image_url_front: nil, image_url_back: nil, group_number: nil, plan_name: nil, plan_type: nil, insurance_type: nil, additional_properties: nil)
+          # @type [InsuranceCards::V2::INSURANCE_CARD_ID]
+          @insurance_card_id = insurance_card_id
+          # @type [String]
+          @member_id = member_id
+          # @type [String]
+          @payer_name = payer_name
+          # @type [String]
+          @payer_id = payer_id
+          # @type [String]
+          @rx_bin = rx_bin
+          # @type [String]
+          @rx_pcn = rx_pcn
+          # @type [String]
+          @image_url_front = image_url_front
+          # @type [String]
+          @image_url_back = image_url_back
+          # @type [String] Box 11 on the CMS-1500 claim form.
+          @group_number = group_number
+          # @type [String] Box 11c on the CMS-1500 claim form.
+          @plan_name = plan_name
+          # @type [Commons::SourceOfPaymentCode]
+          @plan_type = plan_type
+          # @type [Commons::InsuranceTypeCode]
+          @insurance_type = insurance_type
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InsuranceCard
+        #
+        # @param json_object [JSON]
+        # @return [InsuranceCards::V2::InsuranceCard]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          JSON.parse(json_object)
+          insurance_card_id = struct.insurance_card_id
+          member_id = struct.member_id
+          payer_name = struct.payer_name
+          payer_id = struct.payer_id
+          rx_bin = struct.rx_bin
+          rx_pcn = struct.rx_pcn
+          image_url_front = struct.image_url_front
+          image_url_back = struct.image_url_back
+          group_number = struct.group_number
+          plan_name = struct.plan_name
+          plan_type = struct.plan_type
+          insurance_type = struct.insurance_type
+          new(insurance_card_id: insurance_card_id, member_id: member_id, payer_name: payer_name, payer_id: payer_id,
+              rx_bin: rx_bin, rx_pcn: rx_pcn, image_url_front: image_url_front, image_url_back: image_url_back, group_number: group_number, plan_name: plan_name, plan_type: plan_type, insurance_type: insurance_type, additional_properties: struct)
+        end
+
+        # Serialize an instance of InsuranceCard to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "insurance_card_id": @insurance_card_id,
+            "member_id": @member_id,
+            "payer_name": @payer_name,
+            "payer_id": @payer_id,
+            "rx_bin": @rx_bin,
+            "rx_pcn": @rx_pcn,
+            "image_url_front": @image_url_front,
+            "image_url_back": @image_url_back,
+            "group_number": @group_number,
+            "plan_name": @plan_name,
+            "plan_type": @plan_type,
+            "insurance_type": @insurance_type
+          }.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.insurance_card_id.is_a?(String) != false || raise("Passed value for field obj.insurance_card_id is not the expected type, validation failed.")
+          obj.member_id.is_a?(String) != false || raise("Passed value for field obj.member_id is not the expected type, validation failed.")
+          obj.payer_name.is_a?(String) != false || raise("Passed value for field obj.payer_name is not the expected type, validation failed.")
+          obj.payer_id.is_a?(String) != false || raise("Passed value for field obj.payer_id is not the expected type, validation failed.")
+          obj.rx_bin&.is_a?(String) != false || raise("Passed value for field obj.rx_bin is not the expected type, validation failed.")
+          obj.rx_pcn&.is_a?(String) != false || raise("Passed value for field obj.rx_pcn is not the expected type, validation failed.")
+          obj.image_url_front&.is_a?(String) != false || raise("Passed value for field obj.image_url_front is not the expected type, validation failed.")
+          obj.image_url_back&.is_a?(String) != false || raise("Passed value for field obj.image_url_back is not the expected type, validation failed.")
+          obj.group_number&.is_a?(String) != false || raise("Passed value for field obj.group_number is not the expected type, validation failed.")
+          obj.plan_name&.is_a?(String) != false || raise("Passed value for field obj.plan_name is not the expected type, validation failed.")
+          obj.plan_type&.is_a?(Commons::SourceOfPaymentCode) != false || raise("Passed value for field obj.plan_type is not the expected type, validation failed.")
+          obj.insurance_type&.is_a?(Commons::InsuranceTypeCode) != false || raise("Passed value for field obj.insurance_type is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "../../../commons/types/source_of_payment_code"
+require_relative "../../../commons/types/insurance_type_code"
+require "json"
+
+module CandidApiClient
+  module InsuranceCards
+    module V2
+      class InsuranceCardBase
+        attr_reader :group_number, :plan_name, :plan_type, :insurance_type, :additional_properties
+
+        # @param group_number [String] Box 11 on the CMS-1500 claim form.
+        # @param plan_name [String] Box 11c on the CMS-1500 claim form.
+        # @param plan_type [Commons::SourceOfPaymentCode]
+        # @param insurance_type [Commons::InsuranceTypeCode]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [InsuranceCards::V2::InsuranceCardBase]
+        def initialize(group_number: nil, plan_name: nil, plan_type: nil, insurance_type: nil,
+                       additional_properties: nil)
+          # @type [String] Box 11 on the CMS-1500 claim form.
+          @group_number = group_number
+          # @type [String] Box 11c on the CMS-1500 claim form.
+          @plan_name = plan_name
+          # @type [Commons::SourceOfPaymentCode]
+          @plan_type = plan_type
+          # @type [Commons::InsuranceTypeCode]
+          @insurance_type = insurance_type
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InsuranceCardBase
+        #
+        # @param json_object [JSON]
+        # @return [InsuranceCards::V2::InsuranceCardBase]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          JSON.parse(json_object)
+          group_number = struct.group_number
+          plan_name = struct.plan_name
+          plan_type = struct.plan_type
+          insurance_type = struct.insurance_type
+          new(group_number: group_number, plan_name: plan_name, plan_type: plan_type, insurance_type: insurance_type,
+              additional_properties: struct)
+        end
+
+        # Serialize an instance of InsuranceCardBase to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "group_number": @group_number,
+            "plan_name": @plan_name,
+            "plan_type": @plan_type,
+            "insurance_type": @insurance_type
+          }.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.group_number&.is_a?(String) != false || raise("Passed value for field obj.group_number is not the expected type, validation failed.")
+          obj.plan_name&.is_a?(String) != false || raise("Passed value for field obj.plan_name is not the expected type, validation failed.")
+          obj.plan_type&.is_a?(Commons::SourceOfPaymentCode) != false || raise("Passed value for field obj.plan_type is not the expected type, validation failed.")
+          obj.insurance_type&.is_a?(Commons::InsuranceTypeCode) != false || raise("Passed value for field obj.insurance_type is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_create.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require_relative "../../../commons/types/emr_payer_crosswalk"
+require_relative "../../../commons/types/source_of_payment_code"
+require_relative "../../../commons/types/insurance_type_code"
+require "json"
+
+module CandidApiClient
+  module InsuranceCards
+    module V2
+      class InsuranceCardCreate
+        attr_reader :member_id, :payer_name, :payer_id, :rx_bin, :rx_pcn, :image_url_front, :image_url_back,
+                    :emr_payer_crosswalk, :group_number, :plan_name, :plan_type, :insurance_type, :additional_properties
+
+        # @param member_id [String]
+        # @param payer_name [String]
+        # @param payer_id [String]
+        # @param rx_bin [String]
+        # @param rx_pcn [String]
+        # @param image_url_front [String]
+        # @param image_url_back [String]
+        # @param emr_payer_crosswalk [Commons::EmrPayerCrosswalk]
+        # @param group_number [String] Box 11 on the CMS-1500 claim form.
+        # @param plan_name [String] Box 11c on the CMS-1500 claim form.
+        # @param plan_type [Commons::SourceOfPaymentCode]
+        # @param insurance_type [Commons::InsuranceTypeCode]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [InsuranceCards::V2::InsuranceCardCreate]
+        def initialize(member_id:, payer_name:, payer_id:, rx_bin: nil, rx_pcn: nil, image_url_front: nil,
+                       image_url_back: nil, emr_payer_crosswalk: nil, group_number: nil, plan_name: nil, plan_type: nil, insurance_type: nil, additional_properties: nil)
+          # @type [String]
+          @member_id = member_id
+          # @type [String]
+          @payer_name = payer_name
+          # @type [String]
+          @payer_id = payer_id
+          # @type [String]
+          @rx_bin = rx_bin
+          # @type [String]
+          @rx_pcn = rx_pcn
+          # @type [String]
+          @image_url_front = image_url_front
+          # @type [String]
+          @image_url_back = image_url_back
+          # @type [Commons::EmrPayerCrosswalk]
+          @emr_payer_crosswalk = emr_payer_crosswalk
+          # @type [String] Box 11 on the CMS-1500 claim form.
+          @group_number = group_number
+          # @type [String] Box 11c on the CMS-1500 claim form.
+          @plan_name = plan_name
+          # @type [Commons::SourceOfPaymentCode]
+          @plan_type = plan_type
+          # @type [Commons::InsuranceTypeCode]
+          @insurance_type = insurance_type
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InsuranceCardCreate
+        #
+        # @param json_object [JSON]
+        # @return [InsuranceCards::V2::InsuranceCardCreate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          JSON.parse(json_object)
+          member_id = struct.member_id
+          payer_name = struct.payer_name
+          payer_id = struct.payer_id
+          rx_bin = struct.rx_bin
+          rx_pcn = struct.rx_pcn
+          image_url_front = struct.image_url_front
+          image_url_back = struct.image_url_back
+          emr_payer_crosswalk = struct.emr_payer_crosswalk
+          group_number = struct.group_number
+          plan_name = struct.plan_name
+          plan_type = struct.plan_type
+          insurance_type = struct.insurance_type
+          new(member_id: member_id, payer_name: payer_name, payer_id: payer_id, rx_bin: rx_bin, rx_pcn: rx_pcn,
+              image_url_front: image_url_front, image_url_back: image_url_back, emr_payer_crosswalk: emr_payer_crosswalk, group_number: group_number, plan_name: plan_name, plan_type: plan_type, insurance_type: insurance_type, additional_properties: struct)
+        end
+
+        # Serialize an instance of InsuranceCardCreate to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "member_id": @member_id,
+            "payer_name": @payer_name,
+            "payer_id": @payer_id,
+            "rx_bin": @rx_bin,
+            "rx_pcn": @rx_pcn,
+            "image_url_front": @image_url_front,
+            "image_url_back": @image_url_back,
+            "emr_payer_crosswalk": @emr_payer_crosswalk,
+            "group_number": @group_number,
+            "plan_name": @plan_name,
+            "plan_type": @plan_type,
+            "insurance_type": @insurance_type
+          }.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.member_id.is_a?(String) != false || raise("Passed value for field obj.member_id is not the expected type, validation failed.")
+          obj.payer_name.is_a?(String) != false || raise("Passed value for field obj.payer_name is not the expected type, validation failed.")
+          obj.payer_id.is_a?(String) != false || raise("Passed value for field obj.payer_id is not the expected type, validation failed.")
+          obj.rx_bin&.is_a?(String) != false || raise("Passed value for field obj.rx_bin is not the expected type, validation failed.")
+          obj.rx_pcn&.is_a?(String) != false || raise("Passed value for field obj.rx_pcn is not the expected type, validation failed.")
+          obj.image_url_front&.is_a?(String) != false || raise("Passed value for field obj.image_url_front is not the expected type, validation failed.")
+          obj.image_url_back&.is_a?(String) != false || raise("Passed value for field obj.image_url_back is not the expected type, validation failed.")
+          obj.emr_payer_crosswalk&.is_a?(Commons::EmrPayerCrosswalk) != false || raise("Passed value for field obj.emr_payer_crosswalk is not the expected type, validation failed.")
+          obj.group_number&.is_a?(String) != false || raise("Passed value for field obj.group_number is not the expected type, validation failed.")
+          obj.plan_name&.is_a?(String) != false || raise("Passed value for field obj.plan_name is not the expected type, validation failed.")
+          obj.plan_type&.is_a?(Commons::SourceOfPaymentCode) != false || raise("Passed value for field obj.plan_type is not the expected type, validation failed.")
+          obj.insurance_type&.is_a?(Commons::InsuranceTypeCode) != false || raise("Passed value for field obj.insurance_type is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_id.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module InsuranceCards
+    module V2
+      INSURANCE_CARD_ID = String
+    end
+  end
+end

data/lib/candidhealth/insurance_payments/client.rb

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

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

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../payers/v_3/types/payer_uuid"
+require_relative "../../commons/types/claim_id"
+require_relative "../../commons/types/service_line_id"
+require_relative "../../commons/types/provider_id"
+require_relative "types/insurance_payment_sort_field"
+require_relative "../../commons/types/sort_direction"
+require_relative "../../commons/types/page_token"
+require_relative "types/insurance_payments_page"
+require_relative "types/insurance_payment_id"
+require_relative "types/insurance_payment"
+require_relative "types/insurance_payment_create"
+require "date"
+require_relative "../../financials/types/note_update"
+require "async"
+
+module CandidApiClient
+  module InsurancePayments
+    module V1
+      class V1Client
+        attr_reader :request_client
+
+        # @param request_client [RequestClient]
+        # @return [InsurancePayments::V1::V1Client]
+        def initialize(request_client:)
+          # @type [RequestClient]
+          @request_client = request_client
+        end
+
+        # Returns all non-ERA originated insurance payments satisfying the search criteria
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param payer_uuid [Payers::V3::PAYER_String]
+        # @param claim_id [Commons::CLAIM_ID]
+        # @param service_line_id [Commons::SERVICE_LINE_ID]
+        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param sort [InsurancePayments::V1::InsurancePaymentSortField] Defaults to payment_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 [InsurancePayments::V1::InsurancePaymentsPage]
+        def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
+                      sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
+          response = @request_client.conn.get("/api/insurance-payments/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,
+              "payer_uuid": payer_uuid,
+              "claim_id": claim_id,
+              "service_line_id": service_line_id,
+              "billing_provider_id": billing_provider_id,
+              "sort": sort,
+              "sort_direction": sort_direction,
+              "page_token": page_token
+            }.compact
+          end
+          InsurancePayments::V1::InsurancePaymentsPage.from_json(json_object: response.body)
+        end
+
+        # Retrieves a previously created insurance payment by its `insurance_payment_id`.
+        # If the payment does not exist, a `403` will be thrown.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def get(insurance_payment_id:, request_options: nil)
+          response = @request_client.conn.get("/api/insurance-payments/v1/#{insurance_payment_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
+          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+        end
+
+        # Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
+        # should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
+        # from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
+        #
+        # @param request [Hash] Request of type InsurancePayments::V1::InsurancePaymentCreate, as a Hash
+        #   * :payer_identifier (Hash)
+        #   * :amount_cents (Integer)
+        #   * :payment_timestamp (DateTime)
+        #   * :payment_note (String)
+        #   * :allocations (Array<Financials::AllocationCreate>)
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def create(request:, request_options: nil)
+          response = @request_client.conn.post("/api/insurance-payments/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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+        end
+
+        # Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
+        # then the allocations must be appropriately updated as well.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [Financials::NoteUpdate]
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def update(insurance_payment_id:, payment_timestamp: nil, payment_note: nil, request_options: nil)
+          response = @request_client.conn.patch("/api/insurance-payments/v1/#{insurance_payment_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 || {}),
+              payment_timestamp: payment_timestamp,
+              payment_note: payment_note
+            }.compact
+          end
+          InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+        end
+
+        # Deletes the insurance payment record matching the provided `insurance_payment_id`.
+        # If the matching record's organization_id does not match the authenticated user's
+        # current organization_id, then a response code of `403` will be returned.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param request_options [RequestOptions]
+        # @return [Void]
+        def delete(insurance_payment_id:, request_options: nil)
+          @request_client.conn.delete("/api/insurance-payments/v1/#{insurance_payment_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 [InsurancePayments::V1::AsyncV1Client]
+        def initialize(request_client:)
+          # @type [AsyncRequestClient]
+          @request_client = request_client
+        end
+
+        # Returns all non-ERA originated insurance payments satisfying the search criteria
+        #
+        # @param limit [Integer] Defaults to 100. The value must be greater than 0 and less than 1000.
+        # @param payer_uuid [Payers::V3::PAYER_String]
+        # @param claim_id [Commons::CLAIM_ID]
+        # @param service_line_id [Commons::SERVICE_LINE_ID]
+        # @param billing_provider_id [Commons::PROVIDER_ID]
+        # @param sort [InsurancePayments::V1::InsurancePaymentSortField] Defaults to payment_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 [InsurancePayments::V1::InsurancePaymentsPage]
+        def get_multi(limit: nil, payer_uuid: nil, claim_id: nil, service_line_id: nil, billing_provider_id: nil,
+                      sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/insurance-payments/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,
+                "payer_uuid": payer_uuid,
+                "claim_id": claim_id,
+                "service_line_id": service_line_id,
+                "billing_provider_id": billing_provider_id,
+                "sort": sort,
+                "sort_direction": sort_direction,
+                "page_token": page_token
+              }.compact
+            end
+            InsurancePayments::V1::InsurancePaymentsPage.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieves a previously created insurance payment by its `insurance_payment_id`.
+        # If the payment does not exist, a `403` will be thrown.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def get(insurance_payment_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/insurance-payments/v1/#{insurance_payment_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
+            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
+        # should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
+        # from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
+        #
+        # @param request [Hash] Request of type InsurancePayments::V1::InsurancePaymentCreate, as a Hash
+        #   * :payer_identifier (Hash)
+        #   * :amount_cents (Integer)
+        #   * :payment_timestamp (DateTime)
+        #   * :payment_note (String)
+        #   * :allocations (Array<Financials::AllocationCreate>)
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def create(request:, request_options: nil)
+          Async do
+            response = @request_client.conn.post("/api/insurance-payments/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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
+        # then the allocations must be appropriately updated as well.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [Financials::NoteUpdate]
+        # @param request_options [RequestOptions]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def update(insurance_payment_id:, payment_timestamp: nil, payment_note: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.patch("/api/insurance-payments/v1/#{insurance_payment_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 || {}),
+                payment_timestamp: payment_timestamp,
+                payment_note: payment_note
+              }.compact
+            end
+            InsurancePayments::V1::InsurancePayment.from_json(json_object: response.body)
+          end
+        end
+
+        # Deletes the insurance payment record matching the provided `insurance_payment_id`.
+        # If the matching record's organization_id does not match the authenticated user's
+        # current organization_id, then a response code of `403` will be returned.
+        #
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param request_options [RequestOptions]
+        # @return [Void]
+        def delete(insurance_payment_id:, request_options: nil)
+          Async do
+            @request_client.conn.delete("/api/insurance-payments/v1/#{insurance_payment_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