talon_one 1.1.2 → 2.1.0

data/docs/CustomerAnalytics.md

@@ -1,6 +1,7 @@
 # TalonOne::CustomerAnalytics
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **accepted_coupons** | **Integer** | Total accepted coupons for this customer | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **total_revenue** | **Float** | Total Revenue across all closed sessions | 
 **total_discounts** | **Float** | The sum of discounts that were given across all closed sessions | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerAnalytics.new(accepted_coupons: null,
+                                 created_coupons: null,
+                                 free_items: null,
+                                 total_orders: null,
+                                 total_discounted_orders: null,
+                                 total_revenue: null,
+                                 total_discounts: null)
+```
+
 

data/docs/CustomerInventory.md

@@ -0,0 +1,21 @@
+# TalonOne::CustomerInventory
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**profile** | [**CustomerProfile**](CustomerProfile.md) |  | [optional] 
+**referrals** | [**Array<Referral>**](Referral.md) |  | [optional] 
+**coupons** | [**Array<Coupon>**](Coupon.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerInventory.new(profile: null,
+                                 referrals: null,
+                                 coupons: null)
+```
+
+

data/docs/CustomerProfile.md

@@ -1,15 +1,31 @@
 # TalonOne::CustomerProfile
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration_id** | **String** | The ID used for this entity in the application system. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
-**attributes** | **Object** | Arbitrary properties associated with this item | 
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | 
 **account_id** | **Integer** | The ID of the Talon.One account that owns this profile. | 
 **closed_sessions** | **Integer** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **total_sales** | **Float** | Sum of all purchases made by this customer | 
 **loyalty_memberships** | [**Array<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] 
 **last_activity** | **DateTime** | Timestamp of the most recent event received from this customer | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerProfile.new(integration_id: null,
+                                 created: null,
+                                 attributes: null,
+                                 account_id: null,
+                                 closed_sessions: null,
+                                 total_sales: null,
+                                 loyalty_memberships: null,
+                                 last_activity: null)
+```
+
 

data/docs/CustomerProfileSearchQuery.md

@@ -1,10 +1,21 @@
 # TalonOne::CustomerProfileSearchQuery
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | **Object** | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] 
+**attributes** | [**Object**](.md) | Properties to match against a customer profile. All provided attributes will be exactly matched against profile attributes | [optional] 
 **integration_i_ds** | **Array<String>** |  | [optional] 
 **profile_i_ds** | **Array<Integer>** |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerProfileSearchQuery.new(attributes: null,
+                                 integration_i_ds: null,
+                                 profile_i_ds: null)
+```
+
 

data/docs/CustomerProfileUpdate.md

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

data/docs/CustomerSession.md

@@ -1,6 +1,7 @@
 # TalonOne::CustomerSession
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **integration_id** | **String** | The ID used for this entity in the application system. | 
@@ -13,8 +14,28 @@ Name | Type | Description | Notes
 **cart_items** | [**Array<CartItem>**](CartItem.md) | Serialized JSON representation. | 
 **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. | 
-**attributes** | **Object** | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.  | 
-**first_session** | **BOOLEAN** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | 
+**attributes** | [**Object**](.md) | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings.  | 
+**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | 
 **discounts** | **Hash<String, Float>** | A map of labelled discount values, values will be in the same currency as the application associated with the session. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerSession.new(integration_id: null,
+                                 created: null,
+                                 application_id: null,
+                                 profile_id: null,
+                                 coupon: null,
+                                 referral: null,
+                                 state: null,
+                                 cart_items: null,
+                                 identifiers: null,
+                                 total: null,
+                                 attributes: null,
+                                 first_session: null,
+                                 discounts: null)
+```
+
 

data/docs/CustomerSessionV2.md

@@ -0,0 +1,45 @@
+# TalonOne::CustomerSessionV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_id** | **String** | The ID used for this entity in the application system. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**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. | 
+**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  | [default to 'open']
+**cart_items** | [**Array<CartItem>**](CartItem.md) | All items the customer will be purchasing in this session | 
+**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.  | 
+**first_session** | **Boolean** | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | 
+**total** | **Float** | The total sum of cart-items, as well as additional costs, before any discounts applied | 
+**cart_item_total** | **Float** | The total sum of cart-items before any discounts applied | 
+**additional_cost_total** | **Float** | The total sum of additional costs before any discounts applied | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::CustomerSessionV2.new(integration_id: null,
+                                 created: null,
+                                 application_id: null,
+                                 profile_id: null,
+                                 coupon_codes: null,
+                                 referral_code: null,
+                                 state: null,
+                                 cart_items: null,
+                                 additional_costs: null,
+                                 identifiers: null,
+                                 attributes: null,
+                                 first_session: null,
+                                 total: null,
+                                 cart_item_total: null,
+                                 additional_cost_total: null)
+```
+
+

data/docs/DeductLoyaltyPointsEffectProps.md

@@ -0,0 +1,23 @@
+# TalonOne::DeductLoyaltyPointsEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule_title** | **String** | The title of the rule that contained triggered this points deduction | 
+**program_id** | **Integer** | The ID of the loyalty program where these points were added | 
+**sub_ledger_id** | **String** | The ID of the subledger within the loyalty program where these points were added | 
+**value** | **Float** | The amount of points that were deducted | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::DeductLoyaltyPointsEffectProps.new(rule_title: null,
+                                 program_id: null,
+                                 sub_ledger_id: null,
+                                 value: null)
+```
+
+

data/docs/Effect.md

@@ -0,0 +1,27 @@
+# TalonOne::Effect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | The ID of the campaign that triggered this effect | 
+**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered | 
+**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset | 
+**rule_name** | **String** | The name of the rule that triggered this effect | 
+**effect_type** | **String** | The type of effect that was triggered | 
+**props** | [**Object**](.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Effect.new(campaign_id: null,
+                                 ruleset_id: null,
+                                 rule_index: null,
+                                 rule_name: null,
+                                 effect_type: null,
+                                 props: null)
+```
+
+

data/docs/EffectEntity.md

@@ -0,0 +1,25 @@
+# TalonOne::EffectEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | The ID of the campaign that triggered this effect | 
+**ruleset_id** | **Integer** | The ID of the ruleset that was active in the campaign when this effect was triggered | 
+**rule_index** | **Integer** | The position of the rule that triggered this effect within the ruleset | 
+**rule_name** | **String** | The name of the rule that triggered this effect | 
+**effect_type** | **String** | The type of effect that was triggered | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::EffectEntity.new(campaign_id: null,
+                                 ruleset_id: null,
+                                 rule_index: null,
+                                 rule_name: null,
+                                 effect_type: null)
+```
+
+

data/docs/EmailEntity.md

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

data/docs/Entity.md

@@ -1,9 +1,19 @@
 # TalonOne::Entity
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Entity.new(id: null,
+                                 created: null)
+```
+
 

data/docs/Environment.md

@@ -1,6 +1,7 @@
 # TalonOne::Environment
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **templates** | [**Array<TemplateDef>**](TemplateDef.md) | The templates defined for this application. | 
 **variables** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Environment.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 slots: null,
+                                 functions: null,
+                                 templates: null,
+                                 variables: null)
+```
+
 

data/docs/ErrorEffectProps.md

@@ -0,0 +1,17 @@
+# TalonOne::ErrorEffectProps
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The error message. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ErrorEffectProps.new(message: null)
+```
+
+

data/docs/ErrorResponse.md

@@ -1,9 +1,19 @@
 # TalonOne::ErrorResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **message** | **String** | A message describing the error. | 
 **errors** | [**Array<APIError>**](APIError.md) | An array of individual problems encountered during the request. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ErrorResponse.new(message: null,
+                                 errors: null)
+```
+
 

data/docs/ErrorSource.md

@@ -1,10 +1,23 @@
 # TalonOne::ErrorSource
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pointer** | **String** | Pointer to the path in the payload that caused this error. | [optional] 
 **parameter** | **String** | Query parameter that caused this error. | [optional] 
 **line** | **String** | Line number in uploaded multipart file that caused this error. 'N/A' if unknown. | [optional] 
+**resource** | **String** | Pointer to the resource that caused this error | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::ErrorSource.new(pointer: null,
+                                 parameter: null,
+                                 line: null,
+                                 resource: null)
+```
 
 

data/docs/Event.md

@@ -1,6 +1,7 @@
 # TalonOne::Event
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -8,10 +9,27 @@ Name | Type | Description | Notes
 **application_id** | **Integer** | The ID of the application that owns this entity. | 
 **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. | [optional] 
 **effects** | **Array<Object>** | An array of \"effects\" that must be applied in response to this event. Example effects include `addItemToCart` or `setDiscount`.  | 
 **ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. | 
 **meta** | [**Meta**](Meta.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Event.new(id: null,
+                                 created: null,
+                                 application_id: null,
+                                 profile_id: null,
+                                 type: null,
+                                 attributes: null,
+                                 session_id: null,
+                                 effects: null,
+                                 ledger_entries: null,
+                                 meta: null)
+```
+