DealMakerAPI 0.102.1 → 0.103.5
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.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 893f23d5325614c0e76b90fa418283bb0ff95d7594553ce76f70aa08a6f76a42
|
4
|
+
data.tar.gz: '080f0ea63fc6357666af9800773c4ba1bf4e33b40b5da7677359773c472735be'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 333abbf2666b66db8c698009601086e5a723943289cd7576c188bc444ba9d71680251f3c35e83b9bfc5b30e22e54d68ba251826f4ae72f4fc658aa30081f508b
|
7
|
+
data.tar.gz: 50e06d8c067021a4c10cf610776ed484a55ed9bf223ae936e4afc13e412f9ea78b24472ec06b7492e8490127fe609e9c5e826eb3f4a92afe7aef756062bb698b
|
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.
|
341
|
+
- Package version: 0.103.5
|
342
342
|
- Generator version: 7.6.0-SNAPSHOT
|
343
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
344
344
|
|
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
355
355
|
Then either install the gem locally:
|
356
356
|
|
357
357
|
```shell
|
358
|
-
gem install ./DealMakerAPI-0.
|
358
|
+
gem install ./DealMakerAPI-0.103.5.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.103.5.gem` to install the development dependencies)
|
362
362
|
|
363
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
364
364
|
|
365
365
|
Finally add this to the Gemfile:
|
366
366
|
|
367
|
-
gem 'DealMakerAPI', '~> 0.
|
367
|
+
gem 'DealMakerAPI', '~> 0.103.5'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -433,9 +433,11 @@ Class | Method | HTTP request | Description
|
|
433
433
|
*DealMakerAPI::CompanyApi* | [**get_shareholder_ledger**](docs/CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company
|
434
434
|
*DealMakerAPI::CompanyApi* | [**get_user_accessible_companies**](docs/CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user
|
435
435
|
*DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
|
436
|
+
*DealMakerAPI::CompanyApi* | [**test_document_upload_email**](docs/CompanyApi.md#test_document_upload_email) | **POST** /companies/{id}/documents/test_upload_email | Send document upload test email to given user
|
436
437
|
*DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
|
437
438
|
*DealMakerAPI::CustomEmailsApi* | [**get_access_token**](docs/CustomEmailsApi.md#get_access_token) | **POST** /custom_emails/get_access_token | Generate authorization token information for initializing Beefree editor
|
438
|
-
*DealMakerAPI::DealApi* | [**
|
439
|
+
*DealMakerAPI::DealApi* | [**ach_bank_account_setup_intent**](docs/DealApi.md#ach_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent | Prepares an investor for payment
|
440
|
+
*DealMakerAPI::DealApi* | [**acss_bank_account_setup_intent**](docs/DealApi.md#acss_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent | Prepares an investor for payment
|
439
441
|
*DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
440
442
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
441
443
|
*DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
|
@@ -446,6 +448,7 @@ Class | Method | HTTP request | Description
|
|
446
448
|
*DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data
|
447
449
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
|
448
450
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
|
451
|
+
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page_kind**](docs/DefaultApi.md#get_deals_id_progress_page_kind) | **GET** /deals/{id}/progress_page/{kind} | Get deal progress for a specific kind
|
449
452
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_summary**](docs/DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview
|
450
453
|
*DealMakerAPI::DefaultApi* | [**get_deals_payment_onboarding_questionnaire_initial_questions**](docs/DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions
|
451
454
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
@@ -493,8 +496,12 @@ Class | Method | HTTP request | Description
|
|
493
496
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
494
497
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
495
498
|
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
499
|
+
*DealMakerAPI::UserApi* | [**create_factor**](docs/UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor
|
500
|
+
*DealMakerAPI::UserApi* | [**get_two_factor_channels**](docs/UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor
|
496
501
|
*DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
|
502
|
+
*DealMakerAPI::UserApi* | [**setup_sms_verification**](docs/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
|
497
503
|
*DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
|
504
|
+
*DealMakerAPI::UserApi* | [**verify_factor**](docs/UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor
|
498
505
|
*DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
|
499
506
|
|
500
507
|
|
@@ -538,6 +545,8 @@ Class | Method | HTTP request | Description
|
|
538
545
|
- [DealMakerAPI::RequestNewDocumentRequest](docs/RequestNewDocumentRequest.md)
|
539
546
|
- [DealMakerAPI::RunBackgroundSearchRequest](docs/RunBackgroundSearchRequest.md)
|
540
547
|
- [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
|
548
|
+
- [DealMakerAPI::SetupSmsVerificationRequest](docs/SetupSmsVerificationRequest.md)
|
549
|
+
- [DealMakerAPI::TestDocumentUploadEmailRequest](docs/TestDocumentUploadEmailRequest.md)
|
541
550
|
- [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
|
542
551
|
- [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
|
543
552
|
- [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
|
@@ -563,8 +572,11 @@ Class | Method | HTTP request | Description
|
|
563
572
|
- [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
|
564
573
|
- [DealMakerAPI::V1EntitiesDealsIncentivePlan](docs/V1EntitiesDealsIncentivePlan.md)
|
565
574
|
- [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
|
575
|
+
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
|
566
576
|
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent.md)
|
567
577
|
- [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
|
578
|
+
- [DealMakerAPI::V1EntitiesDealsProgress](docs/V1EntitiesDealsProgress.md)
|
579
|
+
- [DealMakerAPI::V1EntitiesDealsProgressColumn](docs/V1EntitiesDealsProgressColumn.md)
|
568
580
|
- [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
|
569
581
|
- [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
|
570
582
|
- [DealMakerAPI::V1EntitiesEmailEvent](docs/V1EntitiesEmailEvent.md)
|
@@ -613,11 +625,16 @@ Class | Method | HTTP request | Description
|
|
613
625
|
- [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
|
614
626
|
- [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
|
615
627
|
- [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
|
628
|
+
- [DealMakerAPI::V1EntitiesUsersBinding](docs/V1EntitiesUsersBinding.md)
|
629
|
+
- [DealMakerAPI::V1EntitiesUsersFactor](docs/V1EntitiesUsersFactor.md)
|
630
|
+
- [DealMakerAPI::V1EntitiesUsersTwoFactorChannel](docs/V1EntitiesUsersTwoFactorChannel.md)
|
631
|
+
- [DealMakerAPI::V1EntitiesUsersTwoFactorChannels](docs/V1EntitiesUsersTwoFactorChannels.md)
|
616
632
|
- [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
|
617
633
|
- [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
|
618
634
|
- [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)
|
619
635
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeal](docs/V1EntitiesWebhooksSubscriptionDeal.md)
|
620
636
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeals](docs/V1EntitiesWebhooksSubscriptionDeals.md)
|
637
|
+
- [DealMakerAPI::VerifyFactorRequest](docs/VerifyFactorRequest.md)
|
621
638
|
|
622
639
|
|
623
640
|
## Documentation for Authorization
|
data/docs/CompanyApi.md
CHANGED
@@ -26,6 +26,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
26
26
|
| [**get_shareholder_ledger**](CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company |
|
27
27
|
| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
|
28
28
|
| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
|
29
|
+
| [**test_document_upload_email**](CompanyApi.md#test_document_upload_email) | **POST** /companies/{id}/documents/test_upload_email | Send document upload test email to given user |
|
29
30
|
|
30
31
|
|
31
32
|
## create_bulk_upload
|
@@ -1545,3 +1546,70 @@ No authorization required
|
|
1545
1546
|
- **Content-Type**: application/json
|
1546
1547
|
- **Accept**: Not defined
|
1547
1548
|
|
1549
|
+
|
1550
|
+
## test_document_upload_email
|
1551
|
+
|
1552
|
+
> test_document_upload_email(id, test_document_upload_email_request)
|
1553
|
+
|
1554
|
+
Send document upload test email to given user
|
1555
|
+
|
1556
|
+
Send document upload test email to given user
|
1557
|
+
|
1558
|
+
### Examples
|
1559
|
+
|
1560
|
+
```ruby
|
1561
|
+
require 'time'
|
1562
|
+
require 'DealMakerAPI'
|
1563
|
+
# setup authorization
|
1564
|
+
DealMakerAPI.configure do |config|end
|
1565
|
+
|
1566
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
1567
|
+
id = 56 # Integer |
|
1568
|
+
test_document_upload_email_request = DealMakerAPI::TestDocumentUploadEmailRequest.new({user_id: 37, send_confidential_email: false, json_email: 'json_email_example'}) # TestDocumentUploadEmailRequest |
|
1569
|
+
|
1570
|
+
begin
|
1571
|
+
# Send document upload test email to given user
|
1572
|
+
api_instance.test_document_upload_email(id, test_document_upload_email_request)
|
1573
|
+
rescue DealMakerAPI::ApiError => e
|
1574
|
+
puts "Error when calling CompanyApi->test_document_upload_email: #{e}"
|
1575
|
+
end
|
1576
|
+
```
|
1577
|
+
|
1578
|
+
#### Using the test_document_upload_email_with_http_info variant
|
1579
|
+
|
1580
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1581
|
+
|
1582
|
+
> <Array(nil, Integer, Hash)> test_document_upload_email_with_http_info(id, test_document_upload_email_request)
|
1583
|
+
|
1584
|
+
```ruby
|
1585
|
+
begin
|
1586
|
+
# Send document upload test email to given user
|
1587
|
+
data, status_code, headers = api_instance.test_document_upload_email_with_http_info(id, test_document_upload_email_request)
|
1588
|
+
p status_code # => 2xx
|
1589
|
+
p headers # => { ... }
|
1590
|
+
p data # => nil
|
1591
|
+
rescue DealMakerAPI::ApiError => e
|
1592
|
+
puts "Error when calling CompanyApi->test_document_upload_email_with_http_info: #{e}"
|
1593
|
+
end
|
1594
|
+
```
|
1595
|
+
|
1596
|
+
### Parameters
|
1597
|
+
|
1598
|
+
| Name | Type | Description | Notes |
|
1599
|
+
| ---- | ---- | ----------- | ----- |
|
1600
|
+
| **id** | **Integer** | | |
|
1601
|
+
| **test_document_upload_email_request** | [**TestDocumentUploadEmailRequest**](TestDocumentUploadEmailRequest.md) | | |
|
1602
|
+
|
1603
|
+
### Return type
|
1604
|
+
|
1605
|
+
nil (empty response body)
|
1606
|
+
|
1607
|
+
### Authorization
|
1608
|
+
|
1609
|
+
No authorization required
|
1610
|
+
|
1611
|
+
### HTTP request headers
|
1612
|
+
|
1613
|
+
- **Content-Type**: application/json
|
1614
|
+
- **Accept**: Not defined
|
1615
|
+
|
data/docs/DealApi.md
CHANGED
@@ -4,16 +4,17 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**ach_bank_account_setup_intent**](DealApi.md#ach_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent | Prepares an investor for payment |
|
8
|
+
| [**acss_bank_account_setup_intent**](DealApi.md#acss_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent | Prepares an investor for payment |
|
8
9
|
| [**create_deal_setup**](DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
|
9
10
|
| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
|
10
11
|
| [**get_deal_incentive_plan**](DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id |
|
11
12
|
| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
|
12
13
|
|
13
14
|
|
14
|
-
##
|
15
|
+
## ach_bank_account_setup_intent
|
15
16
|
|
16
|
-
> <
|
17
|
+
> <V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent> ach_bank_account_setup_intent(id, investor_id, subscription_id)
|
17
18
|
|
18
19
|
Prepares an investor for payment
|
19
20
|
|
@@ -34,28 +35,98 @@ subscription_id = 56 # Integer | The subscription id
|
|
34
35
|
|
35
36
|
begin
|
36
37
|
# Prepares an investor for payment
|
37
|
-
result = api_instance.
|
38
|
+
result = api_instance.ach_bank_account_setup_intent(id, investor_id, subscription_id)
|
38
39
|
p result
|
39
40
|
rescue DealMakerAPI::ApiError => e
|
40
|
-
puts "Error when calling DealApi->
|
41
|
+
puts "Error when calling DealApi->ach_bank_account_setup_intent: #{e}"
|
41
42
|
end
|
42
43
|
```
|
43
44
|
|
44
|
-
#### Using the
|
45
|
+
#### Using the ach_bank_account_setup_intent_with_http_info variant
|
45
46
|
|
46
47
|
This returns an Array which contains the response data, status code and headers.
|
47
48
|
|
48
|
-
> <Array(<
|
49
|
+
> <Array(<V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent>, Integer, Hash)> ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
49
50
|
|
50
51
|
```ruby
|
51
52
|
begin
|
52
53
|
# Prepares an investor for payment
|
53
|
-
data, status_code, headers = api_instance.
|
54
|
+
data, status_code, headers = api_instance.ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent>
|
58
|
+
rescue DealMakerAPI::ApiError => e
|
59
|
+
puts "Error when calling DealApi->ach_bank_account_setup_intent_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **id** | **String** | The deal id | |
|
68
|
+
| **investor_id** | **Integer** | The investor id | |
|
69
|
+
| **subscription_id** | **Integer** | The subscription id | |
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
[**V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent**](V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
No authorization required
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
## acss_bank_account_setup_intent
|
86
|
+
|
87
|
+
> <V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent> acss_bank_account_setup_intent(id, investor_id, subscription_id)
|
88
|
+
|
89
|
+
Prepares an investor for payment
|
90
|
+
|
91
|
+
Prepare investor for payment
|
92
|
+
|
93
|
+
### Examples
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
require 'time'
|
97
|
+
require 'DealMakerAPI'
|
98
|
+
# setup authorization
|
99
|
+
DealMakerAPI.configure do |config|end
|
100
|
+
|
101
|
+
api_instance = DealMakerAPI::DealApi.new
|
102
|
+
id = 'id_example' # String | The deal id
|
103
|
+
investor_id = 56 # Integer | The investor id
|
104
|
+
subscription_id = 56 # Integer | The subscription id
|
105
|
+
|
106
|
+
begin
|
107
|
+
# Prepares an investor for payment
|
108
|
+
result = api_instance.acss_bank_account_setup_intent(id, investor_id, subscription_id)
|
109
|
+
p result
|
110
|
+
rescue DealMakerAPI::ApiError => e
|
111
|
+
puts "Error when calling DealApi->acss_bank_account_setup_intent: #{e}"
|
112
|
+
end
|
113
|
+
```
|
114
|
+
|
115
|
+
#### Using the acss_bank_account_setup_intent_with_http_info variant
|
116
|
+
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
118
|
+
|
119
|
+
> <Array(<V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent>, Integer, Hash)> acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
begin
|
123
|
+
# Prepares an investor for payment
|
124
|
+
data, status_code, headers = api_instance.acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
54
125
|
p status_code # => 2xx
|
55
126
|
p headers # => { ... }
|
56
127
|
p data # => <V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent>
|
57
128
|
rescue DealMakerAPI::ApiError => e
|
58
|
-
puts "Error when calling DealApi->
|
129
|
+
puts "Error when calling DealApi->acss_bank_account_setup_intent_with_http_info: #{e}"
|
59
130
|
end
|
60
131
|
```
|
61
132
|
|
data/docs/DefaultApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
8
8
|
| [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data |
|
9
9
|
| [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal |
|
10
10
|
| [**get_deals_id_investors_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal |
|
11
|
+
| [**get_deals_id_progress_page_kind**](DefaultApi.md#get_deals_id_progress_page_kind) | **GET** /deals/{id}/progress_page/{kind} | Get deal progress for a specific kind |
|
11
12
|
| [**get_deals_id_summary**](DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview |
|
12
13
|
| [**get_deals_payment_onboarding_questionnaire_initial_questions**](DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions |
|
13
14
|
| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
|
@@ -287,6 +288,74 @@ No authorization required
|
|
287
288
|
- **Accept**: application/json
|
288
289
|
|
289
290
|
|
291
|
+
## get_deals_id_progress_page_kind
|
292
|
+
|
293
|
+
> <V1EntitiesDealsProgress> get_deals_id_progress_page_kind(id, kind)
|
294
|
+
|
295
|
+
Get deal progress for a specific kind
|
296
|
+
|
297
|
+
Get deal progress
|
298
|
+
|
299
|
+
### Examples
|
300
|
+
|
301
|
+
```ruby
|
302
|
+
require 'time'
|
303
|
+
require 'DealMakerAPI'
|
304
|
+
# setup authorization
|
305
|
+
DealMakerAPI.configure do |config|end
|
306
|
+
|
307
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
308
|
+
id = 56 # Integer | The deal id.
|
309
|
+
kind = 'investment_amount' # String | Kind of progress.
|
310
|
+
|
311
|
+
begin
|
312
|
+
# Get deal progress for a specific kind
|
313
|
+
result = api_instance.get_deals_id_progress_page_kind(id, kind)
|
314
|
+
p result
|
315
|
+
rescue DealMakerAPI::ApiError => e
|
316
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_kind: #{e}"
|
317
|
+
end
|
318
|
+
```
|
319
|
+
|
320
|
+
#### Using the get_deals_id_progress_page_kind_with_http_info variant
|
321
|
+
|
322
|
+
This returns an Array which contains the response data, status code and headers.
|
323
|
+
|
324
|
+
> <Array(<V1EntitiesDealsProgress>, Integer, Hash)> get_deals_id_progress_page_kind_with_http_info(id, kind)
|
325
|
+
|
326
|
+
```ruby
|
327
|
+
begin
|
328
|
+
# Get deal progress for a specific kind
|
329
|
+
data, status_code, headers = api_instance.get_deals_id_progress_page_kind_with_http_info(id, kind)
|
330
|
+
p status_code # => 2xx
|
331
|
+
p headers # => { ... }
|
332
|
+
p data # => <V1EntitiesDealsProgress>
|
333
|
+
rescue DealMakerAPI::ApiError => e
|
334
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_kind_with_http_info: #{e}"
|
335
|
+
end
|
336
|
+
```
|
337
|
+
|
338
|
+
### Parameters
|
339
|
+
|
340
|
+
| Name | Type | Description | Notes |
|
341
|
+
| ---- | ---- | ----------- | ----- |
|
342
|
+
| **id** | **Integer** | The deal id. | |
|
343
|
+
| **kind** | **String** | Kind of progress. | |
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
[**V1EntitiesDealsProgress**](V1EntitiesDealsProgress.md)
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
No authorization required
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: Not defined
|
356
|
+
- **Accept**: application/json
|
357
|
+
|
358
|
+
|
290
359
|
## get_deals_id_summary
|
291
360
|
|
292
361
|
> get_deals_id_summary(id)
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::SetupSmsVerificationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **phone_number** | **String** | The phone number of the given user | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::SetupSmsVerificationRequest.new(
|
15
|
+
phone_number: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::TestDocumentUploadEmailRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user_id** | **Integer** | The user that will receive the email. | |
|
8
|
+
| **send_confidential_email** | **Boolean** | The send_confidential_email flag | |
|
9
|
+
| **json_email** | **String** | The json content email | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::TestDocumentUploadEmailRequest.new(
|
17
|
+
user_id: null,
|
18
|
+
send_confidential_email: null,
|
19
|
+
json_email: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **password** | **String** | The
|
7
|
+
| **password** | **String** | The new password for the user. | |
|
8
|
+
| **current_password** | **String** | The current password for the user. | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'DealMakerAPI'
|
13
14
|
|
14
15
|
instance = DealMakerAPI::UpdateUserPasswordRequest.new(
|
15
|
-
password: null
|
16
|
+
password: null,
|
17
|
+
current_password: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|