talon_one 1.4.0

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. | 
+
+

data/docs/ImportCoupons.md

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

data/docs/InlineResponse200.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<CustomerProfile>**](CustomerProfile.md) |  | 
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Coupon>**](Coupon.md) |  | 
+
+

data/docs/InlineResponse20010.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20010
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) |  | 
+
+

data/docs/InlineResponse20011.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20011
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<CampaignAnalytics>**](CampaignAnalytics.md) |  | 
+
+

data/docs/InlineResponse20012.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20012
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<ApplicationCustomer>**](ApplicationCustomer.md) |  | 
+
+

data/docs/InlineResponse20013.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20013
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<ApplicationCustomer>**](ApplicationCustomer.md) |  | 
+
+

data/docs/InlineResponse20014.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20014
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<CustomerActivityReport>**](CustomerActivityReport.md) |  | 
+
+

data/docs/InlineResponse20015.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20015
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<CustomerActivityReport>**](CustomerActivityReport.md) |  | 
+
+

data/docs/InlineResponse20016.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20016
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<ApplicationSession>**](ApplicationSession.md) |  | 
+
+

data/docs/InlineResponse20017.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20017
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<ApplicationEvent>**](ApplicationEvent.md) |  | 
+
+

data/docs/InlineResponse20018.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20018
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<ApplicationEvent>**](ApplicationEvent.md) |  | 
+
+

data/docs/InlineResponse20019.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20019
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | **Array<String>** |  | 
+
+

data/docs/InlineResponse2002.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2002
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Application>**](Application.md) |  | 
+
+

data/docs/InlineResponse20020.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20020
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Attribute>**](Attribute.md) |  | 
+
+

data/docs/InlineResponse20021.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20021
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Webhook>**](Webhook.md) |  | 
+
+

data/docs/InlineResponse20022.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20022
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<WebhookActivationLogEntry>**](WebhookActivationLogEntry.md) |  | 
+
+

data/docs/InlineResponse20023.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20023
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<WebhookLogEntry>**](WebhookLogEntry.md) |  | 
+
+

data/docs/InlineResponse20024.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20024
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<EventType>**](EventType.md) |  | 
+
+

data/docs/InlineResponse20025.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20025
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<User>**](User.md) |  | 
+
+

data/docs/InlineResponse20026.md

@@ -0,0 +1,10 @@
+# TalonOne::InlineResponse20026
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | [optional] 
+**has_more** | **BOOLEAN** |  | [optional] 
+**data** | [**Array<Change>**](Change.md) |  | 
+
+

data/docs/InlineResponse20027.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20027
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Export>**](Export.md) |  | 
+
+

data/docs/InlineResponse20028.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20028
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Import>**](Import.md) |  | 
+
+

data/docs/InlineResponse20029.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse20029
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Role>**](Role.md) |  | 
+
+

data/docs/InlineResponse2003.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2003
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Campaign>**](Campaign.md) |  | 
+
+

data/docs/InlineResponse2004.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2004
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Ruleset>**](Ruleset.md) |  | 
+
+

data/docs/InlineResponse2005.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2005
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<Coupon>**](Coupon.md) |  | 
+
+

data/docs/InlineResponse2006.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2006
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<Referral>**](Referral.md) |  | 
+
+

data/docs/InlineResponse2007.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2007
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **BOOLEAN** |  | 
+**data** | [**Array<Referral>**](Referral.md) |  | 
+
+

data/docs/InlineResponse2008.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2008
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) |  | 
+
+

data/docs/InlineResponse2009.md

@@ -0,0 +1,9 @@
+# TalonOne::InlineResponse2009
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_result_size** | **Integer** |  | 
+**data** | [**Array<AccessLogEntry>**](AccessLogEntry.md) |  | 
+
+

data/docs/IntegrationApi.md

@@ -0,0 +1,624 @@
+# TalonOne::IntegrationApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_coupon_reservation**](IntegrationApi.md#create_coupon_reservation) | **POST** /v1/coupon_reservations/{couponValue} | Create a new coupon reservation
+[**create_referral**](IntegrationApi.md#create_referral) | **POST** /v1/referrals | Create a referral code for an advocate
+[**delete_coupon_reservation**](IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
+[**delete_customer_data**](IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete the personal data of a customer.
+[**get_customer_inventory**](IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
+[**get_reserved_coupons**](IntegrationApi.md#get_reserved_coupons) | **GET** /v1/coupon_reservations/coupons/{integrationId} | Get all valid reserved coupons
+[**get_reserved_customers**](IntegrationApi.md#get_reserved_customers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
+[**track_event**](IntegrationApi.md#track_event) | **POST** /v1/events | Track an Event
+[**update_customer_profile**](IntegrationApi.md#update_customer_profile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
+[**update_customer_session**](IntegrationApi.md#update_customer_session) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
+
+
+# **create_coupon_reservation**
+> Coupon create_coupon_reservation(coupon_value, body)
+
+Create a new coupon reservation
+
+Creates a coupon reservation for all passed customer profiles on this couponID 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+coupon_value = 'coupon_value_example' # String | The value of a coupon
+
+body = TalonOne::CouponReservations.new # CouponReservations | 
+
+
+begin
+  #Create a new coupon reservation
+  result = api_instance.create_coupon_reservation(coupon_value, body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->create_coupon_reservation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **coupon_value** | **String**| The value of a coupon | 
+ **body** | [**CouponReservations**](CouponReservations.md)|  | 
+
+### Return type
+
+[**Coupon**](Coupon.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_referral**
+> Referral create_referral(body)
+
+Create a referral code for an advocate
+
+Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+body = TalonOne::NewReferral.new # NewReferral | 
+
+
+begin
+  #Create a referral code for an advocate
+  result = api_instance.create_referral(body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->create_referral: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NewReferral**](NewReferral.md)|  | 
+
+### Return type
+
+[**Referral**](Referral.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_coupon_reservation**
+> delete_coupon_reservation(coupon_value, body)
+
+Delete coupon reservations
+
+Removes all passed customer profiles reservation from this coupon 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+coupon_value = 'coupon_value_example' # String | The value of a coupon
+
+body = TalonOne::CouponReservations.new # CouponReservations | 
+
+
+begin
+  #Delete coupon reservations
+  api_instance.delete_coupon_reservation(coupon_value, body)
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->delete_coupon_reservation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **coupon_value** | **String**| The value of a coupon | 
+ **body** | [**CouponReservations**](CouponReservations.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_customer_data**
+> delete_customer_data(integration_id)
+
+Delete the personal data of a customer.
+
+Delete all attributes on the customer profile and on entities that reference that customer profile. 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
+
+
+begin
+  #Delete the personal data of a customer.
+  api_instance.delete_customer_data(integration_id)
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->delete_customer_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_customer_inventory**
+> CustomerInventory get_customer_inventory(integration_id, opts)
+
+Get an inventory of all data associated with a specific customer profile.
+
+Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and referral codes. In the future, this will be expanded with coupon codes and loyalty points.
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
+
+opts = { 
+  profile: nil, # Object | optional flag to decide if you would like customer profile information in the response
+  referrals: nil # Object | optional flag to decide if you would like referral information in the response
+}
+
+begin
+  #Get an inventory of all data associated with a specific customer profile.
+  result = api_instance.get_customer_inventory(integration_id, opts)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->get_customer_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. | 
+ **profile** | [**Object**](.md)| optional flag to decide if you would like customer profile information in the response | [optional] 
+ **referrals** | [**Object**](.md)| optional flag to decide if you would like referral information in the response | [optional] 
+
+### Return type
+
+[**CustomerInventory**](CustomerInventory.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_reserved_coupons**
+> InlineResponse2001 get_reserved_coupons(integration_id)
+
+Get all valid reserved coupons
+
+Returns all coupons this user is subscribed to that are valid and usable 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
+
+
+begin
+  #Get all valid reserved coupons
+  result = api_instance.get_reserved_coupons(integration_id)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->get_reserved_coupons: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. | 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_reserved_customers**
+> InlineResponse200 get_reserved_customers(coupon_value)
+
+Get the users that have this coupon reserved
+
+Returns all users that have this coupon marked as reserved 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+coupon_value = 'coupon_value_example' # String | The value of a coupon
+
+
+begin
+  #Get the users that have this coupon reserved
+  result = api_instance.get_reserved_customers(coupon_value)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->get_reserved_customers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **coupon_value** | **String**| The value of a coupon | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **track_event**
+> IntegrationState track_event(body)
+
+Track an Event
+
+Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information.  The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned.  As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+body = TalonOne::NewEvent.new # NewEvent | 
+
+
+begin
+  #Track an Event
+  result = api_instance.track_event(body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->track_event: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NewEvent**](NewEvent.md)|  | 
+
+### Return type
+
+[**IntegrationState**](IntegrationState.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_customer_profile**
+> IntegrationState update_customer_profile(integration_id, body)
+
+Update a Customer Profile
+
+Update (or create) a [Customer Profile][]. This profile information can then be matched and/or updated by campaign [Rules][].  The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+integration_id = 'integration_id_example' # String | The custom identifier for this profile, must be unique within the account.
+
+body = TalonOne::NewCustomerProfile.new # NewCustomerProfile | 
+
+
+begin
+  #Update a Customer Profile
+  result = api_instance.update_customer_profile(integration_id, body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->update_customer_profile: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **integration_id** | **String**| The custom identifier for this profile, must be unique within the account. | 
+ **body** | [**NewCustomerProfile**](NewCustomerProfile.md)|  | 
+
+### Return type
+
+[**IntegrationState**](IntegrationState.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_customer_session**
+> IntegrationState update_customer_session(customer_session_id, body)
+
+Update a Customer Session
+
+Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session.  The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's.  The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically.  Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.  The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.  [Customer Session]: /Getting-Started/entities#customer-session 
+
+### Example
+```ruby
+# load the gem
+require 'talon_one'
+# setup authorization
+TalonOne.configure do |config|
+  # Configure API key authorization: api_key_v1
+  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'
+
+  # Configure API key authorization: integration_auth
+  config.api_key['Content-Signature'] = '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['Content-Signature'] = 'Bearer'
+end
+
+api_instance = TalonOne::IntegrationApi.new
+
+customer_session_id = 'customer_session_id_example' # String | The custom identifier for this session, must be unique within the account.
+
+body = TalonOne::NewCustomerSession.new # NewCustomerSession | 
+
+
+begin
+  #Update a Customer Session
+  result = api_instance.update_customer_session(customer_session_id, body)
+  p result
+rescue TalonOne::ApiError => e
+  puts "Exception when calling IntegrationApi->update_customer_session: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **customer_session_id** | **String**| The custom identifier for this session, must be unique within the account. | 
+ **body** | [**NewCustomerSession**](NewCustomerSession.md)|  | 
+
+### Return type
+
+[**IntegrationState**](IntegrationState.md)
+
+### Authorization
+
+[api_key_v1](../README.md#api_key_v1), [integration_auth](../README.md#integration_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+