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
|
@@ -32,6 +32,18 @@ describe 'IntegrationApi' do
|
|
|
32
32
|
end
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# unit tests for best_prior_price
|
|
36
|
+
# Fetch best prior price
|
|
37
|
+
# Returns the best prior price based on historical pricing data for the specified SKUs within a defined timeframe.
|
|
38
|
+
# @param body body
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [Array<BestPriorPrice>]
|
|
41
|
+
describe 'best_prior_price test' do
|
|
42
|
+
it 'should work' do
|
|
43
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
35
47
|
# unit tests for create_audience_v2
|
|
36
48
|
# Create audience
|
|
37
49
|
# Create an audience. The audience can be created directly from scratch or can come from third party platforms. **Note:** Audiences can also be created from scratch via the Campaign Manager. See the [docs](https://docs.talon.one/docs/product/audiences/creating-audiences). To create an audience from an existing audience from a [technology partner](https://docs.talon.one/docs/dev/technology-partners/overview): 1. Set the `integration` property to `mparticle`, `segment` etc., depending on a third-party platform. 1. Set `integrationId` to the ID of this audience in a third-party platform. To create an audience from an existing audience in another platform: 1. Do not use the `integration` property. 1. Set `integrationId` to the ID of this audience in the 3rd-party platform. To create an audience from scratch: 1. Only set the `name` property. Once you create your first audience, audience-specific rule conditions are enabled in the Rule Builder.
|
|
@@ -250,8 +262,11 @@ describe 'IntegrationApi' do
|
|
|
250
262
|
# @param [Hash] opts the optional parameters
|
|
251
263
|
# @option opts [String] :status Filter points based on their status.
|
|
252
264
|
# @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
|
|
265
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
266
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
253
267
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
254
268
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
269
|
+
# @option opts [String] :sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
|
|
255
270
|
# @return [InlineResponse2005]
|
|
256
271
|
describe 'get_loyalty_card_points test' do
|
|
257
272
|
it 'should work' do
|
|
@@ -269,6 +284,8 @@ describe 'IntegrationApi' do
|
|
|
269
284
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
270
285
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
271
286
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
287
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
288
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
272
289
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
273
290
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
274
291
|
# @return [InlineResponse2003]
|
|
@@ -286,8 +303,11 @@ describe 'IntegrationApi' do
|
|
|
286
303
|
# @param [Hash] opts the optional parameters
|
|
287
304
|
# @option opts [String] :status Filter points based on their status.
|
|
288
305
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
306
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
307
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
289
308
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
290
309
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
310
|
+
# @option opts [String] :sort The field by which results should be sorted. You can enter one of the following values: - `startDate`: Sorts the results by the start date of the points. - `expiryDate`: Sorts the results by the expiry date of the points. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You can only sort by one field at a time.
|
|
291
311
|
# @return [InlineResponse2006]
|
|
292
312
|
describe 'get_loyalty_program_profile_points test' do
|
|
293
313
|
it 'should work' do
|
|
@@ -301,6 +321,8 @@ describe 'IntegrationApi' do
|
|
|
301
321
|
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
302
322
|
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
303
323
|
# @param [Hash] opts the optional parameters
|
|
324
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
325
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
304
326
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
305
327
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
306
328
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
@@ -342,7 +364,7 @@ describe 'IntegrationApi' do
|
|
|
342
364
|
|
|
343
365
|
# unit tests for reopen_customer_session
|
|
344
366
|
# Reopen customer session
|
|
345
|
-
# Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. -
|
|
367
|
+
# Reopen a closed [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). For example, if a session has been completed but still needs to be edited, you can reopen it with this endpoint. A reopen session is treated like a standard open session. When reopening a session: - The `talon_session_reopened` event is triggered. You can see it in the **Events** view in the Campaign Manager. - The session state is updated to `open`. - Any modified budgets and triggered effects are rolled back when the session closes. - Depending on the [return policy](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-programs#return-policy) in your loyalty programs, points are rolled back in the following ways: - Pending points are rolled back automatically. - If **Active points deduction** setting is enabled, any points that were earned and activated when the session closed are rolled back. - If **Negative balance** is enabled, the rollback can create a negative points balance. <details> <summary><strong>Effects and budgets unimpacted by a session reopening</strong></summary> <div> <p>The following effects and budgets remain in the state they were in when the session closed:</p> <ul> <li>Add free item effect</li> <li>Award giveaway</li> <li>Coupon and referral creation</li> <li>Coupon reservation</li> <li>Custom effect</li> <li>Update attribute value</li> <li>Update cart item attribute value</li> </ul> </div> </details> <p>To see an example of a rollback, see the <a href=\"https://docs.talon.one/docs/dev/tutorials/rolling-back-effects\">Cancelling a session with campaign budgets</a>tutorial.</p> **Note:** If your order workflow requires you to create a new session instead of reopening a session, use the [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) endpoint to cancel a closed session and create a new one.
|
|
346
368
|
# @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
347
369
|
# @param [Hash] opts the optional parameters
|
|
348
370
|
# @return [ReopenSessionResponse]
|
|
@@ -381,7 +403,7 @@ describe 'IntegrationApi' do
|
|
|
381
403
|
|
|
382
404
|
# unit tests for track_event_v2
|
|
383
405
|
# Track event
|
|
384
|
-
# Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not
|
|
406
|
+
# Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not specify it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). 1. [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation. </div>
|
|
385
407
|
# @param body body
|
|
386
408
|
# @param [Hash] opts the optional parameters
|
|
387
409
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
|
@@ -434,7 +456,7 @@ describe 'IntegrationApi' do
|
|
|
434
456
|
|
|
435
457
|
# unit tests for update_customer_profile_v2
|
|
436
458
|
# Update customer profile
|
|
437
|
-
# Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of.
|
|
459
|
+
# Update or create a [Customer Profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles). This endpoint triggers the Rule Builder. You can use this endpoint to: - Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first. - Modify the audience the customer profile is a member of. **Note:** [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered in rule evaluation when `runRuleEngine` is `true`. <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer profile returns a response with the requested integration state. - You can use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
|
|
438
460
|
# @param integration_id The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
|
439
461
|
# @param body body
|
|
440
462
|
# @param [Hash] opts the optional parameters
|
|
@@ -462,7 +484,7 @@ describe 'IntegrationApi' do
|
|
|
462
484
|
|
|
463
485
|
# unit tests for update_customer_session_v2
|
|
464
486
|
# Update customer session
|
|
465
|
-
# Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** The currency for the session and the cart items in
|
|
487
|
+
# Update or create a [customer session](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions). The endpoint responds with the potential promotion rule [effects](https://docs.talon.one/docs/dev/integration-api/api-effects) that match the current cart. For example, use this endpoint to share the contents of a customer's cart with Talon.One. **Note:** - The currency for the session and the cart items in it is the currency set for the Application linked to this session. - [Archived campaigns](https://docs.talon.one/docs/product/campaigns/managing-campaigns#archiving-a-campaign) are not considered for rule evaluation. ### Session management To use this endpoint, start by learning about [customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions) and their states and refer to the `state` parameter documentation the request body schema docs below. ### Sessions and customer profiles - To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. - While you can create an anonymous session with `profileId=\"\"`, we recommend you use a guest ID instead. - A profile can be linked to simultaneous sessions in different Applications. Either: - Use unique session integration IDs or, - Use the same session integration ID across all of the Applications. **Note:** If the specified profile does not exist, an empty profile is **created automatically**. You can update it with [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2). <div class=\"redoc-section\"> <p class=\"title\">Performance tips</p> - Updating a customer session returns a response with the new integration state. Use the `responseContent` property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests. - We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div> For more information, see: - The introductory video in [Getting started](https://docs.talon.one/docs/dev/getting-started/overview). - The [integration tutorial](https://docs.talon.one/docs/dev/tutorials/integrating-talon-one).
|
|
466
488
|
# @param customer_session_id The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#operation/getApplicationSessions) endpoint.
|
|
467
489
|
# @param body body
|
|
468
490
|
# @param [Hash] opts the optional parameters
|
|
@@ -162,6 +162,20 @@ describe 'ManagementApi' do
|
|
|
162
162
|
end
|
|
163
163
|
end
|
|
164
164
|
|
|
165
|
+
# unit tests for create_campaign_store_budget
|
|
166
|
+
# Create campaign store budget
|
|
167
|
+
# Create a new store budget for a given campaign.
|
|
168
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
169
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
170
|
+
# @param body body
|
|
171
|
+
# @param [Hash] opts the optional parameters
|
|
172
|
+
# @return [nil]
|
|
173
|
+
describe 'create_campaign_store_budget test' do
|
|
174
|
+
it 'should work' do
|
|
175
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
|
|
165
179
|
# unit tests for create_collection
|
|
166
180
|
# Create campaign-level collection
|
|
167
181
|
# Create a campaign-level collection in a given campaign.
|
|
@@ -360,6 +374,21 @@ describe 'ManagementApi' do
|
|
|
360
374
|
end
|
|
361
375
|
end
|
|
362
376
|
|
|
377
|
+
# unit tests for delete_campaign_store_budgets
|
|
378
|
+
# Delete campaign store budgets
|
|
379
|
+
# Delete the store budgets for a given campaign.
|
|
380
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
381
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
382
|
+
# @param [Hash] opts the optional parameters
|
|
383
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
384
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
385
|
+
# @return [nil]
|
|
386
|
+
describe 'delete_campaign_store_budgets test' do
|
|
387
|
+
it 'should work' do
|
|
388
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
389
|
+
end
|
|
390
|
+
end
|
|
391
|
+
|
|
363
392
|
# unit tests for delete_collection
|
|
364
393
|
# Delete campaign-level collection
|
|
365
394
|
# Delete a given campaign-level collection.
|
|
@@ -540,6 +569,21 @@ describe 'ManagementApi' do
|
|
|
540
569
|
end
|
|
541
570
|
end
|
|
542
571
|
|
|
572
|
+
# unit tests for export_campaign_store_budgets
|
|
573
|
+
# Export campaign store budgets
|
|
574
|
+
# Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
|
575
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
576
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
577
|
+
# @param [Hash] opts the optional parameters
|
|
578
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
579
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
580
|
+
# @return [String]
|
|
581
|
+
describe 'export_campaign_store_budgets test' do
|
|
582
|
+
it 'should work' do
|
|
583
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
584
|
+
end
|
|
585
|
+
end
|
|
586
|
+
|
|
543
587
|
# unit tests for export_campaign_stores
|
|
544
588
|
# Export stores
|
|
545
589
|
# Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
|
@@ -595,7 +639,7 @@ describe 'ManagementApi' do
|
|
|
595
639
|
|
|
596
640
|
# unit tests for export_customer_sessions
|
|
597
641
|
# Export customer sessions
|
|
598
|
-
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
|
642
|
+
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
|
599
643
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
600
644
|
# @param [Hash] opts the optional parameters
|
|
601
645
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
|
@@ -701,6 +745,8 @@ describe 'ManagementApi' do
|
|
|
701
745
|
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
702
746
|
# @param [Hash] opts the optional parameters
|
|
703
747
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
|
748
|
+
# @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
749
|
+
# @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
704
750
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
|
705
751
|
# @return [String]
|
|
706
752
|
describe 'export_loyalty_cards test' do
|
|
@@ -711,7 +757,7 @@ describe 'ManagementApi' do
|
|
|
711
757
|
|
|
712
758
|
# unit tests for export_loyalty_ledger
|
|
713
759
|
# Export customer's transaction logs
|
|
714
|
-
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
|
760
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
|
|
715
761
|
# @param range_start Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
716
762
|
# @param range_end Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
717
763
|
# @param loyalty_program_id The identifier for the loyalty program.
|
|
@@ -974,6 +1020,7 @@ describe 'ManagementApi' do
|
|
|
974
1020
|
# @option opts [String] :referral_code Referral code
|
|
975
1021
|
# @option opts [String] :rule_query Rule name filter for events
|
|
976
1022
|
# @option opts [String] :campaign_query Campaign name filter for events
|
|
1023
|
+
# @option opts [String] :effect_type The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
|
|
977
1024
|
# @return [InlineResponse20030]
|
|
978
1025
|
describe 'get_application_events_without_total_count test' do
|
|
979
1026
|
it 'should work' do
|
|
@@ -1230,7 +1277,7 @@ describe 'ManagementApi' do
|
|
|
1230
1277
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
|
1231
1278
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
|
1232
1279
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
|
1233
|
-
# @return [
|
|
1280
|
+
# @return [InlineResponse20042]
|
|
1234
1281
|
describe 'get_changes test' do
|
|
1235
1282
|
it 'should work' do
|
|
1236
1283
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1432,7 +1479,7 @@ describe 'ManagementApi' do
|
|
|
1432
1479
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
1433
1480
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
1434
1481
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
1435
|
-
# @return [
|
|
1482
|
+
# @return [InlineResponse20040]
|
|
1436
1483
|
describe 'get_event_types test' do
|
|
1437
1484
|
it 'should work' do
|
|
1438
1485
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1448,7 +1495,7 @@ describe 'ManagementApi' do
|
|
|
1448
1495
|
# @option opts [Float] :application_id Filter results by Application ID.
|
|
1449
1496
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
|
1450
1497
|
# @option opts [String] :entity The name of the entity type that was exported.
|
|
1451
|
-
# @return [
|
|
1498
|
+
# @return [InlineResponse20043]
|
|
1452
1499
|
describe 'get_exports test' do
|
|
1453
1500
|
it 'should work' do
|
|
1454
1501
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1479,6 +1526,8 @@ describe 'ManagementApi' do
|
|
|
1479
1526
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
1480
1527
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
1481
1528
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
1529
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1530
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
1482
1531
|
# @return [InlineResponse20019]
|
|
1483
1532
|
describe 'get_loyalty_card_transaction_logs test' do
|
|
1484
1533
|
it 'should work' do
|
|
@@ -1536,6 +1585,8 @@ describe 'ManagementApi' do
|
|
|
1536
1585
|
# @param [Hash] opts the optional parameters
|
|
1537
1586
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
1538
1587
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
|
1588
|
+
# @option opts [Array<String>] :customer_session_i_ds Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
1589
|
+
# @option opts [Array<String>] :transaction_uui_ds Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
1539
1590
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
1540
1591
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
1541
1592
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
@@ -1578,8 +1629,8 @@ describe 'ManagementApi' do
|
|
|
1578
1629
|
# @option opts [String] :message_id Filter results by message ID.
|
|
1579
1630
|
# @option opts [String] :change_type Filter results by change type.
|
|
1580
1631
|
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
|
1581
|
-
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
|
|
1582
|
-
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
|
1632
|
+
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. Use UTC time.
|
|
1633
|
+
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. Use UTC time.
|
|
1583
1634
|
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
|
1584
1635
|
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
|
1585
1636
|
# @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
|
|
@@ -1691,7 +1742,7 @@ describe 'ManagementApi' do
|
|
|
1691
1742
|
# @option opts [Integer] :page_size The number of items in the response.
|
|
1692
1743
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
1693
1744
|
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
1694
|
-
# @return [
|
|
1745
|
+
# @return [InlineResponse20041]
|
|
1695
1746
|
describe 'get_users test' do
|
|
1696
1747
|
it 'should work' do
|
|
1697
1748
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -1710,47 +1761,6 @@ describe 'ManagementApi' do
|
|
|
1710
1761
|
end
|
|
1711
1762
|
end
|
|
1712
1763
|
|
|
1713
|
-
# unit tests for get_webhook_activation_logs
|
|
1714
|
-
# List webhook activation log entries
|
|
1715
|
-
# Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks).
|
|
1716
|
-
# @param [Hash] opts the optional parameters
|
|
1717
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
|
1718
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
1719
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
1720
|
-
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
|
1721
|
-
# @option opts [Float] :webhook_id Filter results by webhook id.
|
|
1722
|
-
# @option opts [Float] :application_id Filter results by Application ID.
|
|
1723
|
-
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
|
1724
|
-
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
1725
|
-
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
1726
|
-
# @return [InlineResponse20040]
|
|
1727
|
-
describe 'get_webhook_activation_logs test' do
|
|
1728
|
-
it 'should work' do
|
|
1729
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1730
|
-
end
|
|
1731
|
-
end
|
|
1732
|
-
|
|
1733
|
-
# unit tests for get_webhook_logs
|
|
1734
|
-
# List webhook log entries
|
|
1735
|
-
# Retrieve all webhook log entries.
|
|
1736
|
-
# @param [Hash] opts the optional parameters
|
|
1737
|
-
# @option opts [Integer] :page_size The number of items in the response.
|
|
1738
|
-
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
|
1739
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
1740
|
-
# @option opts [String] :status Filter results by HTTP status codes.
|
|
1741
|
-
# @option opts [Float] :webhook_id Filter results by webhook id.
|
|
1742
|
-
# @option opts [Float] :application_id Filter results by Application ID.
|
|
1743
|
-
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
|
1744
|
-
# @option opts [String] :request_uuid Filter results by request UUID.
|
|
1745
|
-
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
1746
|
-
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
1747
|
-
# @return [InlineResponse20041]
|
|
1748
|
-
describe 'get_webhook_logs test' do
|
|
1749
|
-
it 'should work' do
|
|
1750
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1751
|
-
end
|
|
1752
|
-
end
|
|
1753
|
-
|
|
1754
1764
|
# unit tests for get_webhooks
|
|
1755
1765
|
# List webhooks
|
|
1756
1766
|
# List all webhooks.
|
|
@@ -1809,6 +1819,22 @@ describe 'ManagementApi' do
|
|
|
1809
1819
|
end
|
|
1810
1820
|
end
|
|
1811
1821
|
|
|
1822
|
+
# unit tests for import_campaign_store_budget
|
|
1823
|
+
# Import campaign store budgets
|
|
1824
|
+
# Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
|
1825
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1826
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1827
|
+
# @param [Hash] opts the optional parameters
|
|
1828
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
1829
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
1830
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
1831
|
+
# @return [Import]
|
|
1832
|
+
describe 'import_campaign_store_budget test' do
|
|
1833
|
+
it 'should work' do
|
|
1834
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1835
|
+
end
|
|
1836
|
+
end
|
|
1837
|
+
|
|
1812
1838
|
# unit tests for import_campaign_stores
|
|
1813
1839
|
# Import stores
|
|
1814
1840
|
# Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
|
@@ -1884,6 +1910,7 @@ describe 'ManagementApi' do
|
|
|
1884
1910
|
# Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
|
1885
1911
|
# @param loyalty_program_id Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
1886
1912
|
# @param [Hash] opts the optional parameters
|
|
1913
|
+
# @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
|
1887
1914
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
|
1888
1915
|
# @return [Import]
|
|
1889
1916
|
describe 'import_loyalty_points test' do
|
|
@@ -1967,13 +1994,28 @@ describe 'ManagementApi' do
|
|
|
1967
1994
|
# List roles
|
|
1968
1995
|
# List all roles.
|
|
1969
1996
|
# @param [Hash] opts the optional parameters
|
|
1970
|
-
# @return [
|
|
1997
|
+
# @return [InlineResponse20044]
|
|
1971
1998
|
describe 'list_all_roles_v2 test' do
|
|
1972
1999
|
it 'should work' do
|
|
1973
2000
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
1974
2001
|
end
|
|
1975
2002
|
end
|
|
1976
2003
|
|
|
2004
|
+
# unit tests for list_campaign_store_budget_limits
|
|
2005
|
+
# List campaign store budget limits
|
|
2006
|
+
# Return the store budget limits for a given campaign.
|
|
2007
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2008
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
2009
|
+
# @param [Hash] opts the optional parameters
|
|
2010
|
+
# @option opts [String] :action The action that this budget is limiting.
|
|
2011
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
2012
|
+
# @return [InlineResponse20046]
|
|
2013
|
+
describe 'list_campaign_store_budget_limits test' do
|
|
2014
|
+
it 'should work' do
|
|
2015
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2016
|
+
end
|
|
2017
|
+
end
|
|
2018
|
+
|
|
1977
2019
|
# unit tests for list_catalog_items
|
|
1978
2020
|
# List items in a catalog
|
|
1979
2021
|
# Return a paginated list of cart items in the given catalog.
|
|
@@ -2039,7 +2081,7 @@ describe 'ManagementApi' do
|
|
|
2039
2081
|
# @option opts [String] :name The name of the store.
|
|
2040
2082
|
# @option opts [String] :integration_id The integration ID of the store.
|
|
2041
2083
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
|
2042
|
-
# @return [
|
|
2084
|
+
# @return [InlineResponse20045]
|
|
2043
2085
|
describe 'list_stores test' do
|
|
2044
2086
|
it 'should work' do
|
|
2045
2087
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
@@ -2083,6 +2125,18 @@ describe 'ManagementApi' do
|
|
|
2083
2125
|
end
|
|
2084
2126
|
end
|
|
2085
2127
|
|
|
2128
|
+
# unit tests for scim_create_group
|
|
2129
|
+
# Create SCIM group
|
|
2130
|
+
# Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2131
|
+
# @param body body
|
|
2132
|
+
# @param [Hash] opts the optional parameters
|
|
2133
|
+
# @return [ScimGroup]
|
|
2134
|
+
describe 'scim_create_group test' do
|
|
2135
|
+
it 'should work' do
|
|
2136
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2137
|
+
end
|
|
2138
|
+
end
|
|
2139
|
+
|
|
2086
2140
|
# unit tests for scim_create_user
|
|
2087
2141
|
# Create SCIM user
|
|
2088
2142
|
# Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
|
@@ -2095,6 +2149,18 @@ describe 'ManagementApi' do
|
|
|
2095
2149
|
end
|
|
2096
2150
|
end
|
|
2097
2151
|
|
|
2152
|
+
# unit tests for scim_delete_group
|
|
2153
|
+
# Delete SCIM group
|
|
2154
|
+
# Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2155
|
+
# @param group_id The ID of the group.
|
|
2156
|
+
# @param [Hash] opts the optional parameters
|
|
2157
|
+
# @return [nil]
|
|
2158
|
+
describe 'scim_delete_group test' do
|
|
2159
|
+
it 'should work' do
|
|
2160
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2161
|
+
end
|
|
2162
|
+
end
|
|
2163
|
+
|
|
2098
2164
|
# unit tests for scim_delete_user
|
|
2099
2165
|
# Delete SCIM user
|
|
2100
2166
|
# Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
|
@@ -2107,6 +2173,29 @@ describe 'ManagementApi' do
|
|
|
2107
2173
|
end
|
|
2108
2174
|
end
|
|
2109
2175
|
|
|
2176
|
+
# unit tests for scim_get_group
|
|
2177
|
+
# Get SCIM group
|
|
2178
|
+
# Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2179
|
+
# @param group_id The ID of the group.
|
|
2180
|
+
# @param [Hash] opts the optional parameters
|
|
2181
|
+
# @return [ScimGroup]
|
|
2182
|
+
describe 'scim_get_group test' do
|
|
2183
|
+
it 'should work' do
|
|
2184
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2185
|
+
end
|
|
2186
|
+
end
|
|
2187
|
+
|
|
2188
|
+
# unit tests for scim_get_groups
|
|
2189
|
+
# List SCIM groups
|
|
2190
|
+
# Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2191
|
+
# @param [Hash] opts the optional parameters
|
|
2192
|
+
# @return [ScimGroupsListResponse]
|
|
2193
|
+
describe 'scim_get_groups test' do
|
|
2194
|
+
it 'should work' do
|
|
2195
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2196
|
+
end
|
|
2197
|
+
end
|
|
2198
|
+
|
|
2110
2199
|
# unit tests for scim_get_resource_types
|
|
2111
2200
|
# List supported SCIM resource types
|
|
2112
2201
|
# Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
|
@@ -2163,6 +2252,19 @@ describe 'ManagementApi' do
|
|
|
2163
2252
|
end
|
|
2164
2253
|
end
|
|
2165
2254
|
|
|
2255
|
+
# unit tests for scim_patch_group
|
|
2256
|
+
# Update SCIM group attributes
|
|
2257
|
+
# Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2258
|
+
# @param group_id The ID of the group.
|
|
2259
|
+
# @param body body
|
|
2260
|
+
# @param [Hash] opts the optional parameters
|
|
2261
|
+
# @return [ScimGroup]
|
|
2262
|
+
describe 'scim_patch_group test' do
|
|
2263
|
+
it 'should work' do
|
|
2264
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2265
|
+
end
|
|
2266
|
+
end
|
|
2267
|
+
|
|
2166
2268
|
# unit tests for scim_patch_user
|
|
2167
2269
|
# Update SCIM user attributes
|
|
2168
2270
|
# Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
|
@@ -2176,6 +2278,19 @@ describe 'ManagementApi' do
|
|
|
2176
2278
|
end
|
|
2177
2279
|
end
|
|
2178
2280
|
|
|
2281
|
+
# unit tests for scim_replace_group_attributes
|
|
2282
|
+
# Update SCIM group
|
|
2283
|
+
# Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
2284
|
+
# @param group_id The ID of the group.
|
|
2285
|
+
# @param body body
|
|
2286
|
+
# @param [Hash] opts the optional parameters
|
|
2287
|
+
# @return [ScimGroup]
|
|
2288
|
+
describe 'scim_replace_group_attributes test' do
|
|
2289
|
+
it 'should work' do
|
|
2290
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2291
|
+
end
|
|
2292
|
+
end
|
|
2293
|
+
|
|
2179
2294
|
# unit tests for scim_replace_user_attributes
|
|
2180
2295
|
# Update SCIM user
|
|
2181
2296
|
# Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
|
@@ -2241,6 +2356,19 @@ describe 'ManagementApi' do
|
|
|
2241
2356
|
end
|
|
2242
2357
|
end
|
|
2243
2358
|
|
|
2359
|
+
# unit tests for summarize_campaign_store_budget
|
|
2360
|
+
# Get summary of campaign store budgets
|
|
2361
|
+
# Fetch a summary of all store budget information for a given campaign.
|
|
2362
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2363
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
2364
|
+
# @param [Hash] opts the optional parameters
|
|
2365
|
+
# @return [InlineResponse20047]
|
|
2366
|
+
describe 'summarize_campaign_store_budget test' do
|
|
2367
|
+
it 'should work' do
|
|
2368
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
2369
|
+
end
|
|
2370
|
+
end
|
|
2371
|
+
|
|
2244
2372
|
# unit tests for transfer_loyalty_card
|
|
2245
2373
|
# Transfer card data
|
|
2246
2374
|
# Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|
|
@@ -104,4 +104,16 @@ describe 'AccountLimits' do
|
|
|
104
104
|
end
|
|
105
105
|
end
|
|
106
106
|
|
|
107
|
+
describe 'test attribute "secondary_deployment_price"' do
|
|
108
|
+
it 'should work' do
|
|
109
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
describe 'test attribute "currency_code"' do
|
|
114
|
+
it 'should work' do
|
|
115
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
|
|
107
119
|
end
|
|
@@ -71,7 +71,7 @@ describe 'AchievementBase' do
|
|
|
71
71
|
describe 'test attribute "recurrence_policy"' do
|
|
72
72
|
it 'should work' do
|
|
73
73
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
74
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
|
|
74
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
|
|
75
75
|
# validator.allowable_values.each do |value|
|
|
76
76
|
# expect { @instance.recurrence_policy = value }.not_to raise_error
|
|
77
77
|
# end
|
|
@@ -100,4 +100,10 @@ describe 'AchievementBase' do
|
|
|
100
100
|
end
|
|
101
101
|
end
|
|
102
102
|
|
|
103
|
+
describe 'test attribute "allow_rollback_after_completion"' do
|
|
104
|
+
it 'should work' do
|
|
105
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
|
|
103
109
|
end
|
|
@@ -105,7 +105,7 @@ describe 'AchievementProgressWithDefinition' do
|
|
|
105
105
|
describe 'test attribute "achievement_recurrence_policy"' do
|
|
106
106
|
it 'should work' do
|
|
107
107
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
108
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration"])
|
|
108
|
+
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["no_recurrence", "on_expiration", "on_completion"])
|
|
109
109
|
# validator.allowable_values.each do |value|
|
|
110
110
|
# expect { @instance.achievement_recurrence_policy = value }.not_to raise_error
|
|
111
111
|
# end
|
|
@@ -134,4 +134,10 @@ describe 'AchievementProgressWithDefinition' do
|
|
|
134
134
|
end
|
|
135
135
|
end
|
|
136
136
|
|
|
137
|
+
describe 'test attribute "achievement_allow_rollback_after_completion"' do
|
|
138
|
+
it 'should work' do
|
|
139
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
|
|
137
143
|
end
|