talon_one 7.0.0 → 8.0.0

data/docs/LoyaltyBalanceWithTier.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **pending_points** | **Float** | Total amount of points awarded to this customer but not available until their start date. | [optional] 
 **spent_points** | **Float** | Total amount of points already spent by this customer. | [optional] 
 **expired_points** | **Float** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional] 
+**negative_points** | **Float** | Total amount of negative points. This implies that `activePoints` is `0`. | [optional] 
 **current_tier** | [**Tier**](Tier.md) |  | [optional] 
 **projected_tier** | [**ProjectedTier**](ProjectedTier.md) |  | [optional] 
 **points_to_next_tier** | **Float** | The number of points required to move up a tier. | [optional] 
@@ -22,6 +23,7 @@ instance = TalonOne::LoyaltyBalanceWithTier.new(active_points: 286.0,
                                  pending_points: 50.0,
                                  spent_points: 150.0,
                                  expired_points: 286.0,
+                                 negative_points: 286.0,
                                  current_tier: null,
                                  projected_tier: null,
                                  points_to_next_tier: 20.0,

data/docs/LoyaltyBalances.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyBalances.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}})
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}})
 ```
 
 

data/docs/LoyaltyBalancesWithTiers.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyBalancesWithTiers.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}})
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}})
 ```
 
 

data/docs/LoyaltyCardBalances.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyCardBalances.new(balance: null,
-                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25}},
+                                 subledger_balances: {"mysubledger":{"activePoints":286,"pendingPoints":50,"spentPoints":150,"expiredPoints":25,"negativePoints":0}},
                                  profiles: null)
 ```
 

data/docs/LoyaltyLedger.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltyLedger.new(ledger: null,
-                                 sub_ledgers: {"mysubledger":{"total":0,"totalActivePoints":286,"totalPendingPoints":50,"totalSpentPoints":150,"totalExpiredPoints":25}})
+                                 sub_ledgers: {"mysubledger":{"total":0,"totalActivePoints":286,"totalPendingPoints":50,"totalSpentPoints":150,"totalExpiredPoints":25,"totalNegativePoints":0}})
 ```
 
 

data/docs/LoyaltyLedgerEntry.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **sub_ledger_id** | **String** | This specifies if we are adding loyalty points to the main ledger or a subledger. | 
 **user_id** | **Integer** | This is the ID of the user who created this entry, if the addition or subtraction was done manually. | [optional] 
 **archived** | **Boolean** | Indicates if the entry belongs to the archived session. | [optional] 
+**flags** | [**LoyaltyLedgerEntryFlags**](LoyaltyLedgerEntryFlags.md) |  | [optional] 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = TalonOne::LoyaltyLedgerEntry.new(created: 2021-07-20T22:00Z,
                                  name: Add points on purchase,
                                  sub_ledger_id: mysubledger,
                                  user_id: 499,
-                                 archived: false)
+                                 archived: false,
+                                 flags: null)
 ```
 
 

data/docs/LoyaltyProgram.md

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
 **tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated.  The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`.  Available units:  - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years  You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.  | [optional] 
 **tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation.  - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier.  - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment.  | [optional] 
 **card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
-**return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative.  | [optional] 
+**return_policy** | **String** | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit.  | [optional] 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this program. | 
 **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | 
 **tiers** | [**Array<LoyaltyTier>**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] 

data/docs/LoyaltyProgramBalance.md

@@ -6,10 +6,12 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current_balance** | **Float** | Sum of currently active points. | 
 **pending_balance** | **Float** | Sum of pending points. | 
+**negative_balance** | **Float** | Sum of negative points. This implies that `currentBalance` is `0`. | 
 **expired_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **spent_balance** | **Float** | **DEPRECATED** Value is shown as 0.  | 
 **tentative_current_balance** | **Float** | The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 **tentative_pending_balance** | **Float** | The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | [optional] 
+**tentative_negative_balance** | **Float** | The tentative negative balance after all additions and deductions from the current customer session are applied to `negativeBalance`. When the session is closed, the tentative effects are applied and `negativeBalance` is updated to this value.  **Note:** Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.  | 
 
 ## Code Sample
 
@@ -18,10 +20,12 @@ require 'TalonOne'
 
 instance = TalonOne::LoyaltyProgramBalance.new(current_balance: 100.0,
                                  pending_balance: 10.0,
+                                 negative_balance: 10.0,
                                  expired_balance: 0.0,
                                  spent_balance: 0.0,
                                  tentative_current_balance: 100.0,
-                                 tentative_pending_balance: 20.0)
+                                 tentative_pending_balance: 20.0,
+                                 tentative_negative_balance: 100.0)
 ```
 
 

data/docs/LoyaltySubLedger.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **total_pending_points** | **Float** | Total amount of pending points, which are not active yet but will become active in the future. | 
 **total_spent_points** | **Float** | Total amount of points already spent by this customer. | 
 **total_expired_points** | **Float** | Total amount of points, that expired without ever being spent. | 
+**total_negative_points** | **Float** | Total amount of negative points. This implies that `totalActivePoints` is `0`. | 
 **transactions** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all events that have happened such as additions, subtractions and expiries. | [optional] 
 **expiring_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points that will expire. | [optional] 
 **active_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all currently active points. | [optional] 
@@ -26,6 +27,7 @@ instance = TalonOne::LoyaltySubLedger.new(total: null,
                                  total_pending_points: null,
                                  total_spent_points: null,
                                  total_expired_points: null,
+                                 total_negative_points: null,
                                  transactions: null,
                                  expiring_points: null,
                                  active_points: null,