talon_one 9.0.0 → 11.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/.github/workflows/autorelease.yml +123 -0
- data/README.md +89 -9
- data/docker-compose.yml +2 -2
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +4 -2
- data/docs/AchievementBase.md +4 -2
- data/docs/AchievementProgressWithDefinition.md +4 -2
- data/docs/AchievementStatusEntry.md +4 -2
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCustomer.md +3 -3
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +3 -3
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/BestPriorPrice.md +27 -0
- data/docs/BestPriorPriceMetadata.md +19 -0
- data/docs/BestPriorPriceRequest.md +25 -0
- data/docs/BestPriorPriceRequestTarget.md +19 -0
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDeletedNotification.md +6 -4
- data/docs/CampaignDeletedNotificationItem.md +21 -0
- data/docs/CampaignEditedNotification.md +6 -6
- data/docs/CampaignEditedNotificationItem.md +23 -0
- data/docs/CampaignEvaluationTreeChangedMessage.md +21 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignNotificationBase.md +19 -0
- data/docs/CampaignNotificationGeneric.md +21 -0
- data/docs/CampaignNotificationItemBase.md +17 -0
- data/docs/CampaignNotificationPolicy.md +1 -1
- data/docs/CampaignRulesetChangedNotification.md +6 -6
- data/docs/CampaignRulesetChangedNotificationItem.md +23 -0
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CardAddedDeductedPointsNotification.md +45 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +1 -1
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/CardLedgerTransactionLogEntry.md +3 -1
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +4 -2
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +3 -3
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +7 -1
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/ExpiringCardPointsData.md +29 -0
- data/docs/ExpiringCardPointsNotification.md +21 -0
- data/docs/ExpiringCouponsData.md +35 -0
- data/docs/ExpiringCouponsNotification.md +21 -0
- data/docs/ExpiringCouponsNotificationPolicy.md +1 -1
- data/docs/ExpiringPointsData.md +25 -0
- data/docs/ExpiringPointsNotification.md +21 -0
- data/docs/ExpiringPointsNotificationPolicy.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/ExtendedCoupon.md +61 -0
- data/docs/GenerateAuditLogSummary.md +17 -0
- data/docs/GenerateCampaignDescription.md +3 -1
- data/docs/GenerateCouponFailureDetailedSummary.md +25 -0
- data/docs/GenerateCouponFailureSummary.md +19 -0
- data/docs/GenerateUserSessionSummary.md +19 -0
- data/docs/GetIntegrationCouponRequest.md +1 -1
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +4 -2
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +2 -4
- data/docs/InlineResponse20045.md +5 -3
- data/docs/InlineResponse20046.md +2 -4
- data/docs/InlineResponse20047.md +2 -6
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +91 -6
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +1819 -339
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +29 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +5 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +25 -0
- data/docs/PriceType.md +33 -0
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeData.md +31 -0
- data/docs/TierDowngradeNotification.md +21 -0
- data/docs/TierDowngradeNotificationPolicy.md +1 -1
- data/docs/TierUpgradeData.md +35 -0
- data/docs/TierUpgradeNotification.md +21 -0
- data/docs/TierUpgradeNotificationPolicy.md +1 -1
- data/docs/TierWillDowngradeData.md +31 -0
- data/docs/TierWillDowngradeNotification.md +21 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +1 -1
- data/docs/UpdateAchievement.md +4 -2
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/User.md +1 -1
- data/docs/Webhook.md +6 -2
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +5 -1
- data/lib/talon_one/api/integration_api.rb +110 -8
- data/lib/talon_one/api/management_api.rb +1123 -429
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +15 -5
- data/lib/talon_one/models/achievement_base.rb +17 -7
- data/lib/talon_one/models/achievement_progress_with_definition.rb +17 -7
- data/lib/talon_one/models/achievement_status_entry.rb +15 -5
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/added_deducted_points_notification.rb +478 -0
- data/lib/talon_one/models/analytics_sku.rb +23 -3
- data/lib/talon_one/models/application.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +3 -3
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +3 -3
- data/lib/talon_one/models/audience_reference.rb +256 -0
- data/lib/talon_one/models/base_loyalty_program.rb +1 -1
- data/lib/talon_one/models/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.rb +1 -1
- data/lib/talon_one/models/best_prior_price.rb +285 -0
- data/lib/talon_one/models/best_prior_price_metadata.rb +219 -0
- data/lib/talon_one/models/best_prior_price_request.rb +268 -0
- data/lib/talon_one/models/best_prior_price_request_target.rb +257 -0
- data/lib/talon_one/models/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_collection_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_created_notification.rb +30 -26
- data/lib/talon_one/models/campaign_created_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +33 -21
- data/lib/talon_one/models/campaign_deleted_notification_item.rb +242 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +239 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_notification_base.rb +227 -0
- data/lib/talon_one/models/campaign_notification_generic.rb +244 -0
- data/lib/talon_one/models/campaign_notification_item_base.rb +212 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +2 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +32 -23
- data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb +245 -0
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_state_changed_notification.rb +30 -42
- data/lib/talon_one/models/campaign_state_changed_notification_item.rb +266 -0
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_template.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +510 -0
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- data/lib/talon_one/models/coupons_notification_data.rb +278 -0
- data/lib/talon_one/models/coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/create_achievement.rb +17 -7
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +3 -3
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.rb +1 -1
- data/lib/talon_one/models/deduct_loyalty_points.rb +0 -9
- data/lib/talon_one/models/delete_coupons_data.rb +310 -0
- data/lib/talon_one/models/effect.rb +31 -2
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/expiring_card_points_data.rb +342 -0
- data/lib/talon_one/models/expiring_card_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_data.rb +369 -0
- data/lib/talon_one/models/expiring_coupons_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/expiring_points_data.rb +291 -0
- data/lib/talon_one/models/expiring_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/extended_coupon.rb +578 -0
- data/lib/talon_one/models/generate_audit_log_summary.rb +212 -0
- data/lib/talon_one/models/generate_campaign_description.rb +16 -1
- data/lib/talon_one/models/generate_coupon_failure_detailed_summary.rb +286 -0
- data/lib/talon_one/models/generate_coupon_failure_summary.rb +222 -0
- data/lib/talon_one/models/generate_user_session_summary.rb +227 -0
- data/lib/talon_one/models/get_integration_coupon_request.rb +2 -0
- data/lib/talon_one/models/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +11 -7
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +7 -11
- data/lib/talon_one/models/inline_response20045.rb +11 -7
- data/lib/talon_one/models/inline_response20046.rb +2 -21
- data/lib/talon_one/models/inline_response20047.rb +2 -25
- data/lib/talon_one/models/inline_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/jwt.rb +228 -0
- data/lib/talon_one/models/label_target_audience.rb +260 -0
- data/lib/talon_one/models/label_target_none.rb +246 -0
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +17 -2
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_dashboard_data.rb +16 -1
- data/lib/talon_one/models/loyalty_ledger_entry_expiry_date_change.rb +238 -0
- data/lib/talon_one/models/loyalty_program.rb +1 -1
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- data/lib/talon_one/models/new_loyalty_program.rb +1 -1
- data/lib/talon_one/models/new_message_test.rb +28 -43
- data/lib/talon_one/models/new_price_adjustment.rb +297 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +29 -4
- data/lib/talon_one/models/pending_active_points_data.rb +308 -0
- data/lib/talon_one/models/pending_active_points_notification.rb +277 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +247 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/price_type_reference_detail.rb +286 -0
- data/lib/talon_one/models/price_type_references.rb +224 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- data/lib/talon_one/models/secondary_deployment.rb +367 -0
- data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_changed_item.rb +13 -1
- data/lib/talon_one/models/strikethrough_effect.rb +46 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +19 -4
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/tier_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_upgrade_data.rb +353 -0
- data/lib/talon_one/models/tier_upgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_will_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_will_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/update_achievement.rb +17 -7
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- data/lib/talon_one/models/update_coupons_data.rb +296 -0
- data/lib/talon_one/models/update_loyalty_program.rb +1 -1
- data/lib/talon_one/models/update_price_type.rb +239 -0
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +30 -5
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +27 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +73 -4
- data/spec/api/integration_api_spec.rb +26 -4
- data/spec/api/management_api_spec.rb +179 -51
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +7 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +7 -1
- data/spec/models/achievement_spec.rb +7 -1
- data/spec/models/achievement_status_entry_spec.rb +7 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/added_deducted_points_notification_spec.rb +125 -0
- data/spec/models/analytics_sku_spec.rb +12 -0
- data/spec/models/async_coupons_data_spec.rb +65 -0
- data/spec/models/audience_reference_spec.rb +53 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/best_prior_price_metadata_spec.rb +47 -0
- data/spec/models/best_prior_price_request_spec.rb +65 -0
- data/spec/models/best_prior_price_request_target_spec.rb +51 -0
- data/spec/models/best_prior_price_spec.rb +71 -0
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_collection_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_collection_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_created_notification_item_spec.rb +59 -0
- data/spec/models/campaign_created_notification_spec.rb +3 -3
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_item_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +53 -0
- data/spec/models/campaign_notification_base_spec.rb +47 -0
- data/spec/models/campaign_notification_generic_spec.rb +53 -0
- data/spec/models/campaign_notification_item_base_spec.rb +41 -0
- data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +59 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_state_changed_notification_item_spec.rb +65 -0
- data/spec/models/campaign_state_changed_notification_spec.rb +3 -9
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/card_added_deducted_points_notification_spec.rb +137 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +6 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +7 -1
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/expiring_card_points_data_spec.rb +77 -0
- data/spec/models/expiring_card_points_notification_spec.rb +57 -0
- data/spec/models/expiring_coupons_data_spec.rb +95 -0
- data/spec/models/expiring_coupons_notification_spec.rb +57 -0
- data/spec/models/expiring_points_data_spec.rb +65 -0
- data/spec/models/expiring_points_notification_spec.rb +57 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/extended_coupon_spec.rb +173 -0
- data/spec/models/generate_audit_log_summary_spec.rb +41 -0
- data/spec/models/generate_campaign_description_spec.rb +6 -0
- data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +65 -0
- data/spec/models/generate_coupon_failure_summary_spec.rb +47 -0
- data/spec/models/generate_user_session_summary_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +6 -0
- data/spec/models/inline_response20044_spec.rb +0 -6
- data/spec/models/inline_response20045_spec.rb +6 -0
- data/spec/models/inline_response20046_spec.rb +0 -6
- data/spec/models/inline_response20047_spec.rb +0 -12
- data/spec/models/inline_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/jwt_spec.rb +47 -0
- data/spec/models/label_target_audience_spec.rb +51 -0
- data/spec/models/label_target_none_spec.rb +45 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +53 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +10 -14
- data/spec/models/new_price_adjustment_spec.rb +77 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +12 -0
- data/spec/models/pending_active_points_data_spec.rb +77 -0
- data/spec/models/pending_active_points_notification_spec.rb +57 -0
- data/spec/models/price_detail_spec.rb +65 -0
- data/spec/models/price_type_reference_detail_spec.rb +63 -0
- data/spec/models/price_type_references_spec.rb +47 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -0
- data/spec/models/secondary_deployment_spec.rb +87 -0
- data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/strikethrough_changed_item_spec.rb +6 -0
- data/spec/models/strikethrough_effect_spec.rb +24 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/tier_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_downgrade_notification_spec.rb +57 -0
- data/spec/models/tier_upgrade_data_spec.rb +95 -0
- data/spec/models/tier_upgrade_notification_spec.rb +57 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_will_downgrade_notification_spec.rb +57 -0
- data/spec/models/update_achievement_spec.rb +7 -1
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +12 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +12 -0
- metadata +305 -3
- data/.github/dependabot.yml +0 -10
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**total_batches** | **Integer** | The total number of batches for the notification. |
|
|
12
12
|
**trigger** | [**StrikethroughTrigger**](StrikethroughTrigger.md) | |
|
|
13
13
|
**changed_items** | [**Array<StrikethroughChangedItem>**](StrikethroughChangedItem.md) | |
|
|
14
|
+
**notification_type** | **String** | The type of the notification |
|
|
14
15
|
|
|
15
16
|
## Code Sample
|
|
16
17
|
|
|
@@ -23,7 +24,8 @@ instance = TalonOne::StrikethroughLabelingNotification.new(version: null,
|
|
|
23
24
|
current_batch: 1,
|
|
24
25
|
total_batches: 10,
|
|
25
26
|
trigger: null,
|
|
26
|
-
changed_items: null
|
|
27
|
+
changed_items: null,
|
|
28
|
+
notification_type: null)
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
|
data/docs/TemplateDef.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**application_id** | **Integer** | The ID of the Application that owns this entity. |
|
|
10
10
|
**title** | **String** | Campaigner-friendly name for the template that will be shown in the rule editor. |
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::TierDowngradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was downgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. | [optional]
|
|
11
|
+
**current_points** | **Float** | The number of points the customer had at the time of tier downgrade. |
|
|
12
|
+
**old_tier** | **String** | The name of the customer's previous tier. |
|
|
13
|
+
**tier_expiration_date** | **DateTime** | The exact date and time the tier expires. | [optional]
|
|
14
|
+
**timestamp_of_tier_change** | **DateTime** | The exact date and time the tier was changed. |
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::TierDowngradeData.new(customer_profile_id: URNGV8294NV,
|
|
22
|
+
loyalty_program_id: 5,
|
|
23
|
+
subledger_id: SL001,
|
|
24
|
+
current_tier: Silver,
|
|
25
|
+
current_points: 120.55,
|
|
26
|
+
old_tier: Gold,
|
|
27
|
+
tier_expiration_date: 2023-12-01T12:23+02:00,
|
|
28
|
+
timestamp_of_tier_change: 2023-10-26T12:23+02:00)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierDowngradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierDowngradeData>**](TierDowngradeData.md) | The array of tier downgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierDowngradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the notification. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# TalonOne::TierUpgradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was upgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. |
|
|
11
|
+
**current_points** | **Float** | The number of points the customer had at the time of tier upgrade. |
|
|
12
|
+
**old_tier** | **String** | The name of the customer's previous tier. | [optional]
|
|
13
|
+
**points_required_to_the_next_tier** | **Float** | The number of points needed for a customer to reach the next tier. | [optional]
|
|
14
|
+
**next_tier** | **String** | The name of the customer's next tier. | [optional]
|
|
15
|
+
**tier_expiration_date** | **DateTime** | The exact date and time the tier expires. |
|
|
16
|
+
**timestamp_of_tier_change** | **DateTime** | The exact date and time the tier was changed. |
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'TalonOne'
|
|
22
|
+
|
|
23
|
+
instance = TalonOne::TierUpgradeData.new(customer_profile_id: URNGV8294NV,
|
|
24
|
+
loyalty_program_id: 5,
|
|
25
|
+
subledger_id: SL001,
|
|
26
|
+
current_tier: Silver,
|
|
27
|
+
current_points: 120.55,
|
|
28
|
+
old_tier: Bronze,
|
|
29
|
+
points_required_to_the_next_tier: 23.51,
|
|
30
|
+
next_tier: Gold,
|
|
31
|
+
tier_expiration_date: 2023-12-01T12:23+02:00,
|
|
32
|
+
timestamp_of_tier_change: 2023-10-26T12:23+02:00)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierUpgradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierUpgradeData>**](TierUpgradeData.md) | The array of tier upgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierUpgradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | Notification name. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
|
|
11
11
|
## Code Sample
|
|
12
12
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# TalonOne::TierWillDowngradeData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**customer_profile_id** | **String** | The integration ID of the customer profile whose tier was downgraded. |
|
|
8
|
+
**loyalty_program_id** | **Integer** | The ID of the loyalty program. |
|
|
9
|
+
**subledger_id** | **String** | The ID of the subledger, when applicable. If this field is empty, the main ledger is used. | [default to '']
|
|
10
|
+
**current_tier** | **String** | The name of the customer's current tier. |
|
|
11
|
+
**current_points** | **Float** | The number of points the customer will have after the tier downgrade. |
|
|
12
|
+
**points_required_to_remain** | **Float** | The number of points needed for a customer to remain on the same tier. |
|
|
13
|
+
**next_tier** | **String** | The name of the customer's next tier. | [optional]
|
|
14
|
+
**tier_expiration_date** | **DateTime** | The date and time the tier expires. | [optional]
|
|
15
|
+
|
|
16
|
+
## Code Sample
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'TalonOne'
|
|
20
|
+
|
|
21
|
+
instance = TalonOne::TierWillDowngradeData.new(customer_profile_id: URNGV8294NV,
|
|
22
|
+
loyalty_program_id: 5,
|
|
23
|
+
subledger_id: SL001,
|
|
24
|
+
current_tier: Silver,
|
|
25
|
+
current_points: 120.55,
|
|
26
|
+
points_required_to_remain: 23.51,
|
|
27
|
+
next_tier: Bronze,
|
|
28
|
+
tier_expiration_date: 2023-12-01T12:23+02:00)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::TierWillDowngradeNotification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_result_size** | **Integer** | |
|
|
8
|
+
**data** | [**Array<TierWillDowngradeData>**](TierWillDowngradeData.md) | The array of upcoming tier downgrade notifications. |
|
|
9
|
+
**notification_type** | **String** | The type of notification. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::TierWillDowngradeNotification.new(total_result_size: 1,
|
|
17
|
+
data: null,
|
|
18
|
+
notification_type: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
7
|
**name** | **String** | The name of the notification. |
|
|
8
8
|
**batching_enabled** | **Boolean** | Indicates whether batching is activated. | [optional] [default to true]
|
|
9
|
-
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional]
|
|
9
|
+
**batch_size** | **Integer** | The required size of each batch of data. This value applies only when `batchingEnabled` is `true`. | [optional] [default to 1000]
|
|
10
10
|
**triggers** | [**Array<TierWillDowngradeNotificationTrigger>**](TierWillDowngradeNotificationTrigger.md) | |
|
|
11
11
|
|
|
12
12
|
## Code Sample
|
data/docs/UpdateAchievement.md
CHANGED
|
@@ -10,10 +10,11 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. | [optional]
|
|
11
11
|
**period** | **String** | The relative duration after which the achievement ends and resets for a particular customer profile. **Note**: The `period` does not start when the achievement is created. The period is a **positive real number** 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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` **Note**: You can either use the round down and round up option or set an absolute period. | [optional]
|
|
12
12
|
**period_end_override** | [**TimePoint**](TimePoint.md) | | [optional]
|
|
13
|
-
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. | [optional]
|
|
13
|
+
**recurrence_policy** | **String** | The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | [optional]
|
|
14
14
|
**activation_policy** | **String** | The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. | [optional]
|
|
15
15
|
**fixed_start_date** | **DateTime** | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
16
16
|
**end_date** | **DateTime** | The achievement's end date. If defined, customers cannot participate in the achievement after this date. **Note:** It must be an RFC3339 timestamp string. | [optional]
|
|
17
|
+
**allow_rollback_after_completion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional]
|
|
17
18
|
|
|
18
19
|
## Code Sample
|
|
19
20
|
|
|
@@ -29,7 +30,8 @@ instance = TalonOne::UpdateAchievement.new(name: Order50Discount,
|
|
|
29
30
|
recurrence_policy: no_recurrence,
|
|
30
31
|
activation_policy: fixed_schedule,
|
|
31
32
|
fixed_start_date: null,
|
|
32
|
-
end_date: null
|
|
33
|
+
end_date: null,
|
|
34
|
+
allow_rollback_after_completion: false)
|
|
33
35
|
```
|
|
34
36
|
|
|
35
37
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TalonOne::UpdateCouponsData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**batch_id** | **String** | |
|
|
8
|
+
**application_id** | **Integer** | |
|
|
9
|
+
**campaign_id** | **Integer** | |
|
|
10
|
+
**type_of_change** | **String** | |
|
|
11
|
+
**operation** | **String** | |
|
|
12
|
+
**employee_name** | **String** | |
|
|
13
|
+
**notification_type** | **String** | The type of the notification |
|
|
14
|
+
|
|
15
|
+
## Code Sample
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'TalonOne'
|
|
19
|
+
|
|
20
|
+
instance = TalonOne::UpdateCouponsData.new(batch_id: null,
|
|
21
|
+
application_id: null,
|
|
22
|
+
campaign_id: null,
|
|
23
|
+
type_of_change: null,
|
|
24
|
+
operation: null,
|
|
25
|
+
employee_name: null,
|
|
26
|
+
notification_type: null)
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**description** | **String** | Description of our Loyalty Program. | [optional]
|
|
9
9
|
**subscribed_applications** | **Array<Integer>** | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional]
|
|
10
10
|
**default_validity** | **String** | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional]
|
|
11
|
-
**default_pending** | **String** | The default duration of the pending time after which points should be valid.
|
|
11
|
+
**default_pending** | **String** | The default duration of the pending time after which points should be valid. Accepted values: 'immediate', 'on_action' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | [optional]
|
|
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]
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::UpdatePriceType
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**title** | **String** | The name displayed in the Campaign Manager for the price type. |
|
|
8
|
+
**description** | **String** | A description of the price type. | [optional]
|
|
9
|
+
**targeted_audiences_ids** | **Array<Integer>** | A list of the IDs of the audiences targeted by this price type. |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::UpdatePriceType.new(title: Member Price,
|
|
17
|
+
description: The price available exclusively to members.,
|
|
18
|
+
targeted_audiences_ids: [1, 2, 3])
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
data/docs/User.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**email** | **String** | The email address associated with the user profile. |
|
data/docs/Webhook.md
CHANGED
|
@@ -4,18 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. |
|
|
11
11
|
**title** | **String** | Name or title for this webhook. |
|
|
12
12
|
**description** | **String** | A description of the webhook. | [optional]
|
|
13
|
+
**draft** | **Boolean** | Indicates if the webhook is a draft. |
|
|
13
14
|
**verb** | **String** | API method for this webhook. |
|
|
14
15
|
**url** | **String** | API URL (supports templating using parameters) for this webhook. |
|
|
15
16
|
**headers** | **Array<String>** | List of API HTTP headers for this webhook. |
|
|
16
17
|
**payload** | **String** | API payload (supports templating using parameters) for this webhook. | [optional]
|
|
17
18
|
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. |
|
|
18
19
|
**enabled** | **Boolean** | Enables or disables webhook from showing in the Rule Builder. |
|
|
20
|
+
**authentication_id** | **Integer** | The ID of the credential that this webhook is using. | [optional]
|
|
19
21
|
|
|
20
22
|
## Code Sample
|
|
21
23
|
|
|
@@ -28,6 +30,7 @@ instance = TalonOne::Webhook.new(id: 6,
|
|
|
28
30
|
application_ids: null,
|
|
29
31
|
title: Send message,
|
|
30
32
|
description: A webhook to send a coupon to the user.,
|
|
33
|
+
draft: false,
|
|
31
34
|
verb: POST,
|
|
32
35
|
url: www.my-company.com/my-endpoint-name,
|
|
33
36
|
headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],
|
|
@@ -35,7 +38,8 @@ instance = TalonOne::Webhook.new(id: 6,
|
|
|
35
38
|
"message": "${message}"
|
|
36
39
|
},
|
|
37
40
|
params: [],
|
|
38
|
-
enabled: true
|
|
41
|
+
enabled: true,
|
|
42
|
+
authentication_id: 1)
|
|
39
43
|
```
|
|
40
44
|
|
|
41
45
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# TalonOne::WebhookAuthentication
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**created_by** | **String** | The name of the user who created the webhook authentication. |
|
|
8
|
+
**modified_by** | **String** | The name of the user who last modified the webhook authentication. |
|
|
9
|
+
**webhooks** | [**Array<WebhookAuthenticationWebhookRef>**](WebhookAuthenticationWebhookRef.md) | |
|
|
10
|
+
**name** | **String** | The name of the webhook authentication. |
|
|
11
|
+
**type** | **String** | |
|
|
12
|
+
**data** | [**Object**](.md) | |
|
|
13
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
14
|
+
**created** | **DateTime** | The time this entity was created. |
|
|
15
|
+
**modified** | **DateTime** | The time this entity was last modified. |
|
|
16
|
+
|
|
17
|
+
## Code Sample
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'TalonOne'
|
|
21
|
+
|
|
22
|
+
instance = TalonOne::WebhookAuthentication.new(created_by: null,
|
|
23
|
+
modified_by: null,
|
|
24
|
+
webhooks: null,
|
|
25
|
+
name: My basic auth,
|
|
26
|
+
type: null,
|
|
27
|
+
data: null,
|
|
28
|
+
id: 6,
|
|
29
|
+
created: 2020-06-10T09:05:27.993483Z,
|
|
30
|
+
modified: 2021-09-12T10:12:42Z)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::WebhookAuthenticationBase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | The name of the webhook authentication. |
|
|
8
|
+
**type** | **String** | |
|
|
9
|
+
**data** | [**Object**](.md) | |
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::WebhookAuthenticationBase.new(name: My basic auth,
|
|
17
|
+
type: null,
|
|
18
|
+
data: null)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TalonOne::WebhookAuthenticationDataBasic
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**username** | **String** | The Basic HTTP username. |
|
|
8
|
+
**password** | **String** | The Basic HTTP password. |
|
|
9
|
+
|
|
10
|
+
## Code Sample
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'TalonOne'
|
|
14
|
+
|
|
15
|
+
instance = TalonOne::WebhookAuthenticationDataBasic.new(username: null,
|
|
16
|
+
password: null)
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TalonOne::WebhookAuthenticationDataCustom
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**headers** | **Hash<String, String>** | |
|
|
8
|
+
|
|
9
|
+
## Code Sample
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'TalonOne'
|
|
13
|
+
|
|
14
|
+
instance = TalonOne::WebhookAuthenticationDataCustom.new(headers: null)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# TalonOne::WebhookAuthenticationWebhookRef
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
|
+
**title** | **String** | The title of the webhook authentication. |
|
|
9
|
+
**description** | **String** | A description of the webhook authentication. | [optional]
|
|
10
|
+
|
|
11
|
+
## Code Sample
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'TalonOne'
|
|
15
|
+
|
|
16
|
+
instance = TalonOne::WebhookAuthenticationWebhookRef.new(id: 6,
|
|
17
|
+
title: Send message,
|
|
18
|
+
description: A webhook to send a coupon to the user.)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
|
|
@@ -4,18 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**id** | **Integer** |
|
|
7
|
+
**id** | **Integer** | The internal ID of this entity. |
|
|
8
8
|
**created** | **DateTime** | The time this entity was created. |
|
|
9
9
|
**modified** | **DateTime** | The time this entity was last modified. |
|
|
10
10
|
**application_ids** | **Array<Integer>** | The IDs of the Applications in which this webhook is available. An empty array means the webhook is available in `All Applications`. |
|
|
11
11
|
**title** | **String** | Name or title for this webhook. |
|
|
12
12
|
**description** | **String** | A description of the webhook. | [optional]
|
|
13
|
+
**draft** | **Boolean** | Indicates if the webhook is a draft. |
|
|
13
14
|
**verb** | **String** | API method for this webhook. |
|
|
14
15
|
**url** | **String** | API URL (supports templating using parameters) for this webhook. |
|
|
15
16
|
**headers** | **Array<String>** | List of API HTTP headers for this webhook. |
|
|
16
17
|
**payload** | **String** | API payload (supports templating using parameters) for this webhook. | [optional]
|
|
17
18
|
**params** | [**Array<TemplateArgDef>**](TemplateArgDef.md) | Array of template argument definitions. |
|
|
18
19
|
**enabled** | **Boolean** | Enables or disables webhook from showing in the Rule Builder. |
|
|
20
|
+
**authentication_id** | **Integer** | The ID of the credential that this webhook is using. | [optional]
|
|
19
21
|
**outgoing_integration_template_id** | **Integer** | Identifier of the outgoing integration template. | [optional]
|
|
20
22
|
**outgoing_integration_type_id** | **Integer** | Identifier of the outgoing integration type. | [optional]
|
|
21
23
|
**outgoing_integration_type_name** | **String** | Name of the outgoing integration. | [optional]
|
|
@@ -31,6 +33,7 @@ instance = TalonOne::WebhookWithOutgoingIntegrationDetails.new(id: 6,
|
|
|
31
33
|
application_ids: null,
|
|
32
34
|
title: Send message,
|
|
33
35
|
description: A webhook to send a coupon to the user.,
|
|
36
|
+
draft: false,
|
|
34
37
|
verb: POST,
|
|
35
38
|
url: www.my-company.com/my-endpoint-name,
|
|
36
39
|
headers: [{"Authorization": "Basic bmF2ZWVua3VtYXIU="}, {"Content-Type": "application/json"}],
|
|
@@ -39,6 +42,7 @@ instance = TalonOne::WebhookWithOutgoingIntegrationDetails.new(id: 6,
|
|
|
39
42
|
},
|
|
40
43
|
params: [],
|
|
41
44
|
enabled: true,
|
|
45
|
+
authentication_id: 1,
|
|
42
46
|
outgoing_integration_template_id: 1,
|
|
43
47
|
outgoing_integration_type_id: 1,
|
|
44
48
|
outgoing_integration_type_name: Braze)
|