candidhealth 0.34.1 → 0.34.2

data/lib/candidhealth/encounters/v_4/types/encounter.rb

@@ -94,9 +94,6 @@ module CandidApiClient
           attr_reader :subscriber_secondary
           # @return [String] Box 23 on the CMS-1500 claim form.
           attr_reader :prior_authorization_number
-          # @return [String] Human-readable description of the appointment type (ex: "Acupuncture -
-          #  Headaches").
-          attr_reader :appointment_type
           # @return [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
           attr_reader :responsible_party
           # @return [String] URL that links directly to the claim created in Candid.
@@ -178,6 +175,9 @@ module CandidApiClient
           #  to be made to you, not them.
           #  Box 27 on the CMS-1500 claim form.
           attr_reader :provider_accepts_assignment
+          # @return [String] Human-readable description of the appointment type (ex: "Acupuncture -
+          #  Headaches").
+          attr_reader :appointment_type
           # @return [Array<CandidApiClient::Encounters::V4::Types::Medication>]
           attr_reader :existing_medications
           # @return [CandidApiClient::Encounters::V4::Types::Vitals]
@@ -286,8 +286,6 @@ module CandidApiClient
           #  to define self-pay claims.
           # @param subscriber_secondary [CandidApiClient::Individual::Types::Subscriber] Contains details of the secondary insurance subscriber.
           # @param prior_authorization_number [String] Box 23 on the CMS-1500 claim form.
-          # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
-          #  Headaches").
           # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
           # @param url [String] URL that links directly to the claim created in Candid.
           # @param diagnoses [Array<CandidApiClient::Diagnoses::Types::Diagnosis>] Ideally, this field should contain no more than 12 diagnoses. However, more
@@ -347,6 +345,8 @@ module CandidApiClient
           # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments
           #  to be made to you, not them.
           #  Box 27 on the CMS-1500 claim form.
+          # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
+          #  Headaches").
           # @param existing_medications [Array<CandidApiClient::Encounters::V4::Types::Medication>]
           # @param vitals [CandidApiClient::Encounters::V4::Types::Vitals]
           # @param interventions [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
@@ -392,7 +392,7 @@ module CandidApiClient
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::Encounter]
           def initialize(encounter_id:, claims:, patient:, billing_provider:, rendering_provider:, service_facility:,
-                         responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, patient_control_number: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, prior_authorization_number: OMIT, appointment_type: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+                         responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, patient_control_number: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
             @patient_control_number = patient_control_number if patient_control_number != OMIT
             @encounter_id = encounter_id
             @claims = claims
@@ -407,7 +407,6 @@ module CandidApiClient
             @subscriber_primary = subscriber_primary if subscriber_primary != OMIT
             @subscriber_secondary = subscriber_secondary if subscriber_secondary != OMIT
             @prior_authorization_number = prior_authorization_number if prior_authorization_number != OMIT
-            @appointment_type = appointment_type if appointment_type != OMIT
             @responsible_party = responsible_party
             @url = url
             @diagnoses = diagnoses
@@ -434,6 +433,7 @@ module CandidApiClient
             @patient_authorized_release = patient_authorized_release
             @benefits_assigned_to_provider = benefits_assigned_to_provider
             @provider_accepts_assignment = provider_accepts_assignment
+            @appointment_type = appointment_type if appointment_type != OMIT
             @existing_medications = existing_medications if existing_medications != OMIT
             @vitals = vitals if vitals != OMIT
             @interventions = interventions if interventions != OMIT
@@ -467,7 +467,6 @@ module CandidApiClient
               "subscriber_primary": subscriber_primary,
               "subscriber_secondary": subscriber_secondary,
               "prior_authorization_number": prior_authorization_number,
-              "appointment_type": appointment_type,
               "responsible_party": responsible_party,
               "url": url,
               "diagnoses": diagnoses,
@@ -490,6 +489,7 @@ module CandidApiClient
               "patient_authorized_release": patient_authorized_release,
               "benefits_assigned_to_provider": benefits_assigned_to_provider,
               "provider_accepts_assignment": provider_accepts_assignment,
+              "appointment_type": appointment_type,
               "existing_medications": existing_medications,
               "vitals": vitals,
               "interventions": interventions,
@@ -582,7 +582,6 @@ module CandidApiClient
               subscriber_secondary = CandidApiClient::Individual::Types::Subscriber.from_json(json_object: subscriber_secondary)
             end
             prior_authorization_number = struct["prior_authorization_number"]
-            appointment_type = struct["appointment_type"]
             responsible_party = struct["responsible_party"]
             url = struct["url"]
             diagnoses = parsed_json["diagnoses"]&.map do |item|
@@ -630,6 +629,7 @@ module CandidApiClient
             patient_authorized_release = struct["patient_authorized_release"]
             benefits_assigned_to_provider = struct["benefits_assigned_to_provider"]
             provider_accepts_assignment = struct["provider_accepts_assignment"]
+            appointment_type = struct["appointment_type"]
             existing_medications = parsed_json["existing_medications"]&.map do |item|
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::Medication.from_json(json_object: item)
@@ -678,7 +678,6 @@ module CandidApiClient
               subscriber_primary: subscriber_primary,
               subscriber_secondary: subscriber_secondary,
               prior_authorization_number: prior_authorization_number,
-              appointment_type: appointment_type,
               responsible_party: responsible_party,
               url: url,
               diagnoses: diagnoses,
@@ -701,6 +700,7 @@ module CandidApiClient
               patient_authorized_release: patient_authorized_release,
               benefits_assigned_to_provider: benefits_assigned_to_provider,
               provider_accepts_assignment: provider_accepts_assignment,
+              appointment_type: appointment_type,
               existing_medications: existing_medications,
               vitals: vitals,
               interventions: interventions,
@@ -746,7 +746,6 @@ module CandidApiClient
             obj.subscriber_primary.nil? || CandidApiClient::Individual::Types::Subscriber.validate_raw(obj: obj.subscriber_primary)
             obj.subscriber_secondary.nil? || CandidApiClient::Individual::Types::Subscriber.validate_raw(obj: obj.subscriber_secondary)
             obj.prior_authorization_number&.is_a?(String) != false || raise("Passed value for field obj.prior_authorization_number is not the expected type, validation failed.")
-            obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
             obj.responsible_party.is_a?(CandidApiClient::Encounters::V4::Types::ResponsiblePartyType) != false || raise("Passed value for field obj.responsible_party is not the expected type, validation failed.")
             obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
             obj.diagnoses.is_a?(Array) != false || raise("Passed value for field obj.diagnoses is not the expected type, validation failed.")
@@ -769,6 +768,7 @@ module CandidApiClient
             obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")
             obj.benefits_assigned_to_provider.is_a?(Boolean) != false || raise("Passed value for field obj.benefits_assigned_to_provider is not the expected type, validation failed.")
             obj.provider_accepts_assignment.is_a?(Boolean) != false || raise("Passed value for field obj.provider_accepts_assignment is not the expected type, validation failed.")
+            obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
             obj.existing_medications&.is_a?(Array) != false || raise("Passed value for field obj.existing_medications is not the expected type, validation failed.")
             obj.vitals.nil? || CandidApiClient::Encounters::V4::Types::Vitals.validate_raw(obj: obj.vitals)
             obj.interventions&.is_a?(Array) != false || raise("Passed value for field obj.interventions is not the expected type, validation failed.")

data/lib/candidhealth/encounters/v_4/types/encounter_base.rb

@@ -51,6 +51,9 @@ module CandidApiClient
           #  to be made to you, not them.
           #  Box 27 on the CMS-1500 claim form.
           attr_reader :provider_accepts_assignment
+          # @return [String] Human-readable description of the appointment type (ex: "Acupuncture -
+          #  Headaches").
+          attr_reader :appointment_type
           # @return [Array<CandidApiClient::Encounters::V4::Types::Medication>]
           attr_reader :existing_medications
           # @return [CandidApiClient::Encounters::V4::Types::Vitals]
@@ -142,6 +145,8 @@ module CandidApiClient
           # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments
           #  to be made to you, not them.
           #  Box 27 on the CMS-1500 claim form.
+          # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
+          #  Headaches").
           # @param existing_medications [Array<CandidApiClient::Encounters::V4::Types::Medication>]
           # @param vitals [CandidApiClient::Encounters::V4::Types::Vitals]
           # @param interventions [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
@@ -187,13 +192,14 @@ module CandidApiClient
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::EncounterBase]
           def initialize(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                         provider_accepts_assignment:, billable_status:, date_of_service: OMIT, end_date_of_service: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+                         provider_accepts_assignment:, billable_status:, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
             @external_id = external_id
             @date_of_service = date_of_service if date_of_service != OMIT
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
             @patient_authorized_release = patient_authorized_release
             @benefits_assigned_to_provider = benefits_assigned_to_provider
             @provider_accepts_assignment = provider_accepts_assignment
+            @appointment_type = appointment_type if appointment_type != OMIT
             @existing_medications = existing_medications if existing_medications != OMIT
             @vitals = vitals if vitals != OMIT
             @interventions = interventions if interventions != OMIT
@@ -219,6 +225,7 @@ module CandidApiClient
               "patient_authorized_release": patient_authorized_release,
               "benefits_assigned_to_provider": benefits_assigned_to_provider,
               "provider_accepts_assignment": provider_accepts_assignment,
+              "appointment_type": appointment_type,
               "existing_medications": existing_medications,
               "vitals": vitals,
               "interventions": interventions,
@@ -252,6 +259,7 @@ module CandidApiClient
             patient_authorized_release = struct["patient_authorized_release"]
             benefits_assigned_to_provider = struct["benefits_assigned_to_provider"]
             provider_accepts_assignment = struct["provider_accepts_assignment"]
+            appointment_type = struct["appointment_type"]
             existing_medications = parsed_json["existing_medications"]&.map do |item|
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::Medication.from_json(json_object: item)
@@ -292,6 +300,7 @@ module CandidApiClient
               patient_authorized_release: patient_authorized_release,
               benefits_assigned_to_provider: benefits_assigned_to_provider,
               provider_accepts_assignment: provider_accepts_assignment,
+              appointment_type: appointment_type,
               existing_medications: existing_medications,
               vitals: vitals,
               interventions: interventions,
@@ -329,6 +338,7 @@ module CandidApiClient
             obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")
             obj.benefits_assigned_to_provider.is_a?(Boolean) != false || raise("Passed value for field obj.benefits_assigned_to_provider is not the expected type, validation failed.")
             obj.provider_accepts_assignment.is_a?(Boolean) != false || raise("Passed value for field obj.provider_accepts_assignment is not the expected type, validation failed.")
+            obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
             obj.existing_medications&.is_a?(Array) != false || raise("Passed value for field obj.existing_medications is not the expected type, validation failed.")
             obj.vitals.nil? || CandidApiClient::Encounters::V4::Types::Vitals.validate_raw(obj: obj.vitals)
             obj.interventions&.is_a?(Array) != false || raise("Passed value for field obj.interventions is not the expected type, validation failed.")

data/lib/candidhealth/{third_party_payers/v_1/types/toggle_third_party_payer_enablement_request.rb → encounters/v_4/types/insurance_pay_missing_primary_coverage_error_type.rb}

@@ -4,12 +4,12 @@ require "ostruct"
 require "json"
 
 module CandidApiClient
-  module ThirdPartyPayers
-    module V1
+  module Encounters
+    module V4
       module Types
-        class ToggleThirdPartyPayerEnablementRequest
-          # @return [Boolean]
-          attr_reader :enabled
+        class InsurancePayMissingPrimaryCoverageErrorType
+          # @return [String]
+          attr_reader :patient_id
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -18,27 +18,28 @@ module CandidApiClient
 
           OMIT = Object.new
 
-          # @param enabled [Boolean]
+          # @param patient_id [String]
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [CandidApiClient::ThirdPartyPayers::V1::Types::ToggleThirdPartyPayerEnablementRequest]
-          def initialize(enabled:, additional_properties: nil)
-            @enabled = enabled
+          # @return [CandidApiClient::Encounters::V4::Types::InsurancePayMissingPrimaryCoverageErrorType]
+          def initialize(patient_id:, additional_properties: nil)
+            @patient_id = patient_id
             @additional_properties = additional_properties
-            @_field_set = { "enabled": enabled }
+            @_field_set = { "patient_id": patient_id }
           end
 
           # Deserialize a JSON object to an instance of
-          #  ToggleThirdPartyPayerEnablementRequest
+          #  InsurancePayMissingPrimaryCoverageErrorType
           #
           # @param json_object [String]
-          # @return [CandidApiClient::ThirdPartyPayers::V1::Types::ToggleThirdPartyPayerEnablementRequest]
+          # @return [CandidApiClient::Encounters::V4::Types::InsurancePayMissingPrimaryCoverageErrorType]
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
-            enabled = struct["enabled"]
-            new(enabled: enabled, additional_properties: struct)
+            patient_id = struct["patient_id"]
+            new(patient_id: patient_id, additional_properties: struct)
           end
 
-          # Serialize an instance of ToggleThirdPartyPayerEnablementRequest to a JSON object
+          # Serialize an instance of InsurancePayMissingPrimaryCoverageErrorType to a JSON
+          #  object
           #
           # @return [String]
           def to_json(*_args)
@@ -52,7 +53,7 @@ module CandidApiClient
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
-            obj.enabled.is_a?(Boolean) != false || raise("Passed value for field obj.enabled is not the expected type, validation failed.")
+            obj.patient_id.is_a?(String) != false || raise("Passed value for field obj.patient_id is not the expected type, validation failed.")
           end
         end
       end

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

@@ -3,9 +3,7 @@
 require_relative "../../../requests"
 require_relative "types/guarantor_create"
 require_relative "types/guarantor"
-require "date"
-require_relative "../../commons/types/street_address_short_zip"
-require_relative "../../commons/types/phone_number"
+require_relative "types/guarantor_update"
 require "async"
 
 module CandidApiClient
@@ -87,41 +85,28 @@ module CandidApiClient
         # Updates a guarantor by its `guarantor_id`.
         #
         # @param guarantor_id [String]
-        # @param first_name [String]
-        # @param last_name [String]
-        # @param external_id [String] A unique identifier for the guarantor assigned by an external system.
-        # @param date_of_birth [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-        # @param address [Hash] 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 phone_numbers [Array<Hash>] Request of type Array<CandidApiClient::Commons::Types::PhoneNumber>, as a Hash
-        #   * :number (String)
-        #   * :type (CandidApiClient::Commons::Types::PhoneNumberType)
-        # @param phone_consent [Boolean]
-        # @param email [String]
-        # @param email_consent [Boolean]
+        # @param request [Hash] Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
+        #   * :first_name (String)
+        #   * :last_name (String)
+        #   * :external_id (String)
+        #   * :date_of_birth (Date)
+        #   * :address (Hash)
+        #     * :zip_plus_four_code (String)
+        #     * :address_1 (String)
+        #     * :address_2 (String)
+        #     * :city (String)
+        #     * :state (CandidApiClient::Commons::Types::State)
+        #     * :zip_code (String)
+        #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
+        #   * :phone_consent (Boolean)
+        #   * :email (String)
+        #   * :email_consent (Boolean)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Guarantor::V1::Types::Guarantor]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.guarantor.v_1.update(
-        #    guarantor_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    first_name: "string",
-        #    last_name: "string",
-        #    external_id: "string",
-        #    date_of_birth: DateTime.parse(2023-01-15),
-        #    address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" },
-        #    phone_numbers: [{ number: "1234567890", type: HOME }],
-        #    phone_consent: true,
-        #    email: "johndoe@joincandidhealth.com",
-        #    email_consent: true
-        #  )
-        def update(guarantor_id:, first_name: nil, last_name: nil, external_id: nil, date_of_birth: nil, address: nil,
-                   phone_numbers: nil, phone_consent: nil, email: nil, email_consent: nil, request_options: nil)
+        #  api.guarantor.v_1.update(guarantor_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true })
+        def update(guarantor_id:, request:, 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?
@@ -130,18 +115,7 @@ module CandidApiClient
           **@request_client.get_headers,
           **(request_options&.additional_headers || {})
             }.compact
-            req.body = {
-              **(request_options&.additional_body_parameters || {}),
-              first_name: first_name,
-              last_name: last_name,
-              external_id: external_id,
-              date_of_birth: date_of_birth,
-              address: address,
-              phone_numbers: phone_numbers,
-              phone_consent: phone_consent,
-              email: email,
-              email_consent: email_consent
-            }.compact
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
                                                request_options: request_options)}/api/guarantors/v1/#{guarantor_id}"
           end
@@ -229,41 +203,28 @@ module CandidApiClient
         # Updates a guarantor by its `guarantor_id`.
         #
         # @param guarantor_id [String]
-        # @param first_name [String]
-        # @param last_name [String]
-        # @param external_id [String] A unique identifier for the guarantor assigned by an external system.
-        # @param date_of_birth [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-        # @param address [Hash] 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 phone_numbers [Array<Hash>] Request of type Array<CandidApiClient::Commons::Types::PhoneNumber>, as a Hash
-        #   * :number (String)
-        #   * :type (CandidApiClient::Commons::Types::PhoneNumberType)
-        # @param phone_consent [Boolean]
-        # @param email [String]
-        # @param email_consent [Boolean]
+        # @param request [Hash] Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
+        #   * :first_name (String)
+        #   * :last_name (String)
+        #   * :external_id (String)
+        #   * :date_of_birth (Date)
+        #   * :address (Hash)
+        #     * :zip_plus_four_code (String)
+        #     * :address_1 (String)
+        #     * :address_2 (String)
+        #     * :city (String)
+        #     * :state (CandidApiClient::Commons::Types::State)
+        #     * :zip_code (String)
+        #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
+        #   * :phone_consent (Boolean)
+        #   * :email (String)
+        #   * :email_consent (Boolean)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Guarantor::V1::Types::Guarantor]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.guarantor.v_1.update(
-        #    guarantor_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    first_name: "string",
-        #    last_name: "string",
-        #    external_id: "string",
-        #    date_of_birth: DateTime.parse(2023-01-15),
-        #    address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" },
-        #    phone_numbers: [{ number: "1234567890", type: HOME }],
-        #    phone_consent: true,
-        #    email: "johndoe@joincandidhealth.com",
-        #    email_consent: true
-        #  )
-        def update(guarantor_id:, first_name: nil, last_name: nil, external_id: nil, date_of_birth: nil, address: nil,
-                   phone_numbers: nil, phone_consent: nil, email: nil, email_consent: nil, request_options: nil)
+        #  api.guarantor.v_1.update(guarantor_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true })
+        def update(guarantor_id:, request:, 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?
@@ -273,18 +234,7 @@ module CandidApiClient
             **@request_client.get_headers,
             **(request_options&.additional_headers || {})
               }.compact
-              req.body = {
-                **(request_options&.additional_body_parameters || {}),
-                first_name: first_name,
-                last_name: last_name,
-                external_id: external_id,
-                date_of_birth: date_of_birth,
-                address: address,
-                phone_numbers: phone_numbers,
-                phone_consent: phone_consent,
-                email: email,
-                email_consent: email_consent
-              }.compact
+              req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
                                                  request_options: request_options)}/api/guarantors/v1/#{guarantor_id}"
             end

data/lib/candidhealth/guarantor/v_1/types/guarantor_update.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "../../../commons/types/street_address_short_zip"
+require_relative "../../../commons/types/phone_number"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Guarantor
+    module V1
+      module Types
+        class GuarantorUpdate
+          # @return [String]
+          attr_reader :first_name
+          # @return [String]
+          attr_reader :last_name
+          # @return [String] A unique identifier for the guarantor assigned by an external system.
+          attr_reader :external_id
+          # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
+          attr_reader :date_of_birth
+          # @return [CandidApiClient::Commons::Types::StreetAddressShortZip]
+          attr_reader :address
+          # @return [Array<CandidApiClient::Commons::Types::PhoneNumber>]
+          attr_reader :phone_numbers
+          # @return [Boolean]
+          attr_reader :phone_consent
+          # @return [String]
+          attr_reader :email
+          # @return [Boolean]
+          attr_reader :email_consent
+          # @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 first_name [String]
+          # @param last_name [String]
+          # @param external_id [String] A unique identifier for the guarantor assigned by an external system.
+          # @param date_of_birth [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
+          # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip]
+          # @param phone_numbers [Array<CandidApiClient::Commons::Types::PhoneNumber>]
+          # @param phone_consent [Boolean]
+          # @param email [String]
+          # @param email_consent [Boolean]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Guarantor::V1::Types::GuarantorUpdate]
+          def initialize(first_name: OMIT, last_name: OMIT, external_id: OMIT, date_of_birth: OMIT, address: OMIT,
+                         phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, additional_properties: nil)
+            @first_name = first_name if first_name != OMIT
+            @last_name = last_name if last_name != OMIT
+            @external_id = external_id if external_id != OMIT
+            @date_of_birth = date_of_birth if date_of_birth != OMIT
+            @address = address if address != OMIT
+            @phone_numbers = phone_numbers if phone_numbers != OMIT
+            @phone_consent = phone_consent if phone_consent != OMIT
+            @email = email if email != OMIT
+            @email_consent = email_consent if email_consent != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "first_name": first_name,
+              "last_name": last_name,
+              "external_id": external_id,
+              "date_of_birth": date_of_birth,
+              "address": address,
+              "phone_numbers": phone_numbers,
+              "phone_consent": phone_consent,
+              "email": email,
+              "email_consent": email_consent
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of GuarantorUpdate
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Guarantor::V1::Types::GuarantorUpdate]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            first_name = struct["first_name"]
+            last_name = struct["last_name"]
+            external_id = struct["external_id"]
+            date_of_birth = (Date.parse(parsed_json["date_of_birth"]) unless parsed_json["date_of_birth"].nil?)
+            if parsed_json["address"].nil?
+              address = nil
+            else
+              address = parsed_json["address"].to_json
+              address = CandidApiClient::Commons::Types::StreetAddressShortZip.from_json(json_object: address)
+            end
+            phone_numbers = parsed_json["phone_numbers"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Commons::Types::PhoneNumber.from_json(json_object: item)
+            end
+            phone_consent = struct["phone_consent"]
+            email = struct["email"]
+            email_consent = struct["email_consent"]
+            new(
+              first_name: first_name,
+              last_name: last_name,
+              external_id: external_id,
+              date_of_birth: date_of_birth,
+              address: address,
+              phone_numbers: phone_numbers,
+              phone_consent: phone_consent,
+              email: email,
+              email_consent: email_consent,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of GuarantorUpdate 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.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+            obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+            obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
+            obj.date_of_birth&.is_a?(Date) != false || raise("Passed value for field obj.date_of_birth is not the expected type, validation failed.")
+            obj.address.nil? || CandidApiClient::Commons::Types::StreetAddressShortZip.validate_raw(obj: obj.address)
+            obj.phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
+            obj.phone_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.phone_consent is not the expected type, validation failed.")
+            obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+            obj.email_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end