talon_one 3.0.2 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +157 -51
- data/docs/AccountAnalytics.md +3 -1
- data/docs/AccountDashboardStatistic.md +0 -2
- data/docs/AccountDashboardStatisticCampaigns.md +4 -2
- data/docs/Achievement.md +39 -0
- data/docs/AchievementAdditionalProperties.md +23 -0
- data/docs/AchievementProgress.md +35 -0
- data/docs/ActivateUserRequest.md +17 -0
- data/docs/AddItemCatalogAction.md +3 -1
- data/docs/AddLoyaltyPoints.md +2 -2
- data/docs/AddLoyaltyPointsEffectProps.md +1 -1
- data/docs/AddToAudienceEffectProps.md +23 -0
- data/docs/AdditionalCampaignProperties.md +59 -0
- data/docs/Application.md +3 -5
- data/docs/ApplicationAPIKey.md +6 -2
- data/docs/ApplicationAnalyticsDataPoint.md +31 -0
- data/docs/ApplicationAnalyticsDataPointAvgItemsPerSession.md +19 -0
- data/docs/ApplicationAnalyticsDataPointAvgSessionValue.md +19 -0
- data/docs/ApplicationAnalyticsDataPointSessionsCount.md +19 -0
- data/docs/ApplicationAnalyticsDataPointTotalRevenue.md +19 -0
- data/docs/ApplicationCampaignAnalytics.md +45 -0
- data/docs/ApplicationCampaignAnalyticsAvgItemsPerSession.md +21 -0
- data/docs/ApplicationCampaignAnalyticsAvgSessionValue.md +21 -0
- data/docs/ApplicationCampaignAnalyticsCouponsCount.md +19 -0
- data/docs/ApplicationCampaignAnalyticsSessionsCount.md +21 -0
- data/docs/ApplicationCampaignAnalyticsTotalDiscounts.md +19 -0
- data/docs/ApplicationCampaignAnalyticsTotalRevenue.md +21 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +4 -0
- data/docs/ApplicationNotification.md +1 -1
- data/docs/ApplicationSession.md +5 -3
- data/docs/ApplicationStoreEntity.md +17 -0
- data/docs/Audience.md +1 -1
- data/docs/AudienceAnalytics.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseCampaign.md +45 -0
- data/docs/BaseLoyaltyProgram.md +9 -1
- data/docs/BaseNotification.md +5 -1
- data/docs/BaseNotificationEntity.md +3 -1
- data/docs/BaseNotificationWebhook.md +3 -1
- data/docs/BulkOperationOnCampaigns.md +19 -0
- data/docs/Campaign.md +25 -17
- data/docs/CampaignBudget.md +21 -0
- data/docs/CampaignCopy.md +3 -1
- data/docs/CampaignCreatedNotification.md +2 -2
- data/docs/CampaignEvaluationGroup.md +31 -0
- data/docs/CampaignEvaluationPosition.md +21 -0
- data/docs/CampaignEvaluationTreeChangedNotification.md +21 -0
- data/docs/CampaignGroup.md +6 -6
- data/docs/CampaignNotificationPolicy.md +17 -0
- data/docs/CampaignSet.md +3 -5
- data/docs/CampaignSetBranchNode.md +13 -3
- data/docs/CampaignTemplate.md +2 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +21 -0
- data/docs/CardExpiringPointsNotificationTrigger.md +19 -0
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +35 -0
- data/docs/CartItem.md +4 -2
- data/docs/CatalogItem.md +3 -1
- data/docs/ChangeLoyaltyTierLevelEffectProps.md +27 -0
- data/docs/Coupon.md +5 -3
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponsNotificationPolicy.md +3 -1
- data/docs/CreateAchievement.md +27 -0
- data/docs/CreateApplicationAPIKey.md +7 -3
- data/docs/CreateTemplateCampaign.md +6 -2
- data/docs/CustomEffectProps.md +1 -1
- data/docs/CustomerInventory.md +4 -2
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileAudienceRequestItem.md +1 -1
- data/docs/CustomerProfileIntegrationResponseV2.md +33 -0
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +8 -6
- data/docs/DeactivateUserRequest.md +17 -0
- data/docs/DeleteUserRequest.md +17 -0
- data/docs/Effect.md +2 -0
- data/docs/EffectEntity.md +3 -1
- data/docs/EmailEntity.md +1 -1
- data/docs/Environment.md +2 -0
- data/docs/Event.md +2 -0
- data/docs/EventV2.md +4 -2
- data/docs/ExpiringCouponsNotificationPolicy.md +21 -0
- data/docs/ExpiringCouponsNotificationTrigger.md +19 -0
- data/docs/ExpiringPointsNotificationPolicy.md +4 -2
- data/docs/FuncArgDef.md +1 -1
- data/docs/GetIntegrationCouponRequest.md +19 -0
- data/docs/IdentifiableEntity.md +17 -0
- data/docs/IncreaseAchievementProgressEffectProps.md +29 -0
- data/docs/InlineResponse20010.md +1 -1
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +3 -3
- data/docs/InlineResponse20014.md +2 -2
- data/docs/InlineResponse20015.md +3 -5
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +2 -2
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +2 -4
- data/docs/InlineResponse20022.md +3 -3
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +3 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +2 -2
- data/docs/InlineResponse20027.md +2 -2
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +3 -5
- data/docs/InlineResponse2003.md +3 -3
- data/docs/InlineResponse20030.md +1 -1
- data/docs/InlineResponse20031.md +3 -3
- data/docs/InlineResponse20032.md +3 -3
- data/docs/InlineResponse20033.md +5 -3
- data/docs/InlineResponse20034.md +1 -1
- data/docs/InlineResponse20035.md +5 -3
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +1 -1
- data/docs/InlineResponse20038.md +2 -4
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +3 -3
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +19 -0
- data/docs/InlineResponse20042.md +21 -0
- data/docs/InlineResponse20043.md +19 -0
- data/docs/InlineResponse20044.md +19 -0
- data/docs/InlineResponse20045.md +21 -0
- data/docs/InlineResponse20046.md +19 -0
- data/docs/InlineResponse20047.md +19 -0
- data/docs/InlineResponse2005.md +1 -1
- data/docs/InlineResponse2006.md +1 -1
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +2 -2
- data/docs/InlineResponse2009.md +1 -1
- data/docs/IntegrationApi.md +209 -122
- data/docs/IntegrationCoupon.md +4 -2
- data/docs/IntegrationEvent.md +2 -0
- data/docs/IntegrationEventV2Request.md +4 -2
- data/docs/IntegrationRequest.md +1 -1
- data/docs/IntegrationStoreEntity.md +17 -0
- data/docs/InventoryCoupon.md +5 -3
- data/docs/LedgerPointsEntryIntegrationAPI.md +33 -0
- data/docs/LoginParams.md +1 -1
- data/docs/LoyaltyCardBalances.md +21 -0
- data/docs/LoyaltyCardProfileRegistration.md +1 -1
- data/docs/LoyaltyLedgerTransactions.md +1 -1
- data/docs/LoyaltyProgram.md +15 -1
- data/docs/LoyaltyProgramLedgers.md +2 -0
- data/docs/LoyaltyProgramSubledgers.md +19 -0
- data/docs/LoyaltyProgramTransaction.md +4 -2
- data/docs/ManagementApi.md +3460 -1649
- data/docs/MessageLogEntries.md +19 -0
- data/docs/MessageLogEntry.md +37 -0
- data/docs/MessageLogRequest.md +19 -0
- data/docs/MessageLogResponse.md +21 -0
- data/docs/NewAccountSignUp.md +1 -1
- data/docs/NewApplication.md +6 -10
- data/docs/NewApplicationAPIKey.md +6 -2
- data/docs/NewAudience.md +1 -1
- data/docs/NewBaseNotification.md +2 -0
- data/docs/NewCampaign.md +8 -2
- data/docs/NewCampaignEvaluationGroup.md +27 -0
- data/docs/NewCampaignGroup.md +6 -6
- data/docs/NewCampaignTemplate.md +3 -1
- data/docs/NewCoupons.md +4 -2
- data/docs/NewCustomerSession.md +1 -1
- data/docs/NewCustomerSessionV2.md +5 -3
- data/docs/NewEvent.md +2 -0
- data/docs/NewExternalInvitation.md +21 -0
- data/docs/NewInternalAudience.md +1 -1
- data/docs/NewInvitation.md +8 -6
- data/docs/NewInviteEmail.md +4 -4
- data/docs/NewLoyaltyProgram.md +8 -0
- data/docs/NewNotificationTest.md +29 -0
- data/docs/NewNotificationWebhook.md +3 -1
- data/docs/NewPicklist.md +1 -1
- data/docs/NewRoleV2.md +23 -0
- data/docs/NewStore.md +23 -0
- data/docs/NewUser.md +1 -1
- data/docs/NotificationActivation.md +17 -0
- data/docs/NotificationListItem.md +23 -0
- data/docs/NotificationTest.md +27 -0
- data/docs/OneTimeCode.md +23 -0
- data/docs/OutgoingIntegrationCleverTapPolicy.md +21 -0
- data/docs/OutgoingIntegrationConfiguration.md +1 -1
- data/docs/OutgoingIntegrationIterablePolicy.md +19 -0
- data/docs/OutgoingIntegrationMoEngagePolicy.md +23 -0
- data/docs/OutgoingIntegrationTemplate.md +33 -0
- data/docs/OutgoingIntegrationTemplateWithConfigurationDetails.md +35 -0
- data/docs/OutgoingIntegrationTemplates.md +17 -0
- data/docs/OutgoingIntegrationType.md +1 -1
- data/docs/PatchItemCatalogAction.md +2 -0
- data/docs/PendingPointsNotificationPolicy.md +19 -0
- data/docs/Picklist.md +1 -1
- data/docs/Product.md +17 -0
- data/docs/RemoveFromAudienceEffectProps.md +23 -0
- data/docs/ReturnedCartItem.md +1 -1
- data/docs/Role.md +1 -1
- data/docs/RoleAssign.md +2 -2
- data/docs/RoleV2.md +12 -6
- data/docs/RoleV2ApplicationDetails.md +6 -4
- data/docs/RoleV2Base.md +23 -0
- data/docs/RoleV2PermissionSet.md +3 -3
- data/docs/RoleV2Permissions.md +3 -3
- data/docs/RoleV2RolesGroup.md +21 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +1 -1
- data/docs/RollbackDiscountEffectProps.md +1 -1
- data/docs/SSOConfig.md +17 -0
- data/docs/SamlConnectionInternal.md +19 -0
- data/docs/SamlLoginEndpoint.md +4 -2
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +1 -1
- data/docs/SetDiscountPerItemEffectProps.md +6 -2
- data/docs/Store.md +33 -0
- data/docs/TemplateArgDef.md +1 -1
- data/docs/Tier.md +5 -1
- data/docs/TierDowngradeNotificationPolicy.md +19 -0
- data/docs/TierUpgradeNotificationPolicy.md +19 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +21 -0
- data/docs/TierWillDowngradeNotificationTrigger.md +19 -0
- data/docs/TimePoint.md +27 -0
- data/docs/TrackEventV2Response.md +33 -0
- data/docs/TwoFAConfig.md +19 -0
- data/docs/UpdateAchievement.md +27 -0
- data/docs/UpdateApplication.md +4 -6
- data/docs/UpdateApplicationAPIKey.md +17 -0
- data/docs/UpdateCampaign.md +9 -3
- data/docs/UpdateCampaignEvaluationGroup.md +27 -0
- data/docs/UpdateCampaignGroup.md +6 -6
- data/docs/UpdateCampaignTemplate.md +3 -1
- data/docs/UpdateCoupon.md +4 -2
- data/docs/UpdateCouponBatch.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +8 -0
- data/docs/UpdatePicklist.md +1 -1
- data/docs/UpdateStore.md +21 -0
- data/docs/UpdateUser.md +8 -6
- data/docs/User.md +19 -13
- data/docs/WebhookWithOutgoingIntegrationDetails.md +45 -0
- data/lib/talon_one/api/integration_api.rb +291 -144
- data/lib/talon_one/api/management_api.rb +3054 -1033
- data/lib/talon_one/models/account_additional_cost.rb +3 -3
- data/lib/talon_one/models/account_analytics.rb +19 -4
- data/lib/talon_one/models/account_dashboard_statistic.rb +1 -13
- data/lib/talon_one/models/account_dashboard_statistic_campaigns.rb +20 -5
- data/lib/talon_one/models/achievement.rb +406 -0
- data/lib/talon_one/models/achievement_additional_properties.rb +252 -0
- data/lib/talon_one/models/achievement_progress.rb +410 -0
- data/lib/talon_one/models/activate_user_request.rb +213 -0
- data/lib/talon_one/models/add_item_catalog_action.rb +12 -3
- data/lib/talon_one/models/add_loyalty_points.rb +2 -2
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +1 -1
- data/lib/talon_one/models/add_to_audience_effect_props.rb +238 -0
- data/lib/talon_one/models/additional_campaign_properties.rb +463 -0
- data/lib/talon_one/models/application.rb +12 -50
- data/lib/talon_one/models/application_analytics_data_point.rb +273 -0
- data/lib/talon_one/models/application_analytics_data_point_avg_items_per_session.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_avg_session_value.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_sessions_count.rb +216 -0
- data/lib/talon_one/models/application_analytics_data_point_total_revenue.rb +216 -0
- data/lib/talon_one/models/application_api_key.rb +37 -5
- data/lib/talon_one/models/application_campaign_analytics.rb +379 -0
- data/lib/talon_one/models/application_campaign_analytics_avg_items_per_session.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_avg_session_value.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_coupons_count.rb +216 -0
- data/lib/talon_one/models/application_campaign_analytics_sessions_count.rb +225 -0
- data/lib/talon_one/models/application_campaign_analytics_total_discounts.rb +216 -0
- data/lib/talon_one/models/application_campaign_analytics_total_revenue.rb +225 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- data/lib/talon_one/models/application_event.rb +45 -1
- data/lib/talon_one/models/application_notification.rb +1 -1
- data/lib/talon_one/models/application_session.rb +51 -17
- data/lib/talon_one/models/application_store_entity.rb +207 -0
- data/lib/talon_one/models/attribute.rb +2 -2
- data/lib/talon_one/models/audience_analytics.rb +2 -2
- data/lib/talon_one/models/audience_customer.rb +2 -2
- data/lib/talon_one/models/base_campaign.rb +449 -0
- data/lib/talon_one/models/base_loyalty_program.rb +102 -4
- data/lib/talon_one/models/base_notification.rb +65 -4
- data/lib/talon_one/models/base_notification_entity.rb +16 -4
- data/lib/talon_one/models/base_notification_webhook.rb +16 -4
- data/lib/talon_one/models/bulk_operation_on_campaigns.rb +263 -0
- data/lib/talon_one/models/campaign.rb +105 -20
- data/lib/talon_one/models/campaign_budget.rb +280 -0
- data/lib/talon_one/models/campaign_copy.rb +14 -4
- data/lib/talon_one/models/campaign_created_notification.rb +10 -10
- data/lib/talon_one/models/campaign_evaluation_group.rb +378 -0
- data/lib/talon_one/models/campaign_evaluation_position.rb +243 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_notification.rb +236 -0
- data/lib/talon_one/models/campaign_group.rb +4 -4
- data/lib/talon_one/models/campaign_notification_policy.rb +231 -0
- data/lib/talon_one/models/campaign_set.rb +16 -31
- data/lib/talon_one/models/campaign_set_branch_node.rb +100 -6
- data/lib/talon_one/models/campaign_template.rb +30 -1
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +259 -0
- data/lib/talon_one/models/card_expiring_points_notification_trigger.rb +280 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +410 -0
- data/lib/talon_one/models/cart_item.rb +12 -3
- data/lib/talon_one/models/catalog_item.rb +13 -4
- data/lib/talon_one/models/change_loyalty_tier_level_effect_props.rb +278 -0
- data/lib/talon_one/models/coupon.rb +17 -7
- data/lib/talon_one/models/coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/coupons_notification_policy.rb +16 -4
- data/lib/talon_one/models/create_achievement.rb +320 -0
- data/lib/talon_one/models/create_application_api_key.rb +40 -8
- data/lib/talon_one/models/create_template_campaign.rb +27 -5
- data/lib/talon_one/models/custom_effect_props.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +16 -5
- data/lib/talon_one/models/customer_profile.rb +2 -2
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +1 -1
- data/lib/talon_one/models/customer_profile_integration_response_v2.rb +307 -0
- data/lib/talon_one/models/customer_session.rb +1 -1
- data/lib/talon_one/models/customer_session_v2.rb +41 -7
- data/lib/talon_one/models/deactivate_user_request.rb +213 -0
- data/lib/talon_one/models/delete_user_request.rb +213 -0
- data/lib/talon_one/models/effect.rb +11 -1
- data/lib/talon_one/models/effect_entity.rb +14 -4
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +13 -1
- data/lib/talon_one/models/event.rb +35 -1
- data/lib/talon_one/models/event_v2.rb +37 -3
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +259 -0
- data/lib/talon_one/models/expiring_coupons_notification_trigger.rb +280 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +16 -4
- data/lib/talon_one/models/func_arg_def.rb +0 -5
- data/lib/talon_one/models/get_integration_coupon_request.rb +257 -0
- data/lib/talon_one/models/identifiable_entity.rb +212 -0
- data/lib/talon_one/models/increase_achievement_progress_effect_props.rb +298 -0
- data/lib/talon_one/models/inline_response20010.rb +1 -1
- data/lib/talon_one/models/inline_response20011.rb +1 -1
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +11 -11
- data/lib/talon_one/models/inline_response20014.rb +1 -3
- data/lib/talon_one/models/inline_response20015.rb +7 -11
- data/lib/talon_one/models/inline_response20016.rb +3 -1
- data/lib/talon_one/models/inline_response20017.rb +1 -1
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +10 -10
- data/lib/talon_one/models/inline_response20020.rb +1 -1
- data/lib/talon_one/models/inline_response20021.rb +7 -11
- data/lib/talon_one/models/inline_response20022.rb +10 -10
- data/lib/talon_one/models/inline_response20023.rb +1 -1
- data/lib/talon_one/models/inline_response20024.rb +10 -6
- data/lib/talon_one/models/inline_response20025.rb +1 -1
- data/lib/talon_one/models/inline_response20026.rb +6 -1
- data/lib/talon_one/models/inline_response20027.rb +1 -6
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +7 -11
- data/lib/talon_one/models/inline_response2003.rb +11 -11
- data/lib/talon_one/models/inline_response20030.rb +1 -1
- data/lib/talon_one/models/inline_response20031.rb +8 -13
- data/lib/talon_one/models/inline_response20032.rb +8 -13
- data/lib/talon_one/models/inline_response20033.rb +11 -7
- data/lib/talon_one/models/inline_response20034.rb +1 -1
- data/lib/talon_one/models/inline_response20035.rb +11 -7
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +1 -1
- data/lib/talon_one/models/inline_response20038.rb +7 -11
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +11 -11
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +227 -0
- data/lib/talon_one/models/inline_response20042.rb +231 -0
- data/lib/talon_one/models/inline_response20043.rb +227 -0
- data/lib/talon_one/models/inline_response20044.rb +227 -0
- data/lib/talon_one/models/inline_response20045.rb +231 -0
- data/lib/talon_one/models/inline_response20046.rb +222 -0
- data/lib/talon_one/models/inline_response20047.rb +227 -0
- data/lib/talon_one/models/inline_response2005.rb +1 -1
- data/lib/talon_one/models/inline_response2006.rb +1 -1
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +10 -10
- data/lib/talon_one/models/inline_response2009.rb +1 -1
- data/lib/talon_one/models/integration_coupon.rb +14 -4
- data/lib/talon_one/models/integration_event.rb +35 -1
- data/lib/talon_one/models/integration_event_v2_request.rb +37 -3
- data/lib/talon_one/models/integration_request.rb +1 -1
- data/lib/talon_one/models/integration_store_entity.rb +231 -0
- data/lib/talon_one/models/inventory_coupon.rb +15 -5
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +400 -0
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +1 -1
- data/lib/talon_one/models/loyalty_card_balances.rb +231 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_transactions.rb +1 -1
- data/lib/talon_one/models/loyalty_program.rb +136 -4
- data/lib/talon_one/models/loyalty_program_ledgers.rb +12 -2
- data/lib/talon_one/models/loyalty_program_subledgers.rb +230 -0
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -3
- data/lib/talon_one/models/message_log_entries.rb +241 -0
- data/lib/talon_one/models/message_log_entry.rb +385 -0
- data/lib/talon_one/models/message_log_request.rb +249 -0
- data/lib/talon_one/models/message_log_response.rb +264 -0
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +3 -3
- data/lib/talon_one/models/new_application.rb +2 -51
- data/lib/talon_one/models/new_application_api_key.rb +37 -5
- data/lib/talon_one/models/new_attribute.rb +2 -2
- data/lib/talon_one/models/new_base_notification.rb +13 -1
- data/lib/talon_one/models/new_campaign.rb +52 -5
- data/lib/talon_one/models/new_campaign_evaluation_group.rb +347 -0
- data/lib/talon_one/models/new_campaign_group.rb +4 -4
- data/lib/talon_one/models/new_campaign_template.rb +33 -4
- data/lib/talon_one/models/new_coupons.rb +16 -6
- data/lib/talon_one/models/new_customer_session.rb +1 -1
- data/lib/talon_one/models/new_customer_session_v2.rb +38 -4
- data/lib/talon_one/models/new_event.rb +35 -1
- data/lib/talon_one/models/new_external_invitation.rb +235 -0
- data/lib/talon_one/models/new_invitation.rb +24 -18
- data/lib/talon_one/models/new_invite_email.rb +2 -38
- data/lib/talon_one/models/new_loyalty_program.rb +99 -1
- data/lib/talon_one/models/new_notification_test.rb +327 -0
- data/lib/talon_one/models/new_notification_webhook.rb +16 -4
- data/lib/talon_one/models/new_picklist.rb +1 -1
- data/lib/talon_one/models/new_role_v2.rb +249 -0
- data/lib/talon_one/models/new_store.rb +309 -0
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/notification_activation.rb +212 -0
- data/lib/talon_one/models/notification_list_item.rb +257 -0
- data/lib/talon_one/models/notification_test.rb +227 -0
- data/lib/talon_one/models/one_time_code.rb +252 -0
- data/lib/talon_one/models/outgoing_integration_clever_tap_policy.rb +242 -0
- data/lib/talon_one/models/outgoing_integration_configuration.rb +1 -0
- data/lib/talon_one/models/outgoing_integration_iterable_policy.rb +227 -0
- data/lib/talon_one/models/outgoing_integration_mo_engage_policy.rb +257 -0
- data/lib/talon_one/models/outgoing_integration_template.rb +409 -0
- data/lib/talon_one/models/outgoing_integration_template_with_configuration_details.rb +425 -0
- data/lib/talon_one/models/outgoing_integration_templates.rb +209 -0
- data/lib/talon_one/models/patch_item_catalog_action.rb +11 -2
- data/lib/talon_one/models/pending_points_notification_policy.rb +243 -0
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/product.rb +232 -0
- data/lib/talon_one/models/remove_from_audience_effect_props.rb +238 -0
- data/lib/talon_one/models/returned_cart_item.rb +1 -1
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_assign.rb +2 -2
- data/lib/talon_one/models/role_v2.rb +63 -12
- data/lib/talon_one/models/role_v2_application_details.rb +17 -7
- data/lib/talon_one/models/role_v2_base.rb +238 -0
- data/lib/talon_one/models/role_v2_permission_set.rb +12 -11
- data/lib/talon_one/models/role_v2_permissions.rb +2 -2
- data/lib/talon_one/models/role_v2_roles_group.rb +233 -0
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_discount_effect_props.rb +1 -1
- data/lib/talon_one/models/saml_connection_internal.rb +265 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +17 -2
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +1 -1
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +25 -5
- data/lib/talon_one/models/sso_config.rb +212 -0
- data/lib/talon_one/models/store.rb +381 -0
- data/lib/talon_one/models/talang_attribute.rb +2 -2
- data/lib/talon_one/models/template_arg_def.rb +0 -5
- data/lib/talon_one/models/tier.rb +58 -4
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +243 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +243 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +259 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_trigger.rb +261 -0
- data/lib/talon_one/models/time_point.rb +345 -0
- data/lib/talon_one/models/track_event_v2_response.rb +307 -0
- data/lib/talon_one/models/two_fa_config.rb +222 -0
- data/lib/talon_one/models/update_achievement.rb +291 -0
- data/lib/talon_one/models/update_application.rb +15 -53
- data/lib/talon_one/models/update_application_api_key.rb +212 -0
- data/lib/talon_one/models/update_campaign.rb +52 -6
- data/lib/talon_one/models/update_campaign_evaluation_group.rb +348 -0
- data/lib/talon_one/models/update_campaign_group.rb +4 -4
- data/lib/talon_one/models/update_campaign_template.rb +28 -4
- data/lib/talon_one/models/update_coupon.rb +16 -6
- data/lib/talon_one/models/update_coupon_batch.rb +2 -2
- data/lib/talon_one/models/update_loyalty_program.rb +99 -1
- data/lib/talon_one/models/update_picklist.rb +1 -1
- data/lib/talon_one/models/update_store.rb +265 -0
- data/lib/talon_one/models/update_user.rb +25 -14
- data/lib/talon_one/models/user.rb +73 -42
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +449 -0
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +89 -16
- data/spec/api/integration_api_spec.rb +77 -50
- data/spec/api/management_api_spec.rb +706 -312
- data/spec/models/account_analytics_spec.rb +6 -0
- data/spec/models/account_dashboard_statistic_campaigns_spec.rb +6 -0
- data/spec/models/account_dashboard_statistic_spec.rb +0 -6
- data/spec/models/achievement_additional_properties_spec.rb +59 -0
- data/spec/models/achievement_progress_spec.rb +99 -0
- data/spec/models/achievement_spec.rb +107 -0
- data/spec/models/activate_user_request_spec.rb +41 -0
- data/spec/models/add_item_catalog_action_spec.rb +6 -0
- data/spec/models/add_to_audience_effect_props_spec.rb +59 -0
- data/spec/models/additional_campaign_properties_spec.rb +171 -0
- data/spec/models/application_analytics_data_point_avg_items_per_session_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_avg_session_value_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_sessions_count_spec.rb +47 -0
- data/spec/models/application_analytics_data_point_spec.rb +83 -0
- data/spec/models/application_analytics_data_point_total_revenue_spec.rb +47 -0
- data/spec/models/application_api_key_spec.rb +17 -1
- data/spec/models/application_campaign_analytics_avg_items_per_session_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_avg_session_value_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_coupons_count_spec.rb +47 -0
- data/spec/models/application_campaign_analytics_sessions_count_spec.rb +53 -0
- data/spec/models/application_campaign_analytics_spec.rb +129 -0
- data/spec/models/application_campaign_analytics_total_discounts_spec.rb +47 -0
- data/spec/models/application_campaign_analytics_total_revenue_spec.rb +53 -0
- data/spec/models/application_event_spec.rb +12 -0
- data/spec/models/application_session_spec.rb +9 -3
- data/spec/models/application_spec.rb +6 -20
- data/spec/models/application_store_entity_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +1 -1
- data/spec/models/base_campaign_spec.rb +137 -0
- data/spec/models/base_loyalty_program_spec.rb +36 -0
- data/spec/models/base_notification_entity_spec.rb +6 -0
- data/spec/models/base_notification_spec.rb +16 -0
- data/spec/models/base_notification_webhook_spec.rb +6 -0
- data/spec/models/bulk_operation_on_campaigns_spec.rb +51 -0
- data/spec/models/campaign_budget_spec.rb +53 -0
- data/spec/models/campaign_copy_spec.rb +6 -0
- data/spec/models/campaign_created_notification_spec.rb +1 -1
- data/spec/models/campaign_evaluation_group_spec.rb +91 -0
- data/spec/models/campaign_evaluation_position_spec.rb +53 -0
- data/spec/models/campaign_evaluation_tree_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_notification_policy_spec.rb +41 -0
- data/spec/models/campaign_set_branch_node_spec.rb +38 -0
- data/spec/models/campaign_set_spec.rb +2 -8
- data/spec/models/campaign_spec.rb +33 -1
- data/spec/models/campaign_template_spec.rb +11 -1
- data/spec/models/card_expiring_points_notification_policy_spec.rb +53 -0
- data/spec/models/card_expiring_points_notification_trigger_spec.rb +51 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +95 -0
- data/spec/models/cart_item_spec.rb +6 -0
- data/spec/models/catalog_item_spec.rb +6 -0
- data/spec/models/change_loyalty_tier_level_effect_props_spec.rb +71 -0
- data/spec/models/coupon_spec.rb +6 -0
- data/spec/models/coupons_notification_policy_spec.rb +6 -0
- data/spec/models/create_achievement_spec.rb +71 -0
- data/spec/models/create_application_api_key_spec.rb +17 -1
- data/spec/models/create_template_campaign_spec.rb +12 -0
- data/spec/models/customer_inventory_spec.rb +6 -0
- data/spec/models/customer_profile_integration_response_v2_spec.rb +89 -0
- data/spec/models/customer_session_v2_spec.rb +6 -0
- data/spec/models/deactivate_user_request_spec.rb +41 -0
- data/spec/models/delete_user_request_spec.rb +41 -0
- data/spec/models/effect_entity_spec.rb +6 -0
- data/spec/models/effect_spec.rb +6 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/event_spec.rb +6 -0
- data/spec/models/event_v2_spec.rb +6 -0
- data/spec/models/expiring_coupons_notification_policy_spec.rb +53 -0
- data/spec/models/expiring_coupons_notification_trigger_spec.rb +51 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/get_integration_coupon_request_spec.rb +47 -0
- data/spec/models/identifiable_entity_spec.rb +41 -0
- data/spec/models/increase_achievement_progress_effect_props_spec.rb +77 -0
- data/spec/models/inline_response20013_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +0 -6
- data/spec/models/inline_response20019_spec.rb +1 -1
- data/spec/models/inline_response20021_spec.rb +0 -6
- data/spec/models/inline_response20022_spec.rb +2 -2
- data/spec/models/inline_response20024_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +0 -6
- data/spec/models/inline_response20031_spec.rb +1 -1
- data/spec/models/inline_response20032_spec.rb +1 -1
- data/spec/models/inline_response20033_spec.rb +6 -0
- data/spec/models/inline_response20035_spec.rb +6 -0
- data/spec/models/inline_response20038_spec.rb +0 -6
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response20041_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +53 -0
- data/spec/models/inline_response20043_spec.rb +47 -0
- data/spec/models/inline_response20044_spec.rb +47 -0
- data/spec/models/inline_response20045_spec.rb +53 -0
- data/spec/models/inline_response20046_spec.rb +47 -0
- data/spec/models/inline_response20047_spec.rb +47 -0
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +1 -1
- data/spec/models/integration_coupon_spec.rb +6 -0
- data/spec/models/integration_event_spec.rb +6 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/integration_store_entity_spec.rb +41 -0
- data/spec/models/inventory_coupon_spec.rb +6 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +89 -0
- data/spec/models/loyalty_card_balances_spec.rb +53 -0
- data/spec/models/loyalty_program_ledgers_spec.rb +6 -0
- data/spec/models/loyalty_program_spec.rb +54 -0
- data/spec/models/loyalty_program_subledgers_spec.rb +47 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/message_log_entries_spec.rb +47 -0
- data/spec/models/message_log_entry_spec.rb +105 -0
- data/spec/models/message_log_request_spec.rb +47 -0
- data/spec/models/message_log_response_spec.rb +53 -0
- data/spec/models/new_application_api_key_spec.rb +17 -1
- data/spec/models/new_application_spec.rb +0 -20
- data/spec/models/new_attribute_spec.rb +1 -1
- data/spec/models/new_base_notification_spec.rb +6 -0
- data/spec/models/new_campaign_evaluation_group_spec.rb +79 -0
- data/spec/models/new_campaign_spec.rb +23 -1
- data/spec/models/new_campaign_template_spec.rb +11 -1
- data/spec/models/new_coupons_spec.rb +6 -0
- data/spec/models/new_customer_session_v2_spec.rb +6 -0
- data/spec/models/new_event_spec.rb +6 -0
- data/spec/models/new_external_invitation_spec.rb +53 -0
- data/spec/models/new_invitation_spec.rb +7 -1
- data/spec/models/new_loyalty_program_spec.rb +36 -0
- data/spec/models/new_notification_test_spec.rb +79 -0
- data/spec/models/new_notification_webhook_spec.rb +6 -0
- data/spec/models/new_role_v2_spec.rb +59 -0
- data/spec/models/new_store_spec.rb +59 -0
- data/spec/models/notification_activation_spec.rb +41 -0
- data/spec/models/notification_list_item_spec.rb +59 -0
- data/spec/models/notification_test_spec.rb +47 -0
- data/spec/models/one_time_code_spec.rb +59 -0
- data/spec/models/outgoing_integration_clever_tap_policy_spec.rb +53 -0
- data/spec/models/outgoing_integration_iterable_policy_spec.rb +47 -0
- data/spec/models/outgoing_integration_mo_engage_policy_spec.rb +59 -0
- data/spec/models/outgoing_integration_template_spec.rb +87 -0
- data/spec/models/outgoing_integration_template_with_configuration_details_spec.rb +93 -0
- data/spec/models/outgoing_integration_templates_spec.rb +41 -0
- data/spec/models/patch_item_catalog_action_spec.rb +6 -0
- data/spec/models/pending_points_notification_policy_spec.rb +47 -0
- data/spec/models/product_spec.rb +41 -0
- data/spec/models/remove_from_audience_effect_props_spec.rb +59 -0
- data/spec/models/role_v2_application_details_spec.rb +6 -0
- data/spec/models/role_v2_base_spec.rb +59 -0
- data/spec/models/role_v2_permission_set_spec.rb +1 -1
- data/spec/models/role_v2_roles_group_spec.rb +53 -0
- data/spec/models/role_v2_spec.rb +21 -3
- data/spec/models/saml_connection_internal_spec.rb +47 -0
- data/spec/models/saml_login_endpoint_spec.rb +6 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +12 -0
- data/spec/models/sso_config_spec.rb +41 -0
- data/spec/models/store_spec.rb +89 -0
- data/spec/models/talang_attribute_spec.rb +1 -1
- data/spec/models/tier_downgrade_notification_policy_spec.rb +47 -0
- data/spec/models/tier_spec.rb +16 -0
- data/spec/models/tier_upgrade_notification_policy_spec.rb +47 -0
- data/spec/models/tier_will_downgrade_notification_policy_spec.rb +53 -0
- data/spec/models/tier_will_downgrade_notification_trigger_spec.rb +51 -0
- data/spec/models/time_point_spec.rb +71 -0
- data/spec/models/track_event_v2_response_spec.rb +89 -0
- data/spec/models/two_fa_config_spec.rb +47 -0
- data/spec/models/update_achievement_spec.rb +71 -0
- data/spec/models/update_application_api_key_spec.rb +41 -0
- data/spec/models/update_application_spec.rb +6 -20
- data/spec/models/update_campaign_evaluation_group_spec.rb +79 -0
- data/spec/models/update_campaign_spec.rb +23 -1
- data/spec/models/update_campaign_template_spec.rb +11 -1
- data/spec/models/update_coupon_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +36 -0
- data/spec/models/update_store_spec.rb +53 -0
- data/spec/models/update_user_spec.rb +12 -6
- data/spec/models/user_spec.rb +23 -5
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +123 -0
- metadata +716 -360
@@ -32,6 +32,18 @@ describe 'ManagementApi' do
|
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
|
+
# unit tests for activate_user_by_email
|
36
|
+
# Activate user by email address
|
37
|
+
# Activate a deactivated user by their email address.
|
38
|
+
# @param body body
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [nil]
|
41
|
+
describe 'activate_user_by_email 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 add_loyalty_card_points
|
36
48
|
# Add points to card
|
37
49
|
# Add points to the given loyalty card in the specified card-based loyalty program.
|
@@ -67,7 +79,7 @@ describe 'ManagementApi' do
|
|
67
79
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
68
80
|
# @param body body
|
69
81
|
# @param [Hash] opts the optional parameters
|
70
|
-
# @return [
|
82
|
+
# @return [InlineResponse2006]
|
71
83
|
describe 'copy_campaign_to_applications test' do
|
72
84
|
it 'should work' do
|
73
85
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -76,7 +88,7 @@ describe 'ManagementApi' do
|
|
76
88
|
|
77
89
|
# unit tests for create_account_collection
|
78
90
|
# Create account-level collection
|
79
|
-
# Create account-level collection.
|
91
|
+
# Create an account-level collection.
|
80
92
|
# @param body body
|
81
93
|
# @param [Hash] opts the optional parameters
|
82
94
|
# @return [Collection]
|
@@ -86,6 +98,20 @@ describe 'ManagementApi' do
|
|
86
98
|
end
|
87
99
|
end
|
88
100
|
|
101
|
+
# unit tests for create_achievement
|
102
|
+
# Create achievement
|
103
|
+
# Create a new achievement in a specific campaign.
|
104
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
105
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
106
|
+
# @param body body
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [Achievement]
|
109
|
+
describe 'create_achievement test' do
|
110
|
+
it 'should work' do
|
111
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
112
|
+
end
|
113
|
+
end
|
114
|
+
|
89
115
|
# unit tests for create_additional_cost
|
90
116
|
# Create additional cost
|
91
117
|
# Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). These additional costs are shared across all applications in your account, and are never required.
|
@@ -124,8 +150,8 @@ describe 'ManagementApi' do
|
|
124
150
|
end
|
125
151
|
|
126
152
|
# unit tests for create_collection
|
127
|
-
# Create collection
|
128
|
-
# Create a collection.
|
153
|
+
# Create campaign-level collection
|
154
|
+
# Create a campaign-level collection in a given campaign.
|
129
155
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
130
156
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
131
157
|
# @param body body
|
@@ -145,7 +171,7 @@ describe 'ManagementApi' do
|
|
145
171
|
# @param body body
|
146
172
|
# @param [Hash] opts the optional parameters
|
147
173
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
148
|
-
# @return [
|
174
|
+
# @return [InlineResponse2008]
|
149
175
|
describe 'create_coupons test' do
|
150
176
|
it 'should work' do
|
151
177
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -174,21 +200,32 @@ describe 'ManagementApi' do
|
|
174
200
|
# @param body body
|
175
201
|
# @param [Hash] opts the optional parameters
|
176
202
|
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
177
|
-
# @return [
|
203
|
+
# @return [InlineResponse2008]
|
178
204
|
describe 'create_coupons_for_multiple_recipients test' do
|
179
205
|
it 'should work' do
|
180
206
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
181
207
|
end
|
182
208
|
end
|
183
209
|
|
184
|
-
# unit tests for
|
185
|
-
#
|
186
|
-
#
|
187
|
-
# @param
|
210
|
+
# unit tests for create_invite_email
|
211
|
+
# Resend invitation email
|
212
|
+
# Resend an email invitation to an existing user. **Note:** The invitation token is valid for 24 hours after the email has been sent.
|
213
|
+
# @param body body
|
214
|
+
# @param [Hash] opts the optional parameters
|
215
|
+
# @return [NewInviteEmail]
|
216
|
+
describe 'create_invite_email test' do
|
217
|
+
it 'should work' do
|
218
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
219
|
+
end
|
220
|
+
end
|
221
|
+
|
222
|
+
# unit tests for create_invite_v2
|
223
|
+
# Invite user
|
224
|
+
# Create a new user in the account and send an invitation to their email address. **Note**: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the [Resend invitation email](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/createInviteEmail) endpoint.
|
188
225
|
# @param body body
|
189
226
|
# @param [Hash] opts the optional parameters
|
190
|
-
# @return [
|
191
|
-
describe '
|
227
|
+
# @return [User]
|
228
|
+
describe 'create_invite_v2 test' do
|
192
229
|
it 'should work' do
|
193
230
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
194
231
|
end
|
@@ -218,6 +255,31 @@ describe 'ManagementApi' do
|
|
218
255
|
end
|
219
256
|
end
|
220
257
|
|
258
|
+
# unit tests for create_store
|
259
|
+
# Create store
|
260
|
+
# Create a new store in a specific Application.
|
261
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
262
|
+
# @param body body
|
263
|
+
# @param [Hash] opts the optional parameters
|
264
|
+
# @return [Store]
|
265
|
+
describe 'create_store test' do
|
266
|
+
it 'should work' do
|
267
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
268
|
+
end
|
269
|
+
end
|
270
|
+
|
271
|
+
# unit tests for deactivate_user_by_email
|
272
|
+
# Deactivate user by email address
|
273
|
+
# Deactivate a specific user by their email address.
|
274
|
+
# @param body body
|
275
|
+
# @param [Hash] opts the optional parameters
|
276
|
+
# @return [nil]
|
277
|
+
describe 'deactivate_user_by_email test' do
|
278
|
+
it 'should work' do
|
279
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
280
|
+
end
|
281
|
+
end
|
282
|
+
|
221
283
|
# unit tests for deduct_loyalty_card_points
|
222
284
|
# Deduct points from card
|
223
285
|
# Deduct points from the given loyalty card in the specified card-based loyalty program.
|
@@ -234,8 +296,8 @@ describe 'ManagementApi' do
|
|
234
296
|
|
235
297
|
# unit tests for delete_account_collection
|
236
298
|
# Delete account-level collection
|
237
|
-
# Delete
|
238
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
299
|
+
# Delete a given account-level collection.
|
300
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
239
301
|
# @param [Hash] opts the optional parameters
|
240
302
|
# @return [nil]
|
241
303
|
describe 'delete_account_collection test' do
|
@@ -244,6 +306,20 @@ describe 'ManagementApi' do
|
|
244
306
|
end
|
245
307
|
end
|
246
308
|
|
309
|
+
# unit tests for delete_achievement
|
310
|
+
# Delete achievement
|
311
|
+
# Delete the specified achievement.
|
312
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
313
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
314
|
+
# @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
315
|
+
# @param [Hash] opts the optional parameters
|
316
|
+
# @return [nil]
|
317
|
+
describe 'delete_achievement test' do
|
318
|
+
it 'should work' do
|
319
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
320
|
+
end
|
321
|
+
end
|
322
|
+
|
247
323
|
# unit tests for delete_campaign
|
248
324
|
# Delete campaign
|
249
325
|
# Delete the given campaign.
|
@@ -258,11 +334,11 @@ describe 'ManagementApi' do
|
|
258
334
|
end
|
259
335
|
|
260
336
|
# unit tests for delete_collection
|
261
|
-
# Delete collection
|
262
|
-
# Delete
|
337
|
+
# Delete campaign-level collection
|
338
|
+
# Delete a given campaign-level collection.
|
263
339
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
264
340
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
265
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
341
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
266
342
|
# @param [Hash] opts the optional parameters
|
267
343
|
# @return [nil]
|
268
344
|
describe 'delete_collection test' do
|
@@ -292,12 +368,12 @@ describe 'ManagementApi' do
|
|
292
368
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
293
369
|
# @param [Hash] opts the optional parameters
|
294
370
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
295
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
296
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
297
|
-
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
298
|
-
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
299
|
-
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
300
|
-
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
371
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
372
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
373
|
+
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
374
|
+
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
375
|
+
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
376
|
+
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
301
377
|
# @option opts [String] :valid - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
302
378
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
303
379
|
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
@@ -324,28 +400,52 @@ describe 'ManagementApi' do
|
|
324
400
|
end
|
325
401
|
end
|
326
402
|
|
327
|
-
# unit tests for
|
328
|
-
# Delete
|
329
|
-
#
|
403
|
+
# unit tests for delete_referral
|
404
|
+
# Delete referral
|
405
|
+
# Delete the specified referral.
|
330
406
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
331
|
-
# @param
|
407
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
408
|
+
# @param referral_id The ID of the referral code.
|
332
409
|
# @param [Hash] opts the optional parameters
|
333
410
|
# @return [nil]
|
334
|
-
describe '
|
411
|
+
describe 'delete_referral test' do
|
335
412
|
it 'should work' do
|
336
413
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
337
414
|
end
|
338
415
|
end
|
339
416
|
|
340
|
-
# unit tests for
|
341
|
-
# Delete
|
342
|
-
# Delete the specified
|
417
|
+
# unit tests for delete_store
|
418
|
+
# Delete store
|
419
|
+
# Delete the specified store.
|
343
420
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
344
|
-
# @param
|
345
|
-
# @param referral_id The ID of the referral code.
|
421
|
+
# @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
|
346
422
|
# @param [Hash] opts the optional parameters
|
347
423
|
# @return [nil]
|
348
|
-
describe '
|
424
|
+
describe 'delete_store test' do
|
425
|
+
it 'should work' do
|
426
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
427
|
+
end
|
428
|
+
end
|
429
|
+
|
430
|
+
# unit tests for delete_user
|
431
|
+
# Delete user
|
432
|
+
# Delete a specific user.
|
433
|
+
# @param user_id The ID of the user.
|
434
|
+
# @param [Hash] opts the optional parameters
|
435
|
+
# @return [nil]
|
436
|
+
describe 'delete_user test' do
|
437
|
+
it 'should work' do
|
438
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
439
|
+
end
|
440
|
+
end
|
441
|
+
|
442
|
+
# unit tests for delete_user_by_email
|
443
|
+
# Delete user by email address
|
444
|
+
# Delete a specific user by their email address.
|
445
|
+
# @param body body
|
446
|
+
# @param [Hash] opts the optional parameters
|
447
|
+
# @return [nil]
|
448
|
+
describe 'delete_user_by_email test' do
|
349
449
|
it 'should work' do
|
350
450
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
351
451
|
end
|
@@ -364,8 +464,8 @@ describe 'ManagementApi' do
|
|
364
464
|
|
365
465
|
# unit tests for export_account_collection_items
|
366
466
|
# Export account-level collection's items
|
367
|
-
# Download a CSV file containing items from
|
368
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
467
|
+
# Download a CSV file containing items from a given account-level collection. **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/).
|
468
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
369
469
|
# @param [Hash] opts the optional parameters
|
370
470
|
# @return [String]
|
371
471
|
describe 'export_account_collection_items test' do
|
@@ -374,12 +474,38 @@ describe 'ManagementApi' do
|
|
374
474
|
end
|
375
475
|
end
|
376
476
|
|
477
|
+
# unit tests for export_achievements
|
478
|
+
# Export achievement customer data
|
479
|
+
# Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - `profileIntegrationID`: The integration ID of the customer profile participating in the achievement. - `title`: The display name of the achievement in the Campaign Manager. - `target`: The required number of actions or the transactional milestone to complete the achievement. - `progress`: The current progress of the customer in the achievement. - `status`: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. - `startDate`: The date on which the customer profile started the achievement in RFC3339. - `endDate`: The date on which the achievement ends and resets for the customer profile in RFC3339. - `completionDate`: The date on which the customer profile completed the achievement in RFC3339.
|
480
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
481
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
482
|
+
# @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
483
|
+
# @param [Hash] opts the optional parameters
|
484
|
+
# @return [String]
|
485
|
+
describe 'export_achievements test' do
|
486
|
+
it 'should work' do
|
487
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
488
|
+
end
|
489
|
+
end
|
490
|
+
|
491
|
+
# unit tests for export_audiences_memberships
|
492
|
+
# Export audience members
|
493
|
+
# Download a CSV file containing the integration IDs of the members of an audience. **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 file contains the following column: - `profileintegrationid`: The integration ID of the customer profile.
|
494
|
+
# @param audience_id The ID of the audience.
|
495
|
+
# @param [Hash] opts the optional parameters
|
496
|
+
# @return [String]
|
497
|
+
describe 'export_audiences_memberships test' do
|
498
|
+
it 'should work' do
|
499
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
500
|
+
end
|
501
|
+
end
|
502
|
+
|
377
503
|
# unit tests for export_collection_items
|
378
|
-
# Export
|
379
|
-
# Download a CSV file containing a collection
|
504
|
+
# Export campaign-level collection's items
|
505
|
+
# Download a CSV file containing items from a given campaign-level collection. **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/).
|
380
506
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
381
507
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
382
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
508
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
383
509
|
# @param [Hash] opts the optional parameters
|
384
510
|
# @return [String]
|
385
511
|
describe 'export_collection_items test' do
|
@@ -390,22 +516,23 @@ describe 'ManagementApi' do
|
|
390
516
|
|
391
517
|
# unit tests for export_coupons
|
392
518
|
# Export coupons
|
393
|
-
# Download a CSV file containing the coupons that match the given properties. **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
|
519
|
+
# Download a CSV file containing the coupons that match the given properties. **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 can contain the following columns: - `accountid`: The ID of your deployment. - `applicationid`: The ID of the Application this coupon is related to. - `attributes`: A json object describing _custom_ referral attribute names and their values. - `batchid`: The ID of the batch this coupon is part of. - `campaignid`: The ID of the campaign this coupon is related to. - `counter`: The number of times this coupon has been redeemed. - `created`: The creation date of the coupon code. - `deleted`: Whether the coupon code is deleted. - `deleted_changelogid`: The ID of the delete event in the logs. - `discount_counter`: The amount of discount given by this coupon. - `discount_limitval`: The maximum discount amount that can be given be this coupon. - `expirydate`: The end date in RFC3339 of the code redemption period. - `id`: The internal ID of the coupon code. - `importid`: The ID of the import job that created this coupon. - `is_reservation_mandatory`: Whether this coupon requires a reservation to be redeemed. - `limits`: The limits set on this coupon. - `limitval`: The maximum number of redemptions of this code. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `referralid`: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - `reservation`: Whether the coupon can be reserved for multiple customers. - `reservation_counter`: How many times this coupon has been reserved. - `reservation_limitval`: The maximum of number of reservations this coupon can have. - `startdate`: The start date in RFC3339 of the code redemption period. - `value`: The coupon code.
|
394
520
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
395
521
|
# @param [Hash] opts the optional parameters
|
396
522
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
397
523
|
# @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:** This parameter works only with numeric fields.
|
398
524
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
399
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
400
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
525
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
526
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
401
527
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
402
528
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
403
529
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
404
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
530
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field.
|
405
531
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
406
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
532
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
407
533
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
408
534
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
535
|
+
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
409
536
|
# @return [String]
|
410
537
|
describe 'export_coupons test' do
|
411
538
|
it 'should work' do
|
@@ -415,7 +542,7 @@ describe 'ManagementApi' do
|
|
415
542
|
|
416
543
|
# unit tests for export_customer_sessions
|
417
544
|
# Export customer sessions
|
418
|
-
# 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/product/server-infrastructure-and-data-retention#data-retention-policy). **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-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of the session. - `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. - `coupons`: Coupon codes in the session.
|
545
|
+
# 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/product/server-infrastructure-and-data-retention#data-retention-policy). **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.
|
419
546
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
420
547
|
# @param [Hash] opts the optional parameters
|
421
548
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
@@ -430,14 +557,28 @@ describe 'ManagementApi' do
|
|
430
557
|
end
|
431
558
|
end
|
432
559
|
|
560
|
+
# unit tests for export_customers_tiers
|
561
|
+
# Export customers' tier data
|
562
|
+
# Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - `programid`: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - `subledgerid`: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - `customerprofileid`: The ID used to integrate customer profiles with the loyalty program. - `tiername`: The name of the tier. - `startdate`: The tier start date in RFC3339. - `expirydate`: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - `subledgerId` (optional): Filter results by subledger ID. If no value is provided, all subledger data for the specified loyalty program will be exported. - `tierName` (optional): Filter results by tier name. If no value is provided, all tier data for the specified loyalty program will be exported.
|
563
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
564
|
+
# @param [Hash] opts the optional parameters
|
565
|
+
# @option opts [Array<String>] :subledger_ids An array of subledgers IDs to filter the export by.
|
566
|
+
# @option opts [Array<String>] :tier_names An array of tier names to filter the export by.
|
567
|
+
# @return [String]
|
568
|
+
describe 'export_customers_tiers test' do
|
569
|
+
it 'should work' do
|
570
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
571
|
+
end
|
572
|
+
end
|
573
|
+
|
433
574
|
# unit tests for export_effects
|
434
575
|
# Export triggered effects
|
435
|
-
# Download a CSV file containing the triggered effects that match the given attributes. **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: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue.
|
576
|
+
# Download a CSV file containing the triggered effects that match the given attributes. **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: - `applicationid`: The ID of the Application. - `campaignid`: The ID of the campaign. - `couponid`: The ID of the coupon, when applicable to the effect. - `created`: The timestamp of the effect. - `event_type`: The name of the event. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/events). - `eventid`: The internal ID of the effect. - `name`: The effect name. See the [docs](https://docs.talon.one/docs/dev/integration-api/api-effects). - `profileintegrationid`: The ID of the customer profile, when applicable. - `props`: The [properties](https://docs.talon.one/docs/dev/integration-api/api-effects) of the effect. - `ruleindex`: The index of the rule. - `rulesetid`: The ID of the rule set. - `sessionid`: The internal ID of the session that triggered the effect. - `profileid`: The internal ID of the customer profile. - `sessionintegrationid`: The integration ID of the session. - `total_revenue`: The total revenue. - `store_integration_id`: The integration ID of the store. You choose this ID when you create a store.
|
436
577
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
437
578
|
# @param [Hash] opts the optional parameters
|
438
579
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
439
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
440
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
580
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
581
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
441
582
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
442
583
|
# @return [String]
|
443
584
|
describe 'export_effects test' do
|
@@ -451,7 +592,7 @@ describe 'ManagementApi' do
|
|
451
592
|
# ⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the [Export customer loyalty balances to CSV](/management-api#tag/Loyalty/operation/exportLoyaltyBalances) endpoint. Download a CSV file containing the balance of each customer 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/).
|
452
593
|
# @param loyalty_program_id The identifier for the loyalty program.
|
453
594
|
# @param [Hash] opts the optional parameters
|
454
|
-
# @option opts [DateTime] :end_date Used to return
|
595
|
+
# @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **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.
|
455
596
|
# @return [String]
|
456
597
|
describe 'export_loyalty_balance test' do
|
457
598
|
it 'should work' do
|
@@ -464,7 +605,7 @@ describe 'ManagementApi' do
|
|
464
605
|
# Download a CSV file containing the balance of each customer 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: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `profileIntegrationID`: The integration ID of the customer profile. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points. - `currentTier`: The tier that the customer is in at the time of the export.
|
465
606
|
# @param loyalty_program_id The identifier for the loyalty program.
|
466
607
|
# @param [Hash] opts the optional parameters
|
467
|
-
# @option opts [DateTime] :end_date Used to return
|
608
|
+
# @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **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.
|
468
609
|
# @return [String]
|
469
610
|
describe 'export_loyalty_balances test' do
|
470
611
|
it 'should work' do
|
@@ -477,7 +618,7 @@ describe 'ManagementApi' do
|
|
477
618
|
# Download a CSV file containing the balances of all cards 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 CSV file contains the following columns: - `loyaltyProgramID`: The ID of the loyalty program. - `loyaltySubledger`: The name of the subdleger, when applicatble. - `cardIdentifier`: The alphanumeric identifier of the loyalty card. - `cardState`:The state of the loyalty card. It can be `active` or `inactive`. - `currentBalance`: The current point balance. - `pendingBalance`: The number of pending points. - `expiredBalance`: The number of expired points. - `spentBalance`: The number of spent points.
|
478
619
|
# @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.
|
479
620
|
# @param [Hash] opts the optional parameters
|
480
|
-
# @option opts [DateTime] :end_date Used to return
|
621
|
+
# @option opts [DateTime] :end_date Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. **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.
|
481
622
|
# @return [String]
|
482
623
|
describe 'export_loyalty_card_balances test' do
|
483
624
|
it 'should work' do
|
@@ -490,8 +631,8 @@ describe 'ManagementApi' do
|
|
490
631
|
# Download a CSV file containing a loyalty card ledger log of 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/).
|
491
632
|
# @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.
|
492
633
|
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
493
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
494
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
634
|
+
# @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.
|
635
|
+
# @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.
|
495
636
|
# @param [Hash] opts the optional parameters
|
496
637
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
497
638
|
# @return [String]
|
@@ -503,9 +644,9 @@ describe 'ManagementApi' do
|
|
503
644
|
|
504
645
|
# unit tests for export_loyalty_ledger
|
505
646
|
# Export customer's transaction logs
|
506
|
-
# 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 type of the loyalty program. - `name`: The name of the loyalty program. - `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.
|
507
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
508
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
647
|
+
# 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 type of the loyalty program. - `name`: The name of the loyalty program. - `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.
|
648
|
+
# @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.
|
649
|
+
# @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.
|
509
650
|
# @param loyalty_program_id The identifier for the loyalty program.
|
510
651
|
# @param integration_id The identifier of the profile.
|
511
652
|
# @param [Hash] opts the optional parameters
|
@@ -517,14 +658,28 @@ describe 'ManagementApi' do
|
|
517
658
|
end
|
518
659
|
end
|
519
660
|
|
661
|
+
# unit tests for export_pool_giveaways
|
662
|
+
# Export giveaway codes of a giveaway pool
|
663
|
+
# Download a CSV file containing the giveaway codes of a specific giveaway pool. **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: - `id`: The internal ID of the giveaway. - `poolid`: The internal ID of the giveaway pool. - `code`: The giveaway code. - `startdate`: The validity start date in RFC3339 of the giveaway (can be empty). - `enddate`: The validity end date in RFC3339 of the giveaway (can be empty). - `attributes`: Any custom attributes associated with the giveaway code (can be empty). - `used`: An indication of whether the giveaway is already awarded. - `importid`: The ID of the import which created the giveaway. - `created`: The creation time of the giveaway code. - `profileintegrationid`: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - `profileid`: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.
|
664
|
+
# @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
|
665
|
+
# @param [Hash] opts the optional parameters
|
666
|
+
# @option opts [DateTime] :created_before Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string.
|
667
|
+
# @option opts [DateTime] :created_after Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string.
|
668
|
+
# @return [String]
|
669
|
+
describe 'export_pool_giveaways test' do
|
670
|
+
it 'should work' do
|
671
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
672
|
+
end
|
673
|
+
end
|
674
|
+
|
520
675
|
# unit tests for export_referrals
|
521
676
|
# Export referrals
|
522
677
|
# Download a CSV file containing the referrals that match the given parameters. **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: - `code`: The referral code. - `advocateprofileintegrationid`: The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values.
|
523
678
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
524
679
|
# @param [Hash] opts the optional parameters
|
525
680
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
526
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any
|
527
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any
|
681
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
682
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
528
683
|
# @option opts [String] :valid - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
|
529
684
|
# @option opts [String] :usable - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
|
530
685
|
# @option opts [String] :batch_id Filter results by batches of referrals
|
@@ -540,16 +695,16 @@ describe 'ManagementApi' do
|
|
540
695
|
# Get access logs for Application
|
541
696
|
# Retrieve the list of API calls sent to the specified Application.
|
542
697
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
543
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
544
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
698
|
+
# @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.
|
699
|
+
# @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.
|
545
700
|
# @param [Hash] opts the optional parameters
|
546
701
|
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
547
702
|
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
548
703
|
# @option opts [String] :status Filter results by HTTP status codes.
|
549
|
-
# @option opts [Integer] :page_size The number of items in
|
550
|
-
# @option opts [Integer] :skip
|
704
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
705
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
551
706
|
# @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:** This parameter works only with numeric fields.
|
552
|
-
# @return [
|
707
|
+
# @return [InlineResponse20019]
|
553
708
|
describe 'get_access_logs_without_total_count test' do
|
554
709
|
it 'should work' do
|
555
710
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -583,7 +738,7 @@ describe 'ManagementApi' do
|
|
583
738
|
# unit tests for get_account_collection
|
584
739
|
# Get account-level collection
|
585
740
|
# Retrieve a given account-level collection.
|
586
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
741
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
587
742
|
# @param [Hash] opts the optional parameters
|
588
743
|
# @return [Collection]
|
589
744
|
describe 'get_account_collection test' do
|
@@ -592,6 +747,20 @@ describe 'ManagementApi' do
|
|
592
747
|
end
|
593
748
|
end
|
594
749
|
|
750
|
+
# unit tests for get_achievement
|
751
|
+
# Get achievement
|
752
|
+
# Get the details of a specific achievement.
|
753
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
754
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
755
|
+
# @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
756
|
+
# @param [Hash] opts the optional parameters
|
757
|
+
# @return [Achievement]
|
758
|
+
describe 'get_achievement test' do
|
759
|
+
it 'should work' do
|
760
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
761
|
+
end
|
762
|
+
end
|
763
|
+
|
595
764
|
# unit tests for get_additional_cost
|
596
765
|
# Get additional cost
|
597
766
|
# Returns the additional cost.
|
@@ -608,10 +777,10 @@ describe 'ManagementApi' do
|
|
608
777
|
# List additional costs
|
609
778
|
# Returns all the defined additional costs for the account.
|
610
779
|
# @param [Hash] opts the optional parameters
|
611
|
-
# @option opts [Integer] :page_size The number of items in
|
612
|
-
# @option opts [Integer] :skip
|
780
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
781
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
613
782
|
# @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:** This parameter works only with numeric fields.
|
614
|
-
# @return [
|
783
|
+
# @return [InlineResponse20036]
|
615
784
|
describe 'get_additional_costs test' do
|
616
785
|
it 'should work' do
|
617
786
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -621,33 +790,22 @@ describe 'ManagementApi' do
|
|
621
790
|
# unit tests for get_all_access_logs
|
622
791
|
# List access logs
|
623
792
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
624
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
625
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
626
793
|
# @param [Hash] opts the optional parameters
|
794
|
+
# @option opts [DateTime] :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.
|
795
|
+
# @option opts [DateTime] :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.
|
627
796
|
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
628
797
|
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
629
798
|
# @option opts [String] :status Filter results by HTTP status codes.
|
630
|
-
# @option opts [Integer] :page_size The number of items in
|
631
|
-
# @option opts [Integer] :skip
|
799
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
800
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
632
801
|
# @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:** This parameter works only with numeric fields.
|
633
|
-
# @return [
|
802
|
+
# @return [InlineResponse20020]
|
634
803
|
describe 'get_all_access_logs test' do
|
635
804
|
it 'should work' do
|
636
805
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
637
806
|
end
|
638
807
|
end
|
639
808
|
|
640
|
-
# unit tests for get_all_roles
|
641
|
-
# List roles
|
642
|
-
# List all roles.
|
643
|
-
# @param [Hash] opts the optional parameters
|
644
|
-
# @return [InlineResponse20040]
|
645
|
-
describe 'get_all_roles test' do
|
646
|
-
it 'should work' do
|
647
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
648
|
-
end
|
649
|
-
end
|
650
|
-
|
651
809
|
# unit tests for get_application
|
652
810
|
# Get Application
|
653
811
|
# Get the application specified by the ID.
|
@@ -691,11 +849,11 @@ describe 'ManagementApi' do
|
|
691
849
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
692
850
|
# @param integration_id The Integration ID of the Advocate's Profile.
|
693
851
|
# @param [Hash] opts the optional parameters
|
694
|
-
# @option opts [Integer] :page_size The number of items in
|
695
|
-
# @option opts [Integer] :skip
|
852
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
853
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
696
854
|
# @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:** This parameter works only with numeric fields.
|
697
855
|
# @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.
|
698
|
-
# @return [
|
856
|
+
# @return [InlineResponse20033]
|
699
857
|
describe 'get_application_customer_friends test' do
|
700
858
|
it 'should work' do
|
701
859
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -708,10 +866,10 @@ describe 'ManagementApi' do
|
|
708
866
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
709
867
|
# @param [Hash] opts the optional parameters
|
710
868
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
711
|
-
# @option opts [Integer] :page_size The number of items in
|
712
|
-
# @option opts [Integer] :skip
|
869
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
870
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
713
871
|
# @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.
|
714
|
-
# @return [
|
872
|
+
# @return [InlineResponse20022]
|
715
873
|
describe 'get_application_customers test' do
|
716
874
|
it 'should work' do
|
717
875
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -724,10 +882,10 @@ describe 'ManagementApi' do
|
|
724
882
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
725
883
|
# @param body body
|
726
884
|
# @param [Hash] opts the optional parameters
|
727
|
-
# @option opts [Integer] :page_size The number of items in
|
728
|
-
# @option opts [Integer] :skip
|
885
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
886
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
729
887
|
# @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.
|
730
|
-
# @return [
|
888
|
+
# @return [InlineResponse20023]
|
731
889
|
describe 'get_application_customers_by_attributes test' do
|
732
890
|
it 'should work' do
|
733
891
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -736,13 +894,13 @@ describe 'ManagementApi' do
|
|
736
894
|
|
737
895
|
# unit tests for get_application_event_types
|
738
896
|
# List Applications event types
|
739
|
-
# Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#operation/
|
897
|
+
# Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](https://docs.talon.one/integration-api#tag/Events/operation/trackEventV2)
|
740
898
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
741
899
|
# @param [Hash] opts the optional parameters
|
742
|
-
# @option opts [Integer] :page_size The number of items in
|
743
|
-
# @option opts [Integer] :skip
|
900
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
901
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
744
902
|
# @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:** This parameter works only with numeric fields.
|
745
|
-
# @return [
|
903
|
+
# @return [InlineResponse20029]
|
746
904
|
describe 'get_application_event_types test' do
|
747
905
|
it 'should work' do
|
748
906
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -754,12 +912,12 @@ describe 'ManagementApi' do
|
|
754
912
|
# Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
|
755
913
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
756
914
|
# @param [Hash] opts the optional parameters
|
757
|
-
# @option opts [Integer] :page_size The number of items in
|
758
|
-
# @option opts [Integer] :skip
|
915
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
916
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
759
917
|
# @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:** This parameter works only with numeric fields.
|
760
918
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
761
|
-
# @option opts [DateTime] :created_before Only return events created before this date. You can use any
|
762
|
-
# @option opts [DateTime] :created_after Only return events created after this date. You can use any
|
919
|
+
# @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.
|
920
|
+
# @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.
|
763
921
|
# @option opts [String] :session Session integration ID filter for events. Must be exact match.
|
764
922
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
765
923
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
@@ -768,7 +926,7 @@ describe 'ManagementApi' do
|
|
768
926
|
# @option opts [String] :referral_code Referral code
|
769
927
|
# @option opts [String] :rule_query Rule name filter for events
|
770
928
|
# @option opts [String] :campaign_query Campaign name filter for events
|
771
|
-
# @return [
|
929
|
+
# @return [InlineResponse20028]
|
772
930
|
describe 'get_application_events_without_total_count test' do
|
773
931
|
it 'should work' do
|
774
932
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -793,17 +951,18 @@ describe 'ManagementApi' do
|
|
793
951
|
# List all the sessions of the specified Application.
|
794
952
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
795
953
|
# @param [Hash] opts the optional parameters
|
796
|
-
# @option opts [Integer] :page_size The number of items in
|
797
|
-
# @option opts [Integer] :skip
|
954
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
955
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
798
956
|
# @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:** This parameter works only with numeric fields.
|
799
957
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
800
958
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
801
|
-
# @option opts [DateTime] :created_before Only return events created before this date. You can use any
|
802
|
-
# @option opts [DateTime] :created_after Only return events created after this date. You can use any
|
959
|
+
# @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.
|
960
|
+
# @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.
|
803
961
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
804
962
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
805
963
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
806
|
-
# @
|
964
|
+
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
965
|
+
# @return [InlineResponse20027]
|
807
966
|
describe 'get_application_sessions test' do
|
808
967
|
it 'should work' do
|
809
968
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -814,10 +973,10 @@ describe 'ManagementApi' do
|
|
814
973
|
# List Applications
|
815
974
|
# List all applications in the current account.
|
816
975
|
# @param [Hash] opts the optional parameters
|
817
|
-
# @option opts [Integer] :page_size The number of items in
|
818
|
-
# @option opts [Integer] :skip
|
976
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
977
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
819
978
|
# @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:** This parameter works only with numeric fields.
|
820
|
-
# @return [
|
979
|
+
# @return [InlineResponse2005]
|
821
980
|
describe 'get_applications test' do
|
822
981
|
it 'should work' do
|
823
982
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -840,32 +999,61 @@ describe 'ManagementApi' do
|
|
840
999
|
# List custom attributes
|
841
1000
|
# Return all the custom attributes for the account.
|
842
1001
|
# @param [Hash] opts the optional parameters
|
843
|
-
# @option opts [Integer] :page_size The number of items in
|
844
|
-
# @option opts [Integer] :skip
|
1002
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1003
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
845
1004
|
# @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:** This parameter works only with numeric fields.
|
846
1005
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
847
|
-
# @return [
|
1006
|
+
# @return [InlineResponse20034]
|
848
1007
|
describe 'get_attributes test' do
|
849
1008
|
it 'should work' do
|
850
1009
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
851
1010
|
end
|
852
1011
|
end
|
853
1012
|
|
1013
|
+
# unit tests for get_audience_memberships
|
1014
|
+
# List audience members
|
1015
|
+
# Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.
|
1016
|
+
# @param audience_id The ID of the audience.
|
1017
|
+
# @param [Hash] opts the optional parameters
|
1018
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1019
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1020
|
+
# @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:** This parameter works only with numeric fields.
|
1021
|
+
# @option opts [String] :profile_query The filter to select a profile.
|
1022
|
+
# @return [InlineResponse20032]
|
1023
|
+
describe 'get_audience_memberships test' do
|
1024
|
+
it 'should work' do
|
1025
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1026
|
+
end
|
1027
|
+
end
|
1028
|
+
|
854
1029
|
# unit tests for get_audiences
|
855
1030
|
# List audiences
|
856
1031
|
# Get all audiences created in the account. To create an audience, use [Create audience](https://docs.talon.one/integration-api#tag/Audiences/operation/createAudienceV2).
|
857
1032
|
# @param [Hash] opts the optional parameters
|
858
|
-
# @option opts [Integer] :page_size The number of items in
|
859
|
-
# @option opts [Integer] :skip
|
1033
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1034
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
860
1035
|
# @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:** This parameter works only with numeric fields.
|
861
1036
|
# @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.
|
862
|
-
# @return [
|
1037
|
+
# @return [InlineResponse20030]
|
863
1038
|
describe 'get_audiences test' do
|
864
1039
|
it 'should work' do
|
865
1040
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
866
1041
|
end
|
867
1042
|
end
|
868
1043
|
|
1044
|
+
# unit tests for get_audiences_analytics
|
1045
|
+
# List audience analytics
|
1046
|
+
# Get a list of audience IDs and their member count.
|
1047
|
+
# @param audience_ids The IDs of one or more audiences, separated by commas, by which to filter results.
|
1048
|
+
# @param [Hash] opts the optional parameters
|
1049
|
+
# @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:** This parameter works only with numeric fields.
|
1050
|
+
# @return [InlineResponse20031]
|
1051
|
+
describe 'get_audiences_analytics test' do
|
1052
|
+
it 'should work' do
|
1053
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1054
|
+
end
|
1055
|
+
end
|
1056
|
+
|
869
1057
|
# unit tests for get_campaign
|
870
1058
|
# Get campaign
|
871
1059
|
# Retrieve the given campaign.
|
@@ -884,11 +1072,11 @@ describe 'ManagementApi' do
|
|
884
1072
|
# Retrieve statistical data about the performance of the given campaign.
|
885
1073
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
886
1074
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
887
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
888
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
1075
|
+
# @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.
|
1076
|
+
# @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.
|
889
1077
|
# @param [Hash] opts the optional parameters
|
890
1078
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
891
|
-
# @return [
|
1079
|
+
# @return [InlineResponse20021]
|
892
1080
|
describe 'get_campaign_analytics test' do
|
893
1081
|
it 'should work' do
|
894
1082
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -901,29 +1089,55 @@ describe 'ManagementApi' do
|
|
901
1089
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
902
1090
|
# @param body body
|
903
1091
|
# @param [Hash] opts the optional parameters
|
904
|
-
# @option opts [Integer] :page_size The number of items in
|
905
|
-
# @option opts [Integer] :skip
|
1092
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1093
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
906
1094
|
# @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:** This parameter works only with numeric fields.
|
907
1095
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
908
|
-
# @return [
|
1096
|
+
# @return [InlineResponse2006]
|
909
1097
|
describe 'get_campaign_by_attributes test' do
|
910
1098
|
it 'should work' do
|
911
1099
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
912
1100
|
end
|
913
1101
|
end
|
914
1102
|
|
1103
|
+
# unit tests for get_campaign_group
|
1104
|
+
# Get campaign access group
|
1105
|
+
# Get a campaign access group specified by its ID.
|
1106
|
+
# @param campaign_group_id The ID of the campaign access group.
|
1107
|
+
# @param [Hash] opts the optional parameters
|
1108
|
+
# @return [CampaignGroup]
|
1109
|
+
describe 'get_campaign_group test' do
|
1110
|
+
it 'should work' do
|
1111
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1112
|
+
end
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# unit tests for get_campaign_groups
|
1116
|
+
# List campaign access groups
|
1117
|
+
# List the campaign access groups in the current account.
|
1118
|
+
# @param [Hash] opts the optional parameters
|
1119
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1120
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1121
|
+
# @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:** This parameter works only with numeric fields.
|
1122
|
+
# @return [InlineResponse20011]
|
1123
|
+
describe 'get_campaign_groups test' do
|
1124
|
+
it 'should work' do
|
1125
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1126
|
+
end
|
1127
|
+
end
|
1128
|
+
|
915
1129
|
# unit tests for get_campaign_templates
|
916
1130
|
# List campaign templates
|
917
1131
|
# Retrieve a list of campaign templates.
|
918
1132
|
# @param [Hash] opts the optional parameters
|
919
|
-
# @option opts [Integer] :page_size The number of items in
|
920
|
-
# @option opts [Integer] :skip
|
1133
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1134
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
921
1135
|
# @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:** This parameter works only with numeric fields.
|
922
1136
|
# @option opts [String] :state Filter results by the state of the campaign template.
|
923
1137
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
924
1138
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
925
1139
|
# @option opts [Integer] :user_id Filter results by user ID.
|
926
|
-
# @return [
|
1140
|
+
# @return [InlineResponse20012]
|
927
1141
|
describe 'get_campaign_templates test' do
|
928
1142
|
it 'should work' do
|
929
1143
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -935,17 +1149,18 @@ describe 'ManagementApi' do
|
|
935
1149
|
# List the campaigns of the specified application that match your filter criteria.
|
936
1150
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
937
1151
|
# @param [Hash] opts the optional parameters
|
938
|
-
# @option opts [Integer] :page_size The number of items in
|
939
|
-
# @option opts [Integer] :skip
|
1152
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1153
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
940
1154
|
# @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:** This parameter works only with numeric fields.
|
941
1155
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
942
1156
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
943
1157
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
944
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any
|
945
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any
|
946
|
-
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
1158
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1159
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1160
|
+
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
947
1161
|
# @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
|
948
|
-
# @
|
1162
|
+
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
1163
|
+
# @return [InlineResponse2006]
|
949
1164
|
describe 'get_campaigns test' do
|
950
1165
|
it 'should work' do
|
951
1166
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -956,18 +1171,18 @@ describe 'ManagementApi' do
|
|
956
1171
|
# Get audit logs for an account
|
957
1172
|
# Retrieve the audit logs displayed in **Accounts > Audit logs**.
|
958
1173
|
# @param [Hash] opts the optional parameters
|
959
|
-
# @option opts [Integer] :page_size The number of items in
|
960
|
-
# @option opts [Integer] :skip
|
1174
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1175
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
961
1176
|
# @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:** This parameter works only with numeric fields.
|
962
1177
|
# @option opts [Float] :application_id Filter results by Application ID.
|
963
1178
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
964
1179
|
# @option opts [Integer] :user_id Filter results by user ID.
|
965
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any
|
966
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any
|
1180
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1181
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
967
1182
|
# @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.
|
968
1183
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
969
1184
|
# @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.
|
970
|
-
# @return [
|
1185
|
+
# @return [InlineResponse20042]
|
971
1186
|
describe 'get_changes test' do
|
972
1187
|
it 'should work' do
|
973
1188
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -975,11 +1190,11 @@ describe 'ManagementApi' do
|
|
975
1190
|
end
|
976
1191
|
|
977
1192
|
# unit tests for get_collection
|
978
|
-
# Get collection
|
979
|
-
# Retrieve a given collection.
|
1193
|
+
# Get campaign-level collection
|
1194
|
+
# Retrieve a given campaign-level collection.
|
980
1195
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
981
1196
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
982
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
1197
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
983
1198
|
# @param [Hash] opts the optional parameters
|
984
1199
|
# @return [Collection]
|
985
1200
|
describe 'get_collection test' do
|
@@ -990,12 +1205,12 @@ describe 'ManagementApi' do
|
|
990
1205
|
|
991
1206
|
# unit tests for get_collection_items
|
992
1207
|
# Get collection items
|
993
|
-
# Retrieve
|
994
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
1208
|
+
# Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.
|
1209
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
995
1210
|
# @param [Hash] opts the optional parameters
|
996
|
-
# @option opts [Integer] :page_size The number of items in
|
997
|
-
# @option opts [Integer] :skip
|
998
|
-
# @return [
|
1211
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1212
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1213
|
+
# @return [InlineResponse20018]
|
999
1214
|
describe 'get_collection_items test' do
|
1000
1215
|
it 'should work' do
|
1001
1216
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1008,19 +1223,19 @@ describe 'ManagementApi' do
|
|
1008
1223
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1009
1224
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1010
1225
|
# @param [Hash] opts the optional parameters
|
1011
|
-
# @option opts [Integer] :page_size The number of items in
|
1012
|
-
# @option opts [Integer] :skip
|
1226
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1227
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1013
1228
|
# @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:** This parameter works only with numeric fields.
|
1014
1229
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1015
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
1016
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
1230
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1231
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1017
1232
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
1018
1233
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
1019
1234
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
1020
1235
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1021
1236
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1022
1237
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1023
|
-
# @return [
|
1238
|
+
# @return [InlineResponse2009]
|
1024
1239
|
describe 'get_coupons_without_total_count test' do
|
1025
1240
|
it 'should work' do
|
1026
1241
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1030,13 +1245,13 @@ describe 'ManagementApi' do
|
|
1030
1245
|
# unit tests for get_customer_activity_report
|
1031
1246
|
# Get customer's activity report
|
1032
1247
|
# Fetch the summary report of a given customer in the given application, in a time range.
|
1033
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
1034
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
1248
|
+
# @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.
|
1249
|
+
# @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.
|
1035
1250
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1036
1251
|
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
1037
1252
|
# @param [Hash] opts the optional parameters
|
1038
|
-
# @option opts [Integer] :page_size The number of items in
|
1039
|
-
# @option opts [Integer] :skip
|
1253
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1254
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1040
1255
|
# @return [CustomerActivityReport]
|
1041
1256
|
describe 'get_customer_activity_report test' do
|
1042
1257
|
it 'should work' do
|
@@ -1047,18 +1262,18 @@ describe 'ManagementApi' do
|
|
1047
1262
|
# unit tests for get_customer_activity_reports_without_total_count
|
1048
1263
|
# Get Activity Reports for Application Customers
|
1049
1264
|
# Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.
|
1050
|
-
# @param range_start Only return results from after this timestamp. This must be an RFC3339 timestamp string.
|
1051
|
-
# @param range_end Only return results from before this timestamp. This must be an RFC3339 timestamp string.
|
1265
|
+
# @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.
|
1266
|
+
# @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.
|
1052
1267
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1053
1268
|
# @param [Hash] opts the optional parameters
|
1054
|
-
# @option opts [Integer] :page_size The number of items in
|
1055
|
-
# @option opts [Integer] :skip
|
1269
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1270
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1056
1271
|
# @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:** This parameter works only with numeric fields.
|
1057
1272
|
# @option opts [String] :name Only return reports matching the customer name
|
1058
1273
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
1059
1274
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
1060
1275
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
1061
|
-
# @return [
|
1276
|
+
# @return [InlineResponse20026]
|
1062
1277
|
describe 'get_customer_activity_reports_without_total_count test' do
|
1063
1278
|
it 'should work' do
|
1064
1279
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1071,8 +1286,8 @@ describe 'ManagementApi' do
|
|
1071
1286
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1072
1287
|
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
1073
1288
|
# @param [Hash] opts the optional parameters
|
1074
|
-
# @option opts [Integer] :page_size The number of items in
|
1075
|
-
# @option opts [Integer] :skip
|
1289
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1290
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1076
1291
|
# @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:** This parameter works only with numeric fields.
|
1077
1292
|
# @return [CustomerAnalytics]
|
1078
1293
|
describe 'get_customer_analytics test' do
|
@@ -1093,14 +1308,31 @@ describe 'ManagementApi' do
|
|
1093
1308
|
end
|
1094
1309
|
end
|
1095
1310
|
|
1311
|
+
# unit tests for get_customer_profile_achievement_progress
|
1312
|
+
# List customer achievements
|
1313
|
+
# For the given customer profile, list all the achievements that match your filter criteria.
|
1314
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1315
|
+
# @param integration_id The identifier of the profile.
|
1316
|
+
# @param [Hash] opts the optional parameters
|
1317
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1318
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1319
|
+
# @option opts [Integer] :achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
1320
|
+
# @option opts [String] :title Filter results by the `title` of an achievement.
|
1321
|
+
# @return [InlineResponse20047]
|
1322
|
+
describe 'get_customer_profile_achievement_progress test' do
|
1323
|
+
it 'should work' do
|
1324
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1325
|
+
end
|
1326
|
+
end
|
1327
|
+
|
1096
1328
|
# unit tests for get_customer_profiles
|
1097
1329
|
# List customer profiles
|
1098
1330
|
# List all customer profiles.
|
1099
1331
|
# @param [Hash] opts the optional parameters
|
1100
|
-
# @option opts [Integer] :page_size The number of items in
|
1101
|
-
# @option opts [Integer] :skip
|
1332
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1333
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1102
1334
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
1103
|
-
# @return [
|
1335
|
+
# @return [InlineResponse20025]
|
1104
1336
|
describe 'get_customer_profiles test' do
|
1105
1337
|
it 'should work' do
|
1106
1338
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1112,10 +1344,10 @@ describe 'ManagementApi' do
|
|
1112
1344
|
# Get a list of the customer profiles matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.
|
1113
1345
|
# @param body body
|
1114
1346
|
# @param [Hash] opts the optional parameters
|
1115
|
-
# @option opts [Integer] :page_size The number of items in
|
1116
|
-
# @option opts [Integer] :skip
|
1347
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1348
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1117
1349
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or Live customer.
|
1118
|
-
# @return [
|
1350
|
+
# @return [InlineResponse20024]
|
1119
1351
|
describe 'get_customers_by_attributes test' do
|
1120
1352
|
it 'should work' do
|
1121
1353
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1128,10 +1360,10 @@ describe 'ManagementApi' do
|
|
1128
1360
|
# @param [Hash] opts the optional parameters
|
1129
1361
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
1130
1362
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
1131
|
-
# @option opts [Integer] :page_size The number of items in
|
1132
|
-
# @option opts [Integer] :skip
|
1363
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1364
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1133
1365
|
# @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:** This parameter works only with numeric fields.
|
1134
|
-
# @return [
|
1366
|
+
# @return [InlineResponse20040]
|
1135
1367
|
describe 'get_event_types test' do
|
1136
1368
|
it 'should work' do
|
1137
1369
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1142,12 +1374,12 @@ describe 'ManagementApi' do
|
|
1142
1374
|
# Get exports
|
1143
1375
|
# List all past exports
|
1144
1376
|
# @param [Hash] opts the optional parameters
|
1145
|
-
# @option opts [Integer] :page_size The number of items in
|
1146
|
-
# @option opts [Integer] :skip
|
1377
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1378
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1147
1379
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1148
1380
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
1149
1381
|
# @option opts [String] :entity The name of the entity type that was exported.
|
1150
|
-
# @return [
|
1382
|
+
# @return [InlineResponse20043]
|
1151
1383
|
describe 'get_exports test' do
|
1152
1384
|
it 'should work' do
|
1153
1385
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1169,16 +1401,16 @@ describe 'ManagementApi' do
|
|
1169
1401
|
|
1170
1402
|
# unit tests for get_loyalty_card_transaction_logs
|
1171
1403
|
# List card's transactions
|
1172
|
-
# Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/
|
1404
|
+
# Retrieve the transaction logs for the given [loyalty card](https://docs.talon.one/docs/product/loyalty-programs/card-based/card-based-overview) within the specified [card-based loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types) with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.
|
1173
1405
|
# @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.
|
1174
1406
|
# @param loyalty_card_id Identifier of the loyalty card. You can get the identifier with the [List loyalty cards](https://docs.talon.one/management-api#tag/Loyalty-cards/operation/getLoyaltyCards) endpoint.
|
1175
1407
|
# @param [Hash] opts the optional parameters
|
1176
|
-
# @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.
|
1177
|
-
# @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.
|
1178
|
-
# @option opts [Integer] :page_size The number of items in
|
1179
|
-
# @option opts [Integer] :skip
|
1408
|
+
# @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.
|
1409
|
+
# @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.
|
1410
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1411
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1180
1412
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1181
|
-
# @return [
|
1413
|
+
# @return [InlineResponse20016]
|
1182
1414
|
describe 'get_loyalty_card_transaction_logs test' do
|
1183
1415
|
it 'should work' do
|
1184
1416
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1190,12 +1422,12 @@ describe 'ManagementApi' do
|
|
1190
1422
|
# For the given card-based loyalty program, list the loyalty cards that match your filter criteria.
|
1191
1423
|
# @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.
|
1192
1424
|
# @param [Hash] opts the optional parameters
|
1193
|
-
# @option opts [Integer] :page_size The number of items in
|
1194
|
-
# @option opts [Integer] :skip
|
1425
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1426
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1195
1427
|
# @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:** This parameter works only with numeric fields.
|
1196
1428
|
# @option opts [String] :identifier Optional query parameter to search cards by identifier.
|
1197
1429
|
# @option opts [Integer] :profile_id Filter by the profile ID.
|
1198
|
-
# @return [
|
1430
|
+
# @return [InlineResponse20015]
|
1199
1431
|
describe 'get_loyalty_cards test' do
|
1200
1432
|
it 'should work' do
|
1201
1433
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1218,7 +1450,7 @@ describe 'ManagementApi' do
|
|
1218
1450
|
# unit tests for get_loyalty_program
|
1219
1451
|
# Get loyalty program
|
1220
1452
|
# Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-programs/overview). To list all loyalty programs in your Application, use [List loyalty programs](#operation/getLoyaltyPrograms). To list the loyalty programs that a customer profile is part of, use the [List customer data](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/getCustomerInventory)
|
1221
|
-
# @param loyalty_program_id Identifier of the
|
1453
|
+
# @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.
|
1222
1454
|
# @param [Hash] opts the optional parameters
|
1223
1455
|
# @return [LoyaltyProgram]
|
1224
1456
|
describe 'get_loyalty_program test' do
|
@@ -1229,16 +1461,16 @@ describe 'ManagementApi' do
|
|
1229
1461
|
|
1230
1462
|
# unit tests for get_loyalty_program_transactions
|
1231
1463
|
# List loyalty program transactions
|
1232
|
-
# Retrieve
|
1233
|
-
# @param loyalty_program_id Identifier of the
|
1464
|
+
# Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. **Note:** If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
1465
|
+
# @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.
|
1234
1466
|
# @param [Hash] opts the optional parameters
|
1235
1467
|
# @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.
|
1236
1468
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1237
|
-
# @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.
|
1238
|
-
# @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.
|
1239
|
-
# @option opts [Integer] :page_size The number of items in
|
1240
|
-
# @option opts [Integer] :skip
|
1241
|
-
# @return [
|
1469
|
+
# @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.
|
1470
|
+
# @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.
|
1471
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1472
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1473
|
+
# @return [InlineResponse20014]
|
1242
1474
|
describe 'get_loyalty_program_transactions test' do
|
1243
1475
|
it 'should work' do
|
1244
1476
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1249,7 +1481,7 @@ describe 'ManagementApi' do
|
|
1249
1481
|
# List loyalty programs
|
1250
1482
|
# List the loyalty programs of the account.
|
1251
1483
|
# @param [Hash] opts the optional parameters
|
1252
|
-
# @return [
|
1484
|
+
# @return [InlineResponse20013]
|
1253
1485
|
describe 'get_loyalty_programs test' do
|
1254
1486
|
it 'should work' do
|
1255
1487
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1259,69 +1491,44 @@ describe 'ManagementApi' do
|
|
1259
1491
|
# unit tests for get_loyalty_statistics
|
1260
1492
|
# Get loyalty program statistics
|
1261
1493
|
# Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
1262
|
-
# @param loyalty_program_id Identifier of the
|
1494
|
+
# @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.
|
1263
1495
|
# @param [Hash] opts the optional parameters
|
1264
|
-
# @return [
|
1496
|
+
# @return [LoyaltyDashboardData]
|
1265
1497
|
describe 'get_loyalty_statistics test' do
|
1266
1498
|
it 'should work' do
|
1267
1499
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1268
1500
|
end
|
1269
1501
|
end
|
1270
1502
|
|
1271
|
-
# unit tests for get_notification_webhook
|
1272
|
-
# Get notification about campaign-related changes
|
1273
|
-
# Return the given [notification about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications).
|
1274
|
-
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1275
|
-
# @param notification_webhook_id The ID of the webhook. Get it with the appropriate _List notifications_ endpoint.
|
1276
|
-
# @param [Hash] opts the optional parameters
|
1277
|
-
# @return [NotificationWebhook]
|
1278
|
-
describe 'get_notification_webhook test' do
|
1279
|
-
it 'should work' do
|
1280
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1281
|
-
end
|
1282
|
-
end
|
1283
|
-
|
1284
|
-
# unit tests for get_notification_webhooks
|
1285
|
-
# List notifications about campaign-related changes
|
1286
|
-
# List all [notifications about campaign-related changes](https://docs.talon.one/docs/product/applications/outbound-notifications) for the given Application.
|
1287
|
-
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1288
|
-
# @param [Hash] opts the optional parameters
|
1289
|
-
# @return [InlineResponse2005]
|
1290
|
-
describe 'get_notification_webhooks test' do
|
1291
|
-
it 'should work' do
|
1292
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1293
|
-
end
|
1294
|
-
end
|
1295
|
-
|
1296
1503
|
# unit tests for get_referrals_without_total_count
|
1297
1504
|
# List referrals
|
1298
1505
|
# List all referrals of the specified campaign.
|
1299
1506
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1300
1507
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1301
1508
|
# @param [Hash] opts the optional parameters
|
1302
|
-
# @option opts [Integer] :page_size The number of items in
|
1303
|
-
# @option opts [Integer] :skip
|
1509
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1510
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1304
1511
|
# @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:** This parameter works only with numeric fields.
|
1305
1512
|
# @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1306
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any
|
1307
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any
|
1513
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1514
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1308
1515
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
1309
1516
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
1310
1517
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
1311
|
-
# @return [
|
1518
|
+
# @return [InlineResponse20010]
|
1312
1519
|
describe 'get_referrals_without_total_count test' do
|
1313
1520
|
it 'should work' do
|
1314
1521
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1315
1522
|
end
|
1316
1523
|
end
|
1317
1524
|
|
1318
|
-
# unit tests for
|
1525
|
+
# unit tests for get_role_v2
|
1319
1526
|
# Get role
|
1320
|
-
# Get the details of
|
1321
|
-
# @param role_id The
|
1527
|
+
# Get the details of a specific role. To see all the roles, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
1528
|
+
# @param role_id The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
1322
1529
|
# @param [Hash] opts the optional parameters
|
1323
|
-
# @return [
|
1324
|
-
describe '
|
1530
|
+
# @return [RoleV2]
|
1531
|
+
describe 'get_role_v2 test' do
|
1325
1532
|
it 'should work' do
|
1326
1533
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1327
1534
|
end
|
@@ -1347,16 +1554,29 @@ describe 'ManagementApi' do
|
|
1347
1554
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1348
1555
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1349
1556
|
# @param [Hash] opts the optional parameters
|
1350
|
-
# @option opts [Integer] :page_size The number of items in
|
1351
|
-
# @option opts [Integer] :skip
|
1557
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1558
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1352
1559
|
# @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:** This parameter works only with numeric fields.
|
1353
|
-
# @return [
|
1560
|
+
# @return [InlineResponse2007]
|
1354
1561
|
describe 'get_rulesets test' do
|
1355
1562
|
it 'should work' do
|
1356
1563
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1357
1564
|
end
|
1358
1565
|
end
|
1359
1566
|
|
1567
|
+
# unit tests for get_store
|
1568
|
+
# Get store
|
1569
|
+
# Get store details for a specific store ID.
|
1570
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1571
|
+
# @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
|
1572
|
+
# @param [Hash] opts the optional parameters
|
1573
|
+
# @return [Store]
|
1574
|
+
describe 'get_store test' do
|
1575
|
+
it 'should work' do
|
1576
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1577
|
+
end
|
1578
|
+
end
|
1579
|
+
|
1360
1580
|
# unit tests for get_user
|
1361
1581
|
# Get user
|
1362
1582
|
# Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
|
@@ -1373,10 +1593,10 @@ describe 'ManagementApi' do
|
|
1373
1593
|
# List users in account
|
1374
1594
|
# Retrieve all users in your account.
|
1375
1595
|
# @param [Hash] opts the optional parameters
|
1376
|
-
# @option opts [Integer] :page_size The number of items in
|
1377
|
-
# @option opts [Integer] :skip
|
1596
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1597
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1378
1598
|
# @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:** This parameter works only with numeric fields.
|
1379
|
-
# @return [
|
1599
|
+
# @return [InlineResponse20041]
|
1380
1600
|
describe 'get_users test' do
|
1381
1601
|
it 'should work' do
|
1382
1602
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1399,16 +1619,16 @@ describe 'ManagementApi' do
|
|
1399
1619
|
# List webhook activation log entries
|
1400
1620
|
# 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).
|
1401
1621
|
# @param [Hash] opts the optional parameters
|
1402
|
-
# @option opts [Integer] :page_size The number of items in
|
1403
|
-
# @option opts [Integer] :skip
|
1622
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1623
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1404
1624
|
# @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:** This parameter works only with numeric fields.
|
1405
1625
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
1406
1626
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
1407
1627
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1408
1628
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1409
|
-
# @option opts [DateTime] :created_before Only return events created before this date. You can use any
|
1410
|
-
# @option opts [DateTime] :created_after Only return events created after this date. You can use any
|
1411
|
-
# @return [
|
1629
|
+
# @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.
|
1630
|
+
# @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.
|
1631
|
+
# @return [InlineResponse20038]
|
1412
1632
|
describe 'get_webhook_activation_logs test' do
|
1413
1633
|
it 'should work' do
|
1414
1634
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1419,17 +1639,17 @@ describe 'ManagementApi' do
|
|
1419
1639
|
# List webhook log entries
|
1420
1640
|
# Retrieve all webhook log entries.
|
1421
1641
|
# @param [Hash] opts the optional parameters
|
1422
|
-
# @option opts [Integer] :page_size The number of items in
|
1423
|
-
# @option opts [Integer] :skip
|
1642
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1643
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1424
1644
|
# @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:** This parameter works only with numeric fields.
|
1425
1645
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1426
1646
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
1427
1647
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1428
1648
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1429
1649
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1430
|
-
# @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
|
1431
|
-
# @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
|
1432
|
-
# @return [
|
1650
|
+
# @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.
|
1651
|
+
# @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.
|
1652
|
+
# @return [InlineResponse20039]
|
1433
1653
|
describe 'get_webhook_logs test' do
|
1434
1654
|
it 'should work' do
|
1435
1655
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1440,11 +1660,15 @@ describe 'ManagementApi' do
|
|
1440
1660
|
# List webhooks
|
1441
1661
|
# List all webhooks.
|
1442
1662
|
# @param [Hash] opts the optional parameters
|
1443
|
-
# @option opts [String] :application_ids Filter by one or more
|
1663
|
+
# @option opts [String] :application_ids Filter by one or more Application IDs, separated by a comma.
|
1444
1664
|
# @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:** This parameter works only with numeric fields.
|
1445
|
-
# @option opts [Integer] :page_size The number of items in
|
1446
|
-
# @option opts [Integer] :skip
|
1447
|
-
# @
|
1665
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1666
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1667
|
+
# @option opts [String] :creation_type Filter results by creation type.
|
1668
|
+
# @option opts [String] :visibility Filter results by visibility.
|
1669
|
+
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
1670
|
+
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
1671
|
+
# @return [InlineResponse20037]
|
1448
1672
|
describe 'get_webhooks test' do
|
1449
1673
|
it 'should work' do
|
1450
1674
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1452,11 +1676,11 @@ describe 'ManagementApi' do
|
|
1452
1676
|
end
|
1453
1677
|
|
1454
1678
|
# unit tests for import_account_collection
|
1455
|
-
# Import data
|
1679
|
+
# Import data into existing account-level collection
|
1456
1680
|
# Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
1457
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
1681
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
1458
1682
|
# @param [Hash] opts the optional parameters
|
1459
|
-
# @option opts [String] :up_file The file
|
1683
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1460
1684
|
# @return [Import]
|
1461
1685
|
describe 'import_account_collection test' do
|
1462
1686
|
it 'should work' do
|
@@ -1469,7 +1693,7 @@ describe 'ManagementApi' do
|
|
1469
1693
|
# Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
|
1470
1694
|
# @param attribute_id The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
1471
1695
|
# @param [Hash] opts the optional parameters
|
1472
|
-
# @option opts [String] :up_file The file
|
1696
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1473
1697
|
# @return [Import]
|
1474
1698
|
describe 'import_allowed_list test' do
|
1475
1699
|
it 'should work' do
|
@@ -1477,14 +1701,27 @@ describe 'ManagementApi' do
|
|
1477
1701
|
end
|
1478
1702
|
end
|
1479
1703
|
|
1704
|
+
# unit tests for import_audiences_memberships
|
1705
|
+
# Import audience members
|
1706
|
+
# Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
|
1707
|
+
# @param audience_id The ID of the audience.
|
1708
|
+
# @param [Hash] opts the optional parameters
|
1709
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1710
|
+
# @return [Import]
|
1711
|
+
describe 'import_audiences_memberships test' do
|
1712
|
+
it 'should work' do
|
1713
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1714
|
+
end
|
1715
|
+
end
|
1716
|
+
|
1480
1717
|
# unit tests for import_collection
|
1481
|
-
# Import data
|
1718
|
+
# Import data into existing campaign-level collection
|
1482
1719
|
# Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
1483
1720
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1484
1721
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1485
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
1722
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
1486
1723
|
# @param [Hash] opts the optional parameters
|
1487
|
-
# @option opts [String] :up_file The file
|
1724
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1488
1725
|
# @return [Import]
|
1489
1726
|
describe 'import_collection test' do
|
1490
1727
|
it 'should work' do
|
@@ -1494,11 +1731,12 @@ describe 'ManagementApi' do
|
|
1494
1731
|
|
1495
1732
|
# unit tests for import_coupons
|
1496
1733
|
# Import coupons
|
1497
|
-
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the
|
1734
|
+
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
|
1498
1735
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1499
1736
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1500
1737
|
# @param [Hash] opts the optional parameters
|
1501
|
-
# @option opts [
|
1738
|
+
# @option opts [Boolean] :skip_duplicates An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
|
1739
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1502
1740
|
# @return [Import]
|
1503
1741
|
describe 'import_coupons test' do
|
1504
1742
|
it 'should work' do
|
@@ -1511,7 +1749,7 @@ describe 'ManagementApi' do
|
|
1511
1749
|
# Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - `identifier` (required): The alphanumeric identifier of the loyalty card. - `state` (required): The state of the loyalty card. It can be `active` or `inactive`. - `customerprofileids` (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA ```
|
1512
1750
|
# @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.
|
1513
1751
|
# @param [Hash] opts the optional parameters
|
1514
|
-
# @option opts [String] :up_file The file
|
1752
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1515
1753
|
# @return [Import]
|
1516
1754
|
describe 'import_loyalty_cards test' do
|
1517
1755
|
it 'should work' do
|
@@ -1519,12 +1757,25 @@ describe 'ManagementApi' do
|
|
1519
1757
|
end
|
1520
1758
|
end
|
1521
1759
|
|
1760
|
+
# unit tests for import_loyalty_customers_tiers
|
1761
|
+
# Import customers into loyalty tiers
|
1762
|
+
# Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. **Important:** This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - `subledgerid` (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - `customerprofileid`: The integration ID of the customer profile to whom the tier should be assigned. - `tiername`: The name of an existing tier to assign to the customer. - `expirydate`: The expiration date of the tier. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. **Note:** We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can [add](/management-api#tag/Loyalty/operation/addLoyaltyPoints) or [deduct](/management-api#tag/Loyalty/operation/removeLoyaltyPoints) their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z ```
|
1763
|
+
# @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.
|
1764
|
+
# @param [Hash] opts the optional parameters
|
1765
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1766
|
+
# @return [Import]
|
1767
|
+
describe 'import_loyalty_customers_tiers test' do
|
1768
|
+
it 'should work' do
|
1769
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1770
|
+
end
|
1771
|
+
end
|
1772
|
+
|
1522
1773
|
# unit tests for import_loyalty_points
|
1523
1774
|
# Import loyalty points
|
1524
|
-
# 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 loyalty program
|
1525
|
-
# @param loyalty_program_id Identifier of the
|
1775
|
+
# 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. - `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 ```
|
1776
|
+
# @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.
|
1526
1777
|
# @param [Hash] opts the optional parameters
|
1527
|
-
# @option opts [String] :up_file The file
|
1778
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1528
1779
|
# @return [Import]
|
1529
1780
|
describe 'import_loyalty_points test' do
|
1530
1781
|
it 'should work' do
|
@@ -1534,10 +1785,10 @@ describe 'ManagementApi' do
|
|
1534
1785
|
|
1535
1786
|
# unit tests for import_pool_giveaways
|
1536
1787
|
# Import giveaway codes into a giveaway pool
|
1537
|
-
# Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required):
|
1788
|
+
# Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - `code` (required): The code of your giveaway, for instance, a gift card redemption code. - `startdate`: The start date in RFC3339 of the code redemption period. - `enddate`: The last date in RFC3339 of the code redemption period. - `attributes`: A JSON object describing _custom_ giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"provider\": \"myPartnerCompany\"}\"`. The `startdate` and `enddate` have nothing to do with the _validity_ of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. **Note:** - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. **Example:** ```text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\" ```
|
1538
1789
|
# @param pool_id The ID of the pool. You can find it in the Campaign Manager, in the **Giveaways** section.
|
1539
1790
|
# @param [Hash] opts the optional parameters
|
1540
|
-
# @option opts [String] :up_file The file
|
1791
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1541
1792
|
# @return [Import]
|
1542
1793
|
describe 'import_pool_giveaways test' do
|
1543
1794
|
it 'should work' do
|
@@ -1547,11 +1798,11 @@ describe 'ManagementApi' do
|
|
1547
1798
|
|
1548
1799
|
# unit tests for import_referrals
|
1549
1800
|
# Import referrals
|
1550
|
-
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A
|
1801
|
+
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `code` (required): The referral code. - `advocateprofileintegrationid` (required): The profile ID of the advocate. - `startdate`: The start date in RFC3339 of the code redemption period. - `expirydate`: The end date in RFC3339 of the code redemption period. - `limitval`: The maximum number of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A JSON object describing _custom_ referral attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Important:** When you import a CSV file with referrals, a [customer profile](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) is **not** automatically created for each `advocateprofileintegrationid` column value. Use the [Update customer profile](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint or the [Update multiple customer profiles](https://docs.talon.one/integration-api#tag/Customer-profiles/operation/updateCustomerProfilesV2) endpoint to create the customer profiles. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\" ```
|
1551
1802
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1552
1803
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1553
1804
|
# @param [Hash] opts the optional parameters
|
1554
|
-
# @option opts [String] :up_file The file
|
1805
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1555
1806
|
# @return [Import]
|
1556
1807
|
describe 'import_referrals test' do
|
1557
1808
|
it 'should work' do
|
@@ -1559,33 +1810,89 @@ describe 'ManagementApi' do
|
|
1559
1810
|
end
|
1560
1811
|
end
|
1561
1812
|
|
1813
|
+
# unit tests for invite_user_external
|
1814
|
+
# Invite user from identity provider
|
1815
|
+
# Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.
|
1816
|
+
# @param body body
|
1817
|
+
# @param [Hash] opts the optional parameters
|
1818
|
+
# @return [nil]
|
1819
|
+
describe 'invite_user_external test' do
|
1820
|
+
it 'should work' do
|
1821
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1822
|
+
end
|
1823
|
+
end
|
1824
|
+
|
1562
1825
|
# unit tests for list_account_collections
|
1563
1826
|
# List collections in account
|
1564
|
-
# List collections in account.
|
1827
|
+
# List account-level collections in the account.
|
1565
1828
|
# @param [Hash] opts the optional parameters
|
1566
|
-
# @option opts [Integer] :page_size The number of items in
|
1567
|
-
# @option opts [Integer] :skip
|
1829
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1830
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1568
1831
|
# @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:** This parameter works only with numeric fields.
|
1569
1832
|
# @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.
|
1570
|
-
# @option opts [String] :name Filter by
|
1571
|
-
# @return [
|
1833
|
+
# @option opts [String] :name Filter by collection name.
|
1834
|
+
# @return [InlineResponse20017]
|
1572
1835
|
describe 'list_account_collections test' do
|
1573
1836
|
it 'should work' do
|
1574
1837
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1575
1838
|
end
|
1576
1839
|
end
|
1577
1840
|
|
1841
|
+
# unit tests for list_achievements
|
1842
|
+
# List achievements
|
1843
|
+
# List all the achievements for a specific campaign.
|
1844
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1845
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1846
|
+
# @param [Hash] opts the optional parameters
|
1847
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1848
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1849
|
+
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
1850
|
+
# @return [InlineResponse20046]
|
1851
|
+
describe 'list_achievements test' do
|
1852
|
+
it 'should work' do
|
1853
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1854
|
+
end
|
1855
|
+
end
|
1856
|
+
|
1857
|
+
# unit tests for list_all_roles_v2
|
1858
|
+
# List roles
|
1859
|
+
# List all roles.
|
1860
|
+
# @param [Hash] opts the optional parameters
|
1861
|
+
# @return [InlineResponse20044]
|
1862
|
+
describe 'list_all_roles_v2 test' do
|
1863
|
+
it 'should work' do
|
1864
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1865
|
+
end
|
1866
|
+
end
|
1867
|
+
|
1868
|
+
# unit tests for list_catalog_items
|
1869
|
+
# List items in a catalog
|
1870
|
+
# Return a paginated list of cart items in the given catalog.
|
1871
|
+
# @param catalog_id The ID of the catalog. You can find the ID in the Campaign Manager in **Account** > **Tools** > **Cart item catalogs**.
|
1872
|
+
# @param [Hash] opts the optional parameters
|
1873
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1874
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1875
|
+
# @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.
|
1876
|
+
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
1877
|
+
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
1878
|
+
# @return [InlineResponse20035]
|
1879
|
+
describe 'list_catalog_items test' do
|
1880
|
+
it 'should work' do
|
1881
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1882
|
+
end
|
1883
|
+
end
|
1884
|
+
|
1578
1885
|
# unit tests for list_collections
|
1579
|
-
# List collections
|
1580
|
-
# List collections in
|
1886
|
+
# List collections in campaign
|
1887
|
+
# List collections in a given campaign.
|
1581
1888
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1582
1889
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1583
1890
|
# @param [Hash] opts the optional parameters
|
1584
|
-
# @option opts [Integer] :page_size The number of items in
|
1585
|
-
# @option opts [Integer] :skip
|
1891
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1892
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1586
1893
|
# @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:** This parameter works only with numeric fields.
|
1587
1894
|
# @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.
|
1588
|
-
# @option opts [String] :name Filter by
|
1895
|
+
# @option opts [String] :name Filter by collection name.
|
1589
1896
|
# @return [InlineResponse20017]
|
1590
1897
|
describe 'list_collections test' do
|
1591
1898
|
it 'should work' do
|
@@ -1594,15 +1901,15 @@ describe 'ManagementApi' do
|
|
1594
1901
|
end
|
1595
1902
|
|
1596
1903
|
# unit tests for list_collections_in_application
|
1597
|
-
# List collections in
|
1598
|
-
# List collections from all campaigns in
|
1904
|
+
# List collections in Application
|
1905
|
+
# List campaign-level collections from all campaigns in a given Application.
|
1599
1906
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1600
1907
|
# @param [Hash] opts the optional parameters
|
1601
|
-
# @option opts [Integer] :page_size The number of items in
|
1602
|
-
# @option opts [Integer] :skip
|
1908
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1909
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1603
1910
|
# @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:** This parameter works only with numeric fields.
|
1604
1911
|
# @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.
|
1605
|
-
# @option opts [String] :name Filter by
|
1912
|
+
# @option opts [String] :name Filter by collection name.
|
1606
1913
|
# @return [InlineResponse20017]
|
1607
1914
|
describe 'list_collections_in_application test' do
|
1608
1915
|
it 'should work' do
|
@@ -1610,10 +1917,43 @@ describe 'ManagementApi' do
|
|
1610
1917
|
end
|
1611
1918
|
end
|
1612
1919
|
|
1920
|
+
# unit tests for list_stores
|
1921
|
+
# List stores
|
1922
|
+
# List all stores for a specific Application.
|
1923
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1924
|
+
# @param [Hash] opts the optional parameters
|
1925
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
1926
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1927
|
+
# @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:** This parameter works only with numeric fields.
|
1928
|
+
# @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.
|
1929
|
+
# @option opts [Float] :campaign_id Filter results by campaign.
|
1930
|
+
# @option opts [String] :name The name of the store.
|
1931
|
+
# @option opts [String] :integration_id The integration ID of the store.
|
1932
|
+
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
1933
|
+
# @return [InlineResponse20045]
|
1934
|
+
describe 'list_stores test' do
|
1935
|
+
it 'should work' do
|
1936
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1937
|
+
end
|
1938
|
+
end
|
1939
|
+
|
1940
|
+
# unit tests for notification_activation
|
1941
|
+
# Activate or deactivate notification
|
1942
|
+
# Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
1943
|
+
# @param notification_id The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
1944
|
+
# @param body body
|
1945
|
+
# @param [Hash] opts the optional parameters
|
1946
|
+
# @return [nil]
|
1947
|
+
describe 'notification_activation test' do
|
1948
|
+
it 'should work' do
|
1949
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1950
|
+
end
|
1951
|
+
end
|
1952
|
+
|
1613
1953
|
# unit tests for post_added_deducted_points_notification
|
1614
1954
|
# Create notification about added or deducted loyalty points
|
1615
|
-
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-notifications).
|
1616
|
-
# @param loyalty_program_id Identifier of the
|
1955
|
+
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
1956
|
+
# @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.
|
1617
1957
|
# @param body body
|
1618
1958
|
# @param [Hash] opts the optional parameters
|
1619
1959
|
# @return [BaseNotification]
|
@@ -1636,9 +1976,22 @@ describe 'ManagementApi' do
|
|
1636
1976
|
end
|
1637
1977
|
end
|
1638
1978
|
|
1979
|
+
# unit tests for post_pending_points_notification
|
1980
|
+
# Create notification about pending loyalty points
|
1981
|
+
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
1982
|
+
# @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.
|
1983
|
+
# @param body body
|
1984
|
+
# @param [Hash] opts the optional parameters
|
1985
|
+
# @return [BaseNotification]
|
1986
|
+
describe 'post_pending_points_notification test' do
|
1987
|
+
it 'should work' do
|
1988
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1989
|
+
end
|
1990
|
+
end
|
1991
|
+
|
1639
1992
|
# unit tests for remove_loyalty_points
|
1640
1993
|
# Deduct points from customer profile
|
1641
|
-
# Deduct points from the specified loyalty program and specified customer profile. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
1994
|
+
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
1642
1995
|
# @param loyalty_program_id The identifier for the loyalty program.
|
1643
1996
|
# @param integration_id The identifier of the profile.
|
1644
1997
|
# @param body body
|
@@ -1664,16 +2017,16 @@ describe 'ManagementApi' do
|
|
1664
2017
|
|
1665
2018
|
# unit tests for search_coupons_advanced_application_wide_without_total_count
|
1666
2019
|
# List coupons that match the given attributes (without total count)
|
1667
|
-
# List the coupons whose attributes match the query criteria in all
|
2020
|
+
# List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. **Note:** The total count is not included in the response.
|
1668
2021
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1669
2022
|
# @param body body
|
1670
2023
|
# @param [Hash] opts the optional parameters
|
1671
|
-
# @option opts [Integer] :page_size The number of items in
|
1672
|
-
# @option opts [Integer] :skip
|
2024
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
2025
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1673
2026
|
# @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:** This parameter works only with numeric fields.
|
1674
2027
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1675
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
1676
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
2028
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2029
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1677
2030
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
1678
2031
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
1679
2032
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
@@ -1681,7 +2034,7 @@ describe 'ManagementApi' do
|
|
1681
2034
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1682
2035
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1683
2036
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. - `draft`: Campaigns that are drafts.
|
1684
|
-
# @return [
|
2037
|
+
# @return [InlineResponse2009]
|
1685
2038
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
1686
2039
|
it 'should work' do
|
1687
2040
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1695,19 +2048,19 @@ describe 'ManagementApi' do
|
|
1695
2048
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1696
2049
|
# @param body body
|
1697
2050
|
# @param [Hash] opts the optional parameters
|
1698
|
-
# @option opts [Integer] :page_size The number of items in
|
1699
|
-
# @option opts [Integer] :skip
|
2051
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
2052
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1700
2053
|
# @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:** This parameter works only with numeric fields.
|
1701
2054
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1702
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
1703
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any
|
2055
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2056
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1704
2057
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future.
|
1705
2058
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
1706
2059
|
# @option opts [Integer] :referral_id Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code.
|
1707
2060
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1708
2061
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1709
2062
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1710
|
-
# @return [
|
2063
|
+
# @return [InlineResponse2009]
|
1711
2064
|
describe 'search_coupons_advanced_without_total_count test' do
|
1712
2065
|
it 'should work' do
|
1713
2066
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1730,8 +2083,8 @@ describe 'ManagementApi' do
|
|
1730
2083
|
|
1731
2084
|
# unit tests for update_account_collection
|
1732
2085
|
# Update account-level collection
|
1733
|
-
# Edit the description of
|
1734
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
2086
|
+
# Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.
|
2087
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
1735
2088
|
# @param body body
|
1736
2089
|
# @param [Hash] opts the optional parameters
|
1737
2090
|
# @return [Collection]
|
@@ -1741,9 +2094,24 @@ describe 'ManagementApi' do
|
|
1741
2094
|
end
|
1742
2095
|
end
|
1743
2096
|
|
2097
|
+
# unit tests for update_achievement
|
2098
|
+
# Update achievement
|
2099
|
+
# Update the details of a specific achievement.
|
2100
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2101
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2102
|
+
# @param achievement_id The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint.
|
2103
|
+
# @param body body
|
2104
|
+
# @param [Hash] opts the optional parameters
|
2105
|
+
# @return [Achievement]
|
2106
|
+
describe 'update_achievement test' do
|
2107
|
+
it 'should work' do
|
2108
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2109
|
+
end
|
2110
|
+
end
|
2111
|
+
|
1744
2112
|
# unit tests for update_additional_cost
|
1745
2113
|
# Update additional cost
|
1746
|
-
# Updates an existing additional cost. Once created, the only property of an additional cost that
|
2114
|
+
# Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the `name` property (or **API name** in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.
|
1747
2115
|
# @param additional_cost_id The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in **Account** > **Tools** > **Additional costs**.
|
1748
2116
|
# @param body body
|
1749
2117
|
# @param [Hash] opts the optional parameters
|
@@ -1782,11 +2150,11 @@ describe 'ManagementApi' do
|
|
1782
2150
|
end
|
1783
2151
|
|
1784
2152
|
# unit tests for update_collection
|
1785
|
-
# Update collection description
|
1786
|
-
# Edit the description of
|
2153
|
+
# Update campaign-level collection's description
|
2154
|
+
# Edit the description of a given campaign-level collection.
|
1787
2155
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1788
2156
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1789
|
-
# @param collection_id The ID of the collection. You can get it with the [List
|
2157
|
+
# @param collection_id The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
1790
2158
|
# @param body body
|
1791
2159
|
# @param [Hash] opts the optional parameters
|
1792
2160
|
# @return [Collection]
|
@@ -1813,7 +2181,7 @@ describe 'ManagementApi' do
|
|
1813
2181
|
|
1814
2182
|
# unit tests for update_coupon_batch
|
1815
2183
|
# Update coupons
|
1816
|
-
# Update all coupons, or a specific batch of coupons
|
2184
|
+
# Update all coupons, or a specific batch of coupons in the given campaign. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager, or you can use [List coupons](#operation/getCouponsWithoutTotalCount). <div class=\"redoc-section\"> <p class=\"title\">Important</p> <ul> <li>Only send sequential requests to this endpoint.</li> <li>Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team.</li> </ul> </div> To update a specific coupon, use [Update coupon](#operation/updateCoupon).
|
1817
2185
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1818
2186
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1819
2187
|
# @param body body
|
@@ -1839,30 +2207,56 @@ describe 'ManagementApi' do
|
|
1839
2207
|
end
|
1840
2208
|
end
|
1841
2209
|
|
1842
|
-
# unit tests for
|
1843
|
-
# Update
|
1844
|
-
# Update the
|
2210
|
+
# unit tests for update_referral
|
2211
|
+
# Update referral
|
2212
|
+
# Update the specified referral.
|
1845
2213
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1846
|
-
# @param
|
2214
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2215
|
+
# @param referral_id The ID of the referral code.
|
1847
2216
|
# @param body body
|
1848
2217
|
# @param [Hash] opts the optional parameters
|
1849
|
-
# @return [
|
1850
|
-
describe '
|
2218
|
+
# @return [Referral]
|
2219
|
+
describe 'update_referral test' do
|
1851
2220
|
it 'should work' do
|
1852
2221
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1853
2222
|
end
|
1854
2223
|
end
|
1855
2224
|
|
1856
|
-
# unit tests for
|
1857
|
-
# Update
|
1858
|
-
# Update
|
2225
|
+
# unit tests for update_role_v2
|
2226
|
+
# Update role
|
2227
|
+
# Update a specific role.
|
2228
|
+
# @param role_id The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint.
|
2229
|
+
# @param body body
|
2230
|
+
# @param [Hash] opts the optional parameters
|
2231
|
+
# @return [RoleV2]
|
2232
|
+
describe 'update_role_v2 test' do
|
2233
|
+
it 'should work' do
|
2234
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2235
|
+
end
|
2236
|
+
end
|
2237
|
+
|
2238
|
+
# unit tests for update_store
|
2239
|
+
# Update store
|
2240
|
+
# Update store details for a specific store ID.
|
1859
2241
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1860
|
-
# @param
|
1861
|
-
# @param referral_id The ID of the referral code.
|
2242
|
+
# @param store_id The ID of the store. You can get this ID with the [List stores](#tag/Stores/operation/listStores) endpoint.
|
1862
2243
|
# @param body body
|
1863
2244
|
# @param [Hash] opts the optional parameters
|
1864
|
-
# @return [
|
1865
|
-
describe '
|
2245
|
+
# @return [Store]
|
2246
|
+
describe 'update_store test' do
|
2247
|
+
it 'should work' do
|
2248
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2249
|
+
end
|
2250
|
+
end
|
2251
|
+
|
2252
|
+
# unit tests for update_user
|
2253
|
+
# Update user
|
2254
|
+
# Update the details of a specific user.
|
2255
|
+
# @param user_id The ID of the user.
|
2256
|
+
# @param body body
|
2257
|
+
# @param [Hash] opts the optional parameters
|
2258
|
+
# @return [User]
|
2259
|
+
describe 'update_user test' do
|
1866
2260
|
it 'should work' do
|
1867
2261
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1868
2262
|
end
|