talon_one 2.4.0 → 2.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Makefile +43 -0
- data/README.md +198 -160
- data/docs/Account.md +3 -3
- data/docs/AccountAdditionalCost.md +6 -4
- data/docs/AccountAnalytics.md +20 -18
- data/docs/AccountEntity.md +1 -1
- data/docs/AddFreeItemEffectProps.md +1 -1
- data/docs/AddLoyaltyPointsEffectProps.md +17 -9
- data/docs/AdditionalCost.md +1 -1
- data/docs/Application.md +22 -18
- data/docs/ApplicationAPIKey.md +9 -9
- data/docs/ApplicationApiHealth.md +1 -1
- data/docs/ApplicationCustomer.md +10 -8
- data/docs/ApplicationCustomerEntity.md +1 -1
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +4 -4
- data/docs/ApplicationNotification.md +17 -0
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +13 -11
- data/docs/AsyncCouponCreationResponse.md +17 -0
- data/docs/Attribute.md +10 -4
- data/docs/Audience.md +9 -9
- data/docs/BaseLoyaltyProgram.md +29 -0
- data/docs/Binding.md +6 -4
- data/docs/BulkApplicationNotification.md +19 -0
- data/docs/BulkCampaignNotification.md +19 -0
- data/docs/Campaign.md +26 -18
- data/docs/CampaignCollection.md +37 -0
- data/docs/CampaignCollectionWithoutPayload.md +35 -0
- data/docs/CampaignCopy.md +2 -2
- data/docs/CampaignCreatedNotification.md +17 -0
- data/docs/CampaignDeletedNotification.md +17 -0
- data/docs/CampaignEditedNotification.md +19 -0
- data/docs/CampaignEntity.md +1 -1
- data/docs/CampaignGroup.md +4 -4
- data/docs/CampaignNotification.md +17 -0
- data/docs/CampaignPrioritiesChangedNotification.md +21 -0
- data/docs/CampaignPrioritiesV2.md +21 -0
- data/docs/CampaignRulesetChangedNotification.md +21 -0
- data/docs/CampaignSet.md +3 -3
- data/docs/CampaignSetIDs.md +17 -0
- data/docs/CampaignSetV2.md +25 -0
- data/docs/CampaignStateChangedNotification.md +21 -0
- data/docs/CampaignTemplate.md +59 -0
- data/docs/CampaignTemplateCollection.md +19 -0
- data/docs/CampaignTemplateParams.md +21 -0
- data/docs/CartItem.md +20 -14
- data/docs/Catalog.md +33 -0
- data/docs/Change.md +2 -2
- data/docs/CodeGeneratorSettings.md +4 -4
- data/docs/Collection.md +39 -0
- data/docs/CollectionWithoutPayload.md +37 -0
- data/docs/Coupon.md +17 -15
- data/docs/CouponConstraints.md +3 -3
- data/docs/CouponCreationJob.md +57 -0
- data/docs/CouponLimitConfigs.md +17 -0
- data/docs/CouponRejectionReason.md +3 -3
- data/docs/CouponReservations.md +1 -1
- data/docs/CouponValue.md +2 -2
- data/docs/CreateApplicationAPIKey.md +4 -4
- data/docs/CreateTemplateCampaign.md +29 -0
- data/docs/CreateTemplateCampaignResponse.md +21 -0
- data/docs/CustomEffect.md +6 -6
- data/docs/CustomEffectProps.md +4 -2
- data/docs/CustomerActivityReport.md +2 -2
- data/docs/CustomerInventory.md +2 -2
- data/docs/CustomerProfile.md +11 -9
- data/docs/CustomerProfileAudienceRequestItem.md +6 -6
- data/docs/CustomerProfileIntegrationRequestV2.md +3 -3
- data/docs/CustomerProfileSearchQuery.md +1 -1
- data/docs/CustomerSession.md +10 -8
- data/docs/CustomerSessionV2.md +26 -20
- data/docs/DeductLoyaltyPointsEffectProps.md +5 -1
- data/docs/Effect.md +6 -6
- data/docs/EffectEntity.md +6 -6
- data/docs/EmailEntity.md +1 -1
- data/docs/Entity.md +2 -2
- data/docs/Environment.md +7 -5
- data/docs/ErrorResponseWithStatus.md +21 -0
- data/docs/Event.md +10 -10
- data/docs/EventType.md +4 -18
- data/docs/EventV2.md +21 -0
- data/docs/Export.md +3 -3
- data/docs/Giveaway.md +3 -3
- data/docs/GiveawaysPool.md +3 -3
- data/docs/Import.md +7 -7
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +2 -4
- data/docs/InlineResponse20012.md +3 -3
- data/docs/InlineResponse20013.md +4 -2
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +2 -2
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +2 -2
- data/docs/InlineResponse20018.md +3 -3
- data/docs/InlineResponse20019.md +3 -5
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +4 -2
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +2 -4
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +4 -2
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse20031.md +19 -0
- data/docs/InlineResponse2008.md +5 -3
- data/docs/InlineResponse2009.md +4 -2
- data/docs/IntegrationApi.md +462 -179
- data/docs/IntegrationCustomerSessionResponse.md +17 -0
- data/docs/IntegrationEntity.md +2 -2
- data/docs/IntegrationEvent.md +4 -4
- data/docs/IntegrationEventV2Request.md +23 -0
- data/docs/IntegrationProfileEntity.md +2 -2
- data/docs/IntegrationRequest.md +2 -2
- data/docs/IntegrationStateV2.md +6 -2
- data/docs/InventoryCoupon.md +19 -17
- data/docs/InventoryReferral.md +43 -0
- data/docs/LedgerEntry.md +6 -6
- data/docs/LedgerInfo.md +31 -0
- data/docs/LimitConfig.md +8 -6
- data/docs/LimitCounter.md +45 -0
- data/docs/LoginParams.md +2 -2
- data/docs/Loyalty.md +4 -2
- data/docs/LoyaltyCard.md +35 -0
- data/docs/LoyaltyCardProfileRegistration.md +19 -0
- data/docs/LoyaltyCardRegistration.md +17 -0
- data/docs/LoyaltyDashboardData.md +33 -0
- data/docs/LoyaltyDashboardPointsBreakdown.md +19 -0
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyMembership.md +1 -1
- data/docs/LoyaltyProgram.md +21 -13
- data/docs/LoyaltyProgramBalance.md +10 -10
- data/docs/LoyaltyProgramEntity.md +1 -1
- data/docs/LoyaltyProgramLedgers.md +5 -5
- data/docs/LoyaltyProjection.md +21 -0
- data/docs/LoyaltyProjectionData.md +23 -0
- data/docs/LoyaltyStatistics.md +16 -6
- data/docs/LoyaltySubLedger.md +13 -11
- data/docs/LoyaltyTier.md +5 -5
- data/docs/ManagementApi.md +1627 -1247
- data/docs/ModelReturn.md +37 -0
- data/docs/MultipleAttribute.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +3 -3
- data/docs/MultipleNewAttribute.md +17 -0
- data/docs/MutableEntity.md +1 -1
- data/docs/NewAccountSignUp.md +2 -2
- data/docs/NewAdditionalCost.md +3 -1
- data/docs/NewApplication.md +18 -14
- data/docs/NewApplicationAPIKey.md +11 -11
- data/docs/NewAttribute.md +4 -0
- data/docs/NewAudience.md +6 -6
- data/docs/NewCampaign.md +14 -14
- data/docs/NewCampaignCollection.md +19 -0
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewCampaignSetV2.md +21 -0
- data/docs/NewCampaignTemplate.md +41 -0
- data/docs/NewCatalog.md +21 -0
- data/docs/NewCollection.md +21 -0
- data/docs/NewCouponCreationJob.md +29 -0
- data/docs/NewCoupons.md +12 -10
- data/docs/NewCouponsForMultipleRecipients.md +5 -5
- data/docs/NewCustomEffect.md +3 -3
- data/docs/NewCustomerProfile.md +1 -1
- data/docs/NewCustomerSession.md +5 -5
- data/docs/NewCustomerSessionV2.md +17 -15
- data/docs/NewEvent.md +5 -5
- data/docs/NewEventType.md +3 -17
- data/docs/NewInvitation.md +3 -3
- data/docs/NewLoyaltyProgram.md +16 -8
- data/docs/NewLoyaltyTier.md +2 -2
- data/docs/NewNotificationWebhook.md +19 -0
- data/docs/NewReferral.md +7 -7
- data/docs/NewReferralsForMultipleAdvocates.md +10 -10
- data/docs/NewReturn.md +17 -0
- data/docs/NewRole.md +2 -2
- data/docs/NewRuleset.md +4 -4
- data/docs/NewUser.md +3 -3
- data/docs/NotificationWebhook.md +27 -0
- data/docs/Referral.md +13 -13
- data/docs/ReferralConstraints.md +4 -4
- data/docs/ReturnIntegrationRequest.md +19 -0
- data/docs/ReturnedCartItem.md +19 -0
- data/docs/Role.md +5 -5
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +7 -1
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +3 -1
- data/docs/RollbackDiscountEffectProps.md +12 -2
- data/docs/Rule.md +4 -4
- data/docs/RuleFailureReason.md +1 -1
- data/docs/Ruleset.md +10 -8
- data/docs/SamlConnection.md +2 -2
- data/docs/Session.md +3 -3
- data/docs/SetDiscountEffectProps.md +3 -1
- data/docs/SetDiscountPerAdditionalCostEffectProps.md +25 -0
- data/docs/SetDiscountPerAdditionalCostPerItemEffectProps.md +29 -0
- data/docs/SetDiscountPerItemEffectProps.md +13 -5
- data/docs/TemplateDef.md +3 -3
- data/docs/TemplateLimitConfig.md +23 -0
- data/docs/Tier.md +19 -0
- data/docs/UpdateApplication.md +19 -15
- data/docs/UpdateAudience.md +2 -2
- data/docs/UpdateCampaign.md +3 -3
- data/docs/UpdateCampaignCollection.md +17 -0
- data/docs/UpdateCampaignTemplate.md +45 -0
- data/docs/UpdateCatalog.md +21 -0
- data/docs/UpdateCollection.md +19 -0
- data/docs/UpdateCoupon.md +5 -3
- data/docs/UpdateCouponBatch.md +4 -4
- data/docs/UpdateCustomEffect.md +3 -3
- data/docs/UpdateLoyaltyCard.md +17 -0
- data/docs/UpdateLoyaltyProgram.md +10 -6
- data/docs/UpdateReferral.md +4 -4
- data/docs/UpdateReferralBatch.md +25 -0
- data/docs/UpdateRole.md +2 -2
- data/docs/User.md +12 -12
- data/docs/Webhook.md +3 -3
- data/lib/talon_one/api/integration_api.rb +561 -165
- data/lib/talon_one/api/management_api.rb +2256 -1674
- data/lib/talon_one/api_client.rb +1 -1
- data/lib/talon_one/api_error.rb +1 -1
- data/lib/talon_one/configuration.rb +1 -8
- data/lib/talon_one/models/accept_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/accept_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/access_log_entry.rb +1 -1
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +93 -5
- data/lib/talon_one/models/account_analytics.rb +21 -6
- data/lib/talon_one/models/account_entity.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +1 -1
- data/lib/talon_one/models/add_free_item_effect_props.rb +1 -1
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +73 -14
- data/lib/talon_one/models/additional_cost.rb +1 -1
- data/lib/talon_one/models/api_error.rb +1 -1
- data/lib/talon_one/models/application.rb +48 -12
- data/lib/talon_one/models/application_api_health.rb +1 -1
- data/lib/talon_one/models/application_api_key.rb +4 -4
- data/lib/talon_one/models/application_campaign_stats.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +53 -9
- data/lib/talon_one/models/application_customer_entity.rb +1 -1
- data/lib/talon_one/models/application_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_notification.rb +212 -0
- data/lib/talon_one/models/application_referee.rb +39 -1
- data/lib/talon_one/models/application_session.rb +55 -6
- data/lib/talon_one/models/application_session_entity.rb +1 -1
- data/lib/talon_one/models/async_coupon_creation_response.rb +212 -0
- data/lib/talon_one/models/attribute.rb +80 -5
- data/lib/talon_one/models/attributes_mandatory.rb +1 -1
- data/lib/talon_one/models/attributes_settings.rb +1 -1
- data/lib/talon_one/models/audience.rb +12 -51
- data/lib/talon_one/models/audience_membership.rb +1 -1
- data/lib/talon_one/models/award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/models/base_loyalty_program.rb +284 -0
- data/lib/talon_one/models/base_saml_connection.rb +1 -1
- data/lib/talon_one/models/binding.rb +16 -6
- data/lib/talon_one/models/{new_feature_flags.rb → bulk_application_notification.rb} +29 -29
- data/lib/talon_one/models/bulk_campaign_notification.rb +227 -0
- data/lib/talon_one/models/campaign.rb +53 -13
- data/lib/talon_one/models/campaign_analytics.rb +1 -1
- data/lib/talon_one/models/campaign_collection.rb +370 -0
- data/lib/talon_one/models/campaign_collection_without_payload.rb +358 -0
- data/lib/talon_one/models/campaign_copy.rb +3 -3
- data/lib/talon_one/models/campaign_created_notification.rb +212 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +212 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +226 -0
- data/lib/talon_one/models/campaign_entity.rb +1 -1
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_group_entity.rb +1 -1
- data/lib/talon_one/models/campaign_notification.rb +212 -0
- data/lib/talon_one/models/campaign_priorities_changed_notification.rb +241 -0
- data/lib/talon_one/models/campaign_priorities_v2.rb +230 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +235 -0
- data/lib/talon_one/models/campaign_search.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_set_branch_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_i_ds.rb +208 -0
- data/lib/talon_one/models/campaign_set_leaf_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_node.rb +1 -1
- data/lib/talon_one/models/campaign_set_v2.rb +291 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +242 -0
- data/lib/talon_one/models/campaign_template.rb +533 -0
- data/lib/talon_one/models/{update_loyalty_tier.rb → campaign_template_collection.rb} +30 -34
- data/lib/talon_one/models/campaign_template_params.rb +295 -0
- data/lib/talon_one/models/cart_item.rb +44 -7
- data/lib/talon_one/models/catalog.rb +330 -0
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/change_profile_password.rb +1 -1
- data/lib/talon_one/models/code_generator_settings.rb +3 -3
- data/lib/talon_one/models/collection.rb +382 -0
- data/lib/talon_one/models/collection_without_payload.rb +370 -0
- data/lib/talon_one/models/coupon.rb +35 -6
- data/lib/talon_one/models/coupon_constraints.rb +2 -2
- data/lib/talon_one/models/coupon_created_effect_props.rb +1 -1
- data/lib/talon_one/models/coupon_creation_job.rb +560 -0
- data/lib/talon_one/models/coupon_limit_configs.rb +209 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +1 -1
- data/lib/talon_one/models/coupon_reservations.rb +1 -1
- data/lib/talon_one/models/coupon_search.rb +1 -1
- data/lib/talon_one/models/coupon_value.rb +2 -2
- data/lib/talon_one/models/create_application_api_key.rb +4 -4
- data/lib/talon_one/models/create_template_campaign.rb +302 -0
- data/lib/talon_one/models/create_template_campaign_response.rb +236 -0
- data/lib/talon_one/models/custom_effect.rb +61 -14
- data/lib/talon_one/models/custom_effect_props.rb +26 -11
- data/lib/talon_one/models/customer_activity_report.rb +20 -1
- data/lib/talon_one/models/customer_analytics.rb +1 -1
- data/lib/talon_one/models/customer_inventory.rb +3 -2
- data/lib/talon_one/models/customer_profile.rb +49 -15
- data/lib/talon_one/models/customer_profile_audience_request.rb +1 -1
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +23 -1
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +2 -2
- data/lib/talon_one/models/customer_profile_search_query.rb +2 -2
- data/lib/talon_one/models/customer_session.rb +44 -10
- data/lib/talon_one/models/customer_session_v2.rb +87 -26
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +30 -5
- data/lib/talon_one/models/effect.rb +1 -1
- data/lib/talon_one/models/effect_entity.rb +1 -1
- data/lib/talon_one/models/email_entity.rb +1 -1
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +1 -1
- data/lib/talon_one/models/environment.rb +21 -8
- data/lib/talon_one/models/error_effect_props.rb +1 -1
- data/lib/talon_one/models/error_response.rb +1 -1
- data/lib/talon_one/models/error_response_with_status.rb +228 -0
- data/lib/talon_one/models/error_source.rb +1 -1
- data/lib/talon_one/models/event.rb +3 -3
- data/lib/talon_one/models/event_type.rb +5 -148
- data/lib/talon_one/models/event_v2.rb +252 -0
- data/lib/talon_one/models/export.rb +3 -3
- data/lib/talon_one/models/feature_flag.rb +1 -1
- data/lib/talon_one/models/features_feed.rb +1 -1
- data/lib/talon_one/models/feed_notification.rb +1 -1
- data/lib/talon_one/models/func_arg_def.rb +1 -1
- data/lib/talon_one/models/function_def.rb +1 -1
- data/lib/talon_one/models/giveaway.rb +2 -2
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +3 -3
- data/lib/talon_one/models/import_entity.rb +1 -1
- data/lib/talon_one/models/inline_response200.rb +1 -1
- data/lib/talon_one/models/inline_response2001.rb +1 -1
- data/lib/talon_one/models/inline_response20010.rb +12 -12
- data/lib/talon_one/models/inline_response20011.rb +8 -12
- data/lib/talon_one/models/inline_response20012.rb +12 -12
- data/lib/talon_one/models/inline_response20013.rb +12 -8
- data/lib/talon_one/models/inline_response20014.rb +2 -2
- data/lib/talon_one/models/inline_response20015.rb +7 -2
- data/lib/talon_one/models/inline_response20016.rb +12 -12
- data/lib/talon_one/models/inline_response20017.rb +2 -7
- data/lib/talon_one/models/inline_response20018.rb +12 -12
- data/lib/talon_one/models/inline_response20019.rb +8 -12
- data/lib/talon_one/models/inline_response2002.rb +1 -1
- data/lib/talon_one/models/inline_response20020.rb +12 -8
- data/lib/talon_one/models/inline_response20021.rb +17 -3
- data/lib/talon_one/models/inline_response20022.rb +2 -2
- data/lib/talon_one/models/inline_response20023.rb +2 -2
- data/lib/talon_one/models/inline_response20024.rb +2 -2
- data/lib/talon_one/models/inline_response20025.rb +2 -2
- data/lib/talon_one/models/inline_response20026.rb +2 -2
- data/lib/talon_one/models/inline_response20027.rb +8 -12
- data/lib/talon_one/models/inline_response20028.rb +2 -2
- data/lib/talon_one/models/inline_response20029.rb +12 -8
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +227 -0
- data/lib/talon_one/models/inline_response20031.rb +227 -0
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- 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 +12 -8
- data/lib/talon_one/models/inline_response2009.rb +12 -8
- data/lib/talon_one/models/inline_response201.rb +1 -1
- data/lib/talon_one/models/integration_customer_session_response.rb +206 -0
- data/lib/talon_one/models/integration_entity.rb +20 -1
- data/lib/talon_one/models/integration_event.rb +2 -2
- data/lib/talon_one/models/integration_event_v2_request.rb +286 -0
- data/lib/talon_one/models/integration_profile_entity.rb +2 -2
- data/lib/talon_one/models/integration_request.rb +2 -2
- data/lib/talon_one/models/integration_state.rb +1 -1
- data/lib/talon_one/models/integration_state_v2.rb +26 -6
- data/lib/talon_one/models/inventory_coupon.rb +36 -7
- data/lib/talon_one/models/inventory_referral.rb +446 -0
- data/lib/talon_one/models/ledger_entry.rb +2 -2
- data/lib/talon_one/models/ledger_info.rb +301 -0
- data/lib/talon_one/models/library_attribute.rb +1 -1
- data/lib/talon_one/models/limit_config.rb +27 -5
- data/lib/talon_one/models/limit_counter.rb +398 -0
- data/lib/talon_one/models/login_params.rb +1 -1
- data/lib/talon_one/models/loyalty.rb +15 -3
- data/lib/talon_one/models/loyalty_card.rb +350 -0
- data/lib/talon_one/models/loyalty_card_profile_registration.rb +246 -0
- data/lib/talon_one/models/loyalty_card_registration.rb +212 -0
- data/lib/talon_one/models/loyalty_dashboard_data.rb +331 -0
- data/lib/talon_one/models/loyalty_dashboard_points_breakdown.rb +225 -0
- data/lib/talon_one/models/loyalty_ledger.rb +3 -3
- data/lib/talon_one/models/loyalty_ledger_entry.rb +11 -7
- data/lib/talon_one/models/loyalty_membership.rb +1 -1
- data/lib/talon_one/models/loyalty_points.rb +6 -6
- data/lib/talon_one/models/loyalty_program.rb +124 -33
- data/lib/talon_one/models/loyalty_program_balance.rb +6 -6
- data/lib/talon_one/models/loyalty_program_entity.rb +1 -1
- data/lib/talon_one/models/loyalty_program_ledgers.rb +4 -4
- data/lib/talon_one/models/loyalty_projection.rb +239 -0
- data/lib/talon_one/models/loyalty_projection_data.rb +257 -0
- data/lib/talon_one/models/loyalty_statistics.rb +82 -9
- data/lib/talon_one/models/loyalty_sub_ledger.rb +25 -16
- data/lib/talon_one/models/loyalty_tier.rb +6 -6
- data/lib/talon_one/models/manager_config.rb +1 -1
- data/lib/talon_one/models/meta.rb +1 -1
- data/lib/talon_one/models/model_return.rb +384 -0
- data/lib/talon_one/models/multi_application_entity.rb +1 -1
- data/lib/talon_one/models/{application_customer_search.rb → multiple_attribute.rb} +10 -31
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +1 -1
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +21 -2
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +1 -1
- data/lib/talon_one/models/multiple_new_attribute.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +1 -1
- data/lib/talon_one/models/new_account.rb +1 -1
- data/lib/talon_one/models/new_account_sign_up.rb +1 -1
- data/lib/talon_one/models/new_additional_cost.rb +93 -5
- data/lib/talon_one/models/new_application.rb +48 -12
- data/lib/talon_one/models/new_application_api_key.rb +5 -5
- data/lib/talon_one/models/new_attribute.rb +68 -2
- data/lib/talon_one/models/new_audience.rb +12 -51
- data/lib/talon_one/models/new_campaign.rb +8 -8
- data/lib/talon_one/models/new_campaign_collection.rb +253 -0
- data/lib/talon_one/models/new_campaign_group.rb +1 -1
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_campaign_set_v2.rb +261 -0
- data/lib/talon_one/models/new_campaign_template.rb +408 -0
- data/lib/talon_one/models/{feature_flags.rb → new_catalog.rb} +36 -39
- data/lib/talon_one/models/new_collection.rb +265 -0
- data/lib/talon_one/models/new_coupon_creation_job.rb +353 -0
- data/lib/talon_one/models/new_coupons.rb +33 -6
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +4 -4
- data/lib/talon_one/models/new_custom_effect.rb +62 -14
- data/lib/talon_one/models/new_customer_profile.rb +1 -1
- data/lib/talon_one/models/new_customer_session.rb +6 -6
- data/lib/talon_one/models/new_customer_session_v2.rb +24 -12
- data/lib/talon_one/models/new_event.rb +2 -2
- data/lib/talon_one/models/new_event_type.rb +5 -148
- data/lib/talon_one/models/new_giveaways_pool.rb +1 -1
- data/lib/talon_one/models/new_invitation.rb +2 -2
- data/lib/talon_one/models/new_invite_email.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +109 -21
- data/lib/talon_one/models/new_loyalty_tier.rb +7 -7
- data/lib/talon_one/models/new_notification_webhook.rb +229 -0
- data/lib/talon_one/models/new_password.rb +1 -1
- data/lib/talon_one/models/new_password_email.rb +1 -1
- data/lib/talon_one/models/new_referral.rb +21 -2
- data/lib/talon_one/models/new_referrals_for_multiple_advocates.rb +4 -4
- data/lib/talon_one/models/new_return.rb +214 -0
- data/lib/talon_one/models/new_role.rb +12 -12
- data/lib/talon_one/models/new_ruleset.rb +3 -3
- data/lib/talon_one/models/new_saml_connection.rb +1 -1
- data/lib/talon_one/models/new_template_def.rb +1 -1
- data/lib/talon_one/models/new_user.rb +1 -1
- data/lib/talon_one/models/new_webhook.rb +22 -1
- data/lib/talon_one/models/notification.rb +1 -1
- data/lib/talon_one/models/notification_webhook.rb +290 -0
- data/lib/talon_one/models/profile_audiences_changes.rb +1 -1
- data/lib/talon_one/models/redeem_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/referral.rb +22 -3
- data/lib/talon_one/models/referral_constraints.rb +2 -2
- data/lib/talon_one/models/referral_created_effect_props.rb +1 -1
- data/lib/talon_one/models/referral_rejection_reason.rb +1 -1
- data/lib/talon_one/models/reject_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/reject_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/return_integration_request.rb +246 -0
- data/lib/talon_one/models/returned_cart_item.rb +222 -0
- data/lib/talon_one/models/role.rb +2 -2
- data/lib/talon_one/models/role_assign.rb +1 -1
- data/lib/talon_one/models/role_membership.rb +1 -1
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +54 -5
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +1 -1
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +34 -5
- data/lib/talon_one/models/rollback_discount_effect_props.rb +57 -7
- data/lib/talon_one/models/rollback_referral_effect_props.rb +1 -1
- data/lib/talon_one/models/rule.rb +1 -1
- data/lib/talon_one/models/rule_failure_reason.rb +2 -2
- data/lib/talon_one/models/ruleset.rb +24 -19
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/saml_connection_metadata.rb +1 -1
- data/lib/talon_one/models/saml_login_endpoint.rb +1 -1
- data/lib/talon_one/models/session.rb +2 -2
- data/lib/talon_one/models/set_discount_effect_props.rb +15 -5
- data/lib/talon_one/models/set_discount_per_additional_cost_effect_props.rb +268 -0
- data/lib/talon_one/models/set_discount_per_additional_cost_per_item_effect_props.rb +293 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +50 -10
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +1 -1
- data/lib/talon_one/models/show_notification_effect_props.rb +1 -1
- data/lib/talon_one/models/slot_def.rb +1 -1
- data/lib/talon_one/models/template_arg_def.rb +1 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/template_limit_config.rb +308 -0
- data/lib/talon_one/models/tier.rb +227 -0
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +1 -1
- data/lib/talon_one/models/update_account.rb +1 -1
- data/lib/talon_one/models/update_application.rb +51 -15
- data/lib/talon_one/models/update_attribute_effect_props.rb +1 -1
- data/lib/talon_one/models/update_audience.rb +2 -2
- data/lib/talon_one/models/update_campaign.rb +4 -4
- data/lib/talon_one/models/update_campaign_collection.rb +207 -0
- data/lib/talon_one/models/update_campaign_group.rb +1 -1
- data/lib/talon_one/models/update_campaign_template.rb +435 -0
- data/lib/talon_one/models/update_catalog.rb +229 -0
- data/lib/talon_one/models/update_collection.rb +219 -0
- data/lib/talon_one/models/update_coupon.rb +30 -3
- data/lib/talon_one/models/update_coupon_batch.rb +2 -7
- data/lib/talon_one/models/update_custom_effect.rb +61 -14
- data/lib/talon_one/models/update_loyalty_card.rb +212 -0
- data/lib/talon_one/models/update_loyalty_program.rb +43 -6
- data/lib/talon_one/models/update_referral.rb +16 -1
- data/lib/talon_one/models/update_referral_batch.rb +276 -0
- data/lib/talon_one/models/update_role.rb +9 -9
- data/lib/talon_one/models/update_user.rb +1 -1
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +1 -1
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/user_entity.rb +1 -1
- data/lib/talon_one/models/user_feed_notifications.rb +1 -1
- data/lib/talon_one/models/webhook.rb +22 -1
- data/lib/talon_one/models/webhook_activation_log_entry.rb +1 -1
- data/lib/talon_one/models/webhook_log_entry.rb +1 -1
- data/lib/talon_one/models/will_award_giveaway_effect_props.rb +20 -1
- data/lib/talon_one/version.rb +2 -2
- data/lib/talon_one.rb +68 -5
- data/spec/api/integration_api_spec.rb +129 -54
- data/spec/api/management_api_spec.rb +526 -459
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accept_coupon_effect_props_spec.rb +1 -1
- data/spec/models/accept_referral_effect_props_spec.rb +1 -1
- data/spec/models/access_log_entry_spec.rb +1 -1
- data/spec/models/account_additional_cost_spec.rb +11 -1
- data/spec/models/account_analytics_spec.rb +7 -1
- data/spec/models/account_entity_spec.rb +1 -1
- data/spec/models/account_limits_spec.rb +1 -1
- data/spec/models/account_spec.rb +1 -1
- data/spec/models/add_free_item_effect_props_spec.rb +1 -1
- data/spec/models/add_loyalty_points_effect_props_spec.rb +25 -1
- data/spec/models/additional_cost_spec.rb +1 -1
- data/spec/models/api_error_spec.rb +1 -1
- data/spec/models/application_api_health_spec.rb +1 -1
- data/spec/models/application_api_key_spec.rb +2 -2
- data/spec/models/application_campaign_stats_spec.rb +1 -1
- data/spec/models/application_customer_entity_spec.rb +1 -1
- data/spec/models/application_customer_spec.rb +7 -1
- data/spec/models/application_entity_spec.rb +1 -1
- data/spec/models/application_event_spec.rb +1 -1
- data/spec/models/application_notification_spec.rb +41 -0
- data/spec/models/application_referee_spec.rb +1 -1
- data/spec/models/application_session_entity_spec.rb +1 -1
- data/spec/models/application_session_spec.rb +8 -2
- data/spec/models/application_spec.rb +17 -1
- data/spec/models/async_coupon_creation_response_spec.rb +41 -0
- data/spec/models/attribute_spec.rb +19 -1
- data/spec/models/attributes_mandatory_spec.rb +1 -1
- data/spec/models/attributes_settings_spec.rb +1 -1
- data/spec/models/audience_membership_spec.rb +1 -1
- data/spec/models/audience_spec.rb +1 -5
- data/spec/models/award_giveaway_effect_props_spec.rb +1 -1
- data/spec/models/base_loyalty_program_spec.rb +77 -0
- data/spec/models/base_saml_connection_spec.rb +1 -1
- data/spec/models/binding_spec.rb +7 -1
- data/spec/models/bulk_application_notification_spec.rb +47 -0
- data/spec/models/bulk_campaign_notification_spec.rb +47 -0
- data/spec/models/campaign_analytics_spec.rb +1 -1
- data/spec/models/campaign_collection_spec.rb +101 -0
- data/spec/models/campaign_collection_without_payload_spec.rb +95 -0
- data/spec/models/campaign_copy_spec.rb +1 -1
- data/spec/models/campaign_created_notification_spec.rb +41 -0
- data/spec/models/campaign_deleted_notification_spec.rb +41 -0
- data/spec/models/campaign_edited_notification_spec.rb +47 -0
- data/spec/models/campaign_entity_spec.rb +1 -1
- data/spec/models/campaign_group_entity_spec.rb +1 -1
- data/spec/models/campaign_group_spec.rb +1 -1
- data/spec/models/campaign_notification_spec.rb +41 -0
- data/spec/models/campaign_priorities_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_priorities_v2_spec.rb +53 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_search_spec.rb +1 -1
- data/spec/models/campaign_set_branch_node_spec.rb +1 -1
- data/spec/models/campaign_set_i_ds_spec.rb +41 -0
- data/spec/models/campaign_set_leaf_node_spec.rb +1 -1
- data/spec/models/campaign_set_node_spec.rb +1 -1
- data/spec/models/campaign_set_spec.rb +1 -1
- data/spec/models/campaign_set_v2_spec.rb +65 -0
- data/spec/models/campaign_spec.rb +25 -1
- data/spec/models/campaign_state_changed_notification_spec.rb +53 -0
- data/spec/models/campaign_template_collection_spec.rb +47 -0
- data/spec/models/campaign_template_params_spec.rb +57 -0
- data/spec/models/campaign_template_spec.rb +175 -0
- data/spec/models/cart_item_spec.rb +19 -1
- data/spec/models/catalog_spec.rb +89 -0
- data/spec/models/change_profile_password_spec.rb +1 -1
- data/spec/models/change_spec.rb +1 -1
- data/spec/models/code_generator_settings_spec.rb +1 -1
- data/spec/models/collection_spec.rb +107 -0
- data/spec/models/collection_without_payload_spec.rb +101 -0
- data/spec/models/coupon_constraints_spec.rb +1 -1
- data/spec/models/coupon_created_effect_props_spec.rb +1 -1
- data/spec/models/coupon_creation_job_spec.rb +161 -0
- data/spec/models/coupon_limit_configs_spec.rb +41 -0
- data/spec/models/coupon_rejection_reason_spec.rb +1 -1
- data/spec/models/coupon_reservations_spec.rb +1 -1
- data/spec/models/coupon_search_spec.rb +1 -1
- data/spec/models/coupon_spec.rb +7 -1
- data/spec/models/coupon_value_spec.rb +1 -1
- data/spec/models/create_application_api_key_spec.rb +2 -2
- data/spec/models/create_template_campaign_response_spec.rb +53 -0
- data/spec/models/create_template_campaign_spec.rb +77 -0
- data/spec/models/custom_effect_props_spec.rb +8 -2
- data/spec/models/custom_effect_spec.rb +7 -7
- data/spec/models/customer_activity_report_spec.rb +1 -1
- data/spec/models/customer_analytics_spec.rb +1 -1
- data/spec/models/customer_inventory_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_item_spec.rb +1 -1
- data/spec/models/customer_profile_audience_request_spec.rb +1 -1
- data/spec/models/customer_profile_integration_request_v2_spec.rb +1 -1
- data/spec/models/customer_profile_search_query_spec.rb +1 -1
- data/spec/models/customer_profile_spec.rb +8 -2
- data/spec/models/customer_session_spec.rb +8 -2
- data/spec/models/customer_session_v2_spec.rb +21 -3
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +13 -1
- data/spec/models/effect_entity_spec.rb +1 -1
- data/spec/models/effect_spec.rb +1 -1
- data/spec/models/email_entity_spec.rb +1 -1
- data/spec/models/entity_spec.rb +1 -1
- data/spec/models/entity_with_talang_visible_id_spec.rb +1 -1
- data/spec/models/environment_spec.rb +8 -2
- data/spec/models/error_effect_props_spec.rb +1 -1
- data/spec/models/error_response_spec.rb +1 -1
- data/spec/models/error_response_with_status_spec.rb +53 -0
- data/spec/models/error_source_spec.rb +1 -1
- data/spec/models/event_spec.rb +1 -1
- data/spec/models/event_type_spec.rb +1 -51
- data/spec/models/event_v2_spec.rb +53 -0
- data/spec/models/export_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/features_feed_spec.rb +1 -1
- data/spec/models/feed_notification_spec.rb +1 -1
- data/spec/models/func_arg_def_spec.rb +1 -1
- data/spec/models/function_def_spec.rb +1 -1
- data/spec/models/giveaway_spec.rb +1 -1
- data/spec/models/giveaways_pool_spec.rb +1 -1
- data/spec/models/import_entity_spec.rb +1 -1
- data/spec/models/import_spec.rb +1 -1
- data/spec/models/inline_response20010_spec.rb +2 -2
- data/spec/models/inline_response20011_spec.rb +1 -7
- data/spec/models/inline_response20012_spec.rb +2 -2
- data/spec/models/inline_response20013_spec.rb +7 -1
- data/spec/models/inline_response20014_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +2 -2
- data/spec/models/inline_response20017_spec.rb +1 -1
- data/spec/models/inline_response20018_spec.rb +2 -2
- data/spec/models/inline_response20019_spec.rb +1 -7
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +7 -1
- data/spec/models/inline_response20021_spec.rb +7 -1
- data/spec/models/inline_response20022_spec.rb +1 -1
- data/spec/models/inline_response20023_spec.rb +1 -1
- data/spec/models/inline_response20024_spec.rb +1 -1
- data/spec/models/inline_response20025_spec.rb +1 -1
- data/spec/models/inline_response20026_spec.rb +1 -1
- data/spec/models/inline_response20027_spec.rb +1 -7
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +7 -1
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/inline_response20031_spec.rb +47 -0
- data/spec/models/inline_response2003_spec.rb +1 -1
- data/spec/models/inline_response2004_spec.rb +1 -1
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2007_spec.rb +1 -1
- data/spec/models/inline_response2008_spec.rb +7 -1
- data/spec/models/inline_response2009_spec.rb +7 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/inline_response201_spec.rb +1 -1
- data/spec/models/integration_customer_session_response_spec.rb +41 -0
- data/spec/models/integration_entity_spec.rb +1 -1
- data/spec/models/integration_event_spec.rb +1 -1
- data/spec/models/integration_event_v2_request_spec.rb +63 -0
- data/spec/models/integration_profile_entity_spec.rb +1 -1
- data/spec/models/integration_request_spec.rb +2 -2
- data/spec/models/integration_state_spec.rb +1 -1
- data/spec/models/integration_state_v2_spec.rb +13 -1
- data/spec/models/inventory_coupon_spec.rb +7 -1
- data/spec/models/inventory_referral_spec.rb +119 -0
- data/spec/models/ledger_entry_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +83 -0
- data/spec/models/library_attribute_spec.rb +1 -1
- data/spec/models/limit_config_spec.rb +11 -1
- data/spec/models/limit_counter_spec.rb +125 -0
- data/spec/models/login_params_spec.rb +1 -1
- data/spec/models/loyalty_card_profile_registration_spec.rb +47 -0
- data/spec/models/loyalty_card_registration_spec.rb +41 -0
- data/spec/models/loyalty_card_spec.rb +95 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +89 -0
- data/spec/models/loyalty_dashboard_points_breakdown_spec.rb +47 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +7 -1
- data/spec/models/loyalty_ledger_spec.rb +1 -1
- data/spec/models/loyalty_membership_spec.rb +1 -1
- data/spec/models/loyalty_points_spec.rb +1 -1
- data/spec/models/loyalty_program_balance_spec.rb +1 -1
- data/spec/models/loyalty_program_entity_spec.rb +1 -1
- data/spec/models/loyalty_program_ledgers_spec.rb +1 -1
- data/spec/models/loyalty_program_spec.rb +32 -8
- data/spec/models/loyalty_projection_data_spec.rb +59 -0
- data/spec/models/loyalty_projection_spec.rb +53 -0
- data/spec/models/loyalty_spec.rb +7 -1
- data/spec/models/loyalty_statistics_spec.rb +31 -1
- data/spec/models/loyalty_sub_ledger_spec.rb +7 -1
- data/spec/models/loyalty_tier_spec.rb +1 -1
- data/spec/models/manager_config_spec.rb +1 -1
- data/spec/models/meta_spec.rb +1 -1
- data/spec/models/model_return_spec.rb +101 -0
- data/spec/models/multi_application_entity_spec.rb +1 -1
- data/spec/models/multiple_attribute_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +1 -1
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +1 -1
- data/spec/models/multiple_new_attribute_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +1 -1
- data/spec/models/new_account_sign_up_spec.rb +1 -1
- data/spec/models/new_account_spec.rb +1 -1
- data/spec/models/new_additional_cost_spec.rb +11 -1
- data/spec/models/new_application_api_key_spec.rb +2 -2
- data/spec/models/new_application_spec.rb +17 -1
- data/spec/models/new_attribute_spec.rb +13 -1
- data/spec/models/new_audience_spec.rb +1 -5
- data/spec/models/new_campaign_collection_spec.rb +47 -0
- data/spec/models/new_campaign_group_spec.rb +1 -1
- data/spec/models/new_campaign_set_spec.rb +1 -1
- data/spec/models/new_campaign_set_v2_spec.rb +53 -0
- data/spec/models/new_campaign_spec.rb +1 -1
- data/spec/models/new_campaign_template_spec.rb +121 -0
- data/spec/models/new_catalog_spec.rb +53 -0
- data/spec/models/new_collection_spec.rb +53 -0
- data/spec/models/new_coupon_creation_job_spec.rb +77 -0
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +1 -1
- data/spec/models/new_coupons_spec.rb +7 -1
- data/spec/models/new_custom_effect_spec.rb +7 -7
- data/spec/models/new_customer_profile_spec.rb +1 -1
- data/spec/models/new_customer_session_spec.rb +2 -2
- data/spec/models/new_customer_session_v2_spec.rb +8 -2
- data/spec/models/new_event_spec.rb +1 -1
- data/spec/models/new_event_type_spec.rb +1 -51
- data/spec/models/new_giveaways_pool_spec.rb +1 -1
- data/spec/models/new_invitation_spec.rb +1 -1
- data/spec/models/new_invite_email_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +31 -7
- data/spec/models/new_loyalty_tier_spec.rb +1 -1
- data/spec/models/new_notification_webhook_spec.rb +47 -0
- data/spec/models/new_password_email_spec.rb +1 -1
- data/spec/models/new_password_spec.rb +1 -1
- data/spec/models/new_referral_spec.rb +1 -1
- data/spec/models/new_referrals_for_multiple_advocates_spec.rb +1 -1
- data/spec/models/new_return_spec.rb +41 -0
- data/spec/models/new_role_spec.rb +2 -2
- data/spec/models/new_ruleset_spec.rb +1 -1
- data/spec/models/new_saml_connection_spec.rb +1 -1
- data/spec/models/new_template_def_spec.rb +1 -1
- data/spec/models/new_user_spec.rb +1 -1
- data/spec/models/new_webhook_spec.rb +1 -1
- data/spec/models/notification_spec.rb +1 -1
- data/spec/models/notification_webhook_spec.rb +71 -0
- data/spec/models/profile_audiences_changes_spec.rb +1 -1
- data/spec/models/redeem_referral_effect_props_spec.rb +1 -1
- data/spec/models/referral_constraints_spec.rb +1 -1
- data/spec/models/referral_created_effect_props_spec.rb +1 -1
- data/spec/models/referral_rejection_reason_spec.rb +1 -1
- data/spec/models/referral_spec.rb +1 -1
- data/spec/models/reject_coupon_effect_props_spec.rb +1 -1
- data/spec/models/reject_referral_effect_props_spec.rb +1 -1
- data/spec/models/return_integration_request_spec.rb +51 -0
- data/spec/models/returned_cart_item_spec.rb +47 -0
- data/spec/models/role_assign_spec.rb +1 -1
- data/spec/models/role_membership_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +19 -1
- data/spec/models/rollback_coupon_effect_props_spec.rb +1 -1
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +7 -1
- data/spec/models/rollback_discount_effect_props_spec.rb +31 -1
- data/spec/models/rollback_referral_effect_props_spec.rb +1 -1
- data/spec/models/rule_failure_reason_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/ruleset_spec.rb +13 -7
- data/spec/models/saml_connection_metadata_spec.rb +1 -1
- data/spec/models/saml_connection_spec.rb +1 -1
- data/spec/models/saml_login_endpoint_spec.rb +1 -1
- data/spec/models/session_spec.rb +1 -1
- data/spec/models/set_discount_effect_props_spec.rb +7 -1
- data/spec/models/set_discount_per_additional_cost_effect_props_spec.rb +65 -0
- data/spec/models/set_discount_per_additional_cost_per_item_effect_props_spec.rb +77 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +25 -1
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +1 -1
- data/spec/models/show_notification_effect_props_spec.rb +1 -1
- data/spec/models/slot_def_spec.rb +1 -1
- data/spec/models/template_arg_def_spec.rb +1 -1
- data/spec/models/template_def_spec.rb +1 -1
- data/spec/models/template_limit_config_spec.rb +67 -0
- data/spec/models/tier_spec.rb +47 -0
- data/spec/models/trigger_webhook_effect_props_spec.rb +1 -1
- data/spec/models/update_account_spec.rb +1 -1
- data/spec/models/update_application_spec.rb +17 -1
- data/spec/models/update_attribute_effect_props_spec.rb +1 -1
- data/spec/models/update_audience_spec.rb +1 -1
- data/spec/models/update_campaign_collection_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +1 -1
- data/spec/models/update_campaign_spec.rb +1 -1
- data/spec/models/update_campaign_template_spec.rb +133 -0
- data/spec/models/update_catalog_spec.rb +53 -0
- data/spec/models/update_collection_spec.rb +47 -0
- data/spec/models/update_coupon_batch_spec.rb +1 -1
- data/spec/models/update_coupon_spec.rb +7 -1
- data/spec/models/update_custom_effect_spec.rb +7 -7
- data/spec/models/update_loyalty_card_spec.rb +41 -0
- data/spec/models/update_loyalty_program_spec.rb +13 -1
- data/spec/models/update_referral_batch_spec.rb +65 -0
- data/spec/models/update_referral_spec.rb +1 -1
- data/spec/models/update_role_spec.rb +2 -2
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +1 -1
- data/spec/models/update_user_spec.rb +1 -1
- data/spec/models/user_entity_spec.rb +1 -1
- data/spec/models/user_feed_notifications_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/webhook_activation_log_entry_spec.rb +1 -1
- data/spec/models/webhook_log_entry_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/will_award_giveaway_effect_props_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/talon_one.gemspec +1 -1
- metadata +493 -240
- data/docs/ApplicationCustomerSearch.md +0 -21
- data/docs/FeatureFlags.md +0 -23
- data/docs/NewFeatureFlags.md +0 -21
- data/docs/UpdateLoyaltyTier.md +0 -19
- data/spec/models/application_customer_search_spec.rb +0 -53
- data/spec/models/feature_flags_spec.rb +0 -59
- data/spec/models/new_feature_flags_spec.rb +0 -53
- data/spec/models/update_loyalty_tier_spec.rb +0 -47
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Talon.One API
|
3
3
|
|
4
|
-
#
|
4
|
+
#Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerSession](https://docs.talon.one/integration-api/#operation/updateCustomerSessionV2) endpoint is `https://mycompany.talon.one/v2/customer_sessions/{Id}`
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
@@ -33,9 +33,10 @@ describe 'ManagementApi' do
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# unit tests for add_loyalty_points
|
36
|
-
# Add points in
|
37
|
-
#
|
38
|
-
# @param
|
36
|
+
# Add points in loyalty program for given customer
|
37
|
+
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2).
|
38
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
39
|
+
# @param integration_id The identifier of the profile.
|
39
40
|
# @param body
|
40
41
|
# @param [Hash] opts the optional parameters
|
41
42
|
# @return [nil]
|
@@ -46,10 +47,10 @@ describe 'ManagementApi' do
|
|
46
47
|
end
|
47
48
|
|
48
49
|
# unit tests for copy_campaign_to_applications
|
49
|
-
# Copy the campaign into
|
50
|
-
# Copy the campaign into
|
51
|
-
# @param application_id
|
52
|
-
# @param campaign_id
|
50
|
+
# Copy the campaign into the specified application
|
51
|
+
# Copy the campaign into all specified application.
|
52
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
53
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
53
54
|
# @param body
|
54
55
|
# @param [Hash] opts the optional parameters
|
55
56
|
# @return [InlineResponse2002]
|
@@ -59,9 +60,21 @@ describe 'ManagementApi' do
|
|
59
60
|
end
|
60
61
|
end
|
61
62
|
|
63
|
+
# unit tests for create_account_collection
|
64
|
+
# Create account-level collection
|
65
|
+
# Create account-level collection.
|
66
|
+
# @param body
|
67
|
+
# @param [Hash] opts the optional parameters
|
68
|
+
# @return [Collection]
|
69
|
+
describe 'create_account_collection test' do
|
70
|
+
it 'should work' do
|
71
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
62
75
|
# unit tests for create_additional_cost
|
63
|
-
#
|
64
|
-
#
|
76
|
+
# Create additional cost
|
77
|
+
# Create an [additional cost](/docs/product/account/dev-tools/managing-additional-costs/). These additional costs are shared across all applications in your account, and are never required.
|
65
78
|
# @param body
|
66
79
|
# @param [Hash] opts the optional parameters
|
67
80
|
# @return [AccountAdditionalCost]
|
@@ -72,8 +85,8 @@ describe 'ManagementApi' do
|
|
72
85
|
end
|
73
86
|
|
74
87
|
# unit tests for create_attribute
|
75
|
-
#
|
76
|
-
#
|
88
|
+
# Create custom attribute
|
89
|
+
# Create a _custom attribute_ in this account. Custom attributes allow you to attach new fields to Talon.One domain objects like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these objects, and these values can be used in your campaign rules. For example, you could define a `zipCode` field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all applications in your account, and are never required.
|
77
90
|
# @param body
|
78
91
|
# @param [Hash] opts the optional parameters
|
79
92
|
# @return [Attribute]
|
@@ -83,26 +96,41 @@ describe 'ManagementApi' do
|
|
83
96
|
end
|
84
97
|
end
|
85
98
|
|
86
|
-
# unit tests for
|
87
|
-
# Create
|
88
|
-
#
|
99
|
+
# unit tests for create_campaign_from_template
|
100
|
+
# Create campaign from campaign template
|
101
|
+
# Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing [campaign collections](https://docs.talon.one/docs/product/campaigns/managing-collections), the corresponding collections for the new campaign are created automatically.
|
102
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
89
103
|
# @param body
|
90
104
|
# @param [Hash] opts the optional parameters
|
91
|
-
# @return [
|
92
|
-
describe '
|
105
|
+
# @return [CreateTemplateCampaignResponse]
|
106
|
+
describe 'create_campaign_from_template test' do
|
107
|
+
it 'should work' do
|
108
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
# unit tests for create_collection
|
113
|
+
# Create collection
|
114
|
+
# Create a collection.
|
115
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
116
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
117
|
+
# @param body
|
118
|
+
# @param [Hash] opts the optional parameters
|
119
|
+
# @return [Collection]
|
120
|
+
describe 'create_collection test' do
|
93
121
|
it 'should work' do
|
94
122
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
95
123
|
end
|
96
124
|
end
|
97
125
|
|
98
126
|
# unit tests for create_coupons
|
99
|
-
# Create
|
127
|
+
# Create coupons
|
100
128
|
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
101
|
-
# @param application_id
|
102
|
-
# @param campaign_id
|
129
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
130
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
103
131
|
# @param body
|
104
132
|
# @param [Hash] opts the optional parameters
|
105
|
-
# @option opts [String] :silent
|
133
|
+
# @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 essential data such as the updated customer profiles and session-related information.
|
106
134
|
# @return [InlineResponse2004]
|
107
135
|
describe 'create_coupons test' do
|
108
136
|
it 'should work' do
|
@@ -110,14 +138,28 @@ describe 'ManagementApi' do
|
|
110
138
|
end
|
111
139
|
end
|
112
140
|
|
141
|
+
# unit tests for create_coupons_async
|
142
|
+
# Create coupons asynchronously
|
143
|
+
# Create any number of coupons from 20,001 to 5,000,000.
|
144
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
145
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
146
|
+
# @param body
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @return [AsyncCouponCreationResponse]
|
149
|
+
describe 'create_coupons_async test' do
|
150
|
+
it 'should work' do
|
151
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
113
155
|
# unit tests for create_coupons_for_multiple_recipients
|
114
|
-
# Create
|
156
|
+
# Create coupons for multiple recipients
|
115
157
|
# Create coupons according to some pattern for up to 1000 recipients.
|
116
|
-
# @param application_id
|
117
|
-
# @param campaign_id
|
158
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
159
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
118
160
|
# @param body
|
119
161
|
# @param [Hash] opts the optional parameters
|
120
|
-
# @option opts [String] :silent
|
162
|
+
# @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 essential data such as the updated customer profiles and session-related information.
|
121
163
|
# @return [InlineResponse2004]
|
122
164
|
describe 'create_coupons_for_multiple_recipients test' do
|
123
165
|
it 'should work' do
|
@@ -127,7 +169,7 @@ describe 'ManagementApi' do
|
|
127
169
|
|
128
170
|
# unit tests for create_password_recovery_email
|
129
171
|
# Request a password reset
|
130
|
-
#
|
172
|
+
# Send an email with a password recovery link to the email address of an existing account.
|
131
173
|
# @param body
|
132
174
|
# @param [Hash] opts the optional parameters
|
133
175
|
# @return [NewPasswordEmail]
|
@@ -137,34 +179,35 @@ describe 'ManagementApi' do
|
|
137
179
|
end
|
138
180
|
end
|
139
181
|
|
140
|
-
# unit tests for
|
141
|
-
# Create
|
142
|
-
#
|
143
|
-
# @param campaign_id
|
182
|
+
# unit tests for create_session
|
183
|
+
# Create session
|
184
|
+
# Create a session to use the Management API endpoints. Use the value of the `token` property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do **not** regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. **Note:** You can also use your browser's developer's console to [display your token](https://docs.talon.one/docs/dev/tutorials/receiving-loyalty-ledger-braze/#extracting-the-session-token) when you log into the Campaign Manager. In this case, keep in mind that logging out destroys the token.
|
144
185
|
# @param body
|
145
186
|
# @param [Hash] opts the optional parameters
|
146
|
-
# @return [
|
147
|
-
describe '
|
187
|
+
# @return [Session]
|
188
|
+
describe 'create_session test' do
|
148
189
|
it 'should work' do
|
149
190
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
150
191
|
end
|
151
192
|
end
|
152
193
|
|
153
|
-
# unit tests for
|
154
|
-
#
|
155
|
-
#
|
194
|
+
# unit tests for delete_account_collection
|
195
|
+
# Delete account-level collection
|
196
|
+
# Delete the given account-level collection
|
197
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
156
198
|
# @param [Hash] opts the optional parameters
|
157
|
-
# @return [
|
158
|
-
describe '
|
199
|
+
# @return [nil]
|
200
|
+
describe 'delete_account_collection test' do
|
159
201
|
it 'should work' do
|
160
202
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
161
203
|
end
|
162
204
|
end
|
163
205
|
|
164
206
|
# unit tests for delete_campaign
|
165
|
-
# Delete
|
166
|
-
#
|
167
|
-
# @param
|
207
|
+
# Delete campaign
|
208
|
+
# Delete the given campaign.
|
209
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
210
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
168
211
|
# @param [Hash] opts the optional parameters
|
169
212
|
# @return [nil]
|
170
213
|
describe 'delete_campaign test' do
|
@@ -173,11 +216,26 @@ describe 'ManagementApi' do
|
|
173
216
|
end
|
174
217
|
end
|
175
218
|
|
219
|
+
# unit tests for delete_collection
|
220
|
+
# Delete collection
|
221
|
+
# Delete the given collection.
|
222
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
223
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
224
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
225
|
+
# @param [Hash] opts the optional parameters
|
226
|
+
# @return [nil]
|
227
|
+
describe 'delete_collection test' do
|
228
|
+
it 'should work' do
|
229
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
176
233
|
# unit tests for delete_coupon
|
177
|
-
# Delete
|
178
|
-
#
|
179
|
-
# @param
|
180
|
-
# @param
|
234
|
+
# Delete coupon
|
235
|
+
# Delete the specified coupon.
|
236
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
237
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
238
|
+
# @param coupon_id The ID of the coupon code to update
|
181
239
|
# @param [Hash] opts the optional parameters
|
182
240
|
# @return [nil]
|
183
241
|
describe 'delete_coupon test' do
|
@@ -187,9 +245,10 @@ describe 'ManagementApi' do
|
|
187
245
|
end
|
188
246
|
|
189
247
|
# unit tests for delete_coupons
|
190
|
-
# Delete
|
191
|
-
#
|
192
|
-
# @param
|
248
|
+
# Delete coupons
|
249
|
+
# Deletes all the coupons matching the specified criteria.
|
250
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
251
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
193
252
|
# @param [Hash] opts the optional parameters
|
194
253
|
# @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.
|
195
254
|
# @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 timezone. Talon.One will convert to UTC internally.
|
@@ -198,11 +257,11 @@ describe 'ManagementApi' do
|
|
198
257
|
# @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 timezone. Talon.One will convert to UTC internally.
|
199
258
|
# @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 timezone. Talon.One will convert to UTC internally.
|
200
259
|
# @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 timezone. Talon.One will convert to UTC internally.
|
201
|
-
# @option opts [String] :valid
|
260
|
+
# @option opts [String] :valid - `expired`: Matches coupons in which the expiry date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiry date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future.
|
202
261
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
203
|
-
# @option opts [String] :usable
|
262
|
+
# @option opts [String] :usable - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned.
|
204
263
|
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
205
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
264
|
+
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's `RecipientIntegrationId` field.
|
206
265
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
207
266
|
# @return [nil]
|
208
267
|
describe 'delete_coupons test' do
|
@@ -211,34 +270,36 @@ describe 'ManagementApi' do
|
|
211
270
|
end
|
212
271
|
end
|
213
272
|
|
214
|
-
# unit tests for
|
215
|
-
# Delete
|
216
|
-
#
|
217
|
-
# @param
|
218
|
-
# @param
|
273
|
+
# unit tests for delete_loyalty_card
|
274
|
+
# Delete loyalty card
|
275
|
+
# Delete the specified loyalty card.
|
276
|
+
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms).
|
277
|
+
# @param loyalty_card_identifier Identifier of the loyalty card.
|
219
278
|
# @param [Hash] opts the optional parameters
|
220
279
|
# @return [nil]
|
221
|
-
describe '
|
280
|
+
describe 'delete_loyalty_card test' do
|
222
281
|
it 'should work' do
|
223
282
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
224
283
|
end
|
225
284
|
end
|
226
285
|
|
227
|
-
# unit tests for
|
228
|
-
# Delete
|
229
|
-
#
|
230
|
-
# @param
|
231
|
-
# @param
|
286
|
+
# unit tests for delete_referral
|
287
|
+
# Delete referral
|
288
|
+
# Delete the specified referral.
|
289
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
290
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
291
|
+
# @param referral_id The ID of the referral code to delete
|
232
292
|
# @param [Hash] opts the optional parameters
|
233
293
|
# @return [nil]
|
234
|
-
describe '
|
294
|
+
describe 'delete_referral test' do
|
235
295
|
it 'should work' do
|
236
296
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
237
297
|
end
|
238
298
|
end
|
239
299
|
|
240
300
|
# unit tests for destroy_session
|
241
|
-
# Destroy
|
301
|
+
# Destroy session
|
302
|
+
# Destroys the session.
|
242
303
|
# @param [Hash] opts the optional parameters
|
243
304
|
# @return [nil]
|
244
305
|
describe 'destroy_session test' do
|
@@ -247,10 +308,36 @@ describe 'ManagementApi' do
|
|
247
308
|
end
|
248
309
|
end
|
249
310
|
|
311
|
+
# unit tests for export_account_collection_items
|
312
|
+
# Export account-level collection items to CSV file
|
313
|
+
# Download a file containing an account-level collection's items.
|
314
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
315
|
+
# @param [Hash] opts the optional parameters
|
316
|
+
# @return [String]
|
317
|
+
describe 'export_account_collection_items 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
|
+
|
323
|
+
# unit tests for export_collection_items
|
324
|
+
# Export a collection's items to CSV file
|
325
|
+
# Download a file containing a collection's items.
|
326
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
327
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
328
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
329
|
+
# @param [Hash] opts the optional parameters
|
330
|
+
# @return [String]
|
331
|
+
describe 'export_collection_items test' do
|
332
|
+
it 'should work' do
|
333
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
334
|
+
end
|
335
|
+
end
|
336
|
+
|
250
337
|
# unit tests for export_coupons
|
251
|
-
# Export
|
252
|
-
# Download a file
|
253
|
-
# @param application_id
|
338
|
+
# Export coupons to CSV file
|
339
|
+
# Download a file containing the coupons that match the given properties.
|
340
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
254
341
|
# @param [Hash] opts the optional parameters
|
255
342
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
256
343
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
@@ -264,7 +351,7 @@ describe 'ManagementApi' do
|
|
264
351
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
265
352
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
266
353
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
267
|
-
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
354
|
+
# @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.
|
268
355
|
# @return [String]
|
269
356
|
describe 'export_coupons test' do
|
270
357
|
it 'should work' do
|
@@ -273,9 +360,9 @@ describe 'ManagementApi' do
|
|
273
360
|
end
|
274
361
|
|
275
362
|
# unit tests for export_customer_sessions
|
276
|
-
# Export
|
277
|
-
# Download a file
|
278
|
-
# @param application_id
|
363
|
+
# Export customer sessions to CSV file
|
364
|
+
# Download a file containing the customer sessions that match the request.
|
365
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
279
366
|
# @param [Hash] opts the optional parameters
|
280
367
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
281
368
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
@@ -290,9 +377,9 @@ describe 'ManagementApi' do
|
|
290
377
|
end
|
291
378
|
|
292
379
|
# unit tests for export_effects
|
293
|
-
# Export triggered
|
294
|
-
# Download a file
|
295
|
-
# @param application_id
|
380
|
+
# Export triggered effects to CSV file
|
381
|
+
# Download a file containing the triggered effects that match the given attributes.
|
382
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
296
383
|
# @param [Hash] opts the optional parameters
|
297
384
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
298
385
|
# @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 timezone. Talon.One will convert to UTC internally.
|
@@ -307,8 +394,8 @@ describe 'ManagementApi' do
|
|
307
394
|
|
308
395
|
# unit tests for export_loyalty_balance
|
309
396
|
# Export customer loyalty balance to a CSV file
|
310
|
-
# Download a file with the balance of each customer in the loyalty program
|
311
|
-
# @param
|
397
|
+
# Download a file with the balance of each customer in the loyalty program.
|
398
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
312
399
|
# @param [Hash] opts the optional parameters
|
313
400
|
# @return [String]
|
314
401
|
describe 'export_loyalty_balance test' do
|
@@ -318,12 +405,12 @@ describe 'ManagementApi' do
|
|
318
405
|
end
|
319
406
|
|
320
407
|
# unit tests for export_loyalty_ledger
|
321
|
-
# Export a customer's loyalty ledger log to
|
408
|
+
# Export a customer's loyalty ledger log to CSV file
|
322
409
|
# Download a file with a customer's ledger log in the loyalty program
|
323
410
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
324
411
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
325
|
-
# @param
|
326
|
-
# @param integration_id
|
412
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
413
|
+
# @param integration_id The identifier of the profile.
|
327
414
|
# @param [Hash] opts the optional parameters
|
328
415
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
329
416
|
# @return [String]
|
@@ -333,28 +420,29 @@ describe 'ManagementApi' do
|
|
333
420
|
end
|
334
421
|
end
|
335
422
|
|
336
|
-
# unit tests for
|
337
|
-
#
|
338
|
-
#
|
339
|
-
# @param
|
340
|
-
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
423
|
+
# unit tests for export_referrals
|
424
|
+
# Export referrals to CSV file
|
425
|
+
# Download a file containing the referrals that match the given parameters.
|
426
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
341
427
|
# @param [Hash] opts the optional parameters
|
342
|
-
# @option opts [
|
343
|
-
# @option opts [
|
344
|
-
# @option opts [
|
345
|
-
# @option opts [
|
346
|
-
# @option opts [
|
347
|
-
# @option opts [String] :
|
348
|
-
# @
|
349
|
-
|
428
|
+
# @option opts [Float] :campaign_id Filter results by campaign.
|
429
|
+
# @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 timezone. Talon.One will convert to UTC internally.
|
430
|
+
# @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 timezone. Talon.One will convert to UTC internally.
|
431
|
+
# @option opts [String] :valid - `expired`: Matches referrals in which the expiry date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiry date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future.
|
432
|
+
# @option opts [String] :usable - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned.
|
433
|
+
# @option opts [String] :batch_id Filter results by batches of referrals
|
434
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
435
|
+
# @return [String]
|
436
|
+
describe 'export_referrals test' do
|
350
437
|
it 'should work' do
|
351
438
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
352
439
|
end
|
353
440
|
end
|
354
441
|
|
355
442
|
# unit tests for get_access_logs_without_total_count
|
356
|
-
# Get access logs for
|
357
|
-
#
|
443
|
+
# Get access logs for Application
|
444
|
+
# Retrieve the list of API calls to this Application matching the specified criteria.
|
445
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
358
446
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
359
447
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
360
448
|
# @param [Hash] opts the optional parameters
|
@@ -364,7 +452,7 @@ describe 'ManagementApi' do
|
|
364
452
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
365
453
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
366
454
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
367
|
-
# @return [
|
455
|
+
# @return [InlineResponse20010]
|
368
456
|
describe 'get_access_logs_without_total_count test' do
|
369
457
|
it 'should work' do
|
370
458
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -372,9 +460,9 @@ describe 'ManagementApi' do
|
|
372
460
|
end
|
373
461
|
|
374
462
|
# unit tests for get_account
|
375
|
-
# Get
|
463
|
+
# Get account details
|
376
464
|
# Return the details of your companies Talon.One account.
|
377
|
-
# @param account_id
|
465
|
+
# @param account_id The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property.
|
378
466
|
# @param [Hash] opts the optional parameters
|
379
467
|
# @return [Account]
|
380
468
|
describe 'get_account test' do
|
@@ -384,9 +472,9 @@ describe 'ManagementApi' do
|
|
384
472
|
end
|
385
473
|
|
386
474
|
# unit tests for get_account_analytics
|
387
|
-
# Get
|
388
|
-
# Return the analytics of your
|
389
|
-
# @param account_id
|
475
|
+
# Get account analytics
|
476
|
+
# Return the analytics of your Talon.One account.
|
477
|
+
# @param account_id The identifier of the account. Retrieve it via the [List users in account endpoint](https://docs.talon.one/management-api#operation/getUsers), in the `accountId` property.
|
390
478
|
# @param [Hash] opts the optional parameters
|
391
479
|
# @return [AccountAnalytics]
|
392
480
|
describe 'get_account_analytics test' do
|
@@ -395,9 +483,21 @@ describe 'ManagementApi' do
|
|
395
483
|
end
|
396
484
|
end
|
397
485
|
|
486
|
+
# unit tests for get_account_collection
|
487
|
+
# Get account-level collection
|
488
|
+
# Retrieve the given account-level collection
|
489
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
490
|
+
# @param [Hash] opts the optional parameters
|
491
|
+
# @return [Collection]
|
492
|
+
describe 'get_account_collection test' do
|
493
|
+
it 'should work' do
|
494
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
495
|
+
end
|
496
|
+
end
|
497
|
+
|
398
498
|
# unit tests for get_additional_cost
|
399
|
-
# Get
|
400
|
-
# Returns additional cost
|
499
|
+
# Get additional cost
|
500
|
+
# Returns the additional cost.
|
401
501
|
# @param additional_cost_id
|
402
502
|
# @param [Hash] opts the optional parameters
|
403
503
|
# @return [AccountAdditionalCost]
|
@@ -414,7 +514,7 @@ describe 'ManagementApi' do
|
|
414
514
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
415
515
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
416
516
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
417
|
-
# @return [
|
517
|
+
# @return [InlineResponse20023]
|
418
518
|
describe 'get_additional_costs test' do
|
419
519
|
it 'should work' do
|
420
520
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -422,7 +522,7 @@ describe 'ManagementApi' do
|
|
422
522
|
end
|
423
523
|
|
424
524
|
# unit tests for get_all_access_logs
|
425
|
-
#
|
525
|
+
# List access logs
|
426
526
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
427
527
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
428
528
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -433,7 +533,7 @@ describe 'ManagementApi' do
|
|
433
533
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
434
534
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
435
535
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
436
|
-
# @return [
|
536
|
+
# @return [InlineResponse20011]
|
437
537
|
describe 'get_all_access_logs test' do
|
438
538
|
it 'should work' do
|
439
539
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -441,9 +541,10 @@ describe 'ManagementApi' do
|
|
441
541
|
end
|
442
542
|
|
443
543
|
# unit tests for get_all_roles
|
444
|
-
#
|
544
|
+
# List roles
|
545
|
+
# List all roles.
|
445
546
|
# @param [Hash] opts the optional parameters
|
446
|
-
# @return [
|
547
|
+
# @return [InlineResponse20031]
|
447
548
|
describe 'get_all_roles test' do
|
448
549
|
it 'should work' do
|
449
550
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -451,9 +552,9 @@ describe 'ManagementApi' do
|
|
451
552
|
end
|
452
553
|
|
453
554
|
# unit tests for get_application
|
454
|
-
# Get
|
555
|
+
# Get application
|
455
556
|
# Get the application specified by the ID.
|
456
|
-
# @param application_id
|
557
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
457
558
|
# @param [Hash] opts the optional parameters
|
458
559
|
# @return [Application]
|
459
560
|
describe 'get_application test' do
|
@@ -464,7 +565,8 @@ describe 'ManagementApi' do
|
|
464
565
|
|
465
566
|
# unit tests for get_application_api_health
|
466
567
|
# Get report of health of application API
|
467
|
-
#
|
568
|
+
# Display the health of the application and show the last time the Application was used.
|
569
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
468
570
|
# @param [Hash] opts the optional parameters
|
469
571
|
# @return [ApplicationApiHealth]
|
470
572
|
describe 'get_application_api_health test' do
|
@@ -474,9 +576,10 @@ describe 'ManagementApi' do
|
|
474
576
|
end
|
475
577
|
|
476
578
|
# unit tests for get_application_customer
|
477
|
-
# Get
|
478
|
-
#
|
479
|
-
# @param
|
579
|
+
# Get application's customer
|
580
|
+
# Retrieve the customers of the specified application.
|
581
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
582
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint.
|
480
583
|
# @param [Hash] opts the optional parameters
|
481
584
|
# @return [ApplicationCustomer]
|
482
585
|
describe 'get_application_customer test' do
|
@@ -485,78 +588,74 @@ describe 'ManagementApi' do
|
|
485
588
|
end
|
486
589
|
end
|
487
590
|
|
488
|
-
# unit tests for
|
489
|
-
# List
|
490
|
-
#
|
591
|
+
# unit tests for get_application_customer_friends
|
592
|
+
# List friends referred by customer profile
|
593
|
+
# List the friends referred by the specified customer profile in this Application.
|
594
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
595
|
+
# @param integration_id The Integration ID of the Advocate's Profile.
|
491
596
|
# @param [Hash] opts the optional parameters
|
492
|
-
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
493
597
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
494
598
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
495
|
-
# @option opts [
|
496
|
-
# @
|
497
|
-
|
599
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
600
|
+
# @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.
|
601
|
+
# @return [InlineResponse20021]
|
602
|
+
describe 'get_application_customer_friends test' do
|
498
603
|
it 'should work' do
|
499
604
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
500
605
|
end
|
501
606
|
end
|
502
607
|
|
503
|
-
# unit tests for
|
504
|
-
#
|
505
|
-
#
|
506
|
-
# @param
|
608
|
+
# unit tests for get_application_customers
|
609
|
+
# List application's customers
|
610
|
+
# List all the customers of the specified application.
|
611
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
507
612
|
# @param [Hash] opts the optional parameters
|
508
|
-
# @
|
509
|
-
|
613
|
+
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
614
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
615
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
616
|
+
# @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.
|
617
|
+
# @return [InlineResponse20013]
|
618
|
+
describe 'get_application_customers test' do
|
510
619
|
it 'should work' do
|
511
620
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
512
621
|
end
|
513
622
|
end
|
514
623
|
|
515
|
-
# unit tests for
|
516
|
-
# List
|
517
|
-
# Get
|
518
|
-
# @param application_id
|
624
|
+
# unit tests for get_application_customers_by_attributes
|
625
|
+
# List application customers matching the given attributes
|
626
|
+
# Get a list of the application customers 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.
|
627
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
628
|
+
# @param body
|
519
629
|
# @param [Hash] opts the optional parameters
|
520
630
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
521
631
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
522
|
-
# @option opts [
|
523
|
-
# @return [
|
524
|
-
describe '
|
632
|
+
# @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.
|
633
|
+
# @return [InlineResponse20014]
|
634
|
+
describe 'get_application_customers_by_attributes test' do
|
525
635
|
it 'should work' do
|
526
636
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
527
637
|
end
|
528
638
|
end
|
529
639
|
|
530
|
-
# unit tests for
|
531
|
-
# List Applications
|
532
|
-
#
|
533
|
-
# @param application_id
|
640
|
+
# unit tests for get_application_event_types
|
641
|
+
# List Applications event types
|
642
|
+
# Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/#operation/trackEvent)
|
643
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
534
644
|
# @param [Hash] opts the optional parameters
|
535
645
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
536
646
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
537
647
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
538
|
-
# @
|
539
|
-
|
540
|
-
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
541
|
-
# @option opts [String] :session Session integration ID filter for events. Must be exact match.
|
542
|
-
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
543
|
-
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
544
|
-
# @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
|
545
|
-
# @option opts [String] :coupon_code Coupon code
|
546
|
-
# @option opts [String] :referral_code Referral code
|
547
|
-
# @option opts [String] :rule_query Rule name filter for events
|
548
|
-
# @option opts [String] :campaign_query Campaign name filter for events
|
549
|
-
# @return [InlineResponse20016]
|
550
|
-
describe 'get_application_events test' do
|
648
|
+
# @return [InlineResponse20019]
|
649
|
+
describe 'get_application_event_types test' do
|
551
650
|
it 'should work' do
|
552
651
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
553
652
|
end
|
554
653
|
end
|
555
654
|
|
556
655
|
# unit tests for get_application_events_without_total_count
|
557
|
-
# List Applications
|
656
|
+
# List Applications events
|
558
657
|
# Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
|
559
|
-
# @param application_id
|
658
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
560
659
|
# @param [Hash] opts the optional parameters
|
561
660
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
562
661
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -572,7 +671,7 @@ describe 'ManagementApi' do
|
|
572
671
|
# @option opts [String] :referral_code Referral code
|
573
672
|
# @option opts [String] :rule_query Rule name filter for events
|
574
673
|
# @option opts [String] :campaign_query Campaign name filter for events
|
575
|
-
# @return [
|
674
|
+
# @return [InlineResponse20018]
|
576
675
|
describe 'get_application_events_without_total_count test' do
|
577
676
|
it 'should work' do
|
578
677
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -580,9 +679,10 @@ describe 'ManagementApi' do
|
|
580
679
|
end
|
581
680
|
|
582
681
|
# unit tests for get_application_session
|
583
|
-
# Get Application
|
584
|
-
#
|
585
|
-
# @param
|
682
|
+
# Get Application session
|
683
|
+
# Get the details of the given session. You can list the sessions with the [List Application sessions](#operation/getApplicationSessions) endpoint.
|
684
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
685
|
+
# @param session_id The **internal** ID of the session. You can get the ID with the [List Application sessions endpoint](#operation/getApplicationSessions).
|
586
686
|
# @param [Hash] opts the optional parameters
|
587
687
|
# @return [ApplicationSession]
|
588
688
|
describe 'get_application_session test' do
|
@@ -592,8 +692,9 @@ describe 'ManagementApi' do
|
|
592
692
|
end
|
593
693
|
|
594
694
|
# unit tests for get_application_sessions
|
595
|
-
# List Application
|
596
|
-
#
|
695
|
+
# List Application sessions
|
696
|
+
# List all the sessions of the specified Application.
|
697
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
597
698
|
# @param [Hash] opts the optional parameters
|
598
699
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
599
700
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -605,7 +706,7 @@ describe 'ManagementApi' do
|
|
605
706
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
606
707
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
607
708
|
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
608
|
-
# @return [
|
709
|
+
# @return [InlineResponse20017]
|
609
710
|
describe 'get_application_sessions test' do
|
610
711
|
it 'should work' do
|
611
712
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -613,8 +714,8 @@ describe 'ManagementApi' do
|
|
613
714
|
end
|
614
715
|
|
615
716
|
# unit tests for get_applications
|
616
|
-
# List
|
617
|
-
# List all
|
717
|
+
# List applications
|
718
|
+
# List all applications in the current account.
|
618
719
|
# @param [Hash] opts the optional parameters
|
619
720
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
620
721
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -627,7 +728,7 @@ describe 'ManagementApi' do
|
|
627
728
|
end
|
628
729
|
|
629
730
|
# unit tests for get_attribute
|
630
|
-
# Get
|
731
|
+
# Get custom attribute
|
631
732
|
# Returns custom attribute for the account by its id.
|
632
733
|
# @param attribute_id
|
633
734
|
# @param [Hash] opts the optional parameters
|
@@ -646,7 +747,7 @@ describe 'ManagementApi' do
|
|
646
747
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
647
748
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
648
749
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity
|
649
|
-
# @return [
|
750
|
+
# @return [InlineResponse20022]
|
650
751
|
describe 'get_attributes test' do
|
651
752
|
it 'should work' do
|
652
753
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -654,14 +755,14 @@ describe 'ManagementApi' do
|
|
654
755
|
end
|
655
756
|
|
656
757
|
# unit tests for get_audiences
|
657
|
-
#
|
758
|
+
# List audiences
|
658
759
|
# Get All audiences created in the account.
|
659
760
|
# @param [Hash] opts the optional parameters
|
660
761
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
661
762
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
662
763
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
663
|
-
# @option opts [Boolean] :with_total_result_size When this flag is set, the result
|
664
|
-
# @return [
|
764
|
+
# @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.
|
765
|
+
# @return [InlineResponse20020]
|
665
766
|
describe 'get_audiences test' do
|
666
767
|
it 'should work' do
|
667
768
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -669,9 +770,10 @@ describe 'ManagementApi' do
|
|
669
770
|
end
|
670
771
|
|
671
772
|
# unit tests for get_campaign
|
672
|
-
# Get
|
673
|
-
#
|
674
|
-
# @param
|
773
|
+
# Get campaign
|
774
|
+
# Retrieve the given campaign.
|
775
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
776
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
675
777
|
# @param [Hash] opts the optional parameters
|
676
778
|
# @return [Campaign]
|
677
779
|
describe 'get_campaign test' do
|
@@ -682,13 +784,14 @@ describe 'ManagementApi' do
|
|
682
784
|
|
683
785
|
# unit tests for get_campaign_analytics
|
684
786
|
# Get analytics of campaigns
|
685
|
-
#
|
686
|
-
# @param
|
787
|
+
# Retrieve statistical data about the performance of the given campaign.
|
788
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
789
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
687
790
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
688
791
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
689
792
|
# @param [Hash] opts the optional parameters
|
690
793
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
691
|
-
# @return [
|
794
|
+
# @return [InlineResponse20012]
|
692
795
|
describe 'get_campaign_analytics test' do
|
693
796
|
it 'should work' do
|
694
797
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -696,15 +799,15 @@ describe 'ManagementApi' do
|
|
696
799
|
end
|
697
800
|
|
698
801
|
# unit tests for get_campaign_by_attributes
|
699
|
-
#
|
700
|
-
#
|
701
|
-
# @param application_id
|
802
|
+
# List campaigns that match the given attributes
|
803
|
+
# Get a list of all the campaigns that match a set of attributes.
|
804
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
702
805
|
# @param body
|
703
806
|
# @param [Hash] opts the optional parameters
|
704
807
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
705
808
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
706
809
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
707
|
-
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
810
|
+
# @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.
|
708
811
|
# @return [InlineResponse2002]
|
709
812
|
describe 'get_campaign_by_attributes test' do
|
710
813
|
it 'should work' do
|
@@ -713,18 +816,20 @@ describe 'ManagementApi' do
|
|
713
816
|
end
|
714
817
|
|
715
818
|
# unit tests for get_campaigns
|
716
|
-
# List
|
717
|
-
#
|
819
|
+
# List campaigns
|
820
|
+
# List the campaigns of the specified application that match your filter criteria.
|
821
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
718
822
|
# @param [Hash] opts the optional parameters
|
719
823
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
720
824
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
721
825
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
722
|
-
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
826
|
+
# @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.
|
723
827
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
724
828
|
# @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
|
725
829
|
# @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 timezone. Talon.One will convert to UTC internally.
|
726
830
|
# @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 timezone. Talon.One will convert to UTC internally.
|
727
831
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
832
|
+
# @option opts [Integer] :template_id The ID of the Campaign Template this Campaign was created from.
|
728
833
|
# @return [InlineResponse2002]
|
729
834
|
describe 'get_campaigns test' do
|
730
835
|
it 'should work' do
|
@@ -739,104 +844,39 @@ describe 'ManagementApi' do
|
|
739
844
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
740
845
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
741
846
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
742
|
-
# @option opts [
|
847
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
743
848
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
744
|
-
# @option opts [Integer] :user_id
|
849
|
+
# @option opts [Integer] :user_id Filter results that match the given user ID.
|
745
850
|
# @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 timezone. Talon.One will convert to UTC internally.
|
746
851
|
# @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 timezone. Talon.One will convert to UTC internally.
|
747
|
-
# @option opts [Boolean] :with_total_result_size When this flag is set, the result
|
852
|
+
# @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.
|
748
853
|
# @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.
|
749
|
-
# @return [
|
854
|
+
# @return [InlineResponse20029]
|
750
855
|
describe 'get_changes test' do
|
751
856
|
it 'should work' do
|
752
857
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
753
858
|
end
|
754
859
|
end
|
755
860
|
|
756
|
-
# unit tests for
|
757
|
-
#
|
758
|
-
#
|
759
|
-
# @param
|
760
|
-
# @param
|
761
|
-
# @
|
762
|
-
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
763
|
-
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
764
|
-
# @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.
|
765
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
766
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
767
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
768
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
769
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
770
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
771
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
|
772
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
773
|
-
# @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`.
|
774
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
775
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
776
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
777
|
-
# @return [InlineResponse2004]
|
778
|
-
describe 'get_coupons test' do
|
779
|
-
it 'should work' do
|
780
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
781
|
-
end
|
782
|
-
end
|
783
|
-
|
784
|
-
# unit tests for get_coupons_by_attributes
|
785
|
-
# Get a list of the coupons that match the given attributes
|
786
|
-
# Gets a list of all the coupons that exactly match a set of attributes. 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.
|
787
|
-
# @param application_id
|
788
|
-
# @param campaign_id
|
789
|
-
# @param body
|
790
|
-
# @param [Hash] opts the optional parameters
|
791
|
-
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
792
|
-
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
793
|
-
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
794
|
-
# @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.
|
795
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
796
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
797
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
|
798
|
-
# @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`.
|
799
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
800
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
801
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
802
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
803
|
-
# @return [InlineResponse2004]
|
804
|
-
describe 'get_coupons_by_attributes test' do
|
805
|
-
it 'should work' do
|
806
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
807
|
-
end
|
808
|
-
end
|
809
|
-
|
810
|
-
# unit tests for get_coupons_by_attributes_application_wide
|
811
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
812
|
-
# Gets a list of all the coupons with attributes matching the query criteria Application wide
|
813
|
-
# @param application_id
|
814
|
-
# @param body
|
861
|
+
# unit tests for get_collection
|
862
|
+
# Get collection
|
863
|
+
# Retrieve the given collection.
|
864
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
865
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
866
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
815
867
|
# @param [Hash] opts the optional parameters
|
816
|
-
# @
|
817
|
-
|
818
|
-
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
819
|
-
# @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.
|
820
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
821
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
822
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches coupons in which the expiry date is set and in the past. The second matches coupons in which start date is null or in the past and expiry date is null or in the future, the third matches coupons in which start date is set and in the future.
|
823
|
-
# @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`.
|
824
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
825
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
826
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
827
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
828
|
-
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
829
|
-
# @return [InlineResponse2004]
|
830
|
-
describe 'get_coupons_by_attributes_application_wide test' do
|
868
|
+
# @return [Collection]
|
869
|
+
describe 'get_collection test' do
|
831
870
|
it 'should work' do
|
832
871
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
833
872
|
end
|
834
873
|
end
|
835
874
|
|
836
875
|
# unit tests for get_coupons_without_total_count
|
837
|
-
# List
|
838
|
-
#
|
839
|
-
# @param
|
876
|
+
# List coupons
|
877
|
+
# List all the coupons matching the specified criteria.
|
878
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
879
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
840
880
|
# @param [Hash] opts the optional parameters
|
841
881
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
842
882
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -858,12 +898,12 @@ describe 'ManagementApi' do
|
|
858
898
|
end
|
859
899
|
|
860
900
|
# unit tests for get_customer_activity_report
|
861
|
-
# Get
|
862
|
-
# Fetch summary report
|
901
|
+
# Get customer's activity report
|
902
|
+
# Fetch the summary report of a given customer in the given application, in a time range.
|
863
903
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
864
904
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
865
|
-
# @param application_id
|
866
|
-
# @param customer_id
|
905
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
906
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint.
|
867
907
|
# @param [Hash] opts the optional parameters
|
868
908
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
869
909
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -874,42 +914,21 @@ describe 'ManagementApi' do
|
|
874
914
|
end
|
875
915
|
end
|
876
916
|
|
877
|
-
# unit tests for get_customer_activity_reports
|
878
|
-
# Get Activity Reports for Application Customers (with total count)
|
879
|
-
# Fetch summary reports for all application customers based on a time range
|
880
|
-
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
881
|
-
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
882
|
-
# @param application_id
|
883
|
-
# @param [Hash] opts the optional parameters
|
884
|
-
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
885
|
-
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
886
|
-
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
887
|
-
# @option opts [String] :name Only return reports matching the customer name
|
888
|
-
# @option opts [String] :integration_id Only return reports matching the integrationId
|
889
|
-
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
890
|
-
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
891
|
-
# @return [InlineResponse20013]
|
892
|
-
describe 'get_customer_activity_reports test' do
|
893
|
-
it 'should work' do
|
894
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
895
|
-
end
|
896
|
-
end
|
897
|
-
|
898
917
|
# unit tests for get_customer_activity_reports_without_total_count
|
899
918
|
# Get Activity Reports for Application Customers
|
900
919
|
# 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 if there are more results.
|
901
920
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
902
921
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
903
|
-
# @param application_id
|
922
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
904
923
|
# @param [Hash] opts the optional parameters
|
905
924
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
906
925
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
907
926
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
908
927
|
# @option opts [String] :name Only return reports matching the customer name
|
909
|
-
# @option opts [String] :integration_id
|
928
|
+
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
910
929
|
# @option opts [String] :campaign_name Only return reports matching the campaignName
|
911
930
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name
|
912
|
-
# @return [
|
931
|
+
# @return [InlineResponse20016]
|
913
932
|
describe 'get_customer_activity_reports_without_total_count test' do
|
914
933
|
it 'should work' do
|
915
934
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -917,10 +936,10 @@ describe 'ManagementApi' do
|
|
917
936
|
end
|
918
937
|
|
919
938
|
# unit tests for get_customer_analytics
|
920
|
-
# Get
|
921
|
-
# Fetch analytics for
|
922
|
-
# @param application_id
|
923
|
-
# @param customer_id
|
939
|
+
# Get customer's analytics report
|
940
|
+
# Fetch analytics for a given customer in the given application.
|
941
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
942
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint.
|
924
943
|
# @param [Hash] opts the optional parameters
|
925
944
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
926
945
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -933,10 +952,11 @@ describe 'ManagementApi' do
|
|
933
952
|
end
|
934
953
|
|
935
954
|
# unit tests for get_customer_profile
|
936
|
-
# Get
|
937
|
-
#
|
955
|
+
# Get customer profile
|
956
|
+
# Return the details of the specified customer profile. **Performance tip:** You can retrieve the same information via the Integration API, which can save you extra API requests. Consider these options: - Request the customer profile to be part of the response content using [Update Customer Session](/integration-api/operation#updateCustomerSessionV2). - Send an empty update with the [Update Customer Profile](/integration-api/#operation/updateCustomerProfileV2) endpoint with `runRuleEngine=false`.
|
957
|
+
# @param customer_id The value of the `id` property of a customer profile. Get it with the [List application's customers](#operation/getApplicationCustomers) endpoint.
|
938
958
|
# @param [Hash] opts the optional parameters
|
939
|
-
# @return [
|
959
|
+
# @return [CustomerProfile]
|
940
960
|
describe 'get_customer_profile test' do
|
941
961
|
it 'should work' do
|
942
962
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -944,11 +964,12 @@ describe 'ManagementApi' do
|
|
944
964
|
end
|
945
965
|
|
946
966
|
# unit tests for get_customer_profiles
|
947
|
-
# List
|
967
|
+
# List customer profiles
|
968
|
+
# List all customer profiles.
|
948
969
|
# @param [Hash] opts the optional parameters
|
949
970
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
950
971
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
951
|
-
# @return [
|
972
|
+
# @return [InlineResponse20015]
|
952
973
|
describe 'get_customer_profiles test' do
|
953
974
|
it 'should work' do
|
954
975
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -956,13 +977,13 @@ describe 'ManagementApi' do
|
|
956
977
|
end
|
957
978
|
|
958
979
|
# unit tests for get_customers_by_attributes
|
959
|
-
#
|
960
|
-
#
|
980
|
+
# List customer profiles matching the given attributes
|
981
|
+
# 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.
|
961
982
|
# @param body
|
962
983
|
# @param [Hash] opts the optional parameters
|
963
984
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
964
985
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
965
|
-
# @return [
|
986
|
+
# @return [InlineResponse20015]
|
966
987
|
describe 'get_customers_by_attributes test' do
|
967
988
|
it 'should work' do
|
968
989
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -970,16 +991,15 @@ describe 'ManagementApi' do
|
|
970
991
|
end
|
971
992
|
|
972
993
|
# unit tests for get_event_types
|
973
|
-
# List
|
974
|
-
# Fetch all event type definitions for your account.
|
994
|
+
# List event types
|
995
|
+
# Fetch all event type definitions for your account.
|
975
996
|
# @param [Hash] opts the optional parameters
|
976
|
-
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
977
997
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
978
998
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
979
999
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
980
1000
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
981
1001
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
982
|
-
# @return [
|
1002
|
+
# @return [InlineResponse20027]
|
983
1003
|
describe 'get_event_types test' do
|
984
1004
|
it 'should work' do
|
985
1005
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -987,15 +1007,15 @@ describe 'ManagementApi' do
|
|
987
1007
|
end
|
988
1008
|
|
989
1009
|
# unit tests for get_exports
|
990
|
-
# Get
|
991
|
-
#
|
1010
|
+
# Get exports
|
1011
|
+
# List all past exports
|
992
1012
|
# @param [Hash] opts the optional parameters
|
993
1013
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
994
1014
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
995
|
-
# @option opts [
|
996
|
-
# @option opts [Integer] :campaign_id
|
1015
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
1016
|
+
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
997
1017
|
# @option opts [String] :entity The name of the entity type that was exported.
|
998
|
-
# @return [
|
1018
|
+
# @return [InlineResponse20030]
|
999
1019
|
describe 'get_exports test' do
|
1000
1020
|
it 'should work' do
|
1001
1021
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1003,10 +1023,10 @@ describe 'ManagementApi' do
|
|
1003
1023
|
end
|
1004
1024
|
|
1005
1025
|
# unit tests for get_loyalty_points
|
1006
|
-
#
|
1007
|
-
# Get the
|
1008
|
-
# @param
|
1009
|
-
# @param integration_id The identifier
|
1026
|
+
# Get the Loyalty Ledger for this integrationID
|
1027
|
+
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](/integration-api/#operation/updateCustomerSessionV2).
|
1028
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
1029
|
+
# @param integration_id The identifier of the profile.
|
1010
1030
|
# @param [Hash] opts the optional parameters
|
1011
1031
|
# @return [LoyaltyLedger]
|
1012
1032
|
describe 'get_loyalty_points test' do
|
@@ -1016,8 +1036,9 @@ describe 'ManagementApi' do
|
|
1016
1036
|
end
|
1017
1037
|
|
1018
1038
|
# unit tests for get_loyalty_program
|
1019
|
-
# Get
|
1020
|
-
#
|
1039
|
+
# Get loyalty program
|
1040
|
+
# Get the specified [loyalty program](https://www.talon.one/glossary/loyalty). 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 profile data](/integration-api/#operation/getCustomerInventory)
|
1041
|
+
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms).
|
1021
1042
|
# @param [Hash] opts the optional parameters
|
1022
1043
|
# @return [LoyaltyProgram]
|
1023
1044
|
describe 'get_loyalty_program test' do
|
@@ -1027,7 +1048,8 @@ describe 'ManagementApi' do
|
|
1027
1048
|
end
|
1028
1049
|
|
1029
1050
|
# unit tests for get_loyalty_programs
|
1030
|
-
# List
|
1051
|
+
# List loyalty programs
|
1052
|
+
# List the loyalty programs of the account.
|
1031
1053
|
# @param [Hash] opts the optional parameters
|
1032
1054
|
# @return [InlineResponse2007]
|
1033
1055
|
describe 'get_loyalty_programs test' do
|
@@ -1038,7 +1060,8 @@ describe 'ManagementApi' do
|
|
1038
1060
|
|
1039
1061
|
# unit tests for get_loyalty_statistics
|
1040
1062
|
# Get loyalty program statistics by loyalty program ID
|
1041
|
-
#
|
1063
|
+
# Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points and expired points.
|
1064
|
+
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms).
|
1042
1065
|
# @param [Hash] opts the optional parameters
|
1043
1066
|
# @return [LoyaltyStatistics]
|
1044
1067
|
describe 'get_loyalty_statistics test' do
|
@@ -1047,31 +1070,11 @@ describe 'ManagementApi' do
|
|
1047
1070
|
end
|
1048
1071
|
end
|
1049
1072
|
|
1050
|
-
# unit tests for get_referrals
|
1051
|
-
# List Referrals (with total count)
|
1052
|
-
# @param application_id
|
1053
|
-
# @param campaign_id
|
1054
|
-
# @param [Hash] opts the optional parameters
|
1055
|
-
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1056
|
-
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1057
|
-
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1058
|
-
# @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.
|
1059
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
1060
|
-
# @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 timezone. Talon.One will convert to UTC internally.
|
1061
|
-
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiry date is set and in the past. The second matches referrals in which start date is null or in the past and expiry date is null or in the future, the third matches referrals in which start date is set and in the future.
|
1062
|
-
# @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`.
|
1063
|
-
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
1064
|
-
# @return [InlineResponse201]
|
1065
|
-
describe 'get_referrals test' do
|
1066
|
-
it 'should work' do
|
1067
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1068
|
-
end
|
1069
|
-
end
|
1070
|
-
|
1071
1073
|
# unit tests for get_referrals_without_total_count
|
1072
|
-
# List
|
1073
|
-
#
|
1074
|
-
# @param
|
1074
|
+
# List referrals
|
1075
|
+
# List all referrals of the specified campaign.
|
1076
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1077
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1075
1078
|
# @param [Hash] opts the optional parameters
|
1076
1079
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1077
1080
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1090,8 +1093,9 @@ describe 'ManagementApi' do
|
|
1090
1093
|
end
|
1091
1094
|
|
1092
1095
|
# unit tests for get_role
|
1093
|
-
# Get
|
1094
|
-
#
|
1096
|
+
# Get role
|
1097
|
+
# Get the details of the specified role. To see all the roles, use [List roles](#operation/getAllRoles).
|
1098
|
+
# @param role_id The Id of role.
|
1095
1099
|
# @param [Hash] opts the optional parameters
|
1096
1100
|
# @return [Role]
|
1097
1101
|
describe 'get_role test' do
|
@@ -1101,9 +1105,10 @@ describe 'ManagementApi' do
|
|
1101
1105
|
end
|
1102
1106
|
|
1103
1107
|
# unit tests for get_ruleset
|
1104
|
-
# Get
|
1105
|
-
#
|
1106
|
-
# @param
|
1108
|
+
# Get ruleset
|
1109
|
+
# Retrieve the specified ruleset.
|
1110
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1111
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1107
1112
|
# @param ruleset_id
|
1108
1113
|
# @param [Hash] opts the optional parameters
|
1109
1114
|
# @return [Ruleset]
|
@@ -1114,9 +1119,10 @@ describe 'ManagementApi' do
|
|
1114
1119
|
end
|
1115
1120
|
|
1116
1121
|
# unit tests for get_rulesets
|
1117
|
-
# List
|
1118
|
-
#
|
1119
|
-
# @param
|
1122
|
+
# List campaign rulesets
|
1123
|
+
# List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. **Important:** The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.
|
1124
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1125
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1120
1126
|
# @param [Hash] opts the optional parameters
|
1121
1127
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1122
1128
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1129,9 +1135,9 @@ describe 'ManagementApi' do
|
|
1129
1135
|
end
|
1130
1136
|
|
1131
1137
|
# unit tests for get_user
|
1132
|
-
# Get
|
1133
|
-
#
|
1134
|
-
# @param user_id
|
1138
|
+
# Get user
|
1139
|
+
# Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.
|
1140
|
+
# @param user_id The ID of the user.
|
1135
1141
|
# @param [Hash] opts the optional parameters
|
1136
1142
|
# @return [User]
|
1137
1143
|
describe 'get_user test' do
|
@@ -1141,13 +1147,13 @@ describe 'ManagementApi' do
|
|
1141
1147
|
end
|
1142
1148
|
|
1143
1149
|
# unit tests for get_users
|
1144
|
-
# List
|
1150
|
+
# List users in account
|
1145
1151
|
# Retrieve all users in your account.
|
1146
1152
|
# @param [Hash] opts the optional parameters
|
1147
1153
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1148
1154
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1149
1155
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1150
|
-
# @return [
|
1156
|
+
# @return [InlineResponse20028]
|
1151
1157
|
describe 'get_users test' do
|
1152
1158
|
it 'should work' do
|
1153
1159
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1155,8 +1161,8 @@ describe 'ManagementApi' do
|
|
1155
1161
|
end
|
1156
1162
|
|
1157
1163
|
# unit tests for get_webhook
|
1158
|
-
# Get
|
1159
|
-
# Returns
|
1164
|
+
# Get webhook
|
1165
|
+
# Returns a webhook by its id.
|
1160
1166
|
# @param webhook_id
|
1161
1167
|
# @param [Hash] opts the optional parameters
|
1162
1168
|
# @return [Webhook]
|
@@ -1167,7 +1173,7 @@ describe 'ManagementApi' do
|
|
1167
1173
|
end
|
1168
1174
|
|
1169
1175
|
# unit tests for get_webhook_activation_logs
|
1170
|
-
# List
|
1176
|
+
# List webhook activation log entries
|
1171
1177
|
# Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
|
1172
1178
|
# @param [Hash] opts the optional parameters
|
1173
1179
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -1175,11 +1181,11 @@ describe 'ManagementApi' do
|
|
1175
1181
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1176
1182
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
1177
1183
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
1178
|
-
# @option opts [Float] :application_id
|
1184
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
1179
1185
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1180
1186
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
1181
|
-
# @option opts [DateTime] :created_after
|
1182
|
-
# @return [
|
1187
|
+
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
1188
|
+
# @return [InlineResponse20025]
|
1183
1189
|
describe 'get_webhook_activation_logs test' do
|
1184
1190
|
it 'should work' do
|
1185
1191
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1187,19 +1193,20 @@ describe 'ManagementApi' do
|
|
1187
1193
|
end
|
1188
1194
|
|
1189
1195
|
# unit tests for get_webhook_logs
|
1190
|
-
# List
|
1196
|
+
# List webhook log entries
|
1197
|
+
# Retrieve all webhook log entries.
|
1191
1198
|
# @param [Hash] opts the optional parameters
|
1192
1199
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1193
1200
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1194
1201
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1195
1202
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1196
1203
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
1197
|
-
# @option opts [Float] :application_id
|
1204
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
1198
1205
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1199
1206
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1200
1207
|
# @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 timezone. Talon.One will convert to UTC internally.
|
1201
1208
|
# @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 timezone. Talon.One will convert to UTC internally.
|
1202
|
-
# @return [
|
1209
|
+
# @return [InlineResponse20026]
|
1203
1210
|
describe 'get_webhook_logs test' do
|
1204
1211
|
it 'should work' do
|
1205
1212
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1207,24 +1214,66 @@ describe 'ManagementApi' do
|
|
1207
1214
|
end
|
1208
1215
|
|
1209
1216
|
# unit tests for get_webhooks
|
1210
|
-
# List
|
1217
|
+
# List webhooks
|
1218
|
+
# List all webhooks.
|
1211
1219
|
# @param [Hash] opts the optional parameters
|
1212
1220
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
1213
1221
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1214
1222
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1215
1223
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1216
|
-
# @return [
|
1224
|
+
# @return [InlineResponse20024]
|
1217
1225
|
describe 'get_webhooks test' do
|
1218
1226
|
it 'should work' do
|
1219
1227
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1220
1228
|
end
|
1221
1229
|
end
|
1222
1230
|
|
1231
|
+
# unit tests for import_account_collection
|
1232
|
+
# Import data in existing account-level collection via CSV file
|
1233
|
+
# 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.
|
1234
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
1235
|
+
# @param [Hash] opts the optional parameters
|
1236
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1237
|
+
# @return [Import]
|
1238
|
+
describe 'import_account_collection test' do
|
1239
|
+
it 'should work' do
|
1240
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1241
|
+
end
|
1242
|
+
end
|
1243
|
+
|
1244
|
+
# unit tests for import_allowed_list
|
1245
|
+
# Import allowed values for attribute
|
1246
|
+
# Upload a CSV file containing a list of allowed values for the specified attribute. These values are also called [picklist values](/docs/product/account/dev-tools/managing-attributes/#picklist-values). 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 ```
|
1247
|
+
# @param attribute_id
|
1248
|
+
# @param [Hash] opts the optional parameters
|
1249
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1250
|
+
# @return [Import]
|
1251
|
+
describe 'import_allowed_list test' do
|
1252
|
+
it 'should work' do
|
1253
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1254
|
+
end
|
1255
|
+
end
|
1256
|
+
|
1257
|
+
# unit tests for import_collection
|
1258
|
+
# Import data in existing collection via CSV file
|
1259
|
+
# 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.
|
1260
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1261
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1262
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
1263
|
+
# @param [Hash] opts the optional parameters
|
1264
|
+
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1265
|
+
# @return [Import]
|
1266
|
+
describe 'import_collection test' do
|
1267
|
+
it 'should work' do
|
1268
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1269
|
+
end
|
1270
|
+
end
|
1271
|
+
|
1223
1272
|
# unit tests for import_coupons
|
1224
1273
|
# Import coupons via CSV file
|
1225
|
-
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data.
|
1226
|
-
# @param application_id
|
1227
|
-
# @param campaign_id
|
1274
|
+
# Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file can contain 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. - `limitval`: The maximum amount of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. - `discountlimit`: The amount of discounts that can be given with this coupon code. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the coupon entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. **Important:** Do not leave empty columns in the file. You can use the timezone of your choice. It is converted to UTC internally by Talon.One. **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](#operation/getReservedCustomers).
|
1275
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1276
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1228
1277
|
# @param [Hash] opts the optional parameters
|
1229
1278
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1230
1279
|
# @return [Import]
|
@@ -1236,8 +1285,8 @@ describe 'ManagementApi' do
|
|
1236
1285
|
|
1237
1286
|
# unit tests for import_loyalty_points
|
1238
1287
|
# Import loyalty points via CSV file
|
1239
|
-
# Upload a CSV file containing the loyalty points that should be created. The file should be sent as multipart data.
|
1240
|
-
# @param
|
1288
|
+
# Upload a CSV file containing the [loyalty](https://www.talon.one/pillar-pages/loyalty) points that should be created. The file should be sent as multipart data. **Important**: For existing customer profiles, the imported points are _added_ to their active points. Learn more about [Loyalty programs](https://docs.talon.one/docs/product/loyalty-programs/overview). The CSV file can contain the following columns: - `customerprofileid`: The integration ID of the customer profile that should receive the loyalty points. - `amount`: The amount of points to award to the customer profile. - `startdate`: The earliest date when the points can be redeemed. On this date and until the expiry date, the points are `active`. - `expirydate`: The latest date when the points can be redeemed. After this date, the points are `expired`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): A reason why these points were awarded. **Important:** Do not leave empty columns in the file. You can use the timezone of your choice. It is converted to UTC internally by Talon.One. **Example:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
1289
|
+
# @param loyalty_program_id Identifier of the loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs endpoint](https://docs.talon.one/management-api/#operation/getLoyaltyPrograms).
|
1241
1290
|
# @param [Hash] opts the optional parameters
|
1242
1291
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1243
1292
|
# @return [Import]
|
@@ -1248,8 +1297,8 @@ describe 'ManagementApi' do
|
|
1248
1297
|
end
|
1249
1298
|
|
1250
1299
|
# unit tests for import_pool_giveaways
|
1251
|
-
# Import
|
1252
|
-
# Upload a CSV file containing the
|
1300
|
+
# Import giveaway codes into a giveaway pool
|
1301
|
+
# Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file can contain 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. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `provider` associated to the giveaway entity, set it with `\"{\"\"provider\"\": \"\"myPartnerCompany\"\"}\"`. **Important:** Do not leave empty columns in the file. 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 timezone of your choice. It is converted to UTC internally by Talon.One. **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\"\"}\" ```
|
1253
1302
|
# @param pool_id
|
1254
1303
|
# @param [Hash] opts the optional parameters
|
1255
1304
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
@@ -1262,9 +1311,9 @@ describe 'ManagementApi' do
|
|
1262
1311
|
|
1263
1312
|
# unit tests for import_referrals
|
1264
1313
|
# Import referrals via CSV file
|
1265
|
-
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file can contain the following
|
1266
|
-
# @param application_id
|
1267
|
-
# @param campaign_id
|
1314
|
+
# Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file can contain 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 amount of redemptions of this code. Defaults to `1` when left blank. - `attributes`: A json object describing _custom_ referral attribute names and their values. Double the double-quotes in the object. For example, if you [created a custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated to the referral entity, set it with `\"{\"\"category\"\": \"\"10_off\"\"}\"`. You can use the timezone of your choice. It is converted to UTC internally by Talon.One. **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\"\"}\" ```
|
1315
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1316
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1268
1317
|
# @param [Hash] opts the optional parameters
|
1269
1318
|
# @option opts [String] :up_file The file with the information about the data that should be imported.
|
1270
1319
|
# @return [Import]
|
@@ -1274,87 +1323,87 @@ describe 'ManagementApi' do
|
|
1274
1323
|
end
|
1275
1324
|
end
|
1276
1325
|
|
1277
|
-
# unit tests for
|
1278
|
-
#
|
1279
|
-
#
|
1280
|
-
# @param integration_id
|
1281
|
-
# @param body
|
1326
|
+
# unit tests for list_account_collections
|
1327
|
+
# List collections in account
|
1328
|
+
# List collections in account.
|
1282
1329
|
# @param [Hash] opts the optional parameters
|
1283
|
-
# @
|
1284
|
-
|
1330
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1331
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1332
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1333
|
+
# @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.
|
1334
|
+
# @option opts [String] :name Filter by the name of the Collection.
|
1335
|
+
# @return [InlineResponse2008]
|
1336
|
+
describe 'list_account_collections test' do
|
1285
1337
|
it 'should work' do
|
1286
1338
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1287
1339
|
end
|
1288
1340
|
end
|
1289
1341
|
|
1290
|
-
# unit tests for
|
1291
|
-
#
|
1292
|
-
#
|
1293
|
-
# @param
|
1342
|
+
# unit tests for list_collections
|
1343
|
+
# List collections
|
1344
|
+
# List collections in the campaign.
|
1345
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1346
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1294
1347
|
# @param [Hash] opts the optional parameters
|
1295
|
-
# @
|
1296
|
-
|
1348
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1349
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1350
|
+
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1351
|
+
# @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.
|
1352
|
+
# @option opts [String] :name Filter by the name of the Collection.
|
1353
|
+
# @return [InlineResponse2009]
|
1354
|
+
describe 'list_collections test' do
|
1297
1355
|
it 'should work' do
|
1298
1356
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1299
1357
|
end
|
1300
1358
|
end
|
1301
1359
|
|
1302
|
-
# unit tests for
|
1303
|
-
#
|
1304
|
-
#
|
1305
|
-
# @param application_id
|
1306
|
-
# @param campaign_id
|
1307
|
-
# @param body
|
1360
|
+
# unit tests for list_collections_in_application
|
1361
|
+
# List collections in application
|
1362
|
+
# List collections from all campaigns in the Application.
|
1363
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1308
1364
|
# @param [Hash] opts the optional parameters
|
1309
1365
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1310
1366
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1311
1367
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
1312
|
-
# @option opts [
|
1313
|
-
# @option opts [
|
1314
|
-
# @
|
1315
|
-
|
1316
|
-
# @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`.
|
1317
|
-
# @option opts [Integer] :referral_id Filter the results by matching them with the Id of a referral, that meaning the coupons that had been created as an effect of the usage of a referral code.
|
1318
|
-
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1319
|
-
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1320
|
-
# @option opts [String] :batch_id Filter results by batches of coupons
|
1321
|
-
# @return [InlineResponse2004]
|
1322
|
-
describe 'search_coupons_advanced test' do
|
1368
|
+
# @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.
|
1369
|
+
# @option opts [String] :name Filter by the name of the Collection.
|
1370
|
+
# @return [InlineResponse2009]
|
1371
|
+
describe 'list_collections_in_application test' do
|
1323
1372
|
it 'should work' do
|
1324
1373
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1325
1374
|
end
|
1326
1375
|
end
|
1327
1376
|
|
1328
|
-
# unit tests for
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
# @param
|
1377
|
+
# unit tests for remove_loyalty_points
|
1378
|
+
# Deduct points in loyalty program for given customer
|
1379
|
+
# Remove 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](/integration-api/#operation/updateCustomerSessionV2).
|
1380
|
+
# @param loyalty_program_id The identifier for the loyalty program.
|
1381
|
+
# @param integration_id The identifier of the profile.
|
1332
1382
|
# @param body
|
1333
1383
|
# @param [Hash] opts the optional parameters
|
1334
|
-
# @
|
1335
|
-
|
1336
|
-
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
#
|
1344
|
-
# @
|
1345
|
-
# @
|
1346
|
-
# @
|
1347
|
-
|
1348
|
-
describe 'search_coupons_advanced_application_wide test' do
|
1384
|
+
# @return [nil]
|
1385
|
+
describe 'remove_loyalty_points test' do
|
1386
|
+
it 'should work' do
|
1387
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1388
|
+
end
|
1389
|
+
end
|
1390
|
+
|
1391
|
+
# unit tests for reset_password
|
1392
|
+
# Reset password
|
1393
|
+
# Consumes the supplied password reset token and updates the password for the associated account.
|
1394
|
+
# @param body
|
1395
|
+
# @param [Hash] opts the optional parameters
|
1396
|
+
# @return [NewPassword]
|
1397
|
+
describe 'reset_password test' do
|
1349
1398
|
it 'should work' do
|
1350
1399
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1351
1400
|
end
|
1352
1401
|
end
|
1353
1402
|
|
1354
1403
|
# unit tests for search_coupons_advanced_application_wide_without_total_count
|
1355
|
-
#
|
1356
|
-
#
|
1357
|
-
# @param application_id
|
1404
|
+
# List coupons that match the given attributes (without total count)
|
1405
|
+
# List the coupons whose attributes match the query criteria in all **active** 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.
|
1406
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1358
1407
|
# @param body
|
1359
1408
|
# @param [Hash] opts the optional parameters
|
1360
1409
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -1369,7 +1418,7 @@ describe 'ManagementApi' do
|
|
1369
1418
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1370
1419
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1371
1420
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1372
|
-
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1421
|
+
# @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.
|
1373
1422
|
# @return [InlineResponse2005]
|
1374
1423
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
1375
1424
|
it 'should work' do
|
@@ -1378,10 +1427,10 @@ describe 'ManagementApi' do
|
|
1378
1427
|
end
|
1379
1428
|
|
1380
1429
|
# unit tests for search_coupons_advanced_without_total_count
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
# @param application_id
|
1384
|
-
# @param campaign_id
|
1430
|
+
# List coupons that match the given attributes in campaign (without total count)
|
1431
|
+
# List the coupons whose attributes match the query criteria in the given campaign. 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.
|
1432
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1433
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1385
1434
|
# @param body
|
1386
1435
|
# @param [Hash] opts the optional parameters
|
1387
1436
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -1403,8 +1452,21 @@ describe 'ManagementApi' do
|
|
1403
1452
|
end
|
1404
1453
|
end
|
1405
1454
|
|
1455
|
+
# unit tests for update_account_collection
|
1456
|
+
# Update account-level collection description and connected Applications
|
1457
|
+
# Edit the description of the account-level collection and enable or disable the collection in different Applications.
|
1458
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
1459
|
+
# @param body
|
1460
|
+
# @param [Hash] opts the optional parameters
|
1461
|
+
# @return [Collection]
|
1462
|
+
describe 'update_account_collection test' do
|
1463
|
+
it 'should work' do
|
1464
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1465
|
+
end
|
1466
|
+
end
|
1467
|
+
|
1406
1468
|
# unit tests for update_additional_cost
|
1407
|
-
# Update
|
1469
|
+
# Update additional cost
|
1408
1470
|
# Updates an existing additional cost. Once created, the only property of an additional cost that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations.
|
1409
1471
|
# @param additional_cost_id
|
1410
1472
|
# @param body
|
@@ -1417,7 +1479,7 @@ describe 'ManagementApi' do
|
|
1417
1479
|
end
|
1418
1480
|
|
1419
1481
|
# unit tests for update_attribute
|
1420
|
-
# Update
|
1482
|
+
# Update custom attribute
|
1421
1483
|
# Updates an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the title (human readable description). This restriction is in place to prevent accidentally breaking live integrations. E.g. if you have a customer profile attribute with the name `region`, and your integration is sending `attributes.region` with customer profile updates, changing the name to `locale` would cause the integration requests to begin failing. If you **really** need to change the `type` or `name` property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute. Then delete the old attribute when you are confident you have migrated any needed data from the old attribute to the new one.
|
1422
1484
|
# @param attribute_id
|
1423
1485
|
# @param body
|
@@ -1430,9 +1492,10 @@ describe 'ManagementApi' do
|
|
1430
1492
|
end
|
1431
1493
|
|
1432
1494
|
# unit tests for update_campaign
|
1433
|
-
# Update
|
1434
|
-
#
|
1435
|
-
# @param
|
1495
|
+
# Update campaign
|
1496
|
+
# Update the given campaign.
|
1497
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1498
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1436
1499
|
# @param body
|
1437
1500
|
# @param [Hash] opts the optional parameters
|
1438
1501
|
# @return [Campaign]
|
@@ -1442,10 +1505,26 @@ describe 'ManagementApi' do
|
|
1442
1505
|
end
|
1443
1506
|
end
|
1444
1507
|
|
1508
|
+
# unit tests for update_collection
|
1509
|
+
# Update collection description
|
1510
|
+
# Edit the description of the collection.
|
1511
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1512
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1513
|
+
# @param collection_id The ID of the collection. You can get it with the [List collection in account endpoint](#operation/listCollectionsInApplication).
|
1514
|
+
# @param body
|
1515
|
+
# @param [Hash] opts the optional parameters
|
1516
|
+
# @return [Collection]
|
1517
|
+
describe 'update_collection test' do
|
1518
|
+
it 'should work' do
|
1519
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1520
|
+
end
|
1521
|
+
end
|
1522
|
+
|
1445
1523
|
# unit tests for update_coupon
|
1446
|
-
# Update
|
1447
|
-
#
|
1448
|
-
# @param
|
1524
|
+
# Update coupon
|
1525
|
+
# Update the specified coupon.
|
1526
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1527
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1449
1528
|
# @param coupon_id The ID of the coupon code to update
|
1450
1529
|
# @param body
|
1451
1530
|
# @param [Hash] opts the optional parameters
|
@@ -1457,9 +1536,10 @@ describe 'ManagementApi' do
|
|
1457
1536
|
end
|
1458
1537
|
|
1459
1538
|
# unit tests for update_coupon_batch
|
1460
|
-
# Update
|
1461
|
-
#
|
1462
|
-
# @param
|
1539
|
+
# Update coupons
|
1540
|
+
# Update all coupons of an campaign, or a specific batch of coupons. You can find the `batchId` in the **Coupons** view of your Application in the Campaign Manager or by using [List coupons](#operation/getCouponsWithoutTotalCount). **Important**: - Only send sequential requests to this endpoint. - Requests to this endpoint timeout after 30 minutes. If you hit a timeout, reach out to our support team. To update a specific coupon, use [Update coupon](#operation/updateCoupon).
|
1541
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1542
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1463
1543
|
# @param body
|
1464
1544
|
# @param [Hash] opts the optional parameters
|
1465
1545
|
# @return [nil]
|
@@ -1470,9 +1550,10 @@ describe 'ManagementApi' do
|
|
1470
1550
|
end
|
1471
1551
|
|
1472
1552
|
# unit tests for update_referral
|
1473
|
-
# Update
|
1474
|
-
#
|
1475
|
-
# @param
|
1553
|
+
# Update referral
|
1554
|
+
# Update the specified referral.
|
1555
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1556
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1476
1557
|
# @param referral_id The ID of the referral code to delete
|
1477
1558
|
# @param body
|
1478
1559
|
# @param [Hash] opts the optional parameters
|
@@ -1483,18 +1564,4 @@ describe 'ManagementApi' do
|
|
1483
1564
|
end
|
1484
1565
|
end
|
1485
1566
|
|
1486
|
-
# unit tests for update_ruleset
|
1487
|
-
# Update a Ruleset
|
1488
|
-
# @param application_id
|
1489
|
-
# @param campaign_id
|
1490
|
-
# @param ruleset_id
|
1491
|
-
# @param body
|
1492
|
-
# @param [Hash] opts the optional parameters
|
1493
|
-
# @return [Ruleset]
|
1494
|
-
describe 'update_ruleset test' do
|
1495
|
-
it 'should work' do
|
1496
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1497
|
-
end
|
1498
|
-
end
|
1499
|
-
|
1500
1567
|
end
|