talon_one 1.4.0 → 2.3.0

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] 
+**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). | [optional] 
+**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.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCoupons.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 number_of_coupons: null,
+                                 unique_prefix: null,
+                                 attributes: null,
+                                 recipient_integration_id: null,
+                                 valid_characters: null,
+                                 coupon_pattern: null)
+```
 
 

data/docs/NewCouponsForMultipleRecipients.md

@@ -0,0 +1,31 @@
+# TalonOne::NewCouponsForMultipleRecipients
+
+## 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] 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+**recipients_integration_ids** | **Array<String>** | The integration IDs for recipients | 
+**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). | [optional] 
+**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.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewCouponsForMultipleRecipients.new(usage_limit: null,
+                                 discount_limit: null,
+                                 start_date: null,
+                                 expiry_date: null,
+                                 attributes: null,
+                                 recipients_integration_ids: null,
+                                 valid_characters: null,
+                                 coupon_pattern: 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)
+```
+
+

data/docs/NewEvent.md

@@ -1,11 +1,23 @@
 # TalonOne::NewEvent
 
 ## 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] 
 **type** | **String** | A string representing the event. Must not be a reserved event name. | 
-**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | 
+**attributes** | [**Object**](.md) | Arbitrary additional JSON data associated with the event. | 
 **session_id** | **String** | The ID of the session that this event occurred in. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewEvent.new(profile_id: null,
+                                 type: null,
+                                 attributes: null,
+                                 session_id: null)
+```
+
 

data/docs/NewEventType.md

@@ -1,6 +1,7 @@
 # TalonOne::NewEventType
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
@@ -9,9 +10,26 @@ Name | Type | Description | Notes
 **description** | **String** | An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example:  > The \"Payment Accepted\" event is triggered after successful processing of a payment by our payment gateway.  | 
 **mime_type** | **String** | This defines how the request payload will be parsed before your handler code is run. | 
 **example_payload** | **String** | It is often helpful to include an example payload with the event type definition for documentation purposes. | [optional] 
-**schema** | **Object** | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing.  | [optional] 
+**schema** | [**Object**](.md) | It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing.  | [optional] 
 **handler_language** | **String** | The language of the handler code. Currently only `\"talang\"` is supported. | [optional] 
 **handler** | **String** | Code that will be run after successful parsing & validation of the payload for this event. This code _may_ choose to evaluate campaign rules.  | 
 **version** | **Integer** | The version of this event type. When updating an existing event type this must be **exactly** `currentVersion + 1`.  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewEventType.new(application_ids: null,
+                                 title: null,
+                                 name: null,
+                                 description: null,
+                                 mime_type: null,
+                                 example_payload: null,
+                                 schema: null,
+                                 handler_language: null,
+                                 handler: null,
+                                 version: null)
+```
+
 

data/docs/NewFeatureFlags.md

@@ -1,10 +1,21 @@
 # TalonOne::NewFeatureFlags
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**loyalty** | **BOOLEAN** | Whether the account has access to the loyalty features or not | [optional] 
-**coupons_without_count** | **BOOLEAN** | Whether the account queries coupons with or without total result size | [optional] 
-**beta_effects** | **BOOLEAN** | Whether the account can test beta effects or not | [optional] 
+**loyalty** | **Boolean** | Whether the account has access to the loyalty features or not | [optional] 
+**coupons_without_count** | **Boolean** | Whether the account queries coupons with or without total result size | [optional] 
+**beta_effects** | **Boolean** | Whether the account can test beta effects or not | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewFeatureFlags.new(loyalty: null,
+                                 coupons_without_count: null,
+                                 beta_effects: null)
+```
 
 

data/docs/NewInvitation.md

@@ -1,6 +1,7 @@
 # TalonOne::NewInvitation
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the user being invited. | [optional] 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **acl** | **String** | a blob of acl json | 
 **roles** | **Array<Integer>** | An array of roleIDs to assign the new user to | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewInvitation.new(name: null,
+                                 email: null,
+                                 acl: null,
+                                 roles: null)
+```
+
 

data/docs/NewInviteEmail.md

@@ -1,9 +1,19 @@
 # TalonOne::NewInviteEmail
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **email** | **String** |  | 
 **token** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewInviteEmail.new(email: null,
+                                 token: null)
+```
+
 

data/docs/NewLoyaltyProgram.md

@@ -1,13 +1,29 @@
 # TalonOne::NewLoyaltyProgram
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The internal name for the Loyalty Program. This is an immutable value. | 
 **title** | **String** | The display title for the Loyalty Program. | 
 **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'. | 
-**allow_subledger** | **BOOLEAN** | Indicates if this program supports subledgers inside the program | 
+**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'. | 
+**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'. | 
+**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewLoyaltyProgram.new(name: null,
+                                 title: null,
+                                 description: null,
+                                 subscribed_applications: null,
+                                 default_validity: null,
+                                 default_pending: null,
+                                 allow_subledger: null)
+```
 
 

data/docs/NewPassword.md

@@ -1,9 +1,19 @@
 # TalonOne::NewPassword
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **password** | **String** | The new password for your account. | 
 **reset_token** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewPassword.new(password: null,
+                                 reset_token: null)
+```
+
 

data/docs/NewPasswordEmail.md

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

data/docs/NewReferral.md

@@ -1,6 +1,7 @@
 # TalonOne::NewReferral
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
@@ -9,4 +10,16 @@ Name | Type | Description | Notes
 **start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional] 
 **expiry_date** | **DateTime** | Expiry date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewReferral.new(campaign_id: null,
+                                 advocate_profile_integration_id: null,
+                                 friend_profile_integration_id: null,
+                                 start_date: null,
+                                 expiry_date: null)
+```
+
 

data/docs/NewRole.md

@@ -1,6 +1,7 @@
 # TalonOne::NewRole
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the role | 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **acl** | **String** | Role Policy this should be a stringified blob of json | 
 **users** | **Array<Integer>** | An array of userIDs | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewRole.new(name: null,
+                                 description: null,
+                                 acl: null,
+                                 users: null)
+```
+
 

data/docs/NewRuleset.md

@@ -1,11 +1,23 @@
 # TalonOne::NewRuleset
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **rules** | [**Array<Rule>**](Rule.md) | Set of rules to apply. | 
 **bindings** | [**Array<Binding>**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | 
 **rb_version** | **String** | A string indicating which version of the rulebuilder was used to create this ruleset. | [optional] 
-**activate** | **BOOLEAN** | A boolean indicating whether this newly created ruleset should also be activated for the campaign owns it | [optional] 
+**activate** | **Boolean** | A boolean indicating whether this newly created ruleset should also be activated for the campaign owns it | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewRuleset.new(rules: null,
+                                 bindings: null,
+                                 rb_version: null,
+                                 activate: null)
+```
 
 

data/docs/NewSamlConnection.md

@@ -1,16 +1,33 @@
 # TalonOne::NewSamlConnection
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **x509certificate** | **String** | X.509 Certificate. | 
 **account_id** | **Integer** | The ID of the account that owns this entity. | 
 **name** | **String** | ID of the SAML service. | 
-**enabled** | **BOOLEAN** | Determines if this SAML connection active. | 
+**enabled** | **Boolean** | Determines if this SAML connection active. | 
 **issuer** | **String** | Identity Provider Entity ID. | 
 **sign_on_url** | **String** | Single Sign-On URL. | 
 **sign_out_url** | **String** | Single Sign-Out URL. | [optional] 
 **metadata_url** | **String** | Metadata URL. | [optional] 
 **audience_uri** | **String** | The application-defined unique identifier that is the intended audience of the SAML assertion. This is most often the SP Entity ID of your application. When not specified, the ACS URL will be used.  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewSamlConnection.new(x509certificate: null,
+                                 account_id: null,
+                                 name: null,
+                                 enabled: null,
+                                 issuer: null,
+                                 sign_on_url: null,
+                                 sign_out_url: null,
+                                 metadata_url: null,
+                                 audience_uri: null)
+```
+