voucherify 5.0.1 → 6.0.0

data/docs/PublicationsListResponseBody.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. This object stores information about publications in a dictionary. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the attribute that contains the array of publications. | [default to 'publications'] |
-| **publications** | [**Array<PublicationsListResponseBodyPublicationsItem>**](PublicationsListResponseBodyPublicationsItem.md) | Contains array of publication objects, voucher object will be simplified. |  |
-| **total** | **Integer** | Total number of publications. |  |
+| **object** | **String** | The type of the object represented by JSON. This object stores information about publications in a dictionary. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of publications. | [optional][default to 'publications'] |
+| **publications** | [**Array<PublicationsListResponseBodyPublicationsItem>**](PublicationsListResponseBodyPublicationsItem.md) | Response schema model for publishing vouchers to a specific customer. | [optional] |
+| **total** | **Integer** | Total number of publications. | [optional] |
 

data/docs/PublicationsListResponseBodyPublicationsItem.md

@@ -1,51 +1,22 @@
 # VoucherifySdk::PublicationsListResponseBodyPublicationsItem
 
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'VoucherifySdk'
-
-VoucherifySdk::PublicationsListResponseBodyPublicationsItem.openapi_one_of
-# =>
-# [
-#   :'ListPublicationsItemInvalid',
-#   :'ListPublicationsItemValidMultipleVouchers',
-#   :'ListPublicationsItemValidSingleVoucher'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'VoucherifySdk'
-
-VoucherifySdk::PublicationsListResponseBodyPublicationsItem.build(data)
-# => #<ListPublicationsItemInvalid:0x00007fdd4aab02a0>
-
-VoucherifySdk::PublicationsListResponseBodyPublicationsItem.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `ListPublicationsItemInvalid`
-- `ListPublicationsItemValidMultipleVouchers`
-- `ListPublicationsItemValidSingleVoucher`
-- `nil` (if no type matches)
+## 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 &#x60;publication&#x60;. | [optional][default to &#39;publication&#39;] |
+| **created_at** | **Time** | Timestamp representing the date and time when the publication was created. The value is shown in the ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer receiving the publication. | [optional] |
+| **tracking_id** | **String** | Customer&#39;s &#x60;source_id&#x60;. | [optional] |
+| **metadata** | [**PublicationsListResponseBodyPublicationsItemMetadata**](PublicationsListResponseBodyPublicationsItemMetadata.md) |  | [optional] |
+| **channel** | **String** | How the publication was originated. It can be your own custom channel or an example value provided here. | [optional] |
+| **source_id** | **String** | The merchant&#39;s publication ID if it is different from the Voucherify publication ID. It&#39;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** | **Array&lt;String&gt;** | Contains the voucher IDs that was assigned by Voucherify. and Contains the unique voucher codes that was assigned by Voucherify. | [optional] |
+| **vouchers_id** | **Array&lt;String&gt;** | Contains the unique internal voucher IDs that was assigned by Voucherify. | [optional] |
+| **result** | **String** |  | [optional] |
+| **voucher** | [**ListPublicationsItemVoucher**](ListPublicationsItemVoucher.md) |  | [optional] |
+| **failure_code** | **String** | Generic reason as to why the create publication operation failed. | [optional] |
+| **failure_message** | **String** | This parameter will provide more expanded reason as to why the create publication operation failed. | [optional] |
 

data/docs/PublicationsListResponseBodyPublicationsItemMetadata.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::PublicationsListResponseBodyPublicationsItemMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | **String** | Defines the type of the distribution source. | [optional] |
+| **source_id** | **String** | Unique identifier of the distribution source. | [optional] |
+| **distribution_id** | **String** | Unique identifier of the distribution. | [optional] |
+

data/docs/QualificationsApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Check Eligibility
 
-  🚧 The Qualifications endpoint in the basic mode ignores the rules checking:    - Limit of total redeemed discount amount per campaign  - Limit of total redemptions count per campaign  - Redemptions per customer  - Redemptions per customer in a campaign  Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version  👍 Scenario Guide  Read our dedicated guide to learn about some use cases this endpoint can cover here. # Paging  The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.
+  🚧 The Qualifications endpoint ignores the rules checking:    - Limit of total redeemed discount amount per campaign  - Limit of total redemptions count per campaign  - Redemptions per customer  - Redemptions per customer in a campaign  Generate a list of redeemables that are applicable in the context of the customer and order. The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements: - Qualification results are returned faster - No limit on the number of returned redeemables - Introduces new qualification scenarios, not available in the previous version  👍 Scenario Guide  Read the dedicated guide to learn about some use cases this endpoint can cover. # Paging  The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor. To process of paging the redeemables works in the following manner: - You send the first API request for Qualifications without the starting_after parameter. - The response will contain a parameter named has_more. If the parameters value is set to true, then more redeemables are available. - Get the value of the created_at parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the starting_after parameter set to the value taken from the created_at parameter from the last returned redeemable. - Voucherify will return the next page of redeemables. - If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.
 
 ### Examples
 

data/docs/QualificationsCheckEligibilityRequestBody.md

@@ -6,9 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **customer** | [**Customer**](Customer.md) |  | [optional] |
 | **order** | [**Order**](Order.md) |  | [optional] |
-| **mode** | **String** | Defines which resources Voucherify will use. The `ADVANCED` mode is available after purchase only. | [optional] |
 | **tracking_id** | **String** | Is correspondent to Customer's source_id | [optional] |
-| **scenario** | **String** | Defines the scenario Voucherify should consider during the qualification process.  - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer’s cart based on the vouchers assigned to the customer’s profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s). | [optional] |
+| **scenario** | **String** | Defines the scenario Voucherify should consider during the qualification process.  - `ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s). | [optional] |
 | **options** | [**QualificationsOption**](QualificationsOption.md) |  | [optional] |
 | **metadata** | **Object** | A set of key/value pairs that you can send in the request body to check against redeemables requiring **redemption** metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!-- [Create Validation Rules](https://docs.voucherify.io/reference/create-validation-rules) -->[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ → _Advanced_ → _Redemption metadata satisfy_ or _Basic Builder_ → _Attributes match_ → _REDEMPTION METADATA_. [Read more](https://support.voucherify.io/article/148-how-to-build-a-rule). | [optional] |
 

data/docs/QualificationsFiltersCondition.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **is** | [**Any**](Any.md) |  | [optional] |
-| **is_not** | [**Any**](Any.md) |  | [optional] |
-| **has_value** | [**Any**](Any.md) |  | [optional] |
-| **is_unknown** | [**Any**](Any.md) |  | [optional] |
-| **_in** | [**Any**](Any.md) |  | [optional] |
-| **not_in** | [**Any**](Any.md) |  | [optional] |
+| **is** | **Array<String>** |  | [optional] |
+| **is_not** | **Array<String>** |  | [optional] |
+| **has_value** | **Object** |  | [optional] |
+| **is_unknown** | **Object** |  | [optional] |
+| **_in** | **Array<String>** |  | [optional] |
+| **not_in** | **Array<String>** |  | [optional] |
 

data/docs/QualificationsOptionFilters.md

@@ -7,8 +7,10 @@
 | **junction** | [**Junction**](Junction.md) |  | [optional] |
 | **category_id** | [**QualificationsFieldConditions**](QualificationsFieldConditions.md) |  | [optional] |
 | **campaign_id** | [**QualificationsFieldConditions**](QualificationsFieldConditions.md) |  | [optional] |
+| **campaign_type** | [**QualificationsOptionFiltersCampaignType**](QualificationsOptionFiltersCampaignType.md) |  | [optional] |
 | **resource_id** | [**QualificationsFieldConditions**](QualificationsFieldConditions.md) |  | [optional] |
 | **resource_type** | [**QualificationsOptionFiltersResourceType**](QualificationsOptionFiltersResourceType.md) |  | [optional] |
 | **voucher_type** | [**QualificationsFieldConditions**](QualificationsFieldConditions.md) |  | [optional] |
 | **code** | [**QualificationsFieldConditions**](QualificationsFieldConditions.md) |  | [optional] |
+| **holder_role** | [**QualificationsOptionFiltersHolderRole**](QualificationsOptionFiltersHolderRole.md) |  | [optional] |
 

data/docs/QualificationsOptionFiltersCampaignType.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::QualificationsOptionFiltersCampaignType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**QualificationsOptionFiltersCampaignTypeConditions**](QualificationsOptionFiltersCampaignTypeConditions.md) |  | [optional] |
+

data/docs/QualificationsOptionFiltersCampaignTypeConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::QualificationsOptionFiltersCampaignTypeConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | [**Array<ParameterCampaignType>**](ParameterCampaignType.md) |  | [optional] |
+| **is_not** | [**Array<ParameterCampaignType>**](ParameterCampaignType.md) |  | [optional] |
+| **_in** | [**Array<ParameterCampaignType>**](ParameterCampaignType.md) |  | [optional] |
+| **not_in** | [**Array<ParameterCampaignType>**](ParameterCampaignType.md) |  | [optional] |
+

data/docs/QualificationsOptionFiltersHolderRole.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::QualificationsOptionFiltersHolderRole
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conditions** | [**QualificationsOptionFiltersHolderRoleConditions**](QualificationsOptionFiltersHolderRoleConditions.md) |  | [optional] |
+

data/docs/QualificationsOptionFiltersHolderRoleConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::QualificationsOptionFiltersHolderRoleConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Array<String>** | Will return records only for the first value in the array. | [optional] |
+| **is_not** | **Array<String>** | Will return records only for the first value in the array. | [optional] |
+| **_in** | **Array<String>** | Will return records for the values in the array. | [optional] |
+| **not_in** | **Array<String>** | Will return records for the values in the array. | [optional] |
+

data/docs/QualificationsOptionFiltersResourceTypeConditions.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **is** | [**ResourceTypes**](ResourceTypes.md) |  | [optional] |
-| **is_not** | [**ResourceTypes**](ResourceTypes.md) |  | [optional] |
-| **_in** | [**Array<ResourceTypes>**](ResourceTypes.md) | Array of qualified redeemables. Accepts more than one value. Returns the resource types entered in the array. | [optional] |
-| **not_in** | [**Array<ResourceTypes>**](ResourceTypes.md) | Array of qualified redeemables. Accepts more than one value. Returns the resource types except those entered in the array. | [optional] |
+| **is** | [**Array<ResourceTypes>**](ResourceTypes.md) |  | [optional] |
+| **is_not** | [**Array<ResourceTypes>**](ResourceTypes.md) |  | [optional] |
+| **_in** | [**Array<ResourceTypes>**](ResourceTypes.md) |  | [optional] |
+| **not_in** | [**Array<ResourceTypes>**](ResourceTypes.md) |  | [optional] |
 

data/docs/QualificationsRedeemable.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Id of the redeemable. | [optional] |
 | **object** | **String** | Object type of the redeemable. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **result** | [**RedeemableResult**](RedeemableResult.md) |  | [optional] |
 | **order** | [**OrderCalculated**](OrderCalculated.md) |  | [optional] |
 | **validation_rule_id** | **String** | A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance. | [optional] |

data/docs/QualificationsRedeemableBase.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Id of the redeemable. | [optional] |
 | **object** | **String** | Object type of the redeemable. | [optional] |
-| **created_at** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
 | **result** | [**RedeemableResult**](RedeemableResult.md) |  | [optional] |
 | **order** | [**OrderCalculated**](OrderCalculated.md) |  | [optional] |
 | **validation_rule_id** | **String** | A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance. | [optional] |

data/docs/QualificationsRedeemables.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **object** | **String** | The type of object represented by JSON. Default is `list`. | [default to 'list'] |
-| **data_ref** | **String** | Identifies the name of the attribute that contains the array of qualified redeemables. | [default to 'data'] |
-| **data** | [**Array<QualificationsRedeemable>**](QualificationsRedeemable.md) | Array of qualified redeemables. |  |
-| **total** | **Integer** | The number of redeemables returned in the API request. |  |
-| **has_more** | **Boolean** | As results are always limited, the `has_more` flag indicates whether there are more records for given parameters. This let's you know if you are able to run another request (with different options) to get more records returned in the results. |  |
-| **more_starting_after** | **Time** | Timestamp representing the date and time to use in starting_after cursor to get more redeemables. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. Default is `list`. | [optional][default to 'list'] |
+| **data_ref** | **String** | Identifies the name of the attribute that contains the array of qualified redeemables. | [optional][default to 'data'] |
+| **data** | [**Array<QualificationsRedeemable>**](QualificationsRedeemable.md) | Array of qualified redeemables. | [optional] |
+| **total** | **Integer** | The number of redeemables returned in the API request. | [optional] |
+| **has_more** | **Boolean** | As results are always limited, the `has_more` flag indicates if there are more records for given parameters. This lets you know if you can run another request (with different options) to get more records returned in the results. | [optional] |
+| **more_starting_after** | **Time** | Timestamp representing the date and time to use in `starting_after` cursor to get more redeemables. | [optional] |
 

data/docs/RedeemableLoyaltyCard.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | Total points incurred over lifespan of loyalty card. | [optional] |
+| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
 | **balance** | **Integer** | Points available for reward redemption. | [optional] |
 | **exchange_ratio** | **Float** | The cash equivalent of the points defined in the points_ratio property. | [optional] |
 | **points_ratio** | **Integer** | The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property. | [optional] |

data/docs/RedeemableVoucher.md

@@ -0,0 +1,35 @@
+# VoucherifySdk::RedeemableVoucher
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Assigned by the Voucherify API, identifies the voucher. | [optional] |
+| **code** | **String** | A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. | [optional] |
+| **campaign** | **String** | A unique campaign name, identifies the voucher's parent campaign. | [optional] |
+| **campaign_id** | **String** | Assigned by the Voucherify API, identifies the voucher's parent campaign. | [optional] |
+| **category** | **String** | The value is null. | [optional] |
+| **category_id** | **String** | Unique category ID assigned by Voucherify. | [optional] |
+| **categories** | **Array<Object>** | Contains an empty array. | [optional] |
+| **type** | **String** | Defines the type of the voucher.  | [optional] |
+| **discount** | [**Discount**](Discount.md) |  | [optional] |
+| **gift** | [**RedeemableVoucherGift**](RedeemableVoucherGift.md) |  | [optional] |
+| **loyalty_card** | [**RedeemableVoucherLoyaltyCard**](RedeemableVoucherLoyaltyCard.md) |  | [optional] |
+| **start_date** | **Time** | Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is *inactive before* this date.  | [optional] |
+| **expiration_date** | **Time** | Expiration timestamp defines when the code expires in ISO 8601 format.  Voucher is *inactive after* this date. | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | 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] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **active** | **Boolean** | A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`.    - `true` indicates an *active* voucher - `false` indicates an *inactive* voucher | [optional] |
+| **additional_info** | **String** | An optional field to keep any extra textual information about the code such as a code description and details. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | [optional] |
+| **assets** | [**VoucherAssets**](VoucherAssets.md) |  | [optional] |
+| **is_referral_code** | **Boolean** | Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. | [optional] |
+| **referrer_id** | **String** | Unique identifier of the referring person. | [optional] |
+| **holder_id** | **String** | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. | [optional] |
+| **object** | **String** | The type of the object represented by JSON. Default is `voucher`. | [optional][default to 'voucher'] |
+| **publish** | [**RedeemableVoucherPublish**](RedeemableVoucherPublish.md) |  | [optional] |
+| **redemption** | [**RedeemableVoucherRedemption**](RedeemableVoucherRedemption.md) |  | [optional] |
+

data/docs/RedeemableVoucherGift.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RedeemableVoucherGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **balance** | **Integer** | Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000. | [optional] |
+| **effect** | **String** | Defines how the credits are applied to the customer's order. | [optional] |
+

data/docs/RedeemableVoucherLoyaltyCard.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::RedeemableVoucherLoyaltyCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **points** | **Integer** | Total points incurred over the lifespan of the loyalty card. | [optional] |
+| **balance** | **Integer** | Points available for reward redemption. | [optional] |
+| **next_expiration_date** | **Date** | The next closest date when the next set of points are due to expire. | [optional] |
+| **next_expiration_points** | **Integer** | The amount of points that are set to expire next. | [optional] |
+

data/docs/RedeemableVoucherPublish.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RedeemableVoucherPublish
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the `url` attribute. | [optional][default to 'list'] |
+| **count** | **Integer** | Publication events counter. | [optional] |
+| **url** | **String** | The endpoint where this list of publications can be accessed using a GET method. `/v1/vouchers/{voucher_code}/publications` | [optional] |
+

data/docs/RedeemableVoucherRedemption.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::RedeemableVoucherRedemption
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **quantity** | **Integer** | How many times a voucher can be redeemed. A `null` value means unlimited. | [optional] |
+| **redeemed_quantity** | **Integer** | How many times a voucher has already been redeemed. | [optional] |
+| **redeemed_points** | **Integer** | Total loyalty points redeemed. | [optional] |
+| **object** | **String** | The type of the object represented is by default `list`. To get this list, you need to make a call to the endpoint returned in the url attribute. | [optional][default to 'list'] |
+| **url** | **String** | The endpoint where this list of redemptions can be accessed using a GET method. `/v1/vouchers/{voucher_code}/redemptions` | [optional] |
+

data/docs/Redemption.md

@@ -4,25 +4,25 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | Unique redemption ID. |  |
-| **object** | **String** | The type of object represented by the JSON | [default to 'redemption'] |
-| **date** | **Time** | Timestamp representing the date and time when the object was created in ISO 8601 format. |  |
-| **customer_id** | **String** | Unique customer ID of the redeeming customer. |  |
-| **tracking_id** | **String** | Hashed customer source ID. |  |
-| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. |  |
-| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
-| **redemption** | **String** | Unique redemption ID of the parent redemption. |  |
-| **result** | **String** | Redemption result. |  |
-| **status** | **String** | Redemption status. |  |
+| **id** | **String** | Unique redemption ID. | [optional] |
+| **object** | **String** | The type of the object represented by the JSON | [optional][default to 'redemption'] |
+| **date** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the redeeming customer. | [optional] |
+| **tracking_id** | **String** | Hashed customer source ID. | [optional] |
+| **metadata** | **Object** | The metadata object stores all custom attributes assigned to the redemption. | [optional] |
+| **amount** | **Integer** | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. | [optional] |
+| **redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] |
+| **result** | **String** | Redemption result. | [optional] |
+| **status** | **String** | Redemption status. | [optional] |
 | **related_redemptions** | [**RedemptionRelatedRedemptions**](RedemptionRelatedRedemptions.md) |  | [optional] |
 | **failure_code** | **String** | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. | [optional] |
 | **failure_message** | **String** | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. | [optional] |
-| **order** | [**OrderCalculatedNoCustomerData**](OrderCalculatedNoCustomerData.md) |  |  |
-| **channel** | [**RedemptionChannel**](RedemptionChannel.md) |  |  |
-| **customer** | [**SimpleCustomer**](SimpleCustomer.md) |  |  |
-| **related_object_type** | **String** | Defines the related object. |  |
-| **related_object_id** | **String** | Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher. |  |
-| **voucher** | [**Voucher**](Voucher.md) |  | [optional] |
+| **order** | [**OrderCalculated**](OrderCalculated.md) |  | [optional] |
+| **channel** | [**RedemptionChannel**](RedemptionChannel.md) |  | [optional] |
+| **customer** | [**SimpleCustomer**](SimpleCustomer.md) |  | [optional] |
+| **related_object_type** | **String** | Defines the related object. | [optional] |
+| **related_object_id** | **String** | Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher. | [optional] |
+| **voucher** | [**RedemptionVoucher**](RedemptionVoucher.md) |  | [optional] |
 | **promotion_tier** | [**PromotionTier**](PromotionTier.md) |  | [optional] |
 | **reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) |  | [optional] |
 | **gift** | [**RedemptionGift**](RedemptionGift.md) |  | [optional] |

data/docs/RedemptionEntry.md

@@ -0,0 +1,31 @@
+# VoucherifySdk::RedemptionEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **object** | **String** |  | [optional] |
+| **date** | **Time** | Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the redeeming customer. | [optional] |
+| **tracking_id** | **String** | Hashed customer source ID. | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **amount** | **Integer** | For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction. and For gift cards, this represents the number of the credits restored to the card in the rolledback redemption. The number is a negative integer in the smallest currency unit, e.g. -100 cents for $1.00 added back to the card. For loyalty cards, this represents the number of loyalty points restored to the card in the rolledback redemption. The number is a negative integer. | [optional] |
+| **redemption** | **String** | Unique redemption ID of the parent redemption. | [optional] |
+| **result** | **String** | Redemption result. | [optional] |
+| **status** | **String** |  | [optional] |
+| **related_redemptions** | [**RedemptionEntryRelatedRedemptions**](RedemptionEntryRelatedRedemptions.md) |  | [optional] |
+| **failure_code** | **String** | If the result is `FAILURE`, this parameter will provide a generic reason as to why the redemption failed. | [optional] |
+| **failure_message** | **String** | If the result is `FAILURE`, this parameter will provide a more expanded reason as to why the redemption failed. | [optional] |
+| **order** | [**RedemptionEntryOrder**](RedemptionEntryOrder.md) |  | [optional] |
+| **channel** | [**RedemptionEntryChannel**](RedemptionEntryChannel.md) |  | [optional] |
+| **customer** | [**RedemptionEntryCustomer**](RedemptionEntryCustomer.md) |  | [optional] |
+| **related_object_type** | **String** | Defines the related object. | [optional] |
+| **related_object_id** | **String** |  | [optional] |
+| **voucher** | [**RedemptionEntryVoucher**](RedemptionEntryVoucher.md) |  | [optional] |
+| **promotion_tier** | [**RedemptionEntryPromotionTier**](RedemptionEntryPromotionTier.md) |  | [optional] |
+| **reward** | [**RedemptionRewardResult**](RedemptionRewardResult.md) |  | [optional] |
+| **gift** | [**RedemptionEntryGift**](RedemptionEntryGift.md) |  | [optional] |
+| **loyalty_card** | [**RedemptionEntryLoyaltyCard**](RedemptionEntryLoyaltyCard.md) |  | [optional] |
+| **reason** | **String** | System generated cause for the redemption being invalid in the context of the provided parameters. | [optional] |
+

data/docs/RedemptionEntryChannel.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RedemptionEntryChannel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** |  | [optional] |
+| **channel_type** | **String** | The source of the channel for the redemption. A `USER` corresponds to the Voucherify Dashboard and an `API` corresponds to the API. | [optional] |
+

data/docs/RedemptionEntryCustomer.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::RedemptionEntryCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier of an existing customer. It is assigned by Voucherify. | [optional] |
+| **name** | **String** | Customer's first and last name. | [optional] |
+| **email** | **String** | Customer's email address. | [optional] |
+| **source_id** | **String** | A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service. | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'customer'] |
+

data/docs/RedemptionEntryGift.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::RedemptionEntryGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** | Amount subtracted from the gift card as a result of the redemption. The amount is expressed as the smallest currency unit (e.g. 100 cents for $1.00). and Amount returned to the gift card as a result of the redemption rollback and expressed as a negative integer. The amount is expressed as the smallest currency unit (e.g. -100 cents for $1.00 returned). | [optional] |
+

data/docs/RedemptionEntryLoyaltyCard.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::RedemptionEntryLoyaltyCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **points** | **Integer** | Number of points subtracted from the loyalty card as a result of the redemption. and Number of points being returned to the loyalty card for the reward redemption rollback. It is expressed as a negative integer. | [optional] |
+

data/docs/RedemptionEntryOrder.md

@@ -0,0 +1,29 @@
+# VoucherifySdk::RedemptionEntryOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request. | [optional] |
+| **source_id** | **String** | Unique source ID of an existing order that will be linked to the redemption of this request. | [optional] |
+| **status** | **String** | The order status. | [optional] |
+| **amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **initial_amount** | **Integer** | A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts. | [optional] |
+| **discount_amount** | **Integer** | Sum of all order-level discounts applied to the order. | [optional] |
+| **items_discount_amount** | **Integer** | Sum of all product-specific discounts applied to the order. | [optional] |
+| **total_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied to the order. | [optional] |
+| **total_amount** | **Integer** | Order amount after undoing all the discounts through the rollback redemption. | [optional] |
+| **applied_discount_amount** | **Integer** | This field shows the order-level discount applied. | [optional] |
+| **items_applied_discount_amount** | **Integer** | Sum of all product-specific discounts applied in a particular request.   `sum(items, i => i.applied_discount_amount)` | [optional] |
+| **total_applied_discount_amount** | **Integer** | Sum of all order-level AND all product-specific discounts applied in a particular request.   `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | [optional] |
+| **items** | [**Array<OrderCalculatedItem>**](OrderCalculatedItem.md) | Array of items applied to the order. | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **object** | **String** | The type of the object represented by JSON. | [optional][default to 'order'] |
+| **created_at** | **Time** | Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | Timestamp representing the date and time when the order was last updated in ISO 8601 format. | [optional] |
+| **customer_id** | **String** | Unique customer ID of the customer making the purchase. | [optional] |
+| **referrer_id** | **String** | Unique referrer ID. | [optional] |
+| **customer** | [**RedemptionEntryOrderCustomer**](RedemptionEntryOrderCustomer.md) |  | [optional] |
+| **referrer** | [**RedemptionEntryOrderReferrer**](RedemptionEntryOrderReferrer.md) |  | [optional] |
+| **redemptions** | **Object** |  | [optional] |
+

data/docs/RedemptionEntryOrderCustomer.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RedemptionEntryOrderCustomer
+
+## 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'] |
+

data/docs/RedemptionEntryOrderReferrer.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RedemptionEntryOrderReferrer
+
+## 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'] |
+

data/docs/RedemptionEntryPromotionTier.md

@@ -0,0 +1,29 @@
+# VoucherifySdk::RedemptionEntryPromotionTier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique promotion tier ID. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] |
+| **updated_at** | **Time** | 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** | [**RedemptionEntryPromotionTierAction**](RedemptionEntryPromotionTierAction.md) |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **hierarchy** | **Integer** | 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] |
+| **promotion_id** | **String** | Promotion unique ID. | [optional] |
+| **campaign** | [**RedemptionEntryPromotionTierCampaign**](RedemptionEntryPromotionTierCampaign.md) |  | [optional] |
+| **campaign_id** | **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] |
+| **start_date** | **Time** | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is *inactive before* this date.  | [optional] |
+| **expiration_date** | **Time** | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is *inactive after* this date.  | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | 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] |
+| **validity_hours** | [**ValidityHours**](ValidityHours.md) |  | [optional] |
+| **summary** | [**RedemptionEntryPromotionTierSummary**](RedemptionEntryPromotionTierSummary.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'] |
+| **validation_rule_assignments** | [**ValidationRuleAssignmentsList**](ValidationRuleAssignmentsList.md) |  | [optional] |
+| **category_id** | **String** | Promotion tier category ID. | [optional] |
+| **categories** | [**Array<Category>**](Category.md) |  | [optional] |
+

data/docs/RedemptionEntryPromotionTierAction.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::RedemptionEntryPromotionTierAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount** | [**Discount**](Discount.md) |  | [optional] |
+

data/docs/RedemptionEntryPromotionTierCampaign.md

@@ -0,0 +1,16 @@
+# VoucherifySdk::RedemptionEntryPromotionTierCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique campaign ID. | [optional] |
+| **start_date** | **Time** | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.  | [optional] |
+| **expiration_date** | **Time** | Expiration timestamp defines when the campaign expires in ISO 8601 format.  Campaign is *inactive after* this date. | [optional] |
+| **validity_timeframe** | [**ValidityTimeframe**](ValidityTimeframe.md) |  | [optional] |
+| **validity_day_of_week** | **Array<Integer>** | 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] |
+| **validity_hours** | [**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](OpenAPI.json/paths/~1campaigns~1{campaignId}~1disable) -->[Disable Campaign](ref:disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
+| **category_id** | **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'] |
+