candidhealth 0.39.5 → 0.39.7

data/lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb

@@ -56,7 +56,7 @@ module CandidApiClient
             attr_reader :automated_eligibility_check_complete
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentWorkQueue] The work queue that the appointment belongs to. It is not recommended to change
             #  this value manually via API. If status is NOT_READY, work_queue must be set. If
-            #  status is READY or CHECKED_IN, work_queue must be null.
+            #  status is READY, work_queue must be null.
             attr_reader :work_queue
             # @return [OpenStruct] Additional properties unmapped to the current class definition
             attr_reader :additional_properties
@@ -93,7 +93,7 @@ module CandidApiClient
             #  appointment.
             # @param work_queue [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentWorkQueue] The work queue that the appointment belongs to. It is not recommended to change
             #  this value manually via API. If status is NOT_READY, work_queue must be set. If
-            #  status is READY or CHECKED_IN, work_queue must be null.
+            #  status is READY, work_queue must be null.
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment]
             def initialize(patient_id:, start_timestamp:, service_duration:, services:, status: OMIT,

data/lib/candidhealth/pre_encounter/appointments/v_1/types/visit.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "../../../patients/v_1/types/mutable_patient_with_mrn"
+require "date"
+require_relative "appointment_status"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Appointments
+      module V1
+        module Types
+          # A visit is a collection of appointments that occur on the same day.
+          class Visit
+            # @return [String]
+            attr_reader :patient_id
+            # @return [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
+            attr_reader :patient
+            # @return [DateTime]
+            attr_reader :start_time
+            # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus]
+            attr_reader :status
+            # @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 patient_id [String]
+            # @param patient [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
+            # @param start_time [DateTime]
+            # @param status [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus]
+            # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+            # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Visit]
+            def initialize(patient_id:, patient:, start_time:, status:, additional_properties: nil)
+              @patient_id = patient_id
+              @patient = patient
+              @start_time = start_time
+              @status = status
+              @additional_properties = additional_properties
+              @_field_set = { "patient_id": patient_id, "patient": patient, "start_time": start_time, "status": status }
+            end
+
+            # Deserialize a JSON object to an instance of Visit
+            #
+            # @param json_object [String]
+            # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Visit]
+            def self.from_json(json_object:)
+              struct = JSON.parse(json_object, object_class: OpenStruct)
+              parsed_json = JSON.parse(json_object)
+              patient_id = struct["patient_id"]
+              if parsed_json["patient"].nil?
+                patient = nil
+              else
+                patient = parsed_json["patient"].to_json
+                patient = CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn.from_json(json_object: patient)
+              end
+              start_time = (DateTime.parse(parsed_json["start_time"]) unless parsed_json["start_time"].nil?)
+              status = struct["status"]
+              new(
+                patient_id: patient_id,
+                patient: patient,
+                start_time: start_time,
+                status: status,
+                additional_properties: struct
+              )
+            end
+
+            # Serialize an instance of Visit 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.patient_id.is_a?(String) != false || raise("Passed value for field obj.patient_id is not the expected type, validation failed.")
+              CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn.validate_raw(obj: obj.patient)
+              obj.start_time.is_a?(DateTime) != false || raise("Passed value for field obj.start_time is not the expected type, validation failed.")
+              obj.status.is_a?(CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/pre_encounter/appointments/v_1/types/visits_page.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "visit"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module PreEncounter
+    module Appointments
+      module V1
+        module Types
+          class VisitsPage
+            # @return [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Visit>]
+            attr_reader :items
+            # @return [String]
+            attr_reader :next_page_token
+            # @return [String]
+            attr_reader :prev_page_token
+            # @return [Integer]
+            attr_reader :total
+            # @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 items [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Visit>]
+            # @param next_page_token [String]
+            # @param prev_page_token [String]
+            # @param total [Integer]
+            # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+            # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
+            def initialize(items:, total:, next_page_token: OMIT, prev_page_token: OMIT, additional_properties: nil)
+              @items = items
+              @next_page_token = next_page_token if next_page_token != OMIT
+              @prev_page_token = prev_page_token if prev_page_token != OMIT
+              @total = total
+              @additional_properties = additional_properties
+              @_field_set = {
+                "items": items,
+                "next_page_token": next_page_token,
+                "prev_page_token": prev_page_token,
+                "total": total
+              }.reject do |_k, v|
+                v == OMIT
+              end
+            end
+
+            # Deserialize a JSON object to an instance of VisitsPage
+            #
+            # @param json_object [String]
+            # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
+            def self.from_json(json_object:)
+              struct = JSON.parse(json_object, object_class: OpenStruct)
+              parsed_json = JSON.parse(json_object)
+              items = parsed_json["items"]&.map do |item|
+                item = item.to_json
+                CandidApiClient::PreEncounter::Appointments::V1::Types::Visit.from_json(json_object: item)
+              end
+              next_page_token = struct["next_page_token"]
+              prev_page_token = struct["prev_page_token"]
+              total = struct["total"]
+              new(
+                items: items,
+                next_page_token: next_page_token,
+                prev_page_token: prev_page_token,
+                total: total,
+                additional_properties: struct
+              )
+            end
+
+            # Serialize an instance of VisitsPage 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.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+              obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
+              obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
+              obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/pre_encounter/common/types/external_identifier.rb

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

data/lib/candidhealth/pre_encounter/common/types/external_provider.rb

@@ -27,6 +27,8 @@ module CandidApiClient
           attr_reader :period
           # @return [String]
           attr_reader :canonical_id
+          # @return [String]
+          attr_reader :fax
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -42,10 +44,11 @@ module CandidApiClient
           # @param addresses [Array<CandidApiClient::PreEncounter::Common::Types::Address>]
           # @param period [CandidApiClient::PreEncounter::Common::Types::Period]
           # @param canonical_id [String]
+          # @param fax [String]
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::PreEncounter::Common::Types::ExternalProvider]
           def initialize(name:, telecoms:, type: OMIT, npi: OMIT, addresses: OMIT, period: OMIT, canonical_id: OMIT,
-                         additional_properties: nil)
+                         fax: OMIT, additional_properties: nil)
             @name = name
             @type = type if type != OMIT
             @npi = npi if npi != OMIT
@@ -53,6 +56,7 @@ module CandidApiClient
             @addresses = addresses if addresses != OMIT
             @period = period if period != OMIT
             @canonical_id = canonical_id if canonical_id != OMIT
+            @fax = fax if fax != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "name": name,
@@ -61,7 +65,8 @@ module CandidApiClient
               "telecoms": telecoms,
               "addresses": addresses,
               "period": period,
-              "canonical_id": canonical_id
+              "canonical_id": canonical_id,
+              "fax": fax
             }.reject do |_k, v|
               v == OMIT
             end
@@ -97,6 +102,7 @@ module CandidApiClient
               period = CandidApiClient::PreEncounter::Common::Types::Period.from_json(json_object: period)
             end
             canonical_id = struct["canonical_id"]
+            fax = struct["fax"]
             new(
               name: name,
               type: type,
@@ -105,6 +111,7 @@ module CandidApiClient
               addresses: addresses,
               period: period,
               canonical_id: canonical_id,
+              fax: fax,
               additional_properties: struct
             )
           end
@@ -130,6 +137,7 @@ module CandidApiClient
             obj.addresses&.is_a?(Array) != false || raise("Passed value for field obj.addresses is not the expected type, validation failed.")
             obj.period.nil? || CandidApiClient::PreEncounter::Common::Types::Period.validate_raw(obj: obj.period)
             obj.canonical_id&.is_a?(String) != false || raise("Passed value for field obj.canonical_id is not the expected type, validation failed.")
+            obj.fax&.is_a?(String) != false || raise("Passed value for field obj.fax is not the expected type, validation failed.")
           end
         end
       end

data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb

@@ -3,6 +3,7 @@
 require_relative "../../../../requests"
 require_relative "types/mutable_coverage"
 require_relative "types/coverage"
+require_relative "types/coverages_page"
 require "json"
 require "date"
 require_relative "types/service_type_code"
@@ -71,6 +72,7 @@ module CandidApiClient
           #       * :start (Date)
           #       * :end_ (Date)
           #     * :insurance_card_image_locator (String)
+          #     * :payer_plan_group_id (String)
           #   * :verified (Boolean)
           #   * :eligibility_checks (Array<CandidApiClient::PreEncounter::Coverages::V1::Types::EligibilityCheckMetadata>)
           #   * :latest_eligibility_check (Hash)
@@ -172,7 +174,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string" }, verified: true, eligibility_checks: [{ check_id: "string", service_code: MEDICAL_CARE, status: COMPLETED, initiated_by: "string", initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }], latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } })
+          #  api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } })
           def create(request:, 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?
@@ -235,6 +237,7 @@ module CandidApiClient
           #       * :start (Date)
           #       * :end_ (Date)
           #     * :insurance_card_image_locator (String)
+          #     * :payer_plan_group_id (String)
           #   * :verified (Boolean)
           #   * :eligibility_checks (Array<CandidApiClient::PreEncounter::Coverages::V1::Types::EligibilityCheckMetadata>)
           #   * :latest_eligibility_check (Hash)
@@ -339,7 +342,7 @@ module CandidApiClient
           #  api.pre_encounter.coverages.v_1.update(
           #    id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
           #    version: "string",
-          #    request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string" }, verified: true, eligibility_checks: [{ check_id: "string", service_code: MEDICAL_CARE, status: COMPLETED, initiated_by: "string", initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }], latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } }
+          #    request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -357,6 +360,45 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
           end
 
+          # Returns a page of Coverages based on the search criteria.
+          #
+          # @param patient_id [String]
+          # @param payer_plan_group_id [String]
+          # @param page_token [String]
+          # @param limit [Integer] Must be between 0 and 1000. Defaults to 100
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.coverages.v_1.get_multi_paginated(
+          #    patient_id: "string",
+          #    payer_plan_group_id: "string",
+          #    page_token: "string",
+          #    limit: 1
+          #  )
+          def get_multi_paginated(patient_id: nil, payer_plan_group_id: nil, page_token: nil, limit: nil,
+                                  request_options: nil)
+            response = @request_client.conn.get do |req|
+              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+              req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+              req.headers = {
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {})
+              }.compact
+              req.params = {
+                **(request_options&.additional_query_parameters || {}),
+                "patient_id": patient_id,
+                "payer_plan_group_id": payer_plan_group_id,
+                "page_token": page_token,
+                "limit": limit
+              }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1/get-multi-paginated"
+            end
+            CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage.from_json(json_object: response.body)
+          end
+
           # gets a specific Coverage
           #
           # @param id [String]
@@ -585,6 +627,7 @@ module CandidApiClient
           #       * :start (Date)
           #       * :end_ (Date)
           #     * :insurance_card_image_locator (String)
+          #     * :payer_plan_group_id (String)
           #   * :verified (Boolean)
           #   * :eligibility_checks (Array<CandidApiClient::PreEncounter::Coverages::V1::Types::EligibilityCheckMetadata>)
           #   * :latest_eligibility_check (Hash)
@@ -686,7 +729,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string" }, verified: true, eligibility_checks: [{ check_id: "string", service_code: MEDICAL_CARE, status: COMPLETED, initiated_by: "string", initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }], latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } })
+          #  api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } })
           def create(request:, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -751,6 +794,7 @@ module CandidApiClient
           #       * :start (Date)
           #       * :end_ (Date)
           #     * :insurance_card_image_locator (String)
+          #     * :payer_plan_group_id (String)
           #   * :verified (Boolean)
           #   * :eligibility_checks (Array<CandidApiClient::PreEncounter::Coverages::V1::Types::EligibilityCheckMetadata>)
           #   * :latest_eligibility_check (Hash)
@@ -855,7 +899,7 @@ module CandidApiClient
           #  api.pre_encounter.coverages.v_1.update(
           #    id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
           #    version: "string",
-          #    request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string" }, verified: true, eligibility_checks: [{ check_id: "string", service_code: MEDICAL_CARE, status: COMPLETED, initiated_by: "string", initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }], latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } }
+          #    request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: {  } }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: {  } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: {  }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: {  }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: {  } }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do
@@ -875,6 +919,47 @@ module CandidApiClient
             end
           end
 
+          # Returns a page of Coverages based on the search criteria.
+          #
+          # @param patient_id [String]
+          # @param payer_plan_group_id [String]
+          # @param page_token [String]
+          # @param limit [Integer] Must be between 0 and 1000. Defaults to 100
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage]
+          # @example
+          #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+          #  api.pre_encounter.coverages.v_1.get_multi_paginated(
+          #    patient_id: "string",
+          #    payer_plan_group_id: "string",
+          #    page_token: "string",
+          #    limit: 1
+          #  )
+          def get_multi_paginated(patient_id: nil, payer_plan_group_id: nil, page_token: nil, limit: nil,
+                                  request_options: nil)
+            Async do
+              response = @request_client.conn.get do |req|
+                req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+                req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+                req.headers = {
+              **(req.headers || {}),
+              **@request_client.get_headers,
+              **(request_options&.additional_headers || {})
+                }.compact
+                req.params = {
+                  **(request_options&.additional_query_parameters || {}),
+                  "patient_id": patient_id,
+                  "payer_plan_group_id": payer_plan_group_id,
+                  "page_token": page_token,
+                  "limit": limit
+                }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1/get-multi-paginated"
+              end
+              CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage.from_json(json_object: response.body)
+            end
+          end
+
           # gets a specific Coverage
           #
           # @param id [String]

data/lib/candidhealth/pre_encounter/coverages/v_1/types/address.rb

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