DealMakerAPI 0.107.3 → 0.107.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 +8 -5
- data/docs/DealApi.md +80 -7
- data/docs/DefaultApi.md +66 -0
- data/docs/PatchPlatformEmailPageRequest.md +20 -0
- data/docs/V1EntitiesUsersContexts.md +4 -0
- data/lib/DealMakerAPI/api/deal_api.rb +95 -9
- data/lib/DealMakerAPI/api/default_api.rb +61 -0
- data/lib/DealMakerAPI/models/patch_platform_email_page_request.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_users_contexts.rb +20 -1
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +1 -0
- data/spec/api/deal_api_spec.rb +15 -1
- data/spec/api/default_api_spec.rb +12 -0
- data/spec/models/patch_platform_email_page_request_spec.rb +42 -0
- data/spec/models/v1_entities_users_contexts_spec.rb +12 -0
- metadata +145 -141
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 81936a41aa12b403d9a4fc4837b0c18e62dc5e7ca33fbf8815229a1350fe1208
|
|
4
|
+
data.tar.gz: 9ab08efc4064b469677abf99f3f1c04d94c21e8b50fb725f29d18caf96b90b9b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8a3bf5764df07d9e449ce327fd7bacd56f053d42297b4703b95c94fd27bb6df0cac85d07780bc1a849a296a871e0b6197ca83856123cd7e427beb4e61dcddc5a
|
|
7
|
+
data.tar.gz: 8cd00522d99bd1ad7febfb3d279cdb90242cbdb0d9b5b050921c419aa1e42c701ff682e634902b12bd2bd0a6cb0b13337df94de7b0c89de1f3d4a56928c6b499
|
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.107.
|
|
341
|
+
- Package version: 0.107.5
|
|
342
342
|
- Generator version: 7.8.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.107.
|
|
358
|
+
gem install ./DealMakerAPI-0.107.5.gem
|
|
359
359
|
```
|
|
360
360
|
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.107.
|
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.107.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.107.
|
|
367
|
+
gem 'DealMakerAPI', '~> 0.107.5'
|
|
368
368
|
|
|
369
369
|
### Install from Git
|
|
370
370
|
|
|
@@ -443,10 +443,11 @@ Class | Method | HTTP request | Description
|
|
|
443
443
|
*DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
|
444
444
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
|
445
445
|
*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
|
-
*DealMakerAPI::DealApi* | [**get_platform_email_page**](docs/DealApi.md#get_platform_email_page) | **GET** /deals/{id}/platform_emails/{
|
|
446
|
+
*DealMakerAPI::DealApi* | [**get_platform_email_page**](docs/DealApi.md#get_platform_email_page) | **GET** /deals/{id}/platform_emails/{kind}/page | Get the Page for a given Platform Email
|
|
447
447
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
|
448
448
|
*DealMakerAPI::DealApi* | [**list_platform_emails**](docs/DealApi.md#list_platform_emails) | **GET** /deals/{id}/platform_emails | Get a list of platform emails for the deal
|
|
449
449
|
*DealMakerAPI::DealApi* | [**patch_platform_email**](docs/DealApi.md#patch_platform_email) | **PATCH** /deals/{id}/platform_emails/{kind}/update | Patch platform email by kind and deal.
|
|
450
|
+
*DealMakerAPI::DealApi* | [**patch_platform_email_page**](docs/DealApi.md#patch_platform_email_page) | **PATCH** /deals/{id}/platform_emails/{kind}/page | Create and associate a page with a platform email or update the existing page
|
|
450
451
|
*DealMakerAPI::DealsApi* | [**post_deals_id_email_campaign_email_campaign_id_send_email**](docs/DealsApi.md#post_deals_id_email_campaign_email_campaign_id_send_email) | **POST** /deals/{id}/email_campaign/{email_campaign_id}/send_email | Send emails to all the investors invited to the material change campaign
|
|
451
452
|
*DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
|
|
452
453
|
*DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage
|
|
@@ -466,6 +467,7 @@ Class | Method | HTTP request | Description
|
|
|
466
467
|
*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
|
|
467
468
|
*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
|
|
468
469
|
*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
|
|
470
|
+
*DealMakerAPI::DefaultApi* | [**post_investors_investor_id_delete_investment_process**](docs/DefaultApi.md#post_investors_investor_id_delete_investment_process) | **POST** /investors/{investor_id}/delete_investment/process | Delete investment
|
|
469
471
|
*DealMakerAPI::DefaultApi* | [**post_investors_investor_id_transactions_request_refund_process**](docs/DefaultApi.md#post_investors_investor_id_transactions_request_refund_process) | **POST** /investors/{investor_id}/transactions/request_refund/process | Request refund for investor transactions
|
|
470
472
|
*DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
|
|
471
473
|
*DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
|
|
@@ -553,6 +555,7 @@ Class | Method | HTTP request | Description
|
|
|
553
555
|
- [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
|
|
554
556
|
- [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
|
|
555
557
|
- [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
|
|
558
|
+
- [DealMakerAPI::PatchPlatformEmailPageRequest](docs/PatchPlatformEmailPageRequest.md)
|
|
556
559
|
- [DealMakerAPI::PatchPlatformEmailRequest](docs/PatchPlatformEmailRequest.md)
|
|
557
560
|
- [DealMakerAPI::PostDealIncentivePlanRequest](docs/PostDealIncentivePlanRequest.md)
|
|
558
561
|
- [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
|
data/docs/DealApi.md
CHANGED
|
@@ -9,10 +9,11 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
9
9
|
| [**create_deal_setup**](DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
|
|
10
10
|
| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
|
|
11
11
|
| [**get_deal_incentive_plan**](DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id |
|
|
12
|
-
| [**get_platform_email_page**](DealApi.md#get_platform_email_page) | **GET** /deals/{id}/platform_emails/{
|
|
12
|
+
| [**get_platform_email_page**](DealApi.md#get_platform_email_page) | **GET** /deals/{id}/platform_emails/{kind}/page | Get the Page for a given Platform Email |
|
|
13
13
|
| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
|
|
14
14
|
| [**list_platform_emails**](DealApi.md#list_platform_emails) | **GET** /deals/{id}/platform_emails | Get a list of platform emails for the deal |
|
|
15
15
|
| [**patch_platform_email**](DealApi.md#patch_platform_email) | **PATCH** /deals/{id}/platform_emails/{kind}/update | Patch platform email by kind and deal. |
|
|
16
|
+
| [**patch_platform_email_page**](DealApi.md#patch_platform_email_page) | **PATCH** /deals/{id}/platform_emails/{kind}/page | Create and associate a page with a platform email or update the existing page |
|
|
16
17
|
|
|
17
18
|
|
|
18
19
|
## ach_bank_account_setup_intent
|
|
@@ -357,7 +358,7 @@ No authorization required
|
|
|
357
358
|
|
|
358
359
|
## get_platform_email_page
|
|
359
360
|
|
|
360
|
-
> <V1EntitiesPage> get_platform_email_page(id,
|
|
361
|
+
> <V1EntitiesPage> get_platform_email_page(id, kind)
|
|
361
362
|
|
|
362
363
|
Get the Page for a given Platform Email
|
|
363
364
|
|
|
@@ -373,11 +374,11 @@ DealMakerAPI.configure do |config|end
|
|
|
373
374
|
|
|
374
375
|
api_instance = DealMakerAPI::DealApi.new
|
|
375
376
|
id = 56 # Integer | The deal id.
|
|
376
|
-
|
|
377
|
+
kind = 'global' # String | The platform email id.
|
|
377
378
|
|
|
378
379
|
begin
|
|
379
380
|
# Get the Page for a given Platform Email
|
|
380
|
-
result = api_instance.get_platform_email_page(id,
|
|
381
|
+
result = api_instance.get_platform_email_page(id, kind)
|
|
381
382
|
p result
|
|
382
383
|
rescue DealMakerAPI::ApiError => e
|
|
383
384
|
puts "Error when calling DealApi->get_platform_email_page: #{e}"
|
|
@@ -388,12 +389,12 @@ end
|
|
|
388
389
|
|
|
389
390
|
This returns an Array which contains the response data, status code and headers.
|
|
390
391
|
|
|
391
|
-
> <Array(<V1EntitiesPage>, Integer, Hash)> get_platform_email_page_with_http_info(id,
|
|
392
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> get_platform_email_page_with_http_info(id, kind)
|
|
392
393
|
|
|
393
394
|
```ruby
|
|
394
395
|
begin
|
|
395
396
|
# Get the Page for a given Platform Email
|
|
396
|
-
data, status_code, headers = api_instance.get_platform_email_page_with_http_info(id,
|
|
397
|
+
data, status_code, headers = api_instance.get_platform_email_page_with_http_info(id, kind)
|
|
397
398
|
p status_code # => 2xx
|
|
398
399
|
p headers # => { ... }
|
|
399
400
|
p data # => <V1EntitiesPage>
|
|
@@ -407,7 +408,7 @@ end
|
|
|
407
408
|
| Name | Type | Description | Notes |
|
|
408
409
|
| ---- | ---- | ----------- | ----- |
|
|
409
410
|
| **id** | **Integer** | The deal id. | |
|
|
410
|
-
| **
|
|
411
|
+
| **kind** | **String** | The platform email id. | |
|
|
411
412
|
|
|
412
413
|
### Return type
|
|
413
414
|
|
|
@@ -630,3 +631,75 @@ No authorization required
|
|
|
630
631
|
- **Content-Type**: application/json
|
|
631
632
|
- **Accept**: application/json
|
|
632
633
|
|
|
634
|
+
|
|
635
|
+
## patch_platform_email_page
|
|
636
|
+
|
|
637
|
+
> <V1EntitiesPage> patch_platform_email_page(id, kind, opts)
|
|
638
|
+
|
|
639
|
+
Create and associate a page with a platform email or update the existing page
|
|
640
|
+
|
|
641
|
+
Create and associate a page with a platform email or update the existing page
|
|
642
|
+
|
|
643
|
+
### Examples
|
|
644
|
+
|
|
645
|
+
```ruby
|
|
646
|
+
require 'time'
|
|
647
|
+
require 'DealMakerAPI'
|
|
648
|
+
# setup authorization
|
|
649
|
+
DealMakerAPI.configure do |config|end
|
|
650
|
+
|
|
651
|
+
api_instance = DealMakerAPI::DealApi.new
|
|
652
|
+
id = 56 # Integer | The deal id.
|
|
653
|
+
kind = 'global' # String | The platform email id.
|
|
654
|
+
opts = {
|
|
655
|
+
patch_platform_email_page_request: DealMakerAPI::PatchPlatformEmailPageRequest.new # PatchPlatformEmailPageRequest |
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
begin
|
|
659
|
+
# Create and associate a page with a platform email or update the existing page
|
|
660
|
+
result = api_instance.patch_platform_email_page(id, kind, opts)
|
|
661
|
+
p result
|
|
662
|
+
rescue DealMakerAPI::ApiError => e
|
|
663
|
+
puts "Error when calling DealApi->patch_platform_email_page: #{e}"
|
|
664
|
+
end
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
#### Using the patch_platform_email_page_with_http_info variant
|
|
668
|
+
|
|
669
|
+
This returns an Array which contains the response data, status code and headers.
|
|
670
|
+
|
|
671
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> patch_platform_email_page_with_http_info(id, kind, opts)
|
|
672
|
+
|
|
673
|
+
```ruby
|
|
674
|
+
begin
|
|
675
|
+
# Create and associate a page with a platform email or update the existing page
|
|
676
|
+
data, status_code, headers = api_instance.patch_platform_email_page_with_http_info(id, kind, opts)
|
|
677
|
+
p status_code # => 2xx
|
|
678
|
+
p headers # => { ... }
|
|
679
|
+
p data # => <V1EntitiesPage>
|
|
680
|
+
rescue DealMakerAPI::ApiError => e
|
|
681
|
+
puts "Error when calling DealApi->patch_platform_email_page_with_http_info: #{e}"
|
|
682
|
+
end
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
### Parameters
|
|
686
|
+
|
|
687
|
+
| Name | Type | Description | Notes |
|
|
688
|
+
| ---- | ---- | ----------- | ----- |
|
|
689
|
+
| **id** | **Integer** | The deal id. | |
|
|
690
|
+
| **kind** | **String** | The platform email id. | |
|
|
691
|
+
| **patch_platform_email_page_request** | [**PatchPlatformEmailPageRequest**](PatchPlatformEmailPageRequest.md) | | [optional] |
|
|
692
|
+
|
|
693
|
+
### Return type
|
|
694
|
+
|
|
695
|
+
[**V1EntitiesPage**](V1EntitiesPage.md)
|
|
696
|
+
|
|
697
|
+
### Authorization
|
|
698
|
+
|
|
699
|
+
No authorization required
|
|
700
|
+
|
|
701
|
+
### HTTP request headers
|
|
702
|
+
|
|
703
|
+
- **Content-Type**: application/json
|
|
704
|
+
- **Accept**: application/json
|
|
705
|
+
|
data/docs/DefaultApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
21
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 |
|
|
22
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 |
|
|
23
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 |
|
|
24
|
+
| [**post_investors_investor_id_delete_investment_process**](DefaultApi.md#post_investors_investor_id_delete_investment_process) | **POST** /investors/{investor_id}/delete_investment/process | Delete investment |
|
|
24
25
|
| [**post_investors_investor_id_transactions_request_refund_process**](DefaultApi.md#post_investors_investor_id_transactions_request_refund_process) | **POST** /investors/{investor_id}/transactions/request_refund/process | Request refund for investor transactions |
|
|
25
26
|
| [**post_webhooks**](DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user |
|
|
26
27
|
| [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
|
|
@@ -1143,6 +1144,71 @@ No authorization required
|
|
|
1143
1144
|
- **Accept**: application/json
|
|
1144
1145
|
|
|
1145
1146
|
|
|
1147
|
+
## post_investors_investor_id_delete_investment_process
|
|
1148
|
+
|
|
1149
|
+
> post_investors_investor_id_delete_investment_process(investor_id)
|
|
1150
|
+
|
|
1151
|
+
Delete investment
|
|
1152
|
+
|
|
1153
|
+
Delete investment
|
|
1154
|
+
|
|
1155
|
+
### Examples
|
|
1156
|
+
|
|
1157
|
+
```ruby
|
|
1158
|
+
require 'time'
|
|
1159
|
+
require 'DealMakerAPI'
|
|
1160
|
+
# setup authorization
|
|
1161
|
+
DealMakerAPI.configure do |config|end
|
|
1162
|
+
|
|
1163
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
|
1164
|
+
investor_id = 56 # Integer |
|
|
1165
|
+
|
|
1166
|
+
begin
|
|
1167
|
+
# Delete investment
|
|
1168
|
+
api_instance.post_investors_investor_id_delete_investment_process(investor_id)
|
|
1169
|
+
rescue DealMakerAPI::ApiError => e
|
|
1170
|
+
puts "Error when calling DefaultApi->post_investors_investor_id_delete_investment_process: #{e}"
|
|
1171
|
+
end
|
|
1172
|
+
```
|
|
1173
|
+
|
|
1174
|
+
#### Using the post_investors_investor_id_delete_investment_process_with_http_info variant
|
|
1175
|
+
|
|
1176
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1177
|
+
|
|
1178
|
+
> <Array(nil, Integer, Hash)> post_investors_investor_id_delete_investment_process_with_http_info(investor_id)
|
|
1179
|
+
|
|
1180
|
+
```ruby
|
|
1181
|
+
begin
|
|
1182
|
+
# Delete investment
|
|
1183
|
+
data, status_code, headers = api_instance.post_investors_investor_id_delete_investment_process_with_http_info(investor_id)
|
|
1184
|
+
p status_code # => 2xx
|
|
1185
|
+
p headers # => { ... }
|
|
1186
|
+
p data # => nil
|
|
1187
|
+
rescue DealMakerAPI::ApiError => e
|
|
1188
|
+
puts "Error when calling DefaultApi->post_investors_investor_id_delete_investment_process_with_http_info: #{e}"
|
|
1189
|
+
end
|
|
1190
|
+
```
|
|
1191
|
+
|
|
1192
|
+
### Parameters
|
|
1193
|
+
|
|
1194
|
+
| Name | Type | Description | Notes |
|
|
1195
|
+
| ---- | ---- | ----------- | ----- |
|
|
1196
|
+
| **investor_id** | **Integer** | | |
|
|
1197
|
+
|
|
1198
|
+
### Return type
|
|
1199
|
+
|
|
1200
|
+
nil (empty response body)
|
|
1201
|
+
|
|
1202
|
+
### Authorization
|
|
1203
|
+
|
|
1204
|
+
No authorization required
|
|
1205
|
+
|
|
1206
|
+
### HTTP request headers
|
|
1207
|
+
|
|
1208
|
+
- **Content-Type**: Not defined
|
|
1209
|
+
- **Accept**: Not defined
|
|
1210
|
+
|
|
1211
|
+
|
|
1146
1212
|
## post_investors_investor_id_transactions_request_refund_process
|
|
1147
1213
|
|
|
1148
1214
|
> post_investors_investor_id_transactions_request_refund_process(investor_id)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DealMakerAPI::PatchPlatformEmailPageRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **draft_json_content** | **String** | The invitation page draft json content | [optional] |
|
|
8
|
+
| **name** | **String** | The name of the invitation page. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'DealMakerAPI'
|
|
14
|
+
|
|
15
|
+
instance = DealMakerAPI::PatchPlatformEmailPageRequest.new(
|
|
16
|
+
draft_json_content: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **has_investments** | **Boolean** | A boolean indicating if the user has investments. | [optional] |
|
|
8
|
+
| **default** | [**V1EntitiesUsersContext**](V1EntitiesUsersContext.md) | | [optional] |
|
|
7
9
|
| **contexts** | [**V1EntitiesUsersContext**](V1EntitiesUsersContext.md) | | [optional] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
@@ -12,6 +14,8 @@
|
|
|
12
14
|
require 'DealMakerAPI'
|
|
13
15
|
|
|
14
16
|
instance = DealMakerAPI::V1EntitiesUsersContexts.new(
|
|
17
|
+
has_investments: null,
|
|
18
|
+
default: null,
|
|
15
19
|
contexts: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
@@ -369,21 +369,21 @@ module DealMakerAPI
|
|
|
369
369
|
# Get the Page for a given Platform Email
|
|
370
370
|
# Get the Page for a given Platform Email
|
|
371
371
|
# @param id [Integer] The deal id.
|
|
372
|
-
# @param
|
|
372
|
+
# @param kind [String] The platform email id.
|
|
373
373
|
# @param [Hash] opts the optional parameters
|
|
374
374
|
# @return [V1EntitiesPage]
|
|
375
|
-
def get_platform_email_page(id,
|
|
376
|
-
data, _status_code, _headers = get_platform_email_page_with_http_info(id,
|
|
375
|
+
def get_platform_email_page(id, kind, opts = {})
|
|
376
|
+
data, _status_code, _headers = get_platform_email_page_with_http_info(id, kind, opts)
|
|
377
377
|
data
|
|
378
378
|
end
|
|
379
379
|
|
|
380
380
|
# Get the Page for a given Platform Email
|
|
381
381
|
# Get the Page for a given Platform Email
|
|
382
382
|
# @param id [Integer] The deal id.
|
|
383
|
-
# @param
|
|
383
|
+
# @param kind [String] The platform email id.
|
|
384
384
|
# @param [Hash] opts the optional parameters
|
|
385
385
|
# @return [Array<(V1EntitiesPage, Integer, Hash)>] V1EntitiesPage data, response status code and response headers
|
|
386
|
-
def get_platform_email_page_with_http_info(id,
|
|
386
|
+
def get_platform_email_page_with_http_info(id, kind, opts = {})
|
|
387
387
|
if @api_client.config.debugging
|
|
388
388
|
@api_client.config.logger.debug 'Calling API: DealApi.get_platform_email_page ...'
|
|
389
389
|
end
|
|
@@ -391,12 +391,17 @@ module DealMakerAPI
|
|
|
391
391
|
if @api_client.config.client_side_validation && id.nil?
|
|
392
392
|
fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.get_platform_email_page"
|
|
393
393
|
end
|
|
394
|
-
# verify the required parameter '
|
|
395
|
-
if @api_client.config.client_side_validation &&
|
|
396
|
-
fail ArgumentError, "Missing the required parameter '
|
|
394
|
+
# verify the required parameter 'kind' is set
|
|
395
|
+
if @api_client.config.client_side_validation && kind.nil?
|
|
396
|
+
fail ArgumentError, "Missing the required parameter 'kind' when calling DealApi.get_platform_email_page"
|
|
397
|
+
end
|
|
398
|
+
# verify enum value
|
|
399
|
+
allowable_values = ["global", "introduction_email", "manual_email", "funnel_start_reminder", "mid_funnel_reminder", "end_of_funnel_reminder", "payment_reminder_email", "payment_failure_email", "payment_confirmation_email", "document_reminder_email", "next_steps_email", "acceptance_email", "reset_signature_or_agreement", "refund_email", "access_link", "payment_instructions", "microdeposit_email", "closing_campaign_email", "closing_opt_out_email", "material_change_email"]
|
|
400
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(kind)
|
|
401
|
+
fail ArgumentError, "invalid value for \"kind\", must be one of #{allowable_values}"
|
|
397
402
|
end
|
|
398
403
|
# resource path
|
|
399
|
-
local_var_path = '/deals/{id}/platform_emails/{
|
|
404
|
+
local_var_path = '/deals/{id}/platform_emails/{kind}/page'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'kind' + '}', CGI.escape(kind.to_s))
|
|
400
405
|
|
|
401
406
|
# query parameters
|
|
402
407
|
query_params = opts[:query_params] || {}
|
|
@@ -643,5 +648,86 @@ module DealMakerAPI
|
|
|
643
648
|
end
|
|
644
649
|
return data, status_code, headers
|
|
645
650
|
end
|
|
651
|
+
|
|
652
|
+
# Create and associate a page with a platform email or update the existing page
|
|
653
|
+
# Create and associate a page with a platform email or update the existing page
|
|
654
|
+
# @param id [Integer] The deal id.
|
|
655
|
+
# @param kind [String] The platform email id.
|
|
656
|
+
# @param [Hash] opts the optional parameters
|
|
657
|
+
# @option opts [PatchPlatformEmailPageRequest] :patch_platform_email_page_request
|
|
658
|
+
# @return [V1EntitiesPage]
|
|
659
|
+
def patch_platform_email_page(id, kind, opts = {})
|
|
660
|
+
data, _status_code, _headers = patch_platform_email_page_with_http_info(id, kind, opts)
|
|
661
|
+
data
|
|
662
|
+
end
|
|
663
|
+
|
|
664
|
+
# Create and associate a page with a platform email or update the existing page
|
|
665
|
+
# Create and associate a page with a platform email or update the existing page
|
|
666
|
+
# @param id [Integer] The deal id.
|
|
667
|
+
# @param kind [String] The platform email id.
|
|
668
|
+
# @param [Hash] opts the optional parameters
|
|
669
|
+
# @option opts [PatchPlatformEmailPageRequest] :patch_platform_email_page_request
|
|
670
|
+
# @return [Array<(V1EntitiesPage, Integer, Hash)>] V1EntitiesPage data, response status code and response headers
|
|
671
|
+
def patch_platform_email_page_with_http_info(id, kind, opts = {})
|
|
672
|
+
if @api_client.config.debugging
|
|
673
|
+
@api_client.config.logger.debug 'Calling API: DealApi.patch_platform_email_page ...'
|
|
674
|
+
end
|
|
675
|
+
# verify the required parameter 'id' is set
|
|
676
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
677
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DealApi.patch_platform_email_page"
|
|
678
|
+
end
|
|
679
|
+
# verify the required parameter 'kind' is set
|
|
680
|
+
if @api_client.config.client_side_validation && kind.nil?
|
|
681
|
+
fail ArgumentError, "Missing the required parameter 'kind' when calling DealApi.patch_platform_email_page"
|
|
682
|
+
end
|
|
683
|
+
# verify enum value
|
|
684
|
+
allowable_values = ["global", "introduction_email", "manual_email", "funnel_start_reminder", "mid_funnel_reminder", "end_of_funnel_reminder", "payment_reminder_email", "payment_failure_email", "payment_confirmation_email", "document_reminder_email", "next_steps_email", "acceptance_email", "reset_signature_or_agreement", "refund_email", "access_link", "payment_instructions", "microdeposit_email", "closing_campaign_email", "closing_opt_out_email", "material_change_email"]
|
|
685
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(kind)
|
|
686
|
+
fail ArgumentError, "invalid value for \"kind\", must be one of #{allowable_values}"
|
|
687
|
+
end
|
|
688
|
+
# resource path
|
|
689
|
+
local_var_path = '/deals/{id}/platform_emails/{kind}/page'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'kind' + '}', CGI.escape(kind.to_s))
|
|
690
|
+
|
|
691
|
+
# query parameters
|
|
692
|
+
query_params = opts[:query_params] || {}
|
|
693
|
+
|
|
694
|
+
# header parameters
|
|
695
|
+
header_params = opts[:header_params] || {}
|
|
696
|
+
# HTTP header 'Accept' (if needed)
|
|
697
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
698
|
+
# HTTP header 'Content-Type'
|
|
699
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
700
|
+
if !content_type.nil?
|
|
701
|
+
header_params['Content-Type'] = content_type
|
|
702
|
+
end
|
|
703
|
+
|
|
704
|
+
# form parameters
|
|
705
|
+
form_params = opts[:form_params] || {}
|
|
706
|
+
|
|
707
|
+
# http body (model)
|
|
708
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patch_platform_email_page_request'])
|
|
709
|
+
|
|
710
|
+
# return_type
|
|
711
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesPage'
|
|
712
|
+
|
|
713
|
+
# auth_names
|
|
714
|
+
auth_names = opts[:debug_auth_names] || []
|
|
715
|
+
|
|
716
|
+
new_options = opts.merge(
|
|
717
|
+
:operation => :"DealApi.patch_platform_email_page",
|
|
718
|
+
:header_params => header_params,
|
|
719
|
+
:query_params => query_params,
|
|
720
|
+
:form_params => form_params,
|
|
721
|
+
:body => post_body,
|
|
722
|
+
:auth_names => auth_names,
|
|
723
|
+
:return_type => return_type
|
|
724
|
+
)
|
|
725
|
+
|
|
726
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
727
|
+
if @api_client.config.debugging
|
|
728
|
+
@api_client.config.logger.debug "API called: DealApi#patch_platform_email_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
729
|
+
end
|
|
730
|
+
return data, status_code, headers
|
|
731
|
+
end
|
|
646
732
|
end
|
|
647
733
|
end
|
|
@@ -1084,6 +1084,67 @@ module DealMakerAPI
|
|
|
1084
1084
|
return data, status_code, headers
|
|
1085
1085
|
end
|
|
1086
1086
|
|
|
1087
|
+
# Delete investment
|
|
1088
|
+
# Delete investment
|
|
1089
|
+
# @param investor_id [Integer]
|
|
1090
|
+
# @param [Hash] opts the optional parameters
|
|
1091
|
+
# @return [nil]
|
|
1092
|
+
def post_investors_investor_id_delete_investment_process(investor_id, opts = {})
|
|
1093
|
+
post_investors_investor_id_delete_investment_process_with_http_info(investor_id, opts)
|
|
1094
|
+
nil
|
|
1095
|
+
end
|
|
1096
|
+
|
|
1097
|
+
# Delete investment
|
|
1098
|
+
# Delete investment
|
|
1099
|
+
# @param investor_id [Integer]
|
|
1100
|
+
# @param [Hash] opts the optional parameters
|
|
1101
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1102
|
+
def post_investors_investor_id_delete_investment_process_with_http_info(investor_id, opts = {})
|
|
1103
|
+
if @api_client.config.debugging
|
|
1104
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.post_investors_investor_id_delete_investment_process ...'
|
|
1105
|
+
end
|
|
1106
|
+
# verify the required parameter 'investor_id' is set
|
|
1107
|
+
if @api_client.config.client_side_validation && investor_id.nil?
|
|
1108
|
+
fail ArgumentError, "Missing the required parameter 'investor_id' when calling DefaultApi.post_investors_investor_id_delete_investment_process"
|
|
1109
|
+
end
|
|
1110
|
+
# resource path
|
|
1111
|
+
local_var_path = '/investors/{investor_id}/delete_investment/process'.sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s))
|
|
1112
|
+
|
|
1113
|
+
# query parameters
|
|
1114
|
+
query_params = opts[:query_params] || {}
|
|
1115
|
+
|
|
1116
|
+
# header parameters
|
|
1117
|
+
header_params = opts[:header_params] || {}
|
|
1118
|
+
|
|
1119
|
+
# form parameters
|
|
1120
|
+
form_params = opts[:form_params] || {}
|
|
1121
|
+
|
|
1122
|
+
# http body (model)
|
|
1123
|
+
post_body = opts[:debug_body]
|
|
1124
|
+
|
|
1125
|
+
# return_type
|
|
1126
|
+
return_type = opts[:debug_return_type]
|
|
1127
|
+
|
|
1128
|
+
# auth_names
|
|
1129
|
+
auth_names = opts[:debug_auth_names] || []
|
|
1130
|
+
|
|
1131
|
+
new_options = opts.merge(
|
|
1132
|
+
:operation => :"DefaultApi.post_investors_investor_id_delete_investment_process",
|
|
1133
|
+
:header_params => header_params,
|
|
1134
|
+
:query_params => query_params,
|
|
1135
|
+
:form_params => form_params,
|
|
1136
|
+
:body => post_body,
|
|
1137
|
+
:auth_names => auth_names,
|
|
1138
|
+
:return_type => return_type
|
|
1139
|
+
)
|
|
1140
|
+
|
|
1141
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1142
|
+
if @api_client.config.debugging
|
|
1143
|
+
@api_client.config.logger.debug "API called: DefaultApi#post_investors_investor_id_delete_investment_process\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1144
|
+
end
|
|
1145
|
+
return data, status_code, headers
|
|
1146
|
+
end
|
|
1147
|
+
|
|
1087
1148
|
# Request refund for investor transactions
|
|
1088
1149
|
# Request refund for investor transactions
|
|
1089
1150
|
# @param investor_id [Integer]
|