primary_connect_client 0.7.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +63 -20
- data/docs/Address.md +32 -0
- data/docs/CodedValue.md +22 -0
- data/docs/DefaultApi.md +635 -0
- data/docs/Demographics.md +52 -0
- data/docs/Error.md +18 -0
- data/docs/Event.md +26 -0
- data/docs/Events.md +18 -0
- data/docs/Identifier.md +20 -0
- data/docs/Location.md +26 -0
- data/docs/Meta.md +34 -0
- data/docs/MetaDestinations.md +22 -0
- data/docs/MetaMessage.md +20 -0
- data/docs/MetaSource.md +20 -0
- data/docs/MetaTransmission.md +18 -0
- data/docs/Name.md +22 -0
- data/docs/Order.md +24 -0
- data/docs/OrderIds.md +18 -0
- data/docs/OrderOrder.md +58 -0
- data/docs/OrderOrderClinicalInfo.md +26 -0
- data/docs/OrderOrderDiagnoses.md +22 -0
- data/docs/OrderOrderOrderingFacility.md +22 -0
- data/docs/OrderOrderSpecimen.md +22 -0
- data/docs/OrderWithEventErrors.md +20 -0
- data/docs/Orders.md +18 -0
- data/docs/OrdersOrders.md +22 -0
- data/docs/Patient.md +24 -0
- data/docs/PatientContacts.md +28 -0
- data/docs/PatientDemographics.md +52 -0
- data/docs/PhoneNumber.md +20 -0
- data/docs/Provider.md +32 -0
- data/docs/Result.md +52 -0
- data/docs/ResultIds.md +18 -0
- data/docs/ResultReferenceRange.md +22 -0
- data/docs/ResultReport.md +22 -0
- data/docs/ResultSpecimen.md +22 -0
- data/docs/Results.md +20 -0
- data/docs/Specimen.md +22 -0
- data/docs/Visit.md +36 -0
- data/docs/VisitCompany.md +24 -0
- data/docs/VisitGuarantor.md +40 -0
- data/docs/VisitGuarantorEmployer.md +22 -0
- data/docs/VisitInsurances.md +40 -0
- data/docs/VisitInsured.md +30 -0
- data/docs/VisitPlan.md +22 -0
- data/git_push.sh +5 -6
- data/lib/primary_connect_client/api/default_api.rb +204 -66
- data/lib/primary_connect_client/api_client.rb +5 -6
- data/lib/primary_connect_client/api_error.rb +1 -1
- data/lib/primary_connect_client/configuration.rb +4 -3
- data/lib/primary_connect_client/models/address.rb +281 -0
- data/lib/primary_connect_client/models/coded_value.rb +238 -0
- data/lib/primary_connect_client/models/demographics.rb +466 -0
- data/lib/primary_connect_client/models/error.rb +218 -0
- data/lib/primary_connect_client/models/event.rb +254 -0
- data/lib/primary_connect_client/models/events.rb +221 -0
- data/lib/primary_connect_client/models/identifier.rb +228 -0
- data/lib/primary_connect_client/models/location.rb +255 -0
- data/lib/primary_connect_client/models/meta.rb +327 -0
- data/lib/primary_connect_client/models/meta_destinations.rb +242 -0
- data/lib/primary_connect_client/models/meta_message.rb +227 -0
- data/lib/primary_connect_client/models/meta_source.rb +227 -0
- data/lib/primary_connect_client/models/meta_transmission.rb +218 -0
- data/lib/primary_connect_client/models/name.rb +237 -0
- data/lib/primary_connect_client/models/order.rb +245 -0
- data/lib/primary_connect_client/models/order_ids.rb +221 -0
- data/lib/primary_connect_client/models/order_order.rb +496 -0
- data/lib/primary_connect_client/models/order_order_clinical_info.rb +260 -0
- data/lib/primary_connect_client/models/order_order_diagnoses.rb +272 -0
- data/lib/primary_connect_client/models/order_order_ordering_facility.rb +239 -0
- data/lib/primary_connect_client/models/order_order_specimen.rb +239 -0
- data/lib/primary_connect_client/models/order_with_event_errors.rb +229 -0
- data/lib/primary_connect_client/models/orders.rb +221 -0
- data/lib/primary_connect_client/models/orders_orders.rb +236 -0
- data/lib/primary_connect_client/models/patient.rb +253 -0
- data/lib/primary_connect_client/models/patient_contacts.rb +305 -0
- data/lib/primary_connect_client/models/patient_demographics.rb +466 -0
- data/lib/primary_connect_client/models/phone_number.rb +262 -0
- data/lib/primary_connect_client/models/provider.rb +288 -0
- data/lib/primary_connect_client/models/result.rb +443 -0
- data/lib/primary_connect_client/models/result_ids.rb +221 -0
- data/lib/primary_connect_client/models/result_reference_range.rb +240 -0
- data/lib/primary_connect_client/models/result_report.rb +240 -0
- data/lib/primary_connect_client/models/result_specimen.rb +239 -0
- data/lib/primary_connect_client/models/results.rb +230 -0
- data/lib/primary_connect_client/models/specimen.rb +239 -0
- data/lib/primary_connect_client/models/visit.rb +306 -0
- data/lib/primary_connect_client/models/visit_company.rb +248 -0
- data/lib/primary_connect_client/models/visit_guarantor.rb +358 -0
- data/lib/primary_connect_client/models/visit_guarantor_employer.rb +238 -0
- data/lib/primary_connect_client/models/visit_insurances.rb +386 -0
- data/lib/primary_connect_client/models/visit_insured.rb +322 -0
- data/lib/primary_connect_client/models/visit_plan.rb +238 -0
- data/lib/primary_connect_client/version.rb +12 -2
- data/lib/primary_connect_client.rb +45 -3
- data/primary_connect_client.gemspec +7 -5
- data/spec/api/default_api_spec.rb +55 -41
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/address_spec.rb +76 -0
- data/spec/models/coded_value_spec.rb +46 -0
- data/spec/models/demographics_spec.rb +168 -0
- data/spec/models/error_spec.rb +34 -0
- data/spec/models/event_spec.rb +58 -0
- data/spec/models/events_spec.rb +34 -0
- data/spec/models/identifier_spec.rb +40 -0
- data/spec/models/location_spec.rb +58 -0
- data/spec/models/meta_destinations_spec.rb +46 -0
- data/spec/models/meta_message_spec.rb +40 -0
- data/spec/models/meta_source_spec.rb +40 -0
- data/spec/models/meta_spec.rb +86 -0
- data/spec/models/meta_transmission_spec.rb +34 -0
- data/spec/models/name_spec.rb +46 -0
- data/spec/models/order_ids_spec.rb +34 -0
- data/spec/models/order_order_clinical_info_spec.rb +58 -0
- data/spec/models/order_order_diagnoses_spec.rb +50 -0
- data/spec/models/order_order_ordering_facility_spec.rb +46 -0
- data/spec/models/order_order_spec.rb +170 -0
- data/spec/models/order_order_specimen_spec.rb +46 -0
- data/spec/models/order_spec.rb +52 -0
- data/spec/models/order_with_event_errors_spec.rb +40 -0
- data/spec/models/orders_orders_spec.rb +46 -0
- data/spec/models/orders_spec.rb +34 -0
- data/spec/models/patient_contacts_spec.rb +68 -0
- data/spec/models/patient_demographics_spec.rb +168 -0
- data/spec/models/patient_spec.rb +52 -0
- data/spec/models/phone_number_spec.rb +44 -0
- data/spec/models/provider_spec.rb +76 -0
- data/spec/models/result_ids_spec.rb +34 -0
- data/spec/models/result_reference_range_spec.rb +46 -0
- data/spec/models/result_report_spec.rb +46 -0
- data/spec/models/result_spec.rb +148 -0
- data/spec/models/result_specimen_spec.rb +46 -0
- data/spec/models/results_spec.rb +40 -0
- data/spec/models/specimen_spec.rb +46 -0
- data/spec/models/visit_company_spec.rb +52 -0
- data/spec/models/visit_guarantor_employer_spec.rb +46 -0
- data/spec/models/visit_guarantor_spec.rb +104 -0
- data/spec/models/visit_insurances_spec.rb +112 -0
- data/spec/models/visit_insured_spec.rb +78 -0
- data/spec/models/visit_plan_spec.rb +46 -0
- data/spec/models/visit_spec.rb +88 -0
- data/spec/spec_helper.rb +1 -1
- metadata +177 -20
- data/Gemfile.lock +0 -74
data/docs/DefaultApi.md
ADDED
@@ -0,0 +1,635 @@
|
|
1
|
+
# PrimaryConnectClient::DefaultApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://connect.primary.health*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**cancel_order**](DefaultApi.md#cancel_order) | **DELETE** /api/v1/orders/{id} | cancel order |
|
8
|
+
| [**create_order**](DefaultApi.md#create_order) | **POST** /api/v1/orders | create order |
|
9
|
+
| [**create_result**](DefaultApi.md#create_result) | **POST** /api/v1/orders/{order_id}/results | create result |
|
10
|
+
| [**get_lab_report**](DefaultApi.md#get_lab_report) | **GET** /api/v1/results/{result_id}/lab_report | show lab report |
|
11
|
+
| [**get_order**](DefaultApi.md#get_order) | **GET** /api/v1/orders/{id} | show order |
|
12
|
+
| [**list_events**](DefaultApi.md#list_events) | **GET** /api/v1/events | list events |
|
13
|
+
| [**list_orders**](DefaultApi.md#list_orders) | **GET** /api/v1/orders | list orders |
|
14
|
+
| [**list_results**](DefaultApi.md#list_results) | **GET** /api/v1/orders/{order_id}/results | list results |
|
15
|
+
| [**update_order**](DefaultApi.md#update_order) | **PUT** /api/v1/orders/{id} | update order |
|
16
|
+
|
17
|
+
|
18
|
+
## cancel_order
|
19
|
+
|
20
|
+
> cancel_order(id)
|
21
|
+
|
22
|
+
cancel order
|
23
|
+
|
24
|
+
### Examples
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'time'
|
28
|
+
require 'primary_connect_client'
|
29
|
+
# setup authorization
|
30
|
+
PrimaryConnectClient.configure do |config|
|
31
|
+
# Configure Bearer authorization: bearer_auth
|
32
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
36
|
+
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
|
37
|
+
|
38
|
+
begin
|
39
|
+
# cancel order
|
40
|
+
api_instance.cancel_order(id)
|
41
|
+
rescue PrimaryConnectClient::ApiError => e
|
42
|
+
puts "Error when calling DefaultApi->cancel_order: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the cancel_order_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
49
|
+
|
50
|
+
> <Array(nil, Integer, Hash)> cancel_order_with_http_info(id)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# cancel order
|
55
|
+
data, status_code, headers = api_instance.cancel_order_with_http_info(id)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => nil
|
59
|
+
rescue PrimaryConnectClient::ApiError => e
|
60
|
+
puts "Error when calling DefaultApi->cancel_order_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **id** | **String** | Order ID | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
nil (empty response body)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[bearer_auth](../README.md#bearer_auth)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: Not defined
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## create_order
|
85
|
+
|
86
|
+
> <OrderIds> create_order(opts)
|
87
|
+
|
88
|
+
create order
|
89
|
+
|
90
|
+
### Examples
|
91
|
+
|
92
|
+
```ruby
|
93
|
+
require 'time'
|
94
|
+
require 'primary_connect_client'
|
95
|
+
# setup authorization
|
96
|
+
PrimaryConnectClient.configure do |config|
|
97
|
+
# Configure Bearer authorization: bearer_auth
|
98
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
99
|
+
end
|
100
|
+
|
101
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
102
|
+
opts = {
|
103
|
+
order: PrimaryConnectClient::Order.new # Order |
|
104
|
+
}
|
105
|
+
|
106
|
+
begin
|
107
|
+
# create order
|
108
|
+
result = api_instance.create_order(opts)
|
109
|
+
p result
|
110
|
+
rescue PrimaryConnectClient::ApiError => e
|
111
|
+
puts "Error when calling DefaultApi->create_order: #{e}"
|
112
|
+
end
|
113
|
+
```
|
114
|
+
|
115
|
+
#### Using the create_order_with_http_info variant
|
116
|
+
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
118
|
+
|
119
|
+
> <Array(<OrderIds>, Integer, Hash)> create_order_with_http_info(opts)
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
begin
|
123
|
+
# create order
|
124
|
+
data, status_code, headers = api_instance.create_order_with_http_info(opts)
|
125
|
+
p status_code # => 2xx
|
126
|
+
p headers # => { ... }
|
127
|
+
p data # => <OrderIds>
|
128
|
+
rescue PrimaryConnectClient::ApiError => e
|
129
|
+
puts "Error when calling DefaultApi->create_order_with_http_info: #{e}"
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
### Parameters
|
134
|
+
|
135
|
+
| Name | Type | Description | Notes |
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
137
|
+
| **order** | [**Order**](Order.md) | | [optional] |
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
[**OrderIds**](OrderIds.md)
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
[bearer_auth](../README.md#bearer_auth)
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: application/json
|
150
|
+
- **Accept**: application/json
|
151
|
+
|
152
|
+
|
153
|
+
## create_result
|
154
|
+
|
155
|
+
> <ResultIds> create_result(order_id, opts)
|
156
|
+
|
157
|
+
create result
|
158
|
+
|
159
|
+
### Examples
|
160
|
+
|
161
|
+
```ruby
|
162
|
+
require 'time'
|
163
|
+
require 'primary_connect_client'
|
164
|
+
# setup authorization
|
165
|
+
PrimaryConnectClient.configure do |config|
|
166
|
+
# Configure Bearer authorization: bearer_auth
|
167
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
168
|
+
end
|
169
|
+
|
170
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
171
|
+
order_id = '01FGD44Q6MVCG2VNSMCVX5ZCT6' # String | Order id
|
172
|
+
opts = {
|
173
|
+
result: PrimaryConnectClient::Result.new # Result |
|
174
|
+
}
|
175
|
+
|
176
|
+
begin
|
177
|
+
# create result
|
178
|
+
result = api_instance.create_result(order_id, opts)
|
179
|
+
p result
|
180
|
+
rescue PrimaryConnectClient::ApiError => e
|
181
|
+
puts "Error when calling DefaultApi->create_result: #{e}"
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
#### Using the create_result_with_http_info variant
|
186
|
+
|
187
|
+
This returns an Array which contains the response data, status code and headers.
|
188
|
+
|
189
|
+
> <Array(<ResultIds>, Integer, Hash)> create_result_with_http_info(order_id, opts)
|
190
|
+
|
191
|
+
```ruby
|
192
|
+
begin
|
193
|
+
# create result
|
194
|
+
data, status_code, headers = api_instance.create_result_with_http_info(order_id, opts)
|
195
|
+
p status_code # => 2xx
|
196
|
+
p headers # => { ... }
|
197
|
+
p data # => <ResultIds>
|
198
|
+
rescue PrimaryConnectClient::ApiError => e
|
199
|
+
puts "Error when calling DefaultApi->create_result_with_http_info: #{e}"
|
200
|
+
end
|
201
|
+
```
|
202
|
+
|
203
|
+
### Parameters
|
204
|
+
|
205
|
+
| Name | Type | Description | Notes |
|
206
|
+
| ---- | ---- | ----------- | ----- |
|
207
|
+
| **order_id** | **String** | Order id | |
|
208
|
+
| **result** | [**Result**](Result.md) | | [optional] |
|
209
|
+
|
210
|
+
### Return type
|
211
|
+
|
212
|
+
[**ResultIds**](ResultIds.md)
|
213
|
+
|
214
|
+
### Authorization
|
215
|
+
|
216
|
+
[bearer_auth](../README.md#bearer_auth)
|
217
|
+
|
218
|
+
### HTTP request headers
|
219
|
+
|
220
|
+
- **Content-Type**: application/json
|
221
|
+
- **Accept**: application/json
|
222
|
+
|
223
|
+
|
224
|
+
## get_lab_report
|
225
|
+
|
226
|
+
> get_lab_report(result_id)
|
227
|
+
|
228
|
+
show lab report
|
229
|
+
|
230
|
+
### Examples
|
231
|
+
|
232
|
+
```ruby
|
233
|
+
require 'time'
|
234
|
+
require 'primary_connect_client'
|
235
|
+
# setup authorization
|
236
|
+
PrimaryConnectClient.configure do |config|
|
237
|
+
# Configure Bearer authorization: bearer_auth
|
238
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
239
|
+
end
|
240
|
+
|
241
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
242
|
+
result_id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Result id
|
243
|
+
|
244
|
+
begin
|
245
|
+
# show lab report
|
246
|
+
api_instance.get_lab_report(result_id)
|
247
|
+
rescue PrimaryConnectClient::ApiError => e
|
248
|
+
puts "Error when calling DefaultApi->get_lab_report: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
#### Using the get_lab_report_with_http_info variant
|
253
|
+
|
254
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
255
|
+
|
256
|
+
> <Array(nil, Integer, Hash)> get_lab_report_with_http_info(result_id)
|
257
|
+
|
258
|
+
```ruby
|
259
|
+
begin
|
260
|
+
# show lab report
|
261
|
+
data, status_code, headers = api_instance.get_lab_report_with_http_info(result_id)
|
262
|
+
p status_code # => 2xx
|
263
|
+
p headers # => { ... }
|
264
|
+
p data # => nil
|
265
|
+
rescue PrimaryConnectClient::ApiError => e
|
266
|
+
puts "Error when calling DefaultApi->get_lab_report_with_http_info: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
| Name | Type | Description | Notes |
|
273
|
+
| ---- | ---- | ----------- | ----- |
|
274
|
+
| **result_id** | **String** | Result id | |
|
275
|
+
|
276
|
+
### Return type
|
277
|
+
|
278
|
+
nil (empty response body)
|
279
|
+
|
280
|
+
### Authorization
|
281
|
+
|
282
|
+
[bearer_auth](../README.md#bearer_auth)
|
283
|
+
|
284
|
+
### HTTP request headers
|
285
|
+
|
286
|
+
- **Content-Type**: Not defined
|
287
|
+
- **Accept**: application/json
|
288
|
+
|
289
|
+
|
290
|
+
## get_order
|
291
|
+
|
292
|
+
> <OrderWithEventErrors> get_order(id)
|
293
|
+
|
294
|
+
show order
|
295
|
+
|
296
|
+
### Examples
|
297
|
+
|
298
|
+
```ruby
|
299
|
+
require 'time'
|
300
|
+
require 'primary_connect_client'
|
301
|
+
# setup authorization
|
302
|
+
PrimaryConnectClient.configure do |config|
|
303
|
+
# Configure Bearer authorization: bearer_auth
|
304
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
308
|
+
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
|
309
|
+
|
310
|
+
begin
|
311
|
+
# show order
|
312
|
+
result = api_instance.get_order(id)
|
313
|
+
p result
|
314
|
+
rescue PrimaryConnectClient::ApiError => e
|
315
|
+
puts "Error when calling DefaultApi->get_order: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
#### Using the get_order_with_http_info variant
|
320
|
+
|
321
|
+
This returns an Array which contains the response data, status code and headers.
|
322
|
+
|
323
|
+
> <Array(<OrderWithEventErrors>, Integer, Hash)> get_order_with_http_info(id)
|
324
|
+
|
325
|
+
```ruby
|
326
|
+
begin
|
327
|
+
# show order
|
328
|
+
data, status_code, headers = api_instance.get_order_with_http_info(id)
|
329
|
+
p status_code # => 2xx
|
330
|
+
p headers # => { ... }
|
331
|
+
p data # => <OrderWithEventErrors>
|
332
|
+
rescue PrimaryConnectClient::ApiError => e
|
333
|
+
puts "Error when calling DefaultApi->get_order_with_http_info: #{e}"
|
334
|
+
end
|
335
|
+
```
|
336
|
+
|
337
|
+
### Parameters
|
338
|
+
|
339
|
+
| Name | Type | Description | Notes |
|
340
|
+
| ---- | ---- | ----------- | ----- |
|
341
|
+
| **id** | **String** | Order ID | |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
[**OrderWithEventErrors**](OrderWithEventErrors.md)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
[bearer_auth](../README.md#bearer_auth)
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: application/json
|
355
|
+
|
356
|
+
|
357
|
+
## list_events
|
358
|
+
|
359
|
+
> <Events> list_events(opts)
|
360
|
+
|
361
|
+
list events
|
362
|
+
|
363
|
+
### Examples
|
364
|
+
|
365
|
+
```ruby
|
366
|
+
require 'time'
|
367
|
+
require 'primary_connect_client'
|
368
|
+
# setup authorization
|
369
|
+
PrimaryConnectClient.configure do |config|
|
370
|
+
# Configure Bearer authorization: bearer_auth
|
371
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
372
|
+
end
|
373
|
+
|
374
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
375
|
+
opts = {
|
376
|
+
last_event_id: '01FGD30NTPNNZE9MKGMWZGHGTZ', # String | Paginate events with event id. 26 character, sortable id.
|
377
|
+
event_types: 'OrderCreated,OrderComplete' # String | Filter event_types, comma delimited. [OrderComplete, OrderCreated, OrderError, OrderResulted, OrderUpdated, ResultError, SpecimenReceived]
|
378
|
+
}
|
379
|
+
|
380
|
+
begin
|
381
|
+
# list events
|
382
|
+
result = api_instance.list_events(opts)
|
383
|
+
p result
|
384
|
+
rescue PrimaryConnectClient::ApiError => e
|
385
|
+
puts "Error when calling DefaultApi->list_events: #{e}"
|
386
|
+
end
|
387
|
+
```
|
388
|
+
|
389
|
+
#### Using the list_events_with_http_info variant
|
390
|
+
|
391
|
+
This returns an Array which contains the response data, status code and headers.
|
392
|
+
|
393
|
+
> <Array(<Events>, Integer, Hash)> list_events_with_http_info(opts)
|
394
|
+
|
395
|
+
```ruby
|
396
|
+
begin
|
397
|
+
# list events
|
398
|
+
data, status_code, headers = api_instance.list_events_with_http_info(opts)
|
399
|
+
p status_code # => 2xx
|
400
|
+
p headers # => { ... }
|
401
|
+
p data # => <Events>
|
402
|
+
rescue PrimaryConnectClient::ApiError => e
|
403
|
+
puts "Error when calling DefaultApi->list_events_with_http_info: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
| Name | Type | Description | Notes |
|
410
|
+
| ---- | ---- | ----------- | ----- |
|
411
|
+
| **last_event_id** | **String** | Paginate events with event id. 26 character, sortable id. | [optional] |
|
412
|
+
| **event_types** | **String** | Filter event_types, comma delimited. [OrderComplete, OrderCreated, OrderError, OrderResulted, OrderUpdated, ResultError, SpecimenReceived] | [optional] |
|
413
|
+
|
414
|
+
### Return type
|
415
|
+
|
416
|
+
[**Events**](Events.md)
|
417
|
+
|
418
|
+
### Authorization
|
419
|
+
|
420
|
+
[bearer_auth](../README.md#bearer_auth)
|
421
|
+
|
422
|
+
### HTTP request headers
|
423
|
+
|
424
|
+
- **Content-Type**: Not defined
|
425
|
+
- **Accept**: application/json
|
426
|
+
|
427
|
+
|
428
|
+
## list_orders
|
429
|
+
|
430
|
+
> <Orders> list_orders(opts)
|
431
|
+
|
432
|
+
list orders
|
433
|
+
|
434
|
+
### Examples
|
435
|
+
|
436
|
+
```ruby
|
437
|
+
require 'time'
|
438
|
+
require 'primary_connect_client'
|
439
|
+
# setup authorization
|
440
|
+
PrimaryConnectClient.configure do |config|
|
441
|
+
# Configure Bearer authorization: bearer_auth
|
442
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
443
|
+
end
|
444
|
+
|
445
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
446
|
+
opts = {
|
447
|
+
last_order_id: '01FGD30NTPNNZE9MKGMWZGHGTZ', # String | Paginate orders with order id. 26 character, sortable id.
|
448
|
+
state: 'new,resulted' # String | Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
|
449
|
+
}
|
450
|
+
|
451
|
+
begin
|
452
|
+
# list orders
|
453
|
+
result = api_instance.list_orders(opts)
|
454
|
+
p result
|
455
|
+
rescue PrimaryConnectClient::ApiError => e
|
456
|
+
puts "Error when calling DefaultApi->list_orders: #{e}"
|
457
|
+
end
|
458
|
+
```
|
459
|
+
|
460
|
+
#### Using the list_orders_with_http_info variant
|
461
|
+
|
462
|
+
This returns an Array which contains the response data, status code and headers.
|
463
|
+
|
464
|
+
> <Array(<Orders>, Integer, Hash)> list_orders_with_http_info(opts)
|
465
|
+
|
466
|
+
```ruby
|
467
|
+
begin
|
468
|
+
# list orders
|
469
|
+
data, status_code, headers = api_instance.list_orders_with_http_info(opts)
|
470
|
+
p status_code # => 2xx
|
471
|
+
p headers # => { ... }
|
472
|
+
p data # => <Orders>
|
473
|
+
rescue PrimaryConnectClient::ApiError => e
|
474
|
+
puts "Error when calling DefaultApi->list_orders_with_http_info: #{e}"
|
475
|
+
end
|
476
|
+
```
|
477
|
+
|
478
|
+
### Parameters
|
479
|
+
|
480
|
+
| Name | Type | Description | Notes |
|
481
|
+
| ---- | ---- | ----------- | ----- |
|
482
|
+
| **last_order_id** | **String** | Paginate orders with order id. 26 character, sortable id. | [optional] |
|
483
|
+
| **state** | **String** | Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable] | [optional] |
|
484
|
+
|
485
|
+
### Return type
|
486
|
+
|
487
|
+
[**Orders**](Orders.md)
|
488
|
+
|
489
|
+
### Authorization
|
490
|
+
|
491
|
+
[bearer_auth](../README.md#bearer_auth)
|
492
|
+
|
493
|
+
### HTTP request headers
|
494
|
+
|
495
|
+
- **Content-Type**: Not defined
|
496
|
+
- **Accept**: application/json
|
497
|
+
|
498
|
+
|
499
|
+
## list_results
|
500
|
+
|
501
|
+
> <Results> list_results(order_id)
|
502
|
+
|
503
|
+
list results
|
504
|
+
|
505
|
+
### Examples
|
506
|
+
|
507
|
+
```ruby
|
508
|
+
require 'time'
|
509
|
+
require 'primary_connect_client'
|
510
|
+
# setup authorization
|
511
|
+
PrimaryConnectClient.configure do |config|
|
512
|
+
# Configure Bearer authorization: bearer_auth
|
513
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
514
|
+
end
|
515
|
+
|
516
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
517
|
+
order_id = '01FGD44Q6MVCG2VNSMCVX5ZCT6' # String | Order id
|
518
|
+
|
519
|
+
begin
|
520
|
+
# list results
|
521
|
+
result = api_instance.list_results(order_id)
|
522
|
+
p result
|
523
|
+
rescue PrimaryConnectClient::ApiError => e
|
524
|
+
puts "Error when calling DefaultApi->list_results: #{e}"
|
525
|
+
end
|
526
|
+
```
|
527
|
+
|
528
|
+
#### Using the list_results_with_http_info variant
|
529
|
+
|
530
|
+
This returns an Array which contains the response data, status code and headers.
|
531
|
+
|
532
|
+
> <Array(<Results>, Integer, Hash)> list_results_with_http_info(order_id)
|
533
|
+
|
534
|
+
```ruby
|
535
|
+
begin
|
536
|
+
# list results
|
537
|
+
data, status_code, headers = api_instance.list_results_with_http_info(order_id)
|
538
|
+
p status_code # => 2xx
|
539
|
+
p headers # => { ... }
|
540
|
+
p data # => <Results>
|
541
|
+
rescue PrimaryConnectClient::ApiError => e
|
542
|
+
puts "Error when calling DefaultApi->list_results_with_http_info: #{e}"
|
543
|
+
end
|
544
|
+
```
|
545
|
+
|
546
|
+
### Parameters
|
547
|
+
|
548
|
+
| Name | Type | Description | Notes |
|
549
|
+
| ---- | ---- | ----------- | ----- |
|
550
|
+
| **order_id** | **String** | Order id | |
|
551
|
+
|
552
|
+
### Return type
|
553
|
+
|
554
|
+
[**Results**](Results.md)
|
555
|
+
|
556
|
+
### Authorization
|
557
|
+
|
558
|
+
[bearer_auth](../README.md#bearer_auth)
|
559
|
+
|
560
|
+
### HTTP request headers
|
561
|
+
|
562
|
+
- **Content-Type**: Not defined
|
563
|
+
- **Accept**: application/json
|
564
|
+
|
565
|
+
|
566
|
+
## update_order
|
567
|
+
|
568
|
+
> <OrderIds> update_order(id, opts)
|
569
|
+
|
570
|
+
update order
|
571
|
+
|
572
|
+
### Examples
|
573
|
+
|
574
|
+
```ruby
|
575
|
+
require 'time'
|
576
|
+
require 'primary_connect_client'
|
577
|
+
# setup authorization
|
578
|
+
PrimaryConnectClient.configure do |config|
|
579
|
+
# Configure Bearer authorization: bearer_auth
|
580
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
581
|
+
end
|
582
|
+
|
583
|
+
api_instance = PrimaryConnectClient::DefaultApi.new
|
584
|
+
id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
|
585
|
+
opts = {
|
586
|
+
order: PrimaryConnectClient::Order.new # Order |
|
587
|
+
}
|
588
|
+
|
589
|
+
begin
|
590
|
+
# update order
|
591
|
+
result = api_instance.update_order(id, opts)
|
592
|
+
p result
|
593
|
+
rescue PrimaryConnectClient::ApiError => e
|
594
|
+
puts "Error when calling DefaultApi->update_order: #{e}"
|
595
|
+
end
|
596
|
+
```
|
597
|
+
|
598
|
+
#### Using the update_order_with_http_info variant
|
599
|
+
|
600
|
+
This returns an Array which contains the response data, status code and headers.
|
601
|
+
|
602
|
+
> <Array(<OrderIds>, Integer, Hash)> update_order_with_http_info(id, opts)
|
603
|
+
|
604
|
+
```ruby
|
605
|
+
begin
|
606
|
+
# update order
|
607
|
+
data, status_code, headers = api_instance.update_order_with_http_info(id, opts)
|
608
|
+
p status_code # => 2xx
|
609
|
+
p headers # => { ... }
|
610
|
+
p data # => <OrderIds>
|
611
|
+
rescue PrimaryConnectClient::ApiError => e
|
612
|
+
puts "Error when calling DefaultApi->update_order_with_http_info: #{e}"
|
613
|
+
end
|
614
|
+
```
|
615
|
+
|
616
|
+
### Parameters
|
617
|
+
|
618
|
+
| Name | Type | Description | Notes |
|
619
|
+
| ---- | ---- | ----------- | ----- |
|
620
|
+
| **id** | **String** | Order ID | |
|
621
|
+
| **order** | [**Order**](Order.md) | | [optional] |
|
622
|
+
|
623
|
+
### Return type
|
624
|
+
|
625
|
+
[**OrderIds**](OrderIds.md)
|
626
|
+
|
627
|
+
### Authorization
|
628
|
+
|
629
|
+
[bearer_auth](../README.md#bearer_auth)
|
630
|
+
|
631
|
+
### HTTP request headers
|
632
|
+
|
633
|
+
- **Content-Type**: application/json
|
634
|
+
- **Accept**: application/json
|
635
|
+
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# PrimaryConnectClient::Demographics
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | [**Name**](Name.md) | | [optional] |
|
8
|
+
| **dob** | **String** | | [optional] |
|
9
|
+
| **ssn** | **String** | | [optional] |
|
10
|
+
| **sex** | **String** | | [optional] |
|
11
|
+
| **gender** | **String** | | [optional] |
|
12
|
+
| **sexual_orientation** | **String** | | [optional] |
|
13
|
+
| **races** | **Array<String>** | | [optional] |
|
14
|
+
| **race_details** | **Array<String>** | | [optional] |
|
15
|
+
| **ethnicity** | **String** | | [optional] |
|
16
|
+
| **ethnicity_detail** | **Array<String>** | | [optional] |
|
17
|
+
| **marital_status** | **String** | | [optional] |
|
18
|
+
| **is_deceased** | **Boolean** | | [optional] |
|
19
|
+
| **death_date_time** | **Time** | ISO 8601 | [optional] |
|
20
|
+
| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) | | [optional] |
|
21
|
+
| **email_addresses** | **Array<String>** | | [optional] |
|
22
|
+
| **language_code** | **String** | | [optional] |
|
23
|
+
| **citizenships** | **Array<String>** | | [optional] |
|
24
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'primary_connect_client'
|
30
|
+
|
31
|
+
instance = PrimaryConnectClient::Demographics.new(
|
32
|
+
name: null,
|
33
|
+
dob: 1992-07-23,
|
34
|
+
ssn: null,
|
35
|
+
sex: null,
|
36
|
+
gender: null,
|
37
|
+
sexual_orientation: null,
|
38
|
+
races: null,
|
39
|
+
race_details: null,
|
40
|
+
ethnicity: null,
|
41
|
+
ethnicity_detail: null,
|
42
|
+
marital_status: null,
|
43
|
+
is_deceased: null,
|
44
|
+
death_date_time: null,
|
45
|
+
phone_numbers: null,
|
46
|
+
email_addresses: null,
|
47
|
+
language_code: en,
|
48
|
+
citizenships: null,
|
49
|
+
address: null
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
data/docs/Error.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# PrimaryConnectClient::Error
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'primary_connect_client'
|
13
|
+
|
14
|
+
instance = PrimaryConnectClient::Error.new(
|
15
|
+
error: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|