candidhealth 0.45.0 → 0.46.0

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

@@ -46,19 +46,7 @@ module CandidApiClient
         # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.patient_refunds.v_1.get_multi(
-        #    limit: 1,
-        #    patient_external_id: "string",
-        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    unattributed: true,
-        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    sources: MANUAL_ENTRY,
-        #    sort: REFUND_SOURCE,
-        #    sort_direction: ASC,
-        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
-        #  )
+        #  api.patient_refunds.v_1.get_multi
         def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
                       billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           response = @request_client.conn.get do |req|
@@ -133,12 +121,8 @@ module CandidApiClient
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.patient_refunds.v_1.create(
         #    amount_cents: 1,
-        #    refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z),
-        #    refund_note: "string",
-        #    patient_external_id: "string",
-        #    allocations: [{ amount_cents: 1 }],
-        #    invoice: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    refund_reason: OVERCHARGED
+        #    patient_external_id: "patient_external_id",
+        #    allocations: [{ amount_cents: 1 }, { amount_cents: 1 }]
         #  )
         def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
                    invoice: nil, refund_reason: nil, request_options: nil)
@@ -177,7 +161,7 @@ module CandidApiClient
         # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
                    request_options: nil)
           response = @request_client.conn.patch do |req|
@@ -253,19 +237,7 @@ module CandidApiClient
         # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefundsPage]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.patient_refunds.v_1.get_multi(
-        #    limit: 1,
-        #    patient_external_id: "string",
-        #    claim_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    billing_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    unattributed: true,
-        #    invoice_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    sources: MANUAL_ENTRY,
-        #    sort: REFUND_SOURCE,
-        #    sort_direction: ASC,
-        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
-        #  )
+        #  api.patient_refunds.v_1.get_multi
         def get_multi(limit: nil, patient_external_id: nil, claim_id: nil, service_line_id: nil,
                       billing_provider_id: nil, unattributed: nil, invoice_id: nil, sources: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           Async do
@@ -344,12 +316,8 @@ module CandidApiClient
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.patient_refunds.v_1.create(
         #    amount_cents: 1,
-        #    refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z),
-        #    refund_note: "string",
-        #    patient_external_id: "string",
-        #    allocations: [{ amount_cents: 1 }],
-        #    invoice: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    refund_reason: OVERCHARGED
+        #    patient_external_id: "patient_external_id",
+        #    allocations: [{ amount_cents: 1 }, { amount_cents: 1 }]
         #  )
         def create(amount_cents:, patient_external_id:, allocations:, refund_timestamp: nil, refund_note: nil,
                    invoice: nil, refund_reason: nil, request_options: nil)
@@ -390,7 +358,7 @@ module CandidApiClient
         # @return [CandidApiClient::PatientRefunds::V1::Types::PatientRefund]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", refund_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z))
+        #  api.patient_refunds.v_1.update(patient_refund_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
         def update(patient_refund_id:, refund_timestamp: nil, refund_note: nil, invoice: nil, refund_reason: nil,
                    request_options: nil)
           Async do

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

@@ -44,19 +44,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroupPage]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.get_multi(
-        #    plan_group_name: "string",
-        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    payer_id: "string",
-        #    plan_type: SELF_PAY,
-        #    is_active: true,
-        #    payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    limit: 1,
-        #    sort_by_similarity: "string",
-        #    sort: PLAN_GROUP_NAME,
-        #    sort_direction: ASC,
-        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
-        #  )
+        #  api.payer_plan_groups.v_1.get_multi
         def get_multi(plan_group_name: nil, payer_uuid: nil, payer_id: nil, plan_type: nil, is_active: nil,
                       payer_plan_group_id: nil, limit: nil, sort_by_similarity: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           response = @request_client.conn.get do |req|
@@ -120,7 +108,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.create(request: { plan_group_name: "string", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
+        #  api.payer_plan_groups.v_1.create(request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
         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?
@@ -148,7 +136,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.update(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { plan_group_name: "string", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
+        #  api.payer_plan_groups.v_1.update(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
         def update(payer_plan_group_id:, 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?
@@ -221,19 +209,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroupPage]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.get_multi(
-        #    plan_group_name: "string",
-        #    payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    payer_id: "string",
-        #    plan_type: SELF_PAY,
-        #    is_active: true,
-        #    payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
-        #    limit: 1,
-        #    sort_by_similarity: "string",
-        #    sort: PLAN_GROUP_NAME,
-        #    sort_direction: ASC,
-        #    page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"
-        #  )
+        #  api.payer_plan_groups.v_1.get_multi
         def get_multi(plan_group_name: nil, payer_uuid: nil, payer_id: nil, plan_type: nil, is_active: nil,
                       payer_plan_group_id: nil, limit: nil, sort_by_similarity: nil, sort: nil, sort_direction: nil, page_token: nil, request_options: nil)
           Async do
@@ -301,7 +277,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.create(request: { plan_group_name: "string", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
+        #  api.payer_plan_groups.v_1.create(request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
         def create(request:, request_options: nil)
           Async do
             response = @request_client.conn.post do |req|
@@ -331,7 +307,7 @@ module CandidApiClient
         # @return [CandidApiClient::PayerPlanGroups::V1::Types::PayerPlanGroup]
         # @example
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-        #  api.payer_plan_groups.v_1.update(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { plan_group_name: "string", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
+        #  api.payer_plan_groups.v_1.update(payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { plan_group_name: "plan_group_name", payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", plan_type: SELF_PAY })
         def update(payer_plan_group_id:, request:, request_options: nil)
           Async do
             response = @request_client.conn.put do |req|

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

@@ -23,7 +23,7 @@ module CandidApiClient
             @request_client = request_client
           end
 
-          # Adds an appointment. VersionConflictError is returned when the
+          # Adds an appointment.  VersionConflictError is returned when the
           #  placer_appointment_id is already in use.
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment, as a Hash
@@ -63,7 +63,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.create(request: { patient_id: "string", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), status: PENDING, service_duration: 1, services: [{ universal_service_identifier: MD_VISIT, start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }], placer_appointment_id: "string", attending_doctor: { name: { family: "string", given: ["string"], use: USUAL, period: {  }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: {  }, canonical_id: "string", fax: "string" }, estimated_copay_cents: 1, estimated_patient_responsibility_cents: 1, patient_deposit_cents: 1, checked_in_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), notes: "string", location_resource_id: "string", automated_eligibility_check_complete: true, work_queue: EMERGENT_ISSUE })
+          #  api.pre_encounter.appointments.v_1.create(request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{  }, {  }] })
           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?
@@ -92,13 +92,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get_visits(
-          #    page_token: "string",
-          #    limit: 1,
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.appointments.v_1.get_visits
           def get_visits(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
                          request_options: nil)
             response = @request_client.conn.get do |req|
@@ -130,7 +124,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get(id: "string")
+          #  api.pre_encounter.appointments.v_1.get(id: "id")
           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?
@@ -146,7 +140,7 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment.from_json(json_object: response.body)
           end
 
-          # Gets an appointment along with it's full history. The return list is ordered by
+          # Gets an appointment along with it's full history.  The return list is ordered by
           #  version ascending.
           #
           # @param id [String]
@@ -154,7 +148,7 @@ module CandidApiClient
           # @return [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment>]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get_history(id: "string")
+          #  api.pre_encounter.appointments.v_1.get_history(id: "id")
           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?
@@ -174,8 +168,8 @@ 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 most recent version to
+          #  prevent race conditions.  Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -217,9 +211,9 @@ module CandidApiClient
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
           #  api.pre_encounter.appointments.v_1.update(
-          #    id: "string",
-          #    version: "string",
-          #    request: { patient_id: "string", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), status: PENDING, service_duration: 1, services: [{ universal_service_identifier: MD_VISIT, start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }], placer_appointment_id: "string", attending_doctor: { name: { family: "string", given: ["string"], use: USUAL, period: {  }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: {  }, canonical_id: "string", fax: "string" }, estimated_copay_cents: 1, estimated_patient_responsibility_cents: 1, patient_deposit_cents: 1, checked_in_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), notes: "string", location_resource_id: "string", automated_eligibility_check_complete: true, work_queue: EMERGENT_ISSUE }
+          #    id: "id",
+          #    version: "version",
+          #    request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{  }, {  }] }
           #  )
           def update(id:, version:, request:, request_options: nil)
             response = @request_client.conn.put do |req|
@@ -237,8 +231,8 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment.from_json(json_object: response.body)
           end
 
-          # Scans up to 100 appointment updates. The since query parameter is inclusive, and
-          #  the result list is ordered by updatedAt ascending.
+          # Scans up to 100 appointment updates.  The since query parameter is inclusive,
+          #  and the result list is ordered by updatedAt ascending.
           #
           # @param since [DateTime]
           # @param request_options [CandidApiClient::RequestOptions]
@@ -266,8 +260,8 @@ module CandidApiClient
             end
           end
 
-          # Sets an appointment as deactivated. The path must contain the most recent
-          #  version to prevent race conditions. Deactivating historic versions is not
+          # Sets an appointment as deactivated.  The path must contain the most recent
+          #  version to prevent race conditions.  Deactivating historic versions is not
           #  supported. Subsequent updates via PUT to the appointment will "reactivate" the
           #  appointment and set the deactivated flag to false.
           #
@@ -277,7 +271,7 @@ module CandidApiClient
           # @return [Void]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.deactivate(id: "string", version: "string")
+          #  api.pre_encounter.appointments.v_1.deactivate(id: "id", version: "version")
           def deactivate(id:, version:, request_options: nil)
             @request_client.conn.delete do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -303,7 +297,7 @@ module CandidApiClient
             @request_client = request_client
           end
 
-          # Adds an appointment. VersionConflictError is returned when the
+          # Adds an appointment.  VersionConflictError is returned when the
           #  placer_appointment_id is already in use.
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment, as a Hash
@@ -343,7 +337,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.create(request: { patient_id: "string", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), status: PENDING, service_duration: 1, services: [{ universal_service_identifier: MD_VISIT, start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }], placer_appointment_id: "string", attending_doctor: { name: { family: "string", given: ["string"], use: USUAL, period: {  }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: {  }, canonical_id: "string", fax: "string" }, estimated_copay_cents: 1, estimated_patient_responsibility_cents: 1, patient_deposit_cents: 1, checked_in_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), notes: "string", location_resource_id: "string", automated_eligibility_check_complete: true, work_queue: EMERGENT_ISSUE })
+          #  api.pre_encounter.appointments.v_1.create(request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{  }, {  }] })
           def create(request:, request_options: nil)
             Async do
               response = @request_client.conn.post do |req|
@@ -374,13 +368,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get_visits(
-          #    page_token: "string",
-          #    limit: 1,
-          #    sort_field: "string",
-          #    sort_direction: ASC,
-          #    filters: "string"
-          #  )
+          #  api.pre_encounter.appointments.v_1.get_visits
           def get_visits(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
                          request_options: nil)
             Async do
@@ -414,7 +402,7 @@ module CandidApiClient
           # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get(id: "string")
+          #  api.pre_encounter.appointments.v_1.get(id: "id")
           def get(id:, request_options: nil)
             Async do
               response = @request_client.conn.get do |req|
@@ -432,7 +420,7 @@ module CandidApiClient
             end
           end
 
-          # Gets an appointment along with it's full history. The return list is ordered by
+          # Gets an appointment along with it's full history.  The return list is ordered by
           #  version ascending.
           #
           # @param id [String]
@@ -440,7 +428,7 @@ module CandidApiClient
           # @return [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment>]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.get_history(id: "string")
+          #  api.pre_encounter.appointments.v_1.get_history(id: "id")
           def get_history(id:, request_options: nil)
             Async do
               response = @request_client.conn.get do |req|
@@ -462,8 +450,8 @@ 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 most recent version to
+          #  prevent race conditions.  Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -505,9 +493,9 @@ module CandidApiClient
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
           #  api.pre_encounter.appointments.v_1.update(
-          #    id: "string",
-          #    version: "string",
-          #    request: { patient_id: "string", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), status: PENDING, service_duration: 1, services: [{ universal_service_identifier: MD_VISIT, start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }], placer_appointment_id: "string", attending_doctor: { name: { family: "string", given: ["string"], use: USUAL, period: {  }, suffix: "string" }, type: PRIMARY, npi: "string", telecoms: [{ value: "string", use: HOME }], addresses: , period: {  }, canonical_id: "string", fax: "string" }, estimated_copay_cents: 1, estimated_patient_responsibility_cents: 1, patient_deposit_cents: 1, checked_in_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), notes: "string", location_resource_id: "string", automated_eligibility_check_complete: true, work_queue: EMERGENT_ISSUE }
+          #    id: "id",
+          #    version: "version",
+          #    request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{  }, {  }] }
           #  )
           def update(id:, version:, request:, request_options: nil)
             Async do
@@ -527,8 +515,8 @@ module CandidApiClient
             end
           end
 
-          # Scans up to 100 appointment updates. The since query parameter is inclusive, and
-          #  the result list is ordered by updatedAt ascending.
+          # Scans up to 100 appointment updates.  The since query parameter is inclusive,
+          #  and the result list is ordered by updatedAt ascending.
           #
           # @param since [DateTime]
           # @param request_options [CandidApiClient::RequestOptions]
@@ -558,8 +546,8 @@ module CandidApiClient
             end
           end
 
-          # Sets an appointment as deactivated. The path must contain the most recent
-          #  version to prevent race conditions. Deactivating historic versions is not
+          # Sets an appointment as deactivated.  The path must contain the most recent
+          #  version to prevent race conditions.  Deactivating historic versions is not
           #  supported. Subsequent updates via PUT to the appointment will "reactivate" the
           #  appointment and set the deactivated flag to false.
           #
@@ -569,7 +557,7 @@ module CandidApiClient
           # @return [Void]
           # @example
           #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
-          #  api.pre_encounter.appointments.v_1.deactivate(id: "string", version: "string")
+          #  api.pre_encounter.appointments.v_1.deactivate(id: "id", version: "version")
           def deactivate(id:, version:, request_options: nil)
             Async do
               @request_client.conn.delete do |req|

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

@@ -19,10 +19,10 @@ module CandidApiClient
             attr_reader :id
             # @return [String] The organization that owns this object.
             attr_reader :organization_id
-            # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+            # @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]
@@ -82,9 +82,9 @@ module CandidApiClient
 
             # @param id [String]
             # @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
+            # @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.

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

@@ -11,10 +11,10 @@ module CandidApiClient
         class BaseModel
           # @return [String] The organization that owns this object.
           attr_reader :organization_id
-          # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
+          # @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]
@@ -30,9 +30,9 @@ module CandidApiClient
           OMIT = Object.new
 
           # @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
+          # @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.