candidhealth 0.19.1.pre.6de2b0d → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793252ca4daa7586c13132c62e5c8358ba764bccd9c7f0c58119abacf116bfa7
-  data.tar.gz: 90ad15dad0a9f420ffbb36d422e9448f15c2df6702c2b0b0ac19339225ced3d6
+  metadata.gz: 7ce8f1bb83c0488c695d4d690baa38b002d36af4ad712b07182545371b16e2e6
+  data.tar.gz: 154eef6e1ed858c1c46ac1dc0bb62b00b7d3fb5b721778e9f8f841d959c782c8
 SHA512:
-  metadata.gz: f67737e90de29e05858644ed7ffb54663d6dbb23dac2dcab896c3b6c9b31db00387616d006209dce5aa4dea924d72fac4859bb15468b3b840b51000708c2e7f8
-  data.tar.gz: f64c9440c49927a37caddf29cd567184c6ed92a806500300545680eecba0059fec8b59045ba215196b106851e6b946a885bb674b7d9dc4b382632979a0e61205
+  metadata.gz: 5969b02e29ba1d494dd89416f694b7e8604482df5048278cb84fbb0f4b93825790ceec96b027d6e77d4d98b2a2f6bb97836739a0e0b700f52b92ba63ab654192
+  data.tar.gz: b5b3fd3c33a18ddc3d204e56cadd122f2206f35a9dfbe12f08f5c6ca0288fbabbfc4ef8f210a96fecfbc2060e8766d535110c03ecbd42f1343a56043cf684876

data/lib/candidhealth/eligibility/v_2/client.rb

@@ -44,6 +44,10 @@ module CandidApiClient
           response.body
         end
 
+        # **Availity has transitioned their GET endpoint to a POST endpoint. Candid has updated their pass-through integration to enable backwards compatibility for the GET endpoint so that customers do not have to immediately update their integrations.**
+        #
+        # **Candid recommends integrations with the [POST endpoint](https://docs.joincandidhealth.com/api-reference/eligibility/v-2/submit-eligibility-check-availity-post) to ensure the best possible integration experience. Given the transition, Availity’s documentation will be out of sync with this endpoint.**
+        #
         # If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint
         #
         # This API is a wrapper around Availity's coverages API. Below are some helpful documentation links:
@@ -139,6 +143,10 @@ module CandidApiClient
           end
         end
 
+        # **Availity has transitioned their GET endpoint to a POST endpoint. Candid has updated their pass-through integration to enable backwards compatibility for the GET endpoint so that customers do not have to immediately update their integrations.**
+        #
+        # **Candid recommends integrations with the [POST endpoint](https://docs.joincandidhealth.com/api-reference/eligibility/v-2/submit-eligibility-check-availity-post) to ensure the best possible integration experience. Given the transition, Availity’s documentation will be out of sync with this endpoint.**
+        #
         # If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint
         #
         # This API is a wrapper around Availity's coverages API. Below are some helpful documentation links:

data/lib/candidhealth/import_invoice/client.rb

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

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

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "types/create_import_invoice_request"
+require_relative "types/import_invoice"
+require_relative "../../commons/types/invoice_id"
+require_relative "types/import_invoice_update_request"
+require "async"
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class V1Client
+        attr_reader :request_client
+
+        # @param request_client [RequestClient]
+        # @return [ImportInvoice::V1::V1Client]
+        def initialize(request_client:)
+          # @type [RequestClient]
+          @request_client = request_client
+        end
+
+        # Import an existing invoice from a third party service to reflect state in Candid.
+        #
+        # @param request [Hash] Request of type ImportInvoice::V1::CreateImportInvoiceRequest, as a Hash
+        #   * :patient_external_id (Commons::PATIENT_EXTERNAL_ID)
+        #   * :external_customer_identifier (String)
+        #   * :note (String)
+        #   * :due_date (Date)
+        #   * :items (Array<Invoices::V2::InvoiceItemCreate>)
+        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :external_identifier (String)
+        #   * :customer_invoice_url (String)
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def import_invoice(request:, request_options: nil)
+          response = @request_client.conn.post("/api/import-invoice/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
+          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+        end
+
+        # Retrieve and view an import invoice
+        #
+        # @param invoice_id [Commons::INVOICE_ID] InvoiceId to be returned
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def get(invoice_id:, request_options: nil)
+          response = @request_client.conn.get("/api/import-invoice/v1/#{invoice_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
+          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+        end
+
+        # Update the information on the imported invoice
+        #
+        # @param invoice_id [Commons::INVOICE_ID]
+        # @param request [Hash] Request of type ImportInvoice::V1::ImportInvoiceUpdateRequest, as a Hash
+        #   * :customer_invoice_url (String)
+        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :note (String)
+        #   * :due_date (Date)
+        #   * :items (Hash)
+        #     * :update_type (ImportInvoice::V1::InvoiceItemUpdateType)
+        #     * :items (Array<Invoices::V2::InvoiceItemCreate>)
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def update(invoice_id:, request:, request_options: nil)
+          response = @request_client.conn.patch("/api/import-invoice/v1/#{invoice_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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncV1Client
+        attr_reader :request_client
+
+        # @param request_client [AsyncRequestClient]
+        # @return [ImportInvoice::V1::AsyncV1Client]
+        def initialize(request_client:)
+          # @type [AsyncRequestClient]
+          @request_client = request_client
+        end
+
+        # Import an existing invoice from a third party service to reflect state in Candid.
+        #
+        # @param request [Hash] Request of type ImportInvoice::V1::CreateImportInvoiceRequest, as a Hash
+        #   * :patient_external_id (Commons::PATIENT_EXTERNAL_ID)
+        #   * :external_customer_identifier (String)
+        #   * :note (String)
+        #   * :due_date (Date)
+        #   * :items (Array<Invoices::V2::InvoiceItemCreate>)
+        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :external_identifier (String)
+        #   * :customer_invoice_url (String)
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def import_invoice(request:, request_options: nil)
+          Async do
+            response = @request_client.conn.post("/api/import-invoice/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
+            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          end
+        end
+
+        # Retrieve and view an import invoice
+        #
+        # @param invoice_id [Commons::INVOICE_ID] InvoiceId to be returned
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def get(invoice_id:, request_options: nil)
+          Async do
+            response = @request_client.conn.get("/api/import-invoice/v1/#{invoice_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
+            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          end
+        end
+
+        # Update the information on the imported invoice
+        #
+        # @param invoice_id [Commons::INVOICE_ID]
+        # @param request [Hash] Request of type ImportInvoice::V1::ImportInvoiceUpdateRequest, as a Hash
+        #   * :customer_invoice_url (String)
+        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :note (String)
+        #   * :due_date (Date)
+        #   * :items (Hash)
+        #     * :update_type (ImportInvoice::V1::InvoiceItemUpdateType)
+        #     * :items (Array<Invoices::V2::InvoiceItemCreate>)
+        # @param request_options [RequestOptions]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def update(invoice_id:, request:, request_options: nil)
+          Async do
+            response = @request_client.conn.patch("/api/import-invoice/v1/#{invoice_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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/import_invoice/v_1/types/create_import_invoice_request.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "../../../commons/types/patient_external_id"
+require "date"
+require_relative "../../../invoices/v_2/types/invoice_item_create"
+require_relative "../../../invoices/v_2/types/invoice_status"
+require "json"
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class CreateImportInvoiceRequest
+        attr_reader :patient_external_id, :external_customer_identifier, :note, :due_date, :items, :status,
+                    :external_identifier, :customer_invoice_url, :additional_properties
+
+        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
+        # @param external_customer_identifier [String] Id of the customer in the source system
+        # @param note [String]
+        # @param due_date [Date] If given as None, days_until_due in the payment config will be used to create a default date
+        # @param items [Array<Invoices::V2::InvoiceItemCreate>]
+        # @param status [Invoices::V2::InvoiceStatus]
+        # @param external_identifier [String] Id of the invoice being imported in the source system. Warning - This field CANNOT be updated.
+        # @param customer_invoice_url [String] Link to the patient view of the invoice in the third-party service
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [ImportInvoice::V1::CreateImportInvoiceRequest]
+        def initialize(patient_external_id:, external_customer_identifier:, items:, status:, external_identifier:,
+                       note: nil, due_date: nil, customer_invoice_url: nil, additional_properties: nil)
+          # @type [Commons::PATIENT_EXTERNAL_ID]
+          @patient_external_id = patient_external_id
+          # @type [String] Id of the customer in the source system
+          @external_customer_identifier = external_customer_identifier
+          # @type [String]
+          @note = note
+          # @type [Date] If given as None, days_until_due in the payment config will be used to create a default date
+          @due_date = due_date
+          # @type [Array<Invoices::V2::InvoiceItemCreate>]
+          @items = items
+          # @type [Invoices::V2::InvoiceStatus]
+          @status = status
+          # @type [String] Id of the invoice being imported in the source system. Warning - This field CANNOT be updated.
+          @external_identifier = external_identifier
+          # @type [String] Link to the patient view of the invoice in the third-party service
+          @customer_invoice_url = customer_invoice_url
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of CreateImportInvoiceRequest
+        #
+        # @param json_object [JSON]
+        # @return [ImportInvoice::V1::CreateImportInvoiceRequest]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          patient_external_id = struct.patient_external_id
+          external_customer_identifier = struct.external_customer_identifier
+          note = struct.note
+          due_date = (Date.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?)
+          items = parsed_json["items"]&.map do |v|
+            v = v.to_json
+            Invoices::V2::InvoiceItemCreate.from_json(json_object: v)
+          end
+          status = struct.status
+          external_identifier = struct.external_identifier
+          customer_invoice_url = struct.customer_invoice_url
+          new(patient_external_id: patient_external_id, external_customer_identifier: external_customer_identifier,
+              note: note, due_date: due_date, items: items, status: status, external_identifier: external_identifier, customer_invoice_url: customer_invoice_url, additional_properties: struct)
+        end
+
+        # Serialize an instance of CreateImportInvoiceRequest to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "patient_external_id": @patient_external_id,
+            "external_customer_identifier": @external_customer_identifier,
+            "note": @note,
+            "due_date": @due_date,
+            "items": @items,
+            "status": @status,
+            "external_identifier": @external_identifier,
+            "customer_invoice_url": @customer_invoice_url
+          }.to_json
+        end
+
+        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+        #
+        # @param obj [Object]
+        # @return [Void]
+        def self.validate_raw(obj:)
+          obj.patient_external_id.is_a?(String) != false || raise("Passed value for field obj.patient_external_id is not the expected type, validation failed.")
+          obj.external_customer_identifier.is_a?(String) != false || raise("Passed value for field obj.external_customer_identifier is not the expected type, validation failed.")
+          obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
+          obj.due_date&.is_a?(Date) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.")
+          obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+          obj.status.is_a?(Invoices::V2::InvoiceStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+          obj.external_identifier.is_a?(String) != false || raise("Passed value for field obj.external_identifier is not the expected type, validation failed.")
+          obj.customer_invoice_url&.is_a?(String) != false || raise("Passed value for field obj.customer_invoice_url is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/import_invoice/v_1/types/import_invoice.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require_relative "../../../commons/types/invoice_id"
+require "date"
+require_relative "../../../invoices/v_2/types/invoice_item_info"
+require_relative "../../../commons/types/patient_external_id"
+require_relative "../../../invoices/v_2/types/invoice_status"
+require "json"
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class ImportInvoice
+        attr_reader :id, :created_at, :updated_at, :items, :patient_external_id, :external_customer_identifier,
+                    :status, :external_identifier, :note, :customer_invoice_url, :due_date, :amount_cents, :additional_properties
+
+        # @param id [Commons::INVOICE_ID]
+        # @param created_at [DateTime]
+        # @param updated_at [DateTime]
+        # @param items [Invoices::V2::InvoiceItemInfo] The InvoiceItem rollup which contains all claim and service line invoice items
+        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
+        # @param external_customer_identifier [String] Id of the customer in the source system
+        # @param status [Invoices::V2::InvoiceStatus]
+        # @param external_identifier [String] Id of the invoice being imported in the source system
+        # @param note [String]
+        # @param customer_invoice_url [String] Link to the patient view of the invoice in the third-party service
+        # @param due_date [Date]
+        # @param amount_cents [Integer] Total monetary amount (in cents) of all Invoice Items
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def initialize(id:, created_at:, updated_at:, items:, patient_external_id:, external_customer_identifier:,
+                       status:, external_identifier:, due_date:, amount_cents:, note: nil, customer_invoice_url: nil, additional_properties: nil)
+          # @type [Commons::INVOICE_ID]
+          @id = id
+          # @type [DateTime]
+          @created_at = created_at
+          # @type [DateTime]
+          @updated_at = updated_at
+          # @type [Invoices::V2::InvoiceItemInfo] The InvoiceItem rollup which contains all claim and service line invoice items
+          @items = items
+          # @type [Commons::PATIENT_EXTERNAL_ID]
+          @patient_external_id = patient_external_id
+          # @type [String] Id of the customer in the source system
+          @external_customer_identifier = external_customer_identifier
+          # @type [Invoices::V2::InvoiceStatus]
+          @status = status
+          # @type [String] Id of the invoice being imported in the source system
+          @external_identifier = external_identifier
+          # @type [String]
+          @note = note
+          # @type [String] Link to the patient view of the invoice in the third-party service
+          @customer_invoice_url = customer_invoice_url
+          # @type [Date]
+          @due_date = due_date
+          # @type [Integer] Total monetary amount (in cents) of all Invoice Items
+          @amount_cents = amount_cents
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of ImportInvoice
+        #
+        # @param json_object [JSON]
+        # @return [ImportInvoice::V1::ImportInvoice]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          id = struct.id
+          created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+          updated_at = (DateTime.parse(parsed_json["updated_at"]) unless parsed_json["updated_at"].nil?)
+          if parsed_json["items"].nil?
+            items = nil
+          else
+            items = parsed_json["items"].to_json
+            items = Invoices::V2::InvoiceItemInfo.from_json(json_object: items)
+          end
+          patient_external_id = struct.patient_external_id
+          external_customer_identifier = struct.external_customer_identifier
+          status = struct.status
+          external_identifier = struct.external_identifier
+          note = struct.note
+          customer_invoice_url = struct.customer_invoice_url
+          due_date = (Date.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?)
+          amount_cents = struct.amount_cents
+          new(id: id, created_at: created_at, updated_at: updated_at, items: items,
+              patient_external_id: patient_external_id, external_customer_identifier: external_customer_identifier, status: status, external_identifier: external_identifier, note: note, customer_invoice_url: customer_invoice_url, due_date: due_date, amount_cents: amount_cents, additional_properties: struct)
+        end
+
+        # Serialize an instance of ImportInvoice to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "id": @id,
+            "created_at": @created_at,
+            "updated_at": @updated_at,
+            "items": @items,
+            "patient_external_id": @patient_external_id,
+            "external_customer_identifier": @external_customer_identifier,
+            "status": @status,
+            "external_identifier": @external_identifier,
+            "note": @note,
+            "customer_invoice_url": @customer_invoice_url,
+            "due_date": @due_date,
+            "amount_cents": @amount_cents
+          }.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.id.is_a?(UUID) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+          obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+          obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+          Invoices::V2::InvoiceItemInfo.validate_raw(obj: obj.items)
+          obj.patient_external_id.is_a?(String) != false || raise("Passed value for field obj.patient_external_id is not the expected type, validation failed.")
+          obj.external_customer_identifier.is_a?(String) != false || raise("Passed value for field obj.external_customer_identifier is not the expected type, validation failed.")
+          obj.status.is_a?(Invoices::V2::InvoiceStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+          obj.external_identifier.is_a?(String) != false || raise("Passed value for field obj.external_identifier is not the expected type, validation failed.")
+          obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
+          obj.customer_invoice_url&.is_a?(String) != false || raise("Passed value for field obj.customer_invoice_url is not the expected type, validation failed.")
+          obj.due_date.is_a?(Date) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.")
+          obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/import_invoice/v_1/types/import_invoice_update_request.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative "../../../invoices/v_2/types/invoice_status"
+require "date"
+require_relative "invoice_item_info_update"
+require "json"
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class ImportInvoiceUpdateRequest
+        attr_reader :customer_invoice_url, :status, :note, :due_date, :items, :additional_properties
+
+        # @param customer_invoice_url [String] Link to the patient view of the invoice in the third-party service
+        # @param status [Invoices::V2::InvoiceStatus]
+        # @param note [String]
+        # @param due_date [Date]
+        # @param items [ImportInvoice::V1::InvoiceItemInfoUpdate] None here represents there is no update to the invoice items
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [ImportInvoice::V1::ImportInvoiceUpdateRequest]
+        def initialize(customer_invoice_url: nil, status: nil, note: nil, due_date: nil, items: nil,
+                       additional_properties: nil)
+          # @type [String] Link to the patient view of the invoice in the third-party service
+          @customer_invoice_url = customer_invoice_url
+          # @type [Invoices::V2::InvoiceStatus]
+          @status = status
+          # @type [String]
+          @note = note
+          # @type [Date]
+          @due_date = due_date
+          # @type [ImportInvoice::V1::InvoiceItemInfoUpdate] None here represents there is no update to the invoice items
+          @items = items
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of ImportInvoiceUpdateRequest
+        #
+        # @param json_object [JSON]
+        # @return [ImportInvoice::V1::ImportInvoiceUpdateRequest]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          customer_invoice_url = struct.customer_invoice_url
+          status = struct.status
+          note = struct.note
+          due_date = (Date.parse(parsed_json["due_date"]) unless parsed_json["due_date"].nil?)
+          if parsed_json["items"].nil?
+            items = nil
+          else
+            items = parsed_json["items"].to_json
+            items = ImportInvoice::V1::InvoiceItemInfoUpdate.from_json(json_object: items)
+          end
+          new(customer_invoice_url: customer_invoice_url, status: status, note: note, due_date: due_date, items: items,
+              additional_properties: struct)
+        end
+
+        # Serialize an instance of ImportInvoiceUpdateRequest to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          {
+            "customer_invoice_url": @customer_invoice_url,
+            "status": @status,
+            "note": @note,
+            "due_date": @due_date,
+            "items": @items
+          }.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.customer_invoice_url&.is_a?(String) != false || raise("Passed value for field obj.customer_invoice_url is not the expected type, validation failed.")
+          obj.status&.is_a?(Invoices::V2::InvoiceStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+          obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
+          obj.due_date&.is_a?(Date) != false || raise("Passed value for field obj.due_date is not the expected type, validation failed.")
+          obj.items.nil? || ImportInvoice::V1::InvoiceItemInfoUpdate.validate_raw(obj: obj.items)
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/import_invoice/v_1/types/invoice_item_info_update.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "invoice_item_update_type"
+require_relative "../../../invoices/v_2/types/invoice_item_create"
+require "json"
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class InvoiceItemInfoUpdate
+        attr_reader :update_type, :items, :additional_properties
+
+        # @param update_type [ImportInvoice::V1::InvoiceItemUpdateType] The only supported update operations for invoice items is to either overwrite the entire list of invoice items
+        #   or to append new invoice items
+        # @param items [Array<Invoices::V2::InvoiceItemCreate>]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [ImportInvoice::V1::InvoiceItemInfoUpdate]
+        def initialize(update_type:, items:, additional_properties: nil)
+          # @type [ImportInvoice::V1::InvoiceItemUpdateType] The only supported update operations for invoice items is to either overwrite the entire list of invoice items
+          #   or to append new invoice items
+          @update_type = update_type
+          # @type [Array<Invoices::V2::InvoiceItemCreate>]
+          @items = items
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InvoiceItemInfoUpdate
+        #
+        # @param json_object [JSON]
+        # @return [ImportInvoice::V1::InvoiceItemInfoUpdate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          update_type = struct.update_type
+          items = parsed_json["items"]&.map do |v|
+            v = v.to_json
+            Invoices::V2::InvoiceItemCreate.from_json(json_object: v)
+          end
+          new(update_type: update_type, items: items, additional_properties: struct)
+        end
+
+        # Serialize an instance of InvoiceItemInfoUpdate to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          { "update_type": @update_type, "items": @items }.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.update_type.is_a?(ImportInvoice::V1::InvoiceItemUpdateType) != false || raise("Passed value for field obj.update_type is not the expected type, validation failed.")
+          obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/import_invoice/v_1/types/invoice_item_update_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module ImportInvoice
+    module V1
+      class InvoiceItemUpdateType
+        APPEND = "APPEND"
+        OVERWRITE = "OVERWRITE"
+      end
+    end
+  end
+end

data/lib/candidhealth/invoices/v_2/types/invoice_item_attribution_create.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "../../../commons/types/service_line_id"
+require_relative "../../../commons/types/claim_id"
+
+module CandidApiClient
+  module Invoices
+    module V2
+      # Points to the claim or service line that this invoice is attributed to
+      class InvoiceItemAttributionCreate
+        attr_reader :member, :discriminant
+
+        private_class_method :new
+        alias kind_of? is_a?
+        # @param member [Object]
+        # @param discriminant [String]
+        # @return [Invoices::V2::InvoiceItemAttributionCreate]
+        def initialize(member:, discriminant:)
+          # @type [Object]
+          @member = member
+          # @type [String]
+          @discriminant = discriminant
+        end
+
+        # Deserialize a JSON object to an instance of InvoiceItemAttributionCreate
+        #
+        # @param json_object [JSON]
+        # @return [Invoices::V2::InvoiceItemAttributionCreate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          member = case struct.type
+                   when "service_line_id"
+                     json_object.value
+                   when "claim_id"
+                     json_object.value
+                   when "unattributed"
+                     nil
+                   else
+                     json_object
+                   end
+          new(member: member, discriminant: struct.type)
+        end
+
+        # For Union Types, to_json functionality is delegated to the wrapped member.
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          case @discriminant
+          when "service_line_id"
+            { "type": @discriminant, "value": @member }.to_json
+          when "claim_id"
+            { "type": @discriminant, "value": @member }.to_json
+          when "unattributed"
+            { type: @discriminant }.to_json
+          else
+            { "type": @discriminant, value: @member }.to_json
+          end
+          @member.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:)
+          case obj.type
+          when "service_line_id"
+            obj.is_a?(UUID) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+          when "claim_id"
+            obj.is_a?(UUID) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+          when "unattributed"
+            # noop
+          else
+            raise("Passed value matched no type within the union, validation failed.")
+          end
+        end
+
+        # For Union Types, is_a? functionality is delegated to the wrapped member.
+        #
+        # @param obj [Object]
+        # @return [Boolean]
+        def is_a?(obj)
+          @member.is_a?(obj)
+        end
+
+        # @param member [Commons::SERVICE_LINE_ID]
+        # @return [Invoices::V2::InvoiceItemAttributionCreate]
+        def self.service_line_id(member:)
+          new(member: member, discriminant: "service_line_id")
+        end
+
+        # @param member [Commons::CLAIM_ID]
+        # @return [Invoices::V2::InvoiceItemAttributionCreate]
+        def self.claim_id(member:)
+          new(member: member, discriminant: "claim_id")
+        end
+
+        # @return [Invoices::V2::InvoiceItemAttributionCreate]
+        def self.unattributed
+          new(member: nil, discriminant: "unattributed")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/invoices/v_2/types/invoice_item_create.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "invoice_item_attribution_create"
+require "json"
+
+module CandidApiClient
+  module Invoices
+    module V2
+      class InvoiceItemCreate
+        attr_reader :attribution, :amount_cents, :additional_properties
+
+        # @param attribution [Invoices::V2::InvoiceItemAttributionCreate]
+        # @param amount_cents [Integer]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [Invoices::V2::InvoiceItemCreate]
+        def initialize(attribution:, amount_cents:, additional_properties: nil)
+          # @type [Invoices::V2::InvoiceItemAttributionCreate]
+          @attribution = attribution
+          # @type [Integer]
+          @amount_cents = amount_cents
+          # @type [OpenStruct] Additional properties unmapped to the current class definition
+          @additional_properties = additional_properties
+        end
+
+        # Deserialize a JSON object to an instance of InvoiceItemCreate
+        #
+        # @param json_object [JSON]
+        # @return [Invoices::V2::InvoiceItemCreate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          if parsed_json["attribution"].nil?
+            attribution = nil
+          else
+            attribution = parsed_json["attribution"].to_json
+            attribution = Invoices::V2::InvoiceItemAttributionCreate.from_json(json_object: attribution)
+          end
+          amount_cents = struct.amount_cents
+          new(attribution: attribution, amount_cents: amount_cents, additional_properties: struct)
+        end
+
+        # Serialize an instance of InvoiceItemCreate to a JSON object
+        #
+        # @return [JSON]
+        def to_json(*_args)
+          { "attribution": @attribution, "amount_cents": @amount_cents }.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:)
+          Invoices::V2::InvoiceItemAttributionCreate.validate_raw(obj: obj.attribution)
+          obj.amount_cents.is_a?(Integer) != false || raise("Passed value for field obj.amount_cents is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/requests.rb

@@ -20,7 +20,7 @@ module CandidApiClient
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "candidhealth",
-        "X-Fern-SDK-Version": "0.19.1-6de2b0d",
+        "X-Fern-SDK-Version": "0.20.0",
         "Authorization": "Bearer #{token}"
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|
@@ -46,7 +46,7 @@ module CandidApiClient
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "candidhealth",
-        "X-Fern-SDK-Version": "0.19.1-6de2b0d",
+        "X-Fern-SDK-Version": "0.20.0",
         "Authorization": "Bearer #{token}"
       }
       @conn = Faraday.new(@base_url, headers: @headers) do |faraday|

data/lib/types_export.rb

@@ -116,6 +116,11 @@ require_relative "candidhealth/guarantor/v_1/types/guarantor_base"
 require_relative "candidhealth/guarantor/v_1/types/guarantor"
 require_relative "candidhealth/guarantor/v_1/types/guarantor_create"
 require_relative "candidhealth/guarantor/v_1/types/encounter_has_existing_guarantor_error_type"
+require_relative "candidhealth/import_invoice/v_1/types/import_invoice"
+require_relative "candidhealth/import_invoice/v_1/types/create_import_invoice_request"
+require_relative "candidhealth/import_invoice/v_1/types/invoice_item_update_type"
+require_relative "candidhealth/import_invoice/v_1/types/invoice_item_info_update"
+require_relative "candidhealth/import_invoice/v_1/types/import_invoice_update_request"
 require_relative "candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_id"
 require_relative "candidhealth/insurance_adjudications/v_1/types/service_line_adjudication_id"
 require_relative "candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_create"
@@ -143,6 +148,8 @@ require_relative "candidhealth/invoices/v_2/types/invoice_status"
 require_relative "candidhealth/invoices/v_2/types/invoice_destination_metadata"
 require_relative "candidhealth/invoices/v_2/types/invoice"
 require_relative "candidhealth/invoices/v_2/types/invoice_info"
+require_relative "candidhealth/invoices/v_2/types/invoice_item_attribution_create"
+require_relative "candidhealth/invoices/v_2/types/invoice_item_create"
 require_relative "candidhealth/invoices/v_2/types/service_line_invoice_item"
 require_relative "candidhealth/invoices/v_2/types/claim_invoice_item"
 require_relative "candidhealth/invoices/v_2/types/claim_invoice_item_info"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 0.19.1.pre.6de2b0d
+  version: 0.20.0
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -322,6 +322,13 @@ files:
 - lib/candidhealth/identifiers/types/medicaid_provider_identifier.rb
 - lib/candidhealth/identifiers/types/medicare_provider_identifier.rb
 - lib/candidhealth/identifiers/types/updatable_identifier.rb
+- lib/candidhealth/import_invoice/client.rb
+- lib/candidhealth/import_invoice/v_1/client.rb
+- lib/candidhealth/import_invoice/v_1/types/create_import_invoice_request.rb
+- lib/candidhealth/import_invoice/v_1/types/import_invoice.rb
+- lib/candidhealth/import_invoice/v_1/types/import_invoice_update_request.rb
+- lib/candidhealth/import_invoice/v_1/types/invoice_item_info_update.rb
+- lib/candidhealth/import_invoice/v_1/types/invoice_item_update_type.rb
 - lib/candidhealth/individual/types/gender.rb
 - lib/candidhealth/individual/types/individual_base.rb
 - lib/candidhealth/individual/types/individual_id.rb
@@ -368,6 +375,8 @@ files:
 - lib/candidhealth/invoices/v_2/types/invoice_destination.rb
 - lib/candidhealth/invoices/v_2/types/invoice_destination_metadata.rb
 - lib/candidhealth/invoices/v_2/types/invoice_info.rb
+- lib/candidhealth/invoices/v_2/types/invoice_item_attribution_create.rb
+- lib/candidhealth/invoices/v_2/types/invoice_item_create.rb
 - lib/candidhealth/invoices/v_2/types/invoice_item_info.rb
 - lib/candidhealth/invoices/v_2/types/invoice_status.rb
 - lib/candidhealth/invoices/v_2/types/service_line_invoice_item.rb
@@ -500,9 +509,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: