candidhealth 1.3.1 → 1.5.0

data/lib/candidhealth/fee_schedules/v_3/client.rb

@@ -17,6 +17,7 @@ require "json"
 require_relative "types/rate_upload"
 require_relative "types/payer_threshold"
 require_relative "types/payer_thresholds_page"
+require_relative "types/optional_dimensions"
 require "async"
 
 module CandidApiClient
@@ -345,6 +346,45 @@ module CandidApiClient
           end
           CandidApiClient::FeeSchedules::V3::Types::PayerThreshold.from_json(json_object: response.body)
         end
+
+        # Hard deletes rates from the system that match the provided dimensions.  This is
+        #  a destructive operation and cannot be undone.  If an empty dimensions object is
+        #  provided, all rates will be hard deleted.  The maximum number of rates this API
+        #  will delete at a time is 10000.  Returns the number of rates deleted and if that
+        #  number is the maximum, the caller should call this API again to continue
+        #  deleting rates.
+        #
+        # @param request [Hash] Request of type CandidApiClient::FeeSchedules::V3::Types::OptionalDimensions, as a Hash
+        #   * :payer_uuid (String)
+        #   * :organization_billing_provider_id (String)
+        #   * :states (Set<CandidApiClient::Commons::Types::State>)
+        #   * :zip_codes (Set<String>)
+        #   * :license_types (Set<CandidApiClient::OrganizationProviders::V2::Types::LicenseType>)
+        #   * :facility_type_codes (Set<CandidApiClient::Commons::Types::FacilityTypeCode>)
+        #   * :network_types (Set<CandidApiClient::Commons::Types::NetworkType>)
+        #   * :payer_plan_group_ids (Set<String>)
+        #   * :cpt_code (String)
+        #   * :modifiers (Set<CandidApiClient::Commons::Types::ProcedureModifier>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Integer]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.fee_schedules.v_3.hard_delete_rates(request: { states: Set[AA], zip_codes: Set["zip_codes"], license_types: Set[MD], facility_type_codes: Set[PHARMACY], network_types: Set[PPO], payer_plan_group_ids: Set["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], modifiers: Set[AV] })
+        def hard_delete_rates(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: CandidApi,
+                                               request_options: request_options)}/api/fee-schedules/v3/hard-delete"
+          end
+          JSON.parse(response.body)
+        end
       end
 
       class AsyncV3Client
@@ -697,6 +737,48 @@ module CandidApiClient
             CandidApiClient::FeeSchedules::V3::Types::PayerThreshold.from_json(json_object: response.body)
           end
         end
+
+        # Hard deletes rates from the system that match the provided dimensions.  This is
+        #  a destructive operation and cannot be undone.  If an empty dimensions object is
+        #  provided, all rates will be hard deleted.  The maximum number of rates this API
+        #  will delete at a time is 10000.  Returns the number of rates deleted and if that
+        #  number is the maximum, the caller should call this API again to continue
+        #  deleting rates.
+        #
+        # @param request [Hash] Request of type CandidApiClient::FeeSchedules::V3::Types::OptionalDimensions, as a Hash
+        #   * :payer_uuid (String)
+        #   * :organization_billing_provider_id (String)
+        #   * :states (Set<CandidApiClient::Commons::Types::State>)
+        #   * :zip_codes (Set<String>)
+        #   * :license_types (Set<CandidApiClient::OrganizationProviders::V2::Types::LicenseType>)
+        #   * :facility_type_codes (Set<CandidApiClient::Commons::Types::FacilityTypeCode>)
+        #   * :network_types (Set<CandidApiClient::Commons::Types::NetworkType>)
+        #   * :payer_plan_group_ids (Set<String>)
+        #   * :cpt_code (String)
+        #   * :modifiers (Set<CandidApiClient::Commons::Types::ProcedureModifier>)
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [Integer]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.fee_schedules.v_3.hard_delete_rates(request: { states: Set[AA], zip_codes: Set["zip_codes"], license_types: Set[MD], facility_type_codes: Set[PHARMACY], network_types: Set[PPO], payer_plan_group_ids: Set["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], modifiers: Set[AV] })
+        def hard_delete_rates(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: CandidApi,
+                                                 request_options: request_options)}/api/fee-schedules/v3/hard-delete"
+            end
+            parsed_json = JSON.parse(response.body)
+            parsed_json
+          end
+        end
       end
     end
   end

data/lib/candidhealth/individual/types/subscriber_create.rb

@@ -12,7 +12,9 @@ module CandidApiClient
   module Individual
     module Types
       class SubscriberCreate
-        # @return [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreate]
+        # @return [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreate] Please reference our [Payer
+        #  Information](https://docs.joincandidhealth.com/introduction/payer-information)
+        #  documentation for more details on how to populate the `insurance_card` fields.
         attr_reader :insurance_card
         # @return [CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll]
         attr_reader :patient_relationship_to_subscriber_code
@@ -34,7 +36,9 @@ module CandidApiClient
 
         OMIT = Object.new
 
-        # @param insurance_card [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreate]
+        # @param insurance_card [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreate] Please reference our [Payer
+        #  Information](https://docs.joincandidhealth.com/introduction/payer-information)
+        #  documentation for more details on how to populate the `insurance_card` fields.
         # @param patient_relationship_to_subscriber_code [CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll]
         # @param date_of_birth [Date]
         # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip]

data/lib/candidhealth/individual/types/subscriber_create_optional.rb

@@ -12,7 +12,9 @@ module CandidApiClient
   module Individual
     module Types
       class SubscriberCreateOptional
-        # @return [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreateOptional]
+        # @return [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreateOptional] Please reference our [Payer
+        #  Information](https://docs.joincandidhealth.com/introduction/payer-information)
+        #  documentation for more details on how to populate the `insurance_card` fields.
         attr_reader :insurance_card
         # @return [CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll]
         attr_reader :patient_relationship_to_subscriber_code
@@ -34,7 +36,9 @@ module CandidApiClient
 
         OMIT = Object.new
 
-        # @param insurance_card [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreateOptional]
+        # @param insurance_card [CandidApiClient::InsuranceCards::V2::Types::InsuranceCardCreateOptional] Please reference our [Payer
+        #  Information](https://docs.joincandidhealth.com/introduction/payer-information)
+        #  documentation for more details on how to populate the `insurance_card` fields.
         # @param patient_relationship_to_subscriber_code [CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll]
         # @param date_of_birth [Date]
         # @param address [CandidApiClient::Commons::Types::StreetAddressShortZipOptional]

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

@@ -7,6 +7,7 @@ require_relative "types/toggle_non_insurance_payer_enablement_request"
 require_relative "types/non_insurance_payer_sort_field"
 require_relative "../../commons/types/sort_direction"
 require_relative "types/non_insurance_payer_page"
+require_relative "types/non_insurance_payer_categories_page"
 require_relative "types/non_insurance_payer_update_request"
 require "async"
 
@@ -81,7 +82,13 @@ module CandidApiClient
         end
 
         # @param name [String]
-        # @param category [String]
+        # @param category [String] Fuzzy-match category names of non-insurance payers.
+        # @param categories_exact [String] Filter by one or more categories by name.
+        #  When multiple are present, non-insurance payers with any of the specified
+        #  categories will be matched.
+        # @param clinical_trial_ids [String] Filter by one or more clinical trials by their `clinical_trial_id`.
+        #  When multiple are present, non-insurance payers with any of the specified
+        #  clinical trials will be matched.
         # @param enabled [Boolean]
         # @param sort [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerSortField]
         # @param sort_direction [CandidApiClient::Commons::Types::SortDirection]
@@ -92,8 +99,8 @@ module CandidApiClient
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.non_insurance_payers.v_1.get_multi
-        def get_multi(name: nil, category: nil, enabled: nil, sort: nil, sort_direction: nil, limit: nil,
-                      page_token: nil, request_options: nil)
+        def get_multi(name: nil, category: nil, categories_exact: nil, clinical_trial_ids: nil, enabled: nil,
+                      sort: nil, sort_direction: nil, limit: nil, page_token: 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?
@@ -106,6 +113,8 @@ module CandidApiClient
               **(request_options&.additional_query_parameters || {}),
               "name": name,
               "category": category,
+              "categories_exact": categories_exact,
+              "clinical_trial_ids": clinical_trial_ids,
               "enabled": enabled,
               "sort": sort,
               "sort_direction": sort_direction,
@@ -118,6 +127,41 @@ module CandidApiClient
           CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerPage.from_json(json_object: response.body)
         end
 
+        # Returns a paginated list of all non-insurance payer categories.
+        #  Non-insurance payer categories are simply strings and are not stored as a
+        #  separate object in Candid. They are created when added to at least one
+        #  non-insurance payer's `category` field and are deleted when there are no
+        #  longer any non-insurance payers that contain them.
+        #
+        # @param search_term [String] Filters categories by fuzzy matching on name.
+        # @param limit [Integer] Limits the maximum number of categories that will be returned. Defaults to 100.
+        # @param page_token [String] The page token to continue paging through a previous request.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerCategoriesPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.non_insurance_payers.v_1.get_categories
+        def get_categories(search_term: nil, limit: nil, page_token: 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 || {}),
+              "search_term": search_term,
+              "limit": limit,
+              "page_token": page_token
+            }.compact
+            req.url "#{@request_client.get_url(environment: CandidApi,
+                                               request_options: request_options)}/api/non-insurance-payers/v1/categories"
+          end
+          CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerCategoriesPage.from_json(json_object: response.body)
+        end
+
         # @param non_insurance_payer_id [String]
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer]
@@ -259,7 +303,13 @@ module CandidApiClient
         end
 
         # @param name [String]
-        # @param category [String]
+        # @param category [String] Fuzzy-match category names of non-insurance payers.
+        # @param categories_exact [String] Filter by one or more categories by name.
+        #  When multiple are present, non-insurance payers with any of the specified
+        #  categories will be matched.
+        # @param clinical_trial_ids [String] Filter by one or more clinical trials by their `clinical_trial_id`.
+        #  When multiple are present, non-insurance payers with any of the specified
+        #  clinical trials will be matched.
         # @param enabled [Boolean]
         # @param sort [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerSortField]
         # @param sort_direction [CandidApiClient::Commons::Types::SortDirection]
@@ -270,8 +320,8 @@ module CandidApiClient
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.non_insurance_payers.v_1.get_multi
-        def get_multi(name: nil, category: nil, enabled: nil, sort: nil, sort_direction: nil, limit: nil,
-                      page_token: nil, request_options: nil)
+        def get_multi(name: nil, category: nil, categories_exact: nil, clinical_trial_ids: nil, enabled: nil,
+                      sort: nil, sort_direction: nil, limit: nil, page_token: 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?
@@ -285,6 +335,8 @@ module CandidApiClient
                 **(request_options&.additional_query_parameters || {}),
                 "name": name,
                 "category": category,
+                "categories_exact": categories_exact,
+                "clinical_trial_ids": clinical_trial_ids,
                 "enabled": enabled,
                 "sort": sort,
                 "sort_direction": sort_direction,
@@ -298,6 +350,43 @@ module CandidApiClient
           end
         end
 
+        # Returns a paginated list of all non-insurance payer categories.
+        #  Non-insurance payer categories are simply strings and are not stored as a
+        #  separate object in Candid. They are created when added to at least one
+        #  non-insurance payer's `category` field and are deleted when there are no
+        #  longer any non-insurance payers that contain them.
+        #
+        # @param search_term [String] Filters categories by fuzzy matching on name.
+        # @param limit [Integer] Limits the maximum number of categories that will be returned. Defaults to 100.
+        # @param page_token [String] The page token to continue paging through a previous request.
+        # @param request_options [CandidApiClient::RequestOptions]
+        # @return [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerCategoriesPage]
+        # @example
+        #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
+        #  api.non_insurance_payers.v_1.get_categories
+        def get_categories(search_term: nil, limit: nil, page_token: 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 || {}),
+                "search_term": search_term,
+                "limit": limit,
+                "page_token": page_token
+              }.compact
+              req.url "#{@request_client.get_url(environment: CandidApi,
+                                                 request_options: request_options)}/api/non-insurance-payers/v1/categories"
+            end
+            CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayerCategoriesPage.from_json(json_object: response.body)
+          end
+        end
+
         # @param non_insurance_payer_id [String]
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::NonInsurancePayers::V1::Types::NonInsurancePayer]

data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_categories_page.rb

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

data/lib/candidhealth/organization_providers/v_3/client.rb

@@ -47,6 +47,7 @@ module CandidApiClient
         # @param npi [String] Filter to a specific NPI.
         # @param is_rendering [Boolean] Filter to only rendering providers.
         # @param is_billing [Boolean] Filter to only billing providers.
+        # @param organization_provider_ids [String] Filter to the provided organization provider IDs.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param sort [CandidApiClient::OrganizationProviders::V2::Types::OrganizationProviderSortOptions] Defaults to PROVIDER_NAME_ASC.
         # @param request_options [CandidApiClient::RequestOptions]
@@ -62,8 +63,8 @@ module CandidApiClient
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
         #    sort: PROVIDER_NAME_ASC
         #  )
-        def get_multi(limit: nil, search_term: nil, npi: nil, is_rendering: nil, is_billing: nil, page_token: nil,
-                      sort: nil, request_options: nil)
+        def get_multi(limit: nil, search_term: nil, npi: nil, is_rendering: nil, is_billing: nil,
+                      organization_provider_ids: nil, page_token: nil, sort: 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?
@@ -79,6 +80,7 @@ module CandidApiClient
               "npi": npi,
               "is_rendering": is_rendering,
               "is_billing": is_billing,
+              "organization_provider_ids": organization_provider_ids,
               "page_token": page_token,
               "sort": sort
             }.compact
@@ -200,6 +202,7 @@ module CandidApiClient
         # @param npi [String] Filter to a specific NPI.
         # @param is_rendering [Boolean] Filter to only rendering providers.
         # @param is_billing [Boolean] Filter to only billing providers.
+        # @param organization_provider_ids [String] Filter to the provided organization provider IDs.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param sort [CandidApiClient::OrganizationProviders::V2::Types::OrganizationProviderSortOptions] Defaults to PROVIDER_NAME_ASC.
         # @param request_options [CandidApiClient::RequestOptions]
@@ -215,8 +218,8 @@ module CandidApiClient
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
         #    sort: PROVIDER_NAME_ASC
         #  )
-        def get_multi(limit: nil, search_term: nil, npi: nil, is_rendering: nil, is_billing: nil, page_token: nil,
-                      sort: nil, request_options: nil)
+        def get_multi(limit: nil, search_term: nil, npi: nil, is_rendering: nil, is_billing: nil,
+                      organization_provider_ids: nil, page_token: nil, sort: 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?
@@ -233,6 +236,7 @@ module CandidApiClient
                 "npi": npi,
                 "is_rendering": is_rendering,
                 "is_billing": is_billing,
+                "organization_provider_ids": organization_provider_ids,
                 "page_token": page_token,
                 "sort": sort
               }.compact

data/lib/candidhealth/organization_service_facilities/v_2/client.rb

@@ -43,6 +43,7 @@ module CandidApiClient
 
         # @param limit [Integer] Limit the number of results returned. Defaults to 100.
         # @param name [String] Filter to a name or a part of a name.
+        # @param organization_service_facility_ids [String] Filter to the provided organization service facility IDs.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage]
@@ -53,7 +54,8 @@ module CandidApiClient
         #    name: "Test Service Facility",
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
         #  )
-        def get_multi(limit: nil, name: nil, page_token: nil, request_options: nil)
+        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, page_token: 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?
@@ -66,6 +68,7 @@ module CandidApiClient
               **(request_options&.additional_query_parameters || {}),
               "limit": limit,
               "name": name,
+              "organization_service_facility_ids": organization_service_facility_ids,
               "page_token": page_token
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
@@ -209,6 +212,7 @@ module CandidApiClient
 
         # @param limit [Integer] Limit the number of results returned. Defaults to 100.
         # @param name [String] Filter to a name or a part of a name.
+        # @param organization_service_facility_ids [String] Filter to the provided organization service facility IDs.
         # @param page_token [String] The page token to continue paging through a previous request.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::OrganizationServiceFacilities::V2::Types::OrganizationServiceFacilityPage]
@@ -219,7 +223,8 @@ module CandidApiClient
         #    name: "Test Service Facility",
         #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
         #  )
-        def get_multi(limit: nil, name: nil, page_token: nil, request_options: nil)
+        def get_multi(limit: nil, name: nil, organization_service_facility_ids: nil, page_token: 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?
@@ -233,6 +238,7 @@ module CandidApiClient
                 **(request_options&.additional_query_parameters || {}),
                 "limit": limit,
                 "name": name,
+                "organization_service_facility_ids": organization_service_facility_ids,
                 "page_token": page_token
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,

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

@@ -54,6 +54,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -168,8 +169,10 @@ module CandidApiClient
             end
           end
 
-          # Updates an appointment.  The path must contain the most recent version to
-          #  prevent race conditions.  Updating historic versions is not supported.
+          # Updates an appointment. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the appointment is n,
+          #  you will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  appointment. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -201,6 +204,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -328,6 +332,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -450,8 +455,10 @@ module CandidApiClient
             end
           end
 
-          # Updates an appointment.  The path must contain the most recent version to
-          #  prevent race conditions.  Updating historic versions is not supported.
+          # Updates an appointment. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the appointment is n,
+          #  you will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  appointment. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -483,6 +490,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)

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

@@ -22,7 +22,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -54,6 +54,8 @@ module CandidApiClient
             attr_reader :estimated_patient_responsibility_cents
             # @return [Integer]
             attr_reader :patient_deposit_cents
+            # @return [String]
+            attr_reader :appointment_details
             # @return [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -84,7 +86,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.
@@ -103,6 +105,7 @@ module CandidApiClient
             # @param estimated_copay_cents [Integer]
             # @param estimated_patient_responsibility_cents [Integer]
             # @param patient_deposit_cents [Integer]
+            # @param appointment_details [String]
             # @param checked_in_timestamp [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -119,7 +122,7 @@ module CandidApiClient
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
             def initialize(id:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:, patient_id:,
-                           start_timestamp:, service_duration:, services:, status: OMIT, placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
+                           start_timestamp:, service_duration:, services:, status: OMIT, placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, appointment_details: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
               @id = id
               @organization_id = organization_id
               @deactivated = deactivated
@@ -138,6 +141,7 @@ module CandidApiClient
                 @estimated_patient_responsibility_cents = estimated_patient_responsibility_cents
               end
               @patient_deposit_cents = patient_deposit_cents if patient_deposit_cents != OMIT
+              @appointment_details = appointment_details if appointment_details != OMIT
               @checked_in_timestamp = checked_in_timestamp if checked_in_timestamp != OMIT
               @notes = notes if notes != OMIT
               @location_resource_id = location_resource_id if location_resource_id != OMIT
@@ -163,6 +167,7 @@ module CandidApiClient
                 "estimated_copay_cents": estimated_copay_cents,
                 "estimated_patient_responsibility_cents": estimated_patient_responsibility_cents,
                 "patient_deposit_cents": patient_deposit_cents,
+                "appointment_details": appointment_details,
                 "checked_in_timestamp": checked_in_timestamp,
                 "notes": notes,
                 "location_resource_id": location_resource_id,
@@ -206,6 +211,7 @@ module CandidApiClient
               estimated_copay_cents = struct["estimated_copay_cents"]
               estimated_patient_responsibility_cents = struct["estimated_patient_responsibility_cents"]
               patient_deposit_cents = struct["patient_deposit_cents"]
+              appointment_details = struct["appointment_details"]
               checked_in_timestamp = unless parsed_json["checked_in_timestamp"].nil?
                                        DateTime.parse(parsed_json["checked_in_timestamp"])
                                      end
@@ -230,6 +236,7 @@ module CandidApiClient
                 estimated_copay_cents: estimated_copay_cents,
                 estimated_patient_responsibility_cents: estimated_patient_responsibility_cents,
                 patient_deposit_cents: patient_deposit_cents,
+                appointment_details: appointment_details,
                 checked_in_timestamp: checked_in_timestamp,
                 notes: notes,
                 location_resource_id: location_resource_id,
@@ -269,6 +276,7 @@ module CandidApiClient
               obj.estimated_copay_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_copay_cents is not the expected type, validation failed.")
               obj.estimated_patient_responsibility_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_patient_responsibility_cents is not the expected type, validation failed.")
               obj.patient_deposit_cents&.is_a?(Integer) != false || raise("Passed value for field obj.patient_deposit_cents is not the expected type, validation failed.")
+              obj.appointment_details&.is_a?(String) != false || raise("Passed value for field obj.appointment_details is not the expected type, validation failed.")
               obj.checked_in_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.checked_in_timestamp is not the expected type, validation failed.")
               obj.notes&.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
               obj.location_resource_id&.is_a?(String) != false || raise("Passed value for field obj.location_resource_id is not the expected type, validation failed.")