talon_one 5.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +77 -17
- data/docs/AchievementProgress.md +2 -0
- data/docs/AdditionalCampaignProperties.md +3 -1
- data/docs/AnalyticsDataPoint.md +19 -0
- data/docs/AnalyticsDataPointWithTrend.md +19 -0
- data/docs/AnalyticsDataPointWithTrendAndInfluencedRate.md +21 -0
- data/docs/AnalyticsDataPointWithTrendAndUplift.md +21 -0
- data/docs/Application.md +4 -0
- data/docs/ApplicationAnalyticsDataPoint.md +6 -6
- data/docs/ApplicationCIF.md +33 -0
- data/docs/ApplicationCIFExpression.md +27 -0
- data/docs/ApplicationCampaignAnalytics.md +13 -19
- data/docs/ApplicationCampaignStats.md +1 -3
- data/docs/AsyncCouponDeletionJobResponse.md +17 -0
- data/docs/BaseLoyaltyProgram.md +8 -4
- data/docs/BaseNotification.md +1 -1
- data/docs/BaseNotificationEntity.md +1 -1
- data/docs/Campaign.md +15 -1
- data/docs/CampaignCollectionEditedNotification.md +21 -0
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignStateChangedNotification.md +2 -2
- data/docs/CampaignStoreBudget.md +25 -0
- data/docs/CampaignVersions.md +27 -0
- data/docs/CardAddedDeductedPointsNotificationPolicy.md +19 -0
- data/docs/CartItem.md +1 -1
- data/docs/CodeGeneratorSettings.md +1 -1
- data/docs/Coupon.md +1 -1
- data/docs/CouponConstraints.md +1 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionFilters.md +43 -0
- data/docs/CouponDeletionJob.md +39 -0
- data/docs/CustomerSessionV2.md +2 -2
- data/docs/Effect.md +8 -0
- data/docs/EffectEntity.md +9 -1
- data/docs/Environment.md +3 -1
- data/docs/Event.md +1 -1
- data/docs/GenerateCampaignDescription.md +19 -0
- data/docs/GenerateCampaignTags.md +17 -0
- data/docs/GenerateItemFilterDescription.md +17 -0
- data/docs/GenerateLoyaltyCard.md +19 -0
- data/docs/GenerateRuleTitle.md +19 -0
- data/docs/GenerateRuleTitleRule.md +19 -0
- data/docs/IncreaseAchievementProgressEffectProps.md +1 -1
- data/docs/IntegrationApi.md +67 -6
- data/docs/IntegrationCoupon.md +1 -1
- data/docs/InventoryCoupon.md +1 -1
- data/docs/InventoryReferral.md +1 -1
- data/docs/LoyaltyBalanceWithTier.md +31 -0
- data/docs/LoyaltyBalancesWithTiers.md +19 -0
- data/docs/LoyaltyCard.md +6 -2
- data/docs/LoyaltyCardBatch.md +21 -0
- data/docs/LoyaltyCardBatchResponse.md +19 -0
- data/docs/LoyaltyProgram.md +14 -6
- data/docs/ManagementApi.md +1044 -69
- data/docs/MessageLogResponse.md +3 -3
- data/docs/NewAppWideCouponDeletionJob.md +19 -0
- data/docs/NewApplication.md +3 -1
- data/docs/NewApplicationCIF.md +27 -0
- data/docs/NewApplicationCIFExpression.md +21 -0
- data/docs/NewBaseNotification.md +1 -1
- data/docs/NewCouponCreationJob.md +1 -1
- data/docs/NewCouponDeletionJob.md +17 -0
- data/docs/NewCoupons.md +1 -1
- data/docs/NewCouponsForMultipleRecipients.md +1 -1
- data/docs/NewCustomerSessionV2.md +2 -2
- data/docs/NewLoyaltyProgram.md +8 -4
- data/docs/NewOutgoingIntegrationWebhook.md +2 -0
- data/docs/NewReferral.md +1 -1
- data/docs/NewReferralsForMultipleAdvocates.md +1 -1
- data/docs/NewRevisionVersion.md +37 -0
- data/docs/NewWebhook.md +2 -0
- data/docs/OktaEvent.md +19 -0
- data/docs/OktaEventPayload.md +17 -0
- data/docs/OktaEventPayloadData.md +17 -0
- data/docs/OktaEventTarget.md +21 -0
- data/docs/ProjectedTier.md +21 -0
- data/docs/Referral.md +1 -1
- data/docs/ReferralConstraints.md +1 -1
- data/docs/RejectCouponEffectProps.md +3 -1
- data/docs/RejectReferralEffectProps.md +3 -1
- data/docs/Revision.md +35 -0
- data/docs/RevisionActivation.md +17 -0
- data/docs/RevisionVersion.md +53 -0
- data/docs/RollbackIncreasedAchievementProgressEffectProps.md +27 -0
- data/docs/RuleFailureReason.md +5 -1
- data/docs/SSOConfig.md +3 -1
- data/docs/ScimBaseUser.md +23 -0
- data/docs/ScimBaseUserName.md +17 -0
- data/docs/ScimNewUser.md +23 -0
- data/docs/ScimPatchOperation.md +21 -0
- data/docs/ScimPatchRequest.md +19 -0
- data/docs/ScimResource.md +21 -0
- data/docs/ScimResourceTypesListResponse.md +17 -0
- data/docs/ScimSchemaResource.md +23 -0
- data/docs/ScimSchemasListResponse.md +21 -0
- data/docs/ScimServiceProviderConfigResponse.md +27 -0
- data/docs/ScimServiceProviderConfigResponseBulk.md +21 -0
- data/docs/ScimServiceProviderConfigResponseChangePassword.md +17 -0
- data/docs/ScimServiceProviderConfigResponseFilter.md +19 -0
- data/docs/ScimServiceProviderConfigResponsePatch.md +17 -0
- data/docs/ScimUser.md +25 -0
- data/docs/ScimUsersListResponse.md +21 -0
- data/docs/Tier.md +3 -1
- data/docs/TransferLoyaltyCard.md +3 -1
- data/docs/UpdateApplication.md +5 -1
- data/docs/UpdateApplicationCIF.md +23 -0
- data/docs/UpdateCampaign.md +1 -1
- data/docs/UpdateCoupon.md +1 -1
- data/docs/UpdateCouponBatch.md +1 -1
- data/docs/UpdateLoyaltyCard.md +4 -2
- data/docs/UpdateLoyaltyProgram.md +8 -4
- data/docs/UpdateReferral.md +1 -1
- data/docs/UpdateReferralBatch.md +1 -1
- data/docs/User.md +3 -1
- data/docs/Webhook.md +2 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
- data/lib/talon_one/api/integration_api.rb +83 -7
- data/lib/talon_one/api/management_api.rb +1127 -78
- data/lib/talon_one/models/achievement_progress.rb +16 -1
- data/lib/talon_one/models/additional_campaign_properties.rb +21 -6
- data/lib/talon_one/models/analytics_data_point.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend.rb +225 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_influenced_rate.rb +239 -0
- data/lib/talon_one/models/analytics_data_point_with_trend_and_uplift.rb +239 -0
- data/lib/talon_one/models/application.rb +21 -1
- data/lib/talon_one/models/application_analytics_data_point.rb +14 -4
- data/lib/talon_one/models/application_campaign_analytics.rb +39 -41
- data/lib/talon_one/models/application_campaign_stats.rb +1 -16
- data/lib/talon_one/models/application_cif.rb +308 -0
- data/lib/talon_one/models/application_cif_expression.rb +275 -0
- data/lib/talon_one/models/async_coupon_deletion_job_response.rb +213 -0
- data/lib/talon_one/models/attribute.rb +2 -2
- data/lib/talon_one/models/base_loyalty_program.rb +44 -25
- data/lib/talon_one/models/base_notification.rb +3 -2
- data/lib/talon_one/models/base_notification_entity.rb +1 -0
- data/lib/talon_one/models/campaign.rb +83 -6
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +235 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +16 -4
- data/lib/talon_one/models/campaign_state_changed_notification.rb +2 -2
- data/lib/talon_one/models/campaign_store_budget.rb +275 -0
- data/lib/talon_one/models/campaign_versions.rb +259 -0
- data/lib/talon_one/models/card_added_deducted_points_notification_policy.rb +269 -0
- data/lib/talon_one/models/cart_item.rb +1 -1
- data/lib/talon_one/models/code_generator_settings.rb +1 -1
- data/lib/talon_one/models/coupon.rb +1 -1
- data/lib/talon_one/models/coupon_constraints.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/coupon_deletion_filters.rb +375 -0
- data/lib/talon_one/models/coupon_deletion_job.rb +370 -0
- data/lib/talon_one/models/customer_session_v2.rb +2 -2
- data/lib/talon_one/models/effect.rb +41 -1
- data/lib/talon_one/models/effect_entity.rb +44 -4
- data/lib/talon_one/models/environment.rb +16 -4
- data/lib/talon_one/models/event.rb +0 -5
- data/lib/talon_one/models/generate_campaign_description.rb +227 -0
- data/lib/talon_one/models/generate_campaign_tags.rb +212 -0
- data/lib/talon_one/models/generate_item_filter_description.rb +214 -0
- data/lib/talon_one/models/generate_loyalty_card.rb +256 -0
- data/lib/talon_one/models/generate_rule_title.rb +226 -0
- data/lib/talon_one/models/generate_rule_title_rule.rb +221 -0
- data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +1 -1
- data/lib/talon_one/models/integration_coupon.rb +1 -1
- data/lib/talon_one/models/inventory_coupon.rb +1 -1
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +276 -0
- data/lib/talon_one/models/loyalty_balances_with_tiers.rb +219 -0
- data/lib/talon_one/models/loyalty_card.rb +25 -5
- data/lib/talon_one/models/loyalty_card_batch.rb +304 -0
- data/lib/talon_one/models/loyalty_card_batch_response.rb +227 -0
- data/lib/talon_one/models/loyalty_program.rb +70 -29
- data/lib/talon_one/models/message_log_response.rb +3 -22
- data/lib/talon_one/models/new_app_wide_coupon_deletion_job.rb +227 -0
- data/lib/talon_one/models/new_application.rb +14 -4
- data/lib/talon_one/models/new_application_cif.rb +262 -0
- data/lib/talon_one/models/new_application_cif_expression.rb +229 -0
- data/lib/talon_one/models/new_attribute.rb +2 -2
- data/lib/talon_one/models/new_base_notification.rb +1 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/new_coupon_deletion_job.rb +211 -0
- data/lib/talon_one/models/new_coupons.rb +1 -1
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +1 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +2 -2
- data/lib/talon_one/models/new_loyalty_program.rb +44 -25
- data/lib/talon_one/models/new_notification_test.rb +2 -2
- data/lib/talon_one/models/new_outgoing_integration_webhook.rb +11 -1
- data/lib/talon_one/models/new_referral.rb +1 -1
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +1 -1
- data/lib/talon_one/models/new_revision_version.rb +352 -0
- data/lib/talon_one/models/new_webhook.rb +11 -1
- data/lib/talon_one/models/okta_event.rb +229 -0
- data/lib/talon_one/models/okta_event_payload.rb +212 -0
- data/lib/talon_one/models/okta_event_payload_data.rb +214 -0
- data/lib/talon_one/models/okta_event_target.rb +243 -0
- data/lib/talon_one/models/projected_tier.rb +232 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/referral_constraints.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +14 -4
- data/lib/talon_one/models/reject_referral_effect_props.rb +14 -4
- data/lib/talon_one/models/revision.rb +319 -0
- data/lib/talon_one/models/revision_activation.rb +206 -0
- data/lib/talon_one/models/revision_version.rb +466 -0
- data/lib/talon_one/models/rollback_increased_achievement_progress_effect_props.rb +288 -0
- data/lib/talon_one/models/rule_failure_reason.rb +24 -4
- data/lib/talon_one/models/scim_base_user.rb +237 -0
- data/lib/talon_one/models/scim_base_user_name.rb +208 -0
- data/lib/talon_one/models/scim_new_user.rb +237 -0
- data/lib/talon_one/models/scim_patch_operation.rb +267 -0
- data/lib/talon_one/models/scim_patch_request.rb +226 -0
- data/lib/talon_one/models/scim_resource.rb +228 -0
- data/lib/talon_one/models/scim_resource_types_list_response.rb +214 -0
- data/lib/talon_one/models/scim_schema_resource.rb +239 -0
- data/lib/talon_one/models/scim_schemas_list_response.rb +236 -0
- data/lib/talon_one/models/scim_service_provider_config_response.rb +256 -0
- data/lib/talon_one/models/scim_service_provider_config_response_bulk.rb +228 -0
- data/lib/talon_one/models/scim_service_provider_config_response_change_password.rb +208 -0
- data/lib/talon_one/models/scim_service_provider_config_response_filter.rb +218 -0
- data/lib/talon_one/models/scim_service_provider_config_response_patch.rb +208 -0
- data/lib/talon_one/models/scim_user.rb +252 -0
- data/lib/talon_one/models/scim_users_list_response.rb +236 -0
- data/lib/talon_one/models/sso_config.rb +14 -4
- data/lib/talon_one/models/tier.rb +12 -2
- data/lib/talon_one/models/transfer_loyalty_card.rb +14 -4
- data/lib/talon_one/models/update_application.rb +24 -4
- data/lib/talon_one/models/update_application_cif.rb +237 -0
- data/lib/talon_one/models/update_campaign.rb +1 -1
- data/lib/talon_one/models/update_coupon.rb +1 -1
- data/lib/talon_one/models/update_coupon_batch.rb +1 -1
- data/lib/talon_one/models/update_loyalty_card.rb +15 -5
- data/lib/talon_one/models/update_loyalty_program.rb +44 -25
- data/lib/talon_one/models/update_referral.rb +1 -1
- data/lib/talon_one/models/update_referral_batch.rb +1 -1
- data/lib/talon_one/models/user.rb +14 -4
- data/lib/talon_one/models/webhook.rb +11 -1
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +54 -11
- data/spec/api/integration_api_spec.rb +18 -3
- data/spec/api/management_api_spec.rb +227 -23
- data/spec/models/achievement_progress_spec.rb +6 -0
- data/spec/models/additional_campaign_properties_spec.rb +7 -1
- data/spec/models/analytics_data_point_spec.rb +47 -0
- data/spec/models/analytics_data_point_with_trend_and_influenced_rate_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_and_uplift_spec.rb +53 -0
- data/spec/models/analytics_data_point_with_trend_spec.rb +47 -0
- data/spec/models/application_campaign_analytics_spec.rb +1 -19
- data/spec/models/application_campaign_stats_spec.rb +0 -6
- data/spec/models/application_cif_expression_spec.rb +71 -0
- data/spec/models/application_cif_spec.rb +89 -0
- data/spec/models/application_spec.rb +12 -0
- data/spec/models/async_coupon_deletion_job_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +18 -6
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/campaign_collection_edited_notification_spec.rb +53 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +43 -1
- data/spec/models/campaign_store_budget_spec.rb +65 -0
- data/spec/models/campaign_versions_spec.rb +71 -0
- data/spec/models/card_added_deducted_points_notification_policy_spec.rb +51 -0
- data/spec/models/coupon_deletion_filters_spec.rb +123 -0
- data/spec/models/coupon_deletion_job_spec.rb +107 -0
- data/spec/models/effect_entity_spec.rb +24 -0
- data/spec/models/effect_spec.rb +24 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/generate_campaign_description_spec.rb +47 -0
- data/spec/models/generate_campaign_tags_spec.rb +41 -0
- data/spec/models/generate_item_filter_description_spec.rb +41 -0
- data/spec/models/generate_loyalty_card_spec.rb +51 -0
- data/spec/models/generate_rule_title_rule_spec.rb +47 -0
- data/spec/models/generate_rule_title_spec.rb +47 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +83 -0
- data/spec/models/loyalty_balances_with_tiers_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_response_spec.rb +47 -0
- data/spec/models/loyalty_card_batch_spec.rb +57 -0
- data/spec/models/loyalty_card_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +30 -6
- data/spec/models/new_app_wide_coupon_deletion_job_spec.rb +47 -0
- data/spec/models/new_application_cif_expression_spec.rb +53 -0
- data/spec/models/new_application_cif_spec.rb +71 -0
- data/spec/models/new_application_spec.rb +6 -0
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_coupon_deletion_job_spec.rb +41 -0
- data/spec/models/new_loyalty_program_spec.rb +18 -6
- data/spec/models/new_notification_test_spec.rb +1 -1
- data/spec/models/new_outgoing_integration_webhook_spec.rb +6 -0
- data/spec/models/new_revision_version_spec.rb +105 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/okta_event_payload_data_spec.rb +41 -0
- data/spec/models/okta_event_payload_spec.rb +41 -0
- data/spec/models/okta_event_spec.rb +47 -0
- data/spec/models/okta_event_target_spec.rb +53 -0
- data/spec/models/projected_tier_spec.rb +53 -0
- data/spec/models/reject_coupon_effect_props_spec.rb +6 -0
- data/spec/models/reject_referral_effect_props_spec.rb +6 -0
- data/spec/models/revision_activation_spec.rb +41 -0
- data/spec/models/revision_spec.rb +95 -0
- data/spec/models/revision_version_spec.rb +153 -0
- data/spec/models/rollback_increased_achievement_progress_effect_props_spec.rb +71 -0
- data/spec/models/rule_failure_reason_spec.rb +12 -0
- data/spec/models/scim_base_user_name_spec.rb +41 -0
- data/spec/models/scim_base_user_spec.rb +59 -0
- data/spec/models/scim_new_user_spec.rb +59 -0
- data/spec/models/scim_patch_operation_spec.rb +57 -0
- data/spec/models/scim_patch_request_spec.rb +47 -0
- data/spec/models/scim_resource_spec.rb +53 -0
- data/spec/models/scim_resource_types_list_response_spec.rb +41 -0
- data/spec/models/scim_schema_resource_spec.rb +59 -0
- data/spec/models/scim_schemas_list_response_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_bulk_spec.rb +53 -0
- data/spec/models/scim_service_provider_config_response_change_password_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_filter_spec.rb +47 -0
- data/spec/models/scim_service_provider_config_response_patch_spec.rb +41 -0
- data/spec/models/scim_service_provider_config_response_spec.rb +71 -0
- data/spec/models/scim_user_spec.rb +65 -0
- data/spec/models/scim_users_list_response_spec.rb +53 -0
- data/spec/models/sso_config_spec.rb +6 -0
- data/spec/models/tier_spec.rb +6 -0
- data/spec/models/transfer_loyalty_card_spec.rb +6 -0
- data/spec/models/update_application_cif_spec.rb +59 -0
- data/spec/models/update_application_spec.rb +12 -0
- data/spec/models/update_loyalty_card_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +18 -6
- data/spec/models/user_spec.rb +6 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +219 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 879ed2b6858c69c6f604f23862981550b2074ec0fab98eecdc84e556c769c8df
|
|
4
|
+
data.tar.gz: 59e5f2af6c4a38075594b939f3b77b9c43bb31873d4dcb14954b222837762213
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7645fb707663c23e2840c5d474d17f1da80442e29b2c464665c06daeb832c090c89258280a6df15e27d52c827173bf6180da8085dc5717b0bee44401fb572aad
|
|
7
|
+
data.tar.gz: 814060b2c8160efe5e9a20e35b91bd3529cd7d15634d9b6151f640ca0674cb32844958fcfb362830d6441d0d8ec2ee0b4bbf32a692a5fd1dad3f27804c7e625c
|
data/README.md
CHANGED
|
@@ -21,7 +21,7 @@ is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}`
|
|
|
21
21
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
22
22
|
|
|
23
23
|
- API version:
|
|
24
|
-
- Package version:
|
|
24
|
+
- Package version: 6.0.0
|
|
25
25
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
26
26
|
|
|
27
27
|
## Installation
|
|
@@ -37,16 +37,16 @@ gem build talon_one.gemspec
|
|
|
37
37
|
Then either install the gem locally:
|
|
38
38
|
|
|
39
39
|
```shell
|
|
40
|
-
gem install ./talon_one-
|
|
40
|
+
gem install ./talon_one-6.0.0.gem
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
(for development, run `gem install --dev ./talon_one-
|
|
43
|
+
(for development, run `gem install --dev ./talon_one-6.0.0.gem` to install the development dependencies)
|
|
44
44
|
|
|
45
45
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
46
46
|
|
|
47
47
|
Finally add this to the Gemfile:
|
|
48
48
|
|
|
49
|
-
gem 'talon_one', '~>
|
|
49
|
+
gem 'talon_one', '~> 6.0.0'
|
|
50
50
|
|
|
51
51
|
### Install from Git
|
|
52
52
|
|
|
@@ -203,6 +203,7 @@ Class | Method | HTTP request | Description
|
|
|
203
203
|
*TalonOne::IntegrationApi* | [**delete_audience_v2**](docs/IntegrationApi.md#delete_audience_v2) | **DELETE** /v2/audiences/{audienceId} | Delete audience
|
|
204
204
|
*TalonOne::IntegrationApi* | [**delete_coupon_reservation**](docs/IntegrationApi.md#delete_coupon_reservation) | **DELETE** /v1/coupon_reservations/{couponValue} | Delete coupon reservations
|
|
205
205
|
*TalonOne::IntegrationApi* | [**delete_customer_data**](docs/IntegrationApi.md#delete_customer_data) | **DELETE** /v1/customer_data/{integrationId} | Delete customer's personal data
|
|
206
|
+
*TalonOne::IntegrationApi* | [**generate_loyalty_card**](docs/IntegrationApi.md#generate_loyalty_card) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards | Generate loyalty card
|
|
206
207
|
*TalonOne::IntegrationApi* | [**get_customer_inventory**](docs/IntegrationApi.md#get_customer_inventory) | **GET** /v1/customer_profiles/{integrationId}/inventory | List customer data
|
|
207
208
|
*TalonOne::IntegrationApi* | [**get_customer_session**](docs/IntegrationApi.md#get_customer_session) | **GET** /v2/customer_sessions/{customerSessionId} | Get customer session
|
|
208
209
|
*TalonOne::IntegrationApi* | [**get_loyalty_balances**](docs/IntegrationApi.md#get_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances | Get customer's loyalty points
|
|
@@ -223,7 +224,7 @@ Class | Method | HTTP request | Description
|
|
|
223
224
|
*TalonOne::IntegrationApi* | [**update_customer_profile_v2**](docs/IntegrationApi.md#update_customer_profile_v2) | **PUT** /v2/customer_profiles/{integrationId} | Update customer profile
|
|
224
225
|
*TalonOne::IntegrationApi* | [**update_customer_profiles_v2**](docs/IntegrationApi.md#update_customer_profiles_v2) | **PUT** /v2/customer_profiles | Update multiple customer profiles
|
|
225
226
|
*TalonOne::IntegrationApi* | [**update_customer_session_v2**](docs/IntegrationApi.md#update_customer_session_v2) | **PUT** /v2/customer_sessions/{customerSessionId} | Update customer session
|
|
226
|
-
*TalonOne::ManagementApi* | [**activate_user_by_email**](docs/ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate |
|
|
227
|
+
*TalonOne::ManagementApi* | [**activate_user_by_email**](docs/ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Enable user by email address
|
|
227
228
|
*TalonOne::ManagementApi* | [**add_loyalty_card_points**](docs/ManagementApi.md#add_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/add_points | Add points to card
|
|
228
229
|
*TalonOne::ManagementApi* | [**add_loyalty_points**](docs/ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/add_points | Add points to customer profile
|
|
229
230
|
*TalonOne::ManagementApi* | [**copy_campaign_to_applications**](docs/ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into the specified Application
|
|
@@ -231,17 +232,19 @@ Class | Method | HTTP request | Description
|
|
|
231
232
|
*TalonOne::ManagementApi* | [**create_achievement**](docs/ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
|
|
232
233
|
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
|
|
233
234
|
*TalonOne::ManagementApi* | [**create_attribute**](docs/ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
|
235
|
+
*TalonOne::ManagementApi* | [**create_batch_loyalty_cards**](docs/ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
|
234
236
|
*TalonOne::ManagementApi* | [**create_campaign_from_template**](docs/ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
|
235
237
|
*TalonOne::ManagementApi* | [**create_collection**](docs/ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
|
236
238
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
|
237
239
|
*TalonOne::ManagementApi* | [**create_coupons_async**](docs/ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
|
|
240
|
+
*TalonOne::ManagementApi* | [**create_coupons_deletion_job**](docs/ManagementApi.md#create_coupons_deletion_job) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_deletion_jobs | Creates a coupon deletion job
|
|
238
241
|
*TalonOne::ManagementApi* | [**create_coupons_for_multiple_recipients**](docs/ManagementApi.md#create_coupons_for_multiple_recipients) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_with_recipients | Create coupons for multiple recipients
|
|
239
242
|
*TalonOne::ManagementApi* | [**create_invite_email**](docs/ManagementApi.md#create_invite_email) | **POST** /v1/invite_emails | Resend invitation email
|
|
240
243
|
*TalonOne::ManagementApi* | [**create_invite_v2**](docs/ManagementApi.md#create_invite_v2) | **POST** /v2/invites | Invite user
|
|
241
244
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
|
242
245
|
*TalonOne::ManagementApi* | [**create_session**](docs/ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
|
|
243
246
|
*TalonOne::ManagementApi* | [**create_store**](docs/ManagementApi.md#create_store) | **POST** /v1/applications/{applicationId}/stores | Create store
|
|
244
|
-
*TalonOne::ManagementApi* | [**deactivate_user_by_email**](docs/ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate |
|
|
247
|
+
*TalonOne::ManagementApi* | [**deactivate_user_by_email**](docs/ManagementApi.md#deactivate_user_by_email) | **POST** /v1/users/deactivate | Disable user by email address
|
|
245
248
|
*TalonOne::ManagementApi* | [**deduct_loyalty_card_points**](docs/ManagementApi.md#deduct_loyalty_card_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/deduct_points | Deduct points from card
|
|
246
249
|
*TalonOne::ManagementApi* | [**delete_account_collection**](docs/ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
|
247
250
|
*TalonOne::ManagementApi* | [**delete_achievement**](docs/ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
|
@@ -255,9 +258,11 @@ Class | Method | HTTP request | Description
|
|
|
255
258
|
*TalonOne::ManagementApi* | [**delete_user**](docs/ManagementApi.md#delete_user) | **DELETE** /v1/users/{userId} | Delete user
|
|
256
259
|
*TalonOne::ManagementApi* | [**delete_user_by_email**](docs/ManagementApi.md#delete_user_by_email) | **POST** /v1/users/delete | Delete user by email address
|
|
257
260
|
*TalonOne::ManagementApi* | [**destroy_session**](docs/ManagementApi.md#destroy_session) | **DELETE** /v1/sessions | Destroy session
|
|
261
|
+
*TalonOne::ManagementApi* | [**disconnect_campaign_stores**](docs/ManagementApi.md#disconnect_campaign_stores) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores | Disconnect stores
|
|
258
262
|
*TalonOne::ManagementApi* | [**export_account_collection_items**](docs/ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
|
259
263
|
*TalonOne::ManagementApi* | [**export_achievements**](docs/ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
|
260
264
|
*TalonOne::ManagementApi* | [**export_audiences_memberships**](docs/ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
|
265
|
+
*TalonOne::ManagementApi* | [**export_campaign_stores**](docs/ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
|
|
261
266
|
*TalonOne::ManagementApi* | [**export_collection_items**](docs/ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
|
|
262
267
|
*TalonOne::ManagementApi* | [**export_coupons**](docs/ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
|
263
268
|
*TalonOne::ManagementApi* | [**export_customer_sessions**](docs/ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
|
|
@@ -267,6 +272,7 @@ Class | Method | HTTP request | Description
|
|
|
267
272
|
*TalonOne::ManagementApi* | [**export_loyalty_balances**](docs/ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
|
|
268
273
|
*TalonOne::ManagementApi* | [**export_loyalty_card_balances**](docs/ManagementApi.md#export_loyalty_card_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_card_balances | Export all card transaction logs
|
|
269
274
|
*TalonOne::ManagementApi* | [**export_loyalty_card_ledger**](docs/ManagementApi.md#export_loyalty_card_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/export_log | Export card's ledger log
|
|
275
|
+
*TalonOne::ManagementApi* | [**export_loyalty_cards**](docs/ManagementApi.md#export_loyalty_cards) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/export | Export loyalty cards
|
|
270
276
|
*TalonOne::ManagementApi* | [**export_loyalty_ledger**](docs/ManagementApi.md#export_loyalty_ledger) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/export_log | Export customer's transaction logs
|
|
271
277
|
*TalonOne::ManagementApi* | [**export_pool_giveaways**](docs/ManagementApi.md#export_pool_giveaways) | **GET** /v1/giveaways/pools/{poolId}/export | Export giveaway codes of a giveaway pool
|
|
272
278
|
*TalonOne::ManagementApi* | [**export_referrals**](docs/ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
|
|
@@ -336,6 +342,7 @@ Class | Method | HTTP request | Description
|
|
|
336
342
|
*TalonOne::ManagementApi* | [**import_account_collection**](docs/ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
|
337
343
|
*TalonOne::ManagementApi* | [**import_allowed_list**](docs/ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
|
338
344
|
*TalonOne::ManagementApi* | [**import_audiences_memberships**](docs/ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
|
345
|
+
*TalonOne::ManagementApi* | [**import_campaign_stores**](docs/ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
|
339
346
|
*TalonOne::ManagementApi* | [**import_collection**](docs/ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
|
340
347
|
*TalonOne::ManagementApi* | [**import_coupons**](docs/ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
|
341
348
|
*TalonOne::ManagementApi* | [**import_loyalty_cards**](docs/ManagementApi.md#import_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_cards | Import loyalty cards
|
|
@@ -352,11 +359,21 @@ Class | Method | HTTP request | Description
|
|
|
352
359
|
*TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
|
353
360
|
*TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
|
354
361
|
*TalonOne::ManagementApi* | [**notification_activation**](docs/ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
|
362
|
+
*TalonOne::ManagementApi* | [**okta_event_handler_challenge**](docs/ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
|
355
363
|
*TalonOne::ManagementApi* | [**post_added_deducted_points_notification**](docs/ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
|
|
356
364
|
*TalonOne::ManagementApi* | [**post_catalogs_strikethrough_notification**](docs/ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
|
357
365
|
*TalonOne::ManagementApi* | [**post_pending_points_notification**](docs/ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
|
358
366
|
*TalonOne::ManagementApi* | [**remove_loyalty_points**](docs/ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
|
359
367
|
*TalonOne::ManagementApi* | [**reset_password**](docs/ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
|
368
|
+
*TalonOne::ManagementApi* | [**scim_create_user**](docs/ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
|
369
|
+
*TalonOne::ManagementApi* | [**scim_delete_user**](docs/ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
|
370
|
+
*TalonOne::ManagementApi* | [**scim_get_resource_types**](docs/ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
|
371
|
+
*TalonOne::ManagementApi* | [**scim_get_schemas**](docs/ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
|
372
|
+
*TalonOne::ManagementApi* | [**scim_get_service_provider_config**](docs/ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
|
373
|
+
*TalonOne::ManagementApi* | [**scim_get_user**](docs/ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
|
374
|
+
*TalonOne::ManagementApi* | [**scim_get_users**](docs/ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
|
375
|
+
*TalonOne::ManagementApi* | [**scim_patch_user**](docs/ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
|
376
|
+
*TalonOne::ManagementApi* | [**scim_replace_user_attributes**](docs/ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
|
360
377
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_application_wide_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count)
|
|
361
378
|
*TalonOne::ManagementApi* | [**search_coupons_advanced_without_total_count**](docs/ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
|
|
362
379
|
*TalonOne::ManagementApi* | [**transfer_loyalty_card**](docs/ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
|
@@ -404,21 +421,17 @@ Class | Method | HTTP request | Description
|
|
|
404
421
|
- [TalonOne::AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md)
|
|
405
422
|
- [TalonOne::AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md)
|
|
406
423
|
- [TalonOne::AdditionalCost](docs/AdditionalCost.md)
|
|
424
|
+
- [TalonOne::AnalyticsDataPoint](docs/AnalyticsDataPoint.md)
|
|
425
|
+
- [TalonOne::AnalyticsDataPointWithTrend](docs/AnalyticsDataPointWithTrend.md)
|
|
426
|
+
- [TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate](docs/AnalyticsDataPointWithTrendAndInfluencedRate.md)
|
|
427
|
+
- [TalonOne::AnalyticsDataPointWithTrendAndUplift](docs/AnalyticsDataPointWithTrendAndUplift.md)
|
|
407
428
|
- [TalonOne::Application](docs/Application.md)
|
|
408
429
|
- [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
|
|
409
430
|
- [TalonOne::ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md)
|
|
410
|
-
- [TalonOne::ApplicationAnalyticsDataPointAvgItemsPerSession](docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md)
|
|
411
|
-
- [TalonOne::ApplicationAnalyticsDataPointAvgSessionValue](docs/ApplicationAnalyticsDataPointAvgSessionValue.md)
|
|
412
|
-
- [TalonOne::ApplicationAnalyticsDataPointSessionsCount](docs/ApplicationAnalyticsDataPointSessionsCount.md)
|
|
413
|
-
- [TalonOne::ApplicationAnalyticsDataPointTotalRevenue](docs/ApplicationAnalyticsDataPointTotalRevenue.md)
|
|
414
431
|
- [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
|
|
432
|
+
- [TalonOne::ApplicationCIF](docs/ApplicationCIF.md)
|
|
433
|
+
- [TalonOne::ApplicationCIFExpression](docs/ApplicationCIFExpression.md)
|
|
415
434
|
- [TalonOne::ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md)
|
|
416
|
-
- [TalonOne::ApplicationCampaignAnalyticsAvgItemsPerSession](docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md)
|
|
417
|
-
- [TalonOne::ApplicationCampaignAnalyticsAvgSessionValue](docs/ApplicationCampaignAnalyticsAvgSessionValue.md)
|
|
418
|
-
- [TalonOne::ApplicationCampaignAnalyticsCouponsCount](docs/ApplicationCampaignAnalyticsCouponsCount.md)
|
|
419
|
-
- [TalonOne::ApplicationCampaignAnalyticsSessionsCount](docs/ApplicationCampaignAnalyticsSessionsCount.md)
|
|
420
|
-
- [TalonOne::ApplicationCampaignAnalyticsTotalDiscounts](docs/ApplicationCampaignAnalyticsTotalDiscounts.md)
|
|
421
|
-
- [TalonOne::ApplicationCampaignAnalyticsTotalRevenue](docs/ApplicationCampaignAnalyticsTotalRevenue.md)
|
|
422
435
|
- [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md)
|
|
423
436
|
- [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md)
|
|
424
437
|
- [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md)
|
|
@@ -430,6 +443,7 @@ Class | Method | HTTP request | Description
|
|
|
430
443
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
|
431
444
|
- [TalonOne::ApplicationStoreEntity](docs/ApplicationStoreEntity.md)
|
|
432
445
|
- [TalonOne::AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md)
|
|
446
|
+
- [TalonOne::AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md)
|
|
433
447
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
434
448
|
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
435
449
|
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
@@ -455,6 +469,7 @@ Class | Method | HTTP request | Description
|
|
|
455
469
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
|
456
470
|
- [TalonOne::CampaignBudget](docs/CampaignBudget.md)
|
|
457
471
|
- [TalonOne::CampaignCollection](docs/CampaignCollection.md)
|
|
472
|
+
- [TalonOne::CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md)
|
|
458
473
|
- [TalonOne::CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md)
|
|
459
474
|
- [TalonOne::CampaignCopy](docs/CampaignCopy.md)
|
|
460
475
|
- [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
|
|
@@ -475,9 +490,12 @@ Class | Method | HTTP request | Description
|
|
|
475
490
|
- [TalonOne::CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
|
|
476
491
|
- [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
|
|
477
492
|
- [TalonOne::CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md)
|
|
493
|
+
- [TalonOne::CampaignStoreBudget](docs/CampaignStoreBudget.md)
|
|
478
494
|
- [TalonOne::CampaignTemplate](docs/CampaignTemplate.md)
|
|
479
495
|
- [TalonOne::CampaignTemplateCollection](docs/CampaignTemplateCollection.md)
|
|
480
496
|
- [TalonOne::CampaignTemplateParams](docs/CampaignTemplateParams.md)
|
|
497
|
+
- [TalonOne::CampaignVersions](docs/CampaignVersions.md)
|
|
498
|
+
- [TalonOne::CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md)
|
|
481
499
|
- [TalonOne::CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md)
|
|
482
500
|
- [TalonOne::CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md)
|
|
483
501
|
- [TalonOne::CardLedgerPointsEntryIntegrationAPI](docs/CardLedgerPointsEntryIntegrationAPI.md)
|
|
@@ -501,6 +519,8 @@ Class | Method | HTTP request | Description
|
|
|
501
519
|
- [TalonOne::CouponConstraints](docs/CouponConstraints.md)
|
|
502
520
|
- [TalonOne::CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
|
|
503
521
|
- [TalonOne::CouponCreationJob](docs/CouponCreationJob.md)
|
|
522
|
+
- [TalonOne::CouponDeletionFilters](docs/CouponDeletionFilters.md)
|
|
523
|
+
- [TalonOne::CouponDeletionJob](docs/CouponDeletionJob.md)
|
|
504
524
|
- [TalonOne::CouponLimitConfigs](docs/CouponLimitConfigs.md)
|
|
505
525
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
|
506
526
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
@@ -554,6 +574,12 @@ Class | Method | HTTP request | Description
|
|
|
554
574
|
- [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
|
|
555
575
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
|
556
576
|
- [TalonOne::FunctionDef](docs/FunctionDef.md)
|
|
577
|
+
- [TalonOne::GenerateCampaignDescription](docs/GenerateCampaignDescription.md)
|
|
578
|
+
- [TalonOne::GenerateCampaignTags](docs/GenerateCampaignTags.md)
|
|
579
|
+
- [TalonOne::GenerateItemFilterDescription](docs/GenerateItemFilterDescription.md)
|
|
580
|
+
- [TalonOne::GenerateLoyaltyCard](docs/GenerateLoyaltyCard.md)
|
|
581
|
+
- [TalonOne::GenerateRuleTitle](docs/GenerateRuleTitle.md)
|
|
582
|
+
- [TalonOne::GenerateRuleTitleRule](docs/GenerateRuleTitleRule.md)
|
|
557
583
|
- [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
|
|
558
584
|
- [TalonOne::Giveaway](docs/Giveaway.md)
|
|
559
585
|
- [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
|
|
@@ -633,9 +659,13 @@ Class | Method | HTTP request | Description
|
|
|
633
659
|
- [TalonOne::LoginParams](docs/LoginParams.md)
|
|
634
660
|
- [TalonOne::Loyalty](docs/Loyalty.md)
|
|
635
661
|
- [TalonOne::LoyaltyBalance](docs/LoyaltyBalance.md)
|
|
662
|
+
- [TalonOne::LoyaltyBalanceWithTier](docs/LoyaltyBalanceWithTier.md)
|
|
636
663
|
- [TalonOne::LoyaltyBalances](docs/LoyaltyBalances.md)
|
|
664
|
+
- [TalonOne::LoyaltyBalancesWithTiers](docs/LoyaltyBalancesWithTiers.md)
|
|
637
665
|
- [TalonOne::LoyaltyCard](docs/LoyaltyCard.md)
|
|
638
666
|
- [TalonOne::LoyaltyCardBalances](docs/LoyaltyCardBalances.md)
|
|
667
|
+
- [TalonOne::LoyaltyCardBatch](docs/LoyaltyCardBatch.md)
|
|
668
|
+
- [TalonOne::LoyaltyCardBatchResponse](docs/LoyaltyCardBatchResponse.md)
|
|
639
669
|
- [TalonOne::LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md)
|
|
640
670
|
- [TalonOne::LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md)
|
|
641
671
|
- [TalonOne::LoyaltyDashboardData](docs/LoyaltyDashboardData.md)
|
|
@@ -648,7 +678,6 @@ Class | Method | HTTP request | Description
|
|
|
648
678
|
- [TalonOne::LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md)
|
|
649
679
|
- [TalonOne::LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md)
|
|
650
680
|
- [TalonOne::LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md)
|
|
651
|
-
- [TalonOne::LoyaltyProgramSubledgers](docs/LoyaltyProgramSubledgers.md)
|
|
652
681
|
- [TalonOne::LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md)
|
|
653
682
|
- [TalonOne::LoyaltySubLedger](docs/LoyaltySubLedger.md)
|
|
654
683
|
- [TalonOne::LoyaltyTier](docs/LoyaltyTier.md)
|
|
@@ -673,8 +702,11 @@ Class | Method | HTTP request | Description
|
|
|
673
702
|
- [TalonOne::NewAccount](docs/NewAccount.md)
|
|
674
703
|
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
|
|
675
704
|
- [TalonOne::NewAdditionalCost](docs/NewAdditionalCost.md)
|
|
705
|
+
- [TalonOne::NewAppWideCouponDeletionJob](docs/NewAppWideCouponDeletionJob.md)
|
|
676
706
|
- [TalonOne::NewApplication](docs/NewApplication.md)
|
|
677
707
|
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
|
|
708
|
+
- [TalonOne::NewApplicationCIF](docs/NewApplicationCIF.md)
|
|
709
|
+
- [TalonOne::NewApplicationCIFExpression](docs/NewApplicationCIFExpression.md)
|
|
678
710
|
- [TalonOne::NewAttribute](docs/NewAttribute.md)
|
|
679
711
|
- [TalonOne::NewAudience](docs/NewAudience.md)
|
|
680
712
|
- [TalonOne::NewBaseNotification](docs/NewBaseNotification.md)
|
|
@@ -687,6 +719,7 @@ Class | Method | HTTP request | Description
|
|
|
687
719
|
- [TalonOne::NewCatalog](docs/NewCatalog.md)
|
|
688
720
|
- [TalonOne::NewCollection](docs/NewCollection.md)
|
|
689
721
|
- [TalonOne::NewCouponCreationJob](docs/NewCouponCreationJob.md)
|
|
722
|
+
- [TalonOne::NewCouponDeletionJob](docs/NewCouponDeletionJob.md)
|
|
690
723
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
|
691
724
|
- [TalonOne::NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md)
|
|
692
725
|
- [TalonOne::NewCustomEffect](docs/NewCustomEffect.md)
|
|
@@ -713,6 +746,7 @@ Class | Method | HTTP request | Description
|
|
|
713
746
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
|
714
747
|
- [TalonOne::NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md)
|
|
715
748
|
- [TalonOne::NewReturn](docs/NewReturn.md)
|
|
749
|
+
- [TalonOne::NewRevisionVersion](docs/NewRevisionVersion.md)
|
|
716
750
|
- [TalonOne::NewRole](docs/NewRole.md)
|
|
717
751
|
- [TalonOne::NewRoleV2](docs/NewRoleV2.md)
|
|
718
752
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
|
@@ -725,6 +759,10 @@ Class | Method | HTTP request | Description
|
|
|
725
759
|
- [TalonOne::NotificationActivation](docs/NotificationActivation.md)
|
|
726
760
|
- [TalonOne::NotificationListItem](docs/NotificationListItem.md)
|
|
727
761
|
- [TalonOne::NotificationTest](docs/NotificationTest.md)
|
|
762
|
+
- [TalonOne::OktaEvent](docs/OktaEvent.md)
|
|
763
|
+
- [TalonOne::OktaEventPayload](docs/OktaEventPayload.md)
|
|
764
|
+
- [TalonOne::OktaEventPayloadData](docs/OktaEventPayloadData.md)
|
|
765
|
+
- [TalonOne::OktaEventTarget](docs/OktaEventTarget.md)
|
|
728
766
|
- [TalonOne::OneTimeCode](docs/OneTimeCode.md)
|
|
729
767
|
- [TalonOne::OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md)
|
|
730
768
|
- [TalonOne::OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md)
|
|
@@ -742,6 +780,7 @@ Class | Method | HTTP request | Description
|
|
|
742
780
|
- [TalonOne::Picklist](docs/Picklist.md)
|
|
743
781
|
- [TalonOne::Product](docs/Product.md)
|
|
744
782
|
- [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
|
|
783
|
+
- [TalonOne::ProjectedTier](docs/ProjectedTier.md)
|
|
745
784
|
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
|
746
785
|
- [TalonOne::Referral](docs/Referral.md)
|
|
747
786
|
- [TalonOne::ReferralConstraints](docs/ReferralConstraints.md)
|
|
@@ -756,6 +795,9 @@ Class | Method | HTTP request | Description
|
|
|
756
795
|
- [TalonOne::ReserveCouponEffectProps](docs/ReserveCouponEffectProps.md)
|
|
757
796
|
- [TalonOne::ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md)
|
|
758
797
|
- [TalonOne::ReturnedCartItem](docs/ReturnedCartItem.md)
|
|
798
|
+
- [TalonOne::Revision](docs/Revision.md)
|
|
799
|
+
- [TalonOne::RevisionActivation](docs/RevisionActivation.md)
|
|
800
|
+
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
|
759
801
|
- [TalonOne::Role](docs/Role.md)
|
|
760
802
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
|
761
803
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
|
@@ -769,6 +811,7 @@ Class | Method | HTTP request | Description
|
|
|
769
811
|
- [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
|
|
770
812
|
- [TalonOne::RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
|
|
771
813
|
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
814
|
+
- [TalonOne::RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md)
|
|
772
815
|
- [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
|
|
773
816
|
- [TalonOne::Rule](docs/Rule.md)
|
|
774
817
|
- [TalonOne::RuleFailureReason](docs/RuleFailureReason.md)
|
|
@@ -778,6 +821,22 @@ Class | Method | HTTP request | Description
|
|
|
778
821
|
- [TalonOne::SamlConnectionInternal](docs/SamlConnectionInternal.md)
|
|
779
822
|
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
|
780
823
|
- [TalonOne::SamlLoginEndpoint](docs/SamlLoginEndpoint.md)
|
|
824
|
+
- [TalonOne::ScimBaseUser](docs/ScimBaseUser.md)
|
|
825
|
+
- [TalonOne::ScimBaseUserName](docs/ScimBaseUserName.md)
|
|
826
|
+
- [TalonOne::ScimNewUser](docs/ScimNewUser.md)
|
|
827
|
+
- [TalonOne::ScimPatchOperation](docs/ScimPatchOperation.md)
|
|
828
|
+
- [TalonOne::ScimPatchRequest](docs/ScimPatchRequest.md)
|
|
829
|
+
- [TalonOne::ScimResource](docs/ScimResource.md)
|
|
830
|
+
- [TalonOne::ScimResourceTypesListResponse](docs/ScimResourceTypesListResponse.md)
|
|
831
|
+
- [TalonOne::ScimSchemaResource](docs/ScimSchemaResource.md)
|
|
832
|
+
- [TalonOne::ScimSchemasListResponse](docs/ScimSchemasListResponse.md)
|
|
833
|
+
- [TalonOne::ScimServiceProviderConfigResponse](docs/ScimServiceProviderConfigResponse.md)
|
|
834
|
+
- [TalonOne::ScimServiceProviderConfigResponseBulk](docs/ScimServiceProviderConfigResponseBulk.md)
|
|
835
|
+
- [TalonOne::ScimServiceProviderConfigResponseChangePassword](docs/ScimServiceProviderConfigResponseChangePassword.md)
|
|
836
|
+
- [TalonOne::ScimServiceProviderConfigResponseFilter](docs/ScimServiceProviderConfigResponseFilter.md)
|
|
837
|
+
- [TalonOne::ScimServiceProviderConfigResponsePatch](docs/ScimServiceProviderConfigResponsePatch.md)
|
|
838
|
+
- [TalonOne::ScimUser](docs/ScimUser.md)
|
|
839
|
+
- [TalonOne::ScimUsersListResponse](docs/ScimUsersListResponse.md)
|
|
781
840
|
- [TalonOne::Session](docs/Session.md)
|
|
782
841
|
- [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
|
|
783
842
|
- [TalonOne::SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md)
|
|
@@ -812,6 +871,7 @@ Class | Method | HTTP request | Description
|
|
|
812
871
|
- [TalonOne::UpdateAchievement](docs/UpdateAchievement.md)
|
|
813
872
|
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
|
814
873
|
- [TalonOne::UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
|
|
874
|
+
- [TalonOne::UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
|
|
815
875
|
- [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
|
|
816
876
|
- [TalonOne::UpdateAudience](docs/UpdateAudience.md)
|
|
817
877
|
- [TalonOne::UpdateCampaign](docs/UpdateCampaign.md)
|
data/docs/AchievementProgress.md
CHANGED
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**achievement_id** | **Integer** | The internal ID of the achievement. |
|
|
8
8
|
**name** | **String** | The internal name of the achievement used in API requests. |
|
|
9
9
|
**title** | **String** | The display name of the achievement in the Campaign Manager. |
|
|
10
|
+
**description** | **String** | The description of the achievement in the Campaign Manager. |
|
|
10
11
|
**campaign_id** | **Integer** | The ID of the campaign the achievement belongs to. |
|
|
11
12
|
**status** | **String** | The status of the achievement. |
|
|
12
13
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
|
@@ -23,6 +24,7 @@ require 'TalonOne'
|
|
|
23
24
|
instance = TalonOne::AchievementProgress.new(achievement_id: 3,
|
|
24
25
|
name: FreeCoffee10Orders,
|
|
25
26
|
title: 50% off on 50th purchase.,
|
|
27
|
+
description: 50% off for every 50th purchase in a year.,
|
|
26
28
|
campaign_id: 3,
|
|
27
29
|
status: completed,
|
|
28
30
|
target: 10.0,
|
|
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**updated_by** | **String** | Name of the user who last updated this campaign if available. | [optional]
|
|
27
27
|
**template_id** | **Integer** | The ID of the Campaign Template this Campaign was created from. | [optional]
|
|
28
28
|
**frontend_state** | **String** | A campaign state described exactly as in the Campaign Manager. |
|
|
29
|
+
**stores_imported** | **Boolean** | Indicates whether the linked stores were imported via a CSV file. |
|
|
29
30
|
|
|
30
31
|
## Code Sample
|
|
31
32
|
|
|
@@ -53,7 +54,8 @@ instance = TalonOne::AdditionalCampaignProperties.new(budgets: null,
|
|
|
53
54
|
created_by: John Doe,
|
|
54
55
|
updated_by: Jane Doe,
|
|
55
56
|
template_id: 3,
|
|
56
|
-
frontend_state: running
|
|
57
|
+
frontend_state: running,
|
|
58
|
+
stores_imported: true)
|
|
57
59
|
```
|
|
58
60
|
|
|
59
61
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AnalyticsDataPoint
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total** | **Float** | |
|
|
8
|
+
**influenced** | **Float** | |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AnalyticsDataPoint.new(total: 12.0,
|
|
16
|
+
influenced: 12.0)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::AnalyticsDataPointWithTrend
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**value** | **Float** | |
|
|
8
|
+
**trend** | **Float** | |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::AnalyticsDataPointWithTrend.new(value: 12.0,
|
|
16
|
+
trend: 3.25)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**value** | **Float** | |
|
|
8
|
+
**influenced_rate** | **Float** | |
|
|
9
|
+
**trend** | **Float** | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::AnalyticsDataPointWithTrendAndInfluencedRate.new(value: 12.0,
|
|
17
|
+
influenced_rate: 12.0,
|
|
18
|
+
trend: 3.25)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::AnalyticsDataPointWithTrendAndUplift
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**value** | **Float** | |
|
|
8
|
+
**uplift** | **Float** | |
|
|
9
|
+
**trend** | **Float** | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::AnalyticsDataPointWithTrendAndUplift.new(value: 12.0,
|
|
17
|
+
uplift: 3.25,
|
|
18
|
+
trend: 3.25)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/Application.md
CHANGED
|
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
|
|
|
23
23
|
**enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
|
|
24
24
|
**default_discount_additional_cost_per_item_scope** | **String** | The default scope to apply `setDiscountPerItem` effects on if no scope was provided with the effect. | [optional]
|
|
25
25
|
**default_evaluation_group_id** | **Integer** | 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]
|
|
26
|
+
**default_cart_item_filter_id** | **Integer** | The ID of the default Cart-Item-Filter for this application. | [optional]
|
|
27
|
+
**enable_campaign_state_management** | **Boolean** | Indicates whether the campaign staging and revisions feature is enabled for the Application. **Important:** After this feature is enabled, it cannot be disabled. | [optional]
|
|
26
28
|
**loyalty_programs** | [**Array<LoyaltyProgram>**](LoyaltyProgram.md) | An array containing all the loyalty programs to which this application is subscribed. |
|
|
27
29
|
|
|
28
30
|
## Code Sample
|
|
@@ -49,6 +51,8 @@ instance = TalonOne::Application.new(id: 6,
|
|
|
49
51
|
enable_partial_discounts: false,
|
|
50
52
|
default_discount_additional_cost_per_item_scope: price,
|
|
51
53
|
default_evaluation_group_id: 3,
|
|
54
|
+
default_cart_item_filter_id: 3,
|
|
55
|
+
enable_campaign_state_management: false,
|
|
52
56
|
loyalty_programs: null)
|
|
53
57
|
```
|
|
54
58
|
|
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
|
|
8
|
-
**end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
|
|
9
|
-
**total_revenue** | [**
|
|
10
|
-
**sessions_count** | [**
|
|
11
|
-
**avg_items_per_session** | [**
|
|
12
|
-
**avg_session_value** | [**
|
|
7
|
+
**start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
|
|
8
|
+
**end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
|
|
9
|
+
**total_revenue** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
|
|
10
|
+
**sessions_count** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
|
|
11
|
+
**avg_items_per_session** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
|
|
12
|
+
**avg_session_value** | [**AnalyticsDataPoint**](AnalyticsDataPoint.md) | | [optional]
|
|
13
13
|
**total_discounts** | **Float** | The total value of discounts given for cart items in influenced sessions. | [optional]
|
|
14
14
|
**coupons_count** | **Float** | The number of times a coupon was successfully redeemed in influenced sessions. | [optional]
|
|
15
15
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# TalonOne::ApplicationCIF
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**name** | **String** | The name of the Application cart item filter used in API requests. |
|
|
10
|
+
**description** | **String** | A short description of the Application cart item filter. | [optional]
|
|
11
|
+
**active_expression_id** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional]
|
|
12
|
+
**modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional]
|
|
13
|
+
**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
|
|
14
|
+
**modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional]
|
|
15
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
16
|
+
|
|
17
|
+
## Code Sample
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'TalonOne'
|
|
21
|
+
|
|
22
|
+
instance = TalonOne::ApplicationCIF.new(id: 6,
|
|
23
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
24
|
+
name: Filter items by product,
|
|
25
|
+
description: This filter allows filtering by shoes,
|
|
26
|
+
active_expression_id: 1,
|
|
27
|
+
modified_by: 334,
|
|
28
|
+
created_by: 216,
|
|
29
|
+
modified: null,
|
|
30
|
+
application_id: 322)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# TalonOne::ApplicationCIFExpression
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | Internal ID of this entity. |
|
|
8
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
9
|
+
**cart_item_filter_id** | **Integer** | The ID of the Application cart item filter. | [optional]
|
|
10
|
+
**created_by** | **Integer** | The ID of the user who created the Application cart item filter. | [optional]
|
|
11
|
+
**expression** | **Array<Object>** | Arbitrary additional JSON data associated with the Application cart item filter. | [optional]
|
|
12
|
+
**application_id** | **Integer** | The ID of the application that owns this entity. |
|
|
13
|
+
|
|
14
|
+
## Code Sample
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'TalonOne'
|
|
18
|
+
|
|
19
|
+
instance = TalonOne::ApplicationCIFExpression.new(id: 6,
|
|
20
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
21
|
+
cart_item_filter_id: 216,
|
|
22
|
+
created_by: 216,
|
|
23
|
+
expression: {expr=[filter, [., Session, CartItems], [[Item], [catch, false, [=, [., Item, Category], Kitchen]]]]},
|
|
24
|
+
application_id: 322)
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
|
|
@@ -4,21 +4,18 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
|
|
8
|
-
**end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
|
|
9
|
-
**campaign_id** | **Integer** | The ID of the campaign. |
|
|
10
|
-
**campaign_name** | **String** | The name of the campaign. |
|
|
11
|
-
**campaign_tags** | **Array<String>** | A list of tags for the campaign. |
|
|
12
|
-
**campaign_state** | **String** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
|
|
13
|
-
**
|
|
14
|
-
**
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**
|
|
19
|
-
**avg_session_value** | [**ApplicationCampaignAnalyticsAvgSessionValue**](ApplicationCampaignAnalyticsAvgSessionValue.md) | | [optional]
|
|
20
|
-
**total_discounts** | [**ApplicationCampaignAnalyticsTotalDiscounts**](ApplicationCampaignAnalyticsTotalDiscounts.md) | | [optional]
|
|
21
|
-
**coupons_count** | [**ApplicationCampaignAnalyticsCouponsCount**](ApplicationCampaignAnalyticsCouponsCount.md) | | [optional]
|
|
7
|
+
**start_time** | **DateTime** | The start of the aggregation time frame in UTC. |
|
|
8
|
+
**end_time** | **DateTime** | The end of the aggregation time frame in UTC. |
|
|
9
|
+
**campaign_id** | **Integer** | The ID of the campaign. |
|
|
10
|
+
**campaign_name** | **String** | The name of the campaign. |
|
|
11
|
+
**campaign_tags** | **Array<String>** | A list of tags for the campaign. |
|
|
12
|
+
**campaign_state** | **String** | The state of the campaign. **Note:** A disabled or archived campaign is not evaluated for rules or coupons. |
|
|
13
|
+
**total_revenue** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
|
|
14
|
+
**sessions_count** | [**AnalyticsDataPointWithTrendAndInfluencedRate**](AnalyticsDataPointWithTrendAndInfluencedRate.md) | | [optional]
|
|
15
|
+
**avg_items_per_session** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
|
|
16
|
+
**avg_session_value** | [**AnalyticsDataPointWithTrendAndUplift**](AnalyticsDataPointWithTrendAndUplift.md) | | [optional]
|
|
17
|
+
**total_discounts** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
|
18
|
+
**coupons_count** | [**AnalyticsDataPointWithTrend**](AnalyticsDataPointWithTrend.md) | | [optional]
|
|
22
19
|
|
|
23
20
|
## Code Sample
|
|
24
21
|
|
|
@@ -30,10 +27,7 @@ instance = TalonOne::ApplicationCampaignAnalytics.new(start_time: 2024-02-01T00:
|
|
|
30
27
|
campaign_id: 1,
|
|
31
28
|
campaign_name: Summer promotions,
|
|
32
29
|
campaign_tags: [summer],
|
|
33
|
-
campaign_state:
|
|
34
|
-
campaign_active_ruleset_id: 2,
|
|
35
|
-
campaign_start_time: 2021-07-20T22:00Z,
|
|
36
|
-
campaign_end_time: 2021-10-01T02:00Z,
|
|
30
|
+
campaign_state: running,
|
|
37
31
|
total_revenue: null,
|
|
38
32
|
sessions_count: null,
|
|
39
33
|
avg_items_per_session: null,
|
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**draft** | **Integer** | Number of draft campaigns. |
|
|
8
7
|
**disabled** | **Integer** | Number of disabled campaigns. |
|
|
9
8
|
**scheduled** | **Integer** | Number of scheduled campaigns. |
|
|
10
9
|
**running** | **Integer** | Number of running campaigns. |
|
|
@@ -16,8 +15,7 @@ Name | Type | Description | Notes
|
|
|
16
15
|
```ruby
|
|
17
16
|
require 'TalonOne'
|
|
18
17
|
|
|
19
|
-
instance = TalonOne::ApplicationCampaignStats.new(
|
|
20
|
-
disabled: null,
|
|
18
|
+
instance = TalonOne::ApplicationCampaignStats.new(disabled: null,
|
|
21
19
|
scheduled: null,
|
|
22
20
|
running: null,
|
|
23
21
|
expired: null,
|