talon_one 1.4.0 → 2.3.0

data/docs/UpdateApplication.md

@@ -1,6 +1,7 @@
 # TalonOne::UpdateApplication
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of this application. | 
@@ -8,8 +9,35 @@ Name | Type | Description | Notes
 **timezone** | **String** | A string containing an IANA timezone descriptor. | 
 **currency** | **String** | A string describing a default currency for new customer sessions. | 
 **case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+**campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] 
+**exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] 
+**default_discount_scope** | **String** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] 
+**enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
+**enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
 **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**sandbox** | **Boolean** | Flag indicating if this is a live or sandbox application | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateApplication.new(name: null,
+                                 description: null,
+                                 timezone: null,
+                                 currency: null,
+                                 case_sensitivity: null,
+                                 attributes: null,
+                                 limits: null,
+                                 campaign_priority: null,
+                                 exclusive_campaigns_strategy: null,
+                                 default_discount_scope: null,
+                                 enable_cascading_discounts: null,
+                                 enable_flattened_cart_items: null,
+                                 attributes_settings: null,
+                                 sandbox: null)
+```
 
 

data/docs/UpdateAttributeEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::UpdateAttributeEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** | The exact path of the attribute that was updated | 
+**value** | [**Object**](.md) | The new value of this attribute. Value can be any of the following types (time, string, number, location, boolean) or a list of any of those types | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateAttributeEffectProps.new(path: null,
+                                 value: null)
+```
+
+

data/docs/UpdateAudience.md

@@ -0,0 +1,17 @@
+# TalonOne::UpdateAudience
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The human-friendly display name for this Audience. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateAudience.new(name: null)
+```
+
+

data/docs/UpdateCampaign.md

@@ -1,13 +1,14 @@
 # TalonOne::UpdateCampaign
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | A friendly name for this campaign. | 
 **description** | **String** | A detailed description of the campaign. | [optional] 
 **start_time** | **DateTime** | Datetime when the campaign will become active. | [optional] 
 **end_time** | **DateTime** | Datetime when the campaign will become in-active. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **state** | **String** | A disabled or archived campaign is not evaluated for rules or coupons.  | [optional] [default to 'enabled']
 **active_ruleset_id** | **Integer** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] 
 **tags** | **Array<String>** | A list of tags for the campaign. | 
@@ -15,5 +16,26 @@ Name | Type | Description | Notes
 **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 | 
+**campaign_groups** | **Array<Integer>** | The IDs of the campaign groups that own this entity. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateCampaign.new(name: null,
+                                 description: null,
+                                 start_time: null,
+                                 end_time: null,
+                                 attributes: null,
+                                 state: null,
+                                 active_ruleset_id: null,
+                                 tags: null,
+                                 features: null,
+                                 coupon_settings: null,
+                                 referral_settings: null,
+                                 limits: null,
+                                 campaign_groups: null)
+```
 
 

data/docs/UpdateCampaignGroup.md

@@ -0,0 +1,23 @@
+# TalonOne::UpdateCampaignGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of this campaign group. | 
+**description** | **String** | A longer description of the campaign group. | [optional] 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that this campaign group is enabled for | [optional] 
+**campaign_ids** | **Array<Integer>** | A list of the IDs of the campaigns that this campaign group owns | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateCampaignGroup.new(name: null,
+                                 description: null,
+                                 subscribed_applications_ids: null,
+                                 campaign_ids: null)
+```
+
+

data/docs/UpdateCoupon.md

@@ -1,12 +1,27 @@
 # TalonOne::UpdateCoupon
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **usage_limit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | [optional] 
+**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
 **recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateCoupon.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 recipient_integration_id: null,
+                                 attributes: null)
+```
 
 

data/docs/UpdateCouponBatch.md

@@ -1,12 +1,27 @@
 # TalonOne::UpdateCouponBatch
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **usage_limit** | **Integer** | The number of times a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | [optional] 
+**discount_limit** | **Float** | The amount of discounts that can be given with this coupon code.  | [optional] 
 **start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
 **batch_id** | **String** | The id of the batch the coupon belongs to. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateCouponBatch.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 attributes: null,
+                                 batch_id: null)
+```
+
 

data/docs/UpdateLoyaltyProgram.md

@@ -1,12 +1,27 @@
 # TalonOne::UpdateLoyaltyProgram
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **String** | The display title for the Loyalty Program. | [optional] 
 **description** | **String** | Description of our Loyalty Program. | [optional] 
 **subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] 
-**default_validity** | **String** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m' or '30d'. | [optional] 
-**allow_subledger** | **BOOLEAN** | Indicates if this program supports subledgers inside the program | [optional] 
+**default_validity** | **String** | Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like '1h' or '40m'. | [optional] 
+**default_pending** | **String** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | [optional] 
+**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateLoyaltyProgram.new(title: null,
+                                 description: null,
+                                 subscribed_applications: null,
+                                 default_validity: null,
+                                 default_pending: null,
+                                 allow_subledger: null)
+```
 
 

data/docs/UpdateRole.md

@@ -1,11 +1,23 @@
 # TalonOne::UpdateRole
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the role | [optional] 
 **description** | **String** | Description of the role | [optional] 
 **acl** | **String** | Role Policy this should be a stringified blob of json | [optional] 
-**users** | **Array<Integer>** | an array of userids | [optional] 
+**users** | **Array<Integer>** | an array of user identifiers | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateRole.new(name: null,
+                                 description: null,
+                                 acl: null,
+                                 users: null)
+```
 
 

data/docs/UpdateUser.md

@@ -1,17 +1,25 @@
 # TalonOne::UpdateUser
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **String** | The email address associated with your account. | 
 **name** | **String** | Your name. | [optional] 
-**password** | **String** | Your old password. | [optional] 
-**new_password** | **String** | Your new password. | [optional] 
 **policy** | **String** | a blob of acl json | [optional] 
 **state** | **String** | New state (\"deactivated\" or \"active\") for the user. Only usable by admins for the user. | [optional] 
-**release_update** | **BOOLEAN** | Update the user via email | [optional] 
-**latest_feature** | **String** | The latest feature you've been notified. | [optional] 
 **roles** | **Array<Integer>** | Update | [optional] 
-**application_notification_subscriptions** | **Object** |  | [optional] 
+**application_notification_subscriptions** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateUser.new(name: null,
+                                 policy: null,
+                                 state: null,
+                                 roles: null,
+                                 application_notification_subscriptions: null)
+```
 
 

data/docs/UpdateUserLatestFeedTimestamp.md

@@ -0,0 +1,17 @@
+# TalonOne::UpdateUserLatestFeedTimestamp
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_latest_feed_timestamp** | **DateTime** | New timestamp to update for the current user | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateUserLatestFeedTimestamp.new(new_latest_feed_timestamp: null)
+```
+
+

data/docs/User.md

@@ -1,6 +1,7 @@
 # TalonOne::User
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -11,11 +12,30 @@ Name | Type | Description | Notes
 **invite_token** | **String** | Invite token, empty if the user as already accepted their invite. | 
 **state** | **String** | Current user state. | 
 **name** | **String** | Full name | 
-**policy** | **String** | A blob of ACL JSON | 
-**release_update** | **BOOLEAN** | Update the user via email | 
-**latest_feature** | **String** | Latest feature the user has been notified. | [optional] 
-**roles** | **Array<Integer>** | Contains a list of all roles a user is a memeber of | [optional] 
-**application_notification_subscriptions** | **Object** |  | [optional] 
+**policy** | [**Object**](.md) | User ACL Policy | 
+**latest_feed_timestamp** | **DateTime** | Latest timestamp the user has been notified for feed. | [optional] 
+**roles** | **Array<Integer>** | Contains a list of all roles the user is a member of | [optional] 
+**application_notification_subscriptions** | [**Object**](.md) |  | [optional] 
 **auth_method** | **String** | The Authentication method for this user | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::User.new(id: null,
+                                 created: null,
+                                 modified: null,
+                                 email: null,
+                                 account_id: null,
+                                 invite_token: null,
+                                 state: null,
+                                 name: null,
+                                 policy: null,
+                                 latest_feed_timestamp: null,
+                                 roles: null,
+                                 application_notification_subscriptions: null,
+                                 auth_method: null)
+```
+
 

data/docs/UserEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::UserEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **user_id** | **Integer** | The ID of the account that owns this entity. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UserEntity.new(user_id: null)
+```
+
 

data/docs/UserFeedNotifications.md

@@ -0,0 +1,19 @@
+# TalonOne::UserFeedNotifications
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_update** | **DateTime** | Timestamp of the last request for this list | 
+**notifications** | [**Array<FeedNotification>**](FeedNotification.md) | List of all notifications to notify the user about | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UserFeedNotifications.new(last_update: null,
+                                 notifications: null)
+```
+
+

data/docs/Webhook.md

@@ -1,6 +1,7 @@
 # TalonOne::Webhook
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -13,6 +14,24 @@ Name | Type | Description | Notes
 **headers** | **Array<String>** | List of API HTTP headers for this webhook | 
 **payload** | **String** | API payload (supports templating using parameters) for this webhook | [optional] 
 **params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | 
-**enabled** | **BOOLEAN** | Enables or disables webhook from showing in rule builder | 
+**enabled** | **Boolean** | Enables or disables webhook from showing in rule builder | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Webhook.new(id: null,
+                                 created: null,
+                                 modified: null,
+                                 application_ids: null,
+                                 title: null,
+                                 verb: null,
+                                 url: null,
+                                 headers: null,
+                                 payload: null,
+                                 params: null,
+                                 enabled: null)
+```
 
 

data/docs/WebhookActivationLogEntry.md

@@ -1,6 +1,7 @@
 # TalonOne::WebhookActivationLogEntry
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration_request_uuid** | **String** | UUID reference of the integration request that triggered the effect with the webhook | 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **campaign_id** | **Integer** | ID of the campaign that triggered the webhook | 
 **created** | **DateTime** | Timestamp of request | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::WebhookActivationLogEntry.new(integration_request_uuid: null,
+                                 webhook_id: null,
+                                 application_id: null,
+                                 campaign_id: null,
+                                 created: null)
+```
+