DealMakerAPI 0.107.0 → 0.107.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -6
  3. data/docs/CampaignApi.md +9 -9
  4. data/docs/DealApi.md +69 -0
  5. data/docs/ShwApi.md +141 -0
  6. data/docs/TtwCampaignsApi.md +141 -0
  7. data/docs/V1EntitiesPage.md +34 -0
  8. data/docs/V1EntitiesTtwReservationCreate.md +2 -4
  9. data/docs/V1EntitiesTtwReservationGetResponse.md +20 -0
  10. data/lib/DealMakerAPI/api/campaign_api.rb +15 -15
  11. data/lib/DealMakerAPI/api/company_api.rb +20 -20
  12. data/lib/DealMakerAPI/api/country_api.rb +1 -1
  13. data/lib/DealMakerAPI/api/custom_emails_api.rb +1 -1
  14. data/lib/DealMakerAPI/api/deal_api.rb +77 -8
  15. data/lib/DealMakerAPI/api/default_api.rb +15 -15
  16. data/lib/DealMakerAPI/api/incentive_plan_api.rb +3 -3
  17. data/lib/DealMakerAPI/api/investor_api.rb +13 -13
  18. data/lib/DealMakerAPI/api/investor_profile_api.rb +13 -13
  19. data/lib/DealMakerAPI/api/reservation_api.rb +2 -2
  20. data/lib/DealMakerAPI/api/shareholder_api.rb +2 -2
  21. data/lib/DealMakerAPI/api/shw_api.rb +148 -0
  22. data/lib/DealMakerAPI/api/ttw_campaigns_api.rb +148 -0
  23. data/lib/DealMakerAPI/api/upload_api.rb +1 -1
  24. data/lib/DealMakerAPI/api/user_api.rb +9 -9
  25. data/lib/DealMakerAPI/api/users_api.rb +2 -2
  26. data/lib/DealMakerAPI/models/v1_entities_page.rb +296 -0
  27. data/lib/DealMakerAPI/models/v1_entities_ttw_reservation_create.rb +7 -17
  28. data/lib/DealMakerAPI/models/{v1_entities_ttw_reservation_user_id.rb → v1_entities_ttw_reservation_get_response.rb} +22 -12
  29. data/lib/DealMakerAPI/version.rb +1 -1
  30. data/lib/DealMakerAPI.rb +4 -1
  31. data/spec/api/campaign_api_spec.rb +2 -2
  32. data/spec/api/deal_api_spec.rb +13 -0
  33. data/spec/api/shw_api_spec.rb +59 -0
  34. data/spec/api/ttw_campaigns_api_spec.rb +59 -0
  35. data/spec/models/v1_entities_page_spec.rb +84 -0
  36. data/spec/models/v1_entities_ttw_reservation_create_spec.rb +1 -7
  37. data/spec/models/{v1_entities_ttw_reservation_user_id_spec.rb → v1_entities_ttw_reservation_get_response_spec.rb} +13 -7
  38. metadata +154 -142
  39. data/docs/V1EntitiesTtwReservationUserId.md +0 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b3c790d330d804f95a99a8805f31e85887b202ee530ccaf915d05e445d8e5bb9
4
- data.tar.gz: 2bb1f1a95c85405685309ae15495544632cd9752ee06013dba28a3a84215954b
3
+ metadata.gz: 00e65603a3efa00c97f06217c2e58d5962fc1554fbcdeb2b1fe0ee2527631c88
4
+ data.tar.gz: 7842559937dedcf55fc400789d3dfd54f26eef3358ccc3ed7fa1bbd6f61b69bc
5
5
  SHA512:
6
- metadata.gz: a061ad7dd2b8b73d4b98fd957cc2e816206c24d8db63ce74ee68a9a66fe0e98402a37a660ec568c665cdea70cb3dd2d8bbfa1973f7fbe80e04781d38204c30aa
7
- data.tar.gz: 8fb11ea3f1e46375f43e43cb396c84ec0999cc3e29c46823fc00c0d00776248ead8d0b06fe943e9b62526e7097861479183e9a157cd1c9297502c8f377034fb2
6
+ metadata.gz: edca57ea5d8d362bb8fd0b868f3b976fdce3e6beb3c2c55c0763eb31e0c18c202ccd6410a7f2f225adf0802f80718c489b4d710b50f827205dac090d3604f3d3
7
+ data.tar.gz: 7b524b1c60e15f66ae9bec7a241ef93be0d5eb0b5bf24e25ad17fd4c25c1be4e0f994f2a35ffac6de66548a48ddeec4fdc45414945143fde351b0ecc250e2553
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.0
341
+ - Package version: 0.107.2
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.0.gem
358
+ gem install ./DealMakerAPI-0.107.2.gem
359
359
  ```
360
360
 
361
- (for development, run `gem install --dev ./DealMakerAPI-0.107.0.gem` to install the development dependencies)
361
+ (for development, run `gem install --dev ./DealMakerAPI-0.107.2.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.0'
367
+ gem 'DealMakerAPI', '~> 0.107.2'
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/{reservation_id}/user_id | Gets User ID for a TTW 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/{reservation_id}/user_id | Gets User ID for a TTW 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
- > <V1EntitiesTtwReservationUserId> get_user_ttw_reservation(id, reservation_id)
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
- reservation_id = 56 # Integer |
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, 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(<V1EntitiesTtwReservationUserId>, Integer, Hash)> get_user_ttw_reservation_with_http_info(id, reservation_id)
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, reservation_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 # => <V1EntitiesTtwReservationUserId>
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
- | **reservation_id** | **Integer** | | |
196
+ | **reservation_uuid** | **Integer** | | |
197
197
 
198
198
  ### Return type
199
199
 
200
- [**V1EntitiesTtwReservationUserId**](V1EntitiesTtwReservationUserId.md)
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
- | **id** | **Integer** | The ID of the reservation. | [optional] |
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
- id: null,
17
- token: null
15
+ uuid: null
18
16
  )
19
17
  ```
20
18
 
@@ -0,0 +1,20 @@
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
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::V1EntitiesTtwReservationGetResponse.new(
16
+ token: null,
17
+ reservation_id: null
18
+ )
19
+ ```
20
+
@@ -51,7 +51,7 @@ module DealMakerAPI
51
51
  # header parameters
52
52
  header_params = opts[:header_params] || {}
53
53
  # HTTP header 'Accept' (if needed)
54
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
55
 
56
56
  # form parameters
57
57
  form_params = opts[:form_params] || {}
@@ -114,7 +114,7 @@ module DealMakerAPI
114
114
  # header parameters
115
115
  header_params = opts[:header_params] || {}
116
116
  # HTTP header 'Accept' (if needed)
117
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
118
118
 
119
119
  # form parameters
120
120
  form_params = opts[:form_params] || {}
@@ -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 reservation_id [Integer]
151
+ # @param reservation_uuid [Integer]
152
152
  # @param [Hash] opts the optional parameters
153
- # @return [V1EntitiesTtwReservationUserId]
154
- def get_user_ttw_reservation(id, reservation_id, opts = {})
155
- data, _status_code, _headers = get_user_ttw_reservation_with_http_info(id, reservation_id, opts)
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 reservation_id [Integer]
162
+ # @param reservation_uuid [Integer]
163
163
  # @param [Hash] opts the optional parameters
164
- # @return [Array<(V1EntitiesTtwReservationUserId, Integer, Hash)>] V1EntitiesTtwReservationUserId data, response status code and response headers
165
- def get_user_ttw_reservation_with_http_info(id, reservation_id, opts = {})
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 'reservation_id' is set
174
- if @api_client.config.client_side_validation && reservation_id.nil?
175
- fail ArgumentError, "Missing the required parameter 'reservation_id' when calling CampaignApi.get_user_ttw_reservation"
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/{reservation_id}/user_id'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'reservation_id' + '}', CGI.escape(reservation_id.to_s))
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] || {}
@@ -183,7 +183,7 @@ module DealMakerAPI
183
183
  # header parameters
184
184
  header_params = opts[:header_params] || {}
185
185
  # HTTP header 'Accept' (if needed)
186
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
186
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
187
187
 
188
188
  # form parameters
189
189
  form_params = opts[:form_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] || 'V1EntitiesTtwReservationUserId'
195
+ return_type = opts[:debug_return_type] || 'V1EntitiesTtwReservationGetResponse'
196
196
 
197
197
  # auth_names
198
198
  auth_names = opts[:debug_auth_names] || []