@voucherify/sdk 2.9.3 → 3.0.0

package/docs/TemplatesApi.md

@@ -0,0 +1,444 @@
+# Voucherify.TemplatesApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**addTierFromTemplate**](TemplatesApi.md#addTierFromTemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/tier-setup | Add Promotion Tier From Template
+[**createCampaignFromTemplate**](TemplatesApi.md#createCampaignFromTemplate) | **POST** /v1/templates/campaigns/{campaignTemplateId}/campaign-setup | Create Campaign From Template
+[**createCampaignTemplate**](TemplatesApi.md#createCampaignTemplate) | **POST** /v1/templates/campaigns | Create Campaign Template
+[**deleteCampaignTemplate**](TemplatesApi.md#deleteCampaignTemplate) | **DELETE** /v1/templates/campaigns/{campaignTemplateId} | Delete Campaign Template
+[**getCampaignTemplate**](TemplatesApi.md#getCampaignTemplate) | **GET** /v1/templates/campaigns/{campaignTemplateId} | Get Campaign Template
+[**listCampaignTemplates**](TemplatesApi.md#listCampaignTemplates) | **GET** /v1/templates/campaigns | List Campaign Templates
+[**updateCampaignTemplate**](TemplatesApi.md#updateCampaignTemplate) | **PUT** /v1/templates/campaigns/{campaignTemplateId} | Update Campaign Template
+
+
+
+## addTierFromTemplate
+
+> TemplatesCampaignsTierSetupCreateResponseBody addTierFromTemplate(campaignTemplateId, templatesCampaignsTierSetupCreateRequestBody)
+
+Add Promotion Tier From Template
+
+Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign. To add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment).  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template)  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let campaignTemplateId = "campaignTemplateId_example"; // String | Pass the campaign template ID that was assigned by Voucherify.
+let templatesCampaignsTierSetupCreateRequestBody = new Voucherify.TemplatesCampaignsTierSetupCreateRequestBody(); // TemplatesCampaignsTierSetupCreateRequestBody | Only name and campaign_id are required. The rest of the fields will overwrite the template configuration.
+apiInstance.addTierFromTemplate(campaignTemplateId, templatesCampaignsTierSetupCreateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignTemplateId** | **String**| Pass the campaign template ID that was assigned by Voucherify. | 
+ **templatesCampaignsTierSetupCreateRequestBody** | [**TemplatesCampaignsTierSetupCreateRequestBody**](TemplatesCampaignsTierSetupCreateRequestBody.md)| Only name and campaign_id are required. The rest of the fields will overwrite the template configuration. | 
+
+### Return type
+
+[**TemplatesCampaignsTierSetupCreateResponseBody**](TemplatesCampaignsTierSetupCreateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## createCampaignFromTemplate
+
+> TemplatesCampaignsCampaignSetupCreateResponseBody createCampaignFromTemplate(campaignTemplateId, templatesCampaignsCampaignSetupCreateRequestBody)
+
+Create Campaign From Template
+
+Creates a campaign out of a campaign template. To create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used. You can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can: - [Update the validation rule](/api-reference/validation-rules/update-validation-rule), - [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment), - [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments).  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template) - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template)  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let campaignTemplateId = "campaignTemplateId_example"; // String | Pass the campaign template ID that was assigned by Voucherify.
+let templatesCampaignsCampaignSetupCreateRequestBody = {"name":"Campaign-out-of-template","description":"Created out of a template","auto_join":true,"join_once":true}; // TemplatesCampaignsCampaignSetupCreateRequestBody | Only name is required. The rest of the fields will overwrite the template configuration.
+apiInstance.createCampaignFromTemplate(campaignTemplateId, templatesCampaignsCampaignSetupCreateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignTemplateId** | **String**| Pass the campaign template ID that was assigned by Voucherify. | 
+ **templatesCampaignsCampaignSetupCreateRequestBody** | [**TemplatesCampaignsCampaignSetupCreateRequestBody**](TemplatesCampaignsCampaignSetupCreateRequestBody.md)| Only name is required. The rest of the fields will overwrite the template configuration. | 
+
+### Return type
+
+[**TemplatesCampaignsCampaignSetupCreateResponseBody**](TemplatesCampaignsCampaignSetupCreateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## createCampaignTemplate
+
+> TemplatesCampaignsCreateTemplateResponseBody createCampaignTemplate(templatesCampaignsCreateRequestBody)
+
+Create Campaign Template
+
+Creates a template for a discount or gift campaign, or a promotion tier. A template stores campaign configuration **without** the following details: - Campaign name - Category - Code count The following elements are not supported by campaign templates: - Redeeming API keys - Redeeming users - Customer loyalty tier - Static segments  👍 Promotion Tiers and Campaign Templates You can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the DISCOUNT_COUPON type. You can use this template to create: - [Discount campaign](/api-reference/templates/create-campaign-from-template), - [Promotion tier](/api-reference/templates/add-promotion-tier-from-template).  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let templatesCampaignsCreateRequestBody = new Voucherify.TemplatesCampaignsCreateRequestBody(); // TemplatesCampaignsCreateRequestBody | Provide details for a campaign template
+apiInstance.createCampaignTemplate(templatesCampaignsCreateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **templatesCampaignsCreateRequestBody** | [**TemplatesCampaignsCreateRequestBody**](TemplatesCampaignsCreateRequestBody.md)| Provide details for a campaign template | 
+
+### Return type
+
+[**TemplatesCampaignsCreateTemplateResponseBody**](TemplatesCampaignsCreateTemplateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## deleteCampaignTemplate
+
+> deleteCampaignTemplate(campaignTemplateId)
+
+Delete Campaign Template
+
+Deletes the campaign template permanently.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let campaignTemplateId = "campaignTemplateId_example"; // String | Pass the campaign template ID that was assigned by Voucherify.
+apiInstance.deleteCampaignTemplate(campaignTemplateId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignTemplateId** | **String**| Pass the campaign template ID that was assigned by Voucherify. | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## getCampaignTemplate
+
+> TemplatesCampaignsGetResponseBody getCampaignTemplate(campaignTemplateId)
+
+Get Campaign Template
+
+Retrieves a campaign template available in the project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let campaignTemplateId = "campaignTemplateId_example"; // String | Pass the campaign template ID that was assigned by Voucherify.
+apiInstance.getCampaignTemplate(campaignTemplateId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignTemplateId** | **String**| Pass the campaign template ID that was assigned by Voucherify. | 
+
+### Return type
+
+[**TemplatesCampaignsGetResponseBody**](TemplatesCampaignsGetResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## listCampaignTemplates
+
+> TemplatesCampaignsListResponseBody listCampaignTemplates(opts)
+
+List Campaign Templates
+
+Lists all campaign templates available in the project.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let opts = {
+  'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
+  'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the campaign templates created after a template with the given ID.
+  'order': new Voucherify.ParameterTemplatesList(), // ParameterTemplatesList | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  'includeTotal': true, // Boolean | If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default.
+  'filters': new Voucherify.ParameterFiltersListTemplates() // ParameterFiltersListTemplates | Filters for listing templates.
+};
+apiInstance.listCampaignTemplates(opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Number**| Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. | [optional] 
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the campaign templates created after a template with the given ID. | [optional] 
+ **order** | [**ParameterTemplatesList**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **includeTotal** | **Boolean**| If set to true, the response returns the number of all campaign templates, regardless of the applied filters or limits. Set to false by default. | [optional] 
+ **filters** | [**ParameterFiltersListTemplates**](.md)| Filters for listing templates. | [optional] 
+
+### Return type
+
+[**TemplatesCampaignsListResponseBody**](TemplatesCampaignsListResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## updateCampaignTemplate
+
+> TemplatesCampaignsUpdateResponseBody updateCampaignTemplate(campaignTemplateId, templatesCampaignsUpdateRequestBody)
+
+Update Campaign Template
+
+Updates the name or description of the campaign template.  📘 Campaign Templates – Documentation Read the [Campaign Templates documentation](https://support.voucherify.io/article/620-campaign-templates) to learn more about this feature.
+
+### Example
+
+```javascript
+import Voucherify from 'voucherify';
+let defaultClient = Voucherify.ApiClient.instance;
+// Configure API key authorization: X-App-Id
+let X-App-Id = defaultClient.authentications['X-App-Id'];
+X-App-Id.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Id.apiKeyPrefix = 'Token';
+// Configure API key authorization: X-App-Token
+let X-App-Token = defaultClient.authentications['X-App-Token'];
+X-App-Token.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//X-App-Token.apiKeyPrefix = 'Token';
+// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
+let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth'];
+X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN';
+
+let apiInstance = new Voucherify.TemplatesApi();
+let campaignTemplateId = "campaignTemplateId_example"; // String | Pass the campaign template ID that was assigned by Voucherify.
+let templatesCampaignsUpdateRequestBody = new Voucherify.TemplatesCampaignsUpdateRequestBody(); // TemplatesCampaignsUpdateRequestBody | Provide the new name or description for the campaign template
+apiInstance.updateCampaignTemplate(campaignTemplateId, templatesCampaignsUpdateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignTemplateId** | **String**| Pass the campaign template ID that was assigned by Voucherify. | 
+ **templatesCampaignsUpdateRequestBody** | [**TemplatesCampaignsUpdateRequestBody**](TemplatesCampaignsUpdateRequestBody.md)| Provide the new name or description for the campaign template | 
+
+### Return type
+
+[**TemplatesCampaignsUpdateResponseBody**](TemplatesCampaignsUpdateResponseBody.md)
+
+### Authorization
+
+[X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

package/docs/TemplatesCampaignsCampaignSetupCreateRequestBody.md

@@ -0,0 +1,58 @@
+# Voucherify.TemplatesCampaignsCampaignSetupCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Campaign name. | [optional] 
+**description** | **String** | An optional field to keep any extra textual information about the campaign such as a campaign description and details. | [optional] 
+**type** | **String** | Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers.  - `AUTO_UPDATE`: the campaign is dynamic, i.e. vouchers will generate based on set criteria -  `STATIC`: vouchers need to be manually published | [optional] 
+**joinOnce** | **Boolean** | If this value is set to `true`, customers will be able to join the campaign only once. For loyalty campaigns, it's forced to `true`, even if `join_once: false` is passed in the request. | [optional] 
+**autoJoin** | **Boolean** | Indicates whether customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled. | [optional] 
+**useVoucherMetadataSchema** | **Boolean** | Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema. | [optional] 
+**vouchersCount** | **Number** | Total number of unique vouchers in campaign (size of campaign). | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] 
+**validityTimeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] 
+**validityDayOfWeek** | **[Number]** | Integer array corresponding to the particular days of the week in which the voucher is valid.  - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday | [optional] 
+**validityHours** | [**ValidityHours**](ValidityHours.md) |  | [optional] 
+**activityDurationAfterPublishing** | **String** | Defines the amount of time the vouchers will be active after publishing. The value is shown in the ISO 8601 format. For example, a voucher with the value of P24D will be valid for a duration of 24 days. | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. Either pass this parameter OR the `category`. | [optional] 
+**category** | **String** | The category assigned to the campaign. Either pass this parameter OR the `category_id`. | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format. | [optional] 
+**accessSettings** | [**AccessSettings**](AccessSettings.md) |  | [optional] 
+**voucher** | [**TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher**](TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `AUTO_UPDATE` (value: `"AUTO_UPDATE"`)
+
+* `STATIC` (value: `"STATIC"`)
+
+
+
+
+
+## Enum: [ValidityDayOfWeekEnum]
+
+
+* `0` (value: `0`)
+
+* `1` (value: `1`)
+
+* `2` (value: `2`)
+
+* `3` (value: `3`)
+
+* `4` (value: `4`)
+
+* `5` (value: `5`)
+
+* `6` (value: `6`)
+
+
+
+

package/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher.md

@@ -0,0 +1,10 @@
+# Voucherify.TemplatesCampaignsCampaignSetupCreateRequestBodyVoucher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**codeConfig** | [**CodeConfig**](CodeConfig.md) |  | [optional] 
+**redemption** | [**TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption**](TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md) |  | [optional] 
+
+

package/docs/TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption.md

@@ -0,0 +1,9 @@
+# Voucherify.TemplatesCampaignsCampaignSetupCreateRequestBodyVoucherRedemption
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Number** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] 
+
+

package/docs/TemplatesCampaignsCampaignSetupCreateResponseBody.md

@@ -0,0 +1,20 @@
+# Voucherify.TemplatesCampaignsCampaignSetupCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdResources** | [**[TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem]**](TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md) | Contains a list of resources that have been added to the project when the campaign has been created out of the template. | [optional] 
+**campaign** | [**Campaign**](Campaign.md) |  | 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the campaign created out of the campaign template. | [optional] [default to 'campaign_setup']
+
+
+
+## Enum: ObjectEnum
+
+
+* `campaign_setup` (value: `"campaign_setup"`)
+
+
+
+

package/docs/TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem.md

@@ -0,0 +1,29 @@
+# Voucherify.TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier assigned to the created resource. It is assigned by Voucherify. | [optional] 
+**object** | **String** | The type of the created resource. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `validation_rules` (value: `"validation_rules"`)
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+* `products_collection` (value: `"products_collection"`)
+
+* `segments` (value: `"segments"`)
+
+* `location` (value: `"location"`)
+
+
+
+

package/docs/TemplatesCampaignsCreateRequestBody.md

@@ -0,0 +1,12 @@
+# Voucherify.TemplatesCampaignsCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaignId** | **String** | Unique identifier of the campaign that will create a template. It must be an ID of an existing discount or gift card campaign. It cannot be passed when `promotion_tier_id` has value. Required when the `promotion_tier_id` is not passed or it is `null`. | [optional] 
+**promotionTierId** | **String** | Unique identifier of the promotion tier that will create a template. It cannot be passed when `campaign_id` has value. Required when the `campaign_id` is not passed or it is `null`. | [optional] 
+**name** | **String** | User-defined name of the campaign template. It must be unique. | [optional] 
+**description** | **String** | User-defined description of the campaign template. | [optional] 
+
+

package/docs/TemplatesCampaignsCreateTemplateResponseBody.md

@@ -0,0 +1,34 @@
+# Voucherify.TemplatesCampaignsCreateTemplateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the campaign template. It is assigned by Voucherify. | [optional] 
+**name** | **String** | User-defined name of the campaign template. | [optional] 
+**description** | **String** | User-defined description of the campaign template. | [optional] 
+**campaignType** | **String** | Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to `DISCOUNT_COUPONS`. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign template was created. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'campaign_template']
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `campaign_template` (value: `"campaign_template"`)
+
+
+
+

package/docs/TemplatesCampaignsGetResponseBody.md

@@ -0,0 +1,35 @@
+# Voucherify.TemplatesCampaignsGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier of the campaign template. It is assigned by Voucherify. | [optional] 
+**name** | **String** | User-defined name of the campaign template. | [optional] 
+**description** | **String** | User-defined description of the campaign template. | [optional] 
+**campaignType** | **String** | Type of the campaign used to create the campaign template. Templates created from a promotion tier are converted to `DISCOUNT_COUPONS`. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the campaign template was created. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'campaign_template']
+**updatedAt** | **Date** | Timestamp representing the date and time when the campaign template was last updated. The value is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: CampaignTypeEnum
+
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `campaign_template` (value: `"campaign_template"`)
+
+
+
+