-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Api.CampaignApi | ||
|
||
All URIs are relative to *http://api.dealmaker.tech* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**getTtwCampaign**](CampaignApi.md#getTtwCampaign) | **GET** /ttw/campaigns/{id} | Gets a TTW campaign for a given company | ||
|
||
|
||
|
||
## getTtwCampaign | ||
|
||
> V1EntitiesTtwCampaignResponse getTtwCampaign(id) | ||
Gets a TTW campaign for a given company | ||
|
||
Gets a TTW campaign for a given company | ||
|
||
### Example | ||
|
||
```javascript | ||
import Api from 'api'; | ||
let defaultClient = Api.ApiClient.instance; | ||
|
||
let apiInstance = new Api.CampaignApi(); | ||
let id = 56; // Number | | ||
apiInstance.getTtwCampaign(id, (error, data, response) => { | ||
if (error) { | ||
console.error(error); | ||
} else { | ||
console.log('API called successfully. Returned data: ' + data); | ||
} | ||
}); | ||
``` | ||
|
||
### Parameters | ||
|
||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**id** | **Number**| | | ||
|
||
### Return type | ||
|
||
[**V1EntitiesTtwCampaignResponse**](V1EntitiesTtwCampaignResponse.md) | ||
|
||
### Authorization | ||
|
||
No authorization required | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: Not defined | ||
- **Accept**: application/json | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Api.V1EntitiesTtwCampaignResponse | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**id** | **Number** | The campaign ID | [optional] | ||
**name** | **String** | Campaign name | [optional] | ||
**redirectLink** | **String** | Redirect link for the campaign | [optional] | ||
**introductionEmail** | **Boolean** | State of the introduction email | [optional] | ||
**oneDayReminderEmail** | **Boolean** | State of the 1 day reminder email | [optional] | ||
**twoDayReminderEmail** | **Boolean** | State of the 2 day reminder email | [optional] | ||
**sevenDayReminderEmail** | **Boolean** | State of the 7 day reminder email | [optional] | ||
**confirmationEmail** | **Boolean** | State of the confirmation email | [optional] | ||
|
||
|
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.