candidhealth 0.0.0 → 0.17.1

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

@@ -1,50 +1,52 @@
 # 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
-        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [CandidApiClient::RequestClient]
-        # @return [CandidApiClient::InsurancePayments::V1::V1Client]
+        # @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 [String]
-        # @param claim_id [String]
-        # @param service_line_id [String]
-        # @param billing_provider_id [String]
-        # @param sort [CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentSortField] 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::InsurancePayments::V1::Types::InsurancePaymentsPage]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.insurance_payments.v_1.get_multi
+        # @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 do |req|
+          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_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "limit": limit,
@@ -56,73 +58,114 @@ module CandidApiClient
               "sort_direction": sort_direction,
               "page_token": page_token
             }.compact
-            req.url "#{@request_client.get_url(environment: CandidApi,
-                                               request_options: request_options)}/api/insurance-payments/v1"
           end
-          CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentsPage.from_json(json_object: response.body)
+          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.
+        # If the payment does not exist, a `403` will be thrown.
         #
-        # @param insurance_payment_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.insurance_payments.v_1.get(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @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 do |req|
+          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_client.get_headers,
-          **(request_options&.additional_headers || {})
+            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
-            req.url "#{@request_client.get_url(environment: CandidApi,
-                                               request_options: request_options)}/api/insurance-payments/v1/#{insurance_payment_id}"
           end
-          CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
+          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
-        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [CandidApiClient::AsyncRequestClient]
-        # @return [CandidApiClient::InsurancePayments::V1::AsyncV1Client]
+        # @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 [String]
-        # @param claim_id [String]
-        # @param service_line_id [String]
-        # @param billing_provider_id [String]
-        # @param sort [CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentSortField] 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::InsurancePayments::V1::Types::InsurancePaymentsPage]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.insurance_payments.v_1.get_multi
+        # @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 do |req|
+            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_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
+              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
                 "limit": limit,
@@ -134,36 +177,90 @@ module CandidApiClient
                 "sort_direction": sort_direction,
                 "page_token": page_token
               }.compact
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/insurance-payments/v1"
             end
-            CandidApiClient::InsurancePayments::V1::Types::InsurancePaymentsPage.from_json(json_object: response.body)
+            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.
+        # If the payment does not exist, a `403` will be thrown.
         #
-        # @param insurance_payment_id [String]
-        # @param request_options [CandidApiClient::RequestOptions]
-        # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
-        # @example
-        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.insurance_payments.v_1.get(insurance_payment_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        # @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 do |req|
+            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_client.get_headers,
-            **(request_options&.additional_headers || {})
+              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
-              req.url "#{@request_client.get_url(environment: CandidApi,
-                                                 request_options: request_options)}/api/insurance-payments/v1/#{insurance_payment_id}"
             end
-            CandidApiClient::InsurancePayments::V1::Types::InsurancePayment.from_json(json_object: response.body)
+            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

data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment.rb

@@ -1,120 +1,96 @@
 # frozen_string_literal: true
 
+require_relative "insurance_payment_id"
 require_relative "../../../payers/v_3/types/payer"
 require "date"
 require_relative "../../../financials/types/allocation"
-require "ostruct"
 require "json"
 
 module CandidApiClient
   module InsurancePayments
     module V1
-      module Types
-        class InsurancePayment
-          # @return [String]
-          attr_reader :insurance_payment_id
-          # @return [CandidApiClient::Payers::V3::Types::Payer]
-          attr_reader :payer
-          # @return [Integer]
-          attr_reader :amount_cents
-          # @return [DateTime]
-          attr_reader :payment_timestamp
-          # @return [String]
-          attr_reader :payment_note
-          # @return [Array<CandidApiClient::Financials::Types::Allocation>]
-          attr_reader :allocations
-          # @return [OpenStruct] Additional properties unmapped to the current class definition
-          attr_reader :additional_properties
-          # @return [Object]
-          attr_reader :_field_set
-          protected :_field_set
+      class InsurancePayment
+        attr_reader :insurance_payment_id, :payer, :amount_cents, :payment_timestamp, :payment_note, :allocations,
+                    :additional_properties
 
-          OMIT = Object.new
+        # @param insurance_payment_id [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+        # @param payer [Payers::V3::Payer]
+        # @param amount_cents [Integer]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [String]
+        # @param allocations [Array<Financials::Allocation>]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def initialize(insurance_payment_id:, payer:, amount_cents:, allocations:, payment_timestamp: nil,
+                       payment_note: nil, additional_properties: nil)
+          # @type [InsurancePayments::V1::INSURANCE_PAYMENT_ID]
+          @insurance_payment_id = insurance_payment_id
+          # @type [Payers::V3::Payer]
+          @payer = payer
+          # @type [Integer]
+          @amount_cents = amount_cents
+          # @type [DateTime]
+          @payment_timestamp = payment_timestamp
+          # @type [String]
+          @payment_note = payment_note
+          # @type [Array<Financials::Allocation>]
+          @allocations = allocations
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
 
-          # @param insurance_payment_id [String]
-          # @param payer [CandidApiClient::Payers::V3::Types::Payer]
-          # @param amount_cents [Integer]
-          # @param payment_timestamp [DateTime]
-          # @param payment_note [String]
-          # @param allocations [Array<CandidApiClient::Financials::Types::Allocation>]
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
-          def initialize(insurance_payment_id:, payer:, amount_cents:, allocations:, payment_timestamp: OMIT,
-                         payment_note: OMIT, additional_properties: nil)
-            @insurance_payment_id = insurance_payment_id
-            @payer = payer
-            @amount_cents = amount_cents
-            @payment_timestamp = payment_timestamp if payment_timestamp != OMIT
-            @payment_note = payment_note if payment_note != OMIT
-            @allocations = allocations
-            @additional_properties = additional_properties
-            @_field_set = {
-              "insurance_payment_id": insurance_payment_id,
-              "payer": payer,
-              "amount_cents": amount_cents,
-              "payment_timestamp": payment_timestamp,
-              "payment_note": payment_note,
-              "allocations": allocations
-            }.reject do |_k, v|
-              v == OMIT
-            end
+        # Deserialize a JSON object to an instance of InsurancePayment
+        #
+        # @param json_object [JSON]
+        # @return [InsurancePayments::V1::InsurancePayment]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          insurance_payment_id = struct.insurance_payment_id
+          if parsed_json["payer"].nil?
+            payer = nil
+          else
+            payer = parsed_json["payer"].to_json
+            payer = Payers::V3::Payer.from_json(json_object: payer)
           end
-
-          # Deserialize a JSON object to an instance of InsurancePayment
-          #
-          # @param json_object [String]
-          # @return [CandidApiClient::InsurancePayments::V1::Types::InsurancePayment]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            insurance_payment_id = struct["insurance_payment_id"]
-            if parsed_json["payer"].nil?
-              payer = nil
-            else
-              payer = parsed_json["payer"].to_json
-              payer = CandidApiClient::Payers::V3::Types::Payer.from_json(json_object: payer)
-            end
-            amount_cents = struct["amount_cents"]
-            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
-            new(
-              insurance_payment_id: insurance_payment_id,
-              payer: payer,
-              amount_cents: amount_cents,
-              payment_timestamp: payment_timestamp,
-              payment_note: payment_note,
-              allocations: allocations,
-              additional_properties: struct
-            )
+          amount_cents = struct.amount_cents
+          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 |v|
+            v = v.to_json
+            Financials::Allocation.from_json(json_object: v)
           end
+          new(insurance_payment_id: insurance_payment_id, payer: payer, amount_cents: amount_cents,
+              payment_timestamp: payment_timestamp, payment_note: payment_note, allocations: allocations, additional_properties: struct)
+        end
 
-          # Serialize an instance of InsurancePayment to a JSON object
-          #
-          # @return [String]
-          def to_json(*_args)
-            @_field_set&.to_json
-          end
+        # Serialize an instance of InsurancePayment to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "insurance_payment_id": @insurance_payment_id,
+            "payer": @payer,
+            "amount_cents": @amount_cents,
+            "payment_timestamp": @payment_timestamp,
+            "payment_note": @payment_note,
+            "allocations": @allocations
+          }.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_payment_id.is_a?(String) != false || raise("Passed value for field obj.insurance_payment_id is not the expected type, validation failed.")
-            CandidApiClient::Payers::V3::Types::Payer.validate_raw(obj: obj.payer)
-            obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents 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.")
-          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_payment_id.is_a?(String) != false || raise("Passed value for field obj.insurance_payment_id is not the expected type, validation failed.")
+          Payers::V3::Payer.validate_raw(obj: obj.payer)
+          obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents 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.")
         end
       end
     end

data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_create.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative "../../../payers/v_3/types/payer_identifier"
+require "date"
+require_relative "../../../financials/types/allocation_create"
+require "json"
+
+module CandidApiClient
+  module InsurancePayments
+    module V1
+      class InsurancePaymentCreate
+        attr_reader :payer_identifier, :amount_cents, :payment_timestamp, :payment_note, :allocations,
+                    :additional_properties
+
+        # @param payer_identifier [Payers::V3::PayerIdentifier]
+        # @param amount_cents [Integer]
+        # @param payment_timestamp [DateTime]
+        # @param payment_note [String]
+        # @param allocations [Array<Financials::AllocationCreate>]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [InsurancePayments::V1::InsurancePaymentCreate]
+        def initialize(payer_identifier:, amount_cents:, allocations:, payment_timestamp: nil, payment_note: nil,
+                       additional_properties: nil)
+          # @type [Payers::V3::PayerIdentifier]
+          @payer_identifier = payer_identifier
+          # @type [Integer]
+          @amount_cents = amount_cents
+          # @type [DateTime]
+          @payment_timestamp = payment_timestamp
+          # @type [String]
+          @payment_note = payment_note
+          # @type [Array<Financials::AllocationCreate>]
+          @allocations = allocations
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InsurancePaymentCreate
+        #
+        # @param json_object [JSON]
+        # @return [InsurancePayments::V1::InsurancePaymentCreate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          if parsed_json["payer_identifier"].nil?
+            payer_identifier = nil
+          else
+            payer_identifier = parsed_json["payer_identifier"].to_json
+            payer_identifier = Payers::V3::PayerIdentifier.from_json(json_object: payer_identifier)
+          end
+          amount_cents = struct.amount_cents
+          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 |v|
+            v = v.to_json
+            Financials::AllocationCreate.from_json(json_object: v)
+          end
+          new(payer_identifier: payer_identifier, amount_cents: amount_cents, payment_timestamp: payment_timestamp,
+              payment_note: payment_note, allocations: allocations, additional_properties: struct)
+        end
+
+        # Serialize an instance of InsurancePaymentCreate to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "payer_identifier": @payer_identifier,
+            "amount_cents": @amount_cents,
+            "payment_timestamp": @payment_timestamp,
+            "payment_note": @payment_note,
+            "allocations": @allocations
+          }.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:)
+          Payers::V3::PayerIdentifier.validate_raw(obj: obj.payer_identifier)
+          obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents 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.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_id.rb

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