talon_one 4.0.0 → 6.0.0

data/docs/MessageLogEntry.md

@@ -12,8 +12,7 @@ Name | Type | Description | Notes
 **request** | [**MessageLogRequest**](MessageLogRequest.md) |  | [optional] 
 **response** | [**MessageLogResponse**](MessageLogResponse.md) |  | [optional] 
 **created_at** | **DateTime** | Timestamp when the log entry was created. | 
-**entity_type** | **String** | The entity type the log is related to.  | [optional] 
-**url** | **String** | The target URL of the request. | [optional] 
+**entity_type** | **String** | The entity type the notification is related to.  | [optional] 
 **application_id** | **Integer** | Identifier of the Application. | [optional] 
 **loyalty_program_id** | **Integer** | Identifier of the loyalty program. | [optional] 
 
@@ -31,7 +30,6 @@ instance = TalonOne::MessageLogEntry.new(id: 123e4567-e89b-12d3-a456-42661417400
                                  response: null,
                                  created_at: 2021-07-20T22:00Z,
                                  entity_type: loyalty_program,
-                                 url: www.my-company.com/my-endpoint-name,
                                  application_id: 5,
                                  loyalty_program_id: 2)
 ```

data/docs/MessageLogResponse.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**created_at** | **DateTime** | Timestamp when the response was received. | 
-**response** | **String** | Raw response data. | 
-**status** | **Integer** | HTTP status code of the response. | 
+**created_at** | **DateTime** | Timestamp when the response was received. | [optional] 
+**response** | **String** | Raw response data. | [optional] 
+**status** | **Integer** | HTTP status code of the response. | [optional] 
 
 ## Code Sample
 

data/docs/NewAppWideCouponDeletionJob.md

@@ -0,0 +1,19 @@
+# TalonOne::NewAppWideCouponDeletionJob
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) |  | 
+**campaignids** | **Array<Integer>** |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAppWideCouponDeletionJob.new(filters: null,
+                                 campaignids: null)
+```
+
+

data/docs/NewApplication.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional] 
 **default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect.  | [optional] 
 **key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits). | [optional] 
+**enable_campaign_state_management** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application.  **Important:** After this feature is enabled, it cannot be disabled.  | [optional] 
 
 ## Code Sample
 
@@ -39,7 +40,8 @@ instance = TalonOne::NewApplication.new(name: My Application,
                                  sandbox: null,
                                  enable_partial_discounts: false,
                                  default_discount_additional_cost_per_item_scope: null,
-                                 key: null)
+                                 key: null,
+                                 enable_campaign_state_management: false)
 ```
 
 

data/docs/NewApplicationCIF.md

@@ -0,0 +1,27 @@
+# TalonOne::NewApplicationCIF
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the Application cart item filter used in API requests. | 
+**description** | **String** | A short description of the Application cart item filter. | [optional] 
+**active_expression_id** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional] 
+**modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewApplicationCIF.new(name: Filter items by product,
+                                 description: This filter allows filtering by shoes,
+                                 active_expression_id: 1,
+                                 modified_by: 334,
+                                 created_by: 216,
+                                 modified: null)
+```
+
+

data/docs/NewApplicationCIFExpression.md

@@ -0,0 +1,21 @@
+# TalonOne::NewApplicationCIFExpression
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional] 
+**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional] 
+**expression** | **Array<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewApplicationCIFExpression.new(cart_item_filter_id: 216,
+                                 created_by: 216,
+                                 expression: {expr=[filter, [., Session, CartItems], [[Item], [catch, false, [=, [., Item, Category], Kitchen]]]]})
+```
+
+

data/docs/NewBaseNotification.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**policy** | [**Object**](.md) |  | 
+**policy** | [**Object**](.md) | Indicates which notification properties to apply. | 
 **enabled** | **Boolean** | Indicates whether the notification is activated. | [optional] [default to true]
 **webhook** | [**NewNotificationWebhook**](NewNotificationWebhook.md) |  | 
 

data/docs/NewCouponCreationJob.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. | 
 **coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with coupons. | 

data/docs/NewCouponDeletionJob.md

@@ -0,0 +1,17 @@
+# TalonOne::NewCouponDeletionJob
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filters** | [**CouponDeletionFilters**](CouponDeletionFilters.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCouponDeletionJob.new(filters: null)
+```
+
+

data/docs/NewCoupons.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign.  **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.  | [optional] 
 **number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. Must be at least 1. | 
 **unique_prefix** | **String** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint.  | [optional] 
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional] 
 **valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression.  | [optional] 
 **coupon_pattern** | **String** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set.  | [optional] 
-**is_reservation_mandatory** | **Boolean** | Whether the reservation effect actually created a new reservation. | [optional] [default to false]
+**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
 **implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional] 
 
 ## Code Sample

data/docs/NewCouponsForMultipleRecipients.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value.  | [optional] 
 **reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional] 
 **recipients_integration_ids** | **Array<String>** | The integration IDs for recipients. | 
 **valid_characters** | **Array<String>** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression.  | [optional] 

data/docs/NewCustomerSessionV2.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **profile_id** | **String** | ID of the customer profile set by your integration layer.  **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.  | [optional] 
 **store_integration_id** | **String** | The integration ID of the store. You choose this ID when you create a store. | [optional] 
 **evaluable_campaign_ids** | **Array<Integer>** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine.  These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.  | [optional] 
-**coupon_codes** | **Array<String>** | Any coupon codes entered.  **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it.  | [optional] 
-**referral_code** | **String** | Any referral code entered.  **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it.  | [optional] 
+**coupon_codes** | **Array<String>** | Any coupon codes entered.  **Important - for requests only**:  - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely.  | [optional] 
+**referral_code** | **String** | Any referral code entered.  **Important - for requests only**:  - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely.  | [optional] 
 **loyalty_cards** | **Array<String>** | Identifier of a loyalty card. | [optional] 
 **state** | **String** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are:  1. `open` → `closed` 2. `open` → `cancelled` 3. Either:    - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or    - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems))    - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled`  For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).  | [optional] [default to 'open']
 **cart_items** | [**Array<CartItem>**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request.  | [optional] 

data/docs/NewExternalInvitation.md

@@ -0,0 +1,21 @@
+# TalonOne::NewExternalInvitation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the user. | [optional] 
+**user_groups** | **Array<String>** | List of user groups in the external identity provider.  If there are roles in Talon.One whose names match these user groups, those roles will be automatically assigned to the user upon invitation.  | [optional] 
+**email** | **String** | Email address of the user. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewExternalInvitation.new(name: John Doe,
+                                 user_groups: [Managers, Customer support],
+                                 email: john.doe@example.com)
+```
+
+

data/docs/NewLoyaltyProgram.md

@@ -12,10 +12,12 @@ Name | Type | Description | Notes
 **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | 
 **users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.  | [optional] 
 **sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | 
-**tiers_expiration_policy** | **String** | The policy that defines which date is used to calculate the expiration date of a customer's current tier.  - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier.  - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program.  | [optional] 
-**tiers_expire_in** | **String** | The amount of time after which the tier expires.  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** | Customers's tier downgrade policy.  - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down.  - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant.  | [optional] 
 **program_join_policy** | **String** | The policy that defines when the customer joins the loyalty program.   - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points.       **Note**: The customer does not have a program join date.   - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time.   - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time.  | [optional] 
+**tiers_expiration_policy** | **String** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined.  - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier.  - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program.  - `customer_attribute`: The tier expiration is determined by a custom customer attribute.  - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`.  | [optional] 
+**tier_cycle_start_date** | **DateTime** | Timestamp at which the tier cycle starts for all customers in the loyalty program.  **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`.  | [optional] 
+**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] 
 **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | 
 **tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] 
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
@@ -34,10 +36,12 @@ instance = TalonOne::NewLoyaltyProgram.new(title: Point collection,
                                  allow_subledger: false,
                                  users_per_card_limit: 111,
                                  sandbox: true,
+                                 program_join_policy: null,
                                  tiers_expiration_policy: null,
+                                 tier_cycle_start_date: 2021-09-12T10:12:42Z,
                                  tiers_expire_in: 27W_U,
                                  tiers_downgrade_policy: null,
-                                 program_join_policy: null,
+                                 card_code_settings: null,
                                  name: GeneralPointCollection,
                                  tiers: null,
                                  timezone: null,

data/docs/NewOutgoingIntegrationWebhook.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **String** | Webhook title. | 
+**description** | **String** | A description of the webhook. | [optional] 
 **application_ids** | **Array<Integer>** | IDs of the Applications to which a webhook must be linked. | 
 
 ## Code Sample
@@ -13,6 +14,7 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::NewOutgoingIntegrationWebhook.new(title: Send email to customer via Braze,
+                                 description: A webhook to send a coupon to the user.,
                                  application_ids: [1, 2, 3])
 ```
 

data/docs/NewReferral.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 
 **usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | [optional] 
 **campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
 **advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 

data/docs/NewReferralsForMultipleAdvocates.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 
 **usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | 
 **campaign_id** | **Integer** | The ID of the campaign from which the referral received the referral code. | 
 **advocate_profile_integration_ids** | **Array<String>** | An array containing all the respective advocate profiles. | 

data/docs/NewRevisionVersion.md

@@ -0,0 +1,37 @@
+# TalonOne::NewRevisionVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A user-facing name for this campaign. | [optional] 
+**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional] 
+**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] 
+**description** | **String** | A detailed description of the campaign. | [optional] 
+**active_ruleset_id** | **Integer** | The ID of the ruleset this campaign template will use. | [optional] 
+**tags** | **Array<String>** | A list of tags for the campaign template. | [optional] 
+**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] 
+**features** | **Array<String>** | A list of features for the campaign template. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewRevisionVersion.new(name: Summer promotions,
+                                 start_time: 2021-07-20T22:00Z,
+                                 end_time: 2021-09-22T22:00Z,
+                                 attributes: null,
+                                 description: Campaign for all summer 2021 promotions,
+                                 active_ruleset_id: 5,
+                                 tags: null,
+                                 coupon_settings: null,
+                                 referral_settings: null,
+                                 limits: null,
+                                 features: null)
+```
+
+

data/docs/NewWebhook.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_ids** | **Array<Integer>** | The IDs of the Applications that are related to this entity. | 
 **title** | **String** | Name or title for this webhook. | 
+**description** | **String** | A description of the webhook. | [optional] 
 **verb** | **String** | API method for this webhook. | 
 **url** | **String** | API URL (supports templating using parameters) for this webhook. | 
 **headers** | **Array<String>** | List of API HTTP headers for this webhook. | 
@@ -20,6 +21,7 @@ require 'TalonOne'
 
 instance = TalonOne::NewWebhook.new(application_ids: null,
                                  title: Send message,
+                                 description: A webhook to send a coupon to the user.,
                                  verb: POST,
                                  url: www.my-company.com/my-endpoint-name,
                                  headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],

data/docs/OktaEvent.md

@@ -0,0 +1,19 @@
+# TalonOne::OktaEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_type** | **String** | Event type defining an action. | 
+**target** | [**Array<OktaEventTarget>**](OktaEventTarget.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OktaEvent.new(event_type: application.user_membership.add,
+                                 target: null)
+```
+
+

data/docs/OktaEventPayload.md

@@ -0,0 +1,17 @@
+# TalonOne::OktaEventPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**OktaEventPayloadData**](OktaEventPayloadData.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OktaEventPayload.new(data: null)
+```
+
+

data/docs/OktaEventPayloadData.md

@@ -0,0 +1,17 @@
+# TalonOne::OktaEventPayloadData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<OktaEvent>**](OktaEvent.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OktaEventPayloadData.new(events: null)
+```
+
+

data/docs/OktaEventTarget.md

@@ -0,0 +1,21 @@
+# TalonOne::OktaEventTarget
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of the event target. | 
+**alternate_id** | **String** | Identifier of the event target, depending on its type. | 
+**display_name** | **String** | Display name of the event target. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::OktaEventTarget.new(type: AppUser,
+                                 alternate_id: john.doe@example.com,
+                                 display_name: John Doe)
+```
+
+

data/docs/ProjectedTier.md

@@ -0,0 +1,21 @@
+# TalonOne::ProjectedTier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**projected_active_points** | **Float** | The active points of the customer when their current tier expires. | 
+**stay_in_tier_points** | **Float** | The number of points the customer needs to stay in the current tier.  **Note**: This is included in the response when the customer is projected to be downgraded.  | [optional] 
+**projected_tier_name** | **String** | The name of the tier the user will enter once their current tier expires. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ProjectedTier.new(projected_active_points: 198.0,
+                                 stay_in_tier_points: 2.0,
+                                 projected_tier_name: Tier 1)
+```
+
+

data/docs/Referral.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **id** | **Integer** | Internal ID of this entity. | 
 **created** | **DateTime** | The time this entity was created. | 
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 
 **usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | 
 **campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
 **advocate_profile_integration_id** | **String** | The Integration ID of the Advocate's Profile. | 

data/docs/ReferralConstraints.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
-**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
+**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] 
 **usage_limit** | **Integer** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.  | [optional] 
 
 ## Code Sample

data/docs/RejectCouponEffectProps.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **condition_index** | **Integer** | The index of the condition that caused the rejection of the coupon. | [optional] 
 **effect_index** | **Integer** | The index of the effect that caused the rejection of the coupon. | [optional] 
 **details** | **String** | More details about the failure. | [optional] 
+**campaign_exclusion_reason** | **String** | The reason why the campaign was not applied. | [optional] 
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = TalonOne::RejectCouponEffectProps.new(value: null,
                                  rejection_reason: null,
                                  condition_index: null,
                                  effect_index: null,
-                                 details: null)
+                                 details: null,
+                                 campaign_exclusion_reason: CampaignGaveLowerDiscount)
 ```
 
 

data/docs/RejectReferralEffectProps.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **condition_index** | **Integer** | The index of the condition that caused the rejection of the referral. | [optional] 
 **effect_index** | **Integer** | The index of the effect that caused the rejection of the referral. | [optional] 
 **details** | **String** | More details about the failure. | [optional] 
+**campaign_exclusion_reason** | **String** | The reason why the campaign was not applied. | [optional] 
 
 ## Code Sample
 
@@ -19,7 +20,8 @@ instance = TalonOne::RejectReferralEffectProps.new(value: null,
                                  rejection_reason: null,
                                  condition_index: null,
                                  effect_index: null,
-                                 details: null)
+                                 details: null,
+                                 campaign_exclusion_reason: CampaignGaveLowerDiscount)
 ```
 
 

data/docs/Revision.md

@@ -0,0 +1,35 @@
+# TalonOne::Revision
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
+**activate_at** | **DateTime** |  | [optional] 
+**account_id** | **Integer** |  | 
+**application_id** | **Integer** |  | 
+**campaign_id** | **Integer** |  | 
+**created** | **DateTime** |  | 
+**created_by** | **Integer** |  | 
+**activated_at** | **DateTime** |  | [optional] 
+**activated_by** | **Integer** |  | [optional] 
+**current_version** | [**RevisionVersion**](RevisionVersion.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Revision.new(id: 6,
+                                 activate_at: null,
+                                 account_id: null,
+                                 application_id: null,
+                                 campaign_id: null,
+                                 created: null,
+                                 created_by: null,
+                                 activated_at: null,
+                                 activated_by: null,
+                                 current_version: null)
+```
+
+

data/docs/RevisionActivation.md

@@ -0,0 +1,17 @@
+# TalonOne::RevisionActivation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activate_at** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RevisionActivation.new(activate_at: null)
+```
+
+

data/docs/RevisionVersion.md

@@ -0,0 +1,53 @@
+# TalonOne::RevisionVersion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. | 
+**account_id** | **Integer** |  | 
+**application_id** | **Integer** |  | 
+**campaign_id** | **Integer** |  | 
+**created** | **DateTime** |  | 
+**created_by** | **Integer** |  | 
+**revision_id** | **Integer** |  | 
+**version** | **Integer** |  | 
+**name** | **String** | A user-facing name for this campaign. | [optional] 
+**start_time** | **DateTime** | Timestamp when the campaign will become active. | [optional] 
+**end_time** | **DateTime** | Timestamp when the campaign will become inactive. | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] 
+**description** | **String** | A detailed description of the campaign. | [optional] 
+**active_ruleset_id** | **Integer** | The ID of the ruleset this campaign template will use. | [optional] 
+**tags** | **Array<String>** | A list of tags for the campaign template. | [optional] 
+**coupon_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
+**limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] 
+**features** | **Array<String>** | A list of features for the campaign template. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::RevisionVersion.new(id: 6,
+                                 account_id: null,
+                                 application_id: null,
+                                 campaign_id: null,
+                                 created: null,
+                                 created_by: null,
+                                 revision_id: null,
+                                 version: null,
+                                 name: Summer promotions,
+                                 start_time: 2021-07-20T22:00Z,
+                                 end_time: 2021-09-22T22:00Z,
+                                 attributes: null,
+                                 description: Campaign for all summer 2021 promotions,
+                                 active_ruleset_id: 5,
+                                 tags: null,
+                                 coupon_settings: null,
+                                 referral_settings: null,
+                                 limits: null,
+                                 features: null)
+```
+
+