talon_one 4.0.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -0,0 +1,27 @@
|
|
1
|
+
# TalonOne::RollbackIncreasedAchievementProgressEffectProps
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**achievement_id** | **Integer** | The internal ID of the achievement. |
|
8
|
+
**achievement_name** | **String** | The name of the achievement. |
|
9
|
+
**progress_tracker_id** | **Integer** | The internal ID of the achievement progress tracker. |
|
10
|
+
**decrease_progress_by** | **Float** | The value by which the customer's current progress in the achievement is decreased. |
|
11
|
+
**current_progress** | **Float** | The current progress of the customer in the achievement. |
|
12
|
+
**target** | **Float** | The target value to complete the achievement. |
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'TalonOne'
|
18
|
+
|
19
|
+
instance = TalonOne::RollbackIncreasedAchievementProgressEffectProps.new(achievement_id: 10,
|
20
|
+
achievement_name: FreeCoffee10Orders,
|
21
|
+
progress_tracker_id: null,
|
22
|
+
decrease_progress_by: null,
|
23
|
+
current_progress: null,
|
24
|
+
target: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/RuleFailureReason.md
CHANGED
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
**condition_index** | **Integer** | The index of the condition that failed. | [optional]
|
17
17
|
**effect_index** | **Integer** | The index of the effect that failed. | [optional]
|
18
18
|
**details** | **String** | More details about the failure. | [optional]
|
19
|
+
**evaluation_group_id** | **Integer** | The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). | [optional]
|
20
|
+
**evaluation_group_mode** | **String** | The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign- | [optional]
|
19
21
|
|
20
22
|
## Code Sample
|
21
23
|
|
@@ -33,7 +35,9 @@ instance = TalonOne::RuleFailureReason.new(campaign_id: null,
|
|
33
35
|
rule_name: null,
|
34
36
|
condition_index: null,
|
35
37
|
effect_index: null,
|
36
|
-
details: null
|
38
|
+
details: null,
|
39
|
+
evaluation_group_id: 3,
|
40
|
+
evaluation_group_mode: stackable)
|
37
41
|
```
|
38
42
|
|
39
43
|
|
data/docs/SSOConfig.md
CHANGED
@@ -5,13 +5,15 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**enforced** | **Boolean** | An indication of whether single sign-on is enforced for the account. When enforced, users cannot use their email and password to sign in to Talon.One. It is not possible to change this to `false` after it is set to `true`. |
|
8
|
+
**new_acs_url** | **String** | Assertion Consumer Service (ACS) URL for setting up a new SAML connection with an identity provider like Okta or Microsoft Entra ID. | [optional]
|
8
9
|
|
9
10
|
## Code Sample
|
10
11
|
|
11
12
|
```ruby
|
12
13
|
require 'TalonOne'
|
13
14
|
|
14
|
-
instance = TalonOne::SSOConfig.new(enforced: true
|
15
|
+
instance = TalonOne::SSOConfig.new(enforced: true,
|
16
|
+
new_acs_url: https://yourdeployment.talon.one/v1/saml_connections/5/saml_callback)
|
15
17
|
```
|
16
18
|
|
17
19
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::ScimBaseUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **Boolean** | Status of the user. | [optional]
|
8
|
+
**display_name** | **String** | Display name of the user. | [optional]
|
9
|
+
**user_name** | **String** | Unique identifier of the user. This is usually an email address. | [optional]
|
10
|
+
**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::ScimBaseUser.new(active: true,
|
18
|
+
display_name: John Doe,
|
19
|
+
user_name: john.doe@example.com,
|
20
|
+
name: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::ScimBaseUserName
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**formatted** | **String** | The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::ScimBaseUserName.new(formatted: Mr. John J Doe)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/ScimNewUser.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::ScimNewUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **Boolean** | Status of the user. | [optional]
|
8
|
+
**display_name** | **String** | Display name of the user. | [optional]
|
9
|
+
**user_name** | **String** | Unique identifier of the user. This is usually an email address. | [optional]
|
10
|
+
**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::ScimNewUser.new(active: true,
|
18
|
+
display_name: John Doe,
|
19
|
+
user_name: john.doe@example.com,
|
20
|
+
name: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::ScimPatchOperation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**op** | **String** | The method that should be used in the operation. |
|
8
|
+
**path** | **String** | The path specifying the attribute that should be updated. | [optional]
|
9
|
+
**value** | **String** | The value that should be updated. Required if `op` is `add` or `replace`. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::ScimPatchOperation.new(op: null,
|
17
|
+
path: null,
|
18
|
+
value: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::ScimPatchRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**schemas** | **Array<String>** | SCIM schema for the given resource. | [optional]
|
8
|
+
**operations** | [**Array<ScimPatchOperation>**](ScimPatchOperation.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::ScimPatchRequest.new(schemas: null,
|
16
|
+
operations: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::ScimResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | ID of the resource. | [optional]
|
8
|
+
**name** | **String** | Name of the resource. | [optional]
|
9
|
+
**description** | **String** | Human-readable description of the resource. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::ScimResource.new(id: null,
|
17
|
+
name: null,
|
18
|
+
description: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::ScimResourceTypesListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**resources** | [**Array<ScimResource>**](ScimResource.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::ScimResourceTypesListResponse.new(resources: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::ScimSchemaResource
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | ID of the resource. | [optional]
|
8
|
+
**name** | **String** | Name of the resource. | [optional]
|
9
|
+
**description** | **String** | Human-readable description of the schema resource. | [optional]
|
10
|
+
**attributes** | **Array<Object>** | | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::ScimSchemaResource.new(id: null,
|
18
|
+
name: null,
|
19
|
+
description: null,
|
20
|
+
attributes: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::ScimSchemasListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**resources** | [**Array<ScimSchemaResource>**](ScimSchemaResource.md) | |
|
8
|
+
**schemas** | **Array<String>** | SCIM schema for the given resource. | [optional]
|
9
|
+
**total_results** | **Integer** | Number of total results in the response. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::ScimSchemasListResponse.new(resources: null,
|
17
|
+
schemas: null,
|
18
|
+
total_results: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# TalonOne::ScimServiceProviderConfigResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**bulk** | [**ScimServiceProviderConfigResponseBulk**](ScimServiceProviderConfigResponseBulk.md) | | [optional]
|
8
|
+
**change_password** | [**ScimServiceProviderConfigResponseChangePassword**](ScimServiceProviderConfigResponseChangePassword.md) | | [optional]
|
9
|
+
**documentation_uri** | **String** | The URI that points to the SCIM service provider's documentation, providing further details about the service's capabilities and usage. | [optional]
|
10
|
+
**filter** | [**ScimServiceProviderConfigResponseFilter**](ScimServiceProviderConfigResponseFilter.md) | | [optional]
|
11
|
+
**patch** | [**ScimServiceProviderConfigResponsePatch**](ScimServiceProviderConfigResponsePatch.md) | | [optional]
|
12
|
+
**schemas** | **Array<String>** | A list of SCIM schemas that define the structure and data types supported by the service provider. | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'TalonOne'
|
18
|
+
|
19
|
+
instance = TalonOne::ScimServiceProviderConfigResponse.new(bulk: null,
|
20
|
+
change_password: null,
|
21
|
+
documentation_uri: null,
|
22
|
+
filter: null,
|
23
|
+
patch: null,
|
24
|
+
schemas: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::ScimServiceProviderConfigResponseBulk
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**max_operations** | **Integer** | The maximum number of individual operations that can be included in a single bulk request. | [optional]
|
8
|
+
**max_payload_size** | **Integer** | The maximum size, in bytes, of the entire payload for a bulk operation request. | [optional]
|
9
|
+
**supported** | **Boolean** | Indicates whether the SCIM service provider supports bulk operations. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::ScimServiceProviderConfigResponseBulk.new(max_operations: null,
|
17
|
+
max_payload_size: null,
|
18
|
+
supported: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::ScimServiceProviderConfigResponseChangePassword
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**supported** | **Boolean** | Indicates whether the service provider supports password changes via the SCIM API. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::ScimServiceProviderConfigResponseChangePassword.new(supported: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# TalonOne::ScimServiceProviderConfigResponseFilter
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**max_results** | **Integer** | The maximum number of resources that can be returned in a single filtered query response. | [optional]
|
8
|
+
**supported** | **Boolean** | Indicates whether the SCIM service provider supports filtering operations. | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'TalonOne'
|
14
|
+
|
15
|
+
instance = TalonOne::ScimServiceProviderConfigResponseFilter.new(max_results: null,
|
16
|
+
supported: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# TalonOne::ScimServiceProviderConfigResponsePatch
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**supported** | **Boolean** | Indicates whether the service provider supports patch operations for modifying resources. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'TalonOne'
|
13
|
+
|
14
|
+
instance = TalonOne::ScimServiceProviderConfigResponsePatch.new(supported: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/ScimUser.md
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
# TalonOne::ScimUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**active** | **Boolean** | Status of the user. | [optional]
|
8
|
+
**display_name** | **String** | Display name of the user. | [optional]
|
9
|
+
**user_name** | **String** | Unique identifier of the user. This is usually an email address. | [optional]
|
10
|
+
**name** | [**ScimBaseUserName**](ScimBaseUserName.md) | | [optional]
|
11
|
+
**id** | **String** | ID of the user. |
|
12
|
+
|
13
|
+
## Code Sample
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'TalonOne'
|
17
|
+
|
18
|
+
instance = TalonOne::ScimUser.new(active: true,
|
19
|
+
display_name: John Doe,
|
20
|
+
user_name: john.doe@example.com,
|
21
|
+
name: null,
|
22
|
+
id: 359)
|
23
|
+
```
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# TalonOne::ScimUsersListResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**resources** | [**Array<ScimUser>**](ScimUser.md) | |
|
8
|
+
**schemas** | **Array<String>** | SCIM schema for the given resource. | [optional]
|
9
|
+
**total_results** | **Integer** | Number of total results in the response. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'TalonOne'
|
15
|
+
|
16
|
+
instance = TalonOne::ScimUsersListResponse.new(resources: null,
|
17
|
+
schemas: null,
|
18
|
+
total_results: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/Tier.md
CHANGED
@@ -6,8 +6,9 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**id** | **Integer** | The internal ID of the tier. |
|
8
8
|
**name** | **String** | The name of the tier. |
|
9
|
+
**start_date** | **DateTime** | Date and time when the customer moved to this tier. This value uses the loyalty program's time zone setting. | [optional]
|
9
10
|
**expiry_date** | **DateTime** | Date when tier level expires in the RFC3339 format (in the Loyalty Program's timezone). | [optional]
|
10
|
-
**downgrade_policy** | **String** |
|
11
|
+
**downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional]
|
11
12
|
|
12
13
|
## Code Sample
|
13
14
|
|
@@ -16,6 +17,7 @@ require 'TalonOne'
|
|
16
17
|
|
17
18
|
instance = TalonOne::Tier.new(id: 11,
|
18
19
|
name: bronze,
|
20
|
+
start_date: null,
|
19
21
|
expiry_date: null,
|
20
22
|
downgrade_policy: null)
|
21
23
|
```
|
data/docs/TransferLoyaltyCard.md
CHANGED
@@ -5,13 +5,15 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**new_card_identifier** | **String** | The alphanumeric identifier of the loyalty card. |
|
8
|
+
**block_reason** | **String** | Reason for transferring and blocking the loyalty card. | [optional]
|
8
9
|
|
9
10
|
## Code Sample
|
10
11
|
|
11
12
|
```ruby
|
12
13
|
require 'TalonOne'
|
13
14
|
|
14
|
-
instance = TalonOne::TransferLoyaltyCard.new(new_card_identifier: summer-loyalty-card-0543
|
15
|
+
instance = TalonOne::TransferLoyaltyCard.new(new_card_identifier: summer-loyalty-card-0543,
|
16
|
+
block_reason: Current card lost. Customer needs a new card.)
|
15
17
|
```
|
16
18
|
|
17
19
|
|
data/docs/UpdateApplication.md
CHANGED
@@ -19,6 +19,8 @@ Name | Type | Description | Notes
|
|
19
19
|
**enable_partial_discounts** | **Boolean** | Indicates if this Application supports partial discounts. | [optional]
|
20
20
|
**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]
|
21
21
|
**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]
|
22
|
+
**default_cart_item_filter_id** | **Integer** | The ID of the default Cart-Item-Filter for this application. | [optional]
|
23
|
+
**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]
|
22
24
|
|
23
25
|
## Code Sample
|
24
26
|
|
@@ -39,7 +41,9 @@ instance = TalonOne::UpdateApplication.new(name: My Application,
|
|
39
41
|
sandbox: true,
|
40
42
|
enable_partial_discounts: false,
|
41
43
|
default_discount_additional_cost_per_item_scope: price,
|
42
|
-
default_evaluation_group_id: 3
|
44
|
+
default_evaluation_group_id: 3,
|
45
|
+
default_cart_item_filter_id: 3,
|
46
|
+
enable_campaign_state_management: false)
|
43
47
|
```
|
44
48
|
|
45
49
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# TalonOne::UpdateApplicationCIF
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**description** | **String** | A short description of the Application cart item filter. | [optional]
|
8
|
+
**active_expression_id** | **Integer** | The ID of the expression that the Application cart item filter uses. | [optional]
|
9
|
+
**modified_by** | **Integer** | The ID of the user who last updated the Application cart item filter. | [optional]
|
10
|
+
**modified** | **DateTime** | Timestamp of the most recent update to the Application cart item filter. | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'TalonOne'
|
16
|
+
|
17
|
+
instance = TalonOne::UpdateApplicationCIF.new(description: This filter allows filtering by shoes,
|
18
|
+
active_expression_id: 1,
|
19
|
+
modified_by: 334,
|
20
|
+
modified: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
data/docs/UpdateCampaign.md
CHANGED
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
|
|
19
19
|
**campaign_groups** | **Array<Integer>** | The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/account-settings/managing-campaign-groups) this campaign belongs to. | [optional]
|
20
20
|
**evaluation_group_id** | **Integer** | The ID of the campaign evaluation group the campaign belongs to. | [optional]
|
21
21
|
**type** | **String** | The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. | [optional] [default to 'advanced']
|
22
|
-
**linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. | [optional]
|
22
|
+
**linked_store_ids** | **Array<Integer>** | A list of store IDs that you want to link to the campaign. **Note:** - Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store. - If you linked stores to the campaign by uploading a CSV file, you cannot use this property and it should be empty. - Use of this property is limited to 50 stores. To link more than 50 stores, upload them via a CSV file. | [optional]
|
23
23
|
|
24
24
|
## Code Sample
|
25
25
|
|
data/docs/UpdateCoupon.md
CHANGED
@@ -8,11 +8,11 @@ Name | Type | Description | Notes
|
|
8
8
|
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
9
9
|
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
10
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
11
|
-
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
|
12
12
|
**limits** | [**Array<LimitConfig>**](LimitConfig.md) | Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. | [optional]
|
13
13
|
**recipient_integration_id** | **String** | The integration ID for this coupon's beneficiary's profile. | [optional]
|
14
14
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
15
|
-
**is_reservation_mandatory** | **Boolean** |
|
15
|
+
**is_reservation_mandatory** | **Boolean** | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false]
|
16
16
|
**implicitly_reserved** | **Boolean** | An indication of whether the coupon is implicitly reserved for all customers. | [optional]
|
17
17
|
|
18
18
|
## Code Sample
|
data/docs/UpdateCouponBatch.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**discount_limit** | **Float** | The total discount value that the code can give. Typically used to represent a gift card value. | [optional]
|
9
9
|
**reservation_limit** | **Integer** | The number of reservations that can be made with this coupon code. | [optional]
|
10
10
|
**start_date** | **DateTime** | Timestamp at which point the coupon becomes valid. | [optional]
|
11
|
-
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted
|
11
|
+
**expiry_date** | **DateTime** | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional]
|
12
12
|
**attributes** | [**Object**](.md) | Optional property to set the value of custom coupon attributes. They are defined in the Campaign Manager, see [Managing attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes). Coupon attributes can also be set to _mandatory_ in your Application [settings](https://docs.talon.one/docs/product/applications/using-attributes#making-attributes-mandatory). If your Application uses mandatory attributes, you must use this property to set their value. | [optional]
|
13
13
|
**batch_id** | **String** | The ID of the batch the coupon(s) belong to. | [optional]
|
14
14
|
|
data/docs/UpdateLoyaltyCard.md
CHANGED
@@ -4,14 +4,16 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**status** | **String** | Status of the loyalty card. Can be
|
7
|
+
**status** | **String** | Status of the loyalty card. Can be `active` or `inactive`. |
|
8
|
+
**block_reason** | **String** | Reason for transferring and blocking the loyalty card. | [optional]
|
8
9
|
|
9
10
|
## Code Sample
|
10
11
|
|
11
12
|
```ruby
|
12
13
|
require 'TalonOne'
|
13
14
|
|
14
|
-
instance = TalonOne::UpdateLoyaltyCard.new(status: active
|
15
|
+
instance = TalonOne::UpdateLoyaltyCard.new(status: active,
|
16
|
+
block_reason: Current card lost. Customer needs a new card.)
|
15
17
|
```
|
16
18
|
|
17
19
|
|
@@ -12,10 +12,12 @@ Name | Type | Description | Notes
|
|
12
12
|
**allow_subledger** | **Boolean** | Indicates if this program supports subledgers inside the program. | [optional]
|
13
13
|
**users_per_card_limit** | **Integer** | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional]
|
14
14
|
**sandbox** | **Boolean** | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | [optional]
|
15
|
-
**tiers_expiration_policy** | **String** | The policy that defines which date is used to calculate the expiration date of a customer's current tier. - `tier_start_date`: The tier expiration date is calculated based on when the customer joined the current tier. - `program_join_date`: The tier expiration date is calculated based on when the customer joined the loyalty program. | [optional]
|
16
|
-
**tiers_expire_in** | **String** | The amount of time after which the tier expires. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
|
17
|
-
**tiers_downgrade_policy** | **String** | Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. | [optional]
|
18
15
|
**program_join_policy** | **String** | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. **Note**: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional]
|
16
|
+
**tiers_expiration_policy** | **String** | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. | [optional]
|
17
|
+
**tier_cycle_start_date** | **DateTime** | Timestamp at which the tier cycle starts for all customers in the loyalty program. **Note**: This is only required when the tier expiration policy is set to `absolute_expiration`. | [optional]
|
18
|
+
**tiers_expire_in** | **String** | The amount of time after which the tier expires and is reevaluated. The time format is an **integer** followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional]
|
19
|
+
**tiers_downgrade_policy** | **String** | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional]
|
20
|
+
**card_code_settings** | [**CodeGeneratorSettings**](CodeGeneratorSettings.md) | | [optional]
|
19
21
|
**tiers** | [**Array<NewLoyaltyTier>**](NewLoyaltyTier.md) | The tiers in this loyalty program. | [optional]
|
20
22
|
|
21
23
|
## Code Sample
|
@@ -31,10 +33,12 @@ instance = TalonOne::UpdateLoyaltyProgram.new(title: Point collection,
|
|
31
33
|
allow_subledger: false,
|
32
34
|
users_per_card_limit: 111,
|
33
35
|
sandbox: true,
|
36
|
+
program_join_policy: null,
|
34
37
|
tiers_expiration_policy: null,
|
38
|
+
tier_cycle_start_date: 2021-09-12T10:12:42Z,
|
35
39
|
tiers_expire_in: 27W_U,
|
36
40
|
tiers_downgrade_policy: null,
|
37
|
-
|
41
|
+
card_code_settings: null,
|
38
42
|
tiers: null)
|
39
43
|
```
|
40
44
|
|
data/docs/UpdateReferral.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**friend_profile_integration_id** | **String** | An optional Integration ID of the Friend's Profile. | [optional]
|
8
8
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
9
|
-
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted
|
9
|
+
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional]
|
10
10
|
**usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional]
|
11
11
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
12
12
|
|
data/docs/UpdateReferralBatch.md
CHANGED
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**attributes** | [**Object**](.md) | Arbitrary properties associated with this item. | [optional]
|
8
8
|
**batch_id** | **String** | The id of the batch the referral belongs to. |
|
9
9
|
**start_date** | **DateTime** | Timestamp at which point the referral code becomes valid. | [optional]
|
10
|
-
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted
|
10
|
+
**expiry_date** | **DateTime** | Expiration date of the referral code. Referral never expires if this is omitted. | [optional]
|
11
11
|
**usage_limit** | **Integer** | The number of times a referral code can be used. This can be set to 0 for no limit, but any campaign usage limits will still apply. | [optional]
|
12
12
|
|
13
13
|
## Code Sample
|
data/docs/UpdateUser.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**state** | **String** | The state of the user. - `deactivated`: The user has been deactivated. - `active`: The user is active. **Note**: Only `admin` users can update the state of another user. | [optional]
|
9
9
|
**is_admin** | **Boolean** | Indicates whether the user is an `admin`. | [optional]
|
10
10
|
**policy** | **String** | Indicates the access level of the user. | [optional]
|
11
|
-
**roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. **Note**:
|
11
|
+
**roles** | **Array<Integer>** | A list of the IDs of the roles assigned to the user. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. | [optional]
|
12
12
|
**application_notification_subscriptions** | [**Object**](.md) | Application notifications that the user is subscribed to. | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|