candidhealth 0.24.3 → 0.24.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1718f0ca0a159b22fe68ff3c74381c4d6c9f0b88748b60300f78eb21c52e77
-  data.tar.gz: e0a6c61539217e8e38d1ebd9b681d9f53ed5b2daec264794187955f6f72228de
+  metadata.gz: 0cc6b4451b8313b62bce521f1a66fbb1c3fd3841179886017423caaf5ab5e741
+  data.tar.gz: 63a2bb039a538e78c8bc3d1ffb86e5193a9517e958e9a401714f3d907e3ae203
 SHA512:
-  metadata.gz: 07f8bf71ea0330db01ded0a5260cf40b8af9622e3d3042e5ad3e65ceb85e8b85acd99921d76a0e33fc8543ea5405c4b39c0f7b6f1baa9ad62e864ea86bbb4b8e
-  data.tar.gz: 2e6edda2e02c8b73e2fe30ee09d90ed73f8e23521324dd79c0a88c84c1d04af110026b72ede5e54fd2567981d599b7ae5ce2bd6512ff0da2847363d58958c663
+  metadata.gz: 0e22c5eacf0626bcdaff500b93bb1273d9abc5b84b6a034461be91723fc63329e827c1a6c6e46f3b785923a758f589854d28538cdf7131a904d10a858990bb67
+  data.tar.gz: 1abbeb8295ca1fbe2fa7bb0d00cd6bb637f7fb08cd89f3b9cc91905331654a9ba92e55df9ac491399671d86a336aa128723ad0c3b76d90101eb900fb0d0b8a95

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class DisabilityStatus
+          DISABLED = "DISABLED"
+          NON_DISABLED = "NON_DISABLED"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class Ethnicity
+          HISPANIC_OR_LATINO = "HISPANIC_OR_LATINO"
+          NOT_HISPANIC_OR_LATINO = "NOT_HISPANIC_OR_LATINO"
+          UNKNOWN = "UNKNOWN"
+          REFUSED = "REFUSED"
+        end
+      end
+    end
+  end
+end

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

@@ -5,10 +5,13 @@ module CandidApiClient
     module Common
       module Types
         class Gender
-          FEMALE = "FEMALE"
-          MALE = "MALE"
+          MAN = "MAN"
+          WOMAN = "WOMAN"
+          NON_BINARY = "NON_BINARY"
+          TWO_SPIRIT = "TWO_SPIRIT"
           OTHER = "OTHER"
           UNKNOWN = "UNKNOWN"
+          REFUSED = "REFUSED"
         end
       end
     end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class Race
+          AMERICAN_INDIAN_OR_ALASKA_NATIVE = "AMERICAN_INDIAN_OR_ALASKA_NATIVE"
+          WHITE = "WHITE"
+          BLACK = "BLACK"
+          ASIAN = "ASIAN"
+          NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER = "NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER"
+          MIDDLE_EASTERN_OR_NORTH_AFRICAN = "MIDDLE_EASTERN_OR_NORTH_AFRICAN"
+          OTHER = "OTHER"
+          UNKNOWN = "UNKNOWN"
+          REFUSED = "REFUSED"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class Sex
+          FEMALE = "FEMALE"
+          MALE = "MALE"
+          UNKNOWN = "UNKNOWN"
+          REFUSED = "REFUSED"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module PreEncounter
+    module Common
+      module Types
+        class SexualOrientation
+          HETEROSEXUAL = "HETEROSEXUAL"
+          HOMOSEXUAL = "HOMOSEXUAL"
+          BISEXUAL = "BISEXUAL"
+          TWO_SPIRIT = "TWO_SPIRIT"
+          OTHER = "OTHER"
+          UNKNOWN = "UNKNOWN"
+          REFUSED = "REFUSED"
+        end
+      end
+    end
+  end
+end

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

@@ -7,24 +7,24 @@ module CandidApiClient
   module PreEncounter
     module Coverages
       class Client
-        # @return [CandidApiClient::PreEncounter::Coverages::V1::Client]
-        attr_reader :pre_encounter
+        # @return [CandidApiClient::PreEncounter::Coverages::V1::V1Client]
+        attr_reader :v_1
 
         # @param request_client [CandidApiClient::RequestClient]
         # @return [CandidApiClient::PreEncounter::Coverages::Client]
         def initialize(request_client:)
-          @pre_encounter = CandidApiClient::PreEncounter::Coverages::V1::Client.new(request_client: request_client)
+          @v_1 = CandidApiClient::PreEncounter::Coverages::V1::V1Client.new(request_client: request_client)
         end
       end
 
       class AsyncClient
-        # @return [CandidApiClient::PreEncounter::Coverages::V1::AsyncClient]
-        attr_reader :pre_encounter
+        # @return [CandidApiClient::PreEncounter::Coverages::V1::AsyncV1Client]
+        attr_reader :v_1
 
         # @param request_client [CandidApiClient::AsyncRequestClient]
         # @return [CandidApiClient::PreEncounter::Coverages::AsyncClient]
         def initialize(request_client:)
-          @pre_encounter = CandidApiClient::PreEncounter::Coverages::V1::AsyncClient.new(request_client: request_client)
+          @v_1 = CandidApiClient::PreEncounter::Coverages::V1::AsyncV1Client.new(request_client: request_client)
         end
       end
     end

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

@@ -1,31 +1,484 @@
 # frozen_string_literal: true
 
 require_relative "../../../../requests"
-require_relative "coverages/client"
+require_relative "types/mutable_coverage"
+require_relative "types/coverage"
+require "json"
+require "date"
+require "async"
 
 module CandidApiClient
   module PreEncounter
     module Coverages
       module V1
-        class Client
-          # @return [CandidApiClient::PreEncounter::Coverages::V1::CoveragesClient]
-          attr_reader :coverages
+        class V1Client
+          # @return [CandidApiClient::RequestClient]
+          attr_reader :request_client
 
           # @param request_client [CandidApiClient::RequestClient]
-          # @return [CandidApiClient::PreEncounter::Coverages::V1::Client]
+          # @return [CandidApiClient::PreEncounter::Coverages::V1::V1Client]
           def initialize(request_client:)
-            @coverages = CandidApiClient::PreEncounter::Coverages::V1::CoveragesClient.new(request_client: request_client)
+            @request_client = request_client
+          end
+
+          # Creates a new Coverage. A Coverage provides the high-level identifiers and
+          #  descriptors of a specific insurance plan for a specific individual - typically
+          #  the information you can find on an insurance card. Additionally a coverage will
+          #  include detailed benefits information covered by the specific plan for the
+          #  individual.
+          #
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage, as a Hash
+          #   * :status (CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus)
+          #   * :subscriber (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :date_of_birth (Date)
+          #     * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :relationship (CandidApiClient::PreEncounter::Common::Types::Relationship)
+          #   * :patient (String)
+          #   * :insurance_plan (Hash)
+          #     * :member_id (String)
+          #     * :payer_id (String)
+          #     * :payer_name (String)
+          #     * :group_number (String)
+          #     * :name (String)
+          #     * :type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #     * :insurance_card_image_locator (String)
+          #   * :verified (Boolean)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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: {  }, date_of_birth: DateTime.parse(2023-01-15), gender: MAN }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", group_number: "string", name: "string", type: PPO, period: {  }, insurance_card_image_locator: "string" }, verified: true })
+          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?
+              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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1"
+            end
+            CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+          end
+
+          # Updates a Coverage. The path must contain the most recent version to prevent
+          #  races. Updating historic versions is not supported.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage, as a Hash
+          #   * :status (CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus)
+          #   * :subscriber (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :date_of_birth (Date)
+          #     * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :relationship (CandidApiClient::PreEncounter::Common::Types::Relationship)
+          #   * :patient (String)
+          #   * :insurance_plan (Hash)
+          #     * :member_id (String)
+          #     * :payer_id (String)
+          #     * :payer_name (String)
+          #     * :group_number (String)
+          #     * :name (String)
+          #     * :type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #     * :insurance_card_image_locator (String)
+          #   * :verified (Boolean)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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.update(
+          #    id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+          #    version: "string",
+          #    request: { status: ACTIVE, subscriber: { name: {  }, date_of_birth: DateTime.parse(2023-01-15), gender: MAN }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", group_number: "string", name: "string", type: PPO, period: {  }, insurance_card_image_locator: "string" }, verified: true }
+          #  )
+          def update(id:, version:, request:, request_options: nil)
+            response = @request_client.conn.put 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1/#{id}/#{version}"
+            end
+            CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+          end
+
+          # gets a specific Coverage
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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.get(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+          def get(id:, 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.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1/#{id}"
+            end
+            CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+          end
+
+          # Gets a coverage along with it's full history. The return list is ordered by
+          #  version ascending.
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.get_history(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+          def get_history(id:, 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.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1/#{id}/history"
+            end
+            parsed_json = JSON.parse(response.body)
+            parsed_json&.map do |item|
+              item = item.to_json
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+            end
+          end
+
+          # returns a list of Coverages based on the search criteria
+          #
+          # @param patient_id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.get_multi(patient_id: "string")
+          def get_multi(patient_id: 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 }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1"
+            end
+            parsed_json = JSON.parse(response.body)
+            parsed_json&.map do |item|
+              item = item.to_json
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+            end
+          end
+
+          # Scans up to 100 coverage updates. The since query parameter is inclusive, and
+          #  the result list is ordered by updatedAt descending.
+          #
+          # @param since [DateTime]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.scan(since: DateTime.parse(2024-01-15T09:30:00.000Z))
+          def scan(since:, 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 || {}), "since": since }.compact
+              req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                 request_options: request_options)}/coverages/v1/updates/scan"
+            end
+            parsed_json = JSON.parse(response.body)
+            parsed_json&.map do |item|
+              item = item.to_json
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+            end
           end
         end
 
-        class AsyncClient
-          # @return [CandidApiClient::PreEncounter::Coverages::V1::AsyncCoveragesClient]
-          attr_reader :coverages
+        class AsyncV1Client
+          # @return [CandidApiClient::AsyncRequestClient]
+          attr_reader :request_client
 
           # @param request_client [CandidApiClient::AsyncRequestClient]
-          # @return [CandidApiClient::PreEncounter::Coverages::V1::AsyncClient]
+          # @return [CandidApiClient::PreEncounter::Coverages::V1::AsyncV1Client]
           def initialize(request_client:)
-            @coverages = CandidApiClient::PreEncounter::Coverages::V1::AsyncCoveragesClient.new(request_client: request_client)
+            @request_client = request_client
+          end
+
+          # Creates a new Coverage. A Coverage provides the high-level identifiers and
+          #  descriptors of a specific insurance plan for a specific individual - typically
+          #  the information you can find on an insurance card. Additionally a coverage will
+          #  include detailed benefits information covered by the specific plan for the
+          #  individual.
+          #
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage, as a Hash
+          #   * :status (CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus)
+          #   * :subscriber (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :date_of_birth (Date)
+          #     * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :relationship (CandidApiClient::PreEncounter::Common::Types::Relationship)
+          #   * :patient (String)
+          #   * :insurance_plan (Hash)
+          #     * :member_id (String)
+          #     * :payer_id (String)
+          #     * :payer_name (String)
+          #     * :group_number (String)
+          #     * :name (String)
+          #     * :type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #     * :insurance_card_image_locator (String)
+          #   * :verified (Boolean)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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: {  }, date_of_birth: DateTime.parse(2023-01-15), gender: MAN }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", group_number: "string", name: "string", type: PPO, period: {  }, insurance_card_image_locator: "string" }, verified: true })
+          def create(request:, request_options: nil)
+            Async do
+              response = @request_client.conn.post do |req|
+                req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+                req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+                req.headers = {
+              **(req.headers || {}),
+              **@request_client.get_headers,
+              **(request_options&.additional_headers || {})
+                }.compact
+                req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1"
+              end
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+            end
+          end
+
+          # Updates a Coverage. The path must contain the most recent version to prevent
+          #  races. Updating historic versions is not supported.
+          #
+          # @param id [String]
+          # @param version [String]
+          # @param request [Hash] Request of type CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage, as a Hash
+          #   * :status (CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageStatus)
+          #   * :subscriber (Hash)
+          #     * :name (Hash)
+          #       * :family (String)
+          #       * :given (Array<String>)
+          #       * :use (CandidApiClient::PreEncounter::Common::Types::NameUse)
+          #       * :period (Hash)
+          #         * :start (Date)
+          #         * :end_ (Date)
+          #     * :date_of_birth (Date)
+          #     * :gender (CandidApiClient::PreEncounter::Common::Types::Gender)
+          #   * :relationship (CandidApiClient::PreEncounter::Common::Types::Relationship)
+          #   * :patient (String)
+          #   * :insurance_plan (Hash)
+          #     * :member_id (String)
+          #     * :payer_id (String)
+          #     * :payer_name (String)
+          #     * :group_number (String)
+          #     * :name (String)
+          #     * :type (CandidApiClient::PreEncounter::Coverages::V1::Types::NetworkType)
+          #     * :period (Hash)
+          #       * :start (Date)
+          #       * :end_ (Date)
+          #     * :insurance_card_image_locator (String)
+          #   * :verified (Boolean)
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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.update(
+          #    id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+          #    version: "string",
+          #    request: { status: ACTIVE, subscriber: { name: {  }, date_of_birth: DateTime.parse(2023-01-15), gender: MAN }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", group_number: "string", name: "string", type: PPO, period: {  }, insurance_card_image_locator: "string" }, verified: true }
+          #  )
+          def update(id:, version:, request:, request_options: nil)
+            Async do
+              response = @request_client.conn.put 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1/#{id}/#{version}"
+              end
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+            end
+          end
+
+          # gets a specific Coverage
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @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.get(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+          def get(id:, 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.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1/#{id}"
+              end
+              CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
+            end
+          end
+
+          # Gets a coverage along with it's full history. The return list is ordered by
+          #  version ascending.
+          #
+          # @param id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.get_history(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
+          def get_history(id:, 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.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1/#{id}/history"
+              end
+              parsed_json = JSON.parse(response.body)
+              parsed_json&.map do |item|
+                item = item.to_json
+                CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+              end
+            end
+          end
+
+          # returns a list of Coverages based on the search criteria
+          #
+          # @param patient_id [String]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.get_multi(patient_id: "string")
+          def get_multi(patient_id: 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
+                }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1"
+              end
+              parsed_json = JSON.parse(response.body)
+              parsed_json&.map do |item|
+                item = item.to_json
+                CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+              end
+            end
+          end
+
+          # Scans up to 100 coverage updates. The since query parameter is inclusive, and
+          #  the result list is ordered by updatedAt descending.
+          #
+          # @param since [DateTime]
+          # @param request_options [CandidApiClient::RequestOptions]
+          # @return [Array<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.scan(since: DateTime.parse(2024-01-15T09:30:00.000Z))
+          def scan(since:, 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 || {}), "since": since }.compact
+                req.url "#{@request_client.get_url(environment: PreEncounter,
+                                                   request_options: request_options)}/coverages/v1/updates/scan"
+              end
+              parsed_json = JSON.parse(response.body)
+              parsed_json&.map do |item|
+                item = item.to_json
+                CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: item)
+              end
+            end
           end
         end
       end