candidhealth 1.0.0 → 1.3.0

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

@@ -19,6 +19,12 @@ module CandidApiClient
           # @return [String] A human readable error explaining why this charge capture Claim Creation failed
           #  to create a claim.
           attr_reader :message
+          # @return [Boolean] Whether or not the error has been resolved as part of user workflows
+          attr_reader :resolved
+          # @return [String] A string denoting who resolved the error within candid's system.
+          attr_reader :resolved_by
+          # @return [String] A string denoting how or why an error was resolved.
+          attr_reader :resolution_reason
           # @return [String] The field of the corresponding underlying ChargeCapture that has a field that is
           #  failing validations,
           #  is not present but marked as required, or otherwise in error.
@@ -41,17 +47,23 @@ module CandidApiClient
           #  which case this field will be null.
           # @param message [String] A human readable error explaining why this charge capture Claim Creation failed
           #  to create a claim.
+          # @param resolved [Boolean] Whether or not the error has been resolved as part of user workflows
+          # @param resolved_by [String] A string denoting who resolved the error within candid's system.
+          # @param resolution_reason [String] A string denoting how or why an error was resolved.
           # @param field_in_error [String] The field of the corresponding underlying ChargeCapture that has a field that is
           #  failing validations,
           #  is not present but marked as required, or otherwise in error.
           # @param claim_creation_id [String] The ID of the ChargeCaptureClaimCreation associated with this Error.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError]
-          def initialize(id:, message:, claim_creation_id:, charge_capture_id: OMIT, field_in_error: OMIT,
-                         additional_properties: nil)
+          def initialize(id:, message:, claim_creation_id:, charge_capture_id: OMIT, resolved: OMIT, resolved_by: OMIT,
+                         resolution_reason: OMIT, field_in_error: OMIT, additional_properties: nil)
             @id = id
             @charge_capture_id = charge_capture_id if charge_capture_id != OMIT
             @message = message
+            @resolved = resolved if resolved != OMIT
+            @resolved_by = resolved_by if resolved_by != OMIT
+            @resolution_reason = resolution_reason if resolution_reason != OMIT
             @field_in_error = field_in_error if field_in_error != OMIT
             @claim_creation_id = claim_creation_id
             @additional_properties = additional_properties
@@ -59,6 +71,9 @@ module CandidApiClient
               "id": id,
               "charge_capture_id": charge_capture_id,
               "message": message,
+              "resolved": resolved,
+              "resolved_by": resolved_by,
+              "resolution_reason": resolution_reason,
               "field_in_error": field_in_error,
               "claim_creation_id": claim_creation_id
             }.reject do |_k, v|
@@ -75,12 +90,18 @@ module CandidApiClient
             id = struct["id"]
             charge_capture_id = struct["charge_capture_id"]
             message = struct["message"]
+            resolved = struct["resolved"]
+            resolved_by = struct["resolved_by"]
+            resolution_reason = struct["resolution_reason"]
             field_in_error = struct["field_in_error"]
             claim_creation_id = struct["claim_creation_id"]
             new(
               id: id,
               charge_capture_id: charge_capture_id,
               message: message,
+              resolved: resolved,
+              resolved_by: resolved_by,
+              resolution_reason: resolution_reason,
               field_in_error: field_in_error,
               claim_creation_id: claim_creation_id,
               additional_properties: struct
@@ -104,6 +125,9 @@ module CandidApiClient
             obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
             obj.charge_capture_id&.is_a?(String) != false || raise("Passed value for field obj.charge_capture_id is not the expected type, validation failed.")
             obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+            obj.resolved&.is_a?(Boolean) != false || raise("Passed value for field obj.resolved is not the expected type, validation failed.")
+            obj.resolved_by&.is_a?(String) != false || raise("Passed value for field obj.resolved_by is not the expected type, validation failed.")
+            obj.resolution_reason&.is_a?(String) != false || raise("Passed value for field obj.resolution_reason is not the expected type, validation failed.")
             obj.field_in_error&.is_a?(String) != false || raise("Passed value for field obj.field_in_error is not the expected type, validation failed.")
             obj.claim_creation_id.is_a?(String) != false || raise("Passed value for field obj.claim_creation_id is not the expected type, validation failed.")
           end

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

@@ -65,6 +65,34 @@ module CandidApiClient
           CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary.from_json(json_object: response.body)
         end
 
+        # @param charge_capture_bundle_error_id [String]
+        # @param resolved_by [String] A string, denoting who resolved the error for audit trail purposes.
+        # @param resolution_reason [String] A string denoting why or how the error was dealt with for audit trail purposes.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.charge_capture_bundles.v_1.resolve_charge_creation_error(charge_capture_bundle_error_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def resolve_charge_creation_error(charge_capture_bundle_error_id:, resolved_by: nil, resolution_reason: nil,
+                                          request_options: nil)
+          @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_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.body = {
+              **(request_options&.additional_body_parameters || {}),
+              resolved_by: resolved_by,
+              resolution_reason: resolution_reason
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/charge_capture_claim_creation/v1/error/#{charge_capture_bundle_error_id}"
+          end
+        end
+
         # @param limit [Integer] Maximum number of entities per page, defaults to 100.
         # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSortField] Defaults to created_at
         # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
@@ -206,6 +234,36 @@ module CandidApiClient
           end
         end
 
+        # @param charge_capture_bundle_error_id [String]
+        # @param resolved_by [String] A string, denoting who resolved the error for audit trail purposes.
+        # @param resolution_reason [String] A string denoting why or how the error was dealt with for audit trail purposes.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.charge_capture_bundles.v_1.resolve_charge_creation_error(charge_capture_bundle_error_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+        def resolve_charge_creation_error(charge_capture_bundle_error_id:, resolved_by: nil, resolution_reason: nil,
+                                          request_options: nil)
+          Async do
+            @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_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.body = {
+                **(request_options&.additional_body_parameters || {}),
+                resolved_by: resolved_by,
+                resolution_reason: resolution_reason
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/charge_capture_claim_creation/v1/error/#{charge_capture_bundle_error_id}"
+            end
+          end
+        end
+
         # @param limit [Integer] Maximum number of entities per page, defaults to 100.
         # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSortField] Defaults to created_at
         # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.

data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create_optional.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "claim_frequency_type_code"
+require_relative "../../../commons/types/claim_submission_payer_responsibility_type"
+require_relative "../../../commons/types/intended_submission_medium"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module ClaimSubmission
+    module V1
+      module Types
+        # Data about each external submission.
+        class ClaimSubmissionRecordCreateOptional
+          # @return [DateTime] When the claim was submitted to the payer.
+          attr_reader :submitted_at
+          # @return [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          attr_reader :claim_frequency_code
+          # @return [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
+          attr_reader :payer_responsibility
+          # @return [CandidApiClient::Commons::Types::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
+          #  If omitted, defaults to electronic.
+          attr_reader :intended_submission_medium
+          # @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 submitted_at [DateTime] When the claim was submitted to the payer.
+          # @param claim_frequency_code [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          # @param payer_responsibility [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
+          # @param intended_submission_medium [CandidApiClient::Commons::Types::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
+          #  If omitted, defaults to electronic.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional]
+          def initialize(submitted_at: OMIT, claim_frequency_code: OMIT, payer_responsibility: OMIT,
+                         intended_submission_medium: OMIT, additional_properties: nil)
+            @submitted_at = submitted_at if submitted_at != OMIT
+            @claim_frequency_code = claim_frequency_code if claim_frequency_code != OMIT
+            @payer_responsibility = payer_responsibility if payer_responsibility != OMIT
+            @intended_submission_medium = intended_submission_medium if intended_submission_medium != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "submitted_at": submitted_at,
+              "claim_frequency_code": claim_frequency_code,
+              "payer_responsibility": payer_responsibility,
+              "intended_submission_medium": intended_submission_medium
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ClaimSubmissionRecordCreateOptional
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            submitted_at = (DateTime.parse(parsed_json["submitted_at"]) unless parsed_json["submitted_at"].nil?)
+            claim_frequency_code = struct["claim_frequency_code"]
+            payer_responsibility = struct["payer_responsibility"]
+            intended_submission_medium = struct["intended_submission_medium"]
+            new(
+              submitted_at: submitted_at,
+              claim_frequency_code: claim_frequency_code,
+              payer_responsibility: payer_responsibility,
+              intended_submission_medium: intended_submission_medium,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ClaimSubmissionRecordCreateOptional 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.submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.submitted_at is not the expected type, validation failed.")
+            obj.claim_frequency_code&.is_a?(CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
+            obj.payer_responsibility&.is_a?(CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType) != false || raise("Passed value for field obj.payer_responsibility is not the expected type, validation failed.")
+            obj.intended_submission_medium&.is_a?(CandidApiClient::Commons::Types::IntendedSubmissionMedium) != false || raise("Passed value for field obj.intended_submission_medium is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/claim_submission/v_1/types/external_claim_submission_create_optional.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "claim_submission_record_create_optional"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module ClaimSubmission
+    module V1
+      module Types
+        class ExternalClaimSubmissionCreateOptional
+          # @return [DateTime] When the claim was created in the external system.
+          attr_reader :claim_created_at
+          # @return [String] The Patient Control Number sent on the claim to the payer. To guarantee
+          #  compatibility with all payers, this field must consist
+          #  only of uppercase letters and numbers and be no more than 14 characters long.
+          attr_reader :patient_control_number
+          # @return [Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>] A successful claim submission record will be created for each value provided.
+          #  An empty list may be provided for cases where the claim originated in an
+          #  external system but was never submitted to a payer.
+          attr_reader :submission_records
+          # @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 claim_created_at [DateTime] When the claim was created in the external system.
+          # @param patient_control_number [String] The Patient Control Number sent on the claim to the payer. To guarantee
+          #  compatibility with all payers, this field must consist
+          #  only of uppercase letters and numbers and be no more than 14 characters long.
+          # @param submission_records [Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>] A successful claim submission record will be created for each value provided.
+          #  An empty list may be provided for cases where the claim originated in an
+          #  external system but was never submitted to a payer.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::ClaimSubmission::V1::Types::ExternalClaimSubmissionCreateOptional]
+          def initialize(submission_records:, claim_created_at: OMIT, patient_control_number: OMIT,
+                         additional_properties: nil)
+            @claim_created_at = claim_created_at if claim_created_at != OMIT
+            @patient_control_number = patient_control_number if patient_control_number != OMIT
+            @submission_records = submission_records
+            @additional_properties = additional_properties
+            @_field_set = {
+              "claim_created_at": claim_created_at,
+              "patient_control_number": patient_control_number,
+              "submission_records": submission_records
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of
+          #  ExternalClaimSubmissionCreateOptional
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::ClaimSubmission::V1::Types::ExternalClaimSubmissionCreateOptional]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            claim_created_at = unless parsed_json["claim_created_at"].nil?
+                                 DateTime.parse(parsed_json["claim_created_at"])
+                               end
+            patient_control_number = struct["patient_control_number"]
+            submission_records = parsed_json["submission_records"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional.from_json(json_object: item)
+            end
+            new(
+              claim_created_at: claim_created_at,
+              patient_control_number: patient_control_number,
+              submission_records: submission_records,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ExternalClaimSubmissionCreateOptional 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.claim_created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.claim_created_at is not the expected type, validation failed.")
+            obj.patient_control_number&.is_a?(String) != false || raise("Passed value for field obj.patient_control_number is not the expected type, validation failed.")
+            obj.submission_records.is_a?(Array) != false || raise("Passed value for field obj.submission_records is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/commons/types/phone_number_optional.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "phone_number_type"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Commons
+    module Types
+      class PhoneNumberOptional
+        # @return [String]
+        attr_reader :number
+        # @return [CandidApiClient::Commons::Types::PhoneNumberType]
+        attr_reader :type
+        # @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 number [String]
+        # @param type [CandidApiClient::Commons::Types::PhoneNumberType]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [CandidApiClient::Commons::Types::PhoneNumberOptional]
+        def initialize(number: OMIT, type: OMIT, additional_properties: nil)
+          @number = number if number != OMIT
+          @type = type if type != OMIT
+          @additional_properties = additional_properties
+          @_field_set = { "number": number, "type": type }.reject do |_k, v|
+            v == OMIT
+          end
+        end
+
+        # Deserialize a JSON object to an instance of PhoneNumberOptional
+        #
+        # @param json_object [String]
+        # @return [CandidApiClient::Commons::Types::PhoneNumberOptional]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          number = struct["number"]
+          type = struct["type"]
+          new(
+            number: number,
+            type: type,
+            additional_properties: struct
+          )
+        end
+
+        # Serialize an instance of PhoneNumberOptional 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.number&.is_a?(String) != false || raise("Passed value for field obj.number is not the expected type, validation failed.")
+          obj.type&.is_a?(CandidApiClient::Commons::Types::PhoneNumberType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/commons/types/procedure_modifier.rb

@@ -397,10 +397,12 @@ module CandidApiClient
         W_1 = "W1"
         W_2 = "W2"
         W_3 = "W3"
+        X_4 = "X4"
         XE = "XE"
         XP = "XP"
         XS = "XS"
         XU = "XU"
+        XY = "XY"
       end
     end
   end

data/lib/candidhealth/commons/types/street_address_long_zip_optional.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "state"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Commons
+    module Types
+      class StreetAddressLongZipOptional
+        # @return [String] 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4
+        attr_reader :zip_plus_four_code
+        # @return [String]
+        attr_reader :address_1
+        # @return [String]
+        attr_reader :address_2
+        # @return [String]
+        attr_reader :city
+        # @return [CandidApiClient::Commons::Types::State]
+        attr_reader :state
+        # @return [String] 5-digit zip code
+        attr_reader :zip_code
+        # @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 zip_plus_four_code [String] 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4
+        # @param address_1 [String]
+        # @param address_2 [String]
+        # @param city [String]
+        # @param state [CandidApiClient::Commons::Types::State]
+        # @param zip_code [String] 5-digit zip code
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [CandidApiClient::Commons::Types::StreetAddressLongZipOptional]
+        def initialize(zip_plus_four_code: OMIT, address_1: OMIT, address_2: OMIT, city: OMIT, state: OMIT,
+                       zip_code: OMIT, additional_properties: nil)
+          @zip_plus_four_code = zip_plus_four_code if zip_plus_four_code != OMIT
+          @address_1 = address_1 if address_1 != OMIT
+          @address_2 = address_2 if address_2 != OMIT
+          @city = city if city != OMIT
+          @state = state if state != OMIT
+          @zip_code = zip_code if zip_code != OMIT
+          @additional_properties = additional_properties
+          @_field_set = {
+            "zip_plus_four_code": zip_plus_four_code,
+            "address1": address_1,
+            "address2": address_2,
+            "city": city,
+            "state": state,
+            "zip_code": zip_code
+          }.reject do |_k, v|
+            v == OMIT
+          end
+        end
+
+        # Deserialize a JSON object to an instance of StreetAddressLongZipOptional
+        #
+        # @param json_object [String]
+        # @return [CandidApiClient::Commons::Types::StreetAddressLongZipOptional]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          zip_plus_four_code = struct["zip_plus_four_code"]
+          address_1 = struct["address1"]
+          address_2 = struct["address2"]
+          city = struct["city"]
+          state = struct["state"]
+          zip_code = struct["zip_code"]
+          new(
+            zip_plus_four_code: zip_plus_four_code,
+            address_1: address_1,
+            address_2: address_2,
+            city: city,
+            state: state,
+            zip_code: zip_code,
+            additional_properties: struct
+          )
+        end
+
+        # Serialize an instance of StreetAddressLongZipOptional 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.zip_plus_four_code&.is_a?(String) != false || raise("Passed value for field obj.zip_plus_four_code is not the expected type, validation failed.")
+          obj.address_1&.is_a?(String) != false || raise("Passed value for field obj.address_1 is not the expected type, validation failed.")
+          obj.address_2&.is_a?(String) != false || raise("Passed value for field obj.address_2 is not the expected type, validation failed.")
+          obj.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.")
+          obj.state&.is_a?(CandidApiClient::Commons::Types::State) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+          obj.zip_code&.is_a?(String) != false || raise("Passed value for field obj.zip_code is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/custom_schemas/v_1/types/schema_instance_optional.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module CustomSchemas
+    module V1
+      module Types
+        class SchemaInstanceOptional
+          # @return [String] The schema to which the content must adhere.
+          attr_reader :schema_id
+          # @return [Hash{String => Object}] A set of key-value pairs that adhere to the naming and type convention of the
+          #  schema. Not all keys in the schema must be included, but attaching any key that
+          #  does not exist in the schema or attaching a key with the incorrect value type
+          #  will result in errors.
+          attr_reader :content
+          # @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 schema_id [String] The schema to which the content must adhere.
+          # @param content [Hash{String => Object}] A set of key-value pairs that adhere to the naming and type convention of the
+          #  schema. Not all keys in the schema must be included, but attaching any key that
+          #  does not exist in the schema or attaching a key with the incorrect value type
+          #  will result in errors.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional]
+          def initialize(schema_id: OMIT, content: OMIT, additional_properties: nil)
+            @schema_id = schema_id if schema_id != OMIT
+            @content = content if content != OMIT
+            @additional_properties = additional_properties
+            @_field_set = { "schema_id": schema_id, "content": content }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of SchemaInstanceOptional
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            schema_id = struct["schema_id"]
+            content = struct["content"]
+            new(
+              schema_id: schema_id,
+              content: content,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of SchemaInstanceOptional 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.schema_id&.is_a?(String) != false || raise("Passed value for field obj.schema_id is not the expected type, validation failed.")
+            obj.content&.is_a?(Hash) != false || raise("Passed value for field obj.content is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end