talon_one 1.3.0 → 2.2.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 +196 -30
- 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 -14
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -11
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +29 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +33 -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 +17 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +46 -3
- data/docs/CampaignCopy.md +19 -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 +21 -1
- data/docs/CartItemAdjustment.md +11 -0
- data/docs/Change.md +16 -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 +23 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +19 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +23 -0
- data/docs/Effect.md +27 -0
- data/docs/EffectEntity.md +25 -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 +14 -0
- data/docs/ImportCoupons.md +9 -0
- 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 +11 -1
- 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 +12 -3
- data/docs/InlineResponse20026.md +11 -1
- data/docs/InlineResponse20027.md +14 -2
- data/docs/InlineResponse20028.md +11 -1
- data/docs/InlineResponse20029.md +19 -0
- 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 +327 -72
- 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 +35 -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 +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +927 -853
- 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 +29 -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 +20 -1
- 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/NewImport.md +9 -0
- 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 +21 -3
- 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/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 +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/Rule.md +13 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +24 -6
- data/docs/SamlConnectionMetadata.md +23 -0
- 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 +28 -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 +88 -35
- data/lib/talon_one/api/integration_api.rb +518 -138
- data/lib/talon_one/api/management_api.rb +2328 -1477
- 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 +151 -68
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -45
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +293 -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 +131 -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 +48 -25
- 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 +222 -0
- data/lib/talon_one/models/attributes_settings.rb +207 -0
- 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 +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +93 -58
- data/lib/talon_one/models/campaign_analytics.rb +223 -50
- data/lib/talon_one/models/campaign_copy.rb +86 -21
- 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 +49 -26
- data/lib/talon_one/models/cart_item_adjustment.rb +43 -20
- data/lib/talon_one/models/change.rb +46 -23
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +41 -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 +237 -0
- 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 +242 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +60 -37
- data/lib/talon_one/models/customer_session_v2.rb +447 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +258 -0
- data/lib/talon_one/models/effect.rb +287 -0
- data/lib/talon_one/models/effect_entity.rb +273 -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 +48 -25
- data/lib/talon_one/models/import_coupons.rb +38 -15
- 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_response20012.rb +231 -0
- 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_response_200_12.rb → inline_response20020.rb} +42 -19
- data/lib/talon_one/models/inline_response20021.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20022.rb} +41 -18
- 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} +44 -21
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +41 -18
- 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_28.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 +313 -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 +43 -20
- 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 +59 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +39 -16
- data/lib/talon_one/models/loyalty_program_ledgers.rb +43 -21
- 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/multiple_customer_profile_integration_request.rb +208 -0
- 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 +138 -48
- 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 +89 -32
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +50 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +322 -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_import.rb +41 -18
- 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 +105 -67
- 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/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 +228 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +228 -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_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +93 -103
- data/lib/talon_one/models/saml_connection_metadata.rb +294 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +265 -0
- 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 +135 -29
- 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 +76 -15
- data/spec/api/management_api_spec.rb +155 -143
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{misc_update_user_latest_feature_spec.rb → accept_coupon_effect_props_spec.rb} +11 -11
- 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 +33 -9
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -4
- 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 +77 -0
- data/spec/models/additional_cost_spec.rb +41 -0
- 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 +4 -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 +43 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- 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 +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +64 -4
- data/spec/models/campaign_copy_spec.rb +28 -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 +10 -4
- data/spec/models/cart_item_adjustment_spec.rb +4 -4
- data/spec/models/cart_item_spec.rb +4 -4
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +4 -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 +59 -0
- 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 +51 -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 +59 -0
- data/spec/models/effect_entity_spec.rb +65 -0
- data/spec/models/effect_spec.rb +71 -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_coupons_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -4
- 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 -10
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -4
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +10 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +4 -4
- data/spec/models/inline_response20029_spec.rb +47 -0
- 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 +95 -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 -4
- 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 +4 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +4 -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 +48 -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_spec.rb +10 -4
- 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_import_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 +17 -11
- 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/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 +47 -0
- data/spec/models/reject_referral_effect_props_spec.rb +47 -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_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -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 +59 -0
- data/spec/models/saml_connection_spec.rb +13 -19
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/set_discount_effect_props_spec.rb +53 -0
- 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 +48 -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 +314 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/MiscUpdateUserLatestFeature.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/inline_response_200_16.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/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.2.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
|
|
@@ -82,13 +82,17 @@ describe 'IntegrationApi' do
|
|
82
82
|
end
|
83
83
|
end
|
84
84
|
|
85
|
-
# unit tests for
|
86
|
-
# Get all
|
87
|
-
#
|
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, 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
|
-
# @
|
91
|
-
|
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
|
94
|
+
# @return [CustomerInventory]
|
95
|
+
describe 'get_customer_inventory test' do
|
92
96
|
it 'should work' do
|
93
97
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
94
98
|
end
|
@@ -111,6 +115,7 @@ describe 'IntegrationApi' do
|
|
111
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.
|
112
116
|
# @param body
|
113
117
|
# @param [Hash] opts the optional parameters
|
118
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
114
119
|
# @return [IntegrationState]
|
115
120
|
describe 'track_event test' do
|
116
121
|
it 'should work' do
|
@@ -119,11 +124,12 @@ describe 'IntegrationApi' do
|
|
119
124
|
end
|
120
125
|
|
121
126
|
# unit tests for update_customer_profile
|
122
|
-
# Update a Customer Profile
|
123
|
-
# Update (or create) a [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
|
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, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [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
|
124
129
|
# @param integration_id The custom identifier for this profile, must be unique within the account.
|
125
130
|
# @param body
|
126
131
|
# @param [Hash] opts the optional parameters
|
132
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
127
133
|
# @return [IntegrationState]
|
128
134
|
describe 'update_customer_profile test' do
|
129
135
|
it 'should work' do
|
@@ -131,12 +137,53 @@ describe 'IntegrationApi' do
|
|
131
137
|
end
|
132
138
|
end
|
133
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][]. 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. [Customer Profile]: /Getting-Started/entities#customer-profile
|
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 Flag to indicate whether to run the rule engine (Defaults to false).
|
159
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to '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][] in 1 request. 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. [Customer Profiles]: /Getting-Started/entities#customer-profile
|
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 the IntegrationStateV2 generated.
|
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
|
+
|
134
180
|
# unit tests for update_customer_session
|
135
|
-
# Update a Customer Session
|
136
|
-
# Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. 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. 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. [Customer Session]: /Getting-Started/entities#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, please migrate to [API V2.0](/Getting-Started/APIV2). Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. 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. 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. [Customer Session]: /Getting-Started/entities#customer-session
|
137
183
|
# @param customer_session_id The custom identifier for this session, must be unique within the account.
|
138
184
|
# @param body
|
139
185
|
# @param [Hash] opts the optional parameters
|
186
|
+
# @option opts [Boolean] :dry Flag to indicate whether to skip persisting the changes or not (Will not persist if set to 'true').
|
140
187
|
# @return [IntegrationState]
|
141
188
|
describe 'update_customer_session test' do
|
142
189
|
it 'should work' do
|
@@ -144,4 +191,18 @@ describe 'IntegrationApi' do
|
|
144
191
|
end
|
145
192
|
end
|
146
193
|
|
194
|
+
# unit tests for update_customer_session_v2
|
195
|
+
# Update a Customer Session
|
196
|
+
# Update (or create) a [Customer Session][]. For example, the items in a customers cart are part of a session. The Talon.One platform supports multiple simultaneous sessions for the same profile, so if you have multiple ways of accessing the same application you have the option of either tracking multiple independent sessions or using the same session across all of them. You should share sessions when application access points share other state, such as the users cart. If two points of access to the application have independent state (e.g. a user can have different items in their cart across the two) they should use independent customer session ID's. The `profileId` parameter in the request body should correspond to an `integrationId` for a customer profile, to track an anonymous session use the empty string (`\"\"`) as the `profileId`. Note that you do **not** need to create a customer profile first: if the specified profile does not yet exist, an empty profile will be created automatically. Updating a customer profile will return a response with the requested integration state. This includes the effects that were generated due to triggered campaigns, the created coupons and referral objects, as well as any entity that was requested in the request parameter \"responseContent\". 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. [Customer Session]: /Getting-Started/entities#customer-session
|
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 Flag to indicate 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
|
+
|
147
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,16 +52,39 @@ 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
|
+
|
74
|
+
# unit tests for create_attribute
|
75
|
+
# Define a new custom attribute
|
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.
|
77
|
+
# @param body
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [Attribute]
|
80
|
+
describe 'create_attribute test' do
|
81
|
+
it 'should work' do
|
82
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
63
86
|
# unit tests for create_campaign
|
64
87
|
# Create a Campaign
|
65
|
-
#
|
66
88
|
# @param application_id
|
67
89
|
# @param body
|
68
90
|
# @param [Hash] opts the optional parameters
|
@@ -75,13 +97,13 @@ describe 'ManagementApi' do
|
|
75
97
|
|
76
98
|
# unit tests for create_coupons
|
77
99
|
# Create Coupons
|
78
|
-
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000
|
100
|
+
# Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.
|
79
101
|
# @param application_id
|
80
102
|
# @param campaign_id
|
81
103
|
# @param body
|
82
104
|
# @param [Hash] opts the optional parameters
|
83
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).
|
84
|
-
# @return [
|
106
|
+
# @return [InlineResponse2004]
|
85
107
|
describe 'create_coupons test' do
|
86
108
|
it 'should work' do
|
87
109
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -102,7 +124,6 @@ describe 'ManagementApi' do
|
|
102
124
|
|
103
125
|
# unit tests for create_ruleset
|
104
126
|
# Create a Ruleset
|
105
|
-
#
|
106
127
|
# @param application_id
|
107
128
|
# @param campaign_id
|
108
129
|
# @param body
|
@@ -116,7 +137,6 @@ describe 'ManagementApi' do
|
|
116
137
|
|
117
138
|
# unit tests for create_session
|
118
139
|
# Create a Session
|
119
|
-
#
|
120
140
|
# @param body
|
121
141
|
# @param [Hash] opts the optional parameters
|
122
142
|
# @return [Session]
|
@@ -128,7 +148,6 @@ describe 'ManagementApi' do
|
|
128
148
|
|
129
149
|
# unit tests for delete_campaign
|
130
150
|
# Delete a Campaign
|
131
|
-
#
|
132
151
|
# @param application_id
|
133
152
|
# @param campaign_id
|
134
153
|
# @param [Hash] opts the optional parameters
|
@@ -141,7 +160,6 @@ describe 'ManagementApi' do
|
|
141
160
|
|
142
161
|
# unit tests for delete_coupon
|
143
162
|
# Delete one Coupon
|
144
|
-
#
|
145
163
|
# @param application_id
|
146
164
|
# @param campaign_id
|
147
165
|
# @param coupon_id The ID of the coupon code to delete
|
@@ -155,7 +173,6 @@ describe 'ManagementApi' do
|
|
155
173
|
|
156
174
|
# unit tests for delete_coupons
|
157
175
|
# Delete Coupons
|
158
|
-
#
|
159
176
|
# @param application_id
|
160
177
|
# @param campaign_id
|
161
178
|
# @param [Hash] opts the optional parameters
|
@@ -171,7 +188,7 @@ describe 'ManagementApi' do
|
|
171
188
|
# @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`.
|
172
189
|
# @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.
|
173
190
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
174
|
-
# @option opts [
|
191
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
175
192
|
# @return [nil]
|
176
193
|
describe 'delete_coupons test' do
|
177
194
|
it 'should work' do
|
@@ -181,7 +198,6 @@ describe 'ManagementApi' do
|
|
181
198
|
|
182
199
|
# unit tests for delete_referral
|
183
200
|
# Delete one Referral
|
184
|
-
#
|
185
201
|
# @param application_id
|
186
202
|
# @param campaign_id
|
187
203
|
# @param referral_id The ID of the referral code to delete
|
@@ -195,7 +211,6 @@ describe 'ManagementApi' do
|
|
195
211
|
|
196
212
|
# unit tests for delete_ruleset
|
197
213
|
# Delete a Ruleset
|
198
|
-
#
|
199
214
|
# @param application_id
|
200
215
|
# @param campaign_id
|
201
216
|
# @param ruleset_id
|
@@ -208,14 +223,13 @@ describe 'ManagementApi' do
|
|
208
223
|
end
|
209
224
|
|
210
225
|
# unit tests for get_access_logs
|
211
|
-
# Get access logs for application
|
212
|
-
#
|
226
|
+
# Get access logs for application (with total count)
|
213
227
|
# @param application_id
|
214
228
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
215
229
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
216
230
|
# @param [Hash] opts the optional parameters
|
217
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
218
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
231
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
232
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
219
233
|
# @option opts [String] :status Filter results by HTTP status codes.
|
220
234
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
221
235
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -229,13 +243,12 @@ describe 'ManagementApi' do
|
|
229
243
|
|
230
244
|
# unit tests for get_access_logs_without_total_count
|
231
245
|
# Get access logs for application
|
232
|
-
#
|
233
246
|
# @param application_id
|
234
247
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
235
248
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
236
249
|
# @param [Hash] opts the optional parameters
|
237
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
238
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
250
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
251
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
239
252
|
# @option opts [String] :status Filter results by HTTP status codes.
|
240
253
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
241
254
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -271,13 +284,27 @@ describe 'ManagementApi' do
|
|
271
284
|
end
|
272
285
|
end
|
273
286
|
|
274
|
-
# unit tests for
|
275
|
-
# Get
|
276
|
-
# Returns
|
277
|
-
# @param
|
287
|
+
# unit tests for get_additional_cost
|
288
|
+
# Get an additional cost
|
289
|
+
# Returns additional cost for the account by its id.
|
290
|
+
# @param additional_cost_id
|
278
291
|
# @param [Hash] opts the optional parameters
|
279
|
-
# @return [
|
280
|
-
describe '
|
292
|
+
# @return [AccountAdditionalCost]
|
293
|
+
describe 'get_additional_cost test' do
|
294
|
+
it 'should work' do
|
295
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
296
|
+
end
|
297
|
+
end
|
298
|
+
|
299
|
+
# unit tests for get_additional_costs
|
300
|
+
# List additional costs
|
301
|
+
# Returns all the defined additional costs for the account.
|
302
|
+
# @param [Hash] opts the optional parameters
|
303
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
304
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
305
|
+
# @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.
|
306
|
+
# @return [InlineResponse20021]
|
307
|
+
describe 'get_additional_costs test' do
|
281
308
|
it 'should work' do
|
282
309
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
283
310
|
end
|
@@ -289,8 +316,8 @@ describe 'ManagementApi' do
|
|
289
316
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
290
317
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
291
318
|
# @param [Hash] opts the optional parameters
|
292
|
-
# @option opts [String] :path Only return results where the request path matches the given regular
|
293
|
-
# @option opts [String] :method Only return results where the request method matches the given regular
|
319
|
+
# @option opts [String] :path Only return results where the request path matches the given regular expression.
|
320
|
+
# @option opts [String] :method Only return results where the request method matches the given regular expression.
|
294
321
|
# @option opts [String] :status Filter results by HTTP status codes.
|
295
322
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
296
323
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -305,7 +332,7 @@ describe 'ManagementApi' do
|
|
305
332
|
# unit tests for get_all_roles
|
306
333
|
# Get all roles.
|
307
334
|
# @param [Hash] opts the optional parameters
|
308
|
-
# @return [
|
335
|
+
# @return [InlineResponse20030]
|
309
336
|
describe 'get_all_roles test' do
|
310
337
|
it 'should work' do
|
311
338
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -326,7 +353,6 @@ describe 'ManagementApi' do
|
|
326
353
|
|
327
354
|
# unit tests for get_application_api_health
|
328
355
|
# Get report of health of application API
|
329
|
-
#
|
330
356
|
# @param application_id
|
331
357
|
# @param [Hash] opts the optional parameters
|
332
358
|
# @return [ApplicationApiHealth]
|
@@ -338,7 +364,6 @@ describe 'ManagementApi' do
|
|
338
364
|
|
339
365
|
# unit tests for get_application_customer
|
340
366
|
# Get Application Customer
|
341
|
-
#
|
342
367
|
# @param application_id
|
343
368
|
# @param customer_id
|
344
369
|
# @param [Hash] opts the optional parameters
|
@@ -351,9 +376,12 @@ describe 'ManagementApi' do
|
|
351
376
|
|
352
377
|
# unit tests for get_application_customers
|
353
378
|
# List Application Customers
|
354
|
-
#
|
355
379
|
# @param application_id
|
356
380
|
# @param [Hash] opts the optional parameters
|
381
|
+
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
382
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
383
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
384
|
+
# @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
385
|
# @return [InlineResponse20012]
|
358
386
|
describe 'get_application_customers test' do
|
359
387
|
it 'should work' do
|
@@ -362,8 +390,8 @@ describe 'ManagementApi' do
|
|
362
390
|
end
|
363
391
|
|
364
392
|
# unit tests for get_application_customers_by_attributes
|
365
|
-
# Get a list of the customer profiles that match the given attributes
|
366
|
-
# 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]:
|
393
|
+
# Get a list of the customer profiles that match the given attributes (with total count)
|
394
|
+
# 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
395
|
# @param body
|
368
396
|
# @param [Hash] opts the optional parameters
|
369
397
|
# @return [InlineResponse20013]
|
@@ -389,7 +417,7 @@ describe 'ManagementApi' do
|
|
389
417
|
end
|
390
418
|
|
391
419
|
# unit tests for get_application_events
|
392
|
-
# List Applications Events
|
420
|
+
# List Applications Events (with total count)
|
393
421
|
# Lists all events recorded for an application.
|
394
422
|
# @param application_id
|
395
423
|
# @param [Hash] opts the optional parameters
|
@@ -403,8 +431,8 @@ describe 'ManagementApi' do
|
|
403
431
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
404
432
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
405
433
|
# @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] :
|
434
|
+
# @option opts [String] :coupon_code Coupon code
|
435
|
+
# @option opts [String] :referral_code Referral code
|
408
436
|
# @option opts [String] :rule_query Rule name filter for events
|
409
437
|
# @option opts [String] :campaign_query Campaign name filter for events
|
410
438
|
# @return [InlineResponse20017]
|
@@ -429,8 +457,8 @@ describe 'ManagementApi' do
|
|
429
457
|
# @option opts [String] :profile Profile integration ID filter for events. Must be exact match.
|
430
458
|
# @option opts [String] :customer_name Customer name filter for events. Will match substrings case-insensitively.
|
431
459
|
# @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] :
|
460
|
+
# @option opts [String] :coupon_code Coupon code
|
461
|
+
# @option opts [String] :referral_code Referral code
|
434
462
|
# @option opts [String] :rule_query Rule name filter for events
|
435
463
|
# @option opts [String] :campaign_query Campaign name filter for events
|
436
464
|
# @return [InlineResponse20018]
|
@@ -442,7 +470,6 @@ describe 'ManagementApi' do
|
|
442
470
|
|
443
471
|
# unit tests for get_application_session
|
444
472
|
# Get Application Session
|
445
|
-
#
|
446
473
|
# @param application_id
|
447
474
|
# @param session_id
|
448
475
|
# @param [Hash] opts the optional parameters
|
@@ -455,7 +482,6 @@ describe 'ManagementApi' do
|
|
455
482
|
|
456
483
|
# unit tests for get_application_sessions
|
457
484
|
# List Application Sessions
|
458
|
-
#
|
459
485
|
# @param application_id
|
460
486
|
# @param [Hash] opts the optional parameters
|
461
487
|
# @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 +489,11 @@ describe 'ManagementApi' do
|
|
463
489
|
# @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
490
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
465
491
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
492
|
+
# @option opts [DateTime] :created_before Only return events created before this date
|
493
|
+
# @option opts [DateTime] :created_after Only return events created after this date
|
466
494
|
# @option opts [String] :coupon Filter by sessions with this coupon. Must be exact match.
|
495
|
+
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
496
|
+
# @option opts [String] :integration_id Filter by sessions with this integrationId. Must be exact match.
|
467
497
|
# @return [InlineResponse20016]
|
468
498
|
describe 'get_application_sessions test' do
|
469
499
|
it 'should work' do
|
@@ -478,7 +508,7 @@ describe 'ManagementApi' do
|
|
478
508
|
# @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
509
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
480
510
|
# @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 [
|
511
|
+
# @return [InlineResponse2001]
|
482
512
|
describe 'get_applications test' do
|
483
513
|
it 'should work' do
|
484
514
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -497,9 +527,22 @@ describe 'ManagementApi' do
|
|
497
527
|
end
|
498
528
|
end
|
499
529
|
|
530
|
+
# unit tests for get_attributes
|
531
|
+
# List custom attributes
|
532
|
+
# Returns all the defined custom attributes for the account.
|
533
|
+
# @param [Hash] opts the optional parameters
|
534
|
+
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
535
|
+
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
536
|
+
# @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.
|
537
|
+
# @return [InlineResponse20020]
|
538
|
+
describe 'get_attributes test' do
|
539
|
+
it 'should work' do
|
540
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
541
|
+
end
|
542
|
+
end
|
543
|
+
|
500
544
|
# unit tests for get_campaign
|
501
545
|
# Get a Campaign
|
502
|
-
#
|
503
546
|
# @param application_id
|
504
547
|
# @param campaign_id
|
505
548
|
# @param [Hash] opts the optional parameters
|
@@ -512,7 +555,6 @@ describe 'ManagementApi' do
|
|
512
555
|
|
513
556
|
# unit tests for get_campaign_analytics
|
514
557
|
# Get analytics of campaigns
|
515
|
-
#
|
516
558
|
# @param application_id
|
517
559
|
# @param campaign_id
|
518
560
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
@@ -536,28 +578,15 @@ describe 'ManagementApi' do
|
|
536
578
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
537
579
|
# @option opts [String] :sort The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
538
580
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
539
|
-
# @return [
|
581
|
+
# @return [InlineResponse2002]
|
540
582
|
describe 'get_campaign_by_attributes test' do
|
541
583
|
it 'should work' do
|
542
584
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
543
585
|
end
|
544
586
|
end
|
545
587
|
|
546
|
-
# unit tests for get_campaign_set
|
547
|
-
# List CampaignSet
|
548
|
-
#
|
549
|
-
# @param application_id
|
550
|
-
# @param [Hash] opts the optional parameters
|
551
|
-
# @return [CampaignSet]
|
552
|
-
describe 'get_campaign_set test' do
|
553
|
-
it 'should work' do
|
554
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
555
|
-
end
|
556
|
-
end
|
557
|
-
|
558
588
|
# unit tests for get_campaigns
|
559
589
|
# List your Campaigns
|
560
|
-
#
|
561
590
|
# @param application_id
|
562
591
|
# @param [Hash] opts the optional parameters
|
563
592
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -568,7 +597,8 @@ describe 'ManagementApi' do
|
|
568
597
|
# @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
|
569
598
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
570
599
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp.
|
571
|
-
# @
|
600
|
+
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign group ID.
|
601
|
+
# @return [InlineResponse2002]
|
572
602
|
describe 'get_campaigns test' do
|
573
603
|
it 'should work' do
|
574
604
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -585,9 +615,9 @@ describe 'ManagementApi' do
|
|
585
615
|
# @option opts [Integer] :application_id
|
586
616
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
587
617
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
588
|
-
# @option opts [
|
589
|
-
# @option opts [
|
590
|
-
# @return [
|
618
|
+
# @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.
|
619
|
+
# @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.
|
620
|
+
# @return [InlineResponse20027]
|
591
621
|
describe 'get_changes test' do
|
592
622
|
it 'should work' do
|
593
623
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -595,8 +625,7 @@ describe 'ManagementApi' do
|
|
595
625
|
end
|
596
626
|
|
597
627
|
# unit tests for get_coupons
|
598
|
-
# List Coupons
|
599
|
-
#
|
628
|
+
# List Coupons (with total count)
|
600
629
|
# @param application_id
|
601
630
|
# @param campaign_id
|
602
631
|
# @param [Hash] opts the optional parameters
|
@@ -615,8 +644,8 @@ describe 'ManagementApi' do
|
|
615
644
|
# @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`.
|
616
645
|
# @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.
|
617
646
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
618
|
-
# @option opts [
|
619
|
-
# @return [
|
647
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
648
|
+
# @return [InlineResponse2004]
|
620
649
|
describe 'get_coupons test' do
|
621
650
|
it 'should work' do
|
622
651
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -640,9 +669,9 @@ describe 'ManagementApi' do
|
|
640
669
|
# @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`.
|
641
670
|
# @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.
|
642
671
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
643
|
-
# @option opts [
|
672
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
644
673
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
645
|
-
# @return [
|
674
|
+
# @return [InlineResponse2004]
|
646
675
|
describe 'get_coupons_by_attributes test' do
|
647
676
|
it 'should work' do
|
648
677
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -650,7 +679,7 @@ describe 'ManagementApi' do
|
|
650
679
|
end
|
651
680
|
|
652
681
|
# unit tests for get_coupons_by_attributes_application_wide
|
653
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
682
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
654
683
|
# Gets a list of all the coupons with attributes matching the query criteria Application wide
|
655
684
|
# @param application_id
|
656
685
|
# @param body
|
@@ -666,9 +695,9 @@ describe 'ManagementApi' do
|
|
666
695
|
# @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.
|
667
696
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
668
697
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
669
|
-
# @option opts [
|
698
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
670
699
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
671
|
-
# @return [
|
700
|
+
# @return [InlineResponse2004]
|
672
701
|
describe 'get_coupons_by_attributes_application_wide test' do
|
673
702
|
it 'should work' do
|
674
703
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -677,7 +706,6 @@ describe 'ManagementApi' do
|
|
677
706
|
|
678
707
|
# unit tests for get_coupons_without_total_count
|
679
708
|
# List Coupons
|
680
|
-
#
|
681
709
|
# @param application_id
|
682
710
|
# @param campaign_id
|
683
711
|
# @param [Hash] opts the optional parameters
|
@@ -692,7 +720,7 @@ describe 'ManagementApi' do
|
|
692
720
|
# @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.
|
693
721
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
694
722
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
695
|
-
# @option opts [
|
723
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
696
724
|
# @return [InlineResponse2005]
|
697
725
|
describe 'get_coupons_without_total_count test' do
|
698
726
|
it 'should work' do
|
@@ -718,7 +746,7 @@ describe 'ManagementApi' do
|
|
718
746
|
end
|
719
747
|
|
720
748
|
# unit tests for get_customer_activity_reports
|
721
|
-
# Get Activity Reports for Application Customers
|
749
|
+
# Get Activity Reports for Application Customers (with total count)
|
722
750
|
# Fetch summary reports for all application customers based on a time range
|
723
751
|
# @param range_start Only return results from after this timestamp, must be an RFC3339 timestamp string
|
724
752
|
# @param range_end Only return results from before this timestamp, must be an RFC3339 timestamp string
|
@@ -777,8 +805,6 @@ describe 'ManagementApi' do
|
|
777
805
|
|
778
806
|
# unit tests for get_customer_profile
|
779
807
|
# Get Customer Profile
|
780
|
-
#
|
781
|
-
# @param application_id
|
782
808
|
# @param customer_id
|
783
809
|
# @param [Hash] opts the optional parameters
|
784
810
|
# @return [ApplicationCustomer]
|
@@ -790,7 +816,6 @@ describe 'ManagementApi' do
|
|
790
816
|
|
791
817
|
# unit tests for get_customer_profiles
|
792
818
|
# List Customer Profiles
|
793
|
-
#
|
794
819
|
# @param [Hash] opts the optional parameters
|
795
820
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
796
821
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -803,7 +828,7 @@ describe 'ManagementApi' do
|
|
803
828
|
|
804
829
|
# unit tests for get_customers_by_attributes
|
805
830
|
# Get a list of the customer profiles that match the given attributes
|
806
|
-
# 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]:
|
831
|
+
# 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
|
807
832
|
# @param body
|
808
833
|
# @param [Hash] opts the optional parameters
|
809
834
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
@@ -821,11 +846,11 @@ describe 'ManagementApi' do
|
|
821
846
|
# @param [Hash] opts the optional parameters
|
822
847
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
823
848
|
# @option opts [String] :name Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
824
|
-
# @option opts [
|
849
|
+
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
825
850
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
826
851
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
827
852
|
# @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.
|
828
|
-
# @return [
|
853
|
+
# @return [InlineResponse20025]
|
829
854
|
describe 'get_event_types test' do
|
830
855
|
it 'should work' do
|
831
856
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -841,7 +866,7 @@ describe 'ManagementApi' do
|
|
841
866
|
# @option opts [Integer] :application_id
|
842
867
|
# @option opts [Integer] :campaign_id
|
843
868
|
# @option opts [String] :entity The name of the entity type that was exported.
|
844
|
-
# @return [
|
869
|
+
# @return [InlineResponse20028]
|
845
870
|
describe 'get_exports test' do
|
846
871
|
it 'should work' do
|
847
872
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -854,7 +879,7 @@ describe 'ManagementApi' do
|
|
854
879
|
# @param [Hash] opts the optional parameters
|
855
880
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
856
881
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
857
|
-
# @return [
|
882
|
+
# @return [InlineResponse20029]
|
858
883
|
describe 'get_imports test' do
|
859
884
|
it 'should work' do
|
860
885
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -876,7 +901,6 @@ describe 'ManagementApi' do
|
|
876
901
|
|
877
902
|
# unit tests for get_loyalty_program
|
878
903
|
# Get a loyalty program
|
879
|
-
#
|
880
904
|
# @param program_id
|
881
905
|
# @param [Hash] opts the optional parameters
|
882
906
|
# @return [LoyaltyProgram]
|
@@ -888,7 +912,6 @@ describe 'ManagementApi' do
|
|
888
912
|
|
889
913
|
# unit tests for get_loyalty_programs
|
890
914
|
# List all loyalty Programs
|
891
|
-
#
|
892
915
|
# @param [Hash] opts the optional parameters
|
893
916
|
# @return [InlineResponse2008]
|
894
917
|
describe 'get_loyalty_programs test' do
|
@@ -897,9 +920,19 @@ describe 'ManagementApi' do
|
|
897
920
|
end
|
898
921
|
end
|
899
922
|
|
923
|
+
# unit tests for get_loyalty_statistics
|
924
|
+
# Get loyalty program statistics by loyalty program ID
|
925
|
+
# @param program_id
|
926
|
+
# @param [Hash] opts the optional parameters
|
927
|
+
# @return [LoyaltyStatistics]
|
928
|
+
describe 'get_loyalty_statistics test' do
|
929
|
+
it 'should work' do
|
930
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
931
|
+
end
|
932
|
+
end
|
933
|
+
|
900
934
|
# unit tests for get_referrals
|
901
|
-
# List Referrals
|
902
|
-
#
|
935
|
+
# List Referrals (with total count)
|
903
936
|
# @param application_id
|
904
937
|
# @param campaign_id
|
905
938
|
# @param [Hash] opts the optional parameters
|
@@ -921,7 +954,6 @@ describe 'ManagementApi' do
|
|
921
954
|
|
922
955
|
# unit tests for get_referrals_without_total_count
|
923
956
|
# List Referrals
|
924
|
-
#
|
925
957
|
# @param application_id
|
926
958
|
# @param campaign_id
|
927
959
|
# @param [Hash] opts the optional parameters
|
@@ -954,7 +986,6 @@ describe 'ManagementApi' do
|
|
954
986
|
|
955
987
|
# unit tests for get_ruleset
|
956
988
|
# Get a Ruleset
|
957
|
-
#
|
958
989
|
# @param application_id
|
959
990
|
# @param campaign_id
|
960
991
|
# @param ruleset_id
|
@@ -968,14 +999,13 @@ describe 'ManagementApi' do
|
|
968
999
|
|
969
1000
|
# unit tests for get_rulesets
|
970
1001
|
# List Campaign Rulesets
|
971
|
-
#
|
972
1002
|
# @param application_id
|
973
1003
|
# @param campaign_id
|
974
1004
|
# @param [Hash] opts the optional parameters
|
975
1005
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
976
1006
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
977
1007
|
# @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.
|
978
|
-
# @return [
|
1008
|
+
# @return [InlineResponse2003]
|
979
1009
|
describe 'get_rulesets test' do
|
980
1010
|
it 'should work' do
|
981
1011
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1001,7 +1031,7 @@ describe 'ManagementApi' do
|
|
1001
1031
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1002
1032
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1003
1033
|
# @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.
|
1004
|
-
# @return [
|
1034
|
+
# @return [InlineResponse20026]
|
1005
1035
|
describe 'get_users test' do
|
1006
1036
|
it 'should work' do
|
1007
1037
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1033,7 +1063,7 @@ describe 'ManagementApi' do
|
|
1033
1063
|
# @option opts [Float] :campaign_id Filter results by campaign.
|
1034
1064
|
# @option opts [DateTime] :created_before Only return events created before this date.
|
1035
1065
|
# @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.
|
1036
|
-
# @return [
|
1066
|
+
# @return [InlineResponse20023]
|
1037
1067
|
describe 'get_webhook_activation_logs test' do
|
1038
1068
|
it 'should work' do
|
1039
1069
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1042,7 +1072,6 @@ describe 'ManagementApi' do
|
|
1042
1072
|
|
1043
1073
|
# unit tests for get_webhook_logs
|
1044
1074
|
# List Webhook Log Entries
|
1045
|
-
#
|
1046
1075
|
# @param [Hash] opts the optional parameters
|
1047
1076
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1048
1077
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
@@ -1054,7 +1083,7 @@ describe 'ManagementApi' do
|
|
1054
1083
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1055
1084
|
# @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.
|
1056
1085
|
# @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.
|
1057
|
-
# @return [
|
1086
|
+
# @return [InlineResponse20024]
|
1058
1087
|
describe 'get_webhook_logs test' do
|
1059
1088
|
it 'should work' do
|
1060
1089
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1063,33 +1092,20 @@ describe 'ManagementApi' do
|
|
1063
1092
|
|
1064
1093
|
# unit tests for get_webhooks
|
1065
1094
|
# List Webhooks
|
1066
|
-
#
|
1067
1095
|
# @param [Hash] opts the optional parameters
|
1068
1096
|
# @option opts [String] :application_ids Filter by one or more application ids separated by comma
|
1069
1097
|
# @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.
|
1070
1098
|
# @option opts [Integer] :page_size The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
1071
1099
|
# @option opts [Integer] :skip Skips the given number of items when paging through large result sets.
|
1072
|
-
# @return [
|
1100
|
+
# @return [InlineResponse20022]
|
1073
1101
|
describe 'get_webhooks test' do
|
1074
1102
|
it 'should work' do
|
1075
1103
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1076
1104
|
end
|
1077
1105
|
end
|
1078
1106
|
|
1079
|
-
# unit tests for refresh_analytics
|
1080
|
-
# Trigger refresh on stale analytics.
|
1081
|
-
# Should be used to trigger a manual refresh of analytics.
|
1082
|
-
# @param [Hash] opts the optional parameters
|
1083
|
-
# @return [nil]
|
1084
|
-
describe 'refresh_analytics test' do
|
1085
|
-
it 'should work' do
|
1086
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1087
|
-
end
|
1088
|
-
end
|
1089
|
-
|
1090
1107
|
# unit tests for remove_loyalty_points
|
1091
1108
|
# Deduct points in a certain loyalty program for the specified customer
|
1092
|
-
#
|
1093
1109
|
# @param program_id
|
1094
1110
|
# @param integration_id
|
1095
1111
|
# @param body
|
@@ -1114,7 +1130,7 @@ describe 'ManagementApi' do
|
|
1114
1130
|
end
|
1115
1131
|
|
1116
1132
|
# unit tests for search_coupons_advanced
|
1117
|
-
# Get a list of the coupons that match the given attributes
|
1133
|
+
# Get a list of the coupons that match the given attributes (with total count)
|
1118
1134
|
# Gets a list of all the coupons with attributes matching the query criteria
|
1119
1135
|
# @param application_id
|
1120
1136
|
# @param campaign_id
|
@@ -1130,9 +1146,9 @@ describe 'ManagementApi' do
|
|
1130
1146
|
# @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`.
|
1131
1147
|
# @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.
|
1132
1148
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1133
|
-
# @option opts [
|
1149
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1134
1150
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1135
|
-
# @return [
|
1151
|
+
# @return [InlineResponse2004]
|
1136
1152
|
describe 'search_coupons_advanced test' do
|
1137
1153
|
it 'should work' do
|
1138
1154
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1140,7 +1156,7 @@ describe 'ManagementApi' do
|
|
1140
1156
|
end
|
1141
1157
|
|
1142
1158
|
# unit tests for search_coupons_advanced_application_wide
|
1143
|
-
# Get a list of the coupons that match the given attributes in all active campaigns of an application
|
1159
|
+
# Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
1144
1160
|
# Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
1145
1161
|
# @param application_id
|
1146
1162
|
# @param body
|
@@ -1156,9 +1172,9 @@ describe 'ManagementApi' do
|
|
1156
1172
|
# @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.
|
1157
1173
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1158
1174
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1159
|
-
# @option opts [
|
1175
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1160
1176
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1161
|
-
# @return [
|
1177
|
+
# @return [InlineResponse2004]
|
1162
1178
|
describe 'search_coupons_advanced_application_wide test' do
|
1163
1179
|
it 'should work' do
|
1164
1180
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1182,7 +1198,7 @@ describe 'ManagementApi' do
|
|
1182
1198
|
# @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.
|
1183
1199
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1184
1200
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1185
|
-
# @option opts [
|
1201
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1186
1202
|
# @option opts [String] :campaign_state Filter results by the state of the campaign.
|
1187
1203
|
# @return [InlineResponse2005]
|
1188
1204
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
@@ -1208,7 +1224,7 @@ describe 'ManagementApi' do
|
|
1208
1224
|
# @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`.
|
1209
1225
|
# @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.
|
1210
1226
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
1211
|
-
# @option opts [
|
1227
|
+
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code
|
1212
1228
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
1213
1229
|
# @return [InlineResponse2005]
|
1214
1230
|
describe 'search_coupons_advanced_without_total_count test' do
|
@@ -1217,41 +1233,40 @@ describe 'ManagementApi' do
|
|
1217
1233
|
end
|
1218
1234
|
end
|
1219
1235
|
|
1220
|
-
# unit tests for
|
1221
|
-
#
|
1222
|
-
#
|
1223
|
-
# @param
|
1236
|
+
# unit tests for update_additional_cost
|
1237
|
+
# Update an additional cost
|
1238
|
+
# 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.
|
1239
|
+
# @param additional_cost_id
|
1224
1240
|
# @param body
|
1225
1241
|
# @param [Hash] opts the optional parameters
|
1226
|
-
# @return [
|
1227
|
-
describe '
|
1242
|
+
# @return [AccountAdditionalCost]
|
1243
|
+
describe 'update_additional_cost test' do
|
1228
1244
|
it 'should work' do
|
1229
1245
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1230
1246
|
end
|
1231
1247
|
end
|
1232
1248
|
|
1233
|
-
# unit tests for
|
1234
|
-
# Update a
|
1235
|
-
#
|
1236
|
-
# @param
|
1237
|
-
# @param campaign_id
|
1249
|
+
# unit tests for update_attribute
|
1250
|
+
# Update a custom attribute
|
1251
|
+
# 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.
|
1252
|
+
# @param attribute_id
|
1238
1253
|
# @param body
|
1239
1254
|
# @param [Hash] opts the optional parameters
|
1240
|
-
# @return [
|
1241
|
-
describe '
|
1255
|
+
# @return [Attribute]
|
1256
|
+
describe 'update_attribute test' do
|
1242
1257
|
it 'should work' do
|
1243
1258
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1244
1259
|
end
|
1245
1260
|
end
|
1246
1261
|
|
1247
|
-
# unit tests for
|
1248
|
-
# Update a Campaign
|
1249
|
-
#
|
1262
|
+
# unit tests for update_campaign
|
1263
|
+
# Update a Campaign
|
1250
1264
|
# @param application_id
|
1265
|
+
# @param campaign_id
|
1251
1266
|
# @param body
|
1252
1267
|
# @param [Hash] opts the optional parameters
|
1253
|
-
# @return [
|
1254
|
-
describe '
|
1268
|
+
# @return [Campaign]
|
1269
|
+
describe 'update_campaign test' do
|
1255
1270
|
it 'should work' do
|
1256
1271
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1257
1272
|
end
|
@@ -1259,7 +1274,6 @@ describe 'ManagementApi' do
|
|
1259
1274
|
|
1260
1275
|
# unit tests for update_coupon
|
1261
1276
|
# Update a Coupon
|
1262
|
-
#
|
1263
1277
|
# @param application_id
|
1264
1278
|
# @param campaign_id
|
1265
1279
|
# @param coupon_id The ID of the coupon code to update
|
@@ -1274,7 +1288,6 @@ describe 'ManagementApi' do
|
|
1274
1288
|
|
1275
1289
|
# unit tests for update_coupon_batch
|
1276
1290
|
# Update a Batch of Coupons
|
1277
|
-
#
|
1278
1291
|
# @param application_id
|
1279
1292
|
# @param campaign_id
|
1280
1293
|
# @param body
|
@@ -1288,7 +1301,6 @@ describe 'ManagementApi' do
|
|
1288
1301
|
|
1289
1302
|
# unit tests for update_ruleset
|
1290
1303
|
# Update a Ruleset
|
1291
|
-
#
|
1292
1304
|
# @param application_id
|
1293
1305
|
# @param campaign_id
|
1294
1306
|
# @param ruleset_id
|