talon_one 0.1.3 → 1.1.0

data/docs/ManagerConfig.md

@@ -0,0 +1,8 @@
+# TalonOne::ManagerConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema_version** | **Integer** |  | 
+
+

data/docs/Meta.md

@@ -0,0 +1,11 @@
+# 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] 
+**coupon_rejection_reason** | [**CouponRejectionReason**](CouponRejectionReason.md) |  | [optional] 
+**warnings** | **Object** |  | [optional] 
+
+

data/docs/MiscUpdateUserLatestFeature.md

@@ -0,0 +1,8 @@
+# TalonOne::MiscUpdateUserLatestFeature
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**latest_feature** | **String** |  | [optional] 
+
+

data/docs/MultiApplicationEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::MultiApplicationEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
+
+

data/docs/MutableEntity.md

@@ -0,0 +1,8 @@
+# TalonOne::MutableEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**modified** | **DateTime** | The exact moment this entity was last modified. | 
+
+

data/docs/NewAccount.md

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

data/docs/NewAccountSignUp.md

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

data/docs/NewApplication.md

@@ -0,0 +1,15 @@
+# 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] 
+**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
+
+

data/docs/NewApplicationAPIKey.md

@@ -0,0 +1,15 @@
+# TalonOne::NewApplicationAPIKey
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the API Key | 
+**created_by** | **Integer** | ID of user who created | 
+**title** | **String** | Title for API Key | 
+**account_id** | **Integer** | ID of account the key is used for | 
+**application_id** | **Integer** | ID of application the key is used for | 
+**created** | **DateTime** | The date the API key was created | 
+**expires** | **DateTime** | The date the API key expired | 
+**key** | **String** | Raw API Key | 
+
+

data/docs/NewApplicationStorage.md

@@ -0,0 +1,10 @@
+# TalonOne::NewApplicationStorage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Identifier for the information to be saved, e.g. \"Loyalty points for SKU\". | 
+**datatype** | **Object** | A JSON Schema describing the information to be saved in the storage | 
+**description** | **String** | Description of the application store | [optional] 
+
+

data/docs/NewApplicationStorageData.md

@@ -0,0 +1,7 @@
+# TalonOne::NewApplicationStorageData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/NewApplicationStorageTuple.md

@@ -0,0 +1,9 @@
+# TalonOne::NewApplicationStorageTuple
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | Key information that will map to a value, e.g. SKU number \"LEV-JN-SL-36-GN\". | 
+**value** | **Object** |  | 
+
+

data/docs/NewAttribute.md

@@ -0,0 +1,15 @@
+# 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.  | 
+**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. | 
+
+

data/docs/NewCampaign.md

@@ -0,0 +1,19 @@
+# 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] 
+**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. | 
+**features** | **Array<String>** | A list of features for the campaign. | 
+**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 | 
+
+

data/docs/NewCampaignSet.md

@@ -0,0 +1,9 @@
+# TalonOne::NewCampaignSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**application_id** | **Integer** | The ID of the application that owns this entity. | 
+**set** | [**CampaignSetBranchNode**](CampaignSetBranchNode.md) |  | 
+
+

data/docs/NewCoupons.md

@@ -0,0 +1,16 @@
+# 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.  | 
+**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] 
+**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile | [optional] 
+
+

data/docs/NewCustomerProfile.md

@@ -0,0 +1,8 @@
+# TalonOne::NewCustomerProfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | **Object** | Arbitrary properties associated with this item | [optional] 
+
+

data/docs/NewCustomerSession.md

@@ -0,0 +1,15 @@
+# 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] 
+**coupon** | **String** | Any coupon code entered. | [optional] 
+**referral** | **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) | 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] 
+
+

data/docs/NewEvent.md

@@ -0,0 +1,11 @@
+# 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] 
+**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. | 
+
+

data/docs/NewEventType.md

@@ -0,0 +1,17 @@
+# TalonOne::NewEventType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/NewFeatureFlags.md

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

data/docs/NewImport.md

@@ -0,0 +1,8 @@
+# TalonOne::NewImport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity** | **String** | The name of the entity that was imported. | 
+
+

data/docs/NewInvitation.md

@@ -0,0 +1,11 @@
+# TalonOne::NewInvitation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the user being invited. | [optional] 
+**email** | **String** |  | 
+**acl** | **String** | a blob of acl json | 
+**roles** | **Array<Integer>** | An array of roleIDs to assign the new user to | [optional] 
+
+

data/docs/NewInviteEmail.md

@@ -0,0 +1,9 @@
+# TalonOne::NewInviteEmail
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | 
+**token** | **String** |  | 
+
+

data/docs/NewLoyaltyProgram.md

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

data/docs/NewPassword.md

@@ -0,0 +1,9 @@
+# TalonOne::NewPassword
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**password** | **String** | The new password for your account. | 
+**reset_token** | **String** |  | 
+
+

data/docs/NewPasswordEmail.md

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

data/docs/NewReferral.md

@@ -0,0 +1,12 @@
+# TalonOne::NewReferral
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
+**advocate_profile_integration_id** | **String** | The Integration Id of the Advocate's Profile | 
+**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
+**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] 
+
+

data/docs/NewRole.md

@@ -0,0 +1,11 @@
+# TalonOne::NewRole
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the role | 
+**description** | **String** | Description of the role | [optional] 
+**acl** | **String** | Role Policy this should be a stringified blob of json | 
+**users** | **Array<Integer>** | An array of userIDs | 
+
+

data/docs/NewRuleset.md

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

data/docs/NewTemplateDef.md

@@ -0,0 +1,14 @@
+# TalonOne::NewTemplateDef
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Campaigner-friendly name for the template that will be shown in the rule editor. | 
+**description** | **String** | A short description of the template that will be shown in the rule editor. | [optional] 
+**help** | **String** | Extended help text for the template. | [optional] 
+**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]
+
+

data/docs/NewUser.md

@@ -0,0 +1,11 @@
+# TalonOne::NewUser
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address associated with your account. | 
+**password** | **String** | The password for your account. | 
+**name** | **String** | Your name. | [optional] 
+**invite_token** | **String** |  | 
+
+

data/docs/NewWebhook.md

@@ -0,0 +1,15 @@
+# TalonOne::NewWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**application_ids** | **Array<Integer>** | The IDs of the applications that are related to this entity. | 
+**title** | **String** | Friendly title for this webhook | 
+**verb** | **String** | API method for this webhook | 
+**url** | **String** | API url (supports templating using parameters) for this webhook | 
+**headers** | **Array<String>** | List of API HTTP headers for this webhook | 
+**payload** | **String** | API payload (supports templating using parameters) for this webhook | [optional] 
+**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions | 
+**enabled** | **BOOLEAN** | Enables or disables webhook from showing in rule builder | 
+
+

data/docs/Referral.md

@@ -0,0 +1,17 @@
+# TalonOne::Referral
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Unique ID for this entity. | 
+**created** | **DateTime** | The exact moment this entity was created. | 
+**campaign_id** | **Integer** | ID of the campaign from which the referral received the referral code. | 
+**advocate_profile_integration_id** | **String** | The Integration Id of the Advocate's Profile | 
+**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile | [optional] 
+**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** | **String** | The actual referral code. | 
+**usage_counter** | **Integer** | The number of times this referral code has been successfully used. | 
+**usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply.  | 
+
+