voucherify 8.1.0 → 8.2.0

data/docs/RedemptionsApi.md

@@ -208,7 +208,7 @@ end
 
 Redeem Stackable Discounts
 
-In the table below, you can see the logic the API follows to calculate discounts and amounts:   API keys with a Merchant role cant use this endpoint.  📘 Rollbacks  You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).      📘 Also available on client-side  This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more.
+In the table below, you can see the logic the API follows to calculate discounts and amounts:   API keys with a Merchant role cant use this endpoint. <Note> <Badge color blue>Rollbacks</Badge> You cant roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions). </Note> <Note> <Badge color blue>Also available on client-side</Badge> This method is also accessible through public keys which you can use in client-side​ apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more. </Note>
 
 ### Examples
 
@@ -268,7 +268,7 @@ end
 
 Rollback Redemption
 
-Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions)  🚧  You can roll back a redemption up to 3 months back.   # Effect  The operation  - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and  - gives 1 redemption back to the pool (decreases redeemed_quantity by 1).  # Returned funds  In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption.
+Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions)  <Warning> You can roll back a redemption up to 3 months back. </Warning>  # Effect  The operation  - creates a rollback entry in vouchers redemption history (redemption.redemption_entries) and  - gives 1 redemption back to the pool (decreases redeemed_quantity by 1).  # Returned funds  In case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption.
 
 ### Examples
 
@@ -334,7 +334,7 @@ end
 
 Rollback Stackable Redemptions
 
-Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). 🚧   You can roll back a redemption up to 3 months back.
+Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption). <Warning> You can roll back a redemption up to 3 months back. </Warning>
 
 ### Examples
 

data/docs/RedemptionsGetResponseBodyPromotionTierCampaign.md

@@ -10,7 +10,7 @@
 | **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](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
+| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/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'] |
 

data/docs/RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign.md

@@ -10,7 +10,7 @@
 | **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](/api-reference/disable-campaign) endpoint.    - `true` indicates an *active* campaign - `false` indicates an *inactive* campaign | [optional] |
+| **active** | **Boolean** | A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the `start_date` and `expiration_date` using the [Disable Campaign](/api-reference/campaigns/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'] |
 

data/docs/RedemptionsRedeemRequestBody.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **options** | [**RedemptionsRedeemRequestBodyOptions**](RedemptionsRedeemRequestBodyOptions.md) |  | [optional] |
-| **redeemables** | [**Array<RedemptionsRedeemRequestBodyRedeemablesItem>**](RedemptionsRedeemRequestBodyRedeemablesItem.md) |  | [optional] |
+| **redeemables** | [**Array<RedemptionsRedeemRequestBodyRedeemablesItem>**](RedemptionsRedeemRequestBodyRedeemablesItem.md) | An array of redeemables. You can combine `voucher`(s) and `promotion_tier`(s). Alternatively, send one unique`promotion_stack` in the array. Each unique redeemable can be sent in one request only once. | [optional] |
 | **order** | [**Order**](Order.md) |  | [optional] |
 | **customer** | [**Customer**](Customer.md) |  | [optional] |
 | **session** | [**Session**](Session.md) |  | [optional] |

data/docs/RedemptionsRedeemRequestBodyOptions.md

@@ -5,4 +5,5 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **expand** | **Array<String>** | Expand array lets you configure params included in the response. Depending on the strings included in the array, the response will contain different details.   | **Expand Option** | **Response Body** | |:---|:---| | [\"order\"] | - Same response as fallback response (without an options object).<br />- Order data with calculated discounts are listed in each child redeemable object.<br />- Metadata not included for each discount type. | | [\"redeemable\"] | Expands redeemable objects by including `metadata` for each discount type. | | [\"order\", \"redeemable\"] | - Order data with calculated discounts are listed in each child redeemable object.<br />- Includes `metadata` for each discount type. | | [\"redeemable\", \"redemption\", \"category\"] | - Returns each discount type's `metadata` in each child redemption object.<br />- Returns redemption object `metadata`.<br />- Returns an expanded `categories` object, showing details about the category. | | [optional] |
+| **language** | **String** | Selects the language for the custom validation-rule error message. Returns the message in this language when a validation rule fails. Falls back to the Error Message Library default language when omitted or when the requested language has no message. Omits the custom error when no message can be resolved. | [optional] |
 

data/docs/ReferralsApi.md

@@ -18,7 +18,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 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.
+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) <Tip> To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. </Tip> <Note> <Badge color blue>Alternative endpoint</Badge> 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. </Note>
 
 ### Examples
 
@@ -80,7 +80,7 @@ end
 
 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.
+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) <Tip> To add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint. </Tip>
 
 ### Examples
 
@@ -214,7 +214,7 @@ end
 
 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.
+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) <Note> <Badge color blue>Alternative endpoint</Badge> 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. </Note>
 
 ### Examples
 
@@ -282,7 +282,7 @@ end
 
 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.
+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) <Note> <Badge color blue>Alternative endpoint</Badge> 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. </Note>
 
 ### Examples
 

data/docs/ReferralsMembersHoldersListResponseBody.md

@@ -7,7 +7,7 @@
 | **object** | **String** | The type of the object represented by JSON. This object stores information about redeemables holders | [optional][default to 'list'] |
 | **data_ref** | **String** | Identifies the name of the JSON property that contains the array of holders. | [optional][default to 'data'] |
 | **data** | [**Array<RedeemableHolder>**](RedeemableHolder.md) | A dictionary that contains an array of holders. | [optional] |
-| **total** | **Integer** | Total number of holders assigned to the redeemable. | [optional] |
+| **total** | **Integer** | Total number of results returned on this page. | [optional] |
 | **has_more** | **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] |
 | **more_starting_after** | **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] |
 

data/docs/ReportCardDefinitionIdFilterConditions.md

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

data/docs/ReportCardDefinitionIdFilterConditionsConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ReportCardDefinitionIdFilterConditionsConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Object** |  | [optional] |
+| **is_not** | **Object** |  | [optional] |
+| **_in** | **Object** |  | [optional] |
+| **not_in** | **Object** |  | [optional] |
+

data/docs/RewardCostResponse.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::RewardCostResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique cost identifier, prefixed with `lrcst_`. | [optional] |
+| **name** | **String** | Display name of the cost. Omitted when not set. `null` when cleared. | [optional] |
+| **rules** | **Object** | Rules group. Contains a `logic` formula string plus numbered rule definition properties (positive-integer keys). | [optional] |
+| **spending** | [**Array<LoyaltyV2ActivityRewardCostSpendingResponse>**](LoyaltyV2ActivityRewardCostSpendingResponse.md) | Points spending definitions, or `null` when none are defined. | [optional] |
+| **tier_rules** | [**RewardCostTierRulesResponse**](RewardCostTierRulesResponse.md) |  |  |
+

data/docs/RewardCostTierRulesAnyOfEntryResponse.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardCostTierRulesAnyOfEntryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier_structure_id** | **String** | Identifies the tier structure. | [optional] |
+| **tier_ids** | **Array<String>** | Lists the qualifying tier IDs. | [optional] |
+

data/docs/RewardCostTierRulesResponse.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardCostTierRulesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Tier requirement type. | [optional] |
+| **any_of** | [**Array<RewardCostTierRulesAnyOfEntryResponse>**](RewardCostTierRulesAnyOfEntryResponse.md) | Lists tier combinations that qualify. Present when `type` is `ANY_OF`. | [optional] |
+

data/docs/RewardDigitalResponse.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::RewardDigitalResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Kind of digital reward. | [optional] |
+| **discount_coupons** | [**LoyaltyV2ActivityRewardDigitalDiscountCoupons**](LoyaltyV2ActivityRewardDigitalDiscountCoupons.md) |  | [optional] |
+| **gift_vouchers** | [**LoyaltyV2ActivityRewardDigitalGiftVouchersResponse**](LoyaltyV2ActivityRewardDigitalGiftVouchersResponse.md) |  | [optional] |
+| **loyalty_card_points** | [**LoyaltyV2ActivityRewardDigitalLoyaltyCardPointsResponse**](LoyaltyV2ActivityRewardDigitalLoyaltyCardPointsResponse.md) |  | [optional] |
+

data/docs/RewardMaterialResponse.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RewardMaterialResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Kind of material reward. | [optional] |
+| **product** | [**LoyaltyV2ActivityRewardMaterialProduct**](LoyaltyV2ActivityRewardMaterialProduct.md) |  | [optional] |
+| **sku** | [**LoyaltyV2ActivityRewardMaterialSKU**](LoyaltyV2ActivityRewardMaterialSKU.md) |  | [optional] |
+

data/docs/RewardPurchaseDigitalCoupon.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RewardPurchaseDigitalCoupon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Voucher identifier of the coupon. | [optional] |
+| **code** | **String** | Coupon code. | [optional] |
+| **result** | **String** | Refund handling result for this coupon (present in refund results):  - `DELETED`: The coupon was deleted.  - `SKIPPED`: The coupon was left intact. | [optional] |
+

data/docs/RewardPurchaseDigitalGiftVoucher.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::RewardPurchaseDigitalGiftVoucher
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Voucher identifier of the gift voucher. | [optional] |
+| **code** | **String** | Gift voucher code. | [optional] |
+| **amount** | **Float** | Amount added to (or, for refunds, subtracted from) the gift voucher balance. | [optional] |
+| **balance** | **Float** | Gift voucher balance after the operation. | [optional] |
+| **result** | **String** | Refund handling result for this gift voucher (present in refund results):  - `CREDITS_SUBTRACTED`: The credited balance was subtracted.  - `SKIPPED`: The voucher was left intact. | [optional] |
+

data/docs/RewardPurchaseLimits.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardPurchaseLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cooldown** | [**RewardPurchaseLimitsCooldown**](RewardPurchaseLimitsCooldown.md) |  |  |
+| **frequency** | [**RewardPurchaseLimitsFrequency**](RewardPurchaseLimitsFrequency.md) |  |  |
+

data/docs/RewardPurchaseLimitsCooldown.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardPurchaseLimitsCooldown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Cooldown type. `NO_COOLDOWN` - no cooldown. `FIXED_COOLDOWN` - wait a fixed period after each purchase. | [optional] |
+| **fixed_cooldown** | [**RewardPurchaseLimitsCooldownFixedCooldown**](RewardPurchaseLimitsCooldownFixedCooldown.md) |  | [optional] |
+

data/docs/RewardPurchaseLimitsCooldownFixedCooldown.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::RewardPurchaseLimitsCooldownFixedCooldown
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **period** | [**LoyaltyV2ActivityRewardPurchaseLimitsCooldownFixedCooldownPeriod**](LoyaltyV2ActivityRewardPurchaseLimitsCooldownFixedCooldownPeriod.md) |  |  |
+

data/docs/RewardPurchaseLimitsFrequency.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardPurchaseLimitsFrequency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Frequency limit type. `NO_LIMIT` - unlimited purchases. `LIMITED` - limited by the `limits` array. | [optional] |
+| **limits** | [**Array<RewardPurchaseLimitsFrequencyLimit>**](RewardPurchaseLimitsFrequencyLimit.md) | Frequency limit definitions. Empty array when `type` is `NO_LIMIT`; one entry when `type` is `LIMITED`. | [optional] |
+

data/docs/RewardPurchaseLimitsFrequencyLimit.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::RewardPurchaseLimitsFrequencyLimit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Limit type. Always `TIME_BASED`. | [optional][default to 'TIME_BASED'] |
+| **period** | [**LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod**](LoyaltyV2ActivityCardDefinitionLimitTimeBasedPeriod.md) |  |  |
+| **triggers** | [**LoyaltyV2ActivityRewardPurchaseLimitsFrequencyLimitTriggers**](LoyaltyV2ActivityRewardPurchaseLimitsFrequencyLimitTriggers.md) |  |  |
+

data/docs/RewardPurchaseRefundPolicies.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardPurchaseRefundPolicies
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refund** | **String** | Applies the refund override. `DEFAULT` follows the reward's refunds setting. `ALLOW` refunds even when the reward is not refundable. Defaults to `DEFAULT`. | [optional] |
+| **stock** | **String** | Controls assignment stock. `DEFAULT` restores one unit when stock is limited. `WRITE_OFF` does not restore stock. Unlimited (`null`) stock is unchanged. Defaults to `DEFAULT`. | [optional] |
+

data/docs/RewardPurchaseTransaction.md

@@ -0,0 +1,20 @@
+# VoucherifySdk::RewardPurchaseTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **program_id** | **String** | Unique identifier of the loyalty program (format `lprg_...`). | [optional] |
+| **member_id** | **String** | Unique identifier of the program member (format `lmbr_...`). | [optional] |
+| **created_at** | **Time** | Timestamp when the transaction was created (ISO 8601). | [optional] |
+| **updated_at** | **Time** | Timestamp when the transaction was last updated (ISO 8601), or `null`. | [optional] |
+| **card_id** | **String** | Unique identifier of the loyalty card the points were spent from (format `lcrd_...`). | [optional] |
+| **id** | **String** | Unique reward transaction identifier (format `lrtx_...`). Absent for `DRY_RUN` (SIMULATED) transactions, which are never persisted. | [optional] |
+| **card_definition_id** | **String** | Unique identifier of the card definition for that card (format `lcdef_...`). `null` when none is stored. | [optional] |
+| **card_transaction_id** | **String** | Identifies of the underlying card transaction (format `lctx_...`). `null` for `DRY_RUN` (SIMULATED) transactions. | [optional] |
+| **reward_id** | **String** | Unique identifier of the purchased reward (format `lrew_...`). | [optional] |
+| **status** | **String** | Transaction status:  - `PENDING`: Created and awaiting processing.  - `PROCESSING`: Being processed.  - `APPROVED`: Completed successfully.  - `REJECTED`: Rejected (see `details.rejection`).  - `SIMULATED`: Dry-run result that is not persisted.  - `REFUNDED`: Purchase has been refunded. | [optional] |
+| **type** | **String** | Transaction type. | [optional] |
+| **details** | **Object** |  | [optional] |
+| **object** | **String** | Object type marker. Always `reward_transaction`. | [optional][default to 'reward_transaction'] |
+

data/docs/RewardValidityHoursResponse.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardValidityHoursResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Whether the reward is purchasable at any time or only during specific daily windows. | [optional] |
+| **daily** | [**Array<LoyaltyV2ActivityRewardValidityDailyHoursResponse>**](LoyaltyV2ActivityRewardValidityDailyHoursResponse.md) | Daily time windows. Present only when `type` is DAILY. | [optional] |
+

data/docs/RewardsCreateRequestBodyParametersCoin.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **exchange_ratio** | **String** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
+| **exchange_ratio** | **Float** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
 | **points_ratio** | **String** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] |
 

data/docs/RewardsReportDailyEntry.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::RewardsReportDailyEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
+| **reward_id** | **String** | Identifies the reward (`lrew_...`). | [optional] |
+| **success_count** | **Float** | Counts approved reward purchases in the period. | [optional] |
+| **failures_count** | **Float** | Counts reward purchase attempts that failed in the period. | [optional] |
+| **failures_breakdown** | **Object** | Always an empty object even if `failures_count` is above zero. | [optional] |
+| **object** | **String** | Object type marker. Always `program_rewards_daily_report`. | [optional][default to 'program_rewards_daily_report'] |
+

data/docs/RewardsReportFilterRewardIdConditions.md

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

data/docs/RewardsReportFilterRewardIdConditionsConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::RewardsReportFilterRewardIdConditionsConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Object** |  | [optional] |
+| **is_not** | **Object** |  | [optional] |
+| **_in** | **Object** |  | [optional] |
+| **not_in** | **Object** |  | [optional] |
+

data/docs/RewardsReportListFilters.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::RewardsReportListFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **junction** | **String** | Joins the field filters. Allowed values are `AND` and `OR`. Defaults to `AND`. | [optional] |
+| **reward_id** | [**RewardsReportFilterRewardIdConditions**](RewardsReportFilterRewardIdConditions.md) |  | [optional] |
+

data/docs/RewardsReportSummaryEntry.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::RewardsReportSummaryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifies the summary row (format: `lprrs_` followed by hexadecimal characters). | [optional] |
+| **reward_id** | **String** | Identifies the reward (`lrew_...`). | [optional] |
+| **success_count** | **Float** | Counts approved reward purchases. | [optional] |
+| **failures_count** | **Float** | Counts reward purchase attempts that failed. | [optional] |
+| **failures_breakdown** | **Object** | Counts failed reward purchase attempts by reason. A reason is present only when it was recorded. Empty when no failures were recorded. Keys can also be a card-transaction rejection reason or a publication error key. |  |
+| **object** | **String** | Object type marker. Always `program_rewards_summary_report`. | [optional][default to 'program_rewards_summary_report'] |
+

data/docs/RewardsSpendingsReportDailyEntry.md

@@ -0,0 +1,15 @@
+# VoucherifySdk::RewardsSpendingsReportDailyEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reward_id** | **String** | Identifies the reward (`lrew_...`). | [optional] |
+| **cost_id** | **String** | Identifies the reward cost (`lrcst_...`). | [optional] |
+| **spending_id** | **String** | Identifies the reward spending (`lrspn_...`). | [optional] |
+| **card_definition_id** | **String** | Identifies the card definition (`lcdef_...`). | [optional] |
+| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
+| **success_count** | **Float** | Counts approved reward point spends in the period. | [optional] |
+| **points** | **Float** | Totals points spent on those reward spends in the period. | [optional] |
+| **object** | **String** | Object type marker. Always `program_rewards_spendings_daily_report`. | [optional][default to 'program_rewards_spendings_daily_report'] |
+

data/docs/RewardsSpendingsReportFilterCostIdConditions.md

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

data/docs/RewardsSpendingsReportFilterCostIdConditionsConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::RewardsSpendingsReportFilterCostIdConditionsConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Object** |  | [optional] |
+| **is_not** | **Object** |  | [optional] |
+| **_in** | **Object** |  | [optional] |
+| **not_in** | **Object** |  | [optional] |
+

data/docs/RewardsSpendingsReportFilterSpendingIdConditions.md

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

data/docs/RewardsSpendingsReportFilterSpendingIdConditionsConditions.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::RewardsSpendingsReportFilterSpendingIdConditionsConditions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is** | **Object** |  | [optional] |
+| **is_not** | **Object** |  | [optional] |
+| **_in** | **Object** |  | [optional] |
+| **not_in** | **Object** |  | [optional] |
+

data/docs/RewardsSpendingsReportListFilters.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::RewardsSpendingsReportListFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **junction** | **String** | Joins the field filters. Allowed values are `AND` and `OR`. Defaults to `AND`. | [optional] |
+| **reward_id** | [**RewardsReportFilterRewardIdConditions**](RewardsReportFilterRewardIdConditions.md) |  | [optional] |
+| **card_definition_id** | [**ReportCardDefinitionIdFilterConditions**](ReportCardDefinitionIdFilterConditions.md) |  | [optional] |
+| **cost_id** | [**RewardsSpendingsReportFilterCostIdConditions**](RewardsSpendingsReportFilterCostIdConditions.md) |  | [optional] |
+| **spending_id** | [**RewardsSpendingsReportFilterSpendingIdConditions**](RewardsSpendingsReportFilterSpendingIdConditions.md) |  | [optional] |
+

data/docs/RewardsSpendingsReportSummaryEntry.md

@@ -0,0 +1,15 @@
+# VoucherifySdk::RewardsSpendingsReportSummaryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reward_id** | **String** | Identifies the reward (`lrew_...`). | [optional] |
+| **cost_id** | **String** | Identifies the reward cost (`lrcst_...`). | [optional] |
+| **spending_id** | **String** | Identifies the reward spending (`lrspn_...`). | [optional] |
+| **card_definition_id** | **String** | Identifies the card definition (`lcdef_...`). | [optional] |
+| **id** | **String** | Identifies the summary row (format: `lprss_` followed by hexadecimal characters). | [optional] |
+| **success_count** | **Float** | Counts approved reward point spends. | [optional] |
+| **points** | **Float** | Totals points spent on those reward spends. | [optional] |
+| **object** | **String** | Object type marker. Always `program_rewards_spendings_summary_report`. | [optional][default to 'program_rewards_spendings_summary_report'] |
+

data/docs/RewardsUpdateRequestBodyParametersCoin.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **exchange_ratio** | **String** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
+| **exchange_ratio** | **Float** | The cash equivalent of the points defined in the `points_ratio` property. | [optional] |
 | **points_ratio** | **String** | The number of loyalty points that will map to the predefined cash amount defined by the `exchange_ratio` property. | [optional] |
 

data/docs/SegmentsApi.md

@@ -15,7 +15,7 @@ All URIs are relative to *https://api.voucherify.io*
 
 Create Segment
 
-Create a customer segment.  🚧 Limit on static segments  There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment.  🚧 Limit on Active and Passive segments  You can create a maximum of 100 passive and active segments.
+Create a customer segment. <Warning> <Badge color yellow>Limit on static segments</Badge> There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update or passive segment instead and use some customer metadata to build this segment. </Warning> <Warning> <Badge color yellow>Limit on Active and Passive segments</Badge> You can create a maximum of 100 passive and active segments. </Warning>
 
 ### Examples
 

data/docs/SpendingReportDailyEntry.md

@@ -0,0 +1,17 @@
+# VoucherifySdk::SpendingReportDailyEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | Identifies the start of the truncated aggregation period (`YYYY-MM-DD`). For `week` this is Monday. For `month` this is the first day. For `quarter` this is the quarter start. | [optional] |
+| **card_definition_id** | **String** | Identifies the card definition (`lcdef_...`). | [optional] |
+| **success** | **Float** | Counts successful spending operations in the period. | [optional] |
+| **success_on_reward** | **Float** | Counts successful reward purchases in the period. | [optional] |
+| **success_on_order** | **Float** | Counts successful order payments in the period. | [optional] |
+| **points** | **Float** | Totals points spent in the period. | [optional] |
+| **points_on_rewards** | **Float** | Totals points spent on reward purchases in the period. | [optional] |
+| **points_on_order** | **Float** | Totals points spent on order payments in the period. | [optional] |
+| **amount_on_order** | **Float** | Totals order amount paid with points in the period. | [optional] |
+| **object** | **String** | Object type marker. Always `spending_daily_report`. | [optional][default to 'spending_daily_report'] |
+

data/docs/SpendingReportListFilters.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::SpendingReportListFilters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **junction** | **String** | Joins the field filters. Allowed values are `AND` and `OR`. Defaults to `AND`. | [optional] |
+| **card_definition_id** | [**ReportCardDefinitionIdFilterConditions**](ReportCardDefinitionIdFilterConditions.md) |  | [optional] |
+

data/docs/SpendingReportSummaryEntry.md

@@ -0,0 +1,17 @@
+# VoucherifySdk::SpendingReportSummaryEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Identifies the summary row (`lssum_...`). | [optional] |
+| **card_definition_id** | **String** | Identifies the card definition (`lcdef_...`). | [optional] |
+| **success** | **Float** | Counts successful spending operations. | [optional] |
+| **success_on_reward** | **Float** | Counts successful reward purchases. | [optional] |
+| **success_on_order** | **Float** | Counts successful order payments. | [optional] |
+| **points** | **Float** | Totals points spent. | [optional] |
+| **points_on_rewards** | **Float** | Totals points spent on reward purchases. | [optional] |
+| **points_on_order** | **Float** | Totals points spent on order payments. | [optional] |
+| **amount_on_order** | **Float** | Totals order amount paid with points. | [optional] |
+| **object** | **String** | Object type marker. Always `spending_summary_report`. | [optional][default to 'spending_summary_report'] |
+