candidhealth 0.41.2 → 0.41.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a462fcf21d7f061320986e29871df7a4c81ef11d6738fdaa2fb2ae682e7ac58
-  data.tar.gz: d0b72d8003bdf6703cfbf4d95936eb546545de79b5752fe046a168cc2eb65b3e
+  metadata.gz: be4c5cd730f0e512cc91aad03321e192751715d9266e41716532a60bd282b067
+  data.tar.gz: e816365693926d5d4caba7714a8f2b8b18ecc05154ba18ec69a447c23c976363
 SHA512:
-  metadata.gz: bfa7481054bc894f77700448180378d988d69788a37f1a61ea35a86c1a2fa2e3e70dd5c2d1b9e69baadde0f3d51b27c01f683e9a6c7dd51c8387453a93513af4
-  data.tar.gz: 3a41ba9039fc607ecab6eafb800ced419b13d40e6fe049343f4c63a0d0471a044067014fdbac7a4480716ded7eed41df64adc5adf52c5a9e55cf13b934fa6e3b
+  metadata.gz: 462519820e6e0c3769bbb44f90cc2cc5f93278b7b6fcb212815207b94cd99cf0ee56ba27669a506d1b5156035b46494c2d5fbee85a81be7a0a5964fe9605813f
+  data.tar.gz: 8f0f17df316647ce78d8b58229f0bcc5806112b4adac66f15f1194aea6c8d4b651dd6fc5a227e5959a1b2e18cc351ef866d877fcfaeb1dbd73d3d58674330459

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

@@ -2,11 +2,11 @@
 
 require_relative "../../../requests"
 require_relative "types/charge_capture_data"
-require "date"
 require_relative "types/charge_capture_status"
 require_relative "types/charge_capture"
 require_relative "types/charge_capture_sort_field"
 require_relative "../../commons/types/sort_direction"
+require "date"
 require_relative "types/charge_capture_page"
 require_relative "types/charge_capture_post_billed_change"
 require "async"
@@ -281,8 +281,6 @@ module CandidApiClient
         # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
         #  system (e.g. the EHR visit page). Send full URL format for the external link
         #  (e.g. https://emr_charge_capture_url.com/123).
-        # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-        #  This date must be the local date in the timezone where the service occurred.
         # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
         # @param request_options [CandidApiClient::RequestOptions]
@@ -293,12 +291,10 @@ module CandidApiClient
         #    data: {  },
         #    charge_external_id: "string",
         #    ehr_source_url: "string",
-        #    date_of_service: DateTime.parse(2023-01-15),
         #    patient_external_id: "string",
         #    status: PLANNED
         #  )
-        def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil,
-                   date_of_service: nil, request_options: nil)
+        def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil, request_options: nil)
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -312,7 +308,6 @@ module CandidApiClient
               data: data,
               charge_external_id: charge_external_id,
               ehr_source_url: ehr_source_url,
-              date_of_service: date_of_service,
               patient_external_id: patient_external_id,
               status: status
             }.compact
@@ -601,8 +596,6 @@ module CandidApiClient
         #  https://emr_charge_capture_url.com/123).
         # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
-        # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-        #  This date must be the local date in the timezone where the service occurred.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
         # @example
@@ -613,11 +606,10 @@ module CandidApiClient
         #    charge_external_id: "string",
         #    ehr_source_url: "string",
         #    patient_external_id: "string",
-        #    status: PLANNED,
-        #    date_of_service: DateTime.parse(2023-01-15)
+        #    status: PLANNED
         #  )
         def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
-                   patient_external_id: nil, status: nil, date_of_service: nil, request_options: nil)
+                   patient_external_id: nil, status: nil, request_options: nil)
           response = @request_client.conn.patch do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -632,8 +624,7 @@ module CandidApiClient
               charge_external_id: charge_external_id,
               ehr_source_url: ehr_source_url,
               patient_external_id: patient_external_id,
-              status: status,
-              date_of_service: date_of_service
+              status: status
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
                                                request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
@@ -1014,8 +1005,6 @@ module CandidApiClient
         # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
         #  system (e.g. the EHR visit page). Send full URL format for the external link
         #  (e.g. https://emr_charge_capture_url.com/123).
-        # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-        #  This date must be the local date in the timezone where the service occurred.
         # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
         # @param request_options [CandidApiClient::RequestOptions]
@@ -1026,12 +1015,10 @@ module CandidApiClient
         #    data: {  },
         #    charge_external_id: "string",
         #    ehr_source_url: "string",
-        #    date_of_service: DateTime.parse(2023-01-15),
         #    patient_external_id: "string",
         #    status: PLANNED
         #  )
-        def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil,
-                   date_of_service: nil, request_options: nil)
+        def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil, request_options: nil)
           Async do
             response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1046,7 +1033,6 @@ module CandidApiClient
                 data: data,
                 charge_external_id: charge_external_id,
                 ehr_source_url: ehr_source_url,
-                date_of_service: date_of_service,
                 patient_external_id: patient_external_id,
                 status: status
               }.compact
@@ -1338,8 +1324,6 @@ module CandidApiClient
         #  https://emr_charge_capture_url.com/123).
         # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
-        # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-        #  This date must be the local date in the timezone where the service occurred.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
         # @example
@@ -1350,11 +1334,10 @@ module CandidApiClient
         #    charge_external_id: "string",
         #    ehr_source_url: "string",
         #    patient_external_id: "string",
-        #    status: PLANNED,
-        #    date_of_service: DateTime.parse(2023-01-15)
+        #    status: PLANNED
         #  )
         def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
-                   patient_external_id: nil, status: nil, date_of_service: nil, request_options: nil)
+                   patient_external_id: nil, status: nil, request_options: nil)
           Async do
             response = @request_client.conn.patch do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1370,8 +1353,7 @@ module CandidApiClient
                 charge_external_id: charge_external_id,
                 ehr_source_url: ehr_source_url,
                 patient_external_id: patient_external_id,
-                status: status,
-                date_of_service: date_of_service
+                status: status
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
                                                  request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"

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

@@ -2,7 +2,6 @@
 
 require_relative "charge_capture_status"
 require_relative "charge_capture_data"
-require "date"
 require_relative "charge_capture_error"
 require_relative "charge_capture_post_billed_change"
 require "ostruct"
@@ -25,9 +24,6 @@ module CandidApiClient
           attr_reader :charge_external_id
           # @return [String]
           attr_reader :ehr_source_url
-          # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-          #  This date must be the local date in the timezone where the service occurred.
-          attr_reader :date_of_service
           # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError]
           attr_reader :error
           # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange>]
@@ -48,22 +44,19 @@ module CandidApiClient
           # @param patient_external_id [String]
           # @param charge_external_id [String]
           # @param ehr_source_url [String]
-          # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-          #  This date must be the local date in the timezone where the service occurred.
           # @param error [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError]
           # @param updates [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange>]
           # @param bundle_id [String]
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
           def initialize(id:, status:, charge_capture_data:, patient_external_id:, charge_external_id:, updates:,
-                         ehr_source_url: OMIT, date_of_service: OMIT, error: OMIT, bundle_id: OMIT, additional_properties: nil)
+                         ehr_source_url: OMIT, error: OMIT, bundle_id: OMIT, additional_properties: nil)
             @id = id
             @status = status
             @charge_capture_data = charge_capture_data
             @patient_external_id = patient_external_id
             @charge_external_id = charge_external_id
             @ehr_source_url = ehr_source_url if ehr_source_url != OMIT
-            @date_of_service = date_of_service if date_of_service != OMIT
             @error = error if error != OMIT
             @updates = updates
             @bundle_id = bundle_id if bundle_id != OMIT
@@ -75,7 +68,6 @@ module CandidApiClient
               "patient_external_id": patient_external_id,
               "charge_external_id": charge_external_id,
               "ehr_source_url": ehr_source_url,
-              "date_of_service": date_of_service,
               "error": error,
               "updates": updates,
               "bundle_id": bundle_id
@@ -102,7 +94,6 @@ module CandidApiClient
             patient_external_id = struct["patient_external_id"]
             charge_external_id = struct["charge_external_id"]
             ehr_source_url = struct["ehr_source_url"]
-            date_of_service = (Date.parse(parsed_json["date_of_service"]) unless parsed_json["date_of_service"].nil?)
             if parsed_json["error"].nil?
               error = nil
             else
@@ -121,7 +112,6 @@ module CandidApiClient
               patient_external_id: patient_external_id,
               charge_external_id: charge_external_id,
               ehr_source_url: ehr_source_url,
-              date_of_service: date_of_service,
               error: error,
               updates: updates,
               bundle_id: bundle_id,
@@ -149,7 +139,6 @@ module CandidApiClient
             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.charge_external_id.is_a?(String) != false || raise("Passed value for field obj.charge_external_id is not the expected type, validation failed.")
             obj.ehr_source_url&.is_a?(String) != false || raise("Passed value for field obj.ehr_source_url is not the expected type, validation failed.")
-            obj.date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
             obj.error.nil? || CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError.validate_raw(obj: obj.error)
             obj.updates.is_a?(Array) != false || raise("Passed value for field obj.updates is not the expected type, validation failed.")
             obj.bundle_id&.is_a?(String) != false || raise("Passed value for field obj.bundle_id is not the expected type, validation failed.")

data/lib/candidhealth/charge_capture/v_1/types/charge_capture_status.rb

@@ -9,9 +9,7 @@ module CandidApiClient
           NOT_BILLABLE = "not-billable"
           BILLABLE = "billable"
           ABORTED = "aborted"
-          BILLED = "billed"
           ENTERED_IN_ERROR = "entered-in-error"
-          UNKNOWN = "unknown"
         end
       end
     end

data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle.rb

@@ -18,6 +18,10 @@ module CandidApiClient
           # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
           #  Claim
           attr_reader :status
+          # @return [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
+          #  based on the bundling configuration.
+          #  Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
+          attr_reader :characteristics
           # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
           attr_reader :charge_captures
           # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
@@ -36,17 +40,21 @@ module CandidApiClient
           # @param created_encounter_id [String]
           # @param status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
           #  Claim
+          # @param characteristics [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
+          #  based on the bundling configuration.
+          #  Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
           # @param charge_captures [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
           # @param errors [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
           #  Errors can correspond to the Bundle as a whole or specific underlying Charge
           #  Captures.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
-          def initialize(id:, status:, charge_captures:, errors:, created_encounter_id: OMIT,
+          def initialize(id:, status:, characteristics:, charge_captures:, errors:, created_encounter_id: OMIT,
                          additional_properties: nil)
             @id = id
             @created_encounter_id = created_encounter_id if created_encounter_id != OMIT
             @status = status
+            @characteristics = characteristics
             @charge_captures = charge_captures
             @errors = errors
             @additional_properties = additional_properties
@@ -54,6 +62,7 @@ module CandidApiClient
               "id": id,
               "created_encounter_id": created_encounter_id,
               "status": status,
+              "characteristics": characteristics,
               "charge_captures": charge_captures,
               "errors": errors
             }.reject do |_k, v|
@@ -71,6 +80,7 @@ module CandidApiClient
             id = struct["id"]
             created_encounter_id = struct["created_encounter_id"]
             status = struct["status"]
+            characteristics = struct["characteristics"]
             charge_captures = parsed_json["charge_captures"]&.map do |item|
               item = item.to_json
               CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: item)
@@ -83,6 +93,7 @@ module CandidApiClient
               id: id,
               created_encounter_id: created_encounter_id,
               status: status,
+              characteristics: characteristics,
               charge_captures: charge_captures,
               errors: errors,
               additional_properties: struct
@@ -106,6 +117,7 @@ module CandidApiClient
             obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
             obj.created_encounter_id&.is_a?(String) != false || raise("Passed value for field obj.created_encounter_id is not the expected type, validation failed.")
             obj.status.is_a?(CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+            obj.characteristics.is_a?(Hash) != false || raise("Passed value for field obj.characteristics is not the expected type, validation failed.")
             obj.charge_captures.is_a?(Array) != false || raise("Passed value for field obj.charge_captures is not the expected type, validation failed.")
             obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
           end

data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle_status.rb

@@ -6,11 +6,11 @@ module CandidApiClient
       module Types
         class ChargeCaptureBundleStatus
           NOT_STARTED = "not-started"
-          IN_PROGRESS = "in-progress"
           IN_ERROR = "in-error"
           SUCCESSFUL = "successful"
           SUCCESSFUL_DRY_RUN = "successful-dry-run"
           ABORTED = "aborted"
+          HELD = "held"
         end
       end
     end

data/lib/candidhealth/superbills/client.rb

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

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require "date"
+require_relative "../../commons/types/street_address_short_zip"
+require_relative "types/superbill_response"
+require "async"
+
+module CandidApiClient
+  module Superbills
+    module V1
+      class V1Client
+        # @return [CandidApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::RequestClient]
+        # @return [CandidApiClient::Superbills::V1::V1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # @param patient_external_id [String] Empty string not allowed
+        # @param date_range_min [Date] Minimum (inclusive) date selected for the superbill
+        # @param date_range_max [Date] Maximum (inclusive) date selected for the superbill
+        # @param pay_to_address [Hash] Address that will be displayed on the superbill as the 'Pay to' Address. If not
+        #  provided this value will be set from available encounter data.Request of type CandidApiClient::Commons::Types::StreetAddressShortZip, as a Hash
+        #   * :zip_plus_four_code (String)
+        #   * :address_1 (String)
+        #   * :address_2 (String)
+        #   * :city (String)
+        #   * :state (CandidApiClient::Commons::Types::State)
+        #   * :zip_code (String)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.superbills.v_1.create_superbill(
+        #    patient_external_id: "string",
+        #    date_range_min: DateTime.parse(2023-01-15),
+        #    date_range_max: DateTime.parse(2023-01-15),
+        #    pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }
+        #  )
+        def create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil,
+                             request_options: nil)
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              patient_external_id: patient_external_id,
+              date_range_min: date_range_min,
+              date_range_max: date_range_max,
+              pay_to_address: pay_to_address
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/superbill/v1"
+          end
+          CandidApiClient::Superbills::V1::Types::SuperbillResponse.from_json(json_object: response.body)
+        end
+      end
+
+      class AsyncV1Client
+        # @return [CandidApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [CandidApiClient::AsyncRequestClient]
+        # @return [CandidApiClient::Superbills::V1::AsyncV1Client]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # @param patient_external_id [String] Empty string not allowed
+        # @param date_range_min [Date] Minimum (inclusive) date selected for the superbill
+        # @param date_range_max [Date] Maximum (inclusive) date selected for the superbill
+        # @param pay_to_address [Hash] Address that will be displayed on the superbill as the 'Pay to' Address. If not
+        #  provided this value will be set from available encounter data.Request of type CandidApiClient::Commons::Types::StreetAddressShortZip, as a Hash
+        #   * :zip_plus_four_code (String)
+        #   * :address_1 (String)
+        #   * :address_2 (String)
+        #   * :city (String)
+        #   * :state (CandidApiClient::Commons::Types::State)
+        #   * :zip_code (String)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.superbills.v_1.create_superbill(
+        #    patient_external_id: "string",
+        #    date_range_min: DateTime.parse(2023-01-15),
+        #    date_range_max: DateTime.parse(2023-01-15),
+        #    pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }
+        #  )
+        def create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil,
+                             request_options: nil)
+          Async do
+            response = @request_client.conn.post do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.body = {
+                **(request_options&.additional_body_parameters || {}),
+                patient_external_id: patient_external_id,
+                date_range_min: date_range_min,
+                date_range_max: date_range_max,
+                pay_to_address: pay_to_address
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/superbill/v1"
+            end
+            CandidApiClient::Superbills::V1::Types::SuperbillResponse.from_json(json_object: response.body)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/superbills/v_1/types/superbill.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Superbills
+    module V1
+      module Types
+        class Superbill
+          # @return [String] Primary id of the superbill.
+          attr_reader :superbill_id
+          # @return [String] external_id of the patient.
+          attr_reader :patient_external_id
+          # @return [String] Authenticated URL for downloading the generated superbill file.
+          attr_reader :authed_url
+          # @return [Date] Minimum (inclusive) date selected for this superbill.
+          attr_reader :date_range_min
+          # @return [Date] Maximum (inclusive) date selected for this superbill.
+          attr_reader :date_range_max
+          # @return [String] Original filename of the superbill.
+          attr_reader :file_name
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param superbill_id [String] Primary id of the superbill.
+          # @param patient_external_id [String] external_id of the patient.
+          # @param authed_url [String] Authenticated URL for downloading the generated superbill file.
+          # @param date_range_min [Date] Minimum (inclusive) date selected for this superbill.
+          # @param date_range_max [Date] Maximum (inclusive) date selected for this superbill.
+          # @param file_name [String] Original filename of the superbill.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Superbills::V1::Types::Superbill]
+          def initialize(superbill_id:, patient_external_id:, authed_url:, date_range_min:, date_range_max:,
+                         file_name:, additional_properties: nil)
+            @superbill_id = superbill_id
+            @patient_external_id = patient_external_id
+            @authed_url = authed_url
+            @date_range_min = date_range_min
+            @date_range_max = date_range_max
+            @file_name = file_name
+            @additional_properties = additional_properties
+            @_field_set = {
+              "superbill_id": superbill_id,
+              "patient_external_id": patient_external_id,
+              "authed_url": authed_url,
+              "date_range_min": date_range_min,
+              "date_range_max": date_range_max,
+              "file_name": file_name
+            }
+          end
+
+          # Deserialize a JSON object to an instance of Superbill
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Superbills::V1::Types::Superbill]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            superbill_id = struct["superbill_id"]
+            patient_external_id = struct["patient_external_id"]
+            authed_url = struct["authed_url"]
+            date_range_min = (Date.parse(parsed_json["date_range_min"]) unless parsed_json["date_range_min"].nil?)
+            date_range_max = (Date.parse(parsed_json["date_range_max"]) unless parsed_json["date_range_max"].nil?)
+            file_name = struct["file_name"]
+            new(
+              superbill_id: superbill_id,
+              patient_external_id: patient_external_id,
+              authed_url: authed_url,
+              date_range_min: date_range_min,
+              date_range_max: date_range_max,
+              file_name: file_name,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of Superbill 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.superbill_id.is_a?(String) != false || raise("Passed value for field obj.superbill_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.authed_url.is_a?(String) != false || raise("Passed value for field obj.authed_url is not the expected type, validation failed.")
+            obj.date_range_min.is_a?(Date) != false || raise("Passed value for field obj.date_range_min is not the expected type, validation failed.")
+            obj.date_range_max.is_a?(Date) != false || raise("Passed value for field obj.date_range_max is not the expected type, validation failed.")
+            obj.file_name.is_a?(String) != false || raise("Passed value for field obj.file_name is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/superbills/v_1/types/superbill_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "superbill"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Superbills
+    module V1
+      module Types
+        class SuperbillResponse
+          # @return [Array<CandidApiClient::Superbills::V1::Types::Superbill>] Each object represents a single Superbill for a single billing provider.
+          attr_reader :superbills
+          # @return [OpenStruct] Additional properties unmapped to the current class definition
+          attr_reader :additional_properties
+          # @return [Object]
+          attr_reader :_field_set
+          protected :_field_set
+
+          OMIT = Object.new
+
+          # @param superbills [Array<CandidApiClient::Superbills::V1::Types::Superbill>] Each object represents a single Superbill for a single billing provider.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
+          def initialize(superbills:, additional_properties: nil)
+            @superbills = superbills
+            @additional_properties = additional_properties
+            @_field_set = { "superbills": superbills }
+          end
+
+          # Deserialize a JSON object to an instance of SuperbillResponse
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Superbills::V1::Types::SuperbillResponse]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            superbills = parsed_json["superbills"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Superbills::V1::Types::Superbill.from_json(json_object: item)
+            end
+            new(superbills: superbills, additional_properties: struct)
+          end
+
+          # Serialize an instance of SuperbillResponse 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.superbills.is_a?(Array) != false || raise("Passed value for field obj.superbills is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth.rb

@@ -34,6 +34,7 @@ require_relative "candidhealth/patient_refunds/client"
 require_relative "candidhealth/payer_plan_groups/client"
 require_relative "candidhealth/payers/client"
 require_relative "candidhealth/service_lines/client"
+require_relative "candidhealth/superbills/client"
 require_relative "candidhealth/tasks/client"
 require_relative "candidhealth/write_offs/client"
 require_relative "candidhealth/pre_encounter/client"
@@ -102,6 +103,8 @@ module CandidApiClient
     attr_reader :payers
     # @return [CandidApiClient::ServiceLines::Client]
     attr_reader :service_lines
+    # @return [CandidApiClient::Superbills::Client]
+    attr_reader :superbills
     # @return [CandidApiClient::Tasks::Client]
     attr_reader :tasks
     # @return [CandidApiClient::WriteOffs::Client]
@@ -169,6 +172,7 @@ module CandidApiClient
       @payer_plan_groups = CandidApiClient::PayerPlanGroups::Client.new(request_client: @request_client)
       @payers = CandidApiClient::Payers::Client.new(request_client: @request_client)
       @service_lines = CandidApiClient::ServiceLines::Client.new(request_client: @request_client)
+      @superbills = CandidApiClient::Superbills::Client.new(request_client: @request_client)
       @tasks = CandidApiClient::Tasks::Client.new(request_client: @request_client)
       @write_offs = CandidApiClient::WriteOffs::Client.new(request_client: @request_client)
       @pre_encounter = CandidApiClient::PreEncounter::Client.new(request_client: @request_client)
@@ -238,6 +242,8 @@ module CandidApiClient
     attr_reader :payers
     # @return [CandidApiClient::ServiceLines::AsyncClient]
     attr_reader :service_lines
+    # @return [CandidApiClient::Superbills::AsyncClient]
+    attr_reader :superbills
     # @return [CandidApiClient::Tasks::AsyncClient]
     attr_reader :tasks
     # @return [CandidApiClient::WriteOffs::AsyncClient]
@@ -305,6 +311,7 @@ module CandidApiClient
       @payer_plan_groups = CandidApiClient::PayerPlanGroups::AsyncClient.new(request_client: @async_request_client)
       @payers = CandidApiClient::Payers::AsyncClient.new(request_client: @async_request_client)
       @service_lines = CandidApiClient::ServiceLines::AsyncClient.new(request_client: @async_request_client)
+      @superbills = CandidApiClient::Superbills::AsyncClient.new(request_client: @async_request_client)
       @tasks = CandidApiClient::Tasks::AsyncClient.new(request_client: @async_request_client)
       @write_offs = CandidApiClient::WriteOffs::AsyncClient.new(request_client: @async_request_client)
       @pre_encounter = CandidApiClient::PreEncounter::AsyncClient.new(request_client: @async_request_client)

data/lib/requests.rb

@@ -43,7 +43,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.2" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.5" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end
@@ -87,7 +87,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.2" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "0.41.5" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end

data/lib/types_export.rb

@@ -269,6 +269,8 @@ require_relative "candidhealth/service_lines/v_2/types/test_result_type"
 require_relative "candidhealth/service_lines/v_2/types/test_result"
 require_relative "candidhealth/service_lines/v_2/types/service_id_qualifier"
 require_relative "candidhealth/service_lines/v_2/types/measurement_unit_code"
+require_relative "candidhealth/superbills/v_1/types/superbill"
+require_relative "candidhealth/superbills/v_1/types/superbill_response"
 require_relative "candidhealth/tasks/v_3/types/task"
 require_relative "candidhealth/tasks/v_3/types/task_note"
 require_relative "candidhealth/tasks/v_3/types/task_assignment"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 0.41.2
+  version: 0.41.5
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-21 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -641,6 +641,10 @@ files:
 - lib/candidhealth/service_lines/v_2/types/service_line_update.rb
 - lib/candidhealth/service_lines/v_2/types/test_result.rb
 - lib/candidhealth/service_lines/v_2/types/test_result_type.rb
+- lib/candidhealth/superbills/client.rb
+- lib/candidhealth/superbills/v_1/client.rb
+- lib/candidhealth/superbills/v_1/types/superbill.rb
+- lib/candidhealth/superbills/v_1/types/superbill_response.rb
 - lib/candidhealth/tags/types/tag.rb
 - lib/candidhealth/tags/types/tag_color_enum.rb
 - lib/candidhealth/tags/types/tag_create.rb