DealMakerAPI 0.105.3 → 0.106.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/docs/CreateReservationRequest.md +24 -0
- data/docs/DefaultApi.md +135 -0
- data/docs/PatchDealsIdPlatformEmailsDomainRequest.md +20 -0
- data/docs/PostDealsIdInvestors.md +2 -0
- data/docs/ReservationApi.md +74 -0
- data/docs/V1EntitiesDealsPlatformEmailsDomainSettings.md +20 -0
- data/docs/V1EntitiesTtwReservation.md +18 -0
- data/lib/DealMakerAPI/api/default_api.rb +135 -0
- data/lib/DealMakerAPI/api/reservation_api.rb +90 -0
- data/lib/DealMakerAPI/models/create_reservation_request.rb +259 -0
- data/lib/DealMakerAPI/models/patch_deals_id_platform_emails_domain_request.rb +239 -0
- data/lib/DealMakerAPI/models/post_deals_id_investors.rb +11 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_platform_emails_domain_settings.rb +226 -0
- data/lib/DealMakerAPI/models/v1_entities_ttw_reservation.rb +216 -0
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +5 -0
- data/spec/api/default_api_spec.rb +25 -0
- data/spec/api/reservation_api_spec.rb +47 -0
- data/spec/models/create_reservation_request_spec.rb +54 -0
- data/spec/models/patch_deals_id_platform_emails_domain_request_spec.rb +42 -0
- data/spec/models/post_deals_id_investors_spec.rb +6 -0
- data/spec/models/v1_entities_deals_platform_emails_domain_settings_spec.rb +42 -0
- data/spec/models/v1_entities_ttw_reservation_spec.rb +36 -0
- metadata +148 -128
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2cb5e7fa22612142eda0a8dcf0dcf279df603c93f4dde967c68cc02fb88edac4
|
4
|
+
data.tar.gz: 0a9fa749a45485cc12a366980de8e38834bb2a3e4dc034fcbb4de7ed632fc37f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cdc95b642bded7445b288ed5dea72c26a9f6367a3fe3a9fadf9cc203625655a89c634c48971d8870e71b73308bd2c285c77317347c92d951f07e6145fc296db5
|
7
|
+
data.tar.gz: 4af539f38b4f814d09d263c00c231ad5e7384fb35b582041c0c38c4c7c13c7014d6a474e92216770ba1cb2c836ba6edb201637da175f66dfbc8fa8dd2e78cfb9
|
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.106.0
|
342
342
|
- Generator version: 7.7.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.106.0.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.106.0.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.106.0'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -448,6 +448,7 @@ Class | Method | HTTP request | Description
|
|
448
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
|
449
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
|
450
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_platform_emails_domain**](docs/DefaultApi.md#get_deals_id_platform_emails_domain) | **GET** /deals/{id}/platform_emails/domain | Get the email domain settings for the deal
|
451
452
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page**](docs/DefaultApi.md#get_deals_id_progress_page) | **GET** /deals/{id}/progress_page | Get deal progress
|
452
453
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page_summary**](docs/DefaultApi.md#get_deals_id_progress_page_summary) | **GET** /deals/{id}/progress_page/summary | Get the deal progress summary
|
453
454
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_summary**](docs/DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview
|
@@ -456,6 +457,7 @@ Class | Method | HTTP request | Description
|
|
456
457
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
|
457
458
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_deals_search**](docs/DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user
|
458
459
|
*DealMakerAPI::DefaultApi* | [**get_webhooks_security_token**](docs/DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription
|
460
|
+
*DealMakerAPI::DefaultApi* | [**patch_deals_id_platform_emails_domain**](docs/DefaultApi.md#patch_deals_id_platform_emails_domain) | **PATCH** /deals/{id}/platform_emails/domain | Update the email domain settings for the deal
|
459
461
|
*DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form
|
460
462
|
*DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response
|
461
463
|
*DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form
|
@@ -496,6 +498,7 @@ Class | Method | HTTP request | Description
|
|
496
498
|
*DealMakerAPI::InvestorProfileApi* | [**patch_managed_profile**](docs/InvestorProfileApi.md#patch_managed_profile) | **PATCH** /investor_profiles/managed/{investor_profile_id} | Patch managed investor profile.
|
497
499
|
*DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
|
498
500
|
*DealMakerAPI::PaymentsApi* | [**post_deal_investor_payments_ira**](docs/PaymentsApi.md#post_deal_investor_payments_ira) | **POST** /deals/{id}/investors/{investor_id}/payments/ira | Creates a payment intent for express wire and mail its instructions.
|
501
|
+
*DealMakerAPI::ReservationApi* | [**create_reservation**](docs/ReservationApi.md#create_reservation) | **POST** /ttw/reservations | Create a new reservation
|
499
502
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
500
503
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
501
504
|
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
@@ -524,11 +527,13 @@ Class | Method | HTTP request | Description
|
|
524
527
|
- [DealMakerAPI::CreateDealSetupRequest](docs/CreateDealSetupRequest.md)
|
525
528
|
- [DealMakerAPI::CreateEmailTemplateRequest](docs/CreateEmailTemplateRequest.md)
|
526
529
|
- [DealMakerAPI::CreateMembersBulkUploadRequest](docs/CreateMembersBulkUploadRequest.md)
|
530
|
+
- [DealMakerAPI::CreateReservationRequest](docs/CreateReservationRequest.md)
|
527
531
|
- [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
|
528
532
|
- [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
|
529
533
|
- [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
|
530
534
|
- [DealMakerAPI::GetAccessTokenRequest](docs/GetAccessTokenRequest.md)
|
531
535
|
- [DealMakerAPI::PatchDealIncentivePlanRequest](docs/PatchDealIncentivePlanRequest.md)
|
536
|
+
- [DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest](docs/PatchDealsIdPlatformEmailsDomainRequest.md)
|
532
537
|
- [DealMakerAPI::PatchInvestorProfilesCorporations](docs/PatchInvestorProfilesCorporations.md)
|
533
538
|
- [DealMakerAPI::PatchInvestorProfilesCorporationsBeneficialOwnersInner](docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md)
|
534
539
|
- [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
|
@@ -583,6 +588,7 @@ Class | Method | HTTP request | Description
|
|
583
588
|
- [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
|
584
589
|
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
|
585
590
|
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent.md)
|
591
|
+
- [DealMakerAPI::V1EntitiesDealsPlatformEmailsDomainSettings](docs/V1EntitiesDealsPlatformEmailsDomainSettings.md)
|
586
592
|
- [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
|
587
593
|
- [DealMakerAPI::V1EntitiesDealsProgress](docs/V1EntitiesDealsProgress.md)
|
588
594
|
- [DealMakerAPI::V1EntitiesDealsProgressColumn](docs/V1EntitiesDealsProgressColumn.md)
|
@@ -638,6 +644,7 @@ Class | Method | HTTP request | Description
|
|
638
644
|
- [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
|
639
645
|
- [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
|
640
646
|
- [DealMakerAPI::V1EntitiesTtwCampaignResponse](docs/V1EntitiesTtwCampaignResponse.md)
|
647
|
+
- [DealMakerAPI::V1EntitiesTtwReservation](docs/V1EntitiesTtwReservation.md)
|
641
648
|
- [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
|
642
649
|
- [DealMakerAPI::V1EntitiesUsersBinding](docs/V1EntitiesUsersBinding.md)
|
643
650
|
- [DealMakerAPI::V1EntitiesUsersFactor](docs/V1EntitiesUsersFactor.md)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::CreateReservationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **campaign_id** | **Integer** | The id of the campaign | |
|
8
|
+
| **email** | **String** | The email of the user association with the reservation | |
|
9
|
+
| **name** | **String** | The name of the reservation | [optional] |
|
10
|
+
| **phone** | **String** | The phone of the user association with the reservation | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::CreateReservationRequest.new(
|
18
|
+
campaign_id: null,
|
19
|
+
email: null,
|
20
|
+
name: null,
|
21
|
+
phone: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
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_platform_emails_domain**](DefaultApi.md#get_deals_id_platform_emails_domain) | **GET** /deals/{id}/platform_emails/domain | Get the email domain settings for the deal |
|
11
12
|
| [**get_deals_id_progress_page**](DefaultApi.md#get_deals_id_progress_page) | **GET** /deals/{id}/progress_page | Get deal progress |
|
12
13
|
| [**get_deals_id_progress_page_summary**](DefaultApi.md#get_deals_id_progress_page_summary) | **GET** /deals/{id}/progress_page/summary | Get the deal progress summary |
|
13
14
|
| [**get_deals_id_summary**](DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview |
|
@@ -16,6 +17,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
16
17
|
| [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
|
17
18
|
| [**get_webhooks_deals_search**](DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user |
|
18
19
|
| [**get_webhooks_security_token**](DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription |
|
20
|
+
| [**patch_deals_id_platform_emails_domain**](DefaultApi.md#patch_deals_id_platform_emails_domain) | **PATCH** /deals/{id}/platform_emails/domain | Update the email domain settings for the deal |
|
19
21
|
| [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form |
|
20
22
|
| [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response |
|
21
23
|
| [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form |
|
@@ -290,6 +292,72 @@ No authorization required
|
|
290
292
|
- **Accept**: application/json
|
291
293
|
|
292
294
|
|
295
|
+
## get_deals_id_platform_emails_domain
|
296
|
+
|
297
|
+
> <V1EntitiesDealsPlatformEmailsDomainSettings> get_deals_id_platform_emails_domain(id)
|
298
|
+
|
299
|
+
Get the email domain settings for the deal
|
300
|
+
|
301
|
+
Get the email domain settings for the deal
|
302
|
+
|
303
|
+
### Examples
|
304
|
+
|
305
|
+
```ruby
|
306
|
+
require 'time'
|
307
|
+
require 'DealMakerAPI'
|
308
|
+
# setup authorization
|
309
|
+
DealMakerAPI.configure do |config|end
|
310
|
+
|
311
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
312
|
+
id = 56 # Integer | The deal id.
|
313
|
+
|
314
|
+
begin
|
315
|
+
# Get the email domain settings for the deal
|
316
|
+
result = api_instance.get_deals_id_platform_emails_domain(id)
|
317
|
+
p result
|
318
|
+
rescue DealMakerAPI::ApiError => e
|
319
|
+
puts "Error when calling DefaultApi->get_deals_id_platform_emails_domain: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
#### Using the get_deals_id_platform_emails_domain_with_http_info variant
|
324
|
+
|
325
|
+
This returns an Array which contains the response data, status code and headers.
|
326
|
+
|
327
|
+
> <Array(<V1EntitiesDealsPlatformEmailsDomainSettings>, Integer, Hash)> get_deals_id_platform_emails_domain_with_http_info(id)
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
begin
|
331
|
+
# Get the email domain settings for the deal
|
332
|
+
data, status_code, headers = api_instance.get_deals_id_platform_emails_domain_with_http_info(id)
|
333
|
+
p status_code # => 2xx
|
334
|
+
p headers # => { ... }
|
335
|
+
p data # => <V1EntitiesDealsPlatformEmailsDomainSettings>
|
336
|
+
rescue DealMakerAPI::ApiError => e
|
337
|
+
puts "Error when calling DefaultApi->get_deals_id_platform_emails_domain_with_http_info: #{e}"
|
338
|
+
end
|
339
|
+
```
|
340
|
+
|
341
|
+
### Parameters
|
342
|
+
|
343
|
+
| Name | Type | Description | Notes |
|
344
|
+
| ---- | ---- | ----------- | ----- |
|
345
|
+
| **id** | **Integer** | The deal id. | |
|
346
|
+
|
347
|
+
### Return type
|
348
|
+
|
349
|
+
[**V1EntitiesDealsPlatformEmailsDomainSettings**](V1EntitiesDealsPlatformEmailsDomainSettings.md)
|
350
|
+
|
351
|
+
### Authorization
|
352
|
+
|
353
|
+
No authorization required
|
354
|
+
|
355
|
+
### HTTP request headers
|
356
|
+
|
357
|
+
- **Content-Type**: Not defined
|
358
|
+
- **Accept**: application/json
|
359
|
+
|
360
|
+
|
293
361
|
## get_deals_id_progress_page
|
294
362
|
|
295
363
|
> <V1EntitiesDealsProgress> get_deals_id_progress_page(id)
|
@@ -811,6 +879,73 @@ No authorization required
|
|
811
879
|
- **Accept**: application/json
|
812
880
|
|
813
881
|
|
882
|
+
## patch_deals_id_platform_emails_domain
|
883
|
+
|
884
|
+
> patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request)
|
885
|
+
|
886
|
+
Update the email domain settings for the deal
|
887
|
+
|
888
|
+
Update the email domain settings for the deal
|
889
|
+
|
890
|
+
### Examples
|
891
|
+
|
892
|
+
```ruby
|
893
|
+
require 'time'
|
894
|
+
require 'DealMakerAPI'
|
895
|
+
# setup authorization
|
896
|
+
DealMakerAPI.configure do |config|end
|
897
|
+
|
898
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
899
|
+
id = 56 # Integer | The deal id.
|
900
|
+
patch_deals_id_platform_emails_domain_request = DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest.new({sender_name: 'sender_name_example', sender_email: 'sender_email_example'}) # PatchDealsIdPlatformEmailsDomainRequest |
|
901
|
+
|
902
|
+
begin
|
903
|
+
# Update the email domain settings for the deal
|
904
|
+
api_instance.patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request)
|
905
|
+
rescue DealMakerAPI::ApiError => e
|
906
|
+
puts "Error when calling DefaultApi->patch_deals_id_platform_emails_domain: #{e}"
|
907
|
+
end
|
908
|
+
```
|
909
|
+
|
910
|
+
#### Using the patch_deals_id_platform_emails_domain_with_http_info variant
|
911
|
+
|
912
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
913
|
+
|
914
|
+
> <Array(nil, Integer, Hash)> patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request)
|
915
|
+
|
916
|
+
```ruby
|
917
|
+
begin
|
918
|
+
# Update the email domain settings for the deal
|
919
|
+
data, status_code, headers = api_instance.patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request)
|
920
|
+
p status_code # => 2xx
|
921
|
+
p headers # => { ... }
|
922
|
+
p data # => nil
|
923
|
+
rescue DealMakerAPI::ApiError => e
|
924
|
+
puts "Error when calling DefaultApi->patch_deals_id_platform_emails_domain_with_http_info: #{e}"
|
925
|
+
end
|
926
|
+
```
|
927
|
+
|
928
|
+
### Parameters
|
929
|
+
|
930
|
+
| Name | Type | Description | Notes |
|
931
|
+
| ---- | ---- | ----------- | ----- |
|
932
|
+
| **id** | **Integer** | The deal id. | |
|
933
|
+
| **patch_deals_id_platform_emails_domain_request** | [**PatchDealsIdPlatformEmailsDomainRequest**](PatchDealsIdPlatformEmailsDomainRequest.md) | | |
|
934
|
+
|
935
|
+
### Return type
|
936
|
+
|
937
|
+
nil (empty response body)
|
938
|
+
|
939
|
+
### Authorization
|
940
|
+
|
941
|
+
No authorization required
|
942
|
+
|
943
|
+
### HTTP request headers
|
944
|
+
|
945
|
+
- **Content-Type**: application/json
|
946
|
+
- **Accept**: Not defined
|
947
|
+
|
948
|
+
|
814
949
|
## post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit
|
815
950
|
|
816
951
|
> <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult> post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit(deal_id)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sender_name** | **String** | The sender name. | |
|
8
|
+
| **sender_email** | **String** | The sender email. It must match an authenticated domain. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::PatchDealsIdPlatformEmailsDomainRequest.new(
|
16
|
+
sender_name: null,
|
17
|
+
sender_email: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **email** | **String** | The investor email address. | |
|
8
|
+
| **email_confirmation** | **String** | The investor confirmation email address. | [optional] |
|
8
9
|
| **investor_profile_id** | **Integer** | The Investor Profile id. | [optional] |
|
9
10
|
| **tags** | **Array<String>** | | [optional] |
|
10
11
|
| **first_name** | **String** | The first name of the investor. | [optional] |
|
@@ -24,6 +25,7 @@ require 'DealMakerAPI'
|
|
24
25
|
|
25
26
|
instance = DealMakerAPI::PostDealsIdInvestors.new(
|
26
27
|
email: null,
|
28
|
+
email_confirmation: null,
|
27
29
|
investor_profile_id: null,
|
28
30
|
tags: null,
|
29
31
|
first_name: null,
|
@@ -0,0 +1,74 @@
|
|
1
|
+
# DealMakerAPI::ReservationApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_reservation**](ReservationApi.md#create_reservation) | **POST** /ttw/reservations | Create a new reservation |
|
8
|
+
|
9
|
+
|
10
|
+
## create_reservation
|
11
|
+
|
12
|
+
> <V1EntitiesTtwReservation> create_reservation(create_reservation_request)
|
13
|
+
|
14
|
+
Create a new reservation
|
15
|
+
|
16
|
+
Create a new reservation
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'DealMakerAPI'
|
23
|
+
# setup authorization
|
24
|
+
DealMakerAPI.configure do |config|end
|
25
|
+
|
26
|
+
api_instance = DealMakerAPI::ReservationApi.new
|
27
|
+
create_reservation_request = DealMakerAPI::CreateReservationRequest.new({campaign_id: 37, email: 'email_example'}) # CreateReservationRequest |
|
28
|
+
|
29
|
+
begin
|
30
|
+
# Create a new reservation
|
31
|
+
result = api_instance.create_reservation(create_reservation_request)
|
32
|
+
p result
|
33
|
+
rescue DealMakerAPI::ApiError => e
|
34
|
+
puts "Error when calling ReservationApi->create_reservation: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the create_reservation_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(<V1EntitiesTtwReservation>, Integer, Hash)> create_reservation_with_http_info(create_reservation_request)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
# Create a new reservation
|
47
|
+
data, status_code, headers = api_instance.create_reservation_with_http_info(create_reservation_request)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => <V1EntitiesTtwReservation>
|
51
|
+
rescue DealMakerAPI::ApiError => e
|
52
|
+
puts "Error when calling ReservationApi->create_reservation_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **create_reservation_request** | [**CreateReservationRequest**](CreateReservationRequest.md) | | |
|
61
|
+
|
62
|
+
### Return type
|
63
|
+
|
64
|
+
[**V1EntitiesTtwReservation**](V1EntitiesTtwReservation.md)
|
65
|
+
|
66
|
+
### Authorization
|
67
|
+
|
68
|
+
No authorization required
|
69
|
+
|
70
|
+
### HTTP request headers
|
71
|
+
|
72
|
+
- **Content-Type**: application/json
|
73
|
+
- **Accept**: application/json
|
74
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsPlatformEmailsDomainSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **sender_name** | **String** | The name of the sender. | [optional] |
|
8
|
+
| **sender_email** | **String** | The email address of the sender. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDealsPlatformEmailsDomainSettings.new(
|
16
|
+
sender_name: null,
|
17
|
+
sender_email: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesTtwReservation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The ID of the reservation. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesTtwReservation.new(
|
15
|
+
id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -277,6 +277,69 @@ module DealMakerAPI
|
|
277
277
|
return data, status_code, headers
|
278
278
|
end
|
279
279
|
|
280
|
+
# Get the email domain settings for the deal
|
281
|
+
# Get the email domain settings for the deal
|
282
|
+
# @param id [Integer] The deal id.
|
283
|
+
# @param [Hash] opts the optional parameters
|
284
|
+
# @return [V1EntitiesDealsPlatformEmailsDomainSettings]
|
285
|
+
def get_deals_id_platform_emails_domain(id, opts = {})
|
286
|
+
data, _status_code, _headers = get_deals_id_platform_emails_domain_with_http_info(id, opts)
|
287
|
+
data
|
288
|
+
end
|
289
|
+
|
290
|
+
# Get the email domain settings for the deal
|
291
|
+
# Get the email domain settings for the deal
|
292
|
+
# @param id [Integer] The deal id.
|
293
|
+
# @param [Hash] opts the optional parameters
|
294
|
+
# @return [Array<(V1EntitiesDealsPlatformEmailsDomainSettings, Integer, Hash)>] V1EntitiesDealsPlatformEmailsDomainSettings data, response status code and response headers
|
295
|
+
def get_deals_id_platform_emails_domain_with_http_info(id, opts = {})
|
296
|
+
if @api_client.config.debugging
|
297
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_id_platform_emails_domain ...'
|
298
|
+
end
|
299
|
+
# verify the required parameter 'id' is set
|
300
|
+
if @api_client.config.client_side_validation && id.nil?
|
301
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.get_deals_id_platform_emails_domain"
|
302
|
+
end
|
303
|
+
# resource path
|
304
|
+
local_var_path = '/deals/{id}/platform_emails/domain'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
305
|
+
|
306
|
+
# query parameters
|
307
|
+
query_params = opts[:query_params] || {}
|
308
|
+
|
309
|
+
# header parameters
|
310
|
+
header_params = opts[:header_params] || {}
|
311
|
+
# HTTP header 'Accept' (if needed)
|
312
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
313
|
+
|
314
|
+
# form parameters
|
315
|
+
form_params = opts[:form_params] || {}
|
316
|
+
|
317
|
+
# http body (model)
|
318
|
+
post_body = opts[:debug_body]
|
319
|
+
|
320
|
+
# return_type
|
321
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesDealsPlatformEmailsDomainSettings'
|
322
|
+
|
323
|
+
# auth_names
|
324
|
+
auth_names = opts[:debug_auth_names] || []
|
325
|
+
|
326
|
+
new_options = opts.merge(
|
327
|
+
:operation => :"DefaultApi.get_deals_id_platform_emails_domain",
|
328
|
+
:header_params => header_params,
|
329
|
+
:query_params => query_params,
|
330
|
+
:form_params => form_params,
|
331
|
+
:body => post_body,
|
332
|
+
:auth_names => auth_names,
|
333
|
+
:return_type => return_type
|
334
|
+
)
|
335
|
+
|
336
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
337
|
+
if @api_client.config.debugging
|
338
|
+
@api_client.config.logger.debug "API called: DefaultApi#get_deals_id_platform_emails_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
339
|
+
end
|
340
|
+
return data, status_code, headers
|
341
|
+
end
|
342
|
+
|
280
343
|
# Get deal progress
|
281
344
|
# Get deal progress
|
282
345
|
# @param id [Integer] The deal id.
|
@@ -762,6 +825,78 @@ module DealMakerAPI
|
|
762
825
|
return data, status_code, headers
|
763
826
|
end
|
764
827
|
|
828
|
+
# Update the email domain settings for the deal
|
829
|
+
# Update the email domain settings for the deal
|
830
|
+
# @param id [Integer] The deal id.
|
831
|
+
# @param patch_deals_id_platform_emails_domain_request [PatchDealsIdPlatformEmailsDomainRequest]
|
832
|
+
# @param [Hash] opts the optional parameters
|
833
|
+
# @return [nil]
|
834
|
+
def patch_deals_id_platform_emails_domain(id, patch_deals_id_platform_emails_domain_request, opts = {})
|
835
|
+
patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request, opts)
|
836
|
+
nil
|
837
|
+
end
|
838
|
+
|
839
|
+
# Update the email domain settings for the deal
|
840
|
+
# Update the email domain settings for the deal
|
841
|
+
# @param id [Integer] The deal id.
|
842
|
+
# @param patch_deals_id_platform_emails_domain_request [PatchDealsIdPlatformEmailsDomainRequest]
|
843
|
+
# @param [Hash] opts the optional parameters
|
844
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
845
|
+
def patch_deals_id_platform_emails_domain_with_http_info(id, patch_deals_id_platform_emails_domain_request, opts = {})
|
846
|
+
if @api_client.config.debugging
|
847
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.patch_deals_id_platform_emails_domain ...'
|
848
|
+
end
|
849
|
+
# verify the required parameter 'id' is set
|
850
|
+
if @api_client.config.client_side_validation && id.nil?
|
851
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.patch_deals_id_platform_emails_domain"
|
852
|
+
end
|
853
|
+
# verify the required parameter 'patch_deals_id_platform_emails_domain_request' is set
|
854
|
+
if @api_client.config.client_side_validation && patch_deals_id_platform_emails_domain_request.nil?
|
855
|
+
fail ArgumentError, "Missing the required parameter 'patch_deals_id_platform_emails_domain_request' when calling DefaultApi.patch_deals_id_platform_emails_domain"
|
856
|
+
end
|
857
|
+
# resource path
|
858
|
+
local_var_path = '/deals/{id}/platform_emails/domain'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
859
|
+
|
860
|
+
# query parameters
|
861
|
+
query_params = opts[:query_params] || {}
|
862
|
+
|
863
|
+
# header parameters
|
864
|
+
header_params = opts[:header_params] || {}
|
865
|
+
# HTTP header 'Content-Type'
|
866
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
867
|
+
if !content_type.nil?
|
868
|
+
header_params['Content-Type'] = content_type
|
869
|
+
end
|
870
|
+
|
871
|
+
# form parameters
|
872
|
+
form_params = opts[:form_params] || {}
|
873
|
+
|
874
|
+
# http body (model)
|
875
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_deals_id_platform_emails_domain_request)
|
876
|
+
|
877
|
+
# return_type
|
878
|
+
return_type = opts[:debug_return_type]
|
879
|
+
|
880
|
+
# auth_names
|
881
|
+
auth_names = opts[:debug_auth_names] || []
|
882
|
+
|
883
|
+
new_options = opts.merge(
|
884
|
+
:operation => :"DefaultApi.patch_deals_id_platform_emails_domain",
|
885
|
+
:header_params => header_params,
|
886
|
+
:query_params => query_params,
|
887
|
+
:form_params => form_params,
|
888
|
+
:body => post_body,
|
889
|
+
:auth_names => auth_names,
|
890
|
+
:return_type => return_type
|
891
|
+
)
|
892
|
+
|
893
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
894
|
+
if @api_client.config.debugging
|
895
|
+
@api_client.config.logger.debug "API called: DefaultApi#patch_deals_id_platform_emails_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
896
|
+
end
|
897
|
+
return data, status_code, headers
|
898
|
+
end
|
899
|
+
|
765
900
|
# Submit a payout account details form
|
766
901
|
# Submit a payout account details form
|
767
902
|
# @param deal_id [Integer]
|