From dc4a8726086b612020810179832ba43eaeb0d78b Mon Sep 17 00:00:00 2001 From: Vitalii Drevenchuk <4005032+Crandel@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:09:18 +0200 Subject: [PATCH 1/5] Add patches, update Makefile, ignore .idea --- .gitignore | 1 + .idea/modules.xml | 8 ----- .idea/talon_go.iml | 9 ----- .idea/vcs.xml | 6 ---- .idea/workspace.xml | 59 ------------------------------ Makefile | 14 +++++++- patches/condition.patch | 78 ++++++++++++++++++++++++++++++++++++++++ patches/effects.patch | 77 +++++++++++++++++++++++++++++++++++++++ patches/expr.patch | 78 ++++++++++++++++++++++++++++++++++++++++ patches/expression.patch | 76 +++++++++++++++++++++++++++++++++++++++ 10 files changed, 323 insertions(+), 83 deletions(-) delete mode 100644 .idea/modules.xml delete mode 100644 .idea/talon_go.iml delete mode 100644 .idea/vcs.xml delete mode 100644 .idea/workspace.xml create mode 100644 patches/condition.patch create mode 100644 patches/effects.patch create mode 100644 patches/expr.patch create mode 100644 patches/expression.patch diff --git a/.gitignore b/.gitignore index daf913b1..0c9e3298 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ # Folders _obj _test +.idea # Architecture specific extensions/prefixes *.[568vq] diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index b5adc10d..00000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/talon_go.iml b/.idea/talon_go.iml deleted file mode 100644 index 5e764c4f..00000000 --- a/.idea/talon_go.iml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1ddf..00000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml deleted file mode 100644 index 7f707a4d..00000000 --- a/.idea/workspace.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - true - - \ No newline at end of file diff --git a/Makefile b/Makefile index 70f75913..435d6859 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,15 @@ update-pkg-cache: GOPROXY=https://proxy.golang.org GO111MODULE=on \ - go get github.com/talon-one/talon_go/v7 + go get github.com/talon-one/talon_go/v8 + +apply-patches: + gopatch -p patches/effects.patch model_event.go + gopatch -p patches/effects.patch model_rule.go + gopatch -p patches/effects.patch model_generate_rule_title_rule.go + gopatch -p patches/expression.patch model_binding.go + gopatch -p patches/expression.patch model_application_cif_expression.go + gopatch -p patches/expression.patch model_new_application_cif_expression.go + gopatch -p patches/expr.patch model_template_def.go + gopatch -p patches/expr.patch model_new_template_def.go + gopatch -p patches/condition.patch model_rule.go + gopatch -p patches/condition.patch model_generate_rule_title_rule.go diff --git a/patches/condition.patch b/patches/condition.patch new file mode 100644 index 00000000..996f949f --- /dev/null +++ b/patches/condition.patch @@ -0,0 +1,78 @@ +@@ +var strName identifier +@@ +type strName struct { + ... +- Condition *[]map[string]interface{} `json:"condition,omitempty"` ++ Condition []interface{} `json:"condition,omitempty"` + ... +} +@@ +var strName identifier +@@ +type strName struct { + ... +- Condition []map[string]interface{} `json:"condition"` ++ Condition []interface{} `json:"condition"` + ... +} + + +# Replace GetEffects +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetCondition() []map[string]interface{} { ++func (a *strName) GetCondition() []interface{} { + ... +} + +# Replace GetEffectsOk +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetConditionOk() ([]map[string]interface{}, bool) { ++func (a *strName) GetConditionOk() ([]interface{}, bool) { + ... +} + +# Replace SetCondition +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) SetCondition(v []map[string]interface{}) { ++func (a *strName) SetCondition(v []interface{}) { + ... + } + +# Replace optional in SetCondition +@@ +var a identifier +@@ +- a.Condition = &v ++ a.Condition = v + +# Replace return type +@@ +var ret identifier +@@ +- var ret []map[string]interface{} ++ var ret []interface{} + +# Replace return value in GetCondition method +@@ +var a identifier +@@ +- return *a.Condition ++ return a.Condition + +# Replace return value in GetConditionOk method +@@ +var a identifier +@@ +- return *a.Condition, true ++ return a.Condition, true + diff --git a/patches/effects.patch b/patches/effects.patch new file mode 100644 index 00000000..786cbee9 --- /dev/null +++ b/patches/effects.patch @@ -0,0 +1,77 @@ +@@ +var strName identifier +@@ +type strName struct { + ... +- Effects *[]map[string]interface{} `json:"effects,omitempty"` ++ Effects [][]interface{} `json:"effects,omitempty"` + ... +} + +@@ +var strName identifier +@@ +type strName struct { + ... +- Effects []map[string]interface{} `json:"effects"` ++ Effects [][]interface{} `json:"effects"` + ... +} + + +# Replace GetEffects +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetEffects() []map[string]interface{} { ++func (a *strName) GetEffects() [][]interface{} { + ... +} + +# Replace GetEffectsOk +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetEffectsOk() ([]map[string]interface{}, bool) { ++func (a *strName) GetEffectsOk() ([][]interface{}, bool) { + ... +} +# Replace SetEffects +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) SetEffects(v []map[string]interface{}) { ++func (a *strName) SetEffects(v [][]interface{}) { + ... +} + +# Replace optional in SetEffects +@@ +var a identifier +@@ +- a.Effects = &v ++ a.Effects = v + +# Replace return type +@@ +var ret identifier +@@ +- var ret []map[string]interface{} ++ var ret [][]interface{} + +# Replace return value +@@ +var a identifier +@@ +- return *a.Effects ++ return a.Effects + +# Replace return value, bool +@@ +var a identifier +@@ +- return *a.Effects, true ++ return a.Effects, true diff --git a/patches/expr.patch b/patches/expr.patch new file mode 100644 index 00000000..139cd280 --- /dev/null +++ b/patches/expr.patch @@ -0,0 +1,78 @@ +@@ +var strName identifier +@@ +type strName struct { + ... +- Expr *[]map[string]interface{} `json:"expr,omitempty"` ++ Expr []interface{} `json:"expr,omitempty"` + ... +} + +@@ +var strName identifier +@@ +type strName struct { + ... +- Expr []map[string]interface{} `json:"expr"` ++ Expr []interface{} `json:"expr"` + ... +} + + +# Replace GetExpression +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetExpr() []map[string]interface{} { ++func (a *strName) GetExpr() []interface{} { + ... +} + +# Replace GetExpressionOk +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetExprOk() ([]map[string]interface{}, bool) { ++func (a *strName) GetExprOk() ([]interface{}, bool) { + ... +} + +# Replace SetExpression +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) SetExpr(v []map[string]interface{}) { ++func (a *strName) SetExpr(v []interface{}) { + ... + } + +# Replace optional in SetExpression +@@ +var strName identifier +var a identifier +@@ +- a.Expr = &v ++ a.Expr = v + +@@ +var ret identifier +@@ +- var ret []map[string]interface{} ++ var ret []interface{} + +# Replace return value in GetExpression +@@ +var a identifier +@@ +- return *a.Expr ++ return a.Expr + +# Replace return value in GetExpressionOk +@@ +var a identifier +@@ +- return *a.Expr, true ++ return a.Expr, true diff --git a/patches/expression.patch b/patches/expression.patch new file mode 100644 index 00000000..090c669b --- /dev/null +++ b/patches/expression.patch @@ -0,0 +1,76 @@ +@@ +var strName identifier +@@ +type strName struct { + ... +- Expression *[]map[string]interface{} `json:"expression,omitempty"` ++ Expression []interface{} `json:"expression,omitempty"` + ... +} +@@ +var strName identifier +@@ +type strName struct { + ... +- Expression []map[string]interface{} `json:"expression"` ++ Expression []interface{} `json:"expression"` + ... +} + +# Replace GetExpression +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetExpression() []map[string]interface{} { ++func (a *strName) GetExpression() []interface{} { + ... +} + +# Replace GetExpressionOk +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) GetExpressionOk() ([]map[string]interface{}, bool) { ++func (a *strName) GetExpressionOk() ([]interface{}, bool) { + ... +} + +# Replace SetExpression +@@ +var strName identifier +var a identifier +@@ +-func (a *strName) SetExpression(v []map[string]interface{}) { ++func (a *strName) SetExpression(v []interface{}) { + ... + } + +# Replace optional in SetExpression +@@ +var strName identifier +var a identifier +@@ +- a.Expression = &v ++ a.Expression = v + +@@ +var ret identifier +@@ +- var ret []map[string]interface{} ++ var ret []interface{} + +# Replace return value in GetExpression +@@ +var a identifier +@@ +- return *a.Expression ++ return a.Expression + +# Replace return value in GetExpressionOk +@@ +var a identifier +@@ +- return *a.Expression, true ++ return a.Expression, true From b7499e934335593bab0e65066571fa36b702d3f6 Mon Sep 17 00:00:00 2001 From: Vitalii Drevenchuk <4005032+Crandel@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:17:53 +0200 Subject: [PATCH 2/5] Update docs files --- docs/AccountDashboardStatisticApiCalls.md | 65 - docs/AchievementProgress.md | 26 + docs/AdditionalCampaignProperties.md | 26 + ...tTotalRevenue.md => AnalyticsDataPoint.md} | 22 +- ...ount.md => AnalyticsDataPointWithTrend.md} | 22 +- ...ticsDataPointWithTrendAndInfluencedRate.md | 91 ++ ...> AnalyticsDataPointWithTrendAndUplift.md} | 32 +- docs/Application.md | 52 + docs/ApplicationAnalyticsDataPoint.md | 44 +- ...ionAnalyticsDataPointAvgItemsPerSession.md | 65 - ...cationAnalyticsDataPointAvgSessionValue.md | 65 - ...licationAnalyticsDataPointSessionsCount.md | 65 - docs/ApplicationCampaignAnalytics.md | 150 +-- ...tionCampaignAnalyticsAvgItemsPerSession.md | 91 -- ...plicationCampaignAnalyticsSessionsCount.md | 91 -- ...licationCampaignAnalyticsTotalDiscounts.md | 65 - ...pplicationCampaignAnalyticsTotalRevenue.md | 91 -- docs/ApplicationCampaignStats.md | 26 - docs/ApplicationCif.md | 247 ++++ docs/ApplicationCifExpression.md | 169 +++ docs/AsyncCouponDeletionJobResponse.md | 39 + docs/BaseCampaignForNotification.md | 429 ------- docs/BaseLoyaltyProgram.md | 82 +- docs/BaseNotification.md | 2 +- docs/BaseNotificationEntity.md | 2 +- docs/Binding.md | 2 +- docs/Campaign.md | 182 +++ docs/CampaignCollectionEditedNotification.md | 91 ++ docs/CampaignForNotification.md | 1079 ---------------- docs/CampaignNotificationPolicy.md | 26 + docs/CampaignPrioritiesChangedNotification.md | 91 -- docs/CampaignPrioritiesV2.md | 91 -- docs/CampaignSetIDs.md | 39 - docs/CampaignSetV2.md | 143 --- docs/CampaignStateChangedNotification.md | 4 +- docs/CampaignStateNotification.md | 1105 ----------------- docs/CampaignStoreBudget.md | 143 +++ docs/CampaignVersions.md | 169 +++ ...rdAddedDeductedPointsNotificationPolicy.md | 65 + docs/CartItem.md | 2 +- docs/CodeGeneratorSettings.md | 2 +- docs/Coupon.md | 2 +- docs/CouponConstraints.md | 2 +- docs/CouponCreationJob.md | 2 +- docs/CouponDeletionFilters.md | 377 ++++++ docs/CouponDeletionJob.md | 325 +++++ docs/CustomerSessionV2.md | 4 +- docs/Effect.md | 104 ++ docs/EffectEntity.md | 104 ++ docs/Environment.md | 26 + docs/Event.md | 2 +- docs/FeedNotification.md | 169 --- docs/FrontendState.md | 11 - docs/GenerateCampaignDescription.md | 65 + docs/GenerateCampaignTags.md | 39 + docs/GenerateItemFilterDescription.md | 39 + docs/GenerateLoyaltyCard.md | 65 + docs/GenerateRuleTitle.md | 65 + docs/GenerateRuleTitleRule.md | 65 + .../IncreaseAchievementProgressEffectProps.md | 2 +- docs/IntegrationApi.md | 53 +- docs/IntegrationCoupon.md | 2 +- docs/InventoryCoupon.md | 2 +- docs/InventoryReferral.md | 2 +- docs/LoyaltyBalanceWithTier.md | 221 ++++ docs/LoyaltyBalancesWithTiers.md | 65 + docs/LoyaltyCard.md | 54 +- docs/LoyaltyCardBatch.md | 91 ++ docs/LoyaltyCardBatchResponse.md | 65 + docs/LoyaltyProgram.md | 136 +- docs/LoyaltyProgramSubledgers.md | 65 - docs/LoyaltyStatistics.md | 247 ---- docs/ManagementApi.md | 741 ++++++++++- docs/MessageLogResponse.md | 6 +- docs/NewAppWideCouponDeletionJob.md | 65 + docs/NewApplication.md | 26 + docs/NewApplicationCif.md | 169 +++ docs/NewApplicationCifExpression.md | 91 ++ docs/NewBaseNotification.md | 2 +- docs/NewCampaignSetV2.md | 91 -- docs/NewCouponCreationJob.md | 2 +- docs/NewCouponDeletionJob.md | 39 + docs/NewCoupons.md | 2 +- docs/NewCouponsForMultipleRecipients.md | 2 +- docs/NewCustomerSessionV2.md | 4 +- docs/NewLoyaltyProgram.md | 82 +- docs/NewOutgoingIntegrationWebhook.md | 26 + docs/NewReferral.md | 2 +- docs/NewReferralsForMultipleAdvocates.md | 2 +- docs/NewRevisionVersion.md | 327 +++++ docs/NewTemplateDef.md | 2 +- docs/NewWebhook.md | 26 + docs/NotificationWebhook.md | 195 --- docs/OktaEvent.md | 65 + docs/OktaEventPayload.md | 39 + docs/OktaEventPayloadData.md | 39 + docs/OktaEventTarget.md | 91 ++ docs/OutgoingIntegrationWebhookTemplate.md | 169 --- docs/OutgoingIntegrationWebhookTemplates.md | 39 - docs/PriorityPosition.md | 65 - docs/ProjectedTier.md | 91 ++ docs/Referral.md | 2 +- docs/ReferralConstraints.md | 2 +- docs/RejectCouponEffectProps.md | 26 + docs/RejectReferralEffectProps.md | 26 + docs/Revision.md | 273 ++++ docs/RevisionActivation.md | 39 + docs/RevisionVersion.md | 535 ++++++++ docs/RoleV2PermissionsRoles.md | 91 -- ...IncreasedAchievementProgressEffectProps.md | 169 +++ docs/Rule.md | 3 +- docs/RuleFailureReason.md | 52 + docs/ScimBaseUser.md | 117 ++ docs/ScimBaseUserName.md | 39 + docs/ScimNewUser.md | 117 ++ docs/ScimPatchOperation.md | 91 ++ docs/ScimPatchRequest.md | 65 + docs/ScimResource.md | 91 ++ docs/ScimResourceTypesListResponse.md | 39 + docs/ScimSchemaResource.md | 117 ++ docs/ScimSchemasListResponse.md | 91 ++ docs/ScimServiceProviderConfigResponse.md | 169 +++ docs/ScimServiceProviderConfigResponseBulk.md | 91 ++ ...iceProviderConfigResponseChangePassword.md | 39 + ...ScimServiceProviderConfigResponseFilter.md | 65 + .../ScimServiceProviderConfigResponsePatch.md | 39 + docs/ScimUser.md | 143 +++ docs/ScimUsersListResponse.md | 91 ++ docs/SsoConfig.md | 26 + docs/Tier.md | 28 +- docs/TransferLoyaltyCard.md | 26 + docs/UpdateApplication.md | 52 + docs/UpdateApplicationCif.md | 117 ++ docs/UpdateCampaign.md | 2 +- docs/UpdateCoupon.md | 2 +- docs/UpdateCouponBatch.md | 2 +- docs/UpdateLoyaltyCard.md | 28 +- docs/UpdateLoyaltyProgram.md | 82 +- docs/UpdateReferral.md | 2 +- docs/UpdateReferralBatch.md | 2 +- docs/UpdateUserLatestFeedTimestamp.md | 39 - docs/User.md | 26 + docs/UserFeedNotifications.md | 65 - docs/Webhook.md | 26 + docs/WebhookWithOutgoingIntegrationDetails.md | 26 + 145 files changed, 8281 insertions(+), 5156 deletions(-) delete mode 100644 docs/AccountDashboardStatisticApiCalls.md rename docs/{ApplicationAnalyticsDataPointTotalRevenue.md => AnalyticsDataPoint.md} (59%) rename docs/{ApplicationCampaignAnalyticsCouponsCount.md => AnalyticsDataPointWithTrend.md} (59%) create mode 100644 docs/AnalyticsDataPointWithTrendAndInfluencedRate.md rename docs/{ApplicationCampaignAnalyticsAvgSessionValue.md => AnalyticsDataPointWithTrendAndUplift.md} (57%) delete mode 100644 docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md delete mode 100644 docs/ApplicationAnalyticsDataPointAvgSessionValue.md delete mode 100644 docs/ApplicationAnalyticsDataPointSessionsCount.md delete mode 100644 docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md delete mode 100644 docs/ApplicationCampaignAnalyticsSessionsCount.md delete mode 100644 docs/ApplicationCampaignAnalyticsTotalDiscounts.md delete mode 100644 docs/ApplicationCampaignAnalyticsTotalRevenue.md create mode 100644 docs/ApplicationCif.md create mode 100644 docs/ApplicationCifExpression.md create mode 100644 docs/AsyncCouponDeletionJobResponse.md delete mode 100644 docs/BaseCampaignForNotification.md create mode 100644 docs/CampaignCollectionEditedNotification.md delete mode 100644 docs/CampaignForNotification.md delete mode 100644 docs/CampaignPrioritiesChangedNotification.md delete mode 100644 docs/CampaignPrioritiesV2.md delete mode 100644 docs/CampaignSetIDs.md delete mode 100644 docs/CampaignSetV2.md delete mode 100644 docs/CampaignStateNotification.md create mode 100644 docs/CampaignStoreBudget.md create mode 100644 docs/CampaignVersions.md create mode 100644 docs/CardAddedDeductedPointsNotificationPolicy.md create mode 100644 docs/CouponDeletionFilters.md create mode 100644 docs/CouponDeletionJob.md delete mode 100644 docs/FeedNotification.md delete mode 100644 docs/FrontendState.md create mode 100644 docs/GenerateCampaignDescription.md create mode 100644 docs/GenerateCampaignTags.md create mode 100644 docs/GenerateItemFilterDescription.md create mode 100644 docs/GenerateLoyaltyCard.md create mode 100644 docs/GenerateRuleTitle.md create mode 100644 docs/GenerateRuleTitleRule.md create mode 100644 docs/LoyaltyBalanceWithTier.md create mode 100644 docs/LoyaltyBalancesWithTiers.md create mode 100644 docs/LoyaltyCardBatch.md create mode 100644 docs/LoyaltyCardBatchResponse.md delete mode 100644 docs/LoyaltyProgramSubledgers.md delete mode 100644 docs/LoyaltyStatistics.md create mode 100644 docs/NewAppWideCouponDeletionJob.md create mode 100644 docs/NewApplicationCif.md create mode 100644 docs/NewApplicationCifExpression.md delete mode 100644 docs/NewCampaignSetV2.md create mode 100644 docs/NewCouponDeletionJob.md create mode 100644 docs/NewRevisionVersion.md delete mode 100644 docs/NotificationWebhook.md create mode 100644 docs/OktaEvent.md create mode 100644 docs/OktaEventPayload.md create mode 100644 docs/OktaEventPayloadData.md create mode 100644 docs/OktaEventTarget.md delete mode 100644 docs/OutgoingIntegrationWebhookTemplate.md delete mode 100644 docs/OutgoingIntegrationWebhookTemplates.md delete mode 100644 docs/PriorityPosition.md create mode 100644 docs/ProjectedTier.md create mode 100644 docs/Revision.md create mode 100644 docs/RevisionActivation.md create mode 100644 docs/RevisionVersion.md delete mode 100644 docs/RoleV2PermissionsRoles.md create mode 100644 docs/RollbackIncreasedAchievementProgressEffectProps.md create mode 100644 docs/ScimBaseUser.md create mode 100644 docs/ScimBaseUserName.md create mode 100644 docs/ScimNewUser.md create mode 100644 docs/ScimPatchOperation.md create mode 100644 docs/ScimPatchRequest.md create mode 100644 docs/ScimResource.md create mode 100644 docs/ScimResourceTypesListResponse.md create mode 100644 docs/ScimSchemaResource.md create mode 100644 docs/ScimSchemasListResponse.md create mode 100644 docs/ScimServiceProviderConfigResponse.md create mode 100644 docs/ScimServiceProviderConfigResponseBulk.md create mode 100644 docs/ScimServiceProviderConfigResponseChangePassword.md create mode 100644 docs/ScimServiceProviderConfigResponseFilter.md create mode 100644 docs/ScimServiceProviderConfigResponsePatch.md create mode 100644 docs/ScimUser.md create mode 100644 docs/ScimUsersListResponse.md create mode 100644 docs/UpdateApplicationCif.md delete mode 100644 docs/UpdateUserLatestFeedTimestamp.md delete mode 100644 docs/UserFeedNotifications.md diff --git a/docs/AccountDashboardStatisticApiCalls.md b/docs/AccountDashboardStatisticApiCalls.md deleted file mode 100644 index c8ca951e..00000000 --- a/docs/AccountDashboardStatisticApiCalls.md +++ /dev/null @@ -1,65 +0,0 @@ -# AccountDashboardStatisticApiCalls - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | Total number of API calls received. | -**Datetime** | Pointer to [**time.Time**](time.Time.md) | Values aggregated for the specified date. | - -## Methods - -### GetTotal - -`func (o *AccountDashboardStatisticApiCalls) GetTotal() float32` - -GetTotal returns the Total field if non-nil, zero value otherwise. - -### GetTotalOk - -`func (o *AccountDashboardStatisticApiCalls) GetTotalOk() (float32, bool)` - -GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotal - -`func (o *AccountDashboardStatisticApiCalls) HasTotal() bool` - -HasTotal returns a boolean if a field has been set. - -### SetTotal - -`func (o *AccountDashboardStatisticApiCalls) SetTotal(v float32)` - -SetTotal gets a reference to the given float32 and assigns it to the Total field. - -### GetDatetime - -`func (o *AccountDashboardStatisticApiCalls) GetDatetime() time.Time` - -GetDatetime returns the Datetime field if non-nil, zero value otherwise. - -### GetDatetimeOk - -`func (o *AccountDashboardStatisticApiCalls) GetDatetimeOk() (time.Time, bool)` - -GetDatetimeOk returns a tuple with the Datetime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDatetime - -`func (o *AccountDashboardStatisticApiCalls) HasDatetime() bool` - -HasDatetime returns a boolean if a field has been set. - -### SetDatetime - -`func (o *AccountDashboardStatisticApiCalls) SetDatetime(v time.Time)` - -SetDatetime gets a reference to the given time.Time and assigns it to the Datetime field. - - -[[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 index 3a29822a..81ac3bef 100644 --- a/docs/AchievementProgress.md +++ b/docs/AchievementProgress.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **AchievementId** | Pointer to **int32** | The internal ID of the achievement. | **Name** | Pointer to **string** | The internal name of the achievement used in API requests. | **Title** | Pointer to **string** | The display name of the achievement in the Campaign Manager. | +**Description** | Pointer to **string** | The description of the achievement in the Campaign Manager. | **CampaignId** | Pointer to **int32** | The ID of the campaign the achievement belongs to. | **Status** | Pointer to **string** | The status of the achievement. | **Target** | Pointer to **float32** | The required number of actions or the transactional milestone to complete the achievement. | [optional] @@ -92,6 +93,31 @@ HasTitle returns a boolean if a field has been set. SetTitle gets a reference to the given string and assigns it to the Title field. +### GetDescription + +`func (o *AchievementProgress) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *AchievementProgress) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *AchievementProgress) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *AchievementProgress) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetCampaignId `func (o *AchievementProgress) GetCampaignId() int32` diff --git a/docs/AdditionalCampaignProperties.md b/docs/AdditionalCampaignProperties.md index 302905e8..793b796d 100644 --- a/docs/AdditionalCampaignProperties.md +++ b/docs/AdditionalCampaignProperties.md @@ -26,6 +26,7 @@ Name | Type | Description | Notes **UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign if available. | [optional] **TemplateId** | Pointer to **int32** | The ID of the Campaign Template this Campaign was created from. | [optional] **FrontendState** | Pointer to **string** | A campaign state described exactly as in the Campaign Manager. | +**StoresImported** | Pointer to **bool** | Indicates whether the linked stores were imported via a CSV file. | ## Methods @@ -579,6 +580,31 @@ HasFrontendState returns a boolean if a field has been set. SetFrontendState gets a reference to the given string and assigns it to the FrontendState field. +### GetStoresImported + +`func (o *AdditionalCampaignProperties) GetStoresImported() bool` + +GetStoresImported returns the StoresImported field if non-nil, zero value otherwise. + +### GetStoresImportedOk + +`func (o *AdditionalCampaignProperties) GetStoresImportedOk() (bool, bool)` + +GetStoresImportedOk returns a tuple with the StoresImported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStoresImported + +`func (o *AdditionalCampaignProperties) HasStoresImported() bool` + +HasStoresImported returns a boolean if a field has been set. + +### SetStoresImported + +`func (o *AdditionalCampaignProperties) SetStoresImported(v bool)` + +SetStoresImported gets a reference to the given bool and assigns it to the StoresImported field. + [[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/ApplicationAnalyticsDataPointTotalRevenue.md b/docs/AnalyticsDataPoint.md similarity index 59% rename from docs/ApplicationAnalyticsDataPointTotalRevenue.md rename to docs/AnalyticsDataPoint.md index eb1fcc88..bc20a370 100644 --- a/docs/ApplicationAnalyticsDataPointTotalRevenue.md +++ b/docs/AnalyticsDataPoint.md @@ -1,61 +1,61 @@ -# ApplicationAnalyticsDataPointTotalRevenue +# AnalyticsDataPoint ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | | [optional] -**Influenced** | Pointer to **float32** | | [optional] +**Total** | Pointer to **float32** | | +**Influenced** | Pointer to **float32** | | ## Methods ### GetTotal -`func (o *ApplicationAnalyticsDataPointTotalRevenue) GetTotal() float32` +`func (o *AnalyticsDataPoint) GetTotal() float32` GetTotal returns the Total field if non-nil, zero value otherwise. ### GetTotalOk -`func (o *ApplicationAnalyticsDataPointTotalRevenue) GetTotalOk() (float32, bool)` +`func (o *AnalyticsDataPoint) GetTotalOk() (float32, bool)` GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasTotal -`func (o *ApplicationAnalyticsDataPointTotalRevenue) HasTotal() bool` +`func (o *AnalyticsDataPoint) HasTotal() bool` HasTotal returns a boolean if a field has been set. ### SetTotal -`func (o *ApplicationAnalyticsDataPointTotalRevenue) SetTotal(v float32)` +`func (o *AnalyticsDataPoint) SetTotal(v float32)` SetTotal gets a reference to the given float32 and assigns it to the Total field. ### GetInfluenced -`func (o *ApplicationAnalyticsDataPointTotalRevenue) GetInfluenced() float32` +`func (o *AnalyticsDataPoint) GetInfluenced() float32` GetInfluenced returns the Influenced field if non-nil, zero value otherwise. ### GetInfluencedOk -`func (o *ApplicationAnalyticsDataPointTotalRevenue) GetInfluencedOk() (float32, bool)` +`func (o *AnalyticsDataPoint) GetInfluencedOk() (float32, bool)` GetInfluencedOk returns a tuple with the Influenced field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasInfluenced -`func (o *ApplicationAnalyticsDataPointTotalRevenue) HasInfluenced() bool` +`func (o *AnalyticsDataPoint) HasInfluenced() bool` HasInfluenced returns a boolean if a field has been set. ### SetInfluenced -`func (o *ApplicationAnalyticsDataPointTotalRevenue) SetInfluenced(v float32)` +`func (o *AnalyticsDataPoint) SetInfluenced(v float32)` SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. diff --git a/docs/ApplicationCampaignAnalyticsCouponsCount.md b/docs/AnalyticsDataPointWithTrend.md similarity index 59% rename from docs/ApplicationCampaignAnalyticsCouponsCount.md rename to docs/AnalyticsDataPointWithTrend.md index 1aca37ee..ecd4a480 100644 --- a/docs/ApplicationCampaignAnalyticsCouponsCount.md +++ b/docs/AnalyticsDataPointWithTrend.md @@ -1,61 +1,61 @@ -# ApplicationCampaignAnalyticsCouponsCount +# AnalyticsDataPointWithTrend ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] +**Value** | Pointer to **float32** | | +**Trend** | Pointer to **float32** | | ## Methods ### GetValue -`func (o *ApplicationCampaignAnalyticsCouponsCount) GetValue() float32` +`func (o *AnalyticsDataPointWithTrend) GetValue() float32` GetValue returns the Value field if non-nil, zero value otherwise. ### GetValueOk -`func (o *ApplicationCampaignAnalyticsCouponsCount) GetValueOk() (float32, bool)` +`func (o *AnalyticsDataPointWithTrend) GetValueOk() (float32, bool)` GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasValue -`func (o *ApplicationCampaignAnalyticsCouponsCount) HasValue() bool` +`func (o *AnalyticsDataPointWithTrend) HasValue() bool` HasValue returns a boolean if a field has been set. ### SetValue -`func (o *ApplicationCampaignAnalyticsCouponsCount) SetValue(v float32)` +`func (o *AnalyticsDataPointWithTrend) SetValue(v float32)` SetValue gets a reference to the given float32 and assigns it to the Value field. ### GetTrend -`func (o *ApplicationCampaignAnalyticsCouponsCount) GetTrend() float32` +`func (o *AnalyticsDataPointWithTrend) GetTrend() float32` GetTrend returns the Trend field if non-nil, zero value otherwise. ### GetTrendOk -`func (o *ApplicationCampaignAnalyticsCouponsCount) GetTrendOk() (float32, bool)` +`func (o *AnalyticsDataPointWithTrend) GetTrendOk() (float32, bool)` GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasTrend -`func (o *ApplicationCampaignAnalyticsCouponsCount) HasTrend() bool` +`func (o *AnalyticsDataPointWithTrend) HasTrend() bool` HasTrend returns a boolean if a field has been set. ### SetTrend -`func (o *ApplicationCampaignAnalyticsCouponsCount) SetTrend(v float32)` +`func (o *AnalyticsDataPointWithTrend) SetTrend(v float32)` SetTrend gets a reference to the given float32 and assigns it to the Trend field. diff --git a/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md b/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md new file mode 100644 index 00000000..91e05179 --- /dev/null +++ b/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md @@ -0,0 +1,91 @@ +# AnalyticsDataPointWithTrendAndInfluencedRate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **float32** | | +**InfluencedRate** | Pointer to **float32** | | +**Trend** | Pointer to **float32** | | + +## Methods + +### GetValue + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetValueOk() (float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetValue(v float32)` + +SetValue gets a reference to the given float32 and assigns it to the Value field. + +### GetInfluencedRate + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetInfluencedRate() float32` + +GetInfluencedRate returns the InfluencedRate field if non-nil, zero value otherwise. + +### GetInfluencedRateOk + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetInfluencedRateOk() (float32, bool)` + +GetInfluencedRateOk returns a tuple with the InfluencedRate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasInfluencedRate + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) HasInfluencedRate() bool` + +HasInfluencedRate returns a boolean if a field has been set. + +### SetInfluencedRate + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetInfluencedRate(v float32)` + +SetInfluencedRate gets a reference to the given float32 and assigns it to the InfluencedRate field. + +### GetTrend + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetTrend() float32` + +GetTrend returns the Trend field if non-nil, zero value otherwise. + +### GetTrendOk + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetTrendOk() (float32, bool)` + +GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTrend + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) HasTrend() bool` + +HasTrend returns a boolean if a field has been set. + +### SetTrend + +`func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetTrend(v float32)` + +SetTrend gets a reference to the given float32 and assigns it to the Trend field. + + +[[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/ApplicationCampaignAnalyticsAvgSessionValue.md b/docs/AnalyticsDataPointWithTrendAndUplift.md similarity index 57% rename from docs/ApplicationCampaignAnalyticsAvgSessionValue.md rename to docs/AnalyticsDataPointWithTrendAndUplift.md index ae60ad25..904b4fcb 100644 --- a/docs/ApplicationCampaignAnalyticsAvgSessionValue.md +++ b/docs/AnalyticsDataPointWithTrendAndUplift.md @@ -1,87 +1,87 @@ -# ApplicationCampaignAnalyticsAvgSessionValue +# AnalyticsDataPointWithTrendAndUplift ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**Uplift** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] +**Value** | Pointer to **float32** | | +**Uplift** | Pointer to **float32** | | +**Trend** | Pointer to **float32** | | ## Methods ### GetValue -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetValue() float32` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetValue() float32` GetValue returns the Value field if non-nil, zero value otherwise. ### GetValueOk -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetValueOk() (float32, bool)` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetValueOk() (float32, bool)` GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasValue -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasValue() bool` +`func (o *AnalyticsDataPointWithTrendAndUplift) HasValue() bool` HasValue returns a boolean if a field has been set. ### SetValue -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetValue(v float32)` +`func (o *AnalyticsDataPointWithTrendAndUplift) SetValue(v float32)` SetValue gets a reference to the given float32 and assigns it to the Value field. ### GetUplift -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetUplift() float32` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetUplift() float32` GetUplift returns the Uplift field if non-nil, zero value otherwise. ### GetUpliftOk -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetUpliftOk() (float32, bool)` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetUpliftOk() (float32, bool)` GetUpliftOk returns a tuple with the Uplift field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasUplift -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasUplift() bool` +`func (o *AnalyticsDataPointWithTrendAndUplift) HasUplift() bool` HasUplift returns a boolean if a field has been set. ### SetUplift -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetUplift(v float32)` +`func (o *AnalyticsDataPointWithTrendAndUplift) SetUplift(v float32)` SetUplift gets a reference to the given float32 and assigns it to the Uplift field. ### GetTrend -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetTrend() float32` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetTrend() float32` GetTrend returns the Trend field if non-nil, zero value otherwise. ### GetTrendOk -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetTrendOk() (float32, bool)` +`func (o *AnalyticsDataPointWithTrendAndUplift) GetTrendOk() (float32, bool)` GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. ### HasTrend -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasTrend() bool` +`func (o *AnalyticsDataPointWithTrendAndUplift) HasTrend() bool` HasTrend returns a boolean if a field has been set. ### SetTrend -`func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetTrend(v float32)` +`func (o *AnalyticsDataPointWithTrendAndUplift) SetTrend(v float32)` SetTrend gets a reference to the given float32 and assigns it to the Trend field. diff --git a/docs/Application.md b/docs/Application.md index ef7fdae1..4a0e75ba 100644 --- a/docs/Application.md +++ b/docs/Application.md @@ -23,6 +23,8 @@ Name | Type | Description | Notes **EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] **DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] **DefaultEvaluationGroupId** | Pointer to **int32** | 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** | Pointer to **int32** | The ID of the default Cart-Item-Filter for this application. | [optional] +**EnableCampaignStateManagement** | Pointer to **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** | Pointer to [**[]LoyaltyProgram**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. | ## Methods @@ -502,6 +504,56 @@ HasDefaultEvaluationGroupId returns a boolean if a field has been set. SetDefaultEvaluationGroupId gets a reference to the given int32 and assigns it to the DefaultEvaluationGroupId field. +### GetDefaultCartItemFilterId + +`func (o *Application) GetDefaultCartItemFilterId() int32` + +GetDefaultCartItemFilterId returns the DefaultCartItemFilterId field if non-nil, zero value otherwise. + +### GetDefaultCartItemFilterIdOk + +`func (o *Application) GetDefaultCartItemFilterIdOk() (int32, bool)` + +GetDefaultCartItemFilterIdOk returns a tuple with the DefaultCartItemFilterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultCartItemFilterId + +`func (o *Application) HasDefaultCartItemFilterId() bool` + +HasDefaultCartItemFilterId returns a boolean if a field has been set. + +### SetDefaultCartItemFilterId + +`func (o *Application) SetDefaultCartItemFilterId(v int32)` + +SetDefaultCartItemFilterId gets a reference to the given int32 and assigns it to the DefaultCartItemFilterId field. + +### GetEnableCampaignStateManagement + +`func (o *Application) GetEnableCampaignStateManagement() bool` + +GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field if non-nil, zero value otherwise. + +### GetEnableCampaignStateManagementOk + +`func (o *Application) GetEnableCampaignStateManagementOk() (bool, bool)` + +GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCampaignStateManagement + +`func (o *Application) HasEnableCampaignStateManagement() bool` + +HasEnableCampaignStateManagement returns a boolean if a field has been set. + +### SetEnableCampaignStateManagement + +`func (o *Application) SetEnableCampaignStateManagement(v bool)` + +SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. + ### GetLoyaltyPrograms `func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram` diff --git a/docs/ApplicationAnalyticsDataPoint.md b/docs/ApplicationAnalyticsDataPoint.md index 3d71b6a2..b93c20b4 100644 --- a/docs/ApplicationAnalyticsDataPoint.md +++ b/docs/ApplicationAnalyticsDataPoint.md @@ -4,12 +4,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**StartTime** | Pointer to [**time.Time**](time.Time.md) | The start of the aggregation time frame in UTC. | [optional] -**EndTime** | Pointer to [**time.Time**](time.Time.md) | The end of the aggregation time frame in UTC. | [optional] -**TotalRevenue** | Pointer to [**ApplicationAnalyticsDataPointTotalRevenue**](ApplicationAnalyticsDataPoint_totalRevenue.md) | | [optional] -**SessionsCount** | Pointer to [**ApplicationAnalyticsDataPointSessionsCount**](ApplicationAnalyticsDataPoint_sessionsCount.md) | | [optional] -**AvgItemsPerSession** | Pointer to [**ApplicationAnalyticsDataPointAvgItemsPerSession**](ApplicationAnalyticsDataPoint_avgItemsPerSession.md) | | [optional] -**AvgSessionValue** | Pointer to [**ApplicationAnalyticsDataPointAvgSessionValue**](ApplicationAnalyticsDataPoint_avgSessionValue.md) | | [optional] +**StartTime** | Pointer to [**time.Time**](time.Time.md) | The start of the aggregation time frame in UTC. | +**EndTime** | Pointer to [**time.Time**](time.Time.md) | The end of the aggregation time frame in UTC. | +**TotalRevenue** | Pointer to [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional] +**SessionsCount** | Pointer to [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional] +**AvgItemsPerSession** | Pointer to [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional] +**AvgSessionValue** | Pointer to [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional] **TotalDiscounts** | Pointer to **float32** | The total value of discounts given for cart items in influenced sessions. | [optional] **CouponsCount** | Pointer to **float32** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional] @@ -67,13 +67,13 @@ SetEndTime gets a reference to the given time.Time and assigns it to the EndTime ### GetTotalRevenue -`func (o *ApplicationAnalyticsDataPoint) GetTotalRevenue() ApplicationAnalyticsDataPointTotalRevenue` +`func (o *ApplicationAnalyticsDataPoint) GetTotalRevenue() AnalyticsDataPoint` GetTotalRevenue returns the TotalRevenue field if non-nil, zero value otherwise. ### GetTotalRevenueOk -`func (o *ApplicationAnalyticsDataPoint) GetTotalRevenueOk() (ApplicationAnalyticsDataPointTotalRevenue, bool)` +`func (o *ApplicationAnalyticsDataPoint) GetTotalRevenueOk() (AnalyticsDataPoint, bool)` GetTotalRevenueOk returns a tuple with the TotalRevenue field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -86,19 +86,19 @@ HasTotalRevenue returns a boolean if a field has been set. ### SetTotalRevenue -`func (o *ApplicationAnalyticsDataPoint) SetTotalRevenue(v ApplicationAnalyticsDataPointTotalRevenue)` +`func (o *ApplicationAnalyticsDataPoint) SetTotalRevenue(v AnalyticsDataPoint)` -SetTotalRevenue gets a reference to the given ApplicationAnalyticsDataPointTotalRevenue and assigns it to the TotalRevenue field. +SetTotalRevenue gets a reference to the given AnalyticsDataPoint and assigns it to the TotalRevenue field. ### GetSessionsCount -`func (o *ApplicationAnalyticsDataPoint) GetSessionsCount() ApplicationAnalyticsDataPointSessionsCount` +`func (o *ApplicationAnalyticsDataPoint) GetSessionsCount() AnalyticsDataPoint` GetSessionsCount returns the SessionsCount field if non-nil, zero value otherwise. ### GetSessionsCountOk -`func (o *ApplicationAnalyticsDataPoint) GetSessionsCountOk() (ApplicationAnalyticsDataPointSessionsCount, bool)` +`func (o *ApplicationAnalyticsDataPoint) GetSessionsCountOk() (AnalyticsDataPoint, bool)` GetSessionsCountOk returns a tuple with the SessionsCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -111,19 +111,19 @@ HasSessionsCount returns a boolean if a field has been set. ### SetSessionsCount -`func (o *ApplicationAnalyticsDataPoint) SetSessionsCount(v ApplicationAnalyticsDataPointSessionsCount)` +`func (o *ApplicationAnalyticsDataPoint) SetSessionsCount(v AnalyticsDataPoint)` -SetSessionsCount gets a reference to the given ApplicationAnalyticsDataPointSessionsCount and assigns it to the SessionsCount field. +SetSessionsCount gets a reference to the given AnalyticsDataPoint and assigns it to the SessionsCount field. ### GetAvgItemsPerSession -`func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSession() ApplicationAnalyticsDataPointAvgItemsPerSession` +`func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSession() AnalyticsDataPoint` GetAvgItemsPerSession returns the AvgItemsPerSession field if non-nil, zero value otherwise. ### GetAvgItemsPerSessionOk -`func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSessionOk() (ApplicationAnalyticsDataPointAvgItemsPerSession, bool)` +`func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSessionOk() (AnalyticsDataPoint, bool)` GetAvgItemsPerSessionOk returns a tuple with the AvgItemsPerSession field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -136,19 +136,19 @@ HasAvgItemsPerSession returns a boolean if a field has been set. ### SetAvgItemsPerSession -`func (o *ApplicationAnalyticsDataPoint) SetAvgItemsPerSession(v ApplicationAnalyticsDataPointAvgItemsPerSession)` +`func (o *ApplicationAnalyticsDataPoint) SetAvgItemsPerSession(v AnalyticsDataPoint)` -SetAvgItemsPerSession gets a reference to the given ApplicationAnalyticsDataPointAvgItemsPerSession and assigns it to the AvgItemsPerSession field. +SetAvgItemsPerSession gets a reference to the given AnalyticsDataPoint and assigns it to the AvgItemsPerSession field. ### GetAvgSessionValue -`func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValue() ApplicationAnalyticsDataPointAvgSessionValue` +`func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValue() AnalyticsDataPoint` GetAvgSessionValue returns the AvgSessionValue field if non-nil, zero value otherwise. ### GetAvgSessionValueOk -`func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValueOk() (ApplicationAnalyticsDataPointAvgSessionValue, bool)` +`func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValueOk() (AnalyticsDataPoint, bool)` GetAvgSessionValueOk returns a tuple with the AvgSessionValue field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -161,9 +161,9 @@ HasAvgSessionValue returns a boolean if a field has been set. ### SetAvgSessionValue -`func (o *ApplicationAnalyticsDataPoint) SetAvgSessionValue(v ApplicationAnalyticsDataPointAvgSessionValue)` +`func (o *ApplicationAnalyticsDataPoint) SetAvgSessionValue(v AnalyticsDataPoint)` -SetAvgSessionValue gets a reference to the given ApplicationAnalyticsDataPointAvgSessionValue and assigns it to the AvgSessionValue field. +SetAvgSessionValue gets a reference to the given AnalyticsDataPoint and assigns it to the AvgSessionValue field. ### GetTotalDiscounts diff --git a/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md b/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md deleted file mode 100644 index aea8150b..00000000 --- a/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md +++ /dev/null @@ -1,65 +0,0 @@ -# ApplicationAnalyticsDataPointAvgItemsPerSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | | [optional] -**Influenced** | Pointer to **float32** | | [optional] - -## Methods - -### GetTotal - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetTotal() float32` - -GetTotal returns the Total field if non-nil, zero value otherwise. - -### GetTotalOk - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetTotalOk() (float32, bool)` - -GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotal - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) HasTotal() bool` - -HasTotal returns a boolean if a field has been set. - -### SetTotal - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) SetTotal(v float32)` - -SetTotal gets a reference to the given float32 and assigns it to the Total field. - -### GetInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetInfluenced() float32` - -GetInfluenced returns the Influenced field if non-nil, zero value otherwise. - -### GetInfluencedOk - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetInfluencedOk() (float32, bool)` - -GetInfluencedOk returns a tuple with the Influenced field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) HasInfluenced() bool` - -HasInfluenced returns a boolean if a field has been set. - -### SetInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) SetInfluenced(v float32)` - -SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. - - -[[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 deleted file mode 100644 index 99cfb48c..00000000 --- a/docs/ApplicationAnalyticsDataPointAvgSessionValue.md +++ /dev/null @@ -1,65 +0,0 @@ -# ApplicationAnalyticsDataPointAvgSessionValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | | [optional] -**Influenced** | Pointer to **float32** | | [optional] - -## Methods - -### GetTotal - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetTotal() float32` - -GetTotal returns the Total field if non-nil, zero value otherwise. - -### GetTotalOk - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetTotalOk() (float32, bool)` - -GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotal - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) HasTotal() bool` - -HasTotal returns a boolean if a field has been set. - -### SetTotal - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) SetTotal(v float32)` - -SetTotal gets a reference to the given float32 and assigns it to the Total field. - -### GetInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetInfluenced() float32` - -GetInfluenced returns the Influenced field if non-nil, zero value otherwise. - -### GetInfluencedOk - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetInfluencedOk() (float32, bool)` - -GetInfluencedOk returns a tuple with the Influenced field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) HasInfluenced() bool` - -HasInfluenced returns a boolean if a field has been set. - -### SetInfluenced - -`func (o *ApplicationAnalyticsDataPointAvgSessionValue) SetInfluenced(v float32)` - -SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. - - -[[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/ApplicationAnalyticsDataPointSessionsCount.md b/docs/ApplicationAnalyticsDataPointSessionsCount.md deleted file mode 100644 index 040492df..00000000 --- a/docs/ApplicationAnalyticsDataPointSessionsCount.md +++ /dev/null @@ -1,65 +0,0 @@ -# ApplicationAnalyticsDataPointSessionsCount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Total** | Pointer to **float32** | | [optional] -**Influenced** | Pointer to **float32** | | [optional] - -## Methods - -### GetTotal - -`func (o *ApplicationAnalyticsDataPointSessionsCount) GetTotal() float32` - -GetTotal returns the Total field if non-nil, zero value otherwise. - -### GetTotalOk - -`func (o *ApplicationAnalyticsDataPointSessionsCount) GetTotalOk() (float32, bool)` - -GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotal - -`func (o *ApplicationAnalyticsDataPointSessionsCount) HasTotal() bool` - -HasTotal returns a boolean if a field has been set. - -### SetTotal - -`func (o *ApplicationAnalyticsDataPointSessionsCount) SetTotal(v float32)` - -SetTotal gets a reference to the given float32 and assigns it to the Total field. - -### GetInfluenced - -`func (o *ApplicationAnalyticsDataPointSessionsCount) GetInfluenced() float32` - -GetInfluenced returns the Influenced field if non-nil, zero value otherwise. - -### GetInfluencedOk - -`func (o *ApplicationAnalyticsDataPointSessionsCount) GetInfluencedOk() (float32, bool)` - -GetInfluencedOk returns a tuple with the Influenced field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasInfluenced - -`func (o *ApplicationAnalyticsDataPointSessionsCount) HasInfluenced() bool` - -HasInfluenced returns a boolean if a field has been set. - -### SetInfluenced - -`func (o *ApplicationAnalyticsDataPointSessionsCount) SetInfluenced(v float32)` - -SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. - - -[[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/ApplicationCampaignAnalytics.md b/docs/ApplicationCampaignAnalytics.md index 6a15696a..c10008bb 100644 --- a/docs/ApplicationCampaignAnalytics.md +++ b/docs/ApplicationCampaignAnalytics.md @@ -4,21 +4,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**StartTime** | Pointer to [**time.Time**](time.Time.md) | The start of the aggregation time frame in UTC. | [optional] -**EndTime** | Pointer to [**time.Time**](time.Time.md) | The end of the aggregation time frame in UTC. | [optional] -**CampaignId** | Pointer to **int32** | The ID of the campaign. | [optional] -**CampaignName** | Pointer to **string** | The name of the campaign. | [optional] -**CampaignTags** | Pointer to **[]string** | A list of tags for the campaign. | [optional] -**CampaignState** | Pointer to **string** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | [optional] [default to CAMPAIGN_STATE_ENABLED] -**CampaignActiveRulesetId** | Pointer to **int32** | The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] -**CampaignStartTime** | Pointer to [**time.Time**](time.Time.md) | Date and time when the campaign becomes active. | [optional] -**CampaignEndTime** | Pointer to [**time.Time**](time.Time.md) | Date and time when the campaign becomes inactive. | [optional] -**TotalRevenue** | Pointer to [**ApplicationCampaignAnalyticsTotalRevenue**](ApplicationCampaignAnalytics_totalRevenue.md) | | [optional] -**SessionsCount** | Pointer to [**ApplicationCampaignAnalyticsSessionsCount**](ApplicationCampaignAnalytics_sessionsCount.md) | | [optional] -**AvgItemsPerSession** | Pointer to [**ApplicationCampaignAnalyticsAvgItemsPerSession**](ApplicationCampaignAnalytics_avgItemsPerSession.md) | | [optional] -**AvgSessionValue** | Pointer to [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalytics_avgSessionValue.md) | | [optional] -**TotalDiscounts** | Pointer to [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalytics_totalDiscounts.md) | | [optional] -**CouponsCount** | Pointer to [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalytics_couponsCount.md) | | [optional] +**StartTime** | Pointer to [**time.Time**](time.Time.md) | The start of the aggregation time frame in UTC. | +**EndTime** | Pointer to [**time.Time**](time.Time.md) | The end of the aggregation time frame in UTC. | +**CampaignId** | Pointer to **int32** | The ID of the campaign. | +**CampaignName** | Pointer to **string** | The name of the campaign. | +**CampaignTags** | Pointer to **[]string** | A list of tags for the campaign. | +**CampaignState** | Pointer to **string** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. | +**TotalRevenue** | Pointer to [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional] +**SessionsCount** | Pointer to [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional] +**AvgItemsPerSession** | Pointer to [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional] +**AvgSessionValue** | Pointer to [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional] +**TotalDiscounts** | Pointer to [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional] +**CouponsCount** | Pointer to [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional] ## Methods @@ -172,90 +169,15 @@ HasCampaignState returns a boolean if a field has been set. SetCampaignState gets a reference to the given string and assigns it to the CampaignState field. -### GetCampaignActiveRulesetId - -`func (o *ApplicationCampaignAnalytics) GetCampaignActiveRulesetId() int32` - -GetCampaignActiveRulesetId returns the CampaignActiveRulesetId field if non-nil, zero value otherwise. - -### GetCampaignActiveRulesetIdOk - -`func (o *ApplicationCampaignAnalytics) GetCampaignActiveRulesetIdOk() (int32, bool)` - -GetCampaignActiveRulesetIdOk returns a tuple with the CampaignActiveRulesetId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignActiveRulesetId - -`func (o *ApplicationCampaignAnalytics) HasCampaignActiveRulesetId() bool` - -HasCampaignActiveRulesetId returns a boolean if a field has been set. - -### SetCampaignActiveRulesetId - -`func (o *ApplicationCampaignAnalytics) SetCampaignActiveRulesetId(v int32)` - -SetCampaignActiveRulesetId gets a reference to the given int32 and assigns it to the CampaignActiveRulesetId field. - -### GetCampaignStartTime - -`func (o *ApplicationCampaignAnalytics) GetCampaignStartTime() time.Time` - -GetCampaignStartTime returns the CampaignStartTime field if non-nil, zero value otherwise. - -### GetCampaignStartTimeOk - -`func (o *ApplicationCampaignAnalytics) GetCampaignStartTimeOk() (time.Time, bool)` - -GetCampaignStartTimeOk returns a tuple with the CampaignStartTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignStartTime - -`func (o *ApplicationCampaignAnalytics) HasCampaignStartTime() bool` - -HasCampaignStartTime returns a boolean if a field has been set. - -### SetCampaignStartTime - -`func (o *ApplicationCampaignAnalytics) SetCampaignStartTime(v time.Time)` - -SetCampaignStartTime gets a reference to the given time.Time and assigns it to the CampaignStartTime field. - -### GetCampaignEndTime - -`func (o *ApplicationCampaignAnalytics) GetCampaignEndTime() time.Time` - -GetCampaignEndTime returns the CampaignEndTime field if non-nil, zero value otherwise. - -### GetCampaignEndTimeOk - -`func (o *ApplicationCampaignAnalytics) GetCampaignEndTimeOk() (time.Time, bool)` - -GetCampaignEndTimeOk returns a tuple with the CampaignEndTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignEndTime - -`func (o *ApplicationCampaignAnalytics) HasCampaignEndTime() bool` - -HasCampaignEndTime returns a boolean if a field has been set. - -### SetCampaignEndTime - -`func (o *ApplicationCampaignAnalytics) SetCampaignEndTime(v time.Time)` - -SetCampaignEndTime gets a reference to the given time.Time and assigns it to the CampaignEndTime field. - ### GetTotalRevenue -`func (o *ApplicationCampaignAnalytics) GetTotalRevenue() ApplicationCampaignAnalyticsTotalRevenue` +`func (o *ApplicationCampaignAnalytics) GetTotalRevenue() AnalyticsDataPointWithTrendAndInfluencedRate` GetTotalRevenue returns the TotalRevenue field if non-nil, zero value otherwise. ### GetTotalRevenueOk -`func (o *ApplicationCampaignAnalytics) GetTotalRevenueOk() (ApplicationCampaignAnalyticsTotalRevenue, bool)` +`func (o *ApplicationCampaignAnalytics) GetTotalRevenueOk() (AnalyticsDataPointWithTrendAndInfluencedRate, bool)` GetTotalRevenueOk returns a tuple with the TotalRevenue field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -268,19 +190,19 @@ HasTotalRevenue returns a boolean if a field has been set. ### SetTotalRevenue -`func (o *ApplicationCampaignAnalytics) SetTotalRevenue(v ApplicationCampaignAnalyticsTotalRevenue)` +`func (o *ApplicationCampaignAnalytics) SetTotalRevenue(v AnalyticsDataPointWithTrendAndInfluencedRate)` -SetTotalRevenue gets a reference to the given ApplicationCampaignAnalyticsTotalRevenue and assigns it to the TotalRevenue field. +SetTotalRevenue gets a reference to the given AnalyticsDataPointWithTrendAndInfluencedRate and assigns it to the TotalRevenue field. ### GetSessionsCount -`func (o *ApplicationCampaignAnalytics) GetSessionsCount() ApplicationCampaignAnalyticsSessionsCount` +`func (o *ApplicationCampaignAnalytics) GetSessionsCount() AnalyticsDataPointWithTrendAndInfluencedRate` GetSessionsCount returns the SessionsCount field if non-nil, zero value otherwise. ### GetSessionsCountOk -`func (o *ApplicationCampaignAnalytics) GetSessionsCountOk() (ApplicationCampaignAnalyticsSessionsCount, bool)` +`func (o *ApplicationCampaignAnalytics) GetSessionsCountOk() (AnalyticsDataPointWithTrendAndInfluencedRate, bool)` GetSessionsCountOk returns a tuple with the SessionsCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -293,19 +215,19 @@ HasSessionsCount returns a boolean if a field has been set. ### SetSessionsCount -`func (o *ApplicationCampaignAnalytics) SetSessionsCount(v ApplicationCampaignAnalyticsSessionsCount)` +`func (o *ApplicationCampaignAnalytics) SetSessionsCount(v AnalyticsDataPointWithTrendAndInfluencedRate)` -SetSessionsCount gets a reference to the given ApplicationCampaignAnalyticsSessionsCount and assigns it to the SessionsCount field. +SetSessionsCount gets a reference to the given AnalyticsDataPointWithTrendAndInfluencedRate and assigns it to the SessionsCount field. ### GetAvgItemsPerSession -`func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSession() ApplicationCampaignAnalyticsAvgItemsPerSession` +`func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSession() AnalyticsDataPointWithTrendAndUplift` GetAvgItemsPerSession returns the AvgItemsPerSession field if non-nil, zero value otherwise. ### GetAvgItemsPerSessionOk -`func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSessionOk() (ApplicationCampaignAnalyticsAvgItemsPerSession, bool)` +`func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSessionOk() (AnalyticsDataPointWithTrendAndUplift, bool)` GetAvgItemsPerSessionOk returns a tuple with the AvgItemsPerSession field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -318,19 +240,19 @@ HasAvgItemsPerSession returns a boolean if a field has been set. ### SetAvgItemsPerSession -`func (o *ApplicationCampaignAnalytics) SetAvgItemsPerSession(v ApplicationCampaignAnalyticsAvgItemsPerSession)` +`func (o *ApplicationCampaignAnalytics) SetAvgItemsPerSession(v AnalyticsDataPointWithTrendAndUplift)` -SetAvgItemsPerSession gets a reference to the given ApplicationCampaignAnalyticsAvgItemsPerSession and assigns it to the AvgItemsPerSession field. +SetAvgItemsPerSession gets a reference to the given AnalyticsDataPointWithTrendAndUplift and assigns it to the AvgItemsPerSession field. ### GetAvgSessionValue -`func (o *ApplicationCampaignAnalytics) GetAvgSessionValue() ApplicationCampaignAnalyticsAvgSessionValue` +`func (o *ApplicationCampaignAnalytics) GetAvgSessionValue() AnalyticsDataPointWithTrendAndUplift` GetAvgSessionValue returns the AvgSessionValue field if non-nil, zero value otherwise. ### GetAvgSessionValueOk -`func (o *ApplicationCampaignAnalytics) GetAvgSessionValueOk() (ApplicationCampaignAnalyticsAvgSessionValue, bool)` +`func (o *ApplicationCampaignAnalytics) GetAvgSessionValueOk() (AnalyticsDataPointWithTrendAndUplift, bool)` GetAvgSessionValueOk returns a tuple with the AvgSessionValue field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -343,19 +265,19 @@ HasAvgSessionValue returns a boolean if a field has been set. ### SetAvgSessionValue -`func (o *ApplicationCampaignAnalytics) SetAvgSessionValue(v ApplicationCampaignAnalyticsAvgSessionValue)` +`func (o *ApplicationCampaignAnalytics) SetAvgSessionValue(v AnalyticsDataPointWithTrendAndUplift)` -SetAvgSessionValue gets a reference to the given ApplicationCampaignAnalyticsAvgSessionValue and assigns it to the AvgSessionValue field. +SetAvgSessionValue gets a reference to the given AnalyticsDataPointWithTrendAndUplift and assigns it to the AvgSessionValue field. ### GetTotalDiscounts -`func (o *ApplicationCampaignAnalytics) GetTotalDiscounts() ApplicationCampaignAnalyticsTotalDiscounts` +`func (o *ApplicationCampaignAnalytics) GetTotalDiscounts() AnalyticsDataPointWithTrend` GetTotalDiscounts returns the TotalDiscounts field if non-nil, zero value otherwise. ### GetTotalDiscountsOk -`func (o *ApplicationCampaignAnalytics) GetTotalDiscountsOk() (ApplicationCampaignAnalyticsTotalDiscounts, bool)` +`func (o *ApplicationCampaignAnalytics) GetTotalDiscountsOk() (AnalyticsDataPointWithTrend, bool)` GetTotalDiscountsOk returns a tuple with the TotalDiscounts field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -368,19 +290,19 @@ HasTotalDiscounts returns a boolean if a field has been set. ### SetTotalDiscounts -`func (o *ApplicationCampaignAnalytics) SetTotalDiscounts(v ApplicationCampaignAnalyticsTotalDiscounts)` +`func (o *ApplicationCampaignAnalytics) SetTotalDiscounts(v AnalyticsDataPointWithTrend)` -SetTotalDiscounts gets a reference to the given ApplicationCampaignAnalyticsTotalDiscounts and assigns it to the TotalDiscounts field. +SetTotalDiscounts gets a reference to the given AnalyticsDataPointWithTrend and assigns it to the TotalDiscounts field. ### GetCouponsCount -`func (o *ApplicationCampaignAnalytics) GetCouponsCount() ApplicationCampaignAnalyticsCouponsCount` +`func (o *ApplicationCampaignAnalytics) GetCouponsCount() AnalyticsDataPointWithTrend` GetCouponsCount returns the CouponsCount field if non-nil, zero value otherwise. ### GetCouponsCountOk -`func (o *ApplicationCampaignAnalytics) GetCouponsCountOk() (ApplicationCampaignAnalyticsCouponsCount, bool)` +`func (o *ApplicationCampaignAnalytics) GetCouponsCountOk() (AnalyticsDataPointWithTrend, bool)` GetCouponsCountOk returns a tuple with the CouponsCount field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. @@ -393,9 +315,9 @@ HasCouponsCount returns a boolean if a field has been set. ### SetCouponsCount -`func (o *ApplicationCampaignAnalytics) SetCouponsCount(v ApplicationCampaignAnalyticsCouponsCount)` +`func (o *ApplicationCampaignAnalytics) SetCouponsCount(v AnalyticsDataPointWithTrend)` -SetCouponsCount gets a reference to the given ApplicationCampaignAnalyticsCouponsCount and assigns it to the CouponsCount field. +SetCouponsCount gets a reference to the given AnalyticsDataPointWithTrend and assigns it to the CouponsCount field. [[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/ApplicationCampaignAnalyticsAvgItemsPerSession.md b/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md deleted file mode 100644 index 132f430a..00000000 --- a/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md +++ /dev/null @@ -1,91 +0,0 @@ -# ApplicationCampaignAnalyticsAvgItemsPerSession - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**Uplift** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] - -## Methods - -### GetValue - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetValue() float32` - -GetValue returns the Value field if non-nil, zero value otherwise. - -### GetValueOk - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetValueOk() (float32, bool)` - -GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasValue - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasValue() bool` - -HasValue returns a boolean if a field has been set. - -### SetValue - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetValue(v float32)` - -SetValue gets a reference to the given float32 and assigns it to the Value field. - -### GetUplift - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetUplift() float32` - -GetUplift returns the Uplift field if non-nil, zero value otherwise. - -### GetUpliftOk - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetUpliftOk() (float32, bool)` - -GetUpliftOk returns a tuple with the Uplift field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUplift - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasUplift() bool` - -HasUplift returns a boolean if a field has been set. - -### SetUplift - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetUplift(v float32)` - -SetUplift gets a reference to the given float32 and assigns it to the Uplift field. - -### GetTrend - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetTrend() float32` - -GetTrend returns the Trend field if non-nil, zero value otherwise. - -### GetTrendOk - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetTrendOk() (float32, bool)` - -GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTrend - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasTrend() bool` - -HasTrend returns a boolean if a field has been set. - -### SetTrend - -`func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetTrend(v float32)` - -SetTrend gets a reference to the given float32 and assigns it to the Trend field. - - -[[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/ApplicationCampaignAnalyticsSessionsCount.md b/docs/ApplicationCampaignAnalyticsSessionsCount.md deleted file mode 100644 index 3ef7ee47..00000000 --- a/docs/ApplicationCampaignAnalyticsSessionsCount.md +++ /dev/null @@ -1,91 +0,0 @@ -# ApplicationCampaignAnalyticsSessionsCount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**InfluenceRate** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] - -## Methods - -### GetValue - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetValue() float32` - -GetValue returns the Value field if non-nil, zero value otherwise. - -### GetValueOk - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetValueOk() (float32, bool)` - -GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasValue - -`func (o *ApplicationCampaignAnalyticsSessionsCount) HasValue() bool` - -HasValue returns a boolean if a field has been set. - -### SetValue - -`func (o *ApplicationCampaignAnalyticsSessionsCount) SetValue(v float32)` - -SetValue gets a reference to the given float32 and assigns it to the Value field. - -### GetInfluenceRate - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetInfluenceRate() float32` - -GetInfluenceRate returns the InfluenceRate field if non-nil, zero value otherwise. - -### GetInfluenceRateOk - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetInfluenceRateOk() (float32, bool)` - -GetInfluenceRateOk returns a tuple with the InfluenceRate field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasInfluenceRate - -`func (o *ApplicationCampaignAnalyticsSessionsCount) HasInfluenceRate() bool` - -HasInfluenceRate returns a boolean if a field has been set. - -### SetInfluenceRate - -`func (o *ApplicationCampaignAnalyticsSessionsCount) SetInfluenceRate(v float32)` - -SetInfluenceRate gets a reference to the given float32 and assigns it to the InfluenceRate field. - -### GetTrend - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetTrend() float32` - -GetTrend returns the Trend field if non-nil, zero value otherwise. - -### GetTrendOk - -`func (o *ApplicationCampaignAnalyticsSessionsCount) GetTrendOk() (float32, bool)` - -GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTrend - -`func (o *ApplicationCampaignAnalyticsSessionsCount) HasTrend() bool` - -HasTrend returns a boolean if a field has been set. - -### SetTrend - -`func (o *ApplicationCampaignAnalyticsSessionsCount) SetTrend(v float32)` - -SetTrend gets a reference to the given float32 and assigns it to the Trend field. - - -[[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/ApplicationCampaignAnalyticsTotalDiscounts.md b/docs/ApplicationCampaignAnalyticsTotalDiscounts.md deleted file mode 100644 index 6c2ade82..00000000 --- a/docs/ApplicationCampaignAnalyticsTotalDiscounts.md +++ /dev/null @@ -1,65 +0,0 @@ -# ApplicationCampaignAnalyticsTotalDiscounts - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] - -## Methods - -### GetValue - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetValue() float32` - -GetValue returns the Value field if non-nil, zero value otherwise. - -### GetValueOk - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetValueOk() (float32, bool)` - -GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasValue - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) HasValue() bool` - -HasValue returns a boolean if a field has been set. - -### SetValue - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) SetValue(v float32)` - -SetValue gets a reference to the given float32 and assigns it to the Value field. - -### GetTrend - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetTrend() float32` - -GetTrend returns the Trend field if non-nil, zero value otherwise. - -### GetTrendOk - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetTrendOk() (float32, bool)` - -GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTrend - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) HasTrend() bool` - -HasTrend returns a boolean if a field has been set. - -### SetTrend - -`func (o *ApplicationCampaignAnalyticsTotalDiscounts) SetTrend(v float32)` - -SetTrend gets a reference to the given float32 and assigns it to the Trend field. - - -[[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/ApplicationCampaignAnalyticsTotalRevenue.md b/docs/ApplicationCampaignAnalyticsTotalRevenue.md deleted file mode 100644 index d239cb7b..00000000 --- a/docs/ApplicationCampaignAnalyticsTotalRevenue.md +++ /dev/null @@ -1,91 +0,0 @@ -# ApplicationCampaignAnalyticsTotalRevenue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **float32** | | [optional] -**InfluenceRate** | Pointer to **float32** | | [optional] -**Trend** | Pointer to **float32** | | [optional] - -## Methods - -### GetValue - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetValue() float32` - -GetValue returns the Value field if non-nil, zero value otherwise. - -### GetValueOk - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetValueOk() (float32, bool)` - -GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasValue - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) HasValue() bool` - -HasValue returns a boolean if a field has been set. - -### SetValue - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) SetValue(v float32)` - -SetValue gets a reference to the given float32 and assigns it to the Value field. - -### GetInfluenceRate - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetInfluenceRate() float32` - -GetInfluenceRate returns the InfluenceRate field if non-nil, zero value otherwise. - -### GetInfluenceRateOk - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetInfluenceRateOk() (float32, bool)` - -GetInfluenceRateOk returns a tuple with the InfluenceRate field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasInfluenceRate - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) HasInfluenceRate() bool` - -HasInfluenceRate returns a boolean if a field has been set. - -### SetInfluenceRate - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) SetInfluenceRate(v float32)` - -SetInfluenceRate gets a reference to the given float32 and assigns it to the InfluenceRate field. - -### GetTrend - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetTrend() float32` - -GetTrend returns the Trend field if non-nil, zero value otherwise. - -### GetTrendOk - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) GetTrendOk() (float32, bool)` - -GetTrendOk returns a tuple with the Trend field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTrend - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) HasTrend() bool` - -HasTrend returns a boolean if a field has been set. - -### SetTrend - -`func (o *ApplicationCampaignAnalyticsTotalRevenue) SetTrend(v float32)` - -SetTrend gets a reference to the given float32 and assigns it to the Trend field. - - -[[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/ApplicationCampaignStats.md b/docs/ApplicationCampaignStats.md index 920a05e8..0c96609c 100644 --- a/docs/ApplicationCampaignStats.md +++ b/docs/ApplicationCampaignStats.md @@ -4,7 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Draft** | Pointer to **int32** | Number of draft campaigns. | **Disabled** | Pointer to **int32** | Number of disabled campaigns. | **Scheduled** | Pointer to **int32** | Number of scheduled campaigns. | **Running** | Pointer to **int32** | Number of running campaigns. | @@ -13,31 +12,6 @@ Name | Type | Description | Notes ## Methods -### GetDraft - -`func (o *ApplicationCampaignStats) GetDraft() int32` - -GetDraft returns the Draft field if non-nil, zero value otherwise. - -### GetDraftOk - -`func (o *ApplicationCampaignStats) GetDraftOk() (int32, bool)` - -GetDraftOk returns a tuple with the Draft field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDraft - -`func (o *ApplicationCampaignStats) HasDraft() bool` - -HasDraft returns a boolean if a field has been set. - -### SetDraft - -`func (o *ApplicationCampaignStats) SetDraft(v int32)` - -SetDraft gets a reference to the given int32 and assigns it to the Draft field. - ### GetDisabled `func (o *ApplicationCampaignStats) GetDisabled() int32` diff --git a/docs/ApplicationCif.md b/docs/ApplicationCif.md new file mode 100644 index 00000000..ac80e711 --- /dev/null +++ b/docs/ApplicationCif.md @@ -0,0 +1,247 @@ +# ApplicationCif + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**Name** | Pointer to **string** | The name of the Application cart item filter used in API requests. | +**Description** | Pointer to **string** | A short description of the Application cart item filter. | [optional] +**ActiveExpressionId** | Pointer to **int32** | The ID of the expression that the Application cart item filter uses. | [optional] +**ModifiedBy** | Pointer to **int32** | The ID of the user who last updated the Application cart item filter. | [optional] +**CreatedBy** | Pointer to **int32** | The ID of the user who created the Application cart item filter. | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the Application cart item filter. | [optional] +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | + +## Methods + +### GetId + +`func (o *ApplicationCif) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApplicationCif) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ApplicationCif) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ApplicationCif) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *ApplicationCif) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ApplicationCif) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *ApplicationCif) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *ApplicationCif) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetName + +`func (o *ApplicationCif) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ApplicationCif) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ApplicationCif) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ApplicationCif) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *ApplicationCif) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ApplicationCif) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *ApplicationCif) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *ApplicationCif) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetActiveExpressionId + +`func (o *ApplicationCif) GetActiveExpressionId() int32` + +GetActiveExpressionId returns the ActiveExpressionId field if non-nil, zero value otherwise. + +### GetActiveExpressionIdOk + +`func (o *ApplicationCif) GetActiveExpressionIdOk() (int32, bool)` + +GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveExpressionId + +`func (o *ApplicationCif) HasActiveExpressionId() bool` + +HasActiveExpressionId returns a boolean if a field has been set. + +### SetActiveExpressionId + +`func (o *ApplicationCif) SetActiveExpressionId(v int32)` + +SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. + +### GetModifiedBy + +`func (o *ApplicationCif) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *ApplicationCif) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *ApplicationCif) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *ApplicationCif) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *ApplicationCif) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *ApplicationCif) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *ApplicationCif) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *ApplicationCif) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetModified + +`func (o *ApplicationCif) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *ApplicationCif) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *ApplicationCif) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *ApplicationCif) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + +### GetApplicationId + +`func (o *ApplicationCif) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *ApplicationCif) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *ApplicationCif) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *ApplicationCif) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + + +[[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/ApplicationCifExpression.md b/docs/ApplicationCifExpression.md new file mode 100644 index 00000000..84f25177 --- /dev/null +++ b/docs/ApplicationCifExpression.md @@ -0,0 +1,169 @@ +# ApplicationCifExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**CartItemFilterId** | Pointer to **int32** | The ID of the Application cart item filter. | [optional] +**CreatedBy** | Pointer to **int32** | The ID of the user who created the Application cart item filter. | [optional] +**Expression** | Pointer to [**[]interface{}**](map[string]interface{}.md) | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | + +## Methods + +### GetId + +`func (o *ApplicationCifExpression) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ApplicationCifExpression) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ApplicationCifExpression) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ApplicationCifExpression) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *ApplicationCifExpression) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *ApplicationCifExpression) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *ApplicationCifExpression) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *ApplicationCifExpression) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCartItemFilterId + +`func (o *ApplicationCifExpression) GetCartItemFilterId() int32` + +GetCartItemFilterId returns the CartItemFilterId field if non-nil, zero value otherwise. + +### GetCartItemFilterIdOk + +`func (o *ApplicationCifExpression) GetCartItemFilterIdOk() (int32, bool)` + +GetCartItemFilterIdOk returns a tuple with the CartItemFilterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemFilterId + +`func (o *ApplicationCifExpression) HasCartItemFilterId() bool` + +HasCartItemFilterId returns a boolean if a field has been set. + +### SetCartItemFilterId + +`func (o *ApplicationCifExpression) SetCartItemFilterId(v int32)` + +SetCartItemFilterId gets a reference to the given int32 and assigns it to the CartItemFilterId field. + +### GetCreatedBy + +`func (o *ApplicationCifExpression) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *ApplicationCifExpression) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *ApplicationCifExpression) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *ApplicationCifExpression) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetExpression + +`func (o *ApplicationCifExpression) GetExpression() []interface{}` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *ApplicationCifExpression) GetExpressionOk() ([]interface{}, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpression + +`func (o *ApplicationCifExpression) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + +### SetExpression + +`func (o *ApplicationCifExpression) SetExpression(v []interface{})` + +SetExpression gets a reference to the given []map[string]interface{} and assigns it to the Expression field. + +### GetApplicationId + +`func (o *ApplicationCifExpression) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *ApplicationCifExpression) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *ApplicationCifExpression) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *ApplicationCifExpression) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + + +[[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/AsyncCouponDeletionJobResponse.md b/docs/AsyncCouponDeletionJobResponse.md new file mode 100644 index 00000000..2b6dc4c9 --- /dev/null +++ b/docs/AsyncCouponDeletionJobResponse.md @@ -0,0 +1,39 @@ +# AsyncCouponDeletionJobResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | 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. | + +## Methods + +### GetId + +`func (o *AsyncCouponDeletionJobResponse) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *AsyncCouponDeletionJobResponse) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *AsyncCouponDeletionJobResponse) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *AsyncCouponDeletionJobResponse) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + + +[[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/BaseCampaignForNotification.md b/docs/BaseCampaignForNotification.md deleted file mode 100644 index fa9e9ef7..00000000 --- a/docs/BaseCampaignForNotification.md +++ /dev/null @@ -1,429 +0,0 @@ -# BaseCampaignForNotification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **string** | A user-facing name for this campaign. | -**Description** | Pointer to **string** | A detailed description of the campaign. | [optional] -**StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] -**EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] -**State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to STATE_ENABLED] -**ActiveRulesetId** | Pointer to **int32** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] -**Tags** | Pointer to **[]string** | A list of tags for the campaign. | -**Features** | Pointer to **[]string** | The features enabled in this campaign. | -**CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | -**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] -**EvaluationGroupId** | Pointer to **int32** | The ID of the campaign evaluation group the campaign belongs to. | [optional] -**Type** | Pointer to **string** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to TYPE_ADVANCED] -**LinkedStoreIds** | Pointer to **[]int32** | A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] - -## Methods - -### GetName - -`func (o *BaseCampaignForNotification) GetName() string` - -GetName returns the Name field if non-nil, zero value otherwise. - -### GetNameOk - -`func (o *BaseCampaignForNotification) GetNameOk() (string, bool)` - -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasName - -`func (o *BaseCampaignForNotification) HasName() bool` - -HasName returns a boolean if a field has been set. - -### SetName - -`func (o *BaseCampaignForNotification) SetName(v string)` - -SetName gets a reference to the given string and assigns it to the Name field. - -### GetDescription - -`func (o *BaseCampaignForNotification) GetDescription() string` - -GetDescription returns the Description field if non-nil, zero value otherwise. - -### GetDescriptionOk - -`func (o *BaseCampaignForNotification) GetDescriptionOk() (string, bool)` - -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDescription - -`func (o *BaseCampaignForNotification) HasDescription() bool` - -HasDescription returns a boolean if a field has been set. - -### SetDescription - -`func (o *BaseCampaignForNotification) SetDescription(v string)` - -SetDescription gets a reference to the given string and assigns it to the Description field. - -### GetStartTime - -`func (o *BaseCampaignForNotification) GetStartTime() time.Time` - -GetStartTime returns the StartTime field if non-nil, zero value otherwise. - -### GetStartTimeOk - -`func (o *BaseCampaignForNotification) GetStartTimeOk() (time.Time, bool)` - -GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasStartTime - -`func (o *BaseCampaignForNotification) HasStartTime() bool` - -HasStartTime returns a boolean if a field has been set. - -### SetStartTime - -`func (o *BaseCampaignForNotification) SetStartTime(v time.Time)` - -SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. - -### GetEndTime - -`func (o *BaseCampaignForNotification) GetEndTime() time.Time` - -GetEndTime returns the EndTime field if non-nil, zero value otherwise. - -### GetEndTimeOk - -`func (o *BaseCampaignForNotification) GetEndTimeOk() (time.Time, bool)` - -GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEndTime - -`func (o *BaseCampaignForNotification) HasEndTime() bool` - -HasEndTime returns a boolean if a field has been set. - -### SetEndTime - -`func (o *BaseCampaignForNotification) SetEndTime(v time.Time)` - -SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. - -### GetAttributes - -`func (o *BaseCampaignForNotification) GetAttributes() map[string]interface{}` - -GetAttributes returns the Attributes field if non-nil, zero value otherwise. - -### GetAttributesOk - -`func (o *BaseCampaignForNotification) GetAttributesOk() (map[string]interface{}, bool)` - -GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAttributes - -`func (o *BaseCampaignForNotification) HasAttributes() bool` - -HasAttributes returns a boolean if a field has been set. - -### SetAttributes - -`func (o *BaseCampaignForNotification) SetAttributes(v map[string]interface{})` - -SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. - -### GetState - -`func (o *BaseCampaignForNotification) GetState() string` - -GetState returns the State field if non-nil, zero value otherwise. - -### GetStateOk - -`func (o *BaseCampaignForNotification) GetStateOk() (string, bool)` - -GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasState - -`func (o *BaseCampaignForNotification) HasState() bool` - -HasState returns a boolean if a field has been set. - -### SetState - -`func (o *BaseCampaignForNotification) SetState(v string)` - -SetState gets a reference to the given string and assigns it to the State field. - -### GetActiveRulesetId - -`func (o *BaseCampaignForNotification) GetActiveRulesetId() int32` - -GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise. - -### GetActiveRulesetIdOk - -`func (o *BaseCampaignForNotification) GetActiveRulesetIdOk() (int32, bool)` - -GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasActiveRulesetId - -`func (o *BaseCampaignForNotification) HasActiveRulesetId() bool` - -HasActiveRulesetId returns a boolean if a field has been set. - -### SetActiveRulesetId - -`func (o *BaseCampaignForNotification) SetActiveRulesetId(v int32)` - -SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. - -### GetTags - -`func (o *BaseCampaignForNotification) GetTags() []string` - -GetTags returns the Tags field if non-nil, zero value otherwise. - -### GetTagsOk - -`func (o *BaseCampaignForNotification) GetTagsOk() ([]string, bool)` - -GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTags - -`func (o *BaseCampaignForNotification) HasTags() bool` - -HasTags returns a boolean if a field has been set. - -### SetTags - -`func (o *BaseCampaignForNotification) SetTags(v []string)` - -SetTags gets a reference to the given []string and assigns it to the Tags field. - -### GetFeatures - -`func (o *BaseCampaignForNotification) GetFeatures() []string` - -GetFeatures returns the Features field if non-nil, zero value otherwise. - -### GetFeaturesOk - -`func (o *BaseCampaignForNotification) GetFeaturesOk() ([]string, bool)` - -GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasFeatures - -`func (o *BaseCampaignForNotification) HasFeatures() bool` - -HasFeatures returns a boolean if a field has been set. - -### SetFeatures - -`func (o *BaseCampaignForNotification) SetFeatures(v []string)` - -SetFeatures gets a reference to the given []string and assigns it to the Features field. - -### GetCouponSettings - -`func (o *BaseCampaignForNotification) GetCouponSettings() CodeGeneratorSettings` - -GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise. - -### GetCouponSettingsOk - -`func (o *BaseCampaignForNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool)` - -GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponSettings - -`func (o *BaseCampaignForNotification) HasCouponSettings() bool` - -HasCouponSettings returns a boolean if a field has been set. - -### SetCouponSettings - -`func (o *BaseCampaignForNotification) SetCouponSettings(v CodeGeneratorSettings)` - -SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. - -### GetReferralSettings - -`func (o *BaseCampaignForNotification) GetReferralSettings() CodeGeneratorSettings` - -GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise. - -### GetReferralSettingsOk - -`func (o *BaseCampaignForNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool)` - -GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralSettings - -`func (o *BaseCampaignForNotification) HasReferralSettings() bool` - -HasReferralSettings returns a boolean if a field has been set. - -### SetReferralSettings - -`func (o *BaseCampaignForNotification) SetReferralSettings(v CodeGeneratorSettings)` - -SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. - -### GetLimits - -`func (o *BaseCampaignForNotification) GetLimits() []LimitConfig` - -GetLimits returns the Limits field if non-nil, zero value otherwise. - -### GetLimitsOk - -`func (o *BaseCampaignForNotification) GetLimitsOk() ([]LimitConfig, bool)` - -GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLimits - -`func (o *BaseCampaignForNotification) HasLimits() bool` - -HasLimits returns a boolean if a field has been set. - -### SetLimits - -`func (o *BaseCampaignForNotification) SetLimits(v []LimitConfig)` - -SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. - -### GetCampaignGroups - -`func (o *BaseCampaignForNotification) GetCampaignGroups() []int32` - -GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. - -### GetCampaignGroupsOk - -`func (o *BaseCampaignForNotification) GetCampaignGroupsOk() ([]int32, bool)` - -GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignGroups - -`func (o *BaseCampaignForNotification) HasCampaignGroups() bool` - -HasCampaignGroups returns a boolean if a field has been set. - -### SetCampaignGroups - -`func (o *BaseCampaignForNotification) SetCampaignGroups(v []int32)` - -SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. - -### GetEvaluationGroupId - -`func (o *BaseCampaignForNotification) GetEvaluationGroupId() int32` - -GetEvaluationGroupId returns the EvaluationGroupId field if non-nil, zero value otherwise. - -### GetEvaluationGroupIdOk - -`func (o *BaseCampaignForNotification) GetEvaluationGroupIdOk() (int32, bool)` - -GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEvaluationGroupId - -`func (o *BaseCampaignForNotification) HasEvaluationGroupId() bool` - -HasEvaluationGroupId returns a boolean if a field has been set. - -### SetEvaluationGroupId - -`func (o *BaseCampaignForNotification) SetEvaluationGroupId(v int32)` - -SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. - -### GetType - -`func (o *BaseCampaignForNotification) GetType() string` - -GetType returns the Type field if non-nil, zero value otherwise. - -### GetTypeOk - -`func (o *BaseCampaignForNotification) GetTypeOk() (string, bool)` - -GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasType - -`func (o *BaseCampaignForNotification) HasType() bool` - -HasType returns a boolean if a field has been set. - -### SetType - -`func (o *BaseCampaignForNotification) SetType(v string)` - -SetType gets a reference to the given string and assigns it to the Type field. - -### GetLinkedStoreIds - -`func (o *BaseCampaignForNotification) GetLinkedStoreIds() []int32` - -GetLinkedStoreIds returns the LinkedStoreIds field if non-nil, zero value otherwise. - -### GetLinkedStoreIdsOk - -`func (o *BaseCampaignForNotification) GetLinkedStoreIdsOk() ([]int32, bool)` - -GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLinkedStoreIds - -`func (o *BaseCampaignForNotification) HasLinkedStoreIds() bool` - -HasLinkedStoreIds returns a boolean if a field has been set. - -### SetLinkedStoreIds - -`func (o *BaseCampaignForNotification) SetLinkedStoreIds(v []int32)` - -SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. - - -[[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/BaseLoyaltyProgram.md b/docs/BaseLoyaltyProgram.md index c7ed4450..d64ce729 100644 --- a/docs/BaseLoyaltyProgram.md +++ b/docs/BaseLoyaltyProgram.md @@ -12,10 +12,12 @@ Name | Type | Description | Notes **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | [optional] **UsersPerCardLimit** | Pointer to **int32** | 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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to [**time.Time**](time.Time.md) | 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** | Pointer to **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** | Pointer to **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** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] ## Methods @@ -219,6 +221,31 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetProgramJoinPolicy + +`func (o *BaseLoyaltyProgram) GetProgramJoinPolicy() string` + +GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. + +### GetProgramJoinPolicyOk + +`func (o *BaseLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` + +GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramJoinPolicy + +`func (o *BaseLoyaltyProgram) HasProgramJoinPolicy() bool` + +HasProgramJoinPolicy returns a boolean if a field has been set. + +### SetProgramJoinPolicy + +`func (o *BaseLoyaltyProgram) SetProgramJoinPolicy(v string)` + +SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. + ### GetTiersExpirationPolicy `func (o *BaseLoyaltyProgram) GetTiersExpirationPolicy() string` @@ -244,6 +271,31 @@ HasTiersExpirationPolicy returns a boolean if a field has been set. SetTiersExpirationPolicy gets a reference to the given string and assigns it to the TiersExpirationPolicy field. +### GetTierCycleStartDate + +`func (o *BaseLoyaltyProgram) GetTierCycleStartDate() time.Time` + +GetTierCycleStartDate returns the TierCycleStartDate field if non-nil, zero value otherwise. + +### GetTierCycleStartDateOk + +`func (o *BaseLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool)` + +GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTierCycleStartDate + +`func (o *BaseLoyaltyProgram) HasTierCycleStartDate() bool` + +HasTierCycleStartDate returns a boolean if a field has been set. + +### SetTierCycleStartDate + +`func (o *BaseLoyaltyProgram) SetTierCycleStartDate(v time.Time)` + +SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. + ### GetTiersExpireIn `func (o *BaseLoyaltyProgram) GetTiersExpireIn() string` @@ -294,30 +346,30 @@ HasTiersDowngradePolicy returns a boolean if a field has been set. SetTiersDowngradePolicy gets a reference to the given string and assigns it to the TiersDowngradePolicy field. -### GetProgramJoinPolicy +### GetCardCodeSettings -`func (o *BaseLoyaltyProgram) GetProgramJoinPolicy() string` +`func (o *BaseLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings` -GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. +GetCardCodeSettings returns the CardCodeSettings field if non-nil, zero value otherwise. -### GetProgramJoinPolicyOk +### GetCardCodeSettingsOk -`func (o *BaseLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` +`func (o *BaseLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool)` -GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasProgramJoinPolicy +### HasCardCodeSettings -`func (o *BaseLoyaltyProgram) HasProgramJoinPolicy() bool` +`func (o *BaseLoyaltyProgram) HasCardCodeSettings() bool` -HasProgramJoinPolicy returns a boolean if a field has been set. +HasCardCodeSettings returns a boolean if a field has been set. -### SetProgramJoinPolicy +### SetCardCodeSettings -`func (o *BaseLoyaltyProgram) SetProgramJoinPolicy(v string)` +`func (o *BaseLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings)` -SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. [[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/BaseNotification.md b/docs/BaseNotification.md index 2dd2316e..99e2f9b7 100644 --- a/docs/BaseNotification.md +++ b/docs/BaseNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Policy** | Pointer to [**map[string]interface{}**](.md) | | +**Policy** | Pointer to [**map[string]interface{}**](.md) | Indicates which notification properties to apply. | **Enabled** | Pointer to **bool** | Indicates whether the notification is activated. | [optional] [default to true] **Webhook** | Pointer to [**BaseNotificationWebhook**](BaseNotificationWebhook.md) | | **Id** | Pointer to **int32** | Unique ID for this entity. | diff --git a/docs/BaseNotificationEntity.md b/docs/BaseNotificationEntity.md index 899c6f79..c5e02b92 100644 --- a/docs/BaseNotificationEntity.md +++ b/docs/BaseNotificationEntity.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Policy** | Pointer to [**map[string]interface{}**](.md) | | +**Policy** | Pointer to [**map[string]interface{}**](.md) | Indicates which notification properties to apply. | **Enabled** | Pointer to **bool** | Indicates whether the notification is activated. | [optional] [default to true] ## Methods diff --git a/docs/Binding.md b/docs/Binding.md index d804887e..225b681f 100644 --- a/docs/Binding.md +++ b/docs/Binding.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | A descriptive name for the value to be bound. | **Type** | Pointer to **string** | The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` | [optional] -**Expression** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated and its result attached to the name of the binding. | +**Expression** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated and its result attached to the name of the binding. | **ValueType** | Pointer to **string** | Can be one of the following: - `string` - `number` - `boolean` | [optional] ## Methods diff --git a/docs/Campaign.md b/docs/Campaign.md index d6a8c407..dc2143da 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -45,6 +45,13 @@ Name | Type | Description | Notes **UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign if available. | [optional] **TemplateId** | Pointer to **int32** | The ID of the Campaign Template this Campaign was created from. | [optional] **FrontendState** | Pointer to **string** | A campaign state described exactly as in the Campaign Manager. | +**StoresImported** | Pointer to **bool** | Indicates whether the linked stores were imported via a CSV file. | +**ActiveRevisionId** | Pointer to **int32** | ID of the revision that was last activated on this campaign. | [optional] +**ActiveRevisionVersionId** | Pointer to **int32** | ID of the revision version that is active on the campaign. | [optional] +**Version** | Pointer to **int32** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] +**CurrentRevisionId** | Pointer to **int32** | ID of the revision currently being modified for the campaign. | [optional] +**CurrentRevisionVersionId** | Pointer to **int32** | ID of the latest version applied on the current revision. | [optional] +**StageRevision** | Pointer to **bool** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to false] ## Methods @@ -1073,6 +1080,181 @@ HasFrontendState returns a boolean if a field has been set. SetFrontendState gets a reference to the given string and assigns it to the FrontendState field. +### GetStoresImported + +`func (o *Campaign) GetStoresImported() bool` + +GetStoresImported returns the StoresImported field if non-nil, zero value otherwise. + +### GetStoresImportedOk + +`func (o *Campaign) GetStoresImportedOk() (bool, bool)` + +GetStoresImportedOk returns a tuple with the StoresImported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStoresImported + +`func (o *Campaign) HasStoresImported() bool` + +HasStoresImported returns a boolean if a field has been set. + +### SetStoresImported + +`func (o *Campaign) SetStoresImported(v bool)` + +SetStoresImported gets a reference to the given bool and assigns it to the StoresImported field. + +### GetActiveRevisionId + +`func (o *Campaign) GetActiveRevisionId() int32` + +GetActiveRevisionId returns the ActiveRevisionId field if non-nil, zero value otherwise. + +### GetActiveRevisionIdOk + +`func (o *Campaign) GetActiveRevisionIdOk() (int32, bool)` + +GetActiveRevisionIdOk returns a tuple with the ActiveRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRevisionId + +`func (o *Campaign) HasActiveRevisionId() bool` + +HasActiveRevisionId returns a boolean if a field has been set. + +### SetActiveRevisionId + +`func (o *Campaign) SetActiveRevisionId(v int32)` + +SetActiveRevisionId gets a reference to the given int32 and assigns it to the ActiveRevisionId field. + +### GetActiveRevisionVersionId + +`func (o *Campaign) GetActiveRevisionVersionId() int32` + +GetActiveRevisionVersionId returns the ActiveRevisionVersionId field if non-nil, zero value otherwise. + +### GetActiveRevisionVersionIdOk + +`func (o *Campaign) GetActiveRevisionVersionIdOk() (int32, bool)` + +GetActiveRevisionVersionIdOk returns a tuple with the ActiveRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRevisionVersionId + +`func (o *Campaign) HasActiveRevisionVersionId() bool` + +HasActiveRevisionVersionId returns a boolean if a field has been set. + +### SetActiveRevisionVersionId + +`func (o *Campaign) SetActiveRevisionVersionId(v int32)` + +SetActiveRevisionVersionId gets a reference to the given int32 and assigns it to the ActiveRevisionVersionId field. + +### GetVersion + +`func (o *Campaign) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *Campaign) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *Campaign) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *Campaign) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetCurrentRevisionId + +`func (o *Campaign) GetCurrentRevisionId() int32` + +GetCurrentRevisionId returns the CurrentRevisionId field if non-nil, zero value otherwise. + +### GetCurrentRevisionIdOk + +`func (o *Campaign) GetCurrentRevisionIdOk() (int32, bool)` + +GetCurrentRevisionIdOk returns a tuple with the CurrentRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentRevisionId + +`func (o *Campaign) HasCurrentRevisionId() bool` + +HasCurrentRevisionId returns a boolean if a field has been set. + +### SetCurrentRevisionId + +`func (o *Campaign) SetCurrentRevisionId(v int32)` + +SetCurrentRevisionId gets a reference to the given int32 and assigns it to the CurrentRevisionId field. + +### GetCurrentRevisionVersionId + +`func (o *Campaign) GetCurrentRevisionVersionId() int32` + +GetCurrentRevisionVersionId returns the CurrentRevisionVersionId field if non-nil, zero value otherwise. + +### GetCurrentRevisionVersionIdOk + +`func (o *Campaign) GetCurrentRevisionVersionIdOk() (int32, bool)` + +GetCurrentRevisionVersionIdOk returns a tuple with the CurrentRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentRevisionVersionId + +`func (o *Campaign) HasCurrentRevisionVersionId() bool` + +HasCurrentRevisionVersionId returns a boolean if a field has been set. + +### SetCurrentRevisionVersionId + +`func (o *Campaign) SetCurrentRevisionVersionId(v int32)` + +SetCurrentRevisionVersionId gets a reference to the given int32 and assigns it to the CurrentRevisionVersionId field. + +### GetStageRevision + +`func (o *Campaign) GetStageRevision() bool` + +GetStageRevision returns the StageRevision field if non-nil, zero value otherwise. + +### GetStageRevisionOk + +`func (o *Campaign) GetStageRevisionOk() (bool, bool)` + +GetStageRevisionOk returns a tuple with the StageRevision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStageRevision + +`func (o *Campaign) HasStageRevision() bool` + +HasStageRevision returns a boolean if a field has been set. + +### SetStageRevision + +`func (o *Campaign) SetStageRevision(v bool)` + +SetStageRevision gets a reference to the given bool and assigns it to the StageRevision field. + [[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/CampaignCollectionEditedNotification.md b/docs/CampaignCollectionEditedNotification.md new file mode 100644 index 00000000..3ae6582c --- /dev/null +++ b/docs/CampaignCollectionEditedNotification.md @@ -0,0 +1,91 @@ +# CampaignCollectionEditedNotification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | Pointer to [**Campaign**](Campaign.md) | | +**Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] +**Collection** | Pointer to [**CollectionWithoutPayload**](CollectionWithoutPayload.md) | | + +## Methods + +### GetCampaign + +`func (o *CampaignCollectionEditedNotification) GetCampaign() Campaign` + +GetCampaign returns the Campaign field if non-nil, zero value otherwise. + +### GetCampaignOk + +`func (o *CampaignCollectionEditedNotification) GetCampaignOk() (Campaign, bool)` + +GetCampaignOk returns a tuple with the Campaign field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaign + +`func (o *CampaignCollectionEditedNotification) HasCampaign() bool` + +HasCampaign returns a boolean if a field has been set. + +### SetCampaign + +`func (o *CampaignCollectionEditedNotification) SetCampaign(v Campaign)` + +SetCampaign gets a reference to the given Campaign and assigns it to the Campaign field. + +### GetRuleset + +`func (o *CampaignCollectionEditedNotification) GetRuleset() Ruleset` + +GetRuleset returns the Ruleset field if non-nil, zero value otherwise. + +### GetRulesetOk + +`func (o *CampaignCollectionEditedNotification) GetRulesetOk() (Ruleset, bool)` + +GetRulesetOk returns a tuple with the Ruleset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRuleset + +`func (o *CampaignCollectionEditedNotification) HasRuleset() bool` + +HasRuleset returns a boolean if a field has been set. + +### SetRuleset + +`func (o *CampaignCollectionEditedNotification) SetRuleset(v Ruleset)` + +SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. + +### GetCollection + +`func (o *CampaignCollectionEditedNotification) GetCollection() CollectionWithoutPayload` + +GetCollection returns the Collection field if non-nil, zero value otherwise. + +### GetCollectionOk + +`func (o *CampaignCollectionEditedNotification) GetCollectionOk() (CollectionWithoutPayload, bool)` + +GetCollectionOk returns a tuple with the Collection field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCollection + +`func (o *CampaignCollectionEditedNotification) HasCollection() bool` + +HasCollection returns a boolean if a field has been set. + +### SetCollection + +`func (o *CampaignCollectionEditedNotification) SetCollection(v CollectionWithoutPayload)` + +SetCollection gets a reference to the given CollectionWithoutPayload and assigns it to the Collection field. + + +[[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/CampaignForNotification.md b/docs/CampaignForNotification.md deleted file mode 100644 index dd876a04..00000000 --- a/docs/CampaignForNotification.md +++ /dev/null @@ -1,1079 +0,0 @@ -# CampaignForNotification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | -**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | -**Name** | Pointer to **string** | A user-facing name for this campaign. | -**Description** | Pointer to **string** | A detailed description of the campaign. | -**StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] -**EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] -**State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to STATE_ENABLED] -**ActiveRulesetId** | Pointer to **int32** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] -**Tags** | Pointer to **[]string** | A list of tags for the campaign. | -**Features** | Pointer to **[]string** | The features enabled in this campaign. | -**CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | -**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] -**EvaluationGroupId** | Pointer to **int32** | The ID of the campaign evaluation group the campaign belongs to. | [optional] -**Type** | Pointer to **string** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to TYPE_ADVANCED] -**LinkedStoreIds** | Pointer to **[]int32** | A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] -**Budgets** | Pointer to [**[]CampaignBudget**](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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] -**ReferralRedemptionCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] -**DiscountCount** | Pointer to **float32** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] -**DiscountEffectCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] -**CouponCreationCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] -**CustomEffectCount** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] -**AddFreeItemEffectCount** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] -**CreatedLoyaltyPointsCount** | Pointer to **float32** | 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** | Pointer to **int32** | 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** | Pointer to **float32** | 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** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] -**ReservecouponEffectCount** | Pointer to **int32** | 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** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received by this campaign. | [optional] -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] -**CreatedBy** | Pointer to **string** | Name of the user who created this campaign if available. | [optional] -**UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign if available. | [optional] -**TemplateId** | Pointer to **int32** | The ID of the Campaign Template this Campaign was created from. | [optional] - -## Methods - -### GetId - -`func (o *CampaignForNotification) GetId() int32` - -GetId returns the Id field if non-nil, zero value otherwise. - -### GetIdOk - -`func (o *CampaignForNotification) GetIdOk() (int32, bool)` - -GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasId - -`func (o *CampaignForNotification) HasId() bool` - -HasId returns a boolean if a field has been set. - -### SetId - -`func (o *CampaignForNotification) SetId(v int32)` - -SetId gets a reference to the given int32 and assigns it to the Id field. - -### GetCreated - -`func (o *CampaignForNotification) GetCreated() time.Time` - -GetCreated returns the Created field if non-nil, zero value otherwise. - -### GetCreatedOk - -`func (o *CampaignForNotification) GetCreatedOk() (time.Time, bool)` - -GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreated - -`func (o *CampaignForNotification) HasCreated() bool` - -HasCreated returns a boolean if a field has been set. - -### SetCreated - -`func (o *CampaignForNotification) SetCreated(v time.Time)` - -SetCreated gets a reference to the given time.Time and assigns it to the Created field. - -### GetApplicationId - -`func (o *CampaignForNotification) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *CampaignForNotification) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *CampaignForNotification) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *CampaignForNotification) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetUserId - -`func (o *CampaignForNotification) GetUserId() int32` - -GetUserId returns the UserId field if non-nil, zero value otherwise. - -### GetUserIdOk - -`func (o *CampaignForNotification) GetUserIdOk() (int32, bool)` - -GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUserId - -`func (o *CampaignForNotification) HasUserId() bool` - -HasUserId returns a boolean if a field has been set. - -### SetUserId - -`func (o *CampaignForNotification) SetUserId(v int32)` - -SetUserId gets a reference to the given int32 and assigns it to the UserId field. - -### GetName - -`func (o *CampaignForNotification) GetName() string` - -GetName returns the Name field if non-nil, zero value otherwise. - -### GetNameOk - -`func (o *CampaignForNotification) GetNameOk() (string, bool)` - -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasName - -`func (o *CampaignForNotification) HasName() bool` - -HasName returns a boolean if a field has been set. - -### SetName - -`func (o *CampaignForNotification) SetName(v string)` - -SetName gets a reference to the given string and assigns it to the Name field. - -### GetDescription - -`func (o *CampaignForNotification) GetDescription() string` - -GetDescription returns the Description field if non-nil, zero value otherwise. - -### GetDescriptionOk - -`func (o *CampaignForNotification) GetDescriptionOk() (string, bool)` - -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDescription - -`func (o *CampaignForNotification) HasDescription() bool` - -HasDescription returns a boolean if a field has been set. - -### SetDescription - -`func (o *CampaignForNotification) SetDescription(v string)` - -SetDescription gets a reference to the given string and assigns it to the Description field. - -### GetStartTime - -`func (o *CampaignForNotification) GetStartTime() time.Time` - -GetStartTime returns the StartTime field if non-nil, zero value otherwise. - -### GetStartTimeOk - -`func (o *CampaignForNotification) GetStartTimeOk() (time.Time, bool)` - -GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasStartTime - -`func (o *CampaignForNotification) HasStartTime() bool` - -HasStartTime returns a boolean if a field has been set. - -### SetStartTime - -`func (o *CampaignForNotification) SetStartTime(v time.Time)` - -SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. - -### GetEndTime - -`func (o *CampaignForNotification) GetEndTime() time.Time` - -GetEndTime returns the EndTime field if non-nil, zero value otherwise. - -### GetEndTimeOk - -`func (o *CampaignForNotification) GetEndTimeOk() (time.Time, bool)` - -GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEndTime - -`func (o *CampaignForNotification) HasEndTime() bool` - -HasEndTime returns a boolean if a field has been set. - -### SetEndTime - -`func (o *CampaignForNotification) SetEndTime(v time.Time)` - -SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. - -### GetAttributes - -`func (o *CampaignForNotification) GetAttributes() map[string]interface{}` - -GetAttributes returns the Attributes field if non-nil, zero value otherwise. - -### GetAttributesOk - -`func (o *CampaignForNotification) GetAttributesOk() (map[string]interface{}, bool)` - -GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAttributes - -`func (o *CampaignForNotification) HasAttributes() bool` - -HasAttributes returns a boolean if a field has been set. - -### SetAttributes - -`func (o *CampaignForNotification) SetAttributes(v map[string]interface{})` - -SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. - -### GetState - -`func (o *CampaignForNotification) GetState() string` - -GetState returns the State field if non-nil, zero value otherwise. - -### GetStateOk - -`func (o *CampaignForNotification) GetStateOk() (string, bool)` - -GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasState - -`func (o *CampaignForNotification) HasState() bool` - -HasState returns a boolean if a field has been set. - -### SetState - -`func (o *CampaignForNotification) SetState(v string)` - -SetState gets a reference to the given string and assigns it to the State field. - -### GetActiveRulesetId - -`func (o *CampaignForNotification) GetActiveRulesetId() int32` - -GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise. - -### GetActiveRulesetIdOk - -`func (o *CampaignForNotification) GetActiveRulesetIdOk() (int32, bool)` - -GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasActiveRulesetId - -`func (o *CampaignForNotification) HasActiveRulesetId() bool` - -HasActiveRulesetId returns a boolean if a field has been set. - -### SetActiveRulesetId - -`func (o *CampaignForNotification) SetActiveRulesetId(v int32)` - -SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. - -### GetTags - -`func (o *CampaignForNotification) GetTags() []string` - -GetTags returns the Tags field if non-nil, zero value otherwise. - -### GetTagsOk - -`func (o *CampaignForNotification) GetTagsOk() ([]string, bool)` - -GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTags - -`func (o *CampaignForNotification) HasTags() bool` - -HasTags returns a boolean if a field has been set. - -### SetTags - -`func (o *CampaignForNotification) SetTags(v []string)` - -SetTags gets a reference to the given []string and assigns it to the Tags field. - -### GetFeatures - -`func (o *CampaignForNotification) GetFeatures() []string` - -GetFeatures returns the Features field if non-nil, zero value otherwise. - -### GetFeaturesOk - -`func (o *CampaignForNotification) GetFeaturesOk() ([]string, bool)` - -GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasFeatures - -`func (o *CampaignForNotification) HasFeatures() bool` - -HasFeatures returns a boolean if a field has been set. - -### SetFeatures - -`func (o *CampaignForNotification) SetFeatures(v []string)` - -SetFeatures gets a reference to the given []string and assigns it to the Features field. - -### GetCouponSettings - -`func (o *CampaignForNotification) GetCouponSettings() CodeGeneratorSettings` - -GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise. - -### GetCouponSettingsOk - -`func (o *CampaignForNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool)` - -GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponSettings - -`func (o *CampaignForNotification) HasCouponSettings() bool` - -HasCouponSettings returns a boolean if a field has been set. - -### SetCouponSettings - -`func (o *CampaignForNotification) SetCouponSettings(v CodeGeneratorSettings)` - -SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. - -### GetReferralSettings - -`func (o *CampaignForNotification) GetReferralSettings() CodeGeneratorSettings` - -GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise. - -### GetReferralSettingsOk - -`func (o *CampaignForNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool)` - -GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralSettings - -`func (o *CampaignForNotification) HasReferralSettings() bool` - -HasReferralSettings returns a boolean if a field has been set. - -### SetReferralSettings - -`func (o *CampaignForNotification) SetReferralSettings(v CodeGeneratorSettings)` - -SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. - -### GetLimits - -`func (o *CampaignForNotification) GetLimits() []LimitConfig` - -GetLimits returns the Limits field if non-nil, zero value otherwise. - -### GetLimitsOk - -`func (o *CampaignForNotification) GetLimitsOk() ([]LimitConfig, bool)` - -GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLimits - -`func (o *CampaignForNotification) HasLimits() bool` - -HasLimits returns a boolean if a field has been set. - -### SetLimits - -`func (o *CampaignForNotification) SetLimits(v []LimitConfig)` - -SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. - -### GetCampaignGroups - -`func (o *CampaignForNotification) GetCampaignGroups() []int32` - -GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. - -### GetCampaignGroupsOk - -`func (o *CampaignForNotification) GetCampaignGroupsOk() ([]int32, bool)` - -GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignGroups - -`func (o *CampaignForNotification) HasCampaignGroups() bool` - -HasCampaignGroups returns a boolean if a field has been set. - -### SetCampaignGroups - -`func (o *CampaignForNotification) SetCampaignGroups(v []int32)` - -SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. - -### GetEvaluationGroupId - -`func (o *CampaignForNotification) GetEvaluationGroupId() int32` - -GetEvaluationGroupId returns the EvaluationGroupId field if non-nil, zero value otherwise. - -### GetEvaluationGroupIdOk - -`func (o *CampaignForNotification) GetEvaluationGroupIdOk() (int32, bool)` - -GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEvaluationGroupId - -`func (o *CampaignForNotification) HasEvaluationGroupId() bool` - -HasEvaluationGroupId returns a boolean if a field has been set. - -### SetEvaluationGroupId - -`func (o *CampaignForNotification) SetEvaluationGroupId(v int32)` - -SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. - -### GetType - -`func (o *CampaignForNotification) GetType() string` - -GetType returns the Type field if non-nil, zero value otherwise. - -### GetTypeOk - -`func (o *CampaignForNotification) GetTypeOk() (string, bool)` - -GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasType - -`func (o *CampaignForNotification) HasType() bool` - -HasType returns a boolean if a field has been set. - -### SetType - -`func (o *CampaignForNotification) SetType(v string)` - -SetType gets a reference to the given string and assigns it to the Type field. - -### GetLinkedStoreIds - -`func (o *CampaignForNotification) GetLinkedStoreIds() []int32` - -GetLinkedStoreIds returns the LinkedStoreIds field if non-nil, zero value otherwise. - -### GetLinkedStoreIdsOk - -`func (o *CampaignForNotification) GetLinkedStoreIdsOk() ([]int32, bool)` - -GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLinkedStoreIds - -`func (o *CampaignForNotification) HasLinkedStoreIds() bool` - -HasLinkedStoreIds returns a boolean if a field has been set. - -### SetLinkedStoreIds - -`func (o *CampaignForNotification) SetLinkedStoreIds(v []int32)` - -SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. - -### GetBudgets - -`func (o *CampaignForNotification) GetBudgets() []CampaignBudget` - -GetBudgets returns the Budgets field if non-nil, zero value otherwise. - -### GetBudgetsOk - -`func (o *CampaignForNotification) GetBudgetsOk() ([]CampaignBudget, bool)` - -GetBudgetsOk returns a tuple with the Budgets field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasBudgets - -`func (o *CampaignForNotification) HasBudgets() bool` - -HasBudgets returns a boolean if a field has been set. - -### SetBudgets - -`func (o *CampaignForNotification) SetBudgets(v []CampaignBudget)` - -SetBudgets gets a reference to the given []CampaignBudget and assigns it to the Budgets field. - -### GetCouponRedemptionCount - -`func (o *CampaignForNotification) GetCouponRedemptionCount() int32` - -GetCouponRedemptionCount returns the CouponRedemptionCount field if non-nil, zero value otherwise. - -### GetCouponRedemptionCountOk - -`func (o *CampaignForNotification) GetCouponRedemptionCountOk() (int32, bool)` - -GetCouponRedemptionCountOk returns a tuple with the CouponRedemptionCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponRedemptionCount - -`func (o *CampaignForNotification) HasCouponRedemptionCount() bool` - -HasCouponRedemptionCount returns a boolean if a field has been set. - -### SetCouponRedemptionCount - -`func (o *CampaignForNotification) SetCouponRedemptionCount(v int32)` - -SetCouponRedemptionCount gets a reference to the given int32 and assigns it to the CouponRedemptionCount field. - -### GetReferralRedemptionCount - -`func (o *CampaignForNotification) GetReferralRedemptionCount() int32` - -GetReferralRedemptionCount returns the ReferralRedemptionCount field if non-nil, zero value otherwise. - -### GetReferralRedemptionCountOk - -`func (o *CampaignForNotification) GetReferralRedemptionCountOk() (int32, bool)` - -GetReferralRedemptionCountOk returns a tuple with the ReferralRedemptionCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralRedemptionCount - -`func (o *CampaignForNotification) HasReferralRedemptionCount() bool` - -HasReferralRedemptionCount returns a boolean if a field has been set. - -### SetReferralRedemptionCount - -`func (o *CampaignForNotification) SetReferralRedemptionCount(v int32)` - -SetReferralRedemptionCount gets a reference to the given int32 and assigns it to the ReferralRedemptionCount field. - -### GetDiscountCount - -`func (o *CampaignForNotification) GetDiscountCount() float32` - -GetDiscountCount returns the DiscountCount field if non-nil, zero value otherwise. - -### GetDiscountCountOk - -`func (o *CampaignForNotification) GetDiscountCountOk() (float32, bool)` - -GetDiscountCountOk returns a tuple with the DiscountCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDiscountCount - -`func (o *CampaignForNotification) HasDiscountCount() bool` - -HasDiscountCount returns a boolean if a field has been set. - -### SetDiscountCount - -`func (o *CampaignForNotification) SetDiscountCount(v float32)` - -SetDiscountCount gets a reference to the given float32 and assigns it to the DiscountCount field. - -### GetDiscountEffectCount - -`func (o *CampaignForNotification) GetDiscountEffectCount() int32` - -GetDiscountEffectCount returns the DiscountEffectCount field if non-nil, zero value otherwise. - -### GetDiscountEffectCountOk - -`func (o *CampaignForNotification) GetDiscountEffectCountOk() (int32, bool)` - -GetDiscountEffectCountOk returns a tuple with the DiscountEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDiscountEffectCount - -`func (o *CampaignForNotification) HasDiscountEffectCount() bool` - -HasDiscountEffectCount returns a boolean if a field has been set. - -### SetDiscountEffectCount - -`func (o *CampaignForNotification) SetDiscountEffectCount(v int32)` - -SetDiscountEffectCount gets a reference to the given int32 and assigns it to the DiscountEffectCount field. - -### GetCouponCreationCount - -`func (o *CampaignForNotification) GetCouponCreationCount() int32` - -GetCouponCreationCount returns the CouponCreationCount field if non-nil, zero value otherwise. - -### GetCouponCreationCountOk - -`func (o *CampaignForNotification) GetCouponCreationCountOk() (int32, bool)` - -GetCouponCreationCountOk returns a tuple with the CouponCreationCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponCreationCount - -`func (o *CampaignForNotification) HasCouponCreationCount() bool` - -HasCouponCreationCount returns a boolean if a field has been set. - -### SetCouponCreationCount - -`func (o *CampaignForNotification) SetCouponCreationCount(v int32)` - -SetCouponCreationCount gets a reference to the given int32 and assigns it to the CouponCreationCount field. - -### GetCustomEffectCount - -`func (o *CampaignForNotification) GetCustomEffectCount() int32` - -GetCustomEffectCount returns the CustomEffectCount field if non-nil, zero value otherwise. - -### GetCustomEffectCountOk - -`func (o *CampaignForNotification) GetCustomEffectCountOk() (int32, bool)` - -GetCustomEffectCountOk returns a tuple with the CustomEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCustomEffectCount - -`func (o *CampaignForNotification) HasCustomEffectCount() bool` - -HasCustomEffectCount returns a boolean if a field has been set. - -### SetCustomEffectCount - -`func (o *CampaignForNotification) SetCustomEffectCount(v int32)` - -SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. - -### GetReferralCreationCount - -`func (o *CampaignForNotification) GetReferralCreationCount() int32` - -GetReferralCreationCount returns the ReferralCreationCount field if non-nil, zero value otherwise. - -### GetReferralCreationCountOk - -`func (o *CampaignForNotification) GetReferralCreationCountOk() (int32, bool)` - -GetReferralCreationCountOk returns a tuple with the ReferralCreationCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralCreationCount - -`func (o *CampaignForNotification) HasReferralCreationCount() bool` - -HasReferralCreationCount returns a boolean if a field has been set. - -### SetReferralCreationCount - -`func (o *CampaignForNotification) SetReferralCreationCount(v int32)` - -SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. - -### GetAddFreeItemEffectCount - -`func (o *CampaignForNotification) GetAddFreeItemEffectCount() int32` - -GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field if non-nil, zero value otherwise. - -### GetAddFreeItemEffectCountOk - -`func (o *CampaignForNotification) GetAddFreeItemEffectCountOk() (int32, bool)` - -GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAddFreeItemEffectCount - -`func (o *CampaignForNotification) HasAddFreeItemEffectCount() bool` - -HasAddFreeItemEffectCount returns a boolean if a field has been set. - -### SetAddFreeItemEffectCount - -`func (o *CampaignForNotification) SetAddFreeItemEffectCount(v int32)` - -SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. - -### GetAwardedGiveawaysCount - -`func (o *CampaignForNotification) GetAwardedGiveawaysCount() int32` - -GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field if non-nil, zero value otherwise. - -### GetAwardedGiveawaysCountOk - -`func (o *CampaignForNotification) GetAwardedGiveawaysCountOk() (int32, bool)` - -GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAwardedGiveawaysCount - -`func (o *CampaignForNotification) HasAwardedGiveawaysCount() bool` - -HasAwardedGiveawaysCount returns a boolean if a field has been set. - -### SetAwardedGiveawaysCount - -`func (o *CampaignForNotification) SetAwardedGiveawaysCount(v int32)` - -SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. - -### GetCreatedLoyaltyPointsCount - -`func (o *CampaignForNotification) GetCreatedLoyaltyPointsCount() float32` - -GetCreatedLoyaltyPointsCount returns the CreatedLoyaltyPointsCount field if non-nil, zero value otherwise. - -### GetCreatedLoyaltyPointsCountOk - -`func (o *CampaignForNotification) GetCreatedLoyaltyPointsCountOk() (float32, bool)` - -GetCreatedLoyaltyPointsCountOk returns a tuple with the CreatedLoyaltyPointsCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedLoyaltyPointsCount - -`func (o *CampaignForNotification) HasCreatedLoyaltyPointsCount() bool` - -HasCreatedLoyaltyPointsCount returns a boolean if a field has been set. - -### SetCreatedLoyaltyPointsCount - -`func (o *CampaignForNotification) SetCreatedLoyaltyPointsCount(v float32)` - -SetCreatedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the CreatedLoyaltyPointsCount field. - -### GetCreatedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) GetCreatedLoyaltyPointsEffectCount() int32` - -GetCreatedLoyaltyPointsEffectCount returns the CreatedLoyaltyPointsEffectCount field if non-nil, zero value otherwise. - -### GetCreatedLoyaltyPointsEffectCountOk - -`func (o *CampaignForNotification) GetCreatedLoyaltyPointsEffectCountOk() (int32, bool)` - -GetCreatedLoyaltyPointsEffectCountOk returns a tuple with the CreatedLoyaltyPointsEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) HasCreatedLoyaltyPointsEffectCount() bool` - -HasCreatedLoyaltyPointsEffectCount returns a boolean if a field has been set. - -### SetCreatedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) SetCreatedLoyaltyPointsEffectCount(v int32)` - -SetCreatedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the CreatedLoyaltyPointsEffectCount field. - -### GetRedeemedLoyaltyPointsCount - -`func (o *CampaignForNotification) GetRedeemedLoyaltyPointsCount() float32` - -GetRedeemedLoyaltyPointsCount returns the RedeemedLoyaltyPointsCount field if non-nil, zero value otherwise. - -### GetRedeemedLoyaltyPointsCountOk - -`func (o *CampaignForNotification) GetRedeemedLoyaltyPointsCountOk() (float32, bool)` - -GetRedeemedLoyaltyPointsCountOk returns a tuple with the RedeemedLoyaltyPointsCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasRedeemedLoyaltyPointsCount - -`func (o *CampaignForNotification) HasRedeemedLoyaltyPointsCount() bool` - -HasRedeemedLoyaltyPointsCount returns a boolean if a field has been set. - -### SetRedeemedLoyaltyPointsCount - -`func (o *CampaignForNotification) SetRedeemedLoyaltyPointsCount(v float32)` - -SetRedeemedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the RedeemedLoyaltyPointsCount field. - -### GetRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) GetRedeemedLoyaltyPointsEffectCount() int32` - -GetRedeemedLoyaltyPointsEffectCount returns the RedeemedLoyaltyPointsEffectCount field if non-nil, zero value otherwise. - -### GetRedeemedLoyaltyPointsEffectCountOk - -`func (o *CampaignForNotification) GetRedeemedLoyaltyPointsEffectCountOk() (int32, bool)` - -GetRedeemedLoyaltyPointsEffectCountOk returns a tuple with the RedeemedLoyaltyPointsEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) HasRedeemedLoyaltyPointsEffectCount() bool` - -HasRedeemedLoyaltyPointsEffectCount returns a boolean if a field has been set. - -### SetRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignForNotification) SetRedeemedLoyaltyPointsEffectCount(v int32)` - -SetRedeemedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the RedeemedLoyaltyPointsEffectCount field. - -### GetCallApiEffectCount - -`func (o *CampaignForNotification) GetCallApiEffectCount() int32` - -GetCallApiEffectCount returns the CallApiEffectCount field if non-nil, zero value otherwise. - -### GetCallApiEffectCountOk - -`func (o *CampaignForNotification) GetCallApiEffectCountOk() (int32, bool)` - -GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCallApiEffectCount - -`func (o *CampaignForNotification) HasCallApiEffectCount() bool` - -HasCallApiEffectCount returns a boolean if a field has been set. - -### SetCallApiEffectCount - -`func (o *CampaignForNotification) SetCallApiEffectCount(v int32)` - -SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. - -### GetReservecouponEffectCount - -`func (o *CampaignForNotification) GetReservecouponEffectCount() int32` - -GetReservecouponEffectCount returns the ReservecouponEffectCount field if non-nil, zero value otherwise. - -### GetReservecouponEffectCountOk - -`func (o *CampaignForNotification) GetReservecouponEffectCountOk() (int32, bool)` - -GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReservecouponEffectCount - -`func (o *CampaignForNotification) HasReservecouponEffectCount() bool` - -HasReservecouponEffectCount returns a boolean if a field has been set. - -### SetReservecouponEffectCount - -`func (o *CampaignForNotification) SetReservecouponEffectCount(v int32)` - -SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. - -### GetLastActivity - -`func (o *CampaignForNotification) GetLastActivity() time.Time` - -GetLastActivity returns the LastActivity field if non-nil, zero value otherwise. - -### GetLastActivityOk - -`func (o *CampaignForNotification) GetLastActivityOk() (time.Time, bool)` - -GetLastActivityOk returns a tuple with the LastActivity field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLastActivity - -`func (o *CampaignForNotification) HasLastActivity() bool` - -HasLastActivity returns a boolean if a field has been set. - -### SetLastActivity - -`func (o *CampaignForNotification) SetLastActivity(v time.Time)` - -SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. - -### GetUpdated - -`func (o *CampaignForNotification) GetUpdated() time.Time` - -GetUpdated returns the Updated field if non-nil, zero value otherwise. - -### GetUpdatedOk - -`func (o *CampaignForNotification) GetUpdatedOk() (time.Time, bool)` - -GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUpdated - -`func (o *CampaignForNotification) HasUpdated() bool` - -HasUpdated returns a boolean if a field has been set. - -### SetUpdated - -`func (o *CampaignForNotification) SetUpdated(v time.Time)` - -SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. - -### GetCreatedBy - -`func (o *CampaignForNotification) GetCreatedBy() string` - -GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. - -### GetCreatedByOk - -`func (o *CampaignForNotification) GetCreatedByOk() (string, bool)` - -GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedBy - -`func (o *CampaignForNotification) HasCreatedBy() bool` - -HasCreatedBy returns a boolean if a field has been set. - -### SetCreatedBy - -`func (o *CampaignForNotification) SetCreatedBy(v string)` - -SetCreatedBy gets a reference to the given string and assigns it to the CreatedBy field. - -### GetUpdatedBy - -`func (o *CampaignForNotification) GetUpdatedBy() string` - -GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. - -### GetUpdatedByOk - -`func (o *CampaignForNotification) GetUpdatedByOk() (string, bool)` - -GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUpdatedBy - -`func (o *CampaignForNotification) HasUpdatedBy() bool` - -HasUpdatedBy returns a boolean if a field has been set. - -### SetUpdatedBy - -`func (o *CampaignForNotification) SetUpdatedBy(v string)` - -SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy field. - -### GetTemplateId - -`func (o *CampaignForNotification) GetTemplateId() int32` - -GetTemplateId returns the TemplateId field if non-nil, zero value otherwise. - -### GetTemplateIdOk - -`func (o *CampaignForNotification) GetTemplateIdOk() (int32, bool)` - -GetTemplateIdOk returns a tuple with the TemplateId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTemplateId - -`func (o *CampaignForNotification) HasTemplateId() bool` - -HasTemplateId returns a boolean if a field has been set. - -### SetTemplateId - -`func (o *CampaignForNotification) SetTemplateId(v int32)` - -SetTemplateId gets a reference to the given int32 and assigns it to the TemplateId field. - - -[[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/CampaignNotificationPolicy.md b/docs/CampaignNotificationPolicy.md index c962c92d..c9e1361a 100644 --- a/docs/CampaignNotificationPolicy.md +++ b/docs/CampaignNotificationPolicy.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | Notification name. | +**BatchingEnabled** | Pointer to **bool** | Indicates whether batching is activated. | [optional] [default to true] ## Methods @@ -33,6 +34,31 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. +### GetBatchingEnabled + +`func (o *CampaignNotificationPolicy) GetBatchingEnabled() bool` + +GetBatchingEnabled returns the BatchingEnabled field if non-nil, zero value otherwise. + +### GetBatchingEnabledOk + +`func (o *CampaignNotificationPolicy) GetBatchingEnabledOk() (bool, bool)` + +GetBatchingEnabledOk returns a tuple with the BatchingEnabled field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchingEnabled + +`func (o *CampaignNotificationPolicy) HasBatchingEnabled() bool` + +HasBatchingEnabled returns a boolean if a field has been set. + +### SetBatchingEnabled + +`func (o *CampaignNotificationPolicy) SetBatchingEnabled(v bool)` + +SetBatchingEnabled gets a reference to the given bool and assigns it to the BatchingEnabled field. + [[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/CampaignPrioritiesChangedNotification.md b/docs/CampaignPrioritiesChangedNotification.md deleted file mode 100644 index e9c3c9c5..00000000 --- a/docs/CampaignPrioritiesChangedNotification.md +++ /dev/null @@ -1,91 +0,0 @@ -# CampaignPrioritiesChangedNotification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **int32** | The ID of the Application whose campaigns' priorities changed. | -**OldPriorities** | Pointer to [**CampaignSet**](CampaignSet.md) | | [optional] -**Priorities** | Pointer to [**CampaignSet**](CampaignSet.md) | | - -## Methods - -### GetApplicationId - -`func (o *CampaignPrioritiesChangedNotification) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *CampaignPrioritiesChangedNotification) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *CampaignPrioritiesChangedNotification) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *CampaignPrioritiesChangedNotification) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetOldPriorities - -`func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() CampaignSet` - -GetOldPriorities returns the OldPriorities field if non-nil, zero value otherwise. - -### GetOldPrioritiesOk - -`func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (CampaignSet, bool)` - -GetOldPrioritiesOk returns a tuple with the OldPriorities field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasOldPriorities - -`func (o *CampaignPrioritiesChangedNotification) HasOldPriorities() bool` - -HasOldPriorities returns a boolean if a field has been set. - -### SetOldPriorities - -`func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v CampaignSet)` - -SetOldPriorities gets a reference to the given CampaignSet and assigns it to the OldPriorities field. - -### GetPriorities - -`func (o *CampaignPrioritiesChangedNotification) GetPriorities() CampaignSet` - -GetPriorities returns the Priorities field if non-nil, zero value otherwise. - -### GetPrioritiesOk - -`func (o *CampaignPrioritiesChangedNotification) GetPrioritiesOk() (CampaignSet, bool)` - -GetPrioritiesOk returns a tuple with the Priorities field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasPriorities - -`func (o *CampaignPrioritiesChangedNotification) HasPriorities() bool` - -HasPriorities returns a boolean if a field has been set. - -### SetPriorities - -`func (o *CampaignPrioritiesChangedNotification) SetPriorities(v CampaignSet)` - -SetPriorities gets a reference to the given CampaignSet and assigns it to the Priorities field. - - -[[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/CampaignPrioritiesV2.md b/docs/CampaignPrioritiesV2.md deleted file mode 100644 index 8959a196..00000000 --- a/docs/CampaignPrioritiesV2.md +++ /dev/null @@ -1,91 +0,0 @@ -# CampaignPrioritiesV2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Exclusive** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] -**Stackable** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] -**Universal** | Pointer to [**[]CampaignSetIDs**](CampaignSetIDs.md) | | [optional] - -## Methods - -### GetExclusive - -`func (o *CampaignPrioritiesV2) GetExclusive() []CampaignSetIDs` - -GetExclusive returns the Exclusive field if non-nil, zero value otherwise. - -### GetExclusiveOk - -`func (o *CampaignPrioritiesV2) GetExclusiveOk() ([]CampaignSetIDs, bool)` - -GetExclusiveOk returns a tuple with the Exclusive field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasExclusive - -`func (o *CampaignPrioritiesV2) HasExclusive() bool` - -HasExclusive returns a boolean if a field has been set. - -### SetExclusive - -`func (o *CampaignPrioritiesV2) SetExclusive(v []CampaignSetIDs)` - -SetExclusive gets a reference to the given []CampaignSetIDs and assigns it to the Exclusive field. - -### GetStackable - -`func (o *CampaignPrioritiesV2) GetStackable() []CampaignSetIDs` - -GetStackable returns the Stackable field if non-nil, zero value otherwise. - -### GetStackableOk - -`func (o *CampaignPrioritiesV2) GetStackableOk() ([]CampaignSetIDs, bool)` - -GetStackableOk returns a tuple with the Stackable field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasStackable - -`func (o *CampaignPrioritiesV2) HasStackable() bool` - -HasStackable returns a boolean if a field has been set. - -### SetStackable - -`func (o *CampaignPrioritiesV2) SetStackable(v []CampaignSetIDs)` - -SetStackable gets a reference to the given []CampaignSetIDs and assigns it to the Stackable field. - -### GetUniversal - -`func (o *CampaignPrioritiesV2) GetUniversal() []CampaignSetIDs` - -GetUniversal returns the Universal field if non-nil, zero value otherwise. - -### GetUniversalOk - -`func (o *CampaignPrioritiesV2) GetUniversalOk() ([]CampaignSetIDs, bool)` - -GetUniversalOk returns a tuple with the Universal field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUniversal - -`func (o *CampaignPrioritiesV2) HasUniversal() bool` - -HasUniversal returns a boolean if a field has been set. - -### SetUniversal - -`func (o *CampaignPrioritiesV2) SetUniversal(v []CampaignSetIDs)` - -SetUniversal gets a reference to the given []CampaignSetIDs and assigns it to the Universal field. - - -[[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/CampaignSetIDs.md b/docs/CampaignSetIDs.md deleted file mode 100644 index 3f4825d0..00000000 --- a/docs/CampaignSetIDs.md +++ /dev/null @@ -1,39 +0,0 @@ -# CampaignSetIDs - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CampaignId** | Pointer to **int32** | ID of the campaign | [optional] - -## Methods - -### GetCampaignId - -`func (o *CampaignSetIDs) GetCampaignId() int32` - -GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. - -### GetCampaignIdOk - -`func (o *CampaignSetIDs) GetCampaignIdOk() (int32, bool)` - -GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignId - -`func (o *CampaignSetIDs) HasCampaignId() bool` - -HasCampaignId returns a boolean if a field has been set. - -### SetCampaignId - -`func (o *CampaignSetIDs) SetCampaignId(v int32)` - -SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. - - -[[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/CampaignSetV2.md b/docs/CampaignSetV2.md deleted file mode 100644 index a7b06f83..00000000 --- a/docs/CampaignSetV2.md +++ /dev/null @@ -1,143 +0,0 @@ -# CampaignSetV2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Internal ID of this entity. | -**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**Version** | Pointer to **int32** | Version of the campaign set. | -**Set** | Pointer to [**CampaignPrioritiesV2**](CampaignPrioritiesV2.md) | | - -## Methods - -### GetId - -`func (o *CampaignSetV2) GetId() int32` - -GetId returns the Id field if non-nil, zero value otherwise. - -### GetIdOk - -`func (o *CampaignSetV2) GetIdOk() (int32, bool)` - -GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasId - -`func (o *CampaignSetV2) HasId() bool` - -HasId returns a boolean if a field has been set. - -### SetId - -`func (o *CampaignSetV2) SetId(v int32)` - -SetId gets a reference to the given int32 and assigns it to the Id field. - -### GetCreated - -`func (o *CampaignSetV2) GetCreated() time.Time` - -GetCreated returns the Created field if non-nil, zero value otherwise. - -### GetCreatedOk - -`func (o *CampaignSetV2) GetCreatedOk() (time.Time, bool)` - -GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreated - -`func (o *CampaignSetV2) HasCreated() bool` - -HasCreated returns a boolean if a field has been set. - -### SetCreated - -`func (o *CampaignSetV2) SetCreated(v time.Time)` - -SetCreated gets a reference to the given time.Time and assigns it to the Created field. - -### GetApplicationId - -`func (o *CampaignSetV2) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *CampaignSetV2) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *CampaignSetV2) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *CampaignSetV2) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetVersion - -`func (o *CampaignSetV2) GetVersion() int32` - -GetVersion returns the Version field if non-nil, zero value otherwise. - -### GetVersionOk - -`func (o *CampaignSetV2) GetVersionOk() (int32, bool)` - -GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasVersion - -`func (o *CampaignSetV2) HasVersion() bool` - -HasVersion returns a boolean if a field has been set. - -### SetVersion - -`func (o *CampaignSetV2) SetVersion(v int32)` - -SetVersion gets a reference to the given int32 and assigns it to the Version field. - -### GetSet - -`func (o *CampaignSetV2) GetSet() CampaignPrioritiesV2` - -GetSet returns the Set field if non-nil, zero value otherwise. - -### GetSetOk - -`func (o *CampaignSetV2) GetSetOk() (CampaignPrioritiesV2, bool)` - -GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSet - -`func (o *CampaignSetV2) HasSet() bool` - -HasSet returns a boolean if a field has been set. - -### SetSet - -`func (o *CampaignSetV2) SetSet(v CampaignPrioritiesV2)` - -SetSet gets a reference to the given CampaignPrioritiesV2 and assigns it to the Set field. - - -[[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/CampaignStateChangedNotification.md b/docs/CampaignStateChangedNotification.md index 269419a7..e3c1a0e0 100644 --- a/docs/CampaignStateChangedNotification.md +++ b/docs/CampaignStateChangedNotification.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Campaign** | Pointer to [**Campaign**](Campaign.md) | | -**OldState** | Pointer to **string** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | -**NewState** | Pointer to **string** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] | +**OldState** | Pointer to **string** | The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] | +**NewState** | Pointer to **string** | The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] | **Ruleset** | Pointer to [**Ruleset**](Ruleset.md) | | [optional] ## Methods diff --git a/docs/CampaignStateNotification.md b/docs/CampaignStateNotification.md deleted file mode 100644 index 2add0001..00000000 --- a/docs/CampaignStateNotification.md +++ /dev/null @@ -1,1105 +0,0 @@ -# CampaignStateNotification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique ID for this entity. | -**Created** | Pointer to [**time.Time**](time.Time.md) | The exact moment this entity was created. | -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**UserId** | Pointer to **int32** | The ID of the user associated with this entity. | -**Name** | Pointer to **string** | A user-facing name for this campaign. | -**Description** | Pointer to **string** | A detailed description of the campaign. | -**StartTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become active. | [optional] -**EndTime** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] -**State** | Pointer to **string** | A disabled or archived campaign is not evaluated for rules or coupons. | [default to STATE_ENABLED] -**ActiveRulesetId** | Pointer to **int32** | [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. | [optional] -**Tags** | Pointer to **[]string** | A list of tags for the campaign. | -**Features** | Pointer to **[]string** | The features enabled in this campaign. | -**CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] -**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. | -**CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. | [optional] -**EvaluationGroupId** | Pointer to **int32** | The ID of the campaign evaluation group the campaign belongs to. | [optional] -**Type** | Pointer to **string** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [default to TYPE_ADVANCED] -**LinkedStoreIds** | Pointer to **[]int32** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] -**Budgets** | Pointer to [**[]CampaignBudget**](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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. | [optional] -**ReferralRedemptionCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. | [optional] -**DiscountCount** | Pointer to **float32** | This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. | [optional] -**DiscountEffectCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. | [optional] -**CouponCreationCount** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. | [optional] -**CustomEffectCount** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. | [optional] -**AddFreeItemEffectCount** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. | [optional] -**CreatedLoyaltyPointsCount** | Pointer to **float32** | 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** | Pointer to **int32** | 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** | Pointer to **float32** | 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** | Pointer to **int32** | 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** | Pointer to **int32** | This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. | [optional] -**ReservecouponEffectCount** | Pointer to **int32** | 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** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent event received by this campaign. | [optional] -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. | [optional] -**CreatedBy** | Pointer to **string** | Name of the user who created this campaign if available. | [optional] -**UpdatedBy** | Pointer to **string** | Name of the user who last updated this campaign if available. | [optional] -**TemplateId** | Pointer to **int32** | The ID of the Campaign Template this Campaign was created from. | [optional] -**FrontendState** | Pointer to **string** | A campaign state described exactly as in the Campaign Manager. | - -## Methods - -### GetId - -`func (o *CampaignStateNotification) GetId() int32` - -GetId returns the Id field if non-nil, zero value otherwise. - -### GetIdOk - -`func (o *CampaignStateNotification) GetIdOk() (int32, bool)` - -GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasId - -`func (o *CampaignStateNotification) HasId() bool` - -HasId returns a boolean if a field has been set. - -### SetId - -`func (o *CampaignStateNotification) SetId(v int32)` - -SetId gets a reference to the given int32 and assigns it to the Id field. - -### GetCreated - -`func (o *CampaignStateNotification) GetCreated() time.Time` - -GetCreated returns the Created field if non-nil, zero value otherwise. - -### GetCreatedOk - -`func (o *CampaignStateNotification) GetCreatedOk() (time.Time, bool)` - -GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreated - -`func (o *CampaignStateNotification) HasCreated() bool` - -HasCreated returns a boolean if a field has been set. - -### SetCreated - -`func (o *CampaignStateNotification) SetCreated(v time.Time)` - -SetCreated gets a reference to the given time.Time and assigns it to the Created field. - -### GetApplicationId - -`func (o *CampaignStateNotification) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *CampaignStateNotification) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *CampaignStateNotification) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *CampaignStateNotification) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetUserId - -`func (o *CampaignStateNotification) GetUserId() int32` - -GetUserId returns the UserId field if non-nil, zero value otherwise. - -### GetUserIdOk - -`func (o *CampaignStateNotification) GetUserIdOk() (int32, bool)` - -GetUserIdOk returns a tuple with the UserId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUserId - -`func (o *CampaignStateNotification) HasUserId() bool` - -HasUserId returns a boolean if a field has been set. - -### SetUserId - -`func (o *CampaignStateNotification) SetUserId(v int32)` - -SetUserId gets a reference to the given int32 and assigns it to the UserId field. - -### GetName - -`func (o *CampaignStateNotification) GetName() string` - -GetName returns the Name field if non-nil, zero value otherwise. - -### GetNameOk - -`func (o *CampaignStateNotification) GetNameOk() (string, bool)` - -GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasName - -`func (o *CampaignStateNotification) HasName() bool` - -HasName returns a boolean if a field has been set. - -### SetName - -`func (o *CampaignStateNotification) SetName(v string)` - -SetName gets a reference to the given string and assigns it to the Name field. - -### GetDescription - -`func (o *CampaignStateNotification) GetDescription() string` - -GetDescription returns the Description field if non-nil, zero value otherwise. - -### GetDescriptionOk - -`func (o *CampaignStateNotification) GetDescriptionOk() (string, bool)` - -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDescription - -`func (o *CampaignStateNotification) HasDescription() bool` - -HasDescription returns a boolean if a field has been set. - -### SetDescription - -`func (o *CampaignStateNotification) SetDescription(v string)` - -SetDescription gets a reference to the given string and assigns it to the Description field. - -### GetStartTime - -`func (o *CampaignStateNotification) GetStartTime() time.Time` - -GetStartTime returns the StartTime field if non-nil, zero value otherwise. - -### GetStartTimeOk - -`func (o *CampaignStateNotification) GetStartTimeOk() (time.Time, bool)` - -GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasStartTime - -`func (o *CampaignStateNotification) HasStartTime() bool` - -HasStartTime returns a boolean if a field has been set. - -### SetStartTime - -`func (o *CampaignStateNotification) SetStartTime(v time.Time)` - -SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. - -### GetEndTime - -`func (o *CampaignStateNotification) GetEndTime() time.Time` - -GetEndTime returns the EndTime field if non-nil, zero value otherwise. - -### GetEndTimeOk - -`func (o *CampaignStateNotification) GetEndTimeOk() (time.Time, bool)` - -GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEndTime - -`func (o *CampaignStateNotification) HasEndTime() bool` - -HasEndTime returns a boolean if a field has been set. - -### SetEndTime - -`func (o *CampaignStateNotification) SetEndTime(v time.Time)` - -SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. - -### GetAttributes - -`func (o *CampaignStateNotification) GetAttributes() map[string]interface{}` - -GetAttributes returns the Attributes field if non-nil, zero value otherwise. - -### GetAttributesOk - -`func (o *CampaignStateNotification) GetAttributesOk() (map[string]interface{}, bool)` - -GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAttributes - -`func (o *CampaignStateNotification) HasAttributes() bool` - -HasAttributes returns a boolean if a field has been set. - -### SetAttributes - -`func (o *CampaignStateNotification) SetAttributes(v map[string]interface{})` - -SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. - -### GetState - -`func (o *CampaignStateNotification) GetState() string` - -GetState returns the State field if non-nil, zero value otherwise. - -### GetStateOk - -`func (o *CampaignStateNotification) GetStateOk() (string, bool)` - -GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasState - -`func (o *CampaignStateNotification) HasState() bool` - -HasState returns a boolean if a field has been set. - -### SetState - -`func (o *CampaignStateNotification) SetState(v string)` - -SetState gets a reference to the given string and assigns it to the State field. - -### GetActiveRulesetId - -`func (o *CampaignStateNotification) GetActiveRulesetId() int32` - -GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise. - -### GetActiveRulesetIdOk - -`func (o *CampaignStateNotification) GetActiveRulesetIdOk() (int32, bool)` - -GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasActiveRulesetId - -`func (o *CampaignStateNotification) HasActiveRulesetId() bool` - -HasActiveRulesetId returns a boolean if a field has been set. - -### SetActiveRulesetId - -`func (o *CampaignStateNotification) SetActiveRulesetId(v int32)` - -SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. - -### GetTags - -`func (o *CampaignStateNotification) GetTags() []string` - -GetTags returns the Tags field if non-nil, zero value otherwise. - -### GetTagsOk - -`func (o *CampaignStateNotification) GetTagsOk() ([]string, bool)` - -GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTags - -`func (o *CampaignStateNotification) HasTags() bool` - -HasTags returns a boolean if a field has been set. - -### SetTags - -`func (o *CampaignStateNotification) SetTags(v []string)` - -SetTags gets a reference to the given []string and assigns it to the Tags field. - -### GetFeatures - -`func (o *CampaignStateNotification) GetFeatures() []string` - -GetFeatures returns the Features field if non-nil, zero value otherwise. - -### GetFeaturesOk - -`func (o *CampaignStateNotification) GetFeaturesOk() ([]string, bool)` - -GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasFeatures - -`func (o *CampaignStateNotification) HasFeatures() bool` - -HasFeatures returns a boolean if a field has been set. - -### SetFeatures - -`func (o *CampaignStateNotification) SetFeatures(v []string)` - -SetFeatures gets a reference to the given []string and assigns it to the Features field. - -### GetCouponSettings - -`func (o *CampaignStateNotification) GetCouponSettings() CodeGeneratorSettings` - -GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise. - -### GetCouponSettingsOk - -`func (o *CampaignStateNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool)` - -GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponSettings - -`func (o *CampaignStateNotification) HasCouponSettings() bool` - -HasCouponSettings returns a boolean if a field has been set. - -### SetCouponSettings - -`func (o *CampaignStateNotification) SetCouponSettings(v CodeGeneratorSettings)` - -SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. - -### GetReferralSettings - -`func (o *CampaignStateNotification) GetReferralSettings() CodeGeneratorSettings` - -GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise. - -### GetReferralSettingsOk - -`func (o *CampaignStateNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool)` - -GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralSettings - -`func (o *CampaignStateNotification) HasReferralSettings() bool` - -HasReferralSettings returns a boolean if a field has been set. - -### SetReferralSettings - -`func (o *CampaignStateNotification) SetReferralSettings(v CodeGeneratorSettings)` - -SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. - -### GetLimits - -`func (o *CampaignStateNotification) GetLimits() []LimitConfig` - -GetLimits returns the Limits field if non-nil, zero value otherwise. - -### GetLimitsOk - -`func (o *CampaignStateNotification) GetLimitsOk() ([]LimitConfig, bool)` - -GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLimits - -`func (o *CampaignStateNotification) HasLimits() bool` - -HasLimits returns a boolean if a field has been set. - -### SetLimits - -`func (o *CampaignStateNotification) SetLimits(v []LimitConfig)` - -SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. - -### GetCampaignGroups - -`func (o *CampaignStateNotification) GetCampaignGroups() []int32` - -GetCampaignGroups returns the CampaignGroups field if non-nil, zero value otherwise. - -### GetCampaignGroupsOk - -`func (o *CampaignStateNotification) GetCampaignGroupsOk() ([]int32, bool)` - -GetCampaignGroupsOk returns a tuple with the CampaignGroups field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignGroups - -`func (o *CampaignStateNotification) HasCampaignGroups() bool` - -HasCampaignGroups returns a boolean if a field has been set. - -### SetCampaignGroups - -`func (o *CampaignStateNotification) SetCampaignGroups(v []int32)` - -SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. - -### GetEvaluationGroupId - -`func (o *CampaignStateNotification) GetEvaluationGroupId() int32` - -GetEvaluationGroupId returns the EvaluationGroupId field if non-nil, zero value otherwise. - -### GetEvaluationGroupIdOk - -`func (o *CampaignStateNotification) GetEvaluationGroupIdOk() (int32, bool)` - -GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEvaluationGroupId - -`func (o *CampaignStateNotification) HasEvaluationGroupId() bool` - -HasEvaluationGroupId returns a boolean if a field has been set. - -### SetEvaluationGroupId - -`func (o *CampaignStateNotification) SetEvaluationGroupId(v int32)` - -SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. - -### GetType - -`func (o *CampaignStateNotification) GetType() string` - -GetType returns the Type field if non-nil, zero value otherwise. - -### GetTypeOk - -`func (o *CampaignStateNotification) GetTypeOk() (string, bool)` - -GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasType - -`func (o *CampaignStateNotification) HasType() bool` - -HasType returns a boolean if a field has been set. - -### SetType - -`func (o *CampaignStateNotification) SetType(v string)` - -SetType gets a reference to the given string and assigns it to the Type field. - -### GetLinkedStoreIds - -`func (o *CampaignStateNotification) GetLinkedStoreIds() []int32` - -GetLinkedStoreIds returns the LinkedStoreIds field if non-nil, zero value otherwise. - -### GetLinkedStoreIdsOk - -`func (o *CampaignStateNotification) GetLinkedStoreIdsOk() ([]int32, bool)` - -GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLinkedStoreIds - -`func (o *CampaignStateNotification) HasLinkedStoreIds() bool` - -HasLinkedStoreIds returns a boolean if a field has been set. - -### SetLinkedStoreIds - -`func (o *CampaignStateNotification) SetLinkedStoreIds(v []int32)` - -SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. - -### GetBudgets - -`func (o *CampaignStateNotification) GetBudgets() []CampaignBudget` - -GetBudgets returns the Budgets field if non-nil, zero value otherwise. - -### GetBudgetsOk - -`func (o *CampaignStateNotification) GetBudgetsOk() ([]CampaignBudget, bool)` - -GetBudgetsOk returns a tuple with the Budgets field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasBudgets - -`func (o *CampaignStateNotification) HasBudgets() bool` - -HasBudgets returns a boolean if a field has been set. - -### SetBudgets - -`func (o *CampaignStateNotification) SetBudgets(v []CampaignBudget)` - -SetBudgets gets a reference to the given []CampaignBudget and assigns it to the Budgets field. - -### GetCouponRedemptionCount - -`func (o *CampaignStateNotification) GetCouponRedemptionCount() int32` - -GetCouponRedemptionCount returns the CouponRedemptionCount field if non-nil, zero value otherwise. - -### GetCouponRedemptionCountOk - -`func (o *CampaignStateNotification) GetCouponRedemptionCountOk() (int32, bool)` - -GetCouponRedemptionCountOk returns a tuple with the CouponRedemptionCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponRedemptionCount - -`func (o *CampaignStateNotification) HasCouponRedemptionCount() bool` - -HasCouponRedemptionCount returns a boolean if a field has been set. - -### SetCouponRedemptionCount - -`func (o *CampaignStateNotification) SetCouponRedemptionCount(v int32)` - -SetCouponRedemptionCount gets a reference to the given int32 and assigns it to the CouponRedemptionCount field. - -### GetReferralRedemptionCount - -`func (o *CampaignStateNotification) GetReferralRedemptionCount() int32` - -GetReferralRedemptionCount returns the ReferralRedemptionCount field if non-nil, zero value otherwise. - -### GetReferralRedemptionCountOk - -`func (o *CampaignStateNotification) GetReferralRedemptionCountOk() (int32, bool)` - -GetReferralRedemptionCountOk returns a tuple with the ReferralRedemptionCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralRedemptionCount - -`func (o *CampaignStateNotification) HasReferralRedemptionCount() bool` - -HasReferralRedemptionCount returns a boolean if a field has been set. - -### SetReferralRedemptionCount - -`func (o *CampaignStateNotification) SetReferralRedemptionCount(v int32)` - -SetReferralRedemptionCount gets a reference to the given int32 and assigns it to the ReferralRedemptionCount field. - -### GetDiscountCount - -`func (o *CampaignStateNotification) GetDiscountCount() float32` - -GetDiscountCount returns the DiscountCount field if non-nil, zero value otherwise. - -### GetDiscountCountOk - -`func (o *CampaignStateNotification) GetDiscountCountOk() (float32, bool)` - -GetDiscountCountOk returns a tuple with the DiscountCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDiscountCount - -`func (o *CampaignStateNotification) HasDiscountCount() bool` - -HasDiscountCount returns a boolean if a field has been set. - -### SetDiscountCount - -`func (o *CampaignStateNotification) SetDiscountCount(v float32)` - -SetDiscountCount gets a reference to the given float32 and assigns it to the DiscountCount field. - -### GetDiscountEffectCount - -`func (o *CampaignStateNotification) GetDiscountEffectCount() int32` - -GetDiscountEffectCount returns the DiscountEffectCount field if non-nil, zero value otherwise. - -### GetDiscountEffectCountOk - -`func (o *CampaignStateNotification) GetDiscountEffectCountOk() (int32, bool)` - -GetDiscountEffectCountOk returns a tuple with the DiscountEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDiscountEffectCount - -`func (o *CampaignStateNotification) HasDiscountEffectCount() bool` - -HasDiscountEffectCount returns a boolean if a field has been set. - -### SetDiscountEffectCount - -`func (o *CampaignStateNotification) SetDiscountEffectCount(v int32)` - -SetDiscountEffectCount gets a reference to the given int32 and assigns it to the DiscountEffectCount field. - -### GetCouponCreationCount - -`func (o *CampaignStateNotification) GetCouponCreationCount() int32` - -GetCouponCreationCount returns the CouponCreationCount field if non-nil, zero value otherwise. - -### GetCouponCreationCountOk - -`func (o *CampaignStateNotification) GetCouponCreationCountOk() (int32, bool)` - -GetCouponCreationCountOk returns a tuple with the CouponCreationCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCouponCreationCount - -`func (o *CampaignStateNotification) HasCouponCreationCount() bool` - -HasCouponCreationCount returns a boolean if a field has been set. - -### SetCouponCreationCount - -`func (o *CampaignStateNotification) SetCouponCreationCount(v int32)` - -SetCouponCreationCount gets a reference to the given int32 and assigns it to the CouponCreationCount field. - -### GetCustomEffectCount - -`func (o *CampaignStateNotification) GetCustomEffectCount() int32` - -GetCustomEffectCount returns the CustomEffectCount field if non-nil, zero value otherwise. - -### GetCustomEffectCountOk - -`func (o *CampaignStateNotification) GetCustomEffectCountOk() (int32, bool)` - -GetCustomEffectCountOk returns a tuple with the CustomEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCustomEffectCount - -`func (o *CampaignStateNotification) HasCustomEffectCount() bool` - -HasCustomEffectCount returns a boolean if a field has been set. - -### SetCustomEffectCount - -`func (o *CampaignStateNotification) SetCustomEffectCount(v int32)` - -SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. - -### GetReferralCreationCount - -`func (o *CampaignStateNotification) GetReferralCreationCount() int32` - -GetReferralCreationCount returns the ReferralCreationCount field if non-nil, zero value otherwise. - -### GetReferralCreationCountOk - -`func (o *CampaignStateNotification) GetReferralCreationCountOk() (int32, bool)` - -GetReferralCreationCountOk returns a tuple with the ReferralCreationCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReferralCreationCount - -`func (o *CampaignStateNotification) HasReferralCreationCount() bool` - -HasReferralCreationCount returns a boolean if a field has been set. - -### SetReferralCreationCount - -`func (o *CampaignStateNotification) SetReferralCreationCount(v int32)` - -SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. - -### GetAddFreeItemEffectCount - -`func (o *CampaignStateNotification) GetAddFreeItemEffectCount() int32` - -GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field if non-nil, zero value otherwise. - -### GetAddFreeItemEffectCountOk - -`func (o *CampaignStateNotification) GetAddFreeItemEffectCountOk() (int32, bool)` - -GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAddFreeItemEffectCount - -`func (o *CampaignStateNotification) HasAddFreeItemEffectCount() bool` - -HasAddFreeItemEffectCount returns a boolean if a field has been set. - -### SetAddFreeItemEffectCount - -`func (o *CampaignStateNotification) SetAddFreeItemEffectCount(v int32)` - -SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. - -### GetAwardedGiveawaysCount - -`func (o *CampaignStateNotification) GetAwardedGiveawaysCount() int32` - -GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field if non-nil, zero value otherwise. - -### GetAwardedGiveawaysCountOk - -`func (o *CampaignStateNotification) GetAwardedGiveawaysCountOk() (int32, bool)` - -GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasAwardedGiveawaysCount - -`func (o *CampaignStateNotification) HasAwardedGiveawaysCount() bool` - -HasAwardedGiveawaysCount returns a boolean if a field has been set. - -### SetAwardedGiveawaysCount - -`func (o *CampaignStateNotification) SetAwardedGiveawaysCount(v int32)` - -SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. - -### GetCreatedLoyaltyPointsCount - -`func (o *CampaignStateNotification) GetCreatedLoyaltyPointsCount() float32` - -GetCreatedLoyaltyPointsCount returns the CreatedLoyaltyPointsCount field if non-nil, zero value otherwise. - -### GetCreatedLoyaltyPointsCountOk - -`func (o *CampaignStateNotification) GetCreatedLoyaltyPointsCountOk() (float32, bool)` - -GetCreatedLoyaltyPointsCountOk returns a tuple with the CreatedLoyaltyPointsCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedLoyaltyPointsCount - -`func (o *CampaignStateNotification) HasCreatedLoyaltyPointsCount() bool` - -HasCreatedLoyaltyPointsCount returns a boolean if a field has been set. - -### SetCreatedLoyaltyPointsCount - -`func (o *CampaignStateNotification) SetCreatedLoyaltyPointsCount(v float32)` - -SetCreatedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the CreatedLoyaltyPointsCount field. - -### GetCreatedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) GetCreatedLoyaltyPointsEffectCount() int32` - -GetCreatedLoyaltyPointsEffectCount returns the CreatedLoyaltyPointsEffectCount field if non-nil, zero value otherwise. - -### GetCreatedLoyaltyPointsEffectCountOk - -`func (o *CampaignStateNotification) GetCreatedLoyaltyPointsEffectCountOk() (int32, bool)` - -GetCreatedLoyaltyPointsEffectCountOk returns a tuple with the CreatedLoyaltyPointsEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) HasCreatedLoyaltyPointsEffectCount() bool` - -HasCreatedLoyaltyPointsEffectCount returns a boolean if a field has been set. - -### SetCreatedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) SetCreatedLoyaltyPointsEffectCount(v int32)` - -SetCreatedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the CreatedLoyaltyPointsEffectCount field. - -### GetRedeemedLoyaltyPointsCount - -`func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsCount() float32` - -GetRedeemedLoyaltyPointsCount returns the RedeemedLoyaltyPointsCount field if non-nil, zero value otherwise. - -### GetRedeemedLoyaltyPointsCountOk - -`func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsCountOk() (float32, bool)` - -GetRedeemedLoyaltyPointsCountOk returns a tuple with the RedeemedLoyaltyPointsCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasRedeemedLoyaltyPointsCount - -`func (o *CampaignStateNotification) HasRedeemedLoyaltyPointsCount() bool` - -HasRedeemedLoyaltyPointsCount returns a boolean if a field has been set. - -### SetRedeemedLoyaltyPointsCount - -`func (o *CampaignStateNotification) SetRedeemedLoyaltyPointsCount(v float32)` - -SetRedeemedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the RedeemedLoyaltyPointsCount field. - -### GetRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsEffectCount() int32` - -GetRedeemedLoyaltyPointsEffectCount returns the RedeemedLoyaltyPointsEffectCount field if non-nil, zero value otherwise. - -### GetRedeemedLoyaltyPointsEffectCountOk - -`func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsEffectCountOk() (int32, bool)` - -GetRedeemedLoyaltyPointsEffectCountOk returns a tuple with the RedeemedLoyaltyPointsEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) HasRedeemedLoyaltyPointsEffectCount() bool` - -HasRedeemedLoyaltyPointsEffectCount returns a boolean if a field has been set. - -### SetRedeemedLoyaltyPointsEffectCount - -`func (o *CampaignStateNotification) SetRedeemedLoyaltyPointsEffectCount(v int32)` - -SetRedeemedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the RedeemedLoyaltyPointsEffectCount field. - -### GetCallApiEffectCount - -`func (o *CampaignStateNotification) GetCallApiEffectCount() int32` - -GetCallApiEffectCount returns the CallApiEffectCount field if non-nil, zero value otherwise. - -### GetCallApiEffectCountOk - -`func (o *CampaignStateNotification) GetCallApiEffectCountOk() (int32, bool)` - -GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCallApiEffectCount - -`func (o *CampaignStateNotification) HasCallApiEffectCount() bool` - -HasCallApiEffectCount returns a boolean if a field has been set. - -### SetCallApiEffectCount - -`func (o *CampaignStateNotification) SetCallApiEffectCount(v int32)` - -SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. - -### GetReservecouponEffectCount - -`func (o *CampaignStateNotification) GetReservecouponEffectCount() int32` - -GetReservecouponEffectCount returns the ReservecouponEffectCount field if non-nil, zero value otherwise. - -### GetReservecouponEffectCountOk - -`func (o *CampaignStateNotification) GetReservecouponEffectCountOk() (int32, bool)` - -GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasReservecouponEffectCount - -`func (o *CampaignStateNotification) HasReservecouponEffectCount() bool` - -HasReservecouponEffectCount returns a boolean if a field has been set. - -### SetReservecouponEffectCount - -`func (o *CampaignStateNotification) SetReservecouponEffectCount(v int32)` - -SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. - -### GetLastActivity - -`func (o *CampaignStateNotification) GetLastActivity() time.Time` - -GetLastActivity returns the LastActivity field if non-nil, zero value otherwise. - -### GetLastActivityOk - -`func (o *CampaignStateNotification) GetLastActivityOk() (time.Time, bool)` - -GetLastActivityOk returns a tuple with the LastActivity field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLastActivity - -`func (o *CampaignStateNotification) HasLastActivity() bool` - -HasLastActivity returns a boolean if a field has been set. - -### SetLastActivity - -`func (o *CampaignStateNotification) SetLastActivity(v time.Time)` - -SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. - -### GetUpdated - -`func (o *CampaignStateNotification) GetUpdated() time.Time` - -GetUpdated returns the Updated field if non-nil, zero value otherwise. - -### GetUpdatedOk - -`func (o *CampaignStateNotification) GetUpdatedOk() (time.Time, bool)` - -GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUpdated - -`func (o *CampaignStateNotification) HasUpdated() bool` - -HasUpdated returns a boolean if a field has been set. - -### SetUpdated - -`func (o *CampaignStateNotification) SetUpdated(v time.Time)` - -SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. - -### GetCreatedBy - -`func (o *CampaignStateNotification) GetCreatedBy() string` - -GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. - -### GetCreatedByOk - -`func (o *CampaignStateNotification) GetCreatedByOk() (string, bool)` - -GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreatedBy - -`func (o *CampaignStateNotification) HasCreatedBy() bool` - -HasCreatedBy returns a boolean if a field has been set. - -### SetCreatedBy - -`func (o *CampaignStateNotification) SetCreatedBy(v string)` - -SetCreatedBy gets a reference to the given string and assigns it to the CreatedBy field. - -### GetUpdatedBy - -`func (o *CampaignStateNotification) GetUpdatedBy() string` - -GetUpdatedBy returns the UpdatedBy field if non-nil, zero value otherwise. - -### GetUpdatedByOk - -`func (o *CampaignStateNotification) GetUpdatedByOk() (string, bool)` - -GetUpdatedByOk returns a tuple with the UpdatedBy field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUpdatedBy - -`func (o *CampaignStateNotification) HasUpdatedBy() bool` - -HasUpdatedBy returns a boolean if a field has been set. - -### SetUpdatedBy - -`func (o *CampaignStateNotification) SetUpdatedBy(v string)` - -SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy field. - -### GetTemplateId - -`func (o *CampaignStateNotification) GetTemplateId() int32` - -GetTemplateId returns the TemplateId field if non-nil, zero value otherwise. - -### GetTemplateIdOk - -`func (o *CampaignStateNotification) GetTemplateIdOk() (int32, bool)` - -GetTemplateIdOk returns a tuple with the TemplateId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTemplateId - -`func (o *CampaignStateNotification) HasTemplateId() bool` - -HasTemplateId returns a boolean if a field has been set. - -### SetTemplateId - -`func (o *CampaignStateNotification) SetTemplateId(v int32)` - -SetTemplateId gets a reference to the given int32 and assigns it to the TemplateId field. - -### GetFrontendState - -`func (o *CampaignStateNotification) GetFrontendState() string` - -GetFrontendState returns the FrontendState field if non-nil, zero value otherwise. - -### GetFrontendStateOk - -`func (o *CampaignStateNotification) GetFrontendStateOk() (string, bool)` - -GetFrontendStateOk returns a tuple with the FrontendState field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasFrontendState - -`func (o *CampaignStateNotification) HasFrontendState() bool` - -HasFrontendState returns a boolean if a field has been set. - -### SetFrontendState - -`func (o *CampaignStateNotification) SetFrontendState(v string)` - -SetFrontendState gets a reference to the given string and assigns it to the FrontendState field. - - -[[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/CampaignStoreBudget.md b/docs/CampaignStoreBudget.md new file mode 100644 index 00000000..3a4b309b --- /dev/null +++ b/docs/CampaignStoreBudget.md @@ -0,0 +1,143 @@ +# CampaignStoreBudget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**CampaignId** | Pointer to **int32** | The ID of the campaign that owns this entity. | +**StoreId** | Pointer to **int32** | The ID of the store. | +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of budget limits for stores linked to the campaign. | + +## Methods + +### GetId + +`func (o *CampaignStoreBudget) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CampaignStoreBudget) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CampaignStoreBudget) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CampaignStoreBudget) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CampaignStoreBudget) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CampaignStoreBudget) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CampaignStoreBudget) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CampaignStoreBudget) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCampaignId + +`func (o *CampaignStoreBudget) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *CampaignStoreBudget) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *CampaignStoreBudget) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *CampaignStoreBudget) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetStoreId + +`func (o *CampaignStoreBudget) GetStoreId() int32` + +GetStoreId returns the StoreId field if non-nil, zero value otherwise. + +### GetStoreIdOk + +`func (o *CampaignStoreBudget) GetStoreIdOk() (int32, bool)` + +GetStoreIdOk returns a tuple with the StoreId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStoreId + +`func (o *CampaignStoreBudget) HasStoreId() bool` + +HasStoreId returns a boolean if a field has been set. + +### SetStoreId + +`func (o *CampaignStoreBudget) SetStoreId(v int32)` + +SetStoreId gets a reference to the given int32 and assigns it to the StoreId field. + +### GetLimits + +`func (o *CampaignStoreBudget) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *CampaignStoreBudget) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *CampaignStoreBudget) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *CampaignStoreBudget) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + + +[[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/CampaignVersions.md b/docs/CampaignVersions.md new file mode 100644 index 00000000..13754752 --- /dev/null +++ b/docs/CampaignVersions.md @@ -0,0 +1,169 @@ +# CampaignVersions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActiveRevisionId** | Pointer to **int32** | ID of the revision that was last activated on this campaign. | [optional] +**ActiveRevisionVersionId** | Pointer to **int32** | ID of the revision version that is active on the campaign. | [optional] +**Version** | Pointer to **int32** | Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. | [optional] +**CurrentRevisionId** | Pointer to **int32** | ID of the revision currently being modified for the campaign. | [optional] +**CurrentRevisionVersionId** | Pointer to **int32** | ID of the latest version applied on the current revision. | [optional] +**StageRevision** | Pointer to **bool** | Flag for determining whether we use current revision when sending requests with staging API key. | [optional] [default to false] + +## Methods + +### GetActiveRevisionId + +`func (o *CampaignVersions) GetActiveRevisionId() int32` + +GetActiveRevisionId returns the ActiveRevisionId field if non-nil, zero value otherwise. + +### GetActiveRevisionIdOk + +`func (o *CampaignVersions) GetActiveRevisionIdOk() (int32, bool)` + +GetActiveRevisionIdOk returns a tuple with the ActiveRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRevisionId + +`func (o *CampaignVersions) HasActiveRevisionId() bool` + +HasActiveRevisionId returns a boolean if a field has been set. + +### SetActiveRevisionId + +`func (o *CampaignVersions) SetActiveRevisionId(v int32)` + +SetActiveRevisionId gets a reference to the given int32 and assigns it to the ActiveRevisionId field. + +### GetActiveRevisionVersionId + +`func (o *CampaignVersions) GetActiveRevisionVersionId() int32` + +GetActiveRevisionVersionId returns the ActiveRevisionVersionId field if non-nil, zero value otherwise. + +### GetActiveRevisionVersionIdOk + +`func (o *CampaignVersions) GetActiveRevisionVersionIdOk() (int32, bool)` + +GetActiveRevisionVersionIdOk returns a tuple with the ActiveRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRevisionVersionId + +`func (o *CampaignVersions) HasActiveRevisionVersionId() bool` + +HasActiveRevisionVersionId returns a boolean if a field has been set. + +### SetActiveRevisionVersionId + +`func (o *CampaignVersions) SetActiveRevisionVersionId(v int32)` + +SetActiveRevisionVersionId gets a reference to the given int32 and assigns it to the ActiveRevisionVersionId field. + +### GetVersion + +`func (o *CampaignVersions) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *CampaignVersions) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *CampaignVersions) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *CampaignVersions) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetCurrentRevisionId + +`func (o *CampaignVersions) GetCurrentRevisionId() int32` + +GetCurrentRevisionId returns the CurrentRevisionId field if non-nil, zero value otherwise. + +### GetCurrentRevisionIdOk + +`func (o *CampaignVersions) GetCurrentRevisionIdOk() (int32, bool)` + +GetCurrentRevisionIdOk returns a tuple with the CurrentRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentRevisionId + +`func (o *CampaignVersions) HasCurrentRevisionId() bool` + +HasCurrentRevisionId returns a boolean if a field has been set. + +### SetCurrentRevisionId + +`func (o *CampaignVersions) SetCurrentRevisionId(v int32)` + +SetCurrentRevisionId gets a reference to the given int32 and assigns it to the CurrentRevisionId field. + +### GetCurrentRevisionVersionId + +`func (o *CampaignVersions) GetCurrentRevisionVersionId() int32` + +GetCurrentRevisionVersionId returns the CurrentRevisionVersionId field if non-nil, zero value otherwise. + +### GetCurrentRevisionVersionIdOk + +`func (o *CampaignVersions) GetCurrentRevisionVersionIdOk() (int32, bool)` + +GetCurrentRevisionVersionIdOk returns a tuple with the CurrentRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentRevisionVersionId + +`func (o *CampaignVersions) HasCurrentRevisionVersionId() bool` + +HasCurrentRevisionVersionId returns a boolean if a field has been set. + +### SetCurrentRevisionVersionId + +`func (o *CampaignVersions) SetCurrentRevisionVersionId(v int32)` + +SetCurrentRevisionVersionId gets a reference to the given int32 and assigns it to the CurrentRevisionVersionId field. + +### GetStageRevision + +`func (o *CampaignVersions) GetStageRevision() bool` + +GetStageRevision returns the StageRevision field if non-nil, zero value otherwise. + +### GetStageRevisionOk + +`func (o *CampaignVersions) GetStageRevisionOk() (bool, bool)` + +GetStageRevisionOk returns a tuple with the StageRevision field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStageRevision + +`func (o *CampaignVersions) HasStageRevision() bool` + +HasStageRevision returns a boolean if a field has been set. + +### SetStageRevision + +`func (o *CampaignVersions) SetStageRevision(v bool)` + +SetStageRevision gets a reference to the given bool and assigns it to the StageRevision field. + + +[[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/CardAddedDeductedPointsNotificationPolicy.md b/docs/CardAddedDeductedPointsNotificationPolicy.md new file mode 100644 index 00000000..686b5f83 --- /dev/null +++ b/docs/CardAddedDeductedPointsNotificationPolicy.md @@ -0,0 +1,65 @@ +# CardAddedDeductedPointsNotificationPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Notification name. | +**Scopes** | Pointer to **[]string** | | + +## Methods + +### GetName + +`func (o *CardAddedDeductedPointsNotificationPolicy) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CardAddedDeductedPointsNotificationPolicy) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *CardAddedDeductedPointsNotificationPolicy) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *CardAddedDeductedPointsNotificationPolicy) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetScopes + +`func (o *CardAddedDeductedPointsNotificationPolicy) GetScopes() []string` + +GetScopes returns the Scopes field if non-nil, zero value otherwise. + +### GetScopesOk + +`func (o *CardAddedDeductedPointsNotificationPolicy) GetScopesOk() ([]string, bool)` + +GetScopesOk returns a tuple with the Scopes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasScopes + +`func (o *CardAddedDeductedPointsNotificationPolicy) HasScopes() bool` + +HasScopes returns a boolean if a field has been set. + +### SetScopes + +`func (o *CardAddedDeductedPointsNotificationPolicy) SetScopes(v []string)` + +SetScopes gets a reference to the given []string and assigns it to the Scopes field. + + +[[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/CartItem.md b/docs/CartItem.md index e10c3647..cba06c61 100644 --- a/docs/CartItem.md +++ b/docs/CartItem.md @@ -17,7 +17,7 @@ Name | Type | Description | Notes **Width** | Pointer to **float32** | Width of item in mm. | [optional] **Length** | Pointer to **float32** | Length of item in mm. | [optional] **Position** | Pointer to **float32** | Position of the Cart Item in the Cart (calculated internally). | [optional] -**Attributes** | Pointer to [**map[string]interface{}**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. | [optional] **AdditionalCosts** | Pointer to [**map[string]AdditionalCost**](AdditionalCost.md) | Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). | [optional] **CatalogItemID** | Pointer to **int32** | The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). | [optional] diff --git a/docs/CodeGeneratorSettings.md b/docs/CodeGeneratorSettings.md index 5700aa44..0e35beaa 100644 --- a/docs/CodeGeneratorSettings.md +++ b/docs/CodeGeneratorSettings.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. | -**CouponPattern** | Pointer to **string** | The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | +**CouponPattern** | Pointer to **string** | The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. | ## Methods diff --git a/docs/Coupon.md b/docs/Coupon.md index bb09d414..f0d2ae09 100644 --- a/docs/Coupon.md +++ b/docs/Coupon.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **UsageCounter** | Pointer to **int32** | The number of times the coupon has been successfully redeemed. | **DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] diff --git a/docs/CouponConstraints.md b/docs/CouponConstraints.md index 0b3c241f..a4cdd238 100644 --- a/docs/CouponConstraints.md +++ b/docs/CouponConstraints.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] ## Methods diff --git a/docs/CouponCreationJob.md b/docs/CouponCreationJob.md index 6a5e8dae..7a9e5711 100644 --- a/docs/CouponCreationJob.md +++ b/docs/CouponCreationJob.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons. | diff --git a/docs/CouponDeletionFilters.md b/docs/CouponDeletionFilters.md new file mode 100644 index 00000000..e80345d1 --- /dev/null +++ b/docs/CouponDeletionFilters.md @@ -0,0 +1,377 @@ +# CouponDeletionFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBefore** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] +**CreatedAfter** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] +**StartsAfter** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] +**StartsBefore** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] +**Valid** | Pointer to **string** | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future. | [optional] +**Usable** | Pointer to **bool** | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | [optional] +**Redeemed** | Pointer to **bool** | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. **Note:** This field cannot be used in conjunction with the `usable` query parameter. | [optional] +**RecipientIntegrationId** | Pointer to **string** | Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. | [optional] +**ExactMatch** | Pointer to **bool** | Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false] +**Value** | Pointer to **string** | Filter results by the coupon code | [optional] [default to false] +**BatchId** | Pointer to **string** | Filter results by batches of coupons | [optional] +**ReferralId** | Pointer to **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | [optional] +**ExpiresAfter** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] +**ExpiresBefore** | Pointer to [**time.Time**](time.Time.md) | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional] + +## Methods + +### GetCreatedBefore + +`func (o *CouponDeletionFilters) GetCreatedBefore() time.Time` + +GetCreatedBefore returns the CreatedBefore field if non-nil, zero value otherwise. + +### GetCreatedBeforeOk + +`func (o *CouponDeletionFilters) GetCreatedBeforeOk() (time.Time, bool)` + +GetCreatedBeforeOk returns a tuple with the CreatedBefore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBefore + +`func (o *CouponDeletionFilters) HasCreatedBefore() bool` + +HasCreatedBefore returns a boolean if a field has been set. + +### SetCreatedBefore + +`func (o *CouponDeletionFilters) SetCreatedBefore(v time.Time)` + +SetCreatedBefore gets a reference to the given time.Time and assigns it to the CreatedBefore field. + +### GetCreatedAfter + +`func (o *CouponDeletionFilters) GetCreatedAfter() time.Time` + +GetCreatedAfter returns the CreatedAfter field if non-nil, zero value otherwise. + +### GetCreatedAfterOk + +`func (o *CouponDeletionFilters) GetCreatedAfterOk() (time.Time, bool)` + +GetCreatedAfterOk returns a tuple with the CreatedAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedAfter + +`func (o *CouponDeletionFilters) HasCreatedAfter() bool` + +HasCreatedAfter returns a boolean if a field has been set. + +### SetCreatedAfter + +`func (o *CouponDeletionFilters) SetCreatedAfter(v time.Time)` + +SetCreatedAfter gets a reference to the given time.Time and assigns it to the CreatedAfter field. + +### GetStartsAfter + +`func (o *CouponDeletionFilters) GetStartsAfter() time.Time` + +GetStartsAfter returns the StartsAfter field if non-nil, zero value otherwise. + +### GetStartsAfterOk + +`func (o *CouponDeletionFilters) GetStartsAfterOk() (time.Time, bool)` + +GetStartsAfterOk returns a tuple with the StartsAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartsAfter + +`func (o *CouponDeletionFilters) HasStartsAfter() bool` + +HasStartsAfter returns a boolean if a field has been set. + +### SetStartsAfter + +`func (o *CouponDeletionFilters) SetStartsAfter(v time.Time)` + +SetStartsAfter gets a reference to the given time.Time and assigns it to the StartsAfter field. + +### GetStartsBefore + +`func (o *CouponDeletionFilters) GetStartsBefore() time.Time` + +GetStartsBefore returns the StartsBefore field if non-nil, zero value otherwise. + +### GetStartsBeforeOk + +`func (o *CouponDeletionFilters) GetStartsBeforeOk() (time.Time, bool)` + +GetStartsBeforeOk returns a tuple with the StartsBefore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartsBefore + +`func (o *CouponDeletionFilters) HasStartsBefore() bool` + +HasStartsBefore returns a boolean if a field has been set. + +### SetStartsBefore + +`func (o *CouponDeletionFilters) SetStartsBefore(v time.Time)` + +SetStartsBefore gets a reference to the given time.Time and assigns it to the StartsBefore field. + +### GetValid + +`func (o *CouponDeletionFilters) GetValid() string` + +GetValid returns the Valid field if non-nil, zero value otherwise. + +### GetValidOk + +`func (o *CouponDeletionFilters) GetValidOk() (string, bool)` + +GetValidOk returns a tuple with the Valid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValid + +`func (o *CouponDeletionFilters) HasValid() bool` + +HasValid returns a boolean if a field has been set. + +### SetValid + +`func (o *CouponDeletionFilters) SetValid(v string)` + +SetValid gets a reference to the given string and assigns it to the Valid field. + +### GetUsable + +`func (o *CouponDeletionFilters) GetUsable() bool` + +GetUsable returns the Usable field if non-nil, zero value otherwise. + +### GetUsableOk + +`func (o *CouponDeletionFilters) GetUsableOk() (bool, bool)` + +GetUsableOk returns a tuple with the Usable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUsable + +`func (o *CouponDeletionFilters) HasUsable() bool` + +HasUsable returns a boolean if a field has been set. + +### SetUsable + +`func (o *CouponDeletionFilters) SetUsable(v bool)` + +SetUsable gets a reference to the given bool and assigns it to the Usable field. + +### GetRedeemed + +`func (o *CouponDeletionFilters) GetRedeemed() bool` + +GetRedeemed returns the Redeemed field if non-nil, zero value otherwise. + +### GetRedeemedOk + +`func (o *CouponDeletionFilters) GetRedeemedOk() (bool, bool)` + +GetRedeemedOk returns a tuple with the Redeemed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRedeemed + +`func (o *CouponDeletionFilters) HasRedeemed() bool` + +HasRedeemed returns a boolean if a field has been set. + +### SetRedeemed + +`func (o *CouponDeletionFilters) SetRedeemed(v bool)` + +SetRedeemed gets a reference to the given bool and assigns it to the Redeemed field. + +### GetRecipientIntegrationId + +`func (o *CouponDeletionFilters) GetRecipientIntegrationId() string` + +GetRecipientIntegrationId returns the RecipientIntegrationId field if non-nil, zero value otherwise. + +### GetRecipientIntegrationIdOk + +`func (o *CouponDeletionFilters) GetRecipientIntegrationIdOk() (string, bool)` + +GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRecipientIntegrationId + +`func (o *CouponDeletionFilters) HasRecipientIntegrationId() bool` + +HasRecipientIntegrationId returns a boolean if a field has been set. + +### SetRecipientIntegrationId + +`func (o *CouponDeletionFilters) SetRecipientIntegrationId(v string)` + +SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. + +### GetExactMatch + +`func (o *CouponDeletionFilters) GetExactMatch() bool` + +GetExactMatch returns the ExactMatch field if non-nil, zero value otherwise. + +### GetExactMatchOk + +`func (o *CouponDeletionFilters) GetExactMatchOk() (bool, bool)` + +GetExactMatchOk returns a tuple with the ExactMatch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExactMatch + +`func (o *CouponDeletionFilters) HasExactMatch() bool` + +HasExactMatch returns a boolean if a field has been set. + +### SetExactMatch + +`func (o *CouponDeletionFilters) SetExactMatch(v bool)` + +SetExactMatch gets a reference to the given bool and assigns it to the ExactMatch field. + +### GetValue + +`func (o *CouponDeletionFilters) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *CouponDeletionFilters) GetValueOk() (string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *CouponDeletionFilters) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *CouponDeletionFilters) SetValue(v string)` + +SetValue gets a reference to the given string and assigns it to the Value field. + +### GetBatchId + +`func (o *CouponDeletionFilters) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *CouponDeletionFilters) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *CouponDeletionFilters) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *CouponDeletionFilters) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + +### GetReferralId + +`func (o *CouponDeletionFilters) GetReferralId() int32` + +GetReferralId returns the ReferralId field if non-nil, zero value otherwise. + +### GetReferralIdOk + +`func (o *CouponDeletionFilters) GetReferralIdOk() (int32, bool)` + +GetReferralIdOk returns a tuple with the ReferralId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralId + +`func (o *CouponDeletionFilters) HasReferralId() bool` + +HasReferralId returns a boolean if a field has been set. + +### SetReferralId + +`func (o *CouponDeletionFilters) SetReferralId(v int32)` + +SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. + +### GetExpiresAfter + +`func (o *CouponDeletionFilters) GetExpiresAfter() time.Time` + +GetExpiresAfter returns the ExpiresAfter field if non-nil, zero value otherwise. + +### GetExpiresAfterOk + +`func (o *CouponDeletionFilters) GetExpiresAfterOk() (time.Time, bool)` + +GetExpiresAfterOk returns a tuple with the ExpiresAfter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiresAfter + +`func (o *CouponDeletionFilters) HasExpiresAfter() bool` + +HasExpiresAfter returns a boolean if a field has been set. + +### SetExpiresAfter + +`func (o *CouponDeletionFilters) SetExpiresAfter(v time.Time)` + +SetExpiresAfter gets a reference to the given time.Time and assigns it to the ExpiresAfter field. + +### GetExpiresBefore + +`func (o *CouponDeletionFilters) GetExpiresBefore() time.Time` + +GetExpiresBefore returns the ExpiresBefore field if non-nil, zero value otherwise. + +### GetExpiresBeforeOk + +`func (o *CouponDeletionFilters) GetExpiresBeforeOk() (time.Time, bool)` + +GetExpiresBeforeOk returns a tuple with the ExpiresBefore field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiresBefore + +`func (o *CouponDeletionFilters) HasExpiresBefore() bool` + +HasExpiresBefore returns a boolean if a field has been set. + +### SetExpiresBefore + +`func (o *CouponDeletionFilters) SetExpiresBefore(v time.Time)` + +SetExpiresBefore gets a reference to the given time.Time and assigns it to the ExpiresBefore field. + + +[[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/CouponDeletionJob.md b/docs/CouponDeletionJob.md new file mode 100644 index 00000000..f91402c5 --- /dev/null +++ b/docs/CouponDeletionJob.md @@ -0,0 +1,325 @@ +# CouponDeletionJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | Internal ID of this entity. | +**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | +**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | +**AccountId** | Pointer to **int32** | The ID of the account that owns this entity. | +**Filters** | Pointer to [**CouponDeletionFilters**](CouponDeletionFilters.md) | | +**Status** | Pointer to **string** | The current status of this request. Possible values: - `not_ready` - `pending` - `completed` - `failed` | +**DeletedAmount** | Pointer to **int32** | The number of coupon codes that were already deleted for this request. | [optional] +**FailCount** | Pointer to **int32** | The number of times this job failed. | +**Errors** | Pointer to **[]string** | An array of individual problems encountered during the request. | +**CreatedBy** | Pointer to **int32** | ID of the user who created this effect. | +**Communicated** | Pointer to **bool** | Indicates whether the user that created this job was notified of its final state. | +**CampaignIDs** | Pointer to **[]int32** | | [optional] + +## Methods + +### GetId + +`func (o *CouponDeletionJob) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CouponDeletionJob) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *CouponDeletionJob) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *CouponDeletionJob) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetCreated + +`func (o *CouponDeletionJob) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CouponDeletionJob) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *CouponDeletionJob) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *CouponDeletionJob) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetApplicationId + +`func (o *CouponDeletionJob) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *CouponDeletionJob) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *CouponDeletionJob) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *CouponDeletionJob) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetAccountId + +`func (o *CouponDeletionJob) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *CouponDeletionJob) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *CouponDeletionJob) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *CouponDeletionJob) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetFilters + +`func (o *CouponDeletionJob) GetFilters() CouponDeletionFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *CouponDeletionJob) GetFiltersOk() (CouponDeletionFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilters + +`func (o *CouponDeletionJob) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFilters + +`func (o *CouponDeletionJob) SetFilters(v CouponDeletionFilters)` + +SetFilters gets a reference to the given CouponDeletionFilters and assigns it to the Filters field. + +### GetStatus + +`func (o *CouponDeletionJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *CouponDeletionJob) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *CouponDeletionJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *CouponDeletionJob) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + +### GetDeletedAmount + +`func (o *CouponDeletionJob) GetDeletedAmount() int32` + +GetDeletedAmount returns the DeletedAmount field if non-nil, zero value otherwise. + +### GetDeletedAmountOk + +`func (o *CouponDeletionJob) GetDeletedAmountOk() (int32, bool)` + +GetDeletedAmountOk returns a tuple with the DeletedAmount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDeletedAmount + +`func (o *CouponDeletionJob) HasDeletedAmount() bool` + +HasDeletedAmount returns a boolean if a field has been set. + +### SetDeletedAmount + +`func (o *CouponDeletionJob) SetDeletedAmount(v int32)` + +SetDeletedAmount gets a reference to the given int32 and assigns it to the DeletedAmount field. + +### GetFailCount + +`func (o *CouponDeletionJob) GetFailCount() int32` + +GetFailCount returns the FailCount field if non-nil, zero value otherwise. + +### GetFailCountOk + +`func (o *CouponDeletionJob) GetFailCountOk() (int32, bool)` + +GetFailCountOk returns a tuple with the FailCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFailCount + +`func (o *CouponDeletionJob) HasFailCount() bool` + +HasFailCount returns a boolean if a field has been set. + +### SetFailCount + +`func (o *CouponDeletionJob) SetFailCount(v int32)` + +SetFailCount gets a reference to the given int32 and assigns it to the FailCount field. + +### GetErrors + +`func (o *CouponDeletionJob) GetErrors() []string` + +GetErrors returns the Errors field if non-nil, zero value otherwise. + +### GetErrorsOk + +`func (o *CouponDeletionJob) GetErrorsOk() ([]string, bool)` + +GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasErrors + +`func (o *CouponDeletionJob) HasErrors() bool` + +HasErrors returns a boolean if a field has been set. + +### SetErrors + +`func (o *CouponDeletionJob) SetErrors(v []string)` + +SetErrors gets a reference to the given []string and assigns it to the Errors field. + +### GetCreatedBy + +`func (o *CouponDeletionJob) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *CouponDeletionJob) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *CouponDeletionJob) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *CouponDeletionJob) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetCommunicated + +`func (o *CouponDeletionJob) GetCommunicated() bool` + +GetCommunicated returns the Communicated field if non-nil, zero value otherwise. + +### GetCommunicatedOk + +`func (o *CouponDeletionJob) GetCommunicatedOk() (bool, bool)` + +GetCommunicatedOk returns a tuple with the Communicated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCommunicated + +`func (o *CouponDeletionJob) HasCommunicated() bool` + +HasCommunicated returns a boolean if a field has been set. + +### SetCommunicated + +`func (o *CouponDeletionJob) SetCommunicated(v bool)` + +SetCommunicated gets a reference to the given bool and assigns it to the Communicated field. + +### GetCampaignIDs + +`func (o *CouponDeletionJob) GetCampaignIDs() []int32` + +GetCampaignIDs returns the CampaignIDs field if non-nil, zero value otherwise. + +### GetCampaignIDsOk + +`func (o *CouponDeletionJob) GetCampaignIDsOk() ([]int32, bool)` + +GetCampaignIDsOk returns a tuple with the CampaignIDs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignIDs + +`func (o *CouponDeletionJob) HasCampaignIDs() bool` + +HasCampaignIDs returns a boolean if a field has been set. + +### SetCampaignIDs + +`func (o *CouponDeletionJob) SetCampaignIDs(v []int32)` + +SetCampaignIDs gets a reference to the given []int32 and assigns it to the CampaignIDs field. + + +[[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/CustomerSessionV2.md b/docs/CustomerSessionV2.md index 0fc81292..b875fb57 100644 --- a/docs/CustomerSessionV2.md +++ b/docs/CustomerSessionV2.md @@ -11,8 +11,8 @@ Name | Type | Description | Notes **ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | **StoreIntegrationId** | Pointer to **string** | The integration ID of the store. You choose this ID when you create a store. | [optional] **EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] -**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] -**ReferralCode** | Pointer to **string** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] +**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely. | [optional] +**ReferralCode** | Pointer to **string** | Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely. | [optional] **LoyaltyCards** | Pointer to **[]string** | Identifier of a loyalty card. | [optional] **State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [default to STATE_OPEN] **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | diff --git a/docs/Effect.md b/docs/Effect.md index 2444932b..3a24c15a 100644 --- a/docs/Effect.md +++ b/docs/Effect.md @@ -12,6 +12,10 @@ Name | Type | Description | Notes **TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] **TriggeredForCatalogItem** | Pointer to **int32** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] **ConditionIndex** | Pointer to **int32** | The index of the condition that was triggered. | [optional] +**EvaluationGroupID** | Pointer to **int32** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**EvaluationGroupMode** | Pointer to **string** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**CampaignRevisionId** | Pointer to **int32** | The revision ID of the campaign that was used when triggering the effect. | [optional] +**CampaignRevisionVersionId** | Pointer to **int32** | The revision version ID of the campaign that was used when triggering the effect. | [optional] **Props** | Pointer to [**map[string]interface{}**](.md) | The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | ## Methods @@ -216,6 +220,106 @@ HasConditionIndex returns a boolean if a field has been set. SetConditionIndex gets a reference to the given int32 and assigns it to the ConditionIndex field. +### GetEvaluationGroupID + +`func (o *Effect) GetEvaluationGroupID() int32` + +GetEvaluationGroupID returns the EvaluationGroupID field if non-nil, zero value otherwise. + +### GetEvaluationGroupIDOk + +`func (o *Effect) GetEvaluationGroupIDOk() (int32, bool)` + +GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupID + +`func (o *Effect) HasEvaluationGroupID() bool` + +HasEvaluationGroupID returns a boolean if a field has been set. + +### SetEvaluationGroupID + +`func (o *Effect) SetEvaluationGroupID(v int32)` + +SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. + +### GetEvaluationGroupMode + +`func (o *Effect) GetEvaluationGroupMode() string` + +GetEvaluationGroupMode returns the EvaluationGroupMode field if non-nil, zero value otherwise. + +### GetEvaluationGroupModeOk + +`func (o *Effect) GetEvaluationGroupModeOk() (string, bool)` + +GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupMode + +`func (o *Effect) HasEvaluationGroupMode() bool` + +HasEvaluationGroupMode returns a boolean if a field has been set. + +### SetEvaluationGroupMode + +`func (o *Effect) SetEvaluationGroupMode(v string)` + +SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. + +### GetCampaignRevisionId + +`func (o *Effect) GetCampaignRevisionId() int32` + +GetCampaignRevisionId returns the CampaignRevisionId field if non-nil, zero value otherwise. + +### GetCampaignRevisionIdOk + +`func (o *Effect) GetCampaignRevisionIdOk() (int32, bool)` + +GetCampaignRevisionIdOk returns a tuple with the CampaignRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignRevisionId + +`func (o *Effect) HasCampaignRevisionId() bool` + +HasCampaignRevisionId returns a boolean if a field has been set. + +### SetCampaignRevisionId + +`func (o *Effect) SetCampaignRevisionId(v int32)` + +SetCampaignRevisionId gets a reference to the given int32 and assigns it to the CampaignRevisionId field. + +### GetCampaignRevisionVersionId + +`func (o *Effect) GetCampaignRevisionVersionId() int32` + +GetCampaignRevisionVersionId returns the CampaignRevisionVersionId field if non-nil, zero value otherwise. + +### GetCampaignRevisionVersionIdOk + +`func (o *Effect) GetCampaignRevisionVersionIdOk() (int32, bool)` + +GetCampaignRevisionVersionIdOk returns a tuple with the CampaignRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignRevisionVersionId + +`func (o *Effect) HasCampaignRevisionVersionId() bool` + +HasCampaignRevisionVersionId returns a boolean if a field has been set. + +### SetCampaignRevisionVersionId + +`func (o *Effect) SetCampaignRevisionVersionId(v int32)` + +SetCampaignRevisionVersionId gets a reference to the given int32 and assigns it to the CampaignRevisionVersionId field. + ### GetProps `func (o *Effect) GetProps() map[string]interface{}` diff --git a/docs/EffectEntity.md b/docs/EffectEntity.md index d3283913..f2b09e64 100644 --- a/docs/EffectEntity.md +++ b/docs/EffectEntity.md @@ -12,6 +12,10 @@ Name | Type | Description | Notes **TriggeredByCoupon** | Pointer to **int32** | The ID of the coupon that was being evaluated when this effect was triggered. | [optional] **TriggeredForCatalogItem** | Pointer to **int32** | The ID of the catalog item that was being evaluated when this effect was triggered. | [optional] **ConditionIndex** | Pointer to **int32** | The index of the condition that was triggered. | [optional] +**EvaluationGroupID** | Pointer to **int32** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**EvaluationGroupMode** | Pointer to **string** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**CampaignRevisionId** | Pointer to **int32** | The revision ID of the campaign that was used when triggering the effect. | [optional] +**CampaignRevisionVersionId** | Pointer to **int32** | The revision version ID of the campaign that was used when triggering the effect. | [optional] ## Methods @@ -215,6 +219,106 @@ HasConditionIndex returns a boolean if a field has been set. SetConditionIndex gets a reference to the given int32 and assigns it to the ConditionIndex field. +### GetEvaluationGroupID + +`func (o *EffectEntity) GetEvaluationGroupID() int32` + +GetEvaluationGroupID returns the EvaluationGroupID field if non-nil, zero value otherwise. + +### GetEvaluationGroupIDOk + +`func (o *EffectEntity) GetEvaluationGroupIDOk() (int32, bool)` + +GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupID + +`func (o *EffectEntity) HasEvaluationGroupID() bool` + +HasEvaluationGroupID returns a boolean if a field has been set. + +### SetEvaluationGroupID + +`func (o *EffectEntity) SetEvaluationGroupID(v int32)` + +SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. + +### GetEvaluationGroupMode + +`func (o *EffectEntity) GetEvaluationGroupMode() string` + +GetEvaluationGroupMode returns the EvaluationGroupMode field if non-nil, zero value otherwise. + +### GetEvaluationGroupModeOk + +`func (o *EffectEntity) GetEvaluationGroupModeOk() (string, bool)` + +GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupMode + +`func (o *EffectEntity) HasEvaluationGroupMode() bool` + +HasEvaluationGroupMode returns a boolean if a field has been set. + +### SetEvaluationGroupMode + +`func (o *EffectEntity) SetEvaluationGroupMode(v string)` + +SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. + +### GetCampaignRevisionId + +`func (o *EffectEntity) GetCampaignRevisionId() int32` + +GetCampaignRevisionId returns the CampaignRevisionId field if non-nil, zero value otherwise. + +### GetCampaignRevisionIdOk + +`func (o *EffectEntity) GetCampaignRevisionIdOk() (int32, bool)` + +GetCampaignRevisionIdOk returns a tuple with the CampaignRevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignRevisionId + +`func (o *EffectEntity) HasCampaignRevisionId() bool` + +HasCampaignRevisionId returns a boolean if a field has been set. + +### SetCampaignRevisionId + +`func (o *EffectEntity) SetCampaignRevisionId(v int32)` + +SetCampaignRevisionId gets a reference to the given int32 and assigns it to the CampaignRevisionId field. + +### GetCampaignRevisionVersionId + +`func (o *EffectEntity) GetCampaignRevisionVersionId() int32` + +GetCampaignRevisionVersionId returns the CampaignRevisionVersionId field if non-nil, zero value otherwise. + +### GetCampaignRevisionVersionIdOk + +`func (o *EffectEntity) GetCampaignRevisionVersionIdOk() (int32, bool)` + +GetCampaignRevisionVersionIdOk returns a tuple with the CampaignRevisionVersionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignRevisionVersionId + +`func (o *EffectEntity) HasCampaignRevisionVersionId() bool` + +HasCampaignRevisionVersionId returns a boolean if a field has been set. + +### SetCampaignRevisionVersionId + +`func (o *EffectEntity) SetCampaignRevisionVersionId(v int32)` + +SetCampaignRevisionVersionId gets a reference to the given int32 and assigns it to the CampaignRevisionVersionId field. + [[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/Environment.md b/docs/Environment.md index bb6a5f40..220c621d 100644 --- a/docs/Environment.md +++ b/docs/Environment.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **AdditionalCosts** | Pointer to [**[]AccountAdditionalCost**](AccountAdditionalCost.md) | The additional costs that the application is subscribed to. | [optional] **Audiences** | Pointer to [**[]Audience**](Audience.md) | The audiences contained in the account which the application belongs to. | [optional] **Collections** | Pointer to [**[]Collection**](Collection.md) | The account-level collections that the application is subscribed to. | [optional] +**ApplicationCartItemFilters** | Pointer to [**[]ApplicationCif**](ApplicationCIF.md) | The cart item filters belonging to the Application. | [optional] ## Methods @@ -371,6 +372,31 @@ HasCollections returns a boolean if a field has been set. SetCollections gets a reference to the given []Collection and assigns it to the Collections field. +### GetApplicationCartItemFilters + +`func (o *Environment) GetApplicationCartItemFilters() []ApplicationCif` + +GetApplicationCartItemFilters returns the ApplicationCartItemFilters field if non-nil, zero value otherwise. + +### GetApplicationCartItemFiltersOk + +`func (o *Environment) GetApplicationCartItemFiltersOk() ([]ApplicationCif, bool)` + +GetApplicationCartItemFiltersOk returns a tuple with the ApplicationCartItemFilters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationCartItemFilters + +`func (o *Environment) HasApplicationCartItemFilters() bool` + +HasApplicationCartItemFilters returns a boolean if a field has been set. + +### SetApplicationCartItemFilters + +`func (o *Environment) SetApplicationCartItemFilters(v []ApplicationCif)` + +SetApplicationCartItemFilters gets a reference to the given []ApplicationCif and assigns it to the ApplicationCartItemFilters field. + [[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/Event.md b/docs/Event.md index ffe04163..b00c3061 100644 --- a/docs/Event.md +++ b/docs/Event.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary additional JSON data associated with the event. | **SessionId** | Pointer to **string** | The ID of the session that this event occurred in. | [optional] **Effects** | Pointer to [**[][]interface{}**]([]interface{}.md) | An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | -**LedgerEntries** | Pointer to [**[]LedgerEntry**](LedgerEntry.md) | Ledger entries for the event. | +**LedgerEntries** | Pointer to [**[]LedgerEntry**](LedgerEntry.md) | Ledger entries for the event. | [optional] **Meta** | Pointer to [**Meta**](Meta.md) | | [optional] ## Methods diff --git a/docs/FeedNotification.md b/docs/FeedNotification.md deleted file mode 100644 index 9e591c4d..00000000 --- a/docs/FeedNotification.md +++ /dev/null @@ -1,169 +0,0 @@ -# FeedNotification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Title** | Pointer to **string** | Title of the feed notification. | -**Created** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was created. | -**Updated** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the moment this feed notification was last updated. | -**ArticleUrl** | Pointer to **string** | URL to the feed notification in the help center. | -**Type** | Pointer to **string** | The type of the feed notification. | -**Body** | Pointer to **string** | Body of the feed notification. | - -## Methods - -### GetTitle - -`func (o *FeedNotification) GetTitle() string` - -GetTitle returns the Title field if non-nil, zero value otherwise. - -### GetTitleOk - -`func (o *FeedNotification) GetTitleOk() (string, bool)` - -GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTitle - -`func (o *FeedNotification) HasTitle() bool` - -HasTitle returns a boolean if a field has been set. - -### SetTitle - -`func (o *FeedNotification) SetTitle(v string)` - -SetTitle gets a reference to the given string and assigns it to the Title field. - -### GetCreated - -`func (o *FeedNotification) GetCreated() time.Time` - -GetCreated returns the Created field if non-nil, zero value otherwise. - -### GetCreatedOk - -`func (o *FeedNotification) GetCreatedOk() (time.Time, bool)` - -GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreated - -`func (o *FeedNotification) HasCreated() bool` - -HasCreated returns a boolean if a field has been set. - -### SetCreated - -`func (o *FeedNotification) SetCreated(v time.Time)` - -SetCreated gets a reference to the given time.Time and assigns it to the Created field. - -### GetUpdated - -`func (o *FeedNotification) GetUpdated() time.Time` - -GetUpdated returns the Updated field if non-nil, zero value otherwise. - -### GetUpdatedOk - -`func (o *FeedNotification) GetUpdatedOk() (time.Time, bool)` - -GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUpdated - -`func (o *FeedNotification) HasUpdated() bool` - -HasUpdated returns a boolean if a field has been set. - -### SetUpdated - -`func (o *FeedNotification) SetUpdated(v time.Time)` - -SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. - -### GetArticleUrl - -`func (o *FeedNotification) GetArticleUrl() string` - -GetArticleUrl returns the ArticleUrl field if non-nil, zero value otherwise. - -### GetArticleUrlOk - -`func (o *FeedNotification) GetArticleUrlOk() (string, bool)` - -GetArticleUrlOk returns a tuple with the ArticleUrl field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasArticleUrl - -`func (o *FeedNotification) HasArticleUrl() bool` - -HasArticleUrl returns a boolean if a field has been set. - -### SetArticleUrl - -`func (o *FeedNotification) SetArticleUrl(v string)` - -SetArticleUrl gets a reference to the given string and assigns it to the ArticleUrl field. - -### GetType - -`func (o *FeedNotification) GetType() string` - -GetType returns the Type field if non-nil, zero value otherwise. - -### GetTypeOk - -`func (o *FeedNotification) GetTypeOk() (string, bool)` - -GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasType - -`func (o *FeedNotification) HasType() bool` - -HasType returns a boolean if a field has been set. - -### SetType - -`func (o *FeedNotification) SetType(v string)` - -SetType gets a reference to the given string and assigns it to the Type field. - -### GetBody - -`func (o *FeedNotification) GetBody() string` - -GetBody returns the Body field if non-nil, zero value otherwise. - -### GetBodyOk - -`func (o *FeedNotification) GetBodyOk() (string, bool)` - -GetBodyOk returns a tuple with the Body field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasBody - -`func (o *FeedNotification) HasBody() bool` - -HasBody returns a boolean if a field has been set. - -### SetBody - -`func (o *FeedNotification) SetBody(v string)` - -SetBody gets a reference to the given string and assigns it to the Body field. - - -[[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/FrontendState.md b/docs/FrontendState.md deleted file mode 100644 index 834b1bd3..00000000 --- a/docs/FrontendState.md +++ /dev/null @@ -1,11 +0,0 @@ -# FrontendState - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - - -[[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/GenerateCampaignDescription.md b/docs/GenerateCampaignDescription.md new file mode 100644 index 00000000..f0d4b15a --- /dev/null +++ b/docs/GenerateCampaignDescription.md @@ -0,0 +1,65 @@ +# GenerateCampaignDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignID** | Pointer to **int32** | ID of the campaign. | +**Currency** | Pointer to **string** | Currency for the campaign. | + +## Methods + +### GetCampaignID + +`func (o *GenerateCampaignDescription) GetCampaignID() int32` + +GetCampaignID returns the CampaignID field if non-nil, zero value otherwise. + +### GetCampaignIDOk + +`func (o *GenerateCampaignDescription) GetCampaignIDOk() (int32, bool)` + +GetCampaignIDOk returns a tuple with the CampaignID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignID + +`func (o *GenerateCampaignDescription) HasCampaignID() bool` + +HasCampaignID returns a boolean if a field has been set. + +### SetCampaignID + +`func (o *GenerateCampaignDescription) SetCampaignID(v int32)` + +SetCampaignID gets a reference to the given int32 and assigns it to the CampaignID field. + +### GetCurrency + +`func (o *GenerateCampaignDescription) GetCurrency() string` + +GetCurrency returns the Currency field if non-nil, zero value otherwise. + +### GetCurrencyOk + +`func (o *GenerateCampaignDescription) GetCurrencyOk() (string, bool)` + +GetCurrencyOk returns a tuple with the Currency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrency + +`func (o *GenerateCampaignDescription) HasCurrency() bool` + +HasCurrency returns a boolean if a field has been set. + +### SetCurrency + +`func (o *GenerateCampaignDescription) SetCurrency(v string)` + +SetCurrency gets a reference to the given string and assigns it to the Currency field. + + +[[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/GenerateCampaignTags.md b/docs/GenerateCampaignTags.md new file mode 100644 index 00000000..8ff662b1 --- /dev/null +++ b/docs/GenerateCampaignTags.md @@ -0,0 +1,39 @@ +# GenerateCampaignTags + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignID** | Pointer to **int32** | ID of the campaign. | + +## Methods + +### GetCampaignID + +`func (o *GenerateCampaignTags) GetCampaignID() int32` + +GetCampaignID returns the CampaignID field if non-nil, zero value otherwise. + +### GetCampaignIDOk + +`func (o *GenerateCampaignTags) GetCampaignIDOk() (int32, bool)` + +GetCampaignIDOk returns a tuple with the CampaignID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignID + +`func (o *GenerateCampaignTags) HasCampaignID() bool` + +HasCampaignID returns a boolean if a field has been set. + +### SetCampaignID + +`func (o *GenerateCampaignTags) SetCampaignID(v int32)` + +SetCampaignID gets a reference to the given int32 and assigns it to the CampaignID field. + + +[[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/GenerateItemFilterDescription.md b/docs/GenerateItemFilterDescription.md new file mode 100644 index 00000000..a26ab864 --- /dev/null +++ b/docs/GenerateItemFilterDescription.md @@ -0,0 +1,39 @@ +# GenerateItemFilterDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ItemFilter** | Pointer to [**[][]interface{}**]([][]interface{}.md) | An array of item filter Talang expressions. | + +## Methods + +### GetItemFilter + +`func (o *GenerateItemFilterDescription) GetItemFilter() [][]interface{}` + +GetItemFilter returns the ItemFilter field if non-nil, zero value otherwise. + +### GetItemFilterOk + +`func (o *GenerateItemFilterDescription) GetItemFilterOk() ([][]interface{}, bool)` + +GetItemFilterOk returns a tuple with the ItemFilter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasItemFilter + +`func (o *GenerateItemFilterDescription) HasItemFilter() bool` + +HasItemFilter returns a boolean if a field has been set. + +### SetItemFilter + +`func (o *GenerateItemFilterDescription) SetItemFilter(v [][]interface{})` + +SetItemFilter gets a reference to the given [][]interface{} and assigns it to the ItemFilter field. + + +[[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/GenerateLoyaltyCard.md b/docs/GenerateLoyaltyCard.md new file mode 100644 index 00000000..9eaf29da --- /dev/null +++ b/docs/GenerateLoyaltyCard.md @@ -0,0 +1,65 @@ +# GenerateLoyaltyCard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | Status of the loyalty card. | [optional] [default to STATUS_ACTIVE] +**CustomerProfileIds** | Pointer to **[]string** | Integration IDs of the customer profiles linked to the card. | [optional] + +## Methods + +### GetStatus + +`func (o *GenerateLoyaltyCard) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *GenerateLoyaltyCard) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *GenerateLoyaltyCard) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *GenerateLoyaltyCard) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + +### GetCustomerProfileIds + +`func (o *GenerateLoyaltyCard) GetCustomerProfileIds() []string` + +GetCustomerProfileIds returns the CustomerProfileIds field if non-nil, zero value otherwise. + +### GetCustomerProfileIdsOk + +`func (o *GenerateLoyaltyCard) GetCustomerProfileIdsOk() ([]string, bool)` + +GetCustomerProfileIdsOk returns a tuple with the CustomerProfileIds field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCustomerProfileIds + +`func (o *GenerateLoyaltyCard) HasCustomerProfileIds() bool` + +HasCustomerProfileIds returns a boolean if a field has been set. + +### SetCustomerProfileIds + +`func (o *GenerateLoyaltyCard) SetCustomerProfileIds(v []string)` + +SetCustomerProfileIds gets a reference to the given []string and assigns it to the CustomerProfileIds field. + + +[[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/GenerateRuleTitle.md b/docs/GenerateRuleTitle.md new file mode 100644 index 00000000..d769e5ab --- /dev/null +++ b/docs/GenerateRuleTitle.md @@ -0,0 +1,65 @@ +# GenerateRuleTitle + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rule** | Pointer to [**GenerateRuleTitleRule**](GenerateRuleTitle_rule.md) | | +**Currency** | Pointer to **string** | Currency for the campaign. | + +## Methods + +### GetRule + +`func (o *GenerateRuleTitle) GetRule() GenerateRuleTitleRule` + +GetRule returns the Rule field if non-nil, zero value otherwise. + +### GetRuleOk + +`func (o *GenerateRuleTitle) GetRuleOk() (GenerateRuleTitleRule, bool)` + +GetRuleOk returns a tuple with the Rule field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRule + +`func (o *GenerateRuleTitle) HasRule() bool` + +HasRule returns a boolean if a field has been set. + +### SetRule + +`func (o *GenerateRuleTitle) SetRule(v GenerateRuleTitleRule)` + +SetRule gets a reference to the given GenerateRuleTitleRule and assigns it to the Rule field. + +### GetCurrency + +`func (o *GenerateRuleTitle) GetCurrency() string` + +GetCurrency returns the Currency field if non-nil, zero value otherwise. + +### GetCurrencyOk + +`func (o *GenerateRuleTitle) GetCurrencyOk() (string, bool)` + +GetCurrencyOk returns a tuple with the Currency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrency + +`func (o *GenerateRuleTitle) HasCurrency() bool` + +HasCurrency returns a boolean if a field has been set. + +### SetCurrency + +`func (o *GenerateRuleTitle) SetCurrency(v string)` + +SetCurrency gets a reference to the given string and assigns it to the Currency field. + + +[[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/GenerateRuleTitleRule.md b/docs/GenerateRuleTitleRule.md new file mode 100644 index 00000000..07eca417 --- /dev/null +++ b/docs/GenerateRuleTitleRule.md @@ -0,0 +1,65 @@ +# GenerateRuleTitleRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Effects** | Pointer to [**[][]interface{}**]([][]interface{}.md) | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | [optional] +**Condition** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated in the context of the given event. | [optional] + +## Methods + +### GetEffects + +`func (o *GenerateRuleTitleRule) GetEffects() [][]interface{}` + +GetEffects returns the Effects field if non-nil, zero value otherwise. + +### GetEffectsOk + +`func (o *GenerateRuleTitleRule) GetEffectsOk() ([][]interface{}, bool)` + +GetEffectsOk returns a tuple with the Effects field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEffects + +`func (o *GenerateRuleTitleRule) HasEffects() bool` + +HasEffects returns a boolean if a field has been set. + +### SetEffects + +`func (o *GenerateRuleTitleRule) SetEffects(v [][]interface{})` + +SetEffects gets a reference to the given [][]interface{} and assigns it to the Effects field. + +### GetCondition + +`func (o *GenerateRuleTitleRule) GetCondition() []interface{}` + +GetCondition returns the Condition field if non-nil, zero value otherwise. + +### GetConditionOk + +`func (o *GenerateRuleTitleRule) GetConditionOk() ([]interface{}, bool)` + +GetConditionOk returns a tuple with the Condition field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCondition + +`func (o *GenerateRuleTitleRule) HasCondition() bool` + +HasCondition returns a boolean if a field has been set. + +### SetCondition + +`func (o *GenerateRuleTitleRule) SetCondition(v []interface{})` + +SetCondition gets a reference to the given []interface{} and assigns it to the Condition field. + + +[[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/IncreaseAchievementProgressEffectProps.md b/docs/IncreaseAchievementProgressEffectProps.md index 953287e9..456662d8 100644 --- a/docs/IncreaseAchievementProgressEffectProps.md +++ b/docs/IncreaseAchievementProgressEffectProps.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **ProgressTrackerId** | Pointer to **int32** | The internal ID of the achievement progress tracker. | [optional] **Delta** | Pointer to **float32** | The value by which the customer's current progress in the achievement is increased. | **Value** | Pointer to **float32** | The current progress of the customer in the achievement. | -**Target** | Pointer to **float32** | The required number of actions or the transactional milestone to complete the achievement. | +**Target** | Pointer to **float32** | The target value to complete the achievement. | **IsJustCompleted** | Pointer to **bool** | Indicates if the customer has completed the achievement in the current session. | ## Methods diff --git a/docs/IntegrationApi.md b/docs/IntegrationApi.md index 58c8a7f6..f5705653 100644 --- a/docs/IntegrationApi.md +++ b/docs/IntegrationApi.md @@ -12,6 +12,7 @@ Method | HTTP request | Description [**DeleteAudienceV2**](IntegrationApi.md#DeleteAudienceV2) | **Delete** /v2/audiences/{audienceId} | Delete audience [**DeleteCouponReservation**](IntegrationApi.md#DeleteCouponReservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations [**DeleteCustomerData**](IntegrationApi.md#DeleteCustomerData) | **Delete** /v1/customer_data/{integrationId} | Delete customer's personal data +[**GenerateLoyaltyCard**](IntegrationApi.md#GenerateLoyaltyCard) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card [**GetCustomerInventory**](IntegrationApi.md#GetCustomerInventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List customer data [**GetCustomerSession**](IntegrationApi.md#GetCustomerSession) | **Get** /v2/customer_sessions/{customerSessionId} | Get customer session [**GetLoyaltyBalances**](IntegrationApi.md#GetLoyaltyBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points @@ -370,6 +371,50 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## GenerateLoyaltyCard + +> LoyaltyCard GenerateLoyaltyCard(ctx, loyaltyProgramId).Body(body).Execute() + +Generate loyalty card + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGenerateLoyaltyCardRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**GenerateLoyaltyCard**](GenerateLoyaltyCard.md) | body | + +### Return type + +[**LoyaltyCard**](LoyaltyCard.md) + +### Authorization + +[api_key_v1](../README.md#api_key_v1) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## GetCustomerInventory > CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).Achievements(achievements).Execute() @@ -464,7 +509,7 @@ Name | Type | Description | Notes ## GetLoyaltyBalances -> LoyaltyBalances GetLoyaltyBalances(ctx, loyaltyProgramId, integrationId).EndDate(endDate).SubledgerId(subledgerId).Execute() +> LoyaltyBalancesWithTiers GetLoyaltyBalances(ctx, loyaltyProgramId, integrationId).EndDate(endDate).SubledgerId(subledgerId).IncludeTiers(includeTiers).IncludeProjectedTier(includeProjectedTier).Execute() Get customer's loyalty points @@ -490,10 +535,12 @@ Name | Type | Description | Notes **endDate** | **time.Time** | Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | **subledgerId** | **string** | The ID of the subledger by which we filter the data. | + **includeTiers** | **bool** | Indicates whether tier information is included in the response. When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. | [default to false] + **includeProjectedTier** | **bool** | Indicates whether the customer's projected tier information is included in the response. When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. **Note** We recommend filtering by `subledgerId` for better performance. | [default to false] ### Return type -[**LoyaltyBalances**](LoyaltyBalances.md) +[**LoyaltyBalancesWithTiers**](LoyaltyBalancesWithTiers.md) ### Authorization @@ -1256,7 +1303,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**IntegrationRequest**](IntegrationRequest.md) | body | - **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will **only** consider the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | + **dry** | **bool** | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. [See the docs](https://docs.talon.one/docs/dev/integration-api/dry-requests). | **now** | **time.Time** | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, [scheduled campaigns](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-schedule)). **Note:** - It must be an RFC3339 timestamp string. - It can **only** be a date in the future. - It can **only** be used if the `dry` parameter in the query is set to `true`. | ### Return type diff --git a/docs/IntegrationCoupon.md b/docs/IntegrationCoupon.md index 165e6879..60f6f05b 100644 --- a/docs/IntegrationCoupon.md +++ b/docs/IntegrationCoupon.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **UsageCounter** | Pointer to **int32** | The number of times the coupon has been successfully redeemed. | **DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] diff --git a/docs/InventoryCoupon.md b/docs/InventoryCoupon.md index 24fa4843..4ad0d321 100644 --- a/docs/InventoryCoupon.md +++ b/docs/InventoryCoupon.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **UsageCounter** | Pointer to **int32** | The number of times the coupon has been successfully redeemed. | **DiscountCounter** | Pointer to **float32** | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] diff --git a/docs/InventoryReferral.md b/docs/InventoryReferral.md index 375c0a21..04e270e3 100644 --- a/docs/InventoryReferral.md +++ b/docs/InventoryReferral.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Id** | Pointer to **int32** | Internal ID of this entity. | **Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | **CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | diff --git a/docs/LoyaltyBalanceWithTier.md b/docs/LoyaltyBalanceWithTier.md new file mode 100644 index 00000000..166fbae5 --- /dev/null +++ b/docs/LoyaltyBalanceWithTier.md @@ -0,0 +1,221 @@ +# LoyaltyBalanceWithTier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActivePoints** | Pointer to **float32** | Total amount of points awarded to this customer and available to spend. | [optional] +**PendingPoints** | Pointer to **float32** | Total amount of points awarded to this customer but not available until their start date. | [optional] +**SpentPoints** | Pointer to **float32** | Total amount of points already spent by this customer. | [optional] +**ExpiredPoints** | Pointer to **float32** | Total amount of points awarded but never redeemed. They cannot be used anymore. | [optional] +**CurrentTier** | Pointer to [**Tier**](Tier.md) | | [optional] +**ProjectedTier** | Pointer to [**ProjectedTier**](ProjectedTier.md) | | [optional] +**PointsToNextTier** | Pointer to **float32** | The number of points required to move up a tier. | [optional] +**NextTierName** | Pointer to **string** | The name of the tier consecutive to the current tier. | [optional] + +## Methods + +### GetActivePoints + +`func (o *LoyaltyBalanceWithTier) GetActivePoints() float32` + +GetActivePoints returns the ActivePoints field if non-nil, zero value otherwise. + +### GetActivePointsOk + +`func (o *LoyaltyBalanceWithTier) GetActivePointsOk() (float32, bool)` + +GetActivePointsOk returns a tuple with the ActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivePoints + +`func (o *LoyaltyBalanceWithTier) HasActivePoints() bool` + +HasActivePoints returns a boolean if a field has been set. + +### SetActivePoints + +`func (o *LoyaltyBalanceWithTier) SetActivePoints(v float32)` + +SetActivePoints gets a reference to the given float32 and assigns it to the ActivePoints field. + +### GetPendingPoints + +`func (o *LoyaltyBalanceWithTier) GetPendingPoints() float32` + +GetPendingPoints returns the PendingPoints field if non-nil, zero value otherwise. + +### GetPendingPointsOk + +`func (o *LoyaltyBalanceWithTier) GetPendingPointsOk() (float32, bool)` + +GetPendingPointsOk returns a tuple with the PendingPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPendingPoints + +`func (o *LoyaltyBalanceWithTier) HasPendingPoints() bool` + +HasPendingPoints returns a boolean if a field has been set. + +### SetPendingPoints + +`func (o *LoyaltyBalanceWithTier) SetPendingPoints(v float32)` + +SetPendingPoints gets a reference to the given float32 and assigns it to the PendingPoints field. + +### GetSpentPoints + +`func (o *LoyaltyBalanceWithTier) GetSpentPoints() float32` + +GetSpentPoints returns the SpentPoints field if non-nil, zero value otherwise. + +### GetSpentPointsOk + +`func (o *LoyaltyBalanceWithTier) GetSpentPointsOk() (float32, bool)` + +GetSpentPointsOk returns a tuple with the SpentPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSpentPoints + +`func (o *LoyaltyBalanceWithTier) HasSpentPoints() bool` + +HasSpentPoints returns a boolean if a field has been set. + +### SetSpentPoints + +`func (o *LoyaltyBalanceWithTier) SetSpentPoints(v float32)` + +SetSpentPoints gets a reference to the given float32 and assigns it to the SpentPoints field. + +### GetExpiredPoints + +`func (o *LoyaltyBalanceWithTier) GetExpiredPoints() float32` + +GetExpiredPoints returns the ExpiredPoints field if non-nil, zero value otherwise. + +### GetExpiredPointsOk + +`func (o *LoyaltyBalanceWithTier) GetExpiredPointsOk() (float32, bool)` + +GetExpiredPointsOk returns a tuple with the ExpiredPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpiredPoints + +`func (o *LoyaltyBalanceWithTier) HasExpiredPoints() bool` + +HasExpiredPoints returns a boolean if a field has been set. + +### SetExpiredPoints + +`func (o *LoyaltyBalanceWithTier) SetExpiredPoints(v float32)` + +SetExpiredPoints gets a reference to the given float32 and assigns it to the ExpiredPoints field. + +### GetCurrentTier + +`func (o *LoyaltyBalanceWithTier) GetCurrentTier() Tier` + +GetCurrentTier returns the CurrentTier field if non-nil, zero value otherwise. + +### GetCurrentTierOk + +`func (o *LoyaltyBalanceWithTier) GetCurrentTierOk() (Tier, bool)` + +GetCurrentTierOk returns a tuple with the CurrentTier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentTier + +`func (o *LoyaltyBalanceWithTier) HasCurrentTier() bool` + +HasCurrentTier returns a boolean if a field has been set. + +### SetCurrentTier + +`func (o *LoyaltyBalanceWithTier) SetCurrentTier(v Tier)` + +SetCurrentTier gets a reference to the given Tier and assigns it to the CurrentTier field. + +### GetProjectedTier + +`func (o *LoyaltyBalanceWithTier) GetProjectedTier() ProjectedTier` + +GetProjectedTier returns the ProjectedTier field if non-nil, zero value otherwise. + +### GetProjectedTierOk + +`func (o *LoyaltyBalanceWithTier) GetProjectedTierOk() (ProjectedTier, bool)` + +GetProjectedTierOk returns a tuple with the ProjectedTier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjectedTier + +`func (o *LoyaltyBalanceWithTier) HasProjectedTier() bool` + +HasProjectedTier returns a boolean if a field has been set. + +### SetProjectedTier + +`func (o *LoyaltyBalanceWithTier) SetProjectedTier(v ProjectedTier)` + +SetProjectedTier gets a reference to the given ProjectedTier and assigns it to the ProjectedTier field. + +### GetPointsToNextTier + +`func (o *LoyaltyBalanceWithTier) GetPointsToNextTier() float32` + +GetPointsToNextTier returns the PointsToNextTier field if non-nil, zero value otherwise. + +### GetPointsToNextTierOk + +`func (o *LoyaltyBalanceWithTier) GetPointsToNextTierOk() (float32, bool)` + +GetPointsToNextTierOk returns a tuple with the PointsToNextTier field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPointsToNextTier + +`func (o *LoyaltyBalanceWithTier) HasPointsToNextTier() bool` + +HasPointsToNextTier returns a boolean if a field has been set. + +### SetPointsToNextTier + +`func (o *LoyaltyBalanceWithTier) SetPointsToNextTier(v float32)` + +SetPointsToNextTier gets a reference to the given float32 and assigns it to the PointsToNextTier field. + +### GetNextTierName + +`func (o *LoyaltyBalanceWithTier) GetNextTierName() string` + +GetNextTierName returns the NextTierName field if non-nil, zero value otherwise. + +### GetNextTierNameOk + +`func (o *LoyaltyBalanceWithTier) GetNextTierNameOk() (string, bool)` + +GetNextTierNameOk returns a tuple with the NextTierName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNextTierName + +`func (o *LoyaltyBalanceWithTier) HasNextTierName() bool` + +HasNextTierName returns a boolean if a field has been set. + +### SetNextTierName + +`func (o *LoyaltyBalanceWithTier) SetNextTierName(v string)` + +SetNextTierName gets a reference to the given string and assigns it to the NextTierName field. + + +[[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/LoyaltyBalancesWithTiers.md b/docs/LoyaltyBalancesWithTiers.md new file mode 100644 index 00000000..da54b703 --- /dev/null +++ b/docs/LoyaltyBalancesWithTiers.md @@ -0,0 +1,65 @@ +# LoyaltyBalancesWithTiers + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Balance** | Pointer to [**LoyaltyBalanceWithTier**](LoyaltyBalanceWithTier.md) | | [optional] +**SubledgerBalances** | Pointer to [**map[string]LoyaltyBalanceWithTier**](LoyaltyBalanceWithTier.md) | Map of the loyalty balances of the subledgers of a ledger. | [optional] + +## Methods + +### GetBalance + +`func (o *LoyaltyBalancesWithTiers) GetBalance() LoyaltyBalanceWithTier` + +GetBalance returns the Balance field if non-nil, zero value otherwise. + +### GetBalanceOk + +`func (o *LoyaltyBalancesWithTiers) GetBalanceOk() (LoyaltyBalanceWithTier, bool)` + +GetBalanceOk returns a tuple with the Balance field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBalance + +`func (o *LoyaltyBalancesWithTiers) HasBalance() bool` + +HasBalance returns a boolean if a field has been set. + +### SetBalance + +`func (o *LoyaltyBalancesWithTiers) SetBalance(v LoyaltyBalanceWithTier)` + +SetBalance gets a reference to the given LoyaltyBalanceWithTier and assigns it to the Balance field. + +### GetSubledgerBalances + +`func (o *LoyaltyBalancesWithTiers) GetSubledgerBalances() map[string]LoyaltyBalanceWithTier` + +GetSubledgerBalances returns the SubledgerBalances field if non-nil, zero value otherwise. + +### GetSubledgerBalancesOk + +`func (o *LoyaltyBalancesWithTiers) GetSubledgerBalancesOk() (map[string]LoyaltyBalanceWithTier, bool)` + +GetSubledgerBalancesOk returns a tuple with the SubledgerBalances field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSubledgerBalances + +`func (o *LoyaltyBalancesWithTiers) HasSubledgerBalances() bool` + +HasSubledgerBalances returns a boolean if a field has been set. + +### SetSubledgerBalances + +`func (o *LoyaltyBalancesWithTiers) SetSubledgerBalances(v map[string]LoyaltyBalanceWithTier)` + +SetSubledgerBalances gets a reference to the given map[string]LoyaltyBalanceWithTier and assigns it to the SubledgerBalances field. + + +[[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/LoyaltyCard.md b/docs/LoyaltyCard.md index 3f63238e..0cff8eec 100644 --- a/docs/LoyaltyCard.md +++ b/docs/LoyaltyCard.md @@ -7,7 +7,8 @@ Name | Type | Description | Notes **Id** | Pointer to **int32** | Internal ID of this entity. | **Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **ProgramID** | Pointer to **int32** | The ID of the loyalty program that owns this entity. | -**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'inactive'] | +**Status** | Pointer to **string** | Status of the loyalty card. Can be `active` or `inactive`. | +**BlockReason** | Pointer to **string** | Reason for transferring and blocking the loyalty card. | [optional] **Identifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | **UsersPerCardLimit** | Pointer to **int32** | The max amount of customer profiles that can be linked to the card. 0 means unlimited. | **Profiles** | Pointer to [**[]LoyaltyCardProfileRegistration**](LoyaltyCardProfileRegistration.md) | Integration IDs of the customers profiles linked to the card. | [optional] @@ -16,6 +17,7 @@ Name | Type | Description | Notes **Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update of the loyalty card. | [optional] **OldCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] **NewCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | [optional] +**BatchId** | Pointer to **string** | The ID of the batch in which the loyalty card was created. | [optional] ## Methods @@ -119,6 +121,31 @@ HasStatus returns a boolean if a field has been set. SetStatus gets a reference to the given string and assigns it to the Status field. +### GetBlockReason + +`func (o *LoyaltyCard) GetBlockReason() string` + +GetBlockReason returns the BlockReason field if non-nil, zero value otherwise. + +### GetBlockReasonOk + +`func (o *LoyaltyCard) GetBlockReasonOk() (string, bool)` + +GetBlockReasonOk returns a tuple with the BlockReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBlockReason + +`func (o *LoyaltyCard) HasBlockReason() bool` + +HasBlockReason returns a boolean if a field has been set. + +### SetBlockReason + +`func (o *LoyaltyCard) SetBlockReason(v string)` + +SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. + ### GetIdentifier `func (o *LoyaltyCard) GetIdentifier() string` @@ -319,6 +346,31 @@ HasNewCardIdentifier returns a boolean if a field has been set. SetNewCardIdentifier gets a reference to the given string and assigns it to the NewCardIdentifier field. +### GetBatchId + +`func (o *LoyaltyCard) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *LoyaltyCard) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *LoyaltyCard) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *LoyaltyCard) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + [[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/LoyaltyCardBatch.md b/docs/LoyaltyCardBatch.md new file mode 100644 index 00000000..5c844da9 --- /dev/null +++ b/docs/LoyaltyCardBatch.md @@ -0,0 +1,91 @@ +# LoyaltyCardBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfCards** | Pointer to **int32** | Number of loyalty cards in the batch. | +**BatchId** | Pointer to **string** | ID of the loyalty card batch. | [optional] +**Status** | Pointer to **string** | Status of the loyalty cards in the batch. | [optional] [default to STATUS_ACTIVE] + +## Methods + +### GetNumberOfCards + +`func (o *LoyaltyCardBatch) GetNumberOfCards() int32` + +GetNumberOfCards returns the NumberOfCards field if non-nil, zero value otherwise. + +### GetNumberOfCardsOk + +`func (o *LoyaltyCardBatch) GetNumberOfCardsOk() (int32, bool)` + +GetNumberOfCardsOk returns a tuple with the NumberOfCards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNumberOfCards + +`func (o *LoyaltyCardBatch) HasNumberOfCards() bool` + +HasNumberOfCards returns a boolean if a field has been set. + +### SetNumberOfCards + +`func (o *LoyaltyCardBatch) SetNumberOfCards(v int32)` + +SetNumberOfCards gets a reference to the given int32 and assigns it to the NumberOfCards field. + +### GetBatchId + +`func (o *LoyaltyCardBatch) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *LoyaltyCardBatch) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *LoyaltyCardBatch) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *LoyaltyCardBatch) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + +### GetStatus + +`func (o *LoyaltyCardBatch) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *LoyaltyCardBatch) GetStatusOk() (string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStatus + +`func (o *LoyaltyCardBatch) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### SetStatus + +`func (o *LoyaltyCardBatch) SetStatus(v string)` + +SetStatus gets a reference to the given string and assigns it to the Status field. + + +[[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/LoyaltyCardBatchResponse.md b/docs/LoyaltyCardBatchResponse.md new file mode 100644 index 00000000..2c165f82 --- /dev/null +++ b/docs/LoyaltyCardBatchResponse.md @@ -0,0 +1,65 @@ +# LoyaltyCardBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfCardsGenerated** | Pointer to **int32** | Number of loyalty cards in the batch. | +**BatchId** | Pointer to **string** | ID of the loyalty card batch. | + +## Methods + +### GetNumberOfCardsGenerated + +`func (o *LoyaltyCardBatchResponse) GetNumberOfCardsGenerated() int32` + +GetNumberOfCardsGenerated returns the NumberOfCardsGenerated field if non-nil, zero value otherwise. + +### GetNumberOfCardsGeneratedOk + +`func (o *LoyaltyCardBatchResponse) GetNumberOfCardsGeneratedOk() (int32, bool)` + +GetNumberOfCardsGeneratedOk returns a tuple with the NumberOfCardsGenerated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNumberOfCardsGenerated + +`func (o *LoyaltyCardBatchResponse) HasNumberOfCardsGenerated() bool` + +HasNumberOfCardsGenerated returns a boolean if a field has been set. + +### SetNumberOfCardsGenerated + +`func (o *LoyaltyCardBatchResponse) SetNumberOfCardsGenerated(v int32)` + +SetNumberOfCardsGenerated gets a reference to the given int32 and assigns it to the NumberOfCardsGenerated field. + +### GetBatchId + +`func (o *LoyaltyCardBatchResponse) GetBatchId() string` + +GetBatchId returns the BatchId field if non-nil, zero value otherwise. + +### GetBatchIdOk + +`func (o *LoyaltyCardBatchResponse) GetBatchIdOk() (string, bool)` + +GetBatchIdOk returns a tuple with the BatchId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBatchId + +`func (o *LoyaltyCardBatchResponse) HasBatchId() bool` + +HasBatchId returns a boolean if a field has been set. + +### SetBatchId + +`func (o *LoyaltyCardBatchResponse) SetBatchId(v string)` + +SetBatchId gets a reference to the given string and assigns it to the BatchId field. + + +[[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/LoyaltyProgram.md b/docs/LoyaltyProgram.md index e2f1a85a..9b83e641 100644 --- a/docs/LoyaltyProgram.md +++ b/docs/LoyaltyProgram.md @@ -14,18 +14,22 @@ Name | Type | Description | Notes **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | **UsersPerCardLimit** | Pointer to **int32** | 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** | Pointer to **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. | -**TiersExpirationPolicy** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to [**time.Time**](time.Time.md) | 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** | Pointer to **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** | Pointer to **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** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **AccountID** | Pointer to **int32** | The ID of the Talon.One account that owns this program. | **Name** | Pointer to **string** | The internal name for the Loyalty Program. This is an immutable value. | **Tiers** | Pointer to [**[]LoyaltyTier**](LoyaltyTier.md) | The tiers in this loyalty program. | [optional] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | **CardBased** | Pointer to **bool** | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false] **CanUpdateTiers** | Pointer to **bool** | `True` if the tier definitions can be updated. | [optional] [default to false] -**CanUpdateJoinPolicy** | Pointer to **bool** | Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`. | [optional] +**CanUpdateJoinPolicy** | Pointer to **bool** | `True` if the program join policy can be updated. | [optional] +**CanUpdateTierExpirationPolicy** | Pointer to **bool** | `True` if the tier expiration policy can be updated. | [optional] **CanUpgradeToAdvancedTiers** | Pointer to **bool** | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. | [optional] [default to false] +**CanUpdateSubledgers** | Pointer to **bool** | `True` if the `allowSubledger` property can be updated in the loyalty program. | [optional] [default to false] ## Methods @@ -279,6 +283,31 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetProgramJoinPolicy + +`func (o *LoyaltyProgram) GetProgramJoinPolicy() string` + +GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. + +### GetProgramJoinPolicyOk + +`func (o *LoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` + +GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramJoinPolicy + +`func (o *LoyaltyProgram) HasProgramJoinPolicy() bool` + +HasProgramJoinPolicy returns a boolean if a field has been set. + +### SetProgramJoinPolicy + +`func (o *LoyaltyProgram) SetProgramJoinPolicy(v string)` + +SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. + ### GetTiersExpirationPolicy `func (o *LoyaltyProgram) GetTiersExpirationPolicy() string` @@ -304,6 +333,31 @@ HasTiersExpirationPolicy returns a boolean if a field has been set. SetTiersExpirationPolicy gets a reference to the given string and assigns it to the TiersExpirationPolicy field. +### GetTierCycleStartDate + +`func (o *LoyaltyProgram) GetTierCycleStartDate() time.Time` + +GetTierCycleStartDate returns the TierCycleStartDate field if non-nil, zero value otherwise. + +### GetTierCycleStartDateOk + +`func (o *LoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool)` + +GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTierCycleStartDate + +`func (o *LoyaltyProgram) HasTierCycleStartDate() bool` + +HasTierCycleStartDate returns a boolean if a field has been set. + +### SetTierCycleStartDate + +`func (o *LoyaltyProgram) SetTierCycleStartDate(v time.Time)` + +SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. + ### GetTiersExpireIn `func (o *LoyaltyProgram) GetTiersExpireIn() string` @@ -354,30 +408,30 @@ HasTiersDowngradePolicy returns a boolean if a field has been set. SetTiersDowngradePolicy gets a reference to the given string and assigns it to the TiersDowngradePolicy field. -### GetProgramJoinPolicy +### GetCardCodeSettings -`func (o *LoyaltyProgram) GetProgramJoinPolicy() string` +`func (o *LoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings` -GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. +GetCardCodeSettings returns the CardCodeSettings field if non-nil, zero value otherwise. -### GetProgramJoinPolicyOk +### GetCardCodeSettingsOk -`func (o *LoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` +`func (o *LoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool)` -GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasProgramJoinPolicy +### HasCardCodeSettings -`func (o *LoyaltyProgram) HasProgramJoinPolicy() bool` +`func (o *LoyaltyProgram) HasCardCodeSettings() bool` -HasProgramJoinPolicy returns a boolean if a field has been set. +HasCardCodeSettings returns a boolean if a field has been set. -### SetProgramJoinPolicy +### SetCardCodeSettings -`func (o *LoyaltyProgram) SetProgramJoinPolicy(v string)` +`func (o *LoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings)` -SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. ### GetAccountID @@ -554,6 +608,31 @@ HasCanUpdateJoinPolicy returns a boolean if a field has been set. SetCanUpdateJoinPolicy gets a reference to the given bool and assigns it to the CanUpdateJoinPolicy field. +### GetCanUpdateTierExpirationPolicy + +`func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicy() bool` + +GetCanUpdateTierExpirationPolicy returns the CanUpdateTierExpirationPolicy field if non-nil, zero value otherwise. + +### GetCanUpdateTierExpirationPolicyOk + +`func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicyOk() (bool, bool)` + +GetCanUpdateTierExpirationPolicyOk returns a tuple with the CanUpdateTierExpirationPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCanUpdateTierExpirationPolicy + +`func (o *LoyaltyProgram) HasCanUpdateTierExpirationPolicy() bool` + +HasCanUpdateTierExpirationPolicy returns a boolean if a field has been set. + +### SetCanUpdateTierExpirationPolicy + +`func (o *LoyaltyProgram) SetCanUpdateTierExpirationPolicy(v bool)` + +SetCanUpdateTierExpirationPolicy gets a reference to the given bool and assigns it to the CanUpdateTierExpirationPolicy field. + ### GetCanUpgradeToAdvancedTiers `func (o *LoyaltyProgram) GetCanUpgradeToAdvancedTiers() bool` @@ -579,6 +658,31 @@ HasCanUpgradeToAdvancedTiers returns a boolean if a field has been set. SetCanUpgradeToAdvancedTiers gets a reference to the given bool and assigns it to the CanUpgradeToAdvancedTiers field. +### GetCanUpdateSubledgers + +`func (o *LoyaltyProgram) GetCanUpdateSubledgers() bool` + +GetCanUpdateSubledgers returns the CanUpdateSubledgers field if non-nil, zero value otherwise. + +### GetCanUpdateSubledgersOk + +`func (o *LoyaltyProgram) GetCanUpdateSubledgersOk() (bool, bool)` + +GetCanUpdateSubledgersOk returns a tuple with the CanUpdateSubledgers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCanUpdateSubledgers + +`func (o *LoyaltyProgram) HasCanUpdateSubledgers() bool` + +HasCanUpdateSubledgers returns a boolean if a field has been set. + +### SetCanUpdateSubledgers + +`func (o *LoyaltyProgram) SetCanUpdateSubledgers(v bool)` + +SetCanUpdateSubledgers gets a reference to the given bool and assigns it to the CanUpdateSubledgers field. + [[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/LoyaltyProgramSubledgers.md b/docs/LoyaltyProgramSubledgers.md deleted file mode 100644 index d1695418..00000000 --- a/docs/LoyaltyProgramSubledgers.md +++ /dev/null @@ -1,65 +0,0 @@ -# LoyaltyProgramSubledgers - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LoyaltyProgramId** | Pointer to **int32** | The internal ID of the loyalty program. | -**SubledgerIds** | Pointer to **[]string** | The list of subledger IDs. | - -## Methods - -### GetLoyaltyProgramId - -`func (o *LoyaltyProgramSubledgers) GetLoyaltyProgramId() int32` - -GetLoyaltyProgramId returns the LoyaltyProgramId field if non-nil, zero value otherwise. - -### GetLoyaltyProgramIdOk - -`func (o *LoyaltyProgramSubledgers) GetLoyaltyProgramIdOk() (int32, bool)` - -GetLoyaltyProgramIdOk returns a tuple with the LoyaltyProgramId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLoyaltyProgramId - -`func (o *LoyaltyProgramSubledgers) HasLoyaltyProgramId() bool` - -HasLoyaltyProgramId returns a boolean if a field has been set. - -### SetLoyaltyProgramId - -`func (o *LoyaltyProgramSubledgers) SetLoyaltyProgramId(v int32)` - -SetLoyaltyProgramId gets a reference to the given int32 and assigns it to the LoyaltyProgramId field. - -### GetSubledgerIds - -`func (o *LoyaltyProgramSubledgers) GetSubledgerIds() []string` - -GetSubledgerIds returns the SubledgerIds field if non-nil, zero value otherwise. - -### GetSubledgerIdsOk - -`func (o *LoyaltyProgramSubledgers) GetSubledgerIdsOk() ([]string, bool)` - -GetSubledgerIdsOk returns a tuple with the SubledgerIds field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSubledgerIds - -`func (o *LoyaltyProgramSubledgers) HasSubledgerIds() bool` - -HasSubledgerIds returns a boolean if a field has been set. - -### SetSubledgerIds - -`func (o *LoyaltyProgramSubledgers) SetSubledgerIds(v []string)` - -SetSubledgerIds gets a reference to the given []string and assigns it to the SubledgerIds field. - - -[[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/LoyaltyStatistics.md b/docs/LoyaltyStatistics.md deleted file mode 100644 index 502dbdcf..00000000 --- a/docs/LoyaltyStatistics.md +++ /dev/null @@ -1,247 +0,0 @@ -# LoyaltyStatistics - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Date** | Pointer to [**time.Time**](time.Time.md) | Date at which data point was collected. | -**TotalActivePoints** | Pointer to **float32** | Total of active points for this loyalty program. | -**TotalPendingPoints** | Pointer to **float32** | Total of pending points for this loyalty program. | -**TotalSpentPoints** | Pointer to **float32** | Total of spent points for this loyalty program. | -**TotalExpiredPoints** | Pointer to **float32** | Total of expired points for this loyalty program. | -**TotalMembers** | Pointer to **float32** | Number of loyalty program members. | -**NewMembers** | Pointer to **float32** | Number of members who joined on this day. | -**SpentPoints** | Pointer to [**LoyaltyDashboardPointsBreakdown**](LoyaltyDashboardPointsBreakdown.md) | | -**EarnedPoints** | Pointer to [**LoyaltyDashboardPointsBreakdown**](LoyaltyDashboardPointsBreakdown.md) | | - -## Methods - -### GetDate - -`func (o *LoyaltyStatistics) GetDate() time.Time` - -GetDate returns the Date field if non-nil, zero value otherwise. - -### GetDateOk - -`func (o *LoyaltyStatistics) GetDateOk() (time.Time, bool)` - -GetDateOk returns a tuple with the Date field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDate - -`func (o *LoyaltyStatistics) HasDate() bool` - -HasDate returns a boolean if a field has been set. - -### SetDate - -`func (o *LoyaltyStatistics) SetDate(v time.Time)` - -SetDate gets a reference to the given time.Time and assigns it to the Date field. - -### GetTotalActivePoints - -`func (o *LoyaltyStatistics) GetTotalActivePoints() float32` - -GetTotalActivePoints returns the TotalActivePoints field if non-nil, zero value otherwise. - -### GetTotalActivePointsOk - -`func (o *LoyaltyStatistics) GetTotalActivePointsOk() (float32, bool)` - -GetTotalActivePointsOk returns a tuple with the TotalActivePoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalActivePoints - -`func (o *LoyaltyStatistics) HasTotalActivePoints() bool` - -HasTotalActivePoints returns a boolean if a field has been set. - -### SetTotalActivePoints - -`func (o *LoyaltyStatistics) SetTotalActivePoints(v float32)` - -SetTotalActivePoints gets a reference to the given float32 and assigns it to the TotalActivePoints field. - -### GetTotalPendingPoints - -`func (o *LoyaltyStatistics) GetTotalPendingPoints() float32` - -GetTotalPendingPoints returns the TotalPendingPoints field if non-nil, zero value otherwise. - -### GetTotalPendingPointsOk - -`func (o *LoyaltyStatistics) GetTotalPendingPointsOk() (float32, bool)` - -GetTotalPendingPointsOk returns a tuple with the TotalPendingPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalPendingPoints - -`func (o *LoyaltyStatistics) HasTotalPendingPoints() bool` - -HasTotalPendingPoints returns a boolean if a field has been set. - -### SetTotalPendingPoints - -`func (o *LoyaltyStatistics) SetTotalPendingPoints(v float32)` - -SetTotalPendingPoints gets a reference to the given float32 and assigns it to the TotalPendingPoints field. - -### GetTotalSpentPoints - -`func (o *LoyaltyStatistics) GetTotalSpentPoints() float32` - -GetTotalSpentPoints returns the TotalSpentPoints field if non-nil, zero value otherwise. - -### GetTotalSpentPointsOk - -`func (o *LoyaltyStatistics) GetTotalSpentPointsOk() (float32, bool)` - -GetTotalSpentPointsOk returns a tuple with the TotalSpentPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalSpentPoints - -`func (o *LoyaltyStatistics) HasTotalSpentPoints() bool` - -HasTotalSpentPoints returns a boolean if a field has been set. - -### SetTotalSpentPoints - -`func (o *LoyaltyStatistics) SetTotalSpentPoints(v float32)` - -SetTotalSpentPoints gets a reference to the given float32 and assigns it to the TotalSpentPoints field. - -### GetTotalExpiredPoints - -`func (o *LoyaltyStatistics) GetTotalExpiredPoints() float32` - -GetTotalExpiredPoints returns the TotalExpiredPoints field if non-nil, zero value otherwise. - -### GetTotalExpiredPointsOk - -`func (o *LoyaltyStatistics) GetTotalExpiredPointsOk() (float32, bool)` - -GetTotalExpiredPointsOk returns a tuple with the TotalExpiredPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalExpiredPoints - -`func (o *LoyaltyStatistics) HasTotalExpiredPoints() bool` - -HasTotalExpiredPoints returns a boolean if a field has been set. - -### SetTotalExpiredPoints - -`func (o *LoyaltyStatistics) SetTotalExpiredPoints(v float32)` - -SetTotalExpiredPoints gets a reference to the given float32 and assigns it to the TotalExpiredPoints field. - -### GetTotalMembers - -`func (o *LoyaltyStatistics) GetTotalMembers() float32` - -GetTotalMembers returns the TotalMembers field if non-nil, zero value otherwise. - -### GetTotalMembersOk - -`func (o *LoyaltyStatistics) GetTotalMembersOk() (float32, bool)` - -GetTotalMembersOk returns a tuple with the TotalMembers field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTotalMembers - -`func (o *LoyaltyStatistics) HasTotalMembers() bool` - -HasTotalMembers returns a boolean if a field has been set. - -### SetTotalMembers - -`func (o *LoyaltyStatistics) SetTotalMembers(v float32)` - -SetTotalMembers gets a reference to the given float32 and assigns it to the TotalMembers field. - -### GetNewMembers - -`func (o *LoyaltyStatistics) GetNewMembers() float32` - -GetNewMembers returns the NewMembers field if non-nil, zero value otherwise. - -### GetNewMembersOk - -`func (o *LoyaltyStatistics) GetNewMembersOk() (float32, bool)` - -GetNewMembersOk returns a tuple with the NewMembers field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasNewMembers - -`func (o *LoyaltyStatistics) HasNewMembers() bool` - -HasNewMembers returns a boolean if a field has been set. - -### SetNewMembers - -`func (o *LoyaltyStatistics) SetNewMembers(v float32)` - -SetNewMembers gets a reference to the given float32 and assigns it to the NewMembers field. - -### GetSpentPoints - -`func (o *LoyaltyStatistics) GetSpentPoints() LoyaltyDashboardPointsBreakdown` - -GetSpentPoints returns the SpentPoints field if non-nil, zero value otherwise. - -### GetSpentPointsOk - -`func (o *LoyaltyStatistics) GetSpentPointsOk() (LoyaltyDashboardPointsBreakdown, bool)` - -GetSpentPointsOk returns a tuple with the SpentPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSpentPoints - -`func (o *LoyaltyStatistics) HasSpentPoints() bool` - -HasSpentPoints returns a boolean if a field has been set. - -### SetSpentPoints - -`func (o *LoyaltyStatistics) SetSpentPoints(v LoyaltyDashboardPointsBreakdown)` - -SetSpentPoints gets a reference to the given LoyaltyDashboardPointsBreakdown and assigns it to the SpentPoints field. - -### GetEarnedPoints - -`func (o *LoyaltyStatistics) GetEarnedPoints() LoyaltyDashboardPointsBreakdown` - -GetEarnedPoints returns the EarnedPoints field if non-nil, zero value otherwise. - -### GetEarnedPointsOk - -`func (o *LoyaltyStatistics) GetEarnedPointsOk() (LoyaltyDashboardPointsBreakdown, bool)` - -GetEarnedPointsOk returns a tuple with the EarnedPoints field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEarnedPoints - -`func (o *LoyaltyStatistics) HasEarnedPoints() bool` - -HasEarnedPoints returns a boolean if a field has been set. - -### SetEarnedPoints - -`func (o *LoyaltyStatistics) SetEarnedPoints(v LoyaltyDashboardPointsBreakdown)` - -SetEarnedPoints gets a reference to the given LoyaltyDashboardPointsBreakdown and assigns it to the EarnedPoints field. - - -[[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/ManagementApi.md b/docs/ManagementApi.md index f3b9d5b3..6d09b969 100644 --- a/docs/ManagementApi.md +++ b/docs/ManagementApi.md @@ -4,7 +4,7 @@ All URIs are relative to *https://yourbaseurl.talon.one* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ActivateUserByEmail**](ManagementApi.md#ActivateUserByEmail) | **Post** /v1/users/activate | Activate user by email address +[**ActivateUserByEmail**](ManagementApi.md#ActivateUserByEmail) | **Post** /v1/users/activate | Enable user by email address [**AddLoyaltyCardPoints**](ManagementApi.md#AddLoyaltyCardPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card [**AddLoyaltyPoints**](ManagementApi.md#AddLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile [**CopyCampaignToApplications**](ManagementApi.md#CopyCampaignToApplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application @@ -12,17 +12,19 @@ Method | HTTP request | Description [**CreateAchievement**](ManagementApi.md#CreateAchievement) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement [**CreateAdditionalCost**](ManagementApi.md#CreateAdditionalCost) | **Post** /v1/additional_costs | Create additional cost [**CreateAttribute**](ManagementApi.md#CreateAttribute) | **Post** /v1/attributes | Create custom attribute +[**CreateBatchLoyaltyCards**](ManagementApi.md#CreateBatchLoyaltyCards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards [**CreateCampaignFromTemplate**](ManagementApi.md#CreateCampaignFromTemplate) | **Post** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template [**CreateCollection**](ManagementApi.md#CreateCollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection [**CreateCoupons**](ManagementApi.md#CreateCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons [**CreateCouponsAsync**](ManagementApi.md#CreateCouponsAsync) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously +[**CreateCouponsDeletionJob**](ManagementApi.md#CreateCouponsDeletionJob) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job [**CreateCouponsForMultipleRecipients**](ManagementApi.md#CreateCouponsForMultipleRecipients) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients [**CreateInviteEmail**](ManagementApi.md#CreateInviteEmail) | **Post** /v1/invite_emails | Resend invitation email [**CreateInviteV2**](ManagementApi.md#CreateInviteV2) | **Post** /v2/invites | Invite user [**CreatePasswordRecoveryEmail**](ManagementApi.md#CreatePasswordRecoveryEmail) | **Post** /v1/password_recovery_emails | Request a password reset [**CreateSession**](ManagementApi.md#CreateSession) | **Post** /v1/sessions | Create session [**CreateStore**](ManagementApi.md#CreateStore) | **Post** /v1/applications/{applicationId}/stores | Create store -[**DeactivateUserByEmail**](ManagementApi.md#DeactivateUserByEmail) | **Post** /v1/users/deactivate | Deactivate user by email address +[**DeactivateUserByEmail**](ManagementApi.md#DeactivateUserByEmail) | **Post** /v1/users/deactivate | Disable user by email address [**DeductLoyaltyCardPoints**](ManagementApi.md#DeductLoyaltyCardPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card [**DeleteAccountCollection**](ManagementApi.md#DeleteAccountCollection) | **Delete** /v1/collections/{collectionId} | Delete account-level collection [**DeleteAchievement**](ManagementApi.md#DeleteAchievement) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement @@ -36,9 +38,11 @@ Method | HTTP request | Description [**DeleteUser**](ManagementApi.md#DeleteUser) | **Delete** /v1/users/{userId} | Delete user [**DeleteUserByEmail**](ManagementApi.md#DeleteUserByEmail) | **Post** /v1/users/delete | Delete user by email address [**DestroySession**](ManagementApi.md#DestroySession) | **Delete** /v1/sessions | Destroy session +[**DisconnectCampaignStores**](ManagementApi.md#DisconnectCampaignStores) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores [**ExportAccountCollectionItems**](ManagementApi.md#ExportAccountCollectionItems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items [**ExportAchievements**](ManagementApi.md#ExportAchievements) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data [**ExportAudiencesMemberships**](ManagementApi.md#ExportAudiencesMemberships) | **Get** /v1/audiences/{audienceId}/memberships/export | Export audience members +[**ExportCampaignStores**](ManagementApi.md#ExportCampaignStores) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores [**ExportCollectionItems**](ManagementApi.md#ExportCollectionItems) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items [**ExportCoupons**](ManagementApi.md#ExportCoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons [**ExportCustomerSessions**](ManagementApi.md#ExportCustomerSessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions @@ -48,6 +52,7 @@ Method | HTTP request | Description [**ExportLoyaltyBalances**](ManagementApi.md#ExportLoyaltyBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances [**ExportLoyaltyCardBalances**](ManagementApi.md#ExportLoyaltyCardBalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs [**ExportLoyaltyCardLedger**](ManagementApi.md#ExportLoyaltyCardLedger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +[**ExportLoyaltyCards**](ManagementApi.md#ExportLoyaltyCards) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards [**ExportLoyaltyLedger**](ManagementApi.md#ExportLoyaltyLedger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs [**ExportPoolGiveaways**](ManagementApi.md#ExportPoolGiveaways) | **Get** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool [**ExportReferrals**](ManagementApi.md#ExportReferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals @@ -117,6 +122,7 @@ Method | HTTP request | Description [**ImportAccountCollection**](ManagementApi.md#ImportAccountCollection) | **Post** /v1/collections/{collectionId}/import | Import data into existing account-level collection [**ImportAllowedList**](ManagementApi.md#ImportAllowedList) | **Post** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute [**ImportAudiencesMemberships**](ManagementApi.md#ImportAudiencesMemberships) | **Post** /v1/audiences/{audienceId}/memberships/import | Import audience members +[**ImportCampaignStores**](ManagementApi.md#ImportCampaignStores) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores [**ImportCollection**](ManagementApi.md#ImportCollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection [**ImportCoupons**](ManagementApi.md#ImportCoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons [**ImportLoyaltyCards**](ManagementApi.md#ImportLoyaltyCards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards @@ -133,11 +139,21 @@ Method | HTTP request | Description [**ListCollectionsInApplication**](ManagementApi.md#ListCollectionsInApplication) | **Get** /v1/applications/{applicationId}/collections | List collections in Application [**ListStores**](ManagementApi.md#ListStores) | **Get** /v1/applications/{applicationId}/stores | List stores [**NotificationActivation**](ManagementApi.md#NotificationActivation) | **Put** /v1/notifications/{notificationId}/activation | Activate or deactivate notification +[**OktaEventHandlerChallenge**](ManagementApi.md#OktaEventHandlerChallenge) | **Get** /v1/provisioning/okta | Validate Okta API ownership [**PostAddedDeductedPointsNotification**](ManagementApi.md#PostAddedDeductedPointsNotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points [**PostCatalogsStrikethroughNotification**](ManagementApi.md#PostCatalogsStrikethroughNotification) | **Post** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification [**PostPendingPointsNotification**](ManagementApi.md#PostPendingPointsNotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points [**RemoveLoyaltyPoints**](ManagementApi.md#RemoveLoyaltyPoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile [**ResetPassword**](ManagementApi.md#ResetPassword) | **Post** /v1/reset_password | Reset password +[**ScimCreateUser**](ManagementApi.md#ScimCreateUser) | **Post** /v1/provisioning/scim/Users | Create SCIM user +[**ScimDeleteUser**](ManagementApi.md#ScimDeleteUser) | **Delete** /v1/provisioning/scim/Users/{userId} | Delete SCIM user +[**ScimGetResourceTypes**](ManagementApi.md#ScimGetResourceTypes) | **Get** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types +[**ScimGetSchemas**](ManagementApi.md#ScimGetSchemas) | **Get** /v1/provisioning/scim/Schemas | List supported SCIM schemas +[**ScimGetServiceProviderConfig**](ManagementApi.md#ScimGetServiceProviderConfig) | **Get** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration +[**ScimGetUser**](ManagementApi.md#ScimGetUser) | **Get** /v1/provisioning/scim/Users/{userId} | Get SCIM user +[**ScimGetUsers**](ManagementApi.md#ScimGetUsers) | **Get** /v1/provisioning/scim/Users | List SCIM users +[**ScimPatchUser**](ManagementApi.md#ScimPatchUser) | **Patch** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes +[**ScimReplaceUserAttributes**](ManagementApi.md#ScimReplaceUserAttributes) | **Put** /v1/provisioning/scim/Users/{userId} | Update SCIM user [**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedApplicationWideWithoutTotalCount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) [**SearchCouponsAdvancedWithoutTotalCount**](ManagementApi.md#SearchCouponsAdvancedWithoutTotalCount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) [**TransferLoyaltyCard**](ManagementApi.md#TransferLoyaltyCard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data @@ -161,7 +177,7 @@ Method | HTTP request | Description > ActivateUserByEmail(ctx).Body(body).Execute() -Activate user by email address +Enable user by email address @@ -497,6 +513,50 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## CreateBatchLoyaltyCards + +> LoyaltyCardBatchResponse CreateBatchLoyaltyCards(ctx, loyaltyProgramId).Body(body).Execute() + +Create loyalty cards + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateBatchLoyaltyCardsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**LoyaltyCardBatch**](LoyaltyCardBatch.md) | body | + +### Return type + +[**LoyaltyCardBatchResponse**](LoyaltyCardBatchResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## CreateCampaignFromTemplate > CreateTemplateCampaignResponse CreateCampaignFromTemplate(ctx, applicationId).Body(body).Execute() @@ -680,6 +740,52 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## CreateCouponsDeletionJob + +> AsyncCouponDeletionJobResponse CreateCouponsDeletionJob(ctx, applicationId, campaignId).Body(body).Execute() + +Creates a coupon deletion job + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateCouponsDeletionJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **body** | [**NewCouponDeletionJob**](NewCouponDeletionJob.md) | body | + +### Return type + +[**AsyncCouponDeletionJobResponse**](AsyncCouponDeletionJobResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## CreateCouponsForMultipleRecipients > InlineResponse2008 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId).Body(body).Silent(silent).Execute() @@ -931,7 +1037,7 @@ Name | Type | Description | Notes > DeactivateUserByEmail(ctx).Body(body).Execute() -Deactivate user by email address +Disable user by email address @@ -1270,10 +1376,10 @@ Name | Type | Description | Notes **value** | **string** | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | - **startsAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | - **startsBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | - **expiresAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | - **expiresBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **startsAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **startsBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **expiresAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **expiresBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | **valid** | **string** | - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | **batchId** | **string** | Filter results by batches of coupons | **usable** | **string** | - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | @@ -1553,6 +1659,51 @@ Other parameters are passed through a pointer to a apiDestroySessionRequest stru [[Back to README]](../README.md) +## DisconnectCampaignStores + +> DisconnectCampaignStores(ctx, applicationId, campaignId).Execute() + +Disconnect stores + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDisconnectCampaignStoresRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## ExportAccountCollectionItems > string ExportAccountCollectionItems(ctx, collectionId).Execute() @@ -1668,6 +1819,51 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- +### Return type + +**string** + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExportCampaignStores + +> string ExportCampaignStores(ctx, applicationId, campaignId).Execute() + +Export stores + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportCampaignStoresRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + ### Return type **string** @@ -1769,7 +1965,7 @@ Name | Type | Description | Notes **batchId** | **string** | Filter results by batches of coupons | **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code. | [default to false] **dateFormat** | **string** | Determines the format of dates in the export document. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | **valuesOnly** | **bool** | Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [default to false] ### Return type @@ -1908,8 +2104,8 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **float32** | Filter results by campaign. | - **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | - **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | + **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | **dateFormat** | **string** | Determines the format of dates in the export document. | ### Return type @@ -2110,6 +2306,50 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## ExportLoyaltyCards + +> string ExportLoyaltyCards(ctx, loyaltyProgramId).BatchId(batchId).Execute() + +Export loyalty cards + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExportLoyaltyCardsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **batchId** | **string** | Filter results by loyalty card batch ID. | + +### Return type + +**string** + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## ExportLoyaltyLedger > string ExportLoyaltyLedger(ctx, loyaltyProgramId, integrationId).RangeStart(rangeStart).RangeEnd(rangeEnd).DateFormat(dateFormat).Execute() @@ -3462,7 +3702,7 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items in the response. | [default to 1000] **skip** | **int32** | The number of items to skip when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | ### Return type @@ -3638,7 +3878,7 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items in the response. | [default to 1000] **skip** | **int32** | The number of items to skip when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | **name** | **string** | Filter results performing case-insensitive matching against the name of the campaign. | **tags** | **string** | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | **createdBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | @@ -3808,7 +4048,7 @@ Name | Type | Description | Notes ## GetCouponsWithoutTotalCount -> InlineResponse2009 GetCouponsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).Execute() +> InlineResponse2009 GetCouponsWithoutTotalCount(ctx, applicationId, campaignId).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).Redeemed(redeemed).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).ExpiresBefore(expiresBefore).ExpiresAfter(expiresAfter).StartsBefore(startsBefore).StartsAfter(startsAfter).ValuesOnly(valuesOnly).Execute() List coupons @@ -3840,10 +4080,16 @@ Name | Type | Description | Notes **createdAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | **valid** | **string** | Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | **usable** | **string** | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | + **redeemed** | **string** | - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | **referralId** | **int32** | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | **batchId** | **string** | Filter results by batches of coupons | **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] + **expiresBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **expiresAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **startsBefore** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **startsAfter** | **time.Time** | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | + **valuesOnly** | **bool** | Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [default to false] ### Return type @@ -4370,7 +4616,7 @@ Name | Type | Description | Notes ## GetLoyaltyCards -> InlineResponse20015 GetLoyaltyCards(ctx, loyaltyProgramId).PageSize(pageSize).Skip(skip).Sort(sort).Identifier(identifier).ProfileId(profileId).Execute() +> InlineResponse20015 GetLoyaltyCards(ctx, loyaltyProgramId).PageSize(pageSize).Skip(skip).Sort(sort).Identifier(identifier).ProfileId(profileId).BatchId(batchId).Execute() List loyalty cards @@ -4395,8 +4641,9 @@ Name | Type | Description | Notes **pageSize** | **int32** | The number of items in the response. | [default to 1000] **skip** | **int32** | The number of items to skip when paging through large result sets. | **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | - **identifier** | **string** | Optional query parameter to search cards by identifier. | - **profileId** | **int32** | Filter by the profile ID. | + **identifier** | **string** | The card code by which to filter loyalty cards in the response. | + **profileId** | **int32** | Filter results by customer profile ID. | + **batchId** | **string** | Filter results by loyalty card batch ID. | ### Return type @@ -5109,7 +5356,7 @@ Other parameters are passed through a pointer to a apiGetWebhooksRequest struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **applicationIds** | **string** | Filter by one or more Application IDs, separated by a comma. | + **applicationIds** | **string** | Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications. | **sort** | **string** | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** This parameter works only with numeric fields. | **pageSize** | **int32** | The number of items in the response. | [default to 1000] **skip** | **int32** | The number of items to skip when paging through large result sets. | @@ -5268,6 +5515,52 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## ImportCampaignStores + +> Import ImportCampaignStores(ctx, applicationId, campaignId).UpFile(upFile).Execute() + +Import stores + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**applicationId** | **int32** | The ID of the Application. It is displayed in your Talon.One deployment URL. | +**campaignId** | **int32** | The ID of the campaign. It is displayed in your Talon.One deployment URL. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiImportCampaignStoresRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **upFile** | **string** | The file containing the data that is being imported. | + +### Return type + +[**Import**](Import.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## ImportCollection > Import ImportCollection(ctx, applicationId, campaignId, collectionId).UpFile(upFile).Execute() @@ -5991,29 +6284,64 @@ Name | Type | Description | Notes [[Back to README]](../README.md) -## PostAddedDeductedPointsNotification +## OktaEventHandlerChallenge -> BaseNotification PostAddedDeductedPointsNotification(ctx, loyaltyProgramId).Body(body).Execute() +> OktaEventHandlerChallenge(ctx).Execute() -Create notification about added or deducted loyalty points +Validate Okta API ownership ### Path Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**loyaltyProgramId** | **int32** | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | +This endpoint does not need any parameter. ### Other Parameters -Other parameters are passed through a pointer to a apiPostAddedDeductedPointsNotificationRequest struct via the builder pattern +Other parameters are passed through a pointer to a apiOktaEventHandlerChallengeRequest struct via the builder pattern -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PostAddedDeductedPointsNotification + +> BaseNotification PostAddedDeductedPointsNotification(ctx, loyaltyProgramId).Body(body).Execute() + +Create notification about added or deducted loyalty points + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**loyaltyProgramId** | **int32** | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPostAddedDeductedPointsNotificationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- **body** | [**NewBaseNotification**](NewBaseNotification.md) | body | @@ -6208,6 +6536,359 @@ Name | Type | Description | Notes [[Back to README]](../README.md) +## ScimCreateUser + +> ScimUser ScimCreateUser(ctx).Body(body).Execute() + +Create SCIM user + + + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimCreateUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**ScimNewUser**](ScimNewUser.md) | body | + +### Return type + +[**ScimUser**](ScimUser.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimDeleteUser + +> ScimDeleteUser(ctx, userId).Execute() + +Delete SCIM user + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userId** | **int32** | The ID of the user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimDeleteUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimGetResourceTypes + +> ScimResourceTypesListResponse ScimGetResourceTypes(ctx).Execute() + +List supported SCIM resource types + + + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimGetResourceTypesRequest struct via the builder pattern + + +### Return type + +[**ScimResourceTypesListResponse**](ScimResourceTypesListResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimGetSchemas + +> ScimSchemasListResponse ScimGetSchemas(ctx).Execute() + +List supported SCIM schemas + + + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimGetSchemasRequest struct via the builder pattern + + +### Return type + +[**ScimSchemasListResponse**](ScimSchemasListResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimGetServiceProviderConfig + +> ScimServiceProviderConfigResponse ScimGetServiceProviderConfig(ctx).Execute() + +Get SCIM service provider configuration + + + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimGetServiceProviderConfigRequest struct via the builder pattern + + +### Return type + +[**ScimServiceProviderConfigResponse**](ScimServiceProviderConfigResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimGetUser + +> ScimUser ScimGetUser(ctx, userId).Execute() + +Get SCIM user + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userId** | **int32** | The ID of the user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimGetUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ScimUser**](ScimUser.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimGetUsers + +> ScimUsersListResponse ScimGetUsers(ctx).Execute() + +List SCIM users + + + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimGetUsersRequest struct via the builder pattern + + +### Return type + +[**ScimUsersListResponse**](ScimUsersListResponse.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimPatchUser + +> ScimUser ScimPatchUser(ctx, userId).Body(body).Execute() + +Update SCIM user attributes + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userId** | **int32** | The ID of the user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimPatchUserRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**ScimPatchRequest**](ScimPatchRequest.md) | body | + +### Return type + +[**ScimUser**](ScimUser.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScimReplaceUserAttributes + +> ScimUser ScimReplaceUserAttributes(ctx, userId).Body(body).Execute() + +Update SCIM user + + + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**userId** | **int32** | The ID of the user. | + +### Other Parameters + +Other parameters are passed through a pointer to a apiScimReplaceUserAttributesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **body** | [**ScimNewUser**](ScimNewUser.md) | body | + +### Return type + +[**ScimUser**](ScimUser.md) + +### Authorization + +[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + ## SearchCouponsAdvancedApplicationWideWithoutTotalCount > InlineResponse2009 SearchCouponsAdvancedApplicationWideWithoutTotalCount(ctx, applicationId).Body(body).PageSize(pageSize).Skip(skip).Sort(sort).Value(value).CreatedBefore(createdBefore).CreatedAfter(createdAfter).Valid(valid).Usable(usable).ReferralId(referralId).RecipientIntegrationId(recipientIntegrationId).BatchId(batchId).ExactMatch(exactMatch).CampaignState(campaignState).Execute() @@ -6245,7 +6926,7 @@ Name | Type | Description | Notes **recipientIntegrationId** | **string** | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | **batchId** | **string** | Filter results by batches of coupons | **exactMatch** | **bool** | Filter results to an exact case-insensitive matching against the coupon code | [default to false] - **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts. | + **campaignState** | **string** | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | ### Return type diff --git a/docs/MessageLogResponse.md b/docs/MessageLogResponse.md index 34b87163..009b1243 100644 --- a/docs/MessageLogResponse.md +++ b/docs/MessageLogResponse.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CreatedAt** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the response was received. | -**Response** | Pointer to **string** | Raw response data. | -**Status** | Pointer to **int32** | HTTP status code of the response. | +**CreatedAt** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the response was received. | [optional] +**Response** | Pointer to **string** | Raw response data. | [optional] +**Status** | Pointer to **int32** | HTTP status code of the response. | [optional] ## Methods diff --git a/docs/NewAppWideCouponDeletionJob.md b/docs/NewAppWideCouponDeletionJob.md new file mode 100644 index 00000000..95635445 --- /dev/null +++ b/docs/NewAppWideCouponDeletionJob.md @@ -0,0 +1,65 @@ +# NewAppWideCouponDeletionJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to [**CouponDeletionFilters**](CouponDeletionFilters.md) | | +**Campaignids** | Pointer to **[]int32** | | + +## Methods + +### GetFilters + +`func (o *NewAppWideCouponDeletionJob) GetFilters() CouponDeletionFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *NewAppWideCouponDeletionJob) GetFiltersOk() (CouponDeletionFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilters + +`func (o *NewAppWideCouponDeletionJob) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFilters + +`func (o *NewAppWideCouponDeletionJob) SetFilters(v CouponDeletionFilters)` + +SetFilters gets a reference to the given CouponDeletionFilters and assigns it to the Filters field. + +### GetCampaignids + +`func (o *NewAppWideCouponDeletionJob) GetCampaignids() []int32` + +GetCampaignids returns the Campaignids field if non-nil, zero value otherwise. + +### GetCampaignidsOk + +`func (o *NewAppWideCouponDeletionJob) GetCampaignidsOk() ([]int32, bool)` + +GetCampaignidsOk returns a tuple with the Campaignids field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignids + +`func (o *NewAppWideCouponDeletionJob) HasCampaignids() bool` + +HasCampaignids returns a boolean if a field has been set. + +### SetCampaignids + +`func (o *NewAppWideCouponDeletionJob) SetCampaignids(v []int32)` + +SetCampaignids gets a reference to the given []int32 and assigns it to the Campaignids field. + + +[[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/NewApplication.md b/docs/NewApplication.md index 0be34a1d..8f9cc537 100644 --- a/docs/NewApplication.md +++ b/docs/NewApplication.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] **DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] **Key** | Pointer to **string** | Hex key for HMAC-signing API calls as coming from this application (16 hex digits). | [optional] +**EnableCampaignStateManagement** | Pointer to **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] ## Methods @@ -397,6 +398,31 @@ HasKey returns a boolean if a field has been set. SetKey gets a reference to the given string and assigns it to the Key field. +### GetEnableCampaignStateManagement + +`func (o *NewApplication) GetEnableCampaignStateManagement() bool` + +GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field if non-nil, zero value otherwise. + +### GetEnableCampaignStateManagementOk + +`func (o *NewApplication) GetEnableCampaignStateManagementOk() (bool, bool)` + +GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCampaignStateManagement + +`func (o *NewApplication) HasEnableCampaignStateManagement() bool` + +HasEnableCampaignStateManagement returns a boolean if a field has been set. + +### SetEnableCampaignStateManagement + +`func (o *NewApplication) SetEnableCampaignStateManagement(v bool)` + +SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. + [[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/NewApplicationCif.md b/docs/NewApplicationCif.md new file mode 100644 index 00000000..26ca6a17 --- /dev/null +++ b/docs/NewApplicationCif.md @@ -0,0 +1,169 @@ +# NewApplicationCif + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The name of the Application cart item filter used in API requests. | +**Description** | Pointer to **string** | A short description of the Application cart item filter. | [optional] +**ActiveExpressionId** | Pointer to **int32** | The ID of the expression that the Application cart item filter uses. | [optional] +**ModifiedBy** | Pointer to **int32** | The ID of the user who last updated the Application cart item filter. | [optional] +**CreatedBy** | Pointer to **int32** | The ID of the user who created the Application cart item filter. | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the Application cart item filter. | [optional] + +## Methods + +### GetName + +`func (o *NewApplicationCif) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewApplicationCif) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewApplicationCif) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewApplicationCif) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *NewApplicationCif) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewApplicationCif) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewApplicationCif) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewApplicationCif) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetActiveExpressionId + +`func (o *NewApplicationCif) GetActiveExpressionId() int32` + +GetActiveExpressionId returns the ActiveExpressionId field if non-nil, zero value otherwise. + +### GetActiveExpressionIdOk + +`func (o *NewApplicationCif) GetActiveExpressionIdOk() (int32, bool)` + +GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveExpressionId + +`func (o *NewApplicationCif) HasActiveExpressionId() bool` + +HasActiveExpressionId returns a boolean if a field has been set. + +### SetActiveExpressionId + +`func (o *NewApplicationCif) SetActiveExpressionId(v int32)` + +SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. + +### GetModifiedBy + +`func (o *NewApplicationCif) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *NewApplicationCif) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *NewApplicationCif) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *NewApplicationCif) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetCreatedBy + +`func (o *NewApplicationCif) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *NewApplicationCif) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *NewApplicationCif) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *NewApplicationCif) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetModified + +`func (o *NewApplicationCif) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *NewApplicationCif) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *NewApplicationCif) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *NewApplicationCif) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + + +[[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/NewApplicationCifExpression.md b/docs/NewApplicationCifExpression.md new file mode 100644 index 00000000..feb0d7a8 --- /dev/null +++ b/docs/NewApplicationCifExpression.md @@ -0,0 +1,91 @@ +# NewApplicationCifExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CartItemFilterId** | Pointer to **int32** | The ID of the Application cart item filter. | [optional] +**CreatedBy** | Pointer to **int32** | The ID of the user who created the Application cart item filter. | [optional] +**Expression** | Pointer to [**[]interface{}**]([]interface{}.md) | Arbitrary additional JSON data associated with the Application cart item filter. | [optional] + +## Methods + +### GetCartItemFilterId + +`func (o *NewApplicationCifExpression) GetCartItemFilterId() int32` + +GetCartItemFilterId returns the CartItemFilterId field if non-nil, zero value otherwise. + +### GetCartItemFilterIdOk + +`func (o *NewApplicationCifExpression) GetCartItemFilterIdOk() (int32, bool)` + +GetCartItemFilterIdOk returns a tuple with the CartItemFilterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCartItemFilterId + +`func (o *NewApplicationCifExpression) HasCartItemFilterId() bool` + +HasCartItemFilterId returns a boolean if a field has been set. + +### SetCartItemFilterId + +`func (o *NewApplicationCifExpression) SetCartItemFilterId(v int32)` + +SetCartItemFilterId gets a reference to the given int32 and assigns it to the CartItemFilterId field. + +### GetCreatedBy + +`func (o *NewApplicationCifExpression) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *NewApplicationCifExpression) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *NewApplicationCifExpression) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *NewApplicationCifExpression) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetExpression + +`func (o *NewApplicationCifExpression) GetExpression() []interface{}` + +GetExpression returns the Expression field if non-nil, zero value otherwise. + +### GetExpressionOk + +`func (o *NewApplicationCifExpression) GetExpressionOk() ([]interface{}, bool)` + +GetExpressionOk returns a tuple with the Expression field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasExpression + +`func (o *NewApplicationCifExpression) HasExpression() bool` + +HasExpression returns a boolean if a field has been set. + +### SetExpression + +`func (o *NewApplicationCifExpression) SetExpression(v []interface{})` + +SetExpression gets a reference to the given []interface{} and assigns it to the Expression field. + + +[[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/NewBaseNotification.md b/docs/NewBaseNotification.md index 623036b8..435225f7 100644 --- a/docs/NewBaseNotification.md +++ b/docs/NewBaseNotification.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Policy** | Pointer to [**map[string]interface{}**](.md) | | +**Policy** | Pointer to [**map[string]interface{}**](.md) | Indicates which notification properties to apply. | **Enabled** | Pointer to **bool** | Indicates whether the notification is activated. | [optional] [default to true] **Webhook** | Pointer to [**NewNotificationWebhook**](NewNotificationWebhook.md) | | diff --git a/docs/NewCampaignSetV2.md b/docs/NewCampaignSetV2.md deleted file mode 100644 index 36bd5e8b..00000000 --- a/docs/NewCampaignSetV2.md +++ /dev/null @@ -1,91 +0,0 @@ -# NewCampaignSetV2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**Version** | Pointer to **int32** | Version of the campaign set. | -**Set** | Pointer to [**CampaignPrioritiesV2**](CampaignPrioritiesV2.md) | | - -## Methods - -### GetApplicationId - -`func (o *NewCampaignSetV2) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *NewCampaignSetV2) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *NewCampaignSetV2) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *NewCampaignSetV2) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetVersion - -`func (o *NewCampaignSetV2) GetVersion() int32` - -GetVersion returns the Version field if non-nil, zero value otherwise. - -### GetVersionOk - -`func (o *NewCampaignSetV2) GetVersionOk() (int32, bool)` - -GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasVersion - -`func (o *NewCampaignSetV2) HasVersion() bool` - -HasVersion returns a boolean if a field has been set. - -### SetVersion - -`func (o *NewCampaignSetV2) SetVersion(v int32)` - -SetVersion gets a reference to the given int32 and assigns it to the Version field. - -### GetSet - -`func (o *NewCampaignSetV2) GetSet() CampaignPrioritiesV2` - -GetSet returns the Set field if non-nil, zero value otherwise. - -### GetSetOk - -`func (o *NewCampaignSetV2) GetSetOk() (CampaignPrioritiesV2, bool)` - -GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSet - -`func (o *NewCampaignSetV2) HasSet() bool` - -HasSet returns a boolean if a field has been set. - -### SetSet - -`func (o *NewCampaignSetV2) SetSet(v CampaignPrioritiesV2)` - -SetSet gets a reference to the given CampaignPrioritiesV2 and assigns it to the Set field. - - -[[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/NewCouponCreationJob.md b/docs/NewCouponCreationJob.md index ab83abe2..925fde82 100644 --- a/docs/NewCouponCreationJob.md +++ b/docs/NewCouponCreationJob.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. | **CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with coupons. | diff --git a/docs/NewCouponDeletionJob.md b/docs/NewCouponDeletionJob.md new file mode 100644 index 00000000..a0a1c250 --- /dev/null +++ b/docs/NewCouponDeletionJob.md @@ -0,0 +1,39 @@ +# NewCouponDeletionJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to [**CouponDeletionFilters**](CouponDeletionFilters.md) | | + +## Methods + +### GetFilters + +`func (o *NewCouponDeletionJob) GetFilters() CouponDeletionFilters` + +GetFilters returns the Filters field if non-nil, zero value otherwise. + +### GetFiltersOk + +`func (o *NewCouponDeletionJob) GetFiltersOk() (CouponDeletionFilters, bool)` + +GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilters + +`func (o *NewCouponDeletionJob) HasFilters() bool` + +HasFilters returns a boolean if a field has been set. + +### SetFilters + +`func (o *NewCouponDeletionJob) SetFilters(v CouponDeletionFilters)` + +SetFilters gets a reference to the given CouponDeletionFilters and assigns it to the Filters field. + + +[[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/NewCoupons.md b/docs/NewCoupons.md index b0493fa3..5c05e775 100644 --- a/docs/NewCoupons.md +++ b/docs/NewCoupons.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **NumberOfCoupons** | Pointer to **int32** | The number of new coupon codes to generate for the campaign. Must be at least 1. | **UniquePrefix** | Pointer to **string** | **DEPRECATED** To create more than 20,000 coupons in one request, use [Create coupons asynchronously](https://docs.talon.one/management-api#operation/createCouponsAsync) endpoint. | [optional] diff --git a/docs/NewCouponsForMultipleRecipients.md b/docs/NewCouponsForMultipleRecipients.md index c344435e..666617aa 100644 --- a/docs/NewCouponsForMultipleRecipients.md +++ b/docs/NewCouponsForMultipleRecipients.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] **RecipientsIntegrationIds** | Pointer to **[]string** | The integration IDs for recipients. | **ValidCharacters** | Pointer to **[]string** | List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. | [optional] diff --git a/docs/NewCustomerSessionV2.md b/docs/NewCustomerSessionV2.md index 6de3eb9f..6e838003 100644 --- a/docs/NewCustomerSessionV2.md +++ b/docs/NewCustomerSessionV2.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **ProfileId** | Pointer to **string** | ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`. | [optional] **StoreIntegrationId** | Pointer to **string** | The integration ID of the store. You choose this ID when you create a store. | [optional] **EvaluableCampaignIds** | Pointer to **[]int32** | When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. | [optional] -**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. | [optional] -**ReferralCode** | Pointer to **string** | Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. | [optional] +**CouponCodes** | Pointer to **[]string** | Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely. | [optional] +**ReferralCode** | Pointer to **string** | Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely. | [optional] **LoyaltyCards** | Pointer to **[]string** | Identifier of a loyalty card. | [optional] **State** | Pointer to **string** | Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). | [optional] [default to STATE_OPEN] **CartItems** | Pointer to [**[]CartItem**](CartItem.md) | The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request. | [optional] diff --git a/docs/NewLoyaltyProgram.md b/docs/NewLoyaltyProgram.md index d6b1e3e6..6ceba5cf 100644 --- a/docs/NewLoyaltyProgram.md +++ b/docs/NewLoyaltyProgram.md @@ -12,10 +12,12 @@ Name | Type | Description | Notes **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | **UsersPerCardLimit** | Pointer to **int32** | 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** | Pointer to **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. | -**TiersExpirationPolicy** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to [**time.Time**](time.Time.md) | 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** | Pointer to **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** | Pointer to **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** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Name** | Pointer to **string** | The internal name for the Loyalty Program. This is an immutable value. | **Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] **Timezone** | Pointer to **string** | A string containing an IANA timezone descriptor. | @@ -223,6 +225,31 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetProgramJoinPolicy + +`func (o *NewLoyaltyProgram) GetProgramJoinPolicy() string` + +GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. + +### GetProgramJoinPolicyOk + +`func (o *NewLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` + +GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramJoinPolicy + +`func (o *NewLoyaltyProgram) HasProgramJoinPolicy() bool` + +HasProgramJoinPolicy returns a boolean if a field has been set. + +### SetProgramJoinPolicy + +`func (o *NewLoyaltyProgram) SetProgramJoinPolicy(v string)` + +SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. + ### GetTiersExpirationPolicy `func (o *NewLoyaltyProgram) GetTiersExpirationPolicy() string` @@ -248,6 +275,31 @@ HasTiersExpirationPolicy returns a boolean if a field has been set. SetTiersExpirationPolicy gets a reference to the given string and assigns it to the TiersExpirationPolicy field. +### GetTierCycleStartDate + +`func (o *NewLoyaltyProgram) GetTierCycleStartDate() time.Time` + +GetTierCycleStartDate returns the TierCycleStartDate field if non-nil, zero value otherwise. + +### GetTierCycleStartDateOk + +`func (o *NewLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool)` + +GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTierCycleStartDate + +`func (o *NewLoyaltyProgram) HasTierCycleStartDate() bool` + +HasTierCycleStartDate returns a boolean if a field has been set. + +### SetTierCycleStartDate + +`func (o *NewLoyaltyProgram) SetTierCycleStartDate(v time.Time)` + +SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. + ### GetTiersExpireIn `func (o *NewLoyaltyProgram) GetTiersExpireIn() string` @@ -298,30 +350,30 @@ HasTiersDowngradePolicy returns a boolean if a field has been set. SetTiersDowngradePolicy gets a reference to the given string and assigns it to the TiersDowngradePolicy field. -### GetProgramJoinPolicy +### GetCardCodeSettings -`func (o *NewLoyaltyProgram) GetProgramJoinPolicy() string` +`func (o *NewLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings` -GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. +GetCardCodeSettings returns the CardCodeSettings field if non-nil, zero value otherwise. -### GetProgramJoinPolicyOk +### GetCardCodeSettingsOk -`func (o *NewLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` +`func (o *NewLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool)` -GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasProgramJoinPolicy +### HasCardCodeSettings -`func (o *NewLoyaltyProgram) HasProgramJoinPolicy() bool` +`func (o *NewLoyaltyProgram) HasCardCodeSettings() bool` -HasProgramJoinPolicy returns a boolean if a field has been set. +HasCardCodeSettings returns a boolean if a field has been set. -### SetProgramJoinPolicy +### SetCardCodeSettings -`func (o *NewLoyaltyProgram) SetProgramJoinPolicy(v string)` +`func (o *NewLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings)` -SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. ### GetName diff --git a/docs/NewOutgoingIntegrationWebhook.md b/docs/NewOutgoingIntegrationWebhook.md index 97353926..384eedb5 100644 --- a/docs/NewOutgoingIntegrationWebhook.md +++ b/docs/NewOutgoingIntegrationWebhook.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Title** | Pointer to **string** | Webhook title. | +**Description** | Pointer to **string** | A description of the webhook. | [optional] **ApplicationIds** | Pointer to **[]int32** | IDs of the Applications to which a webhook must be linked. | ## Methods @@ -34,6 +35,31 @@ HasTitle returns a boolean if a field has been set. SetTitle gets a reference to the given string and assigns it to the Title field. +### GetDescription + +`func (o *NewOutgoingIntegrationWebhook) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewOutgoingIntegrationWebhook) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewOutgoingIntegrationWebhook) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewOutgoingIntegrationWebhook) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetApplicationIds `func (o *NewOutgoingIntegrationWebhook) GetApplicationIds() []int32` diff --git a/docs/NewReferral.md b/docs/NewReferral.md index ee820b55..19d22adc 100644 --- a/docs/NewReferral.md +++ b/docs/NewReferral.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional] **CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | diff --git a/docs/NewReferralsForMultipleAdvocates.md b/docs/NewReferralsForMultipleAdvocates.md index f1df9cae..ede25682 100644 --- a/docs/NewReferralsForMultipleAdvocates.md +++ b/docs/NewReferralsForMultipleAdvocates.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | **CampaignId** | Pointer to **int32** | The ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationIds** | Pointer to **[]string** | An array containing all the respective advocate profiles. | diff --git a/docs/NewRevisionVersion.md b/docs/NewRevisionVersion.md new file mode 100644 index 00000000..6dad5eec --- /dev/null +++ b/docs/NewRevisionVersion.md @@ -0,0 +1,327 @@ +# NewRevisionVersion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | A user-facing name for this campaign. | [optional] +**StartTime** | Pointer to [**NullableTime**](time.Time.md) | Timestamp when the campaign will become active. | [optional] +**EndTime** | Pointer to [**NullableTime**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] +**Description** | Pointer to **NullableString** | A detailed description of the campaign. | [optional] +**ActiveRulesetId** | Pointer to **NullableInt32** | The ID of the ruleset this campaign template will use. | [optional] +**Tags** | Pointer to **[]string** | A list of tags for the campaign template. | [optional] +**CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] +**Features** | Pointer to **[]string** | A list of features for the campaign template. | [optional] + +## Methods + +### GetName + +`func (o *NewRevisionVersion) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NewRevisionVersion) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *NewRevisionVersion) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *NewRevisionVersion) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartTime + +`func (o *NewRevisionVersion) GetStartTime() NullableTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *NewRevisionVersion) GetStartTimeOk() (NullableTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartTime + +`func (o *NewRevisionVersion) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### SetStartTime + +`func (o *NewRevisionVersion) SetStartTime(v NullableTime)` + +SetStartTime gets a reference to the given NullableTime and assigns it to the StartTime field. + +### SetStartTimeExplicitNull + +`func (o *NewRevisionVersion) SetStartTimeExplicitNull(b bool)` + +SetStartTimeExplicitNull (un)sets StartTime to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The StartTime value is set to nil even if false is passed +### GetEndTime + +`func (o *NewRevisionVersion) GetEndTime() NullableTime` + +GetEndTime returns the EndTime field if non-nil, zero value otherwise. + +### GetEndTimeOk + +`func (o *NewRevisionVersion) GetEndTimeOk() (NullableTime, bool)` + +GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndTime + +`func (o *NewRevisionVersion) HasEndTime() bool` + +HasEndTime returns a boolean if a field has been set. + +### SetEndTime + +`func (o *NewRevisionVersion) SetEndTime(v NullableTime)` + +SetEndTime gets a reference to the given NullableTime and assigns it to the EndTime field. + +### SetEndTimeExplicitNull + +`func (o *NewRevisionVersion) SetEndTimeExplicitNull(b bool)` + +SetEndTimeExplicitNull (un)sets EndTime to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The EndTime value is set to nil even if false is passed +### GetAttributes + +`func (o *NewRevisionVersion) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *NewRevisionVersion) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *NewRevisionVersion) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *NewRevisionVersion) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetDescription + +`func (o *NewRevisionVersion) GetDescription() NullableString` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewRevisionVersion) GetDescriptionOk() (NullableString, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewRevisionVersion) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewRevisionVersion) SetDescription(v NullableString)` + +SetDescription gets a reference to the given NullableString and assigns it to the Description field. + +### SetDescriptionExplicitNull + +`func (o *NewRevisionVersion) SetDescriptionExplicitNull(b bool)` + +SetDescriptionExplicitNull (un)sets Description to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The Description value is set to nil even if false is passed +### GetActiveRulesetId + +`func (o *NewRevisionVersion) GetActiveRulesetId() NullableInt32` + +GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise. + +### GetActiveRulesetIdOk + +`func (o *NewRevisionVersion) GetActiveRulesetIdOk() (NullableInt32, bool)` + +GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRulesetId + +`func (o *NewRevisionVersion) HasActiveRulesetId() bool` + +HasActiveRulesetId returns a boolean if a field has been set. + +### SetActiveRulesetId + +`func (o *NewRevisionVersion) SetActiveRulesetId(v NullableInt32)` + +SetActiveRulesetId gets a reference to the given NullableInt32 and assigns it to the ActiveRulesetId field. + +### SetActiveRulesetIdExplicitNull + +`func (o *NewRevisionVersion) SetActiveRulesetIdExplicitNull(b bool)` + +SetActiveRulesetIdExplicitNull (un)sets ActiveRulesetId to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The ActiveRulesetId value is set to nil even if false is passed +### GetTags + +`func (o *NewRevisionVersion) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *NewRevisionVersion) GetTagsOk() ([]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTags + +`func (o *NewRevisionVersion) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### SetTags + +`func (o *NewRevisionVersion) SetTags(v []string)` + +SetTags gets a reference to the given []string and assigns it to the Tags field. + +### GetCouponSettings + +`func (o *NewRevisionVersion) GetCouponSettings() CodeGeneratorSettings` + +GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise. + +### GetCouponSettingsOk + +`func (o *NewRevisionVersion) GetCouponSettingsOk() (CodeGeneratorSettings, bool)` + +GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCouponSettings + +`func (o *NewRevisionVersion) HasCouponSettings() bool` + +HasCouponSettings returns a boolean if a field has been set. + +### SetCouponSettings + +`func (o *NewRevisionVersion) SetCouponSettings(v CodeGeneratorSettings)` + +SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. + +### GetReferralSettings + +`func (o *NewRevisionVersion) GetReferralSettings() CodeGeneratorSettings` + +GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise. + +### GetReferralSettingsOk + +`func (o *NewRevisionVersion) GetReferralSettingsOk() (CodeGeneratorSettings, bool)` + +GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralSettings + +`func (o *NewRevisionVersion) HasReferralSettings() bool` + +HasReferralSettings returns a boolean if a field has been set. + +### SetReferralSettings + +`func (o *NewRevisionVersion) SetReferralSettings(v CodeGeneratorSettings)` + +SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. + +### GetLimits + +`func (o *NewRevisionVersion) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *NewRevisionVersion) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *NewRevisionVersion) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *NewRevisionVersion) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + +### GetFeatures + +`func (o *NewRevisionVersion) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *NewRevisionVersion) GetFeaturesOk() ([]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFeatures + +`func (o *NewRevisionVersion) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeatures + +`func (o *NewRevisionVersion) SetFeatures(v []string)` + +SetFeatures gets a reference to the given []string and assigns it to the Features field. + + +[[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/NewTemplateDef.md b/docs/NewTemplateDef.md index 7fd425e9..5e5f65e8 100644 --- a/docs/NewTemplateDef.md +++ b/docs/NewTemplateDef.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A short description of the template that will be shown in the rule editor. | [optional] **Help** | Pointer to **string** | Extended help text for the template. | [optional] **Category** | Pointer to **string** | Used for grouping templates in the rule editor sidebar. | -**Expr** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that contains variable bindings referring to args. | +**Expr** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that contains variable bindings referring to args. | **Args** | Pointer to [**[]TemplateArgDef**](TemplateArgDef.md) | An array of argument definitions. | **Expose** | Pointer to **bool** | A flag to control exposure in Rule Builder. | [optional] [default to false] diff --git a/docs/NewWebhook.md b/docs/NewWebhook.md index 430c76b1..d942ba09 100644 --- a/docs/NewWebhook.md +++ b/docs/NewWebhook.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. | **Title** | Pointer to **string** | Name or title for this webhook. | +**Description** | Pointer to **string** | A description of the webhook. | [optional] **Verb** | Pointer to **string** | API method for this webhook. | **Url** | Pointer to **string** | API URL (supports templating using parameters) for this webhook. | **Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook. | @@ -65,6 +66,31 @@ HasTitle returns a boolean if a field has been set. SetTitle gets a reference to the given string and assigns it to the Title field. +### GetDescription + +`func (o *NewWebhook) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *NewWebhook) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *NewWebhook) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *NewWebhook) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetVerb `func (o *NewWebhook) GetVerb() string` diff --git a/docs/NotificationWebhook.md b/docs/NotificationWebhook.md deleted file mode 100644 index dc36ce1d..00000000 --- a/docs/NotificationWebhook.md +++ /dev/null @@ -1,195 +0,0 @@ -# NotificationWebhook - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Internal ID of this entity. | -**Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | -**Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | -**ApplicationId** | Pointer to **int32** | The ID of the application that owns this entity. | -**Url** | Pointer to **string** | API URL for the given webhook-based notification. | -**Headers** | Pointer to **[]string** | List of API HTTP headers for the given webhook-based notification. | -**Enabled** | Pointer to **bool** | Indicates whether the notification is activated. | [optional] [default to true] - -## Methods - -### GetId - -`func (o *NotificationWebhook) GetId() int32` - -GetId returns the Id field if non-nil, zero value otherwise. - -### GetIdOk - -`func (o *NotificationWebhook) GetIdOk() (int32, bool)` - -GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasId - -`func (o *NotificationWebhook) HasId() bool` - -HasId returns a boolean if a field has been set. - -### SetId - -`func (o *NotificationWebhook) SetId(v int32)` - -SetId gets a reference to the given int32 and assigns it to the Id field. - -### GetCreated - -`func (o *NotificationWebhook) GetCreated() time.Time` - -GetCreated returns the Created field if non-nil, zero value otherwise. - -### GetCreatedOk - -`func (o *NotificationWebhook) GetCreatedOk() (time.Time, bool)` - -GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCreated - -`func (o *NotificationWebhook) HasCreated() bool` - -HasCreated returns a boolean if a field has been set. - -### SetCreated - -`func (o *NotificationWebhook) SetCreated(v time.Time)` - -SetCreated gets a reference to the given time.Time and assigns it to the Created field. - -### GetModified - -`func (o *NotificationWebhook) GetModified() time.Time` - -GetModified returns the Modified field if non-nil, zero value otherwise. - -### GetModifiedOk - -`func (o *NotificationWebhook) GetModifiedOk() (time.Time, bool)` - -GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasModified - -`func (o *NotificationWebhook) HasModified() bool` - -HasModified returns a boolean if a field has been set. - -### SetModified - -`func (o *NotificationWebhook) SetModified(v time.Time)` - -SetModified gets a reference to the given time.Time and assigns it to the Modified field. - -### GetApplicationId - -`func (o *NotificationWebhook) GetApplicationId() int32` - -GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. - -### GetApplicationIdOk - -`func (o *NotificationWebhook) GetApplicationIdOk() (int32, bool)` - -GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplicationId - -`func (o *NotificationWebhook) HasApplicationId() bool` - -HasApplicationId returns a boolean if a field has been set. - -### SetApplicationId - -`func (o *NotificationWebhook) SetApplicationId(v int32)` - -SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. - -### GetUrl - -`func (o *NotificationWebhook) GetUrl() string` - -GetUrl returns the Url field if non-nil, zero value otherwise. - -### GetUrlOk - -`func (o *NotificationWebhook) GetUrlOk() (string, bool)` - -GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasUrl - -`func (o *NotificationWebhook) HasUrl() bool` - -HasUrl returns a boolean if a field has been set. - -### SetUrl - -`func (o *NotificationWebhook) SetUrl(v string)` - -SetUrl gets a reference to the given string and assigns it to the Url field. - -### GetHeaders - -`func (o *NotificationWebhook) GetHeaders() []string` - -GetHeaders returns the Headers field if non-nil, zero value otherwise. - -### GetHeadersOk - -`func (o *NotificationWebhook) GetHeadersOk() ([]string, bool)` - -GetHeadersOk returns a tuple with the Headers field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasHeaders - -`func (o *NotificationWebhook) HasHeaders() bool` - -HasHeaders returns a boolean if a field has been set. - -### SetHeaders - -`func (o *NotificationWebhook) SetHeaders(v []string)` - -SetHeaders gets a reference to the given []string and assigns it to the Headers field. - -### GetEnabled - -`func (o *NotificationWebhook) GetEnabled() bool` - -GetEnabled returns the Enabled field if non-nil, zero value otherwise. - -### GetEnabledOk - -`func (o *NotificationWebhook) GetEnabledOk() (bool, bool)` - -GetEnabledOk returns a tuple with the Enabled field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasEnabled - -`func (o *NotificationWebhook) HasEnabled() bool` - -HasEnabled returns a boolean if a field has been set. - -### SetEnabled - -`func (o *NotificationWebhook) SetEnabled(v bool)` - -SetEnabled gets a reference to the given bool and assigns it to the Enabled field. - - -[[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/OktaEvent.md b/docs/OktaEvent.md new file mode 100644 index 00000000..9da13427 --- /dev/null +++ b/docs/OktaEvent.md @@ -0,0 +1,65 @@ +# OktaEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **string** | Event type defining an action. | +**Target** | Pointer to [**[]OktaEventTarget**](OktaEventTarget.md) | | + +## Methods + +### GetEventType + +`func (o *OktaEvent) GetEventType() string` + +GetEventType returns the EventType field if non-nil, zero value otherwise. + +### GetEventTypeOk + +`func (o *OktaEvent) GetEventTypeOk() (string, bool)` + +GetEventTypeOk returns a tuple with the EventType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEventType + +`func (o *OktaEvent) HasEventType() bool` + +HasEventType returns a boolean if a field has been set. + +### SetEventType + +`func (o *OktaEvent) SetEventType(v string)` + +SetEventType gets a reference to the given string and assigns it to the EventType field. + +### GetTarget + +`func (o *OktaEvent) GetTarget() []OktaEventTarget` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *OktaEvent) GetTargetOk() ([]OktaEventTarget, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTarget + +`func (o *OktaEvent) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### SetTarget + +`func (o *OktaEvent) SetTarget(v []OktaEventTarget)` + +SetTarget gets a reference to the given []OktaEventTarget and assigns it to the Target field. + + +[[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/OktaEventPayload.md b/docs/OktaEventPayload.md new file mode 100644 index 00000000..662f0ee5 --- /dev/null +++ b/docs/OktaEventPayload.md @@ -0,0 +1,39 @@ +# OktaEventPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | Pointer to [**OktaEventPayloadData**](OktaEventPayloadData.md) | | + +## Methods + +### GetData + +`func (o *OktaEventPayload) GetData() OktaEventPayloadData` + +GetData returns the Data field if non-nil, zero value otherwise. + +### GetDataOk + +`func (o *OktaEventPayload) GetDataOk() (OktaEventPayloadData, bool)` + +GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasData + +`func (o *OktaEventPayload) HasData() bool` + +HasData returns a boolean if a field has been set. + +### SetData + +`func (o *OktaEventPayload) SetData(v OktaEventPayloadData)` + +SetData gets a reference to the given OktaEventPayloadData and assigns it to the Data field. + + +[[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/OktaEventPayloadData.md b/docs/OktaEventPayloadData.md new file mode 100644 index 00000000..0ef6f1a8 --- /dev/null +++ b/docs/OktaEventPayloadData.md @@ -0,0 +1,39 @@ +# OktaEventPayloadData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Events** | Pointer to [**[]OktaEvent**](OktaEvent.md) | | + +## Methods + +### GetEvents + +`func (o *OktaEventPayloadData) GetEvents() []OktaEvent` + +GetEvents returns the Events field if non-nil, zero value otherwise. + +### GetEventsOk + +`func (o *OktaEventPayloadData) GetEventsOk() ([]OktaEvent, bool)` + +GetEventsOk returns a tuple with the Events field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvents + +`func (o *OktaEventPayloadData) HasEvents() bool` + +HasEvents returns a boolean if a field has been set. + +### SetEvents + +`func (o *OktaEventPayloadData) SetEvents(v []OktaEvent)` + +SetEvents gets a reference to the given []OktaEvent and assigns it to the Events field. + + +[[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/OktaEventTarget.md b/docs/OktaEventTarget.md new file mode 100644 index 00000000..af6413fb --- /dev/null +++ b/docs/OktaEventTarget.md @@ -0,0 +1,91 @@ +# OktaEventTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Type of the event target. | +**AlternateId** | Pointer to **string** | Identifier of the event target, depending on its type. | +**DisplayName** | Pointer to **string** | Display name of the event target. | + +## Methods + +### GetType + +`func (o *OktaEventTarget) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *OktaEventTarget) GetTypeOk() (string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasType + +`func (o *OktaEventTarget) HasType() bool` + +HasType returns a boolean if a field has been set. + +### SetType + +`func (o *OktaEventTarget) SetType(v string)` + +SetType gets a reference to the given string and assigns it to the Type field. + +### GetAlternateId + +`func (o *OktaEventTarget) GetAlternateId() string` + +GetAlternateId returns the AlternateId field if non-nil, zero value otherwise. + +### GetAlternateIdOk + +`func (o *OktaEventTarget) GetAlternateIdOk() (string, bool)` + +GetAlternateIdOk returns a tuple with the AlternateId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAlternateId + +`func (o *OktaEventTarget) HasAlternateId() bool` + +HasAlternateId returns a boolean if a field has been set. + +### SetAlternateId + +`func (o *OktaEventTarget) SetAlternateId(v string)` + +SetAlternateId gets a reference to the given string and assigns it to the AlternateId field. + +### GetDisplayName + +`func (o *OktaEventTarget) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *OktaEventTarget) GetDisplayNameOk() (string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDisplayName + +`func (o *OktaEventTarget) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayName + +`func (o *OktaEventTarget) SetDisplayName(v string)` + +SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. + + +[[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/OutgoingIntegrationWebhookTemplate.md b/docs/OutgoingIntegrationWebhookTemplate.md deleted file mode 100644 index 0ccbab97..00000000 --- a/docs/OutgoingIntegrationWebhookTemplate.md +++ /dev/null @@ -1,169 +0,0 @@ -# OutgoingIntegrationWebhookTemplate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **int32** | Unique Id for this entity. | -**IntegrationType** | Pointer to **int32** | Unique Id of outgoing integration type. | -**Title** | Pointer to **string** | Title of the webhook template. | -**Description** | Pointer to **string** | General description for the specific outgoing integration webhook template. | -**Payload** | Pointer to **string** | API payload (supports templating using parameters) for this webhook template. | -**Method** | Pointer to **string** | API method for this webhook. | - -## Methods - -### GetId - -`func (o *OutgoingIntegrationWebhookTemplate) GetId() int32` - -GetId returns the Id field if non-nil, zero value otherwise. - -### GetIdOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetIdOk() (int32, bool)` - -GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasId - -`func (o *OutgoingIntegrationWebhookTemplate) HasId() bool` - -HasId returns a boolean if a field has been set. - -### SetId - -`func (o *OutgoingIntegrationWebhookTemplate) SetId(v int32)` - -SetId gets a reference to the given int32 and assigns it to the Id field. - -### GetIntegrationType - -`func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationType() int32` - -GetIntegrationType returns the IntegrationType field if non-nil, zero value otherwise. - -### GetIntegrationTypeOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationTypeOk() (int32, bool)` - -GetIntegrationTypeOk returns a tuple with the IntegrationType field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasIntegrationType - -`func (o *OutgoingIntegrationWebhookTemplate) HasIntegrationType() bool` - -HasIntegrationType returns a boolean if a field has been set. - -### SetIntegrationType - -`func (o *OutgoingIntegrationWebhookTemplate) SetIntegrationType(v int32)` - -SetIntegrationType gets a reference to the given int32 and assigns it to the IntegrationType field. - -### GetTitle - -`func (o *OutgoingIntegrationWebhookTemplate) GetTitle() string` - -GetTitle returns the Title field if non-nil, zero value otherwise. - -### GetTitleOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetTitleOk() (string, bool)` - -GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasTitle - -`func (o *OutgoingIntegrationWebhookTemplate) HasTitle() bool` - -HasTitle returns a boolean if a field has been set. - -### SetTitle - -`func (o *OutgoingIntegrationWebhookTemplate) SetTitle(v string)` - -SetTitle gets a reference to the given string and assigns it to the Title field. - -### GetDescription - -`func (o *OutgoingIntegrationWebhookTemplate) GetDescription() string` - -GetDescription returns the Description field if non-nil, zero value otherwise. - -### GetDescriptionOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetDescriptionOk() (string, bool)` - -GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasDescription - -`func (o *OutgoingIntegrationWebhookTemplate) HasDescription() bool` - -HasDescription returns a boolean if a field has been set. - -### SetDescription - -`func (o *OutgoingIntegrationWebhookTemplate) SetDescription(v string)` - -SetDescription gets a reference to the given string and assigns it to the Description field. - -### GetPayload - -`func (o *OutgoingIntegrationWebhookTemplate) GetPayload() string` - -GetPayload returns the Payload field if non-nil, zero value otherwise. - -### GetPayloadOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetPayloadOk() (string, bool)` - -GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasPayload - -`func (o *OutgoingIntegrationWebhookTemplate) HasPayload() bool` - -HasPayload returns a boolean if a field has been set. - -### SetPayload - -`func (o *OutgoingIntegrationWebhookTemplate) SetPayload(v string)` - -SetPayload gets a reference to the given string and assigns it to the Payload field. - -### GetMethod - -`func (o *OutgoingIntegrationWebhookTemplate) GetMethod() string` - -GetMethod returns the Method field if non-nil, zero value otherwise. - -### GetMethodOk - -`func (o *OutgoingIntegrationWebhookTemplate) GetMethodOk() (string, bool)` - -GetMethodOk returns a tuple with the Method field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasMethod - -`func (o *OutgoingIntegrationWebhookTemplate) HasMethod() bool` - -HasMethod returns a boolean if a field has been set. - -### SetMethod - -`func (o *OutgoingIntegrationWebhookTemplate) SetMethod(v string)` - -SetMethod gets a reference to the given string and assigns it to the Method field. - - -[[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/OutgoingIntegrationWebhookTemplates.md b/docs/OutgoingIntegrationWebhookTemplates.md deleted file mode 100644 index 98df01d9..00000000 --- a/docs/OutgoingIntegrationWebhookTemplates.md +++ /dev/null @@ -1,39 +0,0 @@ -# OutgoingIntegrationWebhookTemplates - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Data** | Pointer to [**[]OutgoingIntegrationWebhookTemplate**](OutgoingIntegrationWebhookTemplate.md) | The list of webhook templates for a given outgoing integration type. | [optional] - -## Methods - -### GetData - -`func (o *OutgoingIntegrationWebhookTemplates) GetData() []OutgoingIntegrationWebhookTemplate` - -GetData returns the Data field if non-nil, zero value otherwise. - -### GetDataOk - -`func (o *OutgoingIntegrationWebhookTemplates) GetDataOk() ([]OutgoingIntegrationWebhookTemplate, bool)` - -GetDataOk returns a tuple with the Data field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasData - -`func (o *OutgoingIntegrationWebhookTemplates) HasData() bool` - -HasData returns a boolean if a field has been set. - -### SetData - -`func (o *OutgoingIntegrationWebhookTemplates) SetData(v []OutgoingIntegrationWebhookTemplate)` - -SetData gets a reference to the given []OutgoingIntegrationWebhookTemplate and assigns it to the Data field. - - -[[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/PriorityPosition.md b/docs/PriorityPosition.md deleted file mode 100644 index b49b925c..00000000 --- a/docs/PriorityPosition.md +++ /dev/null @@ -1,65 +0,0 @@ -# PriorityPosition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Set** | Pointer to **string** | The name of the priority set where the campaign is located. | [default to SET_UNIVERSAL] -**Position** | Pointer to **int32** | The position of the campaign in the priority order starting from 1. | - -## Methods - -### GetSet - -`func (o *PriorityPosition) GetSet() string` - -GetSet returns the Set field if non-nil, zero value otherwise. - -### GetSetOk - -`func (o *PriorityPosition) GetSetOk() (string, bool)` - -GetSetOk returns a tuple with the Set field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasSet - -`func (o *PriorityPosition) HasSet() bool` - -HasSet returns a boolean if a field has been set. - -### SetSet - -`func (o *PriorityPosition) SetSet(v string)` - -SetSet gets a reference to the given string and assigns it to the Set field. - -### GetPosition - -`func (o *PriorityPosition) GetPosition() int32` - -GetPosition returns the Position field if non-nil, zero value otherwise. - -### GetPositionOk - -`func (o *PriorityPosition) GetPositionOk() (int32, bool)` - -GetPositionOk returns a tuple with the Position field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasPosition - -`func (o *PriorityPosition) HasPosition() bool` - -HasPosition returns a boolean if a field has been set. - -### SetPosition - -`func (o *PriorityPosition) SetPosition(v int32)` - -SetPosition gets a reference to the given int32 and assigns it to the Position field. - - -[[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/ProjectedTier.md b/docs/ProjectedTier.md new file mode 100644 index 00000000..9e7039b9 --- /dev/null +++ b/docs/ProjectedTier.md @@ -0,0 +1,91 @@ +# ProjectedTier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProjectedActivePoints** | Pointer to **float32** | The active points of the customer when their current tier expires. | +**StayInTierPoints** | Pointer to **float32** | The number of points the customer needs to stay in the current tier. **Note**: This is included in the response when the customer is projected to be downgraded. | [optional] +**ProjectedTierName** | Pointer to **string** | The name of the tier the user will enter once their current tier expires. | [optional] + +## Methods + +### GetProjectedActivePoints + +`func (o *ProjectedTier) GetProjectedActivePoints() float32` + +GetProjectedActivePoints returns the ProjectedActivePoints field if non-nil, zero value otherwise. + +### GetProjectedActivePointsOk + +`func (o *ProjectedTier) GetProjectedActivePointsOk() (float32, bool)` + +GetProjectedActivePointsOk returns a tuple with the ProjectedActivePoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjectedActivePoints + +`func (o *ProjectedTier) HasProjectedActivePoints() bool` + +HasProjectedActivePoints returns a boolean if a field has been set. + +### SetProjectedActivePoints + +`func (o *ProjectedTier) SetProjectedActivePoints(v float32)` + +SetProjectedActivePoints gets a reference to the given float32 and assigns it to the ProjectedActivePoints field. + +### GetStayInTierPoints + +`func (o *ProjectedTier) GetStayInTierPoints() float32` + +GetStayInTierPoints returns the StayInTierPoints field if non-nil, zero value otherwise. + +### GetStayInTierPointsOk + +`func (o *ProjectedTier) GetStayInTierPointsOk() (float32, bool)` + +GetStayInTierPointsOk returns a tuple with the StayInTierPoints field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStayInTierPoints + +`func (o *ProjectedTier) HasStayInTierPoints() bool` + +HasStayInTierPoints returns a boolean if a field has been set. + +### SetStayInTierPoints + +`func (o *ProjectedTier) SetStayInTierPoints(v float32)` + +SetStayInTierPoints gets a reference to the given float32 and assigns it to the StayInTierPoints field. + +### GetProjectedTierName + +`func (o *ProjectedTier) GetProjectedTierName() string` + +GetProjectedTierName returns the ProjectedTierName field if non-nil, zero value otherwise. + +### GetProjectedTierNameOk + +`func (o *ProjectedTier) GetProjectedTierNameOk() (string, bool)` + +GetProjectedTierNameOk returns a tuple with the ProjectedTierName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProjectedTierName + +`func (o *ProjectedTier) HasProjectedTierName() bool` + +HasProjectedTierName returns a boolean if a field has been set. + +### SetProjectedTierName + +`func (o *ProjectedTier) SetProjectedTierName(v string)` + +SetProjectedTierName gets a reference to the given string and assigns it to the ProjectedTierName field. + + +[[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/Referral.md b/docs/Referral.md index 7ef38ec5..ada803e9 100644 --- a/docs/Referral.md +++ b/docs/Referral.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Id** | Pointer to **int32** | Internal ID of this entity. | **Created** | Pointer to [**time.Time**](time.Time.md) | The time this entity was created. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | **CampaignId** | Pointer to **int32** | ID of the campaign from which the referral received the referral code. | **AdvocateProfileIntegrationId** | Pointer to **string** | The Integration ID of the Advocate's Profile. | diff --git a/docs/ReferralConstraints.md b/docs/ReferralConstraints.md index 5ead3273..f8c058b5 100644 --- a/docs/ReferralConstraints.md +++ b/docs/ReferralConstraints.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. | [optional] ## Methods diff --git a/docs/RejectCouponEffectProps.md b/docs/RejectCouponEffectProps.md index 26f672a0..adbdd2e0 100644 --- a/docs/RejectCouponEffectProps.md +++ b/docs/RejectCouponEffectProps.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the coupon. | [optional] **EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the coupon. | [optional] **Details** | Pointer to **string** | More details about the failure. | [optional] +**CampaignExclusionReason** | Pointer to **string** | The reason why the campaign was not applied. | [optional] ## Methods @@ -137,6 +138,31 @@ HasDetails returns a boolean if a field has been set. SetDetails gets a reference to the given string and assigns it to the Details field. +### GetCampaignExclusionReason + +`func (o *RejectCouponEffectProps) GetCampaignExclusionReason() string` + +GetCampaignExclusionReason returns the CampaignExclusionReason field if non-nil, zero value otherwise. + +### GetCampaignExclusionReasonOk + +`func (o *RejectCouponEffectProps) GetCampaignExclusionReasonOk() (string, bool)` + +GetCampaignExclusionReasonOk returns a tuple with the CampaignExclusionReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignExclusionReason + +`func (o *RejectCouponEffectProps) HasCampaignExclusionReason() bool` + +HasCampaignExclusionReason returns a boolean if a field has been set. + +### SetCampaignExclusionReason + +`func (o *RejectCouponEffectProps) SetCampaignExclusionReason(v string)` + +SetCampaignExclusionReason gets a reference to the given string and assigns it to the CampaignExclusionReason field. + [[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/RejectReferralEffectProps.md b/docs/RejectReferralEffectProps.md index 6165c887..9db9ce62 100644 --- a/docs/RejectReferralEffectProps.md +++ b/docs/RejectReferralEffectProps.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **ConditionIndex** | Pointer to **int32** | The index of the condition that caused the rejection of the referral. | [optional] **EffectIndex** | Pointer to **int32** | The index of the effect that caused the rejection of the referral. | [optional] **Details** | Pointer to **string** | More details about the failure. | [optional] +**CampaignExclusionReason** | Pointer to **string** | The reason why the campaign was not applied. | [optional] ## Methods @@ -137,6 +138,31 @@ HasDetails returns a boolean if a field has been set. SetDetails gets a reference to the given string and assigns it to the Details field. +### GetCampaignExclusionReason + +`func (o *RejectReferralEffectProps) GetCampaignExclusionReason() string` + +GetCampaignExclusionReason returns the CampaignExclusionReason field if non-nil, zero value otherwise. + +### GetCampaignExclusionReasonOk + +`func (o *RejectReferralEffectProps) GetCampaignExclusionReasonOk() (string, bool)` + +GetCampaignExclusionReasonOk returns a tuple with the CampaignExclusionReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignExclusionReason + +`func (o *RejectReferralEffectProps) HasCampaignExclusionReason() bool` + +HasCampaignExclusionReason returns a boolean if a field has been set. + +### SetCampaignExclusionReason + +`func (o *RejectReferralEffectProps) SetCampaignExclusionReason(v string)` + +SetCampaignExclusionReason gets a reference to the given string and assigns it to the CampaignExclusionReason field. + [[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/Revision.md b/docs/Revision.md new file mode 100644 index 00000000..bfd58736 --- /dev/null +++ b/docs/Revision.md @@ -0,0 +1,273 @@ +# Revision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | 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. | +**ActivateAt** | Pointer to [**time.Time**](time.Time.md) | | [optional] +**AccountId** | Pointer to **int32** | | +**ApplicationId** | Pointer to **int32** | | +**CampaignId** | Pointer to **int32** | | +**Created** | Pointer to [**time.Time**](time.Time.md) | | +**CreatedBy** | Pointer to **int32** | | +**ActivatedAt** | Pointer to [**time.Time**](time.Time.md) | | [optional] +**ActivatedBy** | Pointer to **int32** | | [optional] +**CurrentVersion** | Pointer to [**RevisionVersion**](RevisionVersion.md) | | [optional] + +## Methods + +### GetId + +`func (o *Revision) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Revision) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *Revision) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *Revision) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetActivateAt + +`func (o *Revision) GetActivateAt() time.Time` + +GetActivateAt returns the ActivateAt field if non-nil, zero value otherwise. + +### GetActivateAtOk + +`func (o *Revision) GetActivateAtOk() (time.Time, bool)` + +GetActivateAtOk returns a tuple with the ActivateAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivateAt + +`func (o *Revision) HasActivateAt() bool` + +HasActivateAt returns a boolean if a field has been set. + +### SetActivateAt + +`func (o *Revision) SetActivateAt(v time.Time)` + +SetActivateAt gets a reference to the given time.Time and assigns it to the ActivateAt field. + +### GetAccountId + +`func (o *Revision) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *Revision) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *Revision) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *Revision) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetApplicationId + +`func (o *Revision) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *Revision) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *Revision) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *Revision) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCampaignId + +`func (o *Revision) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *Revision) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *Revision) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *Revision) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetCreated + +`func (o *Revision) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *Revision) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *Revision) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *Revision) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCreatedBy + +`func (o *Revision) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *Revision) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *Revision) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *Revision) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetActivatedAt + +`func (o *Revision) GetActivatedAt() time.Time` + +GetActivatedAt returns the ActivatedAt field if non-nil, zero value otherwise. + +### GetActivatedAtOk + +`func (o *Revision) GetActivatedAtOk() (time.Time, bool)` + +GetActivatedAtOk returns a tuple with the ActivatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivatedAt + +`func (o *Revision) HasActivatedAt() bool` + +HasActivatedAt returns a boolean if a field has been set. + +### SetActivatedAt + +`func (o *Revision) SetActivatedAt(v time.Time)` + +SetActivatedAt gets a reference to the given time.Time and assigns it to the ActivatedAt field. + +### GetActivatedBy + +`func (o *Revision) GetActivatedBy() int32` + +GetActivatedBy returns the ActivatedBy field if non-nil, zero value otherwise. + +### GetActivatedByOk + +`func (o *Revision) GetActivatedByOk() (int32, bool)` + +GetActivatedByOk returns a tuple with the ActivatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivatedBy + +`func (o *Revision) HasActivatedBy() bool` + +HasActivatedBy returns a boolean if a field has been set. + +### SetActivatedBy + +`func (o *Revision) SetActivatedBy(v int32)` + +SetActivatedBy gets a reference to the given int32 and assigns it to the ActivatedBy field. + +### GetCurrentVersion + +`func (o *Revision) GetCurrentVersion() RevisionVersion` + +GetCurrentVersion returns the CurrentVersion field if non-nil, zero value otherwise. + +### GetCurrentVersionOk + +`func (o *Revision) GetCurrentVersionOk() (RevisionVersion, bool)` + +GetCurrentVersionOk returns a tuple with the CurrentVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentVersion + +`func (o *Revision) HasCurrentVersion() bool` + +HasCurrentVersion returns a boolean if a field has been set. + +### SetCurrentVersion + +`func (o *Revision) SetCurrentVersion(v RevisionVersion)` + +SetCurrentVersion gets a reference to the given RevisionVersion and assigns it to the CurrentVersion field. + + +[[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/RevisionActivation.md b/docs/RevisionActivation.md new file mode 100644 index 00000000..b18a514a --- /dev/null +++ b/docs/RevisionActivation.md @@ -0,0 +1,39 @@ +# RevisionActivation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ActivateAt** | Pointer to [**time.Time**](time.Time.md) | | [optional] + +## Methods + +### GetActivateAt + +`func (o *RevisionActivation) GetActivateAt() time.Time` + +GetActivateAt returns the ActivateAt field if non-nil, zero value otherwise. + +### GetActivateAtOk + +`func (o *RevisionActivation) GetActivateAtOk() (time.Time, bool)` + +GetActivateAtOk returns a tuple with the ActivateAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActivateAt + +`func (o *RevisionActivation) HasActivateAt() bool` + +HasActivateAt returns a boolean if a field has been set. + +### SetActivateAt + +`func (o *RevisionActivation) SetActivateAt(v time.Time)` + +SetActivateAt gets a reference to the given time.Time and assigns it to the ActivateAt field. + + +[[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/RevisionVersion.md b/docs/RevisionVersion.md new file mode 100644 index 00000000..f8478d4e --- /dev/null +++ b/docs/RevisionVersion.md @@ -0,0 +1,535 @@ +# RevisionVersion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **int32** | 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. | +**AccountId** | Pointer to **int32** | | +**ApplicationId** | Pointer to **int32** | | +**CampaignId** | Pointer to **int32** | | +**Created** | Pointer to [**time.Time**](time.Time.md) | | +**CreatedBy** | Pointer to **int32** | | +**RevisionId** | Pointer to **int32** | | +**Version** | Pointer to **int32** | | +**Name** | Pointer to **string** | A user-facing name for this campaign. | [optional] +**StartTime** | Pointer to [**NullableTime**](time.Time.md) | Timestamp when the campaign will become active. | [optional] +**EndTime** | Pointer to [**NullableTime**](time.Time.md) | Timestamp when the campaign will become inactive. | [optional] +**Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this campaign. | [optional] +**Description** | Pointer to **NullableString** | A detailed description of the campaign. | [optional] +**ActiveRulesetId** | Pointer to **NullableInt32** | The ID of the ruleset this campaign template will use. | [optional] +**Tags** | Pointer to **[]string** | A list of tags for the campaign template. | [optional] +**CouponSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**ReferralSettings** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] +**Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | The set of limits that will operate for this campaign version. | [optional] +**Features** | Pointer to **[]string** | A list of features for the campaign template. | [optional] + +## Methods + +### GetId + +`func (o *RevisionVersion) GetId() int32` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RevisionVersion) GetIdOk() (int32, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *RevisionVersion) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *RevisionVersion) SetId(v int32)` + +SetId gets a reference to the given int32 and assigns it to the Id field. + +### GetAccountId + +`func (o *RevisionVersion) GetAccountId() int32` + +GetAccountId returns the AccountId field if non-nil, zero value otherwise. + +### GetAccountIdOk + +`func (o *RevisionVersion) GetAccountIdOk() (int32, bool)` + +GetAccountIdOk returns a tuple with the AccountId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAccountId + +`func (o *RevisionVersion) HasAccountId() bool` + +HasAccountId returns a boolean if a field has been set. + +### SetAccountId + +`func (o *RevisionVersion) SetAccountId(v int32)` + +SetAccountId gets a reference to the given int32 and assigns it to the AccountId field. + +### GetApplicationId + +`func (o *RevisionVersion) GetApplicationId() int32` + +GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise. + +### GetApplicationIdOk + +`func (o *RevisionVersion) GetApplicationIdOk() (int32, bool)` + +GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasApplicationId + +`func (o *RevisionVersion) HasApplicationId() bool` + +HasApplicationId returns a boolean if a field has been set. + +### SetApplicationId + +`func (o *RevisionVersion) SetApplicationId(v int32)` + +SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field. + +### GetCampaignId + +`func (o *RevisionVersion) GetCampaignId() int32` + +GetCampaignId returns the CampaignId field if non-nil, zero value otherwise. + +### GetCampaignIdOk + +`func (o *RevisionVersion) GetCampaignIdOk() (int32, bool)` + +GetCampaignIdOk returns a tuple with the CampaignId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCampaignId + +`func (o *RevisionVersion) HasCampaignId() bool` + +HasCampaignId returns a boolean if a field has been set. + +### SetCampaignId + +`func (o *RevisionVersion) SetCampaignId(v int32)` + +SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. + +### GetCreated + +`func (o *RevisionVersion) GetCreated() time.Time` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *RevisionVersion) GetCreatedOk() (time.Time, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreated + +`func (o *RevisionVersion) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### SetCreated + +`func (o *RevisionVersion) SetCreated(v time.Time)` + +SetCreated gets a reference to the given time.Time and assigns it to the Created field. + +### GetCreatedBy + +`func (o *RevisionVersion) GetCreatedBy() int32` + +GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise. + +### GetCreatedByOk + +`func (o *RevisionVersion) GetCreatedByOk() (int32, bool)` + +GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCreatedBy + +`func (o *RevisionVersion) HasCreatedBy() bool` + +HasCreatedBy returns a boolean if a field has been set. + +### SetCreatedBy + +`func (o *RevisionVersion) SetCreatedBy(v int32)` + +SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. + +### GetRevisionId + +`func (o *RevisionVersion) GetRevisionId() int32` + +GetRevisionId returns the RevisionId field if non-nil, zero value otherwise. + +### GetRevisionIdOk + +`func (o *RevisionVersion) GetRevisionIdOk() (int32, bool)` + +GetRevisionIdOk returns a tuple with the RevisionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasRevisionId + +`func (o *RevisionVersion) HasRevisionId() bool` + +HasRevisionId returns a boolean if a field has been set. + +### SetRevisionId + +`func (o *RevisionVersion) SetRevisionId(v int32)` + +SetRevisionId gets a reference to the given int32 and assigns it to the RevisionId field. + +### GetVersion + +`func (o *RevisionVersion) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *RevisionVersion) GetVersionOk() (int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasVersion + +`func (o *RevisionVersion) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersion + +`func (o *RevisionVersion) SetVersion(v int32)` + +SetVersion gets a reference to the given int32 and assigns it to the Version field. + +### GetName + +`func (o *RevisionVersion) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RevisionVersion) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *RevisionVersion) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *RevisionVersion) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetStartTime + +`func (o *RevisionVersion) GetStartTime() NullableTime` + +GetStartTime returns the StartTime field if non-nil, zero value otherwise. + +### GetStartTimeOk + +`func (o *RevisionVersion) GetStartTimeOk() (NullableTime, bool)` + +GetStartTimeOk returns a tuple with the StartTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartTime + +`func (o *RevisionVersion) HasStartTime() bool` + +HasStartTime returns a boolean if a field has been set. + +### SetStartTime + +`func (o *RevisionVersion) SetStartTime(v NullableTime)` + +SetStartTime gets a reference to the given NullableTime and assigns it to the StartTime field. + +### SetStartTimeExplicitNull + +`func (o *RevisionVersion) SetStartTimeExplicitNull(b bool)` + +SetStartTimeExplicitNull (un)sets StartTime to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The StartTime value is set to nil even if false is passed +### GetEndTime + +`func (o *RevisionVersion) GetEndTime() NullableTime` + +GetEndTime returns the EndTime field if non-nil, zero value otherwise. + +### GetEndTimeOk + +`func (o *RevisionVersion) GetEndTimeOk() (NullableTime, bool)` + +GetEndTimeOk returns a tuple with the EndTime field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEndTime + +`func (o *RevisionVersion) HasEndTime() bool` + +HasEndTime returns a boolean if a field has been set. + +### SetEndTime + +`func (o *RevisionVersion) SetEndTime(v NullableTime)` + +SetEndTime gets a reference to the given NullableTime and assigns it to the EndTime field. + +### SetEndTimeExplicitNull + +`func (o *RevisionVersion) SetEndTimeExplicitNull(b bool)` + +SetEndTimeExplicitNull (un)sets EndTime to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The EndTime value is set to nil even if false is passed +### GetAttributes + +`func (o *RevisionVersion) GetAttributes() map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *RevisionVersion) GetAttributesOk() (map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *RevisionVersion) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *RevisionVersion) SetAttributes(v map[string]interface{})` + +SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. + +### GetDescription + +`func (o *RevisionVersion) GetDescription() NullableString` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *RevisionVersion) GetDescriptionOk() (NullableString, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *RevisionVersion) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *RevisionVersion) SetDescription(v NullableString)` + +SetDescription gets a reference to the given NullableString and assigns it to the Description field. + +### SetDescriptionExplicitNull + +`func (o *RevisionVersion) SetDescriptionExplicitNull(b bool)` + +SetDescriptionExplicitNull (un)sets Description to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The Description value is set to nil even if false is passed +### GetActiveRulesetId + +`func (o *RevisionVersion) GetActiveRulesetId() NullableInt32` + +GetActiveRulesetId returns the ActiveRulesetId field if non-nil, zero value otherwise. + +### GetActiveRulesetIdOk + +`func (o *RevisionVersion) GetActiveRulesetIdOk() (NullableInt32, bool)` + +GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveRulesetId + +`func (o *RevisionVersion) HasActiveRulesetId() bool` + +HasActiveRulesetId returns a boolean if a field has been set. + +### SetActiveRulesetId + +`func (o *RevisionVersion) SetActiveRulesetId(v NullableInt32)` + +SetActiveRulesetId gets a reference to the given NullableInt32 and assigns it to the ActiveRulesetId field. + +### SetActiveRulesetIdExplicitNull + +`func (o *RevisionVersion) SetActiveRulesetIdExplicitNull(b bool)` + +SetActiveRulesetIdExplicitNull (un)sets ActiveRulesetId to be considered as explicit "null" value +when serializing to JSON (pass true as argument to set this, false to unset) +The ActiveRulesetId value is set to nil even if false is passed +### GetTags + +`func (o *RevisionVersion) GetTags() []string` + +GetTags returns the Tags field if non-nil, zero value otherwise. + +### GetTagsOk + +`func (o *RevisionVersion) GetTagsOk() ([]string, bool)` + +GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTags + +`func (o *RevisionVersion) HasTags() bool` + +HasTags returns a boolean if a field has been set. + +### SetTags + +`func (o *RevisionVersion) SetTags(v []string)` + +SetTags gets a reference to the given []string and assigns it to the Tags field. + +### GetCouponSettings + +`func (o *RevisionVersion) GetCouponSettings() CodeGeneratorSettings` + +GetCouponSettings returns the CouponSettings field if non-nil, zero value otherwise. + +### GetCouponSettingsOk + +`func (o *RevisionVersion) GetCouponSettingsOk() (CodeGeneratorSettings, bool)` + +GetCouponSettingsOk returns a tuple with the CouponSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCouponSettings + +`func (o *RevisionVersion) HasCouponSettings() bool` + +HasCouponSettings returns a boolean if a field has been set. + +### SetCouponSettings + +`func (o *RevisionVersion) SetCouponSettings(v CodeGeneratorSettings)` + +SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. + +### GetReferralSettings + +`func (o *RevisionVersion) GetReferralSettings() CodeGeneratorSettings` + +GetReferralSettings returns the ReferralSettings field if non-nil, zero value otherwise. + +### GetReferralSettingsOk + +`func (o *RevisionVersion) GetReferralSettingsOk() (CodeGeneratorSettings, bool)` + +GetReferralSettingsOk returns a tuple with the ReferralSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasReferralSettings + +`func (o *RevisionVersion) HasReferralSettings() bool` + +HasReferralSettings returns a boolean if a field has been set. + +### SetReferralSettings + +`func (o *RevisionVersion) SetReferralSettings(v CodeGeneratorSettings)` + +SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. + +### GetLimits + +`func (o *RevisionVersion) GetLimits() []LimitConfig` + +GetLimits returns the Limits field if non-nil, zero value otherwise. + +### GetLimitsOk + +`func (o *RevisionVersion) GetLimitsOk() ([]LimitConfig, bool)` + +GetLimitsOk returns a tuple with the Limits field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasLimits + +`func (o *RevisionVersion) HasLimits() bool` + +HasLimits returns a boolean if a field has been set. + +### SetLimits + +`func (o *RevisionVersion) SetLimits(v []LimitConfig)` + +SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. + +### GetFeatures + +`func (o *RevisionVersion) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *RevisionVersion) GetFeaturesOk() ([]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFeatures + +`func (o *RevisionVersion) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### SetFeatures + +`func (o *RevisionVersion) SetFeatures(v []string)` + +SetFeatures gets a reference to the given []string and assigns it to the Features field. + + +[[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/RoleV2PermissionsRoles.md b/docs/RoleV2PermissionsRoles.md deleted file mode 100644 index 112f0a8f..00000000 --- a/docs/RoleV2PermissionsRoles.md +++ /dev/null @@ -1,91 +0,0 @@ -# RoleV2PermissionsRoles - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Applications** | Pointer to [**map[string]RoleV2ApplicationDetails**](RoleV2ApplicationDetails.md) | | [optional] -**LoyaltyPrograms** | Pointer to **map[string]string** | | [optional] -**CampaignAccessGroups** | Pointer to **map[string]string** | | [optional] - -## Methods - -### GetApplications - -`func (o *RoleV2PermissionsRoles) GetApplications() map[string]RoleV2ApplicationDetails` - -GetApplications returns the Applications field if non-nil, zero value otherwise. - -### GetApplicationsOk - -`func (o *RoleV2PermissionsRoles) GetApplicationsOk() (map[string]RoleV2ApplicationDetails, bool)` - -GetApplicationsOk returns a tuple with the Applications field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasApplications - -`func (o *RoleV2PermissionsRoles) HasApplications() bool` - -HasApplications returns a boolean if a field has been set. - -### SetApplications - -`func (o *RoleV2PermissionsRoles) SetApplications(v map[string]RoleV2ApplicationDetails)` - -SetApplications gets a reference to the given map[string]RoleV2ApplicationDetails and assigns it to the Applications field. - -### GetLoyaltyPrograms - -`func (o *RoleV2PermissionsRoles) GetLoyaltyPrograms() map[string]string` - -GetLoyaltyPrograms returns the LoyaltyPrograms field if non-nil, zero value otherwise. - -### GetLoyaltyProgramsOk - -`func (o *RoleV2PermissionsRoles) GetLoyaltyProgramsOk() (map[string]string, bool)` - -GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLoyaltyPrograms - -`func (o *RoleV2PermissionsRoles) HasLoyaltyPrograms() bool` - -HasLoyaltyPrograms returns a boolean if a field has been set. - -### SetLoyaltyPrograms - -`func (o *RoleV2PermissionsRoles) SetLoyaltyPrograms(v map[string]string)` - -SetLoyaltyPrograms gets a reference to the given map[string]string and assigns it to the LoyaltyPrograms field. - -### GetCampaignAccessGroups - -`func (o *RoleV2PermissionsRoles) GetCampaignAccessGroups() map[string]string` - -GetCampaignAccessGroups returns the CampaignAccessGroups field if non-nil, zero value otherwise. - -### GetCampaignAccessGroupsOk - -`func (o *RoleV2PermissionsRoles) GetCampaignAccessGroupsOk() (map[string]string, bool)` - -GetCampaignAccessGroupsOk returns a tuple with the CampaignAccessGroups field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasCampaignAccessGroups - -`func (o *RoleV2PermissionsRoles) HasCampaignAccessGroups() bool` - -HasCampaignAccessGroups returns a boolean if a field has been set. - -### SetCampaignAccessGroups - -`func (o *RoleV2PermissionsRoles) SetCampaignAccessGroups(v map[string]string)` - -SetCampaignAccessGroups gets a reference to the given map[string]string and assigns it to the CampaignAccessGroups field. - - -[[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/RollbackIncreasedAchievementProgressEffectProps.md b/docs/RollbackIncreasedAchievementProgressEffectProps.md new file mode 100644 index 00000000..e19e4c94 --- /dev/null +++ b/docs/RollbackIncreasedAchievementProgressEffectProps.md @@ -0,0 +1,169 @@ +# RollbackIncreasedAchievementProgressEffectProps + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AchievementId** | Pointer to **int32** | The internal ID of the achievement. | +**AchievementName** | Pointer to **string** | The name of the achievement. | +**ProgressTrackerId** | Pointer to **int32** | The internal ID of the achievement progress tracker. | +**DecreaseProgressBy** | Pointer to **float32** | The value by which the customer's current progress in the achievement is decreased. | +**CurrentProgress** | Pointer to **float32** | The current progress of the customer in the achievement. | +**Target** | Pointer to **float32** | The target value to complete the achievement. | + +## Methods + +### GetAchievementId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementId() int32` + +GetAchievementId returns the AchievementId field if non-nil, zero value otherwise. + +### GetAchievementIdOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementIdOk() (int32, bool)` + +GetAchievementIdOk returns a tuple with the AchievementId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAchievementId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasAchievementId() bool` + +HasAchievementId returns a boolean if a field has been set. + +### SetAchievementId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetAchievementId(v int32)` + +SetAchievementId gets a reference to the given int32 and assigns it to the AchievementId field. + +### GetAchievementName + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementName() string` + +GetAchievementName returns the AchievementName field if non-nil, zero value otherwise. + +### GetAchievementNameOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementNameOk() (string, bool)` + +GetAchievementNameOk returns a tuple with the AchievementName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAchievementName + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasAchievementName() bool` + +HasAchievementName returns a boolean if a field has been set. + +### SetAchievementName + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetAchievementName(v string)` + +SetAchievementName gets a reference to the given string and assigns it to the AchievementName field. + +### GetProgressTrackerId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetProgressTrackerId() int32` + +GetProgressTrackerId returns the ProgressTrackerId field if non-nil, zero value otherwise. + +### GetProgressTrackerIdOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetProgressTrackerIdOk() (int32, bool)` + +GetProgressTrackerIdOk returns a tuple with the ProgressTrackerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgressTrackerId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasProgressTrackerId() bool` + +HasProgressTrackerId returns a boolean if a field has been set. + +### SetProgressTrackerId + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetProgressTrackerId(v int32)` + +SetProgressTrackerId gets a reference to the given int32 and assigns it to the ProgressTrackerId field. + +### GetDecreaseProgressBy + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetDecreaseProgressBy() float32` + +GetDecreaseProgressBy returns the DecreaseProgressBy field if non-nil, zero value otherwise. + +### GetDecreaseProgressByOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetDecreaseProgressByOk() (float32, bool)` + +GetDecreaseProgressByOk returns a tuple with the DecreaseProgressBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDecreaseProgressBy + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasDecreaseProgressBy() bool` + +HasDecreaseProgressBy returns a boolean if a field has been set. + +### SetDecreaseProgressBy + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetDecreaseProgressBy(v float32)` + +SetDecreaseProgressBy gets a reference to the given float32 and assigns it to the DecreaseProgressBy field. + +### GetCurrentProgress + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetCurrentProgress() float32` + +GetCurrentProgress returns the CurrentProgress field if non-nil, zero value otherwise. + +### GetCurrentProgressOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetCurrentProgressOk() (float32, bool)` + +GetCurrentProgressOk returns a tuple with the CurrentProgress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasCurrentProgress + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasCurrentProgress() bool` + +HasCurrentProgress returns a boolean if a field has been set. + +### SetCurrentProgress + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetCurrentProgress(v float32)` + +SetCurrentProgress gets a reference to the given float32 and assigns it to the CurrentProgress field. + +### GetTarget + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetTarget() float32` + +GetTarget returns the Target field if non-nil, zero value otherwise. + +### GetTargetOk + +`func (o *RollbackIncreasedAchievementProgressEffectProps) GetTargetOk() (float32, bool)` + +GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTarget + +`func (o *RollbackIncreasedAchievementProgressEffectProps) HasTarget() bool` + +HasTarget returns a boolean if a field has been set. + +### SetTarget + +`func (o *RollbackIncreasedAchievementProgressEffectProps) SetTarget(v float32)` + +SetTarget gets a reference to the given float32 and assigns it to the Target field. + + +[[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/Rule.md b/docs/Rule.md index 95a057ad..94af45c1 100644 --- a/docs/Rule.md +++ b/docs/Rule.md @@ -10,8 +10,7 @@ Name | Type | Description | Notes **Description** | Pointer to **string** | A longer, more detailed description of the rule. | [optional] **Bindings** | Pointer to [**[]Binding**](Binding.md) | An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. | [optional] **Condition** | Pointer to [**[]interface{}**]([]interface{}.md) | A Talang expression that will be evaluated in the context of the given event. | - -**Effects** | Pointer to [**[][]interface{}**]([][]interface{}].md) | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | +**Effects** | Pointer to [**[][]interface{}**]([][]interface{}.md) | An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. | ## Methods diff --git a/docs/RuleFailureReason.md b/docs/RuleFailureReason.md index 3979d224..8e20c361 100644 --- a/docs/RuleFailureReason.md +++ b/docs/RuleFailureReason.md @@ -16,6 +16,8 @@ Name | Type | Description | Notes **ConditionIndex** | Pointer to **int32** | The index of the condition that failed. | [optional] **EffectIndex** | Pointer to **int32** | The index of the effect that failed. | [optional] **Details** | Pointer to **string** | More details about the failure. | [optional] +**EvaluationGroupID** | Pointer to **int32** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional] +**EvaluationGroupMode** | Pointer to **string** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign- | [optional] ## Methods @@ -319,6 +321,56 @@ HasDetails returns a boolean if a field has been set. SetDetails gets a reference to the given string and assigns it to the Details field. +### GetEvaluationGroupID + +`func (o *RuleFailureReason) GetEvaluationGroupID() int32` + +GetEvaluationGroupID returns the EvaluationGroupID field if non-nil, zero value otherwise. + +### GetEvaluationGroupIDOk + +`func (o *RuleFailureReason) GetEvaluationGroupIDOk() (int32, bool)` + +GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupID + +`func (o *RuleFailureReason) HasEvaluationGroupID() bool` + +HasEvaluationGroupID returns a boolean if a field has been set. + +### SetEvaluationGroupID + +`func (o *RuleFailureReason) SetEvaluationGroupID(v int32)` + +SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. + +### GetEvaluationGroupMode + +`func (o *RuleFailureReason) GetEvaluationGroupMode() string` + +GetEvaluationGroupMode returns the EvaluationGroupMode field if non-nil, zero value otherwise. + +### GetEvaluationGroupModeOk + +`func (o *RuleFailureReason) GetEvaluationGroupModeOk() (string, bool)` + +GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEvaluationGroupMode + +`func (o *RuleFailureReason) HasEvaluationGroupMode() bool` + +HasEvaluationGroupMode returns a boolean if a field has been set. + +### SetEvaluationGroupMode + +`func (o *RuleFailureReason) SetEvaluationGroupMode(v string)` + +SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. + [[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/ScimBaseUser.md b/docs/ScimBaseUser.md new file mode 100644 index 00000000..3042af8a --- /dev/null +++ b/docs/ScimBaseUser.md @@ -0,0 +1,117 @@ +# ScimBaseUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Active** | Pointer to **bool** | Status of the user. | [optional] +**DisplayName** | Pointer to **string** | Display name of the user. | [optional] +**UserName** | Pointer to **string** | Unique identifier of the user. This is usually an email address. | [optional] +**Name** | Pointer to [**ScimBaseUserName**](ScimBaseUser_name.md) | | [optional] + +## Methods + +### GetActive + +`func (o *ScimBaseUser) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *ScimBaseUser) GetActiveOk() (bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActive + +`func (o *ScimBaseUser) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### SetActive + +`func (o *ScimBaseUser) SetActive(v bool)` + +SetActive gets a reference to the given bool and assigns it to the Active field. + +### GetDisplayName + +`func (o *ScimBaseUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ScimBaseUser) GetDisplayNameOk() (string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDisplayName + +`func (o *ScimBaseUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayName + +`func (o *ScimBaseUser) SetDisplayName(v string)` + +SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. + +### GetUserName + +`func (o *ScimBaseUser) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *ScimBaseUser) GetUserNameOk() (string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserName + +`func (o *ScimBaseUser) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### SetUserName + +`func (o *ScimBaseUser) SetUserName(v string)` + +SetUserName gets a reference to the given string and assigns it to the UserName field. + +### GetName + +`func (o *ScimBaseUser) GetName() ScimBaseUserName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScimBaseUser) GetNameOk() (ScimBaseUserName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ScimBaseUser) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ScimBaseUser) SetName(v ScimBaseUserName)` + +SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. + + +[[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/ScimBaseUserName.md b/docs/ScimBaseUserName.md new file mode 100644 index 00000000..4e8f2a4a --- /dev/null +++ b/docs/ScimBaseUserName.md @@ -0,0 +1,39 @@ +# ScimBaseUserName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Formatted** | Pointer to **string** | The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. | [optional] + +## Methods + +### GetFormatted + +`func (o *ScimBaseUserName) GetFormatted() string` + +GetFormatted returns the Formatted field if non-nil, zero value otherwise. + +### GetFormattedOk + +`func (o *ScimBaseUserName) GetFormattedOk() (string, bool)` + +GetFormattedOk returns a tuple with the Formatted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFormatted + +`func (o *ScimBaseUserName) HasFormatted() bool` + +HasFormatted returns a boolean if a field has been set. + +### SetFormatted + +`func (o *ScimBaseUserName) SetFormatted(v string)` + +SetFormatted gets a reference to the given string and assigns it to the Formatted field. + + +[[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/ScimNewUser.md b/docs/ScimNewUser.md new file mode 100644 index 00000000..136a2d0a --- /dev/null +++ b/docs/ScimNewUser.md @@ -0,0 +1,117 @@ +# ScimNewUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Active** | Pointer to **bool** | Status of the user. | [optional] +**DisplayName** | Pointer to **string** | Display name of the user. | [optional] +**UserName** | Pointer to **string** | Unique identifier of the user. This is usually an email address. | [optional] +**Name** | Pointer to [**ScimBaseUserName**](ScimBaseUser_name.md) | | [optional] + +## Methods + +### GetActive + +`func (o *ScimNewUser) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *ScimNewUser) GetActiveOk() (bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActive + +`func (o *ScimNewUser) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### SetActive + +`func (o *ScimNewUser) SetActive(v bool)` + +SetActive gets a reference to the given bool and assigns it to the Active field. + +### GetDisplayName + +`func (o *ScimNewUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ScimNewUser) GetDisplayNameOk() (string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDisplayName + +`func (o *ScimNewUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayName + +`func (o *ScimNewUser) SetDisplayName(v string)` + +SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. + +### GetUserName + +`func (o *ScimNewUser) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *ScimNewUser) GetUserNameOk() (string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserName + +`func (o *ScimNewUser) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### SetUserName + +`func (o *ScimNewUser) SetUserName(v string)` + +SetUserName gets a reference to the given string and assigns it to the UserName field. + +### GetName + +`func (o *ScimNewUser) GetName() ScimBaseUserName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScimNewUser) GetNameOk() (ScimBaseUserName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ScimNewUser) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ScimNewUser) SetName(v ScimBaseUserName)` + +SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. + + +[[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/ScimPatchOperation.md b/docs/ScimPatchOperation.md new file mode 100644 index 00000000..a1852bea --- /dev/null +++ b/docs/ScimPatchOperation.md @@ -0,0 +1,91 @@ +# ScimPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **string** | The method that should be used in the operation. | +**Path** | Pointer to **string** | The path specifying the attribute that should be updated. | [optional] +**Value** | Pointer to **string** | The value that should be updated. Required if `op` is `add` or `replace`. | [optional] + +## Methods + +### GetOp + +`func (o *ScimPatchOperation) GetOp() string` + +GetOp returns the Op field if non-nil, zero value otherwise. + +### GetOpOk + +`func (o *ScimPatchOperation) GetOpOk() (string, bool)` + +GetOpOk returns a tuple with the Op field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOp + +`func (o *ScimPatchOperation) HasOp() bool` + +HasOp returns a boolean if a field has been set. + +### SetOp + +`func (o *ScimPatchOperation) SetOp(v string)` + +SetOp gets a reference to the given string and assigns it to the Op field. + +### GetPath + +`func (o *ScimPatchOperation) GetPath() string` + +GetPath returns the Path field if non-nil, zero value otherwise. + +### GetPathOk + +`func (o *ScimPatchOperation) GetPathOk() (string, bool)` + +GetPathOk returns a tuple with the Path field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPath + +`func (o *ScimPatchOperation) HasPath() bool` + +HasPath returns a boolean if a field has been set. + +### SetPath + +`func (o *ScimPatchOperation) SetPath(v string)` + +SetPath gets a reference to the given string and assigns it to the Path field. + +### GetValue + +`func (o *ScimPatchOperation) GetValue() string` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *ScimPatchOperation) GetValueOk() (string, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasValue + +`func (o *ScimPatchOperation) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### SetValue + +`func (o *ScimPatchOperation) SetValue(v string)` + +SetValue gets a reference to the given string and assigns it to the Value field. + + +[[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/ScimPatchRequest.md b/docs/ScimPatchRequest.md new file mode 100644 index 00000000..d6344b4e --- /dev/null +++ b/docs/ScimPatchRequest.md @@ -0,0 +1,65 @@ +# ScimPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Schemas** | Pointer to **[]string** | SCIM schema for the given resource. | [optional] +**Operations** | Pointer to [**[]ScimPatchOperation**](ScimPatchOperation.md) | | + +## Methods + +### GetSchemas + +`func (o *ScimPatchRequest) GetSchemas() []string` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *ScimPatchRequest) GetSchemasOk() ([]string, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSchemas + +`func (o *ScimPatchRequest) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### SetSchemas + +`func (o *ScimPatchRequest) SetSchemas(v []string)` + +SetSchemas gets a reference to the given []string and assigns it to the Schemas field. + +### GetOperations + +`func (o *ScimPatchRequest) GetOperations() []ScimPatchOperation` + +GetOperations returns the Operations field if non-nil, zero value otherwise. + +### GetOperationsOk + +`func (o *ScimPatchRequest) GetOperationsOk() ([]ScimPatchOperation, bool)` + +GetOperationsOk returns a tuple with the Operations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasOperations + +`func (o *ScimPatchRequest) HasOperations() bool` + +HasOperations returns a boolean if a field has been set. + +### SetOperations + +`func (o *ScimPatchRequest) SetOperations(v []ScimPatchOperation)` + +SetOperations gets a reference to the given []ScimPatchOperation and assigns it to the Operations field. + + +[[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/ScimResource.md b/docs/ScimResource.md new file mode 100644 index 00000000..093886dc --- /dev/null +++ b/docs/ScimResource.md @@ -0,0 +1,91 @@ +# ScimResource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the resource. | [optional] +**Name** | Pointer to **string** | Name of the resource. | [optional] +**Description** | Pointer to **string** | Human-readable description of the resource. | [optional] + +## Methods + +### GetId + +`func (o *ScimResource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScimResource) GetIdOk() (string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ScimResource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ScimResource) SetId(v string)` + +SetId gets a reference to the given string and assigns it to the Id field. + +### GetName + +`func (o *ScimResource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScimResource) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ScimResource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ScimResource) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *ScimResource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScimResource) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *ScimResource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *ScimResource) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + + +[[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/ScimResourceTypesListResponse.md b/docs/ScimResourceTypesListResponse.md new file mode 100644 index 00000000..f4cfcec4 --- /dev/null +++ b/docs/ScimResourceTypesListResponse.md @@ -0,0 +1,39 @@ +# ScimResourceTypesListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Resources** | Pointer to [**[]ScimResource**](ScimResource.md) | | + +## Methods + +### GetResources + +`func (o *ScimResourceTypesListResponse) GetResources() []ScimResource` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *ScimResourceTypesListResponse) GetResourcesOk() ([]ScimResource, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResources + +`func (o *ScimResourceTypesListResponse) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### SetResources + +`func (o *ScimResourceTypesListResponse) SetResources(v []ScimResource)` + +SetResources gets a reference to the given []ScimResource and assigns it to the Resources field. + + +[[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/ScimSchemaResource.md b/docs/ScimSchemaResource.md new file mode 100644 index 00000000..adbb4a2f --- /dev/null +++ b/docs/ScimSchemaResource.md @@ -0,0 +1,117 @@ +# ScimSchemaResource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | ID of the resource. | [optional] +**Name** | Pointer to **string** | Name of the resource. | [optional] +**Description** | Pointer to **string** | Human-readable description of the schema resource. | [optional] +**Attributes** | Pointer to [**[]map[string]interface{}**](map[string]interface{}.md) | | [optional] + +## Methods + +### GetId + +`func (o *ScimSchemaResource) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScimSchemaResource) GetIdOk() (string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ScimSchemaResource) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ScimSchemaResource) SetId(v string)` + +SetId gets a reference to the given string and assigns it to the Id field. + +### GetName + +`func (o *ScimSchemaResource) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScimSchemaResource) GetNameOk() (string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ScimSchemaResource) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ScimSchemaResource) SetName(v string)` + +SetName gets a reference to the given string and assigns it to the Name field. + +### GetDescription + +`func (o *ScimSchemaResource) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *ScimSchemaResource) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *ScimSchemaResource) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *ScimSchemaResource) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetAttributes + +`func (o *ScimSchemaResource) GetAttributes() []map[string]interface{}` + +GetAttributes returns the Attributes field if non-nil, zero value otherwise. + +### GetAttributesOk + +`func (o *ScimSchemaResource) GetAttributesOk() ([]map[string]interface{}, bool)` + +GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAttributes + +`func (o *ScimSchemaResource) HasAttributes() bool` + +HasAttributes returns a boolean if a field has been set. + +### SetAttributes + +`func (o *ScimSchemaResource) SetAttributes(v []map[string]interface{})` + +SetAttributes gets a reference to the given []map[string]interface{} and assigns it to the Attributes field. + + +[[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/ScimSchemasListResponse.md b/docs/ScimSchemasListResponse.md new file mode 100644 index 00000000..65c3856f --- /dev/null +++ b/docs/ScimSchemasListResponse.md @@ -0,0 +1,91 @@ +# ScimSchemasListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Resources** | Pointer to [**[]ScimSchemaResource**](ScimSchemaResource.md) | | +**Schemas** | Pointer to **[]string** | SCIM schema for the given resource. | [optional] +**TotalResults** | Pointer to **int32** | Number of total results in the response. | [optional] + +## Methods + +### GetResources + +`func (o *ScimSchemasListResponse) GetResources() []ScimSchemaResource` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *ScimSchemasListResponse) GetResourcesOk() ([]ScimSchemaResource, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResources + +`func (o *ScimSchemasListResponse) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### SetResources + +`func (o *ScimSchemasListResponse) SetResources(v []ScimSchemaResource)` + +SetResources gets a reference to the given []ScimSchemaResource and assigns it to the Resources field. + +### GetSchemas + +`func (o *ScimSchemasListResponse) GetSchemas() []string` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *ScimSchemasListResponse) GetSchemasOk() ([]string, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSchemas + +`func (o *ScimSchemasListResponse) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### SetSchemas + +`func (o *ScimSchemasListResponse) SetSchemas(v []string)` + +SetSchemas gets a reference to the given []string and assigns it to the Schemas field. + +### GetTotalResults + +`func (o *ScimSchemasListResponse) GetTotalResults() int32` + +GetTotalResults returns the TotalResults field if non-nil, zero value otherwise. + +### GetTotalResultsOk + +`func (o *ScimSchemasListResponse) GetTotalResultsOk() (int32, bool)` + +GetTotalResultsOk returns a tuple with the TotalResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResults + +`func (o *ScimSchemasListResponse) HasTotalResults() bool` + +HasTotalResults returns a boolean if a field has been set. + +### SetTotalResults + +`func (o *ScimSchemasListResponse) SetTotalResults(v int32)` + +SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field. + + +[[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/ScimServiceProviderConfigResponse.md b/docs/ScimServiceProviderConfigResponse.md new file mode 100644 index 00000000..60e4b06a --- /dev/null +++ b/docs/ScimServiceProviderConfigResponse.md @@ -0,0 +1,169 @@ +# ScimServiceProviderConfigResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Bulk** | Pointer to [**ScimServiceProviderConfigResponseBulk**](ScimServiceProviderConfigResponse_bulk.md) | | [optional] +**ChangePassword** | Pointer to [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponse_changePassword.md) | | [optional] +**DocumentationUri** | Pointer to **string** | The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. | [optional] +**Filter** | Pointer to [**ScimServiceProviderConfigResponseFilter**](ScimServiceProviderConfigResponse_filter.md) | | [optional] +**Patch** | Pointer to [**ScimServiceProviderConfigResponsePatch**](ScimServiceProviderConfigResponse_patch.md) | | [optional] +**Schemas** | Pointer to **[]string** | A list of SCIM schemas that define the structure and data types supported by the service provider. | [optional] + +## Methods + +### GetBulk + +`func (o *ScimServiceProviderConfigResponse) GetBulk() ScimServiceProviderConfigResponseBulk` + +GetBulk returns the Bulk field if non-nil, zero value otherwise. + +### GetBulkOk + +`func (o *ScimServiceProviderConfigResponse) GetBulkOk() (ScimServiceProviderConfigResponseBulk, bool)` + +GetBulkOk returns a tuple with the Bulk field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBulk + +`func (o *ScimServiceProviderConfigResponse) HasBulk() bool` + +HasBulk returns a boolean if a field has been set. + +### SetBulk + +`func (o *ScimServiceProviderConfigResponse) SetBulk(v ScimServiceProviderConfigResponseBulk)` + +SetBulk gets a reference to the given ScimServiceProviderConfigResponseBulk and assigns it to the Bulk field. + +### GetChangePassword + +`func (o *ScimServiceProviderConfigResponse) GetChangePassword() ScimServiceProviderConfigResponseChangePassword` + +GetChangePassword returns the ChangePassword field if non-nil, zero value otherwise. + +### GetChangePasswordOk + +`func (o *ScimServiceProviderConfigResponse) GetChangePasswordOk() (ScimServiceProviderConfigResponseChangePassword, bool)` + +GetChangePasswordOk returns a tuple with the ChangePassword field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasChangePassword + +`func (o *ScimServiceProviderConfigResponse) HasChangePassword() bool` + +HasChangePassword returns a boolean if a field has been set. + +### SetChangePassword + +`func (o *ScimServiceProviderConfigResponse) SetChangePassword(v ScimServiceProviderConfigResponseChangePassword)` + +SetChangePassword gets a reference to the given ScimServiceProviderConfigResponseChangePassword and assigns it to the ChangePassword field. + +### GetDocumentationUri + +`func (o *ScimServiceProviderConfigResponse) GetDocumentationUri() string` + +GetDocumentationUri returns the DocumentationUri field if non-nil, zero value otherwise. + +### GetDocumentationUriOk + +`func (o *ScimServiceProviderConfigResponse) GetDocumentationUriOk() (string, bool)` + +GetDocumentationUriOk returns a tuple with the DocumentationUri field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDocumentationUri + +`func (o *ScimServiceProviderConfigResponse) HasDocumentationUri() bool` + +HasDocumentationUri returns a boolean if a field has been set. + +### SetDocumentationUri + +`func (o *ScimServiceProviderConfigResponse) SetDocumentationUri(v string)` + +SetDocumentationUri gets a reference to the given string and assigns it to the DocumentationUri field. + +### GetFilter + +`func (o *ScimServiceProviderConfigResponse) GetFilter() ScimServiceProviderConfigResponseFilter` + +GetFilter returns the Filter field if non-nil, zero value otherwise. + +### GetFilterOk + +`func (o *ScimServiceProviderConfigResponse) GetFilterOk() (ScimServiceProviderConfigResponseFilter, bool)` + +GetFilterOk returns a tuple with the Filter field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasFilter + +`func (o *ScimServiceProviderConfigResponse) HasFilter() bool` + +HasFilter returns a boolean if a field has been set. + +### SetFilter + +`func (o *ScimServiceProviderConfigResponse) SetFilter(v ScimServiceProviderConfigResponseFilter)` + +SetFilter gets a reference to the given ScimServiceProviderConfigResponseFilter and assigns it to the Filter field. + +### GetPatch + +`func (o *ScimServiceProviderConfigResponse) GetPatch() ScimServiceProviderConfigResponsePatch` + +GetPatch returns the Patch field if non-nil, zero value otherwise. + +### GetPatchOk + +`func (o *ScimServiceProviderConfigResponse) GetPatchOk() (ScimServiceProviderConfigResponsePatch, bool)` + +GetPatchOk returns a tuple with the Patch field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasPatch + +`func (o *ScimServiceProviderConfigResponse) HasPatch() bool` + +HasPatch returns a boolean if a field has been set. + +### SetPatch + +`func (o *ScimServiceProviderConfigResponse) SetPatch(v ScimServiceProviderConfigResponsePatch)` + +SetPatch gets a reference to the given ScimServiceProviderConfigResponsePatch and assigns it to the Patch field. + +### GetSchemas + +`func (o *ScimServiceProviderConfigResponse) GetSchemas() []string` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *ScimServiceProviderConfigResponse) GetSchemasOk() ([]string, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSchemas + +`func (o *ScimServiceProviderConfigResponse) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### SetSchemas + +`func (o *ScimServiceProviderConfigResponse) SetSchemas(v []string)` + +SetSchemas gets a reference to the given []string and assigns it to the Schemas field. + + +[[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/ScimServiceProviderConfigResponseBulk.md b/docs/ScimServiceProviderConfigResponseBulk.md new file mode 100644 index 00000000..a4f85ffd --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseBulk.md @@ -0,0 +1,91 @@ +# ScimServiceProviderConfigResponseBulk + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxOperations** | Pointer to **int32** | The maximum number of individual operations that can be included in a single bulk request. | [optional] +**MaxPayloadSize** | Pointer to **int32** | The maximum size, in bytes, of the entire payload for a bulk operation request. | [optional] +**Supported** | Pointer to **bool** | Indicates whether the SCIM service provider supports bulk operations. | [optional] + +## Methods + +### GetMaxOperations + +`func (o *ScimServiceProviderConfigResponseBulk) GetMaxOperations() int32` + +GetMaxOperations returns the MaxOperations field if non-nil, zero value otherwise. + +### GetMaxOperationsOk + +`func (o *ScimServiceProviderConfigResponseBulk) GetMaxOperationsOk() (int32, bool)` + +GetMaxOperationsOk returns a tuple with the MaxOperations field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMaxOperations + +`func (o *ScimServiceProviderConfigResponseBulk) HasMaxOperations() bool` + +HasMaxOperations returns a boolean if a field has been set. + +### SetMaxOperations + +`func (o *ScimServiceProviderConfigResponseBulk) SetMaxOperations(v int32)` + +SetMaxOperations gets a reference to the given int32 and assigns it to the MaxOperations field. + +### GetMaxPayloadSize + +`func (o *ScimServiceProviderConfigResponseBulk) GetMaxPayloadSize() int32` + +GetMaxPayloadSize returns the MaxPayloadSize field if non-nil, zero value otherwise. + +### GetMaxPayloadSizeOk + +`func (o *ScimServiceProviderConfigResponseBulk) GetMaxPayloadSizeOk() (int32, bool)` + +GetMaxPayloadSizeOk returns a tuple with the MaxPayloadSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMaxPayloadSize + +`func (o *ScimServiceProviderConfigResponseBulk) HasMaxPayloadSize() bool` + +HasMaxPayloadSize returns a boolean if a field has been set. + +### SetMaxPayloadSize + +`func (o *ScimServiceProviderConfigResponseBulk) SetMaxPayloadSize(v int32)` + +SetMaxPayloadSize gets a reference to the given int32 and assigns it to the MaxPayloadSize field. + +### GetSupported + +`func (o *ScimServiceProviderConfigResponseBulk) GetSupported() bool` + +GetSupported returns the Supported field if non-nil, zero value otherwise. + +### GetSupportedOk + +`func (o *ScimServiceProviderConfigResponseBulk) GetSupportedOk() (bool, bool)` + +GetSupportedOk returns a tuple with the Supported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSupported + +`func (o *ScimServiceProviderConfigResponseBulk) HasSupported() bool` + +HasSupported returns a boolean if a field has been set. + +### SetSupported + +`func (o *ScimServiceProviderConfigResponseBulk) SetSupported(v bool)` + +SetSupported gets a reference to the given bool and assigns it to the Supported field. + + +[[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/ScimServiceProviderConfigResponseChangePassword.md b/docs/ScimServiceProviderConfigResponseChangePassword.md new file mode 100644 index 00000000..800ab1f9 --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseChangePassword.md @@ -0,0 +1,39 @@ +# ScimServiceProviderConfigResponseChangePassword + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Supported** | Pointer to **bool** | Indicates whether the service provider supports password changes via the SCIM API. | [optional] + +## Methods + +### GetSupported + +`func (o *ScimServiceProviderConfigResponseChangePassword) GetSupported() bool` + +GetSupported returns the Supported field if non-nil, zero value otherwise. + +### GetSupportedOk + +`func (o *ScimServiceProviderConfigResponseChangePassword) GetSupportedOk() (bool, bool)` + +GetSupportedOk returns a tuple with the Supported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSupported + +`func (o *ScimServiceProviderConfigResponseChangePassword) HasSupported() bool` + +HasSupported returns a boolean if a field has been set. + +### SetSupported + +`func (o *ScimServiceProviderConfigResponseChangePassword) SetSupported(v bool)` + +SetSupported gets a reference to the given bool and assigns it to the Supported field. + + +[[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/ScimServiceProviderConfigResponseFilter.md b/docs/ScimServiceProviderConfigResponseFilter.md new file mode 100644 index 00000000..bd2221ab --- /dev/null +++ b/docs/ScimServiceProviderConfigResponseFilter.md @@ -0,0 +1,65 @@ +# ScimServiceProviderConfigResponseFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxResults** | Pointer to **int32** | The maximum number of resources that can be returned in a single filtered query response. | [optional] +**Supported** | Pointer to **bool** | Indicates whether the SCIM service provider supports filtering operations. | [optional] + +## Methods + +### GetMaxResults + +`func (o *ScimServiceProviderConfigResponseFilter) GetMaxResults() int32` + +GetMaxResults returns the MaxResults field if non-nil, zero value otherwise. + +### GetMaxResultsOk + +`func (o *ScimServiceProviderConfigResponseFilter) GetMaxResultsOk() (int32, bool)` + +GetMaxResultsOk returns a tuple with the MaxResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasMaxResults + +`func (o *ScimServiceProviderConfigResponseFilter) HasMaxResults() bool` + +HasMaxResults returns a boolean if a field has been set. + +### SetMaxResults + +`func (o *ScimServiceProviderConfigResponseFilter) SetMaxResults(v int32)` + +SetMaxResults gets a reference to the given int32 and assigns it to the MaxResults field. + +### GetSupported + +`func (o *ScimServiceProviderConfigResponseFilter) GetSupported() bool` + +GetSupported returns the Supported field if non-nil, zero value otherwise. + +### GetSupportedOk + +`func (o *ScimServiceProviderConfigResponseFilter) GetSupportedOk() (bool, bool)` + +GetSupportedOk returns a tuple with the Supported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSupported + +`func (o *ScimServiceProviderConfigResponseFilter) HasSupported() bool` + +HasSupported returns a boolean if a field has been set. + +### SetSupported + +`func (o *ScimServiceProviderConfigResponseFilter) SetSupported(v bool)` + +SetSupported gets a reference to the given bool and assigns it to the Supported field. + + +[[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/ScimServiceProviderConfigResponsePatch.md b/docs/ScimServiceProviderConfigResponsePatch.md new file mode 100644 index 00000000..8fc79d87 --- /dev/null +++ b/docs/ScimServiceProviderConfigResponsePatch.md @@ -0,0 +1,39 @@ +# ScimServiceProviderConfigResponsePatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Supported** | Pointer to **bool** | Indicates whether the service provider supports patch operations for modifying resources. | [optional] + +## Methods + +### GetSupported + +`func (o *ScimServiceProviderConfigResponsePatch) GetSupported() bool` + +GetSupported returns the Supported field if non-nil, zero value otherwise. + +### GetSupportedOk + +`func (o *ScimServiceProviderConfigResponsePatch) GetSupportedOk() (bool, bool)` + +GetSupportedOk returns a tuple with the Supported field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSupported + +`func (o *ScimServiceProviderConfigResponsePatch) HasSupported() bool` + +HasSupported returns a boolean if a field has been set. + +### SetSupported + +`func (o *ScimServiceProviderConfigResponsePatch) SetSupported(v bool)` + +SetSupported gets a reference to the given bool and assigns it to the Supported field. + + +[[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/ScimUser.md b/docs/ScimUser.md new file mode 100644 index 00000000..ec40f850 --- /dev/null +++ b/docs/ScimUser.md @@ -0,0 +1,143 @@ +# ScimUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Active** | Pointer to **bool** | Status of the user. | [optional] +**DisplayName** | Pointer to **string** | Display name of the user. | [optional] +**UserName** | Pointer to **string** | Unique identifier of the user. This is usually an email address. | [optional] +**Name** | Pointer to [**ScimBaseUserName**](ScimBaseUser_name.md) | | [optional] +**Id** | Pointer to **string** | ID of the user. | + +## Methods + +### GetActive + +`func (o *ScimUser) GetActive() bool` + +GetActive returns the Active field if non-nil, zero value otherwise. + +### GetActiveOk + +`func (o *ScimUser) GetActiveOk() (bool, bool)` + +GetActiveOk returns a tuple with the Active field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActive + +`func (o *ScimUser) HasActive() bool` + +HasActive returns a boolean if a field has been set. + +### SetActive + +`func (o *ScimUser) SetActive(v bool)` + +SetActive gets a reference to the given bool and assigns it to the Active field. + +### GetDisplayName + +`func (o *ScimUser) GetDisplayName() string` + +GetDisplayName returns the DisplayName field if non-nil, zero value otherwise. + +### GetDisplayNameOk + +`func (o *ScimUser) GetDisplayNameOk() (string, bool)` + +GetDisplayNameOk returns a tuple with the DisplayName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDisplayName + +`func (o *ScimUser) HasDisplayName() bool` + +HasDisplayName returns a boolean if a field has been set. + +### SetDisplayName + +`func (o *ScimUser) SetDisplayName(v string)` + +SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. + +### GetUserName + +`func (o *ScimUser) GetUserName() string` + +GetUserName returns the UserName field if non-nil, zero value otherwise. + +### GetUserNameOk + +`func (o *ScimUser) GetUserNameOk() (string, bool)` + +GetUserNameOk returns a tuple with the UserName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasUserName + +`func (o *ScimUser) HasUserName() bool` + +HasUserName returns a boolean if a field has been set. + +### SetUserName + +`func (o *ScimUser) SetUserName(v string)` + +SetUserName gets a reference to the given string and assigns it to the UserName field. + +### GetName + +`func (o *ScimUser) GetName() ScimBaseUserName` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ScimUser) GetNameOk() (ScimBaseUserName, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasName + +`func (o *ScimUser) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetName + +`func (o *ScimUser) SetName(v ScimBaseUserName)` + +SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. + +### GetId + +`func (o *ScimUser) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ScimUser) GetIdOk() (string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasId + +`func (o *ScimUser) HasId() bool` + +HasId returns a boolean if a field has been set. + +### SetId + +`func (o *ScimUser) SetId(v string)` + +SetId gets a reference to the given string and assigns it to the Id field. + + +[[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/ScimUsersListResponse.md b/docs/ScimUsersListResponse.md new file mode 100644 index 00000000..232e2234 --- /dev/null +++ b/docs/ScimUsersListResponse.md @@ -0,0 +1,91 @@ +# ScimUsersListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Resources** | Pointer to [**[]ScimUser**](ScimUser.md) | | +**Schemas** | Pointer to **[]string** | SCIM schema for the given resource. | [optional] +**TotalResults** | Pointer to **int32** | Number of total results in the response. | [optional] + +## Methods + +### GetResources + +`func (o *ScimUsersListResponse) GetResources() []ScimUser` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *ScimUsersListResponse) GetResourcesOk() ([]ScimUser, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasResources + +`func (o *ScimUsersListResponse) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### SetResources + +`func (o *ScimUsersListResponse) SetResources(v []ScimUser)` + +SetResources gets a reference to the given []ScimUser and assigns it to the Resources field. + +### GetSchemas + +`func (o *ScimUsersListResponse) GetSchemas() []string` + +GetSchemas returns the Schemas field if non-nil, zero value otherwise. + +### GetSchemasOk + +`func (o *ScimUsersListResponse) GetSchemasOk() ([]string, bool)` + +GetSchemasOk returns a tuple with the Schemas field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasSchemas + +`func (o *ScimUsersListResponse) HasSchemas() bool` + +HasSchemas returns a boolean if a field has been set. + +### SetSchemas + +`func (o *ScimUsersListResponse) SetSchemas(v []string)` + +SetSchemas gets a reference to the given []string and assigns it to the Schemas field. + +### GetTotalResults + +`func (o *ScimUsersListResponse) GetTotalResults() int32` + +GetTotalResults returns the TotalResults field if non-nil, zero value otherwise. + +### GetTotalResultsOk + +`func (o *ScimUsersListResponse) GetTotalResultsOk() (int32, bool)` + +GetTotalResultsOk returns a tuple with the TotalResults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTotalResults + +`func (o *ScimUsersListResponse) HasTotalResults() bool` + +HasTotalResults returns a boolean if a field has been set. + +### SetTotalResults + +`func (o *ScimUsersListResponse) SetTotalResults(v int32)` + +SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field. + + +[[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/SsoConfig.md b/docs/SsoConfig.md index d57548bc..f3172593 100644 --- a/docs/SsoConfig.md +++ b/docs/SsoConfig.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Enforced** | Pointer to **bool** | An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. | +**NewAcsUrl** | Pointer to **string** | Assertion Consumer Service (ACS) URL for setting up a new SAML connection with an identity provider like Okta or Microsoft Entra ID. | [optional] ## Methods @@ -33,6 +34,31 @@ HasEnforced returns a boolean if a field has been set. SetEnforced gets a reference to the given bool and assigns it to the Enforced field. +### GetNewAcsUrl + +`func (o *SsoConfig) GetNewAcsUrl() string` + +GetNewAcsUrl returns the NewAcsUrl field if non-nil, zero value otherwise. + +### GetNewAcsUrlOk + +`func (o *SsoConfig) GetNewAcsUrlOk() (string, bool)` + +GetNewAcsUrlOk returns a tuple with the NewAcsUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasNewAcsUrl + +`func (o *SsoConfig) HasNewAcsUrl() bool` + +HasNewAcsUrl returns a boolean if a field has been set. + +### SetNewAcsUrl + +`func (o *SsoConfig) SetNewAcsUrl(v string)` + +SetNewAcsUrl gets a reference to the given string and assigns it to the NewAcsUrl field. + [[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/Tier.md b/docs/Tier.md index 8c05159c..30b341e4 100644 --- a/docs/Tier.md +++ b/docs/Tier.md @@ -6,8 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | Pointer to **int32** | The internal ID of the tier. | **Name** | Pointer to **string** | The name of the tier. | +**StartDate** | Pointer to [**time.Time**](time.Time.md) | Date and time when the customer moved to this tier. This value uses the loyalty program's time zone setting. | [optional] **ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone). | [optional] -**DowngradePolicy** | Pointer to **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] +**DowngradePolicy** | Pointer to **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] ## Methods @@ -61,6 +62,31 @@ HasName returns a boolean if a field has been set. SetName gets a reference to the given string and assigns it to the Name field. +### GetStartDate + +`func (o *Tier) GetStartDate() time.Time` + +GetStartDate returns the StartDate field if non-nil, zero value otherwise. + +### GetStartDateOk + +`func (o *Tier) GetStartDateOk() (time.Time, bool)` + +GetStartDateOk returns a tuple with the StartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasStartDate + +`func (o *Tier) HasStartDate() bool` + +HasStartDate returns a boolean if a field has been set. + +### SetStartDate + +`func (o *Tier) SetStartDate(v time.Time)` + +SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. + ### GetExpiryDate `func (o *Tier) GetExpiryDate() time.Time` diff --git a/docs/TransferLoyaltyCard.md b/docs/TransferLoyaltyCard.md index 964edab6..c7c9e53f 100644 --- a/docs/TransferLoyaltyCard.md +++ b/docs/TransferLoyaltyCard.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **NewCardIdentifier** | Pointer to **string** | The alphanumeric identifier of the loyalty card. | +**BlockReason** | Pointer to **string** | Reason for transferring and blocking the loyalty card. | [optional] ## Methods @@ -33,6 +34,31 @@ HasNewCardIdentifier returns a boolean if a field has been set. SetNewCardIdentifier gets a reference to the given string and assigns it to the NewCardIdentifier field. +### GetBlockReason + +`func (o *TransferLoyaltyCard) GetBlockReason() string` + +GetBlockReason returns the BlockReason field if non-nil, zero value otherwise. + +### GetBlockReasonOk + +`func (o *TransferLoyaltyCard) GetBlockReasonOk() (string, bool)` + +GetBlockReasonOk returns a tuple with the BlockReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBlockReason + +`func (o *TransferLoyaltyCard) HasBlockReason() bool` + +HasBlockReason returns a boolean if a field has been set. + +### SetBlockReason + +`func (o *TransferLoyaltyCard) SetBlockReason(v string)` + +SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. + [[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/UpdateApplication.md b/docs/UpdateApplication.md index eeb02e18..f7284427 100644 --- a/docs/UpdateApplication.md +++ b/docs/UpdateApplication.md @@ -19,6 +19,8 @@ Name | Type | Description | Notes **EnablePartialDiscounts** | Pointer to **bool** | Indicates if this Application supports partial discounts. | [optional] **DefaultDiscountAdditionalCostPerItemScope** | Pointer to **string** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional] **DefaultEvaluationGroupId** | Pointer to **int32** | 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** | Pointer to **int32** | The ID of the default Cart-Item-Filter for this application. | [optional] +**EnableCampaignStateManagement** | Pointer to **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] ## Methods @@ -397,6 +399,56 @@ HasDefaultEvaluationGroupId returns a boolean if a field has been set. SetDefaultEvaluationGroupId gets a reference to the given int32 and assigns it to the DefaultEvaluationGroupId field. +### GetDefaultCartItemFilterId + +`func (o *UpdateApplication) GetDefaultCartItemFilterId() int32` + +GetDefaultCartItemFilterId returns the DefaultCartItemFilterId field if non-nil, zero value otherwise. + +### GetDefaultCartItemFilterIdOk + +`func (o *UpdateApplication) GetDefaultCartItemFilterIdOk() (int32, bool)` + +GetDefaultCartItemFilterIdOk returns a tuple with the DefaultCartItemFilterId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDefaultCartItemFilterId + +`func (o *UpdateApplication) HasDefaultCartItemFilterId() bool` + +HasDefaultCartItemFilterId returns a boolean if a field has been set. + +### SetDefaultCartItemFilterId + +`func (o *UpdateApplication) SetDefaultCartItemFilterId(v int32)` + +SetDefaultCartItemFilterId gets a reference to the given int32 and assigns it to the DefaultCartItemFilterId field. + +### GetEnableCampaignStateManagement + +`func (o *UpdateApplication) GetEnableCampaignStateManagement() bool` + +GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field if non-nil, zero value otherwise. + +### GetEnableCampaignStateManagementOk + +`func (o *UpdateApplication) GetEnableCampaignStateManagementOk() (bool, bool)` + +GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasEnableCampaignStateManagement + +`func (o *UpdateApplication) HasEnableCampaignStateManagement() bool` + +HasEnableCampaignStateManagement returns a boolean if a field has been set. + +### SetEnableCampaignStateManagement + +`func (o *UpdateApplication) SetEnableCampaignStateManagement(v bool)` + +SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. + [[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/UpdateApplicationCif.md b/docs/UpdateApplicationCif.md new file mode 100644 index 00000000..8cdb10c6 --- /dev/null +++ b/docs/UpdateApplicationCif.md @@ -0,0 +1,117 @@ +# UpdateApplicationCif + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | A short description of the Application cart item filter. | [optional] +**ActiveExpressionId** | Pointer to **int32** | The ID of the expression that the Application cart item filter uses. | [optional] +**ModifiedBy** | Pointer to **int32** | The ID of the user who last updated the Application cart item filter. | [optional] +**Modified** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the most recent update to the Application cart item filter. | [optional] + +## Methods + +### GetDescription + +`func (o *UpdateApplicationCif) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *UpdateApplicationCif) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *UpdateApplicationCif) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *UpdateApplicationCif) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + +### GetActiveExpressionId + +`func (o *UpdateApplicationCif) GetActiveExpressionId() int32` + +GetActiveExpressionId returns the ActiveExpressionId field if non-nil, zero value otherwise. + +### GetActiveExpressionIdOk + +`func (o *UpdateApplicationCif) GetActiveExpressionIdOk() (int32, bool)` + +GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasActiveExpressionId + +`func (o *UpdateApplicationCif) HasActiveExpressionId() bool` + +HasActiveExpressionId returns a boolean if a field has been set. + +### SetActiveExpressionId + +`func (o *UpdateApplicationCif) SetActiveExpressionId(v int32)` + +SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. + +### GetModifiedBy + +`func (o *UpdateApplicationCif) GetModifiedBy() int32` + +GetModifiedBy returns the ModifiedBy field if non-nil, zero value otherwise. + +### GetModifiedByOk + +`func (o *UpdateApplicationCif) GetModifiedByOk() (int32, bool)` + +GetModifiedByOk returns a tuple with the ModifiedBy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModifiedBy + +`func (o *UpdateApplicationCif) HasModifiedBy() bool` + +HasModifiedBy returns a boolean if a field has been set. + +### SetModifiedBy + +`func (o *UpdateApplicationCif) SetModifiedBy(v int32)` + +SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. + +### GetModified + +`func (o *UpdateApplicationCif) GetModified() time.Time` + +GetModified returns the Modified field if non-nil, zero value otherwise. + +### GetModifiedOk + +`func (o *UpdateApplicationCif) GetModifiedOk() (time.Time, bool)` + +GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasModified + +`func (o *UpdateApplicationCif) HasModified() bool` + +HasModified returns a boolean if a field has been set. + +### SetModified + +`func (o *UpdateApplicationCif) SetModified(v time.Time)` + +SetModified gets a reference to the given time.Time and assigns it to the Modified field. + + +[[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/UpdateCampaign.md b/docs/UpdateCampaign.md index eec76d8a..e04c2602 100644 --- a/docs/UpdateCampaign.md +++ b/docs/UpdateCampaign.md @@ -19,7 +19,7 @@ Name | Type | Description | Notes **CampaignGroups** | Pointer to **[]int32** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional] **EvaluationGroupId** | Pointer to **int32** | The ID of the campaign evaluation group the campaign belongs to. | [optional] **Type** | Pointer to **string** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to TYPE_ADVANCED] -**LinkedStoreIds** | Pointer to **[]int32** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional] +**LinkedStoreIds** | Pointer to **[]int32** | A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional] ## Methods diff --git a/docs/UpdateCoupon.md b/docs/UpdateCoupon.md index d6cd7277..026f1c7b 100644 --- a/docs/UpdateCoupon.md +++ b/docs/UpdateCoupon.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Limits** | Pointer to [**[]LimitConfig**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional] **RecipientIntegrationId** | Pointer to **string** | The integration ID for this coupon's beneficiary's profile. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] diff --git a/docs/UpdateCouponBatch.md b/docs/UpdateCouponBatch.md index 69401ad9..d93a5be8 100644 --- a/docs/UpdateCouponBatch.md +++ b/docs/UpdateCouponBatch.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **DiscountLimit** | Pointer to **float32** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] **ReservationLimit** | Pointer to **int32** | The number of reservations that can be made with this coupon code. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the coupon becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. | [optional] **BatchID** | Pointer to **string** | The ID of the batch the coupon(s) belong to. | [optional] diff --git a/docs/UpdateLoyaltyCard.md b/docs/UpdateLoyaltyCard.md index 06d4b000..81faeafc 100644 --- a/docs/UpdateLoyaltyCard.md +++ b/docs/UpdateLoyaltyCard.md @@ -4,7 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Status** | Pointer to **string** | Status of the loyalty card. Can be one of: ['active', 'inactive'] | +**Status** | Pointer to **string** | Status of the loyalty card. Can be `active` or `inactive`. | +**BlockReason** | Pointer to **string** | Reason for transferring and blocking the loyalty card. | [optional] ## Methods @@ -33,6 +34,31 @@ HasStatus returns a boolean if a field has been set. SetStatus gets a reference to the given string and assigns it to the Status field. +### GetBlockReason + +`func (o *UpdateLoyaltyCard) GetBlockReason() string` + +GetBlockReason returns the BlockReason field if non-nil, zero value otherwise. + +### GetBlockReasonOk + +`func (o *UpdateLoyaltyCard) GetBlockReasonOk() (string, bool)` + +GetBlockReasonOk returns a tuple with the BlockReason field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasBlockReason + +`func (o *UpdateLoyaltyCard) HasBlockReason() bool` + +HasBlockReason returns a boolean if a field has been set. + +### SetBlockReason + +`func (o *UpdateLoyaltyCard) SetBlockReason(v string)` + +SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. + [[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/UpdateLoyaltyProgram.md b/docs/UpdateLoyaltyProgram.md index 3a84b1c8..2aecd792 100644 --- a/docs/UpdateLoyaltyProgram.md +++ b/docs/UpdateLoyaltyProgram.md @@ -12,10 +12,12 @@ Name | Type | Description | Notes **AllowSubledger** | Pointer to **bool** | Indicates if this program supports subledgers inside the program. | [optional] **UsersPerCardLimit** | Pointer to **int32** | 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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to **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** | Pointer to [**time.Time**](time.Time.md) | 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** | Pointer to **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** | Pointer to **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** | Pointer to [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional] **Tiers** | Pointer to [**[]NewLoyaltyTier**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional] ## Methods @@ -220,6 +222,31 @@ HasSandbox returns a boolean if a field has been set. SetSandbox gets a reference to the given bool and assigns it to the Sandbox field. +### GetProgramJoinPolicy + +`func (o *UpdateLoyaltyProgram) GetProgramJoinPolicy() string` + +GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. + +### GetProgramJoinPolicyOk + +`func (o *UpdateLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` + +GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasProgramJoinPolicy + +`func (o *UpdateLoyaltyProgram) HasProgramJoinPolicy() bool` + +HasProgramJoinPolicy returns a boolean if a field has been set. + +### SetProgramJoinPolicy + +`func (o *UpdateLoyaltyProgram) SetProgramJoinPolicy(v string)` + +SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. + ### GetTiersExpirationPolicy `func (o *UpdateLoyaltyProgram) GetTiersExpirationPolicy() string` @@ -245,6 +272,31 @@ HasTiersExpirationPolicy returns a boolean if a field has been set. SetTiersExpirationPolicy gets a reference to the given string and assigns it to the TiersExpirationPolicy field. +### GetTierCycleStartDate + +`func (o *UpdateLoyaltyProgram) GetTierCycleStartDate() time.Time` + +GetTierCycleStartDate returns the TierCycleStartDate field if non-nil, zero value otherwise. + +### GetTierCycleStartDateOk + +`func (o *UpdateLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool)` + +GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasTierCycleStartDate + +`func (o *UpdateLoyaltyProgram) HasTierCycleStartDate() bool` + +HasTierCycleStartDate returns a boolean if a field has been set. + +### SetTierCycleStartDate + +`func (o *UpdateLoyaltyProgram) SetTierCycleStartDate(v time.Time)` + +SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. + ### GetTiersExpireIn `func (o *UpdateLoyaltyProgram) GetTiersExpireIn() string` @@ -295,30 +347,30 @@ HasTiersDowngradePolicy returns a boolean if a field has been set. SetTiersDowngradePolicy gets a reference to the given string and assigns it to the TiersDowngradePolicy field. -### GetProgramJoinPolicy +### GetCardCodeSettings -`func (o *UpdateLoyaltyProgram) GetProgramJoinPolicy() string` +`func (o *UpdateLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings` -GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise. +GetCardCodeSettings returns the CardCodeSettings field if non-nil, zero value otherwise. -### GetProgramJoinPolicyOk +### GetCardCodeSettingsOk -`func (o *UpdateLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool)` +`func (o *UpdateLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool)` -GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise +GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set. -### HasProgramJoinPolicy +### HasCardCodeSettings -`func (o *UpdateLoyaltyProgram) HasProgramJoinPolicy() bool` +`func (o *UpdateLoyaltyProgram) HasCardCodeSettings() bool` -HasProgramJoinPolicy returns a boolean if a field has been set. +HasCardCodeSettings returns a boolean if a field has been set. -### SetProgramJoinPolicy +### SetCardCodeSettings -`func (o *UpdateLoyaltyProgram) SetProgramJoinPolicy(v string)` +`func (o *UpdateLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings)` -SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. ### GetTiers diff --git a/docs/UpdateReferral.md b/docs/UpdateReferral.md index 316d8bf3..1dfdb643 100644 --- a/docs/UpdateReferral.md +++ b/docs/UpdateReferral.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **FriendProfileIntegrationId** | Pointer to **string** | An optional Integration ID of the Friend's Profile. | [optional] **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] diff --git a/docs/UpdateReferralBatch.md b/docs/UpdateReferralBatch.md index b54193c6..9049a60e 100644 --- a/docs/UpdateReferralBatch.md +++ b/docs/UpdateReferralBatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **Attributes** | Pointer to [**map[string]interface{}**](.md) | Arbitrary properties associated with this item. | [optional] **BatchID** | Pointer to **string** | The id of the batch the referral belongs to. | **StartDate** | Pointer to [**time.Time**](time.Time.md) | Timestamp at which point the referral code becomes valid. | [optional] -**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. | [optional] +**ExpiryDate** | Pointer to [**time.Time**](time.Time.md) | Expiration date of the referral code. Referral never expires if this is omitted. | [optional] **UsageLimit** | Pointer to **int32** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional] ## Methods diff --git a/docs/UpdateUserLatestFeedTimestamp.md b/docs/UpdateUserLatestFeedTimestamp.md deleted file mode 100644 index ad73dde9..00000000 --- a/docs/UpdateUserLatestFeedTimestamp.md +++ /dev/null @@ -1,39 +0,0 @@ -# UpdateUserLatestFeedTimestamp - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NewLatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | New timestamp to update for the current user. | - -## Methods - -### GetNewLatestFeedTimestamp - -`func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestamp() time.Time` - -GetNewLatestFeedTimestamp returns the NewLatestFeedTimestamp field if non-nil, zero value otherwise. - -### GetNewLatestFeedTimestampOk - -`func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestampOk() (time.Time, bool)` - -GetNewLatestFeedTimestampOk returns a tuple with the NewLatestFeedTimestamp field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasNewLatestFeedTimestamp - -`func (o *UpdateUserLatestFeedTimestamp) HasNewLatestFeedTimestamp() bool` - -HasNewLatestFeedTimestamp returns a boolean if a field has been set. - -### SetNewLatestFeedTimestamp - -`func (o *UpdateUserLatestFeedTimestamp) SetNewLatestFeedTimestamp(v time.Time)` - -SetNewLatestFeedTimestamp gets a reference to the given time.Time and assigns it to the NewLatestFeedTimestamp field. - - -[[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/User.md b/docs/User.md index f2f3ded0..6b68cf60 100644 --- a/docs/User.md +++ b/docs/User.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **LastSignedIn** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the user last signed in to Talon.One. | [optional] **LastAccessed** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the user's last activity after signing in to Talon.One. | [optional] **LatestFeedTimestamp** | Pointer to [**time.Time**](time.Time.md) | Timestamp when the user was notified for feed. | [optional] +**AdditionalAttributes** | Pointer to [**map[string]interface{}**](.md) | Additional user attributes, created and used by external identity providers. | [optional] ## Methods @@ -423,6 +424,31 @@ HasLatestFeedTimestamp returns a boolean if a field has been set. SetLatestFeedTimestamp gets a reference to the given time.Time and assigns it to the LatestFeedTimestamp field. +### GetAdditionalAttributes + +`func (o *User) GetAdditionalAttributes() map[string]interface{}` + +GetAdditionalAttributes returns the AdditionalAttributes field if non-nil, zero value otherwise. + +### GetAdditionalAttributesOk + +`func (o *User) GetAdditionalAttributesOk() (map[string]interface{}, bool)` + +GetAdditionalAttributesOk returns a tuple with the AdditionalAttributes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasAdditionalAttributes + +`func (o *User) HasAdditionalAttributes() bool` + +HasAdditionalAttributes returns a boolean if a field has been set. + +### SetAdditionalAttributes + +`func (o *User) SetAdditionalAttributes(v map[string]interface{})` + +SetAdditionalAttributes gets a reference to the given map[string]interface{} and assigns it to the AdditionalAttributes field. + [[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/UserFeedNotifications.md b/docs/UserFeedNotifications.md deleted file mode 100644 index 7ebdfe3e..00000000 --- a/docs/UserFeedNotifications.md +++ /dev/null @@ -1,65 +0,0 @@ -# UserFeedNotifications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LastUpdate** | Pointer to [**time.Time**](time.Time.md) | Timestamp of the last request for this list. | -**Notifications** | Pointer to [**[]FeedNotification**](FeedNotification.md) | List of all notifications to notify the user about. | - -## Methods - -### GetLastUpdate - -`func (o *UserFeedNotifications) GetLastUpdate() time.Time` - -GetLastUpdate returns the LastUpdate field if non-nil, zero value otherwise. - -### GetLastUpdateOk - -`func (o *UserFeedNotifications) GetLastUpdateOk() (time.Time, bool)` - -GetLastUpdateOk returns a tuple with the LastUpdate field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasLastUpdate - -`func (o *UserFeedNotifications) HasLastUpdate() bool` - -HasLastUpdate returns a boolean if a field has been set. - -### SetLastUpdate - -`func (o *UserFeedNotifications) SetLastUpdate(v time.Time)` - -SetLastUpdate gets a reference to the given time.Time and assigns it to the LastUpdate field. - -### GetNotifications - -`func (o *UserFeedNotifications) GetNotifications() []FeedNotification` - -GetNotifications returns the Notifications field if non-nil, zero value otherwise. - -### GetNotificationsOk - -`func (o *UserFeedNotifications) GetNotificationsOk() ([]FeedNotification, bool)` - -GetNotificationsOk returns a tuple with the Notifications field if it's non-nil, zero value otherwise -and a boolean to check if the value has been set. - -### HasNotifications - -`func (o *UserFeedNotifications) HasNotifications() bool` - -HasNotifications returns a boolean if a field has been set. - -### SetNotifications - -`func (o *UserFeedNotifications) SetNotifications(v []FeedNotification)` - -SetNotifications gets a reference to the given []FeedNotification and assigns it to the Notifications field. - - -[[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/Webhook.md b/docs/Webhook.md index 8f7d190e..8c404400 100644 --- a/docs/Webhook.md +++ b/docs/Webhook.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | **ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | **Title** | Pointer to **string** | Name or title for this webhook. | +**Description** | Pointer to **string** | A description of the webhook. | [optional] **Verb** | Pointer to **string** | API method for this webhook. | **Url** | Pointer to **string** | API URL (supports templating using parameters) for this webhook. | **Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook. | @@ -143,6 +144,31 @@ HasTitle returns a boolean if a field has been set. SetTitle gets a reference to the given string and assigns it to the Title field. +### GetDescription + +`func (o *Webhook) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Webhook) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *Webhook) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *Webhook) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetVerb `func (o *Webhook) GetVerb() string` diff --git a/docs/WebhookWithOutgoingIntegrationDetails.md b/docs/WebhookWithOutgoingIntegrationDetails.md index 597ea264..51b8a844 100644 --- a/docs/WebhookWithOutgoingIntegrationDetails.md +++ b/docs/WebhookWithOutgoingIntegrationDetails.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **Modified** | Pointer to [**time.Time**](time.Time.md) | The time this entity was last modified. | **ApplicationIds** | Pointer to **[]int32** | The IDs of the Applications that are related to this entity. The IDs of the Applications that are related to this entity. | **Title** | Pointer to **string** | Name or title for this webhook. | +**Description** | Pointer to **string** | A description of the webhook. | [optional] **Verb** | Pointer to **string** | API method for this webhook. | **Url** | Pointer to **string** | API URL (supports templating using parameters) for this webhook. | **Headers** | Pointer to **[]string** | List of API HTTP headers for this webhook. | @@ -146,6 +147,31 @@ HasTitle returns a boolean if a field has been set. SetTitle gets a reference to the given string and assigns it to the Title field. +### GetDescription + +`func (o *WebhookWithOutgoingIntegrationDetails) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *WebhookWithOutgoingIntegrationDetails) GetDescriptionOk() (string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### HasDescription + +`func (o *WebhookWithOutgoingIntegrationDetails) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### SetDescription + +`func (o *WebhookWithOutgoingIntegrationDetails) SetDescription(v string)` + +SetDescription gets a reference to the given string and assigns it to the Description field. + ### GetVerb `func (o *WebhookWithOutgoingIntegrationDetails) GetVerb() string` From 861f45666f506455db2054831e4e91fff27146f9 Mon Sep 17 00:00:00 2001 From: Vitalii Drevenchuk <4005032+Crandel@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:22:02 +0200 Subject: [PATCH 3/5] Update README and api --- README.md | 97 +- api/openapi.yaml | 5044 ++++++++++++++++++++++++++++++++++++---------- 2 files changed, 4047 insertions(+), 1094 deletions(-) diff --git a/README.md b/README.md index 673014da..181385ca 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` ## Overview This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. -- API version: -- Package version: 7.0.0 +- API version: +- Package version: 8.0.0 - Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen ## Installation @@ -94,7 +94,7 @@ import ( "encoding/json" "fmt" - talon "github.com/talon-one/talon_go/v7" + talon "github.com/talon-one/talon_go/v8" ) func main() { @@ -220,7 +220,7 @@ import ( "context" "fmt" - talon "github.com/talon-one/talon_go/v7" + talon "github.com/talon-one/talon_go/v8" ) func main() { @@ -275,6 +275,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**DeleteAudienceV2**](docs/IntegrationApi.md#deleteaudiencev2) | **Delete** /v2/audiences/{audienceId} | Delete audience *IntegrationApi* | [**DeleteCouponReservation**](docs/IntegrationApi.md#deletecouponreservation) | **Delete** /v1/coupon_reservations/{couponValue} | Delete coupon reservations *IntegrationApi* | [**DeleteCustomerData**](docs/IntegrationApi.md#deletecustomerdata) | **Delete** /v1/customer_data/{integrationId} | Delete customer's personal data +*IntegrationApi* | [**GenerateLoyaltyCard**](docs/IntegrationApi.md#generateloyaltycard) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card *IntegrationApi* | [**GetCustomerInventory**](docs/IntegrationApi.md#getcustomerinventory) | **Get** /v1/customer_profiles/{integrationId}/inventory | List customer data *IntegrationApi* | [**GetCustomerSession**](docs/IntegrationApi.md#getcustomersession) | **Get** /v2/customer_sessions/{customerSessionId} | Get customer session *IntegrationApi* | [**GetLoyaltyBalances**](docs/IntegrationApi.md#getloyaltybalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points @@ -295,7 +296,7 @@ Class | Method | HTTP request | Description *IntegrationApi* | [**UpdateCustomerProfileV2**](docs/IntegrationApi.md#updatecustomerprofilev2) | **Put** /v2/customer_profiles/{integrationId} | Update customer profile *IntegrationApi* | [**UpdateCustomerProfilesV2**](docs/IntegrationApi.md#updatecustomerprofilesv2) | **Put** /v2/customer_profiles | Update multiple customer profiles *IntegrationApi* | [**UpdateCustomerSessionV2**](docs/IntegrationApi.md#updatecustomersessionv2) | **Put** /v2/customer_sessions/{customerSessionId} | Update customer session -*ManagementApi* | [**ActivateUserByEmail**](docs/ManagementApi.md#activateuserbyemail) | **Post** /v1/users/activate | Activate user by email address +*ManagementApi* | [**ActivateUserByEmail**](docs/ManagementApi.md#activateuserbyemail) | **Post** /v1/users/activate | Enable user by email address *ManagementApi* | [**AddLoyaltyCardPoints**](docs/ManagementApi.md#addloyaltycardpoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card *ManagementApi* | [**AddLoyaltyPoints**](docs/ManagementApi.md#addloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile *ManagementApi* | [**CopyCampaignToApplications**](docs/ManagementApi.md#copycampaigntoapplications) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application @@ -303,17 +304,19 @@ Class | Method | HTTP request | Description *ManagementApi* | [**CreateAchievement**](docs/ManagementApi.md#createachievement) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement *ManagementApi* | [**CreateAdditionalCost**](docs/ManagementApi.md#createadditionalcost) | **Post** /v1/additional_costs | Create additional cost *ManagementApi* | [**CreateAttribute**](docs/ManagementApi.md#createattribute) | **Post** /v1/attributes | Create custom attribute +*ManagementApi* | [**CreateBatchLoyaltyCards**](docs/ManagementApi.md#createbatchloyaltycards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards *ManagementApi* | [**CreateCampaignFromTemplate**](docs/ManagementApi.md#createcampaignfromtemplate) | **Post** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template *ManagementApi* | [**CreateCollection**](docs/ManagementApi.md#createcollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection *ManagementApi* | [**CreateCoupons**](docs/ManagementApi.md#createcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons *ManagementApi* | [**CreateCouponsAsync**](docs/ManagementApi.md#createcouponsasync) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously +*ManagementApi* | [**CreateCouponsDeletionJob**](docs/ManagementApi.md#createcouponsdeletionjob) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job *ManagementApi* | [**CreateCouponsForMultipleRecipients**](docs/ManagementApi.md#createcouponsformultiplerecipients) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients *ManagementApi* | [**CreateInviteEmail**](docs/ManagementApi.md#createinviteemail) | **Post** /v1/invite_emails | Resend invitation email *ManagementApi* | [**CreateInviteV2**](docs/ManagementApi.md#createinvitev2) | **Post** /v2/invites | Invite user *ManagementApi* | [**CreatePasswordRecoveryEmail**](docs/ManagementApi.md#createpasswordrecoveryemail) | **Post** /v1/password_recovery_emails | Request a password reset *ManagementApi* | [**CreateSession**](docs/ManagementApi.md#createsession) | **Post** /v1/sessions | Create session *ManagementApi* | [**CreateStore**](docs/ManagementApi.md#createstore) | **Post** /v1/applications/{applicationId}/stores | Create store -*ManagementApi* | [**DeactivateUserByEmail**](docs/ManagementApi.md#deactivateuserbyemail) | **Post** /v1/users/deactivate | Deactivate user by email address +*ManagementApi* | [**DeactivateUserByEmail**](docs/ManagementApi.md#deactivateuserbyemail) | **Post** /v1/users/deactivate | Disable user by email address *ManagementApi* | [**DeductLoyaltyCardPoints**](docs/ManagementApi.md#deductloyaltycardpoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card *ManagementApi* | [**DeleteAccountCollection**](docs/ManagementApi.md#deleteaccountcollection) | **Delete** /v1/collections/{collectionId} | Delete account-level collection *ManagementApi* | [**DeleteAchievement**](docs/ManagementApi.md#deleteachievement) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement @@ -327,9 +330,11 @@ Class | Method | HTTP request | Description *ManagementApi* | [**DeleteUser**](docs/ManagementApi.md#deleteuser) | **Delete** /v1/users/{userId} | Delete user *ManagementApi* | [**DeleteUserByEmail**](docs/ManagementApi.md#deleteuserbyemail) | **Post** /v1/users/delete | Delete user by email address *ManagementApi* | [**DestroySession**](docs/ManagementApi.md#destroysession) | **Delete** /v1/sessions | Destroy session +*ManagementApi* | [**DisconnectCampaignStores**](docs/ManagementApi.md#disconnectcampaignstores) | **Delete** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores *ManagementApi* | [**ExportAccountCollectionItems**](docs/ManagementApi.md#exportaccountcollectionitems) | **Get** /v1/collections/{collectionId}/export | Export account-level collection's items *ManagementApi* | [**ExportAchievements**](docs/ManagementApi.md#exportachievements) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data *ManagementApi* | [**ExportAudiencesMemberships**](docs/ManagementApi.md#exportaudiencesmemberships) | **Get** /v1/audiences/{audienceId}/memberships/export | Export audience members +*ManagementApi* | [**ExportCampaignStores**](docs/ManagementApi.md#exportcampaignstores) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores *ManagementApi* | [**ExportCollectionItems**](docs/ManagementApi.md#exportcollectionitems) | **Get** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items *ManagementApi* | [**ExportCoupons**](docs/ManagementApi.md#exportcoupons) | **Get** /v1/applications/{applicationId}/export_coupons | Export coupons *ManagementApi* | [**ExportCustomerSessions**](docs/ManagementApi.md#exportcustomersessions) | **Get** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions @@ -339,6 +344,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**ExportLoyaltyBalances**](docs/ManagementApi.md#exportloyaltybalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances *ManagementApi* | [**ExportLoyaltyCardBalances**](docs/ManagementApi.md#exportloyaltycardbalances) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs *ManagementApi* | [**ExportLoyaltyCardLedger**](docs/ManagementApi.md#exportloyaltycardledger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log +*ManagementApi* | [**ExportLoyaltyCards**](docs/ManagementApi.md#exportloyaltycards) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards *ManagementApi* | [**ExportLoyaltyLedger**](docs/ManagementApi.md#exportloyaltyledger) | **Get** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs *ManagementApi* | [**ExportPoolGiveaways**](docs/ManagementApi.md#exportpoolgiveaways) | **Get** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool *ManagementApi* | [**ExportReferrals**](docs/ManagementApi.md#exportreferrals) | **Get** /v1/applications/{applicationId}/export_referrals | Export referrals @@ -408,6 +414,7 @@ Class | Method | HTTP request | Description *ManagementApi* | [**ImportAccountCollection**](docs/ManagementApi.md#importaccountcollection) | **Post** /v1/collections/{collectionId}/import | Import data into existing account-level collection *ManagementApi* | [**ImportAllowedList**](docs/ManagementApi.md#importallowedlist) | **Post** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute *ManagementApi* | [**ImportAudiencesMemberships**](docs/ManagementApi.md#importaudiencesmemberships) | **Post** /v1/audiences/{audienceId}/memberships/import | Import audience members +*ManagementApi* | [**ImportCampaignStores**](docs/ManagementApi.md#importcampaignstores) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores *ManagementApi* | [**ImportCollection**](docs/ManagementApi.md#importcollection) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection *ManagementApi* | [**ImportCoupons**](docs/ManagementApi.md#importcoupons) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons *ManagementApi* | [**ImportLoyaltyCards**](docs/ManagementApi.md#importloyaltycards) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards @@ -424,11 +431,21 @@ Class | Method | HTTP request | Description *ManagementApi* | [**ListCollectionsInApplication**](docs/ManagementApi.md#listcollectionsinapplication) | **Get** /v1/applications/{applicationId}/collections | List collections in Application *ManagementApi* | [**ListStores**](docs/ManagementApi.md#liststores) | **Get** /v1/applications/{applicationId}/stores | List stores *ManagementApi* | [**NotificationActivation**](docs/ManagementApi.md#notificationactivation) | **Put** /v1/notifications/{notificationId}/activation | Activate or deactivate notification +*ManagementApi* | [**OktaEventHandlerChallenge**](docs/ManagementApi.md#oktaeventhandlerchallenge) | **Get** /v1/provisioning/okta | Validate Okta API ownership *ManagementApi* | [**PostAddedDeductedPointsNotification**](docs/ManagementApi.md#postaddeddeductedpointsnotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points *ManagementApi* | [**PostCatalogsStrikethroughNotification**](docs/ManagementApi.md#postcatalogsstrikethroughnotification) | **Post** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification *ManagementApi* | [**PostPendingPointsNotification**](docs/ManagementApi.md#postpendingpointsnotification) | **Post** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points *ManagementApi* | [**RemoveLoyaltyPoints**](docs/ManagementApi.md#removeloyaltypoints) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile *ManagementApi* | [**ResetPassword**](docs/ManagementApi.md#resetpassword) | **Post** /v1/reset_password | Reset password +*ManagementApi* | [**ScimCreateUser**](docs/ManagementApi.md#scimcreateuser) | **Post** /v1/provisioning/scim/Users | Create SCIM user +*ManagementApi* | [**ScimDeleteUser**](docs/ManagementApi.md#scimdeleteuser) | **Delete** /v1/provisioning/scim/Users/{userId} | Delete SCIM user +*ManagementApi* | [**ScimGetResourceTypes**](docs/ManagementApi.md#scimgetresourcetypes) | **Get** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types +*ManagementApi* | [**ScimGetSchemas**](docs/ManagementApi.md#scimgetschemas) | **Get** /v1/provisioning/scim/Schemas | List supported SCIM schemas +*ManagementApi* | [**ScimGetServiceProviderConfig**](docs/ManagementApi.md#scimgetserviceproviderconfig) | **Get** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration +*ManagementApi* | [**ScimGetUser**](docs/ManagementApi.md#scimgetuser) | **Get** /v1/provisioning/scim/Users/{userId} | Get SCIM user +*ManagementApi* | [**ScimGetUsers**](docs/ManagementApi.md#scimgetusers) | **Get** /v1/provisioning/scim/Users | List SCIM users +*ManagementApi* | [**ScimPatchUser**](docs/ManagementApi.md#scimpatchuser) | **Patch** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes +*ManagementApi* | [**ScimReplaceUserAttributes**](docs/ManagementApi.md#scimreplaceuserattributes) | **Put** /v1/provisioning/scim/Users/{userId} | Update SCIM user *ManagementApi* | [**SearchCouponsAdvancedApplicationWideWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedapplicationwidewithouttotalcount) | **Post** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count) *ManagementApi* | [**SearchCouponsAdvancedWithoutTotalCount**](docs/ManagementApi.md#searchcouponsadvancedwithouttotalcount) | **Post** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count) *ManagementApi* | [**TransferLoyaltyCard**](docs/ManagementApi.md#transferloyaltycard) | **Put** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data @@ -475,23 +492,19 @@ Class | Method | HTTP request | Description - [AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md) - [AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md) - [AdditionalCost](docs/AdditionalCost.md) + - [AnalyticsDataPoint](docs/AnalyticsDataPoint.md) + - [AnalyticsDataPointWithTrend](docs/AnalyticsDataPointWithTrend.md) + - [AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md) + - [AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md) - [ApiError](docs/ApiError.md) - [Application](docs/Application.md) - [ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md) - - [ApplicationAnalyticsDataPointAvgItemsPerSession](docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md) - - [ApplicationAnalyticsDataPointAvgSessionValue](docs/ApplicationAnalyticsDataPointAvgSessionValue.md) - - [ApplicationAnalyticsDataPointSessionsCount](docs/ApplicationAnalyticsDataPointSessionsCount.md) - - [ApplicationAnalyticsDataPointTotalRevenue](docs/ApplicationAnalyticsDataPointTotalRevenue.md) - [ApplicationApiHealth](docs/ApplicationApiHealth.md) - [ApplicationApiKey](docs/ApplicationApiKey.md) - [ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md) - - [ApplicationCampaignAnalyticsAvgItemsPerSession](docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md) - - [ApplicationCampaignAnalyticsAvgSessionValue](docs/ApplicationCampaignAnalyticsAvgSessionValue.md) - - [ApplicationCampaignAnalyticsCouponsCount](docs/ApplicationCampaignAnalyticsCouponsCount.md) - - [ApplicationCampaignAnalyticsSessionsCount](docs/ApplicationCampaignAnalyticsSessionsCount.md) - - [ApplicationCampaignAnalyticsTotalDiscounts](docs/ApplicationCampaignAnalyticsTotalDiscounts.md) - - [ApplicationCampaignAnalyticsTotalRevenue](docs/ApplicationCampaignAnalyticsTotalRevenue.md) - [ApplicationCampaignStats](docs/ApplicationCampaignStats.md) + - [ApplicationCif](docs/ApplicationCif.md) + - [ApplicationCifExpression](docs/ApplicationCifExpression.md) - [ApplicationCustomer](docs/ApplicationCustomer.md) - [ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md) - [ApplicationEntity](docs/ApplicationEntity.md) @@ -502,6 +515,7 @@ Class | Method | HTTP request | Description - [ApplicationSessionEntity](docs/ApplicationSessionEntity.md) - [ApplicationStoreEntity](docs/ApplicationStoreEntity.md) - [AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md) + - [AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md) - [Attribute](docs/Attribute.md) - [AttributesMandatory](docs/AttributesMandatory.md) - [AttributesSettings](docs/AttributesSettings.md) @@ -527,6 +541,7 @@ Class | Method | HTTP request | Description - [CampaignAnalytics](docs/CampaignAnalytics.md) - [CampaignBudget](docs/CampaignBudget.md) - [CampaignCollection](docs/CampaignCollection.md) + - [CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md) - [CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md) - [CampaignCopy](docs/CampaignCopy.md) - [CampaignCreatedNotification](docs/CampaignCreatedNotification.md) @@ -547,9 +562,12 @@ Class | Method | HTTP request | Description - [CampaignSetLeafNode](docs/CampaignSetLeafNode.md) - [CampaignSetNode](docs/CampaignSetNode.md) - [CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md) + - [CampaignStoreBudget](docs/CampaignStoreBudget.md) - [CampaignTemplate](docs/CampaignTemplate.md) - [CampaignTemplateCollection](docs/CampaignTemplateCollection.md) - [CampaignTemplateParams](docs/CampaignTemplateParams.md) + - [CampaignVersions](docs/CampaignVersions.md) + - [CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md) - [CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md) - [CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md) - [CardLedgerPointsEntryIntegrationApi](docs/CardLedgerPointsEntryIntegrationApi.md) @@ -573,6 +591,8 @@ Class | Method | HTTP request | Description - [CouponConstraints](docs/CouponConstraints.md) - [CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md) - [CouponCreationJob](docs/CouponCreationJob.md) + - [CouponDeletionFilters](docs/CouponDeletionFilters.md) + - [CouponDeletionJob](docs/CouponDeletionJob.md) - [CouponLimitConfigs](docs/CouponLimitConfigs.md) - [CouponRejectionReason](docs/CouponRejectionReason.md) - [CouponReservations](docs/CouponReservations.md) @@ -626,6 +646,12 @@ Class | Method | HTTP request | Description - [FeaturesFeed](docs/FeaturesFeed.md) - [FuncArgDef](docs/FuncArgDef.md) - [FunctionDef](docs/FunctionDef.md) + - [GenerateCampaignDescription](docs/GenerateCampaignDescription.md) + - [GenerateCampaignTags](docs/GenerateCampaignTags.md) + - [GenerateItemFilterDescription](docs/GenerateItemFilterDescription.md) + - [GenerateLoyaltyCard](docs/GenerateLoyaltyCard.md) + - [GenerateRuleTitle](docs/GenerateRuleTitle.md) + - [GenerateRuleTitleRule](docs/GenerateRuleTitleRule.md) - [GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md) - [Giveaway](docs/Giveaway.md) - [GiveawaysPool](docs/GiveawaysPool.md) @@ -705,9 +731,13 @@ Class | Method | HTTP request | Description - [LoginParams](docs/LoginParams.md) - [Loyalty](docs/Loyalty.md) - [LoyaltyBalance](docs/LoyaltyBalance.md) + - [LoyaltyBalanceWithTier](docs/LoyaltyBalanceWithTier.md) - [LoyaltyBalances](docs/LoyaltyBalances.md) + - [LoyaltyBalancesWithTiers](docs/LoyaltyBalancesWithTiers.md) - [LoyaltyCard](docs/LoyaltyCard.md) - [LoyaltyCardBalances](docs/LoyaltyCardBalances.md) + - [LoyaltyCardBatch](docs/LoyaltyCardBatch.md) + - [LoyaltyCardBatchResponse](docs/LoyaltyCardBatchResponse.md) - [LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md) - [LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md) - [LoyaltyDashboardData](docs/LoyaltyDashboardData.md) @@ -720,7 +750,6 @@ Class | Method | HTTP request | Description - [LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md) - [LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md) - [LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md) - - [LoyaltyProgramSubledgers](docs/LoyaltyProgramSubledgers.md) - [LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md) - [LoyaltySubLedger](docs/LoyaltySubLedger.md) - [LoyaltyTier](docs/LoyaltyTier.md) @@ -744,8 +773,11 @@ Class | Method | HTTP request | Description - [NewAccount](docs/NewAccount.md) - [NewAccountSignUp](docs/NewAccountSignUp.md) - [NewAdditionalCost](docs/NewAdditionalCost.md) + - [NewAppWideCouponDeletionJob](docs/NewAppWideCouponDeletionJob.md) - [NewApplication](docs/NewApplication.md) - [NewApplicationApiKey](docs/NewApplicationApiKey.md) + - [NewApplicationCif](docs/NewApplicationCif.md) + - [NewApplicationCifExpression](docs/NewApplicationCifExpression.md) - [NewAttribute](docs/NewAttribute.md) - [NewAudience](docs/NewAudience.md) - [NewBaseNotification](docs/NewBaseNotification.md) @@ -758,6 +790,7 @@ Class | Method | HTTP request | Description - [NewCatalog](docs/NewCatalog.md) - [NewCollection](docs/NewCollection.md) - [NewCouponCreationJob](docs/NewCouponCreationJob.md) + - [NewCouponDeletionJob](docs/NewCouponDeletionJob.md) - [NewCoupons](docs/NewCoupons.md) - [NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md) - [NewCustomEffect](docs/NewCustomEffect.md) @@ -784,6 +817,7 @@ Class | Method | HTTP request | Description - [NewReferral](docs/NewReferral.md) - [NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md) - [NewReturn](docs/NewReturn.md) + - [NewRevisionVersion](docs/NewRevisionVersion.md) - [NewRole](docs/NewRole.md) - [NewRoleV2](docs/NewRoleV2.md) - [NewRuleset](docs/NewRuleset.md) @@ -796,6 +830,10 @@ Class | Method | HTTP request | Description - [NotificationActivation](docs/NotificationActivation.md) - [NotificationListItem](docs/NotificationListItem.md) - [NotificationTest](docs/NotificationTest.md) + - [OktaEvent](docs/OktaEvent.md) + - [OktaEventPayload](docs/OktaEventPayload.md) + - [OktaEventPayloadData](docs/OktaEventPayloadData.md) + - [OktaEventTarget](docs/OktaEventTarget.md) - [OneTimeCode](docs/OneTimeCode.md) - [OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md) - [OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md) @@ -813,6 +851,7 @@ Class | Method | HTTP request | Description - [Picklist](docs/Picklist.md) - [Product](docs/Product.md) - [ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md) + - [ProjectedTier](docs/ProjectedTier.md) - [RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md) - [Referral](docs/Referral.md) - [ReferralConstraints](docs/ReferralConstraints.md) @@ -828,6 +867,9 @@ Class | Method | HTTP request | Description - [Return](docs/Return.md) - [ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md) - [ReturnedCartItem](docs/ReturnedCartItem.md) + - [Revision](docs/Revision.md) + - [RevisionActivation](docs/RevisionActivation.md) + - [RevisionVersion](docs/RevisionVersion.md) - [Role](docs/Role.md) - [RoleAssign](docs/RoleAssign.md) - [RoleMembership](docs/RoleMembership.md) @@ -841,6 +883,7 @@ Class | Method | HTTP request | Description - [RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md) - [RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md) - [RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md) + - [RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md) - [RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md) - [Rule](docs/Rule.md) - [RuleFailureReason](docs/RuleFailureReason.md) @@ -849,6 +892,22 @@ Class | Method | HTTP request | Description - [SamlConnectionInternal](docs/SamlConnectionInternal.md) - [SamlConnectionMetadata](docs/SamlConnectionMetadata.md) - [SamlLoginEndpoint](docs/SamlLoginEndpoint.md) + - [ScimBaseUser](docs/ScimBaseUser.md) + - [ScimBaseUserName](docs/ScimBaseUserName.md) + - [ScimNewUser](docs/ScimNewUser.md) + - [ScimPatchOperation](docs/ScimPatchOperation.md) + - [ScimPatchRequest](docs/ScimPatchRequest.md) + - [ScimResource](docs/ScimResource.md) + - [ScimResourceTypesListResponse](docs/ScimResourceTypesListResponse.md) + - [ScimSchemaResource](docs/ScimSchemaResource.md) + - [ScimSchemasListResponse](docs/ScimSchemasListResponse.md) + - [ScimServiceProviderConfigResponse](docs/ScimServiceProviderConfigResponse.md) + - [ScimServiceProviderConfigResponseBulk](docs/ScimServiceProviderConfigResponseBulk.md) + - [ScimServiceProviderConfigResponseChangePassword](docs/ScimServiceProviderConfigResponseChangePassword.md) + - [ScimServiceProviderConfigResponseFilter](docs/ScimServiceProviderConfigResponseFilter.md) + - [ScimServiceProviderConfigResponsePatch](docs/ScimServiceProviderConfigResponsePatch.md) + - [ScimUser](docs/ScimUser.md) + - [ScimUsersListResponse](docs/ScimUsersListResponse.md) - [Session](docs/Session.md) - [SetDiscountEffectProps](docs/SetDiscountEffectProps.md) - [SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md) @@ -884,6 +943,7 @@ Class | Method | HTTP request | Description - [UpdateAchievement](docs/UpdateAchievement.md) - [UpdateApplication](docs/UpdateApplication.md) - [UpdateApplicationApiKey](docs/UpdateApplicationApiKey.md) + - [UpdateApplicationCif](docs/UpdateApplicationCif.md) - [UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md) - [UpdateAudience](docs/UpdateAudience.md) - [UpdateCampaign](docs/UpdateCampaign.md) @@ -962,6 +1022,3 @@ Each of these functions takes a value of the given basic type and returns a poin * `PtrTime` ## Author - - - diff --git a/api/openapi.yaml b/api/openapi.yaml index 0f3e9d99..edca4d57 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -23,6 +23,9 @@ security: - manager_auth: [] - management_key: [] tags: +- description: | + Endpoints used for communication between Talon.One and the AI assistant. + name: AI assistant - description: | Represents the API used to send [Integration API](https://docs.talon.one/docs/dev/integration-api/overview) requests to a given Application. name: API keys @@ -306,7 +309,7 @@ paths: Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - - The endpoint will **only** consider the payload that you pass when **closing** the session. + - The endpoint considers **only** the payload that you pass when **closing** the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. @@ -1546,12 +1549,32 @@ paths: name: subledgerId schema: type: string + - description: | + Indicates whether tier information is included in the response. + + When set to `true`, the response includes information about the current tier and the number of points required to move to next tier. + in: query + name: includeTiers + schema: + default: false + type: boolean + - description: | + Indicates whether the customer's projected tier information is included in the response. + + When set to `true`, the response includes information about the customer’s active points and the name of the projected tier. + + **Note** We recommend filtering by `subledgerId` for better performance. + in: query + name: includeProjectedTier + schema: + default: false + type: boolean responses: "200": content: application/json: schema: - $ref: '#/components/schemas/LoyaltyBalances' + $ref: '#/components/schemas/LoyaltyBalancesWithTiers' description: OK "400": content: @@ -2088,7 +2111,6 @@ paths: - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -2096,7 +2118,6 @@ paths: - enabled - disabled - archived - - draft - scheduled - running - expired @@ -2516,7 +2537,6 @@ paths: - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -2524,7 +2544,6 @@ paths: - enabled - disabled - archived - - draft - scheduled - running - expired @@ -2679,32 +2698,32 @@ paths: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string, to the coupon start date timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. in: query name: startsAfter schema: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string, to the coupon start date timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. in: query name: startsBefore schema: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string, to the coupon expiration date timestamp. You + can use any time zone setting. Talon.One will convert to UTC internally. in: query name: expiresAfter schema: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string, to the coupon expiration date timestamp. You + can use any time zone setting. Talon.One will convert to UTC internally. in: query name: expiresBefore schema: @@ -2950,6 +2969,45 @@ paths: tags: - management x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs: + post: + description: | + This endpoint handles creating a job to delete coupons asynchronously. + operationId: createCouponsDeletionJob + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NewCouponDeletionJob' + description: body + required: true + responses: + "202": + content: + application/json: + schema: + $ref: '#/components/schemas/AsyncCouponDeletionJobResponse' + description: The deletion request has been accepted and will be processed + asynchronously + summary: Creates a coupon deletion job + tags: + - management + x-codegen-request-body-name: body /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total: get: description: | @@ -3034,6 +3092,17 @@ paths: - "true" - "false" type: string + - description: | + - `true`: only coupons where `usageCounter > 0` will be returned. + - `false`: only coupons where `usageCounter = 0` will be returned. + - This field cannot be used in conjunction with the `usable` query parameter. + in: query + name: redeemed + schema: + enum: + - "true" + - "false" + type: string - description: Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. in: query @@ -3058,6 +3127,45 @@ paths: schema: default: false type: boolean + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon expiration date timestamp. You + can use any time zone setting. Talon.One will convert to UTC internally. + in: query + name: expiresBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon expiration date timestamp. You + can use any time zone setting. Talon.One will convert to UTC internally. + in: query + name: expiresAfter + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon start date timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + in: query + name: startsBefore + schema: + format: date-time + type: string + - description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon start date timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + in: query + name: startsAfter + schema: + format: date-time + type: string + - description: Filter results to only return the coupon codes (`value` column) + without the associated coupon data. + in: query + name: valuesOnly + schema: + default: false + type: boolean responses: "200": content: @@ -3109,8 +3217,7 @@ paths:

Important

-

With this PUT endpoint only, any property you do not explicitly set in your request - will be set to null.

+

With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

operationId: updateCoupon @@ -3402,7 +3509,6 @@ paths: - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -3410,7 +3516,6 @@ paths: - enabled - disabled - archived - - draft - scheduled - running - expired @@ -3696,9 +3801,9 @@ paths: name: state schema: enum: + - draft - enabled - disabled - - draft type: string - description: Filter results performing case-insensitive matching against the name of the campaign template. @@ -3888,7 +3993,7 @@ paths: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - - `expirydate`: The expiration date of the tier. It should be a future date. + - `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. @@ -4115,8 +4220,8 @@ paths: - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - - `type`: The type of the loyalty program. - - `name`: The name of the loyalty program. + - `type`: The transaction type, such as `addition` or `subtraction`. + - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. @@ -4202,8 +4307,8 @@ paths: You can filter the results by providing the following optional input parameters: - - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported. + - `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. + - `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported. operationId: exportCustomersTiers parameters: - description: The identifier for the loyalty program. @@ -4553,6 +4658,63 @@ paths: summary: Import loyalty cards tags: - management + /v1/loyalty_programs/{loyaltyProgramId}/cards/batch: + post: + description: | + Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). + + Customers can use loyalty cards to collect and spend loyalty points. + + **Important:** + + - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. + - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code. + operationId: createBatchLoyaltyCards + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCardBatch' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCardBatchResponse' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Create loyalty cards + tags: + - management + x-codegen-request-body-name: body /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances: get: description: | @@ -4653,108 +4815,29 @@ paths: required: true schema: type: integer - - description: Optional query parameter to search cards by identifier. + - description: The card code by which to filter loyalty cards in the response. in: query name: identifier schema: minLength: 4 type: string - - description: Filter by the profile ID. + - description: Filter results by customer profile ID. in: query name: profileId schema: minimum: 1 type: integer - responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/inline_response_200_15' - description: OK - "400": - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponseWithStatus' - description: Bad request - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponseWithStatus' - description: Unauthorized - summary: List loyalty cards - tags: - - management - /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}: - delete: - description: Delete the given loyalty card. - operationId: deleteLoyaltyCard - parameters: - - description: | - Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with - the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. - in: path - name: loyaltyProgramId - required: true - schema: - type: integer - - description: | - Identifier of the loyalty card. You can get the identifier with - the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. - in: path - name: loyaltyCardId - required: true - schema: - maxLength: 108 - type: string - responses: - "204": - content: {} - description: No Content - "401": - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponseWithStatus' - description: Unauthorized - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponseWithStatus' - description: Not found - summary: Delete loyalty card - tags: - - management - get: - description: Get the given loyalty card. - operationId: getLoyaltyCard - parameters: - - description: | - Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with - the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. - in: path - name: loyaltyProgramId - required: true - schema: - type: integer - - description: | - Identifier of the loyalty card. You can get the identifier with - the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. - in: path - name: loyaltyCardId - required: true + - description: Filter results by loyalty card batch ID. + in: query + name: batchId schema: - maxLength: 108 type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/LoyaltyCard' + $ref: '#/components/schemas/inline_response_200_15' description: OK "400": content: @@ -4768,19 +4851,19 @@ paths: schema: $ref: '#/components/schemas/ErrorResponseWithStatus' description: Unauthorized - "404": - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponseWithStatus' - description: Not found - summary: Get loyalty card + summary: List loyalty cards tags: - management - put: - description: Update the status of the given loyalty card. A card can be _active_ - or _inactive_. - operationId: updateLoyaltyCard + post: + description: | + Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). + + To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. + + **Note:** + - The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. + - If the loyalty program has a defined code format, it will be used for the loyalty card identifier. + operationId: generateLoyaltyCard parameters: - description: | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with @@ -4790,20 +4873,212 @@ paths: required: true schema: type: integer - - description: | - Identifier of the loyalty card. You can get the identifier with - the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. - in: path - name: loyaltyCardId - required: true - schema: - maxLength: 108 - type: string requestBody: content: application/json: schema: - $ref: '#/components/schemas/UpdateLoyaltyCard' + $ref: '#/components/schemas/GenerateLoyaltyCard' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCard' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + security: + - api_key_v1: [] + summary: Generate loyalty card + tags: + - integration + x-codegen-request-body-name: body + /v1/loyalty_programs/{loyaltyProgramId}/cards/export: + get: + description: | + Download a CSV file containing the loyalty cards from a specified loyalty program. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The CSV file contains the following columns: + - `identifier`: The unique identifier of the loyalty card. + - `created`: The date and time the loyalty card was created. + - `status`: The status of the loyalty card. + - `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. + - `customerprofileids`: Integration IDs of the customer profiles linked to the card. + - `blockreason`: The reason for transferring and blocking the loyalty card. + - `generated`: An indicator of whether the loyalty card was generated. + - `batchid`: The ID of the batch the loyalty card is in. + operationId: exportLoyaltyCards + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: Filter results by loyalty card batch ID. + in: query + name: batchId + schema: + type: string + responses: + "200": + content: + application/csv: + example: | + identifier,created,status,userpercardlimit,customerprofileids,blockreason,generated,batchid + CARD-1234,2020-06-10T09:05:27.993483Z,active,3,['profile1'],card limit reached,false,gwedcbfp + schema: + format: csv + type: string + description: OK + "400": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + summary: Export loyalty cards + tags: + - management + /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}: + delete: + description: Delete the given loyalty card. + operationId: deleteLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + responses: + "204": + content: {} + description: No Content + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Delete loyalty card + tags: + - management + get: + description: Get the given loyalty card. + operationId: getLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LoyaltyCard' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Get loyalty card + tags: + - management + put: + description: Update the status of the given loyalty card. A card can be _active_ + or _inactive_. + operationId: updateLoyaltyCard + parameters: + - description: | + Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with + the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + in: path + name: loyaltyProgramId + required: true + schema: + type: integer + - description: | + Identifier of the loyalty card. You can get the identifier with + the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint. + in: path + name: loyaltyCardId + required: true + schema: + maxLength: 108 + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateLoyaltyCard' description: body required: true responses: @@ -7686,18 +7961,18 @@ paths: /v1/catalogs/{catalogId}/sync: put: description: | - Perform one or more of the following actions for a given cart item catalog: + Perform the following actions for a given cart item catalog: - - Adding an item to the catalog. - - Adding several items to the catalog. - - Editing the attributes of an item in the catalog. - - Editing the attributes of several items in the catalog. - - Removing an item from the catalog. - - Removing several items from the catalog. + - Add an item to the catalog. + - Add multiple items to the catalog. + - Update the attributes of an item in the catalog. + - Update the attributes of multiple items in the catalog. + - Remove an item from the catalog. + - Remove multiple items from the catalog. - You can add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. + You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. - **Important**: Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. + **Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). @@ -7761,7 +8036,7 @@ paths:
- Adding several items to the catalog + Adding multiple items to the catalog
```json @@ -7804,7 +8079,7 @@ paths:
- Editing the attributes of an item in the catalog + Updating the attributes of an item in the catalog
```json @@ -7831,7 +8106,7 @@ paths:
- Editing the attributes of several items in the catalog + Updating the attributes of multiple items in the catalog
```json @@ -7880,7 +8155,7 @@ paths:
- Removing several items from the catalog + Removing multiple items from the catalog
```json @@ -8099,7 +8374,10 @@ paths: description: List all webhooks. operationId: getWebhooks parameters: - - description: Filter by one or more Application IDs, separated by a comma. + - description: | + Checks if the given catalog or its attributes are referenced in the specified Application ID. + + **Note**: If no Application ID is provided, we check for all connected Applications. in: query name: applicationIds schema: @@ -8601,7 +8879,6 @@ paths: - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - - `draft`: Campaigns that are drafts. in: query name: campaignState schema: @@ -8609,7 +8886,6 @@ paths: - enabled - disabled - archived - - draft - scheduled - running - expired @@ -8769,16 +9045,16 @@ paths: schema: type: number - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string. You can use any time zone setting. Talon.One + will convert to UTC internally. in: query name: createdBefore schema: format: date-time type: string - description: Filter results comparing the parameter value, expected to be - an RFC3339 timestamp string, to the coupon creation timestamp. You can use - any time zone setting. Talon.One will convert to UTC internally. + an RFC3339 timestamp string. You can use any time zone setting. Talon.One + will convert to UTC internally. in: query name: createdAfter schema: @@ -9071,10 +9347,215 @@ paths: tags: - management x-codegen-request-body-name: body + /v1/provisioning/okta: + get: + description: | + Validate the ownership of the API through a challenge-response mechanism. + + This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible + for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta. + operationId: oktaEventHandlerChallenge + responses: + "200": + content: {} + description: OK + summary: Validate Okta API ownership + tags: + - management + /v1/provisioning/scim/Users: + get: + description: Retrieve a paginated list of users that have been provisioned using + the SCIM protocol with an identity provider, for example, Microsoft Entra + ID. + operationId: scimGetUsers + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimUsersListResponse' + description: List of SCIM users + summary: List SCIM users + tags: + - management + post: + description: Create a new Talon.One user using the SCIM provisioning protocol + with an identity provider, for example, Microsoft Entra ID. + operationId: scimCreateUser + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScimNewUser' + description: body + required: true + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimUser' + description: Created + summary: Create SCIM user + tags: + - management + x-codegen-request-body-name: body + /v1/provisioning/scim/Users/{userId}: + delete: + description: Delete a specific Talon.One user created using the SCIM provisioning + protocol with an identity provider, for example, Microsoft Entra ID. + operationId: scimDeleteUser + parameters: + - description: The ID of the user. + in: path + name: userId + required: true + schema: + type: integer + responses: + "204": + content: {} + description: No Content + summary: Delete SCIM user + tags: + - management + get: + description: Retrieve data for a specific Talon.One user created using the SCIM + provisioning protocol with an identity provider, for example, Microsoft Entra + ID. + operationId: scimGetUser + parameters: + - description: The ID of the user. + in: path + name: userId + required: true + schema: + type: integer + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimUser' + description: User details + summary: Get SCIM user + tags: + - management + patch: + description: | + Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + + This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged. + operationId: scimPatchUser + parameters: + - description: The ID of the user. + in: path + name: userId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScimPatchRequest' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimUser' + description: User details + summary: Update SCIM user attributes + tags: + - management + x-codegen-request-body-name: body + put: + description: | + Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + + This endpoint replaces all attributes of the specific user with the attributes provided in the request payload. + operationId: scimReplaceUserAttributes + parameters: + - description: The ID of the user. + in: path + name: userId + required: true + schema: + type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScimNewUser' + description: body + required: true + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimUser' + description: User details + summary: Update SCIM user + tags: + - management + x-codegen-request-body-name: body + /v1/provisioning/scim/ResourceTypes: + get: + description: | + Retrieve a list of resource types supported by the SCIM provisioning protocol. + + Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources. + operationId: scimGetResourceTypes + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimResourceTypesListResponse' + description: List of resource types + summary: List supported SCIM resource types + tags: + - management + /v1/provisioning/scim/ServiceProviderConfig: + get: + description: | + Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings. + operationId: scimGetServiceProviderConfig + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse' + description: Service configuration + summary: Get SCIM service provider configuration + tags: + - management + /v1/provisioning/scim/Schemas: + get: + description: | + Retrieve a list of schemas supported by the SCIM provisioning protocol. + + Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources. + operationId: scimGetSchemas + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ScimSchemasListResponse' + description: List of schemas supported by the SCIM provisioning protocol + summary: List supported SCIM schemas + tags: + - management /v1/users/delete: post: description: | - Delete a specific user by their email address. + [Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address. operationId: deleteUserByEmail requestBody: content: @@ -9094,7 +9575,7 @@ paths: /v1/users/activate: post: description: | - Activate a deactivated user by their email address. + Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address. operationId: activateUserByEmail requestBody: content: @@ -9107,14 +9588,14 @@ paths: "204": content: {} description: No Content - summary: Activate user by email address + summary: Enable user by email address tags: - management x-codegen-request-body-name: body /v1/users/deactivate: post: description: | - Deactivate a specific user by their email address. + [Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address. operationId: deactivateUserByEmail requestBody: content: @@ -9127,14 +9608,14 @@ paths: "204": content: {} description: No Content - summary: Deactivate user by email address + summary: Disable user by email address tags: - management x-codegen-request-body-name: body /v1/users/invite: post: description: | - Invite a user from an external identity provider to Talon.One by sending an invitation to their email address. + [Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address. operationId: inviteUserExternal requestBody: content: @@ -9791,6 +10272,174 @@ paths: tags: - management x-codegen-request-body-name: body + /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export: + get: + description: | + Download a CSV file containing the stores linked to a specific campaign. + + **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + + The CSV file contains the following column: + + - `store_integration_id`: The identifier of the store. + operationId: exportCampaignStores + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + responses: + "200": + content: + application/csv: + example: | + store_integration_id + STORE-001 + STORE-002 + STORE-003 + schema: + format: csv + type: string + description: OK + "400": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/csv: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Export stores + tags: + - management + /v1/applications/{applicationId}/campaigns/{campaignId}/stores: + delete: + description: Disconnect the stores linked to a specific campaign. + operationId: disconnectCampaignStores + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + responses: + "204": + content: {} + description: No Content + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Disconnect stores + tags: + - management + /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import: + post: + description: | + Upload a CSV file containing the stores you want to link to a specific campaign. + + Send the file as multipart data. + + The CSV file **must** only contain the following column: + - `store_integration_id`: The identifier of the store. + + The import **replaces** the previous list of stores linked to the campaign. + operationId: importCampaignStores + parameters: + - description: The ID of the Application. It is displayed in your Talon.One + deployment URL. + in: path + name: applicationId + required: true + schema: + type: integer + - description: The ID of the campaign. It is displayed in your Talon.One deployment + URL. + in: path + name: campaignId + required: true + schema: + type: integer + requestBody: + content: + multipart/form-data: + schema: + properties: + upFile: + description: The file containing the data that is being imported. + format: csv + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Import' + description: OK + "400": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + description: Bad request + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Unauthorized - Invalid API key + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponseWithStatus' + description: Not found + summary: Import stores + tags: + - management /v1/applications/{applicationId}/campaigns/{campaignId}/achievements: get: description: List all the achievements for a specific campaign. @@ -10495,7 +11144,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -10586,7 +11235,7 @@ components: type: array couponPattern: description: | - The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. + The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. example: SUMMER-####-#### maxLength: 100 minLength: 3 @@ -10781,6 +11430,17 @@ components: the campaign. example: 3 type: integer + defaultCartItemFilterId: + description: The ID of the default Cart-Item-Filter for this application. + example: 3 + type: integer + enableCampaignStateManagement: + description: | + Indicates whether the campaign staging and revisions feature is enabled for the Application. + + **Important:** After this feature is enabled, it cannot be disabled. + example: false + type: boolean required: - currency - name @@ -10862,6 +11522,13 @@ components: (16 hex digits). pattern: ^[a-fA-F0-9]{16}$ type: string + enableCampaignStateManagement: + description: | + Indicates whether the campaign staging and revisions feature is enabled for the Application. + + **Important:** After this feature is enabled, it cannot be disabled. + example: false + type: boolean required: - currency - name @@ -10873,6 +11540,8 @@ components: enableFlattenedCartItems: true created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false sandbox: true description: A test Application attributesSettings: @@ -10889,7 +11558,6 @@ components: enableCascadingDiscounts: true loyaltyPrograms: - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -10908,27 +11576,69 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -10947,25 +11657,68 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 name: My Application modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal @@ -11084,6 +11837,17 @@ components: the campaign. example: 3 type: integer + defaultCartItemFilterId: + description: The ID of the default Cart-Item-Filter for this application. + example: 3 + type: integer + enableCampaignStateManagement: + description: | + Indicates whether the campaign staging and revisions feature is enabled for the Application. + + **Important:** After this feature is enabled, it cannot be disabled. + example: false + type: boolean loyaltyPrograms: description: An array containing all the loyalty programs to which this application is subscribed. @@ -11369,6 +12133,40 @@ components: - state - tags type: object + CampaignVersions: + properties: + activeRevisionId: + description: | + ID of the revision that was last activated on this campaign. + example: 6 + type: integer + activeRevisionVersionId: + description: | + ID of the revision version that is active on the campaign. + example: 6 + type: integer + version: + description: | + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. + example: 6 + type: integer + currentRevisionId: + description: | + ID of the revision currently being modified for the campaign. + example: 6 + type: integer + currentRevisionVersionId: + description: | + ID of the latest version applied on the current revision. + example: 6 + type: integer + stageRevision: + default: false + description: | + Flag for determining whether we use current revision when sending requests with staging API key. + example: false + type: boolean + type: object UpdateCampaign: example: activeRulesetId: 2 @@ -11591,6 +12389,126 @@ components: description: | A list of store IDs that you want to link to the campaign. + **Note:** + - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. + - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. + example: + - 1 + - 2 + - 3 + items: + type: integer + type: array + required: + - features + - limits + - name + - tags + type: object + BaseCampaign: + properties: + name: + description: A user-facing name for this campaign. + example: Summer promotions + minLength: 1 + title: Campaign Name + type: string + description: + description: A detailed description of the campaign. + example: Campaign for all summer 2021 promotions + title: Campaign Description + type: string + startTime: + description: Timestamp when the campaign will become active. + example: 2021-07-20T22:00:00Z + format: date-time + type: string + endTime: + description: Timestamp when the campaign will become inactive. + example: 2021-09-22T22:00:00Z + format: date-time + type: string + attributes: + description: Arbitrary properties associated with this campaign. + properties: {} + type: object + state: + default: enabled + description: | + A disabled or archived campaign is not evaluated for rules or coupons. + enum: + - enabled + - disabled + - archived + example: enabled + type: string + activeRulesetId: + description: | + [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this + campaign applies on customer session evaluation. + example: 6 + type: integer + tags: + description: A list of tags for the campaign. + example: + - summer + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 50 + type: array + features: + description: The features enabled in this campaign. + example: + - coupons + - referrals + items: + enum: + - coupons + - referrals + - loyalty + - giveaways + - strikethrough + - achievements + type: string + type: array + couponSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + referralSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + limits: + description: | + The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. + items: + $ref: '#/components/schemas/LimitConfig' + type: array + campaignGroups: + description: | + The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. + example: + - 1 + - 3 + items: + type: integer + type: array + type: + default: advanced + description: | + The campaign type. Possible type values: + - `cartItem`: Type of campaign that can apply effects only to cart items. + - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. + enum: + - cartItem + - advanced + example: advanced + title: Type + type: string + linkedStoreIds: + description: | + A list of store IDs that you want to link to the campaign. + **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. @@ -11605,290 +12523,178 @@ components: - features - limits - name + - state - tags type: object - BaseCampaign: + Campaign: + description: "" + example: + callApiEffectCount: 0 + createdLoyaltyPointsEffectCount: 2 + discountCount: 288.0 + description: Campaign for all summer 2021 promotions + type: advanced + templateId: 3 + activeRevisionVersionId: 6 + customEffectCount: 0 + activeRevisionId: 6 + features: + - coupons + - referrals + currentRevisionVersionId: 6 + createdLoyaltyPointsCount: 9.0 + storesImported: true + couponSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + startTime: 2021-07-20T22:00:00Z + id: 4 + state: enabled + currentRevisionId: 6 + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + activeRulesetId: 6 + reservecouponEffectCount: 9 + updatedBy: Jane Doe + frontendState: running + created: 2020-06-10T09:05:27.993483Z + referralCreationCount: 8 + stageRevision: false + couponRedemptionCount: 163 + userId: 388 + couponCreationCount: 16 + version: 6 + campaignGroups: + - 1 + - 3 + tags: + - summer + awardedGiveawaysCount: 9 + redeemedLoyaltyPointsEffectCount: 9 + linkedStoreIds: + - 1 + - 2 + - 3 + discountEffectCount: 343 + budgets: + - limit: 1000.0 + action: createCoupon + counter: 42.0 + - limit: 1000.0 + action: createCoupon + counter: 42.0 + createdBy: John Doe + redeemedLoyaltyPointsCount: 8.0 + addFreeItemEffectCount: 0 + name: Summer promotions + referralSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + attributes: '{}' + lastActivity: 2022-11-10T23:00:00Z + endTime: 2021-09-22T22:00:00Z + applicationId: 322 + referralRedemptionCount: 3 + updated: 2000-01-23T04:56:07.000+00:00 properties: - name: - description: A user-facing name for this campaign. - example: Summer promotions - minLength: 1 - title: Campaign Name - type: string - description: - description: A detailed description of the campaign. - example: Campaign for all summer 2021 promotions - title: Campaign Description - type: string - startTime: - description: Timestamp when the campaign will become active. - example: 2021-07-20T22:00:00Z - format: date-time - type: string - endTime: - description: Timestamp when the campaign will become inactive. - example: 2021-09-22T22:00:00Z - format: date-time - type: string - attributes: - description: Arbitrary properties associated with this campaign. - properties: {} - type: object - state: - default: enabled - description: | - A disabled or archived campaign is not evaluated for rules or coupons. - enum: - - enabled - - disabled - - archived - example: enabled - type: string - activeRulesetId: - description: | - [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this - campaign applies on customer session evaluation. - example: 6 - type: integer - tags: - description: A list of tags for the campaign. - example: - - summer - items: - maxLength: 50 - minLength: 1 - type: string - maxItems: 50 - type: array - features: - description: The features enabled in this campaign. - example: - - coupons - - referrals - items: - enum: - - coupons - - referrals - - loyalty - - giveaways - - strikethrough - - achievements - type: string - type: array - couponSettings: - $ref: '#/components/schemas/CodeGeneratorSettings' - referralSettings: - $ref: '#/components/schemas/CodeGeneratorSettings' - limits: - description: | - The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. - items: - $ref: '#/components/schemas/LimitConfig' - type: array - campaignGroups: - description: | - The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. - example: - - 1 - - 3 - items: - type: integer - type: array - type: - default: advanced - description: | - The campaign type. Possible type values: - - `cartItem`: Type of campaign that can apply effects only to cart items. - - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. - enum: - - cartItem - - advanced - example: advanced - title: Type - type: string - linkedStoreIds: - description: | - A list of store IDs that you want to link to the campaign. - - **Note:** Campaigns with linked store IDs will only be evaluated when there is a - [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) - that references a linked store. - example: - - 1 - - 2 - - 3 - items: - type: integer - type: array - required: - - features - - limits - - name - - state - - tags - type: object - Campaign: - description: "" - example: - callApiEffectCount: 0 - createdLoyaltyPointsEffectCount: 2 - discountCount: 288.0 - description: Campaign for all summer 2021 promotions - type: advanced - templateId: 3 - customEffectCount: 0 - features: - - coupons - - referrals - createdLoyaltyPointsCount: 9.0 - couponSettings: - couponPattern: SUMMER-####-#### - validCharacters: - - A - - B - - C - - D - - E - - F - - G - - H - - I - - J - - K - - L - - M - - "N" - - O - - P - - Q - - R - - S - - T - - U - - V - - W - - X - - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" - startTime: 2021-07-20T22:00:00Z - id: 4 - state: enabled - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - activeRulesetId: 6 - reservecouponEffectCount: 9 - updatedBy: Jane Doe - frontendState: running - created: 2020-06-10T09:05:27.993483Z - referralCreationCount: 8 - couponRedemptionCount: 163 - userId: 388 - couponCreationCount: 16 - campaignGroups: - - 1 - - 3 - tags: - - summer - awardedGiveawaysCount: 9 - redeemedLoyaltyPointsEffectCount: 9 - linkedStoreIds: - - 1 - - 2 - - 3 - discountEffectCount: 343 - budgets: - - limit: 1000.0 - action: createCoupon - counter: 42.0 - - limit: 1000.0 - action: createCoupon - counter: 42.0 - createdBy: John Doe - redeemedLoyaltyPointsCount: 8.0 - addFreeItemEffectCount: 0 - name: Summer promotions - referralSettings: - couponPattern: SUMMER-####-#### - validCharacters: - - A - - B - - C - - D - - E - - F - - G - - H - - I - - J - - K - - L - - M - - "N" - - O - - P - - Q - - R - - S - - T - - U - - V - - W - - X - - "Y" - - Z - - "0" - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - - "8" - - "9" - attributes: '{}' - lastActivity: 2022-11-10T23:00:00Z - endTime: 2021-09-22T22:00:00Z - applicationId: 322 - referralRedemptionCount: 3 - updated: 2000-01-23T04:56:07.000+00:00 - properties: - id: - description: Unique ID for this entity. - example: 4 - type: integer - created: - description: The exact moment this entity was created. - example: 2020-06-10T09:05:27.993483Z - format: date-time - type: string - applicationId: - description: The ID of the application that owns this entity. - example: 322 - type: integer - userId: - description: The ID of the user associated with this entity. - example: 388 - type: integer + id: + description: Unique ID for this entity. + example: 4 + type: integer + created: + description: The exact moment this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + userId: + description: The ID of the user associated with this entity. + example: 388 + type: integer name: description: A user-facing name for this campaign. example: Summer promotions @@ -12128,11 +12934,46 @@ components: - expired - scheduled - running - - draft - disabled - archived example: running type: string + storesImported: + description: Indicates whether the linked stores were imported via a CSV + file. + example: true + type: boolean + activeRevisionId: + description: | + ID of the revision that was last activated on this campaign. + example: 6 + type: integer + activeRevisionVersionId: + description: | + ID of the revision version that is active on the campaign. + example: 6 + type: integer + version: + description: | + Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. + example: 6 + type: integer + currentRevisionId: + description: | + ID of the revision currently being modified for the campaign. + example: 6 + type: integer + currentRevisionVersionId: + description: | + ID of the latest version applied on the current revision. + example: 6 + type: integer + stageRevision: + default: false + description: | + Flag for determining whether we use current revision when sending requests with staging API key. + example: false + type: boolean required: - applicationId - budgets @@ -12144,10 +12985,214 @@ components: - limits - name - state + - storesImported - tags - type - userId type: object + Revision: + description: "" + properties: + id: + description: 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. + example: 6 + type: integer + activateAt: + format: date-time + type: string + accountId: + type: integer + applicationId: + type: integer + campaignId: + type: integer + created: + format: date-time + type: string + createdBy: + type: integer + activatedAt: + format: date-time + type: string + activatedBy: + type: integer + currentVersion: + $ref: '#/components/schemas/RevisionVersion' + required: + - accountId + - applicationId + - campaignId + - created + - createdBy + - id + type: object + RevisionActivation: + properties: + activateAt: + format: date-time + type: string + type: object + RevisionVersion: + description: "" + properties: + id: + description: 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. + example: 6 + type: integer + accountId: + type: integer + applicationId: + type: integer + campaignId: + type: integer + created: + format: date-time + type: string + createdBy: + type: integer + revisionId: + type: integer + version: + type: integer + name: + description: A user-facing name for this campaign. + example: Summer promotions + minLength: 1 + title: Campaign Name + type: string + startTime: + description: Timestamp when the campaign will become active. + example: 2021-07-20T22:00:00Z + format: date-time + nullable: true + type: string + endTime: + description: Timestamp when the campaign will become inactive. + example: 2021-09-22T22:00:00Z + format: date-time + nullable: true + type: string + attributes: + description: Arbitrary properties associated with this campaign. + properties: {} + type: object + description: + description: A detailed description of the campaign. + example: Campaign for all summer 2021 promotions + nullable: true + title: Campaign Description + type: string + activeRulesetId: + description: The ID of the ruleset this campaign template will use. + example: 5 + nullable: true + type: integer + tags: + description: A list of tags for the campaign template. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 50 + type: array + couponSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + referralSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + limits: + description: The set of limits that will operate for this campaign version. + items: + $ref: '#/components/schemas/LimitConfig' + type: array + features: + description: A list of features for the campaign template. + items: + enum: + - coupons + - referrals + - loyalty + - giveaways + - strikethrough + - achievements + type: string + type: array + required: + - accountId + - applicationId + - campaignId + - created + - createdBy + - id + - revisionId + - version + type: object + NewRevisionVersion: + properties: + name: + description: A user-facing name for this campaign. + example: Summer promotions + minLength: 1 + title: Campaign Name + type: string + startTime: + description: Timestamp when the campaign will become active. + example: 2021-07-20T22:00:00Z + format: date-time + nullable: true + type: string + endTime: + description: Timestamp when the campaign will become inactive. + example: 2021-09-22T22:00:00Z + format: date-time + nullable: true + type: string + attributes: + description: Arbitrary properties associated with this campaign. + properties: {} + type: object + description: + description: A detailed description of the campaign. + example: Campaign for all summer 2021 promotions + nullable: true + title: Campaign Description + type: string + activeRulesetId: + description: The ID of the ruleset this campaign template will use. + example: 5 + nullable: true + type: integer + tags: + description: A list of tags for the campaign template. + items: + maxLength: 50 + minLength: 1 + type: string + maxItems: 50 + type: array + couponSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + referralSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + limits: + description: The set of limits that will operate for this campaign version. + items: + $ref: '#/components/schemas/LimitConfig' + type: array + features: + description: A list of features for the campaign template. + items: + enum: + - coupons + - referrals + - loyalty + - giveaways + - strikethrough + - achievements + type: string + type: array + type: object CampaignBudget: example: limit: 1000.0 @@ -12309,14 +13354,19 @@ components: - expired - scheduled - running - - draft - disabled - archived example: running type: string + storesImported: + description: Indicates whether the linked stores were imported via a CSV + file. + example: true + type: boolean required: - budgets - frontendState + - storesImported type: object NewRuleset: properties: @@ -13073,7 +14123,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13106,7 +14156,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13142,7 +14192,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13224,7 +14274,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13312,7 +14362,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13379,7 +14429,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13499,7 +14549,7 @@ components: type: string expiryDate: description: Expiration date of the referral code. Referral never expires - if this is omitted, zero, or negative. + if this is omitted. example: 2021-11-10T23:00:00Z format: date-time title: Referral code valid until @@ -13726,7 +14776,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -13870,7 +14920,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -13988,7 +15038,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -14065,7 +15115,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -14167,7 +15217,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -14345,7 +15395,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -14550,7 +15600,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -15162,10 +16212,6 @@ components: description: HTTP status code of the response. example: 200 type: integer - required: - - createdAt - - response - - status type: object WebhookActivationLogEntry: description: Log of activated webhooks. @@ -15226,6 +16272,7 @@ components: email: john.doe@example.com policy: Role: 127 + additionalAttributes: '{}' properties: id: description: Internal ID of this entity. @@ -15309,6 +16356,11 @@ components: example: 2020-06-01T00:00:00Z format: date-time type: string + additionalAttributes: + description: Additional user attributes, created and used by external identity + providers. + properties: {} + type: object required: - accountId - created @@ -15359,6 +16411,367 @@ components: required: - email type: object + OktaEventTarget: + description: Target of the specific Okta event. + properties: + type: + description: Type of the event target. + example: AppUser + type: string + alternateId: + description: Identifier of the event target, depending on its type. + example: john.doe@example.com + type: string + displayName: + description: Display name of the event target. + example: John Doe + type: string + required: + - alternateId + - displayName + - type + type: object + OktaEvent: + description: Single event definition in the event data emitted by Okta. + properties: + eventType: + description: Event type defining an action. + example: application.user_membership.add + type: string + target: + items: + $ref: '#/components/schemas/OktaEventTarget' + type: array + required: + - eventType + - target + type: object + OktaEventPayloadData: + description: Data part of the event emitted by Okta. + properties: + events: + items: + $ref: '#/components/schemas/OktaEvent' + type: array + required: + - events + type: object + OktaEventPayload: + description: Payload containing provisioning event details from Okta. + properties: + data: + $ref: '#/components/schemas/OktaEventPayloadData' + required: + - data + type: object + ScimBaseUser: + description: Schema definition for base user fields, provisioned using the SCIM + protocol and used by Talon.One. + properties: + active: + description: Status of the user. + example: true + type: boolean + displayName: + description: Display name of the user. + example: John Doe + type: string + userName: + description: Unique identifier of the user. This is usually an email address. + example: john.doe@example.com + type: string + name: + $ref: '#/components/schemas/ScimBaseUser_name' + type: object + ScimNewUser: + description: Payload for users that are created using the SCIM provisioning + protocol with an identity provider, for example, Microsoft Entra ID. + example: + displayName: John Doe + name: + formatted: Mr. John J Doe + active: true + userName: john.doe@example.com + properties: + active: + description: Status of the user. + example: true + type: boolean + displayName: + description: Display name of the user. + example: John Doe + type: string + userName: + description: Unique identifier of the user. This is usually an email address. + example: john.doe@example.com + type: string + name: + $ref: '#/components/schemas/ScimBaseUser_name' + type: object + ScimUser: + description: Schema definition for users that have been provisioned using the + SCIM protocol with an identity provider, for example, Microsoft Entra ID. + example: + displayName: John Doe + name: + formatted: Mr. John J Doe + active: true + id: "359" + userName: john.doe@example.com + properties: + active: + description: Status of the user. + example: true + type: boolean + displayName: + description: Display name of the user. + example: John Doe + type: string + userName: + description: Unique identifier of the user. This is usually an email address. + example: john.doe@example.com + type: string + name: + $ref: '#/components/schemas/ScimBaseUser_name' + id: + description: ID of the user. + example: "359" + type: string + required: + - id + type: object + ScimResource: + description: Resource definition for the SCIM provisioning protocol. + example: + id: User + name: User + description: User Account + properties: + id: + description: ID of the resource. + type: string + name: + description: Name of the resource. + type: string + description: + description: Human-readable description of the resource. + type: string + type: object + ScimSchemaResource: + description: Resource schema definition for the SCIM provisioning protocol. + example: + id: urn:ietf:params:scim:schemas:core:2.0:User + name: User + description: User Account + attributes: + - name: userName + required: true + mutability: readWrite + - name: profileUrl + required: false + mutability: readWrite + properties: + id: + description: ID of the resource. + type: string + name: + description: Name of the resource. + type: string + description: + description: Human-readable description of the schema resource. + type: string + attributes: + items: + description: Key-value attributes of the resource. + properties: {} + type: object + type: array + type: object + ScimUsersListResponse: + description: List of users that have been provisioned using the SCIM protocol + with an identity provider, for example, Microsoft Entra ID. + example: + Resources: + - active: true + displayName: John Doe + id: 283 + meta: + resourceType: User + created: 2024-06-25T17:43:46+02:00 + userName: john.doe@example.com + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + properties: + Resources: + items: + $ref: '#/components/schemas/ScimUser' + type: array + schemas: + description: SCIM schema for the given resource. + items: + example: urn:ietf:params:scim:api:messages:2.0:ListResponse + type: string + type: array + totalResults: + description: Number of total results in the response. + type: integer + required: + - Resources + type: object + ScimPatchOperation: + description: Patch operation that is used to update the information. + example: + op: add + path: nickName + value: John + properties: + op: + description: The method that should be used in the operation. + enum: + - add + - remove + - replace + type: string + path: + description: The path specifying the attribute that should be updated. + type: string + value: + description: The value that should be updated. Required if `op` is `add` + or `replace`. + type: string + required: + - op + type: object + ScimPatchRequest: + description: SCIM Patch request + example: + Operations: + - op: replace + path: active + value: false + - op: add + path: nickName + value: johndoe + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + properties: + schemas: + description: SCIM schema for the given resource. + items: + example: urn:ietf:params:scim:api:messages:2.0:PatchOp + type: string + type: array + Operations: + items: + $ref: '#/components/schemas/ScimPatchOperation' + type: array + required: + - Operations + type: object + ScimResourceTypesListResponse: + description: List of resource types supported by the SCIM provisioning protocol. + example: + Resources: + - id: User + name: User + description: User Account + - id: User + name: User + description: User Account + properties: + Resources: + items: + $ref: '#/components/schemas/ScimResource' + type: array + required: + - Resources + type: object + ScimServiceProviderConfigResponse: + description: Service provider configuration details. + example: + bulk: + maxOperations: 1000 + maxPayloadSize: 1048576 + supported: true + changePassword: + supported: false + documentationUri: example.com/scim/docs + filter: + maxResults: 100 + supported: true + patch: + supported: true + schemas: + - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig + properties: + bulk: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse_bulk' + changePassword: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse_changePassword' + documentationUri: + description: The URI that points to the SCIM service provider's documentation, + providing further details about the service's capabilities and usage. + type: string + filter: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse_filter' + patch: + $ref: '#/components/schemas/ScimServiceProviderConfigResponse_patch' + schemas: + description: A list of SCIM schemas that define the structure and data types + supported by the service provider. + items: + type: string + type: array + type: object + ScimSchemasListResponse: + description: List of resource schemas supported by the SCIM provisioning protocol. + example: + totalResults: 0 + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + - urn:ietf:params:scim:api:messages:2.0:ListResponse + Resources: + - id: urn:ietf:params:scim:schemas:core:2.0:User + name: User + description: User Account + attributes: + - name: userName + required: true + mutability: readWrite + - name: profileUrl + required: false + mutability: readWrite + - id: urn:ietf:params:scim:schemas:core:2.0:User + name: User + description: User Account + attributes: + - name: userName + required: true + mutability: readWrite + - name: profileUrl + required: false + mutability: readWrite + properties: + Resources: + items: + $ref: '#/components/schemas/ScimSchemaResource' + type: array + schemas: + description: SCIM schema for the given resource. + items: + example: urn:ietf:params:scim:api:messages:2.0:ListResponse + type: string + type: array + totalResults: + description: Number of total results in the response. + type: integer + required: + - Resources + type: object NewInvitation: description: Parameters for inviting a new user. example: @@ -15633,7 +17046,6 @@ components: description: "" example: cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -15652,25 +17064,68 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 properties: id: description: The ID of loyalty program. Internal ID of this entity. @@ -15730,18 +17185,43 @@ components: example: true title: Sandbox type: boolean + programJoinPolicy: + description: | + 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. + enum: + - not_join + - points_activated + - points_earned + type: string tiersExpirationPolicy: description: | - 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. + 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`. enum: - tier_start_date - program_join_date + - customer_attribute + - absolute_expiration + type: string + tierCycleStartDate: + description: | + 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`. + example: 2021-09-12T10:12:42Z + format: date-time type: string tiersExpireIn: description: | - The amount of time after which the tier expires. + 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`. @@ -15763,26 +17243,15 @@ components: type: string tiersDowngradePolicy: description: | - 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. + 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. enum: - one_down - balance_based type: string - programJoinPolicy: - description: | - 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. - enum: - - not_join - - points_activated - - points_earned - type: string + cardCodeSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' accountID: description: The ID of the Talon.One account that owns this program. example: 1 @@ -15834,7 +17303,12 @@ components: type: boolean canUpdateJoinPolicy: description: | - Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`. + `True` if the program join policy can be updated. + example: true + type: boolean + canUpdateTierExpirationPolicy: + description: | + `True` if the tier expiration policy can be updated. example: true type: boolean canUpgradeToAdvancedTiers: @@ -15843,6 +17317,12 @@ components: `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. example: true type: boolean + canUpdateSubledgers: + default: false + description: | + `True` if the `allowSubledger` property can be updated in the loyalty program. + example: true + type: boolean required: - accountID - allowSubledger @@ -15964,18 +17444,43 @@ components: example: true title: Sandbox type: boolean + programJoinPolicy: + description: | + 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. + enum: + - not_join + - points_activated + - points_earned + type: string tiersExpirationPolicy: description: | - 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. + 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`. enum: - tier_start_date - program_join_date + - customer_attribute + - absolute_expiration + type: string + tierCycleStartDate: + description: | + 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`. + example: 2021-09-12T10:12:42Z + format: date-time type: string tiersExpireIn: description: | - The amount of time after which the tier expires. + 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`. @@ -15997,26 +17502,15 @@ components: type: string tiersDowngradePolicy: description: | - 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. + 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. enum: - one_down - balance_based type: string - programJoinPolicy: - description: | - 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. - enum: - - not_join - - points_activated - - points_earned - type: string + cardCodeSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' type: object NewLoyaltyProgram: description: "" @@ -16071,46 +17565,6 @@ components: example: true title: Sandbox type: boolean - tiersExpirationPolicy: - description: | - 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. - enum: - - tier_start_date - - program_join_date - type: string - tiersExpireIn: - description: | - 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. - example: 27W_U - type: string - tiersDowngradePolicy: - description: | - 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. - enum: - - one_down - - balance_based - type: string programJoinPolicy: description: | The policy that defines when the customer joins the loyalty program. @@ -16124,103 +17578,30 @@ components: - points_activated - points_earned type: string - name: - description: The internal name for the Loyalty Program. This is an immutable - value. - example: GeneralPointCollection - type: string - tiers: - description: The tiers in this loyalty program. - items: - $ref: '#/components/schemas/NewLoyaltyTier' - type: array - timezone: - description: A string containing an IANA timezone descriptor. - minLength: 1 - type: string - cardBased: - default: false - description: | - Defines the type of loyalty program: - - `true`: the program is a card-based. - - `false`: the program is profile-based. - example: true - type: boolean - required: - - allowSubledger - - cardBased - - defaultPending - - defaultValidity - - name - - sandbox - - timezone - - title - type: object - UpdateLoyaltyProgram: - description: "" - properties: - title: - description: The display title for the Loyalty Program. - example: Point collection - type: string - description: - description: Description of our Loyalty Program. - example: Customers collect 10 points per 1$ spent - type: string - subscribedApplications: - description: A list containing the IDs of all applications that are subscribed - to this Loyalty Program. - example: - - 132 - - 97 - items: - type: integer - type: array - defaultValidity: - description: | - The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. - The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. - example: 2W_U - type: string - defaultPending: - description: | - The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. - The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. - example: immediate - type: string - allowSubledger: - description: Indicates if this program supports subledgers inside the program. - example: false - type: boolean - usersPerCardLimit: - description: | - 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`. - example: 111 - minimum: 0 - type: integer - sandbox: - description: 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. - example: true - title: Sandbox - type: boolean tiersExpirationPolicy: description: | - 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. + 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`. enum: - tier_start_date - program_join_date + - customer_attribute + - absolute_expiration + type: string + tierCycleStartDate: + description: | + 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`. + example: 2021-09-12T10:12:42Z + format: date-time type: string tiersExpireIn: description: | - The amount of time after which the tier expires. + 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`. @@ -16242,13 +17623,100 @@ components: type: string tiersDowngradePolicy: description: | - 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. + 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. enum: - one_down - balance_based type: string + cardCodeSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' + name: + description: The internal name for the Loyalty Program. This is an immutable + value. + example: GeneralPointCollection + type: string + tiers: + description: The tiers in this loyalty program. + items: + $ref: '#/components/schemas/NewLoyaltyTier' + type: array + timezone: + description: A string containing an IANA timezone descriptor. + minLength: 1 + type: string + cardBased: + default: false + description: | + Defines the type of loyalty program: + - `true`: the program is a card-based. + - `false`: the program is profile-based. + example: true + type: boolean + required: + - allowSubledger + - cardBased + - defaultPending + - defaultValidity + - name + - sandbox + - timezone + - title + type: object + UpdateLoyaltyProgram: + description: "" + properties: + title: + description: The display title for the Loyalty Program. + example: Point collection + type: string + description: + description: Description of our Loyalty Program. + example: Customers collect 10 points per 1$ spent + type: string + subscribedApplications: + description: A list containing the IDs of all applications that are subscribed + to this Loyalty Program. + example: + - 132 + - 97 + items: + type: integer + type: array + defaultValidity: + description: | + The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: 2W_U + type: string + defaultPending: + description: | + The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. + The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: + - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. + - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. + example: immediate + type: string + allowSubledger: + description: Indicates if this program supports subledgers inside the program. + example: false + type: boolean + usersPerCardLimit: + description: | + 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`. + example: 111 + minimum: 0 + type: integer + sandbox: + description: 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. + example: true + title: Sandbox + type: boolean programJoinPolicy: description: | The policy that defines when the customer joins the loyalty program. @@ -16262,6 +17730,60 @@ components: - points_activated - points_earned type: string + tiersExpirationPolicy: + description: | + 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`. + enum: + - tier_start_date + - program_join_date + - customer_attribute + - absolute_expiration + type: string + tierCycleStartDate: + description: | + 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`. + example: 2021-09-12T10:12:42Z + format: date-time + type: string + tiersExpireIn: + description: | + 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. + example: 27W_U + type: string + tiersDowngradePolicy: + description: | + 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. + enum: + - one_down + - balance_based + type: string + cardCodeSettings: + $ref: '#/components/schemas/CodeGeneratorSettings' tiers: description: The tiers in this loyalty program. items: @@ -16407,18 +17929,6 @@ components: type: object LoyaltyBalances: description: List of loyalty balances for a ledger and its subledgers. - example: - balance: - activePoints: 286.0 - spentPoints: 150.0 - expiredPoints: 286.0 - pendingPoints: 50.0 - subledgerBalances: - mysubledger: - activePoints: 286 - pendingPoints: 50 - spentPoints: 150 - expiredPoints: 25 properties: balance: $ref: '#/components/schemas/LoyaltyBalance' @@ -16466,6 +17976,103 @@ components: title: Total expired points type: number type: object + LoyaltyBalanceWithTier: + description: "" + example: + projectedTier: + projectedActivePoints: 198.0 + stayInTierPoints: 2.0 + projectedTierName: Tier 1 + activePoints: 286.0 + spentPoints: 150.0 + nextTierName: silver + pointsToNextTier: 20.0 + expiredPoints: 286.0 + currentTier: + expiryDate: 2000-01-23T04:56:07.000+00:00 + downgradePolicy: one_down + name: bronze + id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + pendingPoints: 50.0 + properties: + activePoints: + description: Total amount of points awarded to this customer and available + to spend. + example: 286.0 + title: Current Balance + type: number + pendingPoints: + description: Total amount of points awarded to this customer but not available + until their start date. + example: 50.0 + title: Total pending points + type: number + spentPoints: + description: Total amount of points already spent by this customer. + example: 150.0 + title: Total spent points + type: number + expiredPoints: + description: Total amount of points awarded but never redeemed. They cannot + be used anymore. + example: 286.0 + title: Total expired points + type: number + currentTier: + $ref: '#/components/schemas/Tier' + projectedTier: + $ref: '#/components/schemas/ProjectedTier' + pointsToNextTier: + description: The number of points required to move up a tier. + example: 20.0 + type: number + nextTierName: + description: The name of the tier consecutive to the current tier. + example: silver + type: string + type: object + LoyaltyBalancesWithTiers: + description: List of loyalty balances for a ledger and its subledgers. + example: + balance: + projectedTier: + projectedActivePoints: 198.0 + stayInTierPoints: 2.0 + projectedTierName: Tier 1 + activePoints: 286.0 + spentPoints: 150.0 + nextTierName: silver + pointsToNextTier: 20.0 + expiredPoints: 286.0 + currentTier: + expiryDate: 2000-01-23T04:56:07.000+00:00 + downgradePolicy: one_down + name: bronze + id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + pendingPoints: 50.0 + subledgerBalances: + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 + properties: + balance: + $ref: '#/components/schemas/LoyaltyBalanceWithTier' + subledgerBalances: + additionalProperties: + $ref: '#/components/schemas/LoyaltyBalanceWithTier' + description: Map of the loyalty balances of the subledgers of a ledger. + example: + mysubledger: + activePoints: 286 + pendingPoints: 50 + spentPoints: 150 + expiredPoints: 25 + type: object + type: object LoyaltyLedger: description: Ledger of Balance in Loyalty Program for a Customer. example: @@ -16596,6 +18203,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 pendingPoints: - eventID: 5 amount: 100.0 @@ -16777,6 +18385,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 pendingPoints: - eventID: 5 amount: 100.0 @@ -16882,6 +18491,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -16905,8 +18515,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -16923,6 +18536,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -16946,8 +18560,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -16966,6 +18583,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -16981,6 +18599,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -17017,6 +18636,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -17032,6 +18652,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -17083,6 +18704,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 properties: currentBalance: description: Sum of currently active points. @@ -17134,28 +18756,13 @@ components: - spentBalance - tentativeCurrentBalance type: object - LoyaltyProgramSubledgers: - description: The list of all the subledgers that the loyalty program has. - properties: - loyaltyProgramId: - description: The internal ID of the loyalty program. - example: 5 - type: integer - subledgerIds: - description: The list of subledger IDs. - items: - type: string - type: array - required: - - loyaltyProgramId - - subledgerIds - type: object Tier: example: expiryDate: 2000-01-23T04:56:07.000+00:00 downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 properties: id: description: The internal ID of the tier. @@ -17165,6 +18772,11 @@ components: description: The name of the tier. example: bronze type: string + startDate: + description: Date and time when the customer moved to this tier. This value + uses the loyalty program's time zone setting. + format: date-time + type: string expiryDate: description: Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone). @@ -17172,9 +18784,9 @@ components: type: string downgradePolicy: description: | - 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. + 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. enum: - one_down - balance_based @@ -17183,6 +18795,31 @@ components: - id - name type: object + ProjectedTier: + example: + projectedActivePoints: 198.0 + stayInTierPoints: 2.0 + projectedTierName: Tier 1 + properties: + projectedActivePoints: + description: The active points of the customer when their current tier expires. + example: 198.0 + type: number + stayInTierPoints: + description: | + The number of points the customer needs to stay in the current tier. + + **Note**: This is included in the response when the customer is projected to be downgraded. + example: 2.0 + type: number + projectedTierName: + description: The name of the tier the user will enter once their current + tier expires. + example: Tier 1 + type: string + required: + - projectedActivePoints + type: object TimePoint: description: | The absolute duration after which the achievement ends and resets for a particular customer profile. @@ -17238,6 +18875,31 @@ components: - minute - second type: object + GenerateLoyaltyCard: + description: The parameters necessary to generate a loyalty card. + example: + status: inactive + customerProfileIds: + - R195412 + - G244519 + properties: + status: + default: active + description: Status of the loyalty card. + enum: + - active + - inactive + example: active + type: string + customerProfileIds: + description: Integration IDs of the customer profiles linked to the card. + example: + - R195412 + - G244519 + items: + type: string + type: array + type: object LoyaltyCard: description: "" example: @@ -17254,6 +18916,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -17277,8 +18940,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -17298,9 +18964,14 @@ components: type: integer status: description: | - Status of the loyalty card. Can be one of: ['active', 'inactive'] + Status of the loyalty card. Can be `active` or `inactive`. example: active type: string + blockReason: + description: | + Reason for transferring and blocking the loyalty card. + example: Current card lost. Customer needs a new card. + type: string identifier: description: | The alphanumeric identifier of the loyalty card. @@ -17343,6 +19014,10 @@ components: example: summer-loyalty-card-0543 maxLength: 108 type: string + batchId: + description: The ID of the batch in which the loyalty card was created. + example: wdefpov + type: string required: - created - id @@ -17926,6 +19601,7 @@ components: TransferLoyaltyCard: example: newCardIdentifier: summer-loyalty-card-0543 + blockReason: Current card lost. Customer needs a new card. properties: newCardIdentifier: description: | @@ -17933,18 +19609,29 @@ components: example: summer-loyalty-card-0543 maxLength: 108 type: string + blockReason: + description: | + Reason for transferring and blocking the loyalty card. + example: Current card lost. Customer needs a new card. + type: string required: - newCardIdentifier type: object UpdateLoyaltyCard: example: + blockReason: Current card lost. Customer needs a new card. status: active properties: status: description: | - Status of the loyalty card. Can be one of: ['active', 'inactive'] + Status of the loyalty card. Can be `active` or `inactive`. example: active type: string + blockReason: + description: | + Reason for transferring and blocking the loyalty card. + example: Current card lost. Customer needs a new card. + type: string required: - status type: object @@ -18191,6 +19878,7 @@ components: campaignId: 3 name: FreeCoffee10Orders achievementId: 3 + description: 50% off for every 50th purchase in a year. progress: 10.0 completionDate: 2000-01-23T04:56:07.000+00:00 title: 50% off on 50th purchase. @@ -18201,6 +19889,7 @@ components: campaignId: 3 name: FreeCoffee10Orders achievementId: 3 + description: 50% off for every 50th purchase in a year. progress: 10.0 completionDate: 2000-01-23T04:56:07.000+00:00 title: 50% off on 50th purchase. @@ -18348,6 +20037,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -18371,8 +20061,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -18389,6 +20082,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -18412,8 +20106,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -18432,6 +20129,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -18447,6 +20145,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -18497,6 +20196,52 @@ components: $ref: '#/components/schemas/AchievementProgress' type: array type: object + LoyaltyCardBatch: + description: "" + example: + numberOfCards: 5000 + batchId: hwernpjz + status: active + properties: + numberOfCards: + description: Number of loyalty cards in the batch. + example: 5000 + type: integer + batchId: + description: ID of the loyalty card batch. + example: hwernpjz + maxLength: 20 + minLength: 4 + pattern: ^[A-Za-z0-9_-]*$ + type: string + status: + default: active + description: Status of the loyalty cards in the batch. + enum: + - active + - inactive + example: active + type: string + required: + - numberOfCards + type: object + LoyaltyCardBatchResponse: + example: + numberOfCardsGenerated: 5000 + batchId: hwernpjz + properties: + numberOfCardsGenerated: + description: Number of loyalty cards in the batch. + example: 5000 + type: integer + batchId: + description: ID of the loyalty card batch. + example: hwernpjz + type: string + required: + - batchId + - numberOfCardsGenerated + type: object NewCustomerSession: description: "" properties: @@ -18662,8 +20407,10 @@ components: description: | Any coupon codes entered. - **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) - for your campaign, ensure the session contains a coupon code by the time you close it. + **Important - for requests only**: + + - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. + - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely. example: - XMAS-20-2021 items: @@ -18675,8 +20422,10 @@ components: description: | Any referral code entered. - **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) - for your campaign, ensure the session contains a referral code by the time you close it. + **Important - for requests only**: + + - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. + - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely. example: NT2K54D9 maxLength: 100 title: Referral code entered in session @@ -19117,8 +20866,10 @@ components: description: | Any coupon codes entered. - **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) - for your campaign, ensure the session contains a coupon code by the time you close it. + **Important - for requests only**: + + - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. + - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely. example: - XMAS-20-2021 items: @@ -19130,8 +20881,10 @@ components: description: | Any referral code entered. - **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) - for your campaign, ensure the session contains a referral code by the time you close it. + **Important - for requests only**: + + - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. + - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely. example: NT2K54D9 maxLength: 100 title: Referral code entered in session @@ -19353,6 +21106,8 @@ components: Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. + + **Note:** Any previously defined attributes that you do not include in the array will be removed. example: image: 11.jpeg material: leather @@ -19378,6 +21133,191 @@ components: - sku type: object x-attributable: true + NewApplicationCIF: + properties: + name: + description: The name of the Application cart item filter used in API requests. + example: Filter items by product + type: string + description: + description: A short description of the Application cart item filter. + example: This filter allows filtering by shoes + type: string + activeExpressionId: + description: The ID of the expression that the Application cart item filter + uses. + example: 1 + type: integer + modifiedBy: + description: The ID of the user who last updated the Application cart item + filter. + example: 334 + type: integer + createdBy: + description: The ID of the user who created the Application cart item filter. + example: 216 + type: integer + modified: + description: Timestamp of the most recent update to the Application cart + item filter. + format: date-time + type: string + required: + - name + type: object + UpdateApplicationCIF: + properties: + description: + description: A short description of the Application cart item filter. + example: This filter allows filtering by shoes + type: string + activeExpressionId: + description: The ID of the expression that the Application cart item filter + uses. + example: 1 + type: integer + modifiedBy: + description: The ID of the user who last updated the Application cart item + filter. + example: 334 + type: integer + modified: + description: Timestamp of the most recent update to the Application cart + item filter. + format: date-time + type: string + type: object + ApplicationCIF: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + name: + description: The name of the Application cart item filter used in API requests. + example: Filter items by product + type: string + description: + description: A short description of the Application cart item filter. + example: This filter allows filtering by shoes + type: string + activeExpressionId: + description: The ID of the expression that the Application cart item filter + uses. + example: 1 + type: integer + modifiedBy: + description: The ID of the user who last updated the Application cart item + filter. + example: 334 + type: integer + createdBy: + description: The ID of the user who created the Application cart item filter. + example: 216 + type: integer + modified: + description: Timestamp of the most recent update to the Application cart + item filter. + format: date-time + type: string + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + required: + - applicationId + - created + - id + - name + type: object + NewApplicationCIFExpression: + properties: + cartItemFilterId: + description: The ID of the Application cart item filter. + example: 216 + type: integer + createdBy: + description: The ID of the user who created the Application cart item filter. + example: 216 + type: integer + expression: + description: Arbitrary additional JSON data associated with the Application + cart item filter. + example: + expr: + - filter + - - "." + - Session + - CartItems + - - - Item + - - catch + - false + - - = + - - "." + - Item + - Category + - Kitchen + items: + properties: {} + type: object + type: array + type: object + ApplicationCIFExpression: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + cartItemFilterId: + description: The ID of the Application cart item filter. + example: 216 + type: integer + createdBy: + description: The ID of the user who created the Application cart item filter. + example: 216 + type: integer + expression: + description: Arbitrary additional JSON data associated with the Application + cart item filter. + example: + expr: + - filter + - - "." + - Session + - CartItems + - - - Item + - - catch + - false + - - = + - - "." + - Item + - Category + - Kitchen + items: + properties: {} + type: object + type: array + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + required: + - applicationId + - created + - id + type: object AdditionalCost: properties: price: @@ -19577,7 +21517,6 @@ components: - created - effects - id - - ledgerEntries - type type: object IntegrationState: @@ -19640,6 +21579,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -19663,8 +21603,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -19681,6 +21624,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -19704,8 +21648,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -19724,6 +21671,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -19739,6 +21687,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -19862,22 +21811,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 referral: code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -19903,11 +21860,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -19950,6 +21911,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -19967,9 +21929,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -20044,11 +22008,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -20091,6 +22059,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -20108,9 +22077,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -20399,26 +22370,30 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName return: returnedCartItems: - quantity: 1 @@ -20494,22 +22469,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 triggeredCampaigns: - callApiEffectCount: 0 createdLoyaltyPointsEffectCount: 2 @@ -20517,11 +22500,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -20564,6 +22551,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -20581,9 +22569,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -20658,11 +22648,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -20705,6 +22699,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -20722,9 +22717,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -20830,6 +22827,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -20853,8 +22851,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -20871,6 +22872,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -20894,8 +22896,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -20914,6 +22919,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -20929,6 +22935,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -21071,26 +23078,30 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName createdReferrals: - code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -21165,22 +23176,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 triggeredCampaigns: - callApiEffectCount: 0 createdLoyaltyPointsEffectCount: 2 @@ -21188,11 +23207,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -21235,6 +23258,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -21252,9 +23276,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -21329,11 +23355,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -21376,6 +23406,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -21393,9 +23424,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -21501,6 +23534,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -21524,8 +23558,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -21542,6 +23579,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -21565,8 +23603,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -21585,6 +23626,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 joinDate: 2000-01-23T04:56:07.000+00:00 subLedgers: key: @@ -21600,6 +23642,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 name: program1 id: 5 title: My loyalty program @@ -21742,26 +23785,30 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName createdReferrals: - code: 27G47Y54VH9L created: 2020-06-10T09:05:27.993483Z @@ -21836,22 +23883,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 properties: effects: description: The effects generated by the rules in your running campaigns. @@ -21899,22 +23954,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 customerSession: couponCodes: - XMAS-20-2021 @@ -22424,22 +24487,30 @@ components: effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 storeIntegrationId: STORE-001 created: 2020-06-10T09:05:27.993483Z profileId: 138 @@ -22454,26 +24525,30 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName properties: id: description: Internal ID of this entity. @@ -23081,6 +25156,11 @@ components: items: $ref: '#/components/schemas/Collection' type: array + applicationCartItemFilters: + description: The cart item filters belonging to the Application. + items: + $ref: '#/components/schemas/ApplicationCIF' + type: array required: - applicationId - created @@ -24053,11 +26133,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -24100,6 +26184,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -24117,9 +26202,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -24340,7 +26427,6 @@ components: object with keys corresponding to the `name` of the custom attributes for that type. enum: - - Account - Application - Campaign - CustomerProfile @@ -24508,7 +26594,6 @@ components: object with keys corresponding to the `name` of the custom attributes for that type. enum: - - Account - Application - Campaign - CustomerProfile @@ -24834,6 +26919,10 @@ components: example: Send message pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string + description: + description: A description of the webhook. + example: A webhook to send a coupon to the user. + type: string verb: description: API method for this webhook. enum: @@ -24891,6 +26980,7 @@ components: created: 2020-06-10T09:05:27.993483Z verb: POST modified: 2021-09-12T10:12:42Z + description: A webhook to send a coupon to the user. id: 6 title: Send message params: [] @@ -24927,6 +27017,10 @@ components: example: Send message pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string + description: + description: A description of the webhook. + example: A webhook to send a coupon to the user. + type: string verb: description: API method for this webhook. enum: @@ -24986,6 +27080,7 @@ components: created: 2020-06-10T09:05:27.993483Z outgoingIntegrationTemplateId: 1 verb: POST + description: A webhook to send a coupon to the user. title: Send message params: [] url: www.my-company.com/my-endpoint-name @@ -25026,6 +27121,10 @@ components: example: Send message pattern: ^[A-Za-z][A-Za-z0-9_.!~*'() -]*$ type: string + description: + description: A description of the webhook. + example: A webhook to send a coupon to the user. + type: string verb: description: API method for this webhook. enum: @@ -26970,6 +29069,11 @@ components: It is not possible to change this to `false` after it is set to `true`. example: true type: boolean + newAcsUrl: + description: | + Assertion Consumer Service (ACS) URL for setting up a new SAML connection with an identity provider like Okta or Microsoft Entra ID. + example: https://yourdeployment.talon.one/v1/saml_connections/5/saml_callback + type: string required: - enforced type: object @@ -26978,13 +29082,17 @@ components: example: rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 properties: campaignId: description: The ID of the campaign that triggered this effect. @@ -27022,6 +29130,26 @@ components: description: The index of the condition that was triggered. example: 786 type: integer + evaluationGroupID: + description: The ID of the evaluation group. For more information, see [Managing + campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + example: 3 + type: integer + evaluationGroupMode: + description: The evaluation mode of the evaluation group. For more information, + see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + example: stackable + type: string + campaignRevisionId: + description: The revision ID of the campaign that was used when triggering + the effect. + example: 1 + type: integer + campaignRevisionVersionId: + description: The revision version ID of the campaign that was used when + triggering the effect. + example: 5 + type: integer props: description: The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). type: object @@ -27073,6 +29201,26 @@ components: description: The index of the condition that was triggered. example: 786 type: integer + evaluationGroupID: + description: The ID of the evaluation group. For more information, see [Managing + campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + example: 3 + type: integer + evaluationGroupMode: + description: The evaluation mode of the evaluation group. For more information, + see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + example: stackable + type: string + campaignRevisionId: + description: The revision ID of the campaign that was used when triggering + the effect. + example: 1 + type: integer + campaignRevisionVersionId: + description: The revision version ID of the campaign that was used when + triggering the effect. + example: 5 + type: integer required: - campaignId - effectType @@ -27141,6 +29289,10 @@ components: details: description: More details about the failure. type: string + campaignExclusionReason: + description: The reason why the campaign was not applied. + example: CampaignGaveLowerDiscount + type: string required: - rejectionReason - value @@ -27166,6 +29318,10 @@ components: details: description: More details about the failure. type: string + campaignExclusionReason: + description: The reason why the campaign was not applied. + example: CampaignGaveLowerDiscount + type: string required: - rejectionReason - value @@ -27872,8 +30028,7 @@ components: description: The current progress of the customer in the achievement. type: number target: - description: The required number of actions or the transactional milestone - to complete the achievement. + description: The target value to complete the achievement. type: number isJustCompleted: description: Indicates if the customer has completed the achievement in @@ -27887,6 +30042,41 @@ components: - target - value type: object + RollbackIncreasedAchievementProgressEffectProps: + description: The properties specific to the "rollbackIncreasedAchievementProgress" + effect. This gets triggered whenever a closed session where the `increaseAchievementProgress` + effect was triggered is cancelled. This is applicable only when the customer + has not completed the achievement. + properties: + achievementId: + description: The internal ID of the achievement. + example: 10 + type: integer + achievementName: + description: The name of the achievement. + example: FreeCoffee10Orders + type: string + progressTrackerId: + description: The internal ID of the achievement progress tracker. + type: integer + decreaseProgressBy: + description: The value by which the customer's current progress in the achievement + is decreased. + type: number + currentProgress: + description: The current progress of the customer in the achievement. + type: number + target: + description: The target value to complete the achievement. + type: number + required: + - achievementId + - achievementName + - currentProgress + - decreaseProgressBy + - progressTrackerId + - target + type: object ErrorEffectProps: description: Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder. @@ -28331,9 +30521,6 @@ components: ApplicationCampaignStats: description: Provides statistics regarding an application's campaigns. properties: - draft: - description: Number of draft campaigns. - type: integer disabled: description: Number of disabled campaigns. type: integer @@ -28352,7 +30539,6 @@ components: required: - archived - disabled - - draft - expired - running - scheduled @@ -28364,14 +30550,16 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName properties: campaignID: description: The ID of the campaign that contains the rule that failed. @@ -28414,6 +30602,16 @@ components: details: description: More details about the failure. type: string + evaluationGroupID: + description: The ID of the evaluation group. For more information, see [Managing + campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + example: 3 + type: integer + evaluationGroupMode: + description: The evaluation mode of the evaluation group. For more information, + see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign- + example: stackable + type: string required: - campaignID - campaignName @@ -29304,7 +31502,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -29378,7 +31576,7 @@ components: type: string expiryDate: description: Expiration date of the coupon. Coupon never expires if this - is omitted, zero, or negative. + is omitted. example: 2023-08-24T14:15:22Z format: date-time type: string @@ -29482,6 +31680,230 @@ components: required: - batchId type: object + NewCouponDeletionJob: + example: + filters: + startsAfter: 2000-01-23T04:56:07.000+00:00 + recipientIntegrationId: recipientIntegrationId + exactMatch: false + redeemed: true + referralId: 0 + createdAfter: 2000-01-23T04:56:07.000+00:00 + batchId: batchId + valid: expired + usable: true + expiresAfter: 2000-01-23T04:56:07.000+00:00 + expiresBefore: 2000-01-23T04:56:07.000+00:00 + createdBefore: 2000-01-23T04:56:07.000+00:00 + value: "false" + startsBefore: 2000-01-23T04:56:07.000+00:00 + properties: + filters: + $ref: '#/components/schemas/CouponDeletionFilters' + required: + - filters + type: object + NewAppWideCouponDeletionJob: + properties: + filters: + $ref: '#/components/schemas/CouponDeletionFilters' + campaignids: + items: + type: integer + type: array + required: + - campaignids + - filters + type: object + CouponDeletionFilters: + example: + startsAfter: 2000-01-23T04:56:07.000+00:00 + recipientIntegrationId: recipientIntegrationId + exactMatch: false + redeemed: true + referralId: 0 + createdAfter: 2000-01-23T04:56:07.000+00:00 + batchId: batchId + valid: expired + usable: true + expiresAfter: 2000-01-23T04:56:07.000+00:00 + expiresBefore: 2000-01-23T04:56:07.000+00:00 + createdBefore: 2000-01-23T04:56:07.000+00:00 + value: "false" + startsBefore: 2000-01-23T04:56:07.000+00:00 + properties: + createdBefore: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + createdAfter: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + startsAfter: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + startsBefore: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + valid: + description: | + - `expired`: Matches coupons in which the expiration date is set and in the past. + - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. + - `validFuture`: Matches coupons in which the start date is set and in the future. + enum: + - expired + - validNow + - validFuture + type: string + usable: + description: | + - `true`: only coupons where `usageCounter < usageLimit` will be returned. + - `false`: only coupons where `usageCounter >= usageLimit` will be returned. + - This field cannot be used in conjunction with the `usable` query parameter. + type: boolean + redeemed: + description: | + - `true`: only coupons where `usageCounter > 0` will be returned. + - `false`: only coupons where `usageCounter = 0` will be returned. + + **Note:** This field cannot be used in conjunction with the `usable` query parameter. + type: boolean + recipientIntegrationId: + description: | + Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + type: string + exactMatch: + default: false + description: Filter results to an exact case-insensitive matching against + the coupon code + type: boolean + value: + default: "false" + description: Filter results by the coupon code + type: string + batchId: + description: Filter results by batches of coupons + type: string + referralId: + description: Filter the results by matching them with the ID of a referral. + This filter shows the coupons created by redeeming a referral code. + type: integer + expiresAfter: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + expiresBefore: + description: Filter results comparing the parameter value, expected to be + an RFC3339 timestamp string, to the coupon creation timestamp. You can + use any time zone setting. Talon.One will convert to UTC internally. + format: date-time + type: string + type: object + CouponDeletionJob: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + applicationId: + description: The ID of the application that owns this entity. + example: 322 + type: integer + accountId: + description: The ID of the account that owns this entity. + example: 3886 + type: integer + filters: + $ref: '#/components/schemas/CouponDeletionFilters' + status: + description: | + The current status of this request. Possible values: + - `not_ready` + - `pending` + - `completed` + - `failed` + example: pending + title: Job Status + type: string + deletedAmount: + description: The number of coupon codes that were already deleted for this + request. + example: 1000000 + title: Deleted Amount + type: integer + failCount: + description: The number of times this job failed. + example: 10 + title: Fail Count + type: integer + errors: + description: An array of individual problems encountered during the request. + example: + - Connection to database was reset + - failed to delete codes + items: + type: string + title: Errors + type: array + createdBy: + description: ID of the user who created this effect. + example: 1 + title: Created By + type: integer + communicated: + description: Indicates whether the user that created this job was notified + of its final state. + example: false + type: boolean + campaignIDs: + items: + title: Campaign ID + type: integer + type: array + required: + - accountId + - applicationId + - communicated + - created + - createdBy + - errors + - failCount + - filters + - id + - status + type: object + AsyncCouponDeletionJobResponse: + description: "" + example: + id: 6 + properties: + id: + description: 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. + example: 6 + type: integer + required: + - id + type: object LimitCounter: description: "" properties: @@ -29609,12 +32031,12 @@ components: $ref: '#/components/schemas/Campaign' oldState: description: | - The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] example: disabled type: string newState: description: | - The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] example: running type: string ruleset: @@ -29698,6 +32120,19 @@ components: - campaign - deletedAt type: object + CampaignCollectionEditedNotification: + description: A notification regarding a collection that was edited. + properties: + campaign: + $ref: '#/components/schemas/Campaign' + ruleset: + $ref: '#/components/schemas/Ruleset' + collection: + $ref: '#/components/schemas/CollectionWithoutPayload' + required: + - campaign + - collection + type: object CampaignEvaluationTreeChangedNotification: description: Notification about an Application whose campaign evaluation tree changed. @@ -29908,6 +32343,7 @@ components: policy: '{}' properties: policy: + description: Indicates which notification properties to apply. type: object enabled: default: true @@ -29922,6 +32358,7 @@ components: BaseNotificationEntity: properties: policy: + description: Indicates which notification properties to apply. type: object enabled: default: true @@ -29931,6 +32368,7 @@ components: - policy type: object BaseNotificationPolicy: + description: Indicates which notification properties to apply. type: object ExpiringCouponsNotificationPolicy: properties: @@ -30020,6 +32458,28 @@ components: - name - scopes type: object + CardAddedDeductedPointsNotificationPolicy: + properties: + name: + description: Notification name. + example: Christmas Sale + minLength: 1 + type: string + scopes: + items: + enum: + - all + - campaign_manager + - management_api + - rule_engine + type: string + maxItems: 4 + minItems: 1 + type: array + required: + - name + - scopes + type: object CouponsNotificationPolicy: properties: name: @@ -30109,6 +32569,11 @@ components: example: Christmas Sale minLength: 1 type: string + batchingEnabled: + default: true + description: Indicates whether batching is activated. + example: false + type: boolean required: - name type: object @@ -30227,6 +32692,7 @@ components: policy: '{}' properties: policy: + description: Indicates which notification properties to apply. type: object enabled: default: true @@ -30244,6 +32710,7 @@ components: enum: - campaign - loyalty_added_deducted_points + - card_added_deducted_points - coupon - expiring_coupons - expiring_points @@ -30355,6 +32822,7 @@ components: enum: - campaign - loyalty_added_deducted_points + - card_added_deducted_points - coupon - expiring_coupons - expiring_points @@ -30711,6 +33179,10 @@ components: description: Webhook title. example: Send email to customer via Braze type: string + description: + description: A description of the webhook. + example: A webhook to send a coupon to the user. + type: string applicationIds: description: IDs of the Applications to which a webhook must be linked. example: @@ -31653,6 +34125,37 @@ components: - name - updated type: object + CampaignStoreBudget: + description: "" + properties: + id: + description: Internal ID of this entity. + example: 6 + type: integer + created: + description: The time this entity was created. + example: 2020-06-10T09:05:27.993483Z + format: date-time + type: string + campaignId: + description: The ID of the campaign that owns this entity. + example: 322 + type: integer + storeId: + description: The ID of the store. + type: integer + limits: + description: The set of budget limits for stores linked to the campaign. + items: + $ref: '#/components/schemas/LimitConfig' + type: array + required: + - campaignId + - created + - id + - limits + - storeId + type: object BulkOperationOnCampaigns: properties: operation: @@ -31942,6 +34445,7 @@ components: campaignId: 3 name: FreeCoffee10Orders achievementId: 3 + description: 50% off for every 50th purchase in a year. progress: 10.0 completionDate: 2000-01-23T04:56:07.000+00:00 title: 50% off on 50th purchase. @@ -31965,6 +34469,11 @@ components: description: The display name of the achievement in the Campaign Manager. example: 50% off on 50th purchase. type: string + description: + description: The description of the achievement in the Campaign Manager. + example: 50% off for every 50th purchase in a year. + format: string + type: string campaignId: description: The ID of the campaign the achievement belongs to. example: 3 @@ -32002,6 +34511,7 @@ components: required: - achievementId - campaignId + - description - endDate - name - progress @@ -32021,13 +34531,13 @@ components: format: date-time type: string totalRevenue: - $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_totalRevenue' + $ref: '#/components/schemas/AnalyticsDataPoint' sessionsCount: - $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_sessionsCount' + $ref: '#/components/schemas/AnalyticsDataPoint' avgItemsPerSession: - $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_avgItemsPerSession' + $ref: '#/components/schemas/AnalyticsDataPoint' avgSessionValue: - $ref: '#/components/schemas/ApplicationAnalyticsDataPoint_avgSessionValue' + $ref: '#/components/schemas/AnalyticsDataPoint' totalDiscounts: description: The total value of discounts given for cart items in influenced sessions. @@ -32038,6 +34548,9 @@ components: sessions. example: 12.0 type: number + required: + - endTime + - startTime type: object ApplicationCampaignAnalytics: properties: @@ -32069,45 +34582,150 @@ components: maxItems: 50 type: array campaignState: - default: enabled description: | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. enum: - - enabled + - expired + - scheduled + - running - disabled - archived - example: enabled - type: string - campaignActiveRulesetId: - description: | - The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this - campaign applies on customer session evaluation. - example: 2 - type: integer - campaignStartTime: - description: Date and time when the campaign becomes active. - example: 2021-07-20T22:00:00Z - format: date-time - type: string - campaignEndTime: - description: Date and time when the campaign becomes inactive. - example: 2021-10-01T02:00:00Z - format: date-time + example: running type: string totalRevenue: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_totalRevenue' + $ref: '#/components/schemas/AnalyticsDataPointWithTrendAndInfluencedRate' sessionsCount: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_sessionsCount' + $ref: '#/components/schemas/AnalyticsDataPointWithTrendAndInfluencedRate' avgItemsPerSession: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_avgItemsPerSession' + $ref: '#/components/schemas/AnalyticsDataPointWithTrendAndUplift' avgSessionValue: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_avgSessionValue' + $ref: '#/components/schemas/AnalyticsDataPointWithTrendAndUplift' totalDiscounts: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_totalDiscounts' + $ref: '#/components/schemas/AnalyticsDataPointWithTrend' couponsCount: - $ref: '#/components/schemas/ApplicationCampaignAnalytics_couponsCount' + $ref: '#/components/schemas/AnalyticsDataPointWithTrend' + required: + - campaignId + - campaignName + - campaignState + - campaignTags + - endTime + - startTime + type: object + AnalyticsDataPoint: + properties: + total: + example: 12.0 + type: number + influenced: + example: 12.0 + type: number + required: + - influenced + - total + type: object + AnalyticsDataPointWithTrendAndInfluencedRate: + properties: + value: + example: 12.0 + type: number + influencedRate: + example: 12.0 + type: number + trend: + example: 3.25 + type: number + required: + - influencedRate + - trend + - value + type: object + AnalyticsDataPointWithTrend: + properties: + value: + example: 12.0 + type: number + trend: + example: 3.25 + type: number + required: + - trend + - value + type: object + AnalyticsDataPointWithTrendAndUplift: + properties: + value: + example: 12.0 + type: number + uplift: + example: 3.25 + type: number + trend: + example: 3.25 + type: number + required: + - trend + - uplift + - value + type: object + GenerateCampaignDescription: + properties: + campaignID: + description: ID of the campaign. + type: integer + currency: + description: Currency for the campaign. + type: string + required: + - campaignID + - currency + type: object + GenerateCampaignTags: + properties: + campaignID: + description: ID of the campaign. + type: integer + required: + - campaignID + type: object + GenerateRuleTitle: + properties: + rule: + $ref: '#/components/schemas/GenerateRuleTitle_rule' + currency: + description: Currency for the campaign. + type: string + required: + - currency + - rule + type: object + GenerateItemFilterDescription: + properties: + itemFilter: + description: An array of item filter Talang expressions. + example: + - filter + - - "." + - Session + - CartItems + - - - Item + - - catch + - false + - - and + - - '!=' + - - "." + - Item + - Attributes + - c_productType + - egiftcard + items: + properties: {} + type: object + type: array + required: + - itemFilter type: object inline_response_201: example: @@ -32363,6 +34981,8 @@ components: - enableFlattenedCartItems: true created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false sandbox: true description: A test Application attributesSettings: @@ -32379,7 +34999,6 @@ components: enableCascadingDiscounts: true loyaltyPrograms: - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -32398,27 +35017,69 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -32437,25 +35098,68 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 name: My Application modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal @@ -32478,6 +35182,8 @@ components: - enableFlattenedCartItems: true created: 2020-06-10T09:05:27.993483Z timezone: Europe/Berlin + defaultCartItemFilterId: 3 + enableCampaignStateManagement: false sandbox: true description: A test Application attributesSettings: @@ -32494,7 +35200,6 @@ components: enableCascadingDiscounts: true loyaltyPrograms: - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -32513,27 +35218,69 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 - cardBased: true - canUpgradeToAdvancedTiers: true tiers: - name: Gold minPoints: 300 @@ -32552,25 +35299,68 @@ components: programId: 139 canUpdateTiers: true usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z + tierCycleStartDate: 2021-09-12T10:12:42Z timezone: Europe/Berlin - sandbox: true description: Customers collect 10 points per 1$ spent title: Point collection canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 name: My Application modified: 2021-09-12T10:12:42Z defaultDiscountScope: sessionTotal @@ -32611,11 +35401,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -32658,6 +35452,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -32675,9 +35470,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -32752,11 +35549,15 @@ components: description: Campaign for all summer 2021 promotions type: advanced templateId: 3 + activeRevisionVersionId: 6 customEffectCount: 0 + activeRevisionId: 6 features: - coupons - referrals + currentRevisionVersionId: 6 createdLoyaltyPointsCount: 9.0 + storesImported: true couponSettings: couponPattern: SUMMER-####-#### validCharacters: @@ -32799,6 +35600,7 @@ components: startTime: 2021-07-20T22:00:00Z id: 4 state: enabled + currentRevisionId: 6 limits: - period: yearly entities: @@ -32816,9 +35618,11 @@ components: frontendState: running created: 2020-06-10T09:05:27.993483Z referralCreationCount: 8 + stageRevision: false couponRedemptionCount: 163 userId: 388 couponCreationCount: 16 + version: 6 campaignGroups: - 1 - 3 @@ -33681,123 +36485,207 @@ components: - "7" - "8" - "9" - templateParams: - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - - attributeId: 42 - name: discount_value - description: This is a template parameter of type `number`. - type: number - id: 6 - couponAttributes: '{}' - state: draft - updated: 2022-08-24T14:15:22Z - limits: - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - - period: yearly - entities: - - Coupon - limit: 1000.0 - action: createCoupon - hasMore: true - properties: - hasMore: - example: true - type: boolean - data: - items: - $ref: '#/components/schemas/CampaignTemplate' - type: array - required: - - data - - hasMore - inline_response_200_13: - example: - data: - - cardBased: true - canUpgradeToAdvancedTiers: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programId: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programId: 139 - canUpdateTiers: true - usersPerCardLimit: 111 - created: 2020-06-10T09:05:27.993483Z - timezone: Europe/Berlin - sandbox: true - description: Customers collect 10 points per 1$ spent - title: Point collection - canUpdateJoinPolicy: true - subscribedApplications: - - 132 - - 97 - tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 - defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down - allowSubledger: false - tiersExpireIn: 27W_U - name: my_program + templateParams: + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + - attributeId: 42 + name: discount_value + description: This is a template parameter of type `number`. + type: number + id: 6 + couponAttributes: '{}' + state: draft + updated: 2022-08-24T14:15:22Z + limits: + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + - period: yearly + entities: + - Coupon + limit: 1000.0 + action: createCoupon + hasMore: true + properties: + hasMore: + example: true + type: boolean + data: + items: + $ref: '#/components/schemas/CampaignTemplate' + type: array + required: + - data + - hasMore + inline_response_200_13: + example: + data: + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + canUpdateTiers: true + usersPerCardLimit: 111 + tierCycleStartDate: 2021-09-12T10:12:42Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection + canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + id: 0 + canUpgradeToAdvancedTiers: true + created: 2020-06-10T09:05:27.993483Z + sandbox: true + subscribedApplications: + - 132 + - 97 + tiersExpirationPolicy: tier_start_date + defaultValidity: 2W_U + canUpdateTierExpirationPolicy: true + allowSubledger: false + tiersExpireIn: 27W_U + name: my_program + - cardBased: true + tiers: + - name: Gold + minPoints: 300 + id: 3 + created: 2021-06-10T09:05:27.993483Z + programID: 139 + - name: Silver + minPoints: 200 + id: 2 + created: 2021-06-10T09:04:59.355258Z + programId: 139 + - name: Bronze + minPoints: 100 + id: 1 + created: 2021-06-10T09:04:39.355258Z + programId: 139 + canUpdateTiers: true + usersPerCardLimit: 111 + tierCycleStartDate: 2021-09-12T10:12:42Z + timezone: Europe/Berlin + description: Customers collect 10 points per 1$ spent + title: Point collection + canUpdateJoinPolicy: true + canUpdateSubledgers: true + programJoinPolicy: not_join + accountID: 1 + defaultPending: immediate + tiersDowngradePolicy: one_down + cardCodeSettings: + couponPattern: SUMMER-####-#### + validCharacters: + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + - L + - M + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - X + - "Y" + - Z + - "0" + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" id: 0 - - cardBased: true canUpgradeToAdvancedTiers: true - tiers: - - name: Gold - minPoints: 300 - id: 3 - created: 2021-06-10T09:05:27.993483Z - programID: 139 - - name: Silver - minPoints: 200 - id: 2 - created: 2021-06-10T09:04:59.355258Z - programId: 139 - - name: Bronze - minPoints: 100 - id: 1 - created: 2021-06-10T09:04:39.355258Z - programId: 139 - canUpdateTiers: true - usersPerCardLimit: 111 created: 2020-06-10T09:05:27.993483Z - timezone: Europe/Berlin sandbox: true - description: Customers collect 10 points per 1$ spent - title: Point collection - canUpdateJoinPolicy: true subscribedApplications: - 132 - 97 tiersExpirationPolicy: tier_start_date - programJoinPolicy: not_join - accountID: 1 defaultValidity: 2W_U - defaultPending: immediate - tiersDowngradePolicy: one_down + canUpdateTierExpirationPolicy: true allowSubledger: false tiersExpireIn: 27W_U name: my_program - id: 0 totalResultSize: 1 properties: totalResultSize: @@ -33877,6 +36765,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -33900,8 +36789,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -33918,6 +36810,7 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 identifier: summer-loyalty-card-0543 oldCardIdentifier: summer-loyalty-card-0543 usersPerCardLimit: 111 @@ -33941,8 +36834,11 @@ components: downgradePolicy: one_down name: bronze id: 11 + startDate: 2000-01-23T04:56:07.000+00:00 + batchId: wdefpov modified: 2021-09-12T10:12:42Z id: 6 + blockReason: Current card lost. Customer needs a new card. newCardIdentifier: summer-loyalty-card-0543 programID: 125 status: active @@ -34618,22 +37514,30 @@ components: - effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 storeIntegrationId: STORE-001 created: 2020-06-10T09:05:27.993483Z profileId: 138 @@ -34648,45 +37552,57 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - effects: - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 - rulesetId: 73 ruleIndex: 2 - triggeredForCatalogItem: 786 + campaignRevisionVersionId: 5 campaignId: 244 - ruleName: Give 20% discount conditionIndex: 786 - triggeredByCoupon: 4928 + evaluationGroupMode: stackable effectType: rejectCoupon props: '{}' + evaluationGroupID: 3 + triggeredForCatalogItem: 786 + campaignRevisionId: 1 + ruleName: Give 20% discount + triggeredByCoupon: 4928 storeIntegrationId: STORE-001 created: 2020-06-10T09:05:27.993483Z profileId: 138 @@ -34701,26 +37617,30 @@ components: ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName - rulesetID: 2 ruleIndex: 9 campaignID: 5 referralID: 7 - ruleName: ruleName conditionIndex: 3 effectIndex: 2 - details: details + evaluationGroupMode: stackable couponID: 4928 referralValue: referralValue - campaignName: campaignName couponValue: couponValue + evaluationGroupID: 3 + ruleName: ruleName + details: details + campaignName: campaignName hasMore: true properties: hasMore: @@ -35051,6 +37971,7 @@ components: created: 2020-06-10T09:05:27.993483Z outgoingIntegrationTemplateId: 1 verb: POST + description: A webhook to send a coupon to the user. title: Send message params: [] url: www.my-company.com/my-endpoint-name @@ -35069,6 +37990,7 @@ components: created: 2020-06-10T09:05:27.993483Z outgoingIntegrationTemplateId: 1 verb: POST + description: A webhook to send a coupon to the user. title: Send message params: [] url: www.my-company.com/my-endpoint-name @@ -35205,6 +38127,7 @@ components: email: john.doe@example.com policy: Role: 127 + additionalAttributes: '{}' - created: 2020-06-10T09:05:27.993483Z roles: - 71 @@ -35223,6 +38146,7 @@ components: email: john.doe@example.com policy: Role: 127 + additionalAttributes: '{}' totalResultSize: 1 properties: totalResultSize: @@ -35519,6 +38443,7 @@ components: campaignId: 3 name: FreeCoffee10Orders achievementId: 3 + description: 50% off for every 50th purchase in a year. progress: 10.0 completionDate: 2000-01-23T04:56:07.000+00:00 title: 50% off on 50th purchase. @@ -35529,6 +38454,7 @@ components: campaignId: 3 name: FreeCoffee10Orders achievementId: 3 + description: 50% off for every 50th purchase in a year. progress: 10.0 completionDate: 2000-01-23T04:56:07.000+00:00 title: 50% off on 50th purchase. @@ -35547,120 +38473,90 @@ components: required: - data - hasMore - ApplicationAnalyticsDataPoint_totalRevenue: - description: The total, pre-discount value of all items purchased in a customer - session. - properties: - total: - example: 1.25 - type: number - influenced: - example: 3.25 - type: number - ApplicationAnalyticsDataPoint_sessionsCount: - description: The number of all closed sessions. The `influenced` value includes - only sessions with at least one applied effect. - properties: - total: - example: 15.0 - type: number - influenced: - example: 5.0 - type: number - ApplicationAnalyticsDataPoint_avgItemsPerSession: - description: 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: - total: - example: 1.25 - type: number - influenced: - example: 3.25 - type: number - ApplicationAnalyticsDataPoint_avgSessionValue: - description: 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: - total: - example: 1.25 - type: number - influenced: - example: 3.25 - type: number - ApplicationCampaignAnalytics_totalRevenue: - description: The total, pre-discount value of all items purchased in a customer - session. + ScimBaseUser_name: + description: The components of the user’s real name. + example: + formatted: Mr. John J Doe properties: - value: - example: 1.25 - type: number - influence_rate: - example: 3.25 - type: number - trend: - example: 3.25 - type: number - ApplicationCampaignAnalytics_sessionsCount: - description: The number of all closed sessions. The `influenced` value includes - only sessions with at least one applied effect. + formatted: + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + example: Mr. John J Doe + type: string + ScimServiceProviderConfigResponse_bulk: + description: Configuration related to bulk operations, which allow multiple + SCIM requests to be processed in a single HTTP request. properties: - value: - example: 12.0 - type: number - influence_rate: - example: 3.25 - type: number - trend: - example: 3.25 - type: number - ApplicationCampaignAnalytics_avgItemsPerSession: - description: The number of items from sessions divided by the number of sessions. - The `influenced` value includes only sessions with at least one applied effect. + maxOperations: + description: The maximum number of individual operations that can be included + in a single bulk request. + type: integer + maxPayloadSize: + description: The maximum size, in bytes, of the entire payload for a bulk + operation request. + type: integer + supported: + description: Indicates whether the SCIM service provider supports bulk operations. + type: boolean + ScimServiceProviderConfigResponse_changePassword: + description: Configuration settings related to the ability to change user passwords. properties: - value: - example: 12.0 - type: number - uplift: - example: 3.25 - type: number - trend: - example: 3.25 - type: number - ApplicationCampaignAnalytics_avgSessionValue: - description: 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. + supported: + description: Indicates whether the service provider supports password changes + via the SCIM API. + type: boolean + ScimServiceProviderConfigResponse_filter: + description: Configuration settings related to filtering SCIM resources based + on specific criteria. properties: - value: - example: 12.0 - type: number - uplift: - example: 3.25 - type: number - trend: - example: 3.25 - type: number - ApplicationCampaignAnalytics_totalDiscounts: - description: The total value of discounts given for cart items in influenced - sessions. + maxResults: + description: The maximum number of resources that can be returned in a single + filtered query response. + type: integer + supported: + description: Indicates whether the SCIM service provider supports filtering + operations. + type: boolean + ScimServiceProviderConfigResponse_patch: + description: Configuration settings related to patch operations, which allow + partial updates to SCIM resources. properties: - value: - example: 10.0 - type: number - trend: - example: 3.25 - type: number - ApplicationCampaignAnalytics_couponsCount: - description: The number of times a coupon was successfully redeemed in influenced - sessions. + supported: + description: Indicates whether the service provider supports patch operations + for modifying resources. + type: boolean + GenerateRuleTitle_rule: properties: - value: - example: 10.0 - type: number - trend: - example: 3.25 - type: number + effects: + description: An array of effectful Talang expressions in arrays that will + be evaluated when a rule matches. + example: + - catch + - - noop + - - setDiscount + - 10% off + - - '*' + - - "." + - Session + - Total + - - / + - 10 + - 100 + items: + properties: {} + type: object + type: array + condition: + description: A Talang expression that will be evaluated in the context of + the given event. + example: + - and + - - couponValid + items: + properties: {} + type: object + minItems: 1 + type: array securitySchemes: api_key_v1: description: | From 7dc8f3e58e31684b1b85352baca406980a0670ee Mon Sep 17 00:00:00 2001 From: Vitalii Drevenchuk <4005032+Crandel@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:29:39 +0200 Subject: [PATCH 4/5] Generated models --- api_integration.go | 228 +- api_management.go | 3066 +++++++++++++++-- configuration.go | 2 +- go.mod | 2 +- model_achievement_progress.go | 17 + model_additional_campaign_properties.go | 17 + ..._calls.go => model_analytics_data_point.go | 37 +- model_analytics_data_point_with_trend.go | 74 + ...ta_point_with_trend_and_influenced_rate.go | 90 + ...lytics_data_point_with_trend_and_uplift.go | 90 + model_application.go | 70 + model_application_analytics_data_point.go | 116 +- ...lytics_data_point_avg_items_per_session.go | 110 - ..._analytics_data_point_avg_session_value.go | 110 - ...ion_analytics_data_point_sessions_count.go | 110 - ...tion_analytics_data_point_total_revenue.go | 110 - model_application_campaign_analytics.go | 373 +- ...ampaign_analytics_avg_items_per_session.go | 144 - ...on_campaign_analytics_avg_session_value.go | 144 - ...cation_campaign_analytics_coupons_count.go | 110 - ...ation_campaign_analytics_sessions_count.go | 144 - ...tion_campaign_analytics_total_discounts.go | 110 - ...cation_campaign_analytics_total_revenue.go | 144 - model_application_campaign_stats.go | 17 - model_application_cif.go | 286 ++ model_application_cif_expression.go | 199 ++ model_async_coupon_deletion_job_response.go | 59 + model_base_campaign_for_notification.go | 511 --- model_base_loyalty_program.go | 114 +- model_base_notification.go | 1 + model_base_notification_entity.go | 1 + model_binding.go | 8 +- model_campaign.go | 227 ++ ...campaign_collection_edited_notification.go | 108 + model_campaign_for_notification.go | 1260 ------- model_campaign_notification_policy.go | 35 + ...ampaign_priorities_changed_notification.go | 109 - model_campaign_priorities_v2.go | 144 - model_campaign_state_changed_notification.go | 4 +- model_campaign_state_notification.go | 1277 ------- ...et_v2.go => model_campaign_store_budget.go | 69 +- model_campaign_versions.go | 252 ++ ...ded_deducted_points_notification_policy.go | 48 +- model_cart_item.go | 2 +- model_code_generator_settings.go | 2 +- model_coupon.go | 2 +- model_coupon_constraints.go | 2 +- model_coupon_creation_job.go | 2 +- model_coupon_deletion_filters.go | 533 +++ model_coupon_deletion_job.go | 281 ++ model_customer_session_v2.go | 4 +- model_effect.go | 140 + model_effect_entity.go | 140 + model_environment.go | 35 + model_event.go | 40 +- model_feed_notification.go | 145 - model_generate_campaign_description.go | 76 + model_generate_campaign_tags.go | 59 + ... model_generate_item_filter_description.go | 31 +- model_generate_loyalty_card.go | 112 + ...osition.go => model_generate_rule_title.go | 47 +- model_generate_rule_title_rule.go | 112 + ...rease_achievement_progress_effect_props.go | 2 +- model_integration_coupon.go | 2 +- model_inventory_coupon.go | 2 +- model_inventory_referral.go | 2 +- model_loyalty_balance_with_tier.go | 320 ++ model_loyalty_balances_with_tiers.go | 111 + model_loyalty_card.go | 72 +- model_loyalty_card_batch.go | 129 + ...go => model_loyalty_card_batch_response.go | 46 +- model_loyalty_program.go | 185 +- model_loyalty_statistics.go | 194 -- model_message_log_response.go | 90 +- model_new_app_wide_coupon_deletion_job.go | 74 + model_new_application.go | 35 + model_new_application_cif.go | 235 ++ model_new_application_cif_expression.go | 147 + model_new_base_notification.go | 1 + model_new_coupon_creation_job.go | 2 +- model_new_coupon_deletion_job.go | 58 + model_new_coupons.go | 2 +- model_new_coupons_for_multiple_recipients.go | 2 +- model_new_customer_session_v2.go | 4 +- model_new_loyalty_program.go | 114 +- model_new_outgoing_integration_webhook.go | 35 + model_new_referral.go | 2 +- model_new_referrals_for_multiple_advocates.go | 2 +- model_new_revision_version.go | 425 +++ model_new_template_def.go | 8 +- model_new_webhook.go | 35 + model_notification_webhook.go | 180 - model_okta_event.go | 75 + ...nd_state.go => model_okta_event_payload.go | 38 +- model_okta_event_payload_data.go | 58 + ...gn_set_v2.go => model_okta_event_target.go | 65 +- ...l_outgoing_integration_webhook_template.go | 144 - ..._outgoing_integration_webhook_templates.go | 77 - model_projected_tier.go | 129 + model_referral.go | 2 +- model_referral_constraints.go | 2 +- model_reject_coupon_effect_props.go | 35 + model_reject_referral_effect_props.go | 35 + model_revision.go | 276 ++ ...et_i_ds.go => model_revision_activation.go | 48 +- model_revision_version.go | 555 +++ model_role_v2_permissions_roles.go | 144 - ...eased_achievement_progress_effect_props.go | 144 + model_rule.go | 16 +- model_rule_failure_reason.go | 70 + model_scim_base_user.go | 181 + model_scim_base_user_name.go | 77 + model_scim_new_user.go | 181 + model_scim_patch_operation.go | 129 + model_scim_patch_request.go | 93 + model_scim_resource.go | 147 + model_scim_resource_types_list_response.go | 58 + model_scim_schema_resource.go | 181 + model_scim_schemas_list_response.go | 128 + ...l_scim_service_provider_config_response.go | 248 ++ ...m_service_provider_config_response_bulk.go | 147 + ...rovider_config_response_change_password.go | 77 + ...service_provider_config_response_filter.go | 112 + ..._service_provider_config_response_patch.go | 77 + model_scim_user.go | 198 ++ model_scim_users_list_response.go | 128 + model_sso_config.go | 35 + model_template_def.go | 8 +- model_tier.go | 37 +- model_transfer_loyalty_card.go | 35 + model_update_application.go | 70 + model_update_application_cif.go | 183 + model_update_campaign.go | 2 +- model_update_coupon.go | 2 +- model_update_coupon_batch.go | 2 +- model_update_loyalty_card.go | 37 +- model_update_loyalty_program.go | 114 +- model_update_referral.go | 2 +- model_update_referral_batch.go | 2 +- model_user.go | 35 + model_webhook.go | 35 + ...bhook_with_outgoing_integration_details.go | 35 + 142 files changed, 12634 insertions(+), 6503 deletions(-) rename model_account_dashboard_statistic_api_calls.go => model_analytics_data_point.go (57%) create mode 100644 model_analytics_data_point_with_trend.go create mode 100644 model_analytics_data_point_with_trend_and_influenced_rate.go create mode 100644 model_analytics_data_point_with_trend_and_uplift.go delete mode 100644 model_application_analytics_data_point_avg_items_per_session.go delete mode 100644 model_application_analytics_data_point_avg_session_value.go delete mode 100644 model_application_analytics_data_point_sessions_count.go delete mode 100644 model_application_analytics_data_point_total_revenue.go delete mode 100644 model_application_campaign_analytics_avg_items_per_session.go delete mode 100644 model_application_campaign_analytics_avg_session_value.go delete mode 100644 model_application_campaign_analytics_coupons_count.go delete mode 100644 model_application_campaign_analytics_sessions_count.go delete mode 100644 model_application_campaign_analytics_total_discounts.go delete mode 100644 model_application_campaign_analytics_total_revenue.go create mode 100644 model_application_cif.go create mode 100644 model_application_cif_expression.go create mode 100644 model_async_coupon_deletion_job_response.go delete mode 100644 model_base_campaign_for_notification.go create mode 100644 model_campaign_collection_edited_notification.go delete mode 100644 model_campaign_for_notification.go delete mode 100644 model_campaign_priorities_changed_notification.go delete mode 100644 model_campaign_priorities_v2.go delete mode 100644 model_campaign_state_notification.go rename model_campaign_set_v2.go => model_campaign_store_budget.go (54%) create mode 100644 model_campaign_versions.go rename model_user_feed_notifications.go => model_card_added_deducted_points_notification_policy.go (52%) create mode 100644 model_coupon_deletion_filters.go create mode 100644 model_coupon_deletion_job.go delete mode 100644 model_feed_notification.go create mode 100644 model_generate_campaign_description.go create mode 100644 model_generate_campaign_tags.go rename model_update_user_latest_feed_timestamp.go => model_generate_item_filter_description.go (58%) create mode 100644 model_generate_loyalty_card.go rename model_priority_position.go => model_generate_rule_title.go (58%) create mode 100644 model_generate_rule_title_rule.go create mode 100644 model_loyalty_balance_with_tier.go create mode 100644 model_loyalty_balances_with_tiers.go create mode 100644 model_loyalty_card_batch.go rename model_loyalty_program_subledgers.go => model_loyalty_card_batch_response.go (53%) delete mode 100644 model_loyalty_statistics.go create mode 100644 model_new_app_wide_coupon_deletion_job.go create mode 100644 model_new_application_cif.go create mode 100644 model_new_application_cif_expression.go create mode 100644 model_new_coupon_deletion_job.go create mode 100644 model_new_revision_version.go delete mode 100644 model_notification_webhook.go create mode 100644 model_okta_event.go rename model_frontend_state.go => model_okta_event_payload.go (64%) create mode 100644 model_okta_event_payload_data.go rename model_new_campaign_set_v2.go => model_okta_event_target.go (50%) delete mode 100644 model_outgoing_integration_webhook_template.go delete mode 100644 model_outgoing_integration_webhook_templates.go create mode 100644 model_projected_tier.go create mode 100644 model_revision.go rename model_campaign_set_i_ds.go => model_revision_activation.go (54%) create mode 100644 model_revision_version.go delete mode 100644 model_role_v2_permissions_roles.go create mode 100644 model_rollback_increased_achievement_progress_effect_props.go create mode 100644 model_scim_base_user.go create mode 100644 model_scim_base_user_name.go create mode 100644 model_scim_new_user.go create mode 100644 model_scim_patch_operation.go create mode 100644 model_scim_patch_request.go create mode 100644 model_scim_resource.go create mode 100644 model_scim_resource_types_list_response.go create mode 100644 model_scim_schema_resource.go create mode 100644 model_scim_schemas_list_response.go create mode 100644 model_scim_service_provider_config_response.go create mode 100644 model_scim_service_provider_config_response_bulk.go create mode 100644 model_scim_service_provider_config_response_change_password.go create mode 100644 model_scim_service_provider_config_response_filter.go create mode 100644 model_scim_service_provider_config_response_patch.go create mode 100644 model_scim_user.go create mode 100644 model_scim_users_list_response.go create mode 100644 model_update_application_cif.go diff --git a/api_integration.go b/api_integration.go index 22629c1f..1d348440 100644 --- a/api_integration.go +++ b/api_integration.go @@ -1237,6 +1237,170 @@ func (r apiDeleteCustomerDataRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } +type apiGenerateLoyaltyCardRequest struct { + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + body *GenerateLoyaltyCard +} + +func (r apiGenerateLoyaltyCardRequest) Body(body GenerateLoyaltyCard) apiGenerateLoyaltyCardRequest { + r.body = &body + return r +} + +/* +GenerateLoyaltyCard Generate loyalty card +Generate a loyalty card in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview). + +To link the card to one or more customer profiles, use the `customerProfileIds` parameter in the request body. + +**Note:** +- The number of customer profiles linked to the loyalty card cannot exceed the loyalty program's `usersPerCardLimit`. To find the program's limit, use the [Get loyalty program](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyProgram) endpoint. +- If the loyalty program has a defined code format, it will be used for the loyalty card identifier. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + +@return apiGenerateLoyaltyCardRequest +*/ +func (a *IntegrationApiService) GenerateLoyaltyCard(ctx _context.Context, loyaltyProgramId int32) apiGenerateLoyaltyCardRequest { + return apiGenerateLoyaltyCardRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + } +} + +/* +Execute executes the request + + @return LoyaltyCard +*/ +func (r apiGenerateLoyaltyCardRequest) Execute() (LoyaltyCard, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyCard + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GenerateLoyaltyCard") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v LoyaltyCard + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiGetCustomerInventoryRequest struct { ctx _context.Context apiService *IntegrationApiService @@ -1592,12 +1756,14 @@ func (r apiGetCustomerSessionRequest) Execute() (IntegrationCustomerSessionRespo } type apiGetLoyaltyBalancesRequest struct { - ctx _context.Context - apiService *IntegrationApiService - loyaltyProgramId int32 - integrationId string - endDate *time.Time - subledgerId *string + ctx _context.Context + apiService *IntegrationApiService + loyaltyProgramId int32 + integrationId string + endDate *time.Time + subledgerId *string + includeTiers *bool + includeProjectedTier *bool } func (r apiGetLoyaltyBalancesRequest) EndDate(endDate time.Time) apiGetLoyaltyBalancesRequest { @@ -1610,6 +1776,16 @@ func (r apiGetLoyaltyBalancesRequest) SubledgerId(subledgerId string) apiGetLoya return r } +func (r apiGetLoyaltyBalancesRequest) IncludeTiers(includeTiers bool) apiGetLoyaltyBalancesRequest { + r.includeTiers = &includeTiers + return r +} + +func (r apiGetLoyaltyBalancesRequest) IncludeProjectedTier(includeProjectedTier bool) apiGetLoyaltyBalancesRequest { + r.includeProjectedTier = &includeProjectedTier + return r +} + /* GetLoyaltyBalances Get customer's loyalty points Retrieve loyalty ledger balances for the given Integration ID in the specified loyalty program. @@ -1641,16 +1817,16 @@ func (a *IntegrationApiService) GetLoyaltyBalances(ctx _context.Context, loyalty /* Execute executes the request - @return LoyaltyBalances + @return LoyaltyBalancesWithTiers */ -func (r apiGetLoyaltyBalancesRequest) Execute() (LoyaltyBalances, *_nethttp.Response, error) { +func (r apiGetLoyaltyBalancesRequest) Execute() (LoyaltyBalancesWithTiers, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue LoyaltyBalances + localVarReturnValue LoyaltyBalancesWithTiers ) localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "IntegrationApiService.GetLoyaltyBalances") @@ -1672,6 +1848,12 @@ func (r apiGetLoyaltyBalancesRequest) Execute() (LoyaltyBalances, *_nethttp.Resp if r.subledgerId != nil { localVarQueryParams.Add("subledgerId", parameterToString(*r.subledgerId, "")) } + if r.includeTiers != nil { + localVarQueryParams.Add("includeTiers", parameterToString(*r.includeTiers, "")) + } + if r.includeProjectedTier != nil { + localVarQueryParams.Add("includeProjectedTier", parameterToString(*r.includeProjectedTier, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -1725,7 +1907,7 @@ func (r apiGetLoyaltyBalancesRequest) Execute() (LoyaltyBalances, *_nethttp.Resp error: localVarHTTPResponse.Status, } if localVarHTTPResponse.StatusCode == 200 { - var v LoyaltyBalances + var v LoyaltyBalancesWithTiers err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -3508,18 +3690,18 @@ func (r apiSyncCatalogRequest) Body(body CatalogSyncRequest) apiSyncCatalogReque /* SyncCatalog Sync cart item catalog -Perform one or more of the following actions for a given cart item catalog: +Perform the following actions for a given cart item catalog: -- Adding an item to the catalog. -- Adding several items to the catalog. -- Editing the attributes of an item in the catalog. -- Editing the attributes of several items in the catalog. -- Removing an item from the catalog. -- Removing several items from the catalog. +- Add an item to the catalog. +- Add multiple items to the catalog. +- Update the attributes of an item in the catalog. +- Update the attributes of multiple items in the catalog. +- Remove an item from the catalog. +- Remove multiple items from the catalog. -You can add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. +You can either add, update, or delete up to 1000 cart items in a single request. Each item synced to a catalog must have a unique `SKU`. -**Important**: Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. +**Important**: You can perform only one type of action in a single sync request. Syncing items with duplicate `SKU` values in a single request returns an error message with a `400` status code. For more information, read [managing cart item catalogs](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). @@ -3592,7 +3774,7 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a
- Adding several items to the catalog + Adding multiple items to the catalog
```json @@ -3637,7 +3819,7 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a
- Editing the attributes of an item in the catalog + Updating the attributes of an item in the catalog
```json @@ -3666,7 +3848,7 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a
- Editing the attributes of several items in the catalog + Updating the attributes of multiple items in the catalog
```json @@ -3719,7 +3901,7 @@ Synchronization actions are sent as `PUT` requests. See the structure for each a
- Removing several items from the catalog + Removing multiple items from the catalog
```json diff --git a/api_management.go b/api_management.go index c2c0fc84..484c7e00 100644 --- a/api_management.go +++ b/api_management.go @@ -38,8 +38,8 @@ func (r apiActivateUserByEmailRequest) Body(body ActivateUserRequest) apiActivat } /* -ActivateUserByEmail Activate user by email address -Activate a deactivated user by their email address. +ActivateUserByEmail Enable user by email address +Enable a [disabled user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -1305,6 +1305,195 @@ func (r apiCreateAttributeRequest) Execute() (Attribute, *_nethttp.Response, err return localVarReturnValue, localVarHTTPResponse, nil } +type apiCreateBatchLoyaltyCardsRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + body *LoyaltyCardBatch +} + +func (r apiCreateBatchLoyaltyCardsRequest) Body(body LoyaltyCardBatch) apiCreateBatchLoyaltyCardsRequest { + r.body = &body + return r +} + +/* +CreateBatchLoyaltyCards Create loyalty cards +Create a batch of loyalty cards in a specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types). + +Customers can use loyalty cards to collect and spend loyalty points. + +**Important:** + +- The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. +- Trying to create more than 20,000 loyalty cards in a single request returns an error message with a `400` status code. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + +@return apiCreateBatchLoyaltyCardsRequest +*/ +func (a *ManagementApiService) CreateBatchLoyaltyCards(ctx _context.Context, loyaltyProgramId int32) apiCreateBatchLoyaltyCardsRequest { + return apiCreateBatchLoyaltyCardsRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + } +} + +/* +Execute executes the request + + @return LoyaltyCardBatchResponse +*/ +func (r apiCreateBatchLoyaltyCardsRequest) Execute() (LoyaltyCardBatchResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue LoyaltyCardBatchResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateBatchLoyaltyCards") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/batch" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v LoyaltyCardBatchResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiCreateCampaignFromTemplateRequest struct { ctx _context.Context apiService *ManagementApiService @@ -1939,36 +2128,31 @@ func (r apiCreateCouponsAsyncRequest) Execute() (AsyncCouponCreationResponse, *_ return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateCouponsForMultipleRecipientsRequest struct { +type apiCreateCouponsDeletionJobRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - body *NewCouponsForMultipleRecipients - silent *string + body *NewCouponDeletionJob } -func (r apiCreateCouponsForMultipleRecipientsRequest) Body(body NewCouponsForMultipleRecipients) apiCreateCouponsForMultipleRecipientsRequest { +func (r apiCreateCouponsDeletionJobRequest) Body(body NewCouponDeletionJob) apiCreateCouponsDeletionJobRequest { r.body = &body return r } -func (r apiCreateCouponsForMultipleRecipientsRequest) Silent(silent string) apiCreateCouponsForMultipleRecipientsRequest { - r.silent = &silent - return r -} - /* -CreateCouponsForMultipleRecipients Create coupons for multiple recipients -Create coupons according to some pattern for up to 1000 recipients. +CreateCouponsDeletionJob Creates a coupon deletion job +This endpoint handles creating a job to delete coupons asynchronously. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. -@return apiCreateCouponsForMultipleRecipientsRequest +@return apiCreateCouponsDeletionJobRequest */ -func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsForMultipleRecipientsRequest { - return apiCreateCouponsForMultipleRecipientsRequest{ +func (a *ManagementApiService) CreateCouponsDeletionJob(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsDeletionJobRequest { + return apiCreateCouponsDeletionJobRequest{ apiService: a, ctx: ctx, applicationId: applicationId, @@ -1979,24 +2163,24 @@ func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.C /* Execute executes the request - @return InlineResponse2008 + @return AsyncCouponDeletionJobResponse */ -func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { +func (r apiCreateCouponsDeletionJobRequest) Execute() (AsyncCouponDeletionJobResponse, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue InlineResponse2008 + localVarReturnValue AsyncCouponDeletionJobResponse ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsForMultipleRecipients") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsDeletionJob") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) @@ -2008,9 +2192,6 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 return localVarReturnValue, nil, reportError("body is required and must be specified") } - if r.silent != nil { - localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) - } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -2079,15 +2260,14 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse2008 + if localVarHTTPResponse.StatusCode == 202 { + var v AsyncCouponDeletionJobResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2104,55 +2284,66 @@ func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2 return localVarReturnValue, localVarHTTPResponse, nil } -type apiCreateInviteEmailRequest struct { - ctx _context.Context - apiService *ManagementApiService - body *NewInviteEmail +type apiCreateCouponsForMultipleRecipientsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + body *NewCouponsForMultipleRecipients + silent *string } -func (r apiCreateInviteEmailRequest) Body(body NewInviteEmail) apiCreateInviteEmailRequest { +func (r apiCreateCouponsForMultipleRecipientsRequest) Body(body NewCouponsForMultipleRecipients) apiCreateCouponsForMultipleRecipientsRequest { r.body = &body return r } -/* -CreateInviteEmail Resend invitation email -Resend an email invitation to an existing user. - -**Note:** The invitation token is valid for 24 hours after the email has been sent. +func (r apiCreateCouponsForMultipleRecipientsRequest) Silent(silent string) apiCreateCouponsForMultipleRecipientsRequest { + r.silent = &silent + return r +} +/* +CreateCouponsForMultipleRecipients Create coupons for multiple recipients +Create coupons according to some pattern for up to 1000 recipients. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. -@return apiCreateInviteEmailRequest +@return apiCreateCouponsForMultipleRecipientsRequest */ -func (a *ManagementApiService) CreateInviteEmail(ctx _context.Context) apiCreateInviteEmailRequest { - return apiCreateInviteEmailRequest{ - apiService: a, - ctx: ctx, +func (a *ManagementApiService) CreateCouponsForMultipleRecipients(ctx _context.Context, applicationId int32, campaignId int32) apiCreateCouponsForMultipleRecipientsRequest { + return apiCreateCouponsForMultipleRecipientsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - @return NewInviteEmail + @return InlineResponse2008 */ -func (r apiCreateInviteEmailRequest) Execute() (NewInviteEmail, *_nethttp.Response, error) { +func (r apiCreateCouponsForMultipleRecipientsRequest) Execute() (InlineResponse2008, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPost localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue NewInviteEmail + localVarReturnValue InlineResponse2008 ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateInviteEmail") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateCouponsForMultipleRecipients") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/invite_emails" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2162,6 +2353,9 @@ func (r apiCreateInviteEmailRequest) Execute() (NewInviteEmail, *_nethttp.Respon return localVarReturnValue, nil, reportError("body is required and must be specified") } + if r.silent != nil { + localVarQueryParams.Add("silent", parameterToString(*r.silent, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{"application/json"} @@ -2230,8 +2424,159 @@ func (r apiCreateInviteEmailRequest) Execute() (NewInviteEmail, *_nethttp.Respon body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 201 { - var v NewInviteEmail + if localVarHTTPResponse.StatusCode == 200 { + var v InlineResponse2008 + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiCreateInviteEmailRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *NewInviteEmail +} + +func (r apiCreateInviteEmailRequest) Body(body NewInviteEmail) apiCreateInviteEmailRequest { + r.body = &body + return r +} + +/* +CreateInviteEmail Resend invitation email +Resend an email invitation to an existing user. + +**Note:** The invitation token is valid for 24 hours after the email has been sent. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiCreateInviteEmailRequest +*/ +func (a *ManagementApiService) CreateInviteEmail(ctx _context.Context) apiCreateInviteEmailRequest { + return apiCreateInviteEmailRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return NewInviteEmail +*/ +func (r apiCreateInviteEmailRequest) Execute() (NewInviteEmail, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue NewInviteEmail + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.CreateInviteEmail") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/invite_emails" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 201 { + var v NewInviteEmail err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -2899,8 +3244,8 @@ func (r apiDeactivateUserByEmailRequest) Body(body DeactivateUserRequest) apiDea } /* -DeactivateUserByEmail Deactivate user by email address -Deactivate a specific user by their email address. +DeactivateUserByEmail Disable user by email address +[Disable a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#disabling-a-user) by their email address. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -4609,7 +4954,7 @@ func (r apiDeleteUserByEmailRequest) Body(body DeleteUserRequest) apiDeleteUserB /* DeleteUserByEmail Delete user by email address -Delete a specific user by their email address. +[Delete a specific user](https://docs.talon.one/docs/product/account/account-settings/managing-users#deleting-a-user) by their email address. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -4837,53 +5182,51 @@ func (r apiDestroySessionRequest) Execute() (*_nethttp.Response, error) { return localVarHTTPResponse, nil } -type apiExportAccountCollectionItemsRequest struct { - ctx _context.Context - apiService *ManagementApiService - collectionId int32 +type apiDisconnectCampaignStoresRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 } /* -ExportAccountCollectionItems Export account-level collection's items -Download a CSV file containing items from a given account-level collection. - -**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - +DisconnectCampaignStores Disconnect stores +Disconnect the stores linked to a specific campaign. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. -@return apiExportAccountCollectionItemsRequest +@return apiDisconnectCampaignStoresRequest */ -func (a *ManagementApiService) ExportAccountCollectionItems(ctx _context.Context, collectionId int32) apiExportAccountCollectionItemsRequest { - return apiExportAccountCollectionItemsRequest{ - apiService: a, - ctx: ctx, - collectionId: collectionId, +func (a *ManagementApiService) DisconnectCampaignStores(ctx _context.Context, applicationId int32, campaignId int32) apiDisconnectCampaignStoresRequest { + return apiDisconnectCampaignStoresRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, } } /* Execute executes the request - - @return string */ -func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiDisconnectCampaignStoresRequest) Execute() (*_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodGet + localVarHTTPMethod = _nethttp.MethodDelete localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportAccountCollectionItems") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.DisconnectCampaignStores") if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/collections/{collectionId}/export" - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/stores" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4899,7 +5242,7 @@ func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Res } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/csv"} + localVarHTTPHeaderAccepts := []string{"application/json"} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) @@ -4936,18 +5279,18 @@ func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Res } req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := r.apiService.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -4955,80 +5298,233 @@ func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Res body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.model = v - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } if localVarHTTPResponse.StatusCode == 404 { var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } newErr.model = v } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr + return localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, nil + return localVarHTTPResponse, nil } -type apiExportAchievementsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId int32 - achievementId int32 +type apiExportAccountCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + collectionId int32 } /* -ExportAchievements Export achievement customer data -Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. +ExportAccountCollectionItems Export account-level collection's items +Download a CSV file containing items from a given account-level collection. -The CSV file contains the following columns: -- `profileIntegrationID`: The integration ID of the customer profile participating in the achievement. -- `title`: The display name of the achievement in the Campaign Manager. -- `target`: The required number of actions or the transactional milestone to complete the achievement. -- `progress`: The current progress of the customer in the achievement. -- `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. -- `startDate`: The date on which the customer profile started the achievement in RFC3339. -- `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. -- `completionDate`: The date on which the customer profile completed the achievement in RFC3339. +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - - @param achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. + - @param collectionId The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. -@return apiExportAchievementsRequest +@return apiExportAccountCollectionItemsRequest */ -func (a *ManagementApiService) ExportAchievements(ctx _context.Context, applicationId int32, campaignId int32, achievementId int32) apiExportAchievementsRequest { +func (a *ManagementApiService) ExportAccountCollectionItems(ctx _context.Context, collectionId int32) apiExportAccountCollectionItemsRequest { + return apiExportAccountCollectionItemsRequest{ + apiService: a, + ctx: ctx, + collectionId: collectionId, + } +} + +/* +Execute executes the request + + @return string +*/ +func (r apiExportAccountCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportAccountCollectionItems") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/collections/{collectionId}/export" + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportAchievementsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + achievementId int32 +} + +/* +ExportAchievements Export achievement customer data +Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. + +The CSV file contains the following columns: +- `profileIntegrationID`: The integration ID of the customer profile participating in the achievement. +- `title`: The display name of the achievement in the Campaign Manager. +- `target`: The required number of actions or the transactional milestone to complete the achievement. +- `progress`: The current progress of the customer in the achievement. +- `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. +- `startDate`: The date on which the customer profile started the achievement in RFC3339. +- `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. +- `completionDate`: The date on which the customer profile completed the achievement in RFC3339. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + - @param achievementId The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. + +@return apiExportAchievementsRequest +*/ +func (a *ManagementApiService) ExportAchievements(ctx _context.Context, applicationId int32, campaignId int32, achievementId int32) apiExportAchievementsRequest { return apiExportAchievementsRequest{ apiService: a, ctx: ctx, @@ -5362,34 +5858,35 @@ func (r apiExportAudiencesMembershipsRequest) Execute() (string, *_nethttp.Respo return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportCollectionItemsRequest struct { +type apiExportCampaignStoresRequest struct { ctx _context.Context apiService *ManagementApiService applicationId int32 campaignId int32 - collectionId int32 } /* -ExportCollectionItems Export campaign-level collection's items -Download a CSV file containing items from a given campaign-level collection. +ExportCampaignStores Export stores +Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). +The CSV file contains the following column: + +- `store_integration_id`: The identifier of the store. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. - - @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. -@return apiExportCollectionItemsRequest +@return apiExportCampaignStoresRequest */ -func (a *ManagementApiService) ExportCollectionItems(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiExportCollectionItemsRequest { - return apiExportCollectionItemsRequest{ +func (a *ManagementApiService) ExportCampaignStores(ctx _context.Context, applicationId int32, campaignId int32) apiExportCampaignStoresRequest { + return apiExportCampaignStoresRequest{ apiService: a, ctx: ctx, applicationId: applicationId, campaignId: campaignId, - collectionId: collectionId, } } @@ -5398,7 +5895,7 @@ Execute executes the request @return string */ -func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiExportCampaignStoresRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -5408,15 +5905,14 @@ func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCollectionItems") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCampaignStores") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export" + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/stores/export" localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5498,6 +5994,16 @@ func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, newErr.model = v return localVarReturnValue, localVarHTTPResponse, newErr } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } if localVarHTTPResponse.StatusCode == 401 { var v ErrorResponseWithStatus err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) @@ -5532,43 +6038,213 @@ func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportCouponsRequest struct { - ctx _context.Context - apiService *ManagementApiService - applicationId int32 - campaignId *float32 - sort *string - value *string - createdBefore *time.Time - createdAfter *time.Time - valid *string - usable *string - referralId *int32 - recipientIntegrationId *string - batchId *string - exactMatch *bool - dateFormat *string - campaignState *string - valuesOnly *bool +type apiExportCollectionItemsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + collectionId int32 } -func (r apiExportCouponsRequest) CampaignId(campaignId float32) apiExportCouponsRequest { - r.campaignId = &campaignId - return r -} +/* +ExportCollectionItems Export campaign-level collection's items +Download a CSV file containing items from a given campaign-level collection. -func (r apiExportCouponsRequest) Sort(sort string) apiExportCouponsRequest { - r.sort = &sort - return r -} +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). -func (r apiExportCouponsRequest) Value(value string) apiExportCouponsRequest { - r.value = &value - return r + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + - @param collectionId The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. + +@return apiExportCollectionItemsRequest +*/ +func (a *ManagementApiService) ExportCollectionItems(ctx _context.Context, applicationId int32, campaignId int32, collectionId int32) apiExportCollectionItemsRequest { + return apiExportCollectionItemsRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + collectionId: collectionId, + } } -func (r apiExportCouponsRequest) CreatedBefore(createdBefore time.Time) apiExportCouponsRequest { - r.createdBefore = &createdBefore +/* +Execute executes the request + + @return string +*/ +func (r apiExportCollectionItemsRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportCollectionItems") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"collectionId"+"}", _neturl.QueryEscape(parameterToString(r.collectionId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportCouponsRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId *float32 + sort *string + value *string + createdBefore *time.Time + createdAfter *time.Time + valid *string + usable *string + referralId *int32 + recipientIntegrationId *string + batchId *string + exactMatch *bool + dateFormat *string + campaignState *string + valuesOnly *bool +} + +func (r apiExportCouponsRequest) CampaignId(campaignId float32) apiExportCouponsRequest { + r.campaignId = &campaignId + return r +} + +func (r apiExportCouponsRequest) Sort(sort string) apiExportCouponsRequest { + r.sort = &sort + return r +} + +func (r apiExportCouponsRequest) Value(value string) apiExportCouponsRequest { + r.value = &value + return r +} + +func (r apiExportCouponsRequest) CreatedBefore(createdBefore time.Time) apiExportCouponsRequest { + r.createdBefore = &createdBefore return r } @@ -6095,8 +6771,8 @@ The generated file contains the following columns: You can filter the results by providing the following optional input parameters: -- `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. -- `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported. +- `subledgerIds` (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. +- `tierNames` (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @param loyaltyProgramId The identifier for the loyalty program. @@ -7169,67 +7845,44 @@ func (r apiExportLoyaltyCardLedgerRequest) Execute() (string, *_nethttp.Response return localVarReturnValue, localVarHTTPResponse, nil } -type apiExportLoyaltyLedgerRequest struct { +type apiExportLoyaltyCardsRequest struct { ctx _context.Context apiService *ManagementApiService - rangeStart *time.Time - rangeEnd *time.Time - loyaltyProgramId string - integrationId string - dateFormat *string -} - -func (r apiExportLoyaltyLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyLedgerRequest { - r.rangeStart = &rangeStart - return r -} - -func (r apiExportLoyaltyLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyLedgerRequest { - r.rangeEnd = &rangeEnd - return r + loyaltyProgramId int32 + batchId *string } -func (r apiExportLoyaltyLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyLedgerRequest { - r.dateFormat = &dateFormat +func (r apiExportLoyaltyCardsRequest) BatchId(batchId string) apiExportLoyaltyCardsRequest { + r.batchId = &batchId return r } /* -ExportLoyaltyLedger Export customer's transaction logs -Download a CSV file containing a customer's transaction logs in the loyalty program. +ExportLoyaltyCards Export loyalty cards +Download a CSV file containing the loyalty cards from a specified loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). -The generated file can contain the following columns: - -- `customerprofileid`: The ID of the profile. -- `customersessionid`: The ID of the customer session. -- `rulesetid`: The ID of the rule set. -- `rulename`: The name of the rule. -- `programid`: The ID of the loyalty program. -- `type`: The type of the loyalty program. -- `name`: The name of the loyalty program. -- `subledgerid`: The ID of the subledger, when applicable. -- `startdate`: The start date of the program. -- `expirydate`: The expiration date of the program. -- `id`: The ID of the transaction. -- `created`: The timestamp of the creation of the loyalty program. -- `amount`: The number of points in that transaction. -- `archived`: Whether the session related to the transaction is archived. -- `campaignid`: The ID of the campaign. +The CSV file contains the following columns: +- `identifier`: The unique identifier of the loyalty card. +- `created`: The date and time the loyalty card was created. +- `status`: The status of the loyalty card. +- `userpercardlimit`: The maximum number of customer profiles that can be linked to the card. +- `customerprofileids`: Integration IDs of the customer profiles linked to the card. +- `blockreason`: The reason for transferring and blocking the loyalty card. +- `generated`: An indicator of whether the loyalty card was generated. +- `batchid`: The ID of the batch the loyalty card is in. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param loyaltyProgramId The identifier for the loyalty program. - - @param integrationId The identifier of the profile. + - @param loyaltyProgramId Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiExportLoyaltyLedgerRequest +@return apiExportLoyaltyCardsRequest */ -func (a *ManagementApiService) ExportLoyaltyLedger(ctx _context.Context, loyaltyProgramId string, integrationId string) apiExportLoyaltyLedgerRequest { - return apiExportLoyaltyLedgerRequest{ +func (a *ManagementApiService) ExportLoyaltyCards(ctx _context.Context, loyaltyProgramId int32) apiExportLoyaltyCardsRequest { + return apiExportLoyaltyCardsRequest{ apiService: a, ctx: ctx, loyaltyProgramId: loyaltyProgramId, - integrationId: integrationId, } } @@ -7238,7 +7891,7 @@ Execute executes the request @return string */ -func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { +func (r apiExportLoyaltyCardsRequest) Execute() (string, *_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} @@ -7248,31 +7901,20 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er localVarReturnValue string ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyCards") if err != nil { return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log" + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/cards/export" localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) - localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.rangeStart == nil { - return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") - } - - if r.rangeEnd == nil { - return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") - } - - localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) - localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) - if r.dateFormat != nil { - localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -7348,23 +7990,238 @@ func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, er return localVarReturnValue, localVarHTTPResponse, newErr } newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr := GenericOpenAPIError{ - body: localVarBody, - error: err.Error(), - } - return localVarReturnValue, localVarHTTPResponse, newErr - } - - return localVarReturnValue, localVarHTTPResponse, nil -} - -type apiExportPoolGiveawaysRequest struct { + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportLoyaltyLedgerRequest struct { + ctx _context.Context + apiService *ManagementApiService + rangeStart *time.Time + rangeEnd *time.Time + loyaltyProgramId string + integrationId string + dateFormat *string +} + +func (r apiExportLoyaltyLedgerRequest) RangeStart(rangeStart time.Time) apiExportLoyaltyLedgerRequest { + r.rangeStart = &rangeStart + return r +} + +func (r apiExportLoyaltyLedgerRequest) RangeEnd(rangeEnd time.Time) apiExportLoyaltyLedgerRequest { + r.rangeEnd = &rangeEnd + return r +} + +func (r apiExportLoyaltyLedgerRequest) DateFormat(dateFormat string) apiExportLoyaltyLedgerRequest { + r.dateFormat = &dateFormat + return r +} + +/* +ExportLoyaltyLedger Export customer's transaction logs +Download a CSV file containing a customer's transaction logs in the loyalty program. + +**Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). + +The generated file can contain the following columns: + +- `customerprofileid`: The ID of the profile. +- `customersessionid`: The ID of the customer session. +- `rulesetid`: The ID of the rule set. +- `rulename`: The name of the rule. +- `programid`: The ID of the loyalty program. +- `type`: The transaction type, such as `addition` or `subtraction`. +- `name`: The reason for the transaction. +- `subledgerid`: The ID of the subledger, when applicable. +- `startdate`: The start date of the program. +- `expirydate`: The expiration date of the program. +- `id`: The ID of the transaction. +- `created`: The timestamp of the creation of the loyalty program. +- `amount`: The number of points in that transaction. +- `archived`: Whether the session related to the transaction is archived. +- `campaignid`: The ID of the campaign. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId The identifier for the loyalty program. + - @param integrationId The identifier of the profile. + +@return apiExportLoyaltyLedgerRequest +*/ +func (a *ManagementApiService) ExportLoyaltyLedger(ctx _context.Context, loyaltyProgramId string, integrationId string) apiExportLoyaltyLedgerRequest { + return apiExportLoyaltyLedgerRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + integrationId: integrationId, + } +} + +/* +Execute executes the request + + @return string +*/ +func (r apiExportLoyaltyLedgerRequest) Execute() (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ExportLoyaltyLedger") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"integrationId"+"}", _neturl.QueryEscape(parameterToString(r.integrationId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.rangeStart == nil { + return localVarReturnValue, nil, reportError("rangeStart is required and must be specified") + } + + if r.rangeEnd == nil { + return localVarReturnValue, nil, reportError("rangeEnd is required and must be specified") + } + + localVarQueryParams.Add("rangeStart", parameterToString(*r.rangeStart, "")) + localVarQueryParams.Add("rangeEnd", parameterToString(*r.rangeEnd, "")) + if r.dateFormat != nil { + localVarQueryParams.Add("dateFormat", parameterToString(*r.dateFormat, "")) + } + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/csv"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v string + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiExportPoolGiveawaysRequest struct { ctx _context.Context apiService *ManagementApiService poolId int32 @@ -13685,10 +14542,16 @@ type apiGetCouponsWithoutTotalCountRequest struct { createdAfter *time.Time valid *string usable *string + redeemed *string referralId *int32 recipientIntegrationId *string batchId *string exactMatch *bool + expiresBefore *time.Time + expiresAfter *time.Time + startsBefore *time.Time + startsAfter *time.Time + valuesOnly *bool } func (r apiGetCouponsWithoutTotalCountRequest) PageSize(pageSize int32) apiGetCouponsWithoutTotalCountRequest { @@ -13731,6 +14594,11 @@ func (r apiGetCouponsWithoutTotalCountRequest) Usable(usable string) apiGetCoupo return r } +func (r apiGetCouponsWithoutTotalCountRequest) Redeemed(redeemed string) apiGetCouponsWithoutTotalCountRequest { + r.redeemed = &redeemed + return r +} + func (r apiGetCouponsWithoutTotalCountRequest) ReferralId(referralId int32) apiGetCouponsWithoutTotalCountRequest { r.referralId = &referralId return r @@ -13751,6 +14619,31 @@ func (r apiGetCouponsWithoutTotalCountRequest) ExactMatch(exactMatch bool) apiGe return r } +func (r apiGetCouponsWithoutTotalCountRequest) ExpiresBefore(expiresBefore time.Time) apiGetCouponsWithoutTotalCountRequest { + r.expiresBefore = &expiresBefore + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) ExpiresAfter(expiresAfter time.Time) apiGetCouponsWithoutTotalCountRequest { + r.expiresAfter = &expiresAfter + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) StartsBefore(startsBefore time.Time) apiGetCouponsWithoutTotalCountRequest { + r.startsBefore = &startsBefore + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) StartsAfter(startsAfter time.Time) apiGetCouponsWithoutTotalCountRequest { + r.startsAfter = &startsAfter + return r +} + +func (r apiGetCouponsWithoutTotalCountRequest) ValuesOnly(valuesOnly bool) apiGetCouponsWithoutTotalCountRequest { + r.valuesOnly = &valuesOnly + return r +} + /* GetCouponsWithoutTotalCount List coupons List all the coupons matching the specified criteria. @@ -13822,6 +14715,9 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2009, *_ if r.usable != nil { localVarQueryParams.Add("usable", parameterToString(*r.usable, "")) } + if r.redeemed != nil { + localVarQueryParams.Add("redeemed", parameterToString(*r.redeemed, "")) + } if r.referralId != nil { localVarQueryParams.Add("referralId", parameterToString(*r.referralId, "")) } @@ -13834,6 +14730,21 @@ func (r apiGetCouponsWithoutTotalCountRequest) Execute() (InlineResponse2009, *_ if r.exactMatch != nil { localVarQueryParams.Add("exactMatch", parameterToString(*r.exactMatch, "")) } + if r.expiresBefore != nil { + localVarQueryParams.Add("expiresBefore", parameterToString(*r.expiresBefore, "")) + } + if r.expiresAfter != nil { + localVarQueryParams.Add("expiresAfter", parameterToString(*r.expiresAfter, "")) + } + if r.startsBefore != nil { + localVarQueryParams.Add("startsBefore", parameterToString(*r.startsBefore, "")) + } + if r.startsAfter != nil { + localVarQueryParams.Add("startsAfter", parameterToString(*r.startsAfter, "")) + } + if r.valuesOnly != nil { + localVarQueryParams.Add("valuesOnly", parameterToString(*r.valuesOnly, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -15957,6 +16868,7 @@ type apiGetLoyaltyCardsRequest struct { sort *string identifier *string profileId *int32 + batchId *string } func (r apiGetLoyaltyCardsRequest) PageSize(pageSize int32) apiGetLoyaltyCardsRequest { @@ -15984,6 +16896,11 @@ func (r apiGetLoyaltyCardsRequest) ProfileId(profileId int32) apiGetLoyaltyCards return r } +func (r apiGetLoyaltyCardsRequest) BatchId(batchId string) apiGetLoyaltyCardsRequest { + r.batchId = &batchId + return r +} + /* GetLoyaltyCards List loyalty cards For the given card-based loyalty program, list the loyalty cards that match your filter criteria. @@ -16043,6 +16960,9 @@ func (r apiGetLoyaltyCardsRequest) Execute() (InlineResponse20015, *_nethttp.Res if r.profileId != nil { localVarQueryParams.Add("profileId", parameterToString(*r.profileId, "")) } + if r.batchId != nil { + localVarQueryParams.Add("batchId", parameterToString(*r.batchId, "")) + } // to determine the Content-Type header localVarHTTPContentTypes := []string{} @@ -19463,6 +20383,196 @@ func (r apiImportAudiencesMembershipsRequest) Execute() (Import, *_nethttp.Respo return localVarReturnValue, localVarHTTPResponse, nil } +type apiImportCampaignStoresRequest struct { + ctx _context.Context + apiService *ManagementApiService + applicationId int32 + campaignId int32 + upFile *string +} + +func (r apiImportCampaignStoresRequest) UpFile(upFile string) apiImportCampaignStoresRequest { + r.upFile = &upFile + return r +} + +/* +ImportCampaignStores Import stores +Upload a CSV file containing the stores you want to link to a specific campaign. + +Send the file as multipart data. + +The CSV file **must** only contain the following column: +- `store_integration_id`: The identifier of the store. + +The import **replaces** the previous list of stores linked to the campaign. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param applicationId The ID of the Application. It is displayed in your Talon.One deployment URL. + - @param campaignId The ID of the campaign. It is displayed in your Talon.One deployment URL. + +@return apiImportCampaignStoresRequest +*/ +func (a *ManagementApiService) ImportCampaignStores(ctx _context.Context, applicationId int32, campaignId int32) apiImportCampaignStoresRequest { + return apiImportCampaignStoresRequest{ + apiService: a, + ctx: ctx, + applicationId: applicationId, + campaignId: campaignId, + } +} + +/* +Execute executes the request + + @return Import +*/ +func (r apiImportCampaignStoresRequest) Execute() (Import, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Import + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ImportCampaignStores") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/applications/{applicationId}/campaigns/{campaignId}/stores/import" + localVarPath = strings.Replace(localVarPath, "{"+"applicationId"+"}", _neturl.QueryEscape(parameterToString(r.applicationId, "")), -1) + localVarPath = strings.Replace(localVarPath, "{"+"campaignId"+"}", _neturl.QueryEscape(parameterToString(r.campaignId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"multipart/form-data"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.upFile != nil { + localVarFormParams.Add("upFile", parameterToString(*r.upFile, "")) + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v Import + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 400 { + var v ErrorResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 401 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + return localVarReturnValue, localVarHTTPResponse, newErr + } + if localVarHTTPResponse.StatusCode == 404 { + var v ErrorResponseWithStatus + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiImportCollectionRequest struct { ctx _context.Context apiService *ManagementApiService @@ -20054,7 +21164,7 @@ The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. -- `expirydate`: The expiration date of the tier. It should be a future date. +- `expirydate`: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. @@ -20799,7 +21909,7 @@ func (r apiInviteUserExternalRequest) Body(body NewExternalInvitation) apiInvite /* InviteUserExternal Invite user from identity provider -Invite a user from an external identity provider to Talon.One by sending an invitation to their email address. +[Invite a user](https://docs.talon.one/docs/product/account/account-settings/managing-users#inviting-a-user) from an external identity provider to Talon.One by sending an invitation to their email address. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @@ -22348,72 +23458,54 @@ func (r apiNotificationActivationRequest) Execute() (*_nethttp.Response, error) return localVarHTTPResponse, nil } -type apiPostAddedDeductedPointsNotificationRequest struct { - ctx _context.Context - apiService *ManagementApiService - loyaltyProgramId int32 - body *NewBaseNotification -} - -func (r apiPostAddedDeductedPointsNotificationRequest) Body(body NewBaseNotification) apiPostAddedDeductedPointsNotificationRequest { - r.body = &body - return r +type apiOktaEventHandlerChallengeRequest struct { + ctx _context.Context + apiService *ManagementApiService } /* -PostAddedDeductedPointsNotification Create notification about added or deducted loyalty points -Create a notification about added or deducted loyalty points in a given profile-based loyalty program. -A notification for added or deducted loyalty points is different from regular webhooks -in that it is loyalty program-scoped and has a predefined payload. +OktaEventHandlerChallenge Validate Okta API ownership +Validate the ownership of the API through a challenge-response mechanism. -For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications). +This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible +for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta. - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - - @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. -@return apiPostAddedDeductedPointsNotificationRequest +@return apiOktaEventHandlerChallengeRequest */ -func (a *ManagementApiService) PostAddedDeductedPointsNotification(ctx _context.Context, loyaltyProgramId int32) apiPostAddedDeductedPointsNotificationRequest { - return apiPostAddedDeductedPointsNotificationRequest{ - apiService: a, - ctx: ctx, - loyaltyProgramId: loyaltyProgramId, +func (a *ManagementApiService) OktaEventHandlerChallenge(ctx _context.Context) apiOktaEventHandlerChallengeRequest { + return apiOktaEventHandlerChallengeRequest{ + apiService: a, + ctx: ctx, } } /* Execute executes the request - - @return BaseNotification */ -func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotification, *_nethttp.Response, error) { +func (r apiOktaEventHandlerChallengeRequest) Execute() (*_nethttp.Response, error) { var ( - localVarHTTPMethod = _nethttp.MethodPost + localVarHTTPMethod = _nethttp.MethodGet localVarPostBody interface{} localVarFormFileName string localVarFileName string localVarFileBytes []byte - localVarReturnValue BaseNotification ) - localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.PostAddedDeductedPointsNotification") + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.OktaEventHandlerChallenge") if err != nil { - return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + return nil, GenericOpenAPIError{error: err.Error()} } - localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points" - localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + localVarPath := localBasePath + "/v1/provisioning/okta" localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} localVarFormParams := _neturl.Values{} - if r.body == nil { - return localVarReturnValue, nil, reportError("body is required and must be specified") - } - // to determine the Content-Type header - localVarHTTPContentTypes := []string{"application/json"} + localVarHTTPContentTypes := []string{} // set Content-Type header localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) @@ -22422,15 +23514,13 @@ func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotificati } // to determine the Accept header - localVarHTTPHeaderAccepts := []string{"application/json"} + localVarHTTPHeaderAccepts := []string{} // set Accept header localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) if localVarHTTPHeaderAccept != "" { localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } - // body params - localVarPostBody = r.body if r.ctx != nil { // API Key Authentication if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { @@ -22461,18 +23551,18 @@ func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotificati } req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) if err != nil { - return localVarReturnValue, nil, err + return nil, err } localVarHTTPResponse, err := r.apiService.client.callAPI(req) if err != nil || localVarHTTPResponse == nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) localVarHTTPResponse.Body.Close() if err != nil { - return localVarReturnValue, localVarHTTPResponse, err + return localVarHTTPResponse, err } if localVarHTTPResponse.StatusCode >= 300 { @@ -22480,8 +23570,146 @@ func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotificati body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v BaseNotification + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiPostAddedDeductedPointsNotificationRequest struct { + ctx _context.Context + apiService *ManagementApiService + loyaltyProgramId int32 + body *NewBaseNotification +} + +func (r apiPostAddedDeductedPointsNotificationRequest) Body(body NewBaseNotification) apiPostAddedDeductedPointsNotificationRequest { + r.body = &body + return r +} + +/* +PostAddedDeductedPointsNotification Create notification about added or deducted loyalty points +Create a notification about added or deducted loyalty points in a given profile-based loyalty program. +A notification for added or deducted loyalty points is different from regular webhooks +in that it is loyalty program-scoped and has a predefined payload. + +For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications). + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param loyaltyProgramId Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. + +@return apiPostAddedDeductedPointsNotificationRequest +*/ +func (a *ManagementApiService) PostAddedDeductedPointsNotification(ctx _context.Context, loyaltyProgramId int32) apiPostAddedDeductedPointsNotificationRequest { + return apiPostAddedDeductedPointsNotificationRequest{ + apiService: a, + ctx: ctx, + loyaltyProgramId: loyaltyProgramId, + } +} + +/* +Execute executes the request + + @return BaseNotification +*/ +func (r apiPostAddedDeductedPointsNotificationRequest) Execute() (BaseNotification, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue BaseNotification + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.PostAddedDeductedPointsNotification") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points" + localVarPath = strings.Replace(localVarPath, "{"+"loyaltyProgramId"+"}", _neturl.QueryEscape(parameterToString(r.loyaltyProgramId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v BaseNotification err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) if err != nil { newErr.error = err.Error() @@ -23221,6 +24449,1265 @@ func (r apiResetPasswordRequest) Execute() (NewPassword, *_nethttp.Response, err return localVarReturnValue, localVarHTTPResponse, nil } +type apiScimCreateUserRequest struct { + ctx _context.Context + apiService *ManagementApiService + body *ScimNewUser +} + +func (r apiScimCreateUserRequest) Body(body ScimNewUser) apiScimCreateUserRequest { + r.body = &body + return r +} + +/* +ScimCreateUser Create SCIM user +Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiScimCreateUserRequest +*/ +func (a *ManagementApiService) ScimCreateUser(ctx _context.Context) apiScimCreateUserRequest { + return apiScimCreateUserRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return ScimUser +*/ +func (r apiScimCreateUserRequest) Execute() (ScimUser, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimUser + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimCreateUser") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 201 { + var v ScimUser + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimDeleteUserRequest struct { + ctx _context.Context + apiService *ManagementApiService + userId int32 +} + +/* +ScimDeleteUser Delete SCIM user +Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userId The ID of the user. + +@return apiScimDeleteUserRequest +*/ +func (a *ManagementApiService) ScimDeleteUser(ctx _context.Context, userId int32) apiScimDeleteUserRequest { + return apiScimDeleteUserRequest{ + apiService: a, + ctx: ctx, + userId: userId, + } +} + +/* +Execute executes the request +*/ +func (r apiScimDeleteUserRequest) Execute() (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimDeleteUser") + if err != nil { + return nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users/{userId}" + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +type apiScimGetResourceTypesRequest struct { + ctx _context.Context + apiService *ManagementApiService +} + +/* +ScimGetResourceTypes List supported SCIM resource types +Retrieve a list of resource types supported by the SCIM provisioning protocol. + +Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiScimGetResourceTypesRequest +*/ +func (a *ManagementApiService) ScimGetResourceTypes(ctx _context.Context) apiScimGetResourceTypesRequest { + return apiScimGetResourceTypesRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return ScimResourceTypesListResponse +*/ +func (r apiScimGetResourceTypesRequest) Execute() (ScimResourceTypesListResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimResourceTypesListResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimGetResourceTypes") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/ResourceTypes" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimResourceTypesListResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimGetSchemasRequest struct { + ctx _context.Context + apiService *ManagementApiService +} + +/* +ScimGetSchemas List supported SCIM schemas +Retrieve a list of schemas supported by the SCIM provisioning protocol. + +Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiScimGetSchemasRequest +*/ +func (a *ManagementApiService) ScimGetSchemas(ctx _context.Context) apiScimGetSchemasRequest { + return apiScimGetSchemasRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return ScimSchemasListResponse +*/ +func (r apiScimGetSchemasRequest) Execute() (ScimSchemasListResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimSchemasListResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimGetSchemas") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Schemas" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimSchemasListResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimGetServiceProviderConfigRequest struct { + ctx _context.Context + apiService *ManagementApiService +} + +/* +ScimGetServiceProviderConfig Get SCIM service provider configuration +Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiScimGetServiceProviderConfigRequest +*/ +func (a *ManagementApiService) ScimGetServiceProviderConfig(ctx _context.Context) apiScimGetServiceProviderConfigRequest { + return apiScimGetServiceProviderConfigRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return ScimServiceProviderConfigResponse +*/ +func (r apiScimGetServiceProviderConfigRequest) Execute() (ScimServiceProviderConfigResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimServiceProviderConfigResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimGetServiceProviderConfig") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/ServiceProviderConfig" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimServiceProviderConfigResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimGetUserRequest struct { + ctx _context.Context + apiService *ManagementApiService + userId int32 +} + +/* +ScimGetUser Get SCIM user +Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userId The ID of the user. + +@return apiScimGetUserRequest +*/ +func (a *ManagementApiService) ScimGetUser(ctx _context.Context, userId int32) apiScimGetUserRequest { + return apiScimGetUserRequest{ + apiService: a, + ctx: ctx, + userId: userId, + } +} + +/* +Execute executes the request + + @return ScimUser +*/ +func (r apiScimGetUserRequest) Execute() (ScimUser, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimUser + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimGetUser") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users/{userId}" + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimUser + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimGetUsersRequest struct { + ctx _context.Context + apiService *ManagementApiService +} + +/* +ScimGetUsers List SCIM users +Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + +@return apiScimGetUsersRequest +*/ +func (a *ManagementApiService) ScimGetUsers(ctx _context.Context) apiScimGetUsersRequest { + return apiScimGetUsersRequest{ + apiService: a, + ctx: ctx, + } +} + +/* +Execute executes the request + + @return ScimUsersListResponse +*/ +func (r apiScimGetUsersRequest) Execute() (ScimUsersListResponse, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimUsersListResponse + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimGetUsers") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users" + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimUsersListResponse + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimPatchUserRequest struct { + ctx _context.Context + apiService *ManagementApiService + userId int32 + body *ScimPatchRequest +} + +func (r apiScimPatchUserRequest) Body(body ScimPatchRequest) apiScimPatchUserRequest { + r.body = &body + return r +} + +/* +ScimPatchUser Update SCIM user attributes +Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + +This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userId The ID of the user. + +@return apiScimPatchUserRequest +*/ +func (a *ManagementApiService) ScimPatchUser(ctx _context.Context, userId int32) apiScimPatchUserRequest { + return apiScimPatchUserRequest{ + apiService: a, + ctx: ctx, + userId: userId, + } +} + +/* +Execute executes the request + + @return ScimUser +*/ +func (r apiScimPatchUserRequest) Execute() (ScimUser, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPatch + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimUser + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimPatchUser") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users/{userId}" + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimUser + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +type apiScimReplaceUserAttributesRequest struct { + ctx _context.Context + apiService *ManagementApiService + userId int32 + body *ScimNewUser +} + +func (r apiScimReplaceUserAttributesRequest) Body(body ScimNewUser) apiScimReplaceUserAttributesRequest { + r.body = &body + return r +} + +/* +ScimReplaceUserAttributes Update SCIM user +Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. + +This endpoint replaces all attributes of the specific user with the attributes provided in the request payload. + + - @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + - @param userId The ID of the user. + +@return apiScimReplaceUserAttributesRequest +*/ +func (a *ManagementApiService) ScimReplaceUserAttributes(ctx _context.Context, userId int32) apiScimReplaceUserAttributesRequest { + return apiScimReplaceUserAttributesRequest{ + apiService: a, + ctx: ctx, + userId: userId, + } +} + +/* +Execute executes the request + + @return ScimUser +*/ +func (r apiScimReplaceUserAttributesRequest) Execute() (ScimUser, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPut + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue ScimUser + ) + + localBasePath, err := r.apiService.client.cfg.ServerURLWithContext(r.ctx, "ManagementApiService.ScimReplaceUserAttributes") + if err != nil { + return localVarReturnValue, nil, GenericOpenAPIError{error: err.Error()} + } + + localVarPath := localBasePath + "/v1/provisioning/scim/Users/{userId}" + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(r.userId, "")), -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + if r.body == nil { + return localVarReturnValue, nil, reportError("body is required and must be specified") + } + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = r.body + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + if r.ctx != nil { + // API Key Authentication + if auth, ok := r.ctx.Value(ContextAPIKeys).(map[string]APIKey); ok { + if auth, ok := auth["Authorization"]; ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + } + req, err := r.apiService.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := r.apiService.client.callAPI(req) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + if localVarHTTPResponse.StatusCode == 200 { + var v ScimUser + err = r.apiService.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr.error = err.Error() + return localVarReturnValue, localVarHTTPResponse, newErr + } + newErr.model = v + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = r.apiService.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + type apiSearchCouponsAdvancedApplicationWideWithoutTotalCountRequest struct { ctx _context.Context apiService *ManagementApiService @@ -24962,8 +27449,7 @@ Update the specified coupon.

Important

-

With this PUT endpoint only, any property you do not explicitly set in your request - will be set to null.

+

With this PUT endpoint alone, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

diff --git a/configuration.go b/configuration.go index eb2d4610..df66f44f 100644 --- a/configuration.go +++ b/configuration.go @@ -97,7 +97,7 @@ type Configuration struct { func NewConfiguration() *Configuration { cfg := &Configuration{ DefaultHeader: make(map[string]string), - UserAgent: "OpenAPI-Generator/7.0.0/go", + UserAgent: "OpenAPI-Generator/8.0.0/go", Debug: false, Servers: ServerConfigurations{ { diff --git a/go.mod b/go.mod index 6a3dccf4..d461c58a 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/talon-one/talon_go/v7 +module github.com/talon-one/talon_go go 1.13 diff --git a/model_achievement_progress.go b/model_achievement_progress.go index a570205f..dfc0e163 100644 --- a/model_achievement_progress.go +++ b/model_achievement_progress.go @@ -23,6 +23,8 @@ type AchievementProgress struct { Name string `json:"name"` // The display name of the achievement in the Campaign Manager. Title string `json:"title"` + // The description of the achievement in the Campaign Manager. + Description string `json:"description"` // The ID of the campaign the achievement belongs to. CampaignId int32 `json:"campaignId"` // The status of the achievement. @@ -84,6 +86,21 @@ func (o *AchievementProgress) SetTitle(v string) { o.Title = v } +// GetDescription returns the Description field value +func (o *AchievementProgress) GetDescription() string { + if o == nil { + var ret string + return ret + } + + return o.Description +} + +// SetDescription sets field value +func (o *AchievementProgress) SetDescription(v string) { + o.Description = v +} + // GetCampaignId returns the CampaignId field value func (o *AchievementProgress) GetCampaignId() int32 { if o == nil { diff --git a/model_additional_campaign_properties.go b/model_additional_campaign_properties.go index 01a2a52b..e23b5e86 100644 --- a/model_additional_campaign_properties.go +++ b/model_additional_campaign_properties.go @@ -61,6 +61,8 @@ type AdditionalCampaignProperties struct { TemplateId *int32 `json:"templateId,omitempty"` // A campaign state described exactly as in the Campaign Manager. FrontendState string `json:"frontendState"` + // Indicates whether the linked stores were imported via a CSV file. + StoresImported bool `json:"storesImported"` } // GetBudgets returns the Budgets field value @@ -753,6 +755,21 @@ func (o *AdditionalCampaignProperties) SetFrontendState(v string) { o.FrontendState = v } +// GetStoresImported returns the StoresImported field value +func (o *AdditionalCampaignProperties) GetStoresImported() bool { + if o == nil { + var ret bool + return ret + } + + return o.StoresImported +} + +// SetStoresImported sets field value +func (o *AdditionalCampaignProperties) SetStoresImported(v bool) { + o.StoresImported = v +} + type NullableAdditionalCampaignProperties struct { Value AdditionalCampaignProperties ExplicitNull bool diff --git a/model_account_dashboard_statistic_api_calls.go b/model_analytics_data_point.go similarity index 57% rename from model_account_dashboard_statistic_api_calls.go rename to model_analytics_data_point.go index cbbd19ae..3c4c99d9 100644 --- a/model_account_dashboard_statistic_api_calls.go +++ b/model_analytics_data_point.go @@ -12,19 +12,16 @@ package talon import ( "bytes" "encoding/json" - "time" ) -// AccountDashboardStatisticApiCalls struct for AccountDashboardStatisticApiCalls -type AccountDashboardStatisticApiCalls struct { - // Total number of API calls received. - Total float32 `json:"total"` - // Values aggregated for the specified date. - Datetime time.Time `json:"datetime"` +// AnalyticsDataPoint struct for AnalyticsDataPoint +type AnalyticsDataPoint struct { + Total float32 `json:"total"` + Influenced float32 `json:"influenced"` } // GetTotal returns the Total field value -func (o *AccountDashboardStatisticApiCalls) GetTotal() float32 { +func (o *AnalyticsDataPoint) GetTotal() float32 { if o == nil { var ret float32 return ret @@ -34,31 +31,31 @@ func (o *AccountDashboardStatisticApiCalls) GetTotal() float32 { } // SetTotal sets field value -func (o *AccountDashboardStatisticApiCalls) SetTotal(v float32) { +func (o *AnalyticsDataPoint) SetTotal(v float32) { o.Total = v } -// GetDatetime returns the Datetime field value -func (o *AccountDashboardStatisticApiCalls) GetDatetime() time.Time { +// GetInfluenced returns the Influenced field value +func (o *AnalyticsDataPoint) GetInfluenced() float32 { if o == nil { - var ret time.Time + var ret float32 return ret } - return o.Datetime + return o.Influenced } -// SetDatetime sets field value -func (o *AccountDashboardStatisticApiCalls) SetDatetime(v time.Time) { - o.Datetime = v +// SetInfluenced sets field value +func (o *AnalyticsDataPoint) SetInfluenced(v float32) { + o.Influenced = v } -type NullableAccountDashboardStatisticApiCalls struct { - Value AccountDashboardStatisticApiCalls +type NullableAnalyticsDataPoint struct { + Value AnalyticsDataPoint ExplicitNull bool } -func (v NullableAccountDashboardStatisticApiCalls) MarshalJSON() ([]byte, error) { +func (v NullableAnalyticsDataPoint) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -67,7 +64,7 @@ func (v NullableAccountDashboardStatisticApiCalls) MarshalJSON() ([]byte, error) } } -func (v *NullableAccountDashboardStatisticApiCalls) UnmarshalJSON(src []byte) error { +func (v *NullableAnalyticsDataPoint) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_analytics_data_point_with_trend.go b/model_analytics_data_point_with_trend.go new file mode 100644 index 00000000..389d2d56 --- /dev/null +++ b/model_analytics_data_point_with_trend.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AnalyticsDataPointWithTrend struct for AnalyticsDataPointWithTrend +type AnalyticsDataPointWithTrend struct { + Value float32 `json:"value"` + Trend float32 `json:"trend"` +} + +// GetValue returns the Value field value +func (o *AnalyticsDataPointWithTrend) GetValue() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *AnalyticsDataPointWithTrend) SetValue(v float32) { + o.Value = v +} + +// GetTrend returns the Trend field value +func (o *AnalyticsDataPointWithTrend) GetTrend() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Trend +} + +// SetTrend sets field value +func (o *AnalyticsDataPointWithTrend) SetTrend(v float32) { + o.Trend = v +} + +type NullableAnalyticsDataPointWithTrend struct { + Value AnalyticsDataPointWithTrend + ExplicitNull bool +} + +func (v NullableAnalyticsDataPointWithTrend) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAnalyticsDataPointWithTrend) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_analytics_data_point_with_trend_and_influenced_rate.go b/model_analytics_data_point_with_trend_and_influenced_rate.go new file mode 100644 index 00000000..67f4e2b6 --- /dev/null +++ b/model_analytics_data_point_with_trend_and_influenced_rate.go @@ -0,0 +1,90 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AnalyticsDataPointWithTrendAndInfluencedRate struct for AnalyticsDataPointWithTrendAndInfluencedRate +type AnalyticsDataPointWithTrendAndInfluencedRate struct { + Value float32 `json:"value"` + InfluencedRate float32 `json:"influencedRate"` + Trend float32 `json:"trend"` +} + +// GetValue returns the Value field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetValue() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetValue(v float32) { + o.Value = v +} + +// GetInfluencedRate returns the InfluencedRate field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetInfluencedRate() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.InfluencedRate +} + +// SetInfluencedRate sets field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetInfluencedRate(v float32) { + o.InfluencedRate = v +} + +// GetTrend returns the Trend field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) GetTrend() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Trend +} + +// SetTrend sets field value +func (o *AnalyticsDataPointWithTrendAndInfluencedRate) SetTrend(v float32) { + o.Trend = v +} + +type NullableAnalyticsDataPointWithTrendAndInfluencedRate struct { + Value AnalyticsDataPointWithTrendAndInfluencedRate + ExplicitNull bool +} + +func (v NullableAnalyticsDataPointWithTrendAndInfluencedRate) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAnalyticsDataPointWithTrendAndInfluencedRate) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_analytics_data_point_with_trend_and_uplift.go b/model_analytics_data_point_with_trend_and_uplift.go new file mode 100644 index 00000000..be44d3da --- /dev/null +++ b/model_analytics_data_point_with_trend_and_uplift.go @@ -0,0 +1,90 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AnalyticsDataPointWithTrendAndUplift struct for AnalyticsDataPointWithTrendAndUplift +type AnalyticsDataPointWithTrendAndUplift struct { + Value float32 `json:"value"` + Uplift float32 `json:"uplift"` + Trend float32 `json:"trend"` +} + +// GetValue returns the Value field value +func (o *AnalyticsDataPointWithTrendAndUplift) GetValue() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Value +} + +// SetValue sets field value +func (o *AnalyticsDataPointWithTrendAndUplift) SetValue(v float32) { + o.Value = v +} + +// GetUplift returns the Uplift field value +func (o *AnalyticsDataPointWithTrendAndUplift) GetUplift() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Uplift +} + +// SetUplift sets field value +func (o *AnalyticsDataPointWithTrendAndUplift) SetUplift(v float32) { + o.Uplift = v +} + +// GetTrend returns the Trend field value +func (o *AnalyticsDataPointWithTrendAndUplift) GetTrend() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Trend +} + +// SetTrend sets field value +func (o *AnalyticsDataPointWithTrendAndUplift) SetTrend(v float32) { + o.Trend = v +} + +type NullableAnalyticsDataPointWithTrendAndUplift struct { + Value AnalyticsDataPointWithTrendAndUplift + ExplicitNull bool +} + +func (v NullableAnalyticsDataPointWithTrendAndUplift) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAnalyticsDataPointWithTrendAndUplift) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_application.go b/model_application.go index 44309788..11adce9d 100644 --- a/model_application.go +++ b/model_application.go @@ -54,6 +54,10 @@ type Application struct { DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` // 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. DefaultEvaluationGroupId *int32 `json:"defaultEvaluationGroupId,omitempty"` + // The ID of the default Cart-Item-Filter for this application. + DefaultCartItemFilterId *int32 `json:"defaultCartItemFilterId,omitempty"` + // Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. + EnableCampaignStateManagement *bool `json:"enableCampaignStateManagement,omitempty"` // An array containing all the loyalty programs to which this application is subscribed. LoyaltyPrograms []LoyaltyProgram `json:"loyaltyPrograms"` } @@ -559,6 +563,72 @@ func (o *Application) SetDefaultEvaluationGroupId(v int32) { o.DefaultEvaluationGroupId = &v } +// GetDefaultCartItemFilterId returns the DefaultCartItemFilterId field value if set, zero value otherwise. +func (o *Application) GetDefaultCartItemFilterId() int32 { + if o == nil || o.DefaultCartItemFilterId == nil { + var ret int32 + return ret + } + return *o.DefaultCartItemFilterId +} + +// GetDefaultCartItemFilterIdOk returns a tuple with the DefaultCartItemFilterId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetDefaultCartItemFilterIdOk() (int32, bool) { + if o == nil || o.DefaultCartItemFilterId == nil { + var ret int32 + return ret, false + } + return *o.DefaultCartItemFilterId, true +} + +// HasDefaultCartItemFilterId returns a boolean if a field has been set. +func (o *Application) HasDefaultCartItemFilterId() bool { + if o != nil && o.DefaultCartItemFilterId != nil { + return true + } + + return false +} + +// SetDefaultCartItemFilterId gets a reference to the given int32 and assigns it to the DefaultCartItemFilterId field. +func (o *Application) SetDefaultCartItemFilterId(v int32) { + o.DefaultCartItemFilterId = &v +} + +// GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field value if set, zero value otherwise. +func (o *Application) GetEnableCampaignStateManagement() bool { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret + } + return *o.EnableCampaignStateManagement +} + +// GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Application) GetEnableCampaignStateManagementOk() (bool, bool) { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret, false + } + return *o.EnableCampaignStateManagement, true +} + +// HasEnableCampaignStateManagement returns a boolean if a field has been set. +func (o *Application) HasEnableCampaignStateManagement() bool { + if o != nil && o.EnableCampaignStateManagement != nil { + return true + } + + return false +} + +// SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. +func (o *Application) SetEnableCampaignStateManagement(v bool) { + o.EnableCampaignStateManagement = &v +} + // GetLoyaltyPrograms returns the LoyaltyPrograms field value func (o *Application) GetLoyaltyPrograms() []LoyaltyProgram { if o == nil { diff --git a/model_application_analytics_data_point.go b/model_application_analytics_data_point.go index 740e417d..2ccf41e9 100644 --- a/model_application_analytics_data_point.go +++ b/model_application_analytics_data_point.go @@ -18,89 +18,53 @@ import ( // ApplicationAnalyticsDataPoint struct for ApplicationAnalyticsDataPoint type ApplicationAnalyticsDataPoint struct { // The start of the aggregation time frame in UTC. - StartTime *time.Time `json:"startTime,omitempty"` + StartTime time.Time `json:"startTime"` // The end of the aggregation time frame in UTC. - EndTime *time.Time `json:"endTime,omitempty"` - TotalRevenue *ApplicationAnalyticsDataPointTotalRevenue `json:"totalRevenue,omitempty"` - SessionsCount *ApplicationAnalyticsDataPointSessionsCount `json:"sessionsCount,omitempty"` - AvgItemsPerSession *ApplicationAnalyticsDataPointAvgItemsPerSession `json:"avgItemsPerSession,omitempty"` - AvgSessionValue *ApplicationAnalyticsDataPointAvgSessionValue `json:"avgSessionValue,omitempty"` + EndTime time.Time `json:"endTime"` + TotalRevenue *AnalyticsDataPoint `json:"totalRevenue,omitempty"` + SessionsCount *AnalyticsDataPoint `json:"sessionsCount,omitempty"` + AvgItemsPerSession *AnalyticsDataPoint `json:"avgItemsPerSession,omitempty"` + AvgSessionValue *AnalyticsDataPoint `json:"avgSessionValue,omitempty"` // The total value of discounts given for cart items in influenced sessions. TotalDiscounts *float32 `json:"totalDiscounts,omitempty"` // The number of times a coupon was successfully redeemed in influenced sessions. CouponsCount *float32 `json:"couponsCount,omitempty"` } -// GetStartTime returns the StartTime field value if set, zero value otherwise. +// GetStartTime returns the StartTime field value func (o *ApplicationAnalyticsDataPoint) GetStartTime() time.Time { - if o == nil || o.StartTime == nil { + if o == nil { var ret time.Time return ret } - return *o.StartTime -} -// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetStartTimeOk() (time.Time, bool) { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret, false - } - return *o.StartTime, true -} - -// HasStartTime returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPoint) HasStartTime() bool { - if o != nil && o.StartTime != nil { - return true - } - - return false + return o.StartTime } -// SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. +// SetStartTime sets field value func (o *ApplicationAnalyticsDataPoint) SetStartTime(v time.Time) { - o.StartTime = &v + o.StartTime = v } -// GetEndTime returns the EndTime field value if set, zero value otherwise. +// GetEndTime returns the EndTime field value func (o *ApplicationAnalyticsDataPoint) GetEndTime() time.Time { - if o == nil || o.EndTime == nil { + if o == nil { var ret time.Time return ret } - return *o.EndTime -} -// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetEndTimeOk() (time.Time, bool) { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret, false - } - return *o.EndTime, true -} - -// HasEndTime returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPoint) HasEndTime() bool { - if o != nil && o.EndTime != nil { - return true - } - - return false + return o.EndTime } -// SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. +// SetEndTime sets field value func (o *ApplicationAnalyticsDataPoint) SetEndTime(v time.Time) { - o.EndTime = &v + o.EndTime = v } // GetTotalRevenue returns the TotalRevenue field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPoint) GetTotalRevenue() ApplicationAnalyticsDataPointTotalRevenue { +func (o *ApplicationAnalyticsDataPoint) GetTotalRevenue() AnalyticsDataPoint { if o == nil || o.TotalRevenue == nil { - var ret ApplicationAnalyticsDataPointTotalRevenue + var ret AnalyticsDataPoint return ret } return *o.TotalRevenue @@ -108,9 +72,9 @@ func (o *ApplicationAnalyticsDataPoint) GetTotalRevenue() ApplicationAnalyticsDa // GetTotalRevenueOk returns a tuple with the TotalRevenue field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetTotalRevenueOk() (ApplicationAnalyticsDataPointTotalRevenue, bool) { +func (o *ApplicationAnalyticsDataPoint) GetTotalRevenueOk() (AnalyticsDataPoint, bool) { if o == nil || o.TotalRevenue == nil { - var ret ApplicationAnalyticsDataPointTotalRevenue + var ret AnalyticsDataPoint return ret, false } return *o.TotalRevenue, true @@ -125,15 +89,15 @@ func (o *ApplicationAnalyticsDataPoint) HasTotalRevenue() bool { return false } -// SetTotalRevenue gets a reference to the given ApplicationAnalyticsDataPointTotalRevenue and assigns it to the TotalRevenue field. -func (o *ApplicationAnalyticsDataPoint) SetTotalRevenue(v ApplicationAnalyticsDataPointTotalRevenue) { +// SetTotalRevenue gets a reference to the given AnalyticsDataPoint and assigns it to the TotalRevenue field. +func (o *ApplicationAnalyticsDataPoint) SetTotalRevenue(v AnalyticsDataPoint) { o.TotalRevenue = &v } // GetSessionsCount returns the SessionsCount field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPoint) GetSessionsCount() ApplicationAnalyticsDataPointSessionsCount { +func (o *ApplicationAnalyticsDataPoint) GetSessionsCount() AnalyticsDataPoint { if o == nil || o.SessionsCount == nil { - var ret ApplicationAnalyticsDataPointSessionsCount + var ret AnalyticsDataPoint return ret } return *o.SessionsCount @@ -141,9 +105,9 @@ func (o *ApplicationAnalyticsDataPoint) GetSessionsCount() ApplicationAnalyticsD // GetSessionsCountOk returns a tuple with the SessionsCount field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetSessionsCountOk() (ApplicationAnalyticsDataPointSessionsCount, bool) { +func (o *ApplicationAnalyticsDataPoint) GetSessionsCountOk() (AnalyticsDataPoint, bool) { if o == nil || o.SessionsCount == nil { - var ret ApplicationAnalyticsDataPointSessionsCount + var ret AnalyticsDataPoint return ret, false } return *o.SessionsCount, true @@ -158,15 +122,15 @@ func (o *ApplicationAnalyticsDataPoint) HasSessionsCount() bool { return false } -// SetSessionsCount gets a reference to the given ApplicationAnalyticsDataPointSessionsCount and assigns it to the SessionsCount field. -func (o *ApplicationAnalyticsDataPoint) SetSessionsCount(v ApplicationAnalyticsDataPointSessionsCount) { +// SetSessionsCount gets a reference to the given AnalyticsDataPoint and assigns it to the SessionsCount field. +func (o *ApplicationAnalyticsDataPoint) SetSessionsCount(v AnalyticsDataPoint) { o.SessionsCount = &v } // GetAvgItemsPerSession returns the AvgItemsPerSession field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSession() ApplicationAnalyticsDataPointAvgItemsPerSession { +func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSession() AnalyticsDataPoint { if o == nil || o.AvgItemsPerSession == nil { - var ret ApplicationAnalyticsDataPointAvgItemsPerSession + var ret AnalyticsDataPoint return ret } return *o.AvgItemsPerSession @@ -174,9 +138,9 @@ func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSession() ApplicationAnaly // GetAvgItemsPerSessionOk returns a tuple with the AvgItemsPerSession field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSessionOk() (ApplicationAnalyticsDataPointAvgItemsPerSession, bool) { +func (o *ApplicationAnalyticsDataPoint) GetAvgItemsPerSessionOk() (AnalyticsDataPoint, bool) { if o == nil || o.AvgItemsPerSession == nil { - var ret ApplicationAnalyticsDataPointAvgItemsPerSession + var ret AnalyticsDataPoint return ret, false } return *o.AvgItemsPerSession, true @@ -191,15 +155,15 @@ func (o *ApplicationAnalyticsDataPoint) HasAvgItemsPerSession() bool { return false } -// SetAvgItemsPerSession gets a reference to the given ApplicationAnalyticsDataPointAvgItemsPerSession and assigns it to the AvgItemsPerSession field. -func (o *ApplicationAnalyticsDataPoint) SetAvgItemsPerSession(v ApplicationAnalyticsDataPointAvgItemsPerSession) { +// SetAvgItemsPerSession gets a reference to the given AnalyticsDataPoint and assigns it to the AvgItemsPerSession field. +func (o *ApplicationAnalyticsDataPoint) SetAvgItemsPerSession(v AnalyticsDataPoint) { o.AvgItemsPerSession = &v } // GetAvgSessionValue returns the AvgSessionValue field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValue() ApplicationAnalyticsDataPointAvgSessionValue { +func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValue() AnalyticsDataPoint { if o == nil || o.AvgSessionValue == nil { - var ret ApplicationAnalyticsDataPointAvgSessionValue + var ret AnalyticsDataPoint return ret } return *o.AvgSessionValue @@ -207,9 +171,9 @@ func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValue() ApplicationAnalytic // GetAvgSessionValueOk returns a tuple with the AvgSessionValue field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValueOk() (ApplicationAnalyticsDataPointAvgSessionValue, bool) { +func (o *ApplicationAnalyticsDataPoint) GetAvgSessionValueOk() (AnalyticsDataPoint, bool) { if o == nil || o.AvgSessionValue == nil { - var ret ApplicationAnalyticsDataPointAvgSessionValue + var ret AnalyticsDataPoint return ret, false } return *o.AvgSessionValue, true @@ -224,8 +188,8 @@ func (o *ApplicationAnalyticsDataPoint) HasAvgSessionValue() bool { return false } -// SetAvgSessionValue gets a reference to the given ApplicationAnalyticsDataPointAvgSessionValue and assigns it to the AvgSessionValue field. -func (o *ApplicationAnalyticsDataPoint) SetAvgSessionValue(v ApplicationAnalyticsDataPointAvgSessionValue) { +// SetAvgSessionValue gets a reference to the given AnalyticsDataPoint and assigns it to the AvgSessionValue field. +func (o *ApplicationAnalyticsDataPoint) SetAvgSessionValue(v AnalyticsDataPoint) { o.AvgSessionValue = &v } diff --git a/model_application_analytics_data_point_avg_items_per_session.go b/model_application_analytics_data_point_avg_items_per_session.go deleted file mode 100644 index 44a1b792..00000000 --- a/model_application_analytics_data_point_avg_items_per_session.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// 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. -type ApplicationAnalyticsDataPointAvgItemsPerSession struct { - Total *float32 `json:"total,omitempty"` - Influenced *float32 `json:"influenced,omitempty"` -} - -// GetTotal returns the Total field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetTotal() float32 { - if o == nil || o.Total == nil { - var ret float32 - return ret - } - return *o.Total -} - -// GetTotalOk returns a tuple with the Total field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetTotalOk() (float32, bool) { - if o == nil || o.Total == nil { - var ret float32 - return ret, false - } - return *o.Total, true -} - -// HasTotal returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) HasTotal() bool { - if o != nil && o.Total != nil { - return true - } - - return false -} - -// SetTotal gets a reference to the given float32 and assigns it to the Total field. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) SetTotal(v float32) { - o.Total = &v -} - -// GetInfluenced returns the Influenced field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetInfluenced() float32 { - if o == nil || o.Influenced == nil { - var ret float32 - return ret - } - return *o.Influenced -} - -// GetInfluencedOk returns a tuple with the Influenced field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) GetInfluencedOk() (float32, bool) { - if o == nil || o.Influenced == nil { - var ret float32 - return ret, false - } - return *o.Influenced, true -} - -// HasInfluenced returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) HasInfluenced() bool { - if o != nil && o.Influenced != nil { - return true - } - - return false -} - -// SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. -func (o *ApplicationAnalyticsDataPointAvgItemsPerSession) SetInfluenced(v float32) { - o.Influenced = &v -} - -type NullableApplicationAnalyticsDataPointAvgItemsPerSession struct { - Value ApplicationAnalyticsDataPointAvgItemsPerSession - ExplicitNull bool -} - -func (v NullableApplicationAnalyticsDataPointAvgItemsPerSession) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationAnalyticsDataPointAvgItemsPerSession) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_analytics_data_point_avg_session_value.go b/model_application_analytics_data_point_avg_session_value.go deleted file mode 100644 index d35119a1..00000000 --- a/model_application_analytics_data_point_avg_session_value.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// 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. -type ApplicationAnalyticsDataPointAvgSessionValue struct { - Total *float32 `json:"total,omitempty"` - Influenced *float32 `json:"influenced,omitempty"` -} - -// GetTotal returns the Total field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetTotal() float32 { - if o == nil || o.Total == nil { - var ret float32 - return ret - } - return *o.Total -} - -// GetTotalOk returns a tuple with the Total field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetTotalOk() (float32, bool) { - if o == nil || o.Total == nil { - var ret float32 - return ret, false - } - return *o.Total, true -} - -// HasTotal returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) HasTotal() bool { - if o != nil && o.Total != nil { - return true - } - - return false -} - -// SetTotal gets a reference to the given float32 and assigns it to the Total field. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) SetTotal(v float32) { - o.Total = &v -} - -// GetInfluenced returns the Influenced field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetInfluenced() float32 { - if o == nil || o.Influenced == nil { - var ret float32 - return ret - } - return *o.Influenced -} - -// GetInfluencedOk returns a tuple with the Influenced field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) GetInfluencedOk() (float32, bool) { - if o == nil || o.Influenced == nil { - var ret float32 - return ret, false - } - return *o.Influenced, true -} - -// HasInfluenced returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) HasInfluenced() bool { - if o != nil && o.Influenced != nil { - return true - } - - return false -} - -// SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. -func (o *ApplicationAnalyticsDataPointAvgSessionValue) SetInfluenced(v float32) { - o.Influenced = &v -} - -type NullableApplicationAnalyticsDataPointAvgSessionValue struct { - Value ApplicationAnalyticsDataPointAvgSessionValue - ExplicitNull bool -} - -func (v NullableApplicationAnalyticsDataPointAvgSessionValue) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationAnalyticsDataPointAvgSessionValue) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_analytics_data_point_sessions_count.go b/model_application_analytics_data_point_sessions_count.go deleted file mode 100644 index ffd7684c..00000000 --- a/model_application_analytics_data_point_sessions_count.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationAnalyticsDataPointSessionsCount The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect. -type ApplicationAnalyticsDataPointSessionsCount struct { - Total *float32 `json:"total,omitempty"` - Influenced *float32 `json:"influenced,omitempty"` -} - -// GetTotal returns the Total field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointSessionsCount) GetTotal() float32 { - if o == nil || o.Total == nil { - var ret float32 - return ret - } - return *o.Total -} - -// GetTotalOk returns a tuple with the Total field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointSessionsCount) GetTotalOk() (float32, bool) { - if o == nil || o.Total == nil { - var ret float32 - return ret, false - } - return *o.Total, true -} - -// HasTotal returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointSessionsCount) HasTotal() bool { - if o != nil && o.Total != nil { - return true - } - - return false -} - -// SetTotal gets a reference to the given float32 and assigns it to the Total field. -func (o *ApplicationAnalyticsDataPointSessionsCount) SetTotal(v float32) { - o.Total = &v -} - -// GetInfluenced returns the Influenced field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointSessionsCount) GetInfluenced() float32 { - if o == nil || o.Influenced == nil { - var ret float32 - return ret - } - return *o.Influenced -} - -// GetInfluencedOk returns a tuple with the Influenced field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointSessionsCount) GetInfluencedOk() (float32, bool) { - if o == nil || o.Influenced == nil { - var ret float32 - return ret, false - } - return *o.Influenced, true -} - -// HasInfluenced returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointSessionsCount) HasInfluenced() bool { - if o != nil && o.Influenced != nil { - return true - } - - return false -} - -// SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. -func (o *ApplicationAnalyticsDataPointSessionsCount) SetInfluenced(v float32) { - o.Influenced = &v -} - -type NullableApplicationAnalyticsDataPointSessionsCount struct { - Value ApplicationAnalyticsDataPointSessionsCount - ExplicitNull bool -} - -func (v NullableApplicationAnalyticsDataPointSessionsCount) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationAnalyticsDataPointSessionsCount) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_analytics_data_point_total_revenue.go b/model_application_analytics_data_point_total_revenue.go deleted file mode 100644 index 16ba1268..00000000 --- a/model_application_analytics_data_point_total_revenue.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationAnalyticsDataPointTotalRevenue The total, pre-discount value of all items purchased in a customer session. -type ApplicationAnalyticsDataPointTotalRevenue struct { - Total *float32 `json:"total,omitempty"` - Influenced *float32 `json:"influenced,omitempty"` -} - -// GetTotal returns the Total field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointTotalRevenue) GetTotal() float32 { - if o == nil || o.Total == nil { - var ret float32 - return ret - } - return *o.Total -} - -// GetTotalOk returns a tuple with the Total field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointTotalRevenue) GetTotalOk() (float32, bool) { - if o == nil || o.Total == nil { - var ret float32 - return ret, false - } - return *o.Total, true -} - -// HasTotal returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointTotalRevenue) HasTotal() bool { - if o != nil && o.Total != nil { - return true - } - - return false -} - -// SetTotal gets a reference to the given float32 and assigns it to the Total field. -func (o *ApplicationAnalyticsDataPointTotalRevenue) SetTotal(v float32) { - o.Total = &v -} - -// GetInfluenced returns the Influenced field value if set, zero value otherwise. -func (o *ApplicationAnalyticsDataPointTotalRevenue) GetInfluenced() float32 { - if o == nil || o.Influenced == nil { - var ret float32 - return ret - } - return *o.Influenced -} - -// GetInfluencedOk returns a tuple with the Influenced field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationAnalyticsDataPointTotalRevenue) GetInfluencedOk() (float32, bool) { - if o == nil || o.Influenced == nil { - var ret float32 - return ret, false - } - return *o.Influenced, true -} - -// HasInfluenced returns a boolean if a field has been set. -func (o *ApplicationAnalyticsDataPointTotalRevenue) HasInfluenced() bool { - if o != nil && o.Influenced != nil { - return true - } - - return false -} - -// SetInfluenced gets a reference to the given float32 and assigns it to the Influenced field. -func (o *ApplicationAnalyticsDataPointTotalRevenue) SetInfluenced(v float32) { - o.Influenced = &v -} - -type NullableApplicationAnalyticsDataPointTotalRevenue struct { - Value ApplicationAnalyticsDataPointTotalRevenue - ExplicitNull bool -} - -func (v NullableApplicationAnalyticsDataPointTotalRevenue) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationAnalyticsDataPointTotalRevenue) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics.go b/model_application_campaign_analytics.go index 155a546c..c0d4df53 100644 --- a/model_application_campaign_analytics.go +++ b/model_application_campaign_analytics.go @@ -18,332 +18,119 @@ import ( // ApplicationCampaignAnalytics struct for ApplicationCampaignAnalytics type ApplicationCampaignAnalytics struct { // The start of the aggregation time frame in UTC. - StartTime *time.Time `json:"startTime,omitempty"` + StartTime time.Time `json:"startTime"` // The end of the aggregation time frame in UTC. - EndTime *time.Time `json:"endTime,omitempty"` + EndTime time.Time `json:"endTime"` // The ID of the campaign. - CampaignId *int32 `json:"campaignId,omitempty"` + CampaignId int32 `json:"campaignId"` // The name of the campaign. - CampaignName *string `json:"campaignName,omitempty"` + CampaignName string `json:"campaignName"` // A list of tags for the campaign. - CampaignTags *[]string `json:"campaignTags,omitempty"` + CampaignTags []string `json:"campaignTags"` // The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. - CampaignState *string `json:"campaignState,omitempty"` - // The [ID of the ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. - CampaignActiveRulesetId *int32 `json:"campaignActiveRulesetId,omitempty"` - // Date and time when the campaign becomes active. - CampaignStartTime *time.Time `json:"campaignStartTime,omitempty"` - // Date and time when the campaign becomes inactive. - CampaignEndTime *time.Time `json:"campaignEndTime,omitempty"` - TotalRevenue *ApplicationCampaignAnalyticsTotalRevenue `json:"totalRevenue,omitempty"` - SessionsCount *ApplicationCampaignAnalyticsSessionsCount `json:"sessionsCount,omitempty"` - AvgItemsPerSession *ApplicationCampaignAnalyticsAvgItemsPerSession `json:"avgItemsPerSession,omitempty"` - AvgSessionValue *ApplicationCampaignAnalyticsAvgSessionValue `json:"avgSessionValue,omitempty"` - TotalDiscounts *ApplicationCampaignAnalyticsTotalDiscounts `json:"totalDiscounts,omitempty"` - CouponsCount *ApplicationCampaignAnalyticsCouponsCount `json:"couponsCount,omitempty"` -} - -// GetStartTime returns the StartTime field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetStartTime() time.Time { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret - } - return *o.StartTime + CampaignState string `json:"campaignState"` + TotalRevenue *AnalyticsDataPointWithTrendAndInfluencedRate `json:"totalRevenue,omitempty"` + SessionsCount *AnalyticsDataPointWithTrendAndInfluencedRate `json:"sessionsCount,omitempty"` + AvgItemsPerSession *AnalyticsDataPointWithTrendAndUplift `json:"avgItemsPerSession,omitempty"` + AvgSessionValue *AnalyticsDataPointWithTrendAndUplift `json:"avgSessionValue,omitempty"` + TotalDiscounts *AnalyticsDataPointWithTrend `json:"totalDiscounts,omitempty"` + CouponsCount *AnalyticsDataPointWithTrend `json:"couponsCount,omitempty"` } -// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetStartTimeOk() (time.Time, bool) { - if o == nil || o.StartTime == nil { +// GetStartTime returns the StartTime field value +func (o *ApplicationCampaignAnalytics) GetStartTime() time.Time { + if o == nil { var ret time.Time - return ret, false - } - return *o.StartTime, true -} - -// HasStartTime returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasStartTime() bool { - if o != nil && o.StartTime != nil { - return true + return ret } - return false + return o.StartTime } -// SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. +// SetStartTime sets field value func (o *ApplicationCampaignAnalytics) SetStartTime(v time.Time) { - o.StartTime = &v + o.StartTime = v } -// GetEndTime returns the EndTime field value if set, zero value otherwise. +// GetEndTime returns the EndTime field value func (o *ApplicationCampaignAnalytics) GetEndTime() time.Time { - if o == nil || o.EndTime == nil { + if o == nil { var ret time.Time return ret } - return *o.EndTime -} - -// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetEndTimeOk() (time.Time, bool) { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret, false - } - return *o.EndTime, true -} - -// HasEndTime returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasEndTime() bool { - if o != nil && o.EndTime != nil { - return true - } - return false + return o.EndTime } -// SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. +// SetEndTime sets field value func (o *ApplicationCampaignAnalytics) SetEndTime(v time.Time) { - o.EndTime = &v + o.EndTime = v } -// GetCampaignId returns the CampaignId field value if set, zero value otherwise. +// GetCampaignId returns the CampaignId field value func (o *ApplicationCampaignAnalytics) GetCampaignId() int32 { - if o == nil || o.CampaignId == nil { + if o == nil { var ret int32 return ret } - return *o.CampaignId -} -// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignIdOk() (int32, bool) { - if o == nil || o.CampaignId == nil { - var ret int32 - return ret, false - } - return *o.CampaignId, true + return o.CampaignId } -// HasCampaignId returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignId() bool { - if o != nil && o.CampaignId != nil { - return true - } - - return false -} - -// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. +// SetCampaignId sets field value func (o *ApplicationCampaignAnalytics) SetCampaignId(v int32) { - o.CampaignId = &v + o.CampaignId = v } -// GetCampaignName returns the CampaignName field value if set, zero value otherwise. +// GetCampaignName returns the CampaignName field value func (o *ApplicationCampaignAnalytics) GetCampaignName() string { - if o == nil || o.CampaignName == nil { + if o == nil { var ret string return ret } - return *o.CampaignName -} - -// GetCampaignNameOk returns a tuple with the CampaignName field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignNameOk() (string, bool) { - if o == nil || o.CampaignName == nil { - var ret string - return ret, false - } - return *o.CampaignName, true -} - -// HasCampaignName returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignName() bool { - if o != nil && o.CampaignName != nil { - return true - } - return false + return o.CampaignName } -// SetCampaignName gets a reference to the given string and assigns it to the CampaignName field. +// SetCampaignName sets field value func (o *ApplicationCampaignAnalytics) SetCampaignName(v string) { - o.CampaignName = &v + o.CampaignName = v } -// GetCampaignTags returns the CampaignTags field value if set, zero value otherwise. +// GetCampaignTags returns the CampaignTags field value func (o *ApplicationCampaignAnalytics) GetCampaignTags() []string { - if o == nil || o.CampaignTags == nil { + if o == nil { var ret []string return ret } - return *o.CampaignTags -} -// GetCampaignTagsOk returns a tuple with the CampaignTags field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignTagsOk() ([]string, bool) { - if o == nil || o.CampaignTags == nil { - var ret []string - return ret, false - } - return *o.CampaignTags, true + return o.CampaignTags } -// HasCampaignTags returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignTags() bool { - if o != nil && o.CampaignTags != nil { - return true - } - - return false -} - -// SetCampaignTags gets a reference to the given []string and assigns it to the CampaignTags field. +// SetCampaignTags sets field value func (o *ApplicationCampaignAnalytics) SetCampaignTags(v []string) { - o.CampaignTags = &v + o.CampaignTags = v } -// GetCampaignState returns the CampaignState field value if set, zero value otherwise. +// GetCampaignState returns the CampaignState field value func (o *ApplicationCampaignAnalytics) GetCampaignState() string { - if o == nil || o.CampaignState == nil { + if o == nil { var ret string return ret } - return *o.CampaignState -} -// GetCampaignStateOk returns a tuple with the CampaignState field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignStateOk() (string, bool) { - if o == nil || o.CampaignState == nil { - var ret string - return ret, false - } - return *o.CampaignState, true + return o.CampaignState } -// HasCampaignState returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignState() bool { - if o != nil && o.CampaignState != nil { - return true - } - - return false -} - -// SetCampaignState gets a reference to the given string and assigns it to the CampaignState field. +// SetCampaignState sets field value func (o *ApplicationCampaignAnalytics) SetCampaignState(v string) { - o.CampaignState = &v -} - -// GetCampaignActiveRulesetId returns the CampaignActiveRulesetId field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetCampaignActiveRulesetId() int32 { - if o == nil || o.CampaignActiveRulesetId == nil { - var ret int32 - return ret - } - return *o.CampaignActiveRulesetId -} - -// GetCampaignActiveRulesetIdOk returns a tuple with the CampaignActiveRulesetId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignActiveRulesetIdOk() (int32, bool) { - if o == nil || o.CampaignActiveRulesetId == nil { - var ret int32 - return ret, false - } - return *o.CampaignActiveRulesetId, true -} - -// HasCampaignActiveRulesetId returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignActiveRulesetId() bool { - if o != nil && o.CampaignActiveRulesetId != nil { - return true - } - - return false -} - -// SetCampaignActiveRulesetId gets a reference to the given int32 and assigns it to the CampaignActiveRulesetId field. -func (o *ApplicationCampaignAnalytics) SetCampaignActiveRulesetId(v int32) { - o.CampaignActiveRulesetId = &v -} - -// GetCampaignStartTime returns the CampaignStartTime field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetCampaignStartTime() time.Time { - if o == nil || o.CampaignStartTime == nil { - var ret time.Time - return ret - } - return *o.CampaignStartTime -} - -// GetCampaignStartTimeOk returns a tuple with the CampaignStartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignStartTimeOk() (time.Time, bool) { - if o == nil || o.CampaignStartTime == nil { - var ret time.Time - return ret, false - } - return *o.CampaignStartTime, true -} - -// HasCampaignStartTime returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignStartTime() bool { - if o != nil && o.CampaignStartTime != nil { - return true - } - - return false -} - -// SetCampaignStartTime gets a reference to the given time.Time and assigns it to the CampaignStartTime field. -func (o *ApplicationCampaignAnalytics) SetCampaignStartTime(v time.Time) { - o.CampaignStartTime = &v -} - -// GetCampaignEndTime returns the CampaignEndTime field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetCampaignEndTime() time.Time { - if o == nil || o.CampaignEndTime == nil { - var ret time.Time - return ret - } - return *o.CampaignEndTime -} - -// GetCampaignEndTimeOk returns a tuple with the CampaignEndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCampaignEndTimeOk() (time.Time, bool) { - if o == nil || o.CampaignEndTime == nil { - var ret time.Time - return ret, false - } - return *o.CampaignEndTime, true -} - -// HasCampaignEndTime returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalytics) HasCampaignEndTime() bool { - if o != nil && o.CampaignEndTime != nil { - return true - } - - return false -} - -// SetCampaignEndTime gets a reference to the given time.Time and assigns it to the CampaignEndTime field. -func (o *ApplicationCampaignAnalytics) SetCampaignEndTime(v time.Time) { - o.CampaignEndTime = &v + o.CampaignState = v } // GetTotalRevenue returns the TotalRevenue field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetTotalRevenue() ApplicationCampaignAnalyticsTotalRevenue { +func (o *ApplicationCampaignAnalytics) GetTotalRevenue() AnalyticsDataPointWithTrendAndInfluencedRate { if o == nil || o.TotalRevenue == nil { - var ret ApplicationCampaignAnalyticsTotalRevenue + var ret AnalyticsDataPointWithTrendAndInfluencedRate return ret } return *o.TotalRevenue @@ -351,9 +138,9 @@ func (o *ApplicationCampaignAnalytics) GetTotalRevenue() ApplicationCampaignAnal // GetTotalRevenueOk returns a tuple with the TotalRevenue field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetTotalRevenueOk() (ApplicationCampaignAnalyticsTotalRevenue, bool) { +func (o *ApplicationCampaignAnalytics) GetTotalRevenueOk() (AnalyticsDataPointWithTrendAndInfluencedRate, bool) { if o == nil || o.TotalRevenue == nil { - var ret ApplicationCampaignAnalyticsTotalRevenue + var ret AnalyticsDataPointWithTrendAndInfluencedRate return ret, false } return *o.TotalRevenue, true @@ -368,15 +155,15 @@ func (o *ApplicationCampaignAnalytics) HasTotalRevenue() bool { return false } -// SetTotalRevenue gets a reference to the given ApplicationCampaignAnalyticsTotalRevenue and assigns it to the TotalRevenue field. -func (o *ApplicationCampaignAnalytics) SetTotalRevenue(v ApplicationCampaignAnalyticsTotalRevenue) { +// SetTotalRevenue gets a reference to the given AnalyticsDataPointWithTrendAndInfluencedRate and assigns it to the TotalRevenue field. +func (o *ApplicationCampaignAnalytics) SetTotalRevenue(v AnalyticsDataPointWithTrendAndInfluencedRate) { o.TotalRevenue = &v } // GetSessionsCount returns the SessionsCount field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetSessionsCount() ApplicationCampaignAnalyticsSessionsCount { +func (o *ApplicationCampaignAnalytics) GetSessionsCount() AnalyticsDataPointWithTrendAndInfluencedRate { if o == nil || o.SessionsCount == nil { - var ret ApplicationCampaignAnalyticsSessionsCount + var ret AnalyticsDataPointWithTrendAndInfluencedRate return ret } return *o.SessionsCount @@ -384,9 +171,9 @@ func (o *ApplicationCampaignAnalytics) GetSessionsCount() ApplicationCampaignAna // GetSessionsCountOk returns a tuple with the SessionsCount field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetSessionsCountOk() (ApplicationCampaignAnalyticsSessionsCount, bool) { +func (o *ApplicationCampaignAnalytics) GetSessionsCountOk() (AnalyticsDataPointWithTrendAndInfluencedRate, bool) { if o == nil || o.SessionsCount == nil { - var ret ApplicationCampaignAnalyticsSessionsCount + var ret AnalyticsDataPointWithTrendAndInfluencedRate return ret, false } return *o.SessionsCount, true @@ -401,15 +188,15 @@ func (o *ApplicationCampaignAnalytics) HasSessionsCount() bool { return false } -// SetSessionsCount gets a reference to the given ApplicationCampaignAnalyticsSessionsCount and assigns it to the SessionsCount field. -func (o *ApplicationCampaignAnalytics) SetSessionsCount(v ApplicationCampaignAnalyticsSessionsCount) { +// SetSessionsCount gets a reference to the given AnalyticsDataPointWithTrendAndInfluencedRate and assigns it to the SessionsCount field. +func (o *ApplicationCampaignAnalytics) SetSessionsCount(v AnalyticsDataPointWithTrendAndInfluencedRate) { o.SessionsCount = &v } // GetAvgItemsPerSession returns the AvgItemsPerSession field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSession() ApplicationCampaignAnalyticsAvgItemsPerSession { +func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSession() AnalyticsDataPointWithTrendAndUplift { if o == nil || o.AvgItemsPerSession == nil { - var ret ApplicationCampaignAnalyticsAvgItemsPerSession + var ret AnalyticsDataPointWithTrendAndUplift return ret } return *o.AvgItemsPerSession @@ -417,9 +204,9 @@ func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSession() ApplicationCampai // GetAvgItemsPerSessionOk returns a tuple with the AvgItemsPerSession field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSessionOk() (ApplicationCampaignAnalyticsAvgItemsPerSession, bool) { +func (o *ApplicationCampaignAnalytics) GetAvgItemsPerSessionOk() (AnalyticsDataPointWithTrendAndUplift, bool) { if o == nil || o.AvgItemsPerSession == nil { - var ret ApplicationCampaignAnalyticsAvgItemsPerSession + var ret AnalyticsDataPointWithTrendAndUplift return ret, false } return *o.AvgItemsPerSession, true @@ -434,15 +221,15 @@ func (o *ApplicationCampaignAnalytics) HasAvgItemsPerSession() bool { return false } -// SetAvgItemsPerSession gets a reference to the given ApplicationCampaignAnalyticsAvgItemsPerSession and assigns it to the AvgItemsPerSession field. -func (o *ApplicationCampaignAnalytics) SetAvgItemsPerSession(v ApplicationCampaignAnalyticsAvgItemsPerSession) { +// SetAvgItemsPerSession gets a reference to the given AnalyticsDataPointWithTrendAndUplift and assigns it to the AvgItemsPerSession field. +func (o *ApplicationCampaignAnalytics) SetAvgItemsPerSession(v AnalyticsDataPointWithTrendAndUplift) { o.AvgItemsPerSession = &v } // GetAvgSessionValue returns the AvgSessionValue field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetAvgSessionValue() ApplicationCampaignAnalyticsAvgSessionValue { +func (o *ApplicationCampaignAnalytics) GetAvgSessionValue() AnalyticsDataPointWithTrendAndUplift { if o == nil || o.AvgSessionValue == nil { - var ret ApplicationCampaignAnalyticsAvgSessionValue + var ret AnalyticsDataPointWithTrendAndUplift return ret } return *o.AvgSessionValue @@ -450,9 +237,9 @@ func (o *ApplicationCampaignAnalytics) GetAvgSessionValue() ApplicationCampaignA // GetAvgSessionValueOk returns a tuple with the AvgSessionValue field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetAvgSessionValueOk() (ApplicationCampaignAnalyticsAvgSessionValue, bool) { +func (o *ApplicationCampaignAnalytics) GetAvgSessionValueOk() (AnalyticsDataPointWithTrendAndUplift, bool) { if o == nil || o.AvgSessionValue == nil { - var ret ApplicationCampaignAnalyticsAvgSessionValue + var ret AnalyticsDataPointWithTrendAndUplift return ret, false } return *o.AvgSessionValue, true @@ -467,15 +254,15 @@ func (o *ApplicationCampaignAnalytics) HasAvgSessionValue() bool { return false } -// SetAvgSessionValue gets a reference to the given ApplicationCampaignAnalyticsAvgSessionValue and assigns it to the AvgSessionValue field. -func (o *ApplicationCampaignAnalytics) SetAvgSessionValue(v ApplicationCampaignAnalyticsAvgSessionValue) { +// SetAvgSessionValue gets a reference to the given AnalyticsDataPointWithTrendAndUplift and assigns it to the AvgSessionValue field. +func (o *ApplicationCampaignAnalytics) SetAvgSessionValue(v AnalyticsDataPointWithTrendAndUplift) { o.AvgSessionValue = &v } // GetTotalDiscounts returns the TotalDiscounts field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetTotalDiscounts() ApplicationCampaignAnalyticsTotalDiscounts { +func (o *ApplicationCampaignAnalytics) GetTotalDiscounts() AnalyticsDataPointWithTrend { if o == nil || o.TotalDiscounts == nil { - var ret ApplicationCampaignAnalyticsTotalDiscounts + var ret AnalyticsDataPointWithTrend return ret } return *o.TotalDiscounts @@ -483,9 +270,9 @@ func (o *ApplicationCampaignAnalytics) GetTotalDiscounts() ApplicationCampaignAn // GetTotalDiscountsOk returns a tuple with the TotalDiscounts field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetTotalDiscountsOk() (ApplicationCampaignAnalyticsTotalDiscounts, bool) { +func (o *ApplicationCampaignAnalytics) GetTotalDiscountsOk() (AnalyticsDataPointWithTrend, bool) { if o == nil || o.TotalDiscounts == nil { - var ret ApplicationCampaignAnalyticsTotalDiscounts + var ret AnalyticsDataPointWithTrend return ret, false } return *o.TotalDiscounts, true @@ -500,15 +287,15 @@ func (o *ApplicationCampaignAnalytics) HasTotalDiscounts() bool { return false } -// SetTotalDiscounts gets a reference to the given ApplicationCampaignAnalyticsTotalDiscounts and assigns it to the TotalDiscounts field. -func (o *ApplicationCampaignAnalytics) SetTotalDiscounts(v ApplicationCampaignAnalyticsTotalDiscounts) { +// SetTotalDiscounts gets a reference to the given AnalyticsDataPointWithTrend and assigns it to the TotalDiscounts field. +func (o *ApplicationCampaignAnalytics) SetTotalDiscounts(v AnalyticsDataPointWithTrend) { o.TotalDiscounts = &v } // GetCouponsCount returns the CouponsCount field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalytics) GetCouponsCount() ApplicationCampaignAnalyticsCouponsCount { +func (o *ApplicationCampaignAnalytics) GetCouponsCount() AnalyticsDataPointWithTrend { if o == nil || o.CouponsCount == nil { - var ret ApplicationCampaignAnalyticsCouponsCount + var ret AnalyticsDataPointWithTrend return ret } return *o.CouponsCount @@ -516,9 +303,9 @@ func (o *ApplicationCampaignAnalytics) GetCouponsCount() ApplicationCampaignAnal // GetCouponsCountOk returns a tuple with the CouponsCount field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalytics) GetCouponsCountOk() (ApplicationCampaignAnalyticsCouponsCount, bool) { +func (o *ApplicationCampaignAnalytics) GetCouponsCountOk() (AnalyticsDataPointWithTrend, bool) { if o == nil || o.CouponsCount == nil { - var ret ApplicationCampaignAnalyticsCouponsCount + var ret AnalyticsDataPointWithTrend return ret, false } return *o.CouponsCount, true @@ -533,8 +320,8 @@ func (o *ApplicationCampaignAnalytics) HasCouponsCount() bool { return false } -// SetCouponsCount gets a reference to the given ApplicationCampaignAnalyticsCouponsCount and assigns it to the CouponsCount field. -func (o *ApplicationCampaignAnalytics) SetCouponsCount(v ApplicationCampaignAnalyticsCouponsCount) { +// SetCouponsCount gets a reference to the given AnalyticsDataPointWithTrend and assigns it to the CouponsCount field. +func (o *ApplicationCampaignAnalytics) SetCouponsCount(v AnalyticsDataPointWithTrend) { o.CouponsCount = &v } diff --git a/model_application_campaign_analytics_avg_items_per_session.go b/model_application_campaign_analytics_avg_items_per_session.go deleted file mode 100644 index ec183345..00000000 --- a/model_application_campaign_analytics_avg_items_per_session.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsAvgItemsPerSession The number of items from sessions divided by the number of sessions. The `influenced` value includes only sessions with at least one applied effect. -type ApplicationCampaignAnalyticsAvgItemsPerSession struct { - Value *float32 `json:"value,omitempty"` - Uplift *float32 `json:"uplift,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetValue(v float32) { - o.Value = &v -} - -// GetUplift returns the Uplift field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetUplift() float32 { - if o == nil || o.Uplift == nil { - var ret float32 - return ret - } - return *o.Uplift -} - -// GetUpliftOk returns a tuple with the Uplift field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetUpliftOk() (float32, bool) { - if o == nil || o.Uplift == nil { - var ret float32 - return ret, false - } - return *o.Uplift, true -} - -// HasUplift returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasUplift() bool { - if o != nil && o.Uplift != nil { - return true - } - - return false -} - -// SetUplift gets a reference to the given float32 and assigns it to the Uplift field. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetUplift(v float32) { - o.Uplift = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsAvgItemsPerSession) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsAvgItemsPerSession struct { - Value ApplicationCampaignAnalyticsAvgItemsPerSession - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsAvgItemsPerSession) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsAvgItemsPerSession) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics_avg_session_value.go b/model_application_campaign_analytics_avg_session_value.go deleted file mode 100644 index a91ba6fb..00000000 --- a/model_application_campaign_analytics_avg_session_value.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsAvgSessionValue 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. -type ApplicationCampaignAnalyticsAvgSessionValue struct { - Value *float32 `json:"value,omitempty"` - Uplift *float32 `json:"uplift,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetValue(v float32) { - o.Value = &v -} - -// GetUplift returns the Uplift field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetUplift() float32 { - if o == nil || o.Uplift == nil { - var ret float32 - return ret - } - return *o.Uplift -} - -// GetUpliftOk returns a tuple with the Uplift field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetUpliftOk() (float32, bool) { - if o == nil || o.Uplift == nil { - var ret float32 - return ret, false - } - return *o.Uplift, true -} - -// HasUplift returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasUplift() bool { - if o != nil && o.Uplift != nil { - return true - } - - return false -} - -// SetUplift gets a reference to the given float32 and assigns it to the Uplift field. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetUplift(v float32) { - o.Uplift = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsAvgSessionValue) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsAvgSessionValue struct { - Value ApplicationCampaignAnalyticsAvgSessionValue - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsAvgSessionValue) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsAvgSessionValue) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics_coupons_count.go b/model_application_campaign_analytics_coupons_count.go deleted file mode 100644 index 5af8bbd9..00000000 --- a/model_application_campaign_analytics_coupons_count.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsCouponsCount The number of times a coupon was successfully redeemed in influenced sessions. -type ApplicationCampaignAnalyticsCouponsCount struct { - Value *float32 `json:"value,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsCouponsCount) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsCouponsCount) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsCouponsCount) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsCouponsCount) SetValue(v float32) { - o.Value = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsCouponsCount) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsCouponsCount) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsCouponsCount) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsCouponsCount) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsCouponsCount struct { - Value ApplicationCampaignAnalyticsCouponsCount - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsCouponsCount) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsCouponsCount) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics_sessions_count.go b/model_application_campaign_analytics_sessions_count.go deleted file mode 100644 index a90d4055..00000000 --- a/model_application_campaign_analytics_sessions_count.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsSessionsCount The number of all closed sessions. The `influenced` value includes only sessions with at least one applied effect. -type ApplicationCampaignAnalyticsSessionsCount struct { - Value *float32 `json:"value,omitempty"` - InfluenceRate *float32 `json:"influence_rate,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsSessionsCount) SetValue(v float32) { - o.Value = &v -} - -// GetInfluenceRate returns the InfluenceRate field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetInfluenceRate() float32 { - if o == nil || o.InfluenceRate == nil { - var ret float32 - return ret - } - return *o.InfluenceRate -} - -// GetInfluenceRateOk returns a tuple with the InfluenceRate field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetInfluenceRateOk() (float32, bool) { - if o == nil || o.InfluenceRate == nil { - var ret float32 - return ret, false - } - return *o.InfluenceRate, true -} - -// HasInfluenceRate returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) HasInfluenceRate() bool { - if o != nil && o.InfluenceRate != nil { - return true - } - - return false -} - -// SetInfluenceRate gets a reference to the given float32 and assigns it to the InfluenceRate field. -func (o *ApplicationCampaignAnalyticsSessionsCount) SetInfluenceRate(v float32) { - o.InfluenceRate = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsSessionsCount) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsSessionsCount) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsSessionsCount struct { - Value ApplicationCampaignAnalyticsSessionsCount - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsSessionsCount) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsSessionsCount) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics_total_discounts.go b/model_application_campaign_analytics_total_discounts.go deleted file mode 100644 index b3b983ad..00000000 --- a/model_application_campaign_analytics_total_discounts.go +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsTotalDiscounts The total value of discounts given for cart items in influenced sessions. -type ApplicationCampaignAnalyticsTotalDiscounts struct { - Value *float32 `json:"value,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) SetValue(v float32) { - o.Value = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsTotalDiscounts) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsTotalDiscounts struct { - Value ApplicationCampaignAnalyticsTotalDiscounts - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsTotalDiscounts) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsTotalDiscounts) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_analytics_total_revenue.go b/model_application_campaign_analytics_total_revenue.go deleted file mode 100644 index 594334ed..00000000 --- a/model_application_campaign_analytics_total_revenue.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// ApplicationCampaignAnalyticsTotalRevenue The total, pre-discount value of all items purchased in a customer session. -type ApplicationCampaignAnalyticsTotalRevenue struct { - Value *float32 `json:"value,omitempty"` - InfluenceRate *float32 `json:"influence_rate,omitempty"` - Trend *float32 `json:"trend,omitempty"` -} - -// GetValue returns the Value field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetValue() float32 { - if o == nil || o.Value == nil { - var ret float32 - return ret - } - return *o.Value -} - -// GetValueOk returns a tuple with the Value field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetValueOk() (float32, bool) { - if o == nil || o.Value == nil { - var ret float32 - return ret, false - } - return *o.Value, true -} - -// HasValue returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) HasValue() bool { - if o != nil && o.Value != nil { - return true - } - - return false -} - -// SetValue gets a reference to the given float32 and assigns it to the Value field. -func (o *ApplicationCampaignAnalyticsTotalRevenue) SetValue(v float32) { - o.Value = &v -} - -// GetInfluenceRate returns the InfluenceRate field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetInfluenceRate() float32 { - if o == nil || o.InfluenceRate == nil { - var ret float32 - return ret - } - return *o.InfluenceRate -} - -// GetInfluenceRateOk returns a tuple with the InfluenceRate field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetInfluenceRateOk() (float32, bool) { - if o == nil || o.InfluenceRate == nil { - var ret float32 - return ret, false - } - return *o.InfluenceRate, true -} - -// HasInfluenceRate returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) HasInfluenceRate() bool { - if o != nil && o.InfluenceRate != nil { - return true - } - - return false -} - -// SetInfluenceRate gets a reference to the given float32 and assigns it to the InfluenceRate field. -func (o *ApplicationCampaignAnalyticsTotalRevenue) SetInfluenceRate(v float32) { - o.InfluenceRate = &v -} - -// GetTrend returns the Trend field value if set, zero value otherwise. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetTrend() float32 { - if o == nil || o.Trend == nil { - var ret float32 - return ret - } - return *o.Trend -} - -// GetTrendOk returns a tuple with the Trend field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) GetTrendOk() (float32, bool) { - if o == nil || o.Trend == nil { - var ret float32 - return ret, false - } - return *o.Trend, true -} - -// HasTrend returns a boolean if a field has been set. -func (o *ApplicationCampaignAnalyticsTotalRevenue) HasTrend() bool { - if o != nil && o.Trend != nil { - return true - } - - return false -} - -// SetTrend gets a reference to the given float32 and assigns it to the Trend field. -func (o *ApplicationCampaignAnalyticsTotalRevenue) SetTrend(v float32) { - o.Trend = &v -} - -type NullableApplicationCampaignAnalyticsTotalRevenue struct { - Value ApplicationCampaignAnalyticsTotalRevenue - ExplicitNull bool -} - -func (v NullableApplicationCampaignAnalyticsTotalRevenue) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableApplicationCampaignAnalyticsTotalRevenue) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_application_campaign_stats.go b/model_application_campaign_stats.go index 466bd4d0..a18727b0 100644 --- a/model_application_campaign_stats.go +++ b/model_application_campaign_stats.go @@ -16,8 +16,6 @@ import ( // ApplicationCampaignStats Provides statistics regarding an application's campaigns. type ApplicationCampaignStats struct { - // Number of draft campaigns. - Draft int32 `json:"draft"` // Number of disabled campaigns. Disabled int32 `json:"disabled"` // Number of scheduled campaigns. @@ -30,21 +28,6 @@ type ApplicationCampaignStats struct { Archived int32 `json:"archived"` } -// GetDraft returns the Draft field value -func (o *ApplicationCampaignStats) GetDraft() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Draft -} - -// SetDraft sets field value -func (o *ApplicationCampaignStats) SetDraft(v int32) { - o.Draft = v -} - // GetDisabled returns the Disabled field value func (o *ApplicationCampaignStats) GetDisabled() int32 { if o == nil { diff --git a/model_application_cif.go b/model_application_cif.go new file mode 100644 index 00000000..5c9d8019 --- /dev/null +++ b/model_application_cif.go @@ -0,0 +1,286 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// ApplicationCif +type ApplicationCif struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The name of the Application cart item filter used in API requests. + Name string `json:"name"` + // A short description of the Application cart item filter. + Description *string `json:"description,omitempty"` + // The ID of the expression that the Application cart item filter uses. + ActiveExpressionId *int32 `json:"activeExpressionId,omitempty"` + // The ID of the user who last updated the Application cart item filter. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // The ID of the user who created the Application cart item filter. + CreatedBy *int32 `json:"createdBy,omitempty"` + // Timestamp of the most recent update to the Application cart item filter. + Modified *time.Time `json:"modified,omitempty"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` +} + +// GetId returns the Id field value +func (o *ApplicationCif) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *ApplicationCif) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *ApplicationCif) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *ApplicationCif) SetCreated(v time.Time) { + o.Created = v +} + +// GetName returns the Name field value +func (o *ApplicationCif) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *ApplicationCif) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ApplicationCif) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCif) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ApplicationCif) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ApplicationCif) SetDescription(v string) { + o.Description = &v +} + +// GetActiveExpressionId returns the ActiveExpressionId field value if set, zero value otherwise. +func (o *ApplicationCif) GetActiveExpressionId() int32 { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret + } + return *o.ActiveExpressionId +} + +// GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCif) GetActiveExpressionIdOk() (int32, bool) { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveExpressionId, true +} + +// HasActiveExpressionId returns a boolean if a field has been set. +func (o *ApplicationCif) HasActiveExpressionId() bool { + if o != nil && o.ActiveExpressionId != nil { + return true + } + + return false +} + +// SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. +func (o *ApplicationCif) SetActiveExpressionId(v int32) { + o.ActiveExpressionId = &v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *ApplicationCif) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCif) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *ApplicationCif) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *ApplicationCif) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. +func (o *ApplicationCif) GetCreatedBy() int32 { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret + } + return *o.CreatedBy +} + +// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCif) GetCreatedByOk() (int32, bool) { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret, false + } + return *o.CreatedBy, true +} + +// HasCreatedBy returns a boolean if a field has been set. +func (o *ApplicationCif) HasCreatedBy() bool { + if o != nil && o.CreatedBy != nil { + return true + } + + return false +} + +// SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +func (o *ApplicationCif) SetCreatedBy(v int32) { + o.CreatedBy = &v +} + +// GetModified returns the Modified field value if set, zero value otherwise. +func (o *ApplicationCif) GetModified() time.Time { + if o == nil || o.Modified == nil { + var ret time.Time + return ret + } + return *o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCif) GetModifiedOk() (time.Time, bool) { + if o == nil || o.Modified == nil { + var ret time.Time + return ret, false + } + return *o.Modified, true +} + +// HasModified returns a boolean if a field has been set. +func (o *ApplicationCif) HasModified() bool { + if o != nil && o.Modified != nil { + return true + } + + return false +} + +// SetModified gets a reference to the given time.Time and assigns it to the Modified field. +func (o *ApplicationCif) SetModified(v time.Time) { + o.Modified = &v +} + +// GetApplicationId returns the ApplicationId field value +func (o *ApplicationCif) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *ApplicationCif) SetApplicationId(v int32) { + o.ApplicationId = v +} + +type NullableApplicationCif struct { + Value ApplicationCif + ExplicitNull bool +} + +func (v NullableApplicationCif) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableApplicationCif) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_application_cif_expression.go b/model_application_cif_expression.go new file mode 100644 index 00000000..00dfd306 --- /dev/null +++ b/model_application_cif_expression.go @@ -0,0 +1,199 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// ApplicationCifExpression +type ApplicationCifExpression struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The ID of the Application cart item filter. + CartItemFilterId *int32 `json:"cartItemFilterId,omitempty"` + // The ID of the user who created the Application cart item filter. + CreatedBy *int32 `json:"createdBy,omitempty"` + // Arbitrary additional JSON data associated with the Application cart item filter. + Expression *[]map[string]interface{} `json:"expression,omitempty"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` +} + +// GetId returns the Id field value +func (o *ApplicationCifExpression) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *ApplicationCifExpression) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *ApplicationCifExpression) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *ApplicationCifExpression) SetCreated(v time.Time) { + o.Created = v +} + +// GetCartItemFilterId returns the CartItemFilterId field value if set, zero value otherwise. +func (o *ApplicationCifExpression) GetCartItemFilterId() int32 { + if o == nil || o.CartItemFilterId == nil { + var ret int32 + return ret + } + return *o.CartItemFilterId +} + +// GetCartItemFilterIdOk returns a tuple with the CartItemFilterId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCifExpression) GetCartItemFilterIdOk() (int32, bool) { + if o == nil || o.CartItemFilterId == nil { + var ret int32 + return ret, false + } + return *o.CartItemFilterId, true +} + +// HasCartItemFilterId returns a boolean if a field has been set. +func (o *ApplicationCifExpression) HasCartItemFilterId() bool { + if o != nil && o.CartItemFilterId != nil { + return true + } + + return false +} + +// SetCartItemFilterId gets a reference to the given int32 and assigns it to the CartItemFilterId field. +func (o *ApplicationCifExpression) SetCartItemFilterId(v int32) { + o.CartItemFilterId = &v +} + +// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. +func (o *ApplicationCifExpression) GetCreatedBy() int32 { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret + } + return *o.CreatedBy +} + +// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCifExpression) GetCreatedByOk() (int32, bool) { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret, false + } + return *o.CreatedBy, true +} + +// HasCreatedBy returns a boolean if a field has been set. +func (o *ApplicationCifExpression) HasCreatedBy() bool { + if o != nil && o.CreatedBy != nil { + return true + } + + return false +} + +// SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +func (o *ApplicationCifExpression) SetCreatedBy(v int32) { + o.CreatedBy = &v +} + +// GetExpression returns the Expression field value if set, zero value otherwise. +func (o *ApplicationCifExpression) GetExpression() []map[string]interface{} { + if o == nil || o.Expression == nil { + var ret []map[string]interface{} + return ret + } + return *o.Expression +} + +// GetExpressionOk returns a tuple with the Expression field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ApplicationCifExpression) GetExpressionOk() ([]map[string]interface{}, bool) { + if o == nil || o.Expression == nil { + var ret []map[string]interface{} + return ret, false + } + return *o.Expression, true +} + +// HasExpression returns a boolean if a field has been set. +func (o *ApplicationCifExpression) HasExpression() bool { + if o != nil && o.Expression != nil { + return true + } + + return false +} + +// SetExpression gets a reference to the given []map[string]interface{} and assigns it to the Expression field. +func (o *ApplicationCifExpression) SetExpression(v []map[string]interface{}) { + o.Expression = &v +} + +// GetApplicationId returns the ApplicationId field value +func (o *ApplicationCifExpression) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *ApplicationCifExpression) SetApplicationId(v int32) { + o.ApplicationId = v +} + +type NullableApplicationCifExpression struct { + Value ApplicationCifExpression + ExplicitNull bool +} + +func (v NullableApplicationCifExpression) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableApplicationCifExpression) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_async_coupon_deletion_job_response.go b/model_async_coupon_deletion_job_response.go new file mode 100644 index 00000000..aea61f17 --- /dev/null +++ b/model_async_coupon_deletion_job_response.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// AsyncCouponDeletionJobResponse +type AsyncCouponDeletionJobResponse struct { + // 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. + Id int32 `json:"id"` +} + +// GetId returns the Id field value +func (o *AsyncCouponDeletionJobResponse) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *AsyncCouponDeletionJobResponse) SetId(v int32) { + o.Id = v +} + +type NullableAsyncCouponDeletionJobResponse struct { + Value AsyncCouponDeletionJobResponse + ExplicitNull bool +} + +func (v NullableAsyncCouponDeletionJobResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableAsyncCouponDeletionJobResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_base_campaign_for_notification.go b/model_base_campaign_for_notification.go deleted file mode 100644 index 5143a7af..00000000 --- a/model_base_campaign_for_notification.go +++ /dev/null @@ -1,511 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// BaseCampaignForNotification struct for BaseCampaignForNotification -type BaseCampaignForNotification struct { - // A user-facing name for this campaign. - Name string `json:"name"` - // A detailed description of the campaign. - Description *string `json:"description,omitempty"` - // Timestamp when the campaign will become active. - StartTime *time.Time `json:"startTime,omitempty"` - // Timestamp when the campaign will become inactive. - EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign. - Attributes *map[string]interface{} `json:"attributes,omitempty"` - // A disabled or archived campaign is not evaluated for rules or coupons. - State string `json:"state"` - // [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. - ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` - // A list of tags for the campaign. - Tags []string `json:"tags"` - // The features enabled in this campaign. - Features []string `json:"features"` - CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` - ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. - Limits []LimitConfig `json:"limits"` - // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. - CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` - // The ID of the campaign evaluation group the campaign belongs to. - EvaluationGroupId *int32 `json:"evaluationGroupId,omitempty"` - // The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. - Type *string `json:"type,omitempty"` - // A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - LinkedStoreIds *[]int32 `json:"linkedStoreIds,omitempty"` -} - -// GetName returns the Name field value -func (o *BaseCampaignForNotification) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *BaseCampaignForNotification) SetName(v string) { - o.Name = v -} - -// GetDescription returns the Description field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetDescription() string { - if o == nil || o.Description == nil { - var ret string - return ret - } - return *o.Description -} - -// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetDescriptionOk() (string, bool) { - if o == nil || o.Description == nil { - var ret string - return ret, false - } - return *o.Description, true -} - -// HasDescription returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasDescription() bool { - if o != nil && o.Description != nil { - return true - } - - return false -} - -// SetDescription gets a reference to the given string and assigns it to the Description field. -func (o *BaseCampaignForNotification) SetDescription(v string) { - o.Description = &v -} - -// GetStartTime returns the StartTime field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetStartTime() time.Time { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret - } - return *o.StartTime -} - -// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetStartTimeOk() (time.Time, bool) { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret, false - } - return *o.StartTime, true -} - -// HasStartTime returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasStartTime() bool { - if o != nil && o.StartTime != nil { - return true - } - - return false -} - -// SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. -func (o *BaseCampaignForNotification) SetStartTime(v time.Time) { - o.StartTime = &v -} - -// GetEndTime returns the EndTime field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetEndTime() time.Time { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret - } - return *o.EndTime -} - -// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetEndTimeOk() (time.Time, bool) { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret, false - } - return *o.EndTime, true -} - -// HasEndTime returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasEndTime() bool { - if o != nil && o.EndTime != nil { - return true - } - - return false -} - -// SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. -func (o *BaseCampaignForNotification) SetEndTime(v time.Time) { - o.EndTime = &v -} - -// GetAttributes returns the Attributes field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetAttributes() map[string]interface{} { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret - } - return *o.Attributes -} - -// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetAttributesOk() (map[string]interface{}, bool) { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Attributes, true -} - -// HasAttributes returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasAttributes() bool { - if o != nil && o.Attributes != nil { - return true - } - - return false -} - -// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. -func (o *BaseCampaignForNotification) SetAttributes(v map[string]interface{}) { - o.Attributes = &v -} - -// GetState returns the State field value -func (o *BaseCampaignForNotification) GetState() string { - if o == nil { - var ret string - return ret - } - - return o.State -} - -// SetState sets field value -func (o *BaseCampaignForNotification) SetState(v string) { - o.State = v -} - -// GetActiveRulesetId returns the ActiveRulesetId field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetActiveRulesetId() int32 { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret - } - return *o.ActiveRulesetId -} - -// GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetActiveRulesetIdOk() (int32, bool) { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret, false - } - return *o.ActiveRulesetId, true -} - -// HasActiveRulesetId returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasActiveRulesetId() bool { - if o != nil && o.ActiveRulesetId != nil { - return true - } - - return false -} - -// SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. -func (o *BaseCampaignForNotification) SetActiveRulesetId(v int32) { - o.ActiveRulesetId = &v -} - -// GetTags returns the Tags field value -func (o *BaseCampaignForNotification) GetTags() []string { - if o == nil { - var ret []string - return ret - } - - return o.Tags -} - -// SetTags sets field value -func (o *BaseCampaignForNotification) SetTags(v []string) { - o.Tags = v -} - -// GetFeatures returns the Features field value -func (o *BaseCampaignForNotification) GetFeatures() []string { - if o == nil { - var ret []string - return ret - } - - return o.Features -} - -// SetFeatures sets field value -func (o *BaseCampaignForNotification) SetFeatures(v []string) { - o.Features = v -} - -// GetCouponSettings returns the CouponSettings field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetCouponSettings() CodeGeneratorSettings { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.CouponSettings -} - -// GetCouponSettingsOk returns a tuple with the CouponSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.CouponSettings, true -} - -// HasCouponSettings returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasCouponSettings() bool { - if o != nil && o.CouponSettings != nil { - return true - } - - return false -} - -// SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. -func (o *BaseCampaignForNotification) SetCouponSettings(v CodeGeneratorSettings) { - o.CouponSettings = &v -} - -// GetReferralSettings returns the ReferralSettings field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetReferralSettings() CodeGeneratorSettings { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.ReferralSettings -} - -// GetReferralSettingsOk returns a tuple with the ReferralSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.ReferralSettings, true -} - -// HasReferralSettings returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasReferralSettings() bool { - if o != nil && o.ReferralSettings != nil { - return true - } - - return false -} - -// SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. -func (o *BaseCampaignForNotification) SetReferralSettings(v CodeGeneratorSettings) { - o.ReferralSettings = &v -} - -// GetLimits returns the Limits field value -func (o *BaseCampaignForNotification) GetLimits() []LimitConfig { - if o == nil { - var ret []LimitConfig - return ret - } - - return o.Limits -} - -// SetLimits sets field value -func (o *BaseCampaignForNotification) SetLimits(v []LimitConfig) { - o.Limits = v -} - -// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetCampaignGroups() []int32 { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret - } - return *o.CampaignGroups -} - -// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetCampaignGroupsOk() ([]int32, bool) { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret, false - } - return *o.CampaignGroups, true -} - -// HasCampaignGroups returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasCampaignGroups() bool { - if o != nil && o.CampaignGroups != nil { - return true - } - - return false -} - -// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. -func (o *BaseCampaignForNotification) SetCampaignGroups(v []int32) { - o.CampaignGroups = &v -} - -// GetEvaluationGroupId returns the EvaluationGroupId field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetEvaluationGroupId() int32 { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret - } - return *o.EvaluationGroupId -} - -// GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetEvaluationGroupIdOk() (int32, bool) { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret, false - } - return *o.EvaluationGroupId, true -} - -// HasEvaluationGroupId returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasEvaluationGroupId() bool { - if o != nil && o.EvaluationGroupId != nil { - return true - } - - return false -} - -// SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. -func (o *BaseCampaignForNotification) SetEvaluationGroupId(v int32) { - o.EvaluationGroupId = &v -} - -// GetType returns the Type field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetType() string { - if o == nil || o.Type == nil { - var ret string - return ret - } - return *o.Type -} - -// GetTypeOk returns a tuple with the Type field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetTypeOk() (string, bool) { - if o == nil || o.Type == nil { - var ret string - return ret, false - } - return *o.Type, true -} - -// HasType returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasType() bool { - if o != nil && o.Type != nil { - return true - } - - return false -} - -// SetType gets a reference to the given string and assigns it to the Type field. -func (o *BaseCampaignForNotification) SetType(v string) { - o.Type = &v -} - -// GetLinkedStoreIds returns the LinkedStoreIds field value if set, zero value otherwise. -func (o *BaseCampaignForNotification) GetLinkedStoreIds() []int32 { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret - } - return *o.LinkedStoreIds -} - -// GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *BaseCampaignForNotification) GetLinkedStoreIdsOk() ([]int32, bool) { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret, false - } - return *o.LinkedStoreIds, true -} - -// HasLinkedStoreIds returns a boolean if a field has been set. -func (o *BaseCampaignForNotification) HasLinkedStoreIds() bool { - if o != nil && o.LinkedStoreIds != nil { - return true - } - - return false -} - -// SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. -func (o *BaseCampaignForNotification) SetLinkedStoreIds(v []int32) { - o.LinkedStoreIds = &v -} - -type NullableBaseCampaignForNotification struct { - Value BaseCampaignForNotification - ExplicitNull bool -} - -func (v NullableBaseCampaignForNotification) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableBaseCampaignForNotification) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_base_loyalty_program.go b/model_base_loyalty_program.go index e69634bb..be9ecdc6 100644 --- a/model_base_loyalty_program.go +++ b/model_base_loyalty_program.go @@ -12,6 +12,7 @@ package talon import ( "bytes" "encoding/json" + "time" ) // BaseLoyaltyProgram struct for BaseLoyaltyProgram @@ -32,14 +33,17 @@ type BaseLoyaltyProgram struct { UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // 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. Sandbox *bool `json:"sandbox,omitempty"` - // 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. - TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` - // 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. - TiersExpireIn *string `json:"tiersExpireIn,omitempty"` - // 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. - TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` // 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. ProgramJoinPolicy *string `json:"programJoinPolicy,omitempty"` + // 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`. + TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` + // 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`. + TierCycleStartDate *time.Time `json:"tierCycleStartDate,omitempty"` + // 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. + TiersExpireIn *string `json:"tiersExpireIn,omitempty"` + // 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. + TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` + CardCodeSettings *CodeGeneratorSettings `json:"cardCodeSettings,omitempty"` } // GetTitle returns the Title field value if set, zero value otherwise. @@ -306,6 +310,39 @@ func (o *BaseLoyaltyProgram) SetSandbox(v bool) { o.Sandbox = &v } +// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. +func (o *BaseLoyaltyProgram) GetProgramJoinPolicy() string { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret + } + return *o.ProgramJoinPolicy +} + +// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *BaseLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret, false + } + return *o.ProgramJoinPolicy, true +} + +// HasProgramJoinPolicy returns a boolean if a field has been set. +func (o *BaseLoyaltyProgram) HasProgramJoinPolicy() bool { + if o != nil && o.ProgramJoinPolicy != nil { + return true + } + + return false +} + +// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +func (o *BaseLoyaltyProgram) SetProgramJoinPolicy(v string) { + o.ProgramJoinPolicy = &v +} + // GetTiersExpirationPolicy returns the TiersExpirationPolicy field value if set, zero value otherwise. func (o *BaseLoyaltyProgram) GetTiersExpirationPolicy() string { if o == nil || o.TiersExpirationPolicy == nil { @@ -339,6 +376,39 @@ func (o *BaseLoyaltyProgram) SetTiersExpirationPolicy(v string) { o.TiersExpirationPolicy = &v } +// GetTierCycleStartDate returns the TierCycleStartDate field value if set, zero value otherwise. +func (o *BaseLoyaltyProgram) GetTierCycleStartDate() time.Time { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret + } + return *o.TierCycleStartDate +} + +// GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *BaseLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool) { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret, false + } + return *o.TierCycleStartDate, true +} + +// HasTierCycleStartDate returns a boolean if a field has been set. +func (o *BaseLoyaltyProgram) HasTierCycleStartDate() bool { + if o != nil && o.TierCycleStartDate != nil { + return true + } + + return false +} + +// SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. +func (o *BaseLoyaltyProgram) SetTierCycleStartDate(v time.Time) { + o.TierCycleStartDate = &v +} + // GetTiersExpireIn returns the TiersExpireIn field value if set, zero value otherwise. func (o *BaseLoyaltyProgram) GetTiersExpireIn() string { if o == nil || o.TiersExpireIn == nil { @@ -405,37 +475,37 @@ func (o *BaseLoyaltyProgram) SetTiersDowngradePolicy(v string) { o.TiersDowngradePolicy = &v } -// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. -func (o *BaseLoyaltyProgram) GetProgramJoinPolicy() string { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +// GetCardCodeSettings returns the CardCodeSettings field value if set, zero value otherwise. +func (o *BaseLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret } - return *o.ProgramJoinPolicy + return *o.CardCodeSettings } -// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *BaseLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +func (o *BaseLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret, false } - return *o.ProgramJoinPolicy, true + return *o.CardCodeSettings, true } -// HasProgramJoinPolicy returns a boolean if a field has been set. -func (o *BaseLoyaltyProgram) HasProgramJoinPolicy() bool { - if o != nil && o.ProgramJoinPolicy != nil { +// HasCardCodeSettings returns a boolean if a field has been set. +func (o *BaseLoyaltyProgram) HasCardCodeSettings() bool { + if o != nil && o.CardCodeSettings != nil { return true } return false } -// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. -func (o *BaseLoyaltyProgram) SetProgramJoinPolicy(v string) { - o.ProgramJoinPolicy = &v +// SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. +func (o *BaseLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings) { + o.CardCodeSettings = &v } type NullableBaseLoyaltyProgram struct { diff --git a/model_base_notification.go b/model_base_notification.go index d4b138ca..99681efc 100644 --- a/model_base_notification.go +++ b/model_base_notification.go @@ -16,6 +16,7 @@ import ( // BaseNotification type BaseNotification struct { + // Indicates which notification properties to apply. Policy map[string]interface{} `json:"policy"` // Indicates whether the notification is activated. Enabled *bool `json:"enabled,omitempty"` diff --git a/model_base_notification_entity.go b/model_base_notification_entity.go index f7278809..33526799 100644 --- a/model_base_notification_entity.go +++ b/model_base_notification_entity.go @@ -16,6 +16,7 @@ import ( // BaseNotificationEntity struct for BaseNotificationEntity type BaseNotificationEntity struct { + // Indicates which notification properties to apply. Policy map[string]interface{} `json:"policy"` // Indicates whether the notification is activated. Enabled *bool `json:"enabled,omitempty"` diff --git a/model_binding.go b/model_binding.go index 2449ece1..7f2e64ec 100644 --- a/model_binding.go +++ b/model_binding.go @@ -21,7 +21,7 @@ type Binding struct { // The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` Type *string `json:"type,omitempty"` // A Talang expression that will be evaluated and its result attached to the name of the binding. - Expression []interface{} `json:"expression"` + Expression []map[string]interface{} `json:"expression"` // Can be one of the following: - `string` - `number` - `boolean` ValueType *string `json:"valueType,omitempty"` } @@ -75,9 +75,9 @@ func (o *Binding) SetType(v string) { } // GetExpression returns the Expression field value -func (o *Binding) GetExpression() []interface{} { +func (o *Binding) GetExpression() []map[string]interface{} { if o == nil { - var ret []interface{} + var ret []map[string]interface{} return ret } @@ -85,7 +85,7 @@ func (o *Binding) GetExpression() []interface{} { } // SetExpression sets field value -func (o *Binding) SetExpression(v []interface{}) { +func (o *Binding) SetExpression(v []map[string]interface{}) { o.Expression = v } diff --git a/model_campaign.go b/model_campaign.go index c4c5f777..1e339724 100644 --- a/model_campaign.go +++ b/model_campaign.go @@ -97,6 +97,20 @@ type Campaign struct { TemplateId *int32 `json:"templateId,omitempty"` // A campaign state described exactly as in the Campaign Manager. FrontendState string `json:"frontendState"` + // Indicates whether the linked stores were imported via a CSV file. + StoresImported bool `json:"storesImported"` + // ID of the revision that was last activated on this campaign. + ActiveRevisionId *int32 `json:"activeRevisionId,omitempty"` + // ID of the revision version that is active on the campaign. + ActiveRevisionVersionId *int32 `json:"activeRevisionVersionId,omitempty"` + // Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. + Version *int32 `json:"version,omitempty"` + // ID of the revision currently being modified for the campaign. + CurrentRevisionId *int32 `json:"currentRevisionId,omitempty"` + // ID of the latest version applied on the current revision. + CurrentRevisionVersionId *int32 `json:"currentRevisionVersionId,omitempty"` + // Flag for determining whether we use current revision when sending requests with staging API key. + StageRevision *bool `json:"stageRevision,omitempty"` } // GetId returns the Id field value @@ -1218,6 +1232,219 @@ func (o *Campaign) SetFrontendState(v string) { o.FrontendState = v } +// GetStoresImported returns the StoresImported field value +func (o *Campaign) GetStoresImported() bool { + if o == nil { + var ret bool + return ret + } + + return o.StoresImported +} + +// SetStoresImported sets field value +func (o *Campaign) SetStoresImported(v bool) { + o.StoresImported = v +} + +// GetActiveRevisionId returns the ActiveRevisionId field value if set, zero value otherwise. +func (o *Campaign) GetActiveRevisionId() int32 { + if o == nil || o.ActiveRevisionId == nil { + var ret int32 + return ret + } + return *o.ActiveRevisionId +} + +// GetActiveRevisionIdOk returns a tuple with the ActiveRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetActiveRevisionIdOk() (int32, bool) { + if o == nil || o.ActiveRevisionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveRevisionId, true +} + +// HasActiveRevisionId returns a boolean if a field has been set. +func (o *Campaign) HasActiveRevisionId() bool { + if o != nil && o.ActiveRevisionId != nil { + return true + } + + return false +} + +// SetActiveRevisionId gets a reference to the given int32 and assigns it to the ActiveRevisionId field. +func (o *Campaign) SetActiveRevisionId(v int32) { + o.ActiveRevisionId = &v +} + +// GetActiveRevisionVersionId returns the ActiveRevisionVersionId field value if set, zero value otherwise. +func (o *Campaign) GetActiveRevisionVersionId() int32 { + if o == nil || o.ActiveRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.ActiveRevisionVersionId +} + +// GetActiveRevisionVersionIdOk returns a tuple with the ActiveRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetActiveRevisionVersionIdOk() (int32, bool) { + if o == nil || o.ActiveRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveRevisionVersionId, true +} + +// HasActiveRevisionVersionId returns a boolean if a field has been set. +func (o *Campaign) HasActiveRevisionVersionId() bool { + if o != nil && o.ActiveRevisionVersionId != nil { + return true + } + + return false +} + +// SetActiveRevisionVersionId gets a reference to the given int32 and assigns it to the ActiveRevisionVersionId field. +func (o *Campaign) SetActiveRevisionVersionId(v int32) { + o.ActiveRevisionVersionId = &v +} + +// GetVersion returns the Version field value if set, zero value otherwise. +func (o *Campaign) GetVersion() int32 { + if o == nil || o.Version == nil { + var ret int32 + return ret + } + return *o.Version +} + +// GetVersionOk returns a tuple with the Version field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetVersionOk() (int32, bool) { + if o == nil || o.Version == nil { + var ret int32 + return ret, false + } + return *o.Version, true +} + +// HasVersion returns a boolean if a field has been set. +func (o *Campaign) HasVersion() bool { + if o != nil && o.Version != nil { + return true + } + + return false +} + +// SetVersion gets a reference to the given int32 and assigns it to the Version field. +func (o *Campaign) SetVersion(v int32) { + o.Version = &v +} + +// GetCurrentRevisionId returns the CurrentRevisionId field value if set, zero value otherwise. +func (o *Campaign) GetCurrentRevisionId() int32 { + if o == nil || o.CurrentRevisionId == nil { + var ret int32 + return ret + } + return *o.CurrentRevisionId +} + +// GetCurrentRevisionIdOk returns a tuple with the CurrentRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetCurrentRevisionIdOk() (int32, bool) { + if o == nil || o.CurrentRevisionId == nil { + var ret int32 + return ret, false + } + return *o.CurrentRevisionId, true +} + +// HasCurrentRevisionId returns a boolean if a field has been set. +func (o *Campaign) HasCurrentRevisionId() bool { + if o != nil && o.CurrentRevisionId != nil { + return true + } + + return false +} + +// SetCurrentRevisionId gets a reference to the given int32 and assigns it to the CurrentRevisionId field. +func (o *Campaign) SetCurrentRevisionId(v int32) { + o.CurrentRevisionId = &v +} + +// GetCurrentRevisionVersionId returns the CurrentRevisionVersionId field value if set, zero value otherwise. +func (o *Campaign) GetCurrentRevisionVersionId() int32 { + if o == nil || o.CurrentRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.CurrentRevisionVersionId +} + +// GetCurrentRevisionVersionIdOk returns a tuple with the CurrentRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetCurrentRevisionVersionIdOk() (int32, bool) { + if o == nil || o.CurrentRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.CurrentRevisionVersionId, true +} + +// HasCurrentRevisionVersionId returns a boolean if a field has been set. +func (o *Campaign) HasCurrentRevisionVersionId() bool { + if o != nil && o.CurrentRevisionVersionId != nil { + return true + } + + return false +} + +// SetCurrentRevisionVersionId gets a reference to the given int32 and assigns it to the CurrentRevisionVersionId field. +func (o *Campaign) SetCurrentRevisionVersionId(v int32) { + o.CurrentRevisionVersionId = &v +} + +// GetStageRevision returns the StageRevision field value if set, zero value otherwise. +func (o *Campaign) GetStageRevision() bool { + if o == nil || o.StageRevision == nil { + var ret bool + return ret + } + return *o.StageRevision +} + +// GetStageRevisionOk returns a tuple with the StageRevision field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Campaign) GetStageRevisionOk() (bool, bool) { + if o == nil || o.StageRevision == nil { + var ret bool + return ret, false + } + return *o.StageRevision, true +} + +// HasStageRevision returns a boolean if a field has been set. +func (o *Campaign) HasStageRevision() bool { + if o != nil && o.StageRevision != nil { + return true + } + + return false +} + +// SetStageRevision gets a reference to the given bool and assigns it to the StageRevision field. +func (o *Campaign) SetStageRevision(v bool) { + o.StageRevision = &v +} + type NullableCampaign struct { Value Campaign ExplicitNull bool diff --git a/model_campaign_collection_edited_notification.go b/model_campaign_collection_edited_notification.go new file mode 100644 index 00000000..f88cd9cd --- /dev/null +++ b/model_campaign_collection_edited_notification.go @@ -0,0 +1,108 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignCollectionEditedNotification A notification regarding a collection that was edited. +type CampaignCollectionEditedNotification struct { + Campaign Campaign `json:"campaign"` + Ruleset *Ruleset `json:"ruleset,omitempty"` + Collection CollectionWithoutPayload `json:"collection"` +} + +// GetCampaign returns the Campaign field value +func (o *CampaignCollectionEditedNotification) GetCampaign() Campaign { + if o == nil { + var ret Campaign + return ret + } + + return o.Campaign +} + +// SetCampaign sets field value +func (o *CampaignCollectionEditedNotification) SetCampaign(v Campaign) { + o.Campaign = v +} + +// GetRuleset returns the Ruleset field value if set, zero value otherwise. +func (o *CampaignCollectionEditedNotification) GetRuleset() Ruleset { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret + } + return *o.Ruleset +} + +// GetRulesetOk returns a tuple with the Ruleset field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignCollectionEditedNotification) GetRulesetOk() (Ruleset, bool) { + if o == nil || o.Ruleset == nil { + var ret Ruleset + return ret, false + } + return *o.Ruleset, true +} + +// HasRuleset returns a boolean if a field has been set. +func (o *CampaignCollectionEditedNotification) HasRuleset() bool { + if o != nil && o.Ruleset != nil { + return true + } + + return false +} + +// SetRuleset gets a reference to the given Ruleset and assigns it to the Ruleset field. +func (o *CampaignCollectionEditedNotification) SetRuleset(v Ruleset) { + o.Ruleset = &v +} + +// GetCollection returns the Collection field value +func (o *CampaignCollectionEditedNotification) GetCollection() CollectionWithoutPayload { + if o == nil { + var ret CollectionWithoutPayload + return ret + } + + return o.Collection +} + +// SetCollection sets field value +func (o *CampaignCollectionEditedNotification) SetCollection(v CollectionWithoutPayload) { + o.Collection = v +} + +type NullableCampaignCollectionEditedNotification struct { + Value CampaignCollectionEditedNotification + ExplicitNull bool +} + +func (v NullableCampaignCollectionEditedNotification) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignCollectionEditedNotification) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_for_notification.go b/model_campaign_for_notification.go deleted file mode 100644 index 4ec1945b..00000000 --- a/model_campaign_for_notification.go +++ /dev/null @@ -1,1260 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// CampaignForNotification -type CampaignForNotification struct { - // Unique ID for this entity. - Id int32 `json:"id"` - // The exact moment this entity was created. - Created time.Time `json:"created"` - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // The ID of the user associated with this entity. - UserId int32 `json:"userId"` - // A user-facing name for this campaign. - Name string `json:"name"` - // A detailed description of the campaign. - Description string `json:"description"` - // Timestamp when the campaign will become active. - StartTime *time.Time `json:"startTime,omitempty"` - // Timestamp when the campaign will become inactive. - EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign. - Attributes *map[string]interface{} `json:"attributes,omitempty"` - // A disabled or archived campaign is not evaluated for rules or coupons. - State string `json:"state"` - // [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. - ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` - // A list of tags for the campaign. - Tags []string `json:"tags"` - // The features enabled in this campaign. - Features []string `json:"features"` - CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` - ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. - Limits []LimitConfig `json:"limits"` - // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. - CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` - // The ID of the campaign evaluation group the campaign belongs to. - EvaluationGroupId *int32 `json:"evaluationGroupId,omitempty"` - // The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. - Type string `json:"type"` - // A list of store IDs that are linked to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - LinkedStoreIds *[]int32 `json:"linkedStoreIds,omitempty"` - // 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. - Budgets []CampaignBudget `json:"budgets"` - // This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. - CouponRedemptionCount *int32 `json:"couponRedemptionCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. - ReferralRedemptionCount *int32 `json:"referralRedemptionCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. - DiscountCount *float32 `json:"discountCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. - DiscountEffectCount *int32 `json:"discountEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. - CouponCreationCount *int32 `json:"couponCreationCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. - CustomEffectCount *int32 `json:"customEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. - ReferralCreationCount *int32 `json:"referralCreationCount,omitempty"` - // 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. - AddFreeItemEffectCount *int32 `json:"addFreeItemEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. - AwardedGiveawaysCount *int32 `json:"awardedGiveawaysCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. - CreatedLoyaltyPointsCount *float32 `json:"createdLoyaltyPointsCount,omitempty"` - // 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. - CreatedLoyaltyPointsEffectCount *int32 `json:"createdLoyaltyPointsEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. - RedeemedLoyaltyPointsCount *float32 `json:"redeemedLoyaltyPointsCount,omitempty"` - // 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. - RedeemedLoyaltyPointsEffectCount *int32 `json:"redeemedLoyaltyPointsEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. - CallApiEffectCount *int32 `json:"callApiEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. - ReservecouponEffectCount *int32 `json:"reservecouponEffectCount,omitempty"` - // Timestamp of the most recent event received by this campaign. - LastActivity *time.Time `json:"lastActivity,omitempty"` - // Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. - Updated *time.Time `json:"updated,omitempty"` - // Name of the user who created this campaign if available. - CreatedBy *string `json:"createdBy,omitempty"` - // Name of the user who last updated this campaign if available. - UpdatedBy *string `json:"updatedBy,omitempty"` - // The ID of the Campaign Template this Campaign was created from. - TemplateId *int32 `json:"templateId,omitempty"` -} - -// GetId returns the Id field value -func (o *CampaignForNotification) GetId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Id -} - -// SetId sets field value -func (o *CampaignForNotification) SetId(v int32) { - o.Id = v -} - -// GetCreated returns the Created field value -func (o *CampaignForNotification) GetCreated() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Created -} - -// SetCreated sets field value -func (o *CampaignForNotification) SetCreated(v time.Time) { - o.Created = v -} - -// GetApplicationId returns the ApplicationId field value -func (o *CampaignForNotification) GetApplicationId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ApplicationId -} - -// SetApplicationId sets field value -func (o *CampaignForNotification) SetApplicationId(v int32) { - o.ApplicationId = v -} - -// GetUserId returns the UserId field value -func (o *CampaignForNotification) GetUserId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.UserId -} - -// SetUserId sets field value -func (o *CampaignForNotification) SetUserId(v int32) { - o.UserId = v -} - -// GetName returns the Name field value -func (o *CampaignForNotification) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *CampaignForNotification) SetName(v string) { - o.Name = v -} - -// GetDescription returns the Description field value -func (o *CampaignForNotification) GetDescription() string { - if o == nil { - var ret string - return ret - } - - return o.Description -} - -// SetDescription sets field value -func (o *CampaignForNotification) SetDescription(v string) { - o.Description = v -} - -// GetStartTime returns the StartTime field value if set, zero value otherwise. -func (o *CampaignForNotification) GetStartTime() time.Time { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret - } - return *o.StartTime -} - -// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetStartTimeOk() (time.Time, bool) { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret, false - } - return *o.StartTime, true -} - -// HasStartTime returns a boolean if a field has been set. -func (o *CampaignForNotification) HasStartTime() bool { - if o != nil && o.StartTime != nil { - return true - } - - return false -} - -// SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. -func (o *CampaignForNotification) SetStartTime(v time.Time) { - o.StartTime = &v -} - -// GetEndTime returns the EndTime field value if set, zero value otherwise. -func (o *CampaignForNotification) GetEndTime() time.Time { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret - } - return *o.EndTime -} - -// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetEndTimeOk() (time.Time, bool) { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret, false - } - return *o.EndTime, true -} - -// HasEndTime returns a boolean if a field has been set. -func (o *CampaignForNotification) HasEndTime() bool { - if o != nil && o.EndTime != nil { - return true - } - - return false -} - -// SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. -func (o *CampaignForNotification) SetEndTime(v time.Time) { - o.EndTime = &v -} - -// GetAttributes returns the Attributes field value if set, zero value otherwise. -func (o *CampaignForNotification) GetAttributes() map[string]interface{} { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret - } - return *o.Attributes -} - -// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetAttributesOk() (map[string]interface{}, bool) { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Attributes, true -} - -// HasAttributes returns a boolean if a field has been set. -func (o *CampaignForNotification) HasAttributes() bool { - if o != nil && o.Attributes != nil { - return true - } - - return false -} - -// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. -func (o *CampaignForNotification) SetAttributes(v map[string]interface{}) { - o.Attributes = &v -} - -// GetState returns the State field value -func (o *CampaignForNotification) GetState() string { - if o == nil { - var ret string - return ret - } - - return o.State -} - -// SetState sets field value -func (o *CampaignForNotification) SetState(v string) { - o.State = v -} - -// GetActiveRulesetId returns the ActiveRulesetId field value if set, zero value otherwise. -func (o *CampaignForNotification) GetActiveRulesetId() int32 { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret - } - return *o.ActiveRulesetId -} - -// GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetActiveRulesetIdOk() (int32, bool) { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret, false - } - return *o.ActiveRulesetId, true -} - -// HasActiveRulesetId returns a boolean if a field has been set. -func (o *CampaignForNotification) HasActiveRulesetId() bool { - if o != nil && o.ActiveRulesetId != nil { - return true - } - - return false -} - -// SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. -func (o *CampaignForNotification) SetActiveRulesetId(v int32) { - o.ActiveRulesetId = &v -} - -// GetTags returns the Tags field value -func (o *CampaignForNotification) GetTags() []string { - if o == nil { - var ret []string - return ret - } - - return o.Tags -} - -// SetTags sets field value -func (o *CampaignForNotification) SetTags(v []string) { - o.Tags = v -} - -// GetFeatures returns the Features field value -func (o *CampaignForNotification) GetFeatures() []string { - if o == nil { - var ret []string - return ret - } - - return o.Features -} - -// SetFeatures sets field value -func (o *CampaignForNotification) SetFeatures(v []string) { - o.Features = v -} - -// GetCouponSettings returns the CouponSettings field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCouponSettings() CodeGeneratorSettings { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.CouponSettings -} - -// GetCouponSettingsOk returns a tuple with the CouponSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.CouponSettings, true -} - -// HasCouponSettings returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCouponSettings() bool { - if o != nil && o.CouponSettings != nil { - return true - } - - return false -} - -// SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. -func (o *CampaignForNotification) SetCouponSettings(v CodeGeneratorSettings) { - o.CouponSettings = &v -} - -// GetReferralSettings returns the ReferralSettings field value if set, zero value otherwise. -func (o *CampaignForNotification) GetReferralSettings() CodeGeneratorSettings { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.ReferralSettings -} - -// GetReferralSettingsOk returns a tuple with the ReferralSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.ReferralSettings, true -} - -// HasReferralSettings returns a boolean if a field has been set. -func (o *CampaignForNotification) HasReferralSettings() bool { - if o != nil && o.ReferralSettings != nil { - return true - } - - return false -} - -// SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. -func (o *CampaignForNotification) SetReferralSettings(v CodeGeneratorSettings) { - o.ReferralSettings = &v -} - -// GetLimits returns the Limits field value -func (o *CampaignForNotification) GetLimits() []LimitConfig { - if o == nil { - var ret []LimitConfig - return ret - } - - return o.Limits -} - -// SetLimits sets field value -func (o *CampaignForNotification) SetLimits(v []LimitConfig) { - o.Limits = v -} - -// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCampaignGroups() []int32 { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret - } - return *o.CampaignGroups -} - -// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCampaignGroupsOk() ([]int32, bool) { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret, false - } - return *o.CampaignGroups, true -} - -// HasCampaignGroups returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCampaignGroups() bool { - if o != nil && o.CampaignGroups != nil { - return true - } - - return false -} - -// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. -func (o *CampaignForNotification) SetCampaignGroups(v []int32) { - o.CampaignGroups = &v -} - -// GetEvaluationGroupId returns the EvaluationGroupId field value if set, zero value otherwise. -func (o *CampaignForNotification) GetEvaluationGroupId() int32 { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret - } - return *o.EvaluationGroupId -} - -// GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetEvaluationGroupIdOk() (int32, bool) { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret, false - } - return *o.EvaluationGroupId, true -} - -// HasEvaluationGroupId returns a boolean if a field has been set. -func (o *CampaignForNotification) HasEvaluationGroupId() bool { - if o != nil && o.EvaluationGroupId != nil { - return true - } - - return false -} - -// SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. -func (o *CampaignForNotification) SetEvaluationGroupId(v int32) { - o.EvaluationGroupId = &v -} - -// GetType returns the Type field value -func (o *CampaignForNotification) GetType() string { - if o == nil { - var ret string - return ret - } - - return o.Type -} - -// SetType sets field value -func (o *CampaignForNotification) SetType(v string) { - o.Type = v -} - -// GetLinkedStoreIds returns the LinkedStoreIds field value if set, zero value otherwise. -func (o *CampaignForNotification) GetLinkedStoreIds() []int32 { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret - } - return *o.LinkedStoreIds -} - -// GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetLinkedStoreIdsOk() ([]int32, bool) { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret, false - } - return *o.LinkedStoreIds, true -} - -// HasLinkedStoreIds returns a boolean if a field has been set. -func (o *CampaignForNotification) HasLinkedStoreIds() bool { - if o != nil && o.LinkedStoreIds != nil { - return true - } - - return false -} - -// SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. -func (o *CampaignForNotification) SetLinkedStoreIds(v []int32) { - o.LinkedStoreIds = &v -} - -// GetBudgets returns the Budgets field value -func (o *CampaignForNotification) GetBudgets() []CampaignBudget { - if o == nil { - var ret []CampaignBudget - return ret - } - - return o.Budgets -} - -// SetBudgets sets field value -func (o *CampaignForNotification) SetBudgets(v []CampaignBudget) { - o.Budgets = v -} - -// GetCouponRedemptionCount returns the CouponRedemptionCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCouponRedemptionCount() int32 { - if o == nil || o.CouponRedemptionCount == nil { - var ret int32 - return ret - } - return *o.CouponRedemptionCount -} - -// GetCouponRedemptionCountOk returns a tuple with the CouponRedemptionCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCouponRedemptionCountOk() (int32, bool) { - if o == nil || o.CouponRedemptionCount == nil { - var ret int32 - return ret, false - } - return *o.CouponRedemptionCount, true -} - -// HasCouponRedemptionCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCouponRedemptionCount() bool { - if o != nil && o.CouponRedemptionCount != nil { - return true - } - - return false -} - -// SetCouponRedemptionCount gets a reference to the given int32 and assigns it to the CouponRedemptionCount field. -func (o *CampaignForNotification) SetCouponRedemptionCount(v int32) { - o.CouponRedemptionCount = &v -} - -// GetReferralRedemptionCount returns the ReferralRedemptionCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetReferralRedemptionCount() int32 { - if o == nil || o.ReferralRedemptionCount == nil { - var ret int32 - return ret - } - return *o.ReferralRedemptionCount -} - -// GetReferralRedemptionCountOk returns a tuple with the ReferralRedemptionCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetReferralRedemptionCountOk() (int32, bool) { - if o == nil || o.ReferralRedemptionCount == nil { - var ret int32 - return ret, false - } - return *o.ReferralRedemptionCount, true -} - -// HasReferralRedemptionCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasReferralRedemptionCount() bool { - if o != nil && o.ReferralRedemptionCount != nil { - return true - } - - return false -} - -// SetReferralRedemptionCount gets a reference to the given int32 and assigns it to the ReferralRedemptionCount field. -func (o *CampaignForNotification) SetReferralRedemptionCount(v int32) { - o.ReferralRedemptionCount = &v -} - -// GetDiscountCount returns the DiscountCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetDiscountCount() float32 { - if o == nil || o.DiscountCount == nil { - var ret float32 - return ret - } - return *o.DiscountCount -} - -// GetDiscountCountOk returns a tuple with the DiscountCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetDiscountCountOk() (float32, bool) { - if o == nil || o.DiscountCount == nil { - var ret float32 - return ret, false - } - return *o.DiscountCount, true -} - -// HasDiscountCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasDiscountCount() bool { - if o != nil && o.DiscountCount != nil { - return true - } - - return false -} - -// SetDiscountCount gets a reference to the given float32 and assigns it to the DiscountCount field. -func (o *CampaignForNotification) SetDiscountCount(v float32) { - o.DiscountCount = &v -} - -// GetDiscountEffectCount returns the DiscountEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetDiscountEffectCount() int32 { - if o == nil || o.DiscountEffectCount == nil { - var ret int32 - return ret - } - return *o.DiscountEffectCount -} - -// GetDiscountEffectCountOk returns a tuple with the DiscountEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetDiscountEffectCountOk() (int32, bool) { - if o == nil || o.DiscountEffectCount == nil { - var ret int32 - return ret, false - } - return *o.DiscountEffectCount, true -} - -// HasDiscountEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasDiscountEffectCount() bool { - if o != nil && o.DiscountEffectCount != nil { - return true - } - - return false -} - -// SetDiscountEffectCount gets a reference to the given int32 and assigns it to the DiscountEffectCount field. -func (o *CampaignForNotification) SetDiscountEffectCount(v int32) { - o.DiscountEffectCount = &v -} - -// GetCouponCreationCount returns the CouponCreationCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCouponCreationCount() int32 { - if o == nil || o.CouponCreationCount == nil { - var ret int32 - return ret - } - return *o.CouponCreationCount -} - -// GetCouponCreationCountOk returns a tuple with the CouponCreationCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCouponCreationCountOk() (int32, bool) { - if o == nil || o.CouponCreationCount == nil { - var ret int32 - return ret, false - } - return *o.CouponCreationCount, true -} - -// HasCouponCreationCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCouponCreationCount() bool { - if o != nil && o.CouponCreationCount != nil { - return true - } - - return false -} - -// SetCouponCreationCount gets a reference to the given int32 and assigns it to the CouponCreationCount field. -func (o *CampaignForNotification) SetCouponCreationCount(v int32) { - o.CouponCreationCount = &v -} - -// GetCustomEffectCount returns the CustomEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCustomEffectCount() int32 { - if o == nil || o.CustomEffectCount == nil { - var ret int32 - return ret - } - return *o.CustomEffectCount -} - -// GetCustomEffectCountOk returns a tuple with the CustomEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCustomEffectCountOk() (int32, bool) { - if o == nil || o.CustomEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CustomEffectCount, true -} - -// HasCustomEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCustomEffectCount() bool { - if o != nil && o.CustomEffectCount != nil { - return true - } - - return false -} - -// SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. -func (o *CampaignForNotification) SetCustomEffectCount(v int32) { - o.CustomEffectCount = &v -} - -// GetReferralCreationCount returns the ReferralCreationCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetReferralCreationCount() int32 { - if o == nil || o.ReferralCreationCount == nil { - var ret int32 - return ret - } - return *o.ReferralCreationCount -} - -// GetReferralCreationCountOk returns a tuple with the ReferralCreationCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetReferralCreationCountOk() (int32, bool) { - if o == nil || o.ReferralCreationCount == nil { - var ret int32 - return ret, false - } - return *o.ReferralCreationCount, true -} - -// HasReferralCreationCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasReferralCreationCount() bool { - if o != nil && o.ReferralCreationCount != nil { - return true - } - - return false -} - -// SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. -func (o *CampaignForNotification) SetReferralCreationCount(v int32) { - o.ReferralCreationCount = &v -} - -// GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetAddFreeItemEffectCount() int32 { - if o == nil || o.AddFreeItemEffectCount == nil { - var ret int32 - return ret - } - return *o.AddFreeItemEffectCount -} - -// GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetAddFreeItemEffectCountOk() (int32, bool) { - if o == nil || o.AddFreeItemEffectCount == nil { - var ret int32 - return ret, false - } - return *o.AddFreeItemEffectCount, true -} - -// HasAddFreeItemEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasAddFreeItemEffectCount() bool { - if o != nil && o.AddFreeItemEffectCount != nil { - return true - } - - return false -} - -// SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. -func (o *CampaignForNotification) SetAddFreeItemEffectCount(v int32) { - o.AddFreeItemEffectCount = &v -} - -// GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetAwardedGiveawaysCount() int32 { - if o == nil || o.AwardedGiveawaysCount == nil { - var ret int32 - return ret - } - return *o.AwardedGiveawaysCount -} - -// GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetAwardedGiveawaysCountOk() (int32, bool) { - if o == nil || o.AwardedGiveawaysCount == nil { - var ret int32 - return ret, false - } - return *o.AwardedGiveawaysCount, true -} - -// HasAwardedGiveawaysCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasAwardedGiveawaysCount() bool { - if o != nil && o.AwardedGiveawaysCount != nil { - return true - } - - return false -} - -// SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. -func (o *CampaignForNotification) SetAwardedGiveawaysCount(v int32) { - o.AwardedGiveawaysCount = &v -} - -// GetCreatedLoyaltyPointsCount returns the CreatedLoyaltyPointsCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCreatedLoyaltyPointsCount() float32 { - if o == nil || o.CreatedLoyaltyPointsCount == nil { - var ret float32 - return ret - } - return *o.CreatedLoyaltyPointsCount -} - -// GetCreatedLoyaltyPointsCountOk returns a tuple with the CreatedLoyaltyPointsCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCreatedLoyaltyPointsCountOk() (float32, bool) { - if o == nil || o.CreatedLoyaltyPointsCount == nil { - var ret float32 - return ret, false - } - return *o.CreatedLoyaltyPointsCount, true -} - -// HasCreatedLoyaltyPointsCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCreatedLoyaltyPointsCount() bool { - if o != nil && o.CreatedLoyaltyPointsCount != nil { - return true - } - - return false -} - -// SetCreatedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the CreatedLoyaltyPointsCount field. -func (o *CampaignForNotification) SetCreatedLoyaltyPointsCount(v float32) { - o.CreatedLoyaltyPointsCount = &v -} - -// GetCreatedLoyaltyPointsEffectCount returns the CreatedLoyaltyPointsEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCreatedLoyaltyPointsEffectCount() int32 { - if o == nil || o.CreatedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret - } - return *o.CreatedLoyaltyPointsEffectCount -} - -// GetCreatedLoyaltyPointsEffectCountOk returns a tuple with the CreatedLoyaltyPointsEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCreatedLoyaltyPointsEffectCountOk() (int32, bool) { - if o == nil || o.CreatedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CreatedLoyaltyPointsEffectCount, true -} - -// HasCreatedLoyaltyPointsEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCreatedLoyaltyPointsEffectCount() bool { - if o != nil && o.CreatedLoyaltyPointsEffectCount != nil { - return true - } - - return false -} - -// SetCreatedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the CreatedLoyaltyPointsEffectCount field. -func (o *CampaignForNotification) SetCreatedLoyaltyPointsEffectCount(v int32) { - o.CreatedLoyaltyPointsEffectCount = &v -} - -// GetRedeemedLoyaltyPointsCount returns the RedeemedLoyaltyPointsCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetRedeemedLoyaltyPointsCount() float32 { - if o == nil || o.RedeemedLoyaltyPointsCount == nil { - var ret float32 - return ret - } - return *o.RedeemedLoyaltyPointsCount -} - -// GetRedeemedLoyaltyPointsCountOk returns a tuple with the RedeemedLoyaltyPointsCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetRedeemedLoyaltyPointsCountOk() (float32, bool) { - if o == nil || o.RedeemedLoyaltyPointsCount == nil { - var ret float32 - return ret, false - } - return *o.RedeemedLoyaltyPointsCount, true -} - -// HasRedeemedLoyaltyPointsCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasRedeemedLoyaltyPointsCount() bool { - if o != nil && o.RedeemedLoyaltyPointsCount != nil { - return true - } - - return false -} - -// SetRedeemedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the RedeemedLoyaltyPointsCount field. -func (o *CampaignForNotification) SetRedeemedLoyaltyPointsCount(v float32) { - o.RedeemedLoyaltyPointsCount = &v -} - -// GetRedeemedLoyaltyPointsEffectCount returns the RedeemedLoyaltyPointsEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetRedeemedLoyaltyPointsEffectCount() int32 { - if o == nil || o.RedeemedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret - } - return *o.RedeemedLoyaltyPointsEffectCount -} - -// GetRedeemedLoyaltyPointsEffectCountOk returns a tuple with the RedeemedLoyaltyPointsEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetRedeemedLoyaltyPointsEffectCountOk() (int32, bool) { - if o == nil || o.RedeemedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret, false - } - return *o.RedeemedLoyaltyPointsEffectCount, true -} - -// HasRedeemedLoyaltyPointsEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasRedeemedLoyaltyPointsEffectCount() bool { - if o != nil && o.RedeemedLoyaltyPointsEffectCount != nil { - return true - } - - return false -} - -// SetRedeemedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the RedeemedLoyaltyPointsEffectCount field. -func (o *CampaignForNotification) SetRedeemedLoyaltyPointsEffectCount(v int32) { - o.RedeemedLoyaltyPointsEffectCount = &v -} - -// GetCallApiEffectCount returns the CallApiEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCallApiEffectCount() int32 { - if o == nil || o.CallApiEffectCount == nil { - var ret int32 - return ret - } - return *o.CallApiEffectCount -} - -// GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCallApiEffectCountOk() (int32, bool) { - if o == nil || o.CallApiEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CallApiEffectCount, true -} - -// HasCallApiEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCallApiEffectCount() bool { - if o != nil && o.CallApiEffectCount != nil { - return true - } - - return false -} - -// SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. -func (o *CampaignForNotification) SetCallApiEffectCount(v int32) { - o.CallApiEffectCount = &v -} - -// GetReservecouponEffectCount returns the ReservecouponEffectCount field value if set, zero value otherwise. -func (o *CampaignForNotification) GetReservecouponEffectCount() int32 { - if o == nil || o.ReservecouponEffectCount == nil { - var ret int32 - return ret - } - return *o.ReservecouponEffectCount -} - -// GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetReservecouponEffectCountOk() (int32, bool) { - if o == nil || o.ReservecouponEffectCount == nil { - var ret int32 - return ret, false - } - return *o.ReservecouponEffectCount, true -} - -// HasReservecouponEffectCount returns a boolean if a field has been set. -func (o *CampaignForNotification) HasReservecouponEffectCount() bool { - if o != nil && o.ReservecouponEffectCount != nil { - return true - } - - return false -} - -// SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. -func (o *CampaignForNotification) SetReservecouponEffectCount(v int32) { - o.ReservecouponEffectCount = &v -} - -// GetLastActivity returns the LastActivity field value if set, zero value otherwise. -func (o *CampaignForNotification) GetLastActivity() time.Time { - if o == nil || o.LastActivity == nil { - var ret time.Time - return ret - } - return *o.LastActivity -} - -// GetLastActivityOk returns a tuple with the LastActivity field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetLastActivityOk() (time.Time, bool) { - if o == nil || o.LastActivity == nil { - var ret time.Time - return ret, false - } - return *o.LastActivity, true -} - -// HasLastActivity returns a boolean if a field has been set. -func (o *CampaignForNotification) HasLastActivity() bool { - if o != nil && o.LastActivity != nil { - return true - } - - return false -} - -// SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. -func (o *CampaignForNotification) SetLastActivity(v time.Time) { - o.LastActivity = &v -} - -// GetUpdated returns the Updated field value if set, zero value otherwise. -func (o *CampaignForNotification) GetUpdated() time.Time { - if o == nil || o.Updated == nil { - var ret time.Time - return ret - } - return *o.Updated -} - -// GetUpdatedOk returns a tuple with the Updated field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetUpdatedOk() (time.Time, bool) { - if o == nil || o.Updated == nil { - var ret time.Time - return ret, false - } - return *o.Updated, true -} - -// HasUpdated returns a boolean if a field has been set. -func (o *CampaignForNotification) HasUpdated() bool { - if o != nil && o.Updated != nil { - return true - } - - return false -} - -// SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. -func (o *CampaignForNotification) SetUpdated(v time.Time) { - o.Updated = &v -} - -// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. -func (o *CampaignForNotification) GetCreatedBy() string { - if o == nil || o.CreatedBy == nil { - var ret string - return ret - } - return *o.CreatedBy -} - -// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetCreatedByOk() (string, bool) { - if o == nil || o.CreatedBy == nil { - var ret string - return ret, false - } - return *o.CreatedBy, true -} - -// HasCreatedBy returns a boolean if a field has been set. -func (o *CampaignForNotification) HasCreatedBy() bool { - if o != nil && o.CreatedBy != nil { - return true - } - - return false -} - -// SetCreatedBy gets a reference to the given string and assigns it to the CreatedBy field. -func (o *CampaignForNotification) SetCreatedBy(v string) { - o.CreatedBy = &v -} - -// GetUpdatedBy returns the UpdatedBy field value if set, zero value otherwise. -func (o *CampaignForNotification) GetUpdatedBy() string { - if o == nil || o.UpdatedBy == nil { - var ret string - return ret - } - return *o.UpdatedBy -} - -// GetUpdatedByOk returns a tuple with the UpdatedBy field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetUpdatedByOk() (string, bool) { - if o == nil || o.UpdatedBy == nil { - var ret string - return ret, false - } - return *o.UpdatedBy, true -} - -// HasUpdatedBy returns a boolean if a field has been set. -func (o *CampaignForNotification) HasUpdatedBy() bool { - if o != nil && o.UpdatedBy != nil { - return true - } - - return false -} - -// SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy field. -func (o *CampaignForNotification) SetUpdatedBy(v string) { - o.UpdatedBy = &v -} - -// GetTemplateId returns the TemplateId field value if set, zero value otherwise. -func (o *CampaignForNotification) GetTemplateId() int32 { - if o == nil || o.TemplateId == nil { - var ret int32 - return ret - } - return *o.TemplateId -} - -// GetTemplateIdOk returns a tuple with the TemplateId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignForNotification) GetTemplateIdOk() (int32, bool) { - if o == nil || o.TemplateId == nil { - var ret int32 - return ret, false - } - return *o.TemplateId, true -} - -// HasTemplateId returns a boolean if a field has been set. -func (o *CampaignForNotification) HasTemplateId() bool { - if o != nil && o.TemplateId != nil { - return true - } - - return false -} - -// SetTemplateId gets a reference to the given int32 and assigns it to the TemplateId field. -func (o *CampaignForNotification) SetTemplateId(v int32) { - o.TemplateId = &v -} - -type NullableCampaignForNotification struct { - Value CampaignForNotification - ExplicitNull bool -} - -func (v NullableCampaignForNotification) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableCampaignForNotification) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_campaign_notification_policy.go b/model_campaign_notification_policy.go index 661f6b54..e2dbb723 100644 --- a/model_campaign_notification_policy.go +++ b/model_campaign_notification_policy.go @@ -18,6 +18,8 @@ import ( type CampaignNotificationPolicy struct { // Notification name. Name string `json:"name"` + // Indicates whether batching is activated. + BatchingEnabled *bool `json:"batchingEnabled,omitempty"` } // GetName returns the Name field value @@ -35,6 +37,39 @@ func (o *CampaignNotificationPolicy) SetName(v string) { o.Name = v } +// GetBatchingEnabled returns the BatchingEnabled field value if set, zero value otherwise. +func (o *CampaignNotificationPolicy) GetBatchingEnabled() bool { + if o == nil || o.BatchingEnabled == nil { + var ret bool + return ret + } + return *o.BatchingEnabled +} + +// GetBatchingEnabledOk returns a tuple with the BatchingEnabled field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignNotificationPolicy) GetBatchingEnabledOk() (bool, bool) { + if o == nil || o.BatchingEnabled == nil { + var ret bool + return ret, false + } + return *o.BatchingEnabled, true +} + +// HasBatchingEnabled returns a boolean if a field has been set. +func (o *CampaignNotificationPolicy) HasBatchingEnabled() bool { + if o != nil && o.BatchingEnabled != nil { + return true + } + + return false +} + +// SetBatchingEnabled gets a reference to the given bool and assigns it to the BatchingEnabled field. +func (o *CampaignNotificationPolicy) SetBatchingEnabled(v bool) { + o.BatchingEnabled = &v +} + type NullableCampaignNotificationPolicy struct { Value CampaignNotificationPolicy ExplicitNull bool diff --git a/model_campaign_priorities_changed_notification.go b/model_campaign_priorities_changed_notification.go deleted file mode 100644 index bb1a90ac..00000000 --- a/model_campaign_priorities_changed_notification.go +++ /dev/null @@ -1,109 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// CampaignPrioritiesChangedNotification Notification about an Application whose campaigns' priorities changed. -type CampaignPrioritiesChangedNotification struct { - // The ID of the Application whose campaigns' priorities changed. - ApplicationId int32 `json:"applicationId"` - OldPriorities *CampaignSet `json:"oldPriorities,omitempty"` - Priorities CampaignSet `json:"priorities"` -} - -// GetApplicationId returns the ApplicationId field value -func (o *CampaignPrioritiesChangedNotification) GetApplicationId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ApplicationId -} - -// SetApplicationId sets field value -func (o *CampaignPrioritiesChangedNotification) SetApplicationId(v int32) { - o.ApplicationId = v -} - -// GetOldPriorities returns the OldPriorities field value if set, zero value otherwise. -func (o *CampaignPrioritiesChangedNotification) GetOldPriorities() CampaignSet { - if o == nil || o.OldPriorities == nil { - var ret CampaignSet - return ret - } - return *o.OldPriorities -} - -// GetOldPrioritiesOk returns a tuple with the OldPriorities field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignPrioritiesChangedNotification) GetOldPrioritiesOk() (CampaignSet, bool) { - if o == nil || o.OldPriorities == nil { - var ret CampaignSet - return ret, false - } - return *o.OldPriorities, true -} - -// HasOldPriorities returns a boolean if a field has been set. -func (o *CampaignPrioritiesChangedNotification) HasOldPriorities() bool { - if o != nil && o.OldPriorities != nil { - return true - } - - return false -} - -// SetOldPriorities gets a reference to the given CampaignSet and assigns it to the OldPriorities field. -func (o *CampaignPrioritiesChangedNotification) SetOldPriorities(v CampaignSet) { - o.OldPriorities = &v -} - -// GetPriorities returns the Priorities field value -func (o *CampaignPrioritiesChangedNotification) GetPriorities() CampaignSet { - if o == nil { - var ret CampaignSet - return ret - } - - return o.Priorities -} - -// SetPriorities sets field value -func (o *CampaignPrioritiesChangedNotification) SetPriorities(v CampaignSet) { - o.Priorities = v -} - -type NullableCampaignPrioritiesChangedNotification struct { - Value CampaignPrioritiesChangedNotification - ExplicitNull bool -} - -func (v NullableCampaignPrioritiesChangedNotification) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableCampaignPrioritiesChangedNotification) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_campaign_priorities_v2.go b/model_campaign_priorities_v2.go deleted file mode 100644 index 0c747b5f..00000000 --- a/model_campaign_priorities_v2.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// CampaignPrioritiesV2 struct for CampaignPrioritiesV2 -type CampaignPrioritiesV2 struct { - Exclusive *[]CampaignSetIDs `json:"exclusive,omitempty"` - Stackable *[]CampaignSetIDs `json:"stackable,omitempty"` - Universal *[]CampaignSetIDs `json:"universal,omitempty"` -} - -// GetExclusive returns the Exclusive field value if set, zero value otherwise. -func (o *CampaignPrioritiesV2) GetExclusive() []CampaignSetIDs { - if o == nil || o.Exclusive == nil { - var ret []CampaignSetIDs - return ret - } - return *o.Exclusive -} - -// GetExclusiveOk returns a tuple with the Exclusive field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignPrioritiesV2) GetExclusiveOk() ([]CampaignSetIDs, bool) { - if o == nil || o.Exclusive == nil { - var ret []CampaignSetIDs - return ret, false - } - return *o.Exclusive, true -} - -// HasExclusive returns a boolean if a field has been set. -func (o *CampaignPrioritiesV2) HasExclusive() bool { - if o != nil && o.Exclusive != nil { - return true - } - - return false -} - -// SetExclusive gets a reference to the given []CampaignSetIDs and assigns it to the Exclusive field. -func (o *CampaignPrioritiesV2) SetExclusive(v []CampaignSetIDs) { - o.Exclusive = &v -} - -// GetStackable returns the Stackable field value if set, zero value otherwise. -func (o *CampaignPrioritiesV2) GetStackable() []CampaignSetIDs { - if o == nil || o.Stackable == nil { - var ret []CampaignSetIDs - return ret - } - return *o.Stackable -} - -// GetStackableOk returns a tuple with the Stackable field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignPrioritiesV2) GetStackableOk() ([]CampaignSetIDs, bool) { - if o == nil || o.Stackable == nil { - var ret []CampaignSetIDs - return ret, false - } - return *o.Stackable, true -} - -// HasStackable returns a boolean if a field has been set. -func (o *CampaignPrioritiesV2) HasStackable() bool { - if o != nil && o.Stackable != nil { - return true - } - - return false -} - -// SetStackable gets a reference to the given []CampaignSetIDs and assigns it to the Stackable field. -func (o *CampaignPrioritiesV2) SetStackable(v []CampaignSetIDs) { - o.Stackable = &v -} - -// GetUniversal returns the Universal field value if set, zero value otherwise. -func (o *CampaignPrioritiesV2) GetUniversal() []CampaignSetIDs { - if o == nil || o.Universal == nil { - var ret []CampaignSetIDs - return ret - } - return *o.Universal -} - -// GetUniversalOk returns a tuple with the Universal field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignPrioritiesV2) GetUniversalOk() ([]CampaignSetIDs, bool) { - if o == nil || o.Universal == nil { - var ret []CampaignSetIDs - return ret, false - } - return *o.Universal, true -} - -// HasUniversal returns a boolean if a field has been set. -func (o *CampaignPrioritiesV2) HasUniversal() bool { - if o != nil && o.Universal != nil { - return true - } - - return false -} - -// SetUniversal gets a reference to the given []CampaignSetIDs and assigns it to the Universal field. -func (o *CampaignPrioritiesV2) SetUniversal(v []CampaignSetIDs) { - o.Universal = &v -} - -type NullableCampaignPrioritiesV2 struct { - Value CampaignPrioritiesV2 - ExplicitNull bool -} - -func (v NullableCampaignPrioritiesV2) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableCampaignPrioritiesV2) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_campaign_state_changed_notification.go b/model_campaign_state_changed_notification.go index f5d60aae..c00f26f1 100644 --- a/model_campaign_state_changed_notification.go +++ b/model_campaign_state_changed_notification.go @@ -17,9 +17,9 @@ import ( // CampaignStateChangedNotification A notification regarding a campaign whose state changed. type CampaignStateChangedNotification struct { Campaign Campaign `json:"campaign"` - // The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + // The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] OldState string `json:"oldState"` - // The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived'] + // The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'archived'] NewState string `json:"newState"` Ruleset *Ruleset `json:"ruleset,omitempty"` } diff --git a/model_campaign_state_notification.go b/model_campaign_state_notification.go deleted file mode 100644 index 9b0edc04..00000000 --- a/model_campaign_state_notification.go +++ /dev/null @@ -1,1277 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// CampaignStateNotification Campaign data and its state changes. -type CampaignStateNotification struct { - // Unique ID for this entity. - Id int32 `json:"id"` - // The exact moment this entity was created. - Created time.Time `json:"created"` - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // The ID of the user associated with this entity. - UserId int32 `json:"userId"` - // A user-facing name for this campaign. - Name string `json:"name"` - // A detailed description of the campaign. - Description string `json:"description"` - // Timestamp when the campaign will become active. - StartTime *time.Time `json:"startTime,omitempty"` - // Timestamp when the campaign will become inactive. - EndTime *time.Time `json:"endTime,omitempty"` - // Arbitrary properties associated with this campaign. - Attributes *map[string]interface{} `json:"attributes,omitempty"` - // A disabled or archived campaign is not evaluated for rules or coupons. - State string `json:"state"` - // [ID of Ruleset](https://docs.talon.one/management-api#operation/getRulesets) this campaign applies on customer session evaluation. - ActiveRulesetId *int32 `json:"activeRulesetId,omitempty"` - // A list of tags for the campaign. - Tags []string `json:"tags"` - // The features enabled in this campaign. - Features []string `json:"features"` - CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` - ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` - // The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign. - Limits []LimitConfig `json:"limits"` - // The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to. - CampaignGroups *[]int32 `json:"campaignGroups,omitempty"` - // The ID of the campaign evaluation group the campaign belongs to. - EvaluationGroupId *int32 `json:"evaluationGroupId,omitempty"` - // The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. - Type string `json:"type"` - // A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - LinkedStoreIds *[]int32 `json:"linkedStoreIds,omitempty"` - // 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. - Budgets []CampaignBudget `json:"budgets"` - // This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign. - CouponRedemptionCount *int32 `json:"couponRedemptionCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign. - ReferralRedemptionCount *int32 `json:"referralRedemptionCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign. - DiscountCount *float32 `json:"discountCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign. - DiscountEffectCount *int32 `json:"discountEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign. - CouponCreationCount *int32 `json:"couponCreationCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign. - CustomEffectCount *int32 `json:"customEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign. - ReferralCreationCount *int32 `json:"referralCreationCount,omitempty"` - // 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. - AddFreeItemEffectCount *int32 `json:"addFreeItemEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign. - AwardedGiveawaysCount *int32 `json:"awardedGiveawaysCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign. - CreatedLoyaltyPointsCount *float32 `json:"createdLoyaltyPointsCount,omitempty"` - // 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. - CreatedLoyaltyPointsEffectCount *int32 `json:"createdLoyaltyPointsEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign. - RedeemedLoyaltyPointsCount *float32 `json:"redeemedLoyaltyPointsCount,omitempty"` - // 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. - RedeemedLoyaltyPointsEffectCount *int32 `json:"redeemedLoyaltyPointsEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign. - CallApiEffectCount *int32 `json:"callApiEffectCount,omitempty"` - // This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign. - ReservecouponEffectCount *int32 `json:"reservecouponEffectCount,omitempty"` - // Timestamp of the most recent event received by this campaign. - LastActivity *time.Time `json:"lastActivity,omitempty"` - // Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates. - Updated *time.Time `json:"updated,omitempty"` - // Name of the user who created this campaign if available. - CreatedBy *string `json:"createdBy,omitempty"` - // Name of the user who last updated this campaign if available. - UpdatedBy *string `json:"updatedBy,omitempty"` - // The ID of the Campaign Template this Campaign was created from. - TemplateId *int32 `json:"templateId,omitempty"` - // A campaign state described exactly as in the Campaign Manager. - FrontendState string `json:"frontendState"` -} - -// GetId returns the Id field value -func (o *CampaignStateNotification) GetId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Id -} - -// SetId sets field value -func (o *CampaignStateNotification) SetId(v int32) { - o.Id = v -} - -// GetCreated returns the Created field value -func (o *CampaignStateNotification) GetCreated() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Created -} - -// SetCreated sets field value -func (o *CampaignStateNotification) SetCreated(v time.Time) { - o.Created = v -} - -// GetApplicationId returns the ApplicationId field value -func (o *CampaignStateNotification) GetApplicationId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ApplicationId -} - -// SetApplicationId sets field value -func (o *CampaignStateNotification) SetApplicationId(v int32) { - o.ApplicationId = v -} - -// GetUserId returns the UserId field value -func (o *CampaignStateNotification) GetUserId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.UserId -} - -// SetUserId sets field value -func (o *CampaignStateNotification) SetUserId(v int32) { - o.UserId = v -} - -// GetName returns the Name field value -func (o *CampaignStateNotification) GetName() string { - if o == nil { - var ret string - return ret - } - - return o.Name -} - -// SetName sets field value -func (o *CampaignStateNotification) SetName(v string) { - o.Name = v -} - -// GetDescription returns the Description field value -func (o *CampaignStateNotification) GetDescription() string { - if o == nil { - var ret string - return ret - } - - return o.Description -} - -// SetDescription sets field value -func (o *CampaignStateNotification) SetDescription(v string) { - o.Description = v -} - -// GetStartTime returns the StartTime field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetStartTime() time.Time { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret - } - return *o.StartTime -} - -// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetStartTimeOk() (time.Time, bool) { - if o == nil || o.StartTime == nil { - var ret time.Time - return ret, false - } - return *o.StartTime, true -} - -// HasStartTime returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasStartTime() bool { - if o != nil && o.StartTime != nil { - return true - } - - return false -} - -// SetStartTime gets a reference to the given time.Time and assigns it to the StartTime field. -func (o *CampaignStateNotification) SetStartTime(v time.Time) { - o.StartTime = &v -} - -// GetEndTime returns the EndTime field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetEndTime() time.Time { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret - } - return *o.EndTime -} - -// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetEndTimeOk() (time.Time, bool) { - if o == nil || o.EndTime == nil { - var ret time.Time - return ret, false - } - return *o.EndTime, true -} - -// HasEndTime returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasEndTime() bool { - if o != nil && o.EndTime != nil { - return true - } - - return false -} - -// SetEndTime gets a reference to the given time.Time and assigns it to the EndTime field. -func (o *CampaignStateNotification) SetEndTime(v time.Time) { - o.EndTime = &v -} - -// GetAttributes returns the Attributes field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetAttributes() map[string]interface{} { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret - } - return *o.Attributes -} - -// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetAttributesOk() (map[string]interface{}, bool) { - if o == nil || o.Attributes == nil { - var ret map[string]interface{} - return ret, false - } - return *o.Attributes, true -} - -// HasAttributes returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasAttributes() bool { - if o != nil && o.Attributes != nil { - return true - } - - return false -} - -// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. -func (o *CampaignStateNotification) SetAttributes(v map[string]interface{}) { - o.Attributes = &v -} - -// GetState returns the State field value -func (o *CampaignStateNotification) GetState() string { - if o == nil { - var ret string - return ret - } - - return o.State -} - -// SetState sets field value -func (o *CampaignStateNotification) SetState(v string) { - o.State = v -} - -// GetActiveRulesetId returns the ActiveRulesetId field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetActiveRulesetId() int32 { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret - } - return *o.ActiveRulesetId -} - -// GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetActiveRulesetIdOk() (int32, bool) { - if o == nil || o.ActiveRulesetId == nil { - var ret int32 - return ret, false - } - return *o.ActiveRulesetId, true -} - -// HasActiveRulesetId returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasActiveRulesetId() bool { - if o != nil && o.ActiveRulesetId != nil { - return true - } - - return false -} - -// SetActiveRulesetId gets a reference to the given int32 and assigns it to the ActiveRulesetId field. -func (o *CampaignStateNotification) SetActiveRulesetId(v int32) { - o.ActiveRulesetId = &v -} - -// GetTags returns the Tags field value -func (o *CampaignStateNotification) GetTags() []string { - if o == nil { - var ret []string - return ret - } - - return o.Tags -} - -// SetTags sets field value -func (o *CampaignStateNotification) SetTags(v []string) { - o.Tags = v -} - -// GetFeatures returns the Features field value -func (o *CampaignStateNotification) GetFeatures() []string { - if o == nil { - var ret []string - return ret - } - - return o.Features -} - -// SetFeatures sets field value -func (o *CampaignStateNotification) SetFeatures(v []string) { - o.Features = v -} - -// GetCouponSettings returns the CouponSettings field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCouponSettings() CodeGeneratorSettings { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.CouponSettings -} - -// GetCouponSettingsOk returns a tuple with the CouponSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCouponSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.CouponSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.CouponSettings, true -} - -// HasCouponSettings returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCouponSettings() bool { - if o != nil && o.CouponSettings != nil { - return true - } - - return false -} - -// SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. -func (o *CampaignStateNotification) SetCouponSettings(v CodeGeneratorSettings) { - o.CouponSettings = &v -} - -// GetReferralSettings returns the ReferralSettings field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetReferralSettings() CodeGeneratorSettings { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret - } - return *o.ReferralSettings -} - -// GetReferralSettingsOk returns a tuple with the ReferralSettings field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetReferralSettingsOk() (CodeGeneratorSettings, bool) { - if o == nil || o.ReferralSettings == nil { - var ret CodeGeneratorSettings - return ret, false - } - return *o.ReferralSettings, true -} - -// HasReferralSettings returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasReferralSettings() bool { - if o != nil && o.ReferralSettings != nil { - return true - } - - return false -} - -// SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. -func (o *CampaignStateNotification) SetReferralSettings(v CodeGeneratorSettings) { - o.ReferralSettings = &v -} - -// GetLimits returns the Limits field value -func (o *CampaignStateNotification) GetLimits() []LimitConfig { - if o == nil { - var ret []LimitConfig - return ret - } - - return o.Limits -} - -// SetLimits sets field value -func (o *CampaignStateNotification) SetLimits(v []LimitConfig) { - o.Limits = v -} - -// GetCampaignGroups returns the CampaignGroups field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCampaignGroups() []int32 { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret - } - return *o.CampaignGroups -} - -// GetCampaignGroupsOk returns a tuple with the CampaignGroups field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCampaignGroupsOk() ([]int32, bool) { - if o == nil || o.CampaignGroups == nil { - var ret []int32 - return ret, false - } - return *o.CampaignGroups, true -} - -// HasCampaignGroups returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCampaignGroups() bool { - if o != nil && o.CampaignGroups != nil { - return true - } - - return false -} - -// SetCampaignGroups gets a reference to the given []int32 and assigns it to the CampaignGroups field. -func (o *CampaignStateNotification) SetCampaignGroups(v []int32) { - o.CampaignGroups = &v -} - -// GetEvaluationGroupId returns the EvaluationGroupId field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetEvaluationGroupId() int32 { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret - } - return *o.EvaluationGroupId -} - -// GetEvaluationGroupIdOk returns a tuple with the EvaluationGroupId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetEvaluationGroupIdOk() (int32, bool) { - if o == nil || o.EvaluationGroupId == nil { - var ret int32 - return ret, false - } - return *o.EvaluationGroupId, true -} - -// HasEvaluationGroupId returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasEvaluationGroupId() bool { - if o != nil && o.EvaluationGroupId != nil { - return true - } - - return false -} - -// SetEvaluationGroupId gets a reference to the given int32 and assigns it to the EvaluationGroupId field. -func (o *CampaignStateNotification) SetEvaluationGroupId(v int32) { - o.EvaluationGroupId = &v -} - -// GetType returns the Type field value -func (o *CampaignStateNotification) GetType() string { - if o == nil { - var ret string - return ret - } - - return o.Type -} - -// SetType sets field value -func (o *CampaignStateNotification) SetType(v string) { - o.Type = v -} - -// GetLinkedStoreIds returns the LinkedStoreIds field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetLinkedStoreIds() []int32 { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret - } - return *o.LinkedStoreIds -} - -// GetLinkedStoreIdsOk returns a tuple with the LinkedStoreIds field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetLinkedStoreIdsOk() ([]int32, bool) { - if o == nil || o.LinkedStoreIds == nil { - var ret []int32 - return ret, false - } - return *o.LinkedStoreIds, true -} - -// HasLinkedStoreIds returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasLinkedStoreIds() bool { - if o != nil && o.LinkedStoreIds != nil { - return true - } - - return false -} - -// SetLinkedStoreIds gets a reference to the given []int32 and assigns it to the LinkedStoreIds field. -func (o *CampaignStateNotification) SetLinkedStoreIds(v []int32) { - o.LinkedStoreIds = &v -} - -// GetBudgets returns the Budgets field value -func (o *CampaignStateNotification) GetBudgets() []CampaignBudget { - if o == nil { - var ret []CampaignBudget - return ret - } - - return o.Budgets -} - -// SetBudgets sets field value -func (o *CampaignStateNotification) SetBudgets(v []CampaignBudget) { - o.Budgets = v -} - -// GetCouponRedemptionCount returns the CouponRedemptionCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCouponRedemptionCount() int32 { - if o == nil || o.CouponRedemptionCount == nil { - var ret int32 - return ret - } - return *o.CouponRedemptionCount -} - -// GetCouponRedemptionCountOk returns a tuple with the CouponRedemptionCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCouponRedemptionCountOk() (int32, bool) { - if o == nil || o.CouponRedemptionCount == nil { - var ret int32 - return ret, false - } - return *o.CouponRedemptionCount, true -} - -// HasCouponRedemptionCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCouponRedemptionCount() bool { - if o != nil && o.CouponRedemptionCount != nil { - return true - } - - return false -} - -// SetCouponRedemptionCount gets a reference to the given int32 and assigns it to the CouponRedemptionCount field. -func (o *CampaignStateNotification) SetCouponRedemptionCount(v int32) { - o.CouponRedemptionCount = &v -} - -// GetReferralRedemptionCount returns the ReferralRedemptionCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetReferralRedemptionCount() int32 { - if o == nil || o.ReferralRedemptionCount == nil { - var ret int32 - return ret - } - return *o.ReferralRedemptionCount -} - -// GetReferralRedemptionCountOk returns a tuple with the ReferralRedemptionCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetReferralRedemptionCountOk() (int32, bool) { - if o == nil || o.ReferralRedemptionCount == nil { - var ret int32 - return ret, false - } - return *o.ReferralRedemptionCount, true -} - -// HasReferralRedemptionCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasReferralRedemptionCount() bool { - if o != nil && o.ReferralRedemptionCount != nil { - return true - } - - return false -} - -// SetReferralRedemptionCount gets a reference to the given int32 and assigns it to the ReferralRedemptionCount field. -func (o *CampaignStateNotification) SetReferralRedemptionCount(v int32) { - o.ReferralRedemptionCount = &v -} - -// GetDiscountCount returns the DiscountCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetDiscountCount() float32 { - if o == nil || o.DiscountCount == nil { - var ret float32 - return ret - } - return *o.DiscountCount -} - -// GetDiscountCountOk returns a tuple with the DiscountCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetDiscountCountOk() (float32, bool) { - if o == nil || o.DiscountCount == nil { - var ret float32 - return ret, false - } - return *o.DiscountCount, true -} - -// HasDiscountCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasDiscountCount() bool { - if o != nil && o.DiscountCount != nil { - return true - } - - return false -} - -// SetDiscountCount gets a reference to the given float32 and assigns it to the DiscountCount field. -func (o *CampaignStateNotification) SetDiscountCount(v float32) { - o.DiscountCount = &v -} - -// GetDiscountEffectCount returns the DiscountEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetDiscountEffectCount() int32 { - if o == nil || o.DiscountEffectCount == nil { - var ret int32 - return ret - } - return *o.DiscountEffectCount -} - -// GetDiscountEffectCountOk returns a tuple with the DiscountEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetDiscountEffectCountOk() (int32, bool) { - if o == nil || o.DiscountEffectCount == nil { - var ret int32 - return ret, false - } - return *o.DiscountEffectCount, true -} - -// HasDiscountEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasDiscountEffectCount() bool { - if o != nil && o.DiscountEffectCount != nil { - return true - } - - return false -} - -// SetDiscountEffectCount gets a reference to the given int32 and assigns it to the DiscountEffectCount field. -func (o *CampaignStateNotification) SetDiscountEffectCount(v int32) { - o.DiscountEffectCount = &v -} - -// GetCouponCreationCount returns the CouponCreationCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCouponCreationCount() int32 { - if o == nil || o.CouponCreationCount == nil { - var ret int32 - return ret - } - return *o.CouponCreationCount -} - -// GetCouponCreationCountOk returns a tuple with the CouponCreationCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCouponCreationCountOk() (int32, bool) { - if o == nil || o.CouponCreationCount == nil { - var ret int32 - return ret, false - } - return *o.CouponCreationCount, true -} - -// HasCouponCreationCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCouponCreationCount() bool { - if o != nil && o.CouponCreationCount != nil { - return true - } - - return false -} - -// SetCouponCreationCount gets a reference to the given int32 and assigns it to the CouponCreationCount field. -func (o *CampaignStateNotification) SetCouponCreationCount(v int32) { - o.CouponCreationCount = &v -} - -// GetCustomEffectCount returns the CustomEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCustomEffectCount() int32 { - if o == nil || o.CustomEffectCount == nil { - var ret int32 - return ret - } - return *o.CustomEffectCount -} - -// GetCustomEffectCountOk returns a tuple with the CustomEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCustomEffectCountOk() (int32, bool) { - if o == nil || o.CustomEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CustomEffectCount, true -} - -// HasCustomEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCustomEffectCount() bool { - if o != nil && o.CustomEffectCount != nil { - return true - } - - return false -} - -// SetCustomEffectCount gets a reference to the given int32 and assigns it to the CustomEffectCount field. -func (o *CampaignStateNotification) SetCustomEffectCount(v int32) { - o.CustomEffectCount = &v -} - -// GetReferralCreationCount returns the ReferralCreationCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetReferralCreationCount() int32 { - if o == nil || o.ReferralCreationCount == nil { - var ret int32 - return ret - } - return *o.ReferralCreationCount -} - -// GetReferralCreationCountOk returns a tuple with the ReferralCreationCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetReferralCreationCountOk() (int32, bool) { - if o == nil || o.ReferralCreationCount == nil { - var ret int32 - return ret, false - } - return *o.ReferralCreationCount, true -} - -// HasReferralCreationCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasReferralCreationCount() bool { - if o != nil && o.ReferralCreationCount != nil { - return true - } - - return false -} - -// SetReferralCreationCount gets a reference to the given int32 and assigns it to the ReferralCreationCount field. -func (o *CampaignStateNotification) SetReferralCreationCount(v int32) { - o.ReferralCreationCount = &v -} - -// GetAddFreeItemEffectCount returns the AddFreeItemEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetAddFreeItemEffectCount() int32 { - if o == nil || o.AddFreeItemEffectCount == nil { - var ret int32 - return ret - } - return *o.AddFreeItemEffectCount -} - -// GetAddFreeItemEffectCountOk returns a tuple with the AddFreeItemEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetAddFreeItemEffectCountOk() (int32, bool) { - if o == nil || o.AddFreeItemEffectCount == nil { - var ret int32 - return ret, false - } - return *o.AddFreeItemEffectCount, true -} - -// HasAddFreeItemEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasAddFreeItemEffectCount() bool { - if o != nil && o.AddFreeItemEffectCount != nil { - return true - } - - return false -} - -// SetAddFreeItemEffectCount gets a reference to the given int32 and assigns it to the AddFreeItemEffectCount field. -func (o *CampaignStateNotification) SetAddFreeItemEffectCount(v int32) { - o.AddFreeItemEffectCount = &v -} - -// GetAwardedGiveawaysCount returns the AwardedGiveawaysCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetAwardedGiveawaysCount() int32 { - if o == nil || o.AwardedGiveawaysCount == nil { - var ret int32 - return ret - } - return *o.AwardedGiveawaysCount -} - -// GetAwardedGiveawaysCountOk returns a tuple with the AwardedGiveawaysCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetAwardedGiveawaysCountOk() (int32, bool) { - if o == nil || o.AwardedGiveawaysCount == nil { - var ret int32 - return ret, false - } - return *o.AwardedGiveawaysCount, true -} - -// HasAwardedGiveawaysCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasAwardedGiveawaysCount() bool { - if o != nil && o.AwardedGiveawaysCount != nil { - return true - } - - return false -} - -// SetAwardedGiveawaysCount gets a reference to the given int32 and assigns it to the AwardedGiveawaysCount field. -func (o *CampaignStateNotification) SetAwardedGiveawaysCount(v int32) { - o.AwardedGiveawaysCount = &v -} - -// GetCreatedLoyaltyPointsCount returns the CreatedLoyaltyPointsCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCreatedLoyaltyPointsCount() float32 { - if o == nil || o.CreatedLoyaltyPointsCount == nil { - var ret float32 - return ret - } - return *o.CreatedLoyaltyPointsCount -} - -// GetCreatedLoyaltyPointsCountOk returns a tuple with the CreatedLoyaltyPointsCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCreatedLoyaltyPointsCountOk() (float32, bool) { - if o == nil || o.CreatedLoyaltyPointsCount == nil { - var ret float32 - return ret, false - } - return *o.CreatedLoyaltyPointsCount, true -} - -// HasCreatedLoyaltyPointsCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCreatedLoyaltyPointsCount() bool { - if o != nil && o.CreatedLoyaltyPointsCount != nil { - return true - } - - return false -} - -// SetCreatedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the CreatedLoyaltyPointsCount field. -func (o *CampaignStateNotification) SetCreatedLoyaltyPointsCount(v float32) { - o.CreatedLoyaltyPointsCount = &v -} - -// GetCreatedLoyaltyPointsEffectCount returns the CreatedLoyaltyPointsEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCreatedLoyaltyPointsEffectCount() int32 { - if o == nil || o.CreatedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret - } - return *o.CreatedLoyaltyPointsEffectCount -} - -// GetCreatedLoyaltyPointsEffectCountOk returns a tuple with the CreatedLoyaltyPointsEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCreatedLoyaltyPointsEffectCountOk() (int32, bool) { - if o == nil || o.CreatedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CreatedLoyaltyPointsEffectCount, true -} - -// HasCreatedLoyaltyPointsEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCreatedLoyaltyPointsEffectCount() bool { - if o != nil && o.CreatedLoyaltyPointsEffectCount != nil { - return true - } - - return false -} - -// SetCreatedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the CreatedLoyaltyPointsEffectCount field. -func (o *CampaignStateNotification) SetCreatedLoyaltyPointsEffectCount(v int32) { - o.CreatedLoyaltyPointsEffectCount = &v -} - -// GetRedeemedLoyaltyPointsCount returns the RedeemedLoyaltyPointsCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsCount() float32 { - if o == nil || o.RedeemedLoyaltyPointsCount == nil { - var ret float32 - return ret - } - return *o.RedeemedLoyaltyPointsCount -} - -// GetRedeemedLoyaltyPointsCountOk returns a tuple with the RedeemedLoyaltyPointsCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsCountOk() (float32, bool) { - if o == nil || o.RedeemedLoyaltyPointsCount == nil { - var ret float32 - return ret, false - } - return *o.RedeemedLoyaltyPointsCount, true -} - -// HasRedeemedLoyaltyPointsCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasRedeemedLoyaltyPointsCount() bool { - if o != nil && o.RedeemedLoyaltyPointsCount != nil { - return true - } - - return false -} - -// SetRedeemedLoyaltyPointsCount gets a reference to the given float32 and assigns it to the RedeemedLoyaltyPointsCount field. -func (o *CampaignStateNotification) SetRedeemedLoyaltyPointsCount(v float32) { - o.RedeemedLoyaltyPointsCount = &v -} - -// GetRedeemedLoyaltyPointsEffectCount returns the RedeemedLoyaltyPointsEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsEffectCount() int32 { - if o == nil || o.RedeemedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret - } - return *o.RedeemedLoyaltyPointsEffectCount -} - -// GetRedeemedLoyaltyPointsEffectCountOk returns a tuple with the RedeemedLoyaltyPointsEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetRedeemedLoyaltyPointsEffectCountOk() (int32, bool) { - if o == nil || o.RedeemedLoyaltyPointsEffectCount == nil { - var ret int32 - return ret, false - } - return *o.RedeemedLoyaltyPointsEffectCount, true -} - -// HasRedeemedLoyaltyPointsEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasRedeemedLoyaltyPointsEffectCount() bool { - if o != nil && o.RedeemedLoyaltyPointsEffectCount != nil { - return true - } - - return false -} - -// SetRedeemedLoyaltyPointsEffectCount gets a reference to the given int32 and assigns it to the RedeemedLoyaltyPointsEffectCount field. -func (o *CampaignStateNotification) SetRedeemedLoyaltyPointsEffectCount(v int32) { - o.RedeemedLoyaltyPointsEffectCount = &v -} - -// GetCallApiEffectCount returns the CallApiEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCallApiEffectCount() int32 { - if o == nil || o.CallApiEffectCount == nil { - var ret int32 - return ret - } - return *o.CallApiEffectCount -} - -// GetCallApiEffectCountOk returns a tuple with the CallApiEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCallApiEffectCountOk() (int32, bool) { - if o == nil || o.CallApiEffectCount == nil { - var ret int32 - return ret, false - } - return *o.CallApiEffectCount, true -} - -// HasCallApiEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCallApiEffectCount() bool { - if o != nil && o.CallApiEffectCount != nil { - return true - } - - return false -} - -// SetCallApiEffectCount gets a reference to the given int32 and assigns it to the CallApiEffectCount field. -func (o *CampaignStateNotification) SetCallApiEffectCount(v int32) { - o.CallApiEffectCount = &v -} - -// GetReservecouponEffectCount returns the ReservecouponEffectCount field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetReservecouponEffectCount() int32 { - if o == nil || o.ReservecouponEffectCount == nil { - var ret int32 - return ret - } - return *o.ReservecouponEffectCount -} - -// GetReservecouponEffectCountOk returns a tuple with the ReservecouponEffectCount field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetReservecouponEffectCountOk() (int32, bool) { - if o == nil || o.ReservecouponEffectCount == nil { - var ret int32 - return ret, false - } - return *o.ReservecouponEffectCount, true -} - -// HasReservecouponEffectCount returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasReservecouponEffectCount() bool { - if o != nil && o.ReservecouponEffectCount != nil { - return true - } - - return false -} - -// SetReservecouponEffectCount gets a reference to the given int32 and assigns it to the ReservecouponEffectCount field. -func (o *CampaignStateNotification) SetReservecouponEffectCount(v int32) { - o.ReservecouponEffectCount = &v -} - -// GetLastActivity returns the LastActivity field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetLastActivity() time.Time { - if o == nil || o.LastActivity == nil { - var ret time.Time - return ret - } - return *o.LastActivity -} - -// GetLastActivityOk returns a tuple with the LastActivity field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetLastActivityOk() (time.Time, bool) { - if o == nil || o.LastActivity == nil { - var ret time.Time - return ret, false - } - return *o.LastActivity, true -} - -// HasLastActivity returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasLastActivity() bool { - if o != nil && o.LastActivity != nil { - return true - } - - return false -} - -// SetLastActivity gets a reference to the given time.Time and assigns it to the LastActivity field. -func (o *CampaignStateNotification) SetLastActivity(v time.Time) { - o.LastActivity = &v -} - -// GetUpdated returns the Updated field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetUpdated() time.Time { - if o == nil || o.Updated == nil { - var ret time.Time - return ret - } - return *o.Updated -} - -// GetUpdatedOk returns a tuple with the Updated field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetUpdatedOk() (time.Time, bool) { - if o == nil || o.Updated == nil { - var ret time.Time - return ret, false - } - return *o.Updated, true -} - -// HasUpdated returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasUpdated() bool { - if o != nil && o.Updated != nil { - return true - } - - return false -} - -// SetUpdated gets a reference to the given time.Time and assigns it to the Updated field. -func (o *CampaignStateNotification) SetUpdated(v time.Time) { - o.Updated = &v -} - -// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetCreatedBy() string { - if o == nil || o.CreatedBy == nil { - var ret string - return ret - } - return *o.CreatedBy -} - -// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetCreatedByOk() (string, bool) { - if o == nil || o.CreatedBy == nil { - var ret string - return ret, false - } - return *o.CreatedBy, true -} - -// HasCreatedBy returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasCreatedBy() bool { - if o != nil && o.CreatedBy != nil { - return true - } - - return false -} - -// SetCreatedBy gets a reference to the given string and assigns it to the CreatedBy field. -func (o *CampaignStateNotification) SetCreatedBy(v string) { - o.CreatedBy = &v -} - -// GetUpdatedBy returns the UpdatedBy field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetUpdatedBy() string { - if o == nil || o.UpdatedBy == nil { - var ret string - return ret - } - return *o.UpdatedBy -} - -// GetUpdatedByOk returns a tuple with the UpdatedBy field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetUpdatedByOk() (string, bool) { - if o == nil || o.UpdatedBy == nil { - var ret string - return ret, false - } - return *o.UpdatedBy, true -} - -// HasUpdatedBy returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasUpdatedBy() bool { - if o != nil && o.UpdatedBy != nil { - return true - } - - return false -} - -// SetUpdatedBy gets a reference to the given string and assigns it to the UpdatedBy field. -func (o *CampaignStateNotification) SetUpdatedBy(v string) { - o.UpdatedBy = &v -} - -// GetTemplateId returns the TemplateId field value if set, zero value otherwise. -func (o *CampaignStateNotification) GetTemplateId() int32 { - if o == nil || o.TemplateId == nil { - var ret int32 - return ret - } - return *o.TemplateId -} - -// GetTemplateIdOk returns a tuple with the TemplateId field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *CampaignStateNotification) GetTemplateIdOk() (int32, bool) { - if o == nil || o.TemplateId == nil { - var ret int32 - return ret, false - } - return *o.TemplateId, true -} - -// HasTemplateId returns a boolean if a field has been set. -func (o *CampaignStateNotification) HasTemplateId() bool { - if o != nil && o.TemplateId != nil { - return true - } - - return false -} - -// SetTemplateId gets a reference to the given int32 and assigns it to the TemplateId field. -func (o *CampaignStateNotification) SetTemplateId(v int32) { - o.TemplateId = &v -} - -// GetFrontendState returns the FrontendState field value -func (o *CampaignStateNotification) GetFrontendState() string { - if o == nil { - var ret string - return ret - } - - return o.FrontendState -} - -// SetFrontendState sets field value -func (o *CampaignStateNotification) SetFrontendState(v string) { - o.FrontendState = v -} - -type NullableCampaignStateNotification struct { - Value CampaignStateNotification - ExplicitNull bool -} - -func (v NullableCampaignStateNotification) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableCampaignStateNotification) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_campaign_set_v2.go b/model_campaign_store_budget.go similarity index 54% rename from model_campaign_set_v2.go rename to model_campaign_store_budget.go index 3dd9e681..41d859c0 100644 --- a/model_campaign_set_v2.go +++ b/model_campaign_store_budget.go @@ -15,21 +15,22 @@ import ( "time" ) -// CampaignSetV2 -type CampaignSetV2 struct { +// CampaignStoreBudget +type CampaignStoreBudget struct { // Internal ID of this entity. Id int32 `json:"id"` // The time this entity was created. Created time.Time `json:"created"` - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // Version of the campaign set. - Version int32 `json:"version"` - Set CampaignPrioritiesV2 `json:"set"` + // The ID of the campaign that owns this entity. + CampaignId int32 `json:"campaignId"` + // The ID of the store. + StoreId int32 `json:"storeId"` + // The set of budget limits for stores linked to the campaign. + Limits []LimitConfig `json:"limits"` } // GetId returns the Id field value -func (o *CampaignSetV2) GetId() int32 { +func (o *CampaignStoreBudget) GetId() int32 { if o == nil { var ret int32 return ret @@ -39,12 +40,12 @@ func (o *CampaignSetV2) GetId() int32 { } // SetId sets field value -func (o *CampaignSetV2) SetId(v int32) { +func (o *CampaignStoreBudget) SetId(v int32) { o.Id = v } // GetCreated returns the Created field value -func (o *CampaignSetV2) GetCreated() time.Time { +func (o *CampaignStoreBudget) GetCreated() time.Time { if o == nil { var ret time.Time return ret @@ -54,61 +55,61 @@ func (o *CampaignSetV2) GetCreated() time.Time { } // SetCreated sets field value -func (o *CampaignSetV2) SetCreated(v time.Time) { +func (o *CampaignStoreBudget) SetCreated(v time.Time) { o.Created = v } -// GetApplicationId returns the ApplicationId field value -func (o *CampaignSetV2) GetApplicationId() int32 { +// GetCampaignId returns the CampaignId field value +func (o *CampaignStoreBudget) GetCampaignId() int32 { if o == nil { var ret int32 return ret } - return o.ApplicationId + return o.CampaignId } -// SetApplicationId sets field value -func (o *CampaignSetV2) SetApplicationId(v int32) { - o.ApplicationId = v +// SetCampaignId sets field value +func (o *CampaignStoreBudget) SetCampaignId(v int32) { + o.CampaignId = v } -// GetVersion returns the Version field value -func (o *CampaignSetV2) GetVersion() int32 { +// GetStoreId returns the StoreId field value +func (o *CampaignStoreBudget) GetStoreId() int32 { if o == nil { var ret int32 return ret } - return o.Version + return o.StoreId } -// SetVersion sets field value -func (o *CampaignSetV2) SetVersion(v int32) { - o.Version = v +// SetStoreId sets field value +func (o *CampaignStoreBudget) SetStoreId(v int32) { + o.StoreId = v } -// GetSet returns the Set field value -func (o *CampaignSetV2) GetSet() CampaignPrioritiesV2 { +// GetLimits returns the Limits field value +func (o *CampaignStoreBudget) GetLimits() []LimitConfig { if o == nil { - var ret CampaignPrioritiesV2 + var ret []LimitConfig return ret } - return o.Set + return o.Limits } -// SetSet sets field value -func (o *CampaignSetV2) SetSet(v CampaignPrioritiesV2) { - o.Set = v +// SetLimits sets field value +func (o *CampaignStoreBudget) SetLimits(v []LimitConfig) { + o.Limits = v } -type NullableCampaignSetV2 struct { - Value CampaignSetV2 +type NullableCampaignStoreBudget struct { + Value CampaignStoreBudget ExplicitNull bool } -func (v NullableCampaignSetV2) MarshalJSON() ([]byte, error) { +func (v NullableCampaignStoreBudget) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -117,7 +118,7 @@ func (v NullableCampaignSetV2) MarshalJSON() ([]byte, error) { } } -func (v *NullableCampaignSetV2) UnmarshalJSON(src []byte) error { +func (v *NullableCampaignStoreBudget) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_campaign_versions.go b/model_campaign_versions.go new file mode 100644 index 00000000..0cc439ce --- /dev/null +++ b/model_campaign_versions.go @@ -0,0 +1,252 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// CampaignVersions struct for CampaignVersions +type CampaignVersions struct { + // ID of the revision that was last activated on this campaign. + ActiveRevisionId *int32 `json:"activeRevisionId,omitempty"` + // ID of the revision version that is active on the campaign. + ActiveRevisionVersionId *int32 `json:"activeRevisionVersionId,omitempty"` + // Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. + Version *int32 `json:"version,omitempty"` + // ID of the revision currently being modified for the campaign. + CurrentRevisionId *int32 `json:"currentRevisionId,omitempty"` + // ID of the latest version applied on the current revision. + CurrentRevisionVersionId *int32 `json:"currentRevisionVersionId,omitempty"` + // Flag for determining whether we use current revision when sending requests with staging API key. + StageRevision *bool `json:"stageRevision,omitempty"` +} + +// GetActiveRevisionId returns the ActiveRevisionId field value if set, zero value otherwise. +func (o *CampaignVersions) GetActiveRevisionId() int32 { + if o == nil || o.ActiveRevisionId == nil { + var ret int32 + return ret + } + return *o.ActiveRevisionId +} + +// GetActiveRevisionIdOk returns a tuple with the ActiveRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetActiveRevisionIdOk() (int32, bool) { + if o == nil || o.ActiveRevisionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveRevisionId, true +} + +// HasActiveRevisionId returns a boolean if a field has been set. +func (o *CampaignVersions) HasActiveRevisionId() bool { + if o != nil && o.ActiveRevisionId != nil { + return true + } + + return false +} + +// SetActiveRevisionId gets a reference to the given int32 and assigns it to the ActiveRevisionId field. +func (o *CampaignVersions) SetActiveRevisionId(v int32) { + o.ActiveRevisionId = &v +} + +// GetActiveRevisionVersionId returns the ActiveRevisionVersionId field value if set, zero value otherwise. +func (o *CampaignVersions) GetActiveRevisionVersionId() int32 { + if o == nil || o.ActiveRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.ActiveRevisionVersionId +} + +// GetActiveRevisionVersionIdOk returns a tuple with the ActiveRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetActiveRevisionVersionIdOk() (int32, bool) { + if o == nil || o.ActiveRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveRevisionVersionId, true +} + +// HasActiveRevisionVersionId returns a boolean if a field has been set. +func (o *CampaignVersions) HasActiveRevisionVersionId() bool { + if o != nil && o.ActiveRevisionVersionId != nil { + return true + } + + return false +} + +// SetActiveRevisionVersionId gets a reference to the given int32 and assigns it to the ActiveRevisionVersionId field. +func (o *CampaignVersions) SetActiveRevisionVersionId(v int32) { + o.ActiveRevisionVersionId = &v +} + +// GetVersion returns the Version field value if set, zero value otherwise. +func (o *CampaignVersions) GetVersion() int32 { + if o == nil || o.Version == nil { + var ret int32 + return ret + } + return *o.Version +} + +// GetVersionOk returns a tuple with the Version field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetVersionOk() (int32, bool) { + if o == nil || o.Version == nil { + var ret int32 + return ret, false + } + return *o.Version, true +} + +// HasVersion returns a boolean if a field has been set. +func (o *CampaignVersions) HasVersion() bool { + if o != nil && o.Version != nil { + return true + } + + return false +} + +// SetVersion gets a reference to the given int32 and assigns it to the Version field. +func (o *CampaignVersions) SetVersion(v int32) { + o.Version = &v +} + +// GetCurrentRevisionId returns the CurrentRevisionId field value if set, zero value otherwise. +func (o *CampaignVersions) GetCurrentRevisionId() int32 { + if o == nil || o.CurrentRevisionId == nil { + var ret int32 + return ret + } + return *o.CurrentRevisionId +} + +// GetCurrentRevisionIdOk returns a tuple with the CurrentRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetCurrentRevisionIdOk() (int32, bool) { + if o == nil || o.CurrentRevisionId == nil { + var ret int32 + return ret, false + } + return *o.CurrentRevisionId, true +} + +// HasCurrentRevisionId returns a boolean if a field has been set. +func (o *CampaignVersions) HasCurrentRevisionId() bool { + if o != nil && o.CurrentRevisionId != nil { + return true + } + + return false +} + +// SetCurrentRevisionId gets a reference to the given int32 and assigns it to the CurrentRevisionId field. +func (o *CampaignVersions) SetCurrentRevisionId(v int32) { + o.CurrentRevisionId = &v +} + +// GetCurrentRevisionVersionId returns the CurrentRevisionVersionId field value if set, zero value otherwise. +func (o *CampaignVersions) GetCurrentRevisionVersionId() int32 { + if o == nil || o.CurrentRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.CurrentRevisionVersionId +} + +// GetCurrentRevisionVersionIdOk returns a tuple with the CurrentRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetCurrentRevisionVersionIdOk() (int32, bool) { + if o == nil || o.CurrentRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.CurrentRevisionVersionId, true +} + +// HasCurrentRevisionVersionId returns a boolean if a field has been set. +func (o *CampaignVersions) HasCurrentRevisionVersionId() bool { + if o != nil && o.CurrentRevisionVersionId != nil { + return true + } + + return false +} + +// SetCurrentRevisionVersionId gets a reference to the given int32 and assigns it to the CurrentRevisionVersionId field. +func (o *CampaignVersions) SetCurrentRevisionVersionId(v int32) { + o.CurrentRevisionVersionId = &v +} + +// GetStageRevision returns the StageRevision field value if set, zero value otherwise. +func (o *CampaignVersions) GetStageRevision() bool { + if o == nil || o.StageRevision == nil { + var ret bool + return ret + } + return *o.StageRevision +} + +// GetStageRevisionOk returns a tuple with the StageRevision field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CampaignVersions) GetStageRevisionOk() (bool, bool) { + if o == nil || o.StageRevision == nil { + var ret bool + return ret, false + } + return *o.StageRevision, true +} + +// HasStageRevision returns a boolean if a field has been set. +func (o *CampaignVersions) HasStageRevision() bool { + if o != nil && o.StageRevision != nil { + return true + } + + return false +} + +// SetStageRevision gets a reference to the given bool and assigns it to the StageRevision field. +func (o *CampaignVersions) SetStageRevision(v bool) { + o.StageRevision = &v +} + +type NullableCampaignVersions struct { + Value CampaignVersions + ExplicitNull bool +} + +func (v NullableCampaignVersions) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCampaignVersions) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_user_feed_notifications.go b/model_card_added_deducted_points_notification_policy.go similarity index 52% rename from model_user_feed_notifications.go rename to model_card_added_deducted_points_notification_policy.go index 598c9cd4..72a987bf 100644 --- a/model_user_feed_notifications.go +++ b/model_card_added_deducted_points_notification_policy.go @@ -12,53 +12,51 @@ package talon import ( "bytes" "encoding/json" - "time" ) -// UserFeedNotifications Notifications to notify CAMA user about. -type UserFeedNotifications struct { - // Timestamp of the last request for this list. - LastUpdate time.Time `json:"lastUpdate"` - // List of all notifications to notify the user about. - Notifications []FeedNotification `json:"notifications"` +// CardAddedDeductedPointsNotificationPolicy struct for CardAddedDeductedPointsNotificationPolicy +type CardAddedDeductedPointsNotificationPolicy struct { + // Notification name. + Name string `json:"name"` + Scopes []string `json:"scopes"` } -// GetLastUpdate returns the LastUpdate field value -func (o *UserFeedNotifications) GetLastUpdate() time.Time { +// GetName returns the Name field value +func (o *CardAddedDeductedPointsNotificationPolicy) GetName() string { if o == nil { - var ret time.Time + var ret string return ret } - return o.LastUpdate + return o.Name } -// SetLastUpdate sets field value -func (o *UserFeedNotifications) SetLastUpdate(v time.Time) { - o.LastUpdate = v +// SetName sets field value +func (o *CardAddedDeductedPointsNotificationPolicy) SetName(v string) { + o.Name = v } -// GetNotifications returns the Notifications field value -func (o *UserFeedNotifications) GetNotifications() []FeedNotification { +// GetScopes returns the Scopes field value +func (o *CardAddedDeductedPointsNotificationPolicy) GetScopes() []string { if o == nil { - var ret []FeedNotification + var ret []string return ret } - return o.Notifications + return o.Scopes } -// SetNotifications sets field value -func (o *UserFeedNotifications) SetNotifications(v []FeedNotification) { - o.Notifications = v +// SetScopes sets field value +func (o *CardAddedDeductedPointsNotificationPolicy) SetScopes(v []string) { + o.Scopes = v } -type NullableUserFeedNotifications struct { - Value UserFeedNotifications +type NullableCardAddedDeductedPointsNotificationPolicy struct { + Value CardAddedDeductedPointsNotificationPolicy ExplicitNull bool } -func (v NullableUserFeedNotifications) MarshalJSON() ([]byte, error) { +func (v NullableCardAddedDeductedPointsNotificationPolicy) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -67,7 +65,7 @@ func (v NullableUserFeedNotifications) MarshalJSON() ([]byte, error) { } } -func (v *NullableUserFeedNotifications) UnmarshalJSON(src []byte) error { +func (v *NullableCardAddedDeductedPointsNotificationPolicy) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_cart_item.go b/model_cart_item.go index 4ed295af..abfa36b6 100644 --- a/model_cart_item.go +++ b/model_cart_item.go @@ -41,7 +41,7 @@ type CartItem struct { Length *float32 `json:"length,omitempty"` // Position of the Cart Item in the Cart (calculated internally). Position *float32 `json:"position,omitempty"` - // Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. + // Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. Attributes *map[string]interface{} `json:"attributes,omitempty"` // Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). AdditionalCosts *map[string]AdditionalCost `json:"additionalCosts,omitempty"` diff --git a/model_code_generator_settings.go b/model_code_generator_settings.go index b0e070c8..e6323d18 100644 --- a/model_code_generator_settings.go +++ b/model_code_generator_settings.go @@ -18,7 +18,7 @@ import ( type CodeGeneratorSettings struct { // List of characters used to generate the random parts of a code. ValidCharacters []string `json:"validCharacters"` - // The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. + // The pattern used to generate codes, such as coupon codes, referral codes, and loyalty cards. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. CouponPattern string `json:"couponPattern"` } diff --git a/model_coupon.go b/model_coupon.go index 4a76fb91..91c55457 100644 --- a/model_coupon.go +++ b/model_coupon.go @@ -33,7 +33,7 @@ type Coupon struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. Limits *[]LimitConfig `json:"limits,omitempty"` diff --git a/model_coupon_constraints.go b/model_coupon_constraints.go index 615846d1..ede415b5 100644 --- a/model_coupon_constraints.go +++ b/model_coupon_constraints.go @@ -25,7 +25,7 @@ type CouponConstraints struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` } diff --git a/model_coupon_creation_job.go b/model_coupon_creation_job.go index 1b70c88e..162ea9f6 100644 --- a/model_coupon_creation_job.go +++ b/model_coupon_creation_job.go @@ -35,7 +35,7 @@ type CouponCreationJob struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of new coupon codes to generate for the campaign. NumberOfCoupons int32 `json:"numberOfCoupons"` diff --git a/model_coupon_deletion_filters.go b/model_coupon_deletion_filters.go new file mode 100644 index 00000000..4e8ede06 --- /dev/null +++ b/model_coupon_deletion_filters.go @@ -0,0 +1,533 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CouponDeletionFilters struct for CouponDeletionFilters +type CouponDeletionFilters struct { + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + CreatedBefore *time.Time `json:"createdBefore,omitempty"` + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + CreatedAfter *time.Time `json:"createdAfter,omitempty"` + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + StartsAfter *time.Time `json:"startsAfter,omitempty"` + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + StartsBefore *time.Time `json:"startsBefore,omitempty"` + // - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which the start date is null or in the past and the expiration date is null or in the future. - `validFuture`: Matches coupons in which the start date is set and in the future. + Valid *string `json:"valid,omitempty"` + // - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. + Usable *bool `json:"usable,omitempty"` + // - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. **Note:** This field cannot be used in conjunction with the `usable` query parameter. + Redeemed *bool `json:"redeemed,omitempty"` + // Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field. + RecipientIntegrationId *string `json:"recipientIntegrationId,omitempty"` + // Filter results to an exact case-insensitive matching against the coupon code + ExactMatch *bool `json:"exactMatch,omitempty"` + // Filter results by the coupon code + Value *string `json:"value,omitempty"` + // Filter results by batches of coupons + BatchId *string `json:"batchId,omitempty"` + // Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. + ReferralId *int32 `json:"referralId,omitempty"` + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + ExpiresAfter *time.Time `json:"expiresAfter,omitempty"` + // Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. + ExpiresBefore *time.Time `json:"expiresBefore,omitempty"` +} + +// GetCreatedBefore returns the CreatedBefore field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetCreatedBefore() time.Time { + if o == nil || o.CreatedBefore == nil { + var ret time.Time + return ret + } + return *o.CreatedBefore +} + +// GetCreatedBeforeOk returns a tuple with the CreatedBefore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetCreatedBeforeOk() (time.Time, bool) { + if o == nil || o.CreatedBefore == nil { + var ret time.Time + return ret, false + } + return *o.CreatedBefore, true +} + +// HasCreatedBefore returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasCreatedBefore() bool { + if o != nil && o.CreatedBefore != nil { + return true + } + + return false +} + +// SetCreatedBefore gets a reference to the given time.Time and assigns it to the CreatedBefore field. +func (o *CouponDeletionFilters) SetCreatedBefore(v time.Time) { + o.CreatedBefore = &v +} + +// GetCreatedAfter returns the CreatedAfter field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetCreatedAfter() time.Time { + if o == nil || o.CreatedAfter == nil { + var ret time.Time + return ret + } + return *o.CreatedAfter +} + +// GetCreatedAfterOk returns a tuple with the CreatedAfter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetCreatedAfterOk() (time.Time, bool) { + if o == nil || o.CreatedAfter == nil { + var ret time.Time + return ret, false + } + return *o.CreatedAfter, true +} + +// HasCreatedAfter returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasCreatedAfter() bool { + if o != nil && o.CreatedAfter != nil { + return true + } + + return false +} + +// SetCreatedAfter gets a reference to the given time.Time and assigns it to the CreatedAfter field. +func (o *CouponDeletionFilters) SetCreatedAfter(v time.Time) { + o.CreatedAfter = &v +} + +// GetStartsAfter returns the StartsAfter field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetStartsAfter() time.Time { + if o == nil || o.StartsAfter == nil { + var ret time.Time + return ret + } + return *o.StartsAfter +} + +// GetStartsAfterOk returns a tuple with the StartsAfter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetStartsAfterOk() (time.Time, bool) { + if o == nil || o.StartsAfter == nil { + var ret time.Time + return ret, false + } + return *o.StartsAfter, true +} + +// HasStartsAfter returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasStartsAfter() bool { + if o != nil && o.StartsAfter != nil { + return true + } + + return false +} + +// SetStartsAfter gets a reference to the given time.Time and assigns it to the StartsAfter field. +func (o *CouponDeletionFilters) SetStartsAfter(v time.Time) { + o.StartsAfter = &v +} + +// GetStartsBefore returns the StartsBefore field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetStartsBefore() time.Time { + if o == nil || o.StartsBefore == nil { + var ret time.Time + return ret + } + return *o.StartsBefore +} + +// GetStartsBeforeOk returns a tuple with the StartsBefore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetStartsBeforeOk() (time.Time, bool) { + if o == nil || o.StartsBefore == nil { + var ret time.Time + return ret, false + } + return *o.StartsBefore, true +} + +// HasStartsBefore returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasStartsBefore() bool { + if o != nil && o.StartsBefore != nil { + return true + } + + return false +} + +// SetStartsBefore gets a reference to the given time.Time and assigns it to the StartsBefore field. +func (o *CouponDeletionFilters) SetStartsBefore(v time.Time) { + o.StartsBefore = &v +} + +// GetValid returns the Valid field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetValid() string { + if o == nil || o.Valid == nil { + var ret string + return ret + } + return *o.Valid +} + +// GetValidOk returns a tuple with the Valid field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetValidOk() (string, bool) { + if o == nil || o.Valid == nil { + var ret string + return ret, false + } + return *o.Valid, true +} + +// HasValid returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasValid() bool { + if o != nil && o.Valid != nil { + return true + } + + return false +} + +// SetValid gets a reference to the given string and assigns it to the Valid field. +func (o *CouponDeletionFilters) SetValid(v string) { + o.Valid = &v +} + +// GetUsable returns the Usable field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetUsable() bool { + if o == nil || o.Usable == nil { + var ret bool + return ret + } + return *o.Usable +} + +// GetUsableOk returns a tuple with the Usable field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetUsableOk() (bool, bool) { + if o == nil || o.Usable == nil { + var ret bool + return ret, false + } + return *o.Usable, true +} + +// HasUsable returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasUsable() bool { + if o != nil && o.Usable != nil { + return true + } + + return false +} + +// SetUsable gets a reference to the given bool and assigns it to the Usable field. +func (o *CouponDeletionFilters) SetUsable(v bool) { + o.Usable = &v +} + +// GetRedeemed returns the Redeemed field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetRedeemed() bool { + if o == nil || o.Redeemed == nil { + var ret bool + return ret + } + return *o.Redeemed +} + +// GetRedeemedOk returns a tuple with the Redeemed field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetRedeemedOk() (bool, bool) { + if o == nil || o.Redeemed == nil { + var ret bool + return ret, false + } + return *o.Redeemed, true +} + +// HasRedeemed returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasRedeemed() bool { + if o != nil && o.Redeemed != nil { + return true + } + + return false +} + +// SetRedeemed gets a reference to the given bool and assigns it to the Redeemed field. +func (o *CouponDeletionFilters) SetRedeemed(v bool) { + o.Redeemed = &v +} + +// GetRecipientIntegrationId returns the RecipientIntegrationId field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetRecipientIntegrationId() string { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret + } + return *o.RecipientIntegrationId +} + +// GetRecipientIntegrationIdOk returns a tuple with the RecipientIntegrationId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetRecipientIntegrationIdOk() (string, bool) { + if o == nil || o.RecipientIntegrationId == nil { + var ret string + return ret, false + } + return *o.RecipientIntegrationId, true +} + +// HasRecipientIntegrationId returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasRecipientIntegrationId() bool { + if o != nil && o.RecipientIntegrationId != nil { + return true + } + + return false +} + +// SetRecipientIntegrationId gets a reference to the given string and assigns it to the RecipientIntegrationId field. +func (o *CouponDeletionFilters) SetRecipientIntegrationId(v string) { + o.RecipientIntegrationId = &v +} + +// GetExactMatch returns the ExactMatch field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetExactMatch() bool { + if o == nil || o.ExactMatch == nil { + var ret bool + return ret + } + return *o.ExactMatch +} + +// GetExactMatchOk returns a tuple with the ExactMatch field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetExactMatchOk() (bool, bool) { + if o == nil || o.ExactMatch == nil { + var ret bool + return ret, false + } + return *o.ExactMatch, true +} + +// HasExactMatch returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasExactMatch() bool { + if o != nil && o.ExactMatch != nil { + return true + } + + return false +} + +// SetExactMatch gets a reference to the given bool and assigns it to the ExactMatch field. +func (o *CouponDeletionFilters) SetExactMatch(v bool) { + o.ExactMatch = &v +} + +// GetValue returns the Value field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetValue() string { + if o == nil || o.Value == nil { + var ret string + return ret + } + return *o.Value +} + +// GetValueOk returns a tuple with the Value field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetValueOk() (string, bool) { + if o == nil || o.Value == nil { + var ret string + return ret, false + } + return *o.Value, true +} + +// HasValue returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasValue() bool { + if o != nil && o.Value != nil { + return true + } + + return false +} + +// SetValue gets a reference to the given string and assigns it to the Value field. +func (o *CouponDeletionFilters) SetValue(v string) { + o.Value = &v +} + +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string + return ret + } + return *o.BatchId +} + +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true +} + +// HasBatchId returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *CouponDeletionFilters) SetBatchId(v string) { + o.BatchId = &v +} + +// GetReferralId returns the ReferralId field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetReferralId() int32 { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret + } + return *o.ReferralId +} + +// GetReferralIdOk returns a tuple with the ReferralId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetReferralIdOk() (int32, bool) { + if o == nil || o.ReferralId == nil { + var ret int32 + return ret, false + } + return *o.ReferralId, true +} + +// HasReferralId returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasReferralId() bool { + if o != nil && o.ReferralId != nil { + return true + } + + return false +} + +// SetReferralId gets a reference to the given int32 and assigns it to the ReferralId field. +func (o *CouponDeletionFilters) SetReferralId(v int32) { + o.ReferralId = &v +} + +// GetExpiresAfter returns the ExpiresAfter field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetExpiresAfter() time.Time { + if o == nil || o.ExpiresAfter == nil { + var ret time.Time + return ret + } + return *o.ExpiresAfter +} + +// GetExpiresAfterOk returns a tuple with the ExpiresAfter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetExpiresAfterOk() (time.Time, bool) { + if o == nil || o.ExpiresAfter == nil { + var ret time.Time + return ret, false + } + return *o.ExpiresAfter, true +} + +// HasExpiresAfter returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasExpiresAfter() bool { + if o != nil && o.ExpiresAfter != nil { + return true + } + + return false +} + +// SetExpiresAfter gets a reference to the given time.Time and assigns it to the ExpiresAfter field. +func (o *CouponDeletionFilters) SetExpiresAfter(v time.Time) { + o.ExpiresAfter = &v +} + +// GetExpiresBefore returns the ExpiresBefore field value if set, zero value otherwise. +func (o *CouponDeletionFilters) GetExpiresBefore() time.Time { + if o == nil || o.ExpiresBefore == nil { + var ret time.Time + return ret + } + return *o.ExpiresBefore +} + +// GetExpiresBeforeOk returns a tuple with the ExpiresBefore field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionFilters) GetExpiresBeforeOk() (time.Time, bool) { + if o == nil || o.ExpiresBefore == nil { + var ret time.Time + return ret, false + } + return *o.ExpiresBefore, true +} + +// HasExpiresBefore returns a boolean if a field has been set. +func (o *CouponDeletionFilters) HasExpiresBefore() bool { + if o != nil && o.ExpiresBefore != nil { + return true + } + + return false +} + +// SetExpiresBefore gets a reference to the given time.Time and assigns it to the ExpiresBefore field. +func (o *CouponDeletionFilters) SetExpiresBefore(v time.Time) { + o.ExpiresBefore = &v +} + +type NullableCouponDeletionFilters struct { + Value CouponDeletionFilters + ExplicitNull bool +} + +func (v NullableCouponDeletionFilters) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCouponDeletionFilters) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_coupon_deletion_job.go b/model_coupon_deletion_job.go new file mode 100644 index 00000000..d4177357 --- /dev/null +++ b/model_coupon_deletion_job.go @@ -0,0 +1,281 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// CouponDeletionJob +type CouponDeletionJob struct { + // Internal ID of this entity. + Id int32 `json:"id"` + // The time this entity was created. + Created time.Time `json:"created"` + // The ID of the application that owns this entity. + ApplicationId int32 `json:"applicationId"` + // The ID of the account that owns this entity. + AccountId int32 `json:"accountId"` + Filters CouponDeletionFilters `json:"filters"` + // The current status of this request. Possible values: - `not_ready` - `pending` - `completed` - `failed` + Status string `json:"status"` + // The number of coupon codes that were already deleted for this request. + DeletedAmount *int32 `json:"deletedAmount,omitempty"` + // The number of times this job failed. + FailCount int32 `json:"failCount"` + // An array of individual problems encountered during the request. + Errors []string `json:"errors"` + // ID of the user who created this effect. + CreatedBy int32 `json:"createdBy"` + // Indicates whether the user that created this job was notified of its final state. + Communicated bool `json:"communicated"` + CampaignIDs *[]int32 `json:"campaignIDs,omitempty"` +} + +// GetId returns the Id field value +func (o *CouponDeletionJob) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *CouponDeletionJob) SetId(v int32) { + o.Id = v +} + +// GetCreated returns the Created field value +func (o *CouponDeletionJob) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *CouponDeletionJob) SetCreated(v time.Time) { + o.Created = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *CouponDeletionJob) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *CouponDeletionJob) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetAccountId returns the AccountId field value +func (o *CouponDeletionJob) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *CouponDeletionJob) SetAccountId(v int32) { + o.AccountId = v +} + +// GetFilters returns the Filters field value +func (o *CouponDeletionJob) GetFilters() CouponDeletionFilters { + if o == nil { + var ret CouponDeletionFilters + return ret + } + + return o.Filters +} + +// SetFilters sets field value +func (o *CouponDeletionJob) SetFilters(v CouponDeletionFilters) { + o.Filters = v +} + +// GetStatus returns the Status field value +func (o *CouponDeletionJob) GetStatus() string { + if o == nil { + var ret string + return ret + } + + return o.Status +} + +// SetStatus sets field value +func (o *CouponDeletionJob) SetStatus(v string) { + o.Status = v +} + +// GetDeletedAmount returns the DeletedAmount field value if set, zero value otherwise. +func (o *CouponDeletionJob) GetDeletedAmount() int32 { + if o == nil || o.DeletedAmount == nil { + var ret int32 + return ret + } + return *o.DeletedAmount +} + +// GetDeletedAmountOk returns a tuple with the DeletedAmount field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionJob) GetDeletedAmountOk() (int32, bool) { + if o == nil || o.DeletedAmount == nil { + var ret int32 + return ret, false + } + return *o.DeletedAmount, true +} + +// HasDeletedAmount returns a boolean if a field has been set. +func (o *CouponDeletionJob) HasDeletedAmount() bool { + if o != nil && o.DeletedAmount != nil { + return true + } + + return false +} + +// SetDeletedAmount gets a reference to the given int32 and assigns it to the DeletedAmount field. +func (o *CouponDeletionJob) SetDeletedAmount(v int32) { + o.DeletedAmount = &v +} + +// GetFailCount returns the FailCount field value +func (o *CouponDeletionJob) GetFailCount() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.FailCount +} + +// SetFailCount sets field value +func (o *CouponDeletionJob) SetFailCount(v int32) { + o.FailCount = v +} + +// GetErrors returns the Errors field value +func (o *CouponDeletionJob) GetErrors() []string { + if o == nil { + var ret []string + return ret + } + + return o.Errors +} + +// SetErrors sets field value +func (o *CouponDeletionJob) SetErrors(v []string) { + o.Errors = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *CouponDeletionJob) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *CouponDeletionJob) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetCommunicated returns the Communicated field value +func (o *CouponDeletionJob) GetCommunicated() bool { + if o == nil { + var ret bool + return ret + } + + return o.Communicated +} + +// SetCommunicated sets field value +func (o *CouponDeletionJob) SetCommunicated(v bool) { + o.Communicated = v +} + +// GetCampaignIDs returns the CampaignIDs field value if set, zero value otherwise. +func (o *CouponDeletionJob) GetCampaignIDs() []int32 { + if o == nil || o.CampaignIDs == nil { + var ret []int32 + return ret + } + return *o.CampaignIDs +} + +// GetCampaignIDsOk returns a tuple with the CampaignIDs field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *CouponDeletionJob) GetCampaignIDsOk() ([]int32, bool) { + if o == nil || o.CampaignIDs == nil { + var ret []int32 + return ret, false + } + return *o.CampaignIDs, true +} + +// HasCampaignIDs returns a boolean if a field has been set. +func (o *CouponDeletionJob) HasCampaignIDs() bool { + if o != nil && o.CampaignIDs != nil { + return true + } + + return false +} + +// SetCampaignIDs gets a reference to the given []int32 and assigns it to the CampaignIDs field. +func (o *CouponDeletionJob) SetCampaignIDs(v []int32) { + o.CampaignIDs = &v +} + +type NullableCouponDeletionJob struct { + Value CouponDeletionJob + ExplicitNull bool +} + +func (v NullableCouponDeletionJob) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableCouponDeletionJob) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_customer_session_v2.go b/model_customer_session_v2.go index e1cc28ed..0731f67f 100644 --- a/model_customer_session_v2.go +++ b/model_customer_session_v2.go @@ -31,9 +31,9 @@ type CustomerSessionV2 struct { StoreIntegrationId *string `json:"storeIntegrationId,omitempty"` // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` - // Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. + // Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely. CouponCodes *[]string `json:"couponCodes,omitempty"` - // Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. + // Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely. ReferralCode *string `json:"referralCode,omitempty"` // Identifier of a loyalty card. LoyaltyCards *[]string `json:"loyaltyCards,omitempty"` diff --git a/model_effect.go b/model_effect.go index 200b6149..c0766160 100644 --- a/model_effect.go +++ b/model_effect.go @@ -32,6 +32,14 @@ type Effect struct { TriggeredForCatalogItem *int32 `json:"triggeredForCatalogItem,omitempty"` // The index of the condition that was triggered. ConditionIndex *int32 `json:"conditionIndex,omitempty"` + // The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + EvaluationGroupID *int32 `json:"evaluationGroupID,omitempty"` + // The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + EvaluationGroupMode *string `json:"evaluationGroupMode,omitempty"` + // The revision ID of the campaign that was used when triggering the effect. + CampaignRevisionId *int32 `json:"campaignRevisionId,omitempty"` + // The revision version ID of the campaign that was used when triggering the effect. + CampaignRevisionVersionId *int32 `json:"campaignRevisionVersionId,omitempty"` // The properties of the effect. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). Props map[string]interface{} `json:"props"` } @@ -210,6 +218,138 @@ func (o *Effect) SetConditionIndex(v int32) { o.ConditionIndex = &v } +// GetEvaluationGroupID returns the EvaluationGroupID field value if set, zero value otherwise. +func (o *Effect) GetEvaluationGroupID() int32 { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret + } + return *o.EvaluationGroupID +} + +// GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Effect) GetEvaluationGroupIDOk() (int32, bool) { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret, false + } + return *o.EvaluationGroupID, true +} + +// HasEvaluationGroupID returns a boolean if a field has been set. +func (o *Effect) HasEvaluationGroupID() bool { + if o != nil && o.EvaluationGroupID != nil { + return true + } + + return false +} + +// SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. +func (o *Effect) SetEvaluationGroupID(v int32) { + o.EvaluationGroupID = &v +} + +// GetEvaluationGroupMode returns the EvaluationGroupMode field value if set, zero value otherwise. +func (o *Effect) GetEvaluationGroupMode() string { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret + } + return *o.EvaluationGroupMode +} + +// GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Effect) GetEvaluationGroupModeOk() (string, bool) { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret, false + } + return *o.EvaluationGroupMode, true +} + +// HasEvaluationGroupMode returns a boolean if a field has been set. +func (o *Effect) HasEvaluationGroupMode() bool { + if o != nil && o.EvaluationGroupMode != nil { + return true + } + + return false +} + +// SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. +func (o *Effect) SetEvaluationGroupMode(v string) { + o.EvaluationGroupMode = &v +} + +// GetCampaignRevisionId returns the CampaignRevisionId field value if set, zero value otherwise. +func (o *Effect) GetCampaignRevisionId() int32 { + if o == nil || o.CampaignRevisionId == nil { + var ret int32 + return ret + } + return *o.CampaignRevisionId +} + +// GetCampaignRevisionIdOk returns a tuple with the CampaignRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Effect) GetCampaignRevisionIdOk() (int32, bool) { + if o == nil || o.CampaignRevisionId == nil { + var ret int32 + return ret, false + } + return *o.CampaignRevisionId, true +} + +// HasCampaignRevisionId returns a boolean if a field has been set. +func (o *Effect) HasCampaignRevisionId() bool { + if o != nil && o.CampaignRevisionId != nil { + return true + } + + return false +} + +// SetCampaignRevisionId gets a reference to the given int32 and assigns it to the CampaignRevisionId field. +func (o *Effect) SetCampaignRevisionId(v int32) { + o.CampaignRevisionId = &v +} + +// GetCampaignRevisionVersionId returns the CampaignRevisionVersionId field value if set, zero value otherwise. +func (o *Effect) GetCampaignRevisionVersionId() int32 { + if o == nil || o.CampaignRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.CampaignRevisionVersionId +} + +// GetCampaignRevisionVersionIdOk returns a tuple with the CampaignRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Effect) GetCampaignRevisionVersionIdOk() (int32, bool) { + if o == nil || o.CampaignRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.CampaignRevisionVersionId, true +} + +// HasCampaignRevisionVersionId returns a boolean if a field has been set. +func (o *Effect) HasCampaignRevisionVersionId() bool { + if o != nil && o.CampaignRevisionVersionId != nil { + return true + } + + return false +} + +// SetCampaignRevisionVersionId gets a reference to the given int32 and assigns it to the CampaignRevisionVersionId field. +func (o *Effect) SetCampaignRevisionVersionId(v int32) { + o.CampaignRevisionVersionId = &v +} + // GetProps returns the Props field value func (o *Effect) GetProps() map[string]interface{} { if o == nil { diff --git a/model_effect_entity.go b/model_effect_entity.go index 3813fc5d..c8c3e05b 100644 --- a/model_effect_entity.go +++ b/model_effect_entity.go @@ -32,6 +32,14 @@ type EffectEntity struct { TriggeredForCatalogItem *int32 `json:"triggeredForCatalogItem,omitempty"` // The index of the condition that was triggered. ConditionIndex *int32 `json:"conditionIndex,omitempty"` + // The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + EvaluationGroupID *int32 `json:"evaluationGroupID,omitempty"` + // The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + EvaluationGroupMode *string `json:"evaluationGroupMode,omitempty"` + // The revision ID of the campaign that was used when triggering the effect. + CampaignRevisionId *int32 `json:"campaignRevisionId,omitempty"` + // The revision version ID of the campaign that was used when triggering the effect. + CampaignRevisionVersionId *int32 `json:"campaignRevisionVersionId,omitempty"` } // GetCampaignId returns the CampaignId field value @@ -208,6 +216,138 @@ func (o *EffectEntity) SetConditionIndex(v int32) { o.ConditionIndex = &v } +// GetEvaluationGroupID returns the EvaluationGroupID field value if set, zero value otherwise. +func (o *EffectEntity) GetEvaluationGroupID() int32 { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret + } + return *o.EvaluationGroupID +} + +// GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EffectEntity) GetEvaluationGroupIDOk() (int32, bool) { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret, false + } + return *o.EvaluationGroupID, true +} + +// HasEvaluationGroupID returns a boolean if a field has been set. +func (o *EffectEntity) HasEvaluationGroupID() bool { + if o != nil && o.EvaluationGroupID != nil { + return true + } + + return false +} + +// SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. +func (o *EffectEntity) SetEvaluationGroupID(v int32) { + o.EvaluationGroupID = &v +} + +// GetEvaluationGroupMode returns the EvaluationGroupMode field value if set, zero value otherwise. +func (o *EffectEntity) GetEvaluationGroupMode() string { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret + } + return *o.EvaluationGroupMode +} + +// GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EffectEntity) GetEvaluationGroupModeOk() (string, bool) { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret, false + } + return *o.EvaluationGroupMode, true +} + +// HasEvaluationGroupMode returns a boolean if a field has been set. +func (o *EffectEntity) HasEvaluationGroupMode() bool { + if o != nil && o.EvaluationGroupMode != nil { + return true + } + + return false +} + +// SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. +func (o *EffectEntity) SetEvaluationGroupMode(v string) { + o.EvaluationGroupMode = &v +} + +// GetCampaignRevisionId returns the CampaignRevisionId field value if set, zero value otherwise. +func (o *EffectEntity) GetCampaignRevisionId() int32 { + if o == nil || o.CampaignRevisionId == nil { + var ret int32 + return ret + } + return *o.CampaignRevisionId +} + +// GetCampaignRevisionIdOk returns a tuple with the CampaignRevisionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EffectEntity) GetCampaignRevisionIdOk() (int32, bool) { + if o == nil || o.CampaignRevisionId == nil { + var ret int32 + return ret, false + } + return *o.CampaignRevisionId, true +} + +// HasCampaignRevisionId returns a boolean if a field has been set. +func (o *EffectEntity) HasCampaignRevisionId() bool { + if o != nil && o.CampaignRevisionId != nil { + return true + } + + return false +} + +// SetCampaignRevisionId gets a reference to the given int32 and assigns it to the CampaignRevisionId field. +func (o *EffectEntity) SetCampaignRevisionId(v int32) { + o.CampaignRevisionId = &v +} + +// GetCampaignRevisionVersionId returns the CampaignRevisionVersionId field value if set, zero value otherwise. +func (o *EffectEntity) GetCampaignRevisionVersionId() int32 { + if o == nil || o.CampaignRevisionVersionId == nil { + var ret int32 + return ret + } + return *o.CampaignRevisionVersionId +} + +// GetCampaignRevisionVersionIdOk returns a tuple with the CampaignRevisionVersionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *EffectEntity) GetCampaignRevisionVersionIdOk() (int32, bool) { + if o == nil || o.CampaignRevisionVersionId == nil { + var ret int32 + return ret, false + } + return *o.CampaignRevisionVersionId, true +} + +// HasCampaignRevisionVersionId returns a boolean if a field has been set. +func (o *EffectEntity) HasCampaignRevisionVersionId() bool { + if o != nil && o.CampaignRevisionVersionId != nil { + return true + } + + return false +} + +// SetCampaignRevisionVersionId gets a reference to the given int32 and assigns it to the CampaignRevisionVersionId field. +func (o *EffectEntity) SetCampaignRevisionVersionId(v int32) { + o.CampaignRevisionVersionId = &v +} + type NullableEffectEntity struct { Value EffectEntity ExplicitNull bool diff --git a/model_environment.go b/model_environment.go index 42818965..32451f3b 100644 --- a/model_environment.go +++ b/model_environment.go @@ -45,6 +45,8 @@ type Environment struct { Audiences *[]Audience `json:"audiences,omitempty"` // The account-level collections that the application is subscribed to. Collections *[]Collection `json:"collections,omitempty"` + // The cart item filters belonging to the Application. + ApplicationCartItemFilters *[]ApplicationCif `json:"applicationCartItemFilters,omitempty"` } // GetId returns the Id field value @@ -383,6 +385,39 @@ func (o *Environment) SetCollections(v []Collection) { o.Collections = &v } +// GetApplicationCartItemFilters returns the ApplicationCartItemFilters field value if set, zero value otherwise. +func (o *Environment) GetApplicationCartItemFilters() []ApplicationCif { + if o == nil || o.ApplicationCartItemFilters == nil { + var ret []ApplicationCif + return ret + } + return *o.ApplicationCartItemFilters +} + +// GetApplicationCartItemFiltersOk returns a tuple with the ApplicationCartItemFilters field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Environment) GetApplicationCartItemFiltersOk() ([]ApplicationCif, bool) { + if o == nil || o.ApplicationCartItemFilters == nil { + var ret []ApplicationCif + return ret, false + } + return *o.ApplicationCartItemFilters, true +} + +// HasApplicationCartItemFilters returns a boolean if a field has been set. +func (o *Environment) HasApplicationCartItemFilters() bool { + if o != nil && o.ApplicationCartItemFilters != nil { + return true + } + + return false +} + +// SetApplicationCartItemFilters gets a reference to the given []ApplicationCif and assigns it to the ApplicationCartItemFilters field. +func (o *Environment) SetApplicationCartItemFilters(v []ApplicationCif) { + o.ApplicationCartItemFilters = &v +} + type NullableEnvironment struct { Value Environment ExplicitNull bool diff --git a/model_event.go b/model_event.go index 486eeaf9..fb541761 100644 --- a/model_event.go +++ b/model_event.go @@ -34,10 +34,10 @@ type Event struct { // The ID of the session that this event occurred in. SessionId *string `json:"sessionId,omitempty"` // An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - Effects [][]interface{} `json:"effects"` + Effects []map[string]interface{} `json:"effects"` // Ledger entries for the event. - LedgerEntries []LedgerEntry `json:"ledgerEntries"` - Meta *Meta `json:"meta,omitempty"` + LedgerEntries *[]LedgerEntry `json:"ledgerEntries,omitempty"` + Meta *Meta `json:"meta,omitempty"` } // GetId returns the Id field value @@ -215,9 +215,9 @@ func (o *Event) SetSessionId(v string) { } // GetEffects returns the Effects field value -func (o *Event) GetEffects() [][]interface{} { +func (o *Event) GetEffects() []map[string]interface{} { if o == nil { - var ret [][]interface{} + var ret []map[string]interface{} return ret } @@ -225,23 +225,41 @@ func (o *Event) GetEffects() [][]interface{} { } // SetEffects sets field value -func (o *Event) SetEffects(v [][]interface{}) { +func (o *Event) SetEffects(v []map[string]interface{}) { o.Effects = v } -// GetLedgerEntries returns the LedgerEntries field value +// GetLedgerEntries returns the LedgerEntries field value if set, zero value otherwise. func (o *Event) GetLedgerEntries() []LedgerEntry { - if o == nil { + if o == nil || o.LedgerEntries == nil { var ret []LedgerEntry return ret } + return *o.LedgerEntries +} + +// GetLedgerEntriesOk returns a tuple with the LedgerEntries field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Event) GetLedgerEntriesOk() ([]LedgerEntry, bool) { + if o == nil || o.LedgerEntries == nil { + var ret []LedgerEntry + return ret, false + } + return *o.LedgerEntries, true +} + +// HasLedgerEntries returns a boolean if a field has been set. +func (o *Event) HasLedgerEntries() bool { + if o != nil && o.LedgerEntries != nil { + return true + } - return o.LedgerEntries + return false } -// SetLedgerEntries sets field value +// SetLedgerEntries gets a reference to the given []LedgerEntry and assigns it to the LedgerEntries field. func (o *Event) SetLedgerEntries(v []LedgerEntry) { - o.LedgerEntries = v + o.LedgerEntries = &v } // GetMeta returns the Meta field value if set, zero value otherwise. diff --git a/model_feed_notification.go b/model_feed_notification.go deleted file mode 100644 index 7e33e5b8..00000000 --- a/model_feed_notification.go +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// FeedNotification A feed notification for CAMA users. -type FeedNotification struct { - // Title of the feed notification. - Title string `json:"title"` - // Timestamp of the moment this feed notification was created. - Created time.Time `json:"created"` - // Timestamp of the moment this feed notification was last updated. - Updated time.Time `json:"updated"` - // URL to the feed notification in the help center. - ArticleUrl string `json:"articleUrl"` - // The type of the feed notification. - Type string `json:"type"` - // Body of the feed notification. - Body string `json:"body"` -} - -// GetTitle returns the Title field value -func (o *FeedNotification) GetTitle() string { - if o == nil { - var ret string - return ret - } - - return o.Title -} - -// SetTitle sets field value -func (o *FeedNotification) SetTitle(v string) { - o.Title = v -} - -// GetCreated returns the Created field value -func (o *FeedNotification) GetCreated() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Created -} - -// SetCreated sets field value -func (o *FeedNotification) SetCreated(v time.Time) { - o.Created = v -} - -// GetUpdated returns the Updated field value -func (o *FeedNotification) GetUpdated() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Updated -} - -// SetUpdated sets field value -func (o *FeedNotification) SetUpdated(v time.Time) { - o.Updated = v -} - -// GetArticleUrl returns the ArticleUrl field value -func (o *FeedNotification) GetArticleUrl() string { - if o == nil { - var ret string - return ret - } - - return o.ArticleUrl -} - -// SetArticleUrl sets field value -func (o *FeedNotification) SetArticleUrl(v string) { - o.ArticleUrl = v -} - -// GetType returns the Type field value -func (o *FeedNotification) GetType() string { - if o == nil { - var ret string - return ret - } - - return o.Type -} - -// SetType sets field value -func (o *FeedNotification) SetType(v string) { - o.Type = v -} - -// GetBody returns the Body field value -func (o *FeedNotification) GetBody() string { - if o == nil { - var ret string - return ret - } - - return o.Body -} - -// SetBody sets field value -func (o *FeedNotification) SetBody(v string) { - o.Body = v -} - -type NullableFeedNotification struct { - Value FeedNotification - ExplicitNull bool -} - -func (v NullableFeedNotification) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableFeedNotification) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_generate_campaign_description.go b/model_generate_campaign_description.go new file mode 100644 index 00000000..ac07be58 --- /dev/null +++ b/model_generate_campaign_description.go @@ -0,0 +1,76 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// GenerateCampaignDescription struct for GenerateCampaignDescription +type GenerateCampaignDescription struct { + // ID of the campaign. + CampaignID int32 `json:"campaignID"` + // Currency for the campaign. + Currency string `json:"currency"` +} + +// GetCampaignID returns the CampaignID field value +func (o *GenerateCampaignDescription) GetCampaignID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignID +} + +// SetCampaignID sets field value +func (o *GenerateCampaignDescription) SetCampaignID(v int32) { + o.CampaignID = v +} + +// GetCurrency returns the Currency field value +func (o *GenerateCampaignDescription) GetCurrency() string { + if o == nil { + var ret string + return ret + } + + return o.Currency +} + +// SetCurrency sets field value +func (o *GenerateCampaignDescription) SetCurrency(v string) { + o.Currency = v +} + +type NullableGenerateCampaignDescription struct { + Value GenerateCampaignDescription + ExplicitNull bool +} + +func (v NullableGenerateCampaignDescription) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGenerateCampaignDescription) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_generate_campaign_tags.go b/model_generate_campaign_tags.go new file mode 100644 index 00000000..4992430e --- /dev/null +++ b/model_generate_campaign_tags.go @@ -0,0 +1,59 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// GenerateCampaignTags struct for GenerateCampaignTags +type GenerateCampaignTags struct { + // ID of the campaign. + CampaignID int32 `json:"campaignID"` +} + +// GetCampaignID returns the CampaignID field value +func (o *GenerateCampaignTags) GetCampaignID() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignID +} + +// SetCampaignID sets field value +func (o *GenerateCampaignTags) SetCampaignID(v int32) { + o.CampaignID = v +} + +type NullableGenerateCampaignTags struct { + Value GenerateCampaignTags + ExplicitNull bool +} + +func (v NullableGenerateCampaignTags) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGenerateCampaignTags) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_user_latest_feed_timestamp.go b/model_generate_item_filter_description.go similarity index 58% rename from model_update_user_latest_feed_timestamp.go rename to model_generate_item_filter_description.go index d272ecc2..0c83e262 100644 --- a/model_update_user_latest_feed_timestamp.go +++ b/model_generate_item_filter_description.go @@ -12,36 +12,35 @@ package talon import ( "bytes" "encoding/json" - "time" ) -// UpdateUserLatestFeedTimestamp Updates current user's latest seen notifications timestamp. -type UpdateUserLatestFeedTimestamp struct { - // New timestamp to update for the current user. - NewLatestFeedTimestamp time.Time `json:"newLatestFeedTimestamp"` +// GenerateItemFilterDescription struct for GenerateItemFilterDescription +type GenerateItemFilterDescription struct { + // An array of item filter Talang expressions. + ItemFilter []map[string]interface{} `json:"itemFilter"` } -// GetNewLatestFeedTimestamp returns the NewLatestFeedTimestamp field value -func (o *UpdateUserLatestFeedTimestamp) GetNewLatestFeedTimestamp() time.Time { +// GetItemFilter returns the ItemFilter field value +func (o *GenerateItemFilterDescription) GetItemFilter() []map[string]interface{} { if o == nil { - var ret time.Time + var ret []map[string]interface{} return ret } - return o.NewLatestFeedTimestamp + return o.ItemFilter } -// SetNewLatestFeedTimestamp sets field value -func (o *UpdateUserLatestFeedTimestamp) SetNewLatestFeedTimestamp(v time.Time) { - o.NewLatestFeedTimestamp = v +// SetItemFilter sets field value +func (o *GenerateItemFilterDescription) SetItemFilter(v []map[string]interface{}) { + o.ItemFilter = v } -type NullableUpdateUserLatestFeedTimestamp struct { - Value UpdateUserLatestFeedTimestamp +type NullableGenerateItemFilterDescription struct { + Value GenerateItemFilterDescription ExplicitNull bool } -func (v NullableUpdateUserLatestFeedTimestamp) MarshalJSON() ([]byte, error) { +func (v NullableGenerateItemFilterDescription) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -50,7 +49,7 @@ func (v NullableUpdateUserLatestFeedTimestamp) MarshalJSON() ([]byte, error) { } } -func (v *NullableUpdateUserLatestFeedTimestamp) UnmarshalJSON(src []byte) error { +func (v *NullableGenerateItemFilterDescription) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_generate_loyalty_card.go b/model_generate_loyalty_card.go new file mode 100644 index 00000000..f4123294 --- /dev/null +++ b/model_generate_loyalty_card.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// GenerateLoyaltyCard The parameters necessary to generate a loyalty card. +type GenerateLoyaltyCard struct { + // Status of the loyalty card. + Status *string `json:"status,omitempty"` + // Integration IDs of the customer profiles linked to the card. + CustomerProfileIds *[]string `json:"customerProfileIds,omitempty"` +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *GenerateLoyaltyCard) GetStatus() string { + if o == nil || o.Status == nil { + var ret string + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GenerateLoyaltyCard) GetStatusOk() (string, bool) { + if o == nil || o.Status == nil { + var ret string + return ret, false + } + return *o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *GenerateLoyaltyCard) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given string and assigns it to the Status field. +func (o *GenerateLoyaltyCard) SetStatus(v string) { + o.Status = &v +} + +// GetCustomerProfileIds returns the CustomerProfileIds field value if set, zero value otherwise. +func (o *GenerateLoyaltyCard) GetCustomerProfileIds() []string { + if o == nil || o.CustomerProfileIds == nil { + var ret []string + return ret + } + return *o.CustomerProfileIds +} + +// GetCustomerProfileIdsOk returns a tuple with the CustomerProfileIds field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GenerateLoyaltyCard) GetCustomerProfileIdsOk() ([]string, bool) { + if o == nil || o.CustomerProfileIds == nil { + var ret []string + return ret, false + } + return *o.CustomerProfileIds, true +} + +// HasCustomerProfileIds returns a boolean if a field has been set. +func (o *GenerateLoyaltyCard) HasCustomerProfileIds() bool { + if o != nil && o.CustomerProfileIds != nil { + return true + } + + return false +} + +// SetCustomerProfileIds gets a reference to the given []string and assigns it to the CustomerProfileIds field. +func (o *GenerateLoyaltyCard) SetCustomerProfileIds(v []string) { + o.CustomerProfileIds = &v +} + +type NullableGenerateLoyaltyCard struct { + Value GenerateLoyaltyCard + ExplicitNull bool +} + +func (v NullableGenerateLoyaltyCard) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGenerateLoyaltyCard) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_priority_position.go b/model_generate_rule_title.go similarity index 58% rename from model_priority_position.go rename to model_generate_rule_title.go index 11cd780b..349c0ce1 100644 --- a/model_priority_position.go +++ b/model_generate_rule_title.go @@ -14,50 +14,49 @@ import ( "encoding/json" ) -// PriorityPosition The campaign priority. -type PriorityPosition struct { - // The name of the priority set where the campaign is located. - Set string `json:"set"` - // The position of the campaign in the priority order starting from 1. - Position int32 `json:"position"` +// GenerateRuleTitle struct for GenerateRuleTitle +type GenerateRuleTitle struct { + Rule GenerateRuleTitleRule `json:"rule"` + // Currency for the campaign. + Currency string `json:"currency"` } -// GetSet returns the Set field value -func (o *PriorityPosition) GetSet() string { +// GetRule returns the Rule field value +func (o *GenerateRuleTitle) GetRule() GenerateRuleTitleRule { if o == nil { - var ret string + var ret GenerateRuleTitleRule return ret } - return o.Set + return o.Rule } -// SetSet sets field value -func (o *PriorityPosition) SetSet(v string) { - o.Set = v +// SetRule sets field value +func (o *GenerateRuleTitle) SetRule(v GenerateRuleTitleRule) { + o.Rule = v } -// GetPosition returns the Position field value -func (o *PriorityPosition) GetPosition() int32 { +// GetCurrency returns the Currency field value +func (o *GenerateRuleTitle) GetCurrency() string { if o == nil { - var ret int32 + var ret string return ret } - return o.Position + return o.Currency } -// SetPosition sets field value -func (o *PriorityPosition) SetPosition(v int32) { - o.Position = v +// SetCurrency sets field value +func (o *GenerateRuleTitle) SetCurrency(v string) { + o.Currency = v } -type NullablePriorityPosition struct { - Value PriorityPosition +type NullableGenerateRuleTitle struct { + Value GenerateRuleTitle ExplicitNull bool } -func (v NullablePriorityPosition) MarshalJSON() ([]byte, error) { +func (v NullableGenerateRuleTitle) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -66,7 +65,7 @@ func (v NullablePriorityPosition) MarshalJSON() ([]byte, error) { } } -func (v *NullablePriorityPosition) UnmarshalJSON(src []byte) error { +func (v *NullableGenerateRuleTitle) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_generate_rule_title_rule.go b/model_generate_rule_title_rule.go new file mode 100644 index 00000000..418296ce --- /dev/null +++ b/model_generate_rule_title_rule.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// GenerateRuleTitleRule struct for GenerateRuleTitleRule +type GenerateRuleTitleRule struct { + // An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. + Effects *[]map[string]interface{} `json:"effects,omitempty"` + // A Talang expression that will be evaluated in the context of the given event. + Condition *[]map[string]interface{} `json:"condition,omitempty"` +} + +// GetEffects returns the Effects field value if set, zero value otherwise. +func (o *GenerateRuleTitleRule) GetEffects() []map[string]interface{} { + if o == nil || o.Effects == nil { + var ret []map[string]interface{} + return ret + } + return *o.Effects +} + +// GetEffectsOk returns a tuple with the Effects field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GenerateRuleTitleRule) GetEffectsOk() ([]map[string]interface{}, bool) { + if o == nil || o.Effects == nil { + var ret []map[string]interface{} + return ret, false + } + return *o.Effects, true +} + +// HasEffects returns a boolean if a field has been set. +func (o *GenerateRuleTitleRule) HasEffects() bool { + if o != nil && o.Effects != nil { + return true + } + + return false +} + +// SetEffects gets a reference to the given []map[string]interface{} and assigns it to the Effects field. +func (o *GenerateRuleTitleRule) SetEffects(v []map[string]interface{}) { + o.Effects = &v +} + +// GetCondition returns the Condition field value if set, zero value otherwise. +func (o *GenerateRuleTitleRule) GetCondition() []map[string]interface{} { + if o == nil || o.Condition == nil { + var ret []map[string]interface{} + return ret + } + return *o.Condition +} + +// GetConditionOk returns a tuple with the Condition field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *GenerateRuleTitleRule) GetConditionOk() ([]map[string]interface{}, bool) { + if o == nil || o.Condition == nil { + var ret []map[string]interface{} + return ret, false + } + return *o.Condition, true +} + +// HasCondition returns a boolean if a field has been set. +func (o *GenerateRuleTitleRule) HasCondition() bool { + if o != nil && o.Condition != nil { + return true + } + + return false +} + +// SetCondition gets a reference to the given []map[string]interface{} and assigns it to the Condition field. +func (o *GenerateRuleTitleRule) SetCondition(v []map[string]interface{}) { + o.Condition = &v +} + +type NullableGenerateRuleTitleRule struct { + Value GenerateRuleTitleRule + ExplicitNull bool +} + +func (v NullableGenerateRuleTitleRule) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableGenerateRuleTitleRule) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_increase_achievement_progress_effect_props.go b/model_increase_achievement_progress_effect_props.go index 58825f6e..066be8f8 100644 --- a/model_increase_achievement_progress_effect_props.go +++ b/model_increase_achievement_progress_effect_props.go @@ -26,7 +26,7 @@ type IncreaseAchievementProgressEffectProps struct { Delta float32 `json:"delta"` // The current progress of the customer in the achievement. Value float32 `json:"value"` - // The required number of actions or the transactional milestone to complete the achievement. + // The target value to complete the achievement. Target float32 `json:"target"` // Indicates if the customer has completed the achievement in the current session. IsJustCompleted bool `json:"isJustCompleted"` diff --git a/model_integration_coupon.go b/model_integration_coupon.go index d0986e23..b02171d5 100644 --- a/model_integration_coupon.go +++ b/model_integration_coupon.go @@ -33,7 +33,7 @@ type IntegrationCoupon struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. Limits *[]LimitConfig `json:"limits,omitempty"` diff --git a/model_inventory_coupon.go b/model_inventory_coupon.go index 1cb2c9e7..4bcb7ba9 100644 --- a/model_inventory_coupon.go +++ b/model_inventory_coupon.go @@ -33,7 +33,7 @@ type InventoryCoupon struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. Limits *[]LimitConfig `json:"limits,omitempty"` diff --git a/model_inventory_referral.go b/model_inventory_referral.go index 6cd226d8..6f5fe5c1 100644 --- a/model_inventory_referral.go +++ b/model_inventory_referral.go @@ -23,7 +23,7 @@ type InventoryReferral struct { Created time.Time `json:"created"` // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` diff --git a/model_loyalty_balance_with_tier.go b/model_loyalty_balance_with_tier.go new file mode 100644 index 00000000..3dda35af --- /dev/null +++ b/model_loyalty_balance_with_tier.go @@ -0,0 +1,320 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyBalanceWithTier +type LoyaltyBalanceWithTier struct { + // Total amount of points awarded to this customer and available to spend. + ActivePoints *float32 `json:"activePoints,omitempty"` + // Total amount of points awarded to this customer but not available until their start date. + PendingPoints *float32 `json:"pendingPoints,omitempty"` + // Total amount of points already spent by this customer. + SpentPoints *float32 `json:"spentPoints,omitempty"` + // Total amount of points awarded but never redeemed. They cannot be used anymore. + ExpiredPoints *float32 `json:"expiredPoints,omitempty"` + CurrentTier *Tier `json:"currentTier,omitempty"` + ProjectedTier *ProjectedTier `json:"projectedTier,omitempty"` + // The number of points required to move up a tier. + PointsToNextTier *float32 `json:"pointsToNextTier,omitempty"` + // The name of the tier consecutive to the current tier. + NextTierName *string `json:"nextTierName,omitempty"` +} + +// GetActivePoints returns the ActivePoints field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetActivePoints() float32 { + if o == nil || o.ActivePoints == nil { + var ret float32 + return ret + } + return *o.ActivePoints +} + +// GetActivePointsOk returns a tuple with the ActivePoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetActivePointsOk() (float32, bool) { + if o == nil || o.ActivePoints == nil { + var ret float32 + return ret, false + } + return *o.ActivePoints, true +} + +// HasActivePoints returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasActivePoints() bool { + if o != nil && o.ActivePoints != nil { + return true + } + + return false +} + +// SetActivePoints gets a reference to the given float32 and assigns it to the ActivePoints field. +func (o *LoyaltyBalanceWithTier) SetActivePoints(v float32) { + o.ActivePoints = &v +} + +// GetPendingPoints returns the PendingPoints field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetPendingPoints() float32 { + if o == nil || o.PendingPoints == nil { + var ret float32 + return ret + } + return *o.PendingPoints +} + +// GetPendingPointsOk returns a tuple with the PendingPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetPendingPointsOk() (float32, bool) { + if o == nil || o.PendingPoints == nil { + var ret float32 + return ret, false + } + return *o.PendingPoints, true +} + +// HasPendingPoints returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasPendingPoints() bool { + if o != nil && o.PendingPoints != nil { + return true + } + + return false +} + +// SetPendingPoints gets a reference to the given float32 and assigns it to the PendingPoints field. +func (o *LoyaltyBalanceWithTier) SetPendingPoints(v float32) { + o.PendingPoints = &v +} + +// GetSpentPoints returns the SpentPoints field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetSpentPoints() float32 { + if o == nil || o.SpentPoints == nil { + var ret float32 + return ret + } + return *o.SpentPoints +} + +// GetSpentPointsOk returns a tuple with the SpentPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetSpentPointsOk() (float32, bool) { + if o == nil || o.SpentPoints == nil { + var ret float32 + return ret, false + } + return *o.SpentPoints, true +} + +// HasSpentPoints returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasSpentPoints() bool { + if o != nil && o.SpentPoints != nil { + return true + } + + return false +} + +// SetSpentPoints gets a reference to the given float32 and assigns it to the SpentPoints field. +func (o *LoyaltyBalanceWithTier) SetSpentPoints(v float32) { + o.SpentPoints = &v +} + +// GetExpiredPoints returns the ExpiredPoints field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetExpiredPoints() float32 { + if o == nil || o.ExpiredPoints == nil { + var ret float32 + return ret + } + return *o.ExpiredPoints +} + +// GetExpiredPointsOk returns a tuple with the ExpiredPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetExpiredPointsOk() (float32, bool) { + if o == nil || o.ExpiredPoints == nil { + var ret float32 + return ret, false + } + return *o.ExpiredPoints, true +} + +// HasExpiredPoints returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasExpiredPoints() bool { + if o != nil && o.ExpiredPoints != nil { + return true + } + + return false +} + +// SetExpiredPoints gets a reference to the given float32 and assigns it to the ExpiredPoints field. +func (o *LoyaltyBalanceWithTier) SetExpiredPoints(v float32) { + o.ExpiredPoints = &v +} + +// GetCurrentTier returns the CurrentTier field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetCurrentTier() Tier { + if o == nil || o.CurrentTier == nil { + var ret Tier + return ret + } + return *o.CurrentTier +} + +// GetCurrentTierOk returns a tuple with the CurrentTier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetCurrentTierOk() (Tier, bool) { + if o == nil || o.CurrentTier == nil { + var ret Tier + return ret, false + } + return *o.CurrentTier, true +} + +// HasCurrentTier returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasCurrentTier() bool { + if o != nil && o.CurrentTier != nil { + return true + } + + return false +} + +// SetCurrentTier gets a reference to the given Tier and assigns it to the CurrentTier field. +func (o *LoyaltyBalanceWithTier) SetCurrentTier(v Tier) { + o.CurrentTier = &v +} + +// GetProjectedTier returns the ProjectedTier field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetProjectedTier() ProjectedTier { + if o == nil || o.ProjectedTier == nil { + var ret ProjectedTier + return ret + } + return *o.ProjectedTier +} + +// GetProjectedTierOk returns a tuple with the ProjectedTier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetProjectedTierOk() (ProjectedTier, bool) { + if o == nil || o.ProjectedTier == nil { + var ret ProjectedTier + return ret, false + } + return *o.ProjectedTier, true +} + +// HasProjectedTier returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasProjectedTier() bool { + if o != nil && o.ProjectedTier != nil { + return true + } + + return false +} + +// SetProjectedTier gets a reference to the given ProjectedTier and assigns it to the ProjectedTier field. +func (o *LoyaltyBalanceWithTier) SetProjectedTier(v ProjectedTier) { + o.ProjectedTier = &v +} + +// GetPointsToNextTier returns the PointsToNextTier field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetPointsToNextTier() float32 { + if o == nil || o.PointsToNextTier == nil { + var ret float32 + return ret + } + return *o.PointsToNextTier +} + +// GetPointsToNextTierOk returns a tuple with the PointsToNextTier field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetPointsToNextTierOk() (float32, bool) { + if o == nil || o.PointsToNextTier == nil { + var ret float32 + return ret, false + } + return *o.PointsToNextTier, true +} + +// HasPointsToNextTier returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasPointsToNextTier() bool { + if o != nil && o.PointsToNextTier != nil { + return true + } + + return false +} + +// SetPointsToNextTier gets a reference to the given float32 and assigns it to the PointsToNextTier field. +func (o *LoyaltyBalanceWithTier) SetPointsToNextTier(v float32) { + o.PointsToNextTier = &v +} + +// GetNextTierName returns the NextTierName field value if set, zero value otherwise. +func (o *LoyaltyBalanceWithTier) GetNextTierName() string { + if o == nil || o.NextTierName == nil { + var ret string + return ret + } + return *o.NextTierName +} + +// GetNextTierNameOk returns a tuple with the NextTierName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalanceWithTier) GetNextTierNameOk() (string, bool) { + if o == nil || o.NextTierName == nil { + var ret string + return ret, false + } + return *o.NextTierName, true +} + +// HasNextTierName returns a boolean if a field has been set. +func (o *LoyaltyBalanceWithTier) HasNextTierName() bool { + if o != nil && o.NextTierName != nil { + return true + } + + return false +} + +// SetNextTierName gets a reference to the given string and assigns it to the NextTierName field. +func (o *LoyaltyBalanceWithTier) SetNextTierName(v string) { + o.NextTierName = &v +} + +type NullableLoyaltyBalanceWithTier struct { + Value LoyaltyBalanceWithTier + ExplicitNull bool +} + +func (v NullableLoyaltyBalanceWithTier) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyBalanceWithTier) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_balances_with_tiers.go b/model_loyalty_balances_with_tiers.go new file mode 100644 index 00000000..0bd95ca2 --- /dev/null +++ b/model_loyalty_balances_with_tiers.go @@ -0,0 +1,111 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyBalancesWithTiers List of loyalty balances for a ledger and its subledgers. +type LoyaltyBalancesWithTiers struct { + Balance *LoyaltyBalanceWithTier `json:"balance,omitempty"` + // Map of the loyalty balances of the subledgers of a ledger. + SubledgerBalances *map[string]LoyaltyBalanceWithTier `json:"subledgerBalances,omitempty"` +} + +// GetBalance returns the Balance field value if set, zero value otherwise. +func (o *LoyaltyBalancesWithTiers) GetBalance() LoyaltyBalanceWithTier { + if o == nil || o.Balance == nil { + var ret LoyaltyBalanceWithTier + return ret + } + return *o.Balance +} + +// GetBalanceOk returns a tuple with the Balance field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalancesWithTiers) GetBalanceOk() (LoyaltyBalanceWithTier, bool) { + if o == nil || o.Balance == nil { + var ret LoyaltyBalanceWithTier + return ret, false + } + return *o.Balance, true +} + +// HasBalance returns a boolean if a field has been set. +func (o *LoyaltyBalancesWithTiers) HasBalance() bool { + if o != nil && o.Balance != nil { + return true + } + + return false +} + +// SetBalance gets a reference to the given LoyaltyBalanceWithTier and assigns it to the Balance field. +func (o *LoyaltyBalancesWithTiers) SetBalance(v LoyaltyBalanceWithTier) { + o.Balance = &v +} + +// GetSubledgerBalances returns the SubledgerBalances field value if set, zero value otherwise. +func (o *LoyaltyBalancesWithTiers) GetSubledgerBalances() map[string]LoyaltyBalanceWithTier { + if o == nil || o.SubledgerBalances == nil { + var ret map[string]LoyaltyBalanceWithTier + return ret + } + return *o.SubledgerBalances +} + +// GetSubledgerBalancesOk returns a tuple with the SubledgerBalances field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyBalancesWithTiers) GetSubledgerBalancesOk() (map[string]LoyaltyBalanceWithTier, bool) { + if o == nil || o.SubledgerBalances == nil { + var ret map[string]LoyaltyBalanceWithTier + return ret, false + } + return *o.SubledgerBalances, true +} + +// HasSubledgerBalances returns a boolean if a field has been set. +func (o *LoyaltyBalancesWithTiers) HasSubledgerBalances() bool { + if o != nil && o.SubledgerBalances != nil { + return true + } + + return false +} + +// SetSubledgerBalances gets a reference to the given map[string]LoyaltyBalanceWithTier and assigns it to the SubledgerBalances field. +func (o *LoyaltyBalancesWithTiers) SetSubledgerBalances(v map[string]LoyaltyBalanceWithTier) { + o.SubledgerBalances = &v +} + +type NullableLoyaltyBalancesWithTiers struct { + Value LoyaltyBalancesWithTiers + ExplicitNull bool +} + +func (v NullableLoyaltyBalancesWithTiers) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyBalancesWithTiers) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_card.go b/model_loyalty_card.go index 101bca6b..209f7936 100644 --- a/model_loyalty_card.go +++ b/model_loyalty_card.go @@ -23,8 +23,10 @@ type LoyaltyCard struct { Created time.Time `json:"created"` // The ID of the loyalty program that owns this entity. ProgramID int32 `json:"programID"` - // Status of the loyalty card. Can be one of: ['active', 'inactive'] + // Status of the loyalty card. Can be `active` or `inactive`. Status string `json:"status"` + // Reason for transferring and blocking the loyalty card. + BlockReason *string `json:"blockReason,omitempty"` // The alphanumeric identifier of the loyalty card. Identifier string `json:"identifier"` // The max amount of customer profiles that can be linked to the card. 0 means unlimited. @@ -40,6 +42,8 @@ type LoyaltyCard struct { OldCardIdentifier *string `json:"oldCardIdentifier,omitempty"` // The alphanumeric identifier of the loyalty card. NewCardIdentifier *string `json:"newCardIdentifier,omitempty"` + // The ID of the batch in which the loyalty card was created. + BatchId *string `json:"batchId,omitempty"` } // GetId returns the Id field value @@ -102,6 +106,39 @@ func (o *LoyaltyCard) SetStatus(v string) { o.Status = v } +// GetBlockReason returns the BlockReason field value if set, zero value otherwise. +func (o *LoyaltyCard) GetBlockReason() string { + if o == nil || o.BlockReason == nil { + var ret string + return ret + } + return *o.BlockReason +} + +// GetBlockReasonOk returns a tuple with the BlockReason field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetBlockReasonOk() (string, bool) { + if o == nil || o.BlockReason == nil { + var ret string + return ret, false + } + return *o.BlockReason, true +} + +// HasBlockReason returns a boolean if a field has been set. +func (o *LoyaltyCard) HasBlockReason() bool { + if o != nil && o.BlockReason != nil { + return true + } + + return false +} + +// SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. +func (o *LoyaltyCard) SetBlockReason(v string) { + o.BlockReason = &v +} + // GetIdentifier returns the Identifier field value func (o *LoyaltyCard) GetIdentifier() string { if o == nil { @@ -330,6 +367,39 @@ func (o *LoyaltyCard) SetNewCardIdentifier(v string) { o.NewCardIdentifier = &v } +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *LoyaltyCard) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string + return ret + } + return *o.BatchId +} + +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCard) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true +} + +// HasBatchId returns a boolean if a field has been set. +func (o *LoyaltyCard) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *LoyaltyCard) SetBatchId(v string) { + o.BatchId = &v +} + type NullableLoyaltyCard struct { Value LoyaltyCard ExplicitNull bool diff --git a/model_loyalty_card_batch.go b/model_loyalty_card_batch.go new file mode 100644 index 00000000..7a680769 --- /dev/null +++ b/model_loyalty_card_batch.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// LoyaltyCardBatch +type LoyaltyCardBatch struct { + // Number of loyalty cards in the batch. + NumberOfCards int32 `json:"numberOfCards"` + // ID of the loyalty card batch. + BatchId *string `json:"batchId,omitempty"` + // Status of the loyalty cards in the batch. + Status *string `json:"status,omitempty"` +} + +// GetNumberOfCards returns the NumberOfCards field value +func (o *LoyaltyCardBatch) GetNumberOfCards() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.NumberOfCards +} + +// SetNumberOfCards sets field value +func (o *LoyaltyCardBatch) SetNumberOfCards(v int32) { + o.NumberOfCards = v +} + +// GetBatchId returns the BatchId field value if set, zero value otherwise. +func (o *LoyaltyCardBatch) GetBatchId() string { + if o == nil || o.BatchId == nil { + var ret string + return ret + } + return *o.BatchId +} + +// GetBatchIdOk returns a tuple with the BatchId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCardBatch) GetBatchIdOk() (string, bool) { + if o == nil || o.BatchId == nil { + var ret string + return ret, false + } + return *o.BatchId, true +} + +// HasBatchId returns a boolean if a field has been set. +func (o *LoyaltyCardBatch) HasBatchId() bool { + if o != nil && o.BatchId != nil { + return true + } + + return false +} + +// SetBatchId gets a reference to the given string and assigns it to the BatchId field. +func (o *LoyaltyCardBatch) SetBatchId(v string) { + o.BatchId = &v +} + +// GetStatus returns the Status field value if set, zero value otherwise. +func (o *LoyaltyCardBatch) GetStatus() string { + if o == nil || o.Status == nil { + var ret string + return ret + } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyCardBatch) GetStatusOk() (string, bool) { + if o == nil || o.Status == nil { + var ret string + return ret, false + } + return *o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *LoyaltyCardBatch) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } + + return false +} + +// SetStatus gets a reference to the given string and assigns it to the Status field. +func (o *LoyaltyCardBatch) SetStatus(v string) { + o.Status = &v +} + +type NullableLoyaltyCardBatch struct { + Value LoyaltyCardBatch + ExplicitNull bool +} + +func (v NullableLoyaltyCardBatch) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableLoyaltyCardBatch) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_loyalty_program_subledgers.go b/model_loyalty_card_batch_response.go similarity index 53% rename from model_loyalty_program_subledgers.go rename to model_loyalty_card_batch_response.go index a38d7fca..57669eaf 100644 --- a/model_loyalty_program_subledgers.go +++ b/model_loyalty_card_batch_response.go @@ -14,50 +14,50 @@ import ( "encoding/json" ) -// LoyaltyProgramSubledgers The list of all the subledgers that the loyalty program has. -type LoyaltyProgramSubledgers struct { - // The internal ID of the loyalty program. - LoyaltyProgramId int32 `json:"loyaltyProgramId"` - // The list of subledger IDs. - SubledgerIds []string `json:"subledgerIds"` +// LoyaltyCardBatchResponse struct for LoyaltyCardBatchResponse +type LoyaltyCardBatchResponse struct { + // Number of loyalty cards in the batch. + NumberOfCardsGenerated int32 `json:"numberOfCardsGenerated"` + // ID of the loyalty card batch. + BatchId string `json:"batchId"` } -// GetLoyaltyProgramId returns the LoyaltyProgramId field value -func (o *LoyaltyProgramSubledgers) GetLoyaltyProgramId() int32 { +// GetNumberOfCardsGenerated returns the NumberOfCardsGenerated field value +func (o *LoyaltyCardBatchResponse) GetNumberOfCardsGenerated() int32 { if o == nil { var ret int32 return ret } - return o.LoyaltyProgramId + return o.NumberOfCardsGenerated } -// SetLoyaltyProgramId sets field value -func (o *LoyaltyProgramSubledgers) SetLoyaltyProgramId(v int32) { - o.LoyaltyProgramId = v +// SetNumberOfCardsGenerated sets field value +func (o *LoyaltyCardBatchResponse) SetNumberOfCardsGenerated(v int32) { + o.NumberOfCardsGenerated = v } -// GetSubledgerIds returns the SubledgerIds field value -func (o *LoyaltyProgramSubledgers) GetSubledgerIds() []string { +// GetBatchId returns the BatchId field value +func (o *LoyaltyCardBatchResponse) GetBatchId() string { if o == nil { - var ret []string + var ret string return ret } - return o.SubledgerIds + return o.BatchId } -// SetSubledgerIds sets field value -func (o *LoyaltyProgramSubledgers) SetSubledgerIds(v []string) { - o.SubledgerIds = v +// SetBatchId sets field value +func (o *LoyaltyCardBatchResponse) SetBatchId(v string) { + o.BatchId = v } -type NullableLoyaltyProgramSubledgers struct { - Value LoyaltyProgramSubledgers +type NullableLoyaltyCardBatchResponse struct { + Value LoyaltyCardBatchResponse ExplicitNull bool } -func (v NullableLoyaltyProgramSubledgers) MarshalJSON() ([]byte, error) { +func (v NullableLoyaltyCardBatchResponse) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -66,7 +66,7 @@ func (v NullableLoyaltyProgramSubledgers) MarshalJSON() ([]byte, error) { } } -func (v *NullableLoyaltyProgramSubledgers) UnmarshalJSON(src []byte) error { +func (v *NullableLoyaltyCardBatchResponse) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_loyalty_program.go b/model_loyalty_program.go index bfe7d6c2..8415c3f5 100644 --- a/model_loyalty_program.go +++ b/model_loyalty_program.go @@ -37,14 +37,17 @@ type LoyaltyProgram struct { UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // 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. Sandbox bool `json:"sandbox"` - // 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. - TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` - // 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. - TiersExpireIn *string `json:"tiersExpireIn,omitempty"` - // 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. - TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` // 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. ProgramJoinPolicy *string `json:"programJoinPolicy,omitempty"` + // 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`. + TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` + // 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`. + TierCycleStartDate *time.Time `json:"tierCycleStartDate,omitempty"` + // 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. + TiersExpireIn *string `json:"tiersExpireIn,omitempty"` + // 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. + TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` + CardCodeSettings *CodeGeneratorSettings `json:"cardCodeSettings,omitempty"` // The ID of the Talon.One account that owns this program. AccountID int32 `json:"accountID"` // The internal name for the Loyalty Program. This is an immutable value. @@ -57,10 +60,14 @@ type LoyaltyProgram struct { CardBased bool `json:"cardBased"` // `True` if the tier definitions can be updated. CanUpdateTiers *bool `json:"canUpdateTiers,omitempty"` - // Indicates whether the program join policy can be updated. The join policy can be updated when this value is set to `true`. + // `True` if the program join policy can be updated. CanUpdateJoinPolicy *bool `json:"canUpdateJoinPolicy,omitempty"` + // `True` if the tier expiration policy can be updated. + CanUpdateTierExpirationPolicy *bool `json:"canUpdateTierExpirationPolicy,omitempty"` // `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. CanUpgradeToAdvancedTiers *bool `json:"canUpgradeToAdvancedTiers,omitempty"` + // `True` if the `allowSubledger` property can be updated in the loyalty program. + CanUpdateSubledgers *bool `json:"canUpdateSubledgers,omitempty"` } // GetId returns the Id field value @@ -231,6 +238,39 @@ func (o *LoyaltyProgram) SetSandbox(v bool) { o.Sandbox = v } +// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetProgramJoinPolicy() string { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret + } + return *o.ProgramJoinPolicy +} + +// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret, false + } + return *o.ProgramJoinPolicy, true +} + +// HasProgramJoinPolicy returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasProgramJoinPolicy() bool { + if o != nil && o.ProgramJoinPolicy != nil { + return true + } + + return false +} + +// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +func (o *LoyaltyProgram) SetProgramJoinPolicy(v string) { + o.ProgramJoinPolicy = &v +} + // GetTiersExpirationPolicy returns the TiersExpirationPolicy field value if set, zero value otherwise. func (o *LoyaltyProgram) GetTiersExpirationPolicy() string { if o == nil || o.TiersExpirationPolicy == nil { @@ -264,6 +304,39 @@ func (o *LoyaltyProgram) SetTiersExpirationPolicy(v string) { o.TiersExpirationPolicy = &v } +// GetTierCycleStartDate returns the TierCycleStartDate field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetTierCycleStartDate() time.Time { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret + } + return *o.TierCycleStartDate +} + +// GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool) { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret, false + } + return *o.TierCycleStartDate, true +} + +// HasTierCycleStartDate returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasTierCycleStartDate() bool { + if o != nil && o.TierCycleStartDate != nil { + return true + } + + return false +} + +// SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. +func (o *LoyaltyProgram) SetTierCycleStartDate(v time.Time) { + o.TierCycleStartDate = &v +} + // GetTiersExpireIn returns the TiersExpireIn field value if set, zero value otherwise. func (o *LoyaltyProgram) GetTiersExpireIn() string { if o == nil || o.TiersExpireIn == nil { @@ -330,37 +403,37 @@ func (o *LoyaltyProgram) SetTiersDowngradePolicy(v string) { o.TiersDowngradePolicy = &v } -// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. -func (o *LoyaltyProgram) GetProgramJoinPolicy() string { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +// GetCardCodeSettings returns the CardCodeSettings field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret } - return *o.ProgramJoinPolicy + return *o.CardCodeSettings } -// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *LoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +func (o *LoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret, false } - return *o.ProgramJoinPolicy, true + return *o.CardCodeSettings, true } -// HasProgramJoinPolicy returns a boolean if a field has been set. -func (o *LoyaltyProgram) HasProgramJoinPolicy() bool { - if o != nil && o.ProgramJoinPolicy != nil { +// HasCardCodeSettings returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasCardCodeSettings() bool { + if o != nil && o.CardCodeSettings != nil { return true } return false } -// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. -func (o *LoyaltyProgram) SetProgramJoinPolicy(v string) { - o.ProgramJoinPolicy = &v +// SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. +func (o *LoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings) { + o.CardCodeSettings = &v } // GetAccountID returns the AccountID field value @@ -522,6 +595,39 @@ func (o *LoyaltyProgram) SetCanUpdateJoinPolicy(v bool) { o.CanUpdateJoinPolicy = &v } +// GetCanUpdateTierExpirationPolicy returns the CanUpdateTierExpirationPolicy field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicy() bool { + if o == nil || o.CanUpdateTierExpirationPolicy == nil { + var ret bool + return ret + } + return *o.CanUpdateTierExpirationPolicy +} + +// GetCanUpdateTierExpirationPolicyOk returns a tuple with the CanUpdateTierExpirationPolicy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicyOk() (bool, bool) { + if o == nil || o.CanUpdateTierExpirationPolicy == nil { + var ret bool + return ret, false + } + return *o.CanUpdateTierExpirationPolicy, true +} + +// HasCanUpdateTierExpirationPolicy returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasCanUpdateTierExpirationPolicy() bool { + if o != nil && o.CanUpdateTierExpirationPolicy != nil { + return true + } + + return false +} + +// SetCanUpdateTierExpirationPolicy gets a reference to the given bool and assigns it to the CanUpdateTierExpirationPolicy field. +func (o *LoyaltyProgram) SetCanUpdateTierExpirationPolicy(v bool) { + o.CanUpdateTierExpirationPolicy = &v +} + // GetCanUpgradeToAdvancedTiers returns the CanUpgradeToAdvancedTiers field value if set, zero value otherwise. func (o *LoyaltyProgram) GetCanUpgradeToAdvancedTiers() bool { if o == nil || o.CanUpgradeToAdvancedTiers == nil { @@ -555,6 +661,39 @@ func (o *LoyaltyProgram) SetCanUpgradeToAdvancedTiers(v bool) { o.CanUpgradeToAdvancedTiers = &v } +// GetCanUpdateSubledgers returns the CanUpdateSubledgers field value if set, zero value otherwise. +func (o *LoyaltyProgram) GetCanUpdateSubledgers() bool { + if o == nil || o.CanUpdateSubledgers == nil { + var ret bool + return ret + } + return *o.CanUpdateSubledgers +} + +// GetCanUpdateSubledgersOk returns a tuple with the CanUpdateSubledgers field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *LoyaltyProgram) GetCanUpdateSubledgersOk() (bool, bool) { + if o == nil || o.CanUpdateSubledgers == nil { + var ret bool + return ret, false + } + return *o.CanUpdateSubledgers, true +} + +// HasCanUpdateSubledgers returns a boolean if a field has been set. +func (o *LoyaltyProgram) HasCanUpdateSubledgers() bool { + if o != nil && o.CanUpdateSubledgers != nil { + return true + } + + return false +} + +// SetCanUpdateSubledgers gets a reference to the given bool and assigns it to the CanUpdateSubledgers field. +func (o *LoyaltyProgram) SetCanUpdateSubledgers(v bool) { + o.CanUpdateSubledgers = &v +} + type NullableLoyaltyProgram struct { Value LoyaltyProgram ExplicitNull bool diff --git a/model_loyalty_statistics.go b/model_loyalty_statistics.go deleted file mode 100644 index 789d1627..00000000 --- a/model_loyalty_statistics.go +++ /dev/null @@ -1,194 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// LoyaltyStatistics -type LoyaltyStatistics struct { - // Date at which data point was collected. - Date time.Time `json:"date"` - // Total of active points for this loyalty program. - TotalActivePoints float32 `json:"totalActivePoints"` - // Total of pending points for this loyalty program. - TotalPendingPoints float32 `json:"totalPendingPoints"` - // Total of spent points for this loyalty program. - TotalSpentPoints float32 `json:"totalSpentPoints"` - // Total of expired points for this loyalty program. - TotalExpiredPoints float32 `json:"totalExpiredPoints"` - // Number of loyalty program members. - TotalMembers float32 `json:"totalMembers"` - // Number of members who joined on this day. - NewMembers float32 `json:"newMembers"` - SpentPoints LoyaltyDashboardPointsBreakdown `json:"spentPoints"` - EarnedPoints LoyaltyDashboardPointsBreakdown `json:"earnedPoints"` -} - -// GetDate returns the Date field value -func (o *LoyaltyStatistics) GetDate() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Date -} - -// SetDate sets field value -func (o *LoyaltyStatistics) SetDate(v time.Time) { - o.Date = v -} - -// GetTotalActivePoints returns the TotalActivePoints field value -func (o *LoyaltyStatistics) GetTotalActivePoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.TotalActivePoints -} - -// SetTotalActivePoints sets field value -func (o *LoyaltyStatistics) SetTotalActivePoints(v float32) { - o.TotalActivePoints = v -} - -// GetTotalPendingPoints returns the TotalPendingPoints field value -func (o *LoyaltyStatistics) GetTotalPendingPoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.TotalPendingPoints -} - -// SetTotalPendingPoints sets field value -func (o *LoyaltyStatistics) SetTotalPendingPoints(v float32) { - o.TotalPendingPoints = v -} - -// GetTotalSpentPoints returns the TotalSpentPoints field value -func (o *LoyaltyStatistics) GetTotalSpentPoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.TotalSpentPoints -} - -// SetTotalSpentPoints sets field value -func (o *LoyaltyStatistics) SetTotalSpentPoints(v float32) { - o.TotalSpentPoints = v -} - -// GetTotalExpiredPoints returns the TotalExpiredPoints field value -func (o *LoyaltyStatistics) GetTotalExpiredPoints() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.TotalExpiredPoints -} - -// SetTotalExpiredPoints sets field value -func (o *LoyaltyStatistics) SetTotalExpiredPoints(v float32) { - o.TotalExpiredPoints = v -} - -// GetTotalMembers returns the TotalMembers field value -func (o *LoyaltyStatistics) GetTotalMembers() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.TotalMembers -} - -// SetTotalMembers sets field value -func (o *LoyaltyStatistics) SetTotalMembers(v float32) { - o.TotalMembers = v -} - -// GetNewMembers returns the NewMembers field value -func (o *LoyaltyStatistics) GetNewMembers() float32 { - if o == nil { - var ret float32 - return ret - } - - return o.NewMembers -} - -// SetNewMembers sets field value -func (o *LoyaltyStatistics) SetNewMembers(v float32) { - o.NewMembers = v -} - -// GetSpentPoints returns the SpentPoints field value -func (o *LoyaltyStatistics) GetSpentPoints() LoyaltyDashboardPointsBreakdown { - if o == nil { - var ret LoyaltyDashboardPointsBreakdown - return ret - } - - return o.SpentPoints -} - -// SetSpentPoints sets field value -func (o *LoyaltyStatistics) SetSpentPoints(v LoyaltyDashboardPointsBreakdown) { - o.SpentPoints = v -} - -// GetEarnedPoints returns the EarnedPoints field value -func (o *LoyaltyStatistics) GetEarnedPoints() LoyaltyDashboardPointsBreakdown { - if o == nil { - var ret LoyaltyDashboardPointsBreakdown - return ret - } - - return o.EarnedPoints -} - -// SetEarnedPoints sets field value -func (o *LoyaltyStatistics) SetEarnedPoints(v LoyaltyDashboardPointsBreakdown) { - o.EarnedPoints = v -} - -type NullableLoyaltyStatistics struct { - Value LoyaltyStatistics - ExplicitNull bool -} - -func (v NullableLoyaltyStatistics) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableLoyaltyStatistics) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_message_log_response.go b/model_message_log_response.go index b1e206a7..a9ba098d 100644 --- a/model_message_log_response.go +++ b/model_message_log_response.go @@ -18,56 +18,110 @@ import ( // MessageLogResponse Details of the response. type MessageLogResponse struct { // Timestamp when the response was received. - CreatedAt time.Time `json:"createdAt"` + CreatedAt *time.Time `json:"createdAt,omitempty"` // Raw response data. - Response string `json:"response"` + Response *string `json:"response,omitempty"` // HTTP status code of the response. - Status int32 `json:"status"` + Status *int32 `json:"status,omitempty"` } -// GetCreatedAt returns the CreatedAt field value +// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise. func (o *MessageLogResponse) GetCreatedAt() time.Time { - if o == nil { + if o == nil || o.CreatedAt == nil { var ret time.Time return ret } + return *o.CreatedAt +} - return o.CreatedAt +// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MessageLogResponse) GetCreatedAtOk() (time.Time, bool) { + if o == nil || o.CreatedAt == nil { + var ret time.Time + return ret, false + } + return *o.CreatedAt, true } -// SetCreatedAt sets field value +// HasCreatedAt returns a boolean if a field has been set. +func (o *MessageLogResponse) HasCreatedAt() bool { + if o != nil && o.CreatedAt != nil { + return true + } + + return false +} + +// SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field. func (o *MessageLogResponse) SetCreatedAt(v time.Time) { - o.CreatedAt = v + o.CreatedAt = &v } -// GetResponse returns the Response field value +// GetResponse returns the Response field value if set, zero value otherwise. func (o *MessageLogResponse) GetResponse() string { - if o == nil { + if o == nil || o.Response == nil { var ret string return ret } + return *o.Response +} - return o.Response +// GetResponseOk returns a tuple with the Response field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MessageLogResponse) GetResponseOk() (string, bool) { + if o == nil || o.Response == nil { + var ret string + return ret, false + } + return *o.Response, true } -// SetResponse sets field value +// HasResponse returns a boolean if a field has been set. +func (o *MessageLogResponse) HasResponse() bool { + if o != nil && o.Response != nil { + return true + } + + return false +} + +// SetResponse gets a reference to the given string and assigns it to the Response field. func (o *MessageLogResponse) SetResponse(v string) { - o.Response = v + o.Response = &v } -// GetStatus returns the Status field value +// GetStatus returns the Status field value if set, zero value otherwise. func (o *MessageLogResponse) GetStatus() int32 { - if o == nil { + if o == nil || o.Status == nil { var ret int32 return ret } + return *o.Status +} + +// GetStatusOk returns a tuple with the Status field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *MessageLogResponse) GetStatusOk() (int32, bool) { + if o == nil || o.Status == nil { + var ret int32 + return ret, false + } + return *o.Status, true +} + +// HasStatus returns a boolean if a field has been set. +func (o *MessageLogResponse) HasStatus() bool { + if o != nil && o.Status != nil { + return true + } - return o.Status + return false } -// SetStatus sets field value +// SetStatus gets a reference to the given int32 and assigns it to the Status field. func (o *MessageLogResponse) SetStatus(v int32) { - o.Status = v + o.Status = &v } type NullableMessageLogResponse struct { diff --git a/model_new_app_wide_coupon_deletion_job.go b/model_new_app_wide_coupon_deletion_job.go new file mode 100644 index 00000000..a78ab348 --- /dev/null +++ b/model_new_app_wide_coupon_deletion_job.go @@ -0,0 +1,74 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewAppWideCouponDeletionJob struct for NewAppWideCouponDeletionJob +type NewAppWideCouponDeletionJob struct { + Filters CouponDeletionFilters `json:"filters"` + Campaignids []int32 `json:"campaignids"` +} + +// GetFilters returns the Filters field value +func (o *NewAppWideCouponDeletionJob) GetFilters() CouponDeletionFilters { + if o == nil { + var ret CouponDeletionFilters + return ret + } + + return o.Filters +} + +// SetFilters sets field value +func (o *NewAppWideCouponDeletionJob) SetFilters(v CouponDeletionFilters) { + o.Filters = v +} + +// GetCampaignids returns the Campaignids field value +func (o *NewAppWideCouponDeletionJob) GetCampaignids() []int32 { + if o == nil { + var ret []int32 + return ret + } + + return o.Campaignids +} + +// SetCampaignids sets field value +func (o *NewAppWideCouponDeletionJob) SetCampaignids(v []int32) { + o.Campaignids = v +} + +type NullableNewAppWideCouponDeletionJob struct { + Value NewAppWideCouponDeletionJob + ExplicitNull bool +} + +func (v NullableNewAppWideCouponDeletionJob) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewAppWideCouponDeletionJob) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_application.go b/model_new_application.go index 01f27d57..ec542f33 100644 --- a/model_new_application.go +++ b/model_new_application.go @@ -45,6 +45,8 @@ type NewApplication struct { DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` // Hex key for HMAC-signing API calls as coming from this application (16 hex digits). Key *string `json:"key,omitempty"` + // Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. + EnableCampaignStateManagement *bool `json:"enableCampaignStateManagement,omitempty"` } // GetName returns the Name field value @@ -488,6 +490,39 @@ func (o *NewApplication) SetKey(v string) { o.Key = &v } +// GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field value if set, zero value otherwise. +func (o *NewApplication) GetEnableCampaignStateManagement() bool { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret + } + return *o.EnableCampaignStateManagement +} + +// GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplication) GetEnableCampaignStateManagementOk() (bool, bool) { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret, false + } + return *o.EnableCampaignStateManagement, true +} + +// HasEnableCampaignStateManagement returns a boolean if a field has been set. +func (o *NewApplication) HasEnableCampaignStateManagement() bool { + if o != nil && o.EnableCampaignStateManagement != nil { + return true + } + + return false +} + +// SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. +func (o *NewApplication) SetEnableCampaignStateManagement(v bool) { + o.EnableCampaignStateManagement = &v +} + type NullableNewApplication struct { Value NewApplication ExplicitNull bool diff --git a/model_new_application_cif.go b/model_new_application_cif.go new file mode 100644 index 00000000..fef38867 --- /dev/null +++ b/model_new_application_cif.go @@ -0,0 +1,235 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// NewApplicationCif struct for NewApplicationCif +type NewApplicationCif struct { + // The name of the Application cart item filter used in API requests. + Name string `json:"name"` + // A short description of the Application cart item filter. + Description *string `json:"description,omitempty"` + // The ID of the expression that the Application cart item filter uses. + ActiveExpressionId *int32 `json:"activeExpressionId,omitempty"` + // The ID of the user who last updated the Application cart item filter. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // The ID of the user who created the Application cart item filter. + CreatedBy *int32 `json:"createdBy,omitempty"` + // Timestamp of the most recent update to the Application cart item filter. + Modified *time.Time `json:"modified,omitempty"` +} + +// GetName returns the Name field value +func (o *NewApplicationCif) GetName() string { + if o == nil { + var ret string + return ret + } + + return o.Name +} + +// SetName sets field value +func (o *NewApplicationCif) SetName(v string) { + o.Name = v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewApplicationCif) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCif) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewApplicationCif) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewApplicationCif) SetDescription(v string) { + o.Description = &v +} + +// GetActiveExpressionId returns the ActiveExpressionId field value if set, zero value otherwise. +func (o *NewApplicationCif) GetActiveExpressionId() int32 { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret + } + return *o.ActiveExpressionId +} + +// GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCif) GetActiveExpressionIdOk() (int32, bool) { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveExpressionId, true +} + +// HasActiveExpressionId returns a boolean if a field has been set. +func (o *NewApplicationCif) HasActiveExpressionId() bool { + if o != nil && o.ActiveExpressionId != nil { + return true + } + + return false +} + +// SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. +func (o *NewApplicationCif) SetActiveExpressionId(v int32) { + o.ActiveExpressionId = &v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *NewApplicationCif) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCif) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *NewApplicationCif) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *NewApplicationCif) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. +func (o *NewApplicationCif) GetCreatedBy() int32 { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret + } + return *o.CreatedBy +} + +// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCif) GetCreatedByOk() (int32, bool) { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret, false + } + return *o.CreatedBy, true +} + +// HasCreatedBy returns a boolean if a field has been set. +func (o *NewApplicationCif) HasCreatedBy() bool { + if o != nil && o.CreatedBy != nil { + return true + } + + return false +} + +// SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +func (o *NewApplicationCif) SetCreatedBy(v int32) { + o.CreatedBy = &v +} + +// GetModified returns the Modified field value if set, zero value otherwise. +func (o *NewApplicationCif) GetModified() time.Time { + if o == nil || o.Modified == nil { + var ret time.Time + return ret + } + return *o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCif) GetModifiedOk() (time.Time, bool) { + if o == nil || o.Modified == nil { + var ret time.Time + return ret, false + } + return *o.Modified, true +} + +// HasModified returns a boolean if a field has been set. +func (o *NewApplicationCif) HasModified() bool { + if o != nil && o.Modified != nil { + return true + } + + return false +} + +// SetModified gets a reference to the given time.Time and assigns it to the Modified field. +func (o *NewApplicationCif) SetModified(v time.Time) { + o.Modified = &v +} + +type NullableNewApplicationCif struct { + Value NewApplicationCif + ExplicitNull bool +} + +func (v NullableNewApplicationCif) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewApplicationCif) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_application_cif_expression.go b/model_new_application_cif_expression.go new file mode 100644 index 00000000..1c48dd68 --- /dev/null +++ b/model_new_application_cif_expression.go @@ -0,0 +1,147 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewApplicationCifExpression struct for NewApplicationCifExpression +type NewApplicationCifExpression struct { + // The ID of the Application cart item filter. + CartItemFilterId *int32 `json:"cartItemFilterId,omitempty"` + // The ID of the user who created the Application cart item filter. + CreatedBy *int32 `json:"createdBy,omitempty"` + // Arbitrary additional JSON data associated with the Application cart item filter. + Expression *[]map[string]interface{} `json:"expression,omitempty"` +} + +// GetCartItemFilterId returns the CartItemFilterId field value if set, zero value otherwise. +func (o *NewApplicationCifExpression) GetCartItemFilterId() int32 { + if o == nil || o.CartItemFilterId == nil { + var ret int32 + return ret + } + return *o.CartItemFilterId +} + +// GetCartItemFilterIdOk returns a tuple with the CartItemFilterId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCifExpression) GetCartItemFilterIdOk() (int32, bool) { + if o == nil || o.CartItemFilterId == nil { + var ret int32 + return ret, false + } + return *o.CartItemFilterId, true +} + +// HasCartItemFilterId returns a boolean if a field has been set. +func (o *NewApplicationCifExpression) HasCartItemFilterId() bool { + if o != nil && o.CartItemFilterId != nil { + return true + } + + return false +} + +// SetCartItemFilterId gets a reference to the given int32 and assigns it to the CartItemFilterId field. +func (o *NewApplicationCifExpression) SetCartItemFilterId(v int32) { + o.CartItemFilterId = &v +} + +// GetCreatedBy returns the CreatedBy field value if set, zero value otherwise. +func (o *NewApplicationCifExpression) GetCreatedBy() int32 { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret + } + return *o.CreatedBy +} + +// GetCreatedByOk returns a tuple with the CreatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCifExpression) GetCreatedByOk() (int32, bool) { + if o == nil || o.CreatedBy == nil { + var ret int32 + return ret, false + } + return *o.CreatedBy, true +} + +// HasCreatedBy returns a boolean if a field has been set. +func (o *NewApplicationCifExpression) HasCreatedBy() bool { + if o != nil && o.CreatedBy != nil { + return true + } + + return false +} + +// SetCreatedBy gets a reference to the given int32 and assigns it to the CreatedBy field. +func (o *NewApplicationCifExpression) SetCreatedBy(v int32) { + o.CreatedBy = &v +} + +// GetExpression returns the Expression field value if set, zero value otherwise. +func (o *NewApplicationCifExpression) GetExpression() []map[string]interface{} { + if o == nil || o.Expression == nil { + var ret []map[string]interface{} + return ret + } + return *o.Expression +} + +// GetExpressionOk returns a tuple with the Expression field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewApplicationCifExpression) GetExpressionOk() ([]map[string]interface{}, bool) { + if o == nil || o.Expression == nil { + var ret []map[string]interface{} + return ret, false + } + return *o.Expression, true +} + +// HasExpression returns a boolean if a field has been set. +func (o *NewApplicationCifExpression) HasExpression() bool { + if o != nil && o.Expression != nil { + return true + } + + return false +} + +// SetExpression gets a reference to the given []map[string]interface{} and assigns it to the Expression field. +func (o *NewApplicationCifExpression) SetExpression(v []map[string]interface{}) { + o.Expression = &v +} + +type NullableNewApplicationCifExpression struct { + Value NewApplicationCifExpression + ExplicitNull bool +} + +func (v NullableNewApplicationCifExpression) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewApplicationCifExpression) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_base_notification.go b/model_new_base_notification.go index 6ac9c07d..9315200c 100644 --- a/model_new_base_notification.go +++ b/model_new_base_notification.go @@ -16,6 +16,7 @@ import ( // NewBaseNotification type NewBaseNotification struct { + // Indicates which notification properties to apply. Policy map[string]interface{} `json:"policy"` // Indicates whether the notification is activated. Enabled *bool `json:"enabled,omitempty"` diff --git a/model_new_coupon_creation_job.go b/model_new_coupon_creation_job.go index 886e8526..90271d0b 100644 --- a/model_new_coupon_creation_job.go +++ b/model_new_coupon_creation_job.go @@ -25,7 +25,7 @@ type NewCouponCreationJob struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of new coupon codes to generate for the campaign. NumberOfCoupons int32 `json:"numberOfCoupons"` diff --git a/model_new_coupon_deletion_job.go b/model_new_coupon_deletion_job.go new file mode 100644 index 00000000..ecd2f6c0 --- /dev/null +++ b/model_new_coupon_deletion_job.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewCouponDeletionJob struct for NewCouponDeletionJob +type NewCouponDeletionJob struct { + Filters CouponDeletionFilters `json:"filters"` +} + +// GetFilters returns the Filters field value +func (o *NewCouponDeletionJob) GetFilters() CouponDeletionFilters { + if o == nil { + var ret CouponDeletionFilters + return ret + } + + return o.Filters +} + +// SetFilters sets field value +func (o *NewCouponDeletionJob) SetFilters(v CouponDeletionFilters) { + o.Filters = v +} + +type NullableNewCouponDeletionJob struct { + Value NewCouponDeletionJob + ExplicitNull bool +} + +func (v NullableNewCouponDeletionJob) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewCouponDeletionJob) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_coupons.go b/model_new_coupons.go index e1a88bfa..3ef05b15 100644 --- a/model_new_coupons.go +++ b/model_new_coupons.go @@ -25,7 +25,7 @@ type NewCoupons struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. Limits *[]LimitConfig `json:"limits,omitempty"` diff --git a/model_new_coupons_for_multiple_recipients.go b/model_new_coupons_for_multiple_recipients.go index a5227e12..9cde04ea 100644 --- a/model_new_coupons_for_multiple_recipients.go +++ b/model_new_coupons_for_multiple_recipients.go @@ -25,7 +25,7 @@ type NewCouponsForMultipleRecipients struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Arbitrary properties associated with this item. Attributes *map[string]interface{} `json:"attributes,omitempty"` diff --git a/model_new_customer_session_v2.go b/model_new_customer_session_v2.go index 3a917bc8..b37d2934 100644 --- a/model_new_customer_session_v2.go +++ b/model_new_customer_session_v2.go @@ -22,9 +22,9 @@ type NewCustomerSessionV2 struct { StoreIntegrationId *string `json:"storeIntegrationId,omitempty"` // When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. EvaluableCampaignIds *[]int32 `json:"evaluableCampaignIds,omitempty"` - // Any coupon codes entered. **Important**: If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. + // Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `\"couponCodes\": null` or omit the parameter entirely. CouponCodes *[]string `json:"couponCodes,omitempty"` - // Any referral code entered. **Important**: If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. + // Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `\"referralCode\": null` or omit the parameter entirely. ReferralCode *string `json:"referralCode,omitempty"` // Identifier of a loyalty card. LoyaltyCards *[]string `json:"loyaltyCards,omitempty"` diff --git a/model_new_loyalty_program.go b/model_new_loyalty_program.go index 619a1e90..363ee457 100644 --- a/model_new_loyalty_program.go +++ b/model_new_loyalty_program.go @@ -12,6 +12,7 @@ package talon import ( "bytes" "encoding/json" + "time" ) // NewLoyaltyProgram @@ -32,14 +33,17 @@ type NewLoyaltyProgram struct { UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // 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. Sandbox bool `json:"sandbox"` - // 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. - TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` - // 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. - TiersExpireIn *string `json:"tiersExpireIn,omitempty"` - // 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. - TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` // 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. ProgramJoinPolicy *string `json:"programJoinPolicy,omitempty"` + // 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`. + TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` + // 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`. + TierCycleStartDate *time.Time `json:"tierCycleStartDate,omitempty"` + // 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. + TiersExpireIn *string `json:"tiersExpireIn,omitempty"` + // 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. + TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` + CardCodeSettings *CodeGeneratorSettings `json:"cardCodeSettings,omitempty"` // The internal name for the Loyalty Program. This is an immutable value. Name string `json:"name"` // The tiers in this loyalty program. @@ -224,6 +228,39 @@ func (o *NewLoyaltyProgram) SetSandbox(v bool) { o.Sandbox = v } +// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. +func (o *NewLoyaltyProgram) GetProgramJoinPolicy() string { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret + } + return *o.ProgramJoinPolicy +} + +// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret, false + } + return *o.ProgramJoinPolicy, true +} + +// HasProgramJoinPolicy returns a boolean if a field has been set. +func (o *NewLoyaltyProgram) HasProgramJoinPolicy() bool { + if o != nil && o.ProgramJoinPolicy != nil { + return true + } + + return false +} + +// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +func (o *NewLoyaltyProgram) SetProgramJoinPolicy(v string) { + o.ProgramJoinPolicy = &v +} + // GetTiersExpirationPolicy returns the TiersExpirationPolicy field value if set, zero value otherwise. func (o *NewLoyaltyProgram) GetTiersExpirationPolicy() string { if o == nil || o.TiersExpirationPolicy == nil { @@ -257,6 +294,39 @@ func (o *NewLoyaltyProgram) SetTiersExpirationPolicy(v string) { o.TiersExpirationPolicy = &v } +// GetTierCycleStartDate returns the TierCycleStartDate field value if set, zero value otherwise. +func (o *NewLoyaltyProgram) GetTierCycleStartDate() time.Time { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret + } + return *o.TierCycleStartDate +} + +// GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool) { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret, false + } + return *o.TierCycleStartDate, true +} + +// HasTierCycleStartDate returns a boolean if a field has been set. +func (o *NewLoyaltyProgram) HasTierCycleStartDate() bool { + if o != nil && o.TierCycleStartDate != nil { + return true + } + + return false +} + +// SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. +func (o *NewLoyaltyProgram) SetTierCycleStartDate(v time.Time) { + o.TierCycleStartDate = &v +} + // GetTiersExpireIn returns the TiersExpireIn field value if set, zero value otherwise. func (o *NewLoyaltyProgram) GetTiersExpireIn() string { if o == nil || o.TiersExpireIn == nil { @@ -323,37 +393,37 @@ func (o *NewLoyaltyProgram) SetTiersDowngradePolicy(v string) { o.TiersDowngradePolicy = &v } -// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. -func (o *NewLoyaltyProgram) GetProgramJoinPolicy() string { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +// GetCardCodeSettings returns the CardCodeSettings field value if set, zero value otherwise. +func (o *NewLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret } - return *o.ProgramJoinPolicy + return *o.CardCodeSettings } -// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *NewLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +func (o *NewLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret, false } - return *o.ProgramJoinPolicy, true + return *o.CardCodeSettings, true } -// HasProgramJoinPolicy returns a boolean if a field has been set. -func (o *NewLoyaltyProgram) HasProgramJoinPolicy() bool { - if o != nil && o.ProgramJoinPolicy != nil { +// HasCardCodeSettings returns a boolean if a field has been set. +func (o *NewLoyaltyProgram) HasCardCodeSettings() bool { + if o != nil && o.CardCodeSettings != nil { return true } return false } -// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. -func (o *NewLoyaltyProgram) SetProgramJoinPolicy(v string) { - o.ProgramJoinPolicy = &v +// SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. +func (o *NewLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings) { + o.CardCodeSettings = &v } // GetName returns the Name field value diff --git a/model_new_outgoing_integration_webhook.go b/model_new_outgoing_integration_webhook.go index d9bb41b0..cde3ab17 100644 --- a/model_new_outgoing_integration_webhook.go +++ b/model_new_outgoing_integration_webhook.go @@ -18,6 +18,8 @@ import ( type NewOutgoingIntegrationWebhook struct { // Webhook title. Title string `json:"title"` + // A description of the webhook. + Description *string `json:"description,omitempty"` // IDs of the Applications to which a webhook must be linked. ApplicationIds []int32 `json:"applicationIds"` } @@ -37,6 +39,39 @@ func (o *NewOutgoingIntegrationWebhook) SetTitle(v string) { o.Title = v } +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewOutgoingIntegrationWebhook) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewOutgoingIntegrationWebhook) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewOutgoingIntegrationWebhook) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewOutgoingIntegrationWebhook) SetDescription(v string) { + o.Description = &v +} + // GetApplicationIds returns the ApplicationIds field value func (o *NewOutgoingIntegrationWebhook) GetApplicationIds() []int32 { if o == nil { diff --git a/model_new_referral.go b/model_new_referral.go index 0e5dba7d..2aa00e2c 100644 --- a/model_new_referral.go +++ b/model_new_referral.go @@ -19,7 +19,7 @@ import ( type NewReferral struct { // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_new_referrals_for_multiple_advocates.go b/model_new_referrals_for_multiple_advocates.go index 714b2ac3..1e1ca887 100644 --- a/model_new_referrals_for_multiple_advocates.go +++ b/model_new_referrals_for_multiple_advocates.go @@ -19,7 +19,7 @@ import ( type NewReferralsForMultipleAdvocates struct { // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` diff --git a/model_new_revision_version.go b/model_new_revision_version.go new file mode 100644 index 00000000..68d04881 --- /dev/null +++ b/model_new_revision_version.go @@ -0,0 +1,425 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// NewRevisionVersion struct for NewRevisionVersion +type NewRevisionVersion struct { + // A user-facing name for this campaign. + Name *string `json:"name,omitempty"` + // Timestamp when the campaign will become active. + StartTime *NullableTime `json:"startTime,omitempty"` + // Timestamp when the campaign will become inactive. + EndTime *NullableTime `json:"endTime,omitempty"` + // Arbitrary properties associated with this campaign. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // A detailed description of the campaign. + Description *NullableString `json:"description,omitempty"` + // The ID of the ruleset this campaign template will use. + ActiveRulesetId *NullableInt32 `json:"activeRulesetId,omitempty"` + // A list of tags for the campaign template. + Tags *[]string `json:"tags,omitempty"` + CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` + ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` + // The set of limits that will operate for this campaign version. + Limits *[]LimitConfig `json:"limits,omitempty"` + // A list of features for the campaign template. + Features *[]string `json:"features,omitempty"` +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetNameOk() (string, bool) { + if o == nil || o.Name == nil { + var ret string + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *NewRevisionVersion) SetName(v string) { + o.Name = &v +} + +// GetStartTime returns the StartTime field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetStartTime() NullableTime { + if o == nil || o.StartTime == nil { + var ret NullableTime + return ret + } + return *o.StartTime +} + +// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetStartTimeOk() (NullableTime, bool) { + if o == nil || o.StartTime == nil { + var ret NullableTime + return ret, false + } + return *o.StartTime, true +} + +// HasStartTime returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasStartTime() bool { + if o != nil && o.StartTime != nil { + return true + } + + return false +} + +// SetStartTime gets a reference to the given NullableTime and assigns it to the StartTime field. +func (o *NewRevisionVersion) SetStartTime(v NullableTime) { + o.StartTime = &v +} + +// GetEndTime returns the EndTime field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetEndTime() NullableTime { + if o == nil || o.EndTime == nil { + var ret NullableTime + return ret + } + return *o.EndTime +} + +// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetEndTimeOk() (NullableTime, bool) { + if o == nil || o.EndTime == nil { + var ret NullableTime + return ret, false + } + return *o.EndTime, true +} + +// HasEndTime returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasEndTime() bool { + if o != nil && o.EndTime != nil { + return true + } + + return false +} + +// SetEndTime gets a reference to the given NullableTime and assigns it to the EndTime field. +func (o *NewRevisionVersion) SetEndTime(v NullableTime) { + o.EndTime = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *NewRevisionVersion) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetDescription() NullableString { + if o == nil || o.Description == nil { + var ret NullableString + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetDescriptionOk() (NullableString, bool) { + if o == nil || o.Description == nil { + var ret NullableString + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given NullableString and assigns it to the Description field. +func (o *NewRevisionVersion) SetDescription(v NullableString) { + o.Description = &v +} + +// GetActiveRulesetId returns the ActiveRulesetId field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetActiveRulesetId() NullableInt32 { + if o == nil || o.ActiveRulesetId == nil { + var ret NullableInt32 + return ret + } + return *o.ActiveRulesetId +} + +// GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetActiveRulesetIdOk() (NullableInt32, bool) { + if o == nil || o.ActiveRulesetId == nil { + var ret NullableInt32 + return ret, false + } + return *o.ActiveRulesetId, true +} + +// HasActiveRulesetId returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasActiveRulesetId() bool { + if o != nil && o.ActiveRulesetId != nil { + return true + } + + return false +} + +// SetActiveRulesetId gets a reference to the given NullableInt32 and assigns it to the ActiveRulesetId field. +func (o *NewRevisionVersion) SetActiveRulesetId(v NullableInt32) { + o.ActiveRulesetId = &v +} + +// GetTags returns the Tags field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetTags() []string { + if o == nil || o.Tags == nil { + var ret []string + return ret + } + return *o.Tags +} + +// GetTagsOk returns a tuple with the Tags field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetTagsOk() ([]string, bool) { + if o == nil || o.Tags == nil { + var ret []string + return ret, false + } + return *o.Tags, true +} + +// HasTags returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasTags() bool { + if o != nil && o.Tags != nil { + return true + } + + return false +} + +// SetTags gets a reference to the given []string and assigns it to the Tags field. +func (o *NewRevisionVersion) SetTags(v []string) { + o.Tags = &v +} + +// GetCouponSettings returns the CouponSettings field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetCouponSettings() CodeGeneratorSettings { + if o == nil || o.CouponSettings == nil { + var ret CodeGeneratorSettings + return ret + } + return *o.CouponSettings +} + +// GetCouponSettingsOk returns a tuple with the CouponSettings field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetCouponSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CouponSettings == nil { + var ret CodeGeneratorSettings + return ret, false + } + return *o.CouponSettings, true +} + +// HasCouponSettings returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasCouponSettings() bool { + if o != nil && o.CouponSettings != nil { + return true + } + + return false +} + +// SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. +func (o *NewRevisionVersion) SetCouponSettings(v CodeGeneratorSettings) { + o.CouponSettings = &v +} + +// GetReferralSettings returns the ReferralSettings field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetReferralSettings() CodeGeneratorSettings { + if o == nil || o.ReferralSettings == nil { + var ret CodeGeneratorSettings + return ret + } + return *o.ReferralSettings +} + +// GetReferralSettingsOk returns a tuple with the ReferralSettings field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetReferralSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.ReferralSettings == nil { + var ret CodeGeneratorSettings + return ret, false + } + return *o.ReferralSettings, true +} + +// HasReferralSettings returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasReferralSettings() bool { + if o != nil && o.ReferralSettings != nil { + return true + } + + return false +} + +// SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. +func (o *NewRevisionVersion) SetReferralSettings(v CodeGeneratorSettings) { + o.ReferralSettings = &v +} + +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *NewRevisionVersion) SetLimits(v []LimitConfig) { + o.Limits = &v +} + +// GetFeatures returns the Features field value if set, zero value otherwise. +func (o *NewRevisionVersion) GetFeatures() []string { + if o == nil || o.Features == nil { + var ret []string + return ret + } + return *o.Features +} + +// GetFeaturesOk returns a tuple with the Features field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewRevisionVersion) GetFeaturesOk() ([]string, bool) { + if o == nil || o.Features == nil { + var ret []string + return ret, false + } + return *o.Features, true +} + +// HasFeatures returns a boolean if a field has been set. +func (o *NewRevisionVersion) HasFeatures() bool { + if o != nil && o.Features != nil { + return true + } + + return false +} + +// SetFeatures gets a reference to the given []string and assigns it to the Features field. +func (o *NewRevisionVersion) SetFeatures(v []string) { + o.Features = &v +} + +type NullableNewRevisionVersion struct { + Value NewRevisionVersion + ExplicitNull bool +} + +func (v NullableNewRevisionVersion) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableNewRevisionVersion) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_template_def.go b/model_new_template_def.go index bd92bbf0..e33c6a18 100644 --- a/model_new_template_def.go +++ b/model_new_template_def.go @@ -25,7 +25,7 @@ type NewTemplateDef struct { // Used for grouping templates in the rule editor sidebar. Category string `json:"category"` // A Talang expression that contains variable bindings referring to args. - Expr []interface{} `json:"expr"` + Expr []map[string]interface{} `json:"expr"` // An array of argument definitions. Args []TemplateArgDef `json:"args"` // A flag to control exposure in Rule Builder. @@ -129,9 +129,9 @@ func (o *NewTemplateDef) SetCategory(v string) { } // GetExpr returns the Expr field value -func (o *NewTemplateDef) GetExpr() []interface{} { +func (o *NewTemplateDef) GetExpr() []map[string]interface{} { if o == nil { - var ret []interface{} + var ret []map[string]interface{} return ret } @@ -139,7 +139,7 @@ func (o *NewTemplateDef) GetExpr() []interface{} { } // SetExpr sets field value -func (o *NewTemplateDef) SetExpr(v []interface{}) { +func (o *NewTemplateDef) SetExpr(v []map[string]interface{}) { o.Expr = v } diff --git a/model_new_webhook.go b/model_new_webhook.go index caea4be3..1010ffcb 100644 --- a/model_new_webhook.go +++ b/model_new_webhook.go @@ -20,6 +20,8 @@ type NewWebhook struct { ApplicationIds []int32 `json:"applicationIds"` // Name or title for this webhook. Title string `json:"title"` + // A description of the webhook. + Description *string `json:"description,omitempty"` // API method for this webhook. Verb string `json:"verb"` // API URL (supports templating using parameters) for this webhook. @@ -64,6 +66,39 @@ func (o *NewWebhook) SetTitle(v string) { o.Title = v } +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *NewWebhook) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *NewWebhook) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *NewWebhook) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *NewWebhook) SetDescription(v string) { + o.Description = &v +} + // GetVerb returns the Verb field value func (o *NewWebhook) GetVerb() string { if o == nil { diff --git a/model_notification_webhook.go b/model_notification_webhook.go deleted file mode 100644 index 6d9bc7c2..00000000 --- a/model_notification_webhook.go +++ /dev/null @@ -1,180 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" - "time" -) - -// NotificationWebhook -type NotificationWebhook struct { - // Internal ID of this entity. - Id int32 `json:"id"` - // The time this entity was created. - Created time.Time `json:"created"` - // The time this entity was last modified. - Modified time.Time `json:"modified"` - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // API URL for the given webhook-based notification. - Url string `json:"url"` - // List of API HTTP headers for the given webhook-based notification. - Headers []string `json:"headers"` - // Indicates whether the notification is activated. - Enabled *bool `json:"enabled,omitempty"` -} - -// GetId returns the Id field value -func (o *NotificationWebhook) GetId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Id -} - -// SetId sets field value -func (o *NotificationWebhook) SetId(v int32) { - o.Id = v -} - -// GetCreated returns the Created field value -func (o *NotificationWebhook) GetCreated() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Created -} - -// SetCreated sets field value -func (o *NotificationWebhook) SetCreated(v time.Time) { - o.Created = v -} - -// GetModified returns the Modified field value -func (o *NotificationWebhook) GetModified() time.Time { - if o == nil { - var ret time.Time - return ret - } - - return o.Modified -} - -// SetModified sets field value -func (o *NotificationWebhook) SetModified(v time.Time) { - o.Modified = v -} - -// GetApplicationId returns the ApplicationId field value -func (o *NotificationWebhook) GetApplicationId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.ApplicationId -} - -// SetApplicationId sets field value -func (o *NotificationWebhook) SetApplicationId(v int32) { - o.ApplicationId = v -} - -// GetUrl returns the Url field value -func (o *NotificationWebhook) GetUrl() string { - if o == nil { - var ret string - return ret - } - - return o.Url -} - -// SetUrl sets field value -func (o *NotificationWebhook) SetUrl(v string) { - o.Url = v -} - -// GetHeaders returns the Headers field value -func (o *NotificationWebhook) GetHeaders() []string { - if o == nil { - var ret []string - return ret - } - - return o.Headers -} - -// SetHeaders sets field value -func (o *NotificationWebhook) SetHeaders(v []string) { - o.Headers = v -} - -// GetEnabled returns the Enabled field value if set, zero value otherwise. -func (o *NotificationWebhook) GetEnabled() bool { - if o == nil || o.Enabled == nil { - var ret bool - return ret - } - return *o.Enabled -} - -// GetEnabledOk returns a tuple with the Enabled field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *NotificationWebhook) GetEnabledOk() (bool, bool) { - if o == nil || o.Enabled == nil { - var ret bool - return ret, false - } - return *o.Enabled, true -} - -// HasEnabled returns a boolean if a field has been set. -func (o *NotificationWebhook) HasEnabled() bool { - if o != nil && o.Enabled != nil { - return true - } - - return false -} - -// SetEnabled gets a reference to the given bool and assigns it to the Enabled field. -func (o *NotificationWebhook) SetEnabled(v bool) { - o.Enabled = &v -} - -type NullableNotificationWebhook struct { - Value NotificationWebhook - ExplicitNull bool -} - -func (v NullableNotificationWebhook) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableNotificationWebhook) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_okta_event.go b/model_okta_event.go new file mode 100644 index 00000000..505b4595 --- /dev/null +++ b/model_okta_event.go @@ -0,0 +1,75 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OktaEvent Single event definition in the event data emitted by Okta. +type OktaEvent struct { + // Event type defining an action. + EventType string `json:"eventType"` + Target []OktaEventTarget `json:"target"` +} + +// GetEventType returns the EventType field value +func (o *OktaEvent) GetEventType() string { + if o == nil { + var ret string + return ret + } + + return o.EventType +} + +// SetEventType sets field value +func (o *OktaEvent) SetEventType(v string) { + o.EventType = v +} + +// GetTarget returns the Target field value +func (o *OktaEvent) GetTarget() []OktaEventTarget { + if o == nil { + var ret []OktaEventTarget + return ret + } + + return o.Target +} + +// SetTarget sets field value +func (o *OktaEvent) SetTarget(v []OktaEventTarget) { + o.Target = v +} + +type NullableOktaEvent struct { + Value OktaEvent + ExplicitNull bool +} + +func (v NullableOktaEvent) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOktaEvent) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_frontend_state.go b/model_okta_event_payload.go similarity index 64% rename from model_frontend_state.go rename to model_okta_event_payload.go index eb7d3d7c..fc1eee11 100644 --- a/model_frontend_state.go +++ b/model_okta_event_payload.go @@ -14,24 +14,32 @@ import ( "encoding/json" ) -// FrontendState A campaign state described exactly as in the Campaign Manager. -type FrontendState string - -// List of FrontendState -const ( - EXPIRED FrontendState = "expired" - SCHEDULED FrontendState = "scheduled" - RUNNING FrontendState = "running" - DRAFT FrontendState = "draft" - DISABLED FrontendState = "disabled" -) +// OktaEventPayload Payload containing provisioning event details from Okta. +type OktaEventPayload struct { + Data OktaEventPayloadData `json:"data"` +} + +// GetData returns the Data field value +func (o *OktaEventPayload) GetData() OktaEventPayloadData { + if o == nil { + var ret OktaEventPayloadData + return ret + } + + return o.Data +} + +// SetData sets field value +func (o *OktaEventPayload) SetData(v OktaEventPayloadData) { + o.Data = v +} -type NullableFrontendState struct { - Value FrontendState +type NullableOktaEventPayload struct { + Value OktaEventPayload ExplicitNull bool } -func (v NullableFrontendState) MarshalJSON() ([]byte, error) { +func (v NullableOktaEventPayload) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -40,7 +48,7 @@ func (v NullableFrontendState) MarshalJSON() ([]byte, error) { } } -func (v *NullableFrontendState) UnmarshalJSON(src []byte) error { +func (v *NullableOktaEventPayload) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_okta_event_payload_data.go b/model_okta_event_payload_data.go new file mode 100644 index 00000000..dba9fed4 --- /dev/null +++ b/model_okta_event_payload_data.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// OktaEventPayloadData Data part of the event emitted by Okta. +type OktaEventPayloadData struct { + Events []OktaEvent `json:"events"` +} + +// GetEvents returns the Events field value +func (o *OktaEventPayloadData) GetEvents() []OktaEvent { + if o == nil { + var ret []OktaEvent + return ret + } + + return o.Events +} + +// SetEvents sets field value +func (o *OktaEventPayloadData) SetEvents(v []OktaEvent) { + o.Events = v +} + +type NullableOktaEventPayloadData struct { + Value OktaEventPayloadData + ExplicitNull bool +} + +func (v NullableOktaEventPayloadData) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableOktaEventPayloadData) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_new_campaign_set_v2.go b/model_okta_event_target.go similarity index 50% rename from model_new_campaign_set_v2.go rename to model_okta_event_target.go index ec86956e..1338fe1b 100644 --- a/model_new_campaign_set_v2.go +++ b/model_okta_event_target.go @@ -14,66 +14,67 @@ import ( "encoding/json" ) -// NewCampaignSetV2 -type NewCampaignSetV2 struct { - // The ID of the application that owns this entity. - ApplicationId int32 `json:"applicationId"` - // Version of the campaign set. - Version int32 `json:"version"` - Set CampaignPrioritiesV2 `json:"set"` +// OktaEventTarget Target of the specific Okta event. +type OktaEventTarget struct { + // Type of the event target. + Type string `json:"type"` + // Identifier of the event target, depending on its type. + AlternateId string `json:"alternateId"` + // Display name of the event target. + DisplayName string `json:"displayName"` } -// GetApplicationId returns the ApplicationId field value -func (o *NewCampaignSetV2) GetApplicationId() int32 { +// GetType returns the Type field value +func (o *OktaEventTarget) GetType() string { if o == nil { - var ret int32 + var ret string return ret } - return o.ApplicationId + return o.Type } -// SetApplicationId sets field value -func (o *NewCampaignSetV2) SetApplicationId(v int32) { - o.ApplicationId = v +// SetType sets field value +func (o *OktaEventTarget) SetType(v string) { + o.Type = v } -// GetVersion returns the Version field value -func (o *NewCampaignSetV2) GetVersion() int32 { +// GetAlternateId returns the AlternateId field value +func (o *OktaEventTarget) GetAlternateId() string { if o == nil { - var ret int32 + var ret string return ret } - return o.Version + return o.AlternateId } -// SetVersion sets field value -func (o *NewCampaignSetV2) SetVersion(v int32) { - o.Version = v +// SetAlternateId sets field value +func (o *OktaEventTarget) SetAlternateId(v string) { + o.AlternateId = v } -// GetSet returns the Set field value -func (o *NewCampaignSetV2) GetSet() CampaignPrioritiesV2 { +// GetDisplayName returns the DisplayName field value +func (o *OktaEventTarget) GetDisplayName() string { if o == nil { - var ret CampaignPrioritiesV2 + var ret string return ret } - return o.Set + return o.DisplayName } -// SetSet sets field value -func (o *NewCampaignSetV2) SetSet(v CampaignPrioritiesV2) { - o.Set = v +// SetDisplayName sets field value +func (o *OktaEventTarget) SetDisplayName(v string) { + o.DisplayName = v } -type NullableNewCampaignSetV2 struct { - Value NewCampaignSetV2 +type NullableOktaEventTarget struct { + Value OktaEventTarget ExplicitNull bool } -func (v NullableNewCampaignSetV2) MarshalJSON() ([]byte, error) { +func (v NullableOktaEventTarget) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -82,7 +83,7 @@ func (v NullableNewCampaignSetV2) MarshalJSON() ([]byte, error) { } } -func (v *NullableNewCampaignSetV2) UnmarshalJSON(src []byte) error { +func (v *NullableOktaEventTarget) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_outgoing_integration_webhook_template.go b/model_outgoing_integration_webhook_template.go deleted file mode 100644 index 81be4ed0..00000000 --- a/model_outgoing_integration_webhook_template.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// OutgoingIntegrationWebhookTemplate struct for OutgoingIntegrationWebhookTemplate -type OutgoingIntegrationWebhookTemplate struct { - // Unique Id for this entity. - Id int32 `json:"id"` - // Unique Id of outgoing integration type. - IntegrationType int32 `json:"integrationType"` - // Title of the webhook template. - Title string `json:"title"` - // General description for the specific outgoing integration webhook template. - Description string `json:"description"` - // API payload (supports templating using parameters) for this webhook template. - Payload string `json:"payload"` - // API method for this webhook. - Method string `json:"method"` -} - -// GetId returns the Id field value -func (o *OutgoingIntegrationWebhookTemplate) GetId() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.Id -} - -// SetId sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetId(v int32) { - o.Id = v -} - -// GetIntegrationType returns the IntegrationType field value -func (o *OutgoingIntegrationWebhookTemplate) GetIntegrationType() int32 { - if o == nil { - var ret int32 - return ret - } - - return o.IntegrationType -} - -// SetIntegrationType sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetIntegrationType(v int32) { - o.IntegrationType = v -} - -// GetTitle returns the Title field value -func (o *OutgoingIntegrationWebhookTemplate) GetTitle() string { - if o == nil { - var ret string - return ret - } - - return o.Title -} - -// SetTitle sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetTitle(v string) { - o.Title = v -} - -// GetDescription returns the Description field value -func (o *OutgoingIntegrationWebhookTemplate) GetDescription() string { - if o == nil { - var ret string - return ret - } - - return o.Description -} - -// SetDescription sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetDescription(v string) { - o.Description = v -} - -// GetPayload returns the Payload field value -func (o *OutgoingIntegrationWebhookTemplate) GetPayload() string { - if o == nil { - var ret string - return ret - } - - return o.Payload -} - -// SetPayload sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetPayload(v string) { - o.Payload = v -} - -// GetMethod returns the Method field value -func (o *OutgoingIntegrationWebhookTemplate) GetMethod() string { - if o == nil { - var ret string - return ret - } - - return o.Method -} - -// SetMethod sets field value -func (o *OutgoingIntegrationWebhookTemplate) SetMethod(v string) { - o.Method = v -} - -type NullableOutgoingIntegrationWebhookTemplate struct { - Value OutgoingIntegrationWebhookTemplate - ExplicitNull bool -} - -func (v NullableOutgoingIntegrationWebhookTemplate) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableOutgoingIntegrationWebhookTemplate) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_outgoing_integration_webhook_templates.go b/model_outgoing_integration_webhook_templates.go deleted file mode 100644 index 0564740f..00000000 --- a/model_outgoing_integration_webhook_templates.go +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// OutgoingIntegrationWebhookTemplates struct for OutgoingIntegrationWebhookTemplates -type OutgoingIntegrationWebhookTemplates struct { - // The list of webhook templates for a given outgoing integration type. - Data *[]OutgoingIntegrationWebhookTemplate `json:"data,omitempty"` -} - -// GetData returns the Data field value if set, zero value otherwise. -func (o *OutgoingIntegrationWebhookTemplates) GetData() []OutgoingIntegrationWebhookTemplate { - if o == nil || o.Data == nil { - var ret []OutgoingIntegrationWebhookTemplate - return ret - } - return *o.Data -} - -// GetDataOk returns a tuple with the Data field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *OutgoingIntegrationWebhookTemplates) GetDataOk() ([]OutgoingIntegrationWebhookTemplate, bool) { - if o == nil || o.Data == nil { - var ret []OutgoingIntegrationWebhookTemplate - return ret, false - } - return *o.Data, true -} - -// HasData returns a boolean if a field has been set. -func (o *OutgoingIntegrationWebhookTemplates) HasData() bool { - if o != nil && o.Data != nil { - return true - } - - return false -} - -// SetData gets a reference to the given []OutgoingIntegrationWebhookTemplate and assigns it to the Data field. -func (o *OutgoingIntegrationWebhookTemplates) SetData(v []OutgoingIntegrationWebhookTemplate) { - o.Data = &v -} - -type NullableOutgoingIntegrationWebhookTemplates struct { - Value OutgoingIntegrationWebhookTemplates - ExplicitNull bool -} - -func (v NullableOutgoingIntegrationWebhookTemplates) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableOutgoingIntegrationWebhookTemplates) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_projected_tier.go b/model_projected_tier.go new file mode 100644 index 00000000..c11d79e2 --- /dev/null +++ b/model_projected_tier.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ProjectedTier struct for ProjectedTier +type ProjectedTier struct { + // The active points of the customer when their current tier expires. + ProjectedActivePoints float32 `json:"projectedActivePoints"` + // The number of points the customer needs to stay in the current tier. **Note**: This is included in the response when the customer is projected to be downgraded. + StayInTierPoints *float32 `json:"stayInTierPoints,omitempty"` + // The name of the tier the user will enter once their current tier expires. + ProjectedTierName *string `json:"projectedTierName,omitempty"` +} + +// GetProjectedActivePoints returns the ProjectedActivePoints field value +func (o *ProjectedTier) GetProjectedActivePoints() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.ProjectedActivePoints +} + +// SetProjectedActivePoints sets field value +func (o *ProjectedTier) SetProjectedActivePoints(v float32) { + o.ProjectedActivePoints = v +} + +// GetStayInTierPoints returns the StayInTierPoints field value if set, zero value otherwise. +func (o *ProjectedTier) GetStayInTierPoints() float32 { + if o == nil || o.StayInTierPoints == nil { + var ret float32 + return ret + } + return *o.StayInTierPoints +} + +// GetStayInTierPointsOk returns a tuple with the StayInTierPoints field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ProjectedTier) GetStayInTierPointsOk() (float32, bool) { + if o == nil || o.StayInTierPoints == nil { + var ret float32 + return ret, false + } + return *o.StayInTierPoints, true +} + +// HasStayInTierPoints returns a boolean if a field has been set. +func (o *ProjectedTier) HasStayInTierPoints() bool { + if o != nil && o.StayInTierPoints != nil { + return true + } + + return false +} + +// SetStayInTierPoints gets a reference to the given float32 and assigns it to the StayInTierPoints field. +func (o *ProjectedTier) SetStayInTierPoints(v float32) { + o.StayInTierPoints = &v +} + +// GetProjectedTierName returns the ProjectedTierName field value if set, zero value otherwise. +func (o *ProjectedTier) GetProjectedTierName() string { + if o == nil || o.ProjectedTierName == nil { + var ret string + return ret + } + return *o.ProjectedTierName +} + +// GetProjectedTierNameOk returns a tuple with the ProjectedTierName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ProjectedTier) GetProjectedTierNameOk() (string, bool) { + if o == nil || o.ProjectedTierName == nil { + var ret string + return ret, false + } + return *o.ProjectedTierName, true +} + +// HasProjectedTierName returns a boolean if a field has been set. +func (o *ProjectedTier) HasProjectedTierName() bool { + if o != nil && o.ProjectedTierName != nil { + return true + } + + return false +} + +// SetProjectedTierName gets a reference to the given string and assigns it to the ProjectedTierName field. +func (o *ProjectedTier) SetProjectedTierName(v string) { + o.ProjectedTierName = &v +} + +type NullableProjectedTier struct { + Value ProjectedTier + ExplicitNull bool +} + +func (v NullableProjectedTier) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableProjectedTier) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_referral.go b/model_referral.go index 20480752..8c861e5f 100644 --- a/model_referral.go +++ b/model_referral.go @@ -23,7 +23,7 @@ type Referral struct { Created time.Time `json:"created"` // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit int32 `json:"usageLimit"` diff --git a/model_referral_constraints.go b/model_referral_constraints.go index 57ae54d0..edfba1b0 100644 --- a/model_referral_constraints.go +++ b/model_referral_constraints.go @@ -19,7 +19,7 @@ import ( type ReferralConstraints struct { // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_reject_coupon_effect_props.go b/model_reject_coupon_effect_props.go index c2d43dc2..04dd01e2 100644 --- a/model_reject_coupon_effect_props.go +++ b/model_reject_coupon_effect_props.go @@ -26,6 +26,8 @@ type RejectCouponEffectProps struct { EffectIndex *int32 `json:"effectIndex,omitempty"` // More details about the failure. Details *string `json:"details,omitempty"` + // The reason why the campaign was not applied. + CampaignExclusionReason *string `json:"campaignExclusionReason,omitempty"` } // GetValue returns the Value field value @@ -157,6 +159,39 @@ func (o *RejectCouponEffectProps) SetDetails(v string) { o.Details = &v } +// GetCampaignExclusionReason returns the CampaignExclusionReason field value if set, zero value otherwise. +func (o *RejectCouponEffectProps) GetCampaignExclusionReason() string { + if o == nil || o.CampaignExclusionReason == nil { + var ret string + return ret + } + return *o.CampaignExclusionReason +} + +// GetCampaignExclusionReasonOk returns a tuple with the CampaignExclusionReason field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RejectCouponEffectProps) GetCampaignExclusionReasonOk() (string, bool) { + if o == nil || o.CampaignExclusionReason == nil { + var ret string + return ret, false + } + return *o.CampaignExclusionReason, true +} + +// HasCampaignExclusionReason returns a boolean if a field has been set. +func (o *RejectCouponEffectProps) HasCampaignExclusionReason() bool { + if o != nil && o.CampaignExclusionReason != nil { + return true + } + + return false +} + +// SetCampaignExclusionReason gets a reference to the given string and assigns it to the CampaignExclusionReason field. +func (o *RejectCouponEffectProps) SetCampaignExclusionReason(v string) { + o.CampaignExclusionReason = &v +} + type NullableRejectCouponEffectProps struct { Value RejectCouponEffectProps ExplicitNull bool diff --git a/model_reject_referral_effect_props.go b/model_reject_referral_effect_props.go index 1808a60e..07095c16 100644 --- a/model_reject_referral_effect_props.go +++ b/model_reject_referral_effect_props.go @@ -26,6 +26,8 @@ type RejectReferralEffectProps struct { EffectIndex *int32 `json:"effectIndex,omitempty"` // More details about the failure. Details *string `json:"details,omitempty"` + // The reason why the campaign was not applied. + CampaignExclusionReason *string `json:"campaignExclusionReason,omitempty"` } // GetValue returns the Value field value @@ -157,6 +159,39 @@ func (o *RejectReferralEffectProps) SetDetails(v string) { o.Details = &v } +// GetCampaignExclusionReason returns the CampaignExclusionReason field value if set, zero value otherwise. +func (o *RejectReferralEffectProps) GetCampaignExclusionReason() string { + if o == nil || o.CampaignExclusionReason == nil { + var ret string + return ret + } + return *o.CampaignExclusionReason +} + +// GetCampaignExclusionReasonOk returns a tuple with the CampaignExclusionReason field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RejectReferralEffectProps) GetCampaignExclusionReasonOk() (string, bool) { + if o == nil || o.CampaignExclusionReason == nil { + var ret string + return ret, false + } + return *o.CampaignExclusionReason, true +} + +// HasCampaignExclusionReason returns a boolean if a field has been set. +func (o *RejectReferralEffectProps) HasCampaignExclusionReason() bool { + if o != nil && o.CampaignExclusionReason != nil { + return true + } + + return false +} + +// SetCampaignExclusionReason gets a reference to the given string and assigns it to the CampaignExclusionReason field. +func (o *RejectReferralEffectProps) SetCampaignExclusionReason(v string) { + o.CampaignExclusionReason = &v +} + type NullableRejectReferralEffectProps struct { Value RejectReferralEffectProps ExplicitNull bool diff --git a/model_revision.go b/model_revision.go new file mode 100644 index 00000000..caec0cd2 --- /dev/null +++ b/model_revision.go @@ -0,0 +1,276 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// Revision +type Revision struct { + // 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. + Id int32 `json:"id"` + ActivateAt *time.Time `json:"activateAt,omitempty"` + AccountId int32 `json:"accountId"` + ApplicationId int32 `json:"applicationId"` + CampaignId int32 `json:"campaignId"` + Created time.Time `json:"created"` + CreatedBy int32 `json:"createdBy"` + ActivatedAt *time.Time `json:"activatedAt,omitempty"` + ActivatedBy *int32 `json:"activatedBy,omitempty"` + CurrentVersion *RevisionVersion `json:"currentVersion,omitempty"` +} + +// GetId returns the Id field value +func (o *Revision) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *Revision) SetId(v int32) { + o.Id = v +} + +// GetActivateAt returns the ActivateAt field value if set, zero value otherwise. +func (o *Revision) GetActivateAt() time.Time { + if o == nil || o.ActivateAt == nil { + var ret time.Time + return ret + } + return *o.ActivateAt +} + +// GetActivateAtOk returns a tuple with the ActivateAt field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Revision) GetActivateAtOk() (time.Time, bool) { + if o == nil || o.ActivateAt == nil { + var ret time.Time + return ret, false + } + return *o.ActivateAt, true +} + +// HasActivateAt returns a boolean if a field has been set. +func (o *Revision) HasActivateAt() bool { + if o != nil && o.ActivateAt != nil { + return true + } + + return false +} + +// SetActivateAt gets a reference to the given time.Time and assigns it to the ActivateAt field. +func (o *Revision) SetActivateAt(v time.Time) { + o.ActivateAt = &v +} + +// GetAccountId returns the AccountId field value +func (o *Revision) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *Revision) SetAccountId(v int32) { + o.AccountId = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *Revision) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *Revision) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetCampaignId returns the CampaignId field value +func (o *Revision) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *Revision) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetCreated returns the Created field value +func (o *Revision) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *Revision) SetCreated(v time.Time) { + o.Created = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *Revision) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *Revision) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetActivatedAt returns the ActivatedAt field value if set, zero value otherwise. +func (o *Revision) GetActivatedAt() time.Time { + if o == nil || o.ActivatedAt == nil { + var ret time.Time + return ret + } + return *o.ActivatedAt +} + +// GetActivatedAtOk returns a tuple with the ActivatedAt field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Revision) GetActivatedAtOk() (time.Time, bool) { + if o == nil || o.ActivatedAt == nil { + var ret time.Time + return ret, false + } + return *o.ActivatedAt, true +} + +// HasActivatedAt returns a boolean if a field has been set. +func (o *Revision) HasActivatedAt() bool { + if o != nil && o.ActivatedAt != nil { + return true + } + + return false +} + +// SetActivatedAt gets a reference to the given time.Time and assigns it to the ActivatedAt field. +func (o *Revision) SetActivatedAt(v time.Time) { + o.ActivatedAt = &v +} + +// GetActivatedBy returns the ActivatedBy field value if set, zero value otherwise. +func (o *Revision) GetActivatedBy() int32 { + if o == nil || o.ActivatedBy == nil { + var ret int32 + return ret + } + return *o.ActivatedBy +} + +// GetActivatedByOk returns a tuple with the ActivatedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Revision) GetActivatedByOk() (int32, bool) { + if o == nil || o.ActivatedBy == nil { + var ret int32 + return ret, false + } + return *o.ActivatedBy, true +} + +// HasActivatedBy returns a boolean if a field has been set. +func (o *Revision) HasActivatedBy() bool { + if o != nil && o.ActivatedBy != nil { + return true + } + + return false +} + +// SetActivatedBy gets a reference to the given int32 and assigns it to the ActivatedBy field. +func (o *Revision) SetActivatedBy(v int32) { + o.ActivatedBy = &v +} + +// GetCurrentVersion returns the CurrentVersion field value if set, zero value otherwise. +func (o *Revision) GetCurrentVersion() RevisionVersion { + if o == nil || o.CurrentVersion == nil { + var ret RevisionVersion + return ret + } + return *o.CurrentVersion +} + +// GetCurrentVersionOk returns a tuple with the CurrentVersion field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Revision) GetCurrentVersionOk() (RevisionVersion, bool) { + if o == nil || o.CurrentVersion == nil { + var ret RevisionVersion + return ret, false + } + return *o.CurrentVersion, true +} + +// HasCurrentVersion returns a boolean if a field has been set. +func (o *Revision) HasCurrentVersion() bool { + if o != nil && o.CurrentVersion != nil { + return true + } + + return false +} + +// SetCurrentVersion gets a reference to the given RevisionVersion and assigns it to the CurrentVersion field. +func (o *Revision) SetCurrentVersion(v RevisionVersion) { + o.CurrentVersion = &v +} + +type NullableRevision struct { + Value Revision + ExplicitNull bool +} + +func (v NullableRevision) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRevision) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_campaign_set_i_ds.go b/model_revision_activation.go similarity index 54% rename from model_campaign_set_i_ds.go rename to model_revision_activation.go index 7caf7337..9732f35d 100644 --- a/model_campaign_set_i_ds.go +++ b/model_revision_activation.go @@ -12,53 +12,53 @@ package talon import ( "bytes" "encoding/json" + "time" ) -// CampaignSetIDs Campaign IDs for each priority. -type CampaignSetIDs struct { - // ID of the campaign - CampaignId *int32 `json:"campaignId,omitempty"` +// RevisionActivation struct for RevisionActivation +type RevisionActivation struct { + ActivateAt *time.Time `json:"activateAt,omitempty"` } -// GetCampaignId returns the CampaignId field value if set, zero value otherwise. -func (o *CampaignSetIDs) GetCampaignId() int32 { - if o == nil || o.CampaignId == nil { - var ret int32 +// GetActivateAt returns the ActivateAt field value if set, zero value otherwise. +func (o *RevisionActivation) GetActivateAt() time.Time { + if o == nil || o.ActivateAt == nil { + var ret time.Time return ret } - return *o.CampaignId + return *o.ActivateAt } -// GetCampaignIdOk returns a tuple with the CampaignId field value if set, zero value otherwise +// GetActivateAtOk returns a tuple with the ActivateAt field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *CampaignSetIDs) GetCampaignIdOk() (int32, bool) { - if o == nil || o.CampaignId == nil { - var ret int32 +func (o *RevisionActivation) GetActivateAtOk() (time.Time, bool) { + if o == nil || o.ActivateAt == nil { + var ret time.Time return ret, false } - return *o.CampaignId, true + return *o.ActivateAt, true } -// HasCampaignId returns a boolean if a field has been set. -func (o *CampaignSetIDs) HasCampaignId() bool { - if o != nil && o.CampaignId != nil { +// HasActivateAt returns a boolean if a field has been set. +func (o *RevisionActivation) HasActivateAt() bool { + if o != nil && o.ActivateAt != nil { return true } return false } -// SetCampaignId gets a reference to the given int32 and assigns it to the CampaignId field. -func (o *CampaignSetIDs) SetCampaignId(v int32) { - o.CampaignId = &v +// SetActivateAt gets a reference to the given time.Time and assigns it to the ActivateAt field. +func (o *RevisionActivation) SetActivateAt(v time.Time) { + o.ActivateAt = &v } -type NullableCampaignSetIDs struct { - Value CampaignSetIDs +type NullableRevisionActivation struct { + Value RevisionActivation ExplicitNull bool } -func (v NullableCampaignSetIDs) MarshalJSON() ([]byte, error) { +func (v NullableRevisionActivation) MarshalJSON() ([]byte, error) { switch { case v.ExplicitNull: return []byte("null"), nil @@ -67,7 +67,7 @@ func (v NullableCampaignSetIDs) MarshalJSON() ([]byte, error) { } } -func (v *NullableCampaignSetIDs) UnmarshalJSON(src []byte) error { +func (v *NullableRevisionActivation) UnmarshalJSON(src []byte) error { if bytes.Equal(src, []byte("null")) { v.ExplicitNull = true return nil diff --git a/model_revision_version.go b/model_revision_version.go new file mode 100644 index 00000000..b3932678 --- /dev/null +++ b/model_revision_version.go @@ -0,0 +1,555 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// RevisionVersion +type RevisionVersion struct { + // 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. + Id int32 `json:"id"` + AccountId int32 `json:"accountId"` + ApplicationId int32 `json:"applicationId"` + CampaignId int32 `json:"campaignId"` + Created time.Time `json:"created"` + CreatedBy int32 `json:"createdBy"` + RevisionId int32 `json:"revisionId"` + Version int32 `json:"version"` + // A user-facing name for this campaign. + Name *string `json:"name,omitempty"` + // Timestamp when the campaign will become active. + StartTime *NullableTime `json:"startTime,omitempty"` + // Timestamp when the campaign will become inactive. + EndTime *NullableTime `json:"endTime,omitempty"` + // Arbitrary properties associated with this campaign. + Attributes *map[string]interface{} `json:"attributes,omitempty"` + // A detailed description of the campaign. + Description *NullableString `json:"description,omitempty"` + // The ID of the ruleset this campaign template will use. + ActiveRulesetId *NullableInt32 `json:"activeRulesetId,omitempty"` + // A list of tags for the campaign template. + Tags *[]string `json:"tags,omitempty"` + CouponSettings *CodeGeneratorSettings `json:"couponSettings,omitempty"` + ReferralSettings *CodeGeneratorSettings `json:"referralSettings,omitempty"` + // The set of limits that will operate for this campaign version. + Limits *[]LimitConfig `json:"limits,omitempty"` + // A list of features for the campaign template. + Features *[]string `json:"features,omitempty"` +} + +// GetId returns the Id field value +func (o *RevisionVersion) GetId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *RevisionVersion) SetId(v int32) { + o.Id = v +} + +// GetAccountId returns the AccountId field value +func (o *RevisionVersion) GetAccountId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AccountId +} + +// SetAccountId sets field value +func (o *RevisionVersion) SetAccountId(v int32) { + o.AccountId = v +} + +// GetApplicationId returns the ApplicationId field value +func (o *RevisionVersion) GetApplicationId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ApplicationId +} + +// SetApplicationId sets field value +func (o *RevisionVersion) SetApplicationId(v int32) { + o.ApplicationId = v +} + +// GetCampaignId returns the CampaignId field value +func (o *RevisionVersion) GetCampaignId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CampaignId +} + +// SetCampaignId sets field value +func (o *RevisionVersion) SetCampaignId(v int32) { + o.CampaignId = v +} + +// GetCreated returns the Created field value +func (o *RevisionVersion) GetCreated() time.Time { + if o == nil { + var ret time.Time + return ret + } + + return o.Created +} + +// SetCreated sets field value +func (o *RevisionVersion) SetCreated(v time.Time) { + o.Created = v +} + +// GetCreatedBy returns the CreatedBy field value +func (o *RevisionVersion) GetCreatedBy() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.CreatedBy +} + +// SetCreatedBy sets field value +func (o *RevisionVersion) SetCreatedBy(v int32) { + o.CreatedBy = v +} + +// GetRevisionId returns the RevisionId field value +func (o *RevisionVersion) GetRevisionId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.RevisionId +} + +// SetRevisionId sets field value +func (o *RevisionVersion) SetRevisionId(v int32) { + o.RevisionId = v +} + +// GetVersion returns the Version field value +func (o *RevisionVersion) GetVersion() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.Version +} + +// SetVersion sets field value +func (o *RevisionVersion) SetVersion(v int32) { + o.Version = v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *RevisionVersion) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetNameOk() (string, bool) { + if o == nil || o.Name == nil { + var ret string + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *RevisionVersion) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *RevisionVersion) SetName(v string) { + o.Name = &v +} + +// GetStartTime returns the StartTime field value if set, zero value otherwise. +func (o *RevisionVersion) GetStartTime() NullableTime { + if o == nil || o.StartTime == nil { + var ret NullableTime + return ret + } + return *o.StartTime +} + +// GetStartTimeOk returns a tuple with the StartTime field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetStartTimeOk() (NullableTime, bool) { + if o == nil || o.StartTime == nil { + var ret NullableTime + return ret, false + } + return *o.StartTime, true +} + +// HasStartTime returns a boolean if a field has been set. +func (o *RevisionVersion) HasStartTime() bool { + if o != nil && o.StartTime != nil { + return true + } + + return false +} + +// SetStartTime gets a reference to the given NullableTime and assigns it to the StartTime field. +func (o *RevisionVersion) SetStartTime(v NullableTime) { + o.StartTime = &v +} + +// GetEndTime returns the EndTime field value if set, zero value otherwise. +func (o *RevisionVersion) GetEndTime() NullableTime { + if o == nil || o.EndTime == nil { + var ret NullableTime + return ret + } + return *o.EndTime +} + +// GetEndTimeOk returns a tuple with the EndTime field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetEndTimeOk() (NullableTime, bool) { + if o == nil || o.EndTime == nil { + var ret NullableTime + return ret, false + } + return *o.EndTime, true +} + +// HasEndTime returns a boolean if a field has been set. +func (o *RevisionVersion) HasEndTime() bool { + if o != nil && o.EndTime != nil { + return true + } + + return false +} + +// SetEndTime gets a reference to the given NullableTime and assigns it to the EndTime field. +func (o *RevisionVersion) SetEndTime(v NullableTime) { + o.EndTime = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *RevisionVersion) GetAttributes() map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *RevisionVersion) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field. +func (o *RevisionVersion) SetAttributes(v map[string]interface{}) { + o.Attributes = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *RevisionVersion) GetDescription() NullableString { + if o == nil || o.Description == nil { + var ret NullableString + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetDescriptionOk() (NullableString, bool) { + if o == nil || o.Description == nil { + var ret NullableString + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *RevisionVersion) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given NullableString and assigns it to the Description field. +func (o *RevisionVersion) SetDescription(v NullableString) { + o.Description = &v +} + +// GetActiveRulesetId returns the ActiveRulesetId field value if set, zero value otherwise. +func (o *RevisionVersion) GetActiveRulesetId() NullableInt32 { + if o == nil || o.ActiveRulesetId == nil { + var ret NullableInt32 + return ret + } + return *o.ActiveRulesetId +} + +// GetActiveRulesetIdOk returns a tuple with the ActiveRulesetId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetActiveRulesetIdOk() (NullableInt32, bool) { + if o == nil || o.ActiveRulesetId == nil { + var ret NullableInt32 + return ret, false + } + return *o.ActiveRulesetId, true +} + +// HasActiveRulesetId returns a boolean if a field has been set. +func (o *RevisionVersion) HasActiveRulesetId() bool { + if o != nil && o.ActiveRulesetId != nil { + return true + } + + return false +} + +// SetActiveRulesetId gets a reference to the given NullableInt32 and assigns it to the ActiveRulesetId field. +func (o *RevisionVersion) SetActiveRulesetId(v NullableInt32) { + o.ActiveRulesetId = &v +} + +// GetTags returns the Tags field value if set, zero value otherwise. +func (o *RevisionVersion) GetTags() []string { + if o == nil || o.Tags == nil { + var ret []string + return ret + } + return *o.Tags +} + +// GetTagsOk returns a tuple with the Tags field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetTagsOk() ([]string, bool) { + if o == nil || o.Tags == nil { + var ret []string + return ret, false + } + return *o.Tags, true +} + +// HasTags returns a boolean if a field has been set. +func (o *RevisionVersion) HasTags() bool { + if o != nil && o.Tags != nil { + return true + } + + return false +} + +// SetTags gets a reference to the given []string and assigns it to the Tags field. +func (o *RevisionVersion) SetTags(v []string) { + o.Tags = &v +} + +// GetCouponSettings returns the CouponSettings field value if set, zero value otherwise. +func (o *RevisionVersion) GetCouponSettings() CodeGeneratorSettings { + if o == nil || o.CouponSettings == nil { + var ret CodeGeneratorSettings + return ret + } + return *o.CouponSettings +} + +// GetCouponSettingsOk returns a tuple with the CouponSettings field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetCouponSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CouponSettings == nil { + var ret CodeGeneratorSettings + return ret, false + } + return *o.CouponSettings, true +} + +// HasCouponSettings returns a boolean if a field has been set. +func (o *RevisionVersion) HasCouponSettings() bool { + if o != nil && o.CouponSettings != nil { + return true + } + + return false +} + +// SetCouponSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CouponSettings field. +func (o *RevisionVersion) SetCouponSettings(v CodeGeneratorSettings) { + o.CouponSettings = &v +} + +// GetReferralSettings returns the ReferralSettings field value if set, zero value otherwise. +func (o *RevisionVersion) GetReferralSettings() CodeGeneratorSettings { + if o == nil || o.ReferralSettings == nil { + var ret CodeGeneratorSettings + return ret + } + return *o.ReferralSettings +} + +// GetReferralSettingsOk returns a tuple with the ReferralSettings field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetReferralSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.ReferralSettings == nil { + var ret CodeGeneratorSettings + return ret, false + } + return *o.ReferralSettings, true +} + +// HasReferralSettings returns a boolean if a field has been set. +func (o *RevisionVersion) HasReferralSettings() bool { + if o != nil && o.ReferralSettings != nil { + return true + } + + return false +} + +// SetReferralSettings gets a reference to the given CodeGeneratorSettings and assigns it to the ReferralSettings field. +func (o *RevisionVersion) SetReferralSettings(v CodeGeneratorSettings) { + o.ReferralSettings = &v +} + +// GetLimits returns the Limits field value if set, zero value otherwise. +func (o *RevisionVersion) GetLimits() []LimitConfig { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret + } + return *o.Limits +} + +// GetLimitsOk returns a tuple with the Limits field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetLimitsOk() ([]LimitConfig, bool) { + if o == nil || o.Limits == nil { + var ret []LimitConfig + return ret, false + } + return *o.Limits, true +} + +// HasLimits returns a boolean if a field has been set. +func (o *RevisionVersion) HasLimits() bool { + if o != nil && o.Limits != nil { + return true + } + + return false +} + +// SetLimits gets a reference to the given []LimitConfig and assigns it to the Limits field. +func (o *RevisionVersion) SetLimits(v []LimitConfig) { + o.Limits = &v +} + +// GetFeatures returns the Features field value if set, zero value otherwise. +func (o *RevisionVersion) GetFeatures() []string { + if o == nil || o.Features == nil { + var ret []string + return ret + } + return *o.Features +} + +// GetFeaturesOk returns a tuple with the Features field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RevisionVersion) GetFeaturesOk() ([]string, bool) { + if o == nil || o.Features == nil { + var ret []string + return ret, false + } + return *o.Features, true +} + +// HasFeatures returns a boolean if a field has been set. +func (o *RevisionVersion) HasFeatures() bool { + if o != nil && o.Features != nil { + return true + } + + return false +} + +// SetFeatures gets a reference to the given []string and assigns it to the Features field. +func (o *RevisionVersion) SetFeatures(v []string) { + o.Features = &v +} + +type NullableRevisionVersion struct { + Value RevisionVersion + ExplicitNull bool +} + +func (v NullableRevisionVersion) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRevisionVersion) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_role_v2_permissions_roles.go b/model_role_v2_permissions_roles.go deleted file mode 100644 index b293b477..00000000 --- a/model_role_v2_permissions_roles.go +++ /dev/null @@ -1,144 +0,0 @@ -/* - * Talon.One API - * - * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` - * - * API version: - * Generated by: OpenAPI Generator (https://openapi-generator.tech) - */ - -package talon - -import ( - "bytes" - "encoding/json" -) - -// RoleV2PermissionsRoles struct for RoleV2PermissionsRoles -type RoleV2PermissionsRoles struct { - Applications *map[string]RoleV2ApplicationDetails `json:"applications,omitempty"` - LoyaltyPrograms *map[string]string `json:"loyaltyPrograms,omitempty"` - CampaignAccessGroups *map[string]string `json:"campaignAccessGroups,omitempty"` -} - -// GetApplications returns the Applications field value if set, zero value otherwise. -func (o *RoleV2PermissionsRoles) GetApplications() map[string]RoleV2ApplicationDetails { - if o == nil || o.Applications == nil { - var ret map[string]RoleV2ApplicationDetails - return ret - } - return *o.Applications -} - -// GetApplicationsOk returns a tuple with the Applications field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *RoleV2PermissionsRoles) GetApplicationsOk() (map[string]RoleV2ApplicationDetails, bool) { - if o == nil || o.Applications == nil { - var ret map[string]RoleV2ApplicationDetails - return ret, false - } - return *o.Applications, true -} - -// HasApplications returns a boolean if a field has been set. -func (o *RoleV2PermissionsRoles) HasApplications() bool { - if o != nil && o.Applications != nil { - return true - } - - return false -} - -// SetApplications gets a reference to the given map[string]RoleV2ApplicationDetails and assigns it to the Applications field. -func (o *RoleV2PermissionsRoles) SetApplications(v map[string]RoleV2ApplicationDetails) { - o.Applications = &v -} - -// GetLoyaltyPrograms returns the LoyaltyPrograms field value if set, zero value otherwise. -func (o *RoleV2PermissionsRoles) GetLoyaltyPrograms() map[string]string { - if o == nil || o.LoyaltyPrograms == nil { - var ret map[string]string - return ret - } - return *o.LoyaltyPrograms -} - -// GetLoyaltyProgramsOk returns a tuple with the LoyaltyPrograms field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *RoleV2PermissionsRoles) GetLoyaltyProgramsOk() (map[string]string, bool) { - if o == nil || o.LoyaltyPrograms == nil { - var ret map[string]string - return ret, false - } - return *o.LoyaltyPrograms, true -} - -// HasLoyaltyPrograms returns a boolean if a field has been set. -func (o *RoleV2PermissionsRoles) HasLoyaltyPrograms() bool { - if o != nil && o.LoyaltyPrograms != nil { - return true - } - - return false -} - -// SetLoyaltyPrograms gets a reference to the given map[string]string and assigns it to the LoyaltyPrograms field. -func (o *RoleV2PermissionsRoles) SetLoyaltyPrograms(v map[string]string) { - o.LoyaltyPrograms = &v -} - -// GetCampaignAccessGroups returns the CampaignAccessGroups field value if set, zero value otherwise. -func (o *RoleV2PermissionsRoles) GetCampaignAccessGroups() map[string]string { - if o == nil || o.CampaignAccessGroups == nil { - var ret map[string]string - return ret - } - return *o.CampaignAccessGroups -} - -// GetCampaignAccessGroupsOk returns a tuple with the CampaignAccessGroups field value if set, zero value otherwise -// and a boolean to check if the value has been set. -func (o *RoleV2PermissionsRoles) GetCampaignAccessGroupsOk() (map[string]string, bool) { - if o == nil || o.CampaignAccessGroups == nil { - var ret map[string]string - return ret, false - } - return *o.CampaignAccessGroups, true -} - -// HasCampaignAccessGroups returns a boolean if a field has been set. -func (o *RoleV2PermissionsRoles) HasCampaignAccessGroups() bool { - if o != nil && o.CampaignAccessGroups != nil { - return true - } - - return false -} - -// SetCampaignAccessGroups gets a reference to the given map[string]string and assigns it to the CampaignAccessGroups field. -func (o *RoleV2PermissionsRoles) SetCampaignAccessGroups(v map[string]string) { - o.CampaignAccessGroups = &v -} - -type NullableRoleV2PermissionsRoles struct { - Value RoleV2PermissionsRoles - ExplicitNull bool -} - -func (v NullableRoleV2PermissionsRoles) MarshalJSON() ([]byte, error) { - switch { - case v.ExplicitNull: - return []byte("null"), nil - default: - return json.Marshal(v.Value) - } -} - -func (v *NullableRoleV2PermissionsRoles) UnmarshalJSON(src []byte) error { - if bytes.Equal(src, []byte("null")) { - v.ExplicitNull = true - return nil - } - - return json.Unmarshal(src, &v.Value) -} diff --git a/model_rollback_increased_achievement_progress_effect_props.go b/model_rollback_increased_achievement_progress_effect_props.go new file mode 100644 index 00000000..f8408e4b --- /dev/null +++ b/model_rollback_increased_achievement_progress_effect_props.go @@ -0,0 +1,144 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// RollbackIncreasedAchievementProgressEffectProps The properties specific to the \"rollbackIncreasedAchievementProgress\" effect. This gets triggered whenever a closed session where the `increaseAchievementProgress` effect was triggered is cancelled. This is applicable only when the customer has not completed the achievement. +type RollbackIncreasedAchievementProgressEffectProps struct { + // The internal ID of the achievement. + AchievementId int32 `json:"achievementId"` + // The name of the achievement. + AchievementName string `json:"achievementName"` + // The internal ID of the achievement progress tracker. + ProgressTrackerId int32 `json:"progressTrackerId"` + // The value by which the customer's current progress in the achievement is decreased. + DecreaseProgressBy float32 `json:"decreaseProgressBy"` + // The current progress of the customer in the achievement. + CurrentProgress float32 `json:"currentProgress"` + // The target value to complete the achievement. + Target float32 `json:"target"` +} + +// GetAchievementId returns the AchievementId field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.AchievementId +} + +// SetAchievementId sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetAchievementId(v int32) { + o.AchievementId = v +} + +// GetAchievementName returns the AchievementName field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetAchievementName() string { + if o == nil { + var ret string + return ret + } + + return o.AchievementName +} + +// SetAchievementName sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetAchievementName(v string) { + o.AchievementName = v +} + +// GetProgressTrackerId returns the ProgressTrackerId field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetProgressTrackerId() int32 { + if o == nil { + var ret int32 + return ret + } + + return o.ProgressTrackerId +} + +// SetProgressTrackerId sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetProgressTrackerId(v int32) { + o.ProgressTrackerId = v +} + +// GetDecreaseProgressBy returns the DecreaseProgressBy field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetDecreaseProgressBy() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.DecreaseProgressBy +} + +// SetDecreaseProgressBy sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetDecreaseProgressBy(v float32) { + o.DecreaseProgressBy = v +} + +// GetCurrentProgress returns the CurrentProgress field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetCurrentProgress() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.CurrentProgress +} + +// SetCurrentProgress sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetCurrentProgress(v float32) { + o.CurrentProgress = v +} + +// GetTarget returns the Target field value +func (o *RollbackIncreasedAchievementProgressEffectProps) GetTarget() float32 { + if o == nil { + var ret float32 + return ret + } + + return o.Target +} + +// SetTarget sets field value +func (o *RollbackIncreasedAchievementProgressEffectProps) SetTarget(v float32) { + o.Target = v +} + +type NullableRollbackIncreasedAchievementProgressEffectProps struct { + Value RollbackIncreasedAchievementProgressEffectProps + ExplicitNull bool +} + +func (v NullableRollbackIncreasedAchievementProgressEffectProps) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableRollbackIncreasedAchievementProgressEffectProps) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_rule.go b/model_rule.go index e2401b6f..acc8a36d 100644 --- a/model_rule.go +++ b/model_rule.go @@ -27,9 +27,9 @@ type Rule struct { // An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. Bindings *[]Binding `json:"bindings,omitempty"` // A Talang expression that will be evaluated in the context of the given event. - Condition []interface{} `json:"condition"` + Condition []map[string]interface{} `json:"condition"` // An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. - Effects [][]interface{} `json:"effects"` + Effects []map[string]interface{} `json:"effects"` } // GetId returns the Id field value if set, zero value otherwise. @@ -180,9 +180,9 @@ func (o *Rule) SetBindings(v []Binding) { } // GetCondition returns the Condition field value -func (o *Rule) GetCondition() []interface{} { +func (o *Rule) GetCondition() []map[string]interface{} { if o == nil { - var ret []interface{} + var ret []map[string]interface{} return ret } @@ -190,14 +190,14 @@ func (o *Rule) GetCondition() []interface{} { } // SetCondition sets field value -func (o *Rule) SetCondition(v []interface{}) { +func (o *Rule) SetCondition(v []map[string]interface{}) { o.Condition = v } // GetEffects returns the Effects field value -func (o *Rule) GetEffects() [][]interface{} { +func (o *Rule) GetEffects() []map[string]interface{} { if o == nil { - var ret [][]interface{} + var ret []map[string]interface{} return ret } @@ -205,7 +205,7 @@ func (o *Rule) GetEffects() [][]interface{} { } // SetEffects sets field value -func (o *Rule) SetEffects(v [][]interface{}) { +func (o *Rule) SetEffects(v []map[string]interface{}) { o.Effects = v } diff --git a/model_rule_failure_reason.go b/model_rule_failure_reason.go index 6a91b9f2..f5ae0926 100644 --- a/model_rule_failure_reason.go +++ b/model_rule_failure_reason.go @@ -40,6 +40,10 @@ type RuleFailureReason struct { EffectIndex *int32 `json:"effectIndex,omitempty"` // More details about the failure. Details *string `json:"details,omitempty"` + // The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). + EvaluationGroupID *int32 `json:"evaluationGroupID,omitempty"` + // The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign- + EvaluationGroupMode *string `json:"evaluationGroupMode,omitempty"` } // GetCampaignID returns the CampaignID field value @@ -348,6 +352,72 @@ func (o *RuleFailureReason) SetDetails(v string) { o.Details = &v } +// GetEvaluationGroupID returns the EvaluationGroupID field value if set, zero value otherwise. +func (o *RuleFailureReason) GetEvaluationGroupID() int32 { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret + } + return *o.EvaluationGroupID +} + +// GetEvaluationGroupIDOk returns a tuple with the EvaluationGroupID field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RuleFailureReason) GetEvaluationGroupIDOk() (int32, bool) { + if o == nil || o.EvaluationGroupID == nil { + var ret int32 + return ret, false + } + return *o.EvaluationGroupID, true +} + +// HasEvaluationGroupID returns a boolean if a field has been set. +func (o *RuleFailureReason) HasEvaluationGroupID() bool { + if o != nil && o.EvaluationGroupID != nil { + return true + } + + return false +} + +// SetEvaluationGroupID gets a reference to the given int32 and assigns it to the EvaluationGroupID field. +func (o *RuleFailureReason) SetEvaluationGroupID(v int32) { + o.EvaluationGroupID = &v +} + +// GetEvaluationGroupMode returns the EvaluationGroupMode field value if set, zero value otherwise. +func (o *RuleFailureReason) GetEvaluationGroupMode() string { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret + } + return *o.EvaluationGroupMode +} + +// GetEvaluationGroupModeOk returns a tuple with the EvaluationGroupMode field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *RuleFailureReason) GetEvaluationGroupModeOk() (string, bool) { + if o == nil || o.EvaluationGroupMode == nil { + var ret string + return ret, false + } + return *o.EvaluationGroupMode, true +} + +// HasEvaluationGroupMode returns a boolean if a field has been set. +func (o *RuleFailureReason) HasEvaluationGroupMode() bool { + if o != nil && o.EvaluationGroupMode != nil { + return true + } + + return false +} + +// SetEvaluationGroupMode gets a reference to the given string and assigns it to the EvaluationGroupMode field. +func (o *RuleFailureReason) SetEvaluationGroupMode(v string) { + o.EvaluationGroupMode = &v +} + type NullableRuleFailureReason struct { Value RuleFailureReason ExplicitNull bool diff --git a/model_scim_base_user.go b/model_scim_base_user.go new file mode 100644 index 00000000..96e3cdbb --- /dev/null +++ b/model_scim_base_user.go @@ -0,0 +1,181 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimBaseUser Schema definition for base user fields, provisioned using the SCIM protocol and used by Talon.One. +type ScimBaseUser struct { + // Status of the user. + Active *bool `json:"active,omitempty"` + // Display name of the user. + DisplayName *string `json:"displayName,omitempty"` + // Unique identifier of the user. This is usually an email address. + UserName *string `json:"userName,omitempty"` + Name *ScimBaseUserName `json:"name,omitempty"` +} + +// GetActive returns the Active field value if set, zero value otherwise. +func (o *ScimBaseUser) GetActive() bool { + if o == nil || o.Active == nil { + var ret bool + return ret + } + return *o.Active +} + +// GetActiveOk returns a tuple with the Active field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimBaseUser) GetActiveOk() (bool, bool) { + if o == nil || o.Active == nil { + var ret bool + return ret, false + } + return *o.Active, true +} + +// HasActive returns a boolean if a field has been set. +func (o *ScimBaseUser) HasActive() bool { + if o != nil && o.Active != nil { + return true + } + + return false +} + +// SetActive gets a reference to the given bool and assigns it to the Active field. +func (o *ScimBaseUser) SetActive(v bool) { + o.Active = &v +} + +// GetDisplayName returns the DisplayName field value if set, zero value otherwise. +func (o *ScimBaseUser) GetDisplayName() string { + if o == nil || o.DisplayName == nil { + var ret string + return ret + } + return *o.DisplayName +} + +// GetDisplayNameOk returns a tuple with the DisplayName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimBaseUser) GetDisplayNameOk() (string, bool) { + if o == nil || o.DisplayName == nil { + var ret string + return ret, false + } + return *o.DisplayName, true +} + +// HasDisplayName returns a boolean if a field has been set. +func (o *ScimBaseUser) HasDisplayName() bool { + if o != nil && o.DisplayName != nil { + return true + } + + return false +} + +// SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. +func (o *ScimBaseUser) SetDisplayName(v string) { + o.DisplayName = &v +} + +// GetUserName returns the UserName field value if set, zero value otherwise. +func (o *ScimBaseUser) GetUserName() string { + if o == nil || o.UserName == nil { + var ret string + return ret + } + return *o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimBaseUser) GetUserNameOk() (string, bool) { + if o == nil || o.UserName == nil { + var ret string + return ret, false + } + return *o.UserName, true +} + +// HasUserName returns a boolean if a field has been set. +func (o *ScimBaseUser) HasUserName() bool { + if o != nil && o.UserName != nil { + return true + } + + return false +} + +// SetUserName gets a reference to the given string and assigns it to the UserName field. +func (o *ScimBaseUser) SetUserName(v string) { + o.UserName = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ScimBaseUser) GetName() ScimBaseUserName { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimBaseUser) GetNameOk() (ScimBaseUserName, bool) { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ScimBaseUser) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. +func (o *ScimBaseUser) SetName(v ScimBaseUserName) { + o.Name = &v +} + +type NullableScimBaseUser struct { + Value ScimBaseUser + ExplicitNull bool +} + +func (v NullableScimBaseUser) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimBaseUser) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_base_user_name.go b/model_scim_base_user_name.go new file mode 100644 index 00000000..2424a2f4 --- /dev/null +++ b/model_scim_base_user_name.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimBaseUserName The components of the user’s real name. +type ScimBaseUserName struct { + // The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. + Formatted *string `json:"formatted,omitempty"` +} + +// GetFormatted returns the Formatted field value if set, zero value otherwise. +func (o *ScimBaseUserName) GetFormatted() string { + if o == nil || o.Formatted == nil { + var ret string + return ret + } + return *o.Formatted +} + +// GetFormattedOk returns a tuple with the Formatted field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimBaseUserName) GetFormattedOk() (string, bool) { + if o == nil || o.Formatted == nil { + var ret string + return ret, false + } + return *o.Formatted, true +} + +// HasFormatted returns a boolean if a field has been set. +func (o *ScimBaseUserName) HasFormatted() bool { + if o != nil && o.Formatted != nil { + return true + } + + return false +} + +// SetFormatted gets a reference to the given string and assigns it to the Formatted field. +func (o *ScimBaseUserName) SetFormatted(v string) { + o.Formatted = &v +} + +type NullableScimBaseUserName struct { + Value ScimBaseUserName + ExplicitNull bool +} + +func (v NullableScimBaseUserName) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimBaseUserName) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_new_user.go b/model_scim_new_user.go new file mode 100644 index 00000000..fd654366 --- /dev/null +++ b/model_scim_new_user.go @@ -0,0 +1,181 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimNewUser Payload for users that are created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. +type ScimNewUser struct { + // Status of the user. + Active *bool `json:"active,omitempty"` + // Display name of the user. + DisplayName *string `json:"displayName,omitempty"` + // Unique identifier of the user. This is usually an email address. + UserName *string `json:"userName,omitempty"` + Name *ScimBaseUserName `json:"name,omitempty"` +} + +// GetActive returns the Active field value if set, zero value otherwise. +func (o *ScimNewUser) GetActive() bool { + if o == nil || o.Active == nil { + var ret bool + return ret + } + return *o.Active +} + +// GetActiveOk returns a tuple with the Active field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimNewUser) GetActiveOk() (bool, bool) { + if o == nil || o.Active == nil { + var ret bool + return ret, false + } + return *o.Active, true +} + +// HasActive returns a boolean if a field has been set. +func (o *ScimNewUser) HasActive() bool { + if o != nil && o.Active != nil { + return true + } + + return false +} + +// SetActive gets a reference to the given bool and assigns it to the Active field. +func (o *ScimNewUser) SetActive(v bool) { + o.Active = &v +} + +// GetDisplayName returns the DisplayName field value if set, zero value otherwise. +func (o *ScimNewUser) GetDisplayName() string { + if o == nil || o.DisplayName == nil { + var ret string + return ret + } + return *o.DisplayName +} + +// GetDisplayNameOk returns a tuple with the DisplayName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimNewUser) GetDisplayNameOk() (string, bool) { + if o == nil || o.DisplayName == nil { + var ret string + return ret, false + } + return *o.DisplayName, true +} + +// HasDisplayName returns a boolean if a field has been set. +func (o *ScimNewUser) HasDisplayName() bool { + if o != nil && o.DisplayName != nil { + return true + } + + return false +} + +// SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. +func (o *ScimNewUser) SetDisplayName(v string) { + o.DisplayName = &v +} + +// GetUserName returns the UserName field value if set, zero value otherwise. +func (o *ScimNewUser) GetUserName() string { + if o == nil || o.UserName == nil { + var ret string + return ret + } + return *o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimNewUser) GetUserNameOk() (string, bool) { + if o == nil || o.UserName == nil { + var ret string + return ret, false + } + return *o.UserName, true +} + +// HasUserName returns a boolean if a field has been set. +func (o *ScimNewUser) HasUserName() bool { + if o != nil && o.UserName != nil { + return true + } + + return false +} + +// SetUserName gets a reference to the given string and assigns it to the UserName field. +func (o *ScimNewUser) SetUserName(v string) { + o.UserName = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ScimNewUser) GetName() ScimBaseUserName { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimNewUser) GetNameOk() (ScimBaseUserName, bool) { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ScimNewUser) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. +func (o *ScimNewUser) SetName(v ScimBaseUserName) { + o.Name = &v +} + +type NullableScimNewUser struct { + Value ScimNewUser + ExplicitNull bool +} + +func (v NullableScimNewUser) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimNewUser) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_patch_operation.go b/model_scim_patch_operation.go new file mode 100644 index 00000000..26f52b51 --- /dev/null +++ b/model_scim_patch_operation.go @@ -0,0 +1,129 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimPatchOperation Patch operation that is used to update the information. +type ScimPatchOperation struct { + // The method that should be used in the operation. + Op string `json:"op"` + // The path specifying the attribute that should be updated. + Path *string `json:"path,omitempty"` + // The value that should be updated. Required if `op` is `add` or `replace`. + Value *string `json:"value,omitempty"` +} + +// GetOp returns the Op field value +func (o *ScimPatchOperation) GetOp() string { + if o == nil { + var ret string + return ret + } + + return o.Op +} + +// SetOp sets field value +func (o *ScimPatchOperation) SetOp(v string) { + o.Op = v +} + +// GetPath returns the Path field value if set, zero value otherwise. +func (o *ScimPatchOperation) GetPath() string { + if o == nil || o.Path == nil { + var ret string + return ret + } + return *o.Path +} + +// GetPathOk returns a tuple with the Path field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimPatchOperation) GetPathOk() (string, bool) { + if o == nil || o.Path == nil { + var ret string + return ret, false + } + return *o.Path, true +} + +// HasPath returns a boolean if a field has been set. +func (o *ScimPatchOperation) HasPath() bool { + if o != nil && o.Path != nil { + return true + } + + return false +} + +// SetPath gets a reference to the given string and assigns it to the Path field. +func (o *ScimPatchOperation) SetPath(v string) { + o.Path = &v +} + +// GetValue returns the Value field value if set, zero value otherwise. +func (o *ScimPatchOperation) GetValue() string { + if o == nil || o.Value == nil { + var ret string + return ret + } + return *o.Value +} + +// GetValueOk returns a tuple with the Value field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimPatchOperation) GetValueOk() (string, bool) { + if o == nil || o.Value == nil { + var ret string + return ret, false + } + return *o.Value, true +} + +// HasValue returns a boolean if a field has been set. +func (o *ScimPatchOperation) HasValue() bool { + if o != nil && o.Value != nil { + return true + } + + return false +} + +// SetValue gets a reference to the given string and assigns it to the Value field. +func (o *ScimPatchOperation) SetValue(v string) { + o.Value = &v +} + +type NullableScimPatchOperation struct { + Value ScimPatchOperation + ExplicitNull bool +} + +func (v NullableScimPatchOperation) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimPatchOperation) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_patch_request.go b/model_scim_patch_request.go new file mode 100644 index 00000000..b558d7a8 --- /dev/null +++ b/model_scim_patch_request.go @@ -0,0 +1,93 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimPatchRequest SCIM Patch request +type ScimPatchRequest struct { + // SCIM schema for the given resource. + Schemas *[]string `json:"schemas,omitempty"` + Operations []ScimPatchOperation `json:"Operations"` +} + +// GetSchemas returns the Schemas field value if set, zero value otherwise. +func (o *ScimPatchRequest) GetSchemas() []string { + if o == nil || o.Schemas == nil { + var ret []string + return ret + } + return *o.Schemas +} + +// GetSchemasOk returns a tuple with the Schemas field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimPatchRequest) GetSchemasOk() ([]string, bool) { + if o == nil || o.Schemas == nil { + var ret []string + return ret, false + } + return *o.Schemas, true +} + +// HasSchemas returns a boolean if a field has been set. +func (o *ScimPatchRequest) HasSchemas() bool { + if o != nil && o.Schemas != nil { + return true + } + + return false +} + +// SetSchemas gets a reference to the given []string and assigns it to the Schemas field. +func (o *ScimPatchRequest) SetSchemas(v []string) { + o.Schemas = &v +} + +// GetOperations returns the Operations field value +func (o *ScimPatchRequest) GetOperations() []ScimPatchOperation { + if o == nil { + var ret []ScimPatchOperation + return ret + } + + return o.Operations +} + +// SetOperations sets field value +func (o *ScimPatchRequest) SetOperations(v []ScimPatchOperation) { + o.Operations = v +} + +type NullableScimPatchRequest struct { + Value ScimPatchRequest + ExplicitNull bool +} + +func (v NullableScimPatchRequest) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimPatchRequest) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_resource.go b/model_scim_resource.go new file mode 100644 index 00000000..9b2e123e --- /dev/null +++ b/model_scim_resource.go @@ -0,0 +1,147 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimResource Resource definition for the SCIM provisioning protocol. +type ScimResource struct { + // ID of the resource. + Id *string `json:"id,omitempty"` + // Name of the resource. + Name *string `json:"name,omitempty"` + // Human-readable description of the resource. + Description *string `json:"description,omitempty"` +} + +// GetId returns the Id field value if set, zero value otherwise. +func (o *ScimResource) GetId() string { + if o == nil || o.Id == nil { + var ret string + return ret + } + return *o.Id +} + +// GetIdOk returns a tuple with the Id field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimResource) GetIdOk() (string, bool) { + if o == nil || o.Id == nil { + var ret string + return ret, false + } + return *o.Id, true +} + +// HasId returns a boolean if a field has been set. +func (o *ScimResource) HasId() bool { + if o != nil && o.Id != nil { + return true + } + + return false +} + +// SetId gets a reference to the given string and assigns it to the Id field. +func (o *ScimResource) SetId(v string) { + o.Id = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ScimResource) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimResource) GetNameOk() (string, bool) { + if o == nil || o.Name == nil { + var ret string + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ScimResource) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *ScimResource) SetName(v string) { + o.Name = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ScimResource) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimResource) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ScimResource) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ScimResource) SetDescription(v string) { + o.Description = &v +} + +type NullableScimResource struct { + Value ScimResource + ExplicitNull bool +} + +func (v NullableScimResource) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimResource) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_resource_types_list_response.go b/model_scim_resource_types_list_response.go new file mode 100644 index 00000000..2f44b6ac --- /dev/null +++ b/model_scim_resource_types_list_response.go @@ -0,0 +1,58 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimResourceTypesListResponse List of resource types supported by the SCIM provisioning protocol. +type ScimResourceTypesListResponse struct { + Resources []ScimResource `json:"Resources"` +} + +// GetResources returns the Resources field value +func (o *ScimResourceTypesListResponse) GetResources() []ScimResource { + if o == nil { + var ret []ScimResource + return ret + } + + return o.Resources +} + +// SetResources sets field value +func (o *ScimResourceTypesListResponse) SetResources(v []ScimResource) { + o.Resources = v +} + +type NullableScimResourceTypesListResponse struct { + Value ScimResourceTypesListResponse + ExplicitNull bool +} + +func (v NullableScimResourceTypesListResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimResourceTypesListResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_schema_resource.go b/model_scim_schema_resource.go new file mode 100644 index 00000000..a1b1aefc --- /dev/null +++ b/model_scim_schema_resource.go @@ -0,0 +1,181 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimSchemaResource Resource schema definition for the SCIM provisioning protocol. +type ScimSchemaResource struct { + // ID of the resource. + Id *string `json:"id,omitempty"` + // Name of the resource. + Name *string `json:"name,omitempty"` + // Human-readable description of the schema resource. + Description *string `json:"description,omitempty"` + Attributes *[]map[string]interface{} `json:"attributes,omitempty"` +} + +// GetId returns the Id field value if set, zero value otherwise. +func (o *ScimSchemaResource) GetId() string { + if o == nil || o.Id == nil { + var ret string + return ret + } + return *o.Id +} + +// GetIdOk returns a tuple with the Id field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemaResource) GetIdOk() (string, bool) { + if o == nil || o.Id == nil { + var ret string + return ret, false + } + return *o.Id, true +} + +// HasId returns a boolean if a field has been set. +func (o *ScimSchemaResource) HasId() bool { + if o != nil && o.Id != nil { + return true + } + + return false +} + +// SetId gets a reference to the given string and assigns it to the Id field. +func (o *ScimSchemaResource) SetId(v string) { + o.Id = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ScimSchemaResource) GetName() string { + if o == nil || o.Name == nil { + var ret string + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemaResource) GetNameOk() (string, bool) { + if o == nil || o.Name == nil { + var ret string + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ScimSchemaResource) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given string and assigns it to the Name field. +func (o *ScimSchemaResource) SetName(v string) { + o.Name = &v +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *ScimSchemaResource) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemaResource) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *ScimSchemaResource) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *ScimSchemaResource) SetDescription(v string) { + o.Description = &v +} + +// GetAttributes returns the Attributes field value if set, zero value otherwise. +func (o *ScimSchemaResource) GetAttributes() []map[string]interface{} { + if o == nil || o.Attributes == nil { + var ret []map[string]interface{} + return ret + } + return *o.Attributes +} + +// GetAttributesOk returns a tuple with the Attributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemaResource) GetAttributesOk() ([]map[string]interface{}, bool) { + if o == nil || o.Attributes == nil { + var ret []map[string]interface{} + return ret, false + } + return *o.Attributes, true +} + +// HasAttributes returns a boolean if a field has been set. +func (o *ScimSchemaResource) HasAttributes() bool { + if o != nil && o.Attributes != nil { + return true + } + + return false +} + +// SetAttributes gets a reference to the given []map[string]interface{} and assigns it to the Attributes field. +func (o *ScimSchemaResource) SetAttributes(v []map[string]interface{}) { + o.Attributes = &v +} + +type NullableScimSchemaResource struct { + Value ScimSchemaResource + ExplicitNull bool +} + +func (v NullableScimSchemaResource) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimSchemaResource) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_schemas_list_response.go b/model_scim_schemas_list_response.go new file mode 100644 index 00000000..aa480358 --- /dev/null +++ b/model_scim_schemas_list_response.go @@ -0,0 +1,128 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimSchemasListResponse List of resource schemas supported by the SCIM provisioning protocol. +type ScimSchemasListResponse struct { + Resources []ScimSchemaResource `json:"Resources"` + // SCIM schema for the given resource. + Schemas *[]string `json:"schemas,omitempty"` + // Number of total results in the response. + TotalResults *int32 `json:"totalResults,omitempty"` +} + +// GetResources returns the Resources field value +func (o *ScimSchemasListResponse) GetResources() []ScimSchemaResource { + if o == nil { + var ret []ScimSchemaResource + return ret + } + + return o.Resources +} + +// SetResources sets field value +func (o *ScimSchemasListResponse) SetResources(v []ScimSchemaResource) { + o.Resources = v +} + +// GetSchemas returns the Schemas field value if set, zero value otherwise. +func (o *ScimSchemasListResponse) GetSchemas() []string { + if o == nil || o.Schemas == nil { + var ret []string + return ret + } + return *o.Schemas +} + +// GetSchemasOk returns a tuple with the Schemas field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemasListResponse) GetSchemasOk() ([]string, bool) { + if o == nil || o.Schemas == nil { + var ret []string + return ret, false + } + return *o.Schemas, true +} + +// HasSchemas returns a boolean if a field has been set. +func (o *ScimSchemasListResponse) HasSchemas() bool { + if o != nil && o.Schemas != nil { + return true + } + + return false +} + +// SetSchemas gets a reference to the given []string and assigns it to the Schemas field. +func (o *ScimSchemasListResponse) SetSchemas(v []string) { + o.Schemas = &v +} + +// GetTotalResults returns the TotalResults field value if set, zero value otherwise. +func (o *ScimSchemasListResponse) GetTotalResults() int32 { + if o == nil || o.TotalResults == nil { + var ret int32 + return ret + } + return *o.TotalResults +} + +// GetTotalResultsOk returns a tuple with the TotalResults field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimSchemasListResponse) GetTotalResultsOk() (int32, bool) { + if o == nil || o.TotalResults == nil { + var ret int32 + return ret, false + } + return *o.TotalResults, true +} + +// HasTotalResults returns a boolean if a field has been set. +func (o *ScimSchemasListResponse) HasTotalResults() bool { + if o != nil && o.TotalResults != nil { + return true + } + + return false +} + +// SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field. +func (o *ScimSchemasListResponse) SetTotalResults(v int32) { + o.TotalResults = &v +} + +type NullableScimSchemasListResponse struct { + Value ScimSchemasListResponse + ExplicitNull bool +} + +func (v NullableScimSchemasListResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimSchemasListResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_service_provider_config_response.go b/model_scim_service_provider_config_response.go new file mode 100644 index 00000000..cac8fa6d --- /dev/null +++ b/model_scim_service_provider_config_response.go @@ -0,0 +1,248 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimServiceProviderConfigResponse Service provider configuration details. +type ScimServiceProviderConfigResponse struct { + Bulk *ScimServiceProviderConfigResponseBulk `json:"bulk,omitempty"` + ChangePassword *ScimServiceProviderConfigResponseChangePassword `json:"changePassword,omitempty"` + // The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. + DocumentationUri *string `json:"documentationUri,omitempty"` + Filter *ScimServiceProviderConfigResponseFilter `json:"filter,omitempty"` + Patch *ScimServiceProviderConfigResponsePatch `json:"patch,omitempty"` + // A list of SCIM schemas that define the structure and data types supported by the service provider. + Schemas *[]string `json:"schemas,omitempty"` +} + +// GetBulk returns the Bulk field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetBulk() ScimServiceProviderConfigResponseBulk { + if o == nil || o.Bulk == nil { + var ret ScimServiceProviderConfigResponseBulk + return ret + } + return *o.Bulk +} + +// GetBulkOk returns a tuple with the Bulk field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetBulkOk() (ScimServiceProviderConfigResponseBulk, bool) { + if o == nil || o.Bulk == nil { + var ret ScimServiceProviderConfigResponseBulk + return ret, false + } + return *o.Bulk, true +} + +// HasBulk returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasBulk() bool { + if o != nil && o.Bulk != nil { + return true + } + + return false +} + +// SetBulk gets a reference to the given ScimServiceProviderConfigResponseBulk and assigns it to the Bulk field. +func (o *ScimServiceProviderConfigResponse) SetBulk(v ScimServiceProviderConfigResponseBulk) { + o.Bulk = &v +} + +// GetChangePassword returns the ChangePassword field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetChangePassword() ScimServiceProviderConfigResponseChangePassword { + if o == nil || o.ChangePassword == nil { + var ret ScimServiceProviderConfigResponseChangePassword + return ret + } + return *o.ChangePassword +} + +// GetChangePasswordOk returns a tuple with the ChangePassword field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetChangePasswordOk() (ScimServiceProviderConfigResponseChangePassword, bool) { + if o == nil || o.ChangePassword == nil { + var ret ScimServiceProviderConfigResponseChangePassword + return ret, false + } + return *o.ChangePassword, true +} + +// HasChangePassword returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasChangePassword() bool { + if o != nil && o.ChangePassword != nil { + return true + } + + return false +} + +// SetChangePassword gets a reference to the given ScimServiceProviderConfigResponseChangePassword and assigns it to the ChangePassword field. +func (o *ScimServiceProviderConfigResponse) SetChangePassword(v ScimServiceProviderConfigResponseChangePassword) { + o.ChangePassword = &v +} + +// GetDocumentationUri returns the DocumentationUri field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetDocumentationUri() string { + if o == nil || o.DocumentationUri == nil { + var ret string + return ret + } + return *o.DocumentationUri +} + +// GetDocumentationUriOk returns a tuple with the DocumentationUri field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetDocumentationUriOk() (string, bool) { + if o == nil || o.DocumentationUri == nil { + var ret string + return ret, false + } + return *o.DocumentationUri, true +} + +// HasDocumentationUri returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasDocumentationUri() bool { + if o != nil && o.DocumentationUri != nil { + return true + } + + return false +} + +// SetDocumentationUri gets a reference to the given string and assigns it to the DocumentationUri field. +func (o *ScimServiceProviderConfigResponse) SetDocumentationUri(v string) { + o.DocumentationUri = &v +} + +// GetFilter returns the Filter field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetFilter() ScimServiceProviderConfigResponseFilter { + if o == nil || o.Filter == nil { + var ret ScimServiceProviderConfigResponseFilter + return ret + } + return *o.Filter +} + +// GetFilterOk returns a tuple with the Filter field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetFilterOk() (ScimServiceProviderConfigResponseFilter, bool) { + if o == nil || o.Filter == nil { + var ret ScimServiceProviderConfigResponseFilter + return ret, false + } + return *o.Filter, true +} + +// HasFilter returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasFilter() bool { + if o != nil && o.Filter != nil { + return true + } + + return false +} + +// SetFilter gets a reference to the given ScimServiceProviderConfigResponseFilter and assigns it to the Filter field. +func (o *ScimServiceProviderConfigResponse) SetFilter(v ScimServiceProviderConfigResponseFilter) { + o.Filter = &v +} + +// GetPatch returns the Patch field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetPatch() ScimServiceProviderConfigResponsePatch { + if o == nil || o.Patch == nil { + var ret ScimServiceProviderConfigResponsePatch + return ret + } + return *o.Patch +} + +// GetPatchOk returns a tuple with the Patch field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetPatchOk() (ScimServiceProviderConfigResponsePatch, bool) { + if o == nil || o.Patch == nil { + var ret ScimServiceProviderConfigResponsePatch + return ret, false + } + return *o.Patch, true +} + +// HasPatch returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasPatch() bool { + if o != nil && o.Patch != nil { + return true + } + + return false +} + +// SetPatch gets a reference to the given ScimServiceProviderConfigResponsePatch and assigns it to the Patch field. +func (o *ScimServiceProviderConfigResponse) SetPatch(v ScimServiceProviderConfigResponsePatch) { + o.Patch = &v +} + +// GetSchemas returns the Schemas field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponse) GetSchemas() []string { + if o == nil || o.Schemas == nil { + var ret []string + return ret + } + return *o.Schemas +} + +// GetSchemasOk returns a tuple with the Schemas field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponse) GetSchemasOk() ([]string, bool) { + if o == nil || o.Schemas == nil { + var ret []string + return ret, false + } + return *o.Schemas, true +} + +// HasSchemas returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponse) HasSchemas() bool { + if o != nil && o.Schemas != nil { + return true + } + + return false +} + +// SetSchemas gets a reference to the given []string and assigns it to the Schemas field. +func (o *ScimServiceProviderConfigResponse) SetSchemas(v []string) { + o.Schemas = &v +} + +type NullableScimServiceProviderConfigResponse struct { + Value ScimServiceProviderConfigResponse + ExplicitNull bool +} + +func (v NullableScimServiceProviderConfigResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimServiceProviderConfigResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_service_provider_config_response_bulk.go b/model_scim_service_provider_config_response_bulk.go new file mode 100644 index 00000000..ac457440 --- /dev/null +++ b/model_scim_service_provider_config_response_bulk.go @@ -0,0 +1,147 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimServiceProviderConfigResponseBulk Configuration related to bulk operations, which allow multiple SCIM requests to be processed in a single HTTP request. +type ScimServiceProviderConfigResponseBulk struct { + // The maximum number of individual operations that can be included in a single bulk request. + MaxOperations *int32 `json:"maxOperations,omitempty"` + // The maximum size, in bytes, of the entire payload for a bulk operation request. + MaxPayloadSize *int32 `json:"maxPayloadSize,omitempty"` + // Indicates whether the SCIM service provider supports bulk operations. + Supported *bool `json:"supported,omitempty"` +} + +// GetMaxOperations returns the MaxOperations field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseBulk) GetMaxOperations() int32 { + if o == nil || o.MaxOperations == nil { + var ret int32 + return ret + } + return *o.MaxOperations +} + +// GetMaxOperationsOk returns a tuple with the MaxOperations field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseBulk) GetMaxOperationsOk() (int32, bool) { + if o == nil || o.MaxOperations == nil { + var ret int32 + return ret, false + } + return *o.MaxOperations, true +} + +// HasMaxOperations returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseBulk) HasMaxOperations() bool { + if o != nil && o.MaxOperations != nil { + return true + } + + return false +} + +// SetMaxOperations gets a reference to the given int32 and assigns it to the MaxOperations field. +func (o *ScimServiceProviderConfigResponseBulk) SetMaxOperations(v int32) { + o.MaxOperations = &v +} + +// GetMaxPayloadSize returns the MaxPayloadSize field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseBulk) GetMaxPayloadSize() int32 { + if o == nil || o.MaxPayloadSize == nil { + var ret int32 + return ret + } + return *o.MaxPayloadSize +} + +// GetMaxPayloadSizeOk returns a tuple with the MaxPayloadSize field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseBulk) GetMaxPayloadSizeOk() (int32, bool) { + if o == nil || o.MaxPayloadSize == nil { + var ret int32 + return ret, false + } + return *o.MaxPayloadSize, true +} + +// HasMaxPayloadSize returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseBulk) HasMaxPayloadSize() bool { + if o != nil && o.MaxPayloadSize != nil { + return true + } + + return false +} + +// SetMaxPayloadSize gets a reference to the given int32 and assigns it to the MaxPayloadSize field. +func (o *ScimServiceProviderConfigResponseBulk) SetMaxPayloadSize(v int32) { + o.MaxPayloadSize = &v +} + +// GetSupported returns the Supported field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseBulk) GetSupported() bool { + if o == nil || o.Supported == nil { + var ret bool + return ret + } + return *o.Supported +} + +// GetSupportedOk returns a tuple with the Supported field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseBulk) GetSupportedOk() (bool, bool) { + if o == nil || o.Supported == nil { + var ret bool + return ret, false + } + return *o.Supported, true +} + +// HasSupported returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseBulk) HasSupported() bool { + if o != nil && o.Supported != nil { + return true + } + + return false +} + +// SetSupported gets a reference to the given bool and assigns it to the Supported field. +func (o *ScimServiceProviderConfigResponseBulk) SetSupported(v bool) { + o.Supported = &v +} + +type NullableScimServiceProviderConfigResponseBulk struct { + Value ScimServiceProviderConfigResponseBulk + ExplicitNull bool +} + +func (v NullableScimServiceProviderConfigResponseBulk) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimServiceProviderConfigResponseBulk) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_service_provider_config_response_change_password.go b/model_scim_service_provider_config_response_change_password.go new file mode 100644 index 00000000..e599cc0f --- /dev/null +++ b/model_scim_service_provider_config_response_change_password.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimServiceProviderConfigResponseChangePassword Configuration settings related to the ability to change user passwords. +type ScimServiceProviderConfigResponseChangePassword struct { + // Indicates whether the service provider supports password changes via the SCIM API. + Supported *bool `json:"supported,omitempty"` +} + +// GetSupported returns the Supported field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseChangePassword) GetSupported() bool { + if o == nil || o.Supported == nil { + var ret bool + return ret + } + return *o.Supported +} + +// GetSupportedOk returns a tuple with the Supported field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseChangePassword) GetSupportedOk() (bool, bool) { + if o == nil || o.Supported == nil { + var ret bool + return ret, false + } + return *o.Supported, true +} + +// HasSupported returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseChangePassword) HasSupported() bool { + if o != nil && o.Supported != nil { + return true + } + + return false +} + +// SetSupported gets a reference to the given bool and assigns it to the Supported field. +func (o *ScimServiceProviderConfigResponseChangePassword) SetSupported(v bool) { + o.Supported = &v +} + +type NullableScimServiceProviderConfigResponseChangePassword struct { + Value ScimServiceProviderConfigResponseChangePassword + ExplicitNull bool +} + +func (v NullableScimServiceProviderConfigResponseChangePassword) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimServiceProviderConfigResponseChangePassword) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_service_provider_config_response_filter.go b/model_scim_service_provider_config_response_filter.go new file mode 100644 index 00000000..aefbdc3f --- /dev/null +++ b/model_scim_service_provider_config_response_filter.go @@ -0,0 +1,112 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimServiceProviderConfigResponseFilter Configuration settings related to filtering SCIM resources based on specific criteria. +type ScimServiceProviderConfigResponseFilter struct { + // The maximum number of resources that can be returned in a single filtered query response. + MaxResults *int32 `json:"maxResults,omitempty"` + // Indicates whether the SCIM service provider supports filtering operations. + Supported *bool `json:"supported,omitempty"` +} + +// GetMaxResults returns the MaxResults field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseFilter) GetMaxResults() int32 { + if o == nil || o.MaxResults == nil { + var ret int32 + return ret + } + return *o.MaxResults +} + +// GetMaxResultsOk returns a tuple with the MaxResults field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseFilter) GetMaxResultsOk() (int32, bool) { + if o == nil || o.MaxResults == nil { + var ret int32 + return ret, false + } + return *o.MaxResults, true +} + +// HasMaxResults returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseFilter) HasMaxResults() bool { + if o != nil && o.MaxResults != nil { + return true + } + + return false +} + +// SetMaxResults gets a reference to the given int32 and assigns it to the MaxResults field. +func (o *ScimServiceProviderConfigResponseFilter) SetMaxResults(v int32) { + o.MaxResults = &v +} + +// GetSupported returns the Supported field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponseFilter) GetSupported() bool { + if o == nil || o.Supported == nil { + var ret bool + return ret + } + return *o.Supported +} + +// GetSupportedOk returns a tuple with the Supported field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponseFilter) GetSupportedOk() (bool, bool) { + if o == nil || o.Supported == nil { + var ret bool + return ret, false + } + return *o.Supported, true +} + +// HasSupported returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponseFilter) HasSupported() bool { + if o != nil && o.Supported != nil { + return true + } + + return false +} + +// SetSupported gets a reference to the given bool and assigns it to the Supported field. +func (o *ScimServiceProviderConfigResponseFilter) SetSupported(v bool) { + o.Supported = &v +} + +type NullableScimServiceProviderConfigResponseFilter struct { + Value ScimServiceProviderConfigResponseFilter + ExplicitNull bool +} + +func (v NullableScimServiceProviderConfigResponseFilter) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimServiceProviderConfigResponseFilter) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_service_provider_config_response_patch.go b/model_scim_service_provider_config_response_patch.go new file mode 100644 index 00000000..8a61f7f6 --- /dev/null +++ b/model_scim_service_provider_config_response_patch.go @@ -0,0 +1,77 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimServiceProviderConfigResponsePatch Configuration settings related to patch operations, which allow partial updates to SCIM resources. +type ScimServiceProviderConfigResponsePatch struct { + // Indicates whether the service provider supports patch operations for modifying resources. + Supported *bool `json:"supported,omitempty"` +} + +// GetSupported returns the Supported field value if set, zero value otherwise. +func (o *ScimServiceProviderConfigResponsePatch) GetSupported() bool { + if o == nil || o.Supported == nil { + var ret bool + return ret + } + return *o.Supported +} + +// GetSupportedOk returns a tuple with the Supported field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimServiceProviderConfigResponsePatch) GetSupportedOk() (bool, bool) { + if o == nil || o.Supported == nil { + var ret bool + return ret, false + } + return *o.Supported, true +} + +// HasSupported returns a boolean if a field has been set. +func (o *ScimServiceProviderConfigResponsePatch) HasSupported() bool { + if o != nil && o.Supported != nil { + return true + } + + return false +} + +// SetSupported gets a reference to the given bool and assigns it to the Supported field. +func (o *ScimServiceProviderConfigResponsePatch) SetSupported(v bool) { + o.Supported = &v +} + +type NullableScimServiceProviderConfigResponsePatch struct { + Value ScimServiceProviderConfigResponsePatch + ExplicitNull bool +} + +func (v NullableScimServiceProviderConfigResponsePatch) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimServiceProviderConfigResponsePatch) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_user.go b/model_scim_user.go new file mode 100644 index 00000000..d4717a55 --- /dev/null +++ b/model_scim_user.go @@ -0,0 +1,198 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimUser Schema definition for users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. +type ScimUser struct { + // Status of the user. + Active *bool `json:"active,omitempty"` + // Display name of the user. + DisplayName *string `json:"displayName,omitempty"` + // Unique identifier of the user. This is usually an email address. + UserName *string `json:"userName,omitempty"` + Name *ScimBaseUserName `json:"name,omitempty"` + // ID of the user. + Id string `json:"id"` +} + +// GetActive returns the Active field value if set, zero value otherwise. +func (o *ScimUser) GetActive() bool { + if o == nil || o.Active == nil { + var ret bool + return ret + } + return *o.Active +} + +// GetActiveOk returns a tuple with the Active field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUser) GetActiveOk() (bool, bool) { + if o == nil || o.Active == nil { + var ret bool + return ret, false + } + return *o.Active, true +} + +// HasActive returns a boolean if a field has been set. +func (o *ScimUser) HasActive() bool { + if o != nil && o.Active != nil { + return true + } + + return false +} + +// SetActive gets a reference to the given bool and assigns it to the Active field. +func (o *ScimUser) SetActive(v bool) { + o.Active = &v +} + +// GetDisplayName returns the DisplayName field value if set, zero value otherwise. +func (o *ScimUser) GetDisplayName() string { + if o == nil || o.DisplayName == nil { + var ret string + return ret + } + return *o.DisplayName +} + +// GetDisplayNameOk returns a tuple with the DisplayName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUser) GetDisplayNameOk() (string, bool) { + if o == nil || o.DisplayName == nil { + var ret string + return ret, false + } + return *o.DisplayName, true +} + +// HasDisplayName returns a boolean if a field has been set. +func (o *ScimUser) HasDisplayName() bool { + if o != nil && o.DisplayName != nil { + return true + } + + return false +} + +// SetDisplayName gets a reference to the given string and assigns it to the DisplayName field. +func (o *ScimUser) SetDisplayName(v string) { + o.DisplayName = &v +} + +// GetUserName returns the UserName field value if set, zero value otherwise. +func (o *ScimUser) GetUserName() string { + if o == nil || o.UserName == nil { + var ret string + return ret + } + return *o.UserName +} + +// GetUserNameOk returns a tuple with the UserName field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUser) GetUserNameOk() (string, bool) { + if o == nil || o.UserName == nil { + var ret string + return ret, false + } + return *o.UserName, true +} + +// HasUserName returns a boolean if a field has been set. +func (o *ScimUser) HasUserName() bool { + if o != nil && o.UserName != nil { + return true + } + + return false +} + +// SetUserName gets a reference to the given string and assigns it to the UserName field. +func (o *ScimUser) SetUserName(v string) { + o.UserName = &v +} + +// GetName returns the Name field value if set, zero value otherwise. +func (o *ScimUser) GetName() ScimBaseUserName { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret + } + return *o.Name +} + +// GetNameOk returns a tuple with the Name field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUser) GetNameOk() (ScimBaseUserName, bool) { + if o == nil || o.Name == nil { + var ret ScimBaseUserName + return ret, false + } + return *o.Name, true +} + +// HasName returns a boolean if a field has been set. +func (o *ScimUser) HasName() bool { + if o != nil && o.Name != nil { + return true + } + + return false +} + +// SetName gets a reference to the given ScimBaseUserName and assigns it to the Name field. +func (o *ScimUser) SetName(v ScimBaseUserName) { + o.Name = &v +} + +// GetId returns the Id field value +func (o *ScimUser) GetId() string { + if o == nil { + var ret string + return ret + } + + return o.Id +} + +// SetId sets field value +func (o *ScimUser) SetId(v string) { + o.Id = v +} + +type NullableScimUser struct { + Value ScimUser + ExplicitNull bool +} + +func (v NullableScimUser) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimUser) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_scim_users_list_response.go b/model_scim_users_list_response.go new file mode 100644 index 00000000..a4da366d --- /dev/null +++ b/model_scim_users_list_response.go @@ -0,0 +1,128 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" +) + +// ScimUsersListResponse List of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. +type ScimUsersListResponse struct { + Resources []ScimUser `json:"Resources"` + // SCIM schema for the given resource. + Schemas *[]string `json:"schemas,omitempty"` + // Number of total results in the response. + TotalResults *int32 `json:"totalResults,omitempty"` +} + +// GetResources returns the Resources field value +func (o *ScimUsersListResponse) GetResources() []ScimUser { + if o == nil { + var ret []ScimUser + return ret + } + + return o.Resources +} + +// SetResources sets field value +func (o *ScimUsersListResponse) SetResources(v []ScimUser) { + o.Resources = v +} + +// GetSchemas returns the Schemas field value if set, zero value otherwise. +func (o *ScimUsersListResponse) GetSchemas() []string { + if o == nil || o.Schemas == nil { + var ret []string + return ret + } + return *o.Schemas +} + +// GetSchemasOk returns a tuple with the Schemas field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUsersListResponse) GetSchemasOk() ([]string, bool) { + if o == nil || o.Schemas == nil { + var ret []string + return ret, false + } + return *o.Schemas, true +} + +// HasSchemas returns a boolean if a field has been set. +func (o *ScimUsersListResponse) HasSchemas() bool { + if o != nil && o.Schemas != nil { + return true + } + + return false +} + +// SetSchemas gets a reference to the given []string and assigns it to the Schemas field. +func (o *ScimUsersListResponse) SetSchemas(v []string) { + o.Schemas = &v +} + +// GetTotalResults returns the TotalResults field value if set, zero value otherwise. +func (o *ScimUsersListResponse) GetTotalResults() int32 { + if o == nil || o.TotalResults == nil { + var ret int32 + return ret + } + return *o.TotalResults +} + +// GetTotalResultsOk returns a tuple with the TotalResults field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *ScimUsersListResponse) GetTotalResultsOk() (int32, bool) { + if o == nil || o.TotalResults == nil { + var ret int32 + return ret, false + } + return *o.TotalResults, true +} + +// HasTotalResults returns a boolean if a field has been set. +func (o *ScimUsersListResponse) HasTotalResults() bool { + if o != nil && o.TotalResults != nil { + return true + } + + return false +} + +// SetTotalResults gets a reference to the given int32 and assigns it to the TotalResults field. +func (o *ScimUsersListResponse) SetTotalResults(v int32) { + o.TotalResults = &v +} + +type NullableScimUsersListResponse struct { + Value ScimUsersListResponse + ExplicitNull bool +} + +func (v NullableScimUsersListResponse) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableScimUsersListResponse) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_sso_config.go b/model_sso_config.go index 551b9670..5c8a3fcb 100644 --- a/model_sso_config.go +++ b/model_sso_config.go @@ -18,6 +18,8 @@ import ( type SsoConfig struct { // An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. Enforced bool `json:"enforced"` + // Assertion Consumer Service (ACS) URL for setting up a new SAML connection with an identity provider like Okta or Microsoft Entra ID. + NewAcsUrl *string `json:"newAcsUrl,omitempty"` } // GetEnforced returns the Enforced field value @@ -35,6 +37,39 @@ func (o *SsoConfig) SetEnforced(v bool) { o.Enforced = v } +// GetNewAcsUrl returns the NewAcsUrl field value if set, zero value otherwise. +func (o *SsoConfig) GetNewAcsUrl() string { + if o == nil || o.NewAcsUrl == nil { + var ret string + return ret + } + return *o.NewAcsUrl +} + +// GetNewAcsUrlOk returns a tuple with the NewAcsUrl field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *SsoConfig) GetNewAcsUrlOk() (string, bool) { + if o == nil || o.NewAcsUrl == nil { + var ret string + return ret, false + } + return *o.NewAcsUrl, true +} + +// HasNewAcsUrl returns a boolean if a field has been set. +func (o *SsoConfig) HasNewAcsUrl() bool { + if o != nil && o.NewAcsUrl != nil { + return true + } + + return false +} + +// SetNewAcsUrl gets a reference to the given string and assigns it to the NewAcsUrl field. +func (o *SsoConfig) SetNewAcsUrl(v string) { + o.NewAcsUrl = &v +} + type NullableSsoConfig struct { Value SsoConfig ExplicitNull bool diff --git a/model_template_def.go b/model_template_def.go index 61712310..317c86e5 100644 --- a/model_template_def.go +++ b/model_template_def.go @@ -32,7 +32,7 @@ type TemplateDef struct { // Used for grouping templates in the rule editor sidebar. Category string `json:"category"` // A Talang expression that contains variable bindings referring to args. - Expr []interface{} `json:"expr"` + Expr []map[string]interface{} `json:"expr"` // An array of argument definitions. Args []TemplateArgDef `json:"args"` // A flag to control exposure in Rule Builder. @@ -147,9 +147,9 @@ func (o *TemplateDef) SetCategory(v string) { } // GetExpr returns the Expr field value -func (o *TemplateDef) GetExpr() []interface{} { +func (o *TemplateDef) GetExpr() []map[string]interface{} { if o == nil { - var ret []interface{} + var ret []map[string]interface{} return ret } @@ -157,7 +157,7 @@ func (o *TemplateDef) GetExpr() []interface{} { } // SetExpr sets field value -func (o *TemplateDef) SetExpr(v []interface{}) { +func (o *TemplateDef) SetExpr(v []map[string]interface{}) { o.Expr = v } diff --git a/model_tier.go b/model_tier.go index d940395c..23e79c46 100644 --- a/model_tier.go +++ b/model_tier.go @@ -21,9 +21,11 @@ type Tier struct { Id int32 `json:"id"` // The name of the tier. Name string `json:"name"` + // Date and time when the customer moved to this tier. This value uses the loyalty program's time zone setting. + StartDate *time.Time `json:"startDate,omitempty"` // Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone). ExpiryDate *time.Time `json:"expiryDate,omitempty"` - // 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. + // 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. DowngradePolicy *string `json:"downgradePolicy,omitempty"` } @@ -57,6 +59,39 @@ func (o *Tier) SetName(v string) { o.Name = v } +// GetStartDate returns the StartDate field value if set, zero value otherwise. +func (o *Tier) GetStartDate() time.Time { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret + } + return *o.StartDate +} + +// GetStartDateOk returns a tuple with the StartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Tier) GetStartDateOk() (time.Time, bool) { + if o == nil || o.StartDate == nil { + var ret time.Time + return ret, false + } + return *o.StartDate, true +} + +// HasStartDate returns a boolean if a field has been set. +func (o *Tier) HasStartDate() bool { + if o != nil && o.StartDate != nil { + return true + } + + return false +} + +// SetStartDate gets a reference to the given time.Time and assigns it to the StartDate field. +func (o *Tier) SetStartDate(v time.Time) { + o.StartDate = &v +} + // GetExpiryDate returns the ExpiryDate field value if set, zero value otherwise. func (o *Tier) GetExpiryDate() time.Time { if o == nil || o.ExpiryDate == nil { diff --git a/model_transfer_loyalty_card.go b/model_transfer_loyalty_card.go index 8bec08e0..990b52b2 100644 --- a/model_transfer_loyalty_card.go +++ b/model_transfer_loyalty_card.go @@ -18,6 +18,8 @@ import ( type TransferLoyaltyCard struct { // The alphanumeric identifier of the loyalty card. NewCardIdentifier string `json:"newCardIdentifier"` + // Reason for transferring and blocking the loyalty card. + BlockReason *string `json:"blockReason,omitempty"` } // GetNewCardIdentifier returns the NewCardIdentifier field value @@ -35,6 +37,39 @@ func (o *TransferLoyaltyCard) SetNewCardIdentifier(v string) { o.NewCardIdentifier = v } +// GetBlockReason returns the BlockReason field value if set, zero value otherwise. +func (o *TransferLoyaltyCard) GetBlockReason() string { + if o == nil || o.BlockReason == nil { + var ret string + return ret + } + return *o.BlockReason +} + +// GetBlockReasonOk returns a tuple with the BlockReason field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *TransferLoyaltyCard) GetBlockReasonOk() (string, bool) { + if o == nil || o.BlockReason == nil { + var ret string + return ret, false + } + return *o.BlockReason, true +} + +// HasBlockReason returns a boolean if a field has been set. +func (o *TransferLoyaltyCard) HasBlockReason() bool { + if o != nil && o.BlockReason != nil { + return true + } + + return false +} + +// SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. +func (o *TransferLoyaltyCard) SetBlockReason(v string) { + o.BlockReason = &v +} + type NullableTransferLoyaltyCard struct { Value TransferLoyaltyCard ExplicitNull bool diff --git a/model_update_application.go b/model_update_application.go index fd4254f5..01ba3ad3 100644 --- a/model_update_application.go +++ b/model_update_application.go @@ -45,6 +45,10 @@ type UpdateApplication struct { DefaultDiscountAdditionalCostPerItemScope *string `json:"defaultDiscountAdditionalCostPerItemScope,omitempty"` // 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. DefaultEvaluationGroupId *int32 `json:"defaultEvaluationGroupId,omitempty"` + // The ID of the default Cart-Item-Filter for this application. + DefaultCartItemFilterId *int32 `json:"defaultCartItemFilterId,omitempty"` + // Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. + EnableCampaignStateManagement *bool `json:"enableCampaignStateManagement,omitempty"` } // GetName returns the Name field value @@ -488,6 +492,72 @@ func (o *UpdateApplication) SetDefaultEvaluationGroupId(v int32) { o.DefaultEvaluationGroupId = &v } +// GetDefaultCartItemFilterId returns the DefaultCartItemFilterId field value if set, zero value otherwise. +func (o *UpdateApplication) GetDefaultCartItemFilterId() int32 { + if o == nil || o.DefaultCartItemFilterId == nil { + var ret int32 + return ret + } + return *o.DefaultCartItemFilterId +} + +// GetDefaultCartItemFilterIdOk returns a tuple with the DefaultCartItemFilterId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetDefaultCartItemFilterIdOk() (int32, bool) { + if o == nil || o.DefaultCartItemFilterId == nil { + var ret int32 + return ret, false + } + return *o.DefaultCartItemFilterId, true +} + +// HasDefaultCartItemFilterId returns a boolean if a field has been set. +func (o *UpdateApplication) HasDefaultCartItemFilterId() bool { + if o != nil && o.DefaultCartItemFilterId != nil { + return true + } + + return false +} + +// SetDefaultCartItemFilterId gets a reference to the given int32 and assigns it to the DefaultCartItemFilterId field. +func (o *UpdateApplication) SetDefaultCartItemFilterId(v int32) { + o.DefaultCartItemFilterId = &v +} + +// GetEnableCampaignStateManagement returns the EnableCampaignStateManagement field value if set, zero value otherwise. +func (o *UpdateApplication) GetEnableCampaignStateManagement() bool { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret + } + return *o.EnableCampaignStateManagement +} + +// GetEnableCampaignStateManagementOk returns a tuple with the EnableCampaignStateManagement field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplication) GetEnableCampaignStateManagementOk() (bool, bool) { + if o == nil || o.EnableCampaignStateManagement == nil { + var ret bool + return ret, false + } + return *o.EnableCampaignStateManagement, true +} + +// HasEnableCampaignStateManagement returns a boolean if a field has been set. +func (o *UpdateApplication) HasEnableCampaignStateManagement() bool { + if o != nil && o.EnableCampaignStateManagement != nil { + return true + } + + return false +} + +// SetEnableCampaignStateManagement gets a reference to the given bool and assigns it to the EnableCampaignStateManagement field. +func (o *UpdateApplication) SetEnableCampaignStateManagement(v bool) { + o.EnableCampaignStateManagement = &v +} + type NullableUpdateApplication struct { Value UpdateApplication ExplicitNull bool diff --git a/model_update_application_cif.go b/model_update_application_cif.go new file mode 100644 index 00000000..6bd4c1b9 --- /dev/null +++ b/model_update_application_cif.go @@ -0,0 +1,183 @@ +/* + * Talon.One API + * + * Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` + * + * API version: + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package talon + +import ( + "bytes" + "encoding/json" + "time" +) + +// UpdateApplicationCif struct for UpdateApplicationCif +type UpdateApplicationCif struct { + // A short description of the Application cart item filter. + Description *string `json:"description,omitempty"` + // The ID of the expression that the Application cart item filter uses. + ActiveExpressionId *int32 `json:"activeExpressionId,omitempty"` + // The ID of the user who last updated the Application cart item filter. + ModifiedBy *int32 `json:"modifiedBy,omitempty"` + // Timestamp of the most recent update to the Application cart item filter. + Modified *time.Time `json:"modified,omitempty"` +} + +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *UpdateApplicationCif) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplicationCif) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *UpdateApplicationCif) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *UpdateApplicationCif) SetDescription(v string) { + o.Description = &v +} + +// GetActiveExpressionId returns the ActiveExpressionId field value if set, zero value otherwise. +func (o *UpdateApplicationCif) GetActiveExpressionId() int32 { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret + } + return *o.ActiveExpressionId +} + +// GetActiveExpressionIdOk returns a tuple with the ActiveExpressionId field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplicationCif) GetActiveExpressionIdOk() (int32, bool) { + if o == nil || o.ActiveExpressionId == nil { + var ret int32 + return ret, false + } + return *o.ActiveExpressionId, true +} + +// HasActiveExpressionId returns a boolean if a field has been set. +func (o *UpdateApplicationCif) HasActiveExpressionId() bool { + if o != nil && o.ActiveExpressionId != nil { + return true + } + + return false +} + +// SetActiveExpressionId gets a reference to the given int32 and assigns it to the ActiveExpressionId field. +func (o *UpdateApplicationCif) SetActiveExpressionId(v int32) { + o.ActiveExpressionId = &v +} + +// GetModifiedBy returns the ModifiedBy field value if set, zero value otherwise. +func (o *UpdateApplicationCif) GetModifiedBy() int32 { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret + } + return *o.ModifiedBy +} + +// GetModifiedByOk returns a tuple with the ModifiedBy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplicationCif) GetModifiedByOk() (int32, bool) { + if o == nil || o.ModifiedBy == nil { + var ret int32 + return ret, false + } + return *o.ModifiedBy, true +} + +// HasModifiedBy returns a boolean if a field has been set. +func (o *UpdateApplicationCif) HasModifiedBy() bool { + if o != nil && o.ModifiedBy != nil { + return true + } + + return false +} + +// SetModifiedBy gets a reference to the given int32 and assigns it to the ModifiedBy field. +func (o *UpdateApplicationCif) SetModifiedBy(v int32) { + o.ModifiedBy = &v +} + +// GetModified returns the Modified field value if set, zero value otherwise. +func (o *UpdateApplicationCif) GetModified() time.Time { + if o == nil || o.Modified == nil { + var ret time.Time + return ret + } + return *o.Modified +} + +// GetModifiedOk returns a tuple with the Modified field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateApplicationCif) GetModifiedOk() (time.Time, bool) { + if o == nil || o.Modified == nil { + var ret time.Time + return ret, false + } + return *o.Modified, true +} + +// HasModified returns a boolean if a field has been set. +func (o *UpdateApplicationCif) HasModified() bool { + if o != nil && o.Modified != nil { + return true + } + + return false +} + +// SetModified gets a reference to the given time.Time and assigns it to the Modified field. +func (o *UpdateApplicationCif) SetModified(v time.Time) { + o.Modified = &v +} + +type NullableUpdateApplicationCif struct { + Value UpdateApplicationCif + ExplicitNull bool +} + +func (v NullableUpdateApplicationCif) MarshalJSON() ([]byte, error) { + switch { + case v.ExplicitNull: + return []byte("null"), nil + default: + return json.Marshal(v.Value) + } +} + +func (v *NullableUpdateApplicationCif) UnmarshalJSON(src []byte) error { + if bytes.Equal(src, []byte("null")) { + v.ExplicitNull = true + return nil + } + + return json.Unmarshal(src, &v.Value) +} diff --git a/model_update_campaign.go b/model_update_campaign.go index bb679b52..9b351e54 100644 --- a/model_update_campaign.go +++ b/model_update_campaign.go @@ -45,7 +45,7 @@ type UpdateCampaign struct { EvaluationGroupId *int32 `json:"evaluationGroupId,omitempty"` // The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. Type *string `json:"type,omitempty"` - // A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. + // A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. LinkedStoreIds *[]int32 `json:"linkedStoreIds,omitempty"` } diff --git a/model_update_coupon.go b/model_update_coupon.go index 98ed7f2f..b2e610f8 100644 --- a/model_update_coupon.go +++ b/model_update_coupon.go @@ -25,7 +25,7 @@ type UpdateCoupon struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. Limits *[]LimitConfig `json:"limits,omitempty"` diff --git a/model_update_coupon_batch.go b/model_update_coupon_batch.go index 1b78f97d..5ff34e45 100644 --- a/model_update_coupon_batch.go +++ b/model_update_coupon_batch.go @@ -25,7 +25,7 @@ type UpdateCouponBatch struct { ReservationLimit *int32 `json:"reservationLimit,omitempty"` // Timestamp at which point the coupon becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the coupon. Coupon never expires if this is omitted, zero, or negative. + // Expiration date of the coupon. Coupon never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. Attributes *map[string]interface{} `json:"attributes,omitempty"` diff --git a/model_update_loyalty_card.go b/model_update_loyalty_card.go index 6d6f58b4..bc5bdd28 100644 --- a/model_update_loyalty_card.go +++ b/model_update_loyalty_card.go @@ -16,8 +16,10 @@ import ( // UpdateLoyaltyCard struct for UpdateLoyaltyCard type UpdateLoyaltyCard struct { - // Status of the loyalty card. Can be one of: ['active', 'inactive'] + // Status of the loyalty card. Can be `active` or `inactive`. Status string `json:"status"` + // Reason for transferring and blocking the loyalty card. + BlockReason *string `json:"blockReason,omitempty"` } // GetStatus returns the Status field value @@ -35,6 +37,39 @@ func (o *UpdateLoyaltyCard) SetStatus(v string) { o.Status = v } +// GetBlockReason returns the BlockReason field value if set, zero value otherwise. +func (o *UpdateLoyaltyCard) GetBlockReason() string { + if o == nil || o.BlockReason == nil { + var ret string + return ret + } + return *o.BlockReason +} + +// GetBlockReasonOk returns a tuple with the BlockReason field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateLoyaltyCard) GetBlockReasonOk() (string, bool) { + if o == nil || o.BlockReason == nil { + var ret string + return ret, false + } + return *o.BlockReason, true +} + +// HasBlockReason returns a boolean if a field has been set. +func (o *UpdateLoyaltyCard) HasBlockReason() bool { + if o != nil && o.BlockReason != nil { + return true + } + + return false +} + +// SetBlockReason gets a reference to the given string and assigns it to the BlockReason field. +func (o *UpdateLoyaltyCard) SetBlockReason(v string) { + o.BlockReason = &v +} + type NullableUpdateLoyaltyCard struct { Value UpdateLoyaltyCard ExplicitNull bool diff --git a/model_update_loyalty_program.go b/model_update_loyalty_program.go index 7e6aeafe..216bbfe0 100644 --- a/model_update_loyalty_program.go +++ b/model_update_loyalty_program.go @@ -12,6 +12,7 @@ package talon import ( "bytes" "encoding/json" + "time" ) // UpdateLoyaltyProgram @@ -32,14 +33,17 @@ type UpdateLoyaltyProgram struct { UsersPerCardLimit *int32 `json:"usersPerCardLimit,omitempty"` // 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. Sandbox *bool `json:"sandbox,omitempty"` - // 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. - TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` - // 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. - TiersExpireIn *string `json:"tiersExpireIn,omitempty"` - // 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. - TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` // 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. ProgramJoinPolicy *string `json:"programJoinPolicy,omitempty"` + // 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`. + TiersExpirationPolicy *string `json:"tiersExpirationPolicy,omitempty"` + // 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`. + TierCycleStartDate *time.Time `json:"tierCycleStartDate,omitempty"` + // 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. + TiersExpireIn *string `json:"tiersExpireIn,omitempty"` + // 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. + TiersDowngradePolicy *string `json:"tiersDowngradePolicy,omitempty"` + CardCodeSettings *CodeGeneratorSettings `json:"cardCodeSettings,omitempty"` // The tiers in this loyalty program. Tiers *[]NewLoyaltyTier `json:"tiers,omitempty"` } @@ -308,6 +312,39 @@ func (o *UpdateLoyaltyProgram) SetSandbox(v bool) { o.Sandbox = &v } +// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) GetProgramJoinPolicy() string { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret + } + return *o.ProgramJoinPolicy +} + +// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { + if o == nil || o.ProgramJoinPolicy == nil { + var ret string + return ret, false + } + return *o.ProgramJoinPolicy, true +} + +// HasProgramJoinPolicy returns a boolean if a field has been set. +func (o *UpdateLoyaltyProgram) HasProgramJoinPolicy() bool { + if o != nil && o.ProgramJoinPolicy != nil { + return true + } + + return false +} + +// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. +func (o *UpdateLoyaltyProgram) SetProgramJoinPolicy(v string) { + o.ProgramJoinPolicy = &v +} + // GetTiersExpirationPolicy returns the TiersExpirationPolicy field value if set, zero value otherwise. func (o *UpdateLoyaltyProgram) GetTiersExpirationPolicy() string { if o == nil || o.TiersExpirationPolicy == nil { @@ -341,6 +378,39 @@ func (o *UpdateLoyaltyProgram) SetTiersExpirationPolicy(v string) { o.TiersExpirationPolicy = &v } +// GetTierCycleStartDate returns the TierCycleStartDate field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) GetTierCycleStartDate() time.Time { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret + } + return *o.TierCycleStartDate +} + +// GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *UpdateLoyaltyProgram) GetTierCycleStartDateOk() (time.Time, bool) { + if o == nil || o.TierCycleStartDate == nil { + var ret time.Time + return ret, false + } + return *o.TierCycleStartDate, true +} + +// HasTierCycleStartDate returns a boolean if a field has been set. +func (o *UpdateLoyaltyProgram) HasTierCycleStartDate() bool { + if o != nil && o.TierCycleStartDate != nil { + return true + } + + return false +} + +// SetTierCycleStartDate gets a reference to the given time.Time and assigns it to the TierCycleStartDate field. +func (o *UpdateLoyaltyProgram) SetTierCycleStartDate(v time.Time) { + o.TierCycleStartDate = &v +} + // GetTiersExpireIn returns the TiersExpireIn field value if set, zero value otherwise. func (o *UpdateLoyaltyProgram) GetTiersExpireIn() string { if o == nil || o.TiersExpireIn == nil { @@ -407,37 +477,37 @@ func (o *UpdateLoyaltyProgram) SetTiersDowngradePolicy(v string) { o.TiersDowngradePolicy = &v } -// GetProgramJoinPolicy returns the ProgramJoinPolicy field value if set, zero value otherwise. -func (o *UpdateLoyaltyProgram) GetProgramJoinPolicy() string { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +// GetCardCodeSettings returns the CardCodeSettings field value if set, zero value otherwise. +func (o *UpdateLoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret } - return *o.ProgramJoinPolicy + return *o.CardCodeSettings } -// GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field value if set, zero value otherwise +// GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *UpdateLoyaltyProgram) GetProgramJoinPolicyOk() (string, bool) { - if o == nil || o.ProgramJoinPolicy == nil { - var ret string +func (o *UpdateLoyaltyProgram) GetCardCodeSettingsOk() (CodeGeneratorSettings, bool) { + if o == nil || o.CardCodeSettings == nil { + var ret CodeGeneratorSettings return ret, false } - return *o.ProgramJoinPolicy, true + return *o.CardCodeSettings, true } -// HasProgramJoinPolicy returns a boolean if a field has been set. -func (o *UpdateLoyaltyProgram) HasProgramJoinPolicy() bool { - if o != nil && o.ProgramJoinPolicy != nil { +// HasCardCodeSettings returns a boolean if a field has been set. +func (o *UpdateLoyaltyProgram) HasCardCodeSettings() bool { + if o != nil && o.CardCodeSettings != nil { return true } return false } -// SetProgramJoinPolicy gets a reference to the given string and assigns it to the ProgramJoinPolicy field. -func (o *UpdateLoyaltyProgram) SetProgramJoinPolicy(v string) { - o.ProgramJoinPolicy = &v +// SetCardCodeSettings gets a reference to the given CodeGeneratorSettings and assigns it to the CardCodeSettings field. +func (o *UpdateLoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings) { + o.CardCodeSettings = &v } // GetTiers returns the Tiers field value if set, zero value otherwise. diff --git a/model_update_referral.go b/model_update_referral.go index a320da1a..6487fb0f 100644 --- a/model_update_referral.go +++ b/model_update_referral.go @@ -21,7 +21,7 @@ type UpdateReferral struct { FriendProfileIntegrationId *string `json:"friendProfileIntegrationId,omitempty"` // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_update_referral_batch.go b/model_update_referral_batch.go index e0288faa..42ee5d25 100644 --- a/model_update_referral_batch.go +++ b/model_update_referral_batch.go @@ -23,7 +23,7 @@ type UpdateReferralBatch struct { BatchID string `json:"batchID"` // Timestamp at which point the referral code becomes valid. StartDate *time.Time `json:"startDate,omitempty"` - // Expiration date of the referral code. Referral never expires if this is omitted, zero, or negative. + // Expiration date of the referral code. Referral never expires if this is omitted. ExpiryDate *time.Time `json:"expiryDate,omitempty"` // The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. UsageLimit *int32 `json:"usageLimit,omitempty"` diff --git a/model_user.go b/model_user.go index fcaee37c..aba1f9f7 100644 --- a/model_user.go +++ b/model_user.go @@ -49,6 +49,8 @@ type User struct { LastAccessed *time.Time `json:"lastAccessed,omitempty"` // Timestamp when the user was notified for feed. LatestFeedTimestamp *time.Time `json:"latestFeedTimestamp,omitempty"` + // Additional user attributes, created and used by external identity providers. + AdditionalAttributes *map[string]interface{} `json:"additionalAttributes,omitempty"` } // GetId returns the Id field value @@ -417,6 +419,39 @@ func (o *User) SetLatestFeedTimestamp(v time.Time) { o.LatestFeedTimestamp = &v } +// GetAdditionalAttributes returns the AdditionalAttributes field value if set, zero value otherwise. +func (o *User) GetAdditionalAttributes() map[string]interface{} { + if o == nil || o.AdditionalAttributes == nil { + var ret map[string]interface{} + return ret + } + return *o.AdditionalAttributes +} + +// GetAdditionalAttributesOk returns a tuple with the AdditionalAttributes field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *User) GetAdditionalAttributesOk() (map[string]interface{}, bool) { + if o == nil || o.AdditionalAttributes == nil { + var ret map[string]interface{} + return ret, false + } + return *o.AdditionalAttributes, true +} + +// HasAdditionalAttributes returns a boolean if a field has been set. +func (o *User) HasAdditionalAttributes() bool { + if o != nil && o.AdditionalAttributes != nil { + return true + } + + return false +} + +// SetAdditionalAttributes gets a reference to the given map[string]interface{} and assigns it to the AdditionalAttributes field. +func (o *User) SetAdditionalAttributes(v map[string]interface{}) { + o.AdditionalAttributes = &v +} + type NullableUser struct { Value User ExplicitNull bool diff --git a/model_webhook.go b/model_webhook.go index d8f66a34..fa816b51 100644 --- a/model_webhook.go +++ b/model_webhook.go @@ -27,6 +27,8 @@ type Webhook struct { ApplicationIds []int32 `json:"applicationIds"` // Name or title for this webhook. Title string `json:"title"` + // A description of the webhook. + Description *string `json:"description,omitempty"` // API method for this webhook. Verb string `json:"verb"` // API URL (supports templating using parameters) for this webhook. @@ -116,6 +118,39 @@ func (o *Webhook) SetTitle(v string) { o.Title = v } +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *Webhook) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *Webhook) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *Webhook) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *Webhook) SetDescription(v string) { + o.Description = &v +} + // GetVerb returns the Verb field value func (o *Webhook) GetVerb() string { if o == nil { diff --git a/model_webhook_with_outgoing_integration_details.go b/model_webhook_with_outgoing_integration_details.go index d4fb2a61..3e72a522 100644 --- a/model_webhook_with_outgoing_integration_details.go +++ b/model_webhook_with_outgoing_integration_details.go @@ -27,6 +27,8 @@ type WebhookWithOutgoingIntegrationDetails struct { ApplicationIds []int32 `json:"applicationIds"` // Name or title for this webhook. Title string `json:"title"` + // A description of the webhook. + Description *string `json:"description,omitempty"` // API method for this webhook. Verb string `json:"verb"` // API URL (supports templating using parameters) for this webhook. @@ -122,6 +124,39 @@ func (o *WebhookWithOutgoingIntegrationDetails) SetTitle(v string) { o.Title = v } +// GetDescription returns the Description field value if set, zero value otherwise. +func (o *WebhookWithOutgoingIntegrationDetails) GetDescription() string { + if o == nil || o.Description == nil { + var ret string + return ret + } + return *o.Description +} + +// GetDescriptionOk returns a tuple with the Description field value if set, zero value otherwise +// and a boolean to check if the value has been set. +func (o *WebhookWithOutgoingIntegrationDetails) GetDescriptionOk() (string, bool) { + if o == nil || o.Description == nil { + var ret string + return ret, false + } + return *o.Description, true +} + +// HasDescription returns a boolean if a field has been set. +func (o *WebhookWithOutgoingIntegrationDetails) HasDescription() bool { + if o != nil && o.Description != nil { + return true + } + + return false +} + +// SetDescription gets a reference to the given string and assigns it to the Description field. +func (o *WebhookWithOutgoingIntegrationDetails) SetDescription(v string) { + o.Description = &v +} + // GetVerb returns the Verb field value func (o *WebhookWithOutgoingIntegrationDetails) GetVerb() string { if o == nil { From a9d06fd8b225242a3737d3deb4858115963e97b7 Mon Sep 17 00:00:00 2001 From: Vitalii Drevenchuk <4005032+Crandel@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:34:19 +0200 Subject: [PATCH 5/5] Update model go files using make apply-patches command --- go.mod | 2 +- model_application_cif_expression.go | 18 ++++++------- model_binding.go | 8 +++--- model_event.go | 8 +++--- model_generate_rule_title_rule.go | 36 ++++++++++++------------- model_new_application_cif_expression.go | 20 +++++++------- model_new_template_def.go | 8 +++--- model_rule.go | 16 +++++------ model_template_def.go | 8 +++--- 9 files changed, 62 insertions(+), 62 deletions(-) diff --git a/go.mod b/go.mod index d461c58a..b425b728 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/talon-one/talon_go +module github.com/talon-one/talon_go/v8 go 1.13 diff --git a/model_application_cif_expression.go b/model_application_cif_expression.go index 00dfd306..aa1fd3b8 100644 --- a/model_application_cif_expression.go +++ b/model_application_cif_expression.go @@ -26,7 +26,7 @@ type ApplicationCifExpression struct { // The ID of the user who created the Application cart item filter. CreatedBy *int32 `json:"createdBy,omitempty"` // Arbitrary additional JSON data associated with the Application cart item filter. - Expression *[]map[string]interface{} `json:"expression,omitempty"` + Expression []interface{} `json:"expression,omitempty"` // The ID of the application that owns this entity. ApplicationId int32 `json:"applicationId"` } @@ -128,22 +128,22 @@ func (o *ApplicationCifExpression) SetCreatedBy(v int32) { } // GetExpression returns the Expression field value if set, zero value otherwise. -func (o *ApplicationCifExpression) GetExpression() []map[string]interface{} { +func (o *ApplicationCifExpression) GetExpression() []interface{} { if o == nil || o.Expression == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } - return *o.Expression + return o.Expression } // GetExpressionOk returns a tuple with the Expression field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *ApplicationCifExpression) GetExpressionOk() ([]map[string]interface{}, bool) { +func (o *ApplicationCifExpression) GetExpressionOk() ([]interface{}, bool) { if o == nil || o.Expression == nil { - var ret []map[string]interface{} + var ret []interface{} return ret, false } - return *o.Expression, true + return o.Expression, true } // HasExpression returns a boolean if a field has been set. @@ -156,8 +156,8 @@ func (o *ApplicationCifExpression) HasExpression() bool { } // SetExpression gets a reference to the given []map[string]interface{} and assigns it to the Expression field. -func (o *ApplicationCifExpression) SetExpression(v []map[string]interface{}) { - o.Expression = &v +func (o *ApplicationCifExpression) SetExpression(v []interface{}) { + o.Expression = v } // GetApplicationId returns the ApplicationId field value diff --git a/model_binding.go b/model_binding.go index 7f2e64ec..2449ece1 100644 --- a/model_binding.go +++ b/model_binding.go @@ -21,7 +21,7 @@ type Binding struct { // The kind of binding. Possible values are: - `bundle` - `cartItemFilter` - `subledgerBalance` - `templateParameter` Type *string `json:"type,omitempty"` // A Talang expression that will be evaluated and its result attached to the name of the binding. - Expression []map[string]interface{} `json:"expression"` + Expression []interface{} `json:"expression"` // Can be one of the following: - `string` - `number` - `boolean` ValueType *string `json:"valueType,omitempty"` } @@ -75,9 +75,9 @@ func (o *Binding) SetType(v string) { } // GetExpression returns the Expression field value -func (o *Binding) GetExpression() []map[string]interface{} { +func (o *Binding) GetExpression() []interface{} { if o == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } @@ -85,7 +85,7 @@ func (o *Binding) GetExpression() []map[string]interface{} { } // SetExpression sets field value -func (o *Binding) SetExpression(v []map[string]interface{}) { +func (o *Binding) SetExpression(v []interface{}) { o.Expression = v } diff --git a/model_event.go b/model_event.go index fb541761..cb7d7e8e 100644 --- a/model_event.go +++ b/model_event.go @@ -34,7 +34,7 @@ type Event struct { // The ID of the session that this event occurred in. SessionId *string `json:"sessionId,omitempty"` // An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - Effects []map[string]interface{} `json:"effects"` + Effects [][]interface{} `json:"effects"` // Ledger entries for the event. LedgerEntries *[]LedgerEntry `json:"ledgerEntries,omitempty"` Meta *Meta `json:"meta,omitempty"` @@ -215,9 +215,9 @@ func (o *Event) SetSessionId(v string) { } // GetEffects returns the Effects field value -func (o *Event) GetEffects() []map[string]interface{} { +func (o *Event) GetEffects() [][]interface{} { if o == nil { - var ret []map[string]interface{} + var ret [][]interface{} return ret } @@ -225,7 +225,7 @@ func (o *Event) GetEffects() []map[string]interface{} { } // SetEffects sets field value -func (o *Event) SetEffects(v []map[string]interface{}) { +func (o *Event) SetEffects(v [][]interface{}) { o.Effects = v } diff --git a/model_generate_rule_title_rule.go b/model_generate_rule_title_rule.go index 418296ce..31b19b42 100644 --- a/model_generate_rule_title_rule.go +++ b/model_generate_rule_title_rule.go @@ -17,28 +17,28 @@ import ( // GenerateRuleTitleRule struct for GenerateRuleTitleRule type GenerateRuleTitleRule struct { // An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. - Effects *[]map[string]interface{} `json:"effects,omitempty"` + Effects [][]interface{} `json:"effects,omitempty"` // A Talang expression that will be evaluated in the context of the given event. - Condition *[]map[string]interface{} `json:"condition,omitempty"` + Condition []interface{} `json:"condition,omitempty"` } // GetEffects returns the Effects field value if set, zero value otherwise. -func (o *GenerateRuleTitleRule) GetEffects() []map[string]interface{} { +func (o *GenerateRuleTitleRule) GetEffects() [][]interface{} { if o == nil || o.Effects == nil { - var ret []map[string]interface{} + var ret [][]interface{} return ret } - return *o.Effects + return o.Effects } // GetEffectsOk returns a tuple with the Effects field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *GenerateRuleTitleRule) GetEffectsOk() ([]map[string]interface{}, bool) { +func (o *GenerateRuleTitleRule) GetEffectsOk() ([][]interface{}, bool) { if o == nil || o.Effects == nil { - var ret []map[string]interface{} + var ret [][]interface{} return ret, false } - return *o.Effects, true + return o.Effects, true } // HasEffects returns a boolean if a field has been set. @@ -51,27 +51,27 @@ func (o *GenerateRuleTitleRule) HasEffects() bool { } // SetEffects gets a reference to the given []map[string]interface{} and assigns it to the Effects field. -func (o *GenerateRuleTitleRule) SetEffects(v []map[string]interface{}) { - o.Effects = &v +func (o *GenerateRuleTitleRule) SetEffects(v [][]interface{}) { + o.Effects = v } // GetCondition returns the Condition field value if set, zero value otherwise. -func (o *GenerateRuleTitleRule) GetCondition() []map[string]interface{} { +func (o *GenerateRuleTitleRule) GetCondition() []interface{} { if o == nil || o.Condition == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } - return *o.Condition + return o.Condition } // GetConditionOk returns a tuple with the Condition field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *GenerateRuleTitleRule) GetConditionOk() ([]map[string]interface{}, bool) { +func (o *GenerateRuleTitleRule) GetConditionOk() ([]interface{}, bool) { if o == nil || o.Condition == nil { - var ret []map[string]interface{} + var ret []interface{} return ret, false } - return *o.Condition, true + return o.Condition, true } // HasCondition returns a boolean if a field has been set. @@ -84,8 +84,8 @@ func (o *GenerateRuleTitleRule) HasCondition() bool { } // SetCondition gets a reference to the given []map[string]interface{} and assigns it to the Condition field. -func (o *GenerateRuleTitleRule) SetCondition(v []map[string]interface{}) { - o.Condition = &v +func (o *GenerateRuleTitleRule) SetCondition(v []interface{}) { + o.Condition = v } type NullableGenerateRuleTitleRule struct { diff --git a/model_new_application_cif_expression.go b/model_new_application_cif_expression.go index 1c48dd68..546502c3 100644 --- a/model_new_application_cif_expression.go +++ b/model_new_application_cif_expression.go @@ -21,7 +21,7 @@ type NewApplicationCifExpression struct { // The ID of the user who created the Application cart item filter. CreatedBy *int32 `json:"createdBy,omitempty"` // Arbitrary additional JSON data associated with the Application cart item filter. - Expression *[]map[string]interface{} `json:"expression,omitempty"` + Expression []interface{} `json:"expression,omitempty"` } // GetCartItemFilterId returns the CartItemFilterId field value if set, zero value otherwise. @@ -91,22 +91,22 @@ func (o *NewApplicationCifExpression) SetCreatedBy(v int32) { } // GetExpression returns the Expression field value if set, zero value otherwise. -func (o *NewApplicationCifExpression) GetExpression() []map[string]interface{} { +func (o *NewApplicationCifExpression) GetExpression() []interface{} { if o == nil || o.Expression == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } - return *o.Expression + return o.Expression } // GetExpressionOk returns a tuple with the Expression field value if set, zero value otherwise // and a boolean to check if the value has been set. -func (o *NewApplicationCifExpression) GetExpressionOk() ([]map[string]interface{}, bool) { +func (o *NewApplicationCifExpression) GetExpressionOk() ([]interface{}, bool) { if o == nil || o.Expression == nil { - var ret []map[string]interface{} + var ret []interface{} return ret, false } - return *o.Expression, true + return o.Expression, true } // HasExpression returns a boolean if a field has been set. @@ -118,9 +118,9 @@ func (o *NewApplicationCifExpression) HasExpression() bool { return false } -// SetExpression gets a reference to the given []map[string]interface{} and assigns it to the Expression field. -func (o *NewApplicationCifExpression) SetExpression(v []map[string]interface{}) { - o.Expression = &v +// SetExpression gets a reference to the given []interface{} and assigns it to the Expression field. +func (o *NewApplicationCifExpression) SetExpression(v []interface{}) { + o.Expression = v } type NullableNewApplicationCifExpression struct { diff --git a/model_new_template_def.go b/model_new_template_def.go index e33c6a18..bd92bbf0 100644 --- a/model_new_template_def.go +++ b/model_new_template_def.go @@ -25,7 +25,7 @@ type NewTemplateDef struct { // Used for grouping templates in the rule editor sidebar. Category string `json:"category"` // A Talang expression that contains variable bindings referring to args. - Expr []map[string]interface{} `json:"expr"` + Expr []interface{} `json:"expr"` // An array of argument definitions. Args []TemplateArgDef `json:"args"` // A flag to control exposure in Rule Builder. @@ -129,9 +129,9 @@ func (o *NewTemplateDef) SetCategory(v string) { } // GetExpr returns the Expr field value -func (o *NewTemplateDef) GetExpr() []map[string]interface{} { +func (o *NewTemplateDef) GetExpr() []interface{} { if o == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } @@ -139,7 +139,7 @@ func (o *NewTemplateDef) GetExpr() []map[string]interface{} { } // SetExpr sets field value -func (o *NewTemplateDef) SetExpr(v []map[string]interface{}) { +func (o *NewTemplateDef) SetExpr(v []interface{}) { o.Expr = v } diff --git a/model_rule.go b/model_rule.go index acc8a36d..e2401b6f 100644 --- a/model_rule.go +++ b/model_rule.go @@ -27,9 +27,9 @@ type Rule struct { // An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array. Bindings *[]Binding `json:"bindings,omitempty"` // A Talang expression that will be evaluated in the context of the given event. - Condition []map[string]interface{} `json:"condition"` + Condition []interface{} `json:"condition"` // An array of effectful Talang expressions in arrays that will be evaluated when a rule matches. - Effects []map[string]interface{} `json:"effects"` + Effects [][]interface{} `json:"effects"` } // GetId returns the Id field value if set, zero value otherwise. @@ -180,9 +180,9 @@ func (o *Rule) SetBindings(v []Binding) { } // GetCondition returns the Condition field value -func (o *Rule) GetCondition() []map[string]interface{} { +func (o *Rule) GetCondition() []interface{} { if o == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } @@ -190,14 +190,14 @@ func (o *Rule) GetCondition() []map[string]interface{} { } // SetCondition sets field value -func (o *Rule) SetCondition(v []map[string]interface{}) { +func (o *Rule) SetCondition(v []interface{}) { o.Condition = v } // GetEffects returns the Effects field value -func (o *Rule) GetEffects() []map[string]interface{} { +func (o *Rule) GetEffects() [][]interface{} { if o == nil { - var ret []map[string]interface{} + var ret [][]interface{} return ret } @@ -205,7 +205,7 @@ func (o *Rule) GetEffects() []map[string]interface{} { } // SetEffects sets field value -func (o *Rule) SetEffects(v []map[string]interface{}) { +func (o *Rule) SetEffects(v [][]interface{}) { o.Effects = v } diff --git a/model_template_def.go b/model_template_def.go index 317c86e5..61712310 100644 --- a/model_template_def.go +++ b/model_template_def.go @@ -32,7 +32,7 @@ type TemplateDef struct { // Used for grouping templates in the rule editor sidebar. Category string `json:"category"` // A Talang expression that contains variable bindings referring to args. - Expr []map[string]interface{} `json:"expr"` + Expr []interface{} `json:"expr"` // An array of argument definitions. Args []TemplateArgDef `json:"args"` // A flag to control exposure in Rule Builder. @@ -147,9 +147,9 @@ func (o *TemplateDef) SetCategory(v string) { } // GetExpr returns the Expr field value -func (o *TemplateDef) GetExpr() []map[string]interface{} { +func (o *TemplateDef) GetExpr() []interface{} { if o == nil { - var ret []map[string]interface{} + var ret []interface{} return ret } @@ -157,7 +157,7 @@ func (o *TemplateDef) GetExpr() []map[string]interface{} { } // SetExpr sets field value -func (o *TemplateDef) SetExpr(v []map[string]interface{}) { +func (o *TemplateDef) SetExpr(v []interface{}) { o.Expr = v }