@voucherify/sdk 2.9.4 → 3.0.0

package/docs/ExportsApi.md

@@ -0,0 +1,318 @@
+# Voucherify.ExportsApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createExport**](ExportsApi.md#createExport) | **POST** /v1/exports | Create Export
+[**deleteExport**](ExportsApi.md#deleteExport) | **DELETE** /v1/exports/{exportId} | Delete Export
+[**downloadExport**](ExportsApi.md#downloadExport) | **GET** /v1/exports/{export_Id} | Download Export
+[**getExport**](ExportsApi.md#getExport) | **GET** /v1/exports/{exportId} | Get Export
+[**listExports**](ExportsApi.md#listExports) | **GET** /v1/exports | List Exports
+
+
+
+## createExport
+
+> ExportsCreateResponseBody createExport(exportsCreateRequestBody)
+
+Create Export
+
+Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.   # Defaults If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:    📘 Date and time in the export API  The exported date and times are always provided in the UTC time zone. # Fetching particular data sets Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields: # Orders     # Vouchers        # Publications   # Redemptions    # Customers       # Points Expirations    # Gift Card Transactions    # Loyalty Card Transactions   
+
+### 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.ExportsApi();
+let exportsCreateRequestBody = new Voucherify.ExportsCreateRequestBody(); // ExportsCreateRequestBody | Specify the details of the export that you would like to create.
+apiInstance.createExport(exportsCreateRequestBody, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exportsCreateRequestBody** | [**ExportsCreateRequestBody**](ExportsCreateRequestBody.md)| Specify the details of the export that you would like to create. | 
+
+### Return type
+
+[**ExportsCreateResponseBody**](ExportsCreateResponseBody.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
+
+
+## deleteExport
+
+> deleteExport(exportId)
+
+Delete Export
+
+This method deletes a previously created export object.
+
+### 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.ExportsApi();
+let exportId = "exportId_example"; // String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.
+apiInstance.deleteExport(exportId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exportId** | **String**| Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. | 
+
+### 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
+
+
+## downloadExport
+
+> String downloadExport(exportId, opts)
+
+Download Export
+
+Download the contents of the exported CSV file.   📘 Important notes  **Base URL:**   - https://download.voucherify.io (Europe)   - https://us1.download.voucherify.io (US)   - https://as1.download.voucherify.io (Asia)   **Token:** Can be found within the result parameter of the [Get Export](/api-reference/exports/get-export) method response.
+
+### 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.ExportsApi();
+let exportId = "exp_ex6zq0x0EEa9S0N68QcqhxcQ"; // String | Unique export object ID.
+let opts = {
+  'token': "token_example" // String | Token that was issued to the export, to get this token, get the export first
+};
+apiInstance.downloadExport(exportId, opts, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exportId** | **String**| Unique export object ID. | 
+ **token** | **String**| Token that was issued to the export, to get this token, get the export first | [optional] 
+
+### Return type
+
+**String**
+
+### 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**: text/plain
+
+
+## getExport
+
+> ExportsGetResponseBody getExport(exportId)
+
+Get Export
+
+Retrieves the URL of the downloadable file, which was generated via the [Create Export](/api-reference/exports/create-export) method.
+
+### 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.ExportsApi();
+let exportId = "exportId_example"; // String | Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.
+apiInstance.getExport(exportId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **exportId** | **String**| Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions. | 
+
+### Return type
+
+[**ExportsGetResponseBody**](ExportsGetResponseBody.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
+
+
+## listExports
+
+> ExportsListResponseBody listExports(opts)
+
+List Exports
+
+List all exports. 
+
+### 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.ExportsApi();
+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.ParameterOrderListExports() // ParameterOrderListExports | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+};
+apiInstance.listExports(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** | [**ParameterOrderListExports**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+
+### Return type
+
+[**ExportsListResponseBody**](ExportsListResponseBody.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
+

package/docs/ExportsCreateRequestBody.md

@@ -0,0 +1,31 @@
+# Voucherify.ExportsCreateRequestBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exportedObject** | **String** |  | [optional] 
+**parameters** | [**ExportsCreateRequestBodyParameters**](ExportsCreateRequestBodyParameters.md) |  | [optional] 
+
+
+
+## Enum: ExportedObjectEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `redemption` (value: `"redemption"`)
+
+* `customer` (value: `"customer"`)
+
+* `publication` (value: `"publication"`)
+
+* `order` (value: `"order"`)
+
+* `points_expiration` (value: `"points_expiration"`)
+
+* `voucher_transactions` (value: `"voucher_transactions"`)
+
+
+
+

package/docs/ExportsCreateRequestBodyParameters.md

@@ -0,0 +1,256 @@
+# Voucherify.ExportsCreateRequestBodyParameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order** | **String** |  | [optional] 
+**fields** | **[String]** | Array of strings containing the data in the export. These fields define the headers in the CSV file. | [optional] 
+**filters** | **Object** | Allowed additional properties must start with \"metadata.\" or \"redemption.\" and Allowed additional properties must start with \"metadata.\" and Allowed additional properties must start with \"metadata.\" or \"address.\" or \"summary.\" or \"loyalty.\" or \"loyalty_tier.\" or \"loyalty_points.\" or \"system_metadata.\" | [optional] 
+**campaignId** | **String** | Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. | [optional] 
+
+
+
+## Enum: OrderEnum
+
+
+* `-created_at` (value: `"-created_at"`)
+
+* `created_at` (value: `"created_at"`)
+
+* `-updated_at` (value: `"-updated_at"`)
+
+* `updated_at` (value: `"updated_at"`)
+
+* `-code` (value: `"-code"`)
+
+* `code` (value: `"code"`)
+
+* `-id` (value: `"-id"`)
+
+* `id` (value: `"id"`)
+
+* `-voucher_code` (value: `"-voucher_code"`)
+
+* `voucher_code` (value: `"voucher_code"`)
+
+* `-tracking_id` (value: `"-tracking_id"`)
+
+* `tracking_id` (value: `"tracking_id"`)
+
+* `-customer_id` (value: `"-customer_id"`)
+
+* `customer_id` (value: `"customer_id"`)
+
+* `-name` (value: `"-name"`)
+
+* `name` (value: `"name"`)
+
+* `-email` (value: `"-email"`)
+
+* `email` (value: `"email"`)
+
+* `-source_id` (value: `"-source_id"`)
+
+* `source_id` (value: `"source_id"`)
+
+* `-channel` (value: `"-channel"`)
+
+* `channel` (value: `"channel"`)
+
+* `-status` (value: `"-status"`)
+
+* `status` (value: `"status"`)
+
+* `-expires_at` (value: `"-expires_at"`)
+
+* `expires_at` (value: `"expires_at"`)
+
+
+
+
+
+## Enum: [FieldsEnum]
+
+
+* `code` (value: `"code"`)
+
+* `voucher_type` (value: `"voucher_type"`)
+
+* `value` (value: `"value"`)
+
+* `formula` (value: `"formula"`)
+
+* `discount_type` (value: `"discount_type"`)
+
+* `campaign` (value: `"campaign"`)
+
+* `category` (value: `"category"`)
+
+* `start_date` (value: `"start_date"`)
+
+* `expiration_date` (value: `"expiration_date"`)
+
+* `gift_balance` (value: `"gift_balance"`)
+
+* `loyalty_balance` (value: `"loyalty_balance"`)
+
+* `redemption_quantity` (value: `"redemption_quantity"`)
+
+* `redemption_count` (value: `"redemption_count"`)
+
+* `active` (value: `"active"`)
+
+* `qr_code` (value: `"qr_code"`)
+
+* `bar_code` (value: `"bar_code"`)
+
+* `metadata` (value: `"metadata"`)
+
+* `id` (value: `"id"`)
+
+* `is_referral_code` (value: `"is_referral_code"`)
+
+* `created_at` (value: `"created_at"`)
+
+* `updated_at` (value: `"updated_at"`)
+
+* `validity_timeframe_interval` (value: `"validity_timeframe_interval"`)
+
+* `validity_timeframe_duration` (value: `"validity_timeframe_duration"`)
+
+* `validity_day_of_week` (value: `"validity_day_of_week"`)
+
+* `discount_amount_limit` (value: `"discount_amount_limit"`)
+
+* `campaign_id` (value: `"campaign_id"`)
+
+* `additional_info` (value: `"additional_info"`)
+
+* `customer_id` (value: `"customer_id"`)
+
+* `discount_effect` (value: `"discount_effect"`)
+
+* `discount_unit_type` (value: `"discount_unit_type"`)
+
+* `discount_unit_effect` (value: `"discount_unit_effect"`)
+
+* `validation_rules_id` (value: `"validation_rules_id"`)
+
+* `customer_source_id` (value: `"customer_source_id"`)
+
+* `object` (value: `"object"`)
+
+* `date` (value: `"date"`)
+
+* `voucher_code` (value: `"voucher_code"`)
+
+* `promotion_tier_id` (value: `"promotion_tier_id"`)
+
+* `customer_name` (value: `"customer_name"`)
+
+* `tracking_id` (value: `"tracking_id"`)
+
+* `order_id` (value: `"order_id"`)
+
+* `order_amount` (value: `"order_amount"`)
+
+* `gift_amount` (value: `"gift_amount"`)
+
+* `loyalty_points` (value: `"loyalty_points"`)
+
+* `result` (value: `"result"`)
+
+* `failure_code` (value: `"failure_code"`)
+
+* `failure_message` (value: `"failure_message"`)
+
+* `name` (value: `"name"`)
+
+* `description` (value: `"description"`)
+
+* `email` (value: `"email"`)
+
+* `source_id` (value: `"source_id"`)
+
+* `address_city` (value: `"address_city"`)
+
+* `address_state` (value: `"address_state"`)
+
+* `address_line_1` (value: `"address_line_1"`)
+
+* `address_line_2` (value: `"address_line_2"`)
+
+* `address_country` (value: `"address_country"`)
+
+* `address_postal_code` (value: `"address_postal_code"`)
+
+* `redemptions_total_redeemed` (value: `"redemptions_total_redeemed"`)
+
+* `redemptions_total_failed` (value: `"redemptions_total_failed"`)
+
+* `redemptions_total_succeeded` (value: `"redemptions_total_succeeded"`)
+
+* `redemptions_total_rolled_back` (value: `"redemptions_total_rolled_back"`)
+
+* `redemptions_total_rollback_failed` (value: `"redemptions_total_rollback_failed"`)
+
+* `redemptions_total_rollback_succeeded` (value: `"redemptions_total_rollback_succeeded"`)
+
+* `orders_total_amount` (value: `"orders_total_amount"`)
+
+* `orders_total_count` (value: `"orders_total_count"`)
+
+* `orders_average_amount` (value: `"orders_average_amount"`)
+
+* `orders_last_order_amount` (value: `"orders_last_order_amount"`)
+
+* `orders_last_order_date` (value: `"orders_last_order_date"`)
+
+* `loyalty_referred_customers` (value: `"loyalty_referred_customers"`)
+
+* `phone` (value: `"phone"`)
+
+* `birthday` (value: `"birthday"`)
+
+* `birthdate` (value: `"birthdate"`)
+
+* `channel` (value: `"channel"`)
+
+* `is_winner` (value: `"is_winner"`)
+
+* `status` (value: `"status"`)
+
+* `amount` (value: `"amount"`)
+
+* `discount_amount` (value: `"discount_amount"`)
+
+* `items_discount_amount` (value: `"items_discount_amount"`)
+
+* `total_discount_amount` (value: `"total_discount_amount"`)
+
+* `total_amount` (value: `"total_amount"`)
+
+* `referrer_id` (value: `"referrer_id"`)
+
+* `voucher_id` (value: `"voucher_id"`)
+
+* `points` (value: `"points"`)
+
+* `expires_at` (value: `"expires_at"`)
+
+* `type` (value: `"type"`)
+
+* `reason` (value: `"reason"`)
+
+* `source` (value: `"source"`)
+
+* `balance` (value: `"balance"`)
+
+* `related_transaction_id` (value: `"related_transaction_id"`)
+
+* `details` (value: `"details"`)
+
+
+
+

package/docs/ExportsCreateResponseBody.md

@@ -0,0 +1,56 @@
+# Voucherify.ExportsCreateResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique export ID. | [optional] 
+**object** | **String** | The type of object being represented. This object stores information about the export. | [optional] [default to 'export']
+**createdAt** | **Date** | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. | [optional] 
+**status** | **String** | Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated. | [optional] [default to 'SCHEDULED']
+**channel** | **String** | The channel through which the export was triggered. | [optional] 
+**result** | **Object** | Contains the URL of the CSV file. | [optional] 
+**userId** | **String** | Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. | [optional] 
+**exportedObject** | **String** |  | [optional] 
+**parameters** | [**ExportsCreateResponseBodyParameters**](ExportsCreateResponseBodyParameters.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `export` (value: `"export"`)
+
+
+
+
+
+## Enum: StatusEnum
+
+
+* `SCHEDULED` (value: `"SCHEDULED"`)
+
+
+
+
+
+## Enum: ExportedObjectEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+* `redemption` (value: `"redemption"`)
+
+* `customer` (value: `"customer"`)
+
+* `publication` (value: `"publication"`)
+
+* `order` (value: `"order"`)
+
+* `points_expiration` (value: `"points_expiration"`)
+
+* `voucher_transactions` (value: `"voucher_transactions"`)
+
+
+
+