Merge pull request #29 from talon-one/sc-37684-update-c-sdk

v6.0.0: Achievements
talon-one · Jun 5, 2024 · 96d206f · 96d206f
2 parents 2fba8b1 + b29ed97
commit 96d206f
Show file tree

Hide file tree

Showing 590 changed files with 44,011 additions and 11,617 deletions.
diff --git a/.gitignore b/.gitignore
@@ -184,3 +184,5 @@ $RECYCLE.BIN/
 
 # Visual Studio 2014 CTP
 **/*.sln.ide
+
+.idea
diff --git a/README.md b/README.md
diff --git a/docs/AccountAnalytics.md b/docs/AccountAnalytics.md
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
 **Webhooks** | **int** | Total number of webhooks 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. | 
+**LastUpdatedAt** | **DateTime** | The point in time when the analytics numbers were updated last. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/AccountDashboardStatistic.md b/docs/AccountDashboardStatistic.md
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
 **Discounts** | [**List&lt;AccountDashboardStatisticDiscount&gt;**](AccountDashboardStatisticDiscount.md) | Aggregated statistic for account discount. | [optional] 
 **LoyaltyPoints** | [**List&lt;AccountDashboardStatisticLoyaltyPoints&gt;**](AccountDashboardStatisticLoyaltyPoints.md) | Aggregated statistic for account loyalty points. | [optional] 
 **Referrals** | [**List&lt;AccountDashboardStatisticReferrals&gt;**](AccountDashboardStatisticReferrals.md) | Aggregated statistic for account referrals. | [optional] 
-**ApiCalls** | [**List&lt;AccountDashboardStatisticApiCalls&gt;**](AccountDashboardStatisticApiCalls.md) | Aggregated statistic for the number of account API calls. | [optional] 
 **Campaigns** | [**AccountDashboardStatisticCampaigns**](AccountDashboardStatisticCampaigns.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)

diff --git a/docs/AccountDashboardStatisticCampaigns.md b/docs/AccountDashboardStatisticCampaigns.md
@@ -4,7 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Live** | **int** | Number of campaigns that are active and live (across all Applications). | 
-**EndingSoon** | **int** | Campaigns with a schedule ending in 7 days or with only 10% of budget left. | 
+**EndingSoon** | **int** | Campaigns scheduled to expire sometime in the next 7 days. | 
+**LowOnBudget** | **int** | Campaigns with less than 10% of budget left. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/Achievement.md b/docs/Achievement.md
@@ -0,0 +1,20 @@
+# TalonOne.Model.Achievement
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Id** | **int** | Internal ID of this entity. | 
+**Created** | **DateTime** | The time this entity was created. | 
+**Name** | **string** | The internal name of the achievement used in API requests.  **Note**: The name should start with a letter. This cannot be changed after the achievement has been created.  | 
+**Title** | **string** | The display name for the achievement in the Campaign Manager. | 
+**Description** | **string** | A description of the achievement. | 
+**Target** | **decimal** | The required number of actions or the transactional milestone to complete the achievement. | 
+**Period** | **string** | The relative duration after which the achievement ends and resets for a particular customer profile.  **Note**: The &#x60;period&#x60; does not start when the achievement is created.  The period is a **positive real number** followed by one letter indicating the time unit.  Examples: &#x60;30s&#x60;, &#x60;40m&#x60;, &#x60;1h&#x60;, &#x60;5D&#x60;, &#x60;7W&#x60;, &#x60;10M&#x60;, &#x60;15Y&#x60;.  Available units:  - &#x60;s&#x60;: seconds - &#x60;m&#x60;: minutes - &#x60;h&#x60;: hours - &#x60;D&#x60;: days - &#x60;W&#x60;: weeks - &#x60;M&#x60;: months - &#x60;Y&#x60;: years  You can also round certain units down to the beginning of period and up to the end of period.: - &#x60;_D&#x60; for rounding down days only. Signifies the start of the day. Example: &#x60;30D_D&#x60; - &#x60;_U&#x60; for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: &#x60;23W_U&#x60;  **Note**: You can either use the round down and round up option or set an absolute period.  | 
+**PeriodEndOverride** | [**TimePoint**](TimePoint.md) |  | [optional] 
+**CampaignId** | **int** | ID of the campaign, to which the achievement belongs to | 
+**UserId** | **int** | ID of the user that created this achievement. | 
+**CreatedBy** | **string** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 
+**HasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [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)
+
diff --git a/docs/AchievementAdditionalProperties.md b/docs/AchievementAdditionalProperties.md
@@ -0,0 +1,12 @@
+# TalonOne.Model.AchievementAdditionalProperties
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**CampaignId** | **int** | ID of the campaign, to which the achievement belongs to | 
+**UserId** | **int** | ID of the user that created this achievement. | 
+**CreatedBy** | **string** | Name of the user that created the achievement.  **Note**: This is not available if the user has been deleted.  | 
+**HasProgress** | **bool** | Indicates if a customer has made progress in the achievement. | [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)
+
diff --git a/docs/AchievementProgress.md b/docs/AchievementProgress.md
@@ -0,0 +1,18 @@
+# TalonOne.Model.AchievementProgress
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**AchievementId** | **int** | The internal ID of the achievement. | 
+**Name** | **string** | The internal name of the achievement used in API requests.  | 
+**Title** | **string** | The display name of the achievement in the Campaign Manager. | 
+**CampaignId** | **int** | The ID of the campaign the achievement belongs to. | 
+**Status** | **string** | The status of the achievement. | 
+**Target** | **decimal** | The required number of actions or the transactional milestone to complete the achievement. | [optional] 
+**Progress** | **decimal** | The current progress of the customer in the achievement. | 
+**StartDate** | **DateTime** | Timestamp at which the customer started the achievement. | 
+**CompletionDate** | **DateTime** | Timestamp at which point the customer completed the achievement. | [optional] 
+**EndDate** | **DateTime** | Timestamp at which point the achievement ends and resets for the customer. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/ActivateUserRequest.md b/docs/ActivateUserRequest.md
@@ -0,0 +1,9 @@
+# TalonOne.Model.ActivateUserRequest
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Email** | **string** | The email address associated with the user profile. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AddItemCatalogAction.md b/docs/AddItemCatalogAction.md
@@ -1,13 +1,14 @@
 # TalonOne.Model.AddItemCatalogAction
-The specific properties of the \"ADD\" catalog sync action.
+The specific properties of the \"ADD\" catalog sync action. 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Sku** | **string** | The unique SKU of the item to add. | 
 **Price** | **decimal** | Price of the item. | [optional] 
 **Attributes** | [**Object**](.md) | The attributes of the item to add. | [optional] 
-**ReplaceIfExists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists. | [optional] [default to false]
+**Product** | [**Product**](Product.md) |  | [optional] 
+**ReplaceIfExists** | **bool** | Indicates whether to replace the attributes of the item if the same SKU exists.  **Note**: When set to &#x60;true&#x60;:   - If you do not provide a new &#x60;price&#x60; value, the existing &#x60;price&#x60; value is retained.   - If you do not provide a new &#x60;product&#x60; value, the &#x60;product&#x60; value is set to &#x60;null&#x60;.  | [optional] [default to false]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/AddLoyaltyPointsEffectProps.md b/docs/AddLoyaltyPointsEffectProps.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **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 &#x60;quantity&#x60; &gt; 1.  | [optional] 
+**CartItemSubPosition** | **decimal** | For cart items with &#x60;quantity&#x60; &gt; 1, the sub position indicates to which item the loyalty points addition is applied.  | [optional] 
 **CardIdentifier** | **string** | The alphanumeric identifier of the loyalty card.  | [optional] 
 **BundleIndex** | **int** | The position of the bundle in a list of item bundles created from the same bundle definition. | [optional] 
 **BundleName** | **string** | The name of the bundle definition. | [optional] 

diff --git a/docs/AddToAudienceEffectProps.md b/docs/AddToAudienceEffectProps.md
@@ -0,0 +1,13 @@
+# TalonOne.Model.AddToAudienceEffectProps
+The properties specific to the \"addToAudience\" effect. This gets triggered whenever a validated rule contains an \"addToAudience\" effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**AudienceId** | **int** | The internal ID of the audience. | [optional] 
+**AudienceName** | **string** | The name of the audience. | [optional] 
+**ProfileIntegrationId** | **string** | The ID of the customer profile in the third-party integration platform. | [optional] 
+**ProfileId** | **int** | The internal ID of the customer profile. | [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)
+
diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md
@@ -0,0 +1,30 @@
+# TalonOne.Model.AdditionalCampaignProperties
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Budgets** | [**List&lt;CampaignBudget&gt;**](CampaignBudget.md) | A list of all the budgets that are defined by this campaign and their usage.  **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.  | 
+**CouponRedemptionCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.  | [optional] 
+**ReferralRedemptionCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.  | [optional] 
+**DiscountCount** | **decimal** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.  | [optional] 
+**DiscountEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign.  | [optional] 
+**CouponCreationCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign.  | [optional] 
+**CustomEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign.  | [optional] 
+**ReferralCreationCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign.  | [optional] 
+**AddFreeItemEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.  | [optional] 
+**AwardedGiveawaysCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign.  | [optional] 
+**CreatedLoyaltyPointsCount** | **decimal** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign.  | [optional] 
+**CreatedLoyaltyPointsEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign.  | [optional] 
+**RedeemedLoyaltyPointsCount** | **decimal** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign.  | [optional] 
+**RedeemedLoyaltyPointsEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign.  | [optional] 
+**CallApiEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign.  | [optional] 
+**ReservecouponEffectCount** | **int** | This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign.  | [optional] 
+**LastActivity** | **DateTime** | Timestamp of the most recent event received by this campaign. | [optional] 
+**Updated** | **DateTime** | Timestamp of the most recent update to the campaign&#39;s property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates.  | [optional] 
+**CreatedBy** | **string** | Name of the user who created this campaign if available. | [optional] 
+**UpdatedBy** | **string** | Name of the user who last updated this campaign if available. | [optional] 
+**TemplateId** | **int** | The ID of the Campaign Template this Campaign was created from. | [optional] 
+**FrontendState** | **string** | A campaign state described exactly as in the Campaign Manager. | 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/Application.md b/docs/Application.md
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **Limits** | [**List&lt;LimitConfig&gt;**](LimitConfig.md) | Default limits for campaigns created in this application. | [optional] 
 **DefaultDiscountScope** | **string** | The default scope to apply &#x60;setDiscount&#x60; 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/managing-general-settings#flattening).  | [optional] 
+**EnableFlattenedCartItems** | **bool** | Indicates if cart items of quantity larger than one should be separated into different items of quantity one.  | [optional] 
 **AttributesSettings** | [**AttributesSettings**](AttributesSettings.md) |  | [optional] 
 **Sandbox** | **bool** | Indicates if this is a live or sandbox Application. | [optional] 
 **EnablePartialDiscounts** | **bool** | Indicates if this Application supports partial discounts. | [optional] 

diff --git a/docs/ApplicationAPIKey.md b/docs/ApplicationAPIKey.md
@@ -3,9 +3,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Title** | **string** | Title for API Key. | 
-**Expires** | **DateTime** | The date the API key expired. | 
+**Title** | **string** | Title of the API key. | 
+**Expires** | **DateTime** | The date the API key expires. | 
 **Platform** | **string** | The third-party platform the API key is valid for. Use &#x60;none&#x60; for a generic API key to be used from your own integration layer.  | [optional] 
+**Type** | **string** | The API key type. Can be empty or &#x60;staging&#x60;.  Staging API keys can only be used for dry requests with the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint, [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint, and [Track event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2) endpoint.  When using the _Update customer profile_ endpoint with a staging API key, the query parameter &#x60;runRuleEngine&#x60; must be &#x60;true&#x60;.  | [optional] 
+**TimeOffset** | **int** | A time offset in nanoseconds associated with the API key. When making a request using the API key, rule evaluation is based on a date that is calculated by adding the offset to the current date.  | [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. | 

diff --git a/docs/ApplicationAnalyticsDataPoint.md b/docs/ApplicationAnalyticsDataPoint.md
@@ -0,0 +1,16 @@
+# TalonOne.Model.ApplicationAnalyticsDataPoint
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**StartTime** | **DateTime** | The start of the aggregation time frame in UTC. | [optional] 
+**EndTime** | **DateTime** | The end of the aggregation time frame in UTC. | [optional] 
+**TotalRevenue** | [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPointTotalRevenue.md) |  | [optional] 
+**SessionsCount** | [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPointSessionsCount.md) |  | [optional] 
+**AvgItemsPerSession** | [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPointAvgItemsPerSession.md) |  | [optional] 
+**AvgSessionValue** | [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPointAvgSessionValue.md) |  | [optional] 
+**TotalDiscounts** | **decimal** | The total value of discounts given for cart items in influenced sessions. | [optional] 
+**CouponsCount** | **decimal** | The number of times a coupon was successfully redeemed in influenced sessions. | [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)
+
diff --git a/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md b/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md
@@ -0,0 +1,11 @@
+# TalonOne.Model.ApplicationAnalyticsDataPointAvgItemsPerSession
+The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Total** | **decimal** |  | [optional] 
+**Influenced** | **decimal** |  | [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)
+
diff --git a/docs/ApplicationAnalyticsDataPointAvgSessionValue.md b/docs/ApplicationAnalyticsDataPointAvgSessionValue.md
@@ -0,0 +1,11 @@
+# TalonOne.Model.ApplicationAnalyticsDataPointAvgSessionValue
+The average customer session value, calculated by dividing the revenue value by the number of sessions. The `influenced` value includes only sessions with at least one applied effect.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Total** | **decimal** |  | [optional] 
+**Influenced** | **decimal** |  | [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)
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -184,3 +184,5 @@ $RECYCLE.BIN/

		# Visual Studio 2014 CTP
		*/.sln.ide

		.idea