candidhealth 0.43.1 → 0.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/billing_notes/v_2/client.rb +2 -2
  3. data/lib/candidhealth/charge_capture/v_1/client.rb +479 -559
  4. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +200 -190
  5. data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +2 -44
  6. data/lib/candidhealth/commons/types/street_address_optional_base.rb +99 -0
  7. data/lib/candidhealth/commons/types/street_address_short_zip_optional.rb +107 -0
  8. data/lib/candidhealth/contracts/v_2/client.rb +18 -34
  9. data/lib/candidhealth/contracts/v_2/types/contract_sort_field.rb +18 -0
  10. data/lib/candidhealth/credentialing/v_2/client.rb +6 -44
  11. data/lib/candidhealth/diagnoses/client.rb +4 -14
  12. data/lib/candidhealth/eligibility/v_2/client.rb +4 -4
  13. data/lib/candidhealth/encounter_attachments/v_1/client.rb +0 -6
  14. data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
  15. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +160 -0
  16. data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider_update_with_optional_address.rb +134 -0
  17. data/lib/candidhealth/encounter_providers/v_2/types/referring_provider_update_with_optional_address.rb +125 -0
  18. data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +125 -0
  19. data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider_update_with_optional_address.rb +125 -0
  20. data/lib/candidhealth/encounters/v_4/client.rb +259 -293
  21. data/lib/candidhealth/encounters/v_4/types/encounter.rb +23 -13
  22. data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +10 -10
  23. data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +10 -10
  24. data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +26 -184
  25. data/lib/candidhealth/expected_network_status/v_1/client.rb +12 -18
  26. data/lib/candidhealth/expected_network_status/v_2/client.rb +4 -4
  27. data/lib/candidhealth/expected_network_status/v_2/types/empty_object.rb +53 -0
  28. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +13 -10
  29. data/lib/candidhealth/external_payment_account_config/v_1/client.rb +2 -2
  30. data/lib/candidhealth/fee_schedules/v_3/client.rb +12 -68
  31. data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +3 -3
  32. data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +2 -2
  33. data/lib/candidhealth/guarantor/v_1/client.rb +4 -4
  34. data/lib/candidhealth/import_invoice/v_1/client.rb +6 -28
  35. data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb +179 -0
  36. data/lib/candidhealth/insurance_adjudications/v_1/client.rb +2 -2
  37. data/lib/candidhealth/insurance_payments/v_1/client.rb +2 -20
  38. data/lib/candidhealth/insurance_refunds/v_1/client.rb +6 -24
  39. data/lib/candidhealth/medication_dispense/v_1/client.rb +2 -2
  40. data/lib/candidhealth/non_insurance_payer_payments/v_1/client.rb +6 -22
  41. data/lib/candidhealth/non_insurance_payer_refunds/v_1/client.rb +6 -22
  42. data/lib/candidhealth/non_insurance_payers/v_1/client.rb +6 -22
  43. data/lib/candidhealth/organization_providers/v_3/client.rb +4 -4
  44. data/lib/candidhealth/organization_service_facilities/v_2/client.rb +2 -2
  45. data/lib/candidhealth/patient_payments/v_4/client.rb +8 -38
  46. data/lib/candidhealth/patient_refunds/v_1/client.rb +8 -40
  47. data/lib/candidhealth/payer_plan_groups/v_1/client.rb +6 -30
  48. data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +32 -44
  49. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +4 -4
  50. data/lib/candidhealth/pre_encounter/common/types/base_model.rb +4 -4
  51. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +24 -34
  52. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +4 -4
  53. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +2 -2
  54. data/lib/candidhealth/pre_encounter/images/v_1/client.rb +20 -20
  55. data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +6 -6
  56. data/lib/candidhealth/pre_encounter/lists/v_1/client.rb +4 -28
  57. data/lib/candidhealth/pre_encounter/notes/v_1/client.rb +14 -14
  58. data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +4 -4
  59. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +56 -68
  60. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +8 -8
  61. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +8 -8
  62. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +16 -16
  63. data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +16 -16
  64. data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +4 -4
  65. data/lib/candidhealth/service_facility/client.rb +2 -2
  66. data/lib/candidhealth/service_facility/types/encounter_service_facility_update_with_optional_address.rb +113 -0
  67. data/lib/candidhealth/service_lines/v_2/client.rb +4 -4
  68. data/lib/candidhealth/superbills/v_1/client.rb +4 -6
  69. data/lib/candidhealth/tasks/v_3/client.rb +6 -34
  70. data/lib/candidhealth/write_offs/v_1/client.rb +2 -24
  71. data/lib/environment.rb +4 -0
  72. data/lib/requests.rb +2 -2
  73. data/lib/types_export.rb +11 -1
  74. metadata +13 -3
  75. data/lib/candidhealth/billing_notes/v_2/types/billing_note_optional.rb +0 -112
data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb CHANGED
@@ -23,7 +23,7 @@ module CandidApiClient
23
23
  @request_client = request_client
24
24
  end
25
25
 
26
- # Adds an appointment. VersionConflictError is returned when the
26
+ # Adds an appointment. VersionConflictError is returned when the
27
27
  # placer_appointment_id is already in use.
28
28
  #
29
29
  # @param request [Hash] Request of type CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment, as a Hash
@@ -63,7 +63,7 @@ module CandidApiClient
63
63
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
64
64
  # @example
65
65
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
66
- # 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 })
66
+ # 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: [{ }, { }] })
67
67
  def create(request:, request_options: nil)
68
68
  response = @request_client.conn.post do |req|
69
69
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -92,13 +92,7 @@ module CandidApiClient
92
92
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
93
93
  # @example
94
94
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
95
- # api.pre_encounter.appointments.v_1.get_visits(
96
- # page_token: "string",
97
- # limit: 1,
98
- # sort_field: "string",
99
- # sort_direction: ASC,
100
- # filters: "string"
101
- # )
95
+ # api.pre_encounter.appointments.v_1.get_visits
102
96
  def get_visits(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
103
97
  request_options: nil)
104
98
  response = @request_client.conn.get do |req|
@@ -130,7 +124,7 @@ module CandidApiClient
130
124
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
131
125
  # @example
132
126
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
133
- # api.pre_encounter.appointments.v_1.get(id: "string")
127
+ # api.pre_encounter.appointments.v_1.get(id: "id")
134
128
  def get(id:, request_options: nil)
135
129
  response = @request_client.conn.get do |req|
136
130
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -146,7 +140,7 @@ module CandidApiClient
146
140
  CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment.from_json(json_object: response.body)
147
141
  end
148
142
 
149
- # Gets an appointment along with it's full history. The return list is ordered by
143
+ # Gets an appointment along with it's full history. The return list is ordered by
150
144
  # version ascending.
151
145
  #
152
146
  # @param id [String]
@@ -154,7 +148,7 @@ module CandidApiClient
154
148
  # @return [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment>]
155
149
  # @example
156
150
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
157
- # api.pre_encounter.appointments.v_1.get_history(id: "string")
151
+ # api.pre_encounter.appointments.v_1.get_history(id: "id")
158
152
  def get_history(id:, request_options: nil)
159
153
  response = @request_client.conn.get do |req|
160
154
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -174,8 +168,8 @@ module CandidApiClient
174
168
  end
175
169
  end
176
170
 
177
- # Updates an appointment. The path must contain the most recent version to prevent
178
- # race conditions. Updating historic versions is not supported.
171
+ # Updates an appointment. The path must contain the most recent version to
172
+ # prevent race conditions. Updating historic versions is not supported.
179
173
  #
180
174
  # @param id [String]
181
175
  # @param version [String]
@@ -217,9 +211,9 @@ module CandidApiClient
217
211
  # @example
218
212
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
219
213
  # api.pre_encounter.appointments.v_1.update(
220
- # id: "string",
221
- # version: "string",
222
- # 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 }
214
+ # id: "id",
215
+ # version: "version",
216
+ # request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{ }, { }] }
223
217
  # )
224
218
  def update(id:, version:, request:, request_options: nil)
225
219
  response = @request_client.conn.put do |req|
@@ -237,8 +231,8 @@ module CandidApiClient
237
231
  CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment.from_json(json_object: response.body)
238
232
  end
239
233
 
240
- # Scans up to 100 appointment updates. The since query parameter is inclusive, and
241
- # the result list is ordered by updatedAt ascending.
234
+ # Scans up to 100 appointment updates. The since query parameter is inclusive,
235
+ # and the result list is ordered by updatedAt ascending.
242
236
  #
243
237
  # @param since [DateTime]
244
238
  # @param request_options [CandidApiClient::RequestOptions]
@@ -266,8 +260,8 @@ module CandidApiClient
266
260
  end
267
261
  end
268
262
 
269
- # Sets an appointment as deactivated. The path must contain the most recent
270
- # version to prevent race conditions. Deactivating historic versions is not
263
+ # Sets an appointment as deactivated. The path must contain the most recent
264
+ # version to prevent race conditions. Deactivating historic versions is not
271
265
  # supported. Subsequent updates via PUT to the appointment will "reactivate" the
272
266
  # appointment and set the deactivated flag to false.
273
267
  #
@@ -277,7 +271,7 @@ module CandidApiClient
277
271
  # @return [Void]
278
272
  # @example
279
273
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
280
- # api.pre_encounter.appointments.v_1.deactivate(id: "string", version: "string")
274
+ # api.pre_encounter.appointments.v_1.deactivate(id: "id", version: "version")
281
275
  def deactivate(id:, version:, request_options: nil)
282
276
  @request_client.conn.delete do |req|
283
277
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -303,7 +297,7 @@ module CandidApiClient
303
297
  @request_client = request_client
304
298
  end
305
299
 
306
- # Adds an appointment. VersionConflictError is returned when the
300
+ # Adds an appointment. VersionConflictError is returned when the
307
301
  # placer_appointment_id is already in use.
308
302
  #
309
303
  # @param request [Hash] Request of type CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment, as a Hash
@@ -343,7 +337,7 @@ module CandidApiClient
343
337
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
344
338
  # @example
345
339
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
346
- # 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 })
340
+ # 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: [{ }, { }] })
347
341
  def create(request:, request_options: nil)
348
342
  Async do
349
343
  response = @request_client.conn.post do |req|
@@ -374,13 +368,7 @@ module CandidApiClient
374
368
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::VisitsPage]
375
369
  # @example
376
370
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
377
- # api.pre_encounter.appointments.v_1.get_visits(
378
- # page_token: "string",
379
- # limit: 1,
380
- # sort_field: "string",
381
- # sort_direction: ASC,
382
- # filters: "string"
383
- # )
371
+ # api.pre_encounter.appointments.v_1.get_visits
384
372
  def get_visits(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
385
373
  request_options: nil)
386
374
  Async do
@@ -414,7 +402,7 @@ module CandidApiClient
414
402
  # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
415
403
  # @example
416
404
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
417
- # api.pre_encounter.appointments.v_1.get(id: "string")
405
+ # api.pre_encounter.appointments.v_1.get(id: "id")
418
406
  def get(id:, request_options: nil)
419
407
  Async do
420
408
  response = @request_client.conn.get do |req|
@@ -432,7 +420,7 @@ module CandidApiClient
432
420
  end
433
421
  end
434
422
 
435
- # Gets an appointment along with it's full history. The return list is ordered by
423
+ # Gets an appointment along with it's full history. The return list is ordered by
436
424
  # version ascending.
437
425
  #
438
426
  # @param id [String]
@@ -440,7 +428,7 @@ module CandidApiClient
440
428
  # @return [Array<CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment>]
441
429
  # @example
442
430
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
443
- # api.pre_encounter.appointments.v_1.get_history(id: "string")
431
+ # api.pre_encounter.appointments.v_1.get_history(id: "id")
444
432
  def get_history(id:, request_options: nil)
445
433
  Async do
446
434
  response = @request_client.conn.get do |req|
@@ -462,8 +450,8 @@ module CandidApiClient
462
450
  end
463
451
  end
464
452
 
465
- # Updates an appointment. The path must contain the most recent version to prevent
466
- # race conditions. Updating historic versions is not supported.
453
+ # Updates an appointment. The path must contain the most recent version to
454
+ # prevent race conditions. Updating historic versions is not supported.
467
455
  #
468
456
  # @param id [String]
469
457
  # @param version [String]
@@ -505,9 +493,9 @@ module CandidApiClient
505
493
  # @example
506
494
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
507
495
  # api.pre_encounter.appointments.v_1.update(
508
- # id: "string",
509
- # version: "string",
510
- # 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 }
496
+ # id: "id",
497
+ # version: "version",
498
+ # request: { patient_id: "patient_id", start_timestamp: DateTime.parse(2024-01-15T09:30:00.000Z), service_duration: 1, services: [{ }, { }] }
511
499
  # )
512
500
  def update(id:, version:, request:, request_options: nil)
513
501
  Async do
@@ -527,8 +515,8 @@ module CandidApiClient
527
515
  end
528
516
  end
529
517
 
530
- # Scans up to 100 appointment updates. The since query parameter is inclusive, and
531
- # the result list is ordered by updatedAt ascending.
518
+ # Scans up to 100 appointment updates. The since query parameter is inclusive,
519
+ # and the result list is ordered by updatedAt ascending.
532
520
  #
533
521
  # @param since [DateTime]
534
522
  # @param request_options [CandidApiClient::RequestOptions]
@@ -558,8 +546,8 @@ module CandidApiClient
558
546
  end
559
547
  end
560
548
 
561
- # Sets an appointment as deactivated. The path must contain the most recent
562
- # version to prevent race conditions. Deactivating historic versions is not
549
+ # Sets an appointment as deactivated. The path must contain the most recent
550
+ # version to prevent race conditions. Deactivating historic versions is not
563
551
  # supported. Subsequent updates via PUT to the appointment will "reactivate" the
564
552
  # appointment and set the deactivated flag to false.
565
553
  #
@@ -569,7 +557,7 @@ module CandidApiClient
569
557
  # @return [Void]
570
558
  # @example
571
559
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
572
- # api.pre_encounter.appointments.v_1.deactivate(id: "string", version: "string")
560
+ # api.pre_encounter.appointments.v_1.deactivate(id: "id", version: "version")
573
561
  def deactivate(id:, version:, request_options: nil)
574
562
  Async do
575
563
  @request_client.conn.delete do |req|
data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb CHANGED
@@ -19,10 +19,10 @@ module CandidApiClient
19
19
  attr_reader :id
20
20
  # @return [String] The organization that owns this object.
21
21
  attr_reader :organization_id
22
- # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
22
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
23
23
  # search results but are returned in all other endpoints including scan.
24
24
  attr_reader :deactivated
25
- # @return [Integer] The version of the object. Any update to any property of an object object will
25
+ # @return [Integer] The version of the object. Any update to any property of an object object will
26
26
  # create a new version.
27
27
  attr_reader :version
28
28
  # @return [DateTime]
@@ -82,9 +82,9 @@ module CandidApiClient
82
82
 
83
83
  # @param id [String]
84
84
  # @param organization_id [String] The organization that owns this object.
85
- # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
85
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
86
86
  # search results but are returned in all other endpoints including scan.
87
- # @param version [Integer] The version of the object. Any update to any property of an object object will
87
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
88
88
  # create a new version.
89
89
  # @param updated_at [DateTime]
90
90
  # @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 CHANGED
@@ -11,10 +11,10 @@ module CandidApiClient
11
11
  class BaseModel
12
12
  # @return [String] The organization that owns this object.
13
13
  attr_reader :organization_id
14
- # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
14
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
15
15
  # search results but are returned in all other endpoints including scan.
16
16
  attr_reader :deactivated
17
- # @return [Integer] The version of the object. Any update to any property of an object object will
17
+ # @return [Integer] The version of the object. Any update to any property of an object object will
18
18
  # create a new version.
19
19
  attr_reader :version
20
20
  # @return [DateTime]
@@ -30,9 +30,9 @@ module CandidApiClient
30
30
  OMIT = Object.new
31
31
 
32
32
  # @param organization_id [String] The organization that owns this object.
33
- # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
33
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
34
34
  # search results but are returned in all other endpoints including scan.
35
- # @param version [Integer] The version of the object. Any update to any property of an object object will
35
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
36
36
  # create a new version.
37
37
  # @param updated_at [DateTime]
38
38
  # @param updating_user_id [String] The user ID of the user who last updated the object.
data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb CHANGED
@@ -176,7 +176,7 @@ module CandidApiClient
176
176
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage]
177
177
  # @example
178
178
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
179
- # api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: { }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: { }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: { } })
179
+ # api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "family", given: ["given", "given"], use: USUAL }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE }, relationship: SELF, patient: "patient", insurance_plan: { member_id: "member_id", payer_id: "payer_id", payer_name: "payer_name" }, verified: true })
180
180
  def create(request:, request_options: nil)
181
181
  response = @request_client.conn.post do |req|
182
182
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -193,8 +193,8 @@ module CandidApiClient
193
193
  CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
194
194
  end
195
195
 
196
- # Updates a Coverage. The path must contain the most recent version to prevent
197
- # race conditions. Updating historic versions is not supported.
196
+ # Updates a Coverage. The path must contain the most recent version to prevent
197
+ # race conditions. Updating historic versions is not supported.
198
198
  #
199
199
  # @param id [String]
200
200
  # @param version [String]
@@ -344,8 +344,8 @@ module CandidApiClient
344
344
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
345
345
  # api.pre_encounter.coverages.v_1.update(
346
346
  # id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
347
- # version: "string",
348
- # request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: { }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: { }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: { } }
347
+ # version: "version",
348
+ # request: { status: ACTIVE, subscriber: { name: { family: "family", given: ["given", "given"], use: USUAL }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE }, relationship: SELF, patient: "patient", insurance_plan: { member_id: "member_id", payer_id: "payer_id", payer_name: "payer_name" }, verified: true }
349
349
  # )
350
350
  def update(id:, version:, request:, request_options: nil)
351
351
  response = @request_client.conn.put do |req|
@@ -373,12 +373,7 @@ module CandidApiClient
373
373
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage]
374
374
  # @example
375
375
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
376
- # api.pre_encounter.coverages.v_1.get_multi_paginated(
377
- # patient_id: "string",
378
- # payer_plan_group_id: "string",
379
- # page_token: "string",
380
- # limit: 1
381
- # )
376
+ # api.pre_encounter.coverages.v_1.get_multi_paginated
382
377
  def get_multi_paginated(patient_id: nil, payer_plan_group_id: nil, page_token: nil, limit: nil,
383
378
  request_options: nil)
384
379
  response = @request_client.conn.get do |req|
@@ -425,7 +420,7 @@ module CandidApiClient
425
420
  CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
426
421
  end
427
422
 
428
- # Gets a coverage along with it's full history. The return list is ordered by
423
+ # Gets a coverage along with it's full history. The return list is ordered by
429
424
  # version ascending.
430
425
  #
431
426
  # @param id [String]
@@ -460,7 +455,7 @@ module CandidApiClient
460
455
  # @return [Array<CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage>]
461
456
  # @example
462
457
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
463
- # api.pre_encounter.coverages.v_1.get_multi(patient_id: "string")
458
+ # api.pre_encounter.coverages.v_1.get_multi
464
459
  def get_multi(patient_id: nil, request_options: nil)
465
460
  response = @request_client.conn.get do |req|
466
461
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -481,7 +476,7 @@ module CandidApiClient
481
476
  end
482
477
  end
483
478
 
484
- # Scans up to 100 coverage updates. The since query parameter is inclusive, and
479
+ # Scans up to 100 coverage updates. The since query parameter is inclusive, and
485
480
  # the result list is ordered by updatedAt ascending.
486
481
  #
487
482
  # @param since [DateTime]
@@ -523,7 +518,7 @@ module CandidApiClient
523
518
  # @return [Void]
524
519
  # @example
525
520
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
526
- # api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "string", payer_name: "string", plan_type: SELF_PAY })
521
+ # api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "payer_id", payer_name: "payer_name", plan_type: SELF_PAY })
527
522
  def batch_update_ppg(ppg_id:, request:, request_options: nil)
528
523
  @request_client.conn.post do |req|
529
524
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -554,7 +549,7 @@ module CandidApiClient
554
549
  # id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
555
550
  # service_code: MEDICAL_CARE,
556
551
  # date_of_service: DateTime.parse(2023-01-15),
557
- # npi: "string"
552
+ # npi: "npi"
558
553
  # )
559
554
  def check_eligibility(id:, service_code:, date_of_service:, npi:, request_options: nil)
560
555
  response = @request_client.conn.post do |req|
@@ -585,7 +580,7 @@ module CandidApiClient
585
580
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageEligibilityCheckResponse]
586
581
  # @example
587
582
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
588
- # api.pre_encounter.coverages.v_1.get_eligibility(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", check_id: "string")
583
+ # api.pre_encounter.coverages.v_1.get_eligibility(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", check_id: "check_id")
589
584
  def get_eligibility(id:, check_id:, request_options: nil)
590
585
  response = @request_client.conn.get do |req|
591
586
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -762,7 +757,7 @@ module CandidApiClient
762
757
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage]
763
758
  # @example
764
759
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
765
- # api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: { }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: { }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: { } })
760
+ # api.pre_encounter.coverages.v_1.create(request: { status: ACTIVE, subscriber: { name: { family: "family", given: ["given", "given"], use: USUAL }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE }, relationship: SELF, patient: "patient", insurance_plan: { member_id: "member_id", payer_id: "payer_id", payer_name: "payer_name" }, verified: true })
766
761
  def create(request:, request_options: nil)
767
762
  Async do
768
763
  response = @request_client.conn.post do |req|
@@ -781,8 +776,8 @@ module CandidApiClient
781
776
  end
782
777
  end
783
778
 
784
- # Updates a Coverage. The path must contain the most recent version to prevent
785
- # race conditions. Updating historic versions is not supported.
779
+ # Updates a Coverage. The path must contain the most recent version to prevent
780
+ # race conditions. Updating historic versions is not supported.
786
781
  #
787
782
  # @param id [String]
788
783
  # @param version [String]
@@ -932,8 +927,8 @@ module CandidApiClient
932
927
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
933
928
  # api.pre_encounter.coverages.v_1.update(
934
929
  # id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
935
- # version: "string",
936
- # request: { status: ACTIVE, subscriber: { name: { family: "string", given: ["string"], use: USUAL, period: { }, suffix: "string" }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE, address: { use: HOME, line: ["string"], city: "string", state: "string", postal_code: "string", country: "string", period: { } } }, relationship: SELF, patient: "string", insurance_plan: { member_id: "string", payer_id: "string", payer_name: "string", additional_payer_information: { }, group_number: "string", name: "string", plan_type: SELF_PAY, type: C_01, period: { }, insurance_card_image_locator: "string", payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, verified: true, eligibility_checks: , latest_eligibility_check: { check_id: "string", status: ACTIVE, initiated_at: DateTime.parse(2024-01-15T09:30:00.000Z) }, benefits: { } }
930
+ # version: "version",
931
+ # request: { status: ACTIVE, subscriber: { name: { family: "family", given: ["given", "given"], use: USUAL }, date_of_birth: DateTime.parse(2023-01-15), biological_sex: FEMALE }, relationship: SELF, patient: "patient", insurance_plan: { member_id: "member_id", payer_id: "payer_id", payer_name: "payer_name" }, verified: true }
937
932
  # )
938
933
  def update(id:, version:, request:, request_options: nil)
939
934
  Async do
@@ -963,12 +958,7 @@ module CandidApiClient
963
958
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoveragesPage]
964
959
  # @example
965
960
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
966
- # api.pre_encounter.coverages.v_1.get_multi_paginated(
967
- # patient_id: "string",
968
- # payer_plan_group_id: "string",
969
- # page_token: "string",
970
- # limit: 1
971
- # )
961
+ # api.pre_encounter.coverages.v_1.get_multi_paginated
972
962
  def get_multi_paginated(patient_id: nil, payer_plan_group_id: nil, page_token: nil, limit: nil,
973
963
  request_options: nil)
974
964
  Async do
@@ -1019,7 +1009,7 @@ module CandidApiClient
1019
1009
  end
1020
1010
  end
1021
1011
 
1022
- # Gets a coverage along with it's full history. The return list is ordered by
1012
+ # Gets a coverage along with it's full history. The return list is ordered by
1023
1013
  # version ascending.
1024
1014
  #
1025
1015
  # @param id [String]
@@ -1056,7 +1046,7 @@ module CandidApiClient
1056
1046
  # @return [Array<CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage>]
1057
1047
  # @example
1058
1048
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1059
- # api.pre_encounter.coverages.v_1.get_multi(patient_id: "string")
1049
+ # api.pre_encounter.coverages.v_1.get_multi
1060
1050
  def get_multi(patient_id: nil, request_options: nil)
1061
1051
  Async do
1062
1052
  response = @request_client.conn.get do |req|
@@ -1082,7 +1072,7 @@ module CandidApiClient
1082
1072
  end
1083
1073
  end
1084
1074
 
1085
- # Scans up to 100 coverage updates. The since query parameter is inclusive, and
1075
+ # Scans up to 100 coverage updates. The since query parameter is inclusive, and
1086
1076
  # the result list is ordered by updatedAt ascending.
1087
1077
  #
1088
1078
  # @param since [DateTime]
@@ -1126,7 +1116,7 @@ module CandidApiClient
1126
1116
  # @return [Void]
1127
1117
  # @example
1128
1118
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1129
- # api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "string", payer_name: "string", plan_type: SELF_PAY })
1119
+ # api.pre_encounter.coverages.v_1.batch_update_ppg(ppg_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payer_id: "payer_id", payer_name: "payer_name", plan_type: SELF_PAY })
1130
1120
  def batch_update_ppg(ppg_id:, request:, request_options: nil)
1131
1121
  Async do
1132
1122
  @request_client.conn.post do |req|
@@ -1159,7 +1149,7 @@ module CandidApiClient
1159
1149
  # id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1160
1150
  # service_code: MEDICAL_CARE,
1161
1151
  # date_of_service: DateTime.parse(2023-01-15),
1162
- # npi: "string"
1152
+ # npi: "npi"
1163
1153
  # )
1164
1154
  def check_eligibility(id:, service_code:, date_of_service:, npi:, request_options: nil)
1165
1155
  Async do
@@ -1192,7 +1182,7 @@ module CandidApiClient
1192
1182
  # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::CoverageEligibilityCheckResponse]
1193
1183
  # @example
1194
1184
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1195
- # api.pre_encounter.coverages.v_1.get_eligibility(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", check_id: "string")
1185
+ # api.pre_encounter.coverages.v_1.get_eligibility(id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", check_id: "check_id")
1196
1186
  def get_eligibility(id:, check_id:, request_options: nil)
1197
1187
  Async do
1198
1188
  response = @request_client.conn.get do |req|
data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb CHANGED
@@ -22,10 +22,10 @@ module CandidApiClient
22
22
  attr_reader :id
23
23
  # @return [String] The organization that owns this object.
24
24
  attr_reader :organization_id
25
- # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
25
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
26
26
  # search results but are returned in all other endpoints including scan.
27
27
  attr_reader :deactivated
28
- # @return [Integer] The version of the object. Any update to any property of an object object will
28
+ # @return [Integer] The version of the object. Any update to any property of an object object will
29
29
  # create a new version.
30
30
  attr_reader :version
31
31
  # @return [DateTime]
@@ -63,9 +63,9 @@ module CandidApiClient
63
63
 
64
64
  # @param id [String]
65
65
  # @param organization_id [String] The organization that owns this object.
66
- # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
66
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
67
67
  # search results but are returned in all other endpoints including scan.
68
- # @param version [Integer] The version of the object. Any update to any property of an object object will
68
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
69
69
  # create a new version.
70
70
  # @param updated_at [DateTime]
71
71
  # @param updating_user_id [String] The user ID of the user who last updated the object.
data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb CHANGED
@@ -45,7 +45,7 @@ module CandidApiClient
45
45
  # @return [CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::ELIGIBILITY_RESPONSE]
46
46
  # @example
47
47
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
48
- # api.pre_encounter.eligibility_checks.v_1.post(request: { payer_id: "string", provider: { first_name: "string", last_name: "string", npi: "string" }, subscriber: { member_id: "string", first_name: "string", last_name: "string", date_of_birth: DateTime.parse(2023-01-15) }, dependent: { member_id: "string", first_name: "string", last_name: "string", date_of_birth: DateTime.parse(2023-01-15) }, encounter: { date_of_service: DateTime.parse(2023-01-15), service_type_codes: ["string"] } })
48
+ # api.pre_encounter.eligibility_checks.v_1.post(request: { payer_id: "payer_id", provider: { npi: "npi" }, subscriber: { first_name: "first_name", last_name: "last_name" } })
49
49
  def post(request:, request_options: nil)
50
50
  response = @request_client.conn.post do |req|
51
51
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -99,7 +99,7 @@ module CandidApiClient
99
99
  # @return [CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::ELIGIBILITY_RESPONSE]
100
100
  # @example
101
101
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
102
- # api.pre_encounter.eligibility_checks.v_1.post(request: { payer_id: "string", provider: { first_name: "string", last_name: "string", npi: "string" }, subscriber: { member_id: "string", first_name: "string", last_name: "string", date_of_birth: DateTime.parse(2023-01-15) }, dependent: { member_id: "string", first_name: "string", last_name: "string", date_of_birth: DateTime.parse(2023-01-15) }, encounter: { date_of_service: DateTime.parse(2023-01-15), service_type_codes: ["string"] } })
102
+ # api.pre_encounter.eligibility_checks.v_1.post(request: { payer_id: "payer_id", provider: { npi: "npi" }, subscriber: { first_name: "first_name", last_name: "last_name" } })
103
103
  def post(request:, request_options: nil)
104
104
  Async do
105
105
  response = @request_client.conn.post do |req|