talon_one 1.3.0 → 2.2.0

data/docs/SamlLoginEndpoint.md

@@ -0,0 +1,19 @@
+# TalonOne::SamlLoginEndpoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | ID of the SAML service. | 
+**login_url** | **String** | Single Sign-On URL. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SamlLoginEndpoint.new(name: null,
+                                 login_url: null)
+```
+
+

data/docs/Session.md

@@ -1,10 +1,21 @@
 # TalonOne::Session
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **user_id** | **Integer** | The ID of the user of this session | 
 **token** | **String** | An opaque session identifier | 
 **created** | **DateTime** | Unix timestamp indicating when the session was first created. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Session.new(user_id: null,
+                                 token: null,
+                                 created: null)
+```
+
 

data/docs/SetDiscountEffectProps.md

@@ -0,0 +1,21 @@
+# TalonOne::SetDiscountEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name/description of this discount | 
+**value** | **Float** | The total monetary value of the discount | 
+**scope** | **String** | The scope which the discount was applied on, can be one of (cartItems,additionalCosts,sessionTotal) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SetDiscountEffectProps.new(name: null,
+                                 value: null,
+                                 scope: null)
+```
+
+

data/docs/SetDiscountPerItemEffectProps.md

@@ -0,0 +1,23 @@
+# TalonOne::SetDiscountPerItemEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name/description of this discount | 
+**value** | **Float** | The total monetary value of the discount | 
+**position** | **Float** | The index of the item in the cart items list on which this discount should be applied | 
+**sub_position** | **Float** | The sub-index of the item in an item stack on which this discount should be applied | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SetDiscountPerItemEffectProps.new(name: null,
+                                 value: null,
+                                 position: null,
+                                 sub_position: null)
+```
+
+

data/docs/ShowBundleMetadataEffectProps.md

@@ -0,0 +1,21 @@
+# TalonOne::ShowBundleMetadataEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Description of the product bundle | 
+**bundle_attributes** | **Array<String>** | The cart item attributes that determined which items are being bundled together | 
+**items_indices** | **Array<Float>** | The indices in the cart items array of the bundled items | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ShowBundleMetadataEffectProps.new(description: null,
+                                 bundle_attributes: null,
+                                 items_indices: null)
+```
+
+

data/docs/ShowNotificationEffectProps.md

@@ -0,0 +1,21 @@
+# TalonOne::ShowNotificationEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification_type** | **String** | The type of notification that should be shown (e.g. error/warning/info) | 
+**title** | **String** | Title of the notification | 
+**body** | **String** | Body of the notification | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ShowNotificationEffectProps.new(notification_type: null,
+                                 title: null,
+                                 body: null)
+```
+
+

data/docs/SlotDef.md

@@ -1,6 +1,7 @@
 # TalonOne::SlotDef
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The dot-separated path to this slot for use in Talang. | 
@@ -8,6 +9,19 @@ Name | Type | Description | Notes
 **title** | **String** | Campaigner-friendly name for the slot. | 
 **description** | **String** | A short description of the slot. | [optional] 
 **help** | **String** | Extended help text for the slot. | [optional] 
-**writable** | **BOOLEAN** | Whether or not this slot can be updated by rule effects. | 
+**writable** | **Boolean** | Whether or not this slot can be updated by rule effects. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::SlotDef.new(name: null,
+                                 type: null,
+                                 title: null,
+                                 description: null,
+                                 help: null,
+                                 writable: null)
+```
 
 

data/docs/TemplateArgDef.md

@@ -1,11 +1,23 @@
 # TalonOne::TemplateArgDef
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of value this argument expects. | 
 **description** | **String** | A campaigner-friendly description of the argument, this will also be shown in the rule editor. | 
 **title** | **String** | A campaigner friendly name for the argument, this will be shown in the rule editor. | 
-**ui** | **Object** | Arbitrary metadata that may be used to render an input for this argument. | 
+**ui** | [**Object**](.md) | Arbitrary metadata that may be used to render an input for this argument. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::TemplateArgDef.new(type: null,
+                                 description: null,
+                                 title: null,
+                                 ui: null)
+```
 
 

data/docs/TemplateDef.md

@@ -1,6 +1,7 @@
 # TalonOne::TemplateDef
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -12,7 +13,25 @@ Name | Type | Description | Notes
 **category** | **String** | Used for grouping templates in the rule editor sidebar. | 
 **expr** | **Array<Object>** | A Talang expression that contains variable bindings referring to args. | 
 **args** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | An array of argument definitions. | 
-**expose** | **BOOLEAN** | A flag to control exposure in Rule Builder. | [optional] [default to false]
+**expose** | **Boolean** | A flag to control exposure in Rule Builder. | [optional] [default to false]
 **name** | **String** | The template name used in Talang. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::TemplateDef.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 title: null,
+                                 description: null,
+                                 help: null,
+                                 category: null,
+                                 expr: null,
+                                 args: null,
+                                 expose: null,
+                                 name: null)
+```
+
 

data/docs/TriggerWebhookEffectProps.md

@@ -0,0 +1,19 @@
+# TalonOne::TriggerWebhookEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook_id** | **Float** | The ID of the webhook that was triggered | 
+**webhook_name** | **String** | The name of the webhook that was triggered | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::TriggerWebhookEffectProps.new(webhook_id: null,
+                                 webhook_name: null)
+```
+
+

data/docs/UpdateAccount.md

@@ -1,10 +1,25 @@
 # TalonOne::UpdateAccount
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Arbitrary properties associated with this campaign | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **company_name** | **String** | Name of your company. | 
 **billing_email** | **String** | The billing email address associated with your company account. | 
+**state** | **String** | State of the account (active, deactivated) | [optional] 
+**plan_expires** | **DateTime** | The point in time at which your current plan expires. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::UpdateAccount.new(attributes: null,
+                                 company_name: null,
+                                 billing_email: null,
+                                 state: null,
+                                 plan_expires: null)
+```
 
 

data/docs/UpdateApplication.md

@@ -1,6 +1,7 @@
 # TalonOne::UpdateApplication
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of this application. | 
@@ -8,7 +9,33 @@ 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] 
+**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,
+                                 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)
+```