@voucherify/sdk 2.9.3 → 3.0.0

package/docs/ReferralsApi.md

@@ -0,0 +1,402 @@
+# Voucherify.ReferralsApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**referralsAddHolders**](ReferralsApi.md#referralsAddHolders) | **POST** /v1/referrals/members/{memberId}/holders | Add Referral Code Holders
+[**referralsAddHolders1**](ReferralsApi.md#referralsAddHolders1) | **POST** /v1/referrals/{campaignId}/members/{memberId}/holders | Add Referral Code Holders with Campaign ID
+[**referralsCodeHolders**](ReferralsApi.md#referralsCodeHolders) | **GET** /v1/referrals/{campaignId}/members/{memberId}/holders | List Referral Code Holders with campaign ID
+[**referralsCodeHolders1**](ReferralsApi.md#referralsCodeHolders1) | **GET** /v1/referrals/members/{memberId}/holders | List Referral Code Holders
+[**referralsRemoveHolder**](ReferralsApi.md#referralsRemoveHolder) | **DELETE** /v1/referrals/members/{memberId}/holders/{holderId} | Remove Referral Card Holder
+[**referralsRemoveHolder1**](ReferralsApi.md#referralsRemoveHolder1) | **DELETE** /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | Remove Referral Card Holder with campaign ID
+
+
+
+## referralsAddHolders
+
+> ReferralsMembersHoldersCreateInBulkResponseBody referralsAddHolders(memberId, referralsMembersHoldersCreateInBulkRequestBody)
+
+Add Referral Code Holders
+
+Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.  📘 Alternative endpoint This endpoint is an alternative to the [Add Referral Code Holders endpoint](/api-reference/referrals/add-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+
+### 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.ReferralsApi();
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+let referralsMembersHoldersCreateInBulkRequestBody = {"holders":[{"source_id":"cst-prsn01","name":"Alex Doe","email":"alex-doe@your.domain.com","country":"England"},{"source_id":"cst-prsn02","name":"Alex Joe","email":"alex-joe@your.domain.com","country":"Wales"}],"metadata":{"influencer_code":true}}; // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders.
+apiInstance.referralsAddHolders(memberId, referralsMembersHoldersCreateInBulkRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md)| Specify the customer data to be upserted as redeemable holders. | 
+
+### Return type
+
+[**ReferralsMembersHoldersCreateInBulkResponseBody**](ReferralsMembersHoldersCreateInBulkResponseBody.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
+
+
+## referralsAddHolders1
+
+> ReferralsMembersHoldersCreateInBulkResponseBody referralsAddHolders1(campaignId, memberId, referralsMembersHoldersCreateInBulkRequestBody)
+
+Add Referral Code Holders with Campaign ID
+
+Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data. If the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  👍 To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.
+
+### 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.ReferralsApi();
+let campaignId = "campaignId_example"; // String | Unique identifier of a referral program campaign.
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+let referralsMembersHoldersCreateInBulkRequestBody = {"holders":[{"source_id":"cst-prsn01","name":"Alex Doe","email":"alex-doe@your.domain.com","country":"England"},{"source_id":"cst-prsn02","name":"Alex Joe","email":"alex-joe@your.domain.com","country":"Wales"}],"metadata":{"influencer_code":true}}; // ReferralsMembersHoldersCreateInBulkRequestBody | Specify the customer data to be upserted as redeemable holders.
+apiInstance.referralsAddHolders1(campaignId, memberId, referralsMembersHoldersCreateInBulkRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignId** | **String**| Unique identifier of a referral program campaign. | 
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **referralsMembersHoldersCreateInBulkRequestBody** | [**ReferralsMembersHoldersCreateInBulkRequestBody**](ReferralsMembersHoldersCreateInBulkRequestBody.md)| Specify the customer data to be upserted as redeemable holders. | 
+
+### Return type
+
+[**ReferralsMembersHoldersCreateInBulkResponseBody**](ReferralsMembersHoldersCreateInBulkResponseBody.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
+
+
+## referralsCodeHolders
+
+> ReferralsMembersHoldersListResponseBody referralsCodeHolders(campaignId, memberId, opts)
+
+List Referral Code Holders with campaign ID
+
+Retrieves all the redeemables that have been assigned to the customer. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)
+
+### 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.ReferralsApi();
+let campaignId = "campaignId_example"; // String | Unique identifier of a referral program campaign.
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+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.
+  'order': new Voucherify.ParameterOrderListRedeemables(), // ParameterOrderListRedeemables | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
+  'filters': new Voucherify.ParameterFiltersListReferralsRedeemableHolders() // ParameterFiltersListReferralsRedeemableHolders | Filters for listing customer redeemables.
+};
+apiInstance.referralsCodeHolders(campaignId, memberId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignId** | **String**| Unique identifier of a referral program campaign. | 
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **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] 
+ **order** | [**ParameterOrderListRedeemables**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] 
+ **filters** | [**ParameterFiltersListReferralsRedeemableHolders**](.md)| Filters for listing customer redeemables. | [optional] 
+
+### Return type
+
+[**ReferralsMembersHoldersListResponseBody**](ReferralsMembersHoldersListResponseBody.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
+
+
+## referralsCodeHolders1
+
+> ReferralsMembersHoldersListResponseBody referralsCodeHolders1(memberId, opts)
+
+List Referral Code Holders
+
+Retrieves the holders of the referral code from a referral campaign. To use this endpoint, you must have the following permissions: - Read Customers (customers.details.read)  📘 Alternative endpoint This endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+
+### 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.ReferralsApi();
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+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.
+  'order': new Voucherify.ParameterOrderListRedeemables(), // ParameterOrderListRedeemables | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the events starting after an event with the given ID.
+  'filters': new Voucherify.ParameterFiltersListReferralsRedeemableHolders() // ParameterFiltersListReferralsRedeemableHolders | Filters for listing customer redeemables.
+};
+apiInstance.referralsCodeHolders1(memberId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **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] 
+ **order** | [**ParameterOrderListRedeemables**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **startingAfterId** | **String**| A cursor for pagination. It retrieves the events starting after an event with the given ID. | [optional] 
+ **filters** | [**ParameterFiltersListReferralsRedeemableHolders**](.md)| Filters for listing customer redeemables. | [optional] 
+
+### Return type
+
+[**ReferralsMembersHoldersListResponseBody**](ReferralsMembersHoldersListResponseBody.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
+
+
+## referralsRemoveHolder
+
+> referralsRemoveHolder(memberId, holderId)
+
+Remove Referral Card Holder
+
+Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)  📘 Alternative endpoint This endpoint is an alternative to the [Remove Referral Card Holder endpoint](/api-reference/referrals/remove-referral-card-holder-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the campaignId as a path paremeter.
+
+### 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.ReferralsApi();
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+let holderId = "holderId_example"; // String | Unique identifier of a redeemable holder.
+apiInstance.referralsRemoveHolder(memberId, holderId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **holderId** | **String**| Unique identifier of a redeemable holder. | 
+
+### 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
+
+
+## referralsRemoveHolder1
+
+> referralsRemoveHolder1(campaignId, memberId, holderId)
+
+Remove Referral Card Holder with campaign ID
+
+Removes the holder from a referral card. You can remove a referee only. To use this endpoint, you must have the following permissions: - Create and modify Customers and Segments (customers.modify) - Publish Voucher (vouchers.publish)
+
+### 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.ReferralsApi();
+let campaignId = "campaignId_example"; // String | Unique identifier of a referral program campaign.
+let memberId = "memberId_example"; // String | Unique referral code or its identifier.
+let holderId = "holderId_example"; // String | Unique identifier of a redeemable holder.
+apiInstance.referralsRemoveHolder1(campaignId, memberId, holderId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaignId** | **String**| Unique identifier of a referral program campaign. | 
+ **memberId** | **String**| Unique referral code or its identifier. | 
+ **holderId** | **String**| Unique identifier of a redeemable holder. | 
+
+### 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
+

package/docs/ReferralsMembersHoldersCreateInBulkRequestBody.md

@@ -0,0 +1,10 @@
+# Voucherify.ReferralsMembersHoldersCreateInBulkRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**holders** | [**[Customer]**](Customer.md) | Array of holders to be added to a referral card as referees. You have to send at least one object in the array up to a maximum of 100 objects. You can send either a `source_id` or `id`, or both; however, at least one of them is required. If both are sent, Voucherify checks `id` to upsert that customer's data. | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to the redeemable holders sent in the array. The value can be a string, number, boolean, date, datetime, image URL, or object. The metadata must meet the metadata schema for publications. The metadata object stores all custom attributes assigned to the redeemable holder. | [optional] 
+
+

package/docs/ReferralsMembersHoldersCreateInBulkResponseBody.md

@@ -0,0 +1,9 @@
+# Voucherify.ReferralsMembersHoldersCreateInBulkResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**holders** | [**[RedeemableHolder]**](RedeemableHolder.md) | Contains an array of referral card holders who are the customers sent in the request. | [optional] 
+
+

package/docs/ReferralsMembersHoldersListResponseBody.md

@@ -0,0 +1,14 @@
+# Voucherify.ReferralsMembersHoldersListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about redeemables holders | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the JSON property that contains the array of holders. | [optional] [default to 'data']
+**data** | [**[RedeemableHolder]**](RedeemableHolder.md) | A dictionary that contains an array of holders. | [optional] 
+**total** | **Number** | Total number of holders assigned to the redeemable. | [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 with a `starting_after_id` query or a different limit to get more records returned in the results. | [optional] 
+**moreStartingAfter** | **String** | Returns an ID that can be used to return another page of results. Use the ID in the `starting_after_id` query parameter to display another page of the results occuring after the field with that ID. | [optional] 
+
+

package/docs/Referrer.md

@@ -0,0 +1,18 @@
+# Voucherify.Referrer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of an existing customer. | [optional] 
+**sourceId** | **String** | A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored. | [optional] 
+**name** | **String** | Customer's first and last name. | [optional] 
+**description** | **String** | An arbitrary string that you can attach to a customer object. | [optional] 
+**email** | **String** | Customer's email address. | [optional] 
+**phone** | **String** | Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel. | [optional] 
+**birthday** | **Date** | `Deprecated`. ~~Customer's birthdate; format YYYY-MM-DD~~. | [optional] 
+**birthdate** | **Date** | Customer's birthdate; format YYYY-MM-DD. | [optional] 
+**address** | [**ReferrerAddress**](ReferrerAddress.md) |  | [optional] 
+**metadata** | **Object** | A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments. | [optional] 
+
+

package/docs/ReferrerAddress.md

@@ -0,0 +1,14 @@
+# Voucherify.ReferrerAddress
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **String** | City | [optional] 
+**state** | **String** | State | [optional] 
+**line1** | **String** | First line of address. | [optional] 
+**line2** | **String** | Second line of address. | [optional] 
+**country** | **String** | Country. | [optional] 
+**postalCode** | **String** | Postal code. | [optional] 
+
+

package/docs/ReferrerId.md

@@ -0,0 +1,19 @@
+# Voucherify.ReferrerId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | A unique identifier of an existing customer. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'customer']
+
+
+
+## Enum: ObjectEnum
+
+
+* `customer` (value: `"customer"`)
+
+
+
+

package/docs/ResourceTypes.md

@@ -0,0 +1,12 @@
+# Voucherify.ResourceTypes
+
+## Enum
+
+
+* `campaign` (value: `"campaign"`)
+
+* `voucher` (value: `"voucher"`)
+
+* `promotion_tier` (value: `"promotion_tier"`)
+
+

package/docs/Reward.md

@@ -0,0 +1,41 @@
+# Voucherify.Reward
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique reward ID, assigned by Voucherify. | [optional] 
+**name** | **String** | Reward name. | [optional] 
+**stock** | **Number** | Configurable for **material rewards**. The number of units of the product that you want to share as a reward. Use this parameter to code a stock-taking logic. | [optional] 
+**redeemed** | **Number** | Defines the number of already invoked (successful) reward redemptions.  | [optional] 
+**attributes** | [**RewardAttributes**](RewardAttributes.md) |  | [optional] 
+**metadata** | **Object** | The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format. | [optional] 
+**type** | **String** | Reward type. | [optional] 
+**parameters** | [**RewardType**](RewardType.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the reward. | [default to 'reward']
+
+
+
+## Enum: TypeEnum
+
+
+* `CAMPAIGN` (value: `"CAMPAIGN"`)
+
+* `COIN` (value: `"COIN"`)
+
+* `MATERIAL` (value: `"MATERIAL"`)
+
+
+
+
+
+## Enum: ObjectEnum
+
+
+* `reward` (value: `"reward"`)
+
+
+
+

package/docs/RewardAssignment.md

@@ -0,0 +1,34 @@
+# Voucherify.RewardAssignment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique reward assignment ID, assigned by Voucherify. | [optional] 
+**rewardId** | **String** | Associated reward ID. | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the reward assignment. | [optional] [default to 'reward_assignment']
+**relatedObjectId** | **String** | Related object ID to which the reward was assigned. | [optional] 
+**relatedObjectType** | **String** | Related object type to which the reward was assigned. | [optional] [default to 'campaign']
+**parameters** | [**RewardAssignmentParameters**](RewardAssignmentParameters.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `reward_assignment` (value: `"reward_assignment"`)
+
+
+
+
+
+## Enum: RelatedObjectTypeEnum
+
+
+* `campaign` (value: `"campaign"`)
+
+
+
+

package/docs/RewardAssignmentParameters.md

@@ -0,0 +1,9 @@
+# Voucherify.RewardAssignmentParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**loyalty** | [**RewardAssignmentParametersLoyalty**](RewardAssignmentParametersLoyalty.md) |  | [optional] 
+
+

package/docs/RewardAssignmentParametersLoyalty.md

@@ -0,0 +1,10 @@
+# Voucherify.RewardAssignmentParametersLoyalty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**points** | **Number** | The number of points required to redeem the reward. | [optional] 
+**autoRedeem** | **Boolean** | Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value `true` means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value `true`. | [optional] 
+
+

package/docs/RewardAttributes.md

@@ -0,0 +1,10 @@
+# Voucherify.RewardAttributes
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageUrl** | **String** | The HTTPS URL pointing to the .png or .jpg file. | [optional] 
+**description** | **String** | An arbitrary string that you can attach to a material reward. | [optional] 
+
+

package/docs/RewardType.md

@@ -0,0 +1,11 @@
+# Voucherify.RewardType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign** | [**RewardTypeCampaign**](RewardTypeCampaign.md) |  | [optional] 
+**coin** | [**RewardTypeCoin**](RewardTypeCoin.md) |  | [optional] 
+**product** | [**RewardTypeProduct**](RewardTypeProduct.md) |  | [optional] 
+
+

package/docs/RewardTypeCampaign.md

@@ -0,0 +1,24 @@
+# Voucherify.RewardTypeCampaign
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique campaign ID, assigned by Voucherify. | [optional] 
+**balance** | **Number** | The number of points to be added to a loyalty card or the amount to be added to the current balance on the gift card.  For gift cards, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] 
+**type** | **String** | Campaign type. | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `DISCOUNT_COUPONS` (value: `"DISCOUNT_COUPONS"`)
+
+* `GIFT_VOUCHERS` (value: `"GIFT_VOUCHERS"`)
+
+* `LOYALTY_PROGRAM` (value: `"LOYALTY_PROGRAM"`)
+
+
+
+