v4.2.0: Typescript definitions files, Loyalty Programs pending points & statistics, Introducing Loyalty customer inventory

README.md

@@ -15,7 +15,7 @@ The API is available at the same hostname as these docs. For example, if you are
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.1.1
+- Package version: 4.2.0
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -311,9 +311,11 @@ Class | Method | HTTP request | Description
 *TalonOne.IntegrationApi* | [**getCustomerInventory**](docs/IntegrationApi.md#getCustomerInventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | Get an inventory of all data associated with a specific customer profile.
 *TalonOne.IntegrationApi* | [**getReservedCustomers**](docs/IntegrationApi.md#getReservedCustomers) | **GET** /v1/coupon_reservations/customerprofiles/{couponValue} | Get the users that have this coupon reserved
 *TalonOne.IntegrationApi* | [**trackEvent**](docs/IntegrationApi.md#trackEvent) | **POST** /v1/events | Track an Event
-*TalonOne.IntegrationApi* | [**updateCustomerProfile**](docs/IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile
-*TalonOne.IntegrationApi* | [**updateCustomerProfileV2**](docs/IntegrationApi.md#updateCustomerProfileV2) | **PUT** /v2/customer_profiles/{customerProfileId} | Update a Customer Profile
-*TalonOne.IntegrationApi* | [**updateCustomerSession**](docs/IntegrationApi.md#updateCustomerSession) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session
+*TalonOne.IntegrationApi* | [**updateCustomerProfile**](docs/IntegrationApi.md#updateCustomerProfile) | **PUT** /v1/customer_profiles/{integrationId} | Update a Customer Profile V1
+*TalonOne.IntegrationApi* | [**updateCustomerProfileAudiences**](docs/IntegrationApi.md#updateCustomerProfileAudiences) | **POST** /v2/customer_audiences | Update a Customer Profile Audiences
+*TalonOne.IntegrationApi* | [**updateCustomerProfileV2**](docs/IntegrationApi.md#updateCustomerProfileV2) | **PUT** /v2/customer_profiles/{integrationId} | Update a Customer Profile
+*TalonOne.IntegrationApi* | [**updateCustomerProfilesV2**](docs/IntegrationApi.md#updateCustomerProfilesV2) | **PUT** /v2/customer_profiles | Update multiple Customer Profiles
+*TalonOne.IntegrationApi* | [**updateCustomerSession**](docs/IntegrationApi.md#updateCustomerSession) | **PUT** /v1/customer_sessions/{customerSessionId} | Update a Customer Session V1
 *TalonOne.IntegrationApi* | [**updateCustomerSessionV2**](docs/IntegrationApi.md#updateCustomerSessionV2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update a Customer Session
 *TalonOne.ManagementApi* | [**addLoyaltyPoints**](docs/ManagementApi.md#addLoyaltyPoints) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
 *TalonOne.ManagementApi* | [**copyCampaignToApplications**](docs/ManagementApi.md#copyCampaignToApplications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
@@ -372,6 +374,7 @@ Class | Method | HTTP request | Description
 *TalonOne.ManagementApi* | [**getLoyaltyPoints**](docs/ManagementApi.md#getLoyaltyPoints) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
 *TalonOne.ManagementApi* | [**getLoyaltyProgram**](docs/ManagementApi.md#getLoyaltyProgram) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
 *TalonOne.ManagementApi* | [**getLoyaltyPrograms**](docs/ManagementApi.md#getLoyaltyPrograms) | **GET** /v1/loyalty_programs | List all loyalty Programs
+*TalonOne.ManagementApi* | [**getLoyaltyStatistics**](docs/ManagementApi.md#getLoyaltyStatistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
 *TalonOne.ManagementApi* | [**getReferrals**](docs/ManagementApi.md#getReferrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
 *TalonOne.ManagementApi* | [**getReferralsWithoutTotalCount**](docs/ManagementApi.md#getReferralsWithoutTotalCount) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
 *TalonOne.ManagementApi* | [**getRole**](docs/ManagementApi.md#getRole) | **GET** /v1/roles/{roleId} | Get information for the specified role.
@@ -424,12 +427,16 @@ Class | Method | HTTP request | Description
  - [TalonOne.Attribute](docs/Attribute.md)
  - [TalonOne.AttributesMandatory](docs/AttributesMandatory.md)
  - [TalonOne.AttributesSettings](docs/AttributesSettings.md)
+ - [TalonOne.Audience](docs/Audience.md)
+ - [TalonOne.AudienceMembership](docs/AudienceMembership.md)
  - [TalonOne.BaseSamlConnection](docs/BaseSamlConnection.md)
  - [TalonOne.Binding](docs/Binding.md)
  - [TalonOne.Campaign](docs/Campaign.md)
  - [TalonOne.CampaignAnalytics](docs/CampaignAnalytics.md)
  - [TalonOne.CampaignCopy](docs/CampaignCopy.md)
  - [TalonOne.CampaignEntity](docs/CampaignEntity.md)
+ - [TalonOne.CampaignGroup](docs/CampaignGroup.md)
+ - [TalonOne.CampaignGroupEntity](docs/CampaignGroupEntity.md)
  - [TalonOne.CampaignSearch](docs/CampaignSearch.md)
  - [TalonOne.CampaignSet](docs/CampaignSet.md)
  - [TalonOne.CampaignSetBranchNode](docs/CampaignSetBranchNode.md)
@@ -452,15 +459,18 @@ Class | Method | HTTP request | Description
  - [TalonOne.CustomerAnalytics](docs/CustomerAnalytics.md)
  - [TalonOne.CustomerInventory](docs/CustomerInventory.md)
  - [TalonOne.CustomerProfile](docs/CustomerProfile.md)
+ - [TalonOne.CustomerProfileAudienceRequest](docs/CustomerProfileAudienceRequest.md)
+ - [TalonOne.CustomerProfileAudienceRequestItem](docs/CustomerProfileAudienceRequestItem.md)
+ - [TalonOne.CustomerProfileIntegrationRequestV2](docs/CustomerProfileIntegrationRequestV2.md)
  - [TalonOne.CustomerProfileSearchQuery](docs/CustomerProfileSearchQuery.md)
- - [TalonOne.CustomerProfileUpdate](docs/CustomerProfileUpdate.md)
  - [TalonOne.CustomerSession](docs/CustomerSession.md)
  - [TalonOne.CustomerSessionV2](docs/CustomerSessionV2.md)
  - [TalonOne.DeductLoyaltyPointsEffectProps](docs/DeductLoyaltyPointsEffectProps.md)
  - [TalonOne.Effect](docs/Effect.md)
  - [TalonOne.EffectEntity](docs/EffectEntity.md)
  - [TalonOne.EmailEntity](docs/EmailEntity.md)
  - [TalonOne.Entity](docs/Entity.md)
+ - [TalonOne.EntityWithTalangVisibleID](docs/EntityWithTalangVisibleID.md)
  - [TalonOne.Environment](docs/Environment.md)
  - [TalonOne.ErrorEffectProps](docs/ErrorEffectProps.md)
  - [TalonOne.ErrorResponse](docs/ErrorResponse.md)
@@ -470,6 +480,7 @@ Class | Method | HTTP request | Description
  - [TalonOne.FeatureFlag](docs/FeatureFlag.md)
  - [TalonOne.FeatureFlags](docs/FeatureFlags.md)
  - [TalonOne.FeaturesFeed](docs/FeaturesFeed.md)
+ - [TalonOne.FeedNotification](docs/FeedNotification.md)
  - [TalonOne.FuncArgDef](docs/FuncArgDef.md)
  - [TalonOne.FunctionDef](docs/FunctionDef.md)
  - [TalonOne.ImportCoupons](docs/ImportCoupons.md)
@@ -522,21 +533,26 @@ Class | Method | HTTP request | Description
  - [TalonOne.LoyaltyProgram](docs/LoyaltyProgram.md)
  - [TalonOne.LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md)
  - [TalonOne.LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md)
+ - [TalonOne.LoyaltyStatistics](docs/LoyaltyStatistics.md)
  - [TalonOne.LoyaltySubLedger](docs/LoyaltySubLedger.md)
  - [TalonOne.ManagerConfig](docs/ManagerConfig.md)
  - [TalonOne.Meta](docs/Meta.md)
- - [TalonOne.MiscUpdateUserLatestFeature](docs/MiscUpdateUserLatestFeature.md)
  - [TalonOne.ModelExport](docs/ModelExport.md)
  - [TalonOne.ModelImport](docs/ModelImport.md)
  - [TalonOne.MultiApplicationEntity](docs/MultiApplicationEntity.md)
+ - [TalonOne.MultipleCustomerProfileIntegrationRequest](docs/MultipleCustomerProfileIntegrationRequest.md)
+ - [TalonOne.MultipleCustomerProfileIntegrationRequestItem](docs/MultipleCustomerProfileIntegrationRequestItem.md)
+ - [TalonOne.MultipleCustomerProfileIntegrationResponseV2](docs/MultipleCustomerProfileIntegrationResponseV2.md)
  - [TalonOne.MutableEntity](docs/MutableEntity.md)
  - [TalonOne.NewAccount](docs/NewAccount.md)
  - [TalonOne.NewAccountSignUp](docs/NewAccountSignUp.md)
  - [TalonOne.NewAdditionalCost](docs/NewAdditionalCost.md)
  - [TalonOne.NewApplication](docs/NewApplication.md)
  - [TalonOne.NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
  - [TalonOne.NewAttribute](docs/NewAttribute.md)
+ - [TalonOne.NewAudience](docs/NewAudience.md)
  - [TalonOne.NewCampaign](docs/NewCampaign.md)
+ - [TalonOne.NewCampaignGroup](docs/NewCampaignGroup.md)
  - [TalonOne.NewCampaignSet](docs/NewCampaignSet.md)
  - [TalonOne.NewCoupons](docs/NewCoupons.md)
  - [TalonOne.NewCustomerProfile](docs/NewCustomerProfile.md)
@@ -587,14 +603,18 @@ Class | Method | HTTP request | Description
  - [TalonOne.UpdateAccount](docs/UpdateAccount.md)
  - [TalonOne.UpdateApplication](docs/UpdateApplication.md)
  - [TalonOne.UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
+ - [TalonOne.UpdateAudience](docs/UpdateAudience.md)
  - [TalonOne.UpdateCampaign](docs/UpdateCampaign.md)
+ - [TalonOne.UpdateCampaignGroup](docs/UpdateCampaignGroup.md)
  - [TalonOne.UpdateCoupon](docs/UpdateCoupon.md)
  - [TalonOne.UpdateCouponBatch](docs/UpdateCouponBatch.md)
  - [TalonOne.UpdateLoyaltyProgram](docs/UpdateLoyaltyProgram.md)
  - [TalonOne.UpdateRole](docs/UpdateRole.md)
  - [TalonOne.UpdateUser](docs/UpdateUser.md)
+ - [TalonOne.UpdateUserLatestFeedTimestamp](docs/UpdateUserLatestFeedTimestamp.md)
  - [TalonOne.User](docs/User.md)
  - [TalonOne.UserEntity](docs/UserEntity.md)
+ - [TalonOne.UserFeedNotifications](docs/UserFeedNotifications.md)
  - [TalonOne.Webhook](docs/Webhook.md)
  - [TalonOne.WebhookActivationLogEntry](docs/WebhookActivationLogEntry.md)
  - [TalonOne.WebhookLogEntry](docs/WebhookLogEntry.md)

docs/AccountAnalytics.md

@@ -4,20 +4,23 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**applications** | **Number** | Total Number of Applications inside the account | 
-**activeCampaigns** | **Number** | Total Number of Active Applications inside the account | 
-**campaigns** | **Number** | Total Number of campaigns inside the account | 
-**coupons** | **Number** | Total Number of coupons inside the account | 
-**activeCoupons** | **Number** | Total Number of active coupons inside the account | 
-**expiredCoupons** | **Number** | Total Number of expired coupons inside the account | 
-**customAttributes** | **Number** | Total Number of custom attributes inside the account | 
-**referralCodes** | **Number** | Total Number of referral codes inside the account | 
-**activeReferralCodes** | **Number** | Total Number of active referral codes inside the account | 
-**expiredReferralCodes** | **Number** | Total Number of expired referral codes inside the account | 
-**users** | **Number** | Total Number of users inside the account | 
-**roles** | **Number** | Total Number of roles inside the account | 
-**webhooks** | **Number** | Total Number of webhooks inside the account | 
-**loyaltyPrograms** | **Number** | Total Number of loyalty programs inside the account | 
-**activeRules** | **Number** | Total Number of active rules in the account | 
+**applications** | **Number** | Total number of applications in the account | 
+**liveApplications** | **Number** | Total number of live applications in the account | 
+**sandboxApplications** | **Number** | Total number of sandbox applications in the account | 
+**campaigns** | **Number** | Total number of campaigns in the account | 
+**activeCampaigns** | **Number** | Total number of active campaigns in the account | 
+**liveActiveCampaigns** | **Number** | Total number of active campaigns in live applications in the account | 
+**coupons** | **Number** | Total number of coupons in the account | 
+**activeCoupons** | **Number** | Total number of active coupons in the account | 
+**expiredCoupons** | **Number** | Total number of expired coupons in the account | 
+**referralCodes** | **Number** | Total number of referral codes in the account | 
+**activeReferralCodes** | **Number** | Total number of active referral codes in the account | 
+**expiredReferralCodes** | **Number** | Total number of expired referral codes in the account | 
+**activeRules** | **Number** | Total number of active rules in the account | 
+**users** | **Number** | Total number of users in the account | 
+**roles** | **Number** | Total number of roles in the account | 
+**customAttributes** | **Number** | Total number of custom attributes in the account | 
+**webhooks** | **Number** | Total number of webhooks in the account | 
+**loyaltyPrograms** | **Number** | Total number of loyalty programs in the account | 
 
 

docs/AccountLimits.md

@@ -4,17 +4,17 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**liveApplications** | **Number** | Total Number of allowed live applications in the account | 
-**sandboxApplications** | **Number** | Total Number of allowed sandbox applications in the account | 
-**activeCampaigns** | **Number** | Total Number of allowed active campaigns in the account | 
-**coupons** | **Number** | Total Number of allowed coupons in the account | 
-**referralCodes** | **Number** | Total Number of allowed referral codes in the account | 
-**liveLoyaltyPrograms** | **Number** | Total Number of allowed live loyalty programs in the account | 
-**sandboxLoyaltyPrograms** | **Number** | Total Number of allowed sandbox loyalty programs in the account | 
-**webhooks** | **Number** | Total Number of allowed webhooks in the account | 
-**users** | **Number** | Total Number of allowed users in the account | 
-**apiVolume** | **Number** | Total allowed api volume | 
-**activeRules** | **Number** | Total allowed active rulesets | [optional] 
-**promotionTypes** | **[String]** | array of rulesets where webhook is used | 
+**liveApplications** | **Number** | Total number of allowed live applications in the account | 
+**sandboxApplications** | **Number** | Total number of allowed sandbox applications in the account | 
+**activeCampaigns** | **Number** | Total number of allowed active campaigns in live applications in the account | 
+**coupons** | **Number** | Total number of allowed coupons in the account | 
+**referralCodes** | **Number** | Total number of allowed referral codes in the account | 
+**activeRules** | **Number** | Total number of allowed active rulesets in the account | 
+**liveLoyaltyPrograms** | **Number** | Total number of allowed live loyalty programs in the account | 
+**sandboxLoyaltyPrograms** | **Number** | Total number of allowed sandbox loyalty programs in the account | 
+**webhooks** | **Number** | Total number of allowed webhooks in the account | 
+**users** | **Number** | Total number of allowed users in the account | 
+**apiVolume** | **Number** | Allowed volume of API requests to the account | 
+**promotionTypes** | **[String]** | Array of promotion types that are employed in the account | 
 
 

docs/AddLoyaltyPointsEffectProps.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **subLedgerId** | **String** | The ID of the subledger within the loyalty program where these points were added | 
 **value** | **Number** | The amount of points that were added | 
 **recipientIntegrationId** | **String** | The user for whom these points were added | 
-**expiryCondition** | **String** | The amount of time (in days) these points are valid | 
+**startDate** | **Date** | Date after which points will be valid | [optional] 
+**expiryDate** | **Date** | Date after which points will expire | [optional] 
 
 

docs/Application.md

@@ -15,8 +15,12 @@ Name | Type | Description | Notes
 **caseSensitivity** | **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** | [**[LimitConfig]**](LimitConfig.md) | Default limits for campaigns created in this application | [optional] 
-**campaignPriority** | **String** | Default priority for campaigns created in this application, can be one of (universal, stackable, exclusive) | [optional] 
+**campaignPriority** | **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] 
+**exclusiveCampaignsStrategy** | **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] 
+**enableCascadingDiscounts** | **Boolean** | Flag indicating if discounts should cascade for this application | [optional] 
+**enableFlattenedCartItems** | **Boolean** | Flag indicating if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
 **attributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
+**sandbox** | **Boolean** | Flag indicating if this is a live or sandbox application | [optional] 
 **loyaltyPrograms** | [**[LoyaltyProgram]**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
 
@@ -46,3 +50,16 @@ Name | Type | Description | Notes
 
 
 
+
+## Enum: ExclusiveCampaignsStrategyEnum
+
+
+* `listOrder` (value: `"listOrder"`)
+
+* `lowestDiscount` (value: `"lowestDiscount"`)
+
+* `highestDiscount` (value: `"highestDiscount"`)
+
+
+
+

docs/ApplicationAPIKey.md

@@ -4,12 +4,28 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**title** | **String** | Title for API Key | 
+**expires** | **Date** | The date the API key expired | 
+**platform** | **String** | Platform the API key is valid for. | [optional] 
 **id** | **Number** | ID of the API Key | 
 **createdBy** | **Number** | ID of user who created | 
-**title** | **String** | Title for API Key | 
 **accountID** | **Number** | ID of account the key is used for | 
 **applicationID** | **Number** | ID of application the key is used for | 
 **created** | **Date** | The date the API key was created | 
-**expires** | **Date** | The date the API key expired | 
+
+
+
+## Enum: PlatformEnum
+
+
+* `none` (value: `"none"`)
+
+* `segment` (value: `"segment"`)
+
+* `braze` (value: `"braze"`)
+
+* `mparticle` (value: `"mparticle"`)
+
+
 
 

docs/ApplicationCustomer.md

@@ -6,12 +6,13 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **Number** | Unique ID for this entity. | 
 **created** | **Date** | The exact moment this entity was created. The exact moment this entity was created. The exact moment this entity was created. | 
-**integrationId** | **String** | The ID used for this entity in the application system. The ID used for this entity in the application system. | 
+**integrationId** | **String** | The integration ID for this entity sent to and used in the Talon.One system. The integration ID for this entity sent to and used in the Talon.One system. | 
 **attributes** | [**Object**](.md) | Arbitrary properties associated with this item | 
 **accountId** | **Number** | The ID of the Talon.One account that owns this profile. The ID of the Talon.One account that owns this profile. | 
 **closedSessions** | **Number** | The total amount of closed sessions by a customer. A closed session is a successful purchase. | 
 **totalSales** | **Number** | Sum of all purchases made by this customer | 
 **loyaltyMemberships** | [**[LoyaltyMembership]**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] 
+**audienceMemberships** | [**[AudienceMembership]**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] 
 **lastActivity** | **Date** | Timestamp of the most recent event received from this customer |