v4.0.3: Partial Returns, Collections (#22)

Exposing collections endpoints, campaigns templates, partial returns support

docs/AccountAnalytics.md

@@ -20,7 +20,8 @@ Name | Type | Description | Notes
 **Roles** | **int** | Total number of roles in the account | 
 **CustomAttributes** | **int** | Total number of custom attributes in the account | 
 **Webhooks** | **int** | Total number of webhooks in the account | 
-**LoyaltyPrograms** | **int** | Total number of loyalty programs in the account | 
+**LoyaltyPrograms** | **int** | Total number of all loyalty programs in the account | 
+**LiveLoyaltyPrograms** | **int** | Total number of live loyalty programs in the account | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/AddLoyaltyPointsEffectProps.md

@@ -1,17 +1,19 @@
 # TalonOne.Model.AddLoyaltyPointsEffectProps
-The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One.
+The properties specific to the \"addLoyaltyPoints\" effect. This gets triggered whenever a validated rule contained an \"add loyalty\" effect. These points are automatically stored and managed inside Talon.One. 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** | The name/description of this loyalty point addition | 
-**ProgramId** | **int** | The ID of the loyalty program where these points were added | 
-**SubLedgerId** | **string** | The ID of the subledger within the loyalty program where these points were added | 
-**Value** | **decimal** | The amount of points that were added | 
-**RecipientIntegrationId** | **string** | The user for whom these points were added | 
-**StartDate** | **DateTime** | Date after which points will be valid | [optional] 
-**ExpiryDate** | **DateTime** | Date after which points will expire | [optional] 
-**TransactionUUID** | **string** | The identifier of this addition in the loyalty ledger | 
+**Name** | **string** | The name/description of this loyalty point addition. | 
+**ProgramId** | **int** | The ID of the loyalty program where these points were added. | 
+**SubLedgerId** | **string** | The ID of the subledger within the loyalty program where these points were added. | 
+**Value** | **decimal** | The amount of points that were added. | 
+**RecipientIntegrationId** | **string** | The user for whom these points were added. | 
+**StartDate** | **DateTime** | Date after which points will be valid. | [optional] 
+**ExpiryDate** | **DateTime** | Date after which points will expire. | [optional] 
+**TransactionUUID** | **string** | The identifier of this addition in the loyalty ledger. | 
+**CartItemPosition** | **decimal** | The index of the item in the cart items list on which the loyal points addition should be applied. | [optional] 
+**CartItemSubPosition** | **decimal** | The sub position is triggered when application flattening is enabled. It indicates to which item the loyalty points addition applies, for cart items with `quantity` > 1.  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Application.md

@@ -10,17 +10,18 @@ Name | Type | Description | Notes
 **Name** | **string** | The name of this application. | 
 **Description** | **string** | A longer description of the application. | [optional] 
 **Timezone** | **string** | A string containing an IANA timezone descriptor. | 
-**Currency** | **string** | A string describing a default currency for new customer sessions. | 
-**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** | [**List<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). 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] 
-**DefaultDiscountScope** | **string** | The default scope to apply \"setDiscount\" effects on if no scope was provided with the effect. | [optional] 
-**EnableCascadingDiscounts** | **bool** | Indicates if discounts should cascade for this application | [optional] 
-**EnableFlattenedCartItems** | **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one | [optional] 
+**Currency** | **string** | The default currency for new customer sessions. | 
+**CaseSensitivity** | **string** | The case sensitivity behavior to check coupon codes in the campaigns of this Application. | [optional] 
+**Attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign. | [optional] 
+**Limits** | [**List<LimitConfig>**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] 
+**CampaignPriority** | **string** | Default [priority](https://docs.talon.one/docs/product/applications/setting-up-campaign-priorities) for campaigns created in this Application.  | [optional] [default to CampaignPriorityEnum.Universal]
+**ExclusiveCampaignsStrategy** | **string** | The strategy used when choosing exclusive campaigns for evaluation. | [optional] [default to ExclusiveCampaignsStrategyEnum.ListOrder]
+**DefaultDiscountScope** | **string** | The default scope to apply `setDiscount` effects on if no scope was provided with the effect.  | [optional] 
+**EnableCascadingDiscounts** | **bool** | Indicates if discounts should cascade for this Application. | [optional] 
+**EnableFlattenedCartItems** | **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one. See [the docs](https://docs.talon.one/docs/product/campaigns/campaign-evaluation/#flattened-cart-items).  | [optional] 
 **AttributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
-**Sandbox** | **bool** | Indicates if this is a live or sandbox application | [optional] 
+**Sandbox** | **bool** | Indicates if this is a live or sandbox Application. | [optional] 
+**EnablePartialDiscounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] 
 **LoyaltyPrograms** | [**List<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ApplicationAPIKey.md

@@ -5,7 +5,7 @@ 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] 
+**Platform** | **string** | The third-party platform the API key is valid for. Use `none` for a generic API key to be used from your own intergration layer.  | [optional] 
 **Id** | **int** | ID of the API Key | 
 **CreatedBy** | **int** | ID of user who created | 
 **AccountID** | **int** | ID of account the key is used for | 

docs/ApplicationCustomer.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **TotalSales** | **decimal** | Sum of all purchases made by this customer | 
 **LoyaltyMemberships** | [**List<LoyaltyMembership>**](LoyaltyMembership.md) | A list of loyalty programs joined by the customer | [optional] 
 **AudienceMemberships** | [**List<AudienceMembership>**](AudienceMembership.md) | A list of audiences the customer belongs to | [optional] 
-**LastActivity** | **DateTime** | Timestamp of the most recent event received from this customer | 
+**LastActivity** | **DateTime** | Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the rule-engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay).  For example, [reserving a coupon](https://docs.talon.one/integration-api/#operation/createCouponReservation) for a customer doesn't impact this field.  | 
 **AdvocateIntegrationId** | **string** | The Integration ID of the Customer Profile that referred this Customer in the Application. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/ApplicationNotification.md

@@ -0,0 +1,9 @@
+# TalonOne.Model.ApplicationNotification
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Event** | **string** | Event type. It can be one of the following: ['campaign_priorities_changed']  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/AsyncCouponCreationResponse.md

@@ -0,0 +1,9 @@
+# TalonOne.Model.AsyncCouponCreationResponse
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**BatchId** | **string** | The batch ID that all coupons created by the request will have. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/Attribute.md

@@ -13,8 +13,11 @@ Name | Type | Description | Notes
 **Type** | **string** | The data type of the attribute, a `time` attribute must be sent as a string that conforms to the [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp format. | 
 **Description** | **string** | A description of this attribute. | 
 **Suggestions** | **List<string>** | A list of suggestions for the attribute. | 
+**HasAllowedList** | **bool** | Whether or not this attribute has an allowed list of values associated with it. | [optional] [default to false]
+**RestrictedBySuggestions** | **bool** | Whether or not this attribute's value is restricted by suggestions (`suggestions` property) or by an allowed list of value (`hasAllowedList` property).  | [optional] [default to false]
 **Editable** | **bool** | Whether or not this attribute can be edited. | 
 **SubscribedApplicationsIds** | **List<int>** | A list of the IDs of the applications that are subscribed to this attribute | [optional] 
+**EventTypeId** | **int** |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Audience.md

@@ -6,9 +6,9 @@ Name | Type | Description | Notes
 **AccountId** | **int** | The ID of the account that owns this entity. | 
 **Id** | **int** | Unique ID for this entity. | 
 **Created** | **DateTime** | The exact moment this entity was created. | 
-**Name** | **string** | The human-friendly display name for this Audience. | 
-**Integration** | **string** | Integration that this audience was created in. | 
-**IntegrationId** | **string** | The ID of this Audience in the third-party integration | 
+**Name** | **string** | The human-friendly display name for this audience. | 
+**Integration** | **string** | Integration that this audience was created in. Can be used for mParticle and Segment audiences. | [optional] 
+**IntegrationId** | **string** | The ID of this audience in the third-party integration. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/BaseLoyaltyProgram.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **DefaultValidity** | **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'. | [optional] 
 **DefaultPending** | **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'. | [optional] 
 **AllowSubledger** | **bool** | Indicates if this program supports subledgers inside the program | [optional] 
-**Timezone** | **string** | A string containing an IANA timezone descriptor. | [optional] 
+**UsersPerCardLimit** | **int** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`.  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/Binding.md

@@ -4,8 +4,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Name** | **string** | A descriptive name for the value to be bound. | 
-**Type** | **string** | The kind of binding. Possible values are cartItemFilter, subledgerBalance. | [optional] 
+**Type** | **string** | The kind of binding. Possible values are: - `cartItemFilter` - `subledgerBalance` - `templateParameter`  | [optional] 
 **Expression** | **List<Object>** | A Talang expression that will be evaluated and its result attached to the name of the binding. | 
+**ValueType** | **string** | Can be one of the following: - `string` - `number` - `boolean`  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/BulkApplicationNotification.md

@@ -0,0 +1,10 @@
+# TalonOne.Model.BulkApplicationNotification
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**TotalResultSize** | **int** |  | 
+**Data** | [**List<ApplicationNotification>**](ApplicationNotification.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/BulkCampaignNotification.md

@@ -0,0 +1,10 @@
+# TalonOne.Model.BulkCampaignNotification
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**TotalResultSize** | **int** |  | 
+**Data** | [**List<CampaignNotification>**](CampaignNotification.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/Campaign.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 **EndTime** | **DateTime** | Timestamp the campaign will become inactive. | [optional] 
 **Attributes** | [**Object**](.md) | Arbitrary properties associated with this campaign | [optional] 
 **State** | **string** | A disabled or archived campaign is not evaluated for rules or coupons.  | [default to StateEnum.Enabled]
-**ActiveRulesetId** | **int** | ID of Ruleset this campaign applies on customer session evaluation. | [optional] 
+**ActiveRulesetId** | **int** | [ID of Ruleset](https://docs.talon.one/management-api/#operation/getRulesets) this campaign applies on customer session evaluation.  | [optional] 
 **Tags** | **List<string>** | A list of tags for the campaign. | 
-**Features** | **List<string>** | A list of features for the campaign. | 
+**Features** | **List<string>** | The features enabled in this campaign. | 
 **CouponSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
 **ReferralSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) |  | [optional] 
-**Limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of limits that will operate for this campaign | 
-**CampaignGroups** | **List<int>** | The IDs of the campaign groups that own this entity. | [optional] 
+**Limits** | [**List<LimitConfig>**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/) for this campaign.  | 
+**CampaignGroups** | **List<int>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups/) this campaign belongs to.  | [optional] 
 **CouponRedemptionCount** | **int** | Number of coupons redeemed in the campaign. | [optional] 
 **ReferralRedemptionCount** | **int** | Number of referral codes redeemed in the campaign. | [optional] 
 **DiscountCount** | **decimal** | Total amount of discounts redeemed in the campaign. | [optional] 

docs/CampaignCreatedNotification.md

@@ -0,0 +1,10 @@
+# TalonOne.Model.CampaignCreatedNotification
+A notification regarding a campaign that was created.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Campaign** | [**Campaign**](Campaign.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/CampaignDeletedNotification.md

@@ -0,0 +1,10 @@
+# TalonOne.Model.CampaignDeletedNotification
+A notification regarding a campaign that was deleted.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Campaign** | [**Campaign**](Campaign.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/CampaignEditedNotification.md

@@ -0,0 +1,11 @@
+# TalonOne.Model.CampaignEditedNotification
+A notification regarding a campaign which was edited.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Campaign** | [**Campaign**](Campaign.md) |  | 
+**OldCampaign** | [**Campaign**](Campaign.md) |  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/CampaignNotification.md

@@ -0,0 +1,9 @@
+# TalonOne.Model.CampaignNotification
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Event** | **string** | The type of the event. Can be one of the following: ['campaign_state_changed', 'campaign_ruleset_changed', 'campaign_edited', 'campaign_created', 'campaign_deleted']  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+

docs/CampaignPrioritiesChangedNotification.md

@@ -0,0 +1,12 @@
+# TalonOne.Model.CampaignPrioritiesChangedNotification
+Notification about an Application whose campaigns' priorities changed.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Application** | [**Application**](Application.md) |  | 
+**OldPriorities** | **Dictionary<string, List<int>>** | Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive']  | [optional] 
+**Priorities** | **Dictionary<string, List<int>>** | Campaign IDs for each priority. The priority can be one of: ['universal', 'stackable', 'exclusive']  | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+