@voucherify/sdk 2.9.4 → 3.0.0

package/docs/Gift.md

@@ -0,0 +1,23 @@
+# Voucherify.Gift
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Number** | Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] 
+**subtractedAmount** | **Number** | Total amount of subtracted credits over the gift card lifetime. | [optional] 
+**balance** | **Number** | Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`. `balance` = `amount` - `subtracted_amount` - `redemption.redeemed_amount`. | [optional] 
+**effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] 
+
+
+
+## Enum: EffectEnum
+
+
+* `APPLY_TO_ORDER` (value: `"APPLY_TO_ORDER"`)
+
+* `APPLY_TO_ITEMS` (value: `"APPLY_TO_ITEMS"`)
+
+
+
+

package/docs/InapplicableTo.md

@@ -0,0 +1,49 @@
+# Voucherify.InapplicableTo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | This object stores information about the resource to which the discount is applicable. | [optional] 
+**id** | **String** | Unique product collection, product, or SKU identifier assigned by Voucherify. | [optional] 
+**sourceId** | **String** | The source identifier from your inventory system. | [optional] 
+**productId** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] 
+**productSourceId** | **String** | Parent product's source ID from your inventory system. | [optional] 
+**price** | **Number** | New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price. | [optional] 
+**priceFormula** | **Number** | Formula used to dynamically calculate the discounted price of an item. | [optional] 
+**effect** | [**ApplicableToEffect**](ApplicableToEffect.md) |  | 
+**quantityLimit** | **Number** | The maximum number of units allowed to be discounted per order line item. | [optional] 
+**aggregatedQuantityLimit** | **Number** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] 
+**amountLimit** | **Number** | Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] 
+**aggregatedAmountLimit** | **Number** | Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value) | [optional] 
+**orderItemIndices** | **[Number]** | Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on. | [optional] 
+**orderItemUnits** | [**[InapplicableToOrderItemUnitsItem]**](InapplicableToOrderItemUnitsItem.md) | Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request. | [optional] 
+**repeat** | **Number** | Determines the recurrence of the discount, e.g. `\"repeat\": 3` means that the discount is applied to every third item. | [optional] 
+**skipInitially** | **Number** | Determines how many items are skipped before the discount is applied. | [optional] 
+**target** | **String** | Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `product` (value: `"product"`)
+
+* `sku` (value: `"sku"`)
+
+* `products_collection` (value: `"products_collection"`)
+
+
+
+
+
+## Enum: TargetEnum
+
+
+* `ITEM` (value: `"ITEM"`)
+
+* `UNIT` (value: `"UNIT"`)
+
+
+
+

package/docs/InapplicableToOrderItemUnitsItem.md

@@ -0,0 +1,11 @@
+# Voucherify.InapplicableToOrderItemUnitsItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Number** | Number assigned to the order line item in accordance with the order sent in the request. | [optional] 
+**units** | **[Number]** | Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `\"skip_initially\": 1`, `\"repeat\": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units. | [optional] 
+**unitsLimitExceeded** | **Boolean** | Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000. | [optional] 
+
+

package/docs/InapplicableToResultList.md

@@ -0,0 +1,30 @@
+# Voucherify.InapplicableToResultList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**[InapplicableTo]**](InapplicableTo.md) | Contains array of items to which the discount cannot apply. | [optional] 
+**total** | **Number** | Total number of objects defining included products, SKUs, or product collections. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'list']
+**dataRef** | **String** | The type of the object represented by JSON. | [optional] [default to 'data']
+
+
+
+## Enum: ObjectEnum
+
+
+* `list` (value: `"list"`)
+
+
+
+
+
+## Enum: DataRefEnum
+
+
+* `data` (value: `"data"`)
+
+
+
+

package/docs/Junction.md

@@ -0,0 +1,10 @@
+# Voucherify.Junction
+
+## Enum
+
+
+* `and` (value: `"and"`)
+
+* `or` (value: `"or"`)
+
+

package/docs/ListPublicationsItemValidSingleVoucher.md

@@ -0,0 +1,39 @@
+# Voucherify.ListPublicationsItemValidSingleVoucher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique publication ID, assigned by Voucherify. | [optional] 
+**object** | **String** | The type of the object represented by the JSON. This object stores information about the `publication`. | [optional] [default to 'publication']
+**createdAt** | **Date** | Timestamp representing the date and time when the publication was created. The value is shown in the ISO 8601 format. | [optional] 
+**customerId** | **String** | Unique customer ID of the customer receiving the publication. | [optional] 
+**trackingId** | **String** | Customer's `source_id`. | [optional] 
+**metadata** | [**ListPublicationsItemValidSingleVoucherMetadata**](ListPublicationsItemValidSingleVoucherMetadata.md) |  | [optional] 
+**channel** | **String** | How the publication was originated. It can be your own custom channel or an example value provided here. | [optional] 
+**sourceId** | **String** | The merchant's publication ID if it is different from the Voucherify publication ID. It's 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.  | [optional] 
+**customer** | [**CustomerWithSummaryLoyaltyReferrals**](CustomerWithSummaryLoyaltyReferrals.md) |  | [optional] 
+**vouchers** | **[String]** | Contains the voucher IDs that was assigned by Voucherify. | [optional] 
+**vouchersId** | **[String]** | Contains the unique internal voucher IDs that was assigned by Voucherify. | [optional] 
+**result** | **String** | Status of the publication attempt. | [optional] [default to 'SUCCESS']
+**voucher** | [**ListPublicationsItemVoucher**](ListPublicationsItemVoucher.md) |  | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `publication` (value: `"publication"`)
+
+
+
+
+
+## Enum: ResultEnum
+
+
+* `SUCCESS` (value: `"SUCCESS"`)
+
+
+
+

package/docs/ListPublicationsItemValidSingleVoucherMetadata.md

@@ -0,0 +1,11 @@
+# Voucherify.ListPublicationsItemValidSingleVoucherMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sourceType** | **String** | Defines the type of the distribution source. | [optional] 
+**sourceId** | **String** | Unique identifier of the distribution source. | [optional] 
+**distributionId** | **String** | Unique identifier of the distribution. | [optional] 
+
+

package/docs/ListPublicationsItemVoucher.md

@@ -0,0 +1,24 @@
+# Voucherify.ListPublicationsItemVoucher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Voucher code. | [optional] 
+**object** | **String** | The type of the object represented by JSON. | [optional] [default to 'voucher']
+**campaign** | **String** | Campaign name | [optional] 
+**gift** | [**Gift**](Gift.md) |  | [optional] 
+**loyaltyCard** | **Object** | Defines the loyalty card details. | [optional] 
+**discount** | [**Discount**](Discount.md) |  | [optional] 
+**isReferralCode** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `voucher` (value: `"voucher"`)
+
+
+
+

package/docs/Location.md

@@ -0,0 +1,23 @@
+# Voucherify.Location
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique location ID, assigned by the Voucherify API. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about a `location`. | [optional] [default to 'location']
+**name** | **String** | Location name. | [optional] 
+**shape** | [**LocationShape**](LocationShape.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `location` (value: `"location"`)
+
+
+
+

package/docs/LocationShape.md

@@ -0,0 +1,34 @@
+# Voucherify.LocationShape
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**format** | **String** |  | [optional] 
+**distance** | [**LocationShapeDistance**](LocationShapeDistance.md) |  | [optional] 
+**geojson** | [**LocationShapeGeojson**](LocationShapeGeojson.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `circle` (value: `"circle"`)
+
+* `polygon` (value: `"polygon"`)
+
+
+
+
+
+## Enum: FormatEnum
+
+
+* `distance` (value: `"distance"`)
+
+* `geojson` (value: `"geojson"`)
+
+
+
+

package/docs/LocationShapeDistance.md

@@ -0,0 +1,10 @@
+# Voucherify.LocationShapeDistance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**center** | **String** | Center of the circle identified by GPS coordinates in decimal degrees. | [optional] 
+**radius** | **String** | Defines the radius of the circle. | [optional] 
+
+

package/docs/LocationShapeGeojson.md

@@ -0,0 +1,21 @@
+# Voucherify.LocationShapeGeojson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**coordinates** | **[[Number]]** |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `Polygon` (value: `"Polygon"`)
+
+* `MultiPolygon` (value: `"MultiPolygon"`)
+
+
+
+

package/docs/LocationsApi.md

@@ -0,0 +1,136 @@
+# Voucherify.LocationsApi
+
+All URIs are relative to *https://api.voucherify.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**getLocation**](LocationsApi.md#getLocation) | **GET** /v1/locations/{locationId} | Get Location
+[**listLocations**](LocationsApi.md#listLocations) | **GET** /v1/locations | List Locations
+
+
+
+## getLocation
+
+> LocationsGetResponseBody getLocation(locationId)
+
+Get Location
+
+Returns a location 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.LocationsApi();
+let locationId = "locationId_example"; // String | The unique location ID.
+apiInstance.getLocation(locationId, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+});
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **locationId** | **String**| The unique location ID. | 
+
+### Return type
+
+[**LocationsGetResponseBody**](LocationsGetResponseBody.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
+
+
+## listLocations
+
+> LocationsListResponseBody listLocations(opts)
+
+List Locations
+
+Returns a list of your locations.
+
+### 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.LocationsApi();
+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.ParameterOrderListLocations(), // ParameterOrderListLocations | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
+  'filters': new Voucherify.ParameterFiltersListLocations(), // ParameterFiltersListLocations | Filter the locations using one of the available filters.
+  'endDate': new Date("2013-10-20T19:20:30+01:00") // Date | A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).
+};
+apiInstance.listLocations(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] 
+ **order** | [**ParameterOrderListLocations**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] 
+ **filters** | [**ParameterFiltersListLocations**](.md)| Filter the locations using one of the available filters. | [optional] 
+ **endDate** | **Date**| A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). | [optional] 
+
+### Return type
+
+[**LocationsListResponseBody**](LocationsListResponseBody.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/LocationsGetResponseBody.md

@@ -0,0 +1,23 @@
+# Voucherify.LocationsGetResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique location ID, assigned by the Voucherify API. | [optional] 
+**object** | **String** | The type of the object represented by JSON. This object stores information about a `location`. | [optional] [default to 'location']
+**name** | **String** | Location name. | [optional] 
+**shape** | [**LocationsGetResponseBodyShape**](LocationsGetResponseBodyShape.md) |  | [optional] 
+**createdAt** | **Date** | Timestamp representing the date and time when the location was created. The value is shown in the ISO 8601 format. | [optional] 
+**updatedAt** | **Date** | Timestamp representing the date and time when the location was updated. The value is shown in the ISO 8601 format. | [optional] 
+
+
+
+## Enum: ObjectEnum
+
+
+* `location` (value: `"location"`)
+
+
+
+

package/docs/LocationsGetResponseBodyShape.md

@@ -0,0 +1,34 @@
+# Voucherify.LocationsGetResponseBodyShape
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**format** | **String** |  | [optional] 
+**distance** | [**LocationsGetResponseBodyShapeDistance**](LocationsGetResponseBodyShapeDistance.md) |  | [optional] 
+**geojson** | [**LocationsGetResponseBodyShapeGeojson**](LocationsGetResponseBodyShapeGeojson.md) |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `circle` (value: `"circle"`)
+
+* `polygon` (value: `"polygon"`)
+
+
+
+
+
+## Enum: FormatEnum
+
+
+* `distance` (value: `"distance"`)
+
+* `geojson` (value: `"geojson"`)
+
+
+
+

package/docs/LocationsGetResponseBodyShapeDistance.md

@@ -0,0 +1,10 @@
+# Voucherify.LocationsGetResponseBodyShapeDistance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**center** | **String** | Center of the circle identified by GPS coordinates in decimal degrees. | [optional] 
+**radius** | **String** | Defines the radius of the circle. | [optional] 
+
+

package/docs/LocationsGetResponseBodyShapeGeojson.md

@@ -0,0 +1,21 @@
+# Voucherify.LocationsGetResponseBodyShapeGeojson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**coordinates** | **[[Number]]** |  | [optional] 
+
+
+
+## Enum: TypeEnum
+
+
+* `Polygon` (value: `"Polygon"`)
+
+* `MultiPolygon` (value: `"MultiPolygon"`)
+
+
+
+

package/docs/LocationsListResponseBody.md

@@ -0,0 +1,13 @@
+# Voucherify.LocationsListResponseBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **String** | The type of the object represented by JSON. This object stores information about locations in a dictionary. | [optional] [default to 'list']
+**dataRef** | **String** | Identifies the name of the attribute that contains the array of metadata schema objects. | [optional] [default to 'data']
+**data** | [**[Location]**](Location.md) | Array of location objects. | [optional] 
+**total** | **Number** | Total number of locations. | [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 different end date filter) to get more records returned in the results. | [optional] 
+
+