candidhealth 0.42.4 → 0.43.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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/billing_notes/v_2/types/billing_note_optional.rb +112 -0
  3. data/lib/candidhealth/charge_capture/v_1/client.rb +22 -28
  4. data/lib/candidhealth/charge_capture/v_1/types/charge_capture.rb +8 -8
  5. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +4 -4
  6. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_error.rb +21 -19
  7. data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +85 -129
  8. data/lib/candidhealth/charge_capture_bundles/v_1/types/{charge_capture_bundle.rb → charge_capture_claim_creation.rb} +18 -30
  9. data/lib/candidhealth/charge_capture_bundles/v_1/types/{charge_capture_bundle_page.rb → charge_capture_claim_creation_page.rb} +9 -9
  10. data/lib/candidhealth/charge_capture_bundles/v_1/types/{charge_capture_bundle_sort_field.rb → charge_capture_claim_creation_sort_field.rb} +1 -1
  11. data/lib/candidhealth/charge_capture_bundles/v_1/types/{charge_capture_bundle_status.rb → charge_capture_claim_creation_status.rb} +1 -1
  12. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation_summary.rb +100 -0
  13. data/lib/candidhealth/encounter_attachments/client.rb +30 -0
  14. data/lib/candidhealth/encounter_attachments/v_1/client.rb +199 -0
  15. data/lib/candidhealth/encounter_attachments/v_1/types/base_attachment.rb +98 -0
  16. data/lib/candidhealth/encounter_attachments/v_1/types/encounter_attachment.rb +115 -0
  17. data/lib/candidhealth/encounter_attachments/v_1/types/encounter_attachment_type.rb +13 -0
  18. data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
  19. data/lib/candidhealth/encounters/v_4/client.rb +20 -20
  20. data/lib/candidhealth/guarantor/v_1/client.rb +2 -2
  21. data/lib/candidhealth/service_lines/v_2/client.rb +2 -2
  22. data/lib/candidhealth.rb +7 -0
  23. data/lib/core/file_utilities.rb +26 -0
  24. data/lib/requests.rb +5 -2
  25. data/lib/types_export.rb +9 -6
  26. metadata +48 -8
  27. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_bundle_summary.rb +0 -94
  28. data/lib/candidhealth/commons/types/not_implemented_error_message.rb +0 -60
@@ -1,14 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../requests"
4
- require_relative "types/charge_capture_bundle"
5
- require_relative "types/charge_capture_bundle_summary"
6
- require_relative "types/charge_capture_bundle_sort_field"
4
+ require_relative "types/charge_capture_claim_creation"
5
+ require_relative "types/charge_capture_claim_creation_summary"
6
+ require_relative "types/charge_capture_claim_creation_sort_field"
7
7
  require_relative "../../commons/types/sort_direction"
8
- require_relative "types/charge_capture_bundle_status"
8
+ require_relative "types/charge_capture_claim_creation_status"
9
9
  require_relative "../../charge_capture/v_1/types/charge_capture_status"
10
10
  require "date"
11
- require_relative "types/charge_capture_bundle_page"
11
+ require_relative "types/charge_capture_claim_creation_page"
12
12
  require "async"
13
13
 
14
14
  module CandidApiClient
@@ -24,13 +24,13 @@ module CandidApiClient
24
24
  @request_client = request_client
25
25
  end
26
26
 
27
- # @param charge_capture_bundle_id [String]
27
+ # @param charge_capture_claim_creation_id [String]
28
28
  # @param request_options [CandidApiClient::RequestOptions]
29
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
29
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation]
30
30
  # @example
31
31
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
32
- # api.charge_capture_bundles.v_1.get(charge_capture_bundle_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
33
- def get(charge_capture_bundle_id:, request_options: nil)
32
+ # api.charge_capture_bundles.v_1.get(charge_capture_claim_creation_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
33
+ def get(charge_capture_claim_creation_id:, request_options: nil)
34
34
  response = @request_client.conn.get do |req|
35
35
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
36
36
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -40,13 +40,13 @@ module CandidApiClient
40
40
  **(request_options&.additional_headers || {})
41
41
  }.compact
42
42
  req.url "#{@request_client.get_url(environment: CandidApi,
43
- request_options: request_options)}/api/charge_capture_bundle/v1/#{charge_capture_bundle_id}"
43
+ request_options: request_options)}/api/charge_capture_claim_creation/v1/#{charge_capture_claim_creation_id}"
44
44
  end
45
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle.from_json(json_object: response.body)
45
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation.from_json(json_object: response.body)
46
46
  end
47
47
 
48
48
  # @param request_options [CandidApiClient::RequestOptions]
49
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSummary]
49
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary]
50
50
  # @example
51
51
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
52
52
  # api.charge_capture_bundles.v_1.get_summary
@@ -60,39 +60,18 @@ module CandidApiClient
60
60
  **(request_options&.additional_headers || {})
61
61
  }.compact
62
62
  req.url "#{@request_client.get_url(environment: CandidApi,
63
- request_options: request_options)}/api/charge_capture_bundle/v1/all/summary"
63
+ request_options: request_options)}/api/charge_capture_claim_creation/v1/all/summary"
64
64
  end
65
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSummary.from_json(json_object: response.body)
66
- end
67
-
68
- # @param charge_capture_bundle_id [String]
69
- # @param request_options [CandidApiClient::RequestOptions]
70
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
71
- # @example
72
- # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
73
- # api.charge_capture_bundles.v_1.resubmit(charge_capture_bundle_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
74
- def resubmit(charge_capture_bundle_id:, request_options: nil)
75
- response = @request_client.conn.post do |req|
76
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
77
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
78
- req.headers = {
79
- **(req.headers || {}),
80
- **@request_client.get_headers,
81
- **(request_options&.additional_headers || {})
82
- }.compact
83
- req.url "#{@request_client.get_url(environment: CandidApi,
84
- request_options: request_options)}/api/charge_capture_bundle/v1/#{charge_capture_bundle_id}"
85
- end
86
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle.from_json(json_object: response.body)
65
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary.from_json(json_object: response.body)
87
66
  end
88
67
 
89
68
  # @param limit [Integer] Maximum number of entities per page, defaults to 100.
90
- # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSortField] Defaults to created_at
69
+ # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSortField] Defaults to created_at
91
70
  # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
92
71
  # @param page_token [String]
93
72
  # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
94
- # @param bundle_status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] the status of the charge capture bundle, refers to whether it was able to create
95
- # an encounter.
73
+ # @param claim_creation_status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus] the status of the charge capture Claim Creation, refers to whether it was able
74
+ # to create a claim.
96
75
  # @param charge_status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge captures
97
76
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
98
77
  # for example, your internal encounter ID or a Dr. Chrono encounter ID.
@@ -101,34 +80,34 @@ module CandidApiClient
101
80
  # This date must be the local date in the timezone where the service occurred.
102
81
  # @param date_of_service_max [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
103
82
  # This date must be the local date in the timezone where the service occurred.
104
- # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge capture bundles
105
- # that have a resulting claim with one of the IDs in this list.
106
- # @param bundle_ids [String] A list of bundle IDs to filter by.
83
+ # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge capture
84
+ # claim_creations that have a resulting claim with one of the IDs in this list.
85
+ # @param claim_creation_ids [String] A list of Claim Creation IDs to filter by.
107
86
  # @param billing_provider_npis [String] A list of billing provider NPIs to filter by. This will return all charge
108
- # capture bundles which include one or more charges with one of the NPIs in this
109
- # list.
110
- # @param service_facility_name [String] A string to filter by. This will return all charge capture bundles which include
111
- # one or more charges with this service facility name.
87
+ # capture claim_creations which include one or more charges with one of the NPIs
88
+ # in this list.
89
+ # @param service_facility_name [String] A string to filter by. This will return all charge capture claim_creations which
90
+ # include one or more charges with this service facility name.
112
91
  # @param primary_payer_ids [String] A list of primary payer IDs to filter by. This will return all charge capture
113
- # bundles which include one or more charges with one of the primary payer IDs in
114
- # this list.
92
+ # claim_creations which include one or more charges with one of the primary payer
93
+ # IDs in this list.
115
94
  # @param rendering_provider_npis [String] A list of rendering provider NPIs to filter by. This will return all charge
116
- # capture bundles which include one or more charges with one of the NPIs in this
117
- # list.
95
+ # capture claim_creations which include one or more charges with one of the NPIs
96
+ # in this list.
118
97
  # @param rendering_provider_names [String] A list of rendering provider names to filter by. This will return all charge
119
- # capture bundles which include one or more charges with one of the names in this
120
- # list.
98
+ # capture claim_creations which include one or more charges with one of the names
99
+ # in this list.
121
100
  # @param supervising_provider_npis [String] A list of supervising provider NPIs to filter by. This will return all charge
122
- # capture bundles which include one or more charges with one of the NPIs in this
123
- # list.
101
+ # capture claim_creations which include one or more charges with one of the NPIs
102
+ # in this list.
124
103
  # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
125
- # capture bundles which include one or more charges with one of the names in this
126
- # list.
127
- # @param has_charge_capture_updates [Boolean] If true, only return bundles that have charge captures that have been updated
128
- # since the bundle has had a status of BILLED. See the updates property on
129
- # ChargeCapture for more details.
104
+ # capture claim_creations which include one or more charges with one of the names
105
+ # in this list.
106
+ # @param has_charge_capture_updates [Boolean] If true, only return claim_creations that have charge captures that have been
107
+ # updated since the Claim Creation has had a status of BILLED. See the updates
108
+ # property on ChargeCapture for more details.
130
109
  # @param request_options [CandidApiClient::RequestOptions]
131
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage]
110
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage]
132
111
  # @example
133
112
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
134
113
  # api.charge_capture_bundles.v_1.get_all(
@@ -137,13 +116,13 @@ module CandidApiClient
137
116
  # sort_direction: ASC,
138
117
  # page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
139
118
  # patient_external_id: "string",
140
- # bundle_status: NOT_STARTED,
119
+ # claim_creation_status: NOT_STARTED,
141
120
  # charge_status: PLANNED,
142
121
  # charge_external_id: "string",
143
122
  # date_of_service_min: DateTime.parse(2023-01-15),
144
123
  # date_of_service_max: DateTime.parse(2023-01-15),
145
124
  # claim_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
146
- # bundle_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
125
+ # claim_creation_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
147
126
  # billing_provider_npis: "string",
148
127
  # service_facility_name: "string",
149
128
  # primary_payer_ids: "string",
@@ -154,7 +133,7 @@ module CandidApiClient
154
133
  # has_charge_capture_updates: true
155
134
  # )
156
135
  def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil,
157
- bundle_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, bundle_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil)
136
+ claim_creation_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil)
158
137
  response = @request_client.conn.get do |req|
159
138
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
160
139
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -170,13 +149,13 @@ module CandidApiClient
170
149
  "sort_direction": sort_direction,
171
150
  "page_token": page_token,
172
151
  "patient_external_id": patient_external_id,
173
- "bundle_status": bundle_status,
152
+ "claim_creation_status": claim_creation_status,
174
153
  "charge_status": charge_status,
175
154
  "charge_external_id": charge_external_id,
176
155
  "date_of_service_min": date_of_service_min,
177
156
  "date_of_service_max": date_of_service_max,
178
157
  "claim_ids": claim_ids,
179
- "bundle_ids": bundle_ids,
158
+ "claim_creation_ids": claim_creation_ids,
180
159
  "billing_provider_npis": billing_provider_npis,
181
160
  "service_facility_name": service_facility_name,
182
161
  "primary_payer_ids": primary_payer_ids,
@@ -187,9 +166,9 @@ module CandidApiClient
187
166
  "has_charge_capture_updates": has_charge_capture_updates
188
167
  }.compact
189
168
  req.url "#{@request_client.get_url(environment: CandidApi,
190
- request_options: request_options)}/api/charge_capture_bundle/v1"
169
+ request_options: request_options)}/api/charge_capture_claim_creation/v1"
191
170
  end
192
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage.from_json(json_object: response.body)
171
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage.from_json(json_object: response.body)
193
172
  end
194
173
  end
195
174
 
@@ -203,13 +182,13 @@ module CandidApiClient
203
182
  @request_client = request_client
204
183
  end
205
184
 
206
- # @param charge_capture_bundle_id [String]
185
+ # @param charge_capture_claim_creation_id [String]
207
186
  # @param request_options [CandidApiClient::RequestOptions]
208
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
187
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation]
209
188
  # @example
210
189
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
211
- # api.charge_capture_bundles.v_1.get(charge_capture_bundle_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
212
- def get(charge_capture_bundle_id:, request_options: nil)
190
+ # api.charge_capture_bundles.v_1.get(charge_capture_claim_creation_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
191
+ def get(charge_capture_claim_creation_id:, request_options: nil)
213
192
  Async do
214
193
  response = @request_client.conn.get do |req|
215
194
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -220,14 +199,14 @@ module CandidApiClient
220
199
  **(request_options&.additional_headers || {})
221
200
  }.compact
222
201
  req.url "#{@request_client.get_url(environment: CandidApi,
223
- request_options: request_options)}/api/charge_capture_bundle/v1/#{charge_capture_bundle_id}"
202
+ request_options: request_options)}/api/charge_capture_claim_creation/v1/#{charge_capture_claim_creation_id}"
224
203
  end
225
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle.from_json(json_object: response.body)
204
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation.from_json(json_object: response.body)
226
205
  end
227
206
  end
228
207
 
229
208
  # @param request_options [CandidApiClient::RequestOptions]
230
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSummary]
209
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary]
231
210
  # @example
232
211
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
233
212
  # api.charge_capture_bundles.v_1.get_summary
@@ -242,42 +221,19 @@ module CandidApiClient
242
221
  **(request_options&.additional_headers || {})
243
222
  }.compact
244
223
  req.url "#{@request_client.get_url(environment: CandidApi,
245
- request_options: request_options)}/api/charge_capture_bundle/v1/all/summary"
246
- end
247
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSummary.from_json(json_object: response.body)
248
- end
249
- end
250
-
251
- # @param charge_capture_bundle_id [String]
252
- # @param request_options [CandidApiClient::RequestOptions]
253
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
254
- # @example
255
- # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
256
- # api.charge_capture_bundles.v_1.resubmit(charge_capture_bundle_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
257
- def resubmit(charge_capture_bundle_id:, request_options: nil)
258
- Async do
259
- response = @request_client.conn.post do |req|
260
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
261
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
262
- req.headers = {
263
- **(req.headers || {}),
264
- **@request_client.get_headers,
265
- **(request_options&.additional_headers || {})
266
- }.compact
267
- req.url "#{@request_client.get_url(environment: CandidApi,
268
- request_options: request_options)}/api/charge_capture_bundle/v1/#{charge_capture_bundle_id}"
224
+ request_options: request_options)}/api/charge_capture_claim_creation/v1/all/summary"
269
225
  end
270
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle.from_json(json_object: response.body)
226
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary.from_json(json_object: response.body)
271
227
  end
272
228
  end
273
229
 
274
230
  # @param limit [Integer] Maximum number of entities per page, defaults to 100.
275
- # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleSortField] Defaults to created_at
231
+ # @param sort [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSortField] Defaults to created_at
276
232
  # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
277
233
  # @param page_token [String]
278
234
  # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
279
- # @param bundle_status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] the status of the charge capture bundle, refers to whether it was able to create
280
- # an encounter.
235
+ # @param claim_creation_status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus] the status of the charge capture Claim Creation, refers to whether it was able
236
+ # to create a claim.
281
237
  # @param charge_status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge captures
282
238
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
283
239
  # for example, your internal encounter ID or a Dr. Chrono encounter ID.
@@ -286,34 +242,34 @@ module CandidApiClient
286
242
  # This date must be the local date in the timezone where the service occurred.
287
243
  # @param date_of_service_max [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
288
244
  # This date must be the local date in the timezone where the service occurred.
289
- # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge capture bundles
290
- # that have a resulting claim with one of the IDs in this list.
291
- # @param bundle_ids [String] A list of bundle IDs to filter by.
245
+ # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge capture
246
+ # claim_creations that have a resulting claim with one of the IDs in this list.
247
+ # @param claim_creation_ids [String] A list of Claim Creation IDs to filter by.
292
248
  # @param billing_provider_npis [String] A list of billing provider NPIs to filter by. This will return all charge
293
- # capture bundles which include one or more charges with one of the NPIs in this
294
- # list.
295
- # @param service_facility_name [String] A string to filter by. This will return all charge capture bundles which include
296
- # one or more charges with this service facility name.
249
+ # capture claim_creations which include one or more charges with one of the NPIs
250
+ # in this list.
251
+ # @param service_facility_name [String] A string to filter by. This will return all charge capture claim_creations which
252
+ # include one or more charges with this service facility name.
297
253
  # @param primary_payer_ids [String] A list of primary payer IDs to filter by. This will return all charge capture
298
- # bundles which include one or more charges with one of the primary payer IDs in
299
- # this list.
254
+ # claim_creations which include one or more charges with one of the primary payer
255
+ # IDs in this list.
300
256
  # @param rendering_provider_npis [String] A list of rendering provider NPIs to filter by. This will return all charge
301
- # capture bundles which include one or more charges with one of the NPIs in this
302
- # list.
257
+ # capture claim_creations which include one or more charges with one of the NPIs
258
+ # in this list.
303
259
  # @param rendering_provider_names [String] A list of rendering provider names to filter by. This will return all charge
304
- # capture bundles which include one or more charges with one of the names in this
305
- # list.
260
+ # capture claim_creations which include one or more charges with one of the names
261
+ # in this list.
306
262
  # @param supervising_provider_npis [String] A list of supervising provider NPIs to filter by. This will return all charge
307
- # capture bundles which include one or more charges with one of the NPIs in this
308
- # list.
263
+ # capture claim_creations which include one or more charges with one of the NPIs
264
+ # in this list.
309
265
  # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
310
- # capture bundles which include one or more charges with one of the names in this
311
- # list.
312
- # @param has_charge_capture_updates [Boolean] If true, only return bundles that have charge captures that have been updated
313
- # since the bundle has had a status of BILLED. See the updates property on
314
- # ChargeCapture for more details.
266
+ # capture claim_creations which include one or more charges with one of the names
267
+ # in this list.
268
+ # @param has_charge_capture_updates [Boolean] If true, only return claim_creations that have charge captures that have been
269
+ # updated since the Claim Creation has had a status of BILLED. See the updates
270
+ # property on ChargeCapture for more details.
315
271
  # @param request_options [CandidApiClient::RequestOptions]
316
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage]
272
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage]
317
273
  # @example
318
274
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
319
275
  # api.charge_capture_bundles.v_1.get_all(
@@ -322,13 +278,13 @@ module CandidApiClient
322
278
  # sort_direction: ASC,
323
279
  # page_token: "eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
324
280
  # patient_external_id: "string",
325
- # bundle_status: NOT_STARTED,
281
+ # claim_creation_status: NOT_STARTED,
326
282
  # charge_status: PLANNED,
327
283
  # charge_external_id: "string",
328
284
  # date_of_service_min: DateTime.parse(2023-01-15),
329
285
  # date_of_service_max: DateTime.parse(2023-01-15),
330
286
  # claim_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
331
- # bundle_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
287
+ # claim_creation_ids: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
332
288
  # billing_provider_npis: "string",
333
289
  # service_facility_name: "string",
334
290
  # primary_payer_ids: "string",
@@ -339,7 +295,7 @@ module CandidApiClient
339
295
  # has_charge_capture_updates: true
340
296
  # )
341
297
  def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil,
342
- bundle_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, bundle_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil)
298
+ claim_creation_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil)
343
299
  Async do
344
300
  response = @request_client.conn.get do |req|
345
301
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -356,13 +312,13 @@ module CandidApiClient
356
312
  "sort_direction": sort_direction,
357
313
  "page_token": page_token,
358
314
  "patient_external_id": patient_external_id,
359
- "bundle_status": bundle_status,
315
+ "claim_creation_status": claim_creation_status,
360
316
  "charge_status": charge_status,
361
317
  "charge_external_id": charge_external_id,
362
318
  "date_of_service_min": date_of_service_min,
363
319
  "date_of_service_max": date_of_service_max,
364
320
  "claim_ids": claim_ids,
365
- "bundle_ids": bundle_ids,
321
+ "claim_creation_ids": claim_creation_ids,
366
322
  "billing_provider_npis": billing_provider_npis,
367
323
  "service_facility_name": service_facility_name,
368
324
  "primary_payer_ids": primary_payer_ids,
@@ -373,9 +329,9 @@ module CandidApiClient
373
329
  "has_charge_capture_updates": has_charge_capture_updates
374
330
  }.compact
375
331
  req.url "#{@request_client.get_url(environment: CandidApi,
376
- request_options: request_options)}/api/charge_capture_bundle/v1"
332
+ request_options: request_options)}/api/charge_capture_claim_creation/v1"
377
333
  end
378
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage.from_json(json_object: response.body)
334
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage.from_json(json_object: response.body)
379
335
  end
380
336
  end
381
337
  end
@@ -1,7 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "charge_capture_bundle_status"
4
- require_relative "../../../charge_capture/v_1/types/charge_capture"
3
+ require_relative "charge_capture_claim_creation_status"
5
4
  require_relative "../../../charge_capture/v_1/types/charge_capture_error"
6
5
  require "ostruct"
7
6
  require "json"
@@ -10,23 +9,21 @@ module CandidApiClient
10
9
  module ChargeCaptureBundles
11
10
  module V1
12
11
  module Types
13
- class ChargeCaptureBundle
12
+ class ChargeCaptureClaimCreation
14
13
  # @return [String]
15
14
  attr_reader :id
16
15
  # @return [String]
17
16
  attr_reader :created_encounter_id
18
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
19
- # Claim
17
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus] Status of the Claim Creation, Successful means that the Claim Creation created a
18
+ # corresponding Claim
20
19
  attr_reader :status
21
20
  # @return [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
22
21
  # based on the bundling configuration.
23
22
  # Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
24
23
  attr_reader :characteristics
25
- # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
26
- attr_reader :charge_captures
27
- # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
28
- # Errors can correspond to the Bundle as a whole or specific underlying Charge
29
- # Captures.
24
+ # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the Claim was attempted to be created.
25
+ # Errors can correspond to the Claim Creation as a whole or specific underlying
26
+ # Charge Captures.
30
27
  attr_reader :errors
31
28
  # @return [OpenStruct] Additional properties unmapped to the current class definition
32
29
  attr_reader :additional_properties
@@ -38,24 +35,22 @@ module CandidApiClient
38
35
 
39
36
  # @param id [String]
40
37
  # @param created_encounter_id [String]
41
- # @param status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus] Status of the Bundle, Successful means that the Bundle created a corresponding
42
- # Claim
38
+ # @param status [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus] Status of the Claim Creation, Successful means that the Claim Creation created a
39
+ # corresponding Claim
43
40
  # @param characteristics [Hash{String => String}] A dictionary of characteristics that are used to group charge captures together
44
41
  # based on the bundling configuration.
45
42
  # Example: {"service_facility.npi": "99999999", "date_of_service": "2023-01-01"}
46
- # @param charge_captures [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapture>] All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.
47
- # @param errors [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the bundle was attempted to be created.
48
- # Errors can correspond to the Bundle as a whole or specific underlying Charge
49
- # Captures.
43
+ # @param errors [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError>] All errors that were found when the Claim was attempted to be created.
44
+ # Errors can correspond to the Claim Creation as a whole or specific underlying
45
+ # Charge Captures.
50
46
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
51
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
52
- def initialize(id:, status:, characteristics:, charge_captures:, errors:, created_encounter_id: OMIT,
47
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation]
48
+ def initialize(id:, status:, characteristics:, errors:, created_encounter_id: OMIT,
53
49
  additional_properties: nil)
54
50
  @id = id
55
51
  @created_encounter_id = created_encounter_id if created_encounter_id != OMIT
56
52
  @status = status
57
53
  @characteristics = characteristics
58
- @charge_captures = charge_captures
59
54
  @errors = errors
60
55
  @additional_properties = additional_properties
61
56
  @_field_set = {
@@ -63,17 +58,16 @@ module CandidApiClient
63
58
  "created_encounter_id": created_encounter_id,
64
59
  "status": status,
65
60
  "characteristics": characteristics,
66
- "charge_captures": charge_captures,
67
61
  "errors": errors
68
62
  }.reject do |_k, v|
69
63
  v == OMIT
70
64
  end
71
65
  end
72
66
 
73
- # Deserialize a JSON object to an instance of ChargeCaptureBundle
67
+ # Deserialize a JSON object to an instance of ChargeCaptureClaimCreation
74
68
  #
75
69
  # @param json_object [String]
76
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle]
70
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation]
77
71
  def self.from_json(json_object:)
78
72
  struct = JSON.parse(json_object, object_class: OpenStruct)
79
73
  parsed_json = JSON.parse(json_object)
@@ -81,10 +75,6 @@ module CandidApiClient
81
75
  created_encounter_id = struct["created_encounter_id"]
82
76
  status = struct["status"]
83
77
  characteristics = struct["characteristics"]
84
- charge_captures = parsed_json["charge_captures"]&.map do |item|
85
- item = item.to_json
86
- CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: item)
87
- end
88
78
  errors = parsed_json["errors"]&.map do |item|
89
79
  item = item.to_json
90
80
  CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureError.from_json(json_object: item)
@@ -94,13 +84,12 @@ module CandidApiClient
94
84
  created_encounter_id: created_encounter_id,
95
85
  status: status,
96
86
  characteristics: characteristics,
97
- charge_captures: charge_captures,
98
87
  errors: errors,
99
88
  additional_properties: struct
100
89
  )
101
90
  end
102
91
 
103
- # Serialize an instance of ChargeCaptureBundle to a JSON object
92
+ # Serialize an instance of ChargeCaptureClaimCreation to a JSON object
104
93
  #
105
94
  # @return [String]
106
95
  def to_json(*_args)
@@ -116,9 +105,8 @@ module CandidApiClient
116
105
  def self.validate_raw(obj:)
117
106
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
118
107
  obj.created_encounter_id&.is_a?(String) != false || raise("Passed value for field obj.created_encounter_id is not the expected type, validation failed.")
119
- obj.status.is_a?(CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundleStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
108
+ obj.status.is_a?(CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
120
109
  obj.characteristics.is_a?(Hash) != false || raise("Passed value for field obj.characteristics is not the expected type, validation failed.")
121
- obj.charge_captures.is_a?(Array) != false || raise("Passed value for field obj.charge_captures is not the expected type, validation failed.")
122
110
  obj.errors.is_a?(Array) != false || raise("Passed value for field obj.errors is not the expected type, validation failed.")
123
111
  end
124
112
  end
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "charge_capture_bundle"
3
+ require_relative "charge_capture_claim_creation"
4
4
  require "ostruct"
5
5
  require "json"
6
6
 
@@ -8,8 +8,8 @@ module CandidApiClient
8
8
  module ChargeCaptureBundles
9
9
  module V1
10
10
  module Types
11
- class ChargeCaptureBundlePage
12
- # @return [Array<CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle>]
11
+ class ChargeCaptureClaimCreationPage
12
+ # @return [Array<CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation>]
13
13
  attr_reader :items
14
14
  # @return [String]
15
15
  attr_reader :prev_page_token
@@ -23,11 +23,11 @@ module CandidApiClient
23
23
 
24
24
  OMIT = Object.new
25
25
 
26
- # @param items [Array<CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle>]
26
+ # @param items [Array<CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation>]
27
27
  # @param prev_page_token [String]
28
28
  # @param next_page_token [String]
29
29
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
30
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage]
30
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage]
31
31
  def initialize(items:, prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil)
32
32
  @items = items
33
33
  @prev_page_token = prev_page_token if prev_page_token != OMIT
@@ -42,16 +42,16 @@ module CandidApiClient
42
42
  end
43
43
  end
44
44
 
45
- # Deserialize a JSON object to an instance of ChargeCaptureBundlePage
45
+ # Deserialize a JSON object to an instance of ChargeCaptureClaimCreationPage
46
46
  #
47
47
  # @param json_object [String]
48
- # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundlePage]
48
+ # @return [CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage]
49
49
  def self.from_json(json_object:)
50
50
  struct = JSON.parse(json_object, object_class: OpenStruct)
51
51
  parsed_json = JSON.parse(json_object)
52
52
  items = parsed_json["items"]&.map do |item|
53
53
  item = item.to_json
54
- CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureBundle.from_json(json_object: item)
54
+ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation.from_json(json_object: item)
55
55
  end
56
56
  prev_page_token = struct["prev_page_token"]
57
57
  next_page_token = struct["next_page_token"]
@@ -63,7 +63,7 @@ module CandidApiClient
63
63
  )
64
64
  end
65
65
 
66
- # Serialize an instance of ChargeCaptureBundlePage to a JSON object
66
+ # Serialize an instance of ChargeCaptureClaimCreationPage to a JSON object
67
67
  #
68
68
  # @return [String]
69
69
  def to_json(*_args)
@@ -4,7 +4,7 @@ module CandidApiClient
4
4
  module ChargeCaptureBundles
5
5
  module V1
6
6
  module Types
7
- class ChargeCaptureBundleSortField
7
+ class ChargeCaptureClaimCreationSortField
8
8
  CREATED_AT = "created_at"
9
9
  end
10
10
  end
@@ -4,7 +4,7 @@ module CandidApiClient
4
4
  module ChargeCaptureBundles
5
5
  module V1
6
6
  module Types
7
- class ChargeCaptureBundleStatus
7
+ class ChargeCaptureClaimCreationStatus
8
8
  NOT_STARTED = "not-started"
9
9
  IN_ERROR = "in-error"
10
10
  SUCCESSFUL = "successful"