DealMakerAPI 0.106.2 → 0.106.3

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -5
  3. data/docs/CampaignApi.md +67 -0
  4. data/docs/DealApi.md +138 -0
  5. data/docs/PatchPlatformEmailRequest.md +24 -0
  6. data/docs/ReservationApi.md +71 -4
  7. data/docs/V1EntitiesDealsPlatformEmail.md +30 -0
  8. data/docs/V1EntitiesDealsPlatformEmails.md +18 -0
  9. data/docs/V1EntitiesTtwCampaignList.md +18 -0
  10. data/docs/V1EntitiesTtwCampaignResponse.md +5 -1
  11. data/docs/{V1EntitiesTtwReservation.md → V1EntitiesTtwReservationCreate.md} +5 -3
  12. data/docs/V1EntitiesTtwReservationResponse.md +36 -0
  13. data/lib/DealMakerAPI/api/campaign_api.rb +63 -0
  14. data/lib/DealMakerAPI/api/deal_api.rb +143 -0
  15. data/lib/DealMakerAPI/api/reservation_api.rb +66 -3
  16. data/lib/DealMakerAPI/models/patch_platform_email_request.rb +307 -0
  17. data/lib/DealMakerAPI/models/v1_entities_deals_platform_email.rb +322 -0
  18. data/lib/DealMakerAPI/models/v1_entities_deals_platform_emails.rb +215 -0
  19. data/lib/DealMakerAPI/models/{v1_entities_ttw_reservation.rb → v1_entities_ttw_campaign_list.rb} +11 -12
  20. data/lib/DealMakerAPI/models/v1_entities_ttw_campaign_response.rb +29 -9
  21. data/lib/DealMakerAPI/models/v1_entities_ttw_reservation_create.rb +226 -0
  22. data/lib/DealMakerAPI/models/v1_entities_ttw_reservation_response.rb +306 -0
  23. data/lib/DealMakerAPI/version.rb +1 -1
  24. data/lib/DealMakerAPI.rb +6 -1
  25. data/spec/api/campaign_api_spec.rb +12 -0
  26. data/spec/api/deal_api_spec.rb +26 -0
  27. data/spec/api/reservation_api_spec.rb +13 -1
  28. data/spec/models/patch_platform_email_request_spec.rb +58 -0
  29. data/spec/models/v1_entities_deals_platform_email_spec.rb +80 -0
  30. data/spec/models/v1_entities_deals_platform_emails_spec.rb +36 -0
  31. data/spec/models/{v1_entities_ttw_reservation_spec.rb → v1_entities_ttw_campaign_list_spec.rb} +7 -7
  32. data/spec/models/v1_entities_ttw_campaign_response_spec.rb +12 -0
  33. data/spec/models/v1_entities_ttw_reservation_create_spec.rb +42 -0
  34. data/spec/models/v1_entities_ttw_reservation_response_spec.rb +90 -0
  35. metadata +26 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1c35bad3dc94079263b92537d4e42b13146e95043d5ae2cd0a4b5c5a2c1be918
4
- data.tar.gz: 3aa9a2a2f2d54bf04d9de37a0570d10495019cf0ad6a47c4d1330153da9dfbb3
3
+ metadata.gz: f7949c5a69581ecefe438aa9f60b2dcee22885877d3a7d213408d14b59615dc6
4
+ data.tar.gz: aae2a9845ecdd8d06e4378c4204f269990ec00915e1d381c4083051125f4bea0
5
5
  SHA512:
6
- metadata.gz: b4196319e342928423e34e90f832842f13d1e1eb204324abd7098711a5400f3fcc9ca1bac5413201e0982577388b937b5702c1021849e034eb0186008ae86ea4
7
- data.tar.gz: 484836f28330f59bc7e7c190e19dc1017b98939ce38cbb2d3f5cae086c6f3254cbaa82b5452b9cee5e1f3f87d01dad8943cfc9cde86b23d686591e89b5fd0d09
6
+ metadata.gz: 22fbfe11ef18ebaec30619e6830a00cd3e0655f964aa1ab855212a4c8f76a6623a934387a7712c92fef6d1e1585b093b9e8908a5cc25764515d43840e8ee0a4d
7
+ data.tar.gz: 73bbfbc161432c0ec342fed0fb2a802f0f0f48c5d04c54107bc081a123c0cc4cf504df0432ba7c19d8c5d604265ab8373ff8065e3dfcb7da6c9865f47cfce768
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.106.2
341
+ - Package version: 0.106.3
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.106.2.gem
358
+ gem install ./DealMakerAPI-0.106.3.gem
359
359
  ```
360
360
 
361
- (for development, run `gem install --dev ./DealMakerAPI-0.106.2.gem` to install the development dependencies)
361
+ (for development, run `gem install --dev ./DealMakerAPI-0.106.3.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.106.2'
367
+ gem 'DealMakerAPI', '~> 0.106.3'
368
368
 
369
369
  ### Install from Git
370
370
 
@@ -411,6 +411,7 @@ All URIs are relative to *http://api.dealmaker.tech*
411
411
  Class | Method | HTTP request | Description
412
412
  ------------ | ------------- | ------------- | -------------
413
413
  *DealMakerAPI::CampaignApi* | [**get_ttw_campaign**](docs/CampaignApi.md#get_ttw_campaign) | **GET** /ttw/campaigns/{id} | Gets a TTW campaign for a given company
414
+ *DealMakerAPI::CampaignApi* | [**get_ttw_campaigns**](docs/CampaignApi.md#get_ttw_campaigns) | **GET** /ttw/companies/{company_id}/campaigns | Gets a list TTW campaigns for a given company
414
415
  *DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
415
416
  *DealMakerAPI::CompanyApi* | [**create_bulk_upload_detail**](docs/CompanyApi.md#create_bulk_upload_detail) | **POST** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details | Create a BulkUploadDetail class record
416
417
  *DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
@@ -442,6 +443,8 @@ Class | Method | HTTP request | Description
442
443
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
443
444
  *DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
444
445
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
446
+ *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
447
+ *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.
445
448
  *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
446
449
  *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.
447
450
  *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
@@ -499,6 +502,7 @@ Class | Method | HTTP request | Description
499
502
  *DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
500
503
  *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
504
  *DealMakerAPI::ReservationApi* | [**create_reservation**](docs/ReservationApi.md#create_reservation) | **POST** /ttw/reservations | Create a new reservation
505
+ *DealMakerAPI::ReservationApi* | [**get_ttw_reservation**](docs/ReservationApi.md#get_ttw_reservation) | **GET** /ttw/reservations/{id} | Gets a TTW reservation
502
506
  *DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
503
507
  *DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
504
508
  *DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
@@ -543,6 +547,7 @@ Class | Method | HTTP request | Description
543
547
  - [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
544
548
  - [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
545
549
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
550
+ - [DealMakerAPI::PatchPlatformEmailRequest](docs/PatchPlatformEmailRequest.md)
546
551
  - [DealMakerAPI::PostDealIncentivePlanRequest](docs/PostDealIncentivePlanRequest.md)
547
552
  - [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
548
553
  - [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
@@ -589,6 +594,8 @@ Class | Method | HTTP request | Description
589
594
  - [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
590
595
  - [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
591
596
  - [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent.md)
597
+ - [DealMakerAPI::V1EntitiesDealsPlatformEmail](docs/V1EntitiesDealsPlatformEmail.md)
598
+ - [DealMakerAPI::V1EntitiesDealsPlatformEmails](docs/V1EntitiesDealsPlatformEmails.md)
592
599
  - [DealMakerAPI::V1EntitiesDealsPlatformEmailsDomainSettings](docs/V1EntitiesDealsPlatformEmailsDomainSettings.md)
593
600
  - [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
594
601
  - [DealMakerAPI::V1EntitiesDealsProgress](docs/V1EntitiesDealsProgress.md)
@@ -644,8 +651,10 @@ Class | Method | HTTP request | Description
644
651
  - [DealMakerAPI::V1EntitiesShareholdersTags](docs/V1EntitiesShareholdersTags.md)
645
652
  - [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
646
653
  - [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
654
+ - [DealMakerAPI::V1EntitiesTtwCampaignList](docs/V1EntitiesTtwCampaignList.md)
647
655
  - [DealMakerAPI::V1EntitiesTtwCampaignResponse](docs/V1EntitiesTtwCampaignResponse.md)
648
- - [DealMakerAPI::V1EntitiesTtwReservation](docs/V1EntitiesTtwReservation.md)
656
+ - [DealMakerAPI::V1EntitiesTtwReservationCreate](docs/V1EntitiesTtwReservationCreate.md)
657
+ - [DealMakerAPI::V1EntitiesTtwReservationResponse](docs/V1EntitiesTtwReservationResponse.md)
649
658
  - [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
650
659
  - [DealMakerAPI::V1EntitiesUsersBinding](docs/V1EntitiesUsersBinding.md)
651
660
  - [DealMakerAPI::V1EntitiesUsersContext](docs/V1EntitiesUsersContext.md)
data/docs/CampaignApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.dealmaker.tech*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**get_ttw_campaign**](CampaignApi.md#get_ttw_campaign) | **GET** /ttw/campaigns/{id} | Gets a TTW campaign for a given company |
8
+ | [**get_ttw_campaigns**](CampaignApi.md#get_ttw_campaigns) | **GET** /ttw/companies/{company_id}/campaigns | Gets a list TTW campaigns for a given company |
8
9
 
9
10
 
10
11
  ## get_ttw_campaign
@@ -72,3 +73,69 @@ No authorization required
72
73
  - **Content-Type**: Not defined
73
74
  - **Accept**: application/json
74
75
 
76
+
77
+ ## get_ttw_campaigns
78
+
79
+ > <V1EntitiesTtwCampaignList> get_ttw_campaigns(company_id)
80
+
81
+ Gets a list TTW campaigns for a given company
82
+
83
+ Gets a list TTW campaigns for a given company
84
+
85
+ ### Examples
86
+
87
+ ```ruby
88
+ require 'time'
89
+ require 'DealMakerAPI'
90
+ # setup authorization
91
+ DealMakerAPI.configure do |config|end
92
+
93
+ api_instance = DealMakerAPI::CampaignApi.new
94
+ company_id = 56 # Integer |
95
+
96
+ begin
97
+ # Gets a list TTW campaigns for a given company
98
+ result = api_instance.get_ttw_campaigns(company_id)
99
+ p result
100
+ rescue DealMakerAPI::ApiError => e
101
+ puts "Error when calling CampaignApi->get_ttw_campaigns: #{e}"
102
+ end
103
+ ```
104
+
105
+ #### Using the get_ttw_campaigns_with_http_info variant
106
+
107
+ This returns an Array which contains the response data, status code and headers.
108
+
109
+ > <Array(<V1EntitiesTtwCampaignList>, Integer, Hash)> get_ttw_campaigns_with_http_info(company_id)
110
+
111
+ ```ruby
112
+ begin
113
+ # Gets a list TTW campaigns for a given company
114
+ data, status_code, headers = api_instance.get_ttw_campaigns_with_http_info(company_id)
115
+ p status_code # => 2xx
116
+ p headers # => { ... }
117
+ p data # => <V1EntitiesTtwCampaignList>
118
+ rescue DealMakerAPI::ApiError => e
119
+ puts "Error when calling CampaignApi->get_ttw_campaigns_with_http_info: #{e}"
120
+ end
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+ | Name | Type | Description | Notes |
126
+ | ---- | ---- | ----------- | ----- |
127
+ | **company_id** | **Integer** | | |
128
+
129
+ ### Return type
130
+
131
+ [**V1EntitiesTtwCampaignList**](V1EntitiesTtwCampaignList.md)
132
+
133
+ ### Authorization
134
+
135
+ No authorization required
136
+
137
+ ### HTTP request headers
138
+
139
+ - **Content-Type**: Not defined
140
+ - **Accept**: application/json
141
+
data/docs/DealApi.md CHANGED
@@ -10,6 +10,8 @@ All URIs are relative to *http://api.dealmaker.tech*
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
12
  | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
13
+ | [**list_platform_emails**](DealApi.md#list_platform_emails) | **GET** /deals/{id}/platform_emails | Get a list of platform emails for the deal |
14
+ | [**patch_platform_email**](DealApi.md#patch_platform_email) | **PATCH** /deals/{id}/platform_emails/{kind}/update | Patch platform email by kind and deal. |
13
15
 
14
16
 
15
17
  ## ach_bank_account_setup_intent
@@ -423,3 +425,139 @@ No authorization required
423
425
  - **Content-Type**: Not defined
424
426
  - **Accept**: application/json
425
427
 
428
+
429
+ ## list_platform_emails
430
+
431
+ > <V1EntitiesDealsPlatformEmails> list_platform_emails(id)
432
+
433
+ Get a list of platform emails for the deal
434
+
435
+ Get a list of platform emails for the deal
436
+
437
+ ### Examples
438
+
439
+ ```ruby
440
+ require 'time'
441
+ require 'DealMakerAPI'
442
+ # setup authorization
443
+ DealMakerAPI.configure do |config|end
444
+
445
+ api_instance = DealMakerAPI::DealApi.new
446
+ id = 56 # Integer | The deal id.
447
+
448
+ begin
449
+ # Get a list of platform emails for the deal
450
+ result = api_instance.list_platform_emails(id)
451
+ p result
452
+ rescue DealMakerAPI::ApiError => e
453
+ puts "Error when calling DealApi->list_platform_emails: #{e}"
454
+ end
455
+ ```
456
+
457
+ #### Using the list_platform_emails_with_http_info variant
458
+
459
+ This returns an Array which contains the response data, status code and headers.
460
+
461
+ > <Array(<V1EntitiesDealsPlatformEmails>, Integer, Hash)> list_platform_emails_with_http_info(id)
462
+
463
+ ```ruby
464
+ begin
465
+ # Get a list of platform emails for the deal
466
+ data, status_code, headers = api_instance.list_platform_emails_with_http_info(id)
467
+ p status_code # => 2xx
468
+ p headers # => { ... }
469
+ p data # => <V1EntitiesDealsPlatformEmails>
470
+ rescue DealMakerAPI::ApiError => e
471
+ puts "Error when calling DealApi->list_platform_emails_with_http_info: #{e}"
472
+ end
473
+ ```
474
+
475
+ ### Parameters
476
+
477
+ | Name | Type | Description | Notes |
478
+ | ---- | ---- | ----------- | ----- |
479
+ | **id** | **Integer** | The deal id. | |
480
+
481
+ ### Return type
482
+
483
+ [**V1EntitiesDealsPlatformEmails**](V1EntitiesDealsPlatformEmails.md)
484
+
485
+ ### Authorization
486
+
487
+ No authorization required
488
+
489
+ ### HTTP request headers
490
+
491
+ - **Content-Type**: Not defined
492
+ - **Accept**: application/json
493
+
494
+
495
+ ## patch_platform_email
496
+
497
+ > <V1EntitiesDealsPlatformEmail> patch_platform_email(id, kind, patch_platform_email_request)
498
+
499
+ Patch platform email by kind and deal.
500
+
501
+ Patch platform email by kind and deal.
502
+
503
+ ### Examples
504
+
505
+ ```ruby
506
+ require 'time'
507
+ require 'DealMakerAPI'
508
+ # setup authorization
509
+ DealMakerAPI.configure do |config|end
510
+
511
+ api_instance = DealMakerAPI::DealApi.new
512
+ id = 56 # Integer |
513
+ kind = 56 # Integer |
514
+ patch_platform_email_request = DealMakerAPI::PatchPlatformEmailRequest.new({enabled: false, subject: 'subject_example', reminder_number: 37, reminder_type: 'day'}) # PatchPlatformEmailRequest |
515
+
516
+ begin
517
+ # Patch platform email by kind and deal.
518
+ result = api_instance.patch_platform_email(id, kind, patch_platform_email_request)
519
+ p result
520
+ rescue DealMakerAPI::ApiError => e
521
+ puts "Error when calling DealApi->patch_platform_email: #{e}"
522
+ end
523
+ ```
524
+
525
+ #### Using the patch_platform_email_with_http_info variant
526
+
527
+ This returns an Array which contains the response data, status code and headers.
528
+
529
+ > <Array(<V1EntitiesDealsPlatformEmail>, Integer, Hash)> patch_platform_email_with_http_info(id, kind, patch_platform_email_request)
530
+
531
+ ```ruby
532
+ begin
533
+ # Patch platform email by kind and deal.
534
+ data, status_code, headers = api_instance.patch_platform_email_with_http_info(id, kind, patch_platform_email_request)
535
+ p status_code # => 2xx
536
+ p headers # => { ... }
537
+ p data # => <V1EntitiesDealsPlatformEmail>
538
+ rescue DealMakerAPI::ApiError => e
539
+ puts "Error when calling DealApi->patch_platform_email_with_http_info: #{e}"
540
+ end
541
+ ```
542
+
543
+ ### Parameters
544
+
545
+ | Name | Type | Description | Notes |
546
+ | ---- | ---- | ----------- | ----- |
547
+ | **id** | **Integer** | | |
548
+ | **kind** | **Integer** | | |
549
+ | **patch_platform_email_request** | [**PatchPlatformEmailRequest**](PatchPlatformEmailRequest.md) | | |
550
+
551
+ ### Return type
552
+
553
+ [**V1EntitiesDealsPlatformEmail**](V1EntitiesDealsPlatformEmail.md)
554
+
555
+ ### Authorization
556
+
557
+ No authorization required
558
+
559
+ ### HTTP request headers
560
+
561
+ - **Content-Type**: application/json
562
+ - **Accept**: application/json
563
+
@@ -0,0 +1,24 @@
1
+ # DealMakerAPI::PatchPlatformEmailRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **enabled** | **Boolean** | Specifies if platform email is enabled. | |
8
+ | **subject** | **String** | The platform email subject. | |
9
+ | **reminder_number** | **Integer** | The number of reminder_type periods of platform email. | |
10
+ | **reminder_type** | **String** | The reminder type of platform email. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'DealMakerAPI'
16
+
17
+ instance = DealMakerAPI::PatchPlatformEmailRequest.new(
18
+ enabled: null,
19
+ subject: null,
20
+ reminder_number: null,
21
+ reminder_type: null
22
+ )
23
+ ```
24
+
@@ -5,11 +5,12 @@ All URIs are relative to *http://api.dealmaker.tech*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_reservation**](ReservationApi.md#create_reservation) | **POST** /ttw/reservations | Create a new reservation |
8
+ | [**get_ttw_reservation**](ReservationApi.md#get_ttw_reservation) | **GET** /ttw/reservations/{id} | Gets a TTW reservation |
8
9
 
9
10
 
10
11
  ## create_reservation
11
12
 
12
- > <V1EntitiesTtwReservation> create_reservation(create_reservation_request)
13
+ > <V1EntitiesTtwReservationCreate> create_reservation(create_reservation_request)
13
14
 
14
15
  Create a new reservation
15
16
 
@@ -39,7 +40,7 @@ end
39
40
 
40
41
  This returns an Array which contains the response data, status code and headers.
41
42
 
42
- > <Array(<V1EntitiesTtwReservation>, Integer, Hash)> create_reservation_with_http_info(create_reservation_request)
43
+ > <Array(<V1EntitiesTtwReservationCreate>, Integer, Hash)> create_reservation_with_http_info(create_reservation_request)
43
44
 
44
45
  ```ruby
45
46
  begin
@@ -47,7 +48,7 @@ begin
47
48
  data, status_code, headers = api_instance.create_reservation_with_http_info(create_reservation_request)
48
49
  p status_code # => 2xx
49
50
  p headers # => { ... }
50
- p data # => <V1EntitiesTtwReservation>
51
+ p data # => <V1EntitiesTtwReservationCreate>
51
52
  rescue DealMakerAPI::ApiError => e
52
53
  puts "Error when calling ReservationApi->create_reservation_with_http_info: #{e}"
53
54
  end
@@ -61,7 +62,7 @@ end
61
62
 
62
63
  ### Return type
63
64
 
64
- [**V1EntitiesTtwReservation**](V1EntitiesTtwReservation.md)
65
+ [**V1EntitiesTtwReservationCreate**](V1EntitiesTtwReservationCreate.md)
65
66
 
66
67
  ### Authorization
67
68
 
@@ -72,3 +73,69 @@ No authorization required
72
73
  - **Content-Type**: application/json
73
74
  - **Accept**: application/json
74
75
 
76
+
77
+ ## get_ttw_reservation
78
+
79
+ > <V1EntitiesTtwReservationResponse> get_ttw_reservation(id)
80
+
81
+ Gets a TTW reservation
82
+
83
+ Gets a TTW reservation
84
+
85
+ ### Examples
86
+
87
+ ```ruby
88
+ require 'time'
89
+ require 'DealMakerAPI'
90
+ # setup authorization
91
+ DealMakerAPI.configure do |config|end
92
+
93
+ api_instance = DealMakerAPI::ReservationApi.new
94
+ id = 56 # Integer |
95
+
96
+ begin
97
+ # Gets a TTW reservation
98
+ result = api_instance.get_ttw_reservation(id)
99
+ p result
100
+ rescue DealMakerAPI::ApiError => e
101
+ puts "Error when calling ReservationApi->get_ttw_reservation: #{e}"
102
+ end
103
+ ```
104
+
105
+ #### Using the get_ttw_reservation_with_http_info variant
106
+
107
+ This returns an Array which contains the response data, status code and headers.
108
+
109
+ > <Array(<V1EntitiesTtwReservationResponse>, Integer, Hash)> get_ttw_reservation_with_http_info(id)
110
+
111
+ ```ruby
112
+ begin
113
+ # Gets a TTW reservation
114
+ data, status_code, headers = api_instance.get_ttw_reservation_with_http_info(id)
115
+ p status_code # => 2xx
116
+ p headers # => { ... }
117
+ p data # => <V1EntitiesTtwReservationResponse>
118
+ rescue DealMakerAPI::ApiError => e
119
+ puts "Error when calling ReservationApi->get_ttw_reservation_with_http_info: #{e}"
120
+ end
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+ | Name | Type | Description | Notes |
126
+ | ---- | ---- | ----------- | ----- |
127
+ | **id** | **Integer** | | |
128
+
129
+ ### Return type
130
+
131
+ [**V1EntitiesTtwReservationResponse**](V1EntitiesTtwReservationResponse.md)
132
+
133
+ ### Authorization
134
+
135
+ No authorization required
136
+
137
+ ### HTTP request headers
138
+
139
+ - **Content-Type**: Not defined
140
+ - **Accept**: application/json
141
+
@@ -0,0 +1,30 @@
1
+ # DealMakerAPI::V1EntitiesDealsPlatformEmail
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | The platform email id. | [optional] |
8
+ | **kind** | **String** | The platform email kind. | [optional] |
9
+ | **enabled** | **Boolean** | Specifies if platform email is enabled. | [optional] |
10
+ | **subject** | **String** | The platform email subject. | [optional] |
11
+ | **last_reminder** | **Time** | The platform email last reminder. | [optional] |
12
+ | **reminder_number** | **String** | The number of reminder_type periods of platform email. | [optional] |
13
+ | **reminder_type** | **String** | The reminder type of platform email. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'DealMakerAPI'
19
+
20
+ instance = DealMakerAPI::V1EntitiesDealsPlatformEmail.new(
21
+ id: null,
22
+ kind: null,
23
+ enabled: null,
24
+ subject: null,
25
+ last_reminder: null,
26
+ reminder_number: null,
27
+ reminder_type: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::V1EntitiesDealsPlatformEmails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**V1EntitiesDealsPlatformEmail**](V1EntitiesDealsPlatformEmail.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::V1EntitiesDealsPlatformEmails.new(
15
+ items: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::V1EntitiesTtwCampaignList
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | [**V1EntitiesTtwCampaignResponse**](V1EntitiesTtwCampaignResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::V1EntitiesTtwCampaignList.new(
15
+ items: null
16
+ )
17
+ ```
18
+
@@ -6,12 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **Integer** | The campaign ID | [optional] |
8
8
  | **name** | **String** | Campaign name | [optional] |
9
+ | **state** | **String** | Campaign state | [optional] |
9
10
  | **redirect_link** | **String** | Redirect link for the campaign | [optional] |
10
11
  | **introduction_email** | **Boolean** | State of the introduction email | [optional] |
11
12
  | **one_day_reminder_email** | **Boolean** | State of the 1 day reminder email | [optional] |
12
13
  | **two_day_reminder_email** | **Boolean** | State of the 2 day reminder email | [optional] |
13
14
  | **seven_day_reminder_email** | **Boolean** | State of the 7 day reminder email | [optional] |
14
15
  | **confirmation_email** | **Boolean** | State of the confirmation email | [optional] |
16
+ | **launch_date** | **Date** | Campaign launch date | [optional] |
15
17
 
16
18
  ## Example
17
19
 
@@ -21,12 +23,14 @@ require 'DealMakerAPI'
21
23
  instance = DealMakerAPI::V1EntitiesTtwCampaignResponse.new(
22
24
  id: null,
23
25
  name: null,
26
+ state: null,
24
27
  redirect_link: null,
25
28
  introduction_email: null,
26
29
  one_day_reminder_email: null,
27
30
  two_day_reminder_email: null,
28
31
  seven_day_reminder_email: null,
29
- confirmation_email: null
32
+ confirmation_email: null,
33
+ launch_date: null
30
34
  )
31
35
  ```
32
36
 
@@ -1,18 +1,20 @@
1
- # DealMakerAPI::V1EntitiesTtwReservation
1
+ # DealMakerAPI::V1EntitiesTtwReservationCreate
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **Integer** | The ID of the reservation. | [optional] |
8
+ | **token** | **String** | The token for the reservation. | [optional] |
8
9
 
9
10
  ## Example
10
11
 
11
12
  ```ruby
12
13
  require 'DealMakerAPI'
13
14
 
14
- instance = DealMakerAPI::V1EntitiesTtwReservation.new(
15
- id: null
15
+ instance = DealMakerAPI::V1EntitiesTtwReservationCreate.new(
16
+ id: null,
17
+ token: null
16
18
  )
17
19
  ```
18
20
 
@@ -0,0 +1,36 @@
1
+ # DealMakerAPI::V1EntitiesTtwReservationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | The TTW reservation ID | [optional] |
8
+ | **email** | **String** | The reservation email | [optional] |
9
+ | **name** | **String** | The reservation name | [optional] |
10
+ | **phone** | **String** | The reservation phone | [optional] |
11
+ | **reservation_amount** | **Integer** | The reservation amount | [optional] |
12
+ | **state** | **String** | The state of the reservation | [optional] |
13
+ | **validated** | **Boolean** | The validated status for the reservation | [optional] |
14
+ | **ttw_campaign_id** | **Integer** | The ID of the associated campaign | [optional] |
15
+ | **user_id** | **Integer** | The ID of the associated user | [optional] |
16
+ | **investor_profile_id** | **Integer** | The ID of the associated investor profile | [optional] |
17
+
18
+ ## Example
19
+
20
+ ```ruby
21
+ require 'DealMakerAPI'
22
+
23
+ instance = DealMakerAPI::V1EntitiesTtwReservationResponse.new(
24
+ id: null,
25
+ email: null,
26
+ name: null,
27
+ phone: null,
28
+ reservation_amount: null,
29
+ state: null,
30
+ validated: null,
31
+ ttw_campaign_id: null,
32
+ user_id: null,
33
+ investor_profile_id: null
34
+ )
35
+ ```
36
+