@voucherify/sdk 2.9.3 → 3.0.0

package/docs/PromotionsTiersEnableResponseBodyCampaign.md

@@ -0,0 +1,38 @@
+# Voucherify.PromotionsTiersEnableResponseBodyCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID. | [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] 
+**active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional] [default to 'campaign']
+
+
+
+## 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/PromotionsTiersEnableResponseBodySummary.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersEnableResponseBodySummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**PromotionsTiersEnableResponseBodySummaryRedemptions**](PromotionsTiersEnableResponseBodySummaryRedemptions.md) |  | [optional] 
+**orders** | [**PromotionsTiersEnableResponseBodySummaryOrders**](PromotionsTiersEnableResponseBodySummaryOrders.md) |  | [optional] 
+
+

package/docs/PromotionsTiersEnableResponseBodySummaryOrders.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersEnableResponseBodySummaryOrders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **Number** | Sum of order totals. | [optional] 
+**totalDiscountAmount** | **Number** | Sum of total discount applied using the promotion tier. | [optional] 
+
+

package/docs/PromotionsTiersEnableResponseBodySummaryRedemptions.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersEnableResponseBodySummaryRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalRedeemed** | **Number** | Number of times the promotion tier was redeemed. | [optional] 
+
+

package/docs/PromotionsTiersGetResponseBody.md

@@ -0,0 +1,51 @@
+# Voucherify.PromotionsTiersGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique promotion tier ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] 
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**PromotionsTiersGetResponseBodyAction**](PromotionsTiersGetResponseBodyAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**promotionId** | **String** | Promotion unique ID. | [optional] 
+**campaign** | [**PromotionsTiersGetResponseBodyCampaign**](PromotionsTiersGetResponseBodyCampaign.md) |  | [optional] 
+**campaignId** | **String** | Promotion tier's parent campaign's unique ID. | [optional] 
+**active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier 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] 
+**summary** | [**PromotionsTiersGetResponseBodySummary**](PromotionsTiersGetResponseBodySummary.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional] [default to 'promotion_tier']
+**validationRuleAssignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] 
+**categoryId** | **String** | Promotion tier category ID. | [optional] 
+**categories** | [**[Category]**](Category.md) |  | [optional] 
+
+
+
+## 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/PromotionsTiersGetResponseBodyAction.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersGetResponseBodyAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/PromotionsTiersGetResponseBodyCampaign.md

@@ -0,0 +1,38 @@
+# Voucherify.PromotionsTiersGetResponseBodyCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID. | [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] 
+**active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional] [default to 'campaign']
+
+
+
+## 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/PromotionsTiersGetResponseBodySummary.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersGetResponseBodySummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**PromotionsTiersGetResponseBodySummaryRedemptions**](PromotionsTiersGetResponseBodySummaryRedemptions.md) |  | [optional] 
+**orders** | [**PromotionsTiersGetResponseBodySummaryOrders**](PromotionsTiersGetResponseBodySummaryOrders.md) |  | [optional] 
+
+

package/docs/PromotionsTiersGetResponseBodySummaryOrders.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersGetResponseBodySummaryOrders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **Number** | Sum of order totals. | [optional] 
+**totalDiscountAmount** | **Number** | Sum of total discount applied using the promotion tier. | [optional] 
+
+

package/docs/PromotionsTiersGetResponseBodySummaryRedemptions.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersGetResponseBodySummaryRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalRedeemed** | **Number** | Number of times the promotion tier was redeemed. | [optional] 
+
+

package/docs/PromotionsTiersListResponseBody.md

@@ -0,0 +1,13 @@
+# Voucherify.PromotionsTiersListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of promotion tier objects. | [optional] [default to 'tiers']
+**tiers** | [**[PromotionTier]**](PromotionTier.md) | Contains array of promotion tier objects. | [optional] 
+**total** | **Number** | Total number of promotion tiers. | [optional] 
+**hasMore** | **Boolean** | As query results are always limited (by the limit parameter), the `has_more` flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results. | [optional] 
+
+

package/docs/PromotionsTiersUpdateRequestBody.md

@@ -0,0 +1,42 @@
+# Voucherify.PromotionsTiersUpdateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**PromotionsTiersUpdateRequestBodyAction**](PromotionsTiersUpdateRequestBodyAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier 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] 
+**validationRuleAssignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] 
+**category** | **String** | Assign a new or update the promotion tier's category using name. | [optional] 
+**categoryId** | **String** | Assign a new or update the promotion tier's category using id | [optional] 
+
+
+
+## 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/PromotionsTiersUpdateRequestBodyAction.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersUpdateRequestBodyAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/PromotionsTiersUpdateResponseBody.md

@@ -0,0 +1,51 @@
+# Voucherify.PromotionsTiersUpdateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique promotion tier ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] 
+**name** | **String** | Name of the promotion tier. | [optional] 
+**banner** | **String** | Text to be displayed to your customers on your website. | [optional] 
+**action** | [**PromotionsTiersUpdateResponseBodyAction**](PromotionsTiersUpdateResponseBodyAction.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format. | [optional] 
+**hierarchy** | **Number** | The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy. | [optional] 
+**promotionId** | **String** | Promotion unique ID. | [optional] 
+**campaign** | [**PromotionsTiersUpdateResponseBodyCampaign**](PromotionsTiersUpdateResponseBodyCampaign.md) |  | [optional] 
+**campaignId** | **String** | Promotion tier's parent campaign's unique ID. | [optional] 
+**active** | **Boolean** | A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* promotion tier - `false` indicates an *inactive* promotion tier | [optional] 
+**startDate** | **Date** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] 
+**expirationDate** | **Date** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier 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] 
+**summary** | [**PromotionsTiersUpdateResponseBodySummary**](PromotionsTiersUpdateResponseBodySummary.md) |  | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional] [default to 'promotion_tier']
+**validationRuleAssignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] 
+**categoryId** | **String** | Promotion tier category ID. | [optional] 
+**categories** | [**[Category]**](Category.md) |  | [optional] 
+
+
+
+## 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/PromotionsTiersUpdateResponseBodyAction.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersUpdateResponseBodyAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+
+

package/docs/PromotionsTiersUpdateResponseBodyCampaign.md

@@ -0,0 +1,38 @@
+# Voucherify.PromotionsTiersUpdateResponseBodyCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID. | [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] 
+**active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] 
+**categoryId** | **String** | Unique category ID that this campaign belongs to. | [optional] 
+**object** | **String** | The type of the object represented by the campaign object. This object stores information about the campaign. | [optional] [default to 'campaign']
+
+
+
+## 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/PromotionsTiersUpdateResponseBodySummary.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersUpdateResponseBodySummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redemptions** | [**PromotionsTiersUpdateResponseBodySummaryRedemptions**](PromotionsTiersUpdateResponseBodySummaryRedemptions.md) |  | [optional] 
+**orders** | [**PromotionsTiersUpdateResponseBodySummaryOrders**](PromotionsTiersUpdateResponseBodySummaryOrders.md) |  | [optional] 
+
+

package/docs/PromotionsTiersUpdateResponseBodySummaryOrders.md

@@ -0,0 +1,10 @@
+# Voucherify.PromotionsTiersUpdateResponseBodySummaryOrders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalAmount** | **Number** | Sum of order totals. | [optional] 
+**totalDiscountAmount** | **Number** | Sum of total discount applied using the promotion tier. | [optional] 
+
+

package/docs/PromotionsTiersUpdateResponseBodySummaryRedemptions.md

@@ -0,0 +1,9 @@
+# Voucherify.PromotionsTiersUpdateResponseBodySummaryRedemptions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalRedeemed** | **Number** | Number of times the promotion tier was redeemed. | [optional] 
+
+

package/docs/PublicationsApi.md

@@ -0,0 +1,226 @@
+# Voucherify.PublicationsApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createPublication**](PublicationsApi.md#createPublication) | **POST** /v1/publications | Create Publication
+[**createPublication1**](PublicationsApi.md#createPublication1) | **GET** /v1/publications/create | Create Publication with GET
+[**listPublications**](PublicationsApi.md#listPublications) | **GET** /v1/publications | List Publications
+
+
+
+## createPublication
+
+> PublicationsCreateResponseBody createPublication(publicationsCreateRequestBody, opts)
+
+Create Publication
+
+This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.    🚧 Clearly define the source of the voucher  You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.    🚧 Publish multiple vouchers  In case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish.    📘 Auto-update campaign  In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.
+
+### 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.PublicationsApi();
+let publicationsCreateRequestBody = {"campaign":{"name":"campaign-name"},"customer":{"source_id":"source-id","Name":"Customer Name","email":"customer email"},"voucher":"voucher-code","metadata":{"key":"value"}}; // PublicationsCreateRequestBody | Specify the publication parameters.
+let opts = {
+  'joinOnce': true // Boolean | Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer.
+};
+apiInstance.createPublication(publicationsCreateRequestBody, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **publicationsCreateRequestBody** | [**PublicationsCreateRequestBody**](PublicationsCreateRequestBody.md)| Specify the publication parameters. | 
+ **joinOnce** | **Boolean**| Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. | [optional] 
+
+### Return type
+
+[**PublicationsCreateResponseBody**](PublicationsCreateResponseBody.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
+
+
+## createPublication1
+
+> PublicationsCreateResponseBody createPublication1(customer, opts)
+
+Create Publication with GET
+
+This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication. A voucher is suitable for publication when its active and hasnt been published yet.  ❗️ Limited access  Access to this endpoint is limited. This endpoint is designed for specific integrations and the API keys need to be configured to access this endpoint. Navigate to the **Dashboard** → **Project Settings** → **General** → **Integration Keys** to set up a pair of API keys and use them to send the request.    🚧 Clearly define the source of the voucher  You must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.    🚧 Publish multiple vouchers  This endpoint does not support the publishing of multiple vouchers from a single campaign. In case you want to publish multiple vouchers within a single publication, you need to use a [dedicated endpoint](/api-reference/publications/create-publication).    📘 Auto-update campaign  In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.   # Example Request      ❗️ Required    Query param voucher OR campaign MUST be filled out. If you provide both, campaign param will be skipped.
+
+### 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.PublicationsApi();
+let customer = new Voucherify.Customer(); // Customer | Contains information about the customer to whom the publication was directed.
+let opts = {
+  'joinOnce': true, // Boolean | Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer.
+  'voucher': "voucher_example", // String | Code of voucher being published.
+  'campaign': new Voucherify.CreatePublicationCampaign(), // CreatePublicationCampaign | Create publication with campaign.
+  'sourceId': "sourceId_example", // String | The merchants publication ID if it is different from the Voucherify publication ID. Its an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service. If source_id is provided only 1 voucher can be published per request.
+  'metadata': {key: null} // Object | The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format.
+};
+apiInstance.createPublication1(customer, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer** | [**Customer**](.md)| Contains information about the customer to whom the publication was directed. | 
+ **joinOnce** | **Boolean**| Through this flag, you can control if a particular person gets only one and always the same code even if the app sends multiple publication requests. It means that if you have a referral program, a referrer is assigned only to one code if an integration sends publication requests more than once for the same customer. | [optional] 
+ **voucher** | **String**| Code of voucher being published. | [optional] 
+ **campaign** | [**CreatePublicationCampaign**](.md)| Create publication with campaign. | [optional] 
+ **sourceId** | **String**| The merchants publication ID if it is different from the Voucherify publication ID. Its an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service. If source_id is provided only 1 voucher can be published per request. | [optional] 
+ **metadata** | [**Object**](.md)| The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format. | [optional] 
+
+### Return type
+
+[**PublicationsCreateResponseBody**](PublicationsCreateResponseBody.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
+
+
+## listPublications
+
+> PublicationsListResponseBody listPublications(opts)
+
+List Publications
+
+Retrieve a list of publications. To return a **particular** publication, you can use the source_id query parameter and provide the source_id of the publication you are looking for specifically. # Pagination  🚧 Important!  If you want to scroll through a huge set of records, it is recommended to use the [Exports API](/api-reference/exports/create-export). This API will return an error page_over_limit if you reach a page above 1000. # Filter Query The filters query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows:  ## Examples  
+
+### 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.PublicationsApi();
+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.
+  'page': 56, // Number | Which page of results to return. The lowest value is 1.
+  'order': new Voucherify.ParameterOrderListPublications(), // ParameterOrderListPublications | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  'campaign': "campaign_example", // String | Filters by a given campaign name.
+  'customer': "customer_example", // String | Filters by a unique customer ID.
+  'voucher': "voucher_example", // String | Filters by a given voucher code.
+  'result': new Voucherify.ParameterResultListPublications(), // ParameterResultListPublications | Filters by a publication result.
+  'voucherType': new Voucherify.ParameterVoucherTypeListPublications(), // ParameterVoucherTypeListPublications | Filters by a voucher type.
+  'isReferralCode': true, // Boolean | This filter works only for the true option. If set to true, the query returns only publications of codes from referral campaigns. 
+  'filters': new Voucherify.ParameterFiltersListPublications(), // ParameterFiltersListPublications | Filters for listing publications.
+  'sourceId': "sourceId_example" // String | Using this endpoint with a particular publication source_id, which was sent with the original request to create a publication, returns in the response, exactly the same code published initially because the code was assigned to the given publication. As a result, you can use this endpoint as a reference and return a code that was assigned in a publication by using a particular source_id.
+};
+apiInstance.listPublications(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] 
+ **page** | **Number**| Which page of results to return. The lowest value is 1. | [optional] 
+ **order** | [**ParameterOrderListPublications**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **campaign** | **String**| Filters by a given campaign name. | [optional] 
+ **customer** | **String**| Filters by a unique customer ID. | [optional] 
+ **voucher** | **String**| Filters by a given voucher code. | [optional] 
+ **result** | [**ParameterResultListPublications**](.md)| Filters by a publication result. | [optional] 
+ **voucherType** | [**ParameterVoucherTypeListPublications**](.md)| Filters by a voucher type. | [optional] 
+ **isReferralCode** | **Boolean**| This filter works only for the true option. If set to true, the query returns only publications of codes from referral campaigns.  | [optional] 
+ **filters** | [**ParameterFiltersListPublications**](.md)| Filters for listing publications. | [optional] 
+ **sourceId** | **String**| Using this endpoint with a particular publication source_id, which was sent with the original request to create a publication, returns in the response, exactly the same code published initially because the code was assigned to the given publication. As a result, you can use this endpoint as a reference and return a code that was assigned in a publication by using a particular source_id. | [optional] 
+
+### Return type
+
+[**PublicationsListResponseBody**](PublicationsListResponseBody.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
+