spartera_api_sdk 1.0.62 → 1.0.68

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 (35) hide show
  1. checksums.yaml +4 -4
  2. data/config.json +1 -1
  3. data/docs/APIKeysApi.md +25 -15
  4. data/docs/AlertsApi.md +43 -29
  5. data/docs/AssetPriceHistoryApi.md +48 -32
  6. data/docs/AssetsApi.md +74 -336
  7. data/docs/CloudProvidersApi.md +10 -207
  8. data/docs/CompaniesApi.md +45 -27
  9. data/docs/ConnectionsApi.md +39 -25
  10. data/docs/FavoritesApi.md +52 -36
  11. data/docs/StorageEnginesApi.md +149 -0
  12. data/docs/UsersApi.md +29 -19
  13. data/lib/spartera_api_sdk/api/alerts_api.rb +11 -11
  14. data/lib/spartera_api_sdk/api/api_keys_api.rb +5 -5
  15. data/lib/spartera_api_sdk/api/asset_price_history_api.rb +12 -12
  16. data/lib/spartera_api_sdk/api/assets_api.rb +26 -302
  17. data/lib/spartera_api_sdk/api/cloud_providers_api.rb +2 -179
  18. data/lib/spartera_api_sdk/api/companies_api.rb +9 -9
  19. data/lib/spartera_api_sdk/api/connections_api.rb +9 -9
  20. data/lib/spartera_api_sdk/api/favorites_api.rb +14 -14
  21. data/lib/spartera_api_sdk/api/storage_engines_api.rb +150 -0
  22. data/lib/spartera_api_sdk/api/users_api.rb +7 -7
  23. data/lib/spartera_api_sdk/configuration.rb +2 -10
  24. data/lib/spartera_api_sdk/version.rb +1 -1
  25. data/lib/spartera_api_sdk.rb +1 -0
  26. data/spec/api/alerts_api_spec.rb +2 -2
  27. data/spec/api/asset_price_history_api_spec.rb +2 -2
  28. data/spec/api/assets_api_spec.rb +3 -53
  29. data/spec/api/cloud_providers_api_spec.rb +0 -32
  30. data/spec/api/connections_api_spec.rb +1 -1
  31. data/spec/api/favorites_api_spec.rb +3 -3
  32. data/spec/api/storage_engines_api_spec.rb +58 -0
  33. data/spec/api/users_api_spec.rb +1 -1
  34. metadata +28 -22
  35. data/Gemfile.lock +0 -69
@@ -5,10 +5,7 @@ All URIs are relative to *https://api.spartera.com*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**cloud_providers_get**](CloudProvidersApi.md#cloud_providers_get) | **GET** /cloud-providers | Get a list of all cloud providers |
8
- | [**cloud_providers_post**](CloudProvidersApi.md#cloud_providers_post) | **POST** /cloud-providers | Create single cloud provider |
9
- | [**cloud_providers_provider_id_delete**](CloudProvidersApi.md#cloud_providers_provider_id_delete) | **DELETE** /cloud-providers/{provider_id} | Delete single cloud provider by ID |
10
8
  | [**cloud_providers_provider_id_get**](CloudProvidersApi.md#cloud_providers_provider_id_get) | **GET** /cloud-providers/{provider_id} | Get single cloud provider by ID |
11
- | [**cloud_providers_provider_id_patch**](CloudProvidersApi.md#cloud_providers_provider_id_patch) | **PATCH** /cloud-providers/{provider_id} | Update an existing cloud provider by ID |
12
9
 
13
10
 
14
11
  ## cloud_providers_get
@@ -24,8 +21,10 @@ require 'time'
24
21
  require 'spartera_api_sdk'
25
22
  # setup authorization
26
23
  SparteraApiSdk.configure do |config|
27
- # Configure Bearer authorization (JWT): bearerAuth
28
- config.access_token = 'YOUR_BEARER_TOKEN'
24
+ # Configure API key authorization: ApiKeyAuth
25
+ config.api_key['x-api-key'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
29
28
  end
30
29
 
31
30
  api_instance = SparteraApiSdk::CloudProvidersApi.new
@@ -67,138 +66,7 @@ This endpoint does not need any parameter.
67
66
 
68
67
  ### Authorization
69
68
 
70
- [bearerAuth](../README.md#bearerAuth)
71
-
72
- ### HTTP request headers
73
-
74
- - **Content-Type**: Not defined
75
- - **Accept**: application/json
76
-
77
-
78
- ## cloud_providers_post
79
-
80
- > Object cloud_providers_post
81
-
82
- Create single cloud provider
83
-
84
- ### Examples
85
-
86
- ```ruby
87
- require 'time'
88
- require 'spartera_api_sdk'
89
- # setup authorization
90
- SparteraApiSdk.configure do |config|
91
- # Configure Bearer authorization (JWT): bearerAuth
92
- config.access_token = 'YOUR_BEARER_TOKEN'
93
- end
94
-
95
- api_instance = SparteraApiSdk::CloudProvidersApi.new
96
-
97
- begin
98
- # Create single cloud provider
99
- result = api_instance.cloud_providers_post
100
- p result
101
- rescue SparteraApiSdk::ApiError => e
102
- puts "Error when calling CloudProvidersApi->cloud_providers_post: #{e}"
103
- end
104
- ```
105
-
106
- #### Using the cloud_providers_post_with_http_info variant
107
-
108
- This returns an Array which contains the response data, status code and headers.
109
-
110
- > <Array(Object, Integer, Hash)> cloud_providers_post_with_http_info
111
-
112
- ```ruby
113
- begin
114
- # Create single cloud provider
115
- data, status_code, headers = api_instance.cloud_providers_post_with_http_info
116
- p status_code # => 2xx
117
- p headers # => { ... }
118
- p data # => Object
119
- rescue SparteraApiSdk::ApiError => e
120
- puts "Error when calling CloudProvidersApi->cloud_providers_post_with_http_info: #{e}"
121
- end
122
- ```
123
-
124
- ### Parameters
125
-
126
- This endpoint does not need any parameter.
127
-
128
- ### Return type
129
-
130
- **Object**
131
-
132
- ### Authorization
133
-
134
- [bearerAuth](../README.md#bearerAuth)
135
-
136
- ### HTTP request headers
137
-
138
- - **Content-Type**: Not defined
139
- - **Accept**: application/json
140
-
141
-
142
- ## cloud_providers_provider_id_delete
143
-
144
- > Object cloud_providers_provider_id_delete(provider_id)
145
-
146
- Delete single cloud provider by ID
147
-
148
- ### Examples
149
-
150
- ```ruby
151
- require 'time'
152
- require 'spartera_api_sdk'
153
- # setup authorization
154
- SparteraApiSdk.configure do |config|
155
- # Configure Bearer authorization (JWT): bearerAuth
156
- config.access_token = 'YOUR_BEARER_TOKEN'
157
- end
158
-
159
- api_instance = SparteraApiSdk::CloudProvidersApi.new
160
- provider_id = 'provider_id_example' # String |
161
-
162
- begin
163
- # Delete single cloud provider by ID
164
- result = api_instance.cloud_providers_provider_id_delete(provider_id)
165
- p result
166
- rescue SparteraApiSdk::ApiError => e
167
- puts "Error when calling CloudProvidersApi->cloud_providers_provider_id_delete: #{e}"
168
- end
169
- ```
170
-
171
- #### Using the cloud_providers_provider_id_delete_with_http_info variant
172
-
173
- This returns an Array which contains the response data, status code and headers.
174
-
175
- > <Array(Object, Integer, Hash)> cloud_providers_provider_id_delete_with_http_info(provider_id)
176
-
177
- ```ruby
178
- begin
179
- # Delete single cloud provider by ID
180
- data, status_code, headers = api_instance.cloud_providers_provider_id_delete_with_http_info(provider_id)
181
- p status_code # => 2xx
182
- p headers # => { ... }
183
- p data # => Object
184
- rescue SparteraApiSdk::ApiError => e
185
- puts "Error when calling CloudProvidersApi->cloud_providers_provider_id_delete_with_http_info: #{e}"
186
- end
187
- ```
188
-
189
- ### Parameters
190
-
191
- | Name | Type | Description | Notes |
192
- | ---- | ---- | ----------- | ----- |
193
- | **provider_id** | **String** | | |
194
-
195
- ### Return type
196
-
197
- **Object**
198
-
199
- ### Authorization
200
-
201
- [bearerAuth](../README.md#bearerAuth)
69
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
202
70
 
203
71
  ### HTTP request headers
204
72
 
@@ -219,8 +87,10 @@ require 'time'
219
87
  require 'spartera_api_sdk'
220
88
  # setup authorization
221
89
  SparteraApiSdk.configure do |config|
222
- # Configure Bearer authorization (JWT): bearerAuth
223
- config.access_token = 'YOUR_BEARER_TOKEN'
90
+ # Configure API key authorization: ApiKeyAuth
91
+ config.api_key['x-api-key'] = 'YOUR API KEY'
92
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
93
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
224
94
  end
225
95
 
226
96
  api_instance = SparteraApiSdk::CloudProvidersApi.new
@@ -265,74 +135,7 @@ end
265
135
 
266
136
  ### Authorization
267
137
 
268
- [bearerAuth](../README.md#bearerAuth)
269
-
270
- ### HTTP request headers
271
-
272
- - **Content-Type**: Not defined
273
- - **Accept**: application/json
274
-
275
-
276
- ## cloud_providers_provider_id_patch
277
-
278
- > Object cloud_providers_provider_id_patch(provider_id)
279
-
280
- Update an existing cloud provider by ID
281
-
282
- ### Examples
283
-
284
- ```ruby
285
- require 'time'
286
- require 'spartera_api_sdk'
287
- # setup authorization
288
- SparteraApiSdk.configure do |config|
289
- # Configure Bearer authorization (JWT): bearerAuth
290
- config.access_token = 'YOUR_BEARER_TOKEN'
291
- end
292
-
293
- api_instance = SparteraApiSdk::CloudProvidersApi.new
294
- provider_id = 'provider_id_example' # String |
295
-
296
- begin
297
- # Update an existing cloud provider by ID
298
- result = api_instance.cloud_providers_provider_id_patch(provider_id)
299
- p result
300
- rescue SparteraApiSdk::ApiError => e
301
- puts "Error when calling CloudProvidersApi->cloud_providers_provider_id_patch: #{e}"
302
- end
303
- ```
304
-
305
- #### Using the cloud_providers_provider_id_patch_with_http_info variant
306
-
307
- This returns an Array which contains the response data, status code and headers.
308
-
309
- > <Array(Object, Integer, Hash)> cloud_providers_provider_id_patch_with_http_info(provider_id)
310
-
311
- ```ruby
312
- begin
313
- # Update an existing cloud provider by ID
314
- data, status_code, headers = api_instance.cloud_providers_provider_id_patch_with_http_info(provider_id)
315
- p status_code # => 2xx
316
- p headers # => { ... }
317
- p data # => Object
318
- rescue SparteraApiSdk::ApiError => e
319
- puts "Error when calling CloudProvidersApi->cloud_providers_provider_id_patch_with_http_info: #{e}"
320
- end
321
- ```
322
-
323
- ### Parameters
324
-
325
- | Name | Type | Description | Notes |
326
- | ---- | ---- | ----------- | ----- |
327
- | **provider_id** | **String** | | |
328
-
329
- ### Return type
330
-
331
- **Object**
332
-
333
- ### Authorization
334
-
335
- [bearerAuth](../README.md#bearerAuth)
138
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
336
139
 
337
140
  ### HTTP request headers
338
141
 
data/docs/CompaniesApi.md CHANGED
@@ -28,8 +28,10 @@ require 'time'
28
28
  require 'spartera_api_sdk'
29
29
  # setup authorization
30
30
  SparteraApiSdk.configure do |config|
31
- # Configure Bearer authorization (JWT): bearerAuth
32
- config.access_token = 'YOUR_BEARER_TOKEN'
31
+ # Configure API key authorization: ApiKeyAuth
32
+ config.api_key['x-api-key'] = 'YOUR API KEY'
33
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
34
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
33
35
  end
34
36
 
35
37
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -74,7 +76,7 @@ end
74
76
 
75
77
  ### Authorization
76
78
 
77
- [bearerAuth](../README.md#bearerAuth)
79
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
78
80
 
79
81
  ### HTTP request headers
80
82
 
@@ -95,8 +97,10 @@ require 'time'
95
97
  require 'spartera_api_sdk'
96
98
  # setup authorization
97
99
  SparteraApiSdk.configure do |config|
98
- # Configure Bearer authorization (JWT): bearerAuth
99
- config.access_token = 'YOUR_BEARER_TOKEN'
100
+ # Configure API key authorization: ApiKeyAuth
101
+ config.api_key['x-api-key'] = 'YOUR API KEY'
102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
100
104
  end
101
105
 
102
106
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -141,7 +145,7 @@ end
141
145
 
142
146
  ### Authorization
143
147
 
144
- [bearerAuth](../README.md#bearerAuth)
148
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
145
149
 
146
150
  ### HTTP request headers
147
151
 
@@ -162,8 +166,10 @@ require 'time'
162
166
  require 'spartera_api_sdk'
163
167
  # setup authorization
164
168
  SparteraApiSdk.configure do |config|
165
- # Configure Bearer authorization (JWT): bearerAuth
166
- config.access_token = 'YOUR_BEARER_TOKEN'
169
+ # Configure API key authorization: ApiKeyAuth
170
+ config.api_key['x-api-key'] = 'YOUR API KEY'
171
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
172
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
167
173
  end
168
174
 
169
175
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -208,7 +214,7 @@ end
208
214
 
209
215
  ### Authorization
210
216
 
211
- [bearerAuth](../README.md#bearerAuth)
217
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
212
218
 
213
219
  ### HTTP request headers
214
220
 
@@ -229,8 +235,10 @@ require 'time'
229
235
  require 'spartera_api_sdk'
230
236
  # setup authorization
231
237
  SparteraApiSdk.configure do |config|
232
- # Configure Bearer authorization (JWT): bearerAuth
233
- config.access_token = 'YOUR_BEARER_TOKEN'
238
+ # Configure API key authorization: ApiKeyAuth
239
+ config.api_key['x-api-key'] = 'YOUR API KEY'
240
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
241
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
234
242
  end
235
243
 
236
244
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -275,7 +283,7 @@ end
275
283
 
276
284
  ### Authorization
277
285
 
278
- [bearerAuth](../README.md#bearerAuth)
286
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
279
287
 
280
288
  ### HTTP request headers
281
289
 
@@ -296,8 +304,10 @@ require 'time'
296
304
  require 'spartera_api_sdk'
297
305
  # setup authorization
298
306
  SparteraApiSdk.configure do |config|
299
- # Configure Bearer authorization (JWT): bearerAuth
300
- config.access_token = 'YOUR_BEARER_TOKEN'
307
+ # Configure API key authorization: ApiKeyAuth
308
+ config.api_key['x-api-key'] = 'YOUR API KEY'
309
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
310
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
301
311
  end
302
312
 
303
313
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -342,7 +352,7 @@ end
342
352
 
343
353
  ### Authorization
344
354
 
345
- [bearerAuth](../README.md#bearerAuth)
355
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
346
356
 
347
357
  ### HTTP request headers
348
358
 
@@ -363,8 +373,10 @@ require 'time'
363
373
  require 'spartera_api_sdk'
364
374
  # setup authorization
365
375
  SparteraApiSdk.configure do |config|
366
- # Configure Bearer authorization (JWT): bearerAuth
367
- config.access_token = 'YOUR_BEARER_TOKEN'
376
+ # Configure API key authorization: ApiKeyAuth
377
+ config.api_key['x-api-key'] = 'YOUR API KEY'
378
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
379
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
368
380
  end
369
381
 
370
382
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -409,7 +421,7 @@ end
409
421
 
410
422
  ### Authorization
411
423
 
412
- [bearerAuth](../README.md#bearerAuth)
424
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
413
425
 
414
426
  ### HTTP request headers
415
427
 
@@ -430,8 +442,10 @@ require 'time'
430
442
  require 'spartera_api_sdk'
431
443
  # setup authorization
432
444
  SparteraApiSdk.configure do |config|
433
- # Configure Bearer authorization (JWT): bearerAuth
434
- config.access_token = 'YOUR_BEARER_TOKEN'
445
+ # Configure API key authorization: ApiKeyAuth
446
+ config.api_key['x-api-key'] = 'YOUR API KEY'
447
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
448
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
435
449
  end
436
450
 
437
451
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -476,7 +490,7 @@ end
476
490
 
477
491
  ### Authorization
478
492
 
479
- [bearerAuth](../README.md#bearerAuth)
493
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
480
494
 
481
495
  ### HTTP request headers
482
496
 
@@ -497,8 +511,10 @@ require 'time'
497
511
  require 'spartera_api_sdk'
498
512
  # setup authorization
499
513
  SparteraApiSdk.configure do |config|
500
- # Configure Bearer authorization (JWT): bearerAuth
501
- config.access_token = 'YOUR_BEARER_TOKEN'
514
+ # Configure API key authorization: ApiKeyAuth
515
+ config.api_key['x-api-key'] = 'YOUR API KEY'
516
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
517
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
502
518
  end
503
519
 
504
520
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -543,7 +559,7 @@ end
543
559
 
544
560
  ### Authorization
545
561
 
546
- [bearerAuth](../README.md#bearerAuth)
562
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
547
563
 
548
564
  ### HTTP request headers
549
565
 
@@ -564,8 +580,10 @@ require 'time'
564
580
  require 'spartera_api_sdk'
565
581
  # setup authorization
566
582
  SparteraApiSdk.configure do |config|
567
- # Configure Bearer authorization (JWT): bearerAuth
568
- config.access_token = 'YOUR_BEARER_TOKEN'
583
+ # Configure API key authorization: ApiKeyAuth
584
+ config.api_key['x-api-key'] = 'YOUR API KEY'
585
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
586
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
569
587
  end
570
588
 
571
589
  api_instance = SparteraApiSdk::CompaniesApi.new
@@ -610,7 +628,7 @@ end
610
628
 
611
629
  ### Authorization
612
630
 
613
- [bearerAuth](../README.md#bearerAuth)
631
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
614
632
 
615
633
  ### HTTP request headers
616
634
 
@@ -8,7 +8,7 @@ All URIs are relative to *https://api.spartera.com*
8
8
  | [**companies_company_id_connections_connection_id_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_get) | **GET** /companies/{company_id}/connections/{connection_id} | Get single connection by ID |
9
9
  | [**companies_company_id_connections_connection_id_infoschema_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_infoschema_get) | **GET** /companies/{company_id}/connections/{connection_id}/infoschema | Retrieve the information schema for the specified connection |
10
10
  | [**companies_company_id_connections_connection_id_patch**](ConnectionsApi.md#companies_company_id_connections_connection_id_patch) | **PATCH** /companies/{company_id}/connections/{connection_id} | Update an existing connection by ID |
11
- | [**companies_company_id_connections_connection_id_test_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_test_get) | **GET** /companies/{company_id}/connections/{connection_id}/test | Verify the specified connection to ensure it is functioning correctly |
11
+ | [**companies_company_id_connections_connection_id_test_get**](ConnectionsApi.md#companies_company_id_connections_connection_id_test_get) | **GET** /companies/{company_id}/connections/{connection_id}/test | Test the specified connection |
12
12
  | [**companies_company_id_connections_get**](ConnectionsApi.md#companies_company_id_connections_get) | **GET** /companies/{company_id}/connections | Get all connections for a specific company |
13
13
  | [**companies_company_id_connections_post**](ConnectionsApi.md#companies_company_id_connections_post) | **POST** /companies/{company_id}/connections | Create a new connection by ID |
14
14
 
@@ -26,8 +26,10 @@ require 'time'
26
26
  require 'spartera_api_sdk'
27
27
  # setup authorization
28
28
  SparteraApiSdk.configure do |config|
29
- # Configure Bearer authorization (JWT): bearerAuth
30
- config.access_token = 'YOUR_BEARER_TOKEN'
29
+ # Configure API key authorization: ApiKeyAuth
30
+ config.api_key['x-api-key'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
31
33
  end
32
34
 
33
35
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -74,7 +76,7 @@ end
74
76
 
75
77
  ### Authorization
76
78
 
77
- [bearerAuth](../README.md#bearerAuth)
79
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
78
80
 
79
81
  ### HTTP request headers
80
82
 
@@ -95,8 +97,10 @@ require 'time'
95
97
  require 'spartera_api_sdk'
96
98
  # setup authorization
97
99
  SparteraApiSdk.configure do |config|
98
- # Configure Bearer authorization (JWT): bearerAuth
99
- config.access_token = 'YOUR_BEARER_TOKEN'
100
+ # Configure API key authorization: ApiKeyAuth
101
+ config.api_key['x-api-key'] = 'YOUR API KEY'
102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
100
104
  end
101
105
 
102
106
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -143,7 +147,7 @@ end
143
147
 
144
148
  ### Authorization
145
149
 
146
- [bearerAuth](../README.md#bearerAuth)
150
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
147
151
 
148
152
  ### HTTP request headers
149
153
 
@@ -164,8 +168,10 @@ require 'time'
164
168
  require 'spartera_api_sdk'
165
169
  # setup authorization
166
170
  SparteraApiSdk.configure do |config|
167
- # Configure Bearer authorization (JWT): bearerAuth
168
- config.access_token = 'YOUR_BEARER_TOKEN'
171
+ # Configure API key authorization: ApiKeyAuth
172
+ config.api_key['x-api-key'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
169
175
  end
170
176
 
171
177
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -212,7 +218,7 @@ end
212
218
 
213
219
  ### Authorization
214
220
 
215
- [bearerAuth](../README.md#bearerAuth)
221
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
216
222
 
217
223
  ### HTTP request headers
218
224
 
@@ -233,8 +239,10 @@ require 'time'
233
239
  require 'spartera_api_sdk'
234
240
  # setup authorization
235
241
  SparteraApiSdk.configure do |config|
236
- # Configure Bearer authorization (JWT): bearerAuth
237
- config.access_token = 'YOUR_BEARER_TOKEN'
242
+ # Configure API key authorization: ApiKeyAuth
243
+ config.api_key['x-api-key'] = 'YOUR API KEY'
244
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
245
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
238
246
  end
239
247
 
240
248
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -283,7 +291,7 @@ end
283
291
 
284
292
  ### Authorization
285
293
 
286
- [bearerAuth](../README.md#bearerAuth)
294
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
287
295
 
288
296
  ### HTTP request headers
289
297
 
@@ -295,7 +303,7 @@ end
295
303
 
296
304
  > Object companies_company_id_connections_connection_id_test_get(company_id, connection_id)
297
305
 
298
- Verify the specified connection to ensure it is functioning correctly
306
+ Test the specified connection
299
307
 
300
308
  ### Examples
301
309
 
@@ -304,8 +312,10 @@ require 'time'
304
312
  require 'spartera_api_sdk'
305
313
  # setup authorization
306
314
  SparteraApiSdk.configure do |config|
307
- # Configure Bearer authorization (JWT): bearerAuth
308
- config.access_token = 'YOUR_BEARER_TOKEN'
315
+ # Configure API key authorization: ApiKeyAuth
316
+ config.api_key['x-api-key'] = 'YOUR API KEY'
317
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
318
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
309
319
  end
310
320
 
311
321
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -313,7 +323,7 @@ company_id = 'company_id_example' # String |
313
323
  connection_id = 'connection_id_example' # String |
314
324
 
315
325
  begin
316
- # Verify the specified connection to ensure it is functioning correctly
326
+ # Test the specified connection
317
327
  result = api_instance.companies_company_id_connections_connection_id_test_get(company_id, connection_id)
318
328
  p result
319
329
  rescue SparteraApiSdk::ApiError => e
@@ -329,7 +339,7 @@ This returns an Array which contains the response data, status code and headers.
329
339
 
330
340
  ```ruby
331
341
  begin
332
- # Verify the specified connection to ensure it is functioning correctly
342
+ # Test the specified connection
333
343
  data, status_code, headers = api_instance.companies_company_id_connections_connection_id_test_get_with_http_info(company_id, connection_id)
334
344
  p status_code # => 2xx
335
345
  p headers # => { ... }
@@ -352,7 +362,7 @@ end
352
362
 
353
363
  ### Authorization
354
364
 
355
- [bearerAuth](../README.md#bearerAuth)
365
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
356
366
 
357
367
  ### HTTP request headers
358
368
 
@@ -373,8 +383,10 @@ require 'time'
373
383
  require 'spartera_api_sdk'
374
384
  # setup authorization
375
385
  SparteraApiSdk.configure do |config|
376
- # Configure Bearer authorization (JWT): bearerAuth
377
- config.access_token = 'YOUR_BEARER_TOKEN'
386
+ # Configure API key authorization: ApiKeyAuth
387
+ config.api_key['x-api-key'] = 'YOUR API KEY'
388
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
389
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
378
390
  end
379
391
 
380
392
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -419,7 +431,7 @@ end
419
431
 
420
432
  ### Authorization
421
433
 
422
- [bearerAuth](../README.md#bearerAuth)
434
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
423
435
 
424
436
  ### HTTP request headers
425
437
 
@@ -440,8 +452,10 @@ require 'time'
440
452
  require 'spartera_api_sdk'
441
453
  # setup authorization
442
454
  SparteraApiSdk.configure do |config|
443
- # Configure Bearer authorization (JWT): bearerAuth
444
- config.access_token = 'YOUR_BEARER_TOKEN'
455
+ # Configure API key authorization: ApiKeyAuth
456
+ config.api_key['x-api-key'] = 'YOUR API KEY'
457
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
458
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
445
459
  end
446
460
 
447
461
  api_instance = SparteraApiSdk::ConnectionsApi.new
@@ -488,7 +502,7 @@ end
488
502
 
489
503
  ### Authorization
490
504
 
491
- [bearerAuth](../README.md#bearerAuth)
505
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
492
506
 
493
507
  ### HTTP request headers
494
508