docs/Event.md in talon_one-2.5.1 vs docs/Event.md in talon_one-3.0.0
- old
+ new
@@ -2,18 +2,18 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**id** | **Integer** | Unique ID for this entity. |
-**created** | **DateTime** | The exact moment this entity was created. |
+**id** | **Integer** | Internal ID of this entity. |
+**created** | **DateTime** | The time 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. **Note:** If the customer does not yet have a known profileId, we recommend you use a guest profileId. | [optional]
+**profile_id** | **String** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional]
**type** | **String** | A string representing the event. Must not be a reserved event name. |
**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. See the list of [effects](/docs/dev/integration-api/api-effects). |
+**effects** | **Array<Object>** | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). |
**ledger_entries** | [**Array<LedgerEntry>**](LedgerEntry.md) | Ledger entries for the event. |
**meta** | [**Meta**](Meta.md) | | [optional]
## Code Sample
@@ -22,13 +22,13 @@
instance = TalonOne::Event.new(id: 6,
created: 2020-06-10T09:05:27.993483Z,
application_id: 322,
profile_id: URNGV8294NV,
- type: pageViews,
+ type: pageViewed,
attributes: {"myAttribute":"myValue"},
session_id: 175KJPS947296,
- effects: [addItemToCart],
+ effects: null,
ledger_entries: null,
meta: null)
```