Skip to content

Commit

Permalink
Merge pull request #30 from talon-one/sc-42169-update-c-sdk
Browse files Browse the repository at this point in the history
Quarterly sdk updates
  • Loading branch information
rubyjohn93 authored Sep 24, 2024
2 parents 96d206f + c00b231 commit 49cbb53
Show file tree
Hide file tree
Showing 321 changed files with 23,400 additions and 1,593 deletions.
88 changes: 74 additions & 14 deletions README.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/AchievementProgress.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ 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. |
**Description** | **string** | The description 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]
Expand Down
1 change: 1 addition & 0 deletions docs/AdditionalCampaignProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**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. |
**StoresImported** | **bool** | Indicates whether the linked stores were imported via a CSV file. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/AnalyticsDataPoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.Model.AnalyticsDataPoint
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Total** | **decimal** | |
**Influenced** | **decimal** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

10 changes: 10 additions & 0 deletions docs/AnalyticsDataPointWithTrend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# TalonOne.Model.AnalyticsDataPointWithTrend
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **decimal** | |
**Trend** | **decimal** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions docs/AnalyticsDataPointWithTrendAndInfluencedRate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# TalonOne.Model.AnalyticsDataPointWithTrendAndInfluencedRate
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **decimal** | |
**InfluencedRate** | **decimal** | |
**Trend** | **decimal** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

11 changes: 11 additions & 0 deletions docs/AnalyticsDataPointWithTrendAndUplift.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# TalonOne.Model.AnalyticsDataPointWithTrendAndUplift
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Value** | **decimal** | |
**Uplift** | **decimal** | |
**Trend** | **decimal** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

2 changes: 2 additions & 0 deletions docs/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Name | Type | Description | Notes
**EnablePartialDiscounts** | **bool** | Indicates if this Application supports partial discounts. | [optional]
**DefaultDiscountAdditionalCostPerItemScope** | **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
**DefaultEvaluationGroupId** | **int** | The ID of the default campaign evaluation group to which new campaigns will be added unless a different group is selected when creating the campaign. | [optional]
**DefaultCartItemFilterId** | **int** | The ID of the default Cart-Item-Filter for this application. | [optional]
**EnableCampaignStateManagement** | **bool** | Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. | [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)
Expand Down
12 changes: 6 additions & 6 deletions docs/ApplicationAnalyticsDataPoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@

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]
**StartTime** | **DateTime** | The start of the aggregation time frame in UTC. |
**EndTime** | **DateTime** | The end of the aggregation time frame in UTC. |
**TotalRevenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**SessionsCount** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**AvgItemsPerSession** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
**AvgSessionValue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.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]

Expand Down
17 changes: 17 additions & 0 deletions docs/ApplicationCIF.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# TalonOne.Model.ApplicationCIF
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | Internal ID of this entity. |
**Created** | **DateTime** | The time this entity was created. |
**Name** | **string** | The name of the Application cart item filter used in API requests. |
**Description** | **string** | A short description of the Application cart item filter. | [optional]
**ActiveExpressionId** | **int** | The ID of the expression that the Application cart item filter uses. | [optional]
**ModifiedBy** | **int** | The ID of the user who last updated the Application cart item filter. | [optional]
**CreatedBy** | **int** | The ID of the user who created the Application cart item filter. | [optional]
**Modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional]
**ApplicationId** | **int** | The ID of the application that owns this entity. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

14 changes: 14 additions & 0 deletions docs/ApplicationCIFExpression.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# TalonOne.Model.ApplicationCIFExpression
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | Internal ID of this entity. |
**Created** | **DateTime** | The time this entity was created. |
**CartItemFilterId** | **int** | The ID of the Application cart item filter. | [optional]
**CreatedBy** | **int** | The ID of the user who created the Application cart item filter. | [optional]
**Expression** | **List<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional]
**ApplicationId** | **int** | The ID of the application that owns this entity. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

27 changes: 12 additions & 15 deletions docs/ApplicationCampaignAnalytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,18 @@

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]
**CampaignId** | **int** | The ID of the campaign. | [optional]
**CampaignName** | **string** | The name of the campaign. | [optional]
**CampaignTags** | **List<string>** | A list of tags for the campaign. | [optional]
**CampaignState** | **string** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to CampaignStateEnum.Enabled]
**CampaignActiveRulesetId** | **int** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional]
**CampaignStartTime** | **DateTime** | Date and time when the campaign becomes active. | [optional]
**CampaignEndTime** | **DateTime** | Date and time when the campaign becomes inactive. | [optional]
**TotalRevenue** | [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalyticsTotalRevenue.md) | | [optional]
**SessionsCount** | [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalyticsSessionsCount.md) | | [optional]
**AvgItemsPerSession** | [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalyticsAvgItemsPerSession.md) | | [optional]
**AvgSessionValue** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) | | [optional]
**TotalDiscounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) | | [optional]
**CouponsCount** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) | | [optional]
**StartTime** | **DateTime** | The start of the aggregation time frame in UTC. |
**EndTime** | **DateTime** | The end of the aggregation time frame in UTC. |
**CampaignId** | **int** | The ID of the campaign. |
**CampaignName** | **string** | The name of the campaign. |
**CampaignTags** | **List<string>** | A list of tags for the campaign. |
**CampaignState** | **string** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
**TotalRevenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**SessionsCount** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
**AvgItemsPerSession** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**AvgSessionValue** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
**TotalDiscounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
**CouponsCount** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [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)

1 change: 0 additions & 1 deletion docs/ApplicationCampaignStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Provides statistics regarding an application's campaigns.

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Draft** | **int** | Number of draft campaigns. |
**Disabled** | **int** | Number of disabled campaigns. |
**Scheduled** | **int** | Number of scheduled campaigns. |
**Running** | **int** | Number of running campaigns. |
Expand Down
9 changes: 9 additions & 0 deletions docs/AsyncCouponDeletionJobResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TalonOne.Model.AsyncCouponDeletionJobResponse
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **int** | Unique ID for this entity. Not to be confused with the Integration ID, which is set by your integration layer and used in most endpoints. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

8 changes: 5 additions & 3 deletions docs/BaseLoyaltyProgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Name | Type | Description | Notes
**AllowSubledger** | **bool** | Indicates if this program supports subledgers inside the program. | [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]
**Sandbox** | **bool** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
**TiersExpirationPolicy** | **string** | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
**TiersExpireIn** | **string** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**TiersDowngradePolicy** | **string** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
**ProgramJoinPolicy** | **string** | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
**TiersExpirationPolicy** | **string** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. | [optional]
**TierCycleStartDate** | **DateTime** | Timestamp at which the tier cycle starts for all customers in the loyalty program. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. | [optional]
**TiersExpireIn** | **string** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
**TiersDowngradePolicy** | **string** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional]
**CardCodeSettings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [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)

2 changes: 1 addition & 1 deletion docs/BaseNotification.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Policy** | [**Object**](.md) | |
**Policy** | [**Object**](.md) | Indicates which notification properties to apply. |
**Enabled** | **bool** | Indicates whether the notification is activated. | [optional] [default to true]
**Webhook** | [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | |
**Id** | **int** | Unique ID for this entity. |
Expand Down
2 changes: 1 addition & 1 deletion docs/BaseNotificationEntity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Policy** | [**Object**](.md) | |
**Policy** | [**Object**](.md) | Indicates which notification properties to apply. |
**Enabled** | **bool** | Indicates whether the notification is activated. | [optional] [default to true]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
7 changes: 7 additions & 0 deletions docs/Campaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ Name | Type | Description | Notes
**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. |
**StoresImported** | **bool** | Indicates whether the linked stores were imported via a CSV file. |
**ActiveRevisionId** | **int** | ID of the revision that was last activated on this campaign. | [optional]
**ActiveRevisionVersionId** | **int** | ID of the revision version that is active on the campaign. | [optional]
**Version** | **int** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional]
**CurrentRevisionId** | **int** | ID of the revision currently being modified for the campaign. | [optional]
**CurrentRevisionVersionId** | **int** | ID of the latest version applied on the current revision. | [optional]
**StageRevision** | **bool** | Flag for determining whether we use current revision when sending requests with staging API key. | [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)

12 changes: 12 additions & 0 deletions docs/CampaignCollectionEditedNotification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# TalonOne.Model.CampaignCollectionEditedNotification
A notification regarding a collection that was edited.
## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Campaign** | [**Campaign**](Campaign.md) | |
**Ruleset** | [**Ruleset**](Ruleset.md) | | [optional]
**Collection** | [**CollectionWithoutPayload**](CollectionWithoutPayload.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)

Loading

0 comments on commit 49cbb53

Please sign in to comment.