voucherify 5.0.1 → 6.0.0

data/docs/ClientSideApi.md

@@ -5,9 +5,9 @@ All URIs are relative to *https://api.voucherify.io*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**check_eligibility_client_side**](ClientSideApi.md#check_eligibility_client_side) | **POST** /client/v1/qualifications | Check Eligibility (client-side) |
+| [**list_promotion_tiers_client_side**](ClientSideApi.md#list_promotion_tiers_client_side) | **GET** /client/v1/promotions/tiers | List Promotion Tiers (client-side) |
 | [**redeem_stacked_discounts_client_side**](ClientSideApi.md#redeem_stacked_discounts_client_side) | **POST** /client/v1/redemptions | Redeem Stackable Discounts (client-side) |
 | [**track_custom_event_client_side**](ClientSideApi.md#track_custom_event_client_side) | **POST** /client/v1/events | Track Custom Event (client-side) |
-| [**update_customers_consents_client_side**](ClientSideApi.md#update_customers_consents_client_side) | **PUT** /client/v1/customers/{customerId}/consents | Update Customer's consents (client-side) |
 | [**validate_stacked_discounts_client_side**](ClientSideApi.md#validate_stacked_discounts_client_side) | **POST** /client/v1/validations | Validate Stackable Discounts (client-side) |
 
 
@@ -71,13 +71,13 @@ end
 - **Accept**: application/json
 
 
-## redeem_stacked_discounts_client_side
+## list_promotion_tiers_client_side
 
-> <ClientRedemptionsRedeemResponseBody> redeem_stacked_discounts_client_side(origin, opts)
+> <ClientPromotionsTiersListResponseBody> list_promotion_tiers_client_side(origin, opts)
 
-Redeem Stackable Discounts (client-side)
+List Promotion Tiers (client-side)
 
-This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:    📘 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.
+This method enables you to list promotion tiers.
 
 ### Examples
 
@@ -100,15 +100,18 @@ end
 api_instance = VoucherifySdk::ClientSideApi.new
 origin = 'origin_example' # String | Indicates the origin (scheme, hostname, and port).
 opts = {
-  client_redemptions_redeem_request_body: VoucherifySdk::ClientRedemptionsRedeemRequestBody.new({redeemables: [VoucherifySdk::RedeemGiftCard.new({object: 'voucher', id: 'id_example'})]}) # ClientRedemptionsRedeemRequestBody | 
+  is_available: true, # Boolean | This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions.
+  limit: 56, # Integer | Limits the number of objects to be returned. The limit can range between 1 and 100 items.
+  page: 56, # Integer | Which page of results to return. The lowest value is 1.
+  order: VoucherifySdk::ParameterOrderListPromotionTiersClientSide::CREATED_AT # ParameterOrderListPromotionTiersClientSide | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
 }
 
 begin
-  # Redeem Stackable Discounts (client-side)
-  result = api_instance.redeem_stacked_discounts_client_side(origin, opts)
+  # List Promotion Tiers (client-side)
+  result = api_instance.list_promotion_tiers_client_side(origin, opts)
   p result
 rescue VoucherifySdk::ApiError => e
-  puts "Error when calling ClientSideApi->redeem_stacked_discounts_client_side: #{e}"
+  puts "Error when calling ClientSideApi->list_promotion_tiers_client_side: #{e}"
 end
 ```
 
@@ -117,11 +120,14 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **origin** | **String** | Indicates the origin (scheme, hostname, and port). |  |
-| **client_redemptions_redeem_request_body** | [**ClientRedemptionsRedeemRequestBody**](ClientRedemptionsRedeemRequestBody.md) |  | [optional] |
+| **is_available** | **Boolean** | This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions. | [optional] |
+| **limit** | **Integer** | Limits the number of objects to be returned. The limit can range between 1 and 100 items. | [optional] |
+| **page** | **Integer** | Which page of results to return. The lowest value is 1. | [optional] |
+| **order** | [**ParameterOrderListPromotionTiersClientSide**](.md) | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
 
 ### Return type
 
-[**ClientRedemptionsRedeemResponseBody**](ClientRedemptionsRedeemResponseBody.md)
+[**ClientPromotionsTiersListResponseBody**](ClientPromotionsTiersListResponseBody.md)
 
 ### Authorization
 
@@ -129,17 +135,17 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
-## track_custom_event_client_side
+## redeem_stacked_discounts_client_side
 
-> <ClientEventsCreateResponseBody> track_custom_event_client_side(origin, opts)
+> <ClientRedemptionsRedeemResponseBody> redeem_stacked_discounts_client_side(origin, opts)
 
-Track Custom Event (client-side)
+Redeem Stackable Discounts (client-side)
 
-To track a custom event, you create an event object.   The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created.
+This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications. # How API returns calculated discounts and order amounts in the response In the table below, you can see the logic the API follows to calculate discounts and amounts:    📘 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.
 
 ### Examples
 
@@ -162,15 +168,15 @@ end
 api_instance = VoucherifySdk::ClientSideApi.new
 origin = 'origin_example' # String | Indicates the origin (scheme, hostname, and port).
 opts = {
-  client_events_create_request_body: VoucherifySdk::ClientEventsCreateRequestBody.new({event: 'event_example', customer: VoucherifySdk::Customer.new}) # ClientEventsCreateRequestBody | Specify the details of the custom event.
+  client_redemptions_redeem_request_body: VoucherifySdk::ClientRedemptionsRedeemRequestBody.new # ClientRedemptionsRedeemRequestBody | 
 }
 
 begin
-  # Track Custom Event (client-side)
-  result = api_instance.track_custom_event_client_side(origin, opts)
+  # Redeem Stackable Discounts (client-side)
+  result = api_instance.redeem_stacked_discounts_client_side(origin, opts)
   p result
 rescue VoucherifySdk::ApiError => e
-  puts "Error when calling ClientSideApi->track_custom_event_client_side: #{e}"
+  puts "Error when calling ClientSideApi->redeem_stacked_discounts_client_side: #{e}"
 end
 ```
 
@@ -179,11 +185,11 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **origin** | **String** | Indicates the origin (scheme, hostname, and port). |  |
-| **client_events_create_request_body** | [**ClientEventsCreateRequestBody**](ClientEventsCreateRequestBody.md) | Specify the details of the custom event. | [optional] |
+| **client_redemptions_redeem_request_body** | [**ClientRedemptionsRedeemRequestBody**](ClientRedemptionsRedeemRequestBody.md) |  | [optional] |
 
 ### Return type
 
-[**ClientEventsCreateResponseBody**](ClientEventsCreateResponseBody.md)
+[**ClientRedemptionsRedeemResponseBody**](ClientRedemptionsRedeemResponseBody.md)
 
 ### Authorization
 
@@ -195,13 +201,13 @@ end
 - **Accept**: application/json
 
 
-## update_customers_consents_client_side
+## track_custom_event_client_side
 
-> update_customers_consents_client_side(customer_id, opts)
+> <ClientEventsCreateResponseBody> track_custom_event_client_side(origin, opts)
 
-Update Customer's consents (client-side)
+Track Custom Event (client-side)
 
-Update marketing permissions for the specified customer.
+To track a custom event, you create an event object.   The event object must be linked to the customer who performs the action. If a customer doesnt exist in Voucherify, the customer will be created.
 
 ### Examples
 
@@ -222,16 +228,17 @@ VoucherifySdk.configure do |config|
 end
 
 api_instance = VoucherifySdk::ClientSideApi.new
-customer_id = 'customer_id_example' # String | A Voucherify customer identifier or source_id
+origin = 'origin_example' # String | Indicates the origin (scheme, hostname, and port).
 opts = {
-  body: { ... } # Object | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value.   ## Examples  Opt-out from all communication: 
+  client_events_create_request_body: VoucherifySdk::ClientEventsCreateRequestBody.new({customer: VoucherifySdk::Customer.new}) # ClientEventsCreateRequestBody | Specify the details of the custom event.
 }
 
 begin
-  # Update Customer's consents (client-side)
-  api_instance.update_customers_consents_client_side(customer_id, opts)
+  # Track Custom Event (client-side)
+  result = api_instance.track_custom_event_client_side(origin, opts)
+  p result
 rescue VoucherifySdk::ApiError => e
-  puts "Error when calling ClientSideApi->update_customers_consents_client_side: #{e}"
+  puts "Error when calling ClientSideApi->track_custom_event_client_side: #{e}"
 end
 ```
 
@@ -239,12 +246,12 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **customer_id** | **String** | A Voucherify customer identifier or source_id |  |
-| **body** | **Object** | Key-value pairs where the key is the consent identifier and value is a boolean that identifies if a customer has given the consent or not. To deny all consents use unsubscribed as a consent identifier and true as its value.   ## Examples  Opt-out from all communication:  | [optional] |
+| **origin** | **String** | Indicates the origin (scheme, hostname, and port). |  |
+| **client_events_create_request_body** | [**ClientEventsCreateRequestBody**](ClientEventsCreateRequestBody.md) | Specify the details of the custom event. | [optional] |
 
 ### Return type
 
-nil (empty response body)
+[**ClientEventsCreateResponseBody**](ClientEventsCreateResponseBody.md)
 
 ### Authorization
 
@@ -253,7 +260,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## validate_stacked_discounts_client_side
@@ -285,7 +292,7 @@ end
 api_instance = VoucherifySdk::ClientSideApi.new
 origin = 'origin_example' # String | Indicates the origin (scheme, hostname, and port).
 opts = {
-  client_validations_validate_request_body: VoucherifySdk::ClientValidationsValidateRequestBody.new({redeemables: [VoucherifySdk::RedeemGiftCard.new({object: 'voucher', id: 'id_example'})]}) # ClientValidationsValidateRequestBody | 
+  client_validations_validate_request_body: VoucherifySdk::ClientValidationsValidateRequestBody.new # ClientValidationsValidateRequestBody | 
 }
 
 begin

data/docs/ClientValidationsValidateRequestBody.md

@@ -4,11 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redeemables** | [**Array<StackableValidateRedeemBaseRedeemablesItem>**](StackableValidateRedeemBaseRedeemablesItem.md) | An array of redeemables. You can combine `voucher`(s) and `promotion_tier`(s). Alternatively, send one unique`promotion_stack` in the array. |  |
+| **options** | [**ClientValidationsValidateRequestBodyOptions**](ClientValidationsValidateRequestBodyOptions.md) |  | [optional] |
+| **redeemables** | [**Array<ClientValidationsValidateRequestBodyRedeemablesItem>**](ClientValidationsValidateRequestBodyRedeemablesItem.md) |  | [optional] |
 | **order** | [**Order**](Order.md) |  | [optional] |
 | **customer** | [**Customer**](Customer.md) |  | [optional] |
 | **session** | [**Session**](Session.md) |  | [optional] |
 | **tracking_id** | **String** | Is correspondent to Customer's source_id | [optional] |
 | **metadata** | **Object** | A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format. | [optional] |
-| **options** | [**ClientValidationsValidateRequestBodyAllOfOptions**](ClientValidationsValidateRequestBodyAllOfOptions.md) |  | [optional] |
 

data/docs/ClientValidationsValidateRequestBodyOptions.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientValidationsValidateRequestBodyOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expand** | **Array<String>** | The expand array lets you configure the parameters 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. | | [\"category\"] | - Returns an expanded `categories` object, showing details about the category. | | [optional] |
+

data/docs/ClientValidationsValidateRequestBodyRedeemablesItem.md

@@ -0,0 +1,11 @@
+# VoucherifySdk::ClientValidationsValidateRequestBodyRedeemablesItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+| **gift** | [**ClientValidationsValidateRequestBodyRedeemablesItemGift**](ClientValidationsValidateRequestBodyRedeemablesItemGift.md) |  | [optional] |
+| **reward** | [**ClientValidationsValidateRequestBodyRedeemablesItemReward**](ClientValidationsValidateRequestBodyRedeemablesItemReward.md) |  | [optional] |
+

data/docs/ClientValidationsValidateRequestBodyRedeemablesItemGift.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientValidationsValidateRequestBodyRedeemablesItemGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credits** | **Integer** | The number of credits that the user wants to use from the gift card to fulfill the order. The value of credits cannot be higher than the current balance on the gift card. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
+

data/docs/ClientValidationsValidateRequestBodyRedeemablesItemReward.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::ClientValidationsValidateRequestBodyRedeemablesItemReward
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique reward ID assigned by Voucherify. The reward must be assigned to the campaign in order for the user to be able to use the reward. | [optional] |
+| **points** | **Integer** | The number of loyalty points that the user wants to spend in order to fulfill the order using a **pay with points** reward. The number of points cannot be higher than the current balance on the loyalty card. | [optional] |
+

data/docs/ClientValidationsValidateResponseBody.md

@@ -4,11 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **valid** | **Boolean** | The result of the validation. It takes all of the redeemables into account and returns a `false` if at least one redeemable is inapplicable. Returns `true` if all redeemables are applicable. |  |
-| **redeemables** | [**Array<ValidationsValidateAllResponseBodyRedeemablesItem>**](ValidationsValidateAllResponseBodyRedeemablesItem.md) | Lists validation results of each redeemable. If redeemables_application_mode=\"PARTIAL\" all redeemables here will be \"APPLICABLE\" |  |
-| **skipped_redeemables** | [**Array<ValidationsRedeemableInapplicable>**](ValidationsRedeemableInapplicable.md) | Lists validation results of each skipped redeemable. | [optional] |
+| **valid** | **Boolean** | The result of the validation. It takes all of the redeemables into account and returns a `false` if at least one redeemable is inapplicable. Returns `true` if all redeemables are applicable. | [optional] |
+| **redeemables** | [**Array<ClientValidationsValidateResponseBodyRedeemablesItem>**](ClientValidationsValidateResponseBodyRedeemablesItem.md) |  | [optional] |
+| **skipped_redeemables** | [**Array<ValidationsRedeemableSkipped>**](ValidationsRedeemableSkipped.md) | Lists validation results of each skipped redeemable. | [optional] |
 | **inapplicable_redeemables** | [**Array<ValidationsRedeemableInapplicable>**](ValidationsRedeemableInapplicable.md) | Lists validation results of each inapplicable redeemable. | [optional] |
 | **order** | [**OrderCalculated**](OrderCalculated.md) |  | [optional] |
 | **tracking_id** | **String** | Hashed customer source ID. | [optional] |
 | **session** | [**Session**](Session.md) |  | [optional] |
+| **stacking_rules** | [**StackingRules**](StackingRules.md) |  |  |
 

data/docs/ClientValidationsValidateResponseBodyRedeemablesItem.md

@@ -0,0 +1,16 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **id** | **String** | Redeemable ID, i.e. the voucher code. | [optional] |
+| **object** | **String** | Redeemable's object type. | [optional] |
+| **order** | [**OrderCalculated**](OrderCalculated.md) |  | [optional] |
+| **applicable_to** | [**ApplicableToResultList**](ApplicableToResultList.md) |  | [optional] |
+| **inapplicable_to** | [**InapplicableToResultList**](InapplicableToResultList.md) |  | [optional] |
+| **result** | [**ClientValidationsValidateResponseBodyRedeemablesItemResult**](ClientValidationsValidateResponseBodyRedeemablesItemResult.md) |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **categories** | [**Array<Category>**](Category.md) |  | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResult.md

@@ -0,0 +1,12 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **discount** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md) |  | [optional] |
+| **gift** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultGift**](ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md) |  | [optional] |
+| **loyalty_card** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard**](ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **details** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDetails**](ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md) |  | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDetails.md

@@ -0,0 +1,9 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResultDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount.md

@@ -0,0 +1,24 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **amount_off** | **Float** | Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. | [optional] |
+| **amount_off_formula** | **String** |  | [optional] |
+| **aggregated_amount_limit** | **Integer** | Maximum discount amount per order. | [optional] |
+| **effect** | **String** |  | [optional] |
+| **is_dynamic** | **Boolean** | Flag indicating whether the discount was calculated using a formula. | [optional] |
+| **unit_off** | **Integer** | Number of units to be granted a full value discount. | [optional] |
+| **unit_off_formula** | **String** |  | [optional] |
+| **unit_type** | **String** | The product deemed as free, chosen from product inventory (e.g. time, items). | [optional] |
+| **product** | [**ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct**](ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md) |  | [optional] |
+| **sku** | [**SimpleSkuDiscountUnit**](SimpleSkuDiscountUnit.md) |  | [optional] |
+| **units** | [**Array<DiscountUnitMultipleOneUnit>**](DiscountUnitMultipleOneUnit.md) |  | [optional] |
+| **percent_off** | **Float** | The percent discount that the customer will receive. | [optional] |
+| **percent_off_formula** | **String** |  | [optional] |
+| **amount_limit** | **Float** | Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600. | [optional] |
+| **fixed_amount** | **Float** | Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value. | [optional] |
+| **fixed_amount_formula** | **String** |  | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique product ID, assigned by Voucherify. | [optional] |
+| **source_id** | **String** | Product's source ID. | [optional] |
+| **name** | **String** | Product name. | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultGift.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResultGift
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credits** | **Integer** | Total number of gift card credits to be applied in the redemption expressed as the smallest currency unit (e.g. 100 cents for $1.00). | [optional] |
+

data/docs/ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard.md

@@ -0,0 +1,8 @@
+# VoucherifySdk::ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **points** | **Integer** | Total number of loyalty points to be applied in the redemption. | [optional] |
+

data/docs/CodeConfig.md

@@ -9,5 +9,5 @@
 | **prefix** | **String** | A text appended before the code. | [optional] |
 | **postfix** | **String** | A text appended after the code. | [optional] |
 | **pattern** | **String** | A pattern for codes where hashes (#) will be replaced with random characters. Overrides `length`. | [optional] |
-| **initial_count** | **Integer** | The initial count | [optional] |
+| **initial_count** | **Integer** | Internal value, does not change anything if provided. | [optional] |
 

data/docs/CreatePublicationCampaign.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of voucher's parent campaign or unique campaign ID that was assigned by Voucherify. |  |
+| **name** | **String** | Name of voucher's parent campaign or unique campaign ID that was assigned by Voucherify. | [optional] |
 | **count** | **Integer** | Number of vouchers to be published to customer. | [optional] |
 

data/docs/Customer.md

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

data/docs/CustomerActivity.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Unique event ID, assigned by Voucherify. | [optional] |
 | **type** | **String** | Event type. | [optional] |
-| **data** | [**Array<CustomerActivityData>**](CustomerActivityData.md) | Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type. | [optional] |
+| **data** | **Object** | Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type. | [optional] |
 | **created_at** | **Time** | Timestamp representing the date and time when the customer activity occurred in ISO 8601 format. | [optional] |
+| **group_id** | **String** | Unique identifier of the request that caused the event. | [optional] |
 

data/docs/CustomerAddress.md

@@ -0,0 +1,13 @@
+# VoucherifySdk::CustomerAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city** | **String** | City | [optional] |
+| **state** | **String** | State | [optional] |
+| **line_1** | **String** | First line of address. | [optional] |
+| **line_2** | **String** | Second line of address. | [optional] |
+| **country** | **String** | Country. | [optional] |
+| **postal_code** | **String** | Postal code. | [optional] |
+

data/docs/CustomerId.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | A unique identifier of an existing customer. |  |
-| **object** | **String** | The type of object represented by JSON. | [default to 'customer'] |
+| **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/CustomerLoyalty.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **points** | **Integer** | Customer's loyalty points. |  |
-| **referred_customers** | **Integer** | Total number of customers referred by the customer. |  |
-| **campaigns** | [**Hash<String, CustomerLoyaltyCampaignsValue>**](CustomerLoyaltyCampaignsValue.md) | Contains campaigns with details about point balances and how many customers were referred by the customer. |  |
+| **points** | **Integer** | Customer's loyalty points. | [optional] |
+| **referred_customers** | **Integer** | Total number of customers referred by the customer. | [optional] |
+| **campaigns** | [**Hash<String, CustomerLoyaltyCampaignsEntry>**](CustomerLoyaltyCampaignsEntry.md) | Contains campaigns with details about point balances and how many customers were referred by the customer. | [optional] |
 

data/docs/CustomerLoyaltyCampaignsEntry.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CustomerLoyaltyCampaignsEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **points** | **Integer** | Remaining point balance in campaign. | [optional] |
+| **loyalty_tier** | **String** | Customer's loyalty tier within the campaign. | [optional] |
+| **referred_customers** | **Integer** | Number of customers referred by the customer in campaign. | [optional] |
+

data/docs/CustomerRedeemable.md

@@ -0,0 +1,17 @@
+# VoucherifySdk::CustomerRedeemable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique redeemable holder identifier. | [optional] |
+| **created_at** | **Time** | Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format. | [optional] |
+| **redeemable_id** | **String** | Identifier of the redeemable item. | [optional] |
+| **redeemable_object** | **String** | Type of the redeemable. | [optional] |
+| **customer_id** | **String** | Identifier of the customer. | [optional] |
+| **holder_role** | **String** | Role of the holder. | [optional][default to 'OWNER'] |
+| **campaign_id** | **String** | Unique campaign identifier, assigned by Voucherify. | [optional] |
+| **campaign_type** | **String** | Defines the type of the campaign. | [optional][default to 'DISCOUNT_COUPONS'] |
+| **voucher_type** | **String** | Defines the type of the voucher. | [optional][default to 'DISCOUNT_VOUCHER'] |
+| **redeemable** | [**CustomerRedeemableRedeemable**](CustomerRedeemableRedeemable.md) |  | [optional] |
+

data/docs/CustomerRedeemableRedeemable.md

@@ -0,0 +1,10 @@
+# VoucherifySdk::CustomerRedeemableRedeemable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Type of the redeemable. | [optional] |
+| **voucher** | [**RedeemableVoucher**](RedeemableVoucher.md) |  |  |
+| **status** | **String** | Status of the redeemable. | [optional][default to 'ACTIVE'] |
+

data/docs/CustomerReferrals.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **total** | **Integer** | Total number of times this customer received a referral, i.e. was referred by another customer. |  |
-| **campaigns** | [**Array<CustomerReferralsCampaignsItem>**](CustomerReferralsCampaignsItem.md) | Contains an array of campaigns that served as the source of a referral for the customer. |  |
+| **total** | **Integer** | Total number of times this customer received a referral, i.e. was referred by another customer. | [optional] |
+| **campaigns** | [**Array<CustomerReferralsCampaignsItem>**](CustomerReferralsCampaignsItem.md) | Contains an array of campaigns that served as the source of a referral for the customer. | [optional] |
 

data/docs/CustomerSummaryOrders.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **total_amount** | **Integer** | The total amount spent by the customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. |  |
-| **total_count** | **Integer** | Total number of orders made by the customer. |  |
-| **average_amount** | **Integer** | Average amount spent on orders. `total_amount` ÷ `total_count`. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. |  |
-| **last_order_amount** | **Integer** | Amount spent on last order. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. |  |
+| **total_amount** | **Integer** | The total amount spent by the customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
+| **total_count** | **Integer** | Total number of orders made by the customer. | [optional] |
+| **average_amount** | **Integer** | Average amount spent on orders. `total_amount` ÷ `total_count`. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
+| **last_order_amount** | **Integer** | Amount spent on last order. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional] |
 | **last_order_date** | **Time** | Timestamp representing the date and time of the customer's last order in ISO 8601 format. | [optional] |
 

data/docs/CustomerSummaryRedemptions.md

@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **total_redeemed** | **Integer** | Total number of redemptions made by the customer. |  |
-| **total_failed** | **Integer** | Total number of redemptions that failed. |  |
-| **total_succeeded** | **Integer** | Total number of redemptions that succeeded. |  |
-| **total_rolled_back** | **Integer** | Total number of redemptions that were rolled back for the customer. |  |
-| **total_rollback_failed** | **Integer** | Total number of redemption rollbacks that failed. |  |
-| **total_rollback_succeeded** | **Integer** | Total number of redemption rollbacks that succeeded. |  |
-| **gift** | [**CustomerSummaryRedemptionsGift**](CustomerSummaryRedemptionsGift.md) |  |  |
-| **loyalty_card** | [**CustomerSummaryRedemptionsLoyaltyCard**](CustomerSummaryRedemptionsLoyaltyCard.md) |  |  |
+| **total_redeemed** | **Integer** | Total number of redemptions made by the customer. | [optional] |
+| **total_failed** | **Integer** | Total number of redemptions that failed. | [optional] |
+| **total_succeeded** | **Integer** | Total number of redemptions that succeeded. | [optional] |
+| **total_rolled_back** | **Integer** | Total number of redemptions that were rolled back for the customer. | [optional] |
+| **total_rollback_failed** | **Integer** | Total number of redemption rollbacks that failed. | [optional] |
+| **total_rollback_succeeded** | **Integer** | Total number of redemption rollbacks that succeeded. | [optional] |
+| **gift** | [**CustomerSummaryRedemptionsGift**](CustomerSummaryRedemptionsGift.md) |  | [optional] |
+| **loyalty_card** | [**CustomerSummaryRedemptionsLoyaltyCard**](CustomerSummaryRedemptionsLoyaltyCard.md) |  | [optional] |
 

data/docs/CustomerSummaryRedemptionsGift.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redeemed_amount** | **Integer** | Total amount of gift card credits redeemed by customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [default to 0] |
-| **amount_to_go** | **Integer** | Remaining gift card balance across all gift cards. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [default to 0] |
+| **redeemed_amount** | **Integer** | Total amount of gift card credits redeemed by customer. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional][default to 0] |
+| **amount_to_go** | **Integer** | Remaining gift card balance across all gift cards. Value is multiplied by 100 to precisely represent 2 decimal places. For example `10000 cents` for `$100.00`. | [optional][default to 0] |
 

data/docs/CustomerSummaryRedemptionsLoyaltyCard.md

@@ -4,6 +4,6 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **redeemed_points** | **Integer** | Total number of loyalty points redeemed by the customer. |  |
-| **points_to_go** | **Integer** | Sum of remaining available point balance across all loyalty cards. |  |
+| **redeemed_points** | **Integer** | Total number of loyalty points redeemed by the customer. | [optional] |
+| **points_to_go** | **Integer** | Sum of remaining available point balance across all loyalty cards. | [optional] |