talon_one 4.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 +83 -18
- data/docs/AchievementProgress.md +2 -0
- data/docs/ActivateUserRequest.md +17 -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 +3 -3
- 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/CustomerInventory.md +1 -1
- 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/InlineResponse20044.md +1 -1
- data/docs/IntegrationApi.md +77 -16
- data/docs/IntegrationCoupon.md +3 -3
- data/docs/InventoryCoupon.md +3 -3
- 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/LoyaltyCardBalances.md +21 -0
- data/docs/LoyaltyCardBatch.md +21 -0
- data/docs/LoyaltyCardBatchResponse.md +19 -0
- data/docs/LoyaltyCardProfileRegistration.md +1 -1
- data/docs/LoyaltyProgram.md +14 -6
- data/docs/ManagementApi.md +1269 -176
- data/docs/MessageLogEntry.md +1 -3
- 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 +2 -2
- data/docs/NewCouponsForMultipleRecipients.md +1 -1
- data/docs/NewCustomerSessionV2.md +2 -2
- data/docs/NewExternalInvitation.md +21 -0
- 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 +2 -2
- 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/UpdateUser.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 +101 -25
- data/lib/talon_one/api/management_api.rb +1362 -189
- data/lib/talon_one/models/achievement_progress.rb +16 -1
- data/lib/talon_one/models/activate_user_request.rb +213 -0
- 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 +3 -3
- 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_inventory.rb +1 -1
- 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/inline_response20044.rb +1 -1
- data/lib/talon_one/models/integration_coupon.rb +3 -3
- data/lib/talon_one/models/inventory_coupon.rb +3 -3
- 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_balances.rb +231 -0
- 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_card_profile_registration.rb +1 -1
- data/lib/talon_one/models/loyalty_program.rb +70 -29
- data/lib/talon_one/models/message_log_entry.rb +4 -14
- 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 +2 -2
- 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_external_invitation.rb +235 -0
- 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 +2 -2
- 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/update_user.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 +57 -11
- data/spec/api/integration_api_spec.rb +25 -10
- data/spec/api/management_api_spec.rb +267 -39
- data/spec/models/achievement_progress_spec.rb +6 -0
- data/spec/models/activate_user_request_spec.rb +41 -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_balances_spec.rb +53 -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/message_log_entry_spec.rb +1 -7
- 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_external_invitation_spec.rb +53 -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 +246 -18
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,6 +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
|
|
227
|
+
*TalonOne::ManagementApi* | [**activate_user_by_email**](docs/ManagementApi.md#activate_user_by_email) | **POST** /v1/users/activate | Enable user by email address
|
|
226
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
|
|
227
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
|
|
228
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
|
|
@@ -230,17 +232,19 @@ Class | Method | HTTP request | Description
|
|
|
230
232
|
*TalonOne::ManagementApi* | [**create_achievement**](docs/ManagementApi.md#create_achievement) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | Create achievement
|
|
231
233
|
*TalonOne::ManagementApi* | [**create_additional_cost**](docs/ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Create additional cost
|
|
232
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
|
|
233
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
|
|
234
237
|
*TalonOne::ManagementApi* | [**create_collection**](docs/ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
|
235
238
|
*TalonOne::ManagementApi* | [**create_coupons**](docs/ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
|
236
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
|
|
237
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
|
|
238
242
|
*TalonOne::ManagementApi* | [**create_invite_email**](docs/ManagementApi.md#create_invite_email) | **POST** /v1/invite_emails | Resend invitation email
|
|
239
243
|
*TalonOne::ManagementApi* | [**create_invite_v2**](docs/ManagementApi.md#create_invite_v2) | **POST** /v2/invites | Invite user
|
|
240
244
|
*TalonOne::ManagementApi* | [**create_password_recovery_email**](docs/ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
|
241
245
|
*TalonOne::ManagementApi* | [**create_session**](docs/ManagementApi.md#create_session) | **POST** /v1/sessions | Create session
|
|
242
246
|
*TalonOne::ManagementApi* | [**create_store**](docs/ManagementApi.md#create_store) | **POST** /v1/applications/{applicationId}/stores | Create store
|
|
243
|
-
*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
|
|
244
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
|
|
245
249
|
*TalonOne::ManagementApi* | [**delete_account_collection**](docs/ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
|
246
250
|
*TalonOne::ManagementApi* | [**delete_achievement**](docs/ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
|
@@ -254,9 +258,11 @@ Class | Method | HTTP request | Description
|
|
|
254
258
|
*TalonOne::ManagementApi* | [**delete_user**](docs/ManagementApi.md#delete_user) | **DELETE** /v1/users/{userId} | Delete user
|
|
255
259
|
*TalonOne::ManagementApi* | [**delete_user_by_email**](docs/ManagementApi.md#delete_user_by_email) | **POST** /v1/users/delete | Delete user by email address
|
|
256
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
|
|
257
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
|
|
258
263
|
*TalonOne::ManagementApi* | [**export_achievements**](docs/ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
|
259
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
|
|
260
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
|
|
261
267
|
*TalonOne::ManagementApi* | [**export_coupons**](docs/ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
|
262
268
|
*TalonOne::ManagementApi* | [**export_customer_sessions**](docs/ManagementApi.md#export_customer_sessions) | **GET** /v1/applications/{applicationId}/export_customer_sessions | Export customer sessions
|
|
@@ -266,6 +272,7 @@ Class | Method | HTTP request | Description
|
|
|
266
272
|
*TalonOne::ManagementApi* | [**export_loyalty_balances**](docs/ManagementApi.md#export_loyalty_balances) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/export_customer_balances | Export customer loyalty balances
|
|
267
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
|
|
268
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
|
|
269
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
|
|
270
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
|
|
271
278
|
*TalonOne::ManagementApi* | [**export_referrals**](docs/ManagementApi.md#export_referrals) | **GET** /v1/applications/{applicationId}/export_referrals | Export referrals
|
|
@@ -277,7 +284,6 @@ Class | Method | HTTP request | Description
|
|
|
277
284
|
*TalonOne::ManagementApi* | [**get_additional_cost**](docs/ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get additional cost
|
|
278
285
|
*TalonOne::ManagementApi* | [**get_additional_costs**](docs/ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
|
279
286
|
*TalonOne::ManagementApi* | [**get_all_access_logs**](docs/ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | List access logs
|
|
280
|
-
*TalonOne::ManagementApi* | [**get_all_roles**](docs/ManagementApi.md#get_all_roles) | **GET** /v1/roles | List roles
|
|
281
287
|
*TalonOne::ManagementApi* | [**get_application**](docs/ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
|
282
288
|
*TalonOne::ManagementApi* | [**get_application_api_health**](docs/ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get Application health
|
|
283
289
|
*TalonOne::ManagementApi* | [**get_application_customer**](docs/ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get application's customer
|
|
@@ -323,7 +329,7 @@ Class | Method | HTTP request | Description
|
|
|
323
329
|
*TalonOne::ManagementApi* | [**get_loyalty_programs**](docs/ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
|
324
330
|
*TalonOne::ManagementApi* | [**get_loyalty_statistics**](docs/ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
|
325
331
|
*TalonOne::ManagementApi* | [**get_referrals_without_total_count**](docs/ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
|
|
326
|
-
*TalonOne::ManagementApi* | [**
|
|
332
|
+
*TalonOne::ManagementApi* | [**get_role_v2**](docs/ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
|
327
333
|
*TalonOne::ManagementApi* | [**get_ruleset**](docs/ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
|
328
334
|
*TalonOne::ManagementApi* | [**get_rulesets**](docs/ManagementApi.md#get_rulesets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets | List campaign rulesets
|
|
329
335
|
*TalonOne::ManagementApi* | [**get_store**](docs/ManagementApi.md#get_store) | **GET** /v1/applications/{applicationId}/stores/{storeId} | Get store
|
|
@@ -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
|
|
@@ -343,18 +350,30 @@ Class | Method | HTTP request | Description
|
|
|
343
350
|
*TalonOne::ManagementApi* | [**import_loyalty_points**](docs/ManagementApi.md#import_loyalty_points) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/import_points | Import loyalty points
|
|
344
351
|
*TalonOne::ManagementApi* | [**import_pool_giveaways**](docs/ManagementApi.md#import_pool_giveaways) | **POST** /v1/giveaways/pools/{poolId}/import | Import giveaway codes into a giveaway pool
|
|
345
352
|
*TalonOne::ManagementApi* | [**import_referrals**](docs/ManagementApi.md#import_referrals) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_referrals | Import referrals
|
|
353
|
+
*TalonOne::ManagementApi* | [**invite_user_external**](docs/ManagementApi.md#invite_user_external) | **POST** /v1/users/invite | Invite user from identity provider
|
|
346
354
|
*TalonOne::ManagementApi* | [**list_account_collections**](docs/ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
|
347
355
|
*TalonOne::ManagementApi* | [**list_achievements**](docs/ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
|
356
|
+
*TalonOne::ManagementApi* | [**list_all_roles_v2**](docs/ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
|
348
357
|
*TalonOne::ManagementApi* | [**list_catalog_items**](docs/ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
|
349
358
|
*TalonOne::ManagementApi* | [**list_collections**](docs/ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
|
350
359
|
*TalonOne::ManagementApi* | [**list_collections_in_application**](docs/ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
|
351
360
|
*TalonOne::ManagementApi* | [**list_stores**](docs/ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
|
352
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
|
|
353
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
|
|
354
364
|
*TalonOne::ManagementApi* | [**post_catalogs_strikethrough_notification**](docs/ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
|
355
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
|
|
356
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
|
|
357
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
|
|
358
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)
|
|
359
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)
|
|
360
379
|
*TalonOne::ManagementApi* | [**transfer_loyalty_card**](docs/ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
|
@@ -393,6 +412,7 @@ Class | Method | HTTP request | Description
|
|
|
393
412
|
- [TalonOne::Achievement](docs/Achievement.md)
|
|
394
413
|
- [TalonOne::AchievementAdditionalProperties](docs/AchievementAdditionalProperties.md)
|
|
395
414
|
- [TalonOne::AchievementProgress](docs/AchievementProgress.md)
|
|
415
|
+
- [TalonOne::ActivateUserRequest](docs/ActivateUserRequest.md)
|
|
396
416
|
- [TalonOne::AddFreeItemEffectProps](docs/AddFreeItemEffectProps.md)
|
|
397
417
|
- [TalonOne::AddItemCatalogAction](docs/AddItemCatalogAction.md)
|
|
398
418
|
- [TalonOne::AddLoyaltyPoints](docs/AddLoyaltyPoints.md)
|
|
@@ -401,21 +421,17 @@ Class | Method | HTTP request | Description
|
|
|
401
421
|
- [TalonOne::AddedDeductedPointsNotificationPolicy](docs/AddedDeductedPointsNotificationPolicy.md)
|
|
402
422
|
- [TalonOne::AdditionalCampaignProperties](docs/AdditionalCampaignProperties.md)
|
|
403
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)
|
|
404
428
|
- [TalonOne::Application](docs/Application.md)
|
|
405
429
|
- [TalonOne::ApplicationAPIKey](docs/ApplicationAPIKey.md)
|
|
406
430
|
- [TalonOne::ApplicationAnalyticsDataPoint](docs/ApplicationAnalyticsDataPoint.md)
|
|
407
|
-
- [TalonOne::ApplicationAnalyticsDataPointAvgItemsPerSession](docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md)
|
|
408
|
-
- [TalonOne::ApplicationAnalyticsDataPointAvgSessionValue](docs/ApplicationAnalyticsDataPointAvgSessionValue.md)
|
|
409
|
-
- [TalonOne::ApplicationAnalyticsDataPointSessionsCount](docs/ApplicationAnalyticsDataPointSessionsCount.md)
|
|
410
|
-
- [TalonOne::ApplicationAnalyticsDataPointTotalRevenue](docs/ApplicationAnalyticsDataPointTotalRevenue.md)
|
|
411
431
|
- [TalonOne::ApplicationApiHealth](docs/ApplicationApiHealth.md)
|
|
432
|
+
- [TalonOne::ApplicationCIF](docs/ApplicationCIF.md)
|
|
433
|
+
- [TalonOne::ApplicationCIFExpression](docs/ApplicationCIFExpression.md)
|
|
412
434
|
- [TalonOne::ApplicationCampaignAnalytics](docs/ApplicationCampaignAnalytics.md)
|
|
413
|
-
- [TalonOne::ApplicationCampaignAnalyticsAvgItemsPerSession](docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md)
|
|
414
|
-
- [TalonOne::ApplicationCampaignAnalyticsAvgSessionValue](docs/ApplicationCampaignAnalyticsAvgSessionValue.md)
|
|
415
|
-
- [TalonOne::ApplicationCampaignAnalyticsCouponsCount](docs/ApplicationCampaignAnalyticsCouponsCount.md)
|
|
416
|
-
- [TalonOne::ApplicationCampaignAnalyticsSessionsCount](docs/ApplicationCampaignAnalyticsSessionsCount.md)
|
|
417
|
-
- [TalonOne::ApplicationCampaignAnalyticsTotalDiscounts](docs/ApplicationCampaignAnalyticsTotalDiscounts.md)
|
|
418
|
-
- [TalonOne::ApplicationCampaignAnalyticsTotalRevenue](docs/ApplicationCampaignAnalyticsTotalRevenue.md)
|
|
419
435
|
- [TalonOne::ApplicationCampaignStats](docs/ApplicationCampaignStats.md)
|
|
420
436
|
- [TalonOne::ApplicationCustomer](docs/ApplicationCustomer.md)
|
|
421
437
|
- [TalonOne::ApplicationCustomerEntity](docs/ApplicationCustomerEntity.md)
|
|
@@ -427,6 +443,7 @@ Class | Method | HTTP request | Description
|
|
|
427
443
|
- [TalonOne::ApplicationSessionEntity](docs/ApplicationSessionEntity.md)
|
|
428
444
|
- [TalonOne::ApplicationStoreEntity](docs/ApplicationStoreEntity.md)
|
|
429
445
|
- [TalonOne::AsyncCouponCreationResponse](docs/AsyncCouponCreationResponse.md)
|
|
446
|
+
- [TalonOne::AsyncCouponDeletionJobResponse](docs/AsyncCouponDeletionJobResponse.md)
|
|
430
447
|
- [TalonOne::Attribute](docs/Attribute.md)
|
|
431
448
|
- [TalonOne::AttributesMandatory](docs/AttributesMandatory.md)
|
|
432
449
|
- [TalonOne::AttributesSettings](docs/AttributesSettings.md)
|
|
@@ -452,6 +469,7 @@ Class | Method | HTTP request | Description
|
|
|
452
469
|
- [TalonOne::CampaignAnalytics](docs/CampaignAnalytics.md)
|
|
453
470
|
- [TalonOne::CampaignBudget](docs/CampaignBudget.md)
|
|
454
471
|
- [TalonOne::CampaignCollection](docs/CampaignCollection.md)
|
|
472
|
+
- [TalonOne::CampaignCollectionEditedNotification](docs/CampaignCollectionEditedNotification.md)
|
|
455
473
|
- [TalonOne::CampaignCollectionWithoutPayload](docs/CampaignCollectionWithoutPayload.md)
|
|
456
474
|
- [TalonOne::CampaignCopy](docs/CampaignCopy.md)
|
|
457
475
|
- [TalonOne::CampaignCreatedNotification](docs/CampaignCreatedNotification.md)
|
|
@@ -472,9 +490,12 @@ Class | Method | HTTP request | Description
|
|
|
472
490
|
- [TalonOne::CampaignSetLeafNode](docs/CampaignSetLeafNode.md)
|
|
473
491
|
- [TalonOne::CampaignSetNode](docs/CampaignSetNode.md)
|
|
474
492
|
- [TalonOne::CampaignStateChangedNotification](docs/CampaignStateChangedNotification.md)
|
|
493
|
+
- [TalonOne::CampaignStoreBudget](docs/CampaignStoreBudget.md)
|
|
475
494
|
- [TalonOne::CampaignTemplate](docs/CampaignTemplate.md)
|
|
476
495
|
- [TalonOne::CampaignTemplateCollection](docs/CampaignTemplateCollection.md)
|
|
477
496
|
- [TalonOne::CampaignTemplateParams](docs/CampaignTemplateParams.md)
|
|
497
|
+
- [TalonOne::CampaignVersions](docs/CampaignVersions.md)
|
|
498
|
+
- [TalonOne::CardAddedDeductedPointsNotificationPolicy](docs/CardAddedDeductedPointsNotificationPolicy.md)
|
|
478
499
|
- [TalonOne::CardExpiringPointsNotificationPolicy](docs/CardExpiringPointsNotificationPolicy.md)
|
|
479
500
|
- [TalonOne::CardExpiringPointsNotificationTrigger](docs/CardExpiringPointsNotificationTrigger.md)
|
|
480
501
|
- [TalonOne::CardLedgerPointsEntryIntegrationAPI](docs/CardLedgerPointsEntryIntegrationAPI.md)
|
|
@@ -498,6 +519,8 @@ Class | Method | HTTP request | Description
|
|
|
498
519
|
- [TalonOne::CouponConstraints](docs/CouponConstraints.md)
|
|
499
520
|
- [TalonOne::CouponCreatedEffectProps](docs/CouponCreatedEffectProps.md)
|
|
500
521
|
- [TalonOne::CouponCreationJob](docs/CouponCreationJob.md)
|
|
522
|
+
- [TalonOne::CouponDeletionFilters](docs/CouponDeletionFilters.md)
|
|
523
|
+
- [TalonOne::CouponDeletionJob](docs/CouponDeletionJob.md)
|
|
501
524
|
- [TalonOne::CouponLimitConfigs](docs/CouponLimitConfigs.md)
|
|
502
525
|
- [TalonOne::CouponRejectionReason](docs/CouponRejectionReason.md)
|
|
503
526
|
- [TalonOne::CouponReservations](docs/CouponReservations.md)
|
|
@@ -551,6 +574,12 @@ Class | Method | HTTP request | Description
|
|
|
551
574
|
- [TalonOne::FeaturesFeed](docs/FeaturesFeed.md)
|
|
552
575
|
- [TalonOne::FuncArgDef](docs/FuncArgDef.md)
|
|
553
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)
|
|
554
583
|
- [TalonOne::GetIntegrationCouponRequest](docs/GetIntegrationCouponRequest.md)
|
|
555
584
|
- [TalonOne::Giveaway](docs/Giveaway.md)
|
|
556
585
|
- [TalonOne::GiveawaysPool](docs/GiveawaysPool.md)
|
|
@@ -630,8 +659,13 @@ Class | Method | HTTP request | Description
|
|
|
630
659
|
- [TalonOne::LoginParams](docs/LoginParams.md)
|
|
631
660
|
- [TalonOne::Loyalty](docs/Loyalty.md)
|
|
632
661
|
- [TalonOne::LoyaltyBalance](docs/LoyaltyBalance.md)
|
|
662
|
+
- [TalonOne::LoyaltyBalanceWithTier](docs/LoyaltyBalanceWithTier.md)
|
|
633
663
|
- [TalonOne::LoyaltyBalances](docs/LoyaltyBalances.md)
|
|
664
|
+
- [TalonOne::LoyaltyBalancesWithTiers](docs/LoyaltyBalancesWithTiers.md)
|
|
634
665
|
- [TalonOne::LoyaltyCard](docs/LoyaltyCard.md)
|
|
666
|
+
- [TalonOne::LoyaltyCardBalances](docs/LoyaltyCardBalances.md)
|
|
667
|
+
- [TalonOne::LoyaltyCardBatch](docs/LoyaltyCardBatch.md)
|
|
668
|
+
- [TalonOne::LoyaltyCardBatchResponse](docs/LoyaltyCardBatchResponse.md)
|
|
635
669
|
- [TalonOne::LoyaltyCardProfileRegistration](docs/LoyaltyCardProfileRegistration.md)
|
|
636
670
|
- [TalonOne::LoyaltyCardRegistration](docs/LoyaltyCardRegistration.md)
|
|
637
671
|
- [TalonOne::LoyaltyDashboardData](docs/LoyaltyDashboardData.md)
|
|
@@ -644,7 +678,6 @@ Class | Method | HTTP request | Description
|
|
|
644
678
|
- [TalonOne::LoyaltyProgramBalance](docs/LoyaltyProgramBalance.md)
|
|
645
679
|
- [TalonOne::LoyaltyProgramEntity](docs/LoyaltyProgramEntity.md)
|
|
646
680
|
- [TalonOne::LoyaltyProgramLedgers](docs/LoyaltyProgramLedgers.md)
|
|
647
|
-
- [TalonOne::LoyaltyProgramSubledgers](docs/LoyaltyProgramSubledgers.md)
|
|
648
681
|
- [TalonOne::LoyaltyProgramTransaction](docs/LoyaltyProgramTransaction.md)
|
|
649
682
|
- [TalonOne::LoyaltySubLedger](docs/LoyaltySubLedger.md)
|
|
650
683
|
- [TalonOne::LoyaltyTier](docs/LoyaltyTier.md)
|
|
@@ -669,8 +702,11 @@ Class | Method | HTTP request | Description
|
|
|
669
702
|
- [TalonOne::NewAccount](docs/NewAccount.md)
|
|
670
703
|
- [TalonOne::NewAccountSignUp](docs/NewAccountSignUp.md)
|
|
671
704
|
- [TalonOne::NewAdditionalCost](docs/NewAdditionalCost.md)
|
|
705
|
+
- [TalonOne::NewAppWideCouponDeletionJob](docs/NewAppWideCouponDeletionJob.md)
|
|
672
706
|
- [TalonOne::NewApplication](docs/NewApplication.md)
|
|
673
707
|
- [TalonOne::NewApplicationAPIKey](docs/NewApplicationAPIKey.md)
|
|
708
|
+
- [TalonOne::NewApplicationCIF](docs/NewApplicationCIF.md)
|
|
709
|
+
- [TalonOne::NewApplicationCIFExpression](docs/NewApplicationCIFExpression.md)
|
|
674
710
|
- [TalonOne::NewAttribute](docs/NewAttribute.md)
|
|
675
711
|
- [TalonOne::NewAudience](docs/NewAudience.md)
|
|
676
712
|
- [TalonOne::NewBaseNotification](docs/NewBaseNotification.md)
|
|
@@ -683,6 +719,7 @@ Class | Method | HTTP request | Description
|
|
|
683
719
|
- [TalonOne::NewCatalog](docs/NewCatalog.md)
|
|
684
720
|
- [TalonOne::NewCollection](docs/NewCollection.md)
|
|
685
721
|
- [TalonOne::NewCouponCreationJob](docs/NewCouponCreationJob.md)
|
|
722
|
+
- [TalonOne::NewCouponDeletionJob](docs/NewCouponDeletionJob.md)
|
|
686
723
|
- [TalonOne::NewCoupons](docs/NewCoupons.md)
|
|
687
724
|
- [TalonOne::NewCouponsForMultipleRecipients](docs/NewCouponsForMultipleRecipients.md)
|
|
688
725
|
- [TalonOne::NewCustomEffect](docs/NewCustomEffect.md)
|
|
@@ -691,6 +728,7 @@ Class | Method | HTTP request | Description
|
|
|
691
728
|
- [TalonOne::NewCustomerSessionV2](docs/NewCustomerSessionV2.md)
|
|
692
729
|
- [TalonOne::NewEvent](docs/NewEvent.md)
|
|
693
730
|
- [TalonOne::NewEventType](docs/NewEventType.md)
|
|
731
|
+
- [TalonOne::NewExternalInvitation](docs/NewExternalInvitation.md)
|
|
694
732
|
- [TalonOne::NewGiveawaysPool](docs/NewGiveawaysPool.md)
|
|
695
733
|
- [TalonOne::NewInternalAudience](docs/NewInternalAudience.md)
|
|
696
734
|
- [TalonOne::NewInvitation](docs/NewInvitation.md)
|
|
@@ -708,6 +746,7 @@ Class | Method | HTTP request | Description
|
|
|
708
746
|
- [TalonOne::NewReferral](docs/NewReferral.md)
|
|
709
747
|
- [TalonOne::NewReferralsForMultipleAdvocates](docs/NewReferralsForMultipleAdvocates.md)
|
|
710
748
|
- [TalonOne::NewReturn](docs/NewReturn.md)
|
|
749
|
+
- [TalonOne::NewRevisionVersion](docs/NewRevisionVersion.md)
|
|
711
750
|
- [TalonOne::NewRole](docs/NewRole.md)
|
|
712
751
|
- [TalonOne::NewRoleV2](docs/NewRoleV2.md)
|
|
713
752
|
- [TalonOne::NewRuleset](docs/NewRuleset.md)
|
|
@@ -720,6 +759,10 @@ Class | Method | HTTP request | Description
|
|
|
720
759
|
- [TalonOne::NotificationActivation](docs/NotificationActivation.md)
|
|
721
760
|
- [TalonOne::NotificationListItem](docs/NotificationListItem.md)
|
|
722
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)
|
|
723
766
|
- [TalonOne::OneTimeCode](docs/OneTimeCode.md)
|
|
724
767
|
- [TalonOne::OutgoingIntegrationBrazePolicy](docs/OutgoingIntegrationBrazePolicy.md)
|
|
725
768
|
- [TalonOne::OutgoingIntegrationCleverTapPolicy](docs/OutgoingIntegrationCleverTapPolicy.md)
|
|
@@ -737,6 +780,7 @@ Class | Method | HTTP request | Description
|
|
|
737
780
|
- [TalonOne::Picklist](docs/Picklist.md)
|
|
738
781
|
- [TalonOne::Product](docs/Product.md)
|
|
739
782
|
- [TalonOne::ProfileAudiencesChanges](docs/ProfileAudiencesChanges.md)
|
|
783
|
+
- [TalonOne::ProjectedTier](docs/ProjectedTier.md)
|
|
740
784
|
- [TalonOne::RedeemReferralEffectProps](docs/RedeemReferralEffectProps.md)
|
|
741
785
|
- [TalonOne::Referral](docs/Referral.md)
|
|
742
786
|
- [TalonOne::ReferralConstraints](docs/ReferralConstraints.md)
|
|
@@ -751,6 +795,9 @@ Class | Method | HTTP request | Description
|
|
|
751
795
|
- [TalonOne::ReserveCouponEffectProps](docs/ReserveCouponEffectProps.md)
|
|
752
796
|
- [TalonOne::ReturnIntegrationRequest](docs/ReturnIntegrationRequest.md)
|
|
753
797
|
- [TalonOne::ReturnedCartItem](docs/ReturnedCartItem.md)
|
|
798
|
+
- [TalonOne::Revision](docs/Revision.md)
|
|
799
|
+
- [TalonOne::RevisionActivation](docs/RevisionActivation.md)
|
|
800
|
+
- [TalonOne::RevisionVersion](docs/RevisionVersion.md)
|
|
754
801
|
- [TalonOne::Role](docs/Role.md)
|
|
755
802
|
- [TalonOne::RoleAssign](docs/RoleAssign.md)
|
|
756
803
|
- [TalonOne::RoleMembership](docs/RoleMembership.md)
|
|
@@ -764,6 +811,7 @@ Class | Method | HTTP request | Description
|
|
|
764
811
|
- [TalonOne::RollbackCouponEffectProps](docs/RollbackCouponEffectProps.md)
|
|
765
812
|
- [TalonOne::RollbackDeductedLoyaltyPointsEffectProps](docs/RollbackDeductedLoyaltyPointsEffectProps.md)
|
|
766
813
|
- [TalonOne::RollbackDiscountEffectProps](docs/RollbackDiscountEffectProps.md)
|
|
814
|
+
- [TalonOne::RollbackIncreasedAchievementProgressEffectProps](docs/RollbackIncreasedAchievementProgressEffectProps.md)
|
|
767
815
|
- [TalonOne::RollbackReferralEffectProps](docs/RollbackReferralEffectProps.md)
|
|
768
816
|
- [TalonOne::Rule](docs/Rule.md)
|
|
769
817
|
- [TalonOne::RuleFailureReason](docs/RuleFailureReason.md)
|
|
@@ -773,6 +821,22 @@ Class | Method | HTTP request | Description
|
|
|
773
821
|
- [TalonOne::SamlConnectionInternal](docs/SamlConnectionInternal.md)
|
|
774
822
|
- [TalonOne::SamlConnectionMetadata](docs/SamlConnectionMetadata.md)
|
|
775
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)
|
|
776
840
|
- [TalonOne::Session](docs/Session.md)
|
|
777
841
|
- [TalonOne::SetDiscountEffectProps](docs/SetDiscountEffectProps.md)
|
|
778
842
|
- [TalonOne::SetDiscountPerAdditionalCostEffectProps](docs/SetDiscountPerAdditionalCostEffectProps.md)
|
|
@@ -807,6 +871,7 @@ Class | Method | HTTP request | Description
|
|
|
807
871
|
- [TalonOne::UpdateAchievement](docs/UpdateAchievement.md)
|
|
808
872
|
- [TalonOne::UpdateApplication](docs/UpdateApplication.md)
|
|
809
873
|
- [TalonOne::UpdateApplicationAPIKey](docs/UpdateApplicationAPIKey.md)
|
|
874
|
+
- [TalonOne::UpdateApplicationCIF](docs/UpdateApplicationCIF.md)
|
|
810
875
|
- [TalonOne::UpdateAttributeEffectProps](docs/UpdateAttributeEffectProps.md)
|
|
811
876
|
- [TalonOne::UpdateAudience](docs/UpdateAudience.md)
|
|
812
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,
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::ActivateUserRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**email** | **String** | The email address associated with the user profile. |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::ActivateUserRequest.new(email: john.doe@example.com)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -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
|
+
|