DealMakerAPI 0.102.1 → 0.103.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +22 -5
- data/docs/CompanyApi.md +68 -0
- data/docs/DealApi.md +80 -9
- data/docs/DefaultApi.md +69 -0
- data/docs/SetupSmsVerificationRequest.md +18 -0
- data/docs/TestDocumentUploadEmailRequest.md +22 -0
- data/docs/UpdateUserPasswordRequest.md +4 -2
- data/docs/UserApi.md +271 -0
- data/docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md +20 -0
- data/docs/V1EntitiesDealsProgress.md +20 -0
- data/docs/V1EntitiesDealsProgressColumn.md +20 -0
- data/docs/V1EntitiesUsersBinding.md +20 -0
- data/docs/V1EntitiesUsersFactor.md +22 -0
- data/docs/V1EntitiesUsersTwoFactorChannel.md +30 -0
- data/docs/V1EntitiesUsersTwoFactorChannels.md +18 -0
- data/docs/VerifyFactorRequest.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +72 -0
- data/lib/DealMakerAPI/api/deal_api.rb +84 -9
- data/lib/DealMakerAPI/api/default_api.rb +74 -0
- data/lib/DealMakerAPI/api/user_api.rb +272 -0
- data/lib/DealMakerAPI/models/setup_sms_verification_request.rb +222 -0
- data/lib/DealMakerAPI/models/test_document_upload_email_request.rb +256 -0
- data/lib/DealMakerAPI/models/update_user_password_request.rb +15 -5
- data/lib/DealMakerAPI/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent.rb +226 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_progress.rb +224 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_column.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_users_binding.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_users_factor.rb +235 -0
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channel.rb +276 -0
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channels.rb +215 -0
- data/lib/DealMakerAPI/models/verify_factor_request.rb +222 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +10 -0
- data/spec/api/company_api_spec.rb +13 -0
- data/spec/api/deal_api_spec.rb +16 -2
- data/spec/api/default_api_spec.rb +13 -0
- data/spec/api/user_api_spec.rb +50 -0
- data/spec/models/setup_sms_verification_request_spec.rb +36 -0
- data/spec/models/test_document_upload_email_request_spec.rb +48 -0
- data/spec/models/update_user_password_request_spec.rb +6 -0
- data/spec/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent_spec.rb +42 -0
- data/spec/models/v1_entities_deals_progress_column_spec.rb +42 -0
- data/spec/models/v1_entities_deals_progress_spec.rb +42 -0
- data/spec/models/v1_entities_users_binding_spec.rb +42 -0
- data/spec/models/v1_entities_users_factor_spec.rb +48 -0
- data/spec/models/v1_entities_users_two_factor_channel_spec.rb +72 -0
- data/spec/models/v1_entities_users_two_factor_channels_spec.rb +36 -0
- data/spec/models/verify_factor_request_spec.rb +36 -0
- metadata +151 -111
data/docs/UserApi.md
CHANGED
@@ -4,8 +4,144 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_factor**](UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor |
|
8
|
+
| [**get_two_factor_channels**](UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor |
|
7
9
|
| [**get_user**](UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID |
|
10
|
+
| [**setup_sms_verification**](UserApi.md#setup_sms_verification) | **POST** /users/{id}/setup_sms_verification | Start a setup for a SMS Verification by creating a two factor channel of sms type |
|
8
11
|
| [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password |
|
12
|
+
| [**verify_factor**](UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor |
|
13
|
+
|
14
|
+
|
15
|
+
## create_factor
|
16
|
+
|
17
|
+
> <V1EntitiesUsersFactor> create_factor(id)
|
18
|
+
|
19
|
+
Creates an API endpoint for creating a new TOTP factor
|
20
|
+
|
21
|
+
Create an API endpoint for creating a new TOTP factor
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'DealMakerAPI'
|
28
|
+
# setup authorization
|
29
|
+
DealMakerAPI.configure do |config|end
|
30
|
+
|
31
|
+
api_instance = DealMakerAPI::UserApi.new
|
32
|
+
id = 56 # Integer |
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Creates an API endpoint for creating a new TOTP factor
|
36
|
+
result = api_instance.create_factor(id)
|
37
|
+
p result
|
38
|
+
rescue DealMakerAPI::ApiError => e
|
39
|
+
puts "Error when calling UserApi->create_factor: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the create_factor_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<V1EntitiesUsersFactor>, Integer, Hash)> create_factor_with_http_info(id)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
# Creates an API endpoint for creating a new TOTP factor
|
52
|
+
data, status_code, headers = api_instance.create_factor_with_http_info(id)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <V1EntitiesUsersFactor>
|
56
|
+
rescue DealMakerAPI::ApiError => e
|
57
|
+
puts "Error when calling UserApi->create_factor_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **id** | **Integer** | | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**V1EntitiesUsersFactor**](V1EntitiesUsersFactor.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
No authorization required
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
80
|
+
|
81
|
+
## get_two_factor_channels
|
82
|
+
|
83
|
+
> <V1EntitiesUsersTwoFactorChannels> get_two_factor_channels(id)
|
84
|
+
|
85
|
+
Creates an API endpoint to return a list of existing TOTP factor
|
86
|
+
|
87
|
+
Create an API endpoint to return a list of existing TOTP factor
|
88
|
+
|
89
|
+
### Examples
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
require 'time'
|
93
|
+
require 'DealMakerAPI'
|
94
|
+
# setup authorization
|
95
|
+
DealMakerAPI.configure do |config|end
|
96
|
+
|
97
|
+
api_instance = DealMakerAPI::UserApi.new
|
98
|
+
id = 56 # Integer |
|
99
|
+
|
100
|
+
begin
|
101
|
+
# Creates an API endpoint to return a list of existing TOTP factor
|
102
|
+
result = api_instance.get_two_factor_channels(id)
|
103
|
+
p result
|
104
|
+
rescue DealMakerAPI::ApiError => e
|
105
|
+
puts "Error when calling UserApi->get_two_factor_channels: #{e}"
|
106
|
+
end
|
107
|
+
```
|
108
|
+
|
109
|
+
#### Using the get_two_factor_channels_with_http_info variant
|
110
|
+
|
111
|
+
This returns an Array which contains the response data, status code and headers.
|
112
|
+
|
113
|
+
> <Array(<V1EntitiesUsersTwoFactorChannels>, Integer, Hash)> get_two_factor_channels_with_http_info(id)
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
begin
|
117
|
+
# Creates an API endpoint to return a list of existing TOTP factor
|
118
|
+
data, status_code, headers = api_instance.get_two_factor_channels_with_http_info(id)
|
119
|
+
p status_code # => 2xx
|
120
|
+
p headers # => { ... }
|
121
|
+
p data # => <V1EntitiesUsersTwoFactorChannels>
|
122
|
+
rescue DealMakerAPI::ApiError => e
|
123
|
+
puts "Error when calling UserApi->get_two_factor_channels_with_http_info: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
| Name | Type | Description | Notes |
|
130
|
+
| ---- | ---- | ----------- | ----- |
|
131
|
+
| **id** | **Integer** | | |
|
132
|
+
|
133
|
+
### Return type
|
134
|
+
|
135
|
+
[**V1EntitiesUsersTwoFactorChannels**](V1EntitiesUsersTwoFactorChannels.md)
|
136
|
+
|
137
|
+
### Authorization
|
138
|
+
|
139
|
+
No authorization required
|
140
|
+
|
141
|
+
### HTTP request headers
|
142
|
+
|
143
|
+
- **Content-Type**: Not defined
|
144
|
+
- **Accept**: application/json
|
9
145
|
|
10
146
|
|
11
147
|
## get_user
|
@@ -74,6 +210,73 @@ No authorization required
|
|
74
210
|
- **Accept**: application/json
|
75
211
|
|
76
212
|
|
213
|
+
## setup_sms_verification
|
214
|
+
|
215
|
+
> setup_sms_verification(id, setup_sms_verification_request)
|
216
|
+
|
217
|
+
Start a setup for a SMS Verification by creating a two factor channel of sms type
|
218
|
+
|
219
|
+
Start a setup for a SMS Verification by creating a two factor channel of sms type
|
220
|
+
|
221
|
+
### Examples
|
222
|
+
|
223
|
+
```ruby
|
224
|
+
require 'time'
|
225
|
+
require 'DealMakerAPI'
|
226
|
+
# setup authorization
|
227
|
+
DealMakerAPI.configure do |config|end
|
228
|
+
|
229
|
+
api_instance = DealMakerAPI::UserApi.new
|
230
|
+
id = 56 # Integer |
|
231
|
+
setup_sms_verification_request = DealMakerAPI::SetupSmsVerificationRequest.new({phone_number: 'phone_number_example'}) # SetupSmsVerificationRequest |
|
232
|
+
|
233
|
+
begin
|
234
|
+
# Start a setup for a SMS Verification by creating a two factor channel of sms type
|
235
|
+
api_instance.setup_sms_verification(id, setup_sms_verification_request)
|
236
|
+
rescue DealMakerAPI::ApiError => e
|
237
|
+
puts "Error when calling UserApi->setup_sms_verification: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
#### Using the setup_sms_verification_with_http_info variant
|
242
|
+
|
243
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
244
|
+
|
245
|
+
> <Array(nil, Integer, Hash)> setup_sms_verification_with_http_info(id, setup_sms_verification_request)
|
246
|
+
|
247
|
+
```ruby
|
248
|
+
begin
|
249
|
+
# Start a setup for a SMS Verification by creating a two factor channel of sms type
|
250
|
+
data, status_code, headers = api_instance.setup_sms_verification_with_http_info(id, setup_sms_verification_request)
|
251
|
+
p status_code # => 2xx
|
252
|
+
p headers # => { ... }
|
253
|
+
p data # => nil
|
254
|
+
rescue DealMakerAPI::ApiError => e
|
255
|
+
puts "Error when calling UserApi->setup_sms_verification_with_http_info: #{e}"
|
256
|
+
end
|
257
|
+
```
|
258
|
+
|
259
|
+
### Parameters
|
260
|
+
|
261
|
+
| Name | Type | Description | Notes |
|
262
|
+
| ---- | ---- | ----------- | ----- |
|
263
|
+
| **id** | **Integer** | | |
|
264
|
+
| **setup_sms_verification_request** | [**SetupSmsVerificationRequest**](SetupSmsVerificationRequest.md) | | |
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
nil (empty response body)
|
269
|
+
|
270
|
+
### Authorization
|
271
|
+
|
272
|
+
No authorization required
|
273
|
+
|
274
|
+
### HTTP request headers
|
275
|
+
|
276
|
+
- **Content-Type**: application/json
|
277
|
+
- **Accept**: Not defined
|
278
|
+
|
279
|
+
|
77
280
|
## update_user_password
|
78
281
|
|
79
282
|
> <V1EntitiesUser> update_user_password(id, update_user_password_request)
|
@@ -141,3 +344,71 @@ No authorization required
|
|
141
344
|
- **Content-Type**: application/json
|
142
345
|
- **Accept**: application/json
|
143
346
|
|
347
|
+
|
348
|
+
## verify_factor
|
349
|
+
|
350
|
+
> <V1EntitiesUsersTwoFactorChannel> verify_factor(id, verify_factor_request)
|
351
|
+
|
352
|
+
Creates an API endpoint to verify an existing TOTP factor
|
353
|
+
|
354
|
+
Create an API endpoint to verify an existing TOTP factor
|
355
|
+
|
356
|
+
### Examples
|
357
|
+
|
358
|
+
```ruby
|
359
|
+
require 'time'
|
360
|
+
require 'DealMakerAPI'
|
361
|
+
# setup authorization
|
362
|
+
DealMakerAPI.configure do |config|end
|
363
|
+
|
364
|
+
api_instance = DealMakerAPI::UserApi.new
|
365
|
+
id = 56 # Integer |
|
366
|
+
verify_factor_request = DealMakerAPI::VerifyFactorRequest.new({code: 'code_example'}) # VerifyFactorRequest |
|
367
|
+
|
368
|
+
begin
|
369
|
+
# Creates an API endpoint to verify an existing TOTP factor
|
370
|
+
result = api_instance.verify_factor(id, verify_factor_request)
|
371
|
+
p result
|
372
|
+
rescue DealMakerAPI::ApiError => e
|
373
|
+
puts "Error when calling UserApi->verify_factor: #{e}"
|
374
|
+
end
|
375
|
+
```
|
376
|
+
|
377
|
+
#### Using the verify_factor_with_http_info variant
|
378
|
+
|
379
|
+
This returns an Array which contains the response data, status code and headers.
|
380
|
+
|
381
|
+
> <Array(<V1EntitiesUsersTwoFactorChannel>, Integer, Hash)> verify_factor_with_http_info(id, verify_factor_request)
|
382
|
+
|
383
|
+
```ruby
|
384
|
+
begin
|
385
|
+
# Creates an API endpoint to verify an existing TOTP factor
|
386
|
+
data, status_code, headers = api_instance.verify_factor_with_http_info(id, verify_factor_request)
|
387
|
+
p status_code # => 2xx
|
388
|
+
p headers # => { ... }
|
389
|
+
p data # => <V1EntitiesUsersTwoFactorChannel>
|
390
|
+
rescue DealMakerAPI::ApiError => e
|
391
|
+
puts "Error when calling UserApi->verify_factor_with_http_info: #{e}"
|
392
|
+
end
|
393
|
+
```
|
394
|
+
|
395
|
+
### Parameters
|
396
|
+
|
397
|
+
| Name | Type | Description | Notes |
|
398
|
+
| ---- | ---- | ----------- | ----- |
|
399
|
+
| **id** | **Integer** | | |
|
400
|
+
| **verify_factor_request** | [**VerifyFactorRequest**](VerifyFactorRequest.md) | | |
|
401
|
+
|
402
|
+
### Return type
|
403
|
+
|
404
|
+
[**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md)
|
405
|
+
|
406
|
+
### Authorization
|
407
|
+
|
408
|
+
No authorization required
|
409
|
+
|
410
|
+
### HTTP request headers
|
411
|
+
|
412
|
+
- **Content-Type**: application/json
|
413
|
+
- **Accept**: application/json
|
414
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **client_secret** | **String** | The client secret for the payment | [optional] |
|
8
|
+
| **name** | **String** | The name of the investor | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.new(
|
16
|
+
client_secret: null,
|
17
|
+
name: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsProgress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **investor_funnel** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) | | [optional] |
|
8
|
+
| **incoming_payments** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDealsProgress.new(
|
16
|
+
investor_funnel: null,
|
17
|
+
incoming_payments: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsProgressColumn
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **label** | **String** | The label of the column. | [optional] |
|
8
|
+
| **value** | **Integer** | The value for the column. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDealsProgressColumn.new(
|
16
|
+
label: null,
|
17
|
+
value: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesUsersBinding
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **secret** | **String** | The secret. | [optional] |
|
8
|
+
| **uri** | **String** | The URI. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesUsersBinding.new(
|
16
|
+
secret: null,
|
17
|
+
uri: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesUsersFactor
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sid** | **String** | The sid for the factor. | [optional] |
|
8
|
+
| **identity** | **String** | The identity of the factor. | [optional] |
|
9
|
+
| **binding** | [**V1EntitiesUsersBinding**](V1EntitiesUsersBinding.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::V1EntitiesUsersFactor.new(
|
17
|
+
sid: null,
|
18
|
+
identity: null,
|
19
|
+
binding: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesUsersTwoFactorChannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The id for the two factor channel. | [optional] |
|
8
|
+
| **user_id** | **Integer** | The user id for the two factor channel. | [optional] |
|
9
|
+
| **channel** | **String** | The channel for the two factor channel. | [optional] |
|
10
|
+
| **verified** | **Boolean** | The verification status for the two factor channel. | [optional] |
|
11
|
+
| **identity** | **String** | The identity for the two factor channel. | [optional] |
|
12
|
+
| **factor_sid** | **String** | The sid for the two factor channel. | [optional] |
|
13
|
+
| **updated_at** | **String** | The time since the two factor channel was last updated/verified. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'DealMakerAPI'
|
19
|
+
|
20
|
+
instance = DealMakerAPI::V1EntitiesUsersTwoFactorChannel.new(
|
21
|
+
id: null,
|
22
|
+
user_id: null,
|
23
|
+
channel: null,
|
24
|
+
verified: null,
|
25
|
+
identity: null,
|
26
|
+
factor_sid: null,
|
27
|
+
updated_at: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesUsersTwoFactorChannels
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesUsersTwoFactorChannels.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::VerifyFactorRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **code** | **String** | The verification code. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::VerifyFactorRequest.new(
|
15
|
+
code: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -1554,5 +1554,77 @@ module DealMakerAPI
|
|
1554
1554
|
end
|
1555
1555
|
return data, status_code, headers
|
1556
1556
|
end
|
1557
|
+
|
1558
|
+
# Send document upload test email to given user
|
1559
|
+
# Send document upload test email to given user
|
1560
|
+
# @param id [Integer]
|
1561
|
+
# @param test_document_upload_email_request [TestDocumentUploadEmailRequest]
|
1562
|
+
# @param [Hash] opts the optional parameters
|
1563
|
+
# @return [nil]
|
1564
|
+
def test_document_upload_email(id, test_document_upload_email_request, opts = {})
|
1565
|
+
test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts)
|
1566
|
+
nil
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# Send document upload test email to given user
|
1570
|
+
# Send document upload test email to given user
|
1571
|
+
# @param id [Integer]
|
1572
|
+
# @param test_document_upload_email_request [TestDocumentUploadEmailRequest]
|
1573
|
+
# @param [Hash] opts the optional parameters
|
1574
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1575
|
+
def test_document_upload_email_with_http_info(id, test_document_upload_email_request, opts = {})
|
1576
|
+
if @api_client.config.debugging
|
1577
|
+
@api_client.config.logger.debug 'Calling API: CompanyApi.test_document_upload_email ...'
|
1578
|
+
end
|
1579
|
+
# verify the required parameter 'id' is set
|
1580
|
+
if @api_client.config.client_side_validation && id.nil?
|
1581
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompanyApi.test_document_upload_email"
|
1582
|
+
end
|
1583
|
+
# verify the required parameter 'test_document_upload_email_request' is set
|
1584
|
+
if @api_client.config.client_side_validation && test_document_upload_email_request.nil?
|
1585
|
+
fail ArgumentError, "Missing the required parameter 'test_document_upload_email_request' when calling CompanyApi.test_document_upload_email"
|
1586
|
+
end
|
1587
|
+
# resource path
|
1588
|
+
local_var_path = '/companies/{id}/documents/test_upload_email'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
1589
|
+
|
1590
|
+
# query parameters
|
1591
|
+
query_params = opts[:query_params] || {}
|
1592
|
+
|
1593
|
+
# header parameters
|
1594
|
+
header_params = opts[:header_params] || {}
|
1595
|
+
# HTTP header 'Content-Type'
|
1596
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1597
|
+
if !content_type.nil?
|
1598
|
+
header_params['Content-Type'] = content_type
|
1599
|
+
end
|
1600
|
+
|
1601
|
+
# form parameters
|
1602
|
+
form_params = opts[:form_params] || {}
|
1603
|
+
|
1604
|
+
# http body (model)
|
1605
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(test_document_upload_email_request)
|
1606
|
+
|
1607
|
+
# return_type
|
1608
|
+
return_type = opts[:debug_return_type]
|
1609
|
+
|
1610
|
+
# auth_names
|
1611
|
+
auth_names = opts[:debug_auth_names] || []
|
1612
|
+
|
1613
|
+
new_options = opts.merge(
|
1614
|
+
:operation => :"CompanyApi.test_document_upload_email",
|
1615
|
+
:header_params => header_params,
|
1616
|
+
:query_params => query_params,
|
1617
|
+
:form_params => form_params,
|
1618
|
+
:body => post_body,
|
1619
|
+
:auth_names => auth_names,
|
1620
|
+
:return_type => return_type
|
1621
|
+
)
|
1622
|
+
|
1623
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1624
|
+
if @api_client.config.debugging
|
1625
|
+
@api_client.config.logger.debug "API called: CompanyApi#test_document_upload_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1626
|
+
end
|
1627
|
+
return data, status_code, headers
|
1628
|
+
end
|
1557
1629
|
end
|
1558
1630
|
end
|
@@ -19,6 +19,81 @@ module DealMakerAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Prepares an investor for payment
|
23
|
+
# Prepare investor for payment
|
24
|
+
# @param id [String] The deal id
|
25
|
+
# @param investor_id [Integer] The investor id
|
26
|
+
# @param subscription_id [Integer] The subscription id
|
27
|
+
# @param [Hash] opts the optional parameters
|
28
|
+
# @return [V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent]
|
29
|
+
def ach_bank_account_setup_intent(id, investor_id, subscription_id, opts = {})
|
30
|
+
data, _status_code, _headers = ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts)
|
31
|
+
data
|
32
|
+
end
|
33
|
+
|
34
|
+
# Prepares an investor for payment
|
35
|
+
# Prepare investor for payment
|
36
|
+
# @param id [String] The deal id
|
37
|
+
# @param investor_id [Integer] The investor id
|
38
|
+
# @param subscription_id [Integer] The subscription id
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [Array<(V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent, Integer, Hash)>] V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent data, response status code and response headers
|
41
|
+
def ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts = {})
|
42
|
+
if @api_client.config.debugging
|
43
|
+
@api_client.config.logger.debug 'Calling API: DealApi.ach_bank_account_setup_intent ...'
|
44
|
+
end
|
45
|
+
# verify the required parameter 'id' is set
|
46
|
+
if @api_client.config.client_side_validation && id.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.ach_bank_account_setup_intent"
|
48
|
+
end
|
49
|
+
# verify the required parameter 'investor_id' is set
|
50
|
+
if @api_client.config.client_side_validation && investor_id.nil?
|
51
|
+
fail ArgumentError, "Missing the required parameter 'investor_id' when calling DealApi.ach_bank_account_setup_intent"
|
52
|
+
end
|
53
|
+
# verify the required parameter 'subscription_id' is set
|
54
|
+
if @api_client.config.client_side_validation && subscription_id.nil?
|
55
|
+
fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DealApi.ach_bank_account_setup_intent"
|
56
|
+
end
|
57
|
+
# resource path
|
58
|
+
local_var_path = '/deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_id.to_s))
|
59
|
+
|
60
|
+
# query parameters
|
61
|
+
query_params = opts[:query_params] || {}
|
62
|
+
|
63
|
+
# header parameters
|
64
|
+
header_params = opts[:header_params] || {}
|
65
|
+
# HTTP header 'Accept' (if needed)
|
66
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
67
|
+
|
68
|
+
# form parameters
|
69
|
+
form_params = opts[:form_params] || {}
|
70
|
+
|
71
|
+
# http body (model)
|
72
|
+
post_body = opts[:debug_body]
|
73
|
+
|
74
|
+
# return_type
|
75
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent'
|
76
|
+
|
77
|
+
# auth_names
|
78
|
+
auth_names = opts[:debug_auth_names] || []
|
79
|
+
|
80
|
+
new_options = opts.merge(
|
81
|
+
:operation => :"DealApi.ach_bank_account_setup_intent",
|
82
|
+
:header_params => header_params,
|
83
|
+
:query_params => query_params,
|
84
|
+
:form_params => form_params,
|
85
|
+
:body => post_body,
|
86
|
+
:auth_names => auth_names,
|
87
|
+
:return_type => return_type
|
88
|
+
)
|
89
|
+
|
90
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug "API called: DealApi#ach_bank_account_setup_intent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
|
+
end
|
94
|
+
return data, status_code, headers
|
95
|
+
end
|
96
|
+
|
22
97
|
# Prepares an investor for payment
|
23
98
|
# Prepare investor for payment
|
24
99
|
# @param id [String] The deal id
|
@@ -26,8 +101,8 @@ module DealMakerAPI
|
|
26
101
|
# @param subscription_id [Integer] The subscription id
|
27
102
|
# @param [Hash] opts the optional parameters
|
28
103
|
# @return [V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent]
|
29
|
-
def
|
30
|
-
data, _status_code, _headers =
|
104
|
+
def acss_bank_account_setup_intent(id, investor_id, subscription_id, opts = {})
|
105
|
+
data, _status_code, _headers = acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts)
|
31
106
|
data
|
32
107
|
end
|
33
108
|
|
@@ -38,21 +113,21 @@ module DealMakerAPI
|
|
38
113
|
# @param subscription_id [Integer] The subscription id
|
39
114
|
# @param [Hash] opts the optional parameters
|
40
115
|
# @return [Array<(V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent, Integer, Hash)>] V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent data, response status code and response headers
|
41
|
-
def
|
116
|
+
def acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id, opts = {})
|
42
117
|
if @api_client.config.debugging
|
43
|
-
@api_client.config.logger.debug 'Calling API: DealApi.
|
118
|
+
@api_client.config.logger.debug 'Calling API: DealApi.acss_bank_account_setup_intent ...'
|
44
119
|
end
|
45
120
|
# verify the required parameter 'id' is set
|
46
121
|
if @api_client.config.client_side_validation && id.nil?
|
47
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.
|
122
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.acss_bank_account_setup_intent"
|
48
123
|
end
|
49
124
|
# verify the required parameter 'investor_id' is set
|
50
125
|
if @api_client.config.client_side_validation && investor_id.nil?
|
51
|
-
fail ArgumentError, "Missing the required parameter 'investor_id' when calling DealApi.
|
126
|
+
fail ArgumentError, "Missing the required parameter 'investor_id' when calling DealApi.acss_bank_account_setup_intent"
|
52
127
|
end
|
53
128
|
# verify the required parameter 'subscription_id' is set
|
54
129
|
if @api_client.config.client_side_validation && subscription_id.nil?
|
55
|
-
fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DealApi.
|
130
|
+
fail ArgumentError, "Missing the required parameter 'subscription_id' when calling DealApi.acss_bank_account_setup_intent"
|
56
131
|
end
|
57
132
|
# resource path
|
58
133
|
local_var_path = '/deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'subscription_id' + '}', CGI.escape(subscription_id.to_s))
|
@@ -78,7 +153,7 @@ module DealMakerAPI
|
|
78
153
|
auth_names = opts[:debug_auth_names] || []
|
79
154
|
|
80
155
|
new_options = opts.merge(
|
81
|
-
:operation => :"DealApi.
|
156
|
+
:operation => :"DealApi.acss_bank_account_setup_intent",
|
82
157
|
:header_params => header_params,
|
83
158
|
:query_params => query_params,
|
84
159
|
:form_params => form_params,
|
@@ -89,7 +164,7 @@ module DealMakerAPI
|
|
89
164
|
|
90
165
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
91
166
|
if @api_client.config.debugging
|
92
|
-
@api_client.config.logger.debug "API called: DealApi#
|
167
|
+
@api_client.config.logger.debug "API called: DealApi#acss_bank_account_setup_intent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
168
|
end
|
94
169
|
return data, status_code, headers
|
95
170
|
end
|