candidhealth 0.21.0 → 0.24.0.pre.2a6d412

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

@@ -3,15 +3,11 @@
 require_relative "../../../requests"
 require_relative "types/create_import_invoice_request"
 require_relative "types/import_invoice"
-require_relative "../../commons/types/patient_external_id"
-require_relative "../../commons/types/encounter_external_id"
 require "date"
 require_relative "../../invoices/v_2/types/invoice_status"
 require_relative "../../invoices/v_2/types/invoice_sort_field"
 require_relative "../../commons/types/sort_direction"
-require_relative "../../commons/types/page_token"
 require_relative "types/import_invoices_page"
-require_relative "../../commons/types/invoice_id"
 require_relative "types/import_invoice_update_request"
 require "async"
 
@@ -19,58 +15,88 @@ module CandidApiClient
   module ImportInvoice
     module V1
       class V1Client
+        # @return [CandidApiClient::RequestClient]
         attr_reader :request_client
 
-        # @param request_client [RequestClient]
-        # @return [ImportInvoice::V1::V1Client]
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::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.
+        # 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)
+        # @param request [Hash] Request of type CandidApiClient::ImportInvoice::V1::Types::CreateImportInvoiceRequest, as a Hash
+        #   * :external_payment_account_config_id (String)
+        #   * :patient_external_id (String)
         #   * :external_customer_identifier (String)
         #   * :note (String)
         #   * :due_date (Date)
-        #   * :items (Array<Invoices::V2::InvoiceItemCreate>)
-        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :items (Array<CandidApiClient::Invoices::V2::Types::InvoiceItemCreate>)
+        #   * :status (CandidApiClient::Invoices::V2::Types::InvoiceStatus)
         #   * :external_identifier (String)
         #   * :customer_invoice_url (String)
-        # @param request_options [RequestOptions]
-        # @return [ImportInvoice::V1::ImportInvoice]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.import_invoice(request: { external_payment_account_config_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", patient_external_id: "string", external_customer_identifier: "string", note: "string", due_date: DateTime.parse(2023-01-15), items: [{  }], status: DRAFT, external_identifier: "string", customer_invoice_url: "string" })
         def import_invoice(request:, request_options: nil)
-          response = @request_client.conn.post("/api/import-invoice/v1") do |req|
+          response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/import-invoice/v1"
           end
-          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          CandidApiClient::ImportInvoice::V1::Types::ImportInvoice.from_json(json_object: response.body)
         end
 
-        # Returns all Invoices for the authenticated user's organziation with all filters applied.
+        # Returns all Invoices for the authenticated user's organziation with all filters
+        #  applied.
         #
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param encounter_external_id [Commons::ENCOUNTER_EXTERNAL_ID]
+        # @param patient_external_id [String]
+        # @param encounter_external_id [String]
         # @param note [String] partial match supported
         # @param due_date_before [Date] all invoices whose due date is before this due date, not inclusive
         # @param due_date_after [Date] all invoices whose due date is after this due date, not inclusive
-        # @param status [Invoices::V2::InvoiceStatus] all invoices that match any of the provided statuses
+        # @param status [CandidApiClient::Invoices::V2::Types::InvoiceStatus] all invoices that match any of the provided statuses
         # @param limit [Integer] Defaults to 100
-        # @param sort [Invoices::V2::InvoiceSortField] Defaults to created_at
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param request_options [RequestOptions]
-        # @return [ImportInvoice::V1::ImportInvoicesPage]
+        # @param sort [CandidApiClient::Invoices::V2::Types::InvoiceSortField] Defaults to created_at
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoicesPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.get_multi(
+        #    patient_external_id: "string",
+        #    encounter_external_id: "string",
+        #    note: "string",
+        #    due_date_before: DateTime.parse(2023-01-15),
+        #    due_date_after: DateTime.parse(2023-01-15),
+        #    status: DRAFT,
+        #    limit: 1,
+        #    sort: CREATED_AT,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(patient_external_id: nil, encounter_external_id: nil, note: nil, due_date_before: nil,
                       due_date_after: nil, status: nil, limit: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
-          response = @request_client.conn.get("/api/import-invoice/v1") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "patient_external_id": patient_external_id,
@@ -84,104 +110,154 @@ module CandidApiClient
               "sort_direction": sort_direction,
               "page_token": page_token
             }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/import-invoice/v1"
           end
-          ImportInvoice::V1::ImportInvoicesPage.from_json(json_object: response.body)
+          CandidApiClient::ImportInvoice::V1::Types::ImportInvoicesPage.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]
+        # @param invoice_id [String] InvoiceId to be returned
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.get(invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(invoice_id:, request_options: nil)
-          response = @request_client.conn.get("/api/import-invoice/v1/#{invoice_id}") do |req|
+          response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/import-invoice/v1/#{invoice_id}"
           end
-          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          CandidApiClient::ImportInvoice::V1::Types::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
+        # @param invoice_id [String]
+        # @param request [Hash] Request of type CandidApiClient::ImportInvoice::V1::Types::ImportInvoiceUpdateRequest, as a Hash
         #   * :customer_invoice_url (String)
-        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :status (CandidApiClient::Invoices::V2::Types::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]
+        #     * :update_type (CandidApiClient::ImportInvoice::V1::Types::InvoiceItemUpdateType)
+        #     * :items (Array<CandidApiClient::Invoices::V2::Types::InvoiceItemCreate>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.update(invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { customer_invoice_url: "string", status: DRAFT, note: "string", due_date: DateTime.parse(2023-01-15), items: { update_type: APPEND, items: [{  }] } })
         def update(invoice_id:, request:, request_options: nil)
-          response = @request_client.conn.patch("/api/import-invoice/v1/#{invoice_id}") do |req|
+          response = @request_client.conn.patch do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
             req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/import-invoice/v1/#{invoice_id}"
           end
-          ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+          CandidApiClient::ImportInvoice::V1::Types::ImportInvoice.from_json(json_object: response.body)
         end
       end
 
       class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
         attr_reader :request_client
 
-        # @param request_client [AsyncRequestClient]
-        # @return [ImportInvoice::V1::AsyncV1Client]
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::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.
+        # 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)
+        # @param request [Hash] Request of type CandidApiClient::ImportInvoice::V1::Types::CreateImportInvoiceRequest, as a Hash
+        #   * :external_payment_account_config_id (String)
+        #   * :patient_external_id (String)
         #   * :external_customer_identifier (String)
         #   * :note (String)
         #   * :due_date (Date)
-        #   * :items (Array<Invoices::V2::InvoiceItemCreate>)
-        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :items (Array<CandidApiClient::Invoices::V2::Types::InvoiceItemCreate>)
+        #   * :status (CandidApiClient::Invoices::V2::Types::InvoiceStatus)
         #   * :external_identifier (String)
         #   * :customer_invoice_url (String)
-        # @param request_options [RequestOptions]
-        # @return [ImportInvoice::V1::ImportInvoice]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.import_invoice(request: { external_payment_account_config_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", patient_external_id: "string", external_customer_identifier: "string", note: "string", due_date: DateTime.parse(2023-01-15), items: [{  }], status: DRAFT, external_identifier: "string", customer_invoice_url: "string" })
         def import_invoice(request:, request_options: nil)
           Async do
-            response = @request_client.conn.post("/api/import-invoice/v1") do |req|
+            response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/import-invoice/v1"
             end
-            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+            CandidApiClient::ImportInvoice::V1::Types::ImportInvoice.from_json(json_object: response.body)
           end
         end
 
-        # Returns all Invoices for the authenticated user's organziation with all filters applied.
+        # Returns all Invoices for the authenticated user's organziation with all filters
+        #  applied.
         #
-        # @param patient_external_id [Commons::PATIENT_EXTERNAL_ID]
-        # @param encounter_external_id [Commons::ENCOUNTER_EXTERNAL_ID]
+        # @param patient_external_id [String]
+        # @param encounter_external_id [String]
         # @param note [String] partial match supported
         # @param due_date_before [Date] all invoices whose due date is before this due date, not inclusive
         # @param due_date_after [Date] all invoices whose due date is after this due date, not inclusive
-        # @param status [Invoices::V2::InvoiceStatus] all invoices that match any of the provided statuses
+        # @param status [CandidApiClient::Invoices::V2::Types::InvoiceStatus] all invoices that match any of the provided statuses
         # @param limit [Integer] Defaults to 100
-        # @param sort [Invoices::V2::InvoiceSortField] Defaults to created_at
-        # @param sort_direction [Commons::SortDirection] Sort direction. Defaults to descending order
-        # @param page_token [Commons::PAGE_TOKEN]
-        # @param request_options [RequestOptions]
-        # @return [ImportInvoice::V1::ImportInvoicesPage]
+        # @param sort [CandidApiClient::Invoices::V2::Types::InvoiceSortField] Defaults to created_at
+        # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order
+        # @param page_token [String]
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoicesPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.get_multi(
+        #    patient_external_id: "string",
+        #    encounter_external_id: "string",
+        #    note: "string",
+        #    due_date_before: DateTime.parse(2023-01-15),
+        #    due_date_after: DateTime.parse(2023-01-15),
+        #    status: DRAFT,
+        #    limit: 1,
+        #    sort: CREATED_AT,
+        #    sort_direction: ASC,
+        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
+        #  )
         def get_multi(patient_external_id: nil, encounter_external_id: nil, note: nil, due_date_before: nil,
                       due_date_after: nil, status: nil, limit: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/import-invoice/v1") do |req|
+            response = @request_client.conn.get do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.params = {
                 **(request_options&.additional_query_parameters || {}),
                 "patient_external_id": patient_external_id,
@@ -195,49 +271,69 @@ module CandidApiClient
                 "sort_direction": sort_direction,
                 "page_token": page_token
               }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/import-invoice/v1"
             end
-            ImportInvoice::V1::ImportInvoicesPage.from_json(json_object: response.body)
+            CandidApiClient::ImportInvoice::V1::Types::ImportInvoicesPage.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]
+        # @param invoice_id [String] InvoiceId to be returned
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.get(invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def get(invoice_id:, request_options: nil)
           Async do
-            response = @request_client.conn.get("/api/import-invoice/v1/#{invoice_id}") do |req|
+            response = @request_client.conn.get do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/import-invoice/v1/#{invoice_id}"
             end
-            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+            CandidApiClient::ImportInvoice::V1::Types::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
+        # @param invoice_id [String]
+        # @param request [Hash] Request of type CandidApiClient::ImportInvoice::V1::Types::ImportInvoiceUpdateRequest, as a Hash
         #   * :customer_invoice_url (String)
-        #   * :status (Invoices::V2::InvoiceStatus)
+        #   * :status (CandidApiClient::Invoices::V2::Types::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]
+        #     * :update_type (CandidApiClient::ImportInvoice::V1::Types::InvoiceItemUpdateType)
+        #     * :items (Array<CandidApiClient::Invoices::V2::Types::InvoiceItemCreate>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::ImportInvoice::V1::Types::ImportInvoice]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.import_invoice.v_1.update(invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { customer_invoice_url: "string", status: DRAFT, note: "string", due_date: DateTime.parse(2023-01-15), items: { update_type: APPEND, items: [{  }] } })
         def update(invoice_id:, request:, request_options: nil)
           Async do
-            response = @request_client.conn.patch("/api/import-invoice/v1/#{invoice_id}") do |req|
+            response = @request_client.conn.patch do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
               req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
-              req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
               req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/import-invoice/v1/#{invoice_id}"
             end
-            ImportInvoice::V1::ImportInvoice.from_json(json_object: response.body)
+            CandidApiClient::ImportInvoice::V1::Types::ImportInvoice.from_json(json_object: response.body)
           end
         end
       end

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

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