talon_one 1.4.0 → 2.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +204 -36
- data/Rakefile +2 -0
- data/docs/APIError.md +11 -0
- data/docs/AcceptCouponEffectProps.md +17 -0
- data/docs/AcceptReferralEffectProps.md +17 -0
- data/docs/AccessLogEntry.md +15 -0
- data/docs/Account.md +28 -2
- data/docs/AccountAdditionalCost.md +29 -0
- data/docs/AccountAnalytics.md +44 -15
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -12
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +31 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +34 -2
- data/docs/ApplicationAPIKey.md +19 -2
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +21 -2
- data/docs/ApplicationCustomerEntity.md +9 -0
- data/docs/ApplicationCustomerSearch.md +12 -1
- data/docs/ApplicationEntity.md +9 -0
- data/docs/ApplicationEvent.md +19 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +10 -0
- data/docs/AttributesSettings.md +9 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +17 -1
- data/docs/Binding.md +12 -0
- data/docs/Campaign.md +47 -2
- data/docs/CampaignAnalytics.md +37 -0
- data/docs/CampaignCopy.md +15 -1
- data/docs/CampaignEntity.md +9 -0
- data/docs/CampaignGroup.md +31 -0
- data/docs/CampaignGroupEntity.md +17 -0
- data/docs/CampaignSearch.md +10 -1
- data/docs/CampaignSet.md +14 -0
- data/docs/CampaignSetBranchNode.md +12 -0
- data/docs/CampaignSetLeafNode.md +10 -0
- data/docs/CampaignSetNode.md +9 -0
- data/docs/CartItem.md +20 -2
- data/docs/Change.md +18 -2
- data/docs/ChangeProfilePassword.md +19 -0
- data/docs/CodeGeneratorSettings.md +10 -0
- data/docs/Coupon.md +31 -3
- data/docs/CouponConstraints.md +13 -0
- data/docs/CouponCreatedEffectProps.md +19 -0
- data/docs/CouponRejectionReason.md +11 -0
- data/docs/CouponReservations.md +9 -0
- data/docs/CouponSearch.md +10 -1
- data/docs/CouponValue.md +9 -0
- data/docs/CreateApplicationAPIKey.md +12 -0
- data/docs/CustomerActivityReport.md +22 -1
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +14 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +21 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +25 -0
- data/docs/Effect.md +29 -0
- data/docs/EffectEntity.md +27 -0
- data/docs/EmailEntity.md +9 -0
- data/docs/Entity.md +10 -0
- data/docs/EntityWithTalangVisibleID.md +19 -0
- data/docs/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +12 -0
- data/docs/Event.md +19 -1
- data/docs/EventType.md +21 -1
- data/docs/Export.md +15 -1
- data/docs/FeatureFlag.md +12 -0
- data/docs/FeatureFlags.md +15 -3
- data/docs/FeaturesFeed.md +10 -0
- data/docs/FeedNotification.md +27 -0
- data/docs/FuncArgDef.md +10 -0
- data/docs/FunctionDef.md +13 -0
- data/docs/Import.md +15 -1
- data/docs/InlineResponse200.md +10 -0
- data/docs/InlineResponse2001.md +11 -1
- data/docs/InlineResponse20010.md +11 -1
- data/docs/InlineResponse20011.md +10 -0
- data/docs/InlineResponse20012.md +13 -1
- data/docs/InlineResponse20013.md +11 -1
- data/docs/InlineResponse20014.md +10 -0
- data/docs/InlineResponse20015.md +11 -1
- data/docs/InlineResponse20016.md +11 -1
- data/docs/InlineResponse20017.md +10 -0
- data/docs/InlineResponse20018.md +11 -1
- data/docs/InlineResponse20019.md +10 -0
- data/docs/InlineResponse2002.md +11 -1
- data/docs/InlineResponse20020.md +12 -2
- data/docs/InlineResponse20021.md +11 -1
- data/docs/InlineResponse20022.md +11 -1
- data/docs/InlineResponse20023.md +11 -1
- data/docs/InlineResponse20024.md +11 -1
- data/docs/InlineResponse20025.md +11 -1
- data/docs/InlineResponse20026.md +12 -3
- data/docs/InlineResponse20027.md +11 -1
- data/docs/InlineResponse20028.md +14 -2
- data/docs/InlineResponse20029.md +11 -1
- data/docs/InlineResponse2003.md +11 -1
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse2004.md +11 -1
- data/docs/InlineResponse2005.md +11 -1
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +11 -1
- data/docs/InlineResponse2008.md +10 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/IntegrationApi.md +302 -113
- data/docs/IntegrationEntity.md +11 -1
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +13 -0
- data/docs/IntegrationStateV2.md +37 -0
- data/docs/LedgerEntry.md +18 -0
- data/docs/LibraryAttribute.md +15 -0
- data/docs/LimitConfig.md +11 -0
- data/docs/LoginParams.md +10 -0
- data/docs/Loyalty.md +9 -0
- data/docs/LoyaltyLedger.md +11 -1
- data/docs/LoyaltyLedgerEntry.md +23 -1
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +15 -1
- data/docs/LoyaltyProgram.md +20 -2
- data/docs/LoyaltyProgramBalance.md +18 -1
- data/docs/LoyaltyProgramLedgers.md +16 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +1419 -952
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +16 -3
- data/docs/MultiApplicationEntity.md +9 -0
- data/docs/MultipleCustomerProfileIntegrationRequest.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +19 -0
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +17 -0
- data/docs/MutableEntity.md +9 -0
- data/docs/NewAccount.md +9 -0
- data/docs/NewAccountSignUp.md +11 -0
- data/docs/NewAdditionalCost.md +23 -0
- data/docs/NewApplication.md +30 -1
- data/docs/NewApplicationAPIKey.md +20 -2
- data/docs/NewAttribute.md +20 -2
- data/docs/NewAudience.md +21 -0
- data/docs/NewCampaign.md +23 -1
- data/docs/NewCampaignGroup.md +23 -0
- data/docs/NewCampaignSet.md +12 -0
- data/docs/NewCoupons.md +22 -3
- data/docs/NewCouponsForMultipleRecipients.md +31 -0
- data/docs/NewCustomerProfile.md +10 -1
- data/docs/NewCustomerSession.md +17 -1
- data/docs/NewCustomerSessionV2.md +31 -0
- data/docs/NewEvent.md +13 -1
- data/docs/NewEventType.md +19 -1
- data/docs/NewFeatureFlags.md +14 -3
- data/docs/NewInvitation.md +12 -0
- data/docs/NewInviteEmail.md +10 -0
- data/docs/NewLoyaltyProgram.md +18 -2
- data/docs/NewPassword.md +10 -0
- data/docs/NewPasswordEmail.md +9 -0
- data/docs/NewReferral.md +13 -0
- data/docs/NewRole.md +12 -0
- data/docs/NewRuleset.md +13 -1
- data/docs/NewSamlConnection.md +18 -1
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +11 -0
- data/docs/ProfileAudiencesChanges.md +19 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +11 -0
- data/docs/RejectCouponEffectProps.md +25 -0
- data/docs/RejectReferralEffectProps.md +25 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackAddedLoyaltyPointsEffectProps.md +25 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDeductedLoyaltyPointsEffectProps.md +29 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/RollbackReferralEffectProps.md +17 -0
- data/docs/Rule.md +13 -0
- data/docs/RuleFailureReason.md +39 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +20 -1
- data/docs/SamlConnectionMetadata.md +13 -1
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +21 -0
- data/docs/SetDiscountPerItemEffectProps.md +23 -0
- data/docs/ShowBundleMetadataEffectProps.md +21 -0
- data/docs/ShowNotificationEffectProps.md +21 -0
- data/docs/SlotDef.md +15 -1
- data/docs/TemplateArgDef.md +13 -1
- data/docs/TemplateDef.md +20 -1
- data/docs/TriggerWebhookEffectProps.md +19 -0
- data/docs/UpdateAccount.md +16 -1
- data/docs/UpdateApplication.md +29 -1
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateAudience.md +17 -0
- data/docs/UpdateCampaign.md +23 -1
- data/docs/UpdateCampaignGroup.md +23 -0
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +17 -2
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +14 -6
- data/docs/UpdateUserLatestFeedTimestamp.md +17 -0
- data/docs/User.md +25 -5
- data/docs/UserEntity.md +9 -0
- data/docs/UserFeedNotifications.md +19 -0
- data/docs/Webhook.md +20 -1
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +89 -39
- data/lib/talon_one/api/integration_api.rb +509 -189
- data/lib/talon_one/api/management_api.rb +2930 -1563
- data/lib/talon_one/api_client.rb +45 -46
- data/lib/talon_one/api_error.rb +22 -3
- data/lib/talon_one/configuration.rb +48 -9
- data/lib/talon_one/models/accept_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/accept_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/access_log_entry.rb +47 -24
- data/lib/talon_one/models/account.rb +72 -49
- data/lib/talon_one/models/account_additional_cost.rb +300 -0
- data/lib/talon_one/models/account_analytics.rb +153 -85
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -55
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +308 -0
- data/lib/talon_one/models/additional_cost.rb +211 -0
- data/lib/talon_one/models/api_error.rb +40 -17
- data/lib/talon_one/models/application.rb +144 -77
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +121 -53
- data/lib/talon_one/models/application_customer.rb +66 -31
- data/lib/talon_one/models/application_customer_entity.rb +39 -16
- data/lib/talon_one/models/application_customer_search.rb +42 -19
- data/lib/talon_one/models/application_entity.rb +39 -16
- data/lib/talon_one/models/application_event.rb +64 -29
- data/lib/talon_one/models/application_session.rb +73 -35
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +73 -38
- data/lib/talon_one/models/attributes_mandatory.rb +39 -16
- data/lib/talon_one/models/attributes_settings.rb +38 -15
- data/lib/talon_one/models/audience.rb +360 -0
- data/lib/talon_one/models/audience_membership.rb +227 -0
- data/lib/talon_one/models/base_saml_connection.rb +51 -28
- data/lib/talon_one/models/binding.rb +50 -17
- data/lib/talon_one/models/campaign.rb +144 -59
- data/lib/talon_one/models/campaign_analytics.rb +142 -59
- data/lib/talon_one/models/campaign_copy.rb +47 -24
- data/lib/talon_one/models/campaign_entity.rb +39 -16
- data/lib/talon_one/models/campaign_group.rb +326 -0
- data/lib/talon_one/models/campaign_group_entity.rb +209 -0
- data/lib/talon_one/models/campaign_search.rb +38 -15
- data/lib/talon_one/models/campaign_set.rb +77 -20
- data/lib/talon_one/models/campaign_set_branch_node.rb +47 -24
- data/lib/talon_one/models/campaign_set_leaf_node.rb +43 -20
- data/lib/talon_one/models/campaign_set_node.rb +38 -15
- data/lib/talon_one/models/cart_item.rb +52 -38
- data/lib/talon_one/models/change.rb +55 -22
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +50 -18
- data/lib/talon_one/models/coupon.rb +117 -40
- data/lib/talon_one/models/coupon_constraints.rb +78 -21
- data/lib/talon_one/models/coupon_created_effect_props.rb +228 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +45 -22
- data/lib/talon_one/models/coupon_reservations.rb +39 -16
- data/lib/talon_one/models/coupon_search.rb +38 -15
- data/lib/talon_one/models/coupon_value.rb +38 -15
- data/lib/talon_one/models/create_application_api_key.rb +87 -20
- data/lib/talon_one/models/customer_activity_report.rb +62 -39
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +63 -20
- data/lib/talon_one/models/customer_profile.rb +65 -30
- data/lib/talon_one/models/customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +273 -0
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +251 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +98 -37
- data/lib/talon_one/models/customer_session_v2.rb +462 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +273 -0
- data/lib/talon_one/models/effect.rb +297 -0
- data/lib/talon_one/models/effect_entity.rb +283 -0
- data/lib/talon_one/models/email_entity.rb +38 -15
- data/lib/talon_one/models/entity.rb +39 -16
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +227 -0
- data/lib/talon_one/models/environment.rb +45 -22
- data/lib/talon_one/models/error_effect_props.rb +213 -0
- data/lib/talon_one/models/error_response.rb +39 -16
- data/lib/talon_one/models/error_source.rb +41 -18
- data/lib/talon_one/models/event.rb +51 -28
- data/lib/talon_one/models/event_type.rb +59 -36
- data/lib/talon_one/models/export.rb +48 -25
- data/lib/talon_one/models/feature_flag.rb +41 -18
- data/lib/talon_one/models/feature_flags.rb +46 -23
- data/lib/talon_one/models/features_feed.rb +40 -17
- data/lib/talon_one/models/feed_notification.rb +322 -0
- data/lib/talon_one/models/func_arg_def.rb +42 -19
- data/lib/talon_one/models/function_def.rb +42 -19
- data/lib/talon_one/models/import.rb +46 -57
- data/lib/talon_one/models/{inline_response_200.rb → inline_response200.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_2.rb → inline_response2001.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_10.rb → inline_response20010.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_11.rb → inline_response20011.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_12.rb → inline_response20012.rb} +50 -23
- data/lib/talon_one/models/{inline_response_200_13.rb → inline_response20013.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_14.rb → inline_response20014.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_15.rb → inline_response20015.rb} +41 -18
- data/lib/talon_one/models/inline_response20016.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_17.rb → inline_response20017.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_18.rb → inline_response20018.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_19.rb → inline_response20019.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_3.rb → inline_response2002.rb} +41 -18
- data/lib/talon_one/models/inline_response20020.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20021.rb} +41 -18
- data/lib/talon_one/models/inline_response20022.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_21.rb → inline_response20023.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_22.rb → inline_response20024.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_23.rb → inline_response20025.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_24.rb → inline_response20026.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_25.rb → inline_response20027.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +44 -21
- data/lib/talon_one/models/{inline_response_200_27.rb → inline_response20029.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_4.rb → inline_response2003.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_29.rb → inline_response20030.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_1.rb → inline_response2004.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_5.rb → inline_response2005.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_6.rb → inline_response2006.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_7.rb → inline_response2007.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_8.rb → inline_response2008.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_9.rb → inline_response2009.rb} +40 -17
- data/lib/talon_one/models/integration_entity.rb +41 -18
- data/lib/talon_one/models/integration_event.rb +41 -18
- data/lib/talon_one/models/integration_profile_entity.rb +39 -16
- data/lib/talon_one/models/integration_request.rb +246 -0
- data/lib/talon_one/models/integration_state.rb +42 -19
- data/lib/talon_one/models/integration_state_v2.rb +324 -0
- data/lib/talon_one/models/ledger_entry.rb +53 -30
- data/lib/talon_one/models/library_attribute.rb +50 -27
- data/lib/talon_one/models/limit_config.rb +40 -29
- data/lib/talon_one/models/login_params.rb +39 -16
- data/lib/talon_one/models/loyalty.rb +38 -15
- data/lib/talon_one/models/loyalty_ledger.rb +40 -18
- data/lib/talon_one/models/loyalty_ledger_entry.rb +76 -67
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +87 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +104 -20
- data/lib/talon_one/models/loyalty_program_ledgers.rb +59 -22
- data/lib/talon_one/models/loyalty_statistics.rb +258 -0
- data/lib/talon_one/models/loyalty_sub_ledger.rb +144 -24
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +45 -21
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- data/lib/talon_one/models/{new_import.rb → multiple_customer_profile_integration_request.rb} +47 -63
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +223 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +38 -15
- data/lib/talon_one/models/new_account.rb +39 -16
- data/lib/talon_one/models/new_account_sign_up.rb +41 -18
- data/lib/talon_one/models/new_additional_cost.rb +255 -0
- data/lib/talon_one/models/new_application.rb +153 -50
- data/lib/talon_one/models/new_application_api_key.rb +119 -52
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_audience.rb +314 -0
- data/lib/talon_one/models/new_campaign.rb +73 -38
- data/lib/talon_one/models/new_campaign_group.rb +265 -0
- data/lib/talon_one/models/new_campaign_set.rb +75 -18
- data/lib/talon_one/models/new_coupons.rb +116 -64
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +368 -0
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +80 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +337 -0
- data/lib/talon_one/models/new_event.rb +43 -20
- data/lib/talon_one/models/new_event_type.rb +57 -34
- data/lib/talon_one/models/new_feature_flags.rb +44 -21
- data/lib/talon_one/models/new_invitation.rb +41 -18
- data/lib/talon_one/models/new_invite_email.rb +39 -16
- data/lib/talon_one/models/new_loyalty_program.rb +64 -26
- data/lib/talon_one/models/new_password.rb +40 -17
- data/lib/talon_one/models/new_password_email.rb +38 -15
- data/lib/talon_one/models/new_referral.rb +47 -24
- data/lib/talon_one/models/new_role.rb +41 -18
- data/lib/talon_one/models/new_ruleset.rb +43 -20
- data/lib/talon_one/models/new_saml_connection.rb +52 -29
- data/lib/talon_one/models/new_template_def.rb +45 -22
- data/lib/talon_one/models/new_user.rb +42 -19
- data/lib/talon_one/models/new_webhook.rb +50 -27
- data/lib/talon_one/models/notification.rb +40 -17
- data/lib/talon_one/models/profile_audiences_changes.rb +231 -0
- data/lib/talon_one/models/redeem_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/referral.rb +54 -31
- data/lib/talon_one/models/referral_created_effect_props.rb +213 -0
- data/lib/talon_one/models/referral_rejection_reason.rb +45 -22
- data/lib/talon_one/models/reject_coupon_effect_props.rb +258 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +258 -0
- data/lib/talon_one/models/role.rb +58 -25
- data/lib/talon_one/models/role_assign.rb +39 -16
- data/lib/talon_one/models/role_membership.rb +41 -18
- data/lib/talon_one/models/rollback_added_loyalty_points_effect_props.rb +273 -0
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_deducted_loyalty_points_effect_props.rb +293 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rollback_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/rule_failure_reason.rb +343 -0
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +55 -32
- data/lib/talon_one/models/saml_connection_metadata.rb +44 -21
- data/lib/talon_one/models/{cart_item_adjustment.rb → saml_login_endpoint.rb} +81 -64
- data/lib/talon_one/models/session.rb +41 -18
- data/lib/talon_one/models/set_discount_effect_props.rb +238 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +253 -0
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +247 -0
- data/lib/talon_one/models/show_notification_effect_props.rb +243 -0
- data/lib/talon_one/models/slot_def.rb +44 -21
- data/lib/talon_one/models/template_arg_def.rb +44 -21
- data/lib/talon_one/models/template_def.rb +50 -27
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +228 -0
- data/lib/talon_one/models/update_account.rb +100 -23
- data/lib/talon_one/models/update_application.rb +150 -31
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_audience.rb +231 -0
- data/lib/talon_one/models/update_campaign.rb +73 -38
- data/lib/talon_one/models/update_campaign_group.rb +266 -0
- data/lib/talon_one/models/update_coupon.rb +81 -24
- data/lib/talon_one/models/update_coupon_batch.rb +81 -24
- data/lib/talon_one/models/update_loyalty_program.rb +58 -25
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +47 -80
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +213 -0
- data/lib/talon_one/models/user.rb +67 -59
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/user_feed_notifications.rb +230 -0
- data/lib/talon_one/models/webhook.rb +53 -30
- data/lib/talon_one/models/webhook_activation_log_entry.rb +46 -23
- data/lib/talon_one/models/webhook_log_entry.rb +52 -29
- data/lib/talon_one/version.rb +4 -4
- data/spec/api/integration_api_spec.rb +74 -27
- data/spec/api/management_api_spec.rb +294 -181
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{new_import_spec.rb → accept_coupon_effect_props_spec.rb} +11 -15
- data/spec/models/accept_referral_effect_props_spec.rb +41 -0
- data/spec/models/access_log_entry_spec.rb +4 -4
- data/spec/models/account_additional_cost_spec.rb +77 -0
- data/spec/models/account_analytics_spec.rb +30 -12
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -10
- data/spec/models/account_spec.rb +5 -5
- data/spec/models/add_free_item_effect_props_spec.rb +47 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +83 -0
- data/spec/models/{import_coupons_spec.rb → additional_cost_spec.rb} +11 -11
- data/spec/models/api_error_spec.rb +4 -4
- data/spec/models/application_api_health_spec.rb +4 -4
- data/spec/models/application_api_key_spec.rb +21 -11
- data/spec/models/application_customer_entity_spec.rb +4 -4
- data/spec/models/application_customer_search_spec.rb +4 -4
- data/spec/models/application_customer_spec.rb +10 -4
- data/spec/models/application_entity_spec.rb +4 -4
- data/spec/models/application_event_spec.rb +10 -4
- data/spec/models/application_session_entity_spec.rb +4 -4
- data/spec/models/application_session_spec.rb +10 -4
- data/spec/models/application_spec.rb +47 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +4 -4
- data/spec/models/attributes_settings_spec.rb +4 -4
- data/spec/models/audience_membership_spec.rb +47 -0
- data/spec/models/audience_spec.rb +75 -0
- data/spec/models/base_saml_connection_spec.rb +4 -4
- data/spec/models/binding_spec.rb +10 -4
- data/spec/models/campaign_analytics_spec.rb +28 -4
- data/spec/models/campaign_copy_spec.rb +4 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- data/spec/models/campaign_group_entity_spec.rb +41 -0
- data/spec/models/campaign_group_spec.rb +83 -0
- data/spec/models/campaign_search_spec.rb +4 -4
- data/spec/models/campaign_set_branch_node_spec.rb +4 -4
- data/spec/models/campaign_set_leaf_node_spec.rb +4 -4
- data/spec/models/campaign_set_node_spec.rb +4 -4
- data/spec/models/campaign_set_spec.rb +10 -4
- data/spec/models/campaign_spec.rb +40 -4
- data/spec/models/cart_item_spec.rb +4 -10
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +10 -4
- data/spec/models/code_generator_settings_spec.rb +4 -4
- data/spec/models/coupon_constraints_spec.rb +10 -4
- data/spec/models/coupon_created_effect_props_spec.rb +47 -0
- data/spec/models/coupon_rejection_reason_spec.rb +5 -5
- data/spec/models/coupon_reservations_spec.rb +4 -4
- data/spec/models/coupon_search_spec.rb +4 -4
- data/spec/models/coupon_spec.rb +22 -4
- data/spec/models/coupon_value_spec.rb +4 -4
- data/spec/models/create_application_api_key_spec.rb +14 -4
- data/spec/models/customer_activity_report_spec.rb +4 -4
- data/spec/models/customer_analytics_spec.rb +4 -4
- data/spec/models/customer_inventory_spec.rb +16 -4
- data/spec/models/customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +57 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +10 -4
- data/spec/models/customer_session_spec.rb +4 -4
- data/spec/models/customer_session_v2_spec.rb +129 -0
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +65 -0
- data/spec/models/effect_entity_spec.rb +71 -0
- data/spec/models/effect_spec.rb +77 -0
- data/spec/models/email_entity_spec.rb +4 -4
- data/spec/models/entity_spec.rb +4 -4
- data/spec/models/entity_with_talang_visible_id_spec.rb +47 -0
- data/spec/models/environment_spec.rb +4 -4
- data/spec/models/error_effect_props_spec.rb +41 -0
- data/spec/models/error_response_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/event_spec.rb +4 -4
- data/spec/models/event_type_spec.rb +4 -4
- data/spec/models/export_spec.rb +4 -4
- data/spec/models/feature_flag_spec.rb +4 -4
- data/spec/models/feature_flags_spec.rb +4 -4
- data/spec/models/features_feed_spec.rb +4 -4
- data/spec/models/feed_notification_spec.rb +75 -0
- data/spec/models/func_arg_def_spec.rb +4 -4
- data/spec/models/function_def_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -8
- data/spec/models/{inline_response_200_10_spec.rb → inline_response20010_spec.rb} +4 -4
- data/spec/models/{inline_response_200_11_spec.rb → inline_response20011_spec.rb} +4 -4
- data/spec/models/{inline_response_200_12_spec.rb → inline_response20012_spec.rb} +10 -4
- data/spec/models/{inline_response_200_13_spec.rb → inline_response20013_spec.rb} +4 -4
- data/spec/models/{inline_response_200_14_spec.rb → inline_response20014_spec.rb} +4 -4
- data/spec/models/{inline_response_200_15_spec.rb → inline_response20015_spec.rb} +4 -4
- data/spec/models/{inline_response_200_16_spec.rb → inline_response20016_spec.rb} +5 -5
- data/spec/models/{inline_response_200_17_spec.rb → inline_response20017_spec.rb} +4 -4
- data/spec/models/{inline_response_200_18_spec.rb → inline_response20018_spec.rb} +4 -4
- data/spec/models/{inline_response_200_19_spec.rb → inline_response20019_spec.rb} +4 -4
- data/spec/models/{inline_response_200_1_spec.rb → inline_response2001_spec.rb} +4 -4
- data/spec/models/{inline_response_200_20_spec.rb → inline_response20020_spec.rb} +4 -4
- data/spec/models/{inline_response_200_21_spec.rb → inline_response20021_spec.rb} +4 -4
- data/spec/models/{inline_response_200_22_spec.rb → inline_response20022_spec.rb} +4 -4
- data/spec/models/{inline_response_200_23_spec.rb → inline_response20023_spec.rb} +4 -4
- data/spec/models/{inline_response_200_24_spec.rb → inline_response20024_spec.rb} +4 -4
- data/spec/models/{inline_response_200_25_spec.rb → inline_response20025_spec.rb} +4 -4
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -10
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +4 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +10 -4
- data/spec/models/{inline_response_200_29_spec.rb → inline_response20029_spec.rb} +4 -4
- data/spec/models/{inline_response_200_2_spec.rb → inline_response2002_spec.rb} +4 -4
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/{inline_response_200_3_spec.rb → inline_response2003_spec.rb} +4 -4
- data/spec/models/{inline_response_200_4_spec.rb → inline_response2004_spec.rb} +4 -4
- data/spec/models/{inline_response_200_5_spec.rb → inline_response2005_spec.rb} +4 -4
- data/spec/models/{inline_response_200_6_spec.rb → inline_response2006_spec.rb} +4 -4
- data/spec/models/{inline_response_200_7_spec.rb → inline_response2007_spec.rb} +4 -4
- data/spec/models/{inline_response_200_8_spec.rb → inline_response2008_spec.rb} +4 -4
- data/spec/models/{inline_response_200_9_spec.rb → inline_response2009_spec.rb} +4 -4
- data/spec/models/{inline_response_200_spec.rb → inline_response200_spec.rb} +4 -4
- data/spec/models/integration_entity_spec.rb +4 -4
- data/spec/models/integration_event_spec.rb +4 -4
- data/spec/models/integration_profile_entity_spec.rb +4 -4
- data/spec/models/integration_request_spec.rb +51 -0
- data/spec/models/integration_state_spec.rb +4 -4
- data/spec/models/integration_state_v2_spec.rb +101 -0
- data/spec/models/ledger_entry_spec.rb +4 -4
- data/spec/models/library_attribute_spec.rb +4 -4
- data/spec/models/limit_config_spec.rb +4 -8
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +16 -8
- data/spec/models/loyalty_ledger_spec.rb +4 -4
- data/spec/models/loyalty_membership_spec.rb +4 -4
- data/spec/models/loyalty_points_spec.rb +11 -5
- data/spec/models/loyalty_program_balance_spec.rb +28 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +10 -4
- data/spec/models/loyalty_program_spec.rb +10 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_statistics_spec.rb +59 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +46 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +4 -4
- data/spec/models/new_account_sign_up_spec.rb +4 -4
- data/spec/models/new_account_spec.rb +4 -4
- data/spec/models/new_additional_cost_spec.rb +59 -0
- data/spec/models/new_application_api_key_spec.rb +21 -11
- data/spec/models/new_application_spec.rb +52 -4
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_audience_spec.rb +57 -0
- data/spec/models/new_campaign_group_spec.rb +59 -0
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +10 -4
- data/spec/models/new_coupons_for_multiple_recipients_spec.rb +83 -0
- data/spec/models/new_coupons_spec.rb +16 -10
- data/spec/models/new_customer_profile_spec.rb +4 -4
- data/spec/models/new_customer_session_spec.rb +4 -4
- data/spec/models/new_customer_session_v2_spec.rb +87 -0
- data/spec/models/new_event_spec.rb +4 -4
- data/spec/models/new_event_type_spec.rb +4 -4
- data/spec/models/new_feature_flags_spec.rb +4 -4
- data/spec/models/new_invitation_spec.rb +4 -4
- data/spec/models/new_invite_email_spec.rb +4 -4
- data/spec/models/new_loyalty_program_spec.rb +10 -4
- data/spec/models/new_password_email_spec.rb +4 -4
- data/spec/models/new_password_spec.rb +4 -4
- data/spec/models/new_referral_spec.rb +4 -4
- data/spec/models/new_role_spec.rb +4 -4
- data/spec/models/new_ruleset_spec.rb +4 -4
- data/spec/models/new_saml_connection_spec.rb +4 -4
- data/spec/models/new_template_def_spec.rb +4 -4
- data/spec/models/new_user_spec.rb +4 -4
- data/spec/models/new_webhook_spec.rb +4 -4
- data/spec/models/notification_spec.rb +4 -4
- data/spec/models/profile_audiences_changes_spec.rb +47 -0
- data/spec/models/redeem_referral_effect_props_spec.rb +47 -0
- data/spec/models/referral_created_effect_props_spec.rb +41 -0
- data/spec/models/referral_rejection_reason_spec.rb +5 -5
- data/spec/models/referral_spec.rb +4 -4
- data/spec/models/reject_coupon_effect_props_spec.rb +65 -0
- data/spec/models/reject_referral_effect_props_spec.rb +65 -0
- data/spec/models/role_assign_spec.rb +4 -4
- data/spec/models/role_membership_spec.rb +4 -4
- data/spec/models/role_spec.rb +10 -4
- data/spec/models/rollback_added_loyalty_points_effect_props_spec.rb +65 -0
- data/spec/models/rollback_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_deducted_loyalty_points_effect_props_spec.rb +77 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -0
- data/spec/models/{misc_update_user_latest_feature_spec.rb → rollback_referral_effect_props_spec.rb} +11 -11
- data/spec/models/rule_failure_reason_spec.rb +107 -0
- data/spec/models/rule_spec.rb +4 -4
- data/spec/models/ruleset_spec.rb +4 -4
- data/spec/models/saml_connection_metadata_spec.rb +4 -4
- data/spec/models/saml_connection_spec.rb +4 -4
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/{cart_item_adjustment_spec.rb → set_discount_effect_props_spec.rb} +13 -13
- data/spec/models/set_discount_per_item_effect_props_spec.rb +59 -0
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +53 -0
- data/spec/models/show_notification_effect_props_spec.rb +53 -0
- data/spec/models/slot_def_spec.rb +4 -4
- data/spec/models/template_arg_def_spec.rb +4 -4
- data/spec/models/template_def_spec.rb +4 -4
- data/spec/models/trigger_webhook_effect_props_spec.rb +47 -0
- data/spec/models/update_account_spec.rb +20 -4
- data/spec/models/update_application_spec.rb +52 -4
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_audience_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +59 -0
- data/spec/models/update_campaign_spec.rb +10 -4
- data/spec/models/update_coupon_batch_spec.rb +10 -4
- data/spec/models/update_coupon_spec.rb +10 -4
- data/spec/models/update_loyalty_program_spec.rb +10 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +41 -0
- data/spec/models/update_user_spec.rb +4 -34
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_feed_notifications_spec.rb +47 -0
- data/spec/models/user_spec.rb +5 -11
- data/spec/models/webhook_activation_log_entry_spec.rb +4 -4
- data/spec/models/webhook_log_entry_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +317 -244
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/CartItemAdjustment.md +0 -10
- data/docs/ImportCoupons.md +0 -8
- data/docs/MiscUpdateUserLatestFeature.md +0 -8
- data/docs/NewImport.md +0 -8
- data/docs/Notifications.md +0 -7
- data/git_push.sh +0 -55
- data/lib/talon_one/models/attribute_query.rb +0 -174
- data/lib/talon_one/models/import_coupons.rb +0 -188
- data/lib/talon_one/models/inline_response_200_16.rb +0 -204
- data/lib/talon_one/models/inline_response_200_28.rb +0 -204
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +0 -183
- data/lib/talon_one/models/notifications.rb +0 -174
- data/spec/models/attribute_query_spec.rb +0 -35
- data/spec/models/notifications_spec.rb +0 -35
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
- data/talon_one-1.3.0.gem +0 -0
data/lib/talon_one/version.rb
CHANGED
@@ -3,13 +3,13 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
module TalonOne
|
14
|
-
VERSION = '
|
14
|
+
VERSION = '2.3.0'
|
15
15
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,12 +14,12 @@ require 'spec_helper'
|
|
14
14
|
require 'json'
|
15
15
|
|
16
16
|
# Unit tests for TalonOne::IntegrationApi
|
17
|
-
# Automatically generated by
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe 'IntegrationApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@
|
22
|
+
@api_instance = TalonOne::IntegrationApi.new
|
23
23
|
end
|
24
24
|
|
25
25
|
after do
|
@@ -28,7 +28,7 @@ describe 'IntegrationApi' do
|
|
28
28
|
|
29
29
|
describe 'test an instance of IntegrationApi' do
|
30
30
|
it 'should create an instance of IntegrationApi' do
|
31
|
-
expect(@
|
31
|
+
expect(@api_instance).to be_instance_of(TalonOne::IntegrationApi)
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
@@ -71,7 +71,7 @@ describe 'IntegrationApi' do
|
|
71
71
|
end
|
72
72
|
|
73
73
|
# unit tests for delete_customer_data
|
74
|
-
# Delete the personal data of a customer
|
74
|
+
# Delete the personal data of a customer
|
75
75
|
# Delete all attributes on the customer profile and on entities that reference that customer profile.
|
76
76
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
77
77
|
# @param [Hash] opts the optional parameters
|
@@ -83,12 +83,14 @@ describe 'IntegrationApi' do
|
|
83
83
|
end
|
84
84
|
|
85
85
|
# unit tests for get_customer_inventory
|
86
|
-
# Get an inventory of all data associated with a specific customer profile
|
87
|
-
# Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information and
|
86
|
+
# Get an inventory of all data associated with a specific customer profile
|
87
|
+
# Get information regarding entities referencing this customer profile's integrationId. Currently we support customer profile information, referral codes and reserved coupons. In the future, this will be expanded with loyalty points.
|
88
88
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
89
89
|
# @param [Hash] opts the optional parameters
|
90
|
-
# @option opts [
|
91
|
-
# @option opts [
|
90
|
+
# @option opts [Boolean] :profile optional flag to decide if you would like customer profile information in the response
|
91
|
+
# @option opts [Boolean] :referrals optional flag to decide if you would like referral information in the response
|
92
|
+
# @option opts [Boolean] :coupons optional flag to decide if you would like coupon information in the response
|
93
|
+
# @option opts [Boolean] :loyalty optional flag to decide if you would like loyalty information in the response
|
92
94
|
# @return [CustomerInventory]
|
93
95
|
describe 'get_customer_inventory test' do
|
94
96
|
it 'should work' do
|
@@ -96,18 +98,6 @@ describe 'IntegrationApi' do
|
|
96
98
|
end
|
97
99
|
end
|
98
100
|
|
99
|
-
# unit tests for get_reserved_coupons
|
100
|
-
# Get all valid reserved coupons
|
101
|
-
# Returns all coupons this user is subscribed to that are valid and usable
|
102
|
-
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
103
|
-
# @param [Hash] opts the optional parameters
|
104
|
-
# @return [InlineResponse2001]
|
105
|
-
describe 'get_reserved_coupons test' do
|
106
|
-
it 'should work' do
|
107
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
108
|
-
end
|
109
|
-
end
|
110
|
-
|
111
101
|
# unit tests for get_reserved_customers
|
112
102
|
# Get the users that have this coupon reserved
|
113
103
|
# Returns all users that have this coupon marked as reserved
|
@@ -125,6 +115,7 @@ describe 'IntegrationApi' do
|
|
125
115
|
# Records an arbitrary event in a customer session. For example, an integration might record an event when a user updates their payment information. The `sessionId` body parameter is required, an event is always part of a session. Much like updating a customer session, if either the profile or the session do not exist, a new empty one will be created. Note that if the specified session already exists, it must belong to the same `profileId` or an error will be returned. As with customer sessions, you can use an empty string for `profileId` to indicate that this is an anonymous session. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place.
|
126
116
|
# @param body
|
127
117
|
# @param [Hash] opts the optional parameters
|
118
|
+
# @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
128
119
|
# @return [IntegrationState]
|
129
120
|
describe 'track_event test' do
|
130
121
|
it 'should work' do
|
@@ -133,11 +124,12 @@ describe 'IntegrationApi' do
|
|
133
124
|
end
|
134
125
|
|
135
126
|
# unit tests for update_customer_profile
|
136
|
-
# Update a Customer Profile
|
137
|
-
# Update (or create) a [Customer Profile]
|
127
|
+
# Update a Customer Profile V1
|
128
|
+
# ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). This profile information can then be matched and/or updated by campaign [Rules][]. The `integrationId` may be any identifier that will remain stable for the customer. For example, you might use a database ID, an email, or a phone number as the `integrationId`. It is vital that this ID **not** change over time, so **don't** use any identifier that the customer can update themselves. E.g. if your application allows a customer to update their e-mail address, you should instead use a database ID. Updating a customer profile will return a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. [Customer Profile]: /Getting-Started/entities#customer-profile [Rules]: /Getting-Started/entities#campaigns-rulesets-and-coupons
|
138
129
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
139
130
|
# @param body
|
140
131
|
# @param [Hash] opts the optional parameters
|
132
|
+
# @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
141
133
|
# @return [IntegrationState]
|
142
134
|
describe 'update_customer_profile test' do
|
143
135
|
it 'should work' do
|
@@ -145,12 +137,53 @@ describe 'IntegrationApi' do
|
|
145
137
|
end
|
146
138
|
end
|
147
139
|
|
140
|
+
# unit tests for update_customer_profile_audiences
|
141
|
+
# Update a Customer Profile Audiences
|
142
|
+
# Update one ore multiple Customer Profiles with the specified Audiences
|
143
|
+
# @param body
|
144
|
+
# @param [Hash] opts the optional parameters
|
145
|
+
# @return [nil]
|
146
|
+
describe 'update_customer_profile_audiences test' do
|
147
|
+
it 'should work' do
|
148
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
# unit tests for update_customer_profile_v2
|
153
|
+
# Update a Customer Profile
|
154
|
+
# Update (or create) a [Customer Profile](https://developers.talon.one/Getting-Started/entities#customer-profile). The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Updating a customer profile returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter.
|
155
|
+
# @param integration_id The custom identifier for this profile. Must be unique within the account.
|
156
|
+
# @param body
|
157
|
+
# @param [Hash] opts the optional parameters
|
158
|
+
# @option opts [Boolean] :run_rule_engine Indicates whether to run the rule engine.
|
159
|
+
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are persisted with `true`. Only used when `runRuleEngine` is set to `true`.
|
160
|
+
# @return [IntegrationStateV2]
|
161
|
+
describe 'update_customer_profile_v2 test' do
|
162
|
+
it 'should work' do
|
163
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
# unit tests for update_customer_profiles_v2
|
168
|
+
# Update multiple Customer Profiles
|
169
|
+
# Update (or create) up to 1000 [Customer Profiles](https://developers.talon.one/Getting-Started/entities#customer-profile) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://developers.talon.one/Integration-API/API-Reference#updateCustomerSessionV2).
|
170
|
+
# @param body
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @option opts [String] :silent If set to `yes`, response will be an empty 204, otherwise a list of integration states will be generated (up to 1000).
|
173
|
+
# @return [MultipleCustomerProfileIntegrationResponseV2]
|
174
|
+
describe 'update_customer_profiles_v2 test' do
|
175
|
+
it 'should work' do
|
176
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
148
180
|
# unit tests for update_customer_session
|
149
|
-
# Update a Customer Session
|
150
|
-
# Update (or create) a [Customer Session]
|
181
|
+
# Update a Customer Session V1
|
182
|
+
# ⚠️ Deprecation Notice: Support for requests to this endpoint will end on 15.07.2021. We will not remove the endpoint, and it will still be accessible for you to use. For new features support, migrate to [API V2.0](https://developers.talon.one/Getting-Started/APIV2). Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer profile returns a response with the full integration state. This includes the current state of the customer profile, the customer session, the event that was recorded, and an array of effects that took place. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
|
151
183
|
# @param customer_session_id The custom identifier for this session, must be unique within the account.
|
152
184
|
# @param body
|
153
185
|
# @param [Hash] opts the optional parameters
|
186
|
+
# @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
154
187
|
# @return [IntegrationState]
|
155
188
|
describe 'update_customer_session test' do
|
156
189
|
it 'should work' do
|
@@ -158,4 +191,18 @@ describe 'IntegrationApi' do
|
|
158
191
|
end
|
159
192
|
end
|
160
193
|
|
194
|
+
# unit tests for update_customer_session_v2
|
195
|
+
# Update a Customer Session
|
196
|
+
# Update (or create) a [Customer Session](https://developers.talon.one/Getting-Started/entities#customer-session). For example, use this endpoint to represent which items are in the customer's cart. The Talon.One platform supports multiple simultaneous sessions for the same profile. If you have multiple ways of accessing the same application you can either: - Track multiple independent sessions or, - Use the same session across all of them. You should share sessions when application access points share other state, such as the user's cart. If two points of access to the application have independent states, for example a user can have different items in their cart across the two) they should use independent customer session ID's. To link a session to a customer profile, set the `profileId` parameter in the request body to a customer profile's `integrationId`. To track an anonymous session use the empty string (`\"\"`) as the `profileId`. **Note:** You do **not** have to create a customer profile first. If the specified profile does not exist, an empty profile is created automatically. Updating a customer session returns a response with the requested integration state. If `runRuleEngine` is set to `true`, the response includes: - The effects generated by the triggered campaigns. - The created coupons and referral objects. - Any entity that was requested in the `responseContent` request parameter. The currency for the session and the cart items in the session is the same as that of the application with which the session is associated.
|
197
|
+
# @param customer_session_id The custom identifier for this session, must be unique within the account.
|
198
|
+
# @param body
|
199
|
+
# @param [Hash] opts the optional parameters
|
200
|
+
# @option opts [Boolean] :dry Indicates whether to skip persisting the changes or not (Will not persist if set to 'true').
|
201
|
+
# @return [IntegrationStateV2]
|
202
|
+
describe 'update_customer_session_v2 test' do
|
203
|
+
it 'should work' do
|
204
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
205
|
+
end
|
206
|
+
end
|
207
|
+
|
161
208
|
end
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#The Talon.One API is used to manage applications and campaigns, as well as to integrate with your application. The operations in the _Integration API_ section are used to integrate with our platform, while the other operations are used to manage applications and campaigns. ### Where is the API? The API is available at the same hostname as these docs. For example, if you are reading this page at `https://mycompany.talon.one/docs/api/`, the URL for the [updateCustomerProfile][] operation is `https://mycompany.talon.one/v1/customer_profiles/id` [updateCustomerProfile]: #operation--v1-customer_profiles--integrationId--put
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
7
|
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -14,12 +14,12 @@ require 'spec_helper'
|
|
14
14
|
require 'json'
|
15
15
|
|
16
16
|
# Unit tests for TalonOne::ManagementApi
|
17
|
-
# Automatically generated by
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
18
|
# Please update as you see appropriate
|
19
19
|
describe 'ManagementApi' do
|
20
20
|
before do
|
21
21
|
# run before each test
|
22
|
-
@
|
22
|
+
@api_instance = TalonOne::ManagementApi.new
|
23
23
|
end
|
24
24
|
|
25
25
|
after do
|
@@ -28,13 +28,12 @@ describe 'ManagementApi' do
|
|
28
28
|
|
29
29
|
describe 'test an instance of ManagementApi' do
|
30
30
|
it 'should create an instance of ManagementApi' do
|
31
|
-
expect(@
|
31
|
+
expect(@api_instance).to be_instance_of(TalonOne::ManagementApi)
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
35
|
# unit tests for add_loyalty_points
|
36
36
|
# Add points in a certain loyalty program for the specified customer
|
37
|
-
#
|
38
37
|
# @param program_id
|
39
38
|
# @param integration_id
|
40
39
|
# @param body
|
@@ -53,13 +52,25 @@ describe 'ManagementApi' do
|
|
53
52
|
# @param campaign_id
|
54
53
|
# @param body
|
55
54
|
# @param [Hash] opts the optional parameters
|
56
|
-
# @return [
|
55
|
+
# @return [InlineResponse2002]
|
57
56
|
describe 'copy_campaign_to_applications test' do
|
58
57
|
it 'should work' do
|
59
58
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
60
59
|
end
|
61
60
|
end
|
62
61
|
|
62
|
+
# unit tests for create_additional_cost
|
63
|
+
# Define a new additional cost
|
64
|
+
# Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
|
65
|
+
# @param body
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @return [AccountAdditionalCost]
|
68
|
+
describe 'create_additional_cost test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
63
74
|
# unit tests for create_attribute
|
64
75
|
# Define a new custom attribute
|
65
76
|
# Defines a new _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.
|
@@ -74,7 +85,6 @@ describe 'ManagementApi' do
|
|
74
85
|
|
75
86
|
# unit tests for create_campaign
|
76
87
|
# Create a Campaign
|
77
|
-
#
|
78
88
|
# @param application_id
|
79
89
|
# @param body
|
80
90
|
# @param [Hash] opts the optional parameters
|
@@ -93,13 +103,28 @@ describe 'ManagementApi' do
|
|
93
103
|
# @param body
|
94
104
|
# @param [Hash] opts the optional parameters
|
95
105
|
# @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
|
96
|
-
# @return [
|
106
|
+
# @return [InlineResponse2004]
|
97
107
|
describe 'create_coupons test' do
|
98
108
|
it 'should work' do
|
99
109
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
100
110
|
end
|
101
111
|
end
|
102
112
|
|
113
|
+
# unit tests for create_coupons_for_multiple_recipients
|
114
|
+
# Create Coupons for Multiple Recipients
|
115
|
+
# Create coupons according to some pattern for up to 1000 recipients.
|
116
|
+
# @param application_id
|
117
|
+
# @param campaign_id
|
118
|
+
# @param body
|
119
|
+
# @param [Hash] opts the optional parameters
|
120
|
+
# @option opts [String] :silent If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
|
121
|
+
# @return [InlineResponse2004]
|
122
|
+
describe 'create_coupons_for_multiple_recipients test' do
|
123
|
+
it 'should work' do
|
124
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
103
128
|
# unit tests for create_password_recovery_email
|
104
129
|
# Request a password reset
|
105
130
|
# Sends an email with a password recovery link to the email of an existing account.
|
@@ -114,7 +139,6 @@ describe 'ManagementApi' do
|
|
114
139
|
|
115
140
|
# unit tests for create_ruleset
|
116
141
|
# Create a Ruleset
|
117
|
-
#
|
118
142
|
# @param application_id
|
119
143
|
# @param campaign_id
|
120
144
|
# @param body
|
@@ -128,7 +152,6 @@ describe 'ManagementApi' do
|
|
128
152
|
|
129
153
|
# unit tests for create_session
|
130
154
|
# Create a Session
|
131
|
-
#
|
132
155
|
# @param body
|
133
156
|
# @param [Hash] opts the optional parameters
|
134
157
|
# @return [Session]
|
@@ -140,7 +163,6 @@ describe 'ManagementApi' do
|
|
140
163
|
|
141
164
|
# unit tests for delete_campaign
|
142
165
|
# Delete a Campaign
|
143
|
-
#
|
144
166
|
# @param application_id
|
145
167
|
# @param campaign_id
|
146
168
|
# @param [Hash] opts the optional parameters
|
@@ -153,7 +175,6 @@ describe 'ManagementApi' do
|
|
153
175
|
|
154
176
|
# unit tests for delete_coupon
|
155
177
|
# Delete one Coupon
|
156
|
-
#
|
157
178
|
# @param application_id
|
158
179
|
# @param campaign_id
|
159
180
|
# @param coupon_id The ID of the coupon code to delete
|
@@ -167,23 +188,22 @@ describe 'ManagementApi' do
|
|
167
188
|
|
168
189
|
# unit tests for delete_coupons
|
169
190
|
# Delete Coupons
|
170
|
-
#
|
171
191
|
# @param application_id
|
172
192
|
# @param campaign_id
|
173
193
|
# @param [Hash] opts the optional parameters
|
174
194
|
# @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.
|
175
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
176
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
177
|
-
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
178
|
-
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
179
|
-
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
180
|
-
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
195
|
+
# @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.
|
196
|
+
# @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.
|
197
|
+
# @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.
|
198
|
+
# @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
|
+
# @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
|
+
# @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.
|
181
201
|
# @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.
|
182
202
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
183
203
|
# @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`.
|
184
204
|
# @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.
|
185
205
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
186
|
-
# @option opts [
|
206
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
187
207
|
# @return [nil]
|
188
208
|
describe 'delete_coupons test' do
|
189
209
|
it 'should work' do
|
@@ -193,7 +213,6 @@ describe 'ManagementApi' do
|
|
193
213
|
|
194
214
|
# unit tests for delete_referral
|
195
215
|
# Delete one Referral
|
196
|
-
#
|
197
216
|
# @param application_id
|
198
217
|
# @param campaign_id
|
199
218
|
# @param referral_id The ID of the referral code to delete
|
@@ -207,7 +226,6 @@ describe 'ManagementApi' do
|
|
207
226
|
|
208
227
|
# unit tests for delete_ruleset
|
209
228
|
# Delete a Ruleset
|
210
|
-
#
|
211
229
|
# @param application_id
|
212
230
|
# @param campaign_id
|
213
231
|
# @param ruleset_id
|
@@ -219,9 +237,104 @@ describe 'ManagementApi' do
|
|
219
237
|
end
|
220
238
|
end
|
221
239
|
|
240
|
+
# unit tests for destroy_session
|
241
|
+
# Destroy a Session
|
242
|
+
# @param [Hash] opts the optional parameters
|
243
|
+
# @return [nil]
|
244
|
+
describe 'destroy_session test' do
|
245
|
+
it 'should work' do
|
246
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
247
|
+
end
|
248
|
+
end
|
249
|
+
|
250
|
+
# unit tests for export_coupons
|
251
|
+
# Export Coupons to a CSV file
|
252
|
+
# Download a file with the coupons that match the given attributes.
|
253
|
+
# @param application_id
|
254
|
+
# @param [Hash] opts the optional parameters
|
255
|
+
# @option opts [Float] :campaign_id Filter results by campaign.
|
256
|
+
# @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.
|
257
|
+
# @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.
|
258
|
+
# @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.
|
259
|
+
# @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.
|
260
|
+
# @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.
|
261
|
+
# @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`.
|
262
|
+
# @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.
|
263
|
+
# @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] :batch_id Filter results by batches of coupons
|
265
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
266
|
+
# @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.
|
268
|
+
# @return [String]
|
269
|
+
describe 'export_coupons test' do
|
270
|
+
it 'should work' do
|
271
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
272
|
+
end
|
273
|
+
end
|
274
|
+
|
275
|
+
# unit tests for export_customer_sessions
|
276
|
+
# Export Customer Sessions to a CSV file
|
277
|
+
# Download a file with the customer sessions that match the request.
|
278
|
+
# @param application_id
|
279
|
+
# @param [Hash] opts the optional parameters
|
280
|
+
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
281
|
+
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
282
|
+
# @option opts [String] :profile_integration_id Only return sessions for the customer that matches this customer integration ID.
|
283
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
284
|
+
# @option opts [String] :customer_session_state Filter results by state.
|
285
|
+
# @return [String]
|
286
|
+
describe 'export_customer_sessions test' do
|
287
|
+
it 'should work' do
|
288
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
289
|
+
end
|
290
|
+
end
|
291
|
+
|
292
|
+
# unit tests for export_effects
|
293
|
+
# Export triggered Effects to a CSV file
|
294
|
+
# Download a file with the triggered effects that match the given attributes.
|
295
|
+
# @param application_id
|
296
|
+
# @param [Hash] opts the optional parameters
|
297
|
+
# @option opts [Float] :campaign_id Filter results by campaign.
|
298
|
+
# @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.
|
299
|
+
# @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.
|
300
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
301
|
+
# @return [String]
|
302
|
+
describe 'export_effects test' do
|
303
|
+
it 'should work' do
|
304
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
308
|
+
# unit tests for export_loyalty_balance
|
309
|
+
# Export customer loyalty balance to a CSV file
|
310
|
+
# Download a file with the balance of each customer in the loyalty program
|
311
|
+
# @param program_id
|
312
|
+
# @param [Hash] opts the optional parameters
|
313
|
+
# @return [String]
|
314
|
+
describe 'export_loyalty_balance test' do
|
315
|
+
it 'should work' do
|
316
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
317
|
+
end
|
318
|
+
end
|
319
|
+
|
320
|
+
# unit tests for export_loyalty_ledger
|
321
|
+
# Export a customer's loyalty ledger log to a CSV file
|
322
|
+
# Download a file with a customer's ledger log in the loyalty program
|
323
|
+
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
324
|
+
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
325
|
+
# @param program_id
|
326
|
+
# @param integration_id
|
327
|
+
# @param [Hash] opts the optional parameters
|
328
|
+
# @option opts [String] :date_format Determines the format of dates in the export document.
|
329
|
+
# @return [String]
|
330
|
+
describe 'export_loyalty_ledger test' do
|
331
|
+
it 'should work' do
|
332
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
222
336
|
# unit tests for get_access_logs
|
223
|
-
# Get access logs for application
|
224
|
-
#
|
337
|
+
# Get access logs for application (with total count)
|
225
338
|
# @param application_id
|
226
339
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
227
340
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -241,7 +354,6 @@ describe 'ManagementApi' do
|
|
241
354
|
|
242
355
|
# unit tests for get_access_logs_without_total_count
|
243
356
|
# Get access logs for application
|
244
|
-
#
|
245
357
|
# @param application_id
|
246
358
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
247
359
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -283,6 +395,32 @@ describe 'ManagementApi' do
|
|
283
395
|
end
|
284
396
|
end
|
285
397
|
|
398
|
+
# unit tests for get_additional_cost
|
399
|
+
# Get an additional cost
|
400
|
+
# Returns additional cost for the account by its id.
|
401
|
+
# @param additional_cost_id
|
402
|
+
# @param [Hash] opts the optional parameters
|
403
|
+
# @return [AccountAdditionalCost]
|
404
|
+
describe 'get_additional_cost test' do
|
405
|
+
it 'should work' do
|
406
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
407
|
+
end
|
408
|
+
end
|
409
|
+
|
410
|
+
# unit tests for get_additional_costs
|
411
|
+
# List additional costs
|
412
|
+
# Returns all the defined additional costs for the account.
|
413
|
+
# @param [Hash] opts the optional parameters
|
414
|
+
# @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
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
416
|
+
# @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 [InlineResponse20022]
|
418
|
+
describe 'get_additional_costs test' do
|
419
|
+
it 'should work' do
|
420
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
421
|
+
end
|
422
|
+
end
|
423
|
+
|
286
424
|
# unit tests for get_all_access_logs
|
287
425
|
# Get all access logs
|
288
426
|
# Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
@@ -303,9 +441,9 @@ describe 'ManagementApi' do
|
|
303
441
|
end
|
304
442
|
|
305
443
|
# unit tests for get_all_roles
|
306
|
-
# Get all roles
|
444
|
+
# Get all roles
|
307
445
|
# @param [Hash] opts the optional parameters
|
308
|
-
# @return [
|
446
|
+
# @return [InlineResponse20030]
|
309
447
|
describe 'get_all_roles test' do
|
310
448
|
it 'should work' do
|
311
449
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -326,7 +464,6 @@ describe 'ManagementApi' do
|
|
326
464
|
|
327
465
|
# unit tests for get_application_api_health
|
328
466
|
# Get report of health of application API
|
329
|
-
#
|
330
467
|
# @param application_id
|
331
468
|
# @param [Hash] opts the optional parameters
|
332
469
|
# @return [ApplicationApiHealth]
|
@@ -338,7 +475,6 @@ describe 'ManagementApi' do
|
|
338
475
|
|
339
476
|
# unit tests for get_application_customer
|
340
477
|
# Get Application Customer
|
341
|
-
#
|
342
478
|
# @param application_id
|
343
479
|
# @param customer_id
|
344
480
|
# @param [Hash] opts the optional parameters
|
@@ -351,9 +487,12 @@ describe 'ManagementApi' do
|
|
351
487
|
|
352
488
|
# unit tests for get_application_customers
|
353
489
|
# List Application Customers
|
354
|
-
#
|
355
490
|
# @param application_id
|
356
491
|
# @param [Hash] opts the optional parameters
|
492
|
+
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
493
|
+
# @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
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
495
|
+
# @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
357
496
|
# @return [InlineResponse20012]
|
358
497
|
describe 'get_application_customers test' do
|
359
498
|
it 'should work' do
|
@@ -362,7 +501,7 @@ describe 'ManagementApi' do
|
|
362
501
|
end
|
363
502
|
|
364
503
|
# unit tests for get_application_customers_by_attributes
|
365
|
-
# Get a list of the customer profiles that match the given attributes
|
504
|
+
# Get a list of the customer profiles that match the given attributes (with total count)
|
366
505
|
# Gets a list of all the customer profiles for the account that exactly match a set of attributes. 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. [Customer Profile]: https://help.talon.one/hc/en-us/articles/360005130739-Data-Model#CustomerProfile
|
367
506
|
# @param body
|
368
507
|
# @param [Hash] opts the optional parameters
|
@@ -389,7 +528,7 @@ describe 'ManagementApi' do
|
|
389
528
|
end
|
390
529
|
|
391
530
|
# unit tests for get_application_events
|
392
|
-
# List Applications Events
|
531
|
+
# List Applications Events (with total count)
|
393
532
|
# Lists all events recorded for an application.
|
394
533
|
# @param application_id
|
395
534
|
# @param [Hash] opts the optional parameters
|
@@ -397,14 +536,14 @@ describe 'ManagementApi' do
|
|
397
536
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
398
537
|
# @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.
|
399
538
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
400
|
-
# @option opts [DateTime] :created_before Only return events created before this date
|
401
|
-
# @option opts [DateTime] :created_after Only return events created after this date
|
539
|
+
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
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.
|
402
541
|
# @option opts [String] :session Session integration ID filter for events. Must be exact match.
|
403
542
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
404
543
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
405
544
|
# @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
|
406
|
-
# @option opts [String] :
|
407
|
-
# @option opts [String] :
|
545
|
+
# @option opts [String] :coupon_code Coupon code
|
546
|
+
# @option opts [String] :referral_code Referral code
|
408
547
|
# @option opts [String] :rule_query Rule name filter for events
|
409
548
|
# @option opts [String] :campaign_query Campaign name filter for events
|
410
549
|
# @return [InlineResponse20017]
|
@@ -423,14 +562,14 @@ describe 'ManagementApi' do
|
|
423
562
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
424
563
|
# @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.
|
425
564
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
426
|
-
# @option opts [DateTime] :created_before Only return events created before this date
|
427
|
-
# @option opts [DateTime] :created_after Only return events created after this date
|
565
|
+
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
566
|
+
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
428
567
|
# @option opts [String] :session Session integration ID filter for events. Must be exact match.
|
429
568
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
430
569
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
431
570
|
# @option opts [String] :customer_email Customer e-mail address filter for events. Will match substrings case-insensitively.
|
432
|
-
# @option opts [String] :
|
433
|
-
# @option opts [String] :
|
571
|
+
# @option opts [String] :coupon_code Coupon code
|
572
|
+
# @option opts [String] :referral_code Referral code
|
434
573
|
# @option opts [String] :rule_query Rule name filter for events
|
435
574
|
# @option opts [String] :campaign_query Campaign name filter for events
|
436
575
|
# @return [InlineResponse20018]
|
@@ -442,7 +581,6 @@ describe 'ManagementApi' do
|
|
442
581
|
|
443
582
|
# unit tests for get_application_session
|
444
583
|
# Get Application Session
|
445
|
-
#
|
446
584
|
# @param application_id
|
447
585
|
# @param session_id
|
448
586
|
# @param [Hash] opts the optional parameters
|
@@ -455,7 +593,6 @@ describe 'ManagementApi' do
|
|
455
593
|
|
456
594
|
# unit tests for get_application_sessions
|
457
595
|
# List Application Sessions
|
458
|
-
#
|
459
596
|
# @param application_id
|
460
597
|
# @param [Hash] opts the optional parameters
|
461
598
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -463,7 +600,11 @@ describe 'ManagementApi' do
|
|
463
600
|
# @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.
|
464
601
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
465
602
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
603
|
+
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
604
|
+
# @option opts [DateTime] :created_after Only return events created after this date. You can use any timezone. Talon.One will convert to UTC internally.
|
466
605
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
606
|
+
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
607
|
+
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
467
608
|
# @return [InlineResponse20016]
|
468
609
|
describe 'get_application_sessions test' do
|
469
610
|
it 'should work' do
|
@@ -478,7 +619,7 @@ describe 'ManagementApi' do
|
|
478
619
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
479
620
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
480
621
|
# @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.
|
481
|
-
# @return [
|
622
|
+
# @return [InlineResponse2001]
|
482
623
|
describe 'get_applications test' do
|
483
624
|
it 'should work' do
|
484
625
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -504,16 +645,30 @@ describe 'ManagementApi' do
|
|
504
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.
|
505
646
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
506
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.
|
507
|
-
# @return [
|
648
|
+
# @return [InlineResponse20021]
|
508
649
|
describe 'get_attributes test' do
|
509
650
|
it 'should work' do
|
510
651
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
511
652
|
end
|
512
653
|
end
|
513
654
|
|
655
|
+
# unit tests for get_audiences
|
656
|
+
# Get all audiences
|
657
|
+
# Get All audiences created in the account.
|
658
|
+
# @param [Hash] opts the optional parameters
|
659
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
660
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
661
|
+
# @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.
|
662
|
+
# @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
663
|
+
# @return [InlineResponse20020]
|
664
|
+
describe 'get_audiences test' do
|
665
|
+
it 'should work' do
|
666
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
667
|
+
end
|
668
|
+
end
|
669
|
+
|
514
670
|
# unit tests for get_campaign
|
515
671
|
# Get a Campaign
|
516
|
-
#
|
517
672
|
# @param application_id
|
518
673
|
# @param campaign_id
|
519
674
|
# @param [Hash] opts the optional parameters
|
@@ -526,7 +681,6 @@ describe 'ManagementApi' do
|
|
526
681
|
|
527
682
|
# unit tests for get_campaign_analytics
|
528
683
|
# Get analytics of campaigns
|
529
|
-
#
|
530
684
|
# @param application_id
|
531
685
|
# @param campaign_id
|
532
686
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
@@ -550,28 +704,15 @@ describe 'ManagementApi' do
|
|
550
704
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
551
705
|
# @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.
|
552
706
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
553
|
-
# @return [
|
707
|
+
# @return [InlineResponse2002]
|
554
708
|
describe 'get_campaign_by_attributes test' do
|
555
709
|
it 'should work' do
|
556
710
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
557
711
|
end
|
558
712
|
end
|
559
713
|
|
560
|
-
# unit tests for get_campaign_set
|
561
|
-
# List CampaignSet
|
562
|
-
#
|
563
|
-
# @param application_id
|
564
|
-
# @param [Hash] opts the optional parameters
|
565
|
-
# @return [CampaignSet]
|
566
|
-
describe 'get_campaign_set test' do
|
567
|
-
it 'should work' do
|
568
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
569
|
-
end
|
570
|
-
end
|
571
|
-
|
572
714
|
# unit tests for get_campaigns
|
573
715
|
# List your Campaigns
|
574
|
-
#
|
575
716
|
# @param application_id
|
576
717
|
# @param [Hash] opts the optional parameters
|
577
718
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -580,9 +721,10 @@ describe 'ManagementApi' do
|
|
580
721
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
581
722
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
582
723
|
# @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
|
583
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
584
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
585
|
-
# @
|
724
|
+
# @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.
|
725
|
+
# @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.
|
726
|
+
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
727
|
+
# @return [InlineResponse2002]
|
586
728
|
describe 'get_campaigns test' do
|
587
729
|
it 'should work' do
|
588
730
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -597,11 +739,13 @@ describe 'ManagementApi' do
|
|
597
739
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
598
740
|
# @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.
|
599
741
|
# @option opts [Integer] :application_id
|
600
|
-
# @option opts [
|
601
|
-
# @option opts [
|
602
|
-
# @option opts [
|
603
|
-
# @option opts [
|
604
|
-
# @
|
742
|
+
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
743
|
+
# @option opts [Integer] :user_id
|
744
|
+
# @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.
|
745
|
+
# @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.
|
746
|
+
# @option opts [Boolean] :with_total_result_size When this flag is set, the result will include the total size of the result, across all pages. This might decrease performance on large data sets. With this flag set to true, hasMore will be be true whenever there is a next page. totalResultSize will always be zero. With this flag set to false, hasMore will always be set to false. totalResultSize will contain the total number of results for this query.
|
747
|
+
# @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.
|
748
|
+
# @return [InlineResponse20028]
|
605
749
|
describe 'get_changes test' do
|
606
750
|
it 'should work' do
|
607
751
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -609,8 +753,7 @@ describe 'ManagementApi' do
|
|
609
753
|
end
|
610
754
|
|
611
755
|
# unit tests for get_coupons
|
612
|
-
# List Coupons
|
613
|
-
#
|
756
|
+
# List Coupons (with total count)
|
614
757
|
# @param application_id
|
615
758
|
# @param campaign_id
|
616
759
|
# @param [Hash] opts the optional parameters
|
@@ -618,19 +761,19 @@ describe 'ManagementApi' do
|
|
618
761
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
619
762
|
# @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.
|
620
763
|
# @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.
|
621
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
622
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
623
|
-
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
624
|
-
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
625
|
-
# @option opts [DateTime] :expires_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
626
|
-
# @option opts [DateTime] :expires_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
764
|
+
# @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.
|
765
|
+
# @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.
|
766
|
+
# @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.
|
767
|
+
# @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.
|
768
|
+
# @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.
|
769
|
+
# @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.
|
627
770
|
# @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.
|
628
771
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
629
772
|
# @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`.
|
630
773
|
# @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.
|
631
774
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
632
|
-
# @option opts [
|
633
|
-
# @return [
|
775
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
776
|
+
# @return [InlineResponse2004]
|
634
777
|
describe 'get_coupons test' do
|
635
778
|
it 'should work' do
|
636
779
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -648,15 +791,15 @@ describe 'ManagementApi' do
|
|
648
791
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
649
792
|
# @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.
|
650
793
|
# @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.
|
651
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
652
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
794
|
+
# @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.
|
795
|
+
# @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.
|
653
796
|
# @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.
|
654
797
|
# @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`.
|
655
798
|
# @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.
|
656
799
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
657
|
-
# @option opts [
|
800
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
658
801
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
659
|
-
# @return [
|
802
|
+
# @return [InlineResponse2004]
|
660
803
|
describe 'get_coupons_by_attributes test' do
|
661
804
|
it 'should work' do
|
662
805
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -664,7 +807,7 @@ describe 'ManagementApi' do
|
|
664
807
|
end
|
665
808
|
|
666
809
|
# unit tests for get_coupons_by_attributes_application_wide
|
667
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
810
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
668
811
|
# Gets a list of all the coupons with attributes matching the query criteria Application wide
|
669
812
|
# @param application_id
|
670
813
|
# @param body
|
@@ -673,16 +816,16 @@ describe 'ManagementApi' do
|
|
673
816
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
674
817
|
# @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.
|
675
818
|
# @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.
|
676
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
677
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
819
|
+
# @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.
|
820
|
+
# @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.
|
678
821
|
# @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.
|
679
822
|
# @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`.
|
680
823
|
# @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.
|
681
824
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
682
825
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
683
|
-
# @option opts [
|
826
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
684
827
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
685
|
-
# @return [
|
828
|
+
# @return [InlineResponse2004]
|
686
829
|
describe 'get_coupons_by_attributes_application_wide test' do
|
687
830
|
it 'should work' do
|
688
831
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -691,7 +834,6 @@ describe 'ManagementApi' do
|
|
691
834
|
|
692
835
|
# unit tests for get_coupons_without_total_count
|
693
836
|
# List Coupons
|
694
|
-
#
|
695
837
|
# @param application_id
|
696
838
|
# @param campaign_id
|
697
839
|
# @param [Hash] opts the optional parameters
|
@@ -699,14 +841,14 @@ describe 'ManagementApi' do
|
|
699
841
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
700
842
|
# @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.
|
701
843
|
# @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.
|
702
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
703
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
844
|
+
# @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.
|
845
|
+
# @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.
|
704
846
|
# @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.
|
705
847
|
# @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`.
|
706
848
|
# @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.
|
707
849
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
708
850
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
709
|
-
# @option opts [
|
851
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
710
852
|
# @return [InlineResponse2005]
|
711
853
|
describe 'get_coupons_without_total_count test' do
|
712
854
|
it 'should work' do
|
@@ -732,7 +874,7 @@ describe 'ManagementApi' do
|
|
732
874
|
end
|
733
875
|
|
734
876
|
# unit tests for get_customer_activity_reports
|
735
|
-
# Get Activity Reports for Application Customers
|
877
|
+
# Get Activity Reports for Application Customers (with total count)
|
736
878
|
# Fetch summary reports for all application customers based on a time range
|
737
879
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
738
880
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -791,8 +933,6 @@ describe 'ManagementApi' do
|
|
791
933
|
|
792
934
|
# unit tests for get_customer_profile
|
793
935
|
# Get Customer Profile
|
794
|
-
#
|
795
|
-
# @param application_id
|
796
936
|
# @param customer_id
|
797
937
|
# @param [Hash] opts the optional parameters
|
798
938
|
# @return [ApplicationCustomer]
|
@@ -804,7 +944,6 @@ describe 'ManagementApi' do
|
|
804
944
|
|
805
945
|
# unit tests for get_customer_profiles
|
806
946
|
# List Customer Profiles
|
807
|
-
#
|
808
947
|
# @param [Hash] opts the optional parameters
|
809
948
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
810
949
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -835,11 +974,11 @@ describe 'ManagementApi' do
|
|
835
974
|
# @param [Hash] opts the optional parameters
|
836
975
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
837
976
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
838
|
-
# @option opts [
|
977
|
+
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
839
978
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
840
979
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
841
980
|
# @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.
|
842
|
-
# @return [
|
981
|
+
# @return [InlineResponse20026]
|
843
982
|
describe 'get_event_types test' do
|
844
983
|
it 'should work' do
|
845
984
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -855,26 +994,13 @@ describe 'ManagementApi' do
|
|
855
994
|
# @option opts [Integer] :application_id
|
856
995
|
# @option opts [Integer] :campaign_id
|
857
996
|
# @option opts [String] :entity The name of the entity type that was exported.
|
858
|
-
# @return [
|
997
|
+
# @return [InlineResponse20029]
|
859
998
|
describe 'get_exports test' do
|
860
999
|
it 'should work' do
|
861
1000
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
862
1001
|
end
|
863
1002
|
end
|
864
1003
|
|
865
|
-
# unit tests for get_imports
|
866
|
-
# Get Imports
|
867
|
-
# Get a list of all past imports
|
868
|
-
# @param [Hash] opts the optional parameters
|
869
|
-
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
870
|
-
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
871
|
-
# @return [InlineResponse20028]
|
872
|
-
describe 'get_imports test' do
|
873
|
-
it 'should work' do
|
874
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
875
|
-
end
|
876
|
-
end
|
877
|
-
|
878
1004
|
# unit tests for get_loyalty_points
|
879
1005
|
# get the Loyalty Ledger for this integrationID
|
880
1006
|
# Get the Loyalty Ledger for this profile integration ID.
|
@@ -890,7 +1016,6 @@ describe 'ManagementApi' do
|
|
890
1016
|
|
891
1017
|
# unit tests for get_loyalty_program
|
892
1018
|
# Get a loyalty program
|
893
|
-
#
|
894
1019
|
# @param program_id
|
895
1020
|
# @param [Hash] opts the optional parameters
|
896
1021
|
# @return [LoyaltyProgram]
|
@@ -902,7 +1027,6 @@ describe 'ManagementApi' do
|
|
902
1027
|
|
903
1028
|
# unit tests for get_loyalty_programs
|
904
1029
|
# List all loyalty Programs
|
905
|
-
#
|
906
1030
|
# @param [Hash] opts the optional parameters
|
907
1031
|
# @return [InlineResponse2008]
|
908
1032
|
describe 'get_loyalty_programs test' do
|
@@ -911,9 +1035,19 @@ describe 'ManagementApi' do
|
|
911
1035
|
end
|
912
1036
|
end
|
913
1037
|
|
1038
|
+
# unit tests for get_loyalty_statistics
|
1039
|
+
# Get loyalty program statistics by loyalty program ID
|
1040
|
+
# @param program_id
|
1041
|
+
# @param [Hash] opts the optional parameters
|
1042
|
+
# @return [LoyaltyStatistics]
|
1043
|
+
describe 'get_loyalty_statistics test' do
|
1044
|
+
it 'should work' do
|
1045
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1046
|
+
end
|
1047
|
+
end
|
1048
|
+
|
914
1049
|
# unit tests for get_referrals
|
915
|
-
# List Referrals
|
916
|
-
#
|
1050
|
+
# List Referrals (with total count)
|
917
1051
|
# @param application_id
|
918
1052
|
# @param campaign_id
|
919
1053
|
# @param [Hash] opts the optional parameters
|
@@ -921,8 +1055,8 @@ describe 'ManagementApi' do
|
|
921
1055
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
922
1056
|
# @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.
|
923
1057
|
# @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.
|
924
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
|
925
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
|
1058
|
+
# @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.
|
1059
|
+
# @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.
|
926
1060
|
# @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.
|
927
1061
|
# @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`.
|
928
1062
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
@@ -935,7 +1069,6 @@ describe 'ManagementApi' do
|
|
935
1069
|
|
936
1070
|
# unit tests for get_referrals_without_total_count
|
937
1071
|
# List Referrals
|
938
|
-
#
|
939
1072
|
# @param application_id
|
940
1073
|
# @param campaign_id
|
941
1074
|
# @param [Hash] opts the optional parameters
|
@@ -943,8 +1076,8 @@ describe 'ManagementApi' do
|
|
943
1076
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
944
1077
|
# @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.
|
945
1078
|
# @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.
|
946
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
|
947
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp.
|
1079
|
+
# @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.
|
1080
|
+
# @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.
|
948
1081
|
# @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.
|
949
1082
|
# @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`.
|
950
1083
|
# @option opts [String] :advocate Filter results by match with a profile id specified in the referral's AdvocateProfileIntegrationId field
|
@@ -956,7 +1089,7 @@ describe 'ManagementApi' do
|
|
956
1089
|
end
|
957
1090
|
|
958
1091
|
# unit tests for get_role
|
959
|
-
# Get information for the specified role
|
1092
|
+
# Get information for the specified role
|
960
1093
|
# @param role_id
|
961
1094
|
# @param [Hash] opts the optional parameters
|
962
1095
|
# @return [Role]
|
@@ -968,7 +1101,6 @@ describe 'ManagementApi' do
|
|
968
1101
|
|
969
1102
|
# unit tests for get_ruleset
|
970
1103
|
# Get a Ruleset
|
971
|
-
#
|
972
1104
|
# @param application_id
|
973
1105
|
# @param campaign_id
|
974
1106
|
# @param ruleset_id
|
@@ -982,14 +1114,13 @@ describe 'ManagementApi' do
|
|
982
1114
|
|
983
1115
|
# unit tests for get_rulesets
|
984
1116
|
# List Campaign Rulesets
|
985
|
-
#
|
986
1117
|
# @param application_id
|
987
1118
|
# @param campaign_id
|
988
1119
|
# @param [Hash] opts the optional parameters
|
989
1120
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
990
1121
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
991
1122
|
# @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.
|
992
|
-
# @return [
|
1123
|
+
# @return [InlineResponse2003]
|
993
1124
|
describe 'get_rulesets test' do
|
994
1125
|
it 'should work' do
|
995
1126
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1015,7 +1146,7 @@ describe 'ManagementApi' do
|
|
1015
1146
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1016
1147
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1017
1148
|
# @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.
|
1018
|
-
# @return [
|
1149
|
+
# @return [InlineResponse20027]
|
1019
1150
|
describe 'get_users test' do
|
1020
1151
|
it 'should work' do
|
1021
1152
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1045,9 +1176,9 @@ describe 'ManagementApi' do
|
|
1045
1176
|
# @option opts [Float] :webhook_id Filter results by Webhook.
|
1046
1177
|
# @option opts [Float] :application_id
|
1047
1178
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1048
|
-
# @option opts [DateTime] :created_before Only return events created before this date.
|
1049
|
-
# @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.
|
1050
|
-
# @return [
|
1179
|
+
# @option opts [DateTime] :created_before Only return events created before this date. You can use any timezone. Talon.One will convert to UTC internally.
|
1180
|
+
# @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.
|
1181
|
+
# @return [InlineResponse20024]
|
1051
1182
|
describe 'get_webhook_activation_logs test' do
|
1052
1183
|
it 'should work' do
|
1053
1184
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1056,7 +1187,6 @@ describe 'ManagementApi' do
|
|
1056
1187
|
|
1057
1188
|
# unit tests for get_webhook_logs
|
1058
1189
|
# List Webhook Log Entries
|
1059
|
-
#
|
1060
1190
|
# @param [Hash] opts the optional parameters
|
1061
1191
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1062
1192
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1066,9 +1196,9 @@ describe 'ManagementApi' do
|
|
1066
1196
|
# @option opts [Float] :application_id
|
1067
1197
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1068
1198
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1069
|
-
# @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.
|
1070
|
-
# @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.
|
1071
|
-
# @return [
|
1199
|
+
# @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.
|
1200
|
+
# @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.
|
1201
|
+
# @return [InlineResponse20025]
|
1072
1202
|
describe 'get_webhook_logs test' do
|
1073
1203
|
it 'should work' do
|
1074
1204
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1077,33 +1207,20 @@ describe 'ManagementApi' do
|
|
1077
1207
|
|
1078
1208
|
# unit tests for get_webhooks
|
1079
1209
|
# List Webhooks
|
1080
|
-
#
|
1081
1210
|
# @param [Hash] opts the optional parameters
|
1082
1211
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
1083
1212
|
# @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.
|
1084
1213
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1085
1214
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1086
|
-
# @return [
|
1215
|
+
# @return [InlineResponse20023]
|
1087
1216
|
describe 'get_webhooks test' do
|
1088
1217
|
it 'should work' do
|
1089
1218
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1090
1219
|
end
|
1091
1220
|
end
|
1092
1221
|
|
1093
|
-
# unit tests for refresh_analytics
|
1094
|
-
# Trigger refresh on stale analytics.
|
1095
|
-
# Should be used to trigger a manual refresh of analytics.
|
1096
|
-
# @param [Hash] opts the optional parameters
|
1097
|
-
# @return [nil]
|
1098
|
-
describe 'refresh_analytics test' do
|
1099
|
-
it 'should work' do
|
1100
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1101
|
-
end
|
1102
|
-
end
|
1103
|
-
|
1104
1222
|
# unit tests for remove_loyalty_points
|
1105
1223
|
# Deduct points in a certain loyalty program for the specified customer
|
1106
|
-
#
|
1107
1224
|
# @param program_id
|
1108
1225
|
# @param integration_id
|
1109
1226
|
# @param body
|
@@ -1128,7 +1245,7 @@ describe 'ManagementApi' do
|
|
1128
1245
|
end
|
1129
1246
|
|
1130
1247
|
# unit tests for search_coupons_advanced
|
1131
|
-
# Get a list of the coupons that match the given attributes
|
1248
|
+
# Get a list of the coupons that match the given attributes (with total count)
|
1132
1249
|
# Gets a list of all the coupons with attributes matching the query criteria
|
1133
1250
|
# @param application_id
|
1134
1251
|
# @param campaign_id
|
@@ -1138,15 +1255,15 @@ describe 'ManagementApi' do
|
|
1138
1255
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1139
1256
|
# @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.
|
1140
1257
|
# @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.
|
1141
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1142
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1258
|
+
# @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.
|
1259
|
+
# @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.
|
1143
1260
|
# @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.
|
1144
1261
|
# @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`.
|
1145
1262
|
# @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.
|
1146
1263
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1147
|
-
# @option opts [
|
1264
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1148
1265
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1149
|
-
# @return [
|
1266
|
+
# @return [InlineResponse2004]
|
1150
1267
|
describe 'search_coupons_advanced test' do
|
1151
1268
|
it 'should work' do
|
1152
1269
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1154,7 +1271,7 @@ describe 'ManagementApi' do
|
|
1154
1271
|
end
|
1155
1272
|
|
1156
1273
|
# unit tests for search_coupons_advanced_application_wide
|
1157
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
1274
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
1158
1275
|
# Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
1159
1276
|
# @param application_id
|
1160
1277
|
# @param body
|
@@ -1163,16 +1280,16 @@ describe 'ManagementApi' do
|
|
1163
1280
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1164
1281
|
# @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.
|
1165
1282
|
# @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.
|
1166
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1167
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1283
|
+
# @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.
|
1284
|
+
# @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.
|
1168
1285
|
# @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.
|
1169
1286
|
# @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`.
|
1170
1287
|
# @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.
|
1171
1288
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1172
1289
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1173
|
-
# @option opts [
|
1290
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1174
1291
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1175
|
-
# @return [
|
1292
|
+
# @return [InlineResponse2004]
|
1176
1293
|
describe 'search_coupons_advanced_application_wide test' do
|
1177
1294
|
it 'should work' do
|
1178
1295
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1189,14 +1306,14 @@ describe 'ManagementApi' do
|
|
1189
1306
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1190
1307
|
# @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.
|
1191
1308
|
# @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.
|
1192
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1193
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1309
|
+
# @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.
|
1310
|
+
# @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.
|
1194
1311
|
# @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.
|
1195
1312
|
# @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`.
|
1196
1313
|
# @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.
|
1197
1314
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1198
1315
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1199
|
-
# @option opts [
|
1316
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1200
1317
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1201
1318
|
# @return [InlineResponse2005]
|
1202
1319
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
@@ -1216,13 +1333,13 @@ describe 'ManagementApi' do
|
|
1216
1333
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1217
1334
|
# @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.
|
1218
1335
|
# @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.
|
1219
|
-
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1220
|
-
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
1336
|
+
# @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.
|
1337
|
+
# @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.
|
1221
1338
|
# @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.
|
1222
1339
|
# @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`.
|
1223
1340
|
# @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.
|
1224
1341
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1225
|
-
# @option opts [
|
1342
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1226
1343
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1227
1344
|
# @return [InlineResponse2005]
|
1228
1345
|
describe 'search_coupons_advanced_without_total_count test' do
|
@@ -1231,6 +1348,19 @@ describe 'ManagementApi' do
|
|
1231
1348
|
end
|
1232
1349
|
end
|
1233
1350
|
|
1351
|
+
# unit tests for update_additional_cost
|
1352
|
+
# Update an additional cost
|
1353
|
+
# 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.
|
1354
|
+
# @param additional_cost_id
|
1355
|
+
# @param body
|
1356
|
+
# @param [Hash] opts the optional parameters
|
1357
|
+
# @return [AccountAdditionalCost]
|
1358
|
+
describe 'update_additional_cost test' do
|
1359
|
+
it 'should work' do
|
1360
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1361
|
+
end
|
1362
|
+
end
|
1363
|
+
|
1234
1364
|
# unit tests for update_attribute
|
1235
1365
|
# Update a custom attribute
|
1236
1366
|
# 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.
|
@@ -1246,7 +1376,6 @@ describe 'ManagementApi' do
|
|
1246
1376
|
|
1247
1377
|
# unit tests for update_campaign
|
1248
1378
|
# Update a Campaign
|
1249
|
-
#
|
1250
1379
|
# @param application_id
|
1251
1380
|
# @param campaign_id
|
1252
1381
|
# @param body
|
@@ -1258,22 +1387,8 @@ describe 'ManagementApi' do
|
|
1258
1387
|
end
|
1259
1388
|
end
|
1260
1389
|
|
1261
|
-
# unit tests for update_campaign_set
|
1262
|
-
# Update a Campaign Set
|
1263
|
-
#
|
1264
|
-
# @param application_id
|
1265
|
-
# @param body
|
1266
|
-
# @param [Hash] opts the optional parameters
|
1267
|
-
# @return [CampaignSet]
|
1268
|
-
describe 'update_campaign_set test' do
|
1269
|
-
it 'should work' do
|
1270
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1271
|
-
end
|
1272
|
-
end
|
1273
|
-
|
1274
1390
|
# unit tests for update_coupon
|
1275
1391
|
# Update a Coupon
|
1276
|
-
#
|
1277
1392
|
# @param application_id
|
1278
1393
|
# @param campaign_id
|
1279
1394
|
# @param coupon_id The ID of the coupon code to update
|
@@ -1288,7 +1403,6 @@ describe 'ManagementApi' do
|
|
1288
1403
|
|
1289
1404
|
# unit tests for update_coupon_batch
|
1290
1405
|
# Update a Batch of Coupons
|
1291
|
-
#
|
1292
1406
|
# @param application_id
|
1293
1407
|
# @param campaign_id
|
1294
1408
|
# @param body
|
@@ -1302,7 +1416,6 @@ describe 'ManagementApi' do
|
|
1302
1416
|
|
1303
1417
|
# unit tests for update_ruleset
|
1304
1418
|
# Update a Ruleset
|
1305
|
-
#
|
1306
1419
|
# @param application_id
|
1307
1420
|
# @param campaign_id
|
1308
1421
|
# @param ruleset_id
|