DealMakerAPI 0.83.1 → 0.83.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -5
- data/docs/CompanyApi.md +214 -1
- data/docs/CreateBulkUploadRequest.md +3 -1
- data/docs/V1EntitiesBulkUpload.md +2 -0
- data/docs/V1EntitiesBulkUploadDetails.md +18 -0
- data/docs/V1EntitiesBulkUploads.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +210 -0
- data/lib/DealMakerAPI/configuration.rb +9 -7
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +21 -4
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +11 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_details.rb +215 -0
- data/lib/DealMakerAPI/models/v1_entities_bulk_uploads.rb +215 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +2 -0
- data/spec/api/company_api_spec.rb +41 -0
- data/spec/models/create_bulk_upload_request_spec.rb +6 -0
- data/spec/models/v1_entities_bulk_upload_details_spec.rb +34 -0
- data/spec/models/v1_entities_bulk_upload_spec.rb +6 -0
- data/spec/models/v1_entities_bulk_uploads_spec.rb +34 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 11d72fc324c0c232b2d318959a5544bfd10d15fce4c5d16bb4eb6287c6a87f2b
|
4
|
+
data.tar.gz: c97056a777e441ab5dc616e48b8c0229130df7124e862f8b7f839189a5690770
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a81f17e42b94f664b584876f60fe0af58aebd58ed1ffd6898afd2dba703240f9eb1c78aa75d19c9be9fe0b7e6091cb93df64b25225bb1e6eb45fc4b738a5ce56
|
7
|
+
data.tar.gz: 13a6eb47dec0dd9b29e599a4aa7a14c520d8f031ce65d53516d2484d08172f72b86fdbdb38e7e6fd8b4ed698148784f473ea951d8f205a12b1d528314c045609
|
data/README.md
CHANGED
@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
|
|
338
338
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
339
339
|
|
340
340
|
- API version: 1.75.0
|
341
|
-
- Package version: 0.83.
|
341
|
+
- Package version: 0.83.3
|
342
342
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
343
343
|
|
344
344
|
## Installation
|
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
|
|
354
354
|
Then either install the gem locally:
|
355
355
|
|
356
356
|
```shell
|
357
|
-
gem install ./DealMakerAPI-0.83.
|
357
|
+
gem install ./DealMakerAPI-0.83.3.gem
|
358
358
|
```
|
359
359
|
|
360
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.83.
|
360
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.83.3.gem` to install the development dependencies)
|
361
361
|
|
362
362
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
363
363
|
|
364
364
|
Finally add this to the Gemfile:
|
365
365
|
|
366
|
-
gem 'DealMakerAPI', '~> 0.83.
|
366
|
+
gem 'DealMakerAPI', '~> 0.83.3'
|
367
367
|
|
368
368
|
### Install from Git
|
369
369
|
|
@@ -392,7 +392,7 @@ DealMakerAPI.configure do |config|end
|
|
392
392
|
|
393
393
|
api_instance = DealMakerAPI::CompanyApi.new
|
394
394
|
id = 56 # Integer | The company id
|
395
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
395
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example'}) # CreateBulkUploadRequest |
|
396
396
|
|
397
397
|
begin
|
398
398
|
#Create bulk upload record
|
@@ -413,6 +413,9 @@ Class | Method | HTTP request | Description
|
|
413
413
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
414
414
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload_detail**](docs/CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record
|
415
415
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
416
|
+
*DealMakerAPI::CompanyApi* | [**get_bulk_upload_details**](docs/CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc
|
417
|
+
*DealMakerAPI::CompanyApi* | [**get_bulk_upload_details_by_status**](docs/CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status
|
418
|
+
*DealMakerAPI::CompanyApi* | [**get_bulk_uploads**](docs/CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads
|
416
419
|
*DealMakerAPI::CompanyApi* | [**get_companies**](docs/CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies
|
417
420
|
*DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
|
418
421
|
*DealMakerAPI::DealApi* | [**get_analytics_dashboard_info**](docs/DealApi.md#get_analytics_dashboard_info) | **GET** /deals/{id}/analytics_dashboard_info | Get Analytics Dashboard Info
|
@@ -483,6 +486,8 @@ Class | Method | HTTP request | Description
|
|
483
486
|
- [DealMakerAPI::V1EntitiesBackgroundCheckSearch](docs/V1EntitiesBackgroundCheckSearch.md)
|
484
487
|
- [DealMakerAPI::V1EntitiesBulkUpload](docs/V1EntitiesBulkUpload.md)
|
485
488
|
- [DealMakerAPI::V1EntitiesBulkUploadDetail](docs/V1EntitiesBulkUploadDetail.md)
|
489
|
+
- [DealMakerAPI::V1EntitiesBulkUploadDetails](docs/V1EntitiesBulkUploadDetails.md)
|
490
|
+
- [DealMakerAPI::V1EntitiesBulkUploads](docs/V1EntitiesBulkUploads.md)
|
486
491
|
- [DealMakerAPI::V1EntitiesCompany](docs/V1EntitiesCompany.md)
|
487
492
|
- [DealMakerAPI::V1EntitiesCompanyDeal](docs/V1EntitiesCompanyDeal.md)
|
488
493
|
- [DealMakerAPI::V1EntitiesCompanyDeals](docs/V1EntitiesCompanyDeals.md)
|
data/docs/CompanyApi.md
CHANGED
@@ -7,6 +7,9 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
7
7
|
| [**create_bulk_upload**](CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record |
|
8
8
|
| [**create_bulk_upload_detail**](CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record |
|
9
9
|
| [**create_company**](CompanyApi.md#create_company) | **POST** /companies | Create new company |
|
10
|
+
| [**get_bulk_upload_details**](CompanyApi.md#get_bulk_upload_details) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Return full list of bulk upload details order by status desc and id asc |
|
11
|
+
| [**get_bulk_upload_details_by_status**](CompanyApi.md#get_bulk_upload_details_by_status) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status | Return bulk upload details grouped by status |
|
12
|
+
| [**get_bulk_uploads**](CompanyApi.md#get_bulk_uploads) | **GET** /companies/{id}/documents/bulk_uploads | Return bulk uploads |
|
10
13
|
| [**get_companies**](CompanyApi.md#get_companies) | **GET** /companies | Get list of Companies |
|
11
14
|
| [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
|
12
15
|
|
@@ -29,7 +32,7 @@ DealMakerAPI.configure do |config|end
|
|
29
32
|
|
30
33
|
api_instance = DealMakerAPI::CompanyApi.new
|
31
34
|
id = 56 # Integer | The company id
|
32
|
-
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example'}) # CreateBulkUploadRequest |
|
35
|
+
create_bulk_upload_request = DealMakerAPI::CreateBulkUploadRequest.new({file_identifier: 'file_identifier_example', document_type: 'document_type_example', upload_name: 'upload_name_example'}) # CreateBulkUploadRequest |
|
33
36
|
|
34
37
|
begin
|
35
38
|
# Create bulk upload record
|
@@ -215,6 +218,216 @@ No authorization required
|
|
215
218
|
- **Accept**: application/json
|
216
219
|
|
217
220
|
|
221
|
+
## get_bulk_upload_details
|
222
|
+
|
223
|
+
> <V1EntitiesBulkUploadDetails> get_bulk_upload_details(company_id, bulk_upload_id)
|
224
|
+
|
225
|
+
Return full list of bulk upload details order by status desc and id asc
|
226
|
+
|
227
|
+
Return full list of bulk upload details
|
228
|
+
|
229
|
+
### Examples
|
230
|
+
|
231
|
+
```ruby
|
232
|
+
require 'time'
|
233
|
+
require 'DealMakerAPI'
|
234
|
+
# setup authorization
|
235
|
+
DealMakerAPI.configure do |config|end
|
236
|
+
|
237
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
238
|
+
company_id = 56 # Integer |
|
239
|
+
bulk_upload_id = 56 # Integer |
|
240
|
+
|
241
|
+
begin
|
242
|
+
# Return full list of bulk upload details order by status desc and id asc
|
243
|
+
result = api_instance.get_bulk_upload_details(company_id, bulk_upload_id)
|
244
|
+
p result
|
245
|
+
rescue DealMakerAPI::ApiError => e
|
246
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details: #{e}"
|
247
|
+
end
|
248
|
+
```
|
249
|
+
|
250
|
+
#### Using the get_bulk_upload_details_with_http_info variant
|
251
|
+
|
252
|
+
This returns an Array which contains the response data, status code and headers.
|
253
|
+
|
254
|
+
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_with_http_info(company_id, bulk_upload_id)
|
255
|
+
|
256
|
+
```ruby
|
257
|
+
begin
|
258
|
+
# Return full list of bulk upload details order by status desc and id asc
|
259
|
+
data, status_code, headers = api_instance.get_bulk_upload_details_with_http_info(company_id, bulk_upload_id)
|
260
|
+
p status_code # => 2xx
|
261
|
+
p headers # => { ... }
|
262
|
+
p data # => <V1EntitiesBulkUploadDetails>
|
263
|
+
rescue DealMakerAPI::ApiError => e
|
264
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details_with_http_info: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
### Parameters
|
269
|
+
|
270
|
+
| Name | Type | Description | Notes |
|
271
|
+
| ---- | ---- | ----------- | ----- |
|
272
|
+
| **company_id** | **Integer** | | |
|
273
|
+
| **bulk_upload_id** | **Integer** | | |
|
274
|
+
|
275
|
+
### Return type
|
276
|
+
|
277
|
+
[**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
|
278
|
+
|
279
|
+
### Authorization
|
280
|
+
|
281
|
+
No authorization required
|
282
|
+
|
283
|
+
### HTTP request headers
|
284
|
+
|
285
|
+
- **Content-Type**: Not defined
|
286
|
+
- **Accept**: application/json
|
287
|
+
|
288
|
+
|
289
|
+
## get_bulk_upload_details_by_status
|
290
|
+
|
291
|
+
> <V1EntitiesBulkUploadDetails> get_bulk_upload_details_by_status(company_id, bulk_upload_id)
|
292
|
+
|
293
|
+
Return bulk upload details grouped by status
|
294
|
+
|
295
|
+
Return bulk upload details grouped by status
|
296
|
+
|
297
|
+
### Examples
|
298
|
+
|
299
|
+
```ruby
|
300
|
+
require 'time'
|
301
|
+
require 'DealMakerAPI'
|
302
|
+
# setup authorization
|
303
|
+
DealMakerAPI.configure do |config|end
|
304
|
+
|
305
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
306
|
+
company_id = 56 # Integer |
|
307
|
+
bulk_upload_id = 56 # Integer |
|
308
|
+
|
309
|
+
begin
|
310
|
+
# Return bulk upload details grouped by status
|
311
|
+
result = api_instance.get_bulk_upload_details_by_status(company_id, bulk_upload_id)
|
312
|
+
p result
|
313
|
+
rescue DealMakerAPI::ApiError => e
|
314
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details_by_status: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
#### Using the get_bulk_upload_details_by_status_with_http_info variant
|
319
|
+
|
320
|
+
This returns an Array which contains the response data, status code and headers.
|
321
|
+
|
322
|
+
> <Array(<V1EntitiesBulkUploadDetails>, Integer, Hash)> get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
|
323
|
+
|
324
|
+
```ruby
|
325
|
+
begin
|
326
|
+
# Return bulk upload details grouped by status
|
327
|
+
data, status_code, headers = api_instance.get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id)
|
328
|
+
p status_code # => 2xx
|
329
|
+
p headers # => { ... }
|
330
|
+
p data # => <V1EntitiesBulkUploadDetails>
|
331
|
+
rescue DealMakerAPI::ApiError => e
|
332
|
+
puts "Error when calling CompanyApi->get_bulk_upload_details_by_status_with_http_info: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### Parameters
|
337
|
+
|
338
|
+
| Name | Type | Description | Notes |
|
339
|
+
| ---- | ---- | ----------- | ----- |
|
340
|
+
| **company_id** | **Integer** | | |
|
341
|
+
| **bulk_upload_id** | **Integer** | | |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
[**V1EntitiesBulkUploadDetails**](V1EntitiesBulkUploadDetails.md)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
No authorization required
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: application/json
|
355
|
+
|
356
|
+
|
357
|
+
## get_bulk_uploads
|
358
|
+
|
359
|
+
> <V1EntitiesBulkUploads> get_bulk_uploads(id, opts)
|
360
|
+
|
361
|
+
Return bulk uploads
|
362
|
+
|
363
|
+
Return bulk uploads
|
364
|
+
|
365
|
+
### Examples
|
366
|
+
|
367
|
+
```ruby
|
368
|
+
require 'time'
|
369
|
+
require 'DealMakerAPI'
|
370
|
+
# setup authorization
|
371
|
+
DealMakerAPI.configure do |config|end
|
372
|
+
|
373
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
374
|
+
id = 56 # Integer |
|
375
|
+
opts = {
|
376
|
+
page: 56, # Integer | Page offset to fetch.
|
377
|
+
per_page: 56, # Integer | Number of results to return per page.
|
378
|
+
offset: 56 # Integer | Pad a number of results.
|
379
|
+
}
|
380
|
+
|
381
|
+
begin
|
382
|
+
# Return bulk uploads
|
383
|
+
result = api_instance.get_bulk_uploads(id, opts)
|
384
|
+
p result
|
385
|
+
rescue DealMakerAPI::ApiError => e
|
386
|
+
puts "Error when calling CompanyApi->get_bulk_uploads: #{e}"
|
387
|
+
end
|
388
|
+
```
|
389
|
+
|
390
|
+
#### Using the get_bulk_uploads_with_http_info variant
|
391
|
+
|
392
|
+
This returns an Array which contains the response data, status code and headers.
|
393
|
+
|
394
|
+
> <Array(<V1EntitiesBulkUploads>, Integer, Hash)> get_bulk_uploads_with_http_info(id, opts)
|
395
|
+
|
396
|
+
```ruby
|
397
|
+
begin
|
398
|
+
# Return bulk uploads
|
399
|
+
data, status_code, headers = api_instance.get_bulk_uploads_with_http_info(id, opts)
|
400
|
+
p status_code # => 2xx
|
401
|
+
p headers # => { ... }
|
402
|
+
p data # => <V1EntitiesBulkUploads>
|
403
|
+
rescue DealMakerAPI::ApiError => e
|
404
|
+
puts "Error when calling CompanyApi->get_bulk_uploads_with_http_info: #{e}"
|
405
|
+
end
|
406
|
+
```
|
407
|
+
|
408
|
+
### Parameters
|
409
|
+
|
410
|
+
| Name | Type | Description | Notes |
|
411
|
+
| ---- | ---- | ----------- | ----- |
|
412
|
+
| **id** | **Integer** | | |
|
413
|
+
| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
|
414
|
+
| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
|
415
|
+
| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
|
416
|
+
|
417
|
+
### Return type
|
418
|
+
|
419
|
+
[**V1EntitiesBulkUploads**](V1EntitiesBulkUploads.md)
|
420
|
+
|
421
|
+
### Authorization
|
422
|
+
|
423
|
+
No authorization required
|
424
|
+
|
425
|
+
### HTTP request headers
|
426
|
+
|
427
|
+
- **Content-Type**: Not defined
|
428
|
+
- **Accept**: application/json
|
429
|
+
|
430
|
+
|
218
431
|
## get_companies
|
219
432
|
|
220
433
|
> <V1EntitiesCompany> get_companies(opts)
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **file_identifier** | **String** | The file identifier | |
|
8
8
|
| **document_type** | **String** | The document type | |
|
9
|
+
| **upload_name** | **String** | The bulk upload name | |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'DealMakerAPI'
|
|
14
15
|
|
15
16
|
instance = DealMakerAPI::CreateBulkUploadRequest.new(
|
16
17
|
file_identifier: null,
|
17
|
-
document_type: null
|
18
|
+
document_type: null,
|
19
|
+
upload_name: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
@@ -8,6 +8,7 @@
|
|
8
8
|
| **company_id** | **Integer** | The company ID | [optional] |
|
9
9
|
| **file_identifier** | **String** | The file identifier [shareholder, investor] | [optional] |
|
10
10
|
| **document_type** | **String** | The document type [drs_statement, shareholder_statement, book_entry_statement] | [optional] |
|
11
|
+
| **upload_name** | **String** | The bulk upload name | [optional] |
|
11
12
|
| **status** | **String** | The status [pending, processing, completed, failed] | [optional] |
|
12
13
|
| **created_at** | **String** | The created at timestamp | [optional] |
|
13
14
|
| **updated_at** | **String** | The updated at timestamp | [optional] |
|
@@ -22,6 +23,7 @@ instance = DealMakerAPI::V1EntitiesBulkUpload.new(
|
|
22
23
|
company_id: null,
|
23
24
|
file_identifier: null,
|
24
25
|
document_type: null,
|
26
|
+
upload_name: null,
|
25
27
|
status: null,
|
26
28
|
created_at: null,
|
27
29
|
updated_at: null
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesBulkUploadDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesBulkUploadDetail**](V1EntitiesBulkUploadDetail.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesBulkUploadDetails.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesBulkUploads
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesBulkUpload**](V1EntitiesBulkUpload.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesBulkUploads.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -241,6 +241,216 @@ module DealMakerAPI
|
|
241
241
|
return data, status_code, headers
|
242
242
|
end
|
243
243
|
|
244
|
+
# Return full list of bulk upload details order by status desc and id asc
|
245
|
+
# Return full list of bulk upload details
|
246
|
+
# @param company_id [Integer]
|
247
|
+
# @param bulk_upload_id [Integer]
|
248
|
+
# @param [Hash] opts the optional parameters
|
249
|
+
# @return [V1EntitiesBulkUploadDetails]
|
250
|
+
def get_bulk_upload_details(company_id, bulk_upload_id, opts = {})
|
251
|
+
data, _status_code, _headers = get_bulk_upload_details_with_http_info(company_id, bulk_upload_id, opts)
|
252
|
+
data
|
253
|
+
end
|
254
|
+
|
255
|
+
# Return full list of bulk upload details order by status desc and id asc
|
256
|
+
# Return full list of bulk upload details
|
257
|
+
# @param company_id [Integer]
|
258
|
+
# @param bulk_upload_id [Integer]
|
259
|
+
# @param [Hash] opts the optional parameters
|
260
|
+
# @return [Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>] V1EntitiesBulkUploadDetails data, response status code and response headers
|
261
|
+
def get_bulk_upload_details_with_http_info(company_id, bulk_upload_id, opts = {})
|
262
|
+
if @api_client.config.debugging
|
263
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_upload_details ...'
|
264
|
+
end
|
265
|
+
# verify the required parameter 'company_id' is set
|
266
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
267
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_bulk_upload_details"
|
268
|
+
end
|
269
|
+
# verify the required parameter 'bulk_upload_id' is set
|
270
|
+
if @api_client.config.client_side_validation && bulk_upload_id.nil?
|
271
|
+
fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_bulk_upload_details"
|
272
|
+
end
|
273
|
+
# resource path
|
274
|
+
local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s))
|
275
|
+
|
276
|
+
# query parameters
|
277
|
+
query_params = opts[:query_params] || {}
|
278
|
+
|
279
|
+
# header parameters
|
280
|
+
header_params = opts[:header_params] || {}
|
281
|
+
# HTTP header 'Accept' (if needed)
|
282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
283
|
+
|
284
|
+
# form parameters
|
285
|
+
form_params = opts[:form_params] || {}
|
286
|
+
|
287
|
+
# http body (model)
|
288
|
+
post_body = opts[:debug_body]
|
289
|
+
|
290
|
+
# return_type
|
291
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploadDetails'
|
292
|
+
|
293
|
+
# auth_names
|
294
|
+
auth_names = opts[:debug_auth_names] || []
|
295
|
+
|
296
|
+
new_options = opts.merge(
|
297
|
+
:operation => :"CompanyApi.get_bulk_upload_details",
|
298
|
+
:header_params => header_params,
|
299
|
+
:query_params => query_params,
|
300
|
+
:form_params => form_params,
|
301
|
+
:body => post_body,
|
302
|
+
:auth_names => auth_names,
|
303
|
+
:return_type => return_type
|
304
|
+
)
|
305
|
+
|
306
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
307
|
+
if @api_client.config.debugging
|
308
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_bulk_upload_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
309
|
+
end
|
310
|
+
return data, status_code, headers
|
311
|
+
end
|
312
|
+
|
313
|
+
# Return bulk upload details grouped by status
|
314
|
+
# Return bulk upload details grouped by status
|
315
|
+
# @param company_id [Integer]
|
316
|
+
# @param bulk_upload_id [Integer]
|
317
|
+
# @param [Hash] opts the optional parameters
|
318
|
+
# @return [V1EntitiesBulkUploadDetails]
|
319
|
+
def get_bulk_upload_details_by_status(company_id, bulk_upload_id, opts = {})
|
320
|
+
data, _status_code, _headers = get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id, opts)
|
321
|
+
data
|
322
|
+
end
|
323
|
+
|
324
|
+
# Return bulk upload details grouped by status
|
325
|
+
# Return bulk upload details grouped by status
|
326
|
+
# @param company_id [Integer]
|
327
|
+
# @param bulk_upload_id [Integer]
|
328
|
+
# @param [Hash] opts the optional parameters
|
329
|
+
# @return [Array<(V1EntitiesBulkUploadDetails, Integer, Hash)>] V1EntitiesBulkUploadDetails data, response status code and response headers
|
330
|
+
def get_bulk_upload_details_by_status_with_http_info(company_id, bulk_upload_id, opts = {})
|
331
|
+
if @api_client.config.debugging
|
332
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_upload_details_by_status ...'
|
333
|
+
end
|
334
|
+
# verify the required parameter 'company_id' is set
|
335
|
+
if @api_client.config.client_side_validation && company_id.nil?
|
336
|
+
fail ArgumentError, "Missing the required parameter 'company_id' when calling CompanyApi.get_bulk_upload_details_by_status"
|
337
|
+
end
|
338
|
+
# verify the required parameter 'bulk_upload_id' is set
|
339
|
+
if @api_client.config.client_side_validation && bulk_upload_id.nil?
|
340
|
+
fail ArgumentError, "Missing the required parameter 'bulk_upload_id' when calling CompanyApi.get_bulk_upload_details_by_status"
|
341
|
+
end
|
342
|
+
# resource path
|
343
|
+
local_var_path = '/companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/group_by_status'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'bulk_upload_id' + '}', CGI.escape(bulk_upload_id.to_s))
|
344
|
+
|
345
|
+
# query parameters
|
346
|
+
query_params = opts[:query_params] || {}
|
347
|
+
|
348
|
+
# header parameters
|
349
|
+
header_params = opts[:header_params] || {}
|
350
|
+
# HTTP header 'Accept' (if needed)
|
351
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
352
|
+
|
353
|
+
# form parameters
|
354
|
+
form_params = opts[:form_params] || {}
|
355
|
+
|
356
|
+
# http body (model)
|
357
|
+
post_body = opts[:debug_body]
|
358
|
+
|
359
|
+
# return_type
|
360
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploadDetails'
|
361
|
+
|
362
|
+
# auth_names
|
363
|
+
auth_names = opts[:debug_auth_names] || []
|
364
|
+
|
365
|
+
new_options = opts.merge(
|
366
|
+
:operation => :"CompanyApi.get_bulk_upload_details_by_status",
|
367
|
+
:header_params => header_params,
|
368
|
+
:query_params => query_params,
|
369
|
+
:form_params => form_params,
|
370
|
+
:body => post_body,
|
371
|
+
:auth_names => auth_names,
|
372
|
+
:return_type => return_type
|
373
|
+
)
|
374
|
+
|
375
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
376
|
+
if @api_client.config.debugging
|
377
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_bulk_upload_details_by_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
378
|
+
end
|
379
|
+
return data, status_code, headers
|
380
|
+
end
|
381
|
+
|
382
|
+
# Return bulk uploads
|
383
|
+
# Return bulk uploads
|
384
|
+
# @param id [Integer]
|
385
|
+
# @param [Hash] opts the optional parameters
|
386
|
+
# @option opts [Integer] :page Page offset to fetch. (default to 1)
|
387
|
+
# @option opts [Integer] :per_page Number of results to return per page. (default to 25)
|
388
|
+
# @option opts [Integer] :offset Pad a number of results. (default to 0)
|
389
|
+
# @return [V1EntitiesBulkUploads]
|
390
|
+
def get_bulk_uploads(id, opts = {})
|
391
|
+
data, _status_code, _headers = get_bulk_uploads_with_http_info(id, opts)
|
392
|
+
data
|
393
|
+
end
|
394
|
+
|
395
|
+
# Return bulk uploads
|
396
|
+
# Return bulk uploads
|
397
|
+
# @param id [Integer]
|
398
|
+
# @param [Hash] opts the optional parameters
|
399
|
+
# @option opts [Integer] :page Page offset to fetch. (default to 1)
|
400
|
+
# @option opts [Integer] :per_page Number of results to return per page. (default to 25)
|
401
|
+
# @option opts [Integer] :offset Pad a number of results. (default to 0)
|
402
|
+
# @return [Array<(V1EntitiesBulkUploads, Integer, Hash)>] V1EntitiesBulkUploads data, response status code and response headers
|
403
|
+
def get_bulk_uploads_with_http_info(id, opts = {})
|
404
|
+
if @api_client.config.debugging
|
405
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.get_bulk_uploads ...'
|
406
|
+
end
|
407
|
+
# verify the required parameter 'id' is set
|
408
|
+
if @api_client.config.client_side_validation && id.nil?
|
409
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.get_bulk_uploads"
|
410
|
+
end
|
411
|
+
# resource path
|
412
|
+
local_var_path = '/companies/{id}/documents/bulk_uploads'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
413
|
+
|
414
|
+
# query parameters
|
415
|
+
query_params = opts[:query_params] || {}
|
416
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
417
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
418
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
419
|
+
|
420
|
+
# header parameters
|
421
|
+
header_params = opts[:header_params] || {}
|
422
|
+
# HTTP header 'Accept' (if needed)
|
423
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
424
|
+
|
425
|
+
# form parameters
|
426
|
+
form_params = opts[:form_params] || {}
|
427
|
+
|
428
|
+
# http body (model)
|
429
|
+
post_body = opts[:debug_body]
|
430
|
+
|
431
|
+
# return_type
|
432
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesBulkUploads'
|
433
|
+
|
434
|
+
# auth_names
|
435
|
+
auth_names = opts[:debug_auth_names] || []
|
436
|
+
|
437
|
+
new_options = opts.merge(
|
438
|
+
:operation => :"CompanyApi.get_bulk_uploads",
|
439
|
+
:header_params => header_params,
|
440
|
+
:query_params => query_params,
|
441
|
+
:form_params => form_params,
|
442
|
+
:body => post_body,
|
443
|
+
:auth_names => auth_names,
|
444
|
+
:return_type => return_type
|
445
|
+
)
|
446
|
+
|
447
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
448
|
+
if @api_client.config.debugging
|
449
|
+
@api_client.config.logger.debug "API called: CompanyApi#get_bulk_uploads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
450
|
+
end
|
451
|
+
return data, status_code, headers
|
452
|
+
end
|
453
|
+
|
244
454
|
# Get list of Companies
|
245
455
|
# Get companies
|
246
456
|
# @param [Hash] opts the optional parameters
|
@@ -152,7 +152,7 @@ module DealMakerAPI
|
|
152
152
|
@scheme = 'http'
|
153
153
|
@host = 'api.dealmaker.tech'
|
154
154
|
@base_path = ''
|
155
|
-
@server_index =
|
155
|
+
@server_index = nil
|
156
156
|
@server_operation_index = {}
|
157
157
|
@server_variables = {}
|
158
158
|
@server_operation_variables = {}
|
@@ -200,10 +200,12 @@ module DealMakerAPI
|
|
200
200
|
|
201
201
|
# Returns base URL for specified operation based on server settings
|
202
202
|
def base_url(operation = nil)
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
203
|
+
if operation_server_settings.key?(operation) then
|
204
|
+
index = server_operation_index.fetch(operation, server_index)
|
205
|
+
server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
|
206
|
+
else
|
207
|
+
server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
|
208
|
+
end
|
207
209
|
end
|
208
210
|
|
209
211
|
# Gets API key (with prefix if set).
|
@@ -258,8 +260,8 @@ module DealMakerAPI
|
|
258
260
|
servers = server_settings if servers == nil
|
259
261
|
|
260
262
|
# check array index out of bound
|
261
|
-
if (index < 0 || index >= servers.size)
|
262
|
-
fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
|
263
|
+
if (index.nil? || index < 0 || index >= servers.size)
|
264
|
+
fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
|
263
265
|
end
|
264
266
|
|
265
267
|
server = servers[index]
|