talon_one 1.1.2 → 2.1.0

data/docs/ManagerConfig.md

@@ -1,8 +1,17 @@
 # TalonOne::ManagerConfig
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **schema_version** | **Integer** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ManagerConfig.new(schema_version: null)
+```
+
 

data/docs/Meta.md

@@ -1,11 +1,25 @@
 # TalonOne::Meta
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**campaigns** | **Object** | Maps each evaluated campaign ID to a key-value list of that campaigns attributes. Campaigns without attributes will be omitted. | [optional] 
-**coupons** | **Object** | Maps the coupon value to a key-value list of that coupons attributes. | [optional] 
+**campaigns** | [**Object**](.md) | Maps each evaluated campaign ID to a key-value list of that campaigns attributes. Campaigns without attributes will be omitted. | [optional] 
+**coupons** | [**Object**](.md) | Maps the coupon value to a key-value list of that coupons attributes. | [optional] 
 **coupon_rejection_reason** | [**CouponRejectionReason**](CouponRejectionReason.md) |  | [optional] 
-**warnings** | **Object** |  | [optional] 
+**referral_rejection_reason** | [**ReferralRejectionReason**](ReferralRejectionReason.md) |  | [optional] 
+**warnings** | [**Object**](.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Meta.new(campaigns: null,
+                                 coupons: null,
+                                 coupon_rejection_reason: null,
+                                 referral_rejection_reason: null,
+                                 warnings: null)
+```
 
 

data/docs/MiscUpdateUserLatestFeature.md

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

data/docs/MultiApplicationEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::MultiApplicationEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MultiApplicationEntity.new(application_ids: null)
+```
+
 

data/docs/MutableEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::MutableEntity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **modified** | **DateTime** | The exact moment this entity was last modified. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MutableEntity.new(modified: null)
+```
+
 

data/docs/NewAccount.md

@@ -1,8 +1,17 @@
 # TalonOne::NewAccount
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **company_name** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAccount.new(company_name: null)
+```
+
 

data/docs/NewAccountSignUp.md

@@ -1,10 +1,21 @@
 # TalonOne::NewAccountSignUp
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **email** | **String** | The email address associated with your account. | 
 **password** | **String** | The password for your account. | 
 **company_name** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAccountSignUp.new(email: null,
+                                 password: null,
+                                 company_name: null)
+```
+
 

data/docs/NewAdditionalCost.md

@@ -0,0 +1,23 @@
+# TalonOne::NewAdditionalCost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The additional cost name that will be used in API requests and Talang. E.g. if `name == \"shipping\"` then you would set the shipping additional cost by including an `additionalCosts.shipping` property in your request payload. | 
+**title** | **String** | The human-readable name for the additional cost that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | 
+**description** | **String** | A description of this additional cost. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this additional cost | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAdditionalCost.new(name: null,
+                                 title: null,
+                                 description: null,
+                                 subscribed_applications_ids: null)
+```
+
+

data/docs/NewApplication.md

@@ -1,15 +1,35 @@
 # TalonOne::NewApplication
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of this application. | 
 **description** | **String** | A longer description of the application. | [optional] 
-**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | 
 **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) | [optional] 
+**attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewApplication.new(name: null,
+                                 description: null,
+                                 timezone: null,
+                                 currency: null,
+                                 case_sensitivity: null,
+                                 attributes: null,
+                                 limits: null,
+                                 campaign_priority: null,
+                                 attributes_settings: null,
+                                 key: null)
+```
 
 

data/docs/NewApplicationAPIKey.md

@@ -1,6 +1,7 @@
 # TalonOne::NewApplicationAPIKey
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | ID of the API Key | 
@@ -12,4 +13,19 @@ Name | Type | Description | Notes
 **expires** | **DateTime** | The date the API key expired | 
 **key** | **String** | Raw API Key | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewApplicationAPIKey.new(id: null,
+                                 created_by: null,
+                                 title: null,
+                                 account_id: null,
+                                 application_id: null,
+                                 created: null,
+                                 expires: null,
+                                 key: null)
+```
+
 

data/docs/NewAttribute.md

@@ -1,15 +1,33 @@
 # TalonOne::NewAttribute
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **entity** | **String** | The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an `attributes` object with keys corresponding to the `name` of the custom attributes for that type. | 
 **event_type** | **String** |  | [optional] 
-**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if `name == \"region\"` then you would set the region attribute by including an `attributes.region` property in your request payload.  | 
+**name** | **String** | The attribute name that will be used in API requests and Talang. E.g. if `name == \"region\"` then you would set the region attribute by including an `attributes.region` property in your request payload. | 
 **title** | **String** | The human-readable name for the attribute that will be shown in the Campaign Manager. Like `name`, the combination of entity and title must also be unique. | 
 **type** | **String** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. | 
 **description** | **String** | A description of this attribute. | 
 **suggestions** | **Array<String>** | A list of suggestions for the attribute. | 
-**editable** | **BOOLEAN** | Whether or not this attribute can be edited. | 
+**editable** | **Boolean** | Whether or not this attribute can be edited. | 
+**subscribed_applications_ids** | **Array<Integer>** | A list of the IDs of the applications that are subscribed to this attribute | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAttribute.new(entity: null,
+                                 event_type: null,
+                                 name: null,
+                                 title: null,
+                                 type: null,
+                                 description: null,
+                                 suggestions: null,
+                                 editable: null,
+                                 subscribed_applications_ids: null)
+```
 
 

data/docs/NewCampaign.md

@@ -1,13 +1,14 @@
 # TalonOne::NewCampaign
 
 ## 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.  | [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. | 
@@ -16,4 +17,23 @@ Name | Type | Description | Notes
 **referral_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCampaign.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)
+```
+
 

data/docs/NewCampaignSet.md

@@ -1,9 +1,21 @@
 # TalonOne::NewCampaignSet
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
+**version** | **Integer** | Version of the campaign set | 
 **set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCampaignSet.new(application_id: null,
+                                 version: null,
+                                 set: null)
+```
+
 

data/docs/NewCoupons.md

@@ -1,16 +1,35 @@
 # TalonOne::NewCoupons
 
 ## 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.  | 
+**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] 
 **valid_characters** | **Array<String>** | Set of characters to be used when generating random part of code. Defaults to [A-Z, 0-9] (in terms of RegExp). | 
 **coupon_pattern** | **String** | The pattern that will be used to generate coupon codes. The character `#` acts as a placeholder and will be replaced by a random character from the `validCharacters` set.  | 
 **number_of_coupons** | **Integer** | The number of new coupon codes to generate for the campaign. Must be at least 1. | 
 **unique_prefix** | **String** | A unique prefix to prepend to all generated coupons. | [optional] 
-**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
 **recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCoupons.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 valid_characters: null,
+                                 coupon_pattern: null,
+                                 number_of_coupons: null,
+                                 unique_prefix: null,
+                                 attributes: null,
+                                 recipient_integration_id: null)
+```
+
 

data/docs/NewCustomerProfile.md

@@ -1,8 +1,17 @@
 # TalonOne::NewCustomerProfile
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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::NewCustomerProfile.new(attributes: null)
+```
 
 

data/docs/NewCustomerSession.md

@@ -1,6 +1,7 @@
 # TalonOne::NewCustomerSession
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] 
@@ -10,6 +11,21 @@ Name | Type | Description | Notes
 **cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | [optional] 
 **identifiers** | **Array<String>** | Identifiers for the customer, this can be used for limits on values such as device ID. | [optional] 
 **total** | **Float** | The total sum of the cart in one session. | [optional] 
-**attributes** | **Object** | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.  | [optional] 
+**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCustomerSession.new(profile_id: null,
+                                 coupon: null,
+                                 referral: null,
+                                 state: null,
+                                 cart_items: null,
+                                 identifiers: null,
+                                 total: null,
+                                 attributes: null)
+```
 
 

data/docs/NewCustomerSessionV2.md

@@ -0,0 +1,31 @@
+# TalonOne::NewCustomerSessionV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile_id** | **String** | ID of the customers profile as used within this Talon.One account. May be omitted or set to the empty string if the customer does not yet have a known profile ID. | [optional] 
+**coupon_codes** | **Array<String>** | Any coupon codes entered. | [optional] 
+**referral_code** | **String** | Any referral code entered. | [optional] 
+**state** | **String** | Indicates the current state of the session. All sessions must start in the \"open\" state, after which valid transitions are...  1. open -> closed 2. open -> cancelled 3. closed -> cancelled  | [optional] [default to 'open']
+**cart_items** | [**Array<CartItem>**](CartItem.md) | All items the customer will be purchasing in this session | [optional] 
+**additional_costs** | [**Hash<String, AdditionalCost>**](AdditionalCost.md) | Any costs associated with the session that can not be explicitly attributed to cart items. Examples include shipping costs and service fees. | [optional] 
+**identifiers** | **Array<String>** | Identifiers for the customer, this can be used for limits on values such as device ID. | [optional] 
+**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCustomerSessionV2.new(profile_id: null,
+                                 coupon_codes: null,
+                                 referral_code: null,
+                                 state: null,
+                                 cart_items: null,
+                                 additional_costs: null,
+                                 identifiers: null,
+                                 attributes: null)
+```
+
+