talon_one 1.1.2 → 2.1.0

data/docs/IntegrationEntity.md

@@ -1,9 +1,19 @@
 # TalonOne::IntegrationEntity
 
 ## 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. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationEntity.new(integration_id: null,
+                                 created: null)
+```
+
 

data/docs/IntegrationEvent.md

@@ -1,10 +1,21 @@
 # TalonOne::IntegrationEvent
 
 ## 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. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationEvent.new(profile_id: null,
+                                 type: null,
+                                 attributes: null)
+```
 
 

data/docs/IntegrationProfileEntity.md

@@ -1,8 +1,17 @@
 # TalonOne::IntegrationProfileEntity
 
 ## 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] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationProfileEntity.new(profile_id: null)
+```
+
 

data/docs/IntegrationRequest.md

@@ -0,0 +1,19 @@
+# TalonOne::IntegrationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_session** | [**NewCustomerSessionV2**](NewCustomerSessionV2.md) |  | 
+**response_content** | **Array<String>** | Optional list of requested information to be present on the response related to the customer session update. Currently supported: \"customerSession\", \"customerProfile\", \"coupons\", \"triggeredCampaigns\", \"referral\", \"loyalty\" and \"event\".  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationRequest.new(customer_session: null,
+                                 response_content: null)
+```
+
+

data/docs/IntegrationState.md

@@ -1,11 +1,25 @@
 # TalonOne::IntegrationState
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **session** | [**CustomerSession**](CustomerSession.md) |  | 
 **profile** | [**CustomerProfile**](CustomerProfile.md) |  | 
 **event** | [**Event**](Event.md) |  | 
 **loyalty** | [**Loyalty**](Loyalty.md) |  | [optional] 
+**coupon** | [**Coupon**](Coupon.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationState.new(session: null,
+                                 profile: null,
+                                 event: null,
+                                 loyalty: null,
+                                 coupon: null)
+```
 
 

data/docs/IntegrationStateV2.md

@@ -0,0 +1,35 @@
+# TalonOne::IntegrationStateV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_session** | [**CustomerSessionV2**](CustomerSessionV2.md) |  | [optional] 
+**customer_profile** | [**CustomerProfile**](CustomerProfile.md) |  | [optional] 
+**event** | [**Event**](Event.md) |  | [optional] 
+**loyalty** | [**Loyalty**](Loyalty.md) |  | [optional] 
+**referral** | [**Referral**](Referral.md) |  | [optional] 
+**coupons** | [**Array<Coupon>**](Coupon.md) |  | [optional] 
+**triggered_campaigns** | [**Array<Campaign>**](Campaign.md) |  | [optional] 
+**effects** | [**Array<Effect>**](Effect.md) |  | 
+**created_coupons** | [**Array<Coupon>**](Coupon.md) |  | 
+**created_referrals** | [**Array<Referral>**](Referral.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::IntegrationStateV2.new(customer_session: null,
+                                 customer_profile: null,
+                                 event: null,
+                                 loyalty: null,
+                                 referral: null,
+                                 coupons: null,
+                                 triggered_campaigns: null,
+                                 effects: null,
+                                 created_coupons: null,
+                                 created_referrals: null)
+```
+
+

data/docs/LedgerEntry.md

@@ -1,6 +1,7 @@
 # TalonOne::LedgerEntry
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | Unique ID for this entity. | 
@@ -14,4 +15,21 @@ Name | Type | Description | Notes
 **expiry_date** | **DateTime** | Expiry date of the points | 
 **reference_id** | **Integer** | The ID of the balancing ledgerEntry | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LedgerEntry.new(id: null,
+                                 created: null,
+                                 profile_id: null,
+                                 account_id: null,
+                                 loyalty_program_id: null,
+                                 event_id: null,
+                                 amount: null,
+                                 reason: null,
+                                 expiry_date: null,
+                                 reference_id: null)
+```
+
 

data/docs/LibraryAttribute.md

@@ -1,6 +1,7 @@
 # TalonOne::LibraryAttribute
 
 ## 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. | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **presets** | **Array<String>** | The presets that indicate to which industry the attribute applies to. | 
 **suggestions** | **Array<String>** | Short suggestions that are used to group attributes. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LibraryAttribute.new(entity: null,
+                                 name: null,
+                                 title: null,
+                                 type: null,
+                                 description: null,
+                                 presets: null,
+                                 suggestions: null)
+```
+
 

data/docs/LimitConfig.md

@@ -1,10 +1,21 @@
 # TalonOne::LimitConfig
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **action** | **String** | The limitable action to which this limit will be applied | 
 **limit** | **Float** | The value to set for the limit | 
 **entities** | **Array<String>** | The entities that make the address of this limit | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LimitConfig.new(action: null,
+                                 limit: null,
+                                 entities: null)
+```
+
 

data/docs/LoginParams.md

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

data/docs/Loyalty.md

@@ -1,8 +1,17 @@
 # TalonOne::Loyalty
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **programs** | [**Hash<String, LoyaltyProgramLedgers>**](LoyaltyProgramLedgers.md) | A map holding information about the loyalty programs balance | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::Loyalty.new(programs: null)
+```
+
 

data/docs/LoyaltyLedger.md

@@ -1,9 +1,19 @@
 # TalonOne::LoyaltyLedger
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**ledger** | [**LoyaltySubLedger**](LoyaltySubLedger.md) | The balance of the main ledger in the loyalty program | 
+**ledger** | [**LoyaltySubLedger**](LoyaltySubLedger.md) |  | 
 **sub_ledgers** | [**Hash<String, LoyaltySubLedger>**](LoyaltySubLedger.md) | A map containing a list of all loyalty subledger balances | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyLedger.new(ledger: null,
+                                 sub_ledgers: null)
+```
+
 

data/docs/LoyaltyLedgerEntry.md

@@ -1,6 +1,7 @@
 # TalonOne::LoyaltyLedgerEntry
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **created** | **DateTime** |  | 
@@ -13,5 +14,24 @@ Name | Type | Description | Notes
 **expiry_date** | **DateTime** |  | [optional] 
 **name** | **String** | A name referencing the condition or effect that added this entry, or the specific name provided in an API call. | 
 **sub_ledger_id** | **String** | This specifies if we are adding loyalty points to the main ledger or a subledger | 
+**user_id** | **Integer** | This is the ID of the user who created this entry, if the addition or subtraction was done manually. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyLedgerEntry.new(created: null,
+                                 program_id: null,
+                                 customer_profile_id: null,
+                                 customer_session_id: null,
+                                 event_id: null,
+                                 type: null,
+                                 amount: null,
+                                 expiry_date: null,
+                                 name: null,
+                                 sub_ledger_id: null,
+                                 user_id: null)
+```
 
 

data/docs/LoyaltyMembership.md

@@ -1,9 +1,19 @@
 # TalonOne::LoyaltyMembership
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **joined** | **DateTime** | The moment in which the loyalty program was joined. | [optional] 
 **loyalty_program_id** | **Integer** | The ID of the loyalty program belonging to this entity. | 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyMembership.new(joined: null,
+                                 loyalty_program_id: null)
+```
+
 

data/docs/LoyaltyPoints.md

@@ -1,6 +1,7 @@
 # TalonOne::LoyaltyPoints
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **points** | **Float** | Amount of loyalty points | 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **expiry_duration** | **String** | Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the unit, like '1h' or '40m' or '30d'. | [optional] 
 **sub_ledger_id** | **String** | This specifies if we are adding loyalty points to the main ledger or a subledger | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyPoints.new(points: null,
+                                 name: null,
+                                 expiry_duration: null,
+                                 sub_ledger_id: null)
+```
+
 

data/docs/LoyaltyProgram.md

@@ -1,6 +1,7 @@
 # TalonOne::LoyaltyProgram
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Integer** | The ID of loyalty program. | 
@@ -10,6 +11,21 @@ Name | Type | Description | Notes
 **description** | **String** | Description of our Loyalty Program. | 
 **subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty 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' or '30d'. | 
-**allow_subledger** | **BOOLEAN** | Indicates if this program supports subledgers inside the program | 
+**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyProgram.new(id: null,
+                                 account_id: null,
+                                 name: null,
+                                 title: null,
+                                 description: null,
+                                 subscribed_applications: null,
+                                 default_validity: null,
+                                 allow_subledger: null)
+```
 
 

data/docs/LoyaltyProgramBalance.md

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

data/docs/LoyaltyProgramLedgers.md

@@ -1,11 +1,23 @@
 # TalonOne::LoyaltyProgramLedgers
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **String** | Visable name of loyalty program | 
+**title** | **String** | Visible name of loyalty program | 
 **name** | **String** | Internal name of loyalty program | 
-**ledger** | [**LoyaltyProgramBalance**](LoyaltyProgramBalance.md) | The balance of the main ledger in the loyalty program | 
+**ledger** | [**LoyaltyProgramBalance**](LoyaltyProgramBalance.md) |  | 
 **sub_ledgers** | [**Hash<String, LoyaltyProgramBalance>**](LoyaltyProgramBalance.md) | A map containing a list of all loyalty subledger balances | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyProgramLedgers.new(title: null,
+                                 name: null,
+                                 ledger: null,
+                                 sub_ledgers: null)
+```
+
 

data/docs/LoyaltySubLedger.md

@@ -1,10 +1,21 @@
 # TalonOne::LoyaltySubLedger
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **total** | **Float** |  | 
 **transactions** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | Transactions contains a list of all events that have happened such as additions, subtractions and expiries | [optional] 
 **expiring_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | ExpiringPoints contains a list of all points that will expiry and when | [optional] 
 
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltySubLedger.new(total: null,
+                                 transactions: null,
+                                 expiring_points: null)
+```
+