talon_one 2.1.1 → 2.2.0

data/docs/IntegrationEntity.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**integration_id** | **String** | The ID used for this entity in the application system. | 
+**integration_id** | **String** | The integration ID for this entity sent to and used in the Talon.One system. | 
 **created** | **DateTime** | The exact moment this entity was created. | 
 
 ## Code Sample

data/docs/LoyaltyLedgerEntry.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **event_id** | **Integer** |  | [optional] 
 **type** | **String** | The type of the ledger transaction. Possible values are addition, subtraction, expire or expiring (for expiring points ledgers)  | 
 **amount** | **Float** |  | 
+**start_date** | **DateTime** |  | [optional] 
 **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 | 
@@ -28,6 +29,7 @@ instance = TalonOne::LoyaltyLedgerEntry.new(created: null,
                                  event_id: null,
                                  type: null,
                                  amount: null,
+                                 start_date: null,
                                  expiry_date: null,
                                  name: null,
                                  sub_ledger_id: null,

data/docs/LoyaltyPoints.md

@@ -6,7 +6,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **points** | **Float** | Amount of loyalty points | 
 **name** | **String** | Allows to specify a name for the addition or deduction | [optional] 
-**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] 
+**validity_duration** | **String** | Indicates the duration after which the added loyalty points should expire. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] 
+**pending_duration** | **String** | Indicates the amount of time before the points are considered valid. The format is a number followed by one letter indicating the time unit, like '1h' or '40m' (defined by Go time package). | [optional] 
 **sub_ledger_id** | **String** | This specifies if we are adding loyalty points to the main ledger or a subledger | [optional] 
 
 ## Code Sample
@@ -16,7 +17,8 @@ require 'TalonOne'
 
 instance = TalonOne::LoyaltyPoints.new(points: null,
                                  name: null,
-                                 expiry_duration: null,
+                                 validity_duration: null,
+                                 pending_duration: null,
                                  sub_ledger_id: null)
 ```
 

data/docs/LoyaltyProgram.md

@@ -10,7 +10,8 @@ Name | Type | Description | Notes
 **title** | **String** | The display title for the Loyalty Program. | 
 **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'. | 
+**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'. | 
+**default_pending** | **String** | Indicates the default duration for the pending time, after which points will be valid. The format is a number followed by a duration unit, like '1h' or '40m'. | 
 **allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program | 
 
 ## Code Sample
@@ -25,6 +26,7 @@ instance = TalonOne::LoyaltyProgram.new(id: null,
                                  description: null,
                                  subscribed_applications: null,
                                  default_validity: null,
+                                 default_pending: null,
                                  allow_subledger: null)
 ```
 

data/docs/LoyaltyStatistics.md

@@ -0,0 +1,23 @@
+# TalonOne::LoyaltyStatistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_active_points** | **Float** | Total of active points for this loyalty program | 
+**total_pending_points** | **Float** | Total of pending points for this loyalty program | 
+**total_spent_points** | **Float** | Total of spent points for this loyalty program | 
+**total_expired_points** | **Float** | Total of expired points for this loyalty program | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::LoyaltyStatistics.new(total_active_points: null,
+                                 total_pending_points: null,
+                                 total_spent_points: null,
+                                 total_expired_points: null)
+```
+
+

data/docs/LoyaltySubLedger.md

@@ -4,9 +4,16 @@
 
 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] 
+**total** | **Float** | ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance  | 
+**total_active_points** | **Float** | Total amount of currently active and available points in the customer's balance | 
+**total_pending_points** | **Float** | Total amount of pending points, which are not active yet but will become active in the future | 
+**total_spent_points** | **Float** | Total amount of points already spent by this customer | 
+**total_expired_points** | **Float** | Total amount of points, that expired without ever being spent | 
+**transactions** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all events that have happened such as additions, subtractions and expiries | [optional] 
+**expiring_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points that will expire | [optional] 
+**active_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all currently active points | [optional] 
+**pending_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points pending activation | [optional] 
+**expired_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of expired points | [optional] 
 
 ## Code Sample
 
@@ -14,8 +21,15 @@ Name | Type | Description | Notes
 require 'TalonOne'
 
 instance = TalonOne::LoyaltySubLedger.new(total: null,
+                                 total_active_points: null,
+                                 total_pending_points: null,
+                                 total_spent_points: null,
+                                 total_expired_points: null,
                                  transactions: null,
-                                 expiring_points: null)
+                                 expiring_points: null,
+                                 active_points: null,
+                                 pending_points: null,
+                                 expired_points: null)
 ```
 
 

data/docs/ManagementApi.md

@@ -61,6 +61,7 @@ Method | HTTP request | Description
 [**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
 [**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
 [**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
+[**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
 [**get_referrals**](ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
 [**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
 [**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
@@ -1527,7 +1528,7 @@ Name | Type | Description  | Notes
 
 ## get_application_customers
 
-> InlineResponse20012 get_application_customers(application_id)
+> InlineResponse20012 get_application_customers(application_id, opts)
 
 List Application Customers
 
@@ -1546,10 +1547,16 @@ end
 
 api_instance = TalonOne::ManagementApi.new
 application_id = 56 # Integer | 
+opts = {
+  integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
+  page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
+  skip: 56, # Integer | Skips the given number of items when paging through large result sets.
+  with_total_result_size: true # Boolean | When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query. 
+}
 
 begin
   #List Application Customers
-  result = api_instance.get_application_customers(application_id)
+  result = api_instance.get_application_customers(application_id, opts)
   p result
 rescue TalonOne::ApiError => e
   puts "Exception when calling ManagementApi->get_application_customers: #{e}"
@@ -1562,6 +1569,10 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **application_id** | **Integer**|  | 
+ **integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional] 
+ **page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional] 
+ **skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional] 
+ **with_total_result_size** | **Boolean**| When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.  | [optional] 
 
 ### Return type
 
@@ -1942,10 +1953,11 @@ opts = {
   sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
   profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
   state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
+  created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date
+  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date
   coupon: 'coupon_example', # String | Filter by sessions with this coupon. Must be exact match.
   referral: 'referral_example', # String | Filter by sessions with this referral. Must be exact match.
-  integration_id: 'integration_id_example', # String | Filter by sessions with this integrationId. Must be exact match.
-  customer_id: 'customer_id_example' # String | Filter by integration ID of the customer for the session
+  integration_id: 'integration_id_example' # String | Filter by sessions with this integrationId. Must be exact match.
 }
 
 begin
@@ -1968,10 +1980,11 @@ Name | Type | Description  | Notes
  **sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional] 
  **profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional] 
  **state** | **String**| Filter by sessions with this state. Must be exact match. | [optional] 
+ **created_before** | **DateTime**| Only return events created before this date | [optional] 
+ **created_after** | **DateTime**| Only return events created after this date | [optional] 
  **coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional] 
  **referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional] 
  **integration_id** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional] 
- **customer_id** | **String**| Filter by integration ID of the customer for the session | [optional] 
 
 ### Return type
 
@@ -2372,7 +2385,8 @@ opts = {
   name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
   tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values 
   created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
-  created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
+  created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
+  campaign_group_id: 56 # Integer | Filter results to campaigns owned by the specified campaign group ID.
 }
 
 begin
@@ -2398,6 +2412,7 @@ Name | Type | Description  | Notes
  **tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values  | [optional] 
  **created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional] 
  **created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional] 
+ **campaign_group_id** | **Integer**| Filter results to campaigns owned by the specified campaign group ID. | [optional] 
 
 ### Return type
 
@@ -3099,7 +3114,7 @@ Name | Type | Description  | Notes
 
 ## get_customer_profile
 
-> ApplicationCustomer get_customer_profile(application_id, customer_id)
+> ApplicationCustomer get_customer_profile(customer_id)
 
 Get Customer Profile
 
@@ -3117,12 +3132,11 @@ TalonOne.configure do |config|
 end
 
 api_instance = TalonOne::ManagementApi.new
-application_id = 56 # Integer | 
 customer_id = 56 # Integer | 
 
 begin
   #Get Customer Profile
-  result = api_instance.get_customer_profile(application_id, customer_id)
+  result = api_instance.get_customer_profile(customer_id)
   p result
 rescue TalonOne::ApiError => e
   puts "Exception when calling ManagementApi->get_customer_profile: #{e}"
@@ -3134,7 +3148,6 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **application_id** | **Integer**|  | 
  **customer_id** | **Integer**|  | 
 
 ### Return type
@@ -3611,6 +3624,58 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
+## get_loyalty_statistics
+
+> LoyaltyStatistics get_loyalty_statistics(program_id)
+
+Get loyalty program statistics by loyalty program ID
+
+### Example
+
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: manager_auth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TalonOne::ManagementApi.new
+program_id = 'program_id_example' # String | 
+
+begin
+  #Get loyalty program statistics by loyalty program ID
+  result = api_instance.get_loyalty_statistics(program_id)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling ManagementApi->get_loyalty_statistics: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **program_id** | **String**|  | 
+
+### Return type
+
+[**LoyaltyStatistics**](LoyaltyStatistics.md)
+
+### Authorization
+
+[manager_auth](../README.md#manager_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_referrals
 
 > InlineResponse2006 get_referrals(application_id, campaign_id, opts)

data/docs/Meta.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **coupons** | [**Object**](.md) | Maps the coupon value to a key-value list of that coupons attributes. | [optional] 
 **coupon_rejection_reason** | [**CouponRejectionReason**](CouponRejectionReason.md) |  | [optional] 
 **referral_rejection_reason** | [**ReferralRejectionReason**](ReferralRejectionReason.md) |  | [optional] 
-**warnings** | [**Object**](.md) |  | [optional] 
+**warnings** | [**Object**](.md) | Contains warnings about possible misuse. | [optional] 
 
 ## Code Sample
 

data/docs/MultipleCustomerProfileIntegrationRequest.md

@@ -0,0 +1,17 @@
+# TalonOne::MultipleCustomerProfileIntegrationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_profiles** | [**Array<MultipleCustomerProfileIntegrationRequestItem>**](MultipleCustomerProfileIntegrationRequestItem.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationRequest.new(customer_profiles: null)
+```
+
+

data/docs/MultipleCustomerProfileIntegrationRequestItem.md

@@ -0,0 +1,19 @@
+# TalonOne::MultipleCustomerProfileIntegrationRequestItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**Object**](.md) | Arbitrary properties associated with this item | [optional] 
+**integration_id** | **String** | The custom identifier for this profile, must be unique within the account. | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationRequestItem.new(attributes: null,
+                                 integration_id: null)
+```
+
+

data/docs/MultipleCustomerProfileIntegrationResponseV2.md

@@ -0,0 +1,17 @@
+# TalonOne::MultipleCustomerProfileIntegrationResponseV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integration_states** | [**Array<IntegrationStateV2>**](IntegrationStateV2.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::MultipleCustomerProfileIntegrationResponseV2.new(integration_states: null)
+```
+
+

data/docs/NewApplication.md

@@ -11,8 +11,12 @@ Name | Type | Description | Notes
 **case_sensitivity** | **String** | A string indicating how should campaigns in this application deal with case sensitivity on coupon codes. | [optional] 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **limits** | [**Array<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
-**campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] 
+**campaign_priority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive). If no value is provided, this is set to \"universal\" | [optional] 
+**exclusive_campaigns_strategy** | **String** | The strategy used when choosing exclusive campaigns for evaluation, can be one of (listOrder, lowestDiscount, highestDiscount). If no value is provided, this is set to \"listOrder\" | [optional] 
+**enable_cascading_discounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
+**enable_flattened_cart_items** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
 **attributes_settings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**sandbox** | **Boolean** | Flag indicating if this is a live or sandbox application | [optional] 
 **key** | **String** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits) | [optional] 
 
 ## Code Sample
@@ -28,7 +32,11 @@ instance = TalonOne::NewApplication.new(name: null,
                                  attributes: null,
                                  limits: null,
                                  campaign_priority: null,
+                                 exclusive_campaigns_strategy: null,
+                                 enable_cascading_discounts: null,
+                                 enable_flattened_cart_items: null,
                                  attributes_settings: null,
+                                 sandbox: null,
                                  key: null)
 ```
 

data/docs/NewApplicationAPIKey.md

@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**title** | **String** | Title for API Key | 
+**expires** | **DateTime** | The date the API key expired | 
+**platform** | **String** | Platform the API key is valid for. | [optional] 
 **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 | 
 
 ## Code Sample
@@ -18,13 +19,14 @@ Name | Type | Description | Notes
 ```ruby
 require 'TalonOne'
 
-instance = TalonOne::NewApplicationAPIKey.new(id: null,
+instance = TalonOne::NewApplicationAPIKey.new(title: null,
+                                 expires: null,
+                                 platform: null,
+                                 id: null,
                                  created_by: null,
-                                 title: null,
                                  account_id: null,
                                  application_id: null,
                                  created: null,
-                                 expires: null,
                                  key: null)
 ```
 

data/docs/NewAudience.md

@@ -0,0 +1,21 @@
+# TalonOne::NewAudience
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The human-friendly display name for this Audience. | 
+**integration** | **String** | Integration that this audience was created in. | 
+**integration_id** | **String** | The ID of this Audience in the third-party integration | 
+
+## Code Sample
+
+```ruby
+require 'TalonOne'
+
+instance = TalonOne::NewAudience.new(name: null,
+                                 integration: null,
+                                 integration_id: null)
+```
+
+