talon_one 0.1.3 → 1.1.0

data/docs/CampaignSetBranchNode.md

@@ -0,0 +1,11 @@
+# TalonOne::CampaignSetBranchNode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Indicates the node type | 
+**name** | **String** | Name of the set | 
+**operator** | **String** | How does the set operates on its elements | 
+**elements** | [**Array<CampaignSetNode>**](CampaignSetNode.md) | Child elements of this set | 
+
+

data/docs/CampaignSetLeafNode.md

@@ -0,0 +1,9 @@
+# TalonOne::CampaignSetLeafNode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Indicates the node type | 
+**campaign_id** | **Integer** | ID of the campaign | 
+
+

data/docs/CampaignSetNode.md

@@ -0,0 +1,8 @@
+# TalonOne::CampaignSetNode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+
+

data/docs/CartItem.md

@@ -0,0 +1,19 @@
+# TalonOne::CartItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**sku** | **String** |  | 
+**quantity** | **Integer** |  | 
+**price** | **Float** |  | 
+**category** | **String** |  | [optional] 
+**weight** | **Float** | Weight of item in mm | [optional] 
+**height** | **Float** | Height of item in mm | [optional] 
+**width** | **Float** | Width of item in mm | [optional] 
+**length** | **Float** | Length of item in mm | [optional] 
+**position** | **Float** | Position of the Cart Item in the Cart (calculated internally) | [optional] 
+**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**adjustment** | [**CartItemAdjustment**](CartItemAdjustment.md) |  | [optional] 
+
+

data/docs/CartItemAdjustment.md

@@ -0,0 +1,10 @@
+# TalonOne::CartItemAdjustment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pay_from_loyalty_program** | **Integer** | Loyalty Program to be used for payment | 
+**point_payment** | **Integer** | Amount of points to be spend | 
+**remaining_price** | **Float** | Remaining price in currency after payment in points has been made | [optional] 
+
+

data/docs/Change.md

@@ -0,0 +1,13 @@
+# TalonOne::Change
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**user_id** | **Integer** | The ID of the account that owns this entity. | 
+**entity** | **String** | API endpoint on which the change was initiated. | 
+**old** | **Object** | Resource before the change occured. | [optional] 
+**new** | **Object** | Resource after the change occured. | [optional] 
+
+

data/docs/CodeGeneratorSettings.md

@@ -0,0 +1,9 @@
+# TalonOne::CodeGeneratorSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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.  | 
+
+

data/docs/Coupon.md

@@ -0,0 +1,21 @@
+# TalonOne::Coupon
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**campaign_id** | **Integer** | The ID of the campaign that owns this entity. | 
+**value** | **String** | The actual coupon code. | 
+**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.  | 
+**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] 
+**usage_counter** | **Integer** | The number of times this coupon has been successfully used. | 
+**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+**referral_id** | **Integer** | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] 
+**recipient_integration_id** | **String** | The integration ID of a referred customer profile. | [optional] 
+**import_id** | **Integer** | The ID of the Import which created this coupon. | [optional] 
+**reservation** | **BOOLEAN** | This value controls what reservations mean to a coupon. If set to true the coupon reservation is used to mark it as a favourite, if set to false the coupon reservation is used as a requirement of usage. This value defaults to true if not specified. | [optional] 
+**batch_id** | **String** | The id of the batch the coupon belongs to. | [optional] 
+
+

data/docs/CouponConstraints.md

@@ -0,0 +1,10 @@
+# TalonOne::CouponConstraints
+
+## 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] 
+**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] 
+
+

data/docs/CouponRejectionReason.md

@@ -0,0 +1,10 @@
+# TalonOne::CouponRejectionReason
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** |  | 
+**coupon_id** | **Integer** |  | 
+**reason** | **String** |  | 
+
+

data/docs/CouponReservations.md

@@ -0,0 +1,8 @@
+# TalonOne::CouponReservations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_i_ds** | **Array<String>** | List of Integration IDs | 
+
+

data/docs/CouponSearch.md

@@ -0,0 +1,8 @@
+# TalonOne::CouponSearch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | **Object** | Properties to match against a coupon. All provided attributes will be exactly matched against attributes | 
+
+

data/docs/CouponValue.md

@@ -0,0 +1,8 @@
+# TalonOne::CouponValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | The actual coupon code. | [optional] 
+
+

data/docs/CreateApplicationAPIKey.md

@@ -0,0 +1,9 @@
+# TalonOne::CreateApplicationAPIKey
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Title for API Key | 
+**expires** | **DateTime** | The date the API key expired | 
+
+

data/docs/CustomerActivityReport.md

@@ -0,0 +1,20 @@
+# TalonOne::CustomerActivityReport
+
+## 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. | 
+**name** | **String** | The name for this customer profile. | 
+**customer_id** | **Integer** | The internal Talon.One ID of the customer. | 
+**last_activity** | **DateTime** | The last activity of the customer. | [optional] 
+**coupon_redemptions** | **Integer** | Number of coupon redemptions in all customer campaigns. | 
+**coupon_use_attempts** | **Integer** | Number of coupon use attempts in all customer campaigns. | 
+**coupon_failed_attempts** | **Integer** | Number of failed coupon use attempts in all customer campaigns. | 
+**accrued_discounts** | **Float** | Number of accrued discounts in all customer campaigns. | 
+**accrued_revenue** | **Float** | Amount of accrued revenue in all customer campaigns. | 
+**total_orders** | **Integer** | Number of orders in all customer campaigns. | 
+**total_orders_no_coupon** | **Integer** | Number of orders without coupon used in all customer campaigns. | 
+**campaign_name** | **String** | The name of the campaign this customer belongs to. | 
+
+

data/docs/CustomerAnalytics.md

@@ -0,0 +1,14 @@
+# TalonOne::CustomerAnalytics
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepted_coupons** | **Integer** | Total accepted coupons for this customer | 
+**created_coupons** | **Integer** | Total created coupons for this customer | 
+**free_items** | **Integer** | Total free items given to this customer | 
+**total_orders** | **Integer** | Total orders made by this customer | 
+**total_discounted_orders** | **Integer** | Total orders made by this customer that had a discount | 
+**total_revenue** | **Float** | Total Revenue across all closed sessions | 
+**total_discounts** | **Float** | The sum of discounts that were given across all closed sessions | 
+
+

data/docs/CustomerProfile.md

@@ -0,0 +1,15 @@
+# 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 | 
+**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 | 
+**last_activity** | **DateTime** | Timestamp of the most recent event received from this customer | 
+
+

data/docs/CustomerProfileSearchQuery.md

@@ -0,0 +1,10 @@
+# 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] 
+**integration_i_ds** | **Array<String>** |  | [optional] 
+**profile_i_ds** | **Array<Integer>** |  | [optional] 
+
+

data/docs/CustomerSession.md

@@ -0,0 +1,20 @@
+# TalonOne::CustomerSession
+
+## 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** | **String** | Any coupon code entered. | 
+**referral** | **String** | Any referral code entered. | 
+**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) | 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. | 
+**discounts** | **Hash<String, Float>** | A map of labelled discount values, values will be in the same currency as the application associated with the session. | 
+
+

data/docs/EmailEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::EmailEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address associated with your account. | 
+
+

data/docs/Entity.md

@@ -0,0 +1,9 @@
+# TalonOne::Entity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+
+

data/docs/Environment.md

@@ -0,0 +1,14 @@
+# TalonOne::Environment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**slots** | [**Array<SlotDef>**](SlotDef.md) | The slots defined for this application. | 
+**functions** | [**Array<FunctionDef>**](FunctionDef.md) | The functions defined for this application. | 
+**templates** | [**Array<TemplateDef>**](TemplateDef.md) | The templates defined for this application. | 
+**variables** | **String** |  | 
+
+

data/docs/ErrorResponse.md

@@ -0,0 +1,9 @@
+# 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] 
+
+

data/docs/ErrorSource.md

@@ -0,0 +1,10 @@
+# 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] 
+
+

data/docs/Event.md

@@ -0,0 +1,17 @@
+# TalonOne::Event
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**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. | [optional] 
+**session_id** | **String** | The ID of the session that this event occurred in. | 
+**type** | **String** | A string representing the event. Must not be a reserved event name. | 
+**attributes** | **Object** | Arbitrary additional JSON data associated with the event. | 
+**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] 
+
+

data/docs/EventType.md

@@ -0,0 +1,19 @@
+# TalonOne::EventType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
+**title** | **String** | The human-friendly display name for this event type. Use a short, past-tense, description of the event. | 
+**name** | **String** | The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created. | 
+**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] 
+**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`.  | 
+
+

data/docs/Export.md

@@ -0,0 +1,13 @@
+# TalonOne::Export
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**user_id** | **Integer** | The ID of the account that owns this entity. | 
+**entity** | **String** | The name of the entity that was exported. | 
+**filter** | **Object** | Map of keys and values that were used to filter the exported rows | 
+
+

data/docs/FeatureFlag.md

@@ -0,0 +1,11 @@
+# TalonOne::FeatureFlag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name for the featureflag | 
+**value** | **String** | The value for the featureflag | 
+**created** | **DateTime** | The exact moment this entity was last created. | [optional] 
+**modified** | **DateTime** | The exact moment this entity was last modified. | [optional] 
+
+

data/docs/FeatureFlags.md

@@ -0,0 +1,11 @@
+# TalonOne::FeatureFlags
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**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] 
+
+

data/docs/FeaturesFeed.md

@@ -0,0 +1,9 @@
+# TalonOne::FeaturesFeed
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** |  | [optional] 
+**pub_date** | **String** |  | [optional] 
+
+

data/docs/FuncArgDef.md

@@ -0,0 +1,9 @@
+# TalonOne::FuncArgDef
+
+## 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. | 
+
+

data/docs/FunctionDef.md

@@ -0,0 +1,12 @@
+# TalonOne::FunctionDef
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The function name used in Talang. | 
+**type** | **String** | The type of this function argument. | 
+**description** | **String** | A short description of the function. | [optional] 
+**help** | **String** | Extended help text for the function. | [optional] 
+**args** | [**Array<FuncArgDef>**](FuncArgDef.md) | An array of argument definitions. | 
+
+

data/docs/Import.md

@@ -0,0 +1,13 @@
+# TalonOne::Import
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**account_id** | **Integer** | The ID of the account that owns this entity. | 
+**user_id** | **Integer** | The ID of the account that owns this entity. | 
+**entity** | **String** | The name of the entity that was imported. | 
+**amount** | **Integer** | The number of members that imported. | 
+
+