candidhealth 0.45.0 → 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 (65) 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 +10 -94
  4. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +16 -16
  5. data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +2 -44
  6. data/lib/candidhealth/contracts/v_2/client.rb +18 -34
  7. data/lib/candidhealth/contracts/v_2/types/contract_sort_field.rb +18 -0
  8. data/lib/candidhealth/credentialing/v_2/client.rb +6 -44
  9. data/lib/candidhealth/diagnoses/client.rb +4 -14
  10. data/lib/candidhealth/eligibility/v_2/client.rb +4 -4
  11. data/lib/candidhealth/encounter_attachments/v_1/client.rb +0 -6
  12. data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
  13. data/lib/candidhealth/encounters/v_4/client.rb +38 -102
  14. data/lib/candidhealth/encounters/v_4/types/encounter.rb +12 -12
  15. data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +10 -10
  16. data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +10 -10
  17. data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +14 -14
  18. data/lib/candidhealth/expected_network_status/v_1/client.rb +12 -18
  19. data/lib/candidhealth/expected_network_status/v_2/client.rb +4 -4
  20. data/lib/candidhealth/expected_network_status/v_2/types/empty_object.rb +53 -0
  21. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +13 -10
  22. data/lib/candidhealth/external_payment_account_config/v_1/client.rb +2 -2
  23. data/lib/candidhealth/fee_schedules/v_3/client.rb +12 -68
  24. data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +3 -3
  25. data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +2 -2
  26. data/lib/candidhealth/guarantor/v_1/client.rb +4 -4
  27. data/lib/candidhealth/import_invoice/v_1/client.rb +6 -28
  28. data/lib/candidhealth/insurance_adjudications/v_1/client.rb +2 -2
  29. data/lib/candidhealth/insurance_payments/v_1/client.rb +2 -20
  30. data/lib/candidhealth/insurance_refunds/v_1/client.rb +6 -24
  31. data/lib/candidhealth/medication_dispense/v_1/client.rb +2 -2
  32. data/lib/candidhealth/non_insurance_payer_payments/v_1/client.rb +6 -22
  33. data/lib/candidhealth/non_insurance_payer_refunds/v_1/client.rb +6 -22
  34. data/lib/candidhealth/non_insurance_payers/v_1/client.rb +6 -22
  35. data/lib/candidhealth/organization_providers/v_3/client.rb +4 -4
  36. data/lib/candidhealth/organization_service_facilities/v_2/client.rb +2 -2
  37. data/lib/candidhealth/patient_payments/v_4/client.rb +8 -38
  38. data/lib/candidhealth/patient_refunds/v_1/client.rb +8 -40
  39. data/lib/candidhealth/payer_plan_groups/v_1/client.rb +6 -30
  40. data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +32 -44
  41. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +4 -4
  42. data/lib/candidhealth/pre_encounter/common/types/base_model.rb +4 -4
  43. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +24 -34
  44. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +4 -4
  45. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +2 -2
  46. data/lib/candidhealth/pre_encounter/images/v_1/client.rb +20 -20
  47. data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +6 -6
  48. data/lib/candidhealth/pre_encounter/lists/v_1/client.rb +4 -28
  49. data/lib/candidhealth/pre_encounter/notes/v_1/client.rb +14 -14
  50. data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +4 -4
  51. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +56 -68
  52. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +8 -8
  53. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +8 -8
  54. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +16 -16
  55. data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +16 -16
  56. data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +4 -4
  57. data/lib/candidhealth/service_facility/client.rb +2 -2
  58. data/lib/candidhealth/service_lines/v_2/client.rb +4 -4
  59. data/lib/candidhealth/superbills/v_1/client.rb +4 -6
  60. data/lib/candidhealth/tasks/v_3/client.rb +6 -34
  61. data/lib/candidhealth/write_offs/v_1/client.rb +2 -24
  62. data/lib/environment.rb +4 -0
  63. data/lib/requests.rb +2 -2
  64. data/lib/types_export.rb +2 -0
  65. metadata +4 -2
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|
data/lib/candidhealth/pre_encounter/images/v_1/client.rb CHANGED
@@ -20,7 +20,7 @@ module CandidApiClient
20
20
  @request_client = request_client
21
21
  end
22
22
 
23
- # Adds an image. VersionConflictError is returned if a front or back of this
23
+ # Adds an image. VersionConflictError is returned if a front or back of this
24
24
  # coverage already exists.
25
25
  #
26
26
  # @param request [Hash] Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash
@@ -38,7 +38,7 @@ module CandidApiClient
38
38
  # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
39
39
  # @example
40
40
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
41
- # api.pre_encounter.images.v_1.create(request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } })
41
+ # api.pre_encounter.images.v_1.create(request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING })
42
42
  def create(request:, request_options: nil)
43
43
  response = @request_client.conn.post do |req|
44
44
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -62,7 +62,7 @@ module CandidApiClient
62
62
  # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
63
63
  # @example
64
64
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
65
- # api.pre_encounter.images.v_1.get(id: "string")
65
+ # api.pre_encounter.images.v_1.get(id: "id")
66
66
  def get(id:, request_options: nil)
67
67
  response = @request_client.conn.get do |req|
68
68
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -78,7 +78,7 @@ module CandidApiClient
78
78
  CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
79
79
  end
80
80
 
81
- # Updates an Image. The path must contain the most recent version to prevent
81
+ # Updates an Image. The path must contain the most recent version to prevent
82
82
  # races.
83
83
  #
84
84
  # @param id [String]
@@ -99,9 +99,9 @@ module CandidApiClient
99
99
  # @example
100
100
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
101
101
  # api.pre_encounter.images.v_1.update(
102
- # id: "string",
103
- # version: "string",
104
- # request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } }
102
+ # id: "id",
103
+ # version: "version",
104
+ # request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING }
105
105
  # )
106
106
  def update(id:, version:, request:, request_options: nil)
107
107
  response = @request_client.conn.put do |req|
@@ -119,7 +119,7 @@ module CandidApiClient
119
119
  CandidApiClient::PreEncounter::Images::V1::Types::Image.from_json(json_object: response.body)
120
120
  end
121
121
 
122
- # Sets an Image as deactivated. The path must contain the most recent version to
122
+ # Sets an Image as deactivated. The path must contain the most recent version to
123
123
  # prevent races.
124
124
  #
125
125
  # @param id [String]
@@ -128,7 +128,7 @@ module CandidApiClient
128
128
  # @return [Void]
129
129
  # @example
130
130
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
131
- # api.pre_encounter.images.v_1.deactivate(id: "string", version: "string")
131
+ # api.pre_encounter.images.v_1.deactivate(id: "id", version: "version")
132
132
  def deactivate(id:, version:, request_options: nil)
133
133
  @request_client.conn.delete do |req|
134
134
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -151,7 +151,7 @@ module CandidApiClient
151
151
  # @return [Array<CandidApiClient::PreEncounter::Images::V1::Types::Image>]
152
152
  # @example
153
153
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
154
- # api.pre_encounter.images.v_1.get_multi(patient_id: "string", coverage_id: "string")
154
+ # api.pre_encounter.images.v_1.get_multi
155
155
  def get_multi(patient_id: nil, coverage_id: nil, request_options: nil)
156
156
  response = @request_client.conn.get do |req|
157
157
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -187,7 +187,7 @@ module CandidApiClient
187
187
  @request_client = request_client
188
188
  end
189
189
 
190
- # Adds an image. VersionConflictError is returned if a front or back of this
190
+ # Adds an image. VersionConflictError is returned if a front or back of this
191
191
  # coverage already exists.
192
192
  #
193
193
  # @param request [Hash] Request of type CandidApiClient::PreEncounter::Images::V1::Types::MutableImage, as a Hash
@@ -205,7 +205,7 @@ module CandidApiClient
205
205
  # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
206
206
  # @example
207
207
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
208
- # api.pre_encounter.images.v_1.create(request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } })
208
+ # api.pre_encounter.images.v_1.create(request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING })
209
209
  def create(request:, request_options: nil)
210
210
  Async do
211
211
  response = @request_client.conn.post do |req|
@@ -231,7 +231,7 @@ module CandidApiClient
231
231
  # @return [CandidApiClient::PreEncounter::Images::V1::Types::Image]
232
232
  # @example
233
233
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
234
- # api.pre_encounter.images.v_1.get(id: "string")
234
+ # api.pre_encounter.images.v_1.get(id: "id")
235
235
  def get(id:, request_options: nil)
236
236
  Async do
237
237
  response = @request_client.conn.get do |req|
@@ -249,7 +249,7 @@ module CandidApiClient
249
249
  end
250
250
  end
251
251
 
252
- # Updates an Image. The path must contain the most recent version to prevent
252
+ # Updates an Image. The path must contain the most recent version to prevent
253
253
  # races.
254
254
  #
255
255
  # @param id [String]
@@ -270,9 +270,9 @@ module CandidApiClient
270
270
  # @example
271
271
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
272
272
  # api.pre_encounter.images.v_1.update(
273
- # id: "string",
274
- # version: "string",
275
- # request: { file_name: "string", display_name: "string", file_type: "string", status: PENDING, coverage: { id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", side: FRONT }, patient: { id: "string", notes: "string" } }
273
+ # id: "id",
274
+ # version: "version",
275
+ # request: { file_name: "file_name", display_name: "display_name", file_type: "file_type", status: PENDING }
276
276
  # )
277
277
  def update(id:, version:, request:, request_options: nil)
278
278
  Async do
@@ -292,7 +292,7 @@ module CandidApiClient
292
292
  end
293
293
  end
294
294
 
295
- # Sets an Image as deactivated. The path must contain the most recent version to
295
+ # Sets an Image as deactivated. The path must contain the most recent version to
296
296
  # prevent races.
297
297
  #
298
298
  # @param id [String]
@@ -301,7 +301,7 @@ module CandidApiClient
301
301
  # @return [Void]
302
302
  # @example
303
303
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
304
- # api.pre_encounter.images.v_1.deactivate(id: "string", version: "string")
304
+ # api.pre_encounter.images.v_1.deactivate(id: "id", version: "version")
305
305
  def deactivate(id:, version:, request_options: nil)
306
306
  Async do
307
307
  @request_client.conn.delete do |req|
@@ -326,7 +326,7 @@ module CandidApiClient
326
326
  # @return [Array<CandidApiClient::PreEncounter::Images::V1::Types::Image>]
327
327
  # @example
328
328
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
329
- # api.pre_encounter.images.v_1.get_multi(patient_id: "string", coverage_id: "string")
329
+ # api.pre_encounter.images.v_1.get_multi
330
330
  def get_multi(patient_id: nil, coverage_id: nil, request_options: nil)
331
331
  Async do
332
332
  response = @request_client.conn.get do |req|
data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb CHANGED
@@ -16,15 +16,15 @@ module CandidApiClient
16
16
  class Image
17
17
  # @return [String]
18
18
  attr_reader :id
19
- # @return [String] A signed URL to the image. This url can be used to upload an image to GCP
19
+ # @return [String] A signed URL to the image. This url can be used to upload an image to GCP
20
20
  # storage or to read the image contents.
21
21
  attr_reader :signed_url
22
22
  # @return [String] The organization that owns this object.
23
23
  attr_reader :organization_id
24
- # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
24
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
25
25
  # search results but are returned in all other endpoints including scan.
26
26
  attr_reader :deactivated
27
- # @return [Integer] The version of the object. Any update to any property of an object object will
27
+ # @return [Integer] The version of the object. Any update to any property of an object object will
28
28
  # create a new version.
29
29
  attr_reader :version
30
30
  # @return [DateTime]
@@ -52,12 +52,12 @@ module CandidApiClient
52
52
  OMIT = Object.new
53
53
 
54
54
  # @param id [String]
55
- # @param signed_url [String] A signed URL to the image. This url can be used to upload an image to GCP
55
+ # @param signed_url [String] A signed URL to the image. This url can be used to upload an image to GCP
56
56
  # storage or to read the image contents.
57
57
  # @param organization_id [String] The organization that owns this object.
58
- # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
58
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
59
59
  # search results but are returned in all other endpoints including scan.
60
- # @param version [Integer] The version of the object. Any update to any property of an object object will
60
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
61
61
  # create a new version.
62
62
  # @param updated_at [DateTime]
63
63
  # @param updating_user_id [String] The user ID of the user who last updated the object.
data/lib/candidhealth/pre_encounter/lists/v_1/client.rb CHANGED
@@ -32,13 +32,7 @@ module CandidApiClient
32
32
  # @return [CandidApiClient::PreEncounter::Lists::V1::Types::PatientListPage]
33
33
  # @example
34
34
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
35
- # api.pre_encounter.lists.v_1.get_patient_list(
36
- # page_token: "string",
37
- # limit: 1,
38
- # sort_field: "string",
39
- # sort_direction: ASC,
40
- # filters: "string"
41
- # )
35
+ # api.pre_encounter.lists.v_1.get_patient_list
42
36
  def get_patient_list(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
43
37
  request_options: nil)
44
38
  response = @request_client.conn.get do |req|
@@ -74,13 +68,7 @@ module CandidApiClient
74
68
  # @return [CandidApiClient::PreEncounter::Lists::V1::Types::AppointmentListPage]
75
69
  # @example
76
70
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
77
- # api.pre_encounter.lists.v_1.get_appointment_list(
78
- # sort_field: "string",
79
- # sort_direction: ASC,
80
- # limit: 1,
81
- # page_token: "string",
82
- # filters: "string"
83
- # )
71
+ # api.pre_encounter.lists.v_1.get_appointment_list
84
72
  def get_appointment_list(sort_field: nil, sort_direction: nil, limit: nil, page_token: nil, filters: nil,
85
73
  request_options: nil)
86
74
  response = @request_client.conn.get do |req|
@@ -128,13 +116,7 @@ module CandidApiClient
128
116
  # @return [CandidApiClient::PreEncounter::Lists::V1::Types::PatientListPage]
129
117
  # @example
130
118
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
131
- # api.pre_encounter.lists.v_1.get_patient_list(
132
- # page_token: "string",
133
- # limit: 1,
134
- # sort_field: "string",
135
- # sort_direction: ASC,
136
- # filters: "string"
137
- # )
119
+ # api.pre_encounter.lists.v_1.get_patient_list
138
120
  def get_patient_list(page_token: nil, limit: nil, sort_field: nil, sort_direction: nil, filters: nil,
139
121
  request_options: nil)
140
122
  Async do
@@ -172,13 +154,7 @@ module CandidApiClient
172
154
  # @return [CandidApiClient::PreEncounter::Lists::V1::Types::AppointmentListPage]
173
155
  # @example
174
156
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
175
- # api.pre_encounter.lists.v_1.get_appointment_list(
176
- # sort_field: "string",
177
- # sort_direction: ASC,
178
- # limit: 1,
179
- # page_token: "string",
180
- # filters: "string"
181
- # )
157
+ # api.pre_encounter.lists.v_1.get_appointment_list
182
158
  def get_appointment_list(sort_field: nil, sort_direction: nil, limit: nil, page_token: nil, filters: nil,
183
159
  request_options: nil)
184
160
  Async do
data/lib/candidhealth/pre_encounter/notes/v_1/client.rb CHANGED
@@ -26,7 +26,7 @@ module CandidApiClient
26
26
  # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
27
27
  # @example
28
28
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
29
- # api.pre_encounter.notes.v_1.get(id: "string")
29
+ # api.pre_encounter.notes.v_1.get(id: "id")
30
30
  def get(id:, request_options: nil)
31
31
  response = @request_client.conn.get do |req|
32
32
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -52,7 +52,7 @@ module CandidApiClient
52
52
  # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
53
53
  # @example
54
54
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
55
- # api.pre_encounter.notes.v_1.create(request: { value: "string", author_email: "string", author_name: "string" })
55
+ # api.pre_encounter.notes.v_1.create(request: { value: "value" })
56
56
  def create(request:, request_options: nil)
57
57
  response = @request_client.conn.post do |req|
58
58
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -81,9 +81,9 @@ module CandidApiClient
81
81
  # @example
82
82
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
83
83
  # api.pre_encounter.notes.v_1.update(
84
- # id: "string",
85
- # version: "string",
86
- # request: { value: "string", author_email: "string", author_name: "string" }
84
+ # id: "id",
85
+ # version: "version",
86
+ # request: { value: "value" }
87
87
  # )
88
88
  def update(id:, version:, request:, request_options: nil)
89
89
  response = @request_client.conn.put do |req|
@@ -101,7 +101,7 @@ module CandidApiClient
101
101
  CandidApiClient::PreEncounter::Notes::V1::Types::Note.from_json(json_object: response.body)
102
102
  end
103
103
 
104
- # Sets a note as deactivated. The path must contain the most recent version to
104
+ # Sets a note as deactivated. The path must contain the most recent version to
105
105
  # prevent races.
106
106
  #
107
107
  # @param id [String]
@@ -110,7 +110,7 @@ module CandidApiClient
110
110
  # @return [Void]
111
111
  # @example
112
112
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
113
- # api.pre_encounter.notes.v_1.deactivate(id: "string", version: "string")
113
+ # api.pre_encounter.notes.v_1.deactivate(id: "id", version: "version")
114
114
  def deactivate(id:, version:, request_options: nil)
115
115
  @request_client.conn.delete do |req|
116
116
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -143,7 +143,7 @@ module CandidApiClient
143
143
  # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
144
144
  # @example
145
145
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
146
- # api.pre_encounter.notes.v_1.get(id: "string")
146
+ # api.pre_encounter.notes.v_1.get(id: "id")
147
147
  def get(id:, request_options: nil)
148
148
  Async do
149
149
  response = @request_client.conn.get do |req|
@@ -171,7 +171,7 @@ module CandidApiClient
171
171
  # @return [CandidApiClient::PreEncounter::Notes::V1::Types::Note]
172
172
  # @example
173
173
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
174
- # api.pre_encounter.notes.v_1.create(request: { value: "string", author_email: "string", author_name: "string" })
174
+ # api.pre_encounter.notes.v_1.create(request: { value: "value" })
175
175
  def create(request:, request_options: nil)
176
176
  Async do
177
177
  response = @request_client.conn.post do |req|
@@ -203,9 +203,9 @@ module CandidApiClient
203
203
  # @example
204
204
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
205
205
  # api.pre_encounter.notes.v_1.update(
206
- # id: "string",
207
- # version: "string",
208
- # request: { value: "string", author_email: "string", author_name: "string" }
206
+ # id: "id",
207
+ # version: "version",
208
+ # request: { value: "value" }
209
209
  # )
210
210
  def update(id:, version:, request:, request_options: nil)
211
211
  Async do
@@ -225,7 +225,7 @@ module CandidApiClient
225
225
  end
226
226
  end
227
227
 
228
- # Sets a note as deactivated. The path must contain the most recent version to
228
+ # Sets a note as deactivated. The path must contain the most recent version to
229
229
  # prevent races.
230
230
  #
231
231
  # @param id [String]
@@ -234,7 +234,7 @@ module CandidApiClient
234
234
  # @return [Void]
235
235
  # @example
236
236
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
237
- # api.pre_encounter.notes.v_1.deactivate(id: "string", version: "string")
237
+ # api.pre_encounter.notes.v_1.deactivate(id: "id", version: "version")
238
238
  def deactivate(id:, version:, request_options: nil)
239
239
  Async do
240
240
  @request_client.conn.delete do |req|
data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb CHANGED
@@ -17,10 +17,10 @@ module CandidApiClient
17
17
  attr_reader :created_at
18
18
  # @return [String] The organization that owns this object.
19
19
  attr_reader :organization_id
20
- # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
20
+ # @return [Boolean] True if the object is deactivated. Deactivated objects are not returned in
21
21
  # search results but are returned in all other endpoints including scan.
22
22
  attr_reader :deactivated
23
- # @return [Integer] The version of the object. Any update to any property of an object object will
23
+ # @return [Integer] The version of the object. Any update to any property of an object object will
24
24
  # create a new version.
25
25
  attr_reader :version
26
26
  # @return [DateTime]
@@ -44,9 +44,9 @@ module CandidApiClient
44
44
  # @param id [String]
45
45
  # @param created_at [DateTime]
46
46
  # @param organization_id [String] The organization that owns this object.
47
- # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
47
+ # @param deactivated [Boolean] True if the object is deactivated. Deactivated objects are not returned in
48
48
  # search results but are returned in all other endpoints including scan.
49
- # @param version [Integer] The version of the object. Any update to any property of an object object will
49
+ # @param version [Integer] The version of the object. Any update to any property of an object object will
50
50
  # create a new version.
51
51
  # @param updated_at [DateTime]
52
52
  # @param updating_user_id [String] The user ID of the user who last updated the object.