DealMakerAPI 0.107.1 → 0.107.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -6
- data/docs/CampaignApi.md +9 -9
- data/docs/DealApi.md +69 -0
- data/docs/ShwApi.md +141 -0
- data/docs/TtwCampaignsApi.md +141 -0
- data/docs/V1EntitiesPage.md +34 -0
- data/docs/V1EntitiesTtwReservationCreate.md +2 -4
- data/docs/V1EntitiesTtwReservationGetResponse.md +22 -0
- data/lib/DealMakerAPI/api/campaign_api.rb +12 -12
- data/lib/DealMakerAPI/api/deal_api.rb +69 -0
- data/lib/DealMakerAPI/api/shw_api.rb +148 -0
- data/lib/DealMakerAPI/api/ttw_campaigns_api.rb +148 -0
- data/lib/DealMakerAPI/models/v1_entities_page.rb +296 -0
- data/lib/DealMakerAPI/models/v1_entities_ttw_reservation_create.rb +7 -17
- data/lib/DealMakerAPI/models/{v1_entities_ttw_reservation_user_id.rb → v1_entities_ttw_reservation_get_response.rb} +32 -12
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +4 -1
- data/spec/api/campaign_api_spec.rb +2 -2
- data/spec/api/deal_api_spec.rb +13 -0
- data/spec/api/shw_api_spec.rb +59 -0
- data/spec/api/ttw_campaigns_api_spec.rb +59 -0
- data/spec/models/v1_entities_page_spec.rb +84 -0
- data/spec/models/v1_entities_ttw_reservation_create_spec.rb +1 -7
- data/spec/models/{v1_entities_ttw_reservation_user_id_spec.rb → v1_entities_ttw_reservation_get_response_spec.rb} +19 -7
- metadata +18 -6
- data/docs/V1EntitiesTtwReservationUserId.md +0 -18
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 31ca7f8a15f9974f39ddaf0f803520ef30f708d00c72a84009ed9a8bd09af51a
|
4
|
+
data.tar.gz: d5b8dd5503edfdba6d34adcc756371f586b0eebaa0e5e6bf6ef56c49cd974315
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c77499f0eae31f3e56f9a9b5f3d833255ea632586848577d20dc918572c6f89425125133f372f58754dcf00b18c3e7ef9257c95be1a9445819e184ee284874dc
|
7
|
+
data.tar.gz: f2cc29077aecf671ae01c6049d83a60977e186b4ab9b3f30a9b2f58d8e0635fb8bded086fbab37b2feacb93ea286ba4e95fc3253e459cb8d6bd59b6ead7734a7
|
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.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.107.
|
358
|
+
gem install ./DealMakerAPI-0.107.3.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.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.107.
|
367
|
+
gem 'DealMakerAPI', '~> 0.107.3'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -412,7 +412,7 @@ 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
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
|
415
|
-
*DealMakerAPI::CampaignApi* | [**get_user_ttw_reservation**](docs/CampaignApi.md#get_user_ttw_reservation) | **GET** /ttw/campaign/{id}/reservation/{
|
415
|
+
*DealMakerAPI::CampaignApi* | [**get_user_ttw_reservation**](docs/CampaignApi.md#get_user_ttw_reservation) | **GET** /ttw/campaign/{id}/reservation/{reservation_uuid} | Gets User ID for a TTW reservation
|
416
416
|
*DealMakerAPI::CompanyApi* | [**create_bulk_upload**](docs/CompanyApi.md#create_bulk_upload) | **POST** /companies/{id}/documents/bulk_uploads | Create bulk upload record
|
417
417
|
*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
|
418
418
|
*DealMakerAPI::CompanyApi* | [**create_company**](docs/CompanyApi.md#create_company) | **POST** /companies | Create new company
|
@@ -443,6 +443,7 @@ 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/{platform_email_id}/page | Get the Page for a given Platform Email
|
446
447
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
447
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
|
448
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.
|
@@ -506,6 +507,10 @@ Class | Method | HTTP request | Description
|
|
506
507
|
*DealMakerAPI::ReservationApi* | [**get_ttw_reservation**](docs/ReservationApi.md#get_ttw_reservation) | **GET** /ttw/reservations/{id} | Gets a TTW reservation
|
507
508
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
508
509
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
510
|
+
*DealMakerAPI::ShwApi* | [**get_shw_page**](docs/ShwApi.md#get_shw_page) | **GET** /shw/{id}/page | Get self hosted website page
|
511
|
+
*DealMakerAPI::ShwApi* | [**publish_shw_page**](docs/ShwApi.md#publish_shw_page) | **PATCH** /shw/{id}/page/publish | Publish self hosted website page
|
512
|
+
*DealMakerAPI::TtwCampaignsApi* | [**get_ttw_campaign_page**](docs/TtwCampaignsApi.md#get_ttw_campaign_page) | **GET** /ttw/campaigns/{id}/page | Get ttw campaign page
|
513
|
+
*DealMakerAPI::TtwCampaignsApi* | [**publish_ttw_campaign_page**](docs/TtwCampaignsApi.md#publish_ttw_campaign_page) | **PATCH** /ttw/campaigns/{id}/page/publish | Publish ttw campaign page
|
509
514
|
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
510
515
|
*DealMakerAPI::UserApi* | [**create_factor**](docs/UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor
|
511
516
|
*DealMakerAPI::UserApi* | [**delete_channel**](docs/UserApi.md#delete_channel) | **DELETE** /users/{id}/two_factor_channels/delete/{channel} | Creates an API endpoint to delete a specific two factor channel\"
|
@@ -641,6 +646,7 @@ Class | Method | HTTP request | Description
|
|
641
646
|
- [DealMakerAPI::V1EntitiesMembersBulkUpload](docs/V1EntitiesMembersBulkUpload.md)
|
642
647
|
- [DealMakerAPI::V1EntitiesMembersBulkUploads](docs/V1EntitiesMembersBulkUploads.md)
|
643
648
|
- [DealMakerAPI::V1EntitiesMoneyEntity](docs/V1EntitiesMoneyEntity.md)
|
649
|
+
- [DealMakerAPI::V1EntitiesPage](docs/V1EntitiesPage.md)
|
644
650
|
- [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
|
645
651
|
- [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsData.md)
|
646
652
|
- [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
|
@@ -655,8 +661,8 @@ Class | Method | HTTP request | Description
|
|
655
661
|
- [DealMakerAPI::V1EntitiesTtwCampaignList](docs/V1EntitiesTtwCampaignList.md)
|
656
662
|
- [DealMakerAPI::V1EntitiesTtwCampaignResponse](docs/V1EntitiesTtwCampaignResponse.md)
|
657
663
|
- [DealMakerAPI::V1EntitiesTtwReservationCreate](docs/V1EntitiesTtwReservationCreate.md)
|
664
|
+
- [DealMakerAPI::V1EntitiesTtwReservationGetResponse](docs/V1EntitiesTtwReservationGetResponse.md)
|
658
665
|
- [DealMakerAPI::V1EntitiesTtwReservationResponse](docs/V1EntitiesTtwReservationResponse.md)
|
659
|
-
- [DealMakerAPI::V1EntitiesTtwReservationUserId](docs/V1EntitiesTtwReservationUserId.md)
|
660
666
|
- [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
|
661
667
|
- [DealMakerAPI::V1EntitiesUsersBinding](docs/V1EntitiesUsersBinding.md)
|
662
668
|
- [DealMakerAPI::V1EntitiesUsersContext](docs/V1EntitiesUsersContext.md)
|
data/docs/CampaignApi.md
CHANGED
@@ -6,7 +6,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
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
8
|
| [**get_ttw_campaigns**](CampaignApi.md#get_ttw_campaigns) | **GET** /ttw/companies/{company_id}/campaigns | Gets a list TTW campaigns for a given company |
|
9
|
-
| [**get_user_ttw_reservation**](CampaignApi.md#get_user_ttw_reservation) | **GET** /ttw/campaign/{id}/reservation/{
|
9
|
+
| [**get_user_ttw_reservation**](CampaignApi.md#get_user_ttw_reservation) | **GET** /ttw/campaign/{id}/reservation/{reservation_uuid} | Gets User ID for a TTW reservation |
|
10
10
|
|
11
11
|
|
12
12
|
## get_ttw_campaign
|
@@ -143,7 +143,7 @@ No authorization required
|
|
143
143
|
|
144
144
|
## get_user_ttw_reservation
|
145
145
|
|
146
|
-
> <
|
146
|
+
> <V1EntitiesTtwReservationGetResponse> get_user_ttw_reservation(id, reservation_uuid)
|
147
147
|
|
148
148
|
Gets User ID for a TTW reservation
|
149
149
|
|
@@ -159,11 +159,11 @@ DealMakerAPI.configure do |config|end
|
|
159
159
|
|
160
160
|
api_instance = DealMakerAPI::CampaignApi.new
|
161
161
|
id = 56 # Integer |
|
162
|
-
|
162
|
+
reservation_uuid = 56 # Integer |
|
163
163
|
|
164
164
|
begin
|
165
165
|
# Gets User ID for a TTW reservation
|
166
|
-
result = api_instance.get_user_ttw_reservation(id,
|
166
|
+
result = api_instance.get_user_ttw_reservation(id, reservation_uuid)
|
167
167
|
p result
|
168
168
|
rescue DealMakerAPI::ApiError => e
|
169
169
|
puts "Error when calling CampaignApi->get_user_ttw_reservation: #{e}"
|
@@ -174,15 +174,15 @@ end
|
|
174
174
|
|
175
175
|
This returns an Array which contains the response data, status code and headers.
|
176
176
|
|
177
|
-
> <Array(<
|
177
|
+
> <Array(<V1EntitiesTtwReservationGetResponse>, Integer, Hash)> get_user_ttw_reservation_with_http_info(id, reservation_uuid)
|
178
178
|
|
179
179
|
```ruby
|
180
180
|
begin
|
181
181
|
# Gets User ID for a TTW reservation
|
182
|
-
data, status_code, headers = api_instance.get_user_ttw_reservation_with_http_info(id,
|
182
|
+
data, status_code, headers = api_instance.get_user_ttw_reservation_with_http_info(id, reservation_uuid)
|
183
183
|
p status_code # => 2xx
|
184
184
|
p headers # => { ... }
|
185
|
-
p data # => <
|
185
|
+
p data # => <V1EntitiesTtwReservationGetResponse>
|
186
186
|
rescue DealMakerAPI::ApiError => e
|
187
187
|
puts "Error when calling CampaignApi->get_user_ttw_reservation_with_http_info: #{e}"
|
188
188
|
end
|
@@ -193,11 +193,11 @@ end
|
|
193
193
|
| Name | Type | Description | Notes |
|
194
194
|
| ---- | ---- | ----------- | ----- |
|
195
195
|
| **id** | **Integer** | | |
|
196
|
-
| **
|
196
|
+
| **reservation_uuid** | **Integer** | | |
|
197
197
|
|
198
198
|
### Return type
|
199
199
|
|
200
|
-
[**
|
200
|
+
[**V1EntitiesTtwReservationGetResponse**](V1EntitiesTtwReservationGetResponse.md)
|
201
201
|
|
202
202
|
### Authorization
|
203
203
|
|
data/docs/DealApi.md
CHANGED
@@ -9,6 +9,7 @@ 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/{platform_email_id}/page | Get the Page for a given Platform Email |
|
12
13
|
| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
|
13
14
|
| [**list_platform_emails**](DealApi.md#list_platform_emails) | **GET** /deals/{id}/platform_emails | Get a list of platform emails for the deal |
|
14
15
|
| [**patch_platform_email**](DealApi.md#patch_platform_email) | **PATCH** /deals/{id}/platform_emails/{kind}/update | Patch platform email by kind and deal. |
|
@@ -354,6 +355,74 @@ No authorization required
|
|
354
355
|
- **Accept**: application/json
|
355
356
|
|
356
357
|
|
358
|
+
## get_platform_email_page
|
359
|
+
|
360
|
+
> <V1EntitiesPage> get_platform_email_page(id, platform_email_id)
|
361
|
+
|
362
|
+
Get the Page for a given Platform Email
|
363
|
+
|
364
|
+
Get the Page for a given Platform Email
|
365
|
+
|
366
|
+
### Examples
|
367
|
+
|
368
|
+
```ruby
|
369
|
+
require 'time'
|
370
|
+
require 'DealMakerAPI'
|
371
|
+
# setup authorization
|
372
|
+
DealMakerAPI.configure do |config|end
|
373
|
+
|
374
|
+
api_instance = DealMakerAPI::DealApi.new
|
375
|
+
id = 56 # Integer | The deal id.
|
376
|
+
platform_email_id = 56 # Integer | The platform email id.
|
377
|
+
|
378
|
+
begin
|
379
|
+
# Get the Page for a given Platform Email
|
380
|
+
result = api_instance.get_platform_email_page(id, platform_email_id)
|
381
|
+
p result
|
382
|
+
rescue DealMakerAPI::ApiError => e
|
383
|
+
puts "Error when calling DealApi->get_platform_email_page: #{e}"
|
384
|
+
end
|
385
|
+
```
|
386
|
+
|
387
|
+
#### Using the get_platform_email_page_with_http_info variant
|
388
|
+
|
389
|
+
This returns an Array which contains the response data, status code and headers.
|
390
|
+
|
391
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> get_platform_email_page_with_http_info(id, platform_email_id)
|
392
|
+
|
393
|
+
```ruby
|
394
|
+
begin
|
395
|
+
# Get the Page for a given Platform Email
|
396
|
+
data, status_code, headers = api_instance.get_platform_email_page_with_http_info(id, platform_email_id)
|
397
|
+
p status_code # => 2xx
|
398
|
+
p headers # => { ... }
|
399
|
+
p data # => <V1EntitiesPage>
|
400
|
+
rescue DealMakerAPI::ApiError => e
|
401
|
+
puts "Error when calling DealApi->get_platform_email_page_with_http_info: #{e}"
|
402
|
+
end
|
403
|
+
```
|
404
|
+
|
405
|
+
### Parameters
|
406
|
+
|
407
|
+
| Name | Type | Description | Notes |
|
408
|
+
| ---- | ---- | ----------- | ----- |
|
409
|
+
| **id** | **Integer** | The deal id. | |
|
410
|
+
| **platform_email_id** | **Integer** | The platform email id. | |
|
411
|
+
|
412
|
+
### Return type
|
413
|
+
|
414
|
+
[**V1EntitiesPage**](V1EntitiesPage.md)
|
415
|
+
|
416
|
+
### Authorization
|
417
|
+
|
418
|
+
No authorization required
|
419
|
+
|
420
|
+
### HTTP request headers
|
421
|
+
|
422
|
+
- **Content-Type**: Not defined
|
423
|
+
- **Accept**: application/json
|
424
|
+
|
425
|
+
|
357
426
|
## list_deals
|
358
427
|
|
359
428
|
> <V1EntitiesDeals> list_deals(opts)
|
data/docs/ShwApi.md
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
# DealMakerAPI::ShwApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_shw_page**](ShwApi.md#get_shw_page) | **GET** /shw/{id}/page | Get self hosted website page |
|
8
|
+
| [**publish_shw_page**](ShwApi.md#publish_shw_page) | **PATCH** /shw/{id}/page/publish | Publish self hosted website page |
|
9
|
+
|
10
|
+
|
11
|
+
## get_shw_page
|
12
|
+
|
13
|
+
> <V1EntitiesPage> get_shw_page(id)
|
14
|
+
|
15
|
+
Get self hosted website page
|
16
|
+
|
17
|
+
Get self hosted website page
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'DealMakerAPI'
|
24
|
+
# setup authorization
|
25
|
+
DealMakerAPI.configure do |config|end
|
26
|
+
|
27
|
+
api_instance = DealMakerAPI::ShwApi.new
|
28
|
+
id = 56 # Integer |
|
29
|
+
|
30
|
+
begin
|
31
|
+
# Get self hosted website page
|
32
|
+
result = api_instance.get_shw_page(id)
|
33
|
+
p result
|
34
|
+
rescue DealMakerAPI::ApiError => e
|
35
|
+
puts "Error when calling ShwApi->get_shw_page: #{e}"
|
36
|
+
end
|
37
|
+
```
|
38
|
+
|
39
|
+
#### Using the get_shw_page_with_http_info variant
|
40
|
+
|
41
|
+
This returns an Array which contains the response data, status code and headers.
|
42
|
+
|
43
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> get_shw_page_with_http_info(id)
|
44
|
+
|
45
|
+
```ruby
|
46
|
+
begin
|
47
|
+
# Get self hosted website page
|
48
|
+
data, status_code, headers = api_instance.get_shw_page_with_http_info(id)
|
49
|
+
p status_code # => 2xx
|
50
|
+
p headers # => { ... }
|
51
|
+
p data # => <V1EntitiesPage>
|
52
|
+
rescue DealMakerAPI::ApiError => e
|
53
|
+
puts "Error when calling ShwApi->get_shw_page_with_http_info: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
### Parameters
|
58
|
+
|
59
|
+
| Name | Type | Description | Notes |
|
60
|
+
| ---- | ---- | ----------- | ----- |
|
61
|
+
| **id** | **Integer** | | |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**V1EntitiesPage**](V1EntitiesPage.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
## publish_shw_page
|
78
|
+
|
79
|
+
> <V1EntitiesPage> publish_shw_page(id)
|
80
|
+
|
81
|
+
Publish self hosted website page
|
82
|
+
|
83
|
+
Publish self hosted website page
|
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::ShwApi.new
|
94
|
+
id = 56 # Integer |
|
95
|
+
|
96
|
+
begin
|
97
|
+
# Publish self hosted website page
|
98
|
+
result = api_instance.publish_shw_page(id)
|
99
|
+
p result
|
100
|
+
rescue DealMakerAPI::ApiError => e
|
101
|
+
puts "Error when calling ShwApi->publish_shw_page: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
#### Using the publish_shw_page_with_http_info variant
|
106
|
+
|
107
|
+
This returns an Array which contains the response data, status code and headers.
|
108
|
+
|
109
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> publish_shw_page_with_http_info(id)
|
110
|
+
|
111
|
+
```ruby
|
112
|
+
begin
|
113
|
+
# Publish self hosted website page
|
114
|
+
data, status_code, headers = api_instance.publish_shw_page_with_http_info(id)
|
115
|
+
p status_code # => 2xx
|
116
|
+
p headers # => { ... }
|
117
|
+
p data # => <V1EntitiesPage>
|
118
|
+
rescue DealMakerAPI::ApiError => e
|
119
|
+
puts "Error when calling ShwApi->publish_shw_page_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
|
+
[**V1EntitiesPage**](V1EntitiesPage.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,141 @@
|
|
1
|
+
# DealMakerAPI::TtwCampaignsApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_ttw_campaign_page**](TtwCampaignsApi.md#get_ttw_campaign_page) | **GET** /ttw/campaigns/{id}/page | Get ttw campaign page |
|
8
|
+
| [**publish_ttw_campaign_page**](TtwCampaignsApi.md#publish_ttw_campaign_page) | **PATCH** /ttw/campaigns/{id}/page/publish | Publish ttw campaign page |
|
9
|
+
|
10
|
+
|
11
|
+
## get_ttw_campaign_page
|
12
|
+
|
13
|
+
> <V1EntitiesPage> get_ttw_campaign_page(id)
|
14
|
+
|
15
|
+
Get ttw campaign page
|
16
|
+
|
17
|
+
Get ttw campaign page
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'DealMakerAPI'
|
24
|
+
# setup authorization
|
25
|
+
DealMakerAPI.configure do |config|end
|
26
|
+
|
27
|
+
api_instance = DealMakerAPI::TtwCampaignsApi.new
|
28
|
+
id = 56 # Integer |
|
29
|
+
|
30
|
+
begin
|
31
|
+
# Get ttw campaign page
|
32
|
+
result = api_instance.get_ttw_campaign_page(id)
|
33
|
+
p result
|
34
|
+
rescue DealMakerAPI::ApiError => e
|
35
|
+
puts "Error when calling TtwCampaignsApi->get_ttw_campaign_page: #{e}"
|
36
|
+
end
|
37
|
+
```
|
38
|
+
|
39
|
+
#### Using the get_ttw_campaign_page_with_http_info variant
|
40
|
+
|
41
|
+
This returns an Array which contains the response data, status code and headers.
|
42
|
+
|
43
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> get_ttw_campaign_page_with_http_info(id)
|
44
|
+
|
45
|
+
```ruby
|
46
|
+
begin
|
47
|
+
# Get ttw campaign page
|
48
|
+
data, status_code, headers = api_instance.get_ttw_campaign_page_with_http_info(id)
|
49
|
+
p status_code # => 2xx
|
50
|
+
p headers # => { ... }
|
51
|
+
p data # => <V1EntitiesPage>
|
52
|
+
rescue DealMakerAPI::ApiError => e
|
53
|
+
puts "Error when calling TtwCampaignsApi->get_ttw_campaign_page_with_http_info: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
### Parameters
|
58
|
+
|
59
|
+
| Name | Type | Description | Notes |
|
60
|
+
| ---- | ---- | ----------- | ----- |
|
61
|
+
| **id** | **Integer** | | |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**V1EntitiesPage**](V1EntitiesPage.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
## publish_ttw_campaign_page
|
78
|
+
|
79
|
+
> <V1EntitiesPage> publish_ttw_campaign_page(id)
|
80
|
+
|
81
|
+
Publish ttw campaign page
|
82
|
+
|
83
|
+
Publish ttw campaign page
|
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::TtwCampaignsApi.new
|
94
|
+
id = 56 # Integer |
|
95
|
+
|
96
|
+
begin
|
97
|
+
# Publish ttw campaign page
|
98
|
+
result = api_instance.publish_ttw_campaign_page(id)
|
99
|
+
p result
|
100
|
+
rescue DealMakerAPI::ApiError => e
|
101
|
+
puts "Error when calling TtwCampaignsApi->publish_ttw_campaign_page: #{e}"
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
#### Using the publish_ttw_campaign_page_with_http_info variant
|
106
|
+
|
107
|
+
This returns an Array which contains the response data, status code and headers.
|
108
|
+
|
109
|
+
> <Array(<V1EntitiesPage>, Integer, Hash)> publish_ttw_campaign_page_with_http_info(id)
|
110
|
+
|
111
|
+
```ruby
|
112
|
+
begin
|
113
|
+
# Publish ttw campaign page
|
114
|
+
data, status_code, headers = api_instance.publish_ttw_campaign_page_with_http_info(id)
|
115
|
+
p status_code # => 2xx
|
116
|
+
p headers # => { ... }
|
117
|
+
p data # => <V1EntitiesPage>
|
118
|
+
rescue DealMakerAPI::ApiError => e
|
119
|
+
puts "Error when calling TtwCampaignsApi->publish_ttw_campaign_page_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
|
+
[**V1EntitiesPage**](V1EntitiesPage.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,34 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesPage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The page id. | [optional] |
|
8
|
+
| **name** | **String** | The page name. | [optional] |
|
9
|
+
| **draft_json_content** | **String** | The page draft json content. | [optional] |
|
10
|
+
| **json_content** | **String** | The page live json content. | [optional] |
|
11
|
+
| **pageable_type** | **String** | The pageable type. | [optional] |
|
12
|
+
| **pageable_id** | **Integer** | The pageable id. | [optional] |
|
13
|
+
| **page_template_id** | **Integer** | The page template id. | [optional] |
|
14
|
+
| **created_at** | **Time** | The creation time. | [optional] |
|
15
|
+
| **updated_at** | **Time** | The last update time. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'DealMakerAPI'
|
21
|
+
|
22
|
+
instance = DealMakerAPI::V1EntitiesPage.new(
|
23
|
+
id: null,
|
24
|
+
name: null,
|
25
|
+
draft_json_content: null,
|
26
|
+
json_content: null,
|
27
|
+
pageable_type: null,
|
28
|
+
pageable_id: null,
|
29
|
+
page_template_id: null,
|
30
|
+
created_at: null,
|
31
|
+
updated_at: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -4,8 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **token** | **String** | The token for the reservation. | [optional] |
|
7
|
+
| **uuid** | **Integer** | The ID of the reservation. | [optional] |
|
9
8
|
|
10
9
|
## Example
|
11
10
|
|
@@ -13,8 +12,7 @@
|
|
13
12
|
require 'DealMakerAPI'
|
14
13
|
|
15
14
|
instance = DealMakerAPI::V1EntitiesTtwReservationCreate.new(
|
16
|
-
|
17
|
-
token: null
|
15
|
+
uuid: null
|
18
16
|
)
|
19
17
|
```
|
20
18
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesTtwReservationGetResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **token** | **String** | The token for the user. | [optional] |
|
8
|
+
| **reservation_id** | **Integer** | The ID of the reservation. | [optional] |
|
9
|
+
| **complete** | **Boolean** | Whether the reservation is complete. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::V1EntitiesTtwReservationGetResponse.new(
|
17
|
+
token: null,
|
18
|
+
reservation_id: null,
|
19
|
+
complete: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -148,21 +148,21 @@ module DealMakerAPI
|
|
148
148
|
# Gets User ID for a TTW reservation
|
149
149
|
# Gets a TTW reservation
|
150
150
|
# @param id [Integer]
|
151
|
-
# @param
|
151
|
+
# @param reservation_uuid [Integer]
|
152
152
|
# @param [Hash] opts the optional parameters
|
153
|
-
# @return [
|
154
|
-
def get_user_ttw_reservation(id,
|
155
|
-
data, _status_code, _headers = get_user_ttw_reservation_with_http_info(id,
|
153
|
+
# @return [V1EntitiesTtwReservationGetResponse]
|
154
|
+
def get_user_ttw_reservation(id, reservation_uuid, opts = {})
|
155
|
+
data, _status_code, _headers = get_user_ttw_reservation_with_http_info(id, reservation_uuid, opts)
|
156
156
|
data
|
157
157
|
end
|
158
158
|
|
159
159
|
# Gets User ID for a TTW reservation
|
160
160
|
# Gets a TTW reservation
|
161
161
|
# @param id [Integer]
|
162
|
-
# @param
|
162
|
+
# @param reservation_uuid [Integer]
|
163
163
|
# @param [Hash] opts the optional parameters
|
164
|
-
# @return [Array<(
|
165
|
-
def get_user_ttw_reservation_with_http_info(id,
|
164
|
+
# @return [Array<(V1EntitiesTtwReservationGetResponse, Integer, Hash)>] V1EntitiesTtwReservationGetResponse data, response status code and response headers
|
165
|
+
def get_user_ttw_reservation_with_http_info(id, reservation_uuid, opts = {})
|
166
166
|
if @api_client.config.debugging
|
167
167
|
@api_client.config.logger.debug 'Calling API: CampaignApi.get_user_ttw_reservation ...'
|
168
168
|
end
|
@@ -170,12 +170,12 @@ module DealMakerAPI
|
|
170
170
|
if @api_client.config.client_side_validation && id.nil?
|
171
171
|
fail ArgumentError, "Missing the required parameter 'id' when calling CampaignApi.get_user_ttw_reservation"
|
172
172
|
end
|
173
|
-
# verify the required parameter '
|
174
|
-
if @api_client.config.client_side_validation &&
|
175
|
-
fail ArgumentError, "Missing the required parameter '
|
173
|
+
# verify the required parameter 'reservation_uuid' is set
|
174
|
+
if @api_client.config.client_side_validation && reservation_uuid.nil?
|
175
|
+
fail ArgumentError, "Missing the required parameter 'reservation_uuid' when calling CampaignApi.get_user_ttw_reservation"
|
176
176
|
end
|
177
177
|
# resource path
|
178
|
-
local_var_path = '/ttw/campaign/{id}/reservation/{
|
178
|
+
local_var_path = '/ttw/campaign/{id}/reservation/{reservation_uuid}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'reservation_uuid' + '}', CGI.escape(reservation_uuid.to_s))
|
179
179
|
|
180
180
|
# query parameters
|
181
181
|
query_params = opts[:query_params] || {}
|
@@ -192,7 +192,7 @@ module DealMakerAPI
|
|
192
192
|
post_body = opts[:debug_body]
|
193
193
|
|
194
194
|
# return_type
|
195
|
-
return_type = opts[:debug_return_type] || '
|
195
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesTtwReservationGetResponse'
|
196
196
|
|
197
197
|
# auth_names
|
198
198
|
auth_names = opts[:debug_auth_names] || []
|