talon_one 1.1.2 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +178 -26
- 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 +24 -0
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +21 -0
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +27 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +25 -2
- data/docs/ApplicationAPIKey.md +15 -0
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +18 -1
- 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 -2
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -4
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +38 -3
- data/docs/CampaignCopy.md +18 -0
- data/docs/CampaignEntity.md +9 -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 +10 -0
- data/docs/CustomerActivityReport.md +21 -0
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +21 -0
- data/docs/CustomerProfile.md +17 -1
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerProfileUpdate.md +17 -0
- data/docs/CustomerSession.md +23 -2
- 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/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +13 -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/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 +10 -0
- 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 +11 -1
- 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 +198 -64
- data/docs/IntegrationEntity.md +10 -0
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +14 -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 +20 -0
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +12 -0
- data/docs/LoyaltyProgram.md +17 -1
- data/docs/LoyaltyProgramBalance.md +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltySubLedger.md +11 -0
- data/docs/ManagementApi.md +834 -815
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +17 -3
- data/docs/MiscUpdateUserLatestFeature.md +9 -0
- data/docs/MultiApplicationEntity.md +9 -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 +22 -2
- data/docs/NewApplicationAPIKey.md +16 -0
- data/docs/NewAttribute.md +20 -2
- data/docs/NewCampaign.md +21 -1
- 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 +15 -1
- 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 +33 -0
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +21 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +21 -0
- data/docs/RejectCouponEffectProps.md +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +15 -1
- 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 +37 -0
- data/docs/SamlConnectionMetadata.md +23 -0
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +19 -0
- data/docs/SetDiscountPerItemEffectProps.md +21 -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 +33 -0
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateCampaign.md +21 -1
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +14 -1
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +17 -4
- data/docs/User.md +26 -2
- data/docs/UserEntity.md +9 -0
- data/docs/Webhook.md +20 -2
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +75 -33
- data/lib/talon_one/api/integration_api.rb +372 -130
- data/lib/talon_one/api/management_api.rb +2238 -1444
- data/lib/talon_one/api_client.rb +39 -42
- 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 +78 -40
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +67 -34
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +288 -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 +87 -85
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +47 -24
- data/lib/talon_one/models/application_customer.rb +52 -29
- 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 +82 -34
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +67 -66
- 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/base_saml_connection.rb +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +97 -54
- data/lib/talon_one/models/campaign_analytics.rb +160 -47
- 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_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 +39 -16
- data/lib/talon_one/models/customer_activity_report.rb +61 -38
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +228 -0
- data/lib/talon_one/models/customer_profile.rb +51 -28
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_profile_update.rb +211 -0
- data/lib/talon_one/models/customer_session.rb +59 -36
- 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/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 +54 -21
- 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/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_response_200_12.rb → inline_response20012.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_13.rb → inline_response20013.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_14.rb → inline_response20014.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_15.rb → inline_response20015.rb} +41 -18
- data/lib/talon_one/models/inline_response20016.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_17.rb → inline_response20017.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_18.rb → inline_response20018.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_19.rb → inline_response20019.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_3.rb → inline_response2002.rb} +41 -18
- data/lib/talon_one/models/inline_response20020.rb +227 -0
- 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} +51 -24
- 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 +40 -17
- 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 +54 -22
- 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 +70 -37
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +43 -20
- data/lib/talon_one/models/loyalty_program.rb +50 -27
- 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_sub_ledger.rb +41 -18
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +52 -20
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +39 -16
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- 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 +111 -81
- data/lib/talon_one/models/new_application_api_key.rb +48 -25
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_campaign.rb +57 -34
- 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 +47 -24
- 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 +394 -0
- 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 +242 -0
- data/lib/talon_one/models/redeem_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/referral.rb +54 -31
- data/lib/talon_one/models/referral_created_effect_props.rb +213 -0
- data/lib/talon_one/models/referral_rejection_reason.rb +274 -0
- 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 +45 -22
- 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 +410 -0
- 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 +228 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +243 -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 +406 -0
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_campaign.rb +57 -34
- 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 +46 -23
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +62 -66
- data/lib/talon_one/models/user.rb +81 -39
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/webhook.rb +56 -50
- 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 +44 -11
- data/spec/api/management_api_spec.rb +141 -140
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/accept_coupon_effect_props_spec.rb +41 -0
- 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 +10 -4
- 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 +71 -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 +4 -4
- 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 +4 -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 +16 -4
- data/spec/models/application_spec.rb +20 -10
- data/spec/models/attribute_spec.rb +5 -11
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -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 +40 -4
- data/spec/models/campaign_copy_spec.rb +28 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- 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 +16 -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 +4 -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 +53 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +4 -4
- data/spec/models/customer_profile_update_spec.rb +41 -0
- 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/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 +10 -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/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} +4 -4
- data/spec/models/{inline_response_200_13_spec.rb → inline_response20013_spec.rb} +4 -4
- data/spec/models/{inline_response_200_14_spec.rb → inline_response20014_spec.rb} +4 -4
- data/spec/models/{inline_response_200_15_spec.rb → inline_response20015_spec.rb} +4 -4
- data/spec/models/{inline_response_200_16_spec.rb → inline_response20016_spec.rb} +5 -5
- data/spec/models/{inline_response_200_17_spec.rb → inline_response20017_spec.rb} +4 -4
- data/spec/models/{inline_response_200_18_spec.rb → inline_response20018_spec.rb} +4 -4
- data/spec/models/{inline_response_200_19_spec.rb → inline_response20019_spec.rb} +4 -4
- data/spec/models/{inline_response_200_1_spec.rb → inline_response2001_spec.rb} +4 -4
- data/spec/models/{inline_response_200_20_spec.rb → inline_response20020_spec.rb} +4 -4
- data/spec/models/{inline_response_200_21_spec.rb → inline_response20021_spec.rb} +4 -4
- data/spec/models/{inline_response_200_22_spec.rb → inline_response20022_spec.rb} +4 -4
- data/spec/models/{inline_response_200_23_spec.rb → inline_response20023_spec.rb} +4 -4
- data/spec/models/{inline_response_200_24_spec.rb → inline_response20024_spec.rb} +4 -4
- data/spec/models/{inline_response_200_25_spec.rb → inline_response20025_spec.rb} +4 -4
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -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 +10 -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 +5 -5
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +11 -5
- 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 +4 -4
- 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 +4 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_sub_ledger_spec.rb +4 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +10 -4
- data/spec/models/misc_update_user_latest_feature_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- 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 +4 -4
- data/spec/models/new_application_spec.rb +26 -10
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +4 -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 +4 -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 +89 -0
- 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 +53 -0
- data/spec/models/redeem_referral_effect_props_spec.rb +47 -0
- data/spec/models/referral_created_effect_props_spec.rb +41 -0
- data/spec/models/referral_rejection_reason_spec.rb +57 -0
- 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 +4 -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 +101 -0
- 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 +47 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +53 -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 +97 -0
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_campaign_spec.rb +4 -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 +4 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_spec.rb +10 -22
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_spec.rb +16 -4
- 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 -10
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +271 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.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/spec/models/attribute_query_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/docs/ManagementApi.md
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
# TalonOne::ManagementApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**add_loyalty_points**](ManagementApi.md#add_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/add_points | Add points in a certain loyalty program for the specified customer
|
|
8
8
|
[**copy_campaign_to_applications**](ManagementApi.md#copy_campaign_to_applications) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/copy | Copy the campaign into every specified application
|
|
9
|
+
[**create_additional_cost**](ManagementApi.md#create_additional_cost) | **POST** /v1/additional_costs | Define a new additional cost
|
|
10
|
+
[**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Define a new custom attribute
|
|
9
11
|
[**create_campaign**](ManagementApi.md#create_campaign) | **POST** /v1/applications/{applicationId}/campaigns | Create a Campaign
|
|
10
12
|
[**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create Coupons
|
|
11
13
|
[**create_password_recovery_email**](ManagementApi.md#create_password_recovery_email) | **POST** /v1/password_recovery_emails | Request a password reset
|
|
@@ -16,37 +18,38 @@ Method | HTTP request | Description
|
|
|
16
18
|
[**delete_coupons**](ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete Coupons
|
|
17
19
|
[**delete_referral**](ManagementApi.md#delete_referral) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/{referralId} | Delete one Referral
|
|
18
20
|
[**delete_ruleset**](ManagementApi.md#delete_ruleset) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Delete a Ruleset
|
|
19
|
-
[**get_access_logs**](ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application
|
|
21
|
+
[**get_access_logs**](ManagementApi.md#get_access_logs) | **GET** /v1/applications/{applicationId}/access_logs | Get access logs for application (with total count)
|
|
20
22
|
[**get_access_logs_without_total_count**](ManagementApi.md#get_access_logs_without_total_count) | **GET** /v1/applications/{applicationId}/access_logs/no_total | Get access logs for application
|
|
21
23
|
[**get_account**](ManagementApi.md#get_account) | **GET** /v1/accounts/{accountId} | Get Account Details
|
|
22
24
|
[**get_account_analytics**](ManagementApi.md#get_account_analytics) | **GET** /v1/accounts/{accountId}/analytics | Get Account Analytics
|
|
23
|
-
[**
|
|
25
|
+
[**get_additional_cost**](ManagementApi.md#get_additional_cost) | **GET** /v1/additional_costs/{additionalCostId} | Get an additional cost
|
|
26
|
+
[**get_additional_costs**](ManagementApi.md#get_additional_costs) | **GET** /v1/additional_costs | List additional costs
|
|
24
27
|
[**get_all_access_logs**](ManagementApi.md#get_all_access_logs) | **GET** /v1/access_logs | Get all access logs
|
|
25
28
|
[**get_all_roles**](ManagementApi.md#get_all_roles) | **GET** /v1/roles | Get all roles.
|
|
26
29
|
[**get_application**](ManagementApi.md#get_application) | **GET** /v1/applications/{applicationId} | Get Application
|
|
27
30
|
[**get_application_api_health**](ManagementApi.md#get_application_api_health) | **GET** /v1/applications/{applicationId}/health_report | Get report of health of application API
|
|
28
31
|
[**get_application_customer**](ManagementApi.md#get_application_customer) | **GET** /v1/applications/{applicationId}/customers/{customerId} | Get Application Customer
|
|
29
32
|
[**get_application_customers**](ManagementApi.md#get_application_customers) | **GET** /v1/applications/{applicationId}/customers | List Application Customers
|
|
30
|
-
[**get_application_customers_by_attributes**](ManagementApi.md#get_application_customers_by_attributes) | **POST** /v1/application_customer_search | Get a list of the customer profiles that match the given attributes
|
|
33
|
+
[**get_application_customers_by_attributes**](ManagementApi.md#get_application_customers_by_attributes) | **POST** /v1/application_customer_search | Get a list of the customer profiles that match the given attributes (with total count)
|
|
31
34
|
[**get_application_event_types**](ManagementApi.md#get_application_event_types) | **GET** /v1/applications/{applicationId}/event_types | List Applications Event Types
|
|
32
|
-
[**get_application_events**](ManagementApi.md#get_application_events) | **GET** /v1/applications/{applicationId}/events | List Applications Events
|
|
35
|
+
[**get_application_events**](ManagementApi.md#get_application_events) | **GET** /v1/applications/{applicationId}/events | List Applications Events (with total count)
|
|
33
36
|
[**get_application_events_without_total_count**](ManagementApi.md#get_application_events_without_total_count) | **GET** /v1/applications/{applicationId}/events/no_total | List Applications Events
|
|
34
37
|
[**get_application_session**](ManagementApi.md#get_application_session) | **GET** /v1/applications/{applicationId}/sessions/{sessionId} | Get Application Session
|
|
35
38
|
[**get_application_sessions**](ManagementApi.md#get_application_sessions) | **GET** /v1/applications/{applicationId}/sessions | List Application Sessions
|
|
36
39
|
[**get_applications**](ManagementApi.md#get_applications) | **GET** /v1/applications | List Applications
|
|
37
40
|
[**get_attribute**](ManagementApi.md#get_attribute) | **GET** /v1/attributes/{attributeId} | Get a custom attribute
|
|
41
|
+
[**get_attributes**](ManagementApi.md#get_attributes) | **GET** /v1/attributes | List custom attributes
|
|
38
42
|
[**get_campaign**](ManagementApi.md#get_campaign) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId} | Get a Campaign
|
|
39
43
|
[**get_campaign_analytics**](ManagementApi.md#get_campaign_analytics) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/analytics | Get analytics of campaigns
|
|
40
44
|
[**get_campaign_by_attributes**](ManagementApi.md#get_campaign_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns_search | Get a list of all campaigns that match the given attributes
|
|
41
|
-
[**get_campaign_set**](ManagementApi.md#get_campaign_set) | **GET** /v1/applications/{applicationId}/campaign_set | List CampaignSet
|
|
42
45
|
[**get_campaigns**](ManagementApi.md#get_campaigns) | **GET** /v1/applications/{applicationId}/campaigns | List your Campaigns
|
|
43
46
|
[**get_changes**](ManagementApi.md#get_changes) | **GET** /v1/changes | Get audit log for an account
|
|
44
|
-
[**get_coupons**](ManagementApi.md#get_coupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons
|
|
47
|
+
[**get_coupons**](ManagementApi.md#get_coupons) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | List Coupons (with total count)
|
|
45
48
|
[**get_coupons_by_attributes**](ManagementApi.md#get_coupons_by_attributes) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search | Get a list of the coupons that match the given attributes
|
|
46
|
-
[**get_coupons_by_attributes_application_wide**](ManagementApi.md#get_coupons_by_attributes_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
49
|
+
[**get_coupons_by_attributes_application_wide**](ManagementApi.md#get_coupons_by_attributes_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search | Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
47
50
|
[**get_coupons_without_total_count**](ManagementApi.md#get_coupons_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/no_total | List Coupons
|
|
48
51
|
[**get_customer_activity_report**](ManagementApi.md#get_customer_activity_report) | **GET** /v1/applications/{applicationId}/customer_activity_reports/{customerId} | Get Activity Report for Single Customer
|
|
49
|
-
[**get_customer_activity_reports**](ManagementApi.md#get_customer_activity_reports) | **GET** /v1/applications/{applicationId}/customer_activity_reports | Get Activity Reports for Application Customers
|
|
52
|
+
[**get_customer_activity_reports**](ManagementApi.md#get_customer_activity_reports) | **GET** /v1/applications/{applicationId}/customer_activity_reports | Get Activity Reports for Application Customers (with total count)
|
|
50
53
|
[**get_customer_activity_reports_without_total_count**](ManagementApi.md#get_customer_activity_reports_without_total_count) | **GET** /v1/applications/{applicationId}/customer_activity_reports/no_total | Get Activity Reports for Application Customers
|
|
51
54
|
[**get_customer_analytics**](ManagementApi.md#get_customer_analytics) | **GET** /v1/applications/{applicationId}/customers/{customerId}/analytics | Get Analytics Report for a Customer
|
|
52
55
|
[**get_customer_profile**](ManagementApi.md#get_customer_profile) | **GET** /v1/customers/{customerId} | Get Customer Profile
|
|
@@ -58,7 +61,7 @@ Method | HTTP request | Description
|
|
|
58
61
|
[**get_loyalty_points**](ManagementApi.md#get_loyalty_points) | **GET** /v1/loyalty_programs/{programID}/profile/{integrationID} | get the Loyalty Ledger for this integrationID
|
|
59
62
|
[**get_loyalty_program**](ManagementApi.md#get_loyalty_program) | **GET** /v1/loyalty_programs/{programID} | Get a loyalty program
|
|
60
63
|
[**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List all loyalty Programs
|
|
61
|
-
[**get_referrals**](ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals
|
|
64
|
+
[**get_referrals**](ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
|
|
62
65
|
[**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
|
|
63
66
|
[**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
|
|
64
67
|
[**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
|
|
@@ -69,29 +72,29 @@ Method | HTTP request | Description
|
|
|
69
72
|
[**get_webhook_activation_logs**](ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
|
|
70
73
|
[**get_webhook_logs**](ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
|
|
71
74
|
[**get_webhooks**](ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List Webhooks
|
|
72
|
-
[**refresh_analytics**](ManagementApi.md#refresh_analytics) | **POST** /v1/refresh_analytics | Trigger refresh on stale analytics.
|
|
73
75
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{programID}/profile/{integrationID}/deduct_points | Deduct points in a certain loyalty program for the specified customer
|
|
74
76
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
|
75
|
-
[**search_coupons_advanced**](ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes
|
|
76
|
-
[**search_coupons_advanced_application_wide**](ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
77
|
+
[**search_coupons_advanced**](ManagementApi.md#search_coupons_advanced) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced | Get a list of the coupons that match the given attributes (with total count)
|
|
78
|
+
[**search_coupons_advanced_application_wide**](ManagementApi.md#search_coupons_advanced_application_wide) | **POST** /v1/applications/{applicationId}/coupons_search_advanced | Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
77
79
|
[**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
78
80
|
[**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | Get a list of the coupons that match the given attributes
|
|
79
|
-
[**
|
|
81
|
+
[**update_additional_cost**](ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost
|
|
82
|
+
[**update_attribute**](ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
|
80
83
|
[**update_campaign**](ManagementApi.md#update_campaign) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId} | Update a Campaign
|
|
81
|
-
[**update_campaign_set**](ManagementApi.md#update_campaign_set) | **PUT** /v1/applications/{applicationId}/campaign_set | Update a Campaign Set
|
|
82
84
|
[**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
|
83
85
|
[**update_coupon_batch**](ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
|
|
84
86
|
[**update_ruleset**](ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
|
|
85
87
|
|
|
86
88
|
|
|
87
|
-
# **add_loyalty_points**
|
|
88
|
-
> add_loyalty_points(program_id, integration_id, body)
|
|
89
89
|
|
|
90
|
-
|
|
90
|
+
## add_loyalty_points
|
|
91
91
|
|
|
92
|
+
> add_loyalty_points(program_id, integration_id, body)
|
|
92
93
|
|
|
94
|
+
Add points in a certain loyalty program for the specified customer
|
|
93
95
|
|
|
94
96
|
### Example
|
|
97
|
+
|
|
95
98
|
```ruby
|
|
96
99
|
# load the gem
|
|
97
100
|
require 'talon_one'
|
|
@@ -104,14 +107,10 @@ TalonOne.configure do |config|
|
|
|
104
107
|
end
|
|
105
108
|
|
|
106
109
|
api_instance = TalonOne::ManagementApi.new
|
|
107
|
-
|
|
108
110
|
program_id = 'program_id_example' # String |
|
|
109
|
-
|
|
110
111
|
integration_id = 'integration_id_example' # String |
|
|
111
|
-
|
|
112
112
|
body = TalonOne::LoyaltyPoints.new # LoyaltyPoints |
|
|
113
113
|
|
|
114
|
-
|
|
115
114
|
begin
|
|
116
115
|
#Add points in a certain loyalty program for the specified customer
|
|
117
116
|
api_instance.add_loyalty_points(program_id, integration_id, body)
|
|
@@ -122,6 +121,7 @@ end
|
|
|
122
121
|
|
|
123
122
|
### Parameters
|
|
124
123
|
|
|
124
|
+
|
|
125
125
|
Name | Type | Description | Notes
|
|
126
126
|
------------- | ------------- | ------------- | -------------
|
|
127
127
|
**program_id** | **String**| |
|
|
@@ -138,19 +138,20 @@ nil (empty response body)
|
|
|
138
138
|
|
|
139
139
|
### HTTP request headers
|
|
140
140
|
|
|
141
|
-
|
|
142
|
-
|
|
141
|
+
- **Content-Type**: application/json
|
|
142
|
+
- **Accept**: Not defined
|
|
143
143
|
|
|
144
144
|
|
|
145
|
+
## copy_campaign_to_applications
|
|
145
146
|
|
|
146
|
-
|
|
147
|
-
> InlineResponse2003 copy_campaign_to_applications(application_id, campaign_id, body)
|
|
147
|
+
> InlineResponse2002 copy_campaign_to_applications(application_id, campaign_id, body)
|
|
148
148
|
|
|
149
149
|
Copy the campaign into every specified application
|
|
150
150
|
|
|
151
151
|
Copy the campaign into every specified application.
|
|
152
152
|
|
|
153
153
|
### Example
|
|
154
|
+
|
|
154
155
|
```ruby
|
|
155
156
|
# load the gem
|
|
156
157
|
require 'talon_one'
|
|
@@ -163,14 +164,10 @@ TalonOne.configure do |config|
|
|
|
163
164
|
end
|
|
164
165
|
|
|
165
166
|
api_instance = TalonOne::ManagementApi.new
|
|
166
|
-
|
|
167
167
|
application_id = 56 # Integer |
|
|
168
|
-
|
|
169
168
|
campaign_id = 56 # Integer |
|
|
170
|
-
|
|
171
169
|
body = TalonOne::CampaignCopy.new # CampaignCopy |
|
|
172
170
|
|
|
173
|
-
|
|
174
171
|
begin
|
|
175
172
|
#Copy the campaign into every specified application
|
|
176
173
|
result = api_instance.copy_campaign_to_applications(application_id, campaign_id, body)
|
|
@@ -182,6 +179,7 @@ end
|
|
|
182
179
|
|
|
183
180
|
### Parameters
|
|
184
181
|
|
|
182
|
+
|
|
185
183
|
Name | Type | Description | Notes
|
|
186
184
|
------------- | ------------- | ------------- | -------------
|
|
187
185
|
**application_id** | **Integer**| |
|
|
@@ -190,7 +188,7 @@ Name | Type | Description | Notes
|
|
|
190
188
|
|
|
191
189
|
### Return type
|
|
192
190
|
|
|
193
|
-
[**
|
|
191
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
194
192
|
|
|
195
193
|
### Authorization
|
|
196
194
|
|
|
@@ -198,19 +196,74 @@ Name | Type | Description | Notes
|
|
|
198
196
|
|
|
199
197
|
### HTTP request headers
|
|
200
198
|
|
|
201
|
-
|
|
202
|
-
|
|
199
|
+
- **Content-Type**: application/json
|
|
200
|
+
- **Accept**: application/json
|
|
203
201
|
|
|
204
202
|
|
|
203
|
+
## create_additional_cost
|
|
205
204
|
|
|
206
|
-
|
|
207
|
-
> Campaign create_campaign(application_id, body)
|
|
205
|
+
> AccountAdditionalCost create_additional_cost(body)
|
|
208
206
|
|
|
209
|
-
|
|
207
|
+
Define a new additional cost
|
|
208
|
+
|
|
209
|
+
Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
|
|
210
|
+
|
|
211
|
+
### Example
|
|
212
|
+
|
|
213
|
+
```ruby
|
|
214
|
+
# load the gem
|
|
215
|
+
require 'talon_one'
|
|
216
|
+
# setup authorization
|
|
217
|
+
TalonOne.configure do |config|
|
|
218
|
+
# Configure API key authorization: manager_auth
|
|
219
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
220
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
221
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
222
|
+
end
|
|
210
223
|
|
|
224
|
+
api_instance = TalonOne::ManagementApi.new
|
|
225
|
+
body = TalonOne::NewAdditionalCost.new # NewAdditionalCost |
|
|
226
|
+
|
|
227
|
+
begin
|
|
228
|
+
#Define a new additional cost
|
|
229
|
+
result = api_instance.create_additional_cost(body)
|
|
230
|
+
p result
|
|
231
|
+
rescue TalonOne::ApiError => e
|
|
232
|
+
puts "Exception when calling ManagementApi->create_additional_cost: #{e}"
|
|
233
|
+
end
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Parameters
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
Name | Type | Description | Notes
|
|
240
|
+
------------- | ------------- | ------------- | -------------
|
|
241
|
+
**body** | [**NewAdditionalCost**](NewAdditionalCost.md)| |
|
|
242
|
+
|
|
243
|
+
### Return type
|
|
244
|
+
|
|
245
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
246
|
+
|
|
247
|
+
### Authorization
|
|
248
|
+
|
|
249
|
+
[manager_auth](../README.md#manager_auth)
|
|
250
|
+
|
|
251
|
+
### HTTP request headers
|
|
252
|
+
|
|
253
|
+
- **Content-Type**: application/json
|
|
254
|
+
- **Accept**: application/json
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
## create_attribute
|
|
258
|
+
|
|
259
|
+
> Attribute create_attribute(body)
|
|
211
260
|
|
|
261
|
+
Define a new custom attribute
|
|
262
|
+
|
|
263
|
+
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.
|
|
212
264
|
|
|
213
265
|
### Example
|
|
266
|
+
|
|
214
267
|
```ruby
|
|
215
268
|
# load the gem
|
|
216
269
|
require 'talon_one'
|
|
@@ -223,11 +276,60 @@ TalonOne.configure do |config|
|
|
|
223
276
|
end
|
|
224
277
|
|
|
225
278
|
api_instance = TalonOne::ManagementApi.new
|
|
279
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
|
226
280
|
|
|
227
|
-
|
|
281
|
+
begin
|
|
282
|
+
#Define a new custom attribute
|
|
283
|
+
result = api_instance.create_attribute(body)
|
|
284
|
+
p result
|
|
285
|
+
rescue TalonOne::ApiError => e
|
|
286
|
+
puts "Exception when calling ManagementApi->create_attribute: #{e}"
|
|
287
|
+
end
|
|
288
|
+
```
|
|
228
289
|
|
|
229
|
-
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
Name | Type | Description | Notes
|
|
294
|
+
------------- | ------------- | ------------- | -------------
|
|
295
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
|
296
|
+
|
|
297
|
+
### Return type
|
|
298
|
+
|
|
299
|
+
[**Attribute**](Attribute.md)
|
|
300
|
+
|
|
301
|
+
### Authorization
|
|
302
|
+
|
|
303
|
+
[manager_auth](../README.md#manager_auth)
|
|
304
|
+
|
|
305
|
+
### HTTP request headers
|
|
306
|
+
|
|
307
|
+
- **Content-Type**: application/json
|
|
308
|
+
- **Accept**: application/json
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
## create_campaign
|
|
312
|
+
|
|
313
|
+
> Campaign create_campaign(application_id, body)
|
|
314
|
+
|
|
315
|
+
Create a Campaign
|
|
316
|
+
|
|
317
|
+
### Example
|
|
318
|
+
|
|
319
|
+
```ruby
|
|
320
|
+
# load the gem
|
|
321
|
+
require 'talon_one'
|
|
322
|
+
# setup authorization
|
|
323
|
+
TalonOne.configure do |config|
|
|
324
|
+
# Configure API key authorization: manager_auth
|
|
325
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
326
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
327
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
328
|
+
end
|
|
230
329
|
|
|
330
|
+
api_instance = TalonOne::ManagementApi.new
|
|
331
|
+
application_id = 56 # Integer |
|
|
332
|
+
body = TalonOne::NewCampaign.new # NewCampaign |
|
|
231
333
|
|
|
232
334
|
begin
|
|
233
335
|
#Create a Campaign
|
|
@@ -240,6 +342,7 @@ end
|
|
|
240
342
|
|
|
241
343
|
### Parameters
|
|
242
344
|
|
|
345
|
+
|
|
243
346
|
Name | Type | Description | Notes
|
|
244
347
|
------------- | ------------- | ------------- | -------------
|
|
245
348
|
**application_id** | **Integer**| |
|
|
@@ -255,19 +358,20 @@ Name | Type | Description | Notes
|
|
|
255
358
|
|
|
256
359
|
### HTTP request headers
|
|
257
360
|
|
|
258
|
-
|
|
259
|
-
|
|
361
|
+
- **Content-Type**: application/json
|
|
362
|
+
- **Accept**: application/json
|
|
260
363
|
|
|
261
364
|
|
|
365
|
+
## create_coupons
|
|
262
366
|
|
|
263
|
-
|
|
264
|
-
> InlineResponse2001 create_coupons(application_id, campaign_id, body, opts)
|
|
367
|
+
> InlineResponse2004 create_coupons(application_id, campaign_id, body, opts)
|
|
265
368
|
|
|
266
369
|
Create Coupons
|
|
267
370
|
|
|
268
|
-
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
|
|
371
|
+
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.
|
|
269
372
|
|
|
270
373
|
### Example
|
|
374
|
+
|
|
271
375
|
```ruby
|
|
272
376
|
# load the gem
|
|
273
377
|
require 'talon_one'
|
|
@@ -280,14 +384,10 @@ TalonOne.configure do |config|
|
|
|
280
384
|
end
|
|
281
385
|
|
|
282
386
|
api_instance = TalonOne::ManagementApi.new
|
|
283
|
-
|
|
284
387
|
application_id = 56 # Integer |
|
|
285
|
-
|
|
286
388
|
campaign_id = 56 # Integer |
|
|
287
|
-
|
|
288
389
|
body = TalonOne::NewCoupons.new # NewCoupons |
|
|
289
|
-
|
|
290
|
-
opts = {
|
|
390
|
+
opts = {
|
|
291
391
|
silent: 'silent_example' # String | If set to 'yes', response will be an empty 204, otherwise a list of the coupons generated (to to 1000).
|
|
292
392
|
}
|
|
293
393
|
|
|
@@ -302,6 +402,7 @@ end
|
|
|
302
402
|
|
|
303
403
|
### Parameters
|
|
304
404
|
|
|
405
|
+
|
|
305
406
|
Name | Type | Description | Notes
|
|
306
407
|
------------- | ------------- | ------------- | -------------
|
|
307
408
|
**application_id** | **Integer**| |
|
|
@@ -311,7 +412,7 @@ Name | Type | Description | Notes
|
|
|
311
412
|
|
|
312
413
|
### Return type
|
|
313
414
|
|
|
314
|
-
[**
|
|
415
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
315
416
|
|
|
316
417
|
### Authorization
|
|
317
418
|
|
|
@@ -319,12 +420,12 @@ Name | Type | Description | Notes
|
|
|
319
420
|
|
|
320
421
|
### HTTP request headers
|
|
321
422
|
|
|
322
|
-
|
|
323
|
-
|
|
423
|
+
- **Content-Type**: application/json
|
|
424
|
+
- **Accept**: application/json
|
|
324
425
|
|
|
325
426
|
|
|
427
|
+
## create_password_recovery_email
|
|
326
428
|
|
|
327
|
-
# **create_password_recovery_email**
|
|
328
429
|
> NewPasswordEmail create_password_recovery_email(body)
|
|
329
430
|
|
|
330
431
|
Request a password reset
|
|
@@ -332,6 +433,7 @@ Request a password reset
|
|
|
332
433
|
Sends an email with a password recovery link to the email of an existing account.
|
|
333
434
|
|
|
334
435
|
### Example
|
|
436
|
+
|
|
335
437
|
```ruby
|
|
336
438
|
# load the gem
|
|
337
439
|
require 'talon_one'
|
|
@@ -344,10 +446,8 @@ TalonOne.configure do |config|
|
|
|
344
446
|
end
|
|
345
447
|
|
|
346
448
|
api_instance = TalonOne::ManagementApi.new
|
|
347
|
-
|
|
348
449
|
body = TalonOne::NewPasswordEmail.new # NewPasswordEmail |
|
|
349
450
|
|
|
350
|
-
|
|
351
451
|
begin
|
|
352
452
|
#Request a password reset
|
|
353
453
|
result = api_instance.create_password_recovery_email(body)
|
|
@@ -359,6 +459,7 @@ end
|
|
|
359
459
|
|
|
360
460
|
### Parameters
|
|
361
461
|
|
|
462
|
+
|
|
362
463
|
Name | Type | Description | Notes
|
|
363
464
|
------------- | ------------- | ------------- | -------------
|
|
364
465
|
**body** | [**NewPasswordEmail**](NewPasswordEmail.md)| |
|
|
@@ -373,19 +474,18 @@ Name | Type | Description | Notes
|
|
|
373
474
|
|
|
374
475
|
### HTTP request headers
|
|
375
476
|
|
|
376
|
-
|
|
377
|
-
|
|
477
|
+
- **Content-Type**: application/json
|
|
478
|
+
- **Accept**: application/json
|
|
378
479
|
|
|
379
480
|
|
|
481
|
+
## create_ruleset
|
|
380
482
|
|
|
381
|
-
# **create_ruleset**
|
|
382
483
|
> Ruleset create_ruleset(application_id, campaign_id, body)
|
|
383
484
|
|
|
384
485
|
Create a Ruleset
|
|
385
486
|
|
|
386
|
-
|
|
387
|
-
|
|
388
487
|
### Example
|
|
488
|
+
|
|
389
489
|
```ruby
|
|
390
490
|
# load the gem
|
|
391
491
|
require 'talon_one'
|
|
@@ -398,14 +498,10 @@ TalonOne.configure do |config|
|
|
|
398
498
|
end
|
|
399
499
|
|
|
400
500
|
api_instance = TalonOne::ManagementApi.new
|
|
401
|
-
|
|
402
501
|
application_id = 56 # Integer |
|
|
403
|
-
|
|
404
502
|
campaign_id = 56 # Integer |
|
|
405
|
-
|
|
406
503
|
body = TalonOne::NewRuleset.new # NewRuleset |
|
|
407
504
|
|
|
408
|
-
|
|
409
505
|
begin
|
|
410
506
|
#Create a Ruleset
|
|
411
507
|
result = api_instance.create_ruleset(application_id, campaign_id, body)
|
|
@@ -417,6 +513,7 @@ end
|
|
|
417
513
|
|
|
418
514
|
### Parameters
|
|
419
515
|
|
|
516
|
+
|
|
420
517
|
Name | Type | Description | Notes
|
|
421
518
|
------------- | ------------- | ------------- | -------------
|
|
422
519
|
**application_id** | **Integer**| |
|
|
@@ -433,19 +530,18 @@ Name | Type | Description | Notes
|
|
|
433
530
|
|
|
434
531
|
### HTTP request headers
|
|
435
532
|
|
|
436
|
-
|
|
437
|
-
|
|
533
|
+
- **Content-Type**: application/json
|
|
534
|
+
- **Accept**: application/json
|
|
438
535
|
|
|
439
536
|
|
|
537
|
+
## create_session
|
|
440
538
|
|
|
441
|
-
# **create_session**
|
|
442
539
|
> Session create_session(body)
|
|
443
540
|
|
|
444
541
|
Create a Session
|
|
445
542
|
|
|
446
|
-
|
|
447
|
-
|
|
448
543
|
### Example
|
|
544
|
+
|
|
449
545
|
```ruby
|
|
450
546
|
# load the gem
|
|
451
547
|
require 'talon_one'
|
|
@@ -458,10 +554,8 @@ TalonOne.configure do |config|
|
|
|
458
554
|
end
|
|
459
555
|
|
|
460
556
|
api_instance = TalonOne::ManagementApi.new
|
|
461
|
-
|
|
462
557
|
body = TalonOne::LoginParams.new # LoginParams |
|
|
463
558
|
|
|
464
|
-
|
|
465
559
|
begin
|
|
466
560
|
#Create a Session
|
|
467
561
|
result = api_instance.create_session(body)
|
|
@@ -473,6 +567,7 @@ end
|
|
|
473
567
|
|
|
474
568
|
### Parameters
|
|
475
569
|
|
|
570
|
+
|
|
476
571
|
Name | Type | Description | Notes
|
|
477
572
|
------------- | ------------- | ------------- | -------------
|
|
478
573
|
**body** | [**LoginParams**](LoginParams.md)| |
|
|
@@ -487,19 +582,18 @@ Name | Type | Description | Notes
|
|
|
487
582
|
|
|
488
583
|
### HTTP request headers
|
|
489
584
|
|
|
490
|
-
|
|
491
|
-
|
|
585
|
+
- **Content-Type**: application/json
|
|
586
|
+
- **Accept**: application/json
|
|
492
587
|
|
|
493
588
|
|
|
589
|
+
## delete_campaign
|
|
494
590
|
|
|
495
|
-
# **delete_campaign**
|
|
496
591
|
> delete_campaign(application_id, campaign_id)
|
|
497
592
|
|
|
498
593
|
Delete a Campaign
|
|
499
594
|
|
|
500
|
-
|
|
501
|
-
|
|
502
595
|
### Example
|
|
596
|
+
|
|
503
597
|
```ruby
|
|
504
598
|
# load the gem
|
|
505
599
|
require 'talon_one'
|
|
@@ -512,12 +606,9 @@ TalonOne.configure do |config|
|
|
|
512
606
|
end
|
|
513
607
|
|
|
514
608
|
api_instance = TalonOne::ManagementApi.new
|
|
515
|
-
|
|
516
609
|
application_id = 56 # Integer |
|
|
517
|
-
|
|
518
610
|
campaign_id = 56 # Integer |
|
|
519
611
|
|
|
520
|
-
|
|
521
612
|
begin
|
|
522
613
|
#Delete a Campaign
|
|
523
614
|
api_instance.delete_campaign(application_id, campaign_id)
|
|
@@ -528,6 +619,7 @@ end
|
|
|
528
619
|
|
|
529
620
|
### Parameters
|
|
530
621
|
|
|
622
|
+
|
|
531
623
|
Name | Type | Description | Notes
|
|
532
624
|
------------- | ------------- | ------------- | -------------
|
|
533
625
|
**application_id** | **Integer**| |
|
|
@@ -543,19 +635,18 @@ nil (empty response body)
|
|
|
543
635
|
|
|
544
636
|
### HTTP request headers
|
|
545
637
|
|
|
546
|
-
|
|
547
|
-
|
|
638
|
+
- **Content-Type**: Not defined
|
|
639
|
+
- **Accept**: Not defined
|
|
548
640
|
|
|
549
641
|
|
|
642
|
+
## delete_coupon
|
|
550
643
|
|
|
551
|
-
# **delete_coupon**
|
|
552
644
|
> delete_coupon(application_id, campaign_id, coupon_id)
|
|
553
645
|
|
|
554
646
|
Delete one Coupon
|
|
555
647
|
|
|
556
|
-
|
|
557
|
-
|
|
558
648
|
### Example
|
|
649
|
+
|
|
559
650
|
```ruby
|
|
560
651
|
# load the gem
|
|
561
652
|
require 'talon_one'
|
|
@@ -568,14 +659,10 @@ TalonOne.configure do |config|
|
|
|
568
659
|
end
|
|
569
660
|
|
|
570
661
|
api_instance = TalonOne::ManagementApi.new
|
|
571
|
-
|
|
572
662
|
application_id = 56 # Integer |
|
|
573
|
-
|
|
574
663
|
campaign_id = 56 # Integer |
|
|
575
|
-
|
|
576
664
|
coupon_id = 'coupon_id_example' # String | The ID of the coupon code to delete
|
|
577
665
|
|
|
578
|
-
|
|
579
666
|
begin
|
|
580
667
|
#Delete one Coupon
|
|
581
668
|
api_instance.delete_coupon(application_id, campaign_id, coupon_id)
|
|
@@ -586,6 +673,7 @@ end
|
|
|
586
673
|
|
|
587
674
|
### Parameters
|
|
588
675
|
|
|
676
|
+
|
|
589
677
|
Name | Type | Description | Notes
|
|
590
678
|
------------- | ------------- | ------------- | -------------
|
|
591
679
|
**application_id** | **Integer**| |
|
|
@@ -602,19 +690,18 @@ nil (empty response body)
|
|
|
602
690
|
|
|
603
691
|
### HTTP request headers
|
|
604
692
|
|
|
605
|
-
|
|
606
|
-
|
|
693
|
+
- **Content-Type**: Not defined
|
|
694
|
+
- **Accept**: Not defined
|
|
607
695
|
|
|
608
696
|
|
|
697
|
+
## delete_coupons
|
|
609
698
|
|
|
610
|
-
# **delete_coupons**
|
|
611
699
|
> delete_coupons(application_id, campaign_id, opts)
|
|
612
700
|
|
|
613
701
|
Delete Coupons
|
|
614
702
|
|
|
615
|
-
|
|
616
|
-
|
|
617
703
|
### Example
|
|
704
|
+
|
|
618
705
|
```ruby
|
|
619
706
|
# load the gem
|
|
620
707
|
require 'talon_one'
|
|
@@ -627,12 +714,9 @@ TalonOne.configure do |config|
|
|
|
627
714
|
end
|
|
628
715
|
|
|
629
716
|
api_instance = TalonOne::ManagementApi.new
|
|
630
|
-
|
|
631
717
|
application_id = 56 # Integer |
|
|
632
|
-
|
|
633
718
|
campaign_id = 56 # Integer |
|
|
634
|
-
|
|
635
|
-
opts = {
|
|
719
|
+
opts = {
|
|
636
720
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
|
637
721
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
|
638
722
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp.
|
|
@@ -645,7 +729,7 @@ opts = {
|
|
|
645
729
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
646
730
|
referral_id: 56, # Integer | 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.
|
|
647
731
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
648
|
-
exact_match: false #
|
|
732
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
649
733
|
}
|
|
650
734
|
|
|
651
735
|
begin
|
|
@@ -658,6 +742,7 @@ end
|
|
|
658
742
|
|
|
659
743
|
### Parameters
|
|
660
744
|
|
|
745
|
+
|
|
661
746
|
Name | Type | Description | Notes
|
|
662
747
|
------------- | ------------- | ------------- | -------------
|
|
663
748
|
**application_id** | **Integer**| |
|
|
@@ -674,7 +759,7 @@ Name | Type | Description | Notes
|
|
|
674
759
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
|
675
760
|
**referral_id** | **Integer**| 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. | [optional]
|
|
676
761
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
677
|
-
**exact_match** | **
|
|
762
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
678
763
|
|
|
679
764
|
### Return type
|
|
680
765
|
|
|
@@ -686,19 +771,18 @@ nil (empty response body)
|
|
|
686
771
|
|
|
687
772
|
### HTTP request headers
|
|
688
773
|
|
|
689
|
-
|
|
690
|
-
|
|
774
|
+
- **Content-Type**: Not defined
|
|
775
|
+
- **Accept**: Not defined
|
|
691
776
|
|
|
692
777
|
|
|
778
|
+
## delete_referral
|
|
693
779
|
|
|
694
|
-
# **delete_referral**
|
|
695
780
|
> delete_referral(application_id, campaign_id, referral_id)
|
|
696
781
|
|
|
697
782
|
Delete one Referral
|
|
698
783
|
|
|
699
|
-
|
|
700
|
-
|
|
701
784
|
### Example
|
|
785
|
+
|
|
702
786
|
```ruby
|
|
703
787
|
# load the gem
|
|
704
788
|
require 'talon_one'
|
|
@@ -711,14 +795,10 @@ TalonOne.configure do |config|
|
|
|
711
795
|
end
|
|
712
796
|
|
|
713
797
|
api_instance = TalonOne::ManagementApi.new
|
|
714
|
-
|
|
715
798
|
application_id = 56 # Integer |
|
|
716
|
-
|
|
717
799
|
campaign_id = 56 # Integer |
|
|
718
|
-
|
|
719
800
|
referral_id = 'referral_id_example' # String | The ID of the referral code to delete
|
|
720
801
|
|
|
721
|
-
|
|
722
802
|
begin
|
|
723
803
|
#Delete one Referral
|
|
724
804
|
api_instance.delete_referral(application_id, campaign_id, referral_id)
|
|
@@ -729,6 +809,7 @@ end
|
|
|
729
809
|
|
|
730
810
|
### Parameters
|
|
731
811
|
|
|
812
|
+
|
|
732
813
|
Name | Type | Description | Notes
|
|
733
814
|
------------- | ------------- | ------------- | -------------
|
|
734
815
|
**application_id** | **Integer**| |
|
|
@@ -745,19 +826,18 @@ nil (empty response body)
|
|
|
745
826
|
|
|
746
827
|
### HTTP request headers
|
|
747
828
|
|
|
748
|
-
|
|
749
|
-
|
|
829
|
+
- **Content-Type**: Not defined
|
|
830
|
+
- **Accept**: Not defined
|
|
750
831
|
|
|
751
832
|
|
|
833
|
+
## delete_ruleset
|
|
752
834
|
|
|
753
|
-
# **delete_ruleset**
|
|
754
835
|
> delete_ruleset(application_id, campaign_id, ruleset_id)
|
|
755
836
|
|
|
756
837
|
Delete a Ruleset
|
|
757
838
|
|
|
758
|
-
|
|
759
|
-
|
|
760
839
|
### Example
|
|
840
|
+
|
|
761
841
|
```ruby
|
|
762
842
|
# load the gem
|
|
763
843
|
require 'talon_one'
|
|
@@ -770,14 +850,10 @@ TalonOne.configure do |config|
|
|
|
770
850
|
end
|
|
771
851
|
|
|
772
852
|
api_instance = TalonOne::ManagementApi.new
|
|
773
|
-
|
|
774
853
|
application_id = 56 # Integer |
|
|
775
|
-
|
|
776
854
|
campaign_id = 56 # Integer |
|
|
777
|
-
|
|
778
855
|
ruleset_id = 56 # Integer |
|
|
779
856
|
|
|
780
|
-
|
|
781
857
|
begin
|
|
782
858
|
#Delete a Ruleset
|
|
783
859
|
api_instance.delete_ruleset(application_id, campaign_id, ruleset_id)
|
|
@@ -788,6 +864,7 @@ end
|
|
|
788
864
|
|
|
789
865
|
### Parameters
|
|
790
866
|
|
|
867
|
+
|
|
791
868
|
Name | Type | Description | Notes
|
|
792
869
|
------------- | ------------- | ------------- | -------------
|
|
793
870
|
**application_id** | **Integer**| |
|
|
@@ -804,19 +881,18 @@ nil (empty response body)
|
|
|
804
881
|
|
|
805
882
|
### HTTP request headers
|
|
806
883
|
|
|
807
|
-
|
|
808
|
-
|
|
884
|
+
- **Content-Type**: Not defined
|
|
885
|
+
- **Accept**: Not defined
|
|
809
886
|
|
|
810
887
|
|
|
888
|
+
## get_access_logs
|
|
811
889
|
|
|
812
|
-
# **get_access_logs**
|
|
813
890
|
> InlineResponse2009 get_access_logs(application_id, range_start, range_end, opts)
|
|
814
891
|
|
|
815
|
-
Get access logs for application
|
|
816
|
-
|
|
817
|
-
|
|
892
|
+
Get access logs for application (with total count)
|
|
818
893
|
|
|
819
894
|
### Example
|
|
895
|
+
|
|
820
896
|
```ruby
|
|
821
897
|
# load the gem
|
|
822
898
|
require 'talon_one'
|
|
@@ -829,16 +905,12 @@ TalonOne.configure do |config|
|
|
|
829
905
|
end
|
|
830
906
|
|
|
831
907
|
api_instance = TalonOne::ManagementApi.new
|
|
832
|
-
|
|
833
908
|
application_id = 56 # Integer |
|
|
834
|
-
|
|
835
909
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
836
|
-
|
|
837
910
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
|
|
911
|
+
opts = {
|
|
912
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
913
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
842
914
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
843
915
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
844
916
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -846,7 +918,7 @@ opts = {
|
|
|
846
918
|
}
|
|
847
919
|
|
|
848
920
|
begin
|
|
849
|
-
#Get access logs for application
|
|
921
|
+
#Get access logs for application (with total count)
|
|
850
922
|
result = api_instance.get_access_logs(application_id, range_start, range_end, opts)
|
|
851
923
|
p result
|
|
852
924
|
rescue TalonOne::ApiError => e
|
|
@@ -856,13 +928,14 @@ end
|
|
|
856
928
|
|
|
857
929
|
### Parameters
|
|
858
930
|
|
|
931
|
+
|
|
859
932
|
Name | Type | Description | Notes
|
|
860
933
|
------------- | ------------- | ------------- | -------------
|
|
861
934
|
**application_id** | **Integer**| |
|
|
862
935
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
863
936
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
|
864
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
|
865
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
|
937
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
938
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
866
939
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
867
940
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
868
941
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -878,19 +951,18 @@ Name | Type | Description | Notes
|
|
|
878
951
|
|
|
879
952
|
### HTTP request headers
|
|
880
953
|
|
|
881
|
-
|
|
882
|
-
|
|
954
|
+
- **Content-Type**: Not defined
|
|
955
|
+
- **Accept**: application/json
|
|
883
956
|
|
|
884
957
|
|
|
958
|
+
## get_access_logs_without_total_count
|
|
885
959
|
|
|
886
|
-
# **get_access_logs_without_total_count**
|
|
887
960
|
> InlineResponse20010 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
|
|
888
961
|
|
|
889
962
|
Get access logs for application
|
|
890
963
|
|
|
891
|
-
|
|
892
|
-
|
|
893
964
|
### Example
|
|
965
|
+
|
|
894
966
|
```ruby
|
|
895
967
|
# load the gem
|
|
896
968
|
require 'talon_one'
|
|
@@ -903,16 +975,12 @@ TalonOne.configure do |config|
|
|
|
903
975
|
end
|
|
904
976
|
|
|
905
977
|
api_instance = TalonOne::ManagementApi.new
|
|
906
|
-
|
|
907
978
|
application_id = 56 # Integer |
|
|
908
|
-
|
|
909
979
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
910
|
-
|
|
911
980
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
|
|
981
|
+
opts = {
|
|
982
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
983
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
916
984
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
917
985
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
918
986
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -930,13 +998,14 @@ end
|
|
|
930
998
|
|
|
931
999
|
### Parameters
|
|
932
1000
|
|
|
1001
|
+
|
|
933
1002
|
Name | Type | Description | Notes
|
|
934
1003
|
------------- | ------------- | ------------- | -------------
|
|
935
1004
|
**application_id** | **Integer**| |
|
|
936
1005
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
937
1006
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
|
938
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
|
939
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
|
1007
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
1008
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
940
1009
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
941
1010
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
942
1011
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -952,12 +1021,12 @@ Name | Type | Description | Notes
|
|
|
952
1021
|
|
|
953
1022
|
### HTTP request headers
|
|
954
1023
|
|
|
955
|
-
|
|
956
|
-
|
|
1024
|
+
- **Content-Type**: Not defined
|
|
1025
|
+
- **Accept**: application/json
|
|
957
1026
|
|
|
958
1027
|
|
|
1028
|
+
## get_account
|
|
959
1029
|
|
|
960
|
-
# **get_account**
|
|
961
1030
|
> Account get_account(account_id)
|
|
962
1031
|
|
|
963
1032
|
Get Account Details
|
|
@@ -965,6 +1034,7 @@ Get Account Details
|
|
|
965
1034
|
Return the details of your companies Talon.One account.
|
|
966
1035
|
|
|
967
1036
|
### Example
|
|
1037
|
+
|
|
968
1038
|
```ruby
|
|
969
1039
|
# load the gem
|
|
970
1040
|
require 'talon_one'
|
|
@@ -977,10 +1047,8 @@ TalonOne.configure do |config|
|
|
|
977
1047
|
end
|
|
978
1048
|
|
|
979
1049
|
api_instance = TalonOne::ManagementApi.new
|
|
980
|
-
|
|
981
1050
|
account_id = 56 # Integer |
|
|
982
1051
|
|
|
983
|
-
|
|
984
1052
|
begin
|
|
985
1053
|
#Get Account Details
|
|
986
1054
|
result = api_instance.get_account(account_id)
|
|
@@ -992,6 +1060,7 @@ end
|
|
|
992
1060
|
|
|
993
1061
|
### Parameters
|
|
994
1062
|
|
|
1063
|
+
|
|
995
1064
|
Name | Type | Description | Notes
|
|
996
1065
|
------------- | ------------- | ------------- | -------------
|
|
997
1066
|
**account_id** | **Integer**| |
|
|
@@ -1006,12 +1075,12 @@ Name | Type | Description | Notes
|
|
|
1006
1075
|
|
|
1007
1076
|
### HTTP request headers
|
|
1008
1077
|
|
|
1009
|
-
|
|
1010
|
-
|
|
1078
|
+
- **Content-Type**: Not defined
|
|
1079
|
+
- **Accept**: application/json
|
|
1011
1080
|
|
|
1012
1081
|
|
|
1082
|
+
## get_account_analytics
|
|
1013
1083
|
|
|
1014
|
-
# **get_account_analytics**
|
|
1015
1084
|
> AccountAnalytics get_account_analytics(account_id)
|
|
1016
1085
|
|
|
1017
1086
|
Get Account Analytics
|
|
@@ -1019,6 +1088,7 @@ Get Account Analytics
|
|
|
1019
1088
|
Return the analytics of your companies Talon.One account.
|
|
1020
1089
|
|
|
1021
1090
|
### Example
|
|
1091
|
+
|
|
1022
1092
|
```ruby
|
|
1023
1093
|
# load the gem
|
|
1024
1094
|
require 'talon_one'
|
|
@@ -1031,10 +1101,8 @@ TalonOne.configure do |config|
|
|
|
1031
1101
|
end
|
|
1032
1102
|
|
|
1033
1103
|
api_instance = TalonOne::ManagementApi.new
|
|
1034
|
-
|
|
1035
1104
|
account_id = 56 # Integer |
|
|
1036
1105
|
|
|
1037
|
-
|
|
1038
1106
|
begin
|
|
1039
1107
|
#Get Account Analytics
|
|
1040
1108
|
result = api_instance.get_account_analytics(account_id)
|
|
@@ -1046,6 +1114,7 @@ end
|
|
|
1046
1114
|
|
|
1047
1115
|
### Parameters
|
|
1048
1116
|
|
|
1117
|
+
|
|
1049
1118
|
Name | Type | Description | Notes
|
|
1050
1119
|
------------- | ------------- | ------------- | -------------
|
|
1051
1120
|
**account_id** | **Integer**| |
|
|
@@ -1060,19 +1129,20 @@ Name | Type | Description | Notes
|
|
|
1060
1129
|
|
|
1061
1130
|
### HTTP request headers
|
|
1062
1131
|
|
|
1063
|
-
|
|
1064
|
-
|
|
1132
|
+
- **Content-Type**: Not defined
|
|
1133
|
+
- **Accept**: application/json
|
|
1065
1134
|
|
|
1066
1135
|
|
|
1136
|
+
## get_additional_cost
|
|
1067
1137
|
|
|
1068
|
-
|
|
1069
|
-
> AccountLimits get_account_limits(account_id)
|
|
1138
|
+
> AccountAdditionalCost get_additional_cost(additional_cost_id)
|
|
1070
1139
|
|
|
1071
|
-
Get
|
|
1140
|
+
Get an additional cost
|
|
1072
1141
|
|
|
1073
|
-
Returns
|
|
1142
|
+
Returns additional cost for the account by its id.
|
|
1074
1143
|
|
|
1075
1144
|
### Example
|
|
1145
|
+
|
|
1076
1146
|
```ruby
|
|
1077
1147
|
# load the gem
|
|
1078
1148
|
require 'talon_one'
|
|
@@ -1085,28 +1155,87 @@ TalonOne.configure do |config|
|
|
|
1085
1155
|
end
|
|
1086
1156
|
|
|
1087
1157
|
api_instance = TalonOne::ManagementApi.new
|
|
1158
|
+
additional_cost_id = 56 # Integer |
|
|
1088
1159
|
|
|
1089
|
-
|
|
1160
|
+
begin
|
|
1161
|
+
#Get an additional cost
|
|
1162
|
+
result = api_instance.get_additional_cost(additional_cost_id)
|
|
1163
|
+
p result
|
|
1164
|
+
rescue TalonOne::ApiError => e
|
|
1165
|
+
puts "Exception when calling ManagementApi->get_additional_cost: #{e}"
|
|
1166
|
+
end
|
|
1167
|
+
```
|
|
1168
|
+
|
|
1169
|
+
### Parameters
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
Name | Type | Description | Notes
|
|
1173
|
+
------------- | ------------- | ------------- | -------------
|
|
1174
|
+
**additional_cost_id** | **Integer**| |
|
|
1175
|
+
|
|
1176
|
+
### Return type
|
|
1177
|
+
|
|
1178
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
1179
|
+
|
|
1180
|
+
### Authorization
|
|
1181
|
+
|
|
1182
|
+
[manager_auth](../README.md#manager_auth)
|
|
1183
|
+
|
|
1184
|
+
### HTTP request headers
|
|
1185
|
+
|
|
1186
|
+
- **Content-Type**: Not defined
|
|
1187
|
+
- **Accept**: application/json
|
|
1090
1188
|
|
|
1091
1189
|
|
|
1190
|
+
## get_additional_costs
|
|
1191
|
+
|
|
1192
|
+
> InlineResponse20021 get_additional_costs(opts)
|
|
1193
|
+
|
|
1194
|
+
List additional costs
|
|
1195
|
+
|
|
1196
|
+
Returns all the defined additional costs for the account.
|
|
1197
|
+
|
|
1198
|
+
### Example
|
|
1199
|
+
|
|
1200
|
+
```ruby
|
|
1201
|
+
# load the gem
|
|
1202
|
+
require 'talon_one'
|
|
1203
|
+
# setup authorization
|
|
1204
|
+
TalonOne.configure do |config|
|
|
1205
|
+
# Configure API key authorization: manager_auth
|
|
1206
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1207
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1208
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1209
|
+
end
|
|
1210
|
+
|
|
1211
|
+
api_instance = TalonOne::ManagementApi.new
|
|
1212
|
+
opts = {
|
|
1213
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1214
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1215
|
+
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
1216
|
+
}
|
|
1217
|
+
|
|
1092
1218
|
begin
|
|
1093
|
-
#
|
|
1094
|
-
result = api_instance.
|
|
1219
|
+
#List additional costs
|
|
1220
|
+
result = api_instance.get_additional_costs(opts)
|
|
1095
1221
|
p result
|
|
1096
1222
|
rescue TalonOne::ApiError => e
|
|
1097
|
-
puts "Exception when calling ManagementApi->
|
|
1223
|
+
puts "Exception when calling ManagementApi->get_additional_costs: #{e}"
|
|
1098
1224
|
end
|
|
1099
1225
|
```
|
|
1100
1226
|
|
|
1101
1227
|
### Parameters
|
|
1102
1228
|
|
|
1229
|
+
|
|
1103
1230
|
Name | Type | Description | Notes
|
|
1104
1231
|
------------- | ------------- | ------------- | -------------
|
|
1105
|
-
**
|
|
1232
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
1233
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
1234
|
+
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
1106
1235
|
|
|
1107
1236
|
### Return type
|
|
1108
1237
|
|
|
1109
|
-
[**
|
|
1238
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
|
1110
1239
|
|
|
1111
1240
|
### Authorization
|
|
1112
1241
|
|
|
@@ -1114,12 +1243,12 @@ Name | Type | Description | Notes
|
|
|
1114
1243
|
|
|
1115
1244
|
### HTTP request headers
|
|
1116
1245
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1246
|
+
- **Content-Type**: Not defined
|
|
1247
|
+
- **Accept**: application/json
|
|
1119
1248
|
|
|
1120
1249
|
|
|
1250
|
+
## get_all_access_logs
|
|
1121
1251
|
|
|
1122
|
-
# **get_all_access_logs**
|
|
1123
1252
|
> InlineResponse2009 get_all_access_logs(range_start, range_end, opts)
|
|
1124
1253
|
|
|
1125
1254
|
Get all access logs
|
|
@@ -1127,6 +1256,7 @@ Get all access logs
|
|
|
1127
1256
|
Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
|
1128
1257
|
|
|
1129
1258
|
### Example
|
|
1259
|
+
|
|
1130
1260
|
```ruby
|
|
1131
1261
|
# load the gem
|
|
1132
1262
|
require 'talon_one'
|
|
@@ -1139,14 +1269,11 @@ TalonOne.configure do |config|
|
|
|
1139
1269
|
end
|
|
1140
1270
|
|
|
1141
1271
|
api_instance = TalonOne::ManagementApi.new
|
|
1142
|
-
|
|
1143
1272
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
1144
|
-
|
|
1145
1273
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
method: 'method_example', # String | Only return results where the request method matches the given regular expresssion.
|
|
1274
|
+
opts = {
|
|
1275
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
1276
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
1150
1277
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
1151
1278
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1152
1279
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -1164,12 +1291,13 @@ end
|
|
|
1164
1291
|
|
|
1165
1292
|
### Parameters
|
|
1166
1293
|
|
|
1294
|
+
|
|
1167
1295
|
Name | Type | Description | Notes
|
|
1168
1296
|
------------- | ------------- | ------------- | -------------
|
|
1169
1297
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
1170
1298
|
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
|
1171
|
-
**path** | **String**| Only return results where the request path matches the given regular
|
|
1172
|
-
**method** | **String**| Only return results where the request method matches the given regular
|
|
1299
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
1300
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
1173
1301
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
1174
1302
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
1175
1303
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -1185,17 +1313,18 @@ Name | Type | Description | Notes
|
|
|
1185
1313
|
|
|
1186
1314
|
### HTTP request headers
|
|
1187
1315
|
|
|
1188
|
-
|
|
1189
|
-
|
|
1316
|
+
- **Content-Type**: Not defined
|
|
1317
|
+
- **Accept**: application/json
|
|
1190
1318
|
|
|
1191
1319
|
|
|
1320
|
+
## get_all_roles
|
|
1192
1321
|
|
|
1193
|
-
|
|
1194
|
-
> InlineResponse20028 get_all_roles
|
|
1322
|
+
> InlineResponse20030 get_all_roles
|
|
1195
1323
|
|
|
1196
1324
|
Get all roles.
|
|
1197
1325
|
|
|
1198
1326
|
### Example
|
|
1327
|
+
|
|
1199
1328
|
```ruby
|
|
1200
1329
|
# load the gem
|
|
1201
1330
|
require 'talon_one'
|
|
@@ -1219,11 +1348,12 @@ end
|
|
|
1219
1348
|
```
|
|
1220
1349
|
|
|
1221
1350
|
### Parameters
|
|
1351
|
+
|
|
1222
1352
|
This endpoint does not need any parameter.
|
|
1223
1353
|
|
|
1224
1354
|
### Return type
|
|
1225
1355
|
|
|
1226
|
-
[**
|
|
1356
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
|
1227
1357
|
|
|
1228
1358
|
### Authorization
|
|
1229
1359
|
|
|
@@ -1231,12 +1361,12 @@ This endpoint does not need any parameter.
|
|
|
1231
1361
|
|
|
1232
1362
|
### HTTP request headers
|
|
1233
1363
|
|
|
1234
|
-
|
|
1235
|
-
|
|
1364
|
+
- **Content-Type**: Not defined
|
|
1365
|
+
- **Accept**: application/json
|
|
1236
1366
|
|
|
1237
1367
|
|
|
1368
|
+
## get_application
|
|
1238
1369
|
|
|
1239
|
-
# **get_application**
|
|
1240
1370
|
> Application get_application(application_id)
|
|
1241
1371
|
|
|
1242
1372
|
Get Application
|
|
@@ -1244,6 +1374,7 @@ Get Application
|
|
|
1244
1374
|
Get the application specified by the ID.
|
|
1245
1375
|
|
|
1246
1376
|
### Example
|
|
1377
|
+
|
|
1247
1378
|
```ruby
|
|
1248
1379
|
# load the gem
|
|
1249
1380
|
require 'talon_one'
|
|
@@ -1256,10 +1387,8 @@ TalonOne.configure do |config|
|
|
|
1256
1387
|
end
|
|
1257
1388
|
|
|
1258
1389
|
api_instance = TalonOne::ManagementApi.new
|
|
1259
|
-
|
|
1260
1390
|
application_id = 56 # Integer |
|
|
1261
1391
|
|
|
1262
|
-
|
|
1263
1392
|
begin
|
|
1264
1393
|
#Get Application
|
|
1265
1394
|
result = api_instance.get_application(application_id)
|
|
@@ -1271,6 +1400,7 @@ end
|
|
|
1271
1400
|
|
|
1272
1401
|
### Parameters
|
|
1273
1402
|
|
|
1403
|
+
|
|
1274
1404
|
Name | Type | Description | Notes
|
|
1275
1405
|
------------- | ------------- | ------------- | -------------
|
|
1276
1406
|
**application_id** | **Integer**| |
|
|
@@ -1285,19 +1415,18 @@ Name | Type | Description | Notes
|
|
|
1285
1415
|
|
|
1286
1416
|
### HTTP request headers
|
|
1287
1417
|
|
|
1288
|
-
|
|
1289
|
-
|
|
1418
|
+
- **Content-Type**: Not defined
|
|
1419
|
+
- **Accept**: application/json
|
|
1290
1420
|
|
|
1291
1421
|
|
|
1422
|
+
## get_application_api_health
|
|
1292
1423
|
|
|
1293
|
-
# **get_application_api_health**
|
|
1294
1424
|
> ApplicationApiHealth get_application_api_health(application_id)
|
|
1295
1425
|
|
|
1296
1426
|
Get report of health of application API
|
|
1297
1427
|
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
1428
|
### Example
|
|
1429
|
+
|
|
1301
1430
|
```ruby
|
|
1302
1431
|
# load the gem
|
|
1303
1432
|
require 'talon_one'
|
|
@@ -1310,10 +1439,8 @@ TalonOne.configure do |config|
|
|
|
1310
1439
|
end
|
|
1311
1440
|
|
|
1312
1441
|
api_instance = TalonOne::ManagementApi.new
|
|
1313
|
-
|
|
1314
1442
|
application_id = 56 # Integer |
|
|
1315
1443
|
|
|
1316
|
-
|
|
1317
1444
|
begin
|
|
1318
1445
|
#Get report of health of application API
|
|
1319
1446
|
result = api_instance.get_application_api_health(application_id)
|
|
@@ -1325,6 +1452,7 @@ end
|
|
|
1325
1452
|
|
|
1326
1453
|
### Parameters
|
|
1327
1454
|
|
|
1455
|
+
|
|
1328
1456
|
Name | Type | Description | Notes
|
|
1329
1457
|
------------- | ------------- | ------------- | -------------
|
|
1330
1458
|
**application_id** | **Integer**| |
|
|
@@ -1339,19 +1467,18 @@ Name | Type | Description | Notes
|
|
|
1339
1467
|
|
|
1340
1468
|
### HTTP request headers
|
|
1341
1469
|
|
|
1342
|
-
|
|
1343
|
-
|
|
1470
|
+
- **Content-Type**: Not defined
|
|
1471
|
+
- **Accept**: application/json
|
|
1344
1472
|
|
|
1345
1473
|
|
|
1474
|
+
## get_application_customer
|
|
1346
1475
|
|
|
1347
|
-
# **get_application_customer**
|
|
1348
1476
|
> ApplicationCustomer get_application_customer(application_id, customer_id)
|
|
1349
1477
|
|
|
1350
|
-
Get Application Customer
|
|
1351
|
-
|
|
1352
|
-
|
|
1478
|
+
Get Application Customer
|
|
1353
1479
|
|
|
1354
1480
|
### Example
|
|
1481
|
+
|
|
1355
1482
|
```ruby
|
|
1356
1483
|
# load the gem
|
|
1357
1484
|
require 'talon_one'
|
|
@@ -1364,12 +1491,9 @@ TalonOne.configure do |config|
|
|
|
1364
1491
|
end
|
|
1365
1492
|
|
|
1366
1493
|
api_instance = TalonOne::ManagementApi.new
|
|
1367
|
-
|
|
1368
1494
|
application_id = 56 # Integer |
|
|
1369
|
-
|
|
1370
1495
|
customer_id = 56 # Integer |
|
|
1371
1496
|
|
|
1372
|
-
|
|
1373
1497
|
begin
|
|
1374
1498
|
#Get Application Customer
|
|
1375
1499
|
result = api_instance.get_application_customer(application_id, customer_id)
|
|
@@ -1381,6 +1505,7 @@ end
|
|
|
1381
1505
|
|
|
1382
1506
|
### Parameters
|
|
1383
1507
|
|
|
1508
|
+
|
|
1384
1509
|
Name | Type | Description | Notes
|
|
1385
1510
|
------------- | ------------- | ------------- | -------------
|
|
1386
1511
|
**application_id** | **Integer**| |
|
|
@@ -1396,19 +1521,18 @@ Name | Type | Description | Notes
|
|
|
1396
1521
|
|
|
1397
1522
|
### HTTP request headers
|
|
1398
1523
|
|
|
1399
|
-
|
|
1400
|
-
|
|
1524
|
+
- **Content-Type**: Not defined
|
|
1525
|
+
- **Accept**: application/json
|
|
1401
1526
|
|
|
1402
1527
|
|
|
1528
|
+
## get_application_customers
|
|
1403
1529
|
|
|
1404
|
-
# **get_application_customers**
|
|
1405
1530
|
> InlineResponse20012 get_application_customers(application_id)
|
|
1406
1531
|
|
|
1407
1532
|
List Application Customers
|
|
1408
1533
|
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
1534
|
### Example
|
|
1535
|
+
|
|
1412
1536
|
```ruby
|
|
1413
1537
|
# load the gem
|
|
1414
1538
|
require 'talon_one'
|
|
@@ -1421,10 +1545,8 @@ TalonOne.configure do |config|
|
|
|
1421
1545
|
end
|
|
1422
1546
|
|
|
1423
1547
|
api_instance = TalonOne::ManagementApi.new
|
|
1424
|
-
|
|
1425
1548
|
application_id = 56 # Integer |
|
|
1426
1549
|
|
|
1427
|
-
|
|
1428
1550
|
begin
|
|
1429
1551
|
#List Application Customers
|
|
1430
1552
|
result = api_instance.get_application_customers(application_id)
|
|
@@ -1436,6 +1558,7 @@ end
|
|
|
1436
1558
|
|
|
1437
1559
|
### Parameters
|
|
1438
1560
|
|
|
1561
|
+
|
|
1439
1562
|
Name | Type | Description | Notes
|
|
1440
1563
|
------------- | ------------- | ------------- | -------------
|
|
1441
1564
|
**application_id** | **Integer**| |
|
|
@@ -1450,19 +1573,20 @@ Name | Type | Description | Notes
|
|
|
1450
1573
|
|
|
1451
1574
|
### HTTP request headers
|
|
1452
1575
|
|
|
1453
|
-
|
|
1454
|
-
|
|
1576
|
+
- **Content-Type**: Not defined
|
|
1577
|
+
- **Accept**: application/json
|
|
1455
1578
|
|
|
1456
1579
|
|
|
1580
|
+
## get_application_customers_by_attributes
|
|
1457
1581
|
|
|
1458
|
-
# **get_application_customers_by_attributes**
|
|
1459
1582
|
> InlineResponse20013 get_application_customers_by_attributes(body)
|
|
1460
1583
|
|
|
1461
|
-
Get a list of the customer profiles that match the given attributes
|
|
1584
|
+
Get a list of the customer profiles that match the given attributes (with total count)
|
|
1462
1585
|
|
|
1463
|
-
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]:
|
|
1586
|
+
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
|
|
1464
1587
|
|
|
1465
1588
|
### Example
|
|
1589
|
+
|
|
1466
1590
|
```ruby
|
|
1467
1591
|
# load the gem
|
|
1468
1592
|
require 'talon_one'
|
|
@@ -1475,12 +1599,10 @@ TalonOne.configure do |config|
|
|
|
1475
1599
|
end
|
|
1476
1600
|
|
|
1477
1601
|
api_instance = TalonOne::ManagementApi.new
|
|
1478
|
-
|
|
1479
1602
|
body = TalonOne::ApplicationCustomerSearch.new # ApplicationCustomerSearch |
|
|
1480
1603
|
|
|
1481
|
-
|
|
1482
1604
|
begin
|
|
1483
|
-
#Get a list of the customer profiles that match the given attributes
|
|
1605
|
+
#Get a list of the customer profiles that match the given attributes (with total count)
|
|
1484
1606
|
result = api_instance.get_application_customers_by_attributes(body)
|
|
1485
1607
|
p result
|
|
1486
1608
|
rescue TalonOne::ApiError => e
|
|
@@ -1490,6 +1612,7 @@ end
|
|
|
1490
1612
|
|
|
1491
1613
|
### Parameters
|
|
1492
1614
|
|
|
1615
|
+
|
|
1493
1616
|
Name | Type | Description | Notes
|
|
1494
1617
|
------------- | ------------- | ------------- | -------------
|
|
1495
1618
|
**body** | [**ApplicationCustomerSearch**](ApplicationCustomerSearch.md)| |
|
|
@@ -1504,12 +1627,12 @@ Name | Type | Description | Notes
|
|
|
1504
1627
|
|
|
1505
1628
|
### HTTP request headers
|
|
1506
1629
|
|
|
1507
|
-
|
|
1508
|
-
|
|
1630
|
+
- **Content-Type**: application/json
|
|
1631
|
+
- **Accept**: application/json
|
|
1509
1632
|
|
|
1510
1633
|
|
|
1634
|
+
## get_application_event_types
|
|
1511
1635
|
|
|
1512
|
-
# **get_application_event_types**
|
|
1513
1636
|
> InlineResponse20019 get_application_event_types(application_id, opts)
|
|
1514
1637
|
|
|
1515
1638
|
List Applications Event Types
|
|
@@ -1517,6 +1640,7 @@ List Applications Event Types
|
|
|
1517
1640
|
Get all of the distinct values of the Event `type` property for events recorded in the application. See also: [Track an event](/integration-api/reference/#trackEvent)
|
|
1518
1641
|
|
|
1519
1642
|
### Example
|
|
1643
|
+
|
|
1520
1644
|
```ruby
|
|
1521
1645
|
# load the gem
|
|
1522
1646
|
require 'talon_one'
|
|
@@ -1529,10 +1653,8 @@ TalonOne.configure do |config|
|
|
|
1529
1653
|
end
|
|
1530
1654
|
|
|
1531
1655
|
api_instance = TalonOne::ManagementApi.new
|
|
1532
|
-
|
|
1533
1656
|
application_id = 56 # Integer |
|
|
1534
|
-
|
|
1535
|
-
opts = {
|
|
1657
|
+
opts = {
|
|
1536
1658
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1537
1659
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1538
1660
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -1549,6 +1671,7 @@ end
|
|
|
1549
1671
|
|
|
1550
1672
|
### Parameters
|
|
1551
1673
|
|
|
1674
|
+
|
|
1552
1675
|
Name | Type | Description | Notes
|
|
1553
1676
|
------------- | ------------- | ------------- | -------------
|
|
1554
1677
|
**application_id** | **Integer**| |
|
|
@@ -1566,19 +1689,20 @@ Name | Type | Description | Notes
|
|
|
1566
1689
|
|
|
1567
1690
|
### HTTP request headers
|
|
1568
1691
|
|
|
1569
|
-
|
|
1570
|
-
|
|
1692
|
+
- **Content-Type**: Not defined
|
|
1693
|
+
- **Accept**: application/json
|
|
1571
1694
|
|
|
1572
1695
|
|
|
1696
|
+
## get_application_events
|
|
1573
1697
|
|
|
1574
|
-
# **get_application_events**
|
|
1575
1698
|
> InlineResponse20017 get_application_events(application_id, opts)
|
|
1576
1699
|
|
|
1577
|
-
List Applications Events
|
|
1700
|
+
List Applications Events (with total count)
|
|
1578
1701
|
|
|
1579
1702
|
Lists all events recorded for an application.
|
|
1580
1703
|
|
|
1581
1704
|
### Example
|
|
1705
|
+
|
|
1582
1706
|
```ruby
|
|
1583
1707
|
# load the gem
|
|
1584
1708
|
require 'talon_one'
|
|
@@ -1591,10 +1715,8 @@ TalonOne.configure do |config|
|
|
|
1591
1715
|
end
|
|
1592
1716
|
|
|
1593
1717
|
api_instance = TalonOne::ManagementApi.new
|
|
1594
|
-
|
|
1595
1718
|
application_id = 56 # Integer |
|
|
1596
|
-
|
|
1597
|
-
opts = {
|
|
1719
|
+
opts = {
|
|
1598
1720
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1599
1721
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1600
1722
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -1605,14 +1727,14 @@ opts = {
|
|
|
1605
1727
|
profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
|
|
1606
1728
|
customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
|
|
1607
1729
|
customer_email: 'customer_email_example', # String | Customer e-mail address filter for events. Will match substrings case-insensitively.
|
|
1608
|
-
|
|
1609
|
-
|
|
1730
|
+
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
1731
|
+
referral_code: 'referral_code_example', # String | Referral code
|
|
1610
1732
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
1611
1733
|
campaign_query: 'campaign_query_example' # String | Campaign name filter for events
|
|
1612
1734
|
}
|
|
1613
1735
|
|
|
1614
1736
|
begin
|
|
1615
|
-
#List Applications Events
|
|
1737
|
+
#List Applications Events (with total count)
|
|
1616
1738
|
result = api_instance.get_application_events(application_id, opts)
|
|
1617
1739
|
p result
|
|
1618
1740
|
rescue TalonOne::ApiError => e
|
|
@@ -1622,6 +1744,7 @@ end
|
|
|
1622
1744
|
|
|
1623
1745
|
### Parameters
|
|
1624
1746
|
|
|
1747
|
+
|
|
1625
1748
|
Name | Type | Description | Notes
|
|
1626
1749
|
------------- | ------------- | ------------- | -------------
|
|
1627
1750
|
**application_id** | **Integer**| |
|
|
@@ -1635,8 +1758,8 @@ Name | Type | Description | Notes
|
|
|
1635
1758
|
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
|
|
1636
1759
|
**customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
|
|
1637
1760
|
**customer_email** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
|
|
1638
|
-
**
|
|
1639
|
-
**
|
|
1761
|
+
**coupon_code** | **String**| Coupon code | [optional]
|
|
1762
|
+
**referral_code** | **String**| Referral code | [optional]
|
|
1640
1763
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
1641
1764
|
**campaign_query** | **String**| Campaign name filter for events | [optional]
|
|
1642
1765
|
|
|
@@ -1650,12 +1773,12 @@ Name | Type | Description | Notes
|
|
|
1650
1773
|
|
|
1651
1774
|
### HTTP request headers
|
|
1652
1775
|
|
|
1653
|
-
|
|
1654
|
-
|
|
1776
|
+
- **Content-Type**: Not defined
|
|
1777
|
+
- **Accept**: application/json
|
|
1655
1778
|
|
|
1656
1779
|
|
|
1780
|
+
## get_application_events_without_total_count
|
|
1657
1781
|
|
|
1658
|
-
# **get_application_events_without_total_count**
|
|
1659
1782
|
> InlineResponse20018 get_application_events_without_total_count(application_id, opts)
|
|
1660
1783
|
|
|
1661
1784
|
List Applications Events
|
|
@@ -1663,6 +1786,7 @@ List Applications Events
|
|
|
1663
1786
|
Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only if there are more results.
|
|
1664
1787
|
|
|
1665
1788
|
### Example
|
|
1789
|
+
|
|
1666
1790
|
```ruby
|
|
1667
1791
|
# load the gem
|
|
1668
1792
|
require 'talon_one'
|
|
@@ -1675,10 +1799,8 @@ TalonOne.configure do |config|
|
|
|
1675
1799
|
end
|
|
1676
1800
|
|
|
1677
1801
|
api_instance = TalonOne::ManagementApi.new
|
|
1678
|
-
|
|
1679
1802
|
application_id = 56 # Integer |
|
|
1680
|
-
|
|
1681
|
-
opts = {
|
|
1803
|
+
opts = {
|
|
1682
1804
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1683
1805
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1684
1806
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -1689,8 +1811,8 @@ opts = {
|
|
|
1689
1811
|
profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
|
|
1690
1812
|
customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
|
|
1691
1813
|
customer_email: 'customer_email_example', # String | Customer e-mail address filter for events. Will match substrings case-insensitively.
|
|
1692
|
-
|
|
1693
|
-
|
|
1814
|
+
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
1815
|
+
referral_code: 'referral_code_example', # String | Referral code
|
|
1694
1816
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
1695
1817
|
campaign_query: 'campaign_query_example' # String | Campaign name filter for events
|
|
1696
1818
|
}
|
|
@@ -1706,6 +1828,7 @@ end
|
|
|
1706
1828
|
|
|
1707
1829
|
### Parameters
|
|
1708
1830
|
|
|
1831
|
+
|
|
1709
1832
|
Name | Type | Description | Notes
|
|
1710
1833
|
------------- | ------------- | ------------- | -------------
|
|
1711
1834
|
**application_id** | **Integer**| |
|
|
@@ -1719,8 +1842,8 @@ Name | Type | Description | Notes
|
|
|
1719
1842
|
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
|
|
1720
1843
|
**customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
|
|
1721
1844
|
**customer_email** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
|
|
1722
|
-
**
|
|
1723
|
-
**
|
|
1845
|
+
**coupon_code** | **String**| Coupon code | [optional]
|
|
1846
|
+
**referral_code** | **String**| Referral code | [optional]
|
|
1724
1847
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
1725
1848
|
**campaign_query** | **String**| Campaign name filter for events | [optional]
|
|
1726
1849
|
|
|
@@ -1734,19 +1857,18 @@ Name | Type | Description | Notes
|
|
|
1734
1857
|
|
|
1735
1858
|
### HTTP request headers
|
|
1736
1859
|
|
|
1737
|
-
|
|
1738
|
-
|
|
1860
|
+
- **Content-Type**: Not defined
|
|
1861
|
+
- **Accept**: application/json
|
|
1739
1862
|
|
|
1740
1863
|
|
|
1864
|
+
## get_application_session
|
|
1741
1865
|
|
|
1742
|
-
# **get_application_session**
|
|
1743
1866
|
> ApplicationSession get_application_session(application_id, session_id)
|
|
1744
1867
|
|
|
1745
1868
|
Get Application Session
|
|
1746
1869
|
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
1870
|
### Example
|
|
1871
|
+
|
|
1750
1872
|
```ruby
|
|
1751
1873
|
# load the gem
|
|
1752
1874
|
require 'talon_one'
|
|
@@ -1759,12 +1881,9 @@ TalonOne.configure do |config|
|
|
|
1759
1881
|
end
|
|
1760
1882
|
|
|
1761
1883
|
api_instance = TalonOne::ManagementApi.new
|
|
1762
|
-
|
|
1763
1884
|
application_id = 56 # Integer |
|
|
1764
|
-
|
|
1765
1885
|
session_id = 56 # Integer |
|
|
1766
1886
|
|
|
1767
|
-
|
|
1768
1887
|
begin
|
|
1769
1888
|
#Get Application Session
|
|
1770
1889
|
result = api_instance.get_application_session(application_id, session_id)
|
|
@@ -1776,6 +1895,7 @@ end
|
|
|
1776
1895
|
|
|
1777
1896
|
### Parameters
|
|
1778
1897
|
|
|
1898
|
+
|
|
1779
1899
|
Name | Type | Description | Notes
|
|
1780
1900
|
------------- | ------------- | ------------- | -------------
|
|
1781
1901
|
**application_id** | **Integer**| |
|
|
@@ -1791,19 +1911,18 @@ Name | Type | Description | Notes
|
|
|
1791
1911
|
|
|
1792
1912
|
### HTTP request headers
|
|
1793
1913
|
|
|
1794
|
-
|
|
1795
|
-
|
|
1914
|
+
- **Content-Type**: Not defined
|
|
1915
|
+
- **Accept**: application/json
|
|
1796
1916
|
|
|
1797
1917
|
|
|
1918
|
+
## get_application_sessions
|
|
1798
1919
|
|
|
1799
|
-
# **get_application_sessions**
|
|
1800
1920
|
> InlineResponse20016 get_application_sessions(application_id, opts)
|
|
1801
1921
|
|
|
1802
1922
|
List Application Sessions
|
|
1803
1923
|
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
1924
|
### Example
|
|
1925
|
+
|
|
1807
1926
|
```ruby
|
|
1808
1927
|
# load the gem
|
|
1809
1928
|
require 'talon_one'
|
|
@@ -1816,16 +1935,17 @@ TalonOne.configure do |config|
|
|
|
1816
1935
|
end
|
|
1817
1936
|
|
|
1818
1937
|
api_instance = TalonOne::ManagementApi.new
|
|
1819
|
-
|
|
1820
1938
|
application_id = 56 # Integer |
|
|
1821
|
-
|
|
1822
|
-
opts = {
|
|
1939
|
+
opts = {
|
|
1823
1940
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1824
1941
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1825
1942
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
1826
1943
|
profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
|
|
1827
1944
|
state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
|
|
1828
|
-
coupon: 'coupon_example' # String | Filter by sessions with this coupon. Must be exact match.
|
|
1945
|
+
coupon: 'coupon_example', # String | Filter by sessions with this coupon. Must be exact match.
|
|
1946
|
+
referral: 'referral_example', # String | Filter by sessions with this referral. Must be exact match.
|
|
1947
|
+
integration_id: 'integration_id_example', # String | Filter by sessions with this integrationId. Must be exact match.
|
|
1948
|
+
customer_id: 'customer_id_example' # String | Filter by integration ID of the customer for the session
|
|
1829
1949
|
}
|
|
1830
1950
|
|
|
1831
1951
|
begin
|
|
@@ -1839,6 +1959,7 @@ end
|
|
|
1839
1959
|
|
|
1840
1960
|
### Parameters
|
|
1841
1961
|
|
|
1962
|
+
|
|
1842
1963
|
Name | Type | Description | Notes
|
|
1843
1964
|
------------- | ------------- | ------------- | -------------
|
|
1844
1965
|
**application_id** | **Integer**| |
|
|
@@ -1848,6 +1969,9 @@ Name | Type | Description | Notes
|
|
|
1848
1969
|
**profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
|
|
1849
1970
|
**state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
|
|
1850
1971
|
**coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
|
|
1972
|
+
**referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
|
|
1973
|
+
**integration_id** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
|
|
1974
|
+
**customer_id** | **String**| Filter by integration ID of the customer for the session | [optional]
|
|
1851
1975
|
|
|
1852
1976
|
### Return type
|
|
1853
1977
|
|
|
@@ -1859,19 +1983,20 @@ Name | Type | Description | Notes
|
|
|
1859
1983
|
|
|
1860
1984
|
### HTTP request headers
|
|
1861
1985
|
|
|
1862
|
-
|
|
1863
|
-
|
|
1986
|
+
- **Content-Type**: Not defined
|
|
1987
|
+
- **Accept**: application/json
|
|
1864
1988
|
|
|
1865
1989
|
|
|
1990
|
+
## get_applications
|
|
1866
1991
|
|
|
1867
|
-
|
|
1868
|
-
> InlineResponse2002 get_applications(opts)
|
|
1992
|
+
> InlineResponse2001 get_applications(opts)
|
|
1869
1993
|
|
|
1870
1994
|
List Applications
|
|
1871
1995
|
|
|
1872
1996
|
List all application in the current account.
|
|
1873
1997
|
|
|
1874
1998
|
### Example
|
|
1999
|
+
|
|
1875
2000
|
```ruby
|
|
1876
2001
|
# load the gem
|
|
1877
2002
|
require 'talon_one'
|
|
@@ -1884,8 +2009,7 @@ TalonOne.configure do |config|
|
|
|
1884
2009
|
end
|
|
1885
2010
|
|
|
1886
2011
|
api_instance = TalonOne::ManagementApi.new
|
|
1887
|
-
|
|
1888
|
-
opts = {
|
|
2012
|
+
opts = {
|
|
1889
2013
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1890
2014
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1891
2015
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -1902,6 +2026,7 @@ end
|
|
|
1902
2026
|
|
|
1903
2027
|
### Parameters
|
|
1904
2028
|
|
|
2029
|
+
|
|
1905
2030
|
Name | Type | Description | Notes
|
|
1906
2031
|
------------- | ------------- | ------------- | -------------
|
|
1907
2032
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -1910,7 +2035,7 @@ Name | Type | Description | Notes
|
|
|
1910
2035
|
|
|
1911
2036
|
### Return type
|
|
1912
2037
|
|
|
1913
|
-
[**
|
|
2038
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
1914
2039
|
|
|
1915
2040
|
### Authorization
|
|
1916
2041
|
|
|
@@ -1918,12 +2043,12 @@ Name | Type | Description | Notes
|
|
|
1918
2043
|
|
|
1919
2044
|
### HTTP request headers
|
|
1920
2045
|
|
|
1921
|
-
|
|
1922
|
-
|
|
2046
|
+
- **Content-Type**: Not defined
|
|
2047
|
+
- **Accept**: application/json
|
|
1923
2048
|
|
|
1924
2049
|
|
|
2050
|
+
## get_attribute
|
|
1925
2051
|
|
|
1926
|
-
# **get_attribute**
|
|
1927
2052
|
> Attribute get_attribute(attribute_id)
|
|
1928
2053
|
|
|
1929
2054
|
Get a custom attribute
|
|
@@ -1931,6 +2056,7 @@ Get a custom attribute
|
|
|
1931
2056
|
Returns custom attribute for the account by its id.
|
|
1932
2057
|
|
|
1933
2058
|
### Example
|
|
2059
|
+
|
|
1934
2060
|
```ruby
|
|
1935
2061
|
# load the gem
|
|
1936
2062
|
require 'talon_one'
|
|
@@ -1943,10 +2069,8 @@ TalonOne.configure do |config|
|
|
|
1943
2069
|
end
|
|
1944
2070
|
|
|
1945
2071
|
api_instance = TalonOne::ManagementApi.new
|
|
1946
|
-
|
|
1947
2072
|
attribute_id = 56 # Integer |
|
|
1948
2073
|
|
|
1949
|
-
|
|
1950
2074
|
begin
|
|
1951
2075
|
#Get a custom attribute
|
|
1952
2076
|
result = api_instance.get_attribute(attribute_id)
|
|
@@ -1958,6 +2082,7 @@ end
|
|
|
1958
2082
|
|
|
1959
2083
|
### Parameters
|
|
1960
2084
|
|
|
2085
|
+
|
|
1961
2086
|
Name | Type | Description | Notes
|
|
1962
2087
|
------------- | ------------- | ------------- | -------------
|
|
1963
2088
|
**attribute_id** | **Integer**| |
|
|
@@ -1972,19 +2097,20 @@ Name | Type | Description | Notes
|
|
|
1972
2097
|
|
|
1973
2098
|
### HTTP request headers
|
|
1974
2099
|
|
|
1975
|
-
|
|
1976
|
-
|
|
2100
|
+
- **Content-Type**: Not defined
|
|
2101
|
+
- **Accept**: application/json
|
|
1977
2102
|
|
|
1978
2103
|
|
|
2104
|
+
## get_attributes
|
|
1979
2105
|
|
|
1980
|
-
|
|
1981
|
-
> Campaign get_campaign(application_id, campaign_id)
|
|
1982
|
-
|
|
1983
|
-
Get a Campaign
|
|
2106
|
+
> InlineResponse20020 get_attributes(opts)
|
|
1984
2107
|
|
|
2108
|
+
List custom attributes
|
|
1985
2109
|
|
|
2110
|
+
Returns all the defined custom attributes for the account.
|
|
1986
2111
|
|
|
1987
2112
|
### Example
|
|
2113
|
+
|
|
1988
2114
|
```ruby
|
|
1989
2115
|
# load the gem
|
|
1990
2116
|
require 'talon_one'
|
|
@@ -1997,31 +2123,33 @@ TalonOne.configure do |config|
|
|
|
1997
2123
|
end
|
|
1998
2124
|
|
|
1999
2125
|
api_instance = TalonOne::ManagementApi.new
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2126
|
+
opts = {
|
|
2127
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2128
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2129
|
+
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
2130
|
+
}
|
|
2005
2131
|
|
|
2006
2132
|
begin
|
|
2007
|
-
#
|
|
2008
|
-
result = api_instance.
|
|
2133
|
+
#List custom attributes
|
|
2134
|
+
result = api_instance.get_attributes(opts)
|
|
2009
2135
|
p result
|
|
2010
2136
|
rescue TalonOne::ApiError => e
|
|
2011
|
-
puts "Exception when calling ManagementApi->
|
|
2137
|
+
puts "Exception when calling ManagementApi->get_attributes: #{e}"
|
|
2012
2138
|
end
|
|
2013
2139
|
```
|
|
2014
2140
|
|
|
2015
2141
|
### Parameters
|
|
2016
2142
|
|
|
2143
|
+
|
|
2017
2144
|
Name | Type | Description | Notes
|
|
2018
2145
|
------------- | ------------- | ------------- | -------------
|
|
2019
|
-
**
|
|
2020
|
-
**
|
|
2146
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
2147
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
2148
|
+
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
2021
2149
|
|
|
2022
2150
|
### Return type
|
|
2023
2151
|
|
|
2024
|
-
[**
|
|
2152
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
|
2025
2153
|
|
|
2026
2154
|
### Authorization
|
|
2027
2155
|
|
|
@@ -2029,19 +2157,18 @@ Name | Type | Description | Notes
|
|
|
2029
2157
|
|
|
2030
2158
|
### HTTP request headers
|
|
2031
2159
|
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2160
|
+
- **Content-Type**: Not defined
|
|
2161
|
+
- **Accept**: application/json
|
|
2036
2162
|
|
|
2037
|
-
# **get_campaign_analytics**
|
|
2038
|
-
> InlineResponse20011 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
|
2039
2163
|
|
|
2040
|
-
|
|
2164
|
+
## get_campaign
|
|
2041
2165
|
|
|
2166
|
+
> Campaign get_campaign(application_id, campaign_id)
|
|
2042
2167
|
|
|
2168
|
+
Get a Campaign
|
|
2043
2169
|
|
|
2044
2170
|
### Example
|
|
2171
|
+
|
|
2045
2172
|
```ruby
|
|
2046
2173
|
# load the gem
|
|
2047
2174
|
require 'talon_one'
|
|
@@ -2054,41 +2181,29 @@ TalonOne.configure do |config|
|
|
|
2054
2181
|
end
|
|
2055
2182
|
|
|
2056
2183
|
api_instance = TalonOne::ManagementApi.new
|
|
2057
|
-
|
|
2058
2184
|
application_id = 56 # Integer |
|
|
2059
|
-
|
|
2060
2185
|
campaign_id = 56 # Integer |
|
|
2061
2186
|
|
|
2062
|
-
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
2063
|
-
|
|
2064
|
-
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
2065
|
-
|
|
2066
|
-
opts = {
|
|
2067
|
-
granularity: 'granularity_example' # String | The time interval between the results in the returned time-series.
|
|
2068
|
-
}
|
|
2069
|
-
|
|
2070
2187
|
begin
|
|
2071
|
-
#Get
|
|
2072
|
-
result = api_instance.
|
|
2188
|
+
#Get a Campaign
|
|
2189
|
+
result = api_instance.get_campaign(application_id, campaign_id)
|
|
2073
2190
|
p result
|
|
2074
2191
|
rescue TalonOne::ApiError => e
|
|
2075
|
-
puts "Exception when calling ManagementApi->
|
|
2192
|
+
puts "Exception when calling ManagementApi->get_campaign: #{e}"
|
|
2076
2193
|
end
|
|
2077
2194
|
```
|
|
2078
2195
|
|
|
2079
2196
|
### Parameters
|
|
2080
2197
|
|
|
2198
|
+
|
|
2081
2199
|
Name | Type | Description | Notes
|
|
2082
2200
|
------------- | ------------- | ------------- | -------------
|
|
2083
2201
|
**application_id** | **Integer**| |
|
|
2084
2202
|
**campaign_id** | **Integer**| |
|
|
2085
|
-
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
2086
|
-
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
|
2087
|
-
**granularity** | **String**| The time interval between the results in the returned time-series. | [optional]
|
|
2088
2203
|
|
|
2089
2204
|
### Return type
|
|
2090
2205
|
|
|
2091
|
-
[**
|
|
2206
|
+
[**Campaign**](Campaign.md)
|
|
2092
2207
|
|
|
2093
2208
|
### Authorization
|
|
2094
2209
|
|
|
@@ -2096,19 +2211,18 @@ Name | Type | Description | Notes
|
|
|
2096
2211
|
|
|
2097
2212
|
### HTTP request headers
|
|
2098
2213
|
|
|
2099
|
-
|
|
2100
|
-
|
|
2214
|
+
- **Content-Type**: Not defined
|
|
2215
|
+
- **Accept**: application/json
|
|
2101
2216
|
|
|
2102
2217
|
|
|
2218
|
+
## get_campaign_analytics
|
|
2103
2219
|
|
|
2104
|
-
|
|
2105
|
-
> InlineResponse2003 get_campaign_by_attributes(application_id, body, opts)
|
|
2106
|
-
|
|
2107
|
-
Get a list of all campaigns that match the given attributes
|
|
2220
|
+
> InlineResponse20011 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
|
2108
2221
|
|
|
2109
|
-
|
|
2222
|
+
Get analytics of campaigns
|
|
2110
2223
|
|
|
2111
2224
|
### Example
|
|
2225
|
+
|
|
2112
2226
|
```ruby
|
|
2113
2227
|
# load the gem
|
|
2114
2228
|
require 'talon_one'
|
|
@@ -2121,41 +2235,37 @@ TalonOne.configure do |config|
|
|
|
2121
2235
|
end
|
|
2122
2236
|
|
|
2123
2237
|
api_instance = TalonOne::ManagementApi.new
|
|
2124
|
-
|
|
2125
2238
|
application_id = 56 # Integer |
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
opts = {
|
|
2130
|
-
|
|
2131
|
-
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2132
|
-
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
2133
|
-
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
2239
|
+
campaign_id = 56 # Integer |
|
|
2240
|
+
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
2241
|
+
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
2242
|
+
opts = {
|
|
2243
|
+
granularity: 'granularity_example' # String | The time interval between the results in the returned time-series.
|
|
2134
2244
|
}
|
|
2135
2245
|
|
|
2136
2246
|
begin
|
|
2137
|
-
#Get
|
|
2138
|
-
result = api_instance.
|
|
2247
|
+
#Get analytics of campaigns
|
|
2248
|
+
result = api_instance.get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
|
2139
2249
|
p result
|
|
2140
2250
|
rescue TalonOne::ApiError => e
|
|
2141
|
-
puts "Exception when calling ManagementApi->
|
|
2251
|
+
puts "Exception when calling ManagementApi->get_campaign_analytics: #{e}"
|
|
2142
2252
|
end
|
|
2143
2253
|
```
|
|
2144
2254
|
|
|
2145
2255
|
### Parameters
|
|
2146
2256
|
|
|
2257
|
+
|
|
2147
2258
|
Name | Type | Description | Notes
|
|
2148
2259
|
------------- | ------------- | ------------- | -------------
|
|
2149
2260
|
**application_id** | **Integer**| |
|
|
2150
|
-
**
|
|
2151
|
-
**
|
|
2152
|
-
**
|
|
2153
|
-
**
|
|
2154
|
-
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
2261
|
+
**campaign_id** | **Integer**| |
|
|
2262
|
+
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
2263
|
+
**range_end** | **DateTime**| Only return results from before this timestamp, must be an RFC3339 timestamp string |
|
|
2264
|
+
**granularity** | **String**| The time interval between the results in the returned time-series. | [optional]
|
|
2155
2265
|
|
|
2156
2266
|
### Return type
|
|
2157
2267
|
|
|
2158
|
-
[**
|
|
2268
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
|
2159
2269
|
|
|
2160
2270
|
### Authorization
|
|
2161
2271
|
|
|
@@ -2163,19 +2273,20 @@ Name | Type | Description | Notes
|
|
|
2163
2273
|
|
|
2164
2274
|
### HTTP request headers
|
|
2165
2275
|
|
|
2166
|
-
|
|
2167
|
-
|
|
2276
|
+
- **Content-Type**: Not defined
|
|
2277
|
+
- **Accept**: application/json
|
|
2168
2278
|
|
|
2169
2279
|
|
|
2280
|
+
## get_campaign_by_attributes
|
|
2170
2281
|
|
|
2171
|
-
|
|
2172
|
-
> CampaignSet get_campaign_set(application_id)
|
|
2173
|
-
|
|
2174
|
-
List CampaignSet
|
|
2282
|
+
> InlineResponse2002 get_campaign_by_attributes(application_id, body, opts)
|
|
2175
2283
|
|
|
2284
|
+
Get a list of all campaigns that match the given attributes
|
|
2176
2285
|
|
|
2286
|
+
Gets a list of all the campaigns that exactly match a set of attributes.
|
|
2177
2287
|
|
|
2178
2288
|
### Example
|
|
2289
|
+
|
|
2179
2290
|
```ruby
|
|
2180
2291
|
# load the gem
|
|
2181
2292
|
require 'talon_one'
|
|
@@ -2188,28 +2299,39 @@ TalonOne.configure do |config|
|
|
|
2188
2299
|
end
|
|
2189
2300
|
|
|
2190
2301
|
api_instance = TalonOne::ManagementApi.new
|
|
2191
|
-
|
|
2192
2302
|
application_id = 56 # Integer |
|
|
2193
|
-
|
|
2303
|
+
body = TalonOne::CampaignSearch.new # CampaignSearch |
|
|
2304
|
+
opts = {
|
|
2305
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2306
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2307
|
+
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
2308
|
+
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
2309
|
+
}
|
|
2194
2310
|
|
|
2195
2311
|
begin
|
|
2196
|
-
#
|
|
2197
|
-
result = api_instance.
|
|
2312
|
+
#Get a list of all campaigns that match the given attributes
|
|
2313
|
+
result = api_instance.get_campaign_by_attributes(application_id, body, opts)
|
|
2198
2314
|
p result
|
|
2199
2315
|
rescue TalonOne::ApiError => e
|
|
2200
|
-
puts "Exception when calling ManagementApi->
|
|
2316
|
+
puts "Exception when calling ManagementApi->get_campaign_by_attributes: #{e}"
|
|
2201
2317
|
end
|
|
2202
2318
|
```
|
|
2203
2319
|
|
|
2204
2320
|
### Parameters
|
|
2205
2321
|
|
|
2322
|
+
|
|
2206
2323
|
Name | Type | Description | Notes
|
|
2207
2324
|
------------- | ------------- | ------------- | -------------
|
|
2208
2325
|
**application_id** | **Integer**| |
|
|
2326
|
+
**body** | [**CampaignSearch**](CampaignSearch.md)| |
|
|
2327
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
2328
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
2329
|
+
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
2330
|
+
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
2209
2331
|
|
|
2210
2332
|
### Return type
|
|
2211
2333
|
|
|
2212
|
-
[**
|
|
2334
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
2213
2335
|
|
|
2214
2336
|
### Authorization
|
|
2215
2337
|
|
|
@@ -2217,19 +2339,18 @@ Name | Type | Description | Notes
|
|
|
2217
2339
|
|
|
2218
2340
|
### HTTP request headers
|
|
2219
2341
|
|
|
2220
|
-
|
|
2221
|
-
|
|
2342
|
+
- **Content-Type**: application/json
|
|
2343
|
+
- **Accept**: application/json
|
|
2222
2344
|
|
|
2223
2345
|
|
|
2346
|
+
## get_campaigns
|
|
2224
2347
|
|
|
2225
|
-
|
|
2226
|
-
> InlineResponse2003 get_campaigns(application_id, opts)
|
|
2348
|
+
> InlineResponse2002 get_campaigns(application_id, opts)
|
|
2227
2349
|
|
|
2228
2350
|
List your Campaigns
|
|
2229
2351
|
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
2352
|
### Example
|
|
2353
|
+
|
|
2233
2354
|
```ruby
|
|
2234
2355
|
# load the gem
|
|
2235
2356
|
require 'talon_one'
|
|
@@ -2242,10 +2363,8 @@ TalonOne.configure do |config|
|
|
|
2242
2363
|
end
|
|
2243
2364
|
|
|
2244
2365
|
api_instance = TalonOne::ManagementApi.new
|
|
2245
|
-
|
|
2246
2366
|
application_id = 56 # Integer |
|
|
2247
|
-
|
|
2248
|
-
opts = {
|
|
2367
|
+
opts = {
|
|
2249
2368
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2250
2369
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2251
2370
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2267,6 +2386,7 @@ end
|
|
|
2267
2386
|
|
|
2268
2387
|
### Parameters
|
|
2269
2388
|
|
|
2389
|
+
|
|
2270
2390
|
Name | Type | Description | Notes
|
|
2271
2391
|
------------- | ------------- | ------------- | -------------
|
|
2272
2392
|
**application_id** | **Integer**| |
|
|
@@ -2281,7 +2401,7 @@ Name | Type | Description | Notes
|
|
|
2281
2401
|
|
|
2282
2402
|
### Return type
|
|
2283
2403
|
|
|
2284
|
-
[**
|
|
2404
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
2285
2405
|
|
|
2286
2406
|
### Authorization
|
|
2287
2407
|
|
|
@@ -2289,19 +2409,20 @@ Name | Type | Description | Notes
|
|
|
2289
2409
|
|
|
2290
2410
|
### HTTP request headers
|
|
2291
2411
|
|
|
2292
|
-
|
|
2293
|
-
|
|
2412
|
+
- **Content-Type**: Not defined
|
|
2413
|
+
- **Accept**: application/json
|
|
2294
2414
|
|
|
2295
2415
|
|
|
2416
|
+
## get_changes
|
|
2296
2417
|
|
|
2297
|
-
|
|
2298
|
-
> InlineResponse20025 get_changes(opts)
|
|
2418
|
+
> InlineResponse20027 get_changes(opts)
|
|
2299
2419
|
|
|
2300
2420
|
Get audit log for an account
|
|
2301
2421
|
|
|
2302
2422
|
Get list of changes caused by API calls for an account. Only accessible for admins.
|
|
2303
2423
|
|
|
2304
2424
|
### Example
|
|
2425
|
+
|
|
2305
2426
|
```ruby
|
|
2306
2427
|
# load the gem
|
|
2307
2428
|
require 'talon_one'
|
|
@@ -2314,11 +2435,15 @@ TalonOne.configure do |config|
|
|
|
2314
2435
|
end
|
|
2315
2436
|
|
|
2316
2437
|
api_instance = TalonOne::ManagementApi.new
|
|
2317
|
-
|
|
2318
|
-
opts = {
|
|
2438
|
+
opts = {
|
|
2319
2439
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2320
2440
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2321
|
-
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
2441
|
+
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
2442
|
+
application_id: 56, # Integer |
|
|
2443
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
|
2444
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp.
|
|
2445
|
+
with_total_result_size: true, # Boolean | 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.
|
|
2446
|
+
include_old: true # Boolean | When this flag is set to false, the state without the change will not be returned. The default value is true.
|
|
2322
2447
|
}
|
|
2323
2448
|
|
|
2324
2449
|
begin
|
|
@@ -2332,15 +2457,21 @@ end
|
|
|
2332
2457
|
|
|
2333
2458
|
### Parameters
|
|
2334
2459
|
|
|
2460
|
+
|
|
2335
2461
|
Name | Type | Description | Notes
|
|
2336
2462
|
------------- | ------------- | ------------- | -------------
|
|
2337
2463
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
2338
2464
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
2339
2465
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
2466
|
+
**application_id** | **Integer**| | [optional]
|
|
2467
|
+
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
|
|
2468
|
+
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
|
|
2469
|
+
**with_total_result_size** | **Boolean**| 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. | [optional]
|
|
2470
|
+
**include_old** | **Boolean**| When this flag is set to false, the state without the change will not be returned. The default value is true. | [optional]
|
|
2340
2471
|
|
|
2341
2472
|
### Return type
|
|
2342
2473
|
|
|
2343
|
-
[**
|
|
2474
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
|
2344
2475
|
|
|
2345
2476
|
### Authorization
|
|
2346
2477
|
|
|
@@ -2348,19 +2479,18 @@ Name | Type | Description | Notes
|
|
|
2348
2479
|
|
|
2349
2480
|
### HTTP request headers
|
|
2350
2481
|
|
|
2351
|
-
|
|
2352
|
-
|
|
2353
|
-
|
|
2482
|
+
- **Content-Type**: Not defined
|
|
2483
|
+
- **Accept**: application/json
|
|
2354
2484
|
|
|
2355
2485
|
|
|
2356
|
-
|
|
2357
|
-
> InlineResponse2001 get_coupons(application_id, campaign_id, opts)
|
|
2358
|
-
|
|
2359
|
-
List Coupons
|
|
2486
|
+
## get_coupons
|
|
2360
2487
|
|
|
2488
|
+
> InlineResponse2004 get_coupons(application_id, campaign_id, opts)
|
|
2361
2489
|
|
|
2490
|
+
List Coupons (with total count)
|
|
2362
2491
|
|
|
2363
2492
|
### Example
|
|
2493
|
+
|
|
2364
2494
|
```ruby
|
|
2365
2495
|
# load the gem
|
|
2366
2496
|
require 'talon_one'
|
|
@@ -2373,12 +2503,9 @@ TalonOne.configure do |config|
|
|
|
2373
2503
|
end
|
|
2374
2504
|
|
|
2375
2505
|
api_instance = TalonOne::ManagementApi.new
|
|
2376
|
-
|
|
2377
2506
|
application_id = 56 # Integer |
|
|
2378
|
-
|
|
2379
2507
|
campaign_id = 56 # Integer |
|
|
2380
|
-
|
|
2381
|
-
opts = {
|
|
2508
|
+
opts = {
|
|
2382
2509
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2383
2510
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2384
2511
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2394,11 +2521,11 @@ opts = {
|
|
|
2394
2521
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
2395
2522
|
referral_id: 56, # Integer | 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.
|
|
2396
2523
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2397
|
-
exact_match: false #
|
|
2524
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2398
2525
|
}
|
|
2399
2526
|
|
|
2400
2527
|
begin
|
|
2401
|
-
#List Coupons
|
|
2528
|
+
#List Coupons (with total count)
|
|
2402
2529
|
result = api_instance.get_coupons(application_id, campaign_id, opts)
|
|
2403
2530
|
p result
|
|
2404
2531
|
rescue TalonOne::ApiError => e
|
|
@@ -2408,6 +2535,7 @@ end
|
|
|
2408
2535
|
|
|
2409
2536
|
### Parameters
|
|
2410
2537
|
|
|
2538
|
+
|
|
2411
2539
|
Name | Type | Description | Notes
|
|
2412
2540
|
------------- | ------------- | ------------- | -------------
|
|
2413
2541
|
**application_id** | **Integer**| |
|
|
@@ -2427,11 +2555,11 @@ Name | Type | Description | Notes
|
|
|
2427
2555
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
|
2428
2556
|
**referral_id** | **Integer**| 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. | [optional]
|
|
2429
2557
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2430
|
-
**exact_match** | **
|
|
2558
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2431
2559
|
|
|
2432
2560
|
### Return type
|
|
2433
2561
|
|
|
2434
|
-
[**
|
|
2562
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2435
2563
|
|
|
2436
2564
|
### Authorization
|
|
2437
2565
|
|
|
@@ -2439,19 +2567,20 @@ Name | Type | Description | Notes
|
|
|
2439
2567
|
|
|
2440
2568
|
### HTTP request headers
|
|
2441
2569
|
|
|
2442
|
-
|
|
2443
|
-
|
|
2570
|
+
- **Content-Type**: Not defined
|
|
2571
|
+
- **Accept**: application/json
|
|
2444
2572
|
|
|
2445
2573
|
|
|
2574
|
+
## get_coupons_by_attributes
|
|
2446
2575
|
|
|
2447
|
-
|
|
2448
|
-
> InlineResponse2001 get_coupons_by_attributes(application_id, campaign_id, body, opts)
|
|
2576
|
+
> InlineResponse2004 get_coupons_by_attributes(application_id, campaign_id, body, opts)
|
|
2449
2577
|
|
|
2450
2578
|
Get a list of the coupons that match the given attributes
|
|
2451
2579
|
|
|
2452
2580
|
Gets a list of all the coupons that exactly match a set of attributes. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request.
|
|
2453
2581
|
|
|
2454
2582
|
### Example
|
|
2583
|
+
|
|
2455
2584
|
```ruby
|
|
2456
2585
|
# load the gem
|
|
2457
2586
|
require 'talon_one'
|
|
@@ -2464,14 +2593,10 @@ TalonOne.configure do |config|
|
|
|
2464
2593
|
end
|
|
2465
2594
|
|
|
2466
2595
|
api_instance = TalonOne::ManagementApi.new
|
|
2467
|
-
|
|
2468
2596
|
application_id = 56 # Integer |
|
|
2469
|
-
|
|
2470
2597
|
campaign_id = 56 # Integer |
|
|
2471
|
-
|
|
2472
2598
|
body = TalonOne::CouponSearch.new # CouponSearch |
|
|
2473
|
-
|
|
2474
|
-
opts = {
|
|
2599
|
+
opts = {
|
|
2475
2600
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2476
2601
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2477
2602
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2482,7 +2607,7 @@ opts = {
|
|
|
2482
2607
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
2483
2608
|
referral_id: 56, # Integer | 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.
|
|
2484
2609
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2485
|
-
exact_match: false, #
|
|
2610
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2486
2611
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
2487
2612
|
}
|
|
2488
2613
|
|
|
@@ -2497,6 +2622,7 @@ end
|
|
|
2497
2622
|
|
|
2498
2623
|
### Parameters
|
|
2499
2624
|
|
|
2625
|
+
|
|
2500
2626
|
Name | Type | Description | Notes
|
|
2501
2627
|
------------- | ------------- | ------------- | -------------
|
|
2502
2628
|
**application_id** | **Integer**| |
|
|
@@ -2512,12 +2638,12 @@ Name | Type | Description | Notes
|
|
|
2512
2638
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
|
2513
2639
|
**referral_id** | **Integer**| 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. | [optional]
|
|
2514
2640
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2515
|
-
**exact_match** | **
|
|
2641
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2516
2642
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2517
2643
|
|
|
2518
2644
|
### Return type
|
|
2519
2645
|
|
|
2520
|
-
[**
|
|
2646
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2521
2647
|
|
|
2522
2648
|
### Authorization
|
|
2523
2649
|
|
|
@@ -2525,19 +2651,20 @@ Name | Type | Description | Notes
|
|
|
2525
2651
|
|
|
2526
2652
|
### HTTP request headers
|
|
2527
2653
|
|
|
2528
|
-
|
|
2529
|
-
|
|
2654
|
+
- **Content-Type**: application/json
|
|
2655
|
+
- **Accept**: application/json
|
|
2530
2656
|
|
|
2531
2657
|
|
|
2658
|
+
## get_coupons_by_attributes_application_wide
|
|
2532
2659
|
|
|
2533
|
-
|
|
2534
|
-
> InlineResponse2001 get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2660
|
+
> InlineResponse2004 get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2535
2661
|
|
|
2536
|
-
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
2662
|
+
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
2537
2663
|
|
|
2538
2664
|
Gets a list of all the coupons with attributes matching the query criteria Application wide
|
|
2539
2665
|
|
|
2540
2666
|
### Example
|
|
2667
|
+
|
|
2541
2668
|
```ruby
|
|
2542
2669
|
# load the gem
|
|
2543
2670
|
require 'talon_one'
|
|
@@ -2550,12 +2677,9 @@ TalonOne.configure do |config|
|
|
|
2550
2677
|
end
|
|
2551
2678
|
|
|
2552
2679
|
api_instance = TalonOne::ManagementApi.new
|
|
2553
|
-
|
|
2554
2680
|
application_id = 56 # Integer |
|
|
2555
|
-
|
|
2556
2681
|
body = TalonOne::CouponSearch.new # CouponSearch |
|
|
2557
|
-
|
|
2558
|
-
opts = {
|
|
2682
|
+
opts = {
|
|
2559
2683
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2560
2684
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2561
2685
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2567,12 +2691,12 @@ opts = {
|
|
|
2567
2691
|
referral_id: 56, # Integer | 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.
|
|
2568
2692
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2569
2693
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
2570
|
-
exact_match: false, #
|
|
2694
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2571
2695
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
2572
2696
|
}
|
|
2573
2697
|
|
|
2574
2698
|
begin
|
|
2575
|
-
#Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
2699
|
+
#Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
2576
2700
|
result = api_instance.get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2577
2701
|
p result
|
|
2578
2702
|
rescue TalonOne::ApiError => e
|
|
@@ -2582,6 +2706,7 @@ end
|
|
|
2582
2706
|
|
|
2583
2707
|
### Parameters
|
|
2584
2708
|
|
|
2709
|
+
|
|
2585
2710
|
Name | Type | Description | Notes
|
|
2586
2711
|
------------- | ------------- | ------------- | -------------
|
|
2587
2712
|
**application_id** | **Integer**| |
|
|
@@ -2597,12 +2722,12 @@ Name | Type | Description | Notes
|
|
|
2597
2722
|
**referral_id** | **Integer**| 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. | [optional]
|
|
2598
2723
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2599
2724
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2600
|
-
**exact_match** | **
|
|
2725
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2601
2726
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
2602
2727
|
|
|
2603
2728
|
### Return type
|
|
2604
2729
|
|
|
2605
|
-
[**
|
|
2730
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2606
2731
|
|
|
2607
2732
|
### Authorization
|
|
2608
2733
|
|
|
@@ -2610,19 +2735,18 @@ Name | Type | Description | Notes
|
|
|
2610
2735
|
|
|
2611
2736
|
### HTTP request headers
|
|
2612
2737
|
|
|
2613
|
-
|
|
2614
|
-
|
|
2738
|
+
- **Content-Type**: application/json
|
|
2739
|
+
- **Accept**: application/json
|
|
2615
2740
|
|
|
2616
2741
|
|
|
2742
|
+
## get_coupons_without_total_count
|
|
2617
2743
|
|
|
2618
|
-
# **get_coupons_without_total_count**
|
|
2619
2744
|
> InlineResponse2005 get_coupons_without_total_count(application_id, campaign_id, opts)
|
|
2620
2745
|
|
|
2621
2746
|
List Coupons
|
|
2622
2747
|
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
2748
|
### Example
|
|
2749
|
+
|
|
2626
2750
|
```ruby
|
|
2627
2751
|
# load the gem
|
|
2628
2752
|
require 'talon_one'
|
|
@@ -2635,12 +2759,9 @@ TalonOne.configure do |config|
|
|
|
2635
2759
|
end
|
|
2636
2760
|
|
|
2637
2761
|
api_instance = TalonOne::ManagementApi.new
|
|
2638
|
-
|
|
2639
2762
|
application_id = 56 # Integer |
|
|
2640
|
-
|
|
2641
2763
|
campaign_id = 56 # Integer |
|
|
2642
|
-
|
|
2643
|
-
opts = {
|
|
2764
|
+
opts = {
|
|
2644
2765
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2645
2766
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2646
2767
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2652,7 +2773,7 @@ opts = {
|
|
|
2652
2773
|
referral_id: 56, # Integer | 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.
|
|
2653
2774
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2654
2775
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
2655
|
-
exact_match: false #
|
|
2776
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2656
2777
|
}
|
|
2657
2778
|
|
|
2658
2779
|
begin
|
|
@@ -2666,6 +2787,7 @@ end
|
|
|
2666
2787
|
|
|
2667
2788
|
### Parameters
|
|
2668
2789
|
|
|
2790
|
+
|
|
2669
2791
|
Name | Type | Description | Notes
|
|
2670
2792
|
------------- | ------------- | ------------- | -------------
|
|
2671
2793
|
**application_id** | **Integer**| |
|
|
@@ -2681,7 +2803,7 @@ Name | Type | Description | Notes
|
|
|
2681
2803
|
**referral_id** | **Integer**| 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. | [optional]
|
|
2682
2804
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2683
2805
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2684
|
-
**exact_match** | **
|
|
2806
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2685
2807
|
|
|
2686
2808
|
### Return type
|
|
2687
2809
|
|
|
@@ -2693,12 +2815,12 @@ Name | Type | Description | Notes
|
|
|
2693
2815
|
|
|
2694
2816
|
### HTTP request headers
|
|
2695
2817
|
|
|
2696
|
-
|
|
2697
|
-
|
|
2818
|
+
- **Content-Type**: Not defined
|
|
2819
|
+
- **Accept**: application/json
|
|
2698
2820
|
|
|
2699
2821
|
|
|
2822
|
+
## get_customer_activity_report
|
|
2700
2823
|
|
|
2701
|
-
# **get_customer_activity_report**
|
|
2702
2824
|
> CustomerActivityReport get_customer_activity_report(range_start, range_end, application_id, customer_id, opts)
|
|
2703
2825
|
|
|
2704
2826
|
Get Activity Report for Single Customer
|
|
@@ -2706,6 +2828,7 @@ Get Activity Report for Single Customer
|
|
|
2706
2828
|
Fetch summary report for single application customer based on a time range
|
|
2707
2829
|
|
|
2708
2830
|
### Example
|
|
2831
|
+
|
|
2709
2832
|
```ruby
|
|
2710
2833
|
# load the gem
|
|
2711
2834
|
require 'talon_one'
|
|
@@ -2718,16 +2841,11 @@ TalonOne.configure do |config|
|
|
|
2718
2841
|
end
|
|
2719
2842
|
|
|
2720
2843
|
api_instance = TalonOne::ManagementApi.new
|
|
2721
|
-
|
|
2722
2844
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
2723
|
-
|
|
2724
2845
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
2725
|
-
|
|
2726
2846
|
application_id = 56 # Integer |
|
|
2727
|
-
|
|
2728
2847
|
customer_id = 56 # Integer |
|
|
2729
|
-
|
|
2730
|
-
opts = {
|
|
2848
|
+
opts = {
|
|
2731
2849
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2732
2850
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
2733
2851
|
}
|
|
@@ -2743,6 +2861,7 @@ end
|
|
|
2743
2861
|
|
|
2744
2862
|
### Parameters
|
|
2745
2863
|
|
|
2864
|
+
|
|
2746
2865
|
Name | Type | Description | Notes
|
|
2747
2866
|
------------- | ------------- | ------------- | -------------
|
|
2748
2867
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2762,19 +2881,20 @@ Name | Type | Description | Notes
|
|
|
2762
2881
|
|
|
2763
2882
|
### HTTP request headers
|
|
2764
2883
|
|
|
2765
|
-
|
|
2766
|
-
|
|
2884
|
+
- **Content-Type**: Not defined
|
|
2885
|
+
- **Accept**: application/json
|
|
2767
2886
|
|
|
2768
2887
|
|
|
2888
|
+
## get_customer_activity_reports
|
|
2769
2889
|
|
|
2770
|
-
# **get_customer_activity_reports**
|
|
2771
2890
|
> InlineResponse20014 get_customer_activity_reports(range_start, range_end, application_id, opts)
|
|
2772
2891
|
|
|
2773
|
-
Get Activity Reports for Application Customers
|
|
2892
|
+
Get Activity Reports for Application Customers (with total count)
|
|
2774
2893
|
|
|
2775
2894
|
Fetch summary reports for all application customers based on a time range
|
|
2776
2895
|
|
|
2777
2896
|
### Example
|
|
2897
|
+
|
|
2778
2898
|
```ruby
|
|
2779
2899
|
# load the gem
|
|
2780
2900
|
require 'talon_one'
|
|
@@ -2787,14 +2907,10 @@ TalonOne.configure do |config|
|
|
|
2787
2907
|
end
|
|
2788
2908
|
|
|
2789
2909
|
api_instance = TalonOne::ManagementApi.new
|
|
2790
|
-
|
|
2791
2910
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
2792
|
-
|
|
2793
2911
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
2794
|
-
|
|
2795
2912
|
application_id = 56 # Integer |
|
|
2796
|
-
|
|
2797
|
-
opts = {
|
|
2913
|
+
opts = {
|
|
2798
2914
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2799
2915
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2800
2916
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2805,7 +2921,7 @@ opts = {
|
|
|
2805
2921
|
}
|
|
2806
2922
|
|
|
2807
2923
|
begin
|
|
2808
|
-
#Get Activity Reports for Application Customers
|
|
2924
|
+
#Get Activity Reports for Application Customers (with total count)
|
|
2809
2925
|
result = api_instance.get_customer_activity_reports(range_start, range_end, application_id, opts)
|
|
2810
2926
|
p result
|
|
2811
2927
|
rescue TalonOne::ApiError => e
|
|
@@ -2815,6 +2931,7 @@ end
|
|
|
2815
2931
|
|
|
2816
2932
|
### Parameters
|
|
2817
2933
|
|
|
2934
|
+
|
|
2818
2935
|
Name | Type | Description | Notes
|
|
2819
2936
|
------------- | ------------- | ------------- | -------------
|
|
2820
2937
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2838,12 +2955,12 @@ Name | Type | Description | Notes
|
|
|
2838
2955
|
|
|
2839
2956
|
### HTTP request headers
|
|
2840
2957
|
|
|
2841
|
-
|
|
2842
|
-
|
|
2958
|
+
- **Content-Type**: Not defined
|
|
2959
|
+
- **Accept**: application/json
|
|
2843
2960
|
|
|
2844
2961
|
|
|
2962
|
+
## get_customer_activity_reports_without_total_count
|
|
2845
2963
|
|
|
2846
|
-
# **get_customer_activity_reports_without_total_count**
|
|
2847
2964
|
> InlineResponse20015 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
|
2848
2965
|
|
|
2849
2966
|
Get Activity Reports for Application Customers
|
|
@@ -2851,6 +2968,7 @@ Get Activity Reports for Application Customers
|
|
|
2851
2968
|
Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only if there are more results.
|
|
2852
2969
|
|
|
2853
2970
|
### Example
|
|
2971
|
+
|
|
2854
2972
|
```ruby
|
|
2855
2973
|
# load the gem
|
|
2856
2974
|
require 'talon_one'
|
|
@@ -2863,14 +2981,10 @@ TalonOne.configure do |config|
|
|
|
2863
2981
|
end
|
|
2864
2982
|
|
|
2865
2983
|
api_instance = TalonOne::ManagementApi.new
|
|
2866
|
-
|
|
2867
2984
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp, must be an RFC3339 timestamp string
|
|
2868
|
-
|
|
2869
2985
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp, must be an RFC3339 timestamp string
|
|
2870
|
-
|
|
2871
2986
|
application_id = 56 # Integer |
|
|
2872
|
-
|
|
2873
|
-
opts = {
|
|
2987
|
+
opts = {
|
|
2874
2988
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2875
2989
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2876
2990
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2891,6 +3005,7 @@ end
|
|
|
2891
3005
|
|
|
2892
3006
|
### Parameters
|
|
2893
3007
|
|
|
3008
|
+
|
|
2894
3009
|
Name | Type | Description | Notes
|
|
2895
3010
|
------------- | ------------- | ------------- | -------------
|
|
2896
3011
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2914,12 +3029,12 @@ Name | Type | Description | Notes
|
|
|
2914
3029
|
|
|
2915
3030
|
### HTTP request headers
|
|
2916
3031
|
|
|
2917
|
-
|
|
2918
|
-
|
|
3032
|
+
- **Content-Type**: Not defined
|
|
3033
|
+
- **Accept**: application/json
|
|
2919
3034
|
|
|
2920
3035
|
|
|
3036
|
+
## get_customer_analytics
|
|
2921
3037
|
|
|
2922
|
-
# **get_customer_analytics**
|
|
2923
3038
|
> CustomerAnalytics get_customer_analytics(application_id, customer_id, opts)
|
|
2924
3039
|
|
|
2925
3040
|
Get Analytics Report for a Customer
|
|
@@ -2927,6 +3042,7 @@ Get Analytics Report for a Customer
|
|
|
2927
3042
|
Fetch analytics for single application customer
|
|
2928
3043
|
|
|
2929
3044
|
### Example
|
|
3045
|
+
|
|
2930
3046
|
```ruby
|
|
2931
3047
|
# load the gem
|
|
2932
3048
|
require 'talon_one'
|
|
@@ -2939,12 +3055,9 @@ TalonOne.configure do |config|
|
|
|
2939
3055
|
end
|
|
2940
3056
|
|
|
2941
3057
|
api_instance = TalonOne::ManagementApi.new
|
|
2942
|
-
|
|
2943
3058
|
application_id = 56 # Integer |
|
|
2944
|
-
|
|
2945
3059
|
customer_id = 56 # Integer |
|
|
2946
|
-
|
|
2947
|
-
opts = {
|
|
3060
|
+
opts = {
|
|
2948
3061
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2949
3062
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2950
3063
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -2961,6 +3074,7 @@ end
|
|
|
2961
3074
|
|
|
2962
3075
|
### Parameters
|
|
2963
3076
|
|
|
3077
|
+
|
|
2964
3078
|
Name | Type | Description | Notes
|
|
2965
3079
|
------------- | ------------- | ------------- | -------------
|
|
2966
3080
|
**application_id** | **Integer**| |
|
|
@@ -2979,19 +3093,18 @@ Name | Type | Description | Notes
|
|
|
2979
3093
|
|
|
2980
3094
|
### HTTP request headers
|
|
2981
3095
|
|
|
2982
|
-
|
|
2983
|
-
|
|
3096
|
+
- **Content-Type**: Not defined
|
|
3097
|
+
- **Accept**: application/json
|
|
2984
3098
|
|
|
2985
3099
|
|
|
3100
|
+
## get_customer_profile
|
|
2986
3101
|
|
|
2987
|
-
# **get_customer_profile**
|
|
2988
3102
|
> ApplicationCustomer get_customer_profile(application_id, customer_id)
|
|
2989
3103
|
|
|
2990
3104
|
Get Customer Profile
|
|
2991
3105
|
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
3106
|
### Example
|
|
3107
|
+
|
|
2995
3108
|
```ruby
|
|
2996
3109
|
# load the gem
|
|
2997
3110
|
require 'talon_one'
|
|
@@ -3004,12 +3117,9 @@ TalonOne.configure do |config|
|
|
|
3004
3117
|
end
|
|
3005
3118
|
|
|
3006
3119
|
api_instance = TalonOne::ManagementApi.new
|
|
3007
|
-
|
|
3008
3120
|
application_id = 56 # Integer |
|
|
3009
|
-
|
|
3010
3121
|
customer_id = 56 # Integer |
|
|
3011
3122
|
|
|
3012
|
-
|
|
3013
3123
|
begin
|
|
3014
3124
|
#Get Customer Profile
|
|
3015
3125
|
result = api_instance.get_customer_profile(application_id, customer_id)
|
|
@@ -3021,6 +3131,7 @@ end
|
|
|
3021
3131
|
|
|
3022
3132
|
### Parameters
|
|
3023
3133
|
|
|
3134
|
+
|
|
3024
3135
|
Name | Type | Description | Notes
|
|
3025
3136
|
------------- | ------------- | ------------- | -------------
|
|
3026
3137
|
**application_id** | **Integer**| |
|
|
@@ -3036,19 +3147,18 @@ Name | Type | Description | Notes
|
|
|
3036
3147
|
|
|
3037
3148
|
### HTTP request headers
|
|
3038
3149
|
|
|
3039
|
-
|
|
3040
|
-
|
|
3150
|
+
- **Content-Type**: Not defined
|
|
3151
|
+
- **Accept**: application/json
|
|
3041
3152
|
|
|
3042
3153
|
|
|
3154
|
+
## get_customer_profiles
|
|
3043
3155
|
|
|
3044
|
-
# **get_customer_profiles**
|
|
3045
3156
|
> InlineResponse20013 get_customer_profiles(opts)
|
|
3046
3157
|
|
|
3047
3158
|
List Customer Profiles
|
|
3048
3159
|
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
3160
|
### Example
|
|
3161
|
+
|
|
3052
3162
|
```ruby
|
|
3053
3163
|
# load the gem
|
|
3054
3164
|
require 'talon_one'
|
|
@@ -3061,8 +3171,7 @@ TalonOne.configure do |config|
|
|
|
3061
3171
|
end
|
|
3062
3172
|
|
|
3063
3173
|
api_instance = TalonOne::ManagementApi.new
|
|
3064
|
-
|
|
3065
|
-
opts = {
|
|
3174
|
+
opts = {
|
|
3066
3175
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3067
3176
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3068
3177
|
}
|
|
@@ -3078,6 +3187,7 @@ end
|
|
|
3078
3187
|
|
|
3079
3188
|
### Parameters
|
|
3080
3189
|
|
|
3190
|
+
|
|
3081
3191
|
Name | Type | Description | Notes
|
|
3082
3192
|
------------- | ------------- | ------------- | -------------
|
|
3083
3193
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3093,19 +3203,20 @@ Name | Type | Description | Notes
|
|
|
3093
3203
|
|
|
3094
3204
|
### HTTP request headers
|
|
3095
3205
|
|
|
3096
|
-
|
|
3097
|
-
|
|
3206
|
+
- **Content-Type**: Not defined
|
|
3207
|
+
- **Accept**: application/json
|
|
3098
3208
|
|
|
3099
3209
|
|
|
3210
|
+
## get_customers_by_attributes
|
|
3100
3211
|
|
|
3101
|
-
# **get_customers_by_attributes**
|
|
3102
3212
|
> InlineResponse20013 get_customers_by_attributes(body, opts)
|
|
3103
3213
|
|
|
3104
3214
|
Get a list of the customer profiles that match the given attributes
|
|
3105
3215
|
|
|
3106
|
-
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]:
|
|
3216
|
+
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
|
|
3107
3217
|
|
|
3108
3218
|
### Example
|
|
3219
|
+
|
|
3109
3220
|
```ruby
|
|
3110
3221
|
# load the gem
|
|
3111
3222
|
require 'talon_one'
|
|
@@ -3118,10 +3229,8 @@ TalonOne.configure do |config|
|
|
|
3118
3229
|
end
|
|
3119
3230
|
|
|
3120
3231
|
api_instance = TalonOne::ManagementApi.new
|
|
3121
|
-
|
|
3122
3232
|
body = TalonOne::ApplicationCustomerSearch.new # ApplicationCustomerSearch |
|
|
3123
|
-
|
|
3124
|
-
opts = {
|
|
3233
|
+
opts = {
|
|
3125
3234
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3126
3235
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3127
3236
|
}
|
|
@@ -3137,6 +3246,7 @@ end
|
|
|
3137
3246
|
|
|
3138
3247
|
### Parameters
|
|
3139
3248
|
|
|
3249
|
+
|
|
3140
3250
|
Name | Type | Description | Notes
|
|
3141
3251
|
------------- | ------------- | ------------- | -------------
|
|
3142
3252
|
**body** | [**ApplicationCustomerSearch**](ApplicationCustomerSearch.md)| |
|
|
@@ -3153,19 +3263,20 @@ Name | Type | Description | Notes
|
|
|
3153
3263
|
|
|
3154
3264
|
### HTTP request headers
|
|
3155
3265
|
|
|
3156
|
-
|
|
3157
|
-
|
|
3266
|
+
- **Content-Type**: application/json
|
|
3267
|
+
- **Accept**: application/json
|
|
3158
3268
|
|
|
3159
3269
|
|
|
3270
|
+
## get_event_types
|
|
3160
3271
|
|
|
3161
|
-
|
|
3162
|
-
> InlineResponse20023 get_event_types(opts)
|
|
3272
|
+
> InlineResponse20025 get_event_types(opts)
|
|
3163
3273
|
|
|
3164
3274
|
List Event Types
|
|
3165
3275
|
|
|
3166
3276
|
Fetch all event type definitions for your account. Each event type can be
|
|
3167
3277
|
|
|
3168
3278
|
### Example
|
|
3279
|
+
|
|
3169
3280
|
```ruby
|
|
3170
3281
|
# load the gem
|
|
3171
3282
|
require 'talon_one'
|
|
@@ -3178,11 +3289,10 @@ TalonOne.configure do |config|
|
|
|
3178
3289
|
end
|
|
3179
3290
|
|
|
3180
3291
|
api_instance = TalonOne::ManagementApi.new
|
|
3181
|
-
|
|
3182
|
-
opts = {
|
|
3292
|
+
opts = {
|
|
3183
3293
|
application_ids: 'application_ids_example', # String | Filter by one or more application ids separated by comma
|
|
3184
3294
|
name: 'name_example', # String | Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
|
3185
|
-
include_old_versions: false, #
|
|
3295
|
+
include_old_versions: false, # Boolean | Include all versions of every event type.
|
|
3186
3296
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3187
3297
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3188
3298
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -3199,18 +3309,19 @@ end
|
|
|
3199
3309
|
|
|
3200
3310
|
### Parameters
|
|
3201
3311
|
|
|
3312
|
+
|
|
3202
3313
|
Name | Type | Description | Notes
|
|
3203
3314
|
------------- | ------------- | ------------- | -------------
|
|
3204
3315
|
**application_ids** | **String**| Filter by one or more application ids separated by comma | [optional]
|
|
3205
3316
|
**name** | **String**| Filter results to event types with the given name. This parameter implies `includeOldVersions`. | [optional]
|
|
3206
|
-
**include_old_versions** | **
|
|
3317
|
+
**include_old_versions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
|
|
3207
3318
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
3208
3319
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
3209
3320
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
3210
3321
|
|
|
3211
3322
|
### Return type
|
|
3212
3323
|
|
|
3213
|
-
[**
|
|
3324
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
|
3214
3325
|
|
|
3215
3326
|
### Authorization
|
|
3216
3327
|
|
|
@@ -3218,19 +3329,20 @@ Name | Type | Description | Notes
|
|
|
3218
3329
|
|
|
3219
3330
|
### HTTP request headers
|
|
3220
3331
|
|
|
3221
|
-
|
|
3222
|
-
|
|
3332
|
+
- **Content-Type**: Not defined
|
|
3333
|
+
- **Accept**: application/json
|
|
3223
3334
|
|
|
3224
3335
|
|
|
3336
|
+
## get_exports
|
|
3225
3337
|
|
|
3226
|
-
|
|
3227
|
-
> InlineResponse20026 get_exports(opts)
|
|
3338
|
+
> InlineResponse20028 get_exports(opts)
|
|
3228
3339
|
|
|
3229
3340
|
Get Exports
|
|
3230
3341
|
|
|
3231
3342
|
Get a list of all past exports
|
|
3232
3343
|
|
|
3233
3344
|
### Example
|
|
3345
|
+
|
|
3234
3346
|
```ruby
|
|
3235
3347
|
# load the gem
|
|
3236
3348
|
require 'talon_one'
|
|
@@ -3243,8 +3355,7 @@ TalonOne.configure do |config|
|
|
|
3243
3355
|
end
|
|
3244
3356
|
|
|
3245
3357
|
api_instance = TalonOne::ManagementApi.new
|
|
3246
|
-
|
|
3247
|
-
opts = {
|
|
3358
|
+
opts = {
|
|
3248
3359
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3249
3360
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3250
3361
|
application_id: 56, # Integer |
|
|
@@ -3263,6 +3374,7 @@ end
|
|
|
3263
3374
|
|
|
3264
3375
|
### Parameters
|
|
3265
3376
|
|
|
3377
|
+
|
|
3266
3378
|
Name | Type | Description | Notes
|
|
3267
3379
|
------------- | ------------- | ------------- | -------------
|
|
3268
3380
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3273,7 +3385,7 @@ Name | Type | Description | Notes
|
|
|
3273
3385
|
|
|
3274
3386
|
### Return type
|
|
3275
3387
|
|
|
3276
|
-
[**
|
|
3388
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
|
3277
3389
|
|
|
3278
3390
|
### Authorization
|
|
3279
3391
|
|
|
@@ -3281,19 +3393,20 @@ Name | Type | Description | Notes
|
|
|
3281
3393
|
|
|
3282
3394
|
### HTTP request headers
|
|
3283
3395
|
|
|
3284
|
-
|
|
3285
|
-
|
|
3396
|
+
- **Content-Type**: Not defined
|
|
3397
|
+
- **Accept**: application/json
|
|
3286
3398
|
|
|
3287
3399
|
|
|
3400
|
+
## get_imports
|
|
3288
3401
|
|
|
3289
|
-
|
|
3290
|
-
> InlineResponse20027 get_imports(opts)
|
|
3402
|
+
> InlineResponse20029 get_imports(opts)
|
|
3291
3403
|
|
|
3292
3404
|
Get Imports
|
|
3293
3405
|
|
|
3294
3406
|
Get a list of all past imports
|
|
3295
3407
|
|
|
3296
3408
|
### Example
|
|
3409
|
+
|
|
3297
3410
|
```ruby
|
|
3298
3411
|
# load the gem
|
|
3299
3412
|
require 'talon_one'
|
|
@@ -3306,8 +3419,7 @@ TalonOne.configure do |config|
|
|
|
3306
3419
|
end
|
|
3307
3420
|
|
|
3308
3421
|
api_instance = TalonOne::ManagementApi.new
|
|
3309
|
-
|
|
3310
|
-
opts = {
|
|
3422
|
+
opts = {
|
|
3311
3423
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3312
3424
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3313
3425
|
}
|
|
@@ -3323,6 +3435,7 @@ end
|
|
|
3323
3435
|
|
|
3324
3436
|
### Parameters
|
|
3325
3437
|
|
|
3438
|
+
|
|
3326
3439
|
Name | Type | Description | Notes
|
|
3327
3440
|
------------- | ------------- | ------------- | -------------
|
|
3328
3441
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3330,7 +3443,7 @@ Name | Type | Description | Notes
|
|
|
3330
3443
|
|
|
3331
3444
|
### Return type
|
|
3332
3445
|
|
|
3333
|
-
[**
|
|
3446
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
|
3334
3447
|
|
|
3335
3448
|
### Authorization
|
|
3336
3449
|
|
|
@@ -3338,12 +3451,12 @@ Name | Type | Description | Notes
|
|
|
3338
3451
|
|
|
3339
3452
|
### HTTP request headers
|
|
3340
3453
|
|
|
3341
|
-
|
|
3342
|
-
|
|
3454
|
+
- **Content-Type**: Not defined
|
|
3455
|
+
- **Accept**: application/json
|
|
3343
3456
|
|
|
3344
3457
|
|
|
3458
|
+
## get_loyalty_points
|
|
3345
3459
|
|
|
3346
|
-
# **get_loyalty_points**
|
|
3347
3460
|
> LoyaltyLedger get_loyalty_points(program_id, integration_id)
|
|
3348
3461
|
|
|
3349
3462
|
get the Loyalty Ledger for this integrationID
|
|
@@ -3351,6 +3464,7 @@ get the Loyalty Ledger for this integrationID
|
|
|
3351
3464
|
Get the Loyalty Ledger for this profile integration ID.
|
|
3352
3465
|
|
|
3353
3466
|
### Example
|
|
3467
|
+
|
|
3354
3468
|
```ruby
|
|
3355
3469
|
# load the gem
|
|
3356
3470
|
require 'talon_one'
|
|
@@ -3363,12 +3477,9 @@ TalonOne.configure do |config|
|
|
|
3363
3477
|
end
|
|
3364
3478
|
|
|
3365
3479
|
api_instance = TalonOne::ManagementApi.new
|
|
3366
|
-
|
|
3367
3480
|
program_id = 'program_id_example' # String | The identifier for the application, must be unique within the account.
|
|
3368
|
-
|
|
3369
3481
|
integration_id = 'integration_id_example' # String | The identifier for the application, must be unique within the account.
|
|
3370
3482
|
|
|
3371
|
-
|
|
3372
3483
|
begin
|
|
3373
3484
|
#get the Loyalty Ledger for this integrationID
|
|
3374
3485
|
result = api_instance.get_loyalty_points(program_id, integration_id)
|
|
@@ -3380,6 +3491,7 @@ end
|
|
|
3380
3491
|
|
|
3381
3492
|
### Parameters
|
|
3382
3493
|
|
|
3494
|
+
|
|
3383
3495
|
Name | Type | Description | Notes
|
|
3384
3496
|
------------- | ------------- | ------------- | -------------
|
|
3385
3497
|
**program_id** | **String**| The identifier for the application, must be unique within the account. |
|
|
@@ -3395,19 +3507,18 @@ Name | Type | Description | Notes
|
|
|
3395
3507
|
|
|
3396
3508
|
### HTTP request headers
|
|
3397
3509
|
|
|
3398
|
-
|
|
3399
|
-
|
|
3510
|
+
- **Content-Type**: Not defined
|
|
3511
|
+
- **Accept**: application/json
|
|
3400
3512
|
|
|
3401
3513
|
|
|
3514
|
+
## get_loyalty_program
|
|
3402
3515
|
|
|
3403
|
-
# **get_loyalty_program**
|
|
3404
3516
|
> LoyaltyProgram get_loyalty_program(program_id)
|
|
3405
3517
|
|
|
3406
3518
|
Get a loyalty program
|
|
3407
3519
|
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
3520
|
### Example
|
|
3521
|
+
|
|
3411
3522
|
```ruby
|
|
3412
3523
|
# load the gem
|
|
3413
3524
|
require 'talon_one'
|
|
@@ -3420,10 +3531,8 @@ TalonOne.configure do |config|
|
|
|
3420
3531
|
end
|
|
3421
3532
|
|
|
3422
3533
|
api_instance = TalonOne::ManagementApi.new
|
|
3423
|
-
|
|
3424
3534
|
program_id = 'program_id_example' # String |
|
|
3425
3535
|
|
|
3426
|
-
|
|
3427
3536
|
begin
|
|
3428
3537
|
#Get a loyalty program
|
|
3429
3538
|
result = api_instance.get_loyalty_program(program_id)
|
|
@@ -3435,6 +3544,7 @@ end
|
|
|
3435
3544
|
|
|
3436
3545
|
### Parameters
|
|
3437
3546
|
|
|
3547
|
+
|
|
3438
3548
|
Name | Type | Description | Notes
|
|
3439
3549
|
------------- | ------------- | ------------- | -------------
|
|
3440
3550
|
**program_id** | **String**| |
|
|
@@ -3449,19 +3559,18 @@ Name | Type | Description | Notes
|
|
|
3449
3559
|
|
|
3450
3560
|
### HTTP request headers
|
|
3451
3561
|
|
|
3452
|
-
|
|
3453
|
-
|
|
3562
|
+
- **Content-Type**: Not defined
|
|
3563
|
+
- **Accept**: application/json
|
|
3454
3564
|
|
|
3455
3565
|
|
|
3566
|
+
## get_loyalty_programs
|
|
3456
3567
|
|
|
3457
|
-
# **get_loyalty_programs**
|
|
3458
3568
|
> InlineResponse2008 get_loyalty_programs
|
|
3459
3569
|
|
|
3460
3570
|
List all loyalty Programs
|
|
3461
3571
|
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
3572
|
### Example
|
|
3573
|
+
|
|
3465
3574
|
```ruby
|
|
3466
3575
|
# load the gem
|
|
3467
3576
|
require 'talon_one'
|
|
@@ -3485,6 +3594,7 @@ end
|
|
|
3485
3594
|
```
|
|
3486
3595
|
|
|
3487
3596
|
### Parameters
|
|
3597
|
+
|
|
3488
3598
|
This endpoint does not need any parameter.
|
|
3489
3599
|
|
|
3490
3600
|
### Return type
|
|
@@ -3497,19 +3607,18 @@ This endpoint does not need any parameter.
|
|
|
3497
3607
|
|
|
3498
3608
|
### HTTP request headers
|
|
3499
3609
|
|
|
3500
|
-
|
|
3501
|
-
|
|
3610
|
+
- **Content-Type**: Not defined
|
|
3611
|
+
- **Accept**: application/json
|
|
3502
3612
|
|
|
3503
3613
|
|
|
3614
|
+
## get_referrals
|
|
3504
3615
|
|
|
3505
|
-
# **get_referrals**
|
|
3506
3616
|
> InlineResponse2006 get_referrals(application_id, campaign_id, opts)
|
|
3507
3617
|
|
|
3508
|
-
List Referrals
|
|
3509
|
-
|
|
3510
|
-
|
|
3618
|
+
List Referrals (with total count)
|
|
3511
3619
|
|
|
3512
3620
|
### Example
|
|
3621
|
+
|
|
3513
3622
|
```ruby
|
|
3514
3623
|
# load the gem
|
|
3515
3624
|
require 'talon_one'
|
|
@@ -3522,12 +3631,9 @@ TalonOne.configure do |config|
|
|
|
3522
3631
|
end
|
|
3523
3632
|
|
|
3524
3633
|
api_instance = TalonOne::ManagementApi.new
|
|
3525
|
-
|
|
3526
3634
|
application_id = 56 # Integer |
|
|
3527
|
-
|
|
3528
3635
|
campaign_id = 56 # Integer |
|
|
3529
|
-
|
|
3530
|
-
opts = {
|
|
3636
|
+
opts = {
|
|
3531
3637
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3532
3638
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3533
3639
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -3540,7 +3646,7 @@ opts = {
|
|
|
3540
3646
|
}
|
|
3541
3647
|
|
|
3542
3648
|
begin
|
|
3543
|
-
#List Referrals
|
|
3649
|
+
#List Referrals (with total count)
|
|
3544
3650
|
result = api_instance.get_referrals(application_id, campaign_id, opts)
|
|
3545
3651
|
p result
|
|
3546
3652
|
rescue TalonOne::ApiError => e
|
|
@@ -3550,6 +3656,7 @@ end
|
|
|
3550
3656
|
|
|
3551
3657
|
### Parameters
|
|
3552
3658
|
|
|
3659
|
+
|
|
3553
3660
|
Name | Type | Description | Notes
|
|
3554
3661
|
------------- | ------------- | ------------- | -------------
|
|
3555
3662
|
**application_id** | **Integer**| |
|
|
@@ -3574,19 +3681,18 @@ Name | Type | Description | Notes
|
|
|
3574
3681
|
|
|
3575
3682
|
### HTTP request headers
|
|
3576
3683
|
|
|
3577
|
-
|
|
3578
|
-
|
|
3684
|
+
- **Content-Type**: Not defined
|
|
3685
|
+
- **Accept**: application/json
|
|
3579
3686
|
|
|
3580
3687
|
|
|
3688
|
+
## get_referrals_without_total_count
|
|
3581
3689
|
|
|
3582
|
-
# **get_referrals_without_total_count**
|
|
3583
3690
|
> InlineResponse2007 get_referrals_without_total_count(application_id, campaign_id, opts)
|
|
3584
3691
|
|
|
3585
3692
|
List Referrals
|
|
3586
3693
|
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
3694
|
### Example
|
|
3695
|
+
|
|
3590
3696
|
```ruby
|
|
3591
3697
|
# load the gem
|
|
3592
3698
|
require 'talon_one'
|
|
@@ -3599,12 +3705,9 @@ TalonOne.configure do |config|
|
|
|
3599
3705
|
end
|
|
3600
3706
|
|
|
3601
3707
|
api_instance = TalonOne::ManagementApi.new
|
|
3602
|
-
|
|
3603
3708
|
application_id = 56 # Integer |
|
|
3604
|
-
|
|
3605
3709
|
campaign_id = 56 # Integer |
|
|
3606
|
-
|
|
3607
|
-
opts = {
|
|
3710
|
+
opts = {
|
|
3608
3711
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3609
3712
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3610
3713
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -3627,6 +3730,7 @@ end
|
|
|
3627
3730
|
|
|
3628
3731
|
### Parameters
|
|
3629
3732
|
|
|
3733
|
+
|
|
3630
3734
|
Name | Type | Description | Notes
|
|
3631
3735
|
------------- | ------------- | ------------- | -------------
|
|
3632
3736
|
**application_id** | **Integer**| |
|
|
@@ -3651,17 +3755,18 @@ Name | Type | Description | Notes
|
|
|
3651
3755
|
|
|
3652
3756
|
### HTTP request headers
|
|
3653
3757
|
|
|
3654
|
-
|
|
3655
|
-
|
|
3758
|
+
- **Content-Type**: Not defined
|
|
3759
|
+
- **Accept**: application/json
|
|
3656
3760
|
|
|
3657
3761
|
|
|
3762
|
+
## get_role
|
|
3658
3763
|
|
|
3659
|
-
# **get_role**
|
|
3660
3764
|
> Role get_role(role_id)
|
|
3661
3765
|
|
|
3662
3766
|
Get information for the specified role.
|
|
3663
3767
|
|
|
3664
3768
|
### Example
|
|
3769
|
+
|
|
3665
3770
|
```ruby
|
|
3666
3771
|
# load the gem
|
|
3667
3772
|
require 'talon_one'
|
|
@@ -3674,10 +3779,8 @@ TalonOne.configure do |config|
|
|
|
3674
3779
|
end
|
|
3675
3780
|
|
|
3676
3781
|
api_instance = TalonOne::ManagementApi.new
|
|
3677
|
-
|
|
3678
3782
|
role_id = 56 # Integer |
|
|
3679
3783
|
|
|
3680
|
-
|
|
3681
3784
|
begin
|
|
3682
3785
|
#Get information for the specified role.
|
|
3683
3786
|
result = api_instance.get_role(role_id)
|
|
@@ -3689,6 +3792,7 @@ end
|
|
|
3689
3792
|
|
|
3690
3793
|
### Parameters
|
|
3691
3794
|
|
|
3795
|
+
|
|
3692
3796
|
Name | Type | Description | Notes
|
|
3693
3797
|
------------- | ------------- | ------------- | -------------
|
|
3694
3798
|
**role_id** | **Integer**| |
|
|
@@ -3703,19 +3807,18 @@ Name | Type | Description | Notes
|
|
|
3703
3807
|
|
|
3704
3808
|
### HTTP request headers
|
|
3705
3809
|
|
|
3706
|
-
|
|
3707
|
-
|
|
3810
|
+
- **Content-Type**: Not defined
|
|
3811
|
+
- **Accept**: application/json
|
|
3708
3812
|
|
|
3709
3813
|
|
|
3814
|
+
## get_ruleset
|
|
3710
3815
|
|
|
3711
|
-
# **get_ruleset**
|
|
3712
3816
|
> Ruleset get_ruleset(application_id, campaign_id, ruleset_id)
|
|
3713
3817
|
|
|
3714
3818
|
Get a Ruleset
|
|
3715
3819
|
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
3820
|
### Example
|
|
3821
|
+
|
|
3719
3822
|
```ruby
|
|
3720
3823
|
# load the gem
|
|
3721
3824
|
require 'talon_one'
|
|
@@ -3728,14 +3831,10 @@ TalonOne.configure do |config|
|
|
|
3728
3831
|
end
|
|
3729
3832
|
|
|
3730
3833
|
api_instance = TalonOne::ManagementApi.new
|
|
3731
|
-
|
|
3732
3834
|
application_id = 56 # Integer |
|
|
3733
|
-
|
|
3734
3835
|
campaign_id = 56 # Integer |
|
|
3735
|
-
|
|
3736
3836
|
ruleset_id = 56 # Integer |
|
|
3737
3837
|
|
|
3738
|
-
|
|
3739
3838
|
begin
|
|
3740
3839
|
#Get a Ruleset
|
|
3741
3840
|
result = api_instance.get_ruleset(application_id, campaign_id, ruleset_id)
|
|
@@ -3747,6 +3846,7 @@ end
|
|
|
3747
3846
|
|
|
3748
3847
|
### Parameters
|
|
3749
3848
|
|
|
3849
|
+
|
|
3750
3850
|
Name | Type | Description | Notes
|
|
3751
3851
|
------------- | ------------- | ------------- | -------------
|
|
3752
3852
|
**application_id** | **Integer**| |
|
|
@@ -3763,19 +3863,18 @@ Name | Type | Description | Notes
|
|
|
3763
3863
|
|
|
3764
3864
|
### HTTP request headers
|
|
3765
3865
|
|
|
3766
|
-
|
|
3767
|
-
|
|
3866
|
+
- **Content-Type**: Not defined
|
|
3867
|
+
- **Accept**: application/json
|
|
3768
3868
|
|
|
3769
3869
|
|
|
3870
|
+
## get_rulesets
|
|
3770
3871
|
|
|
3771
|
-
|
|
3772
|
-
> InlineResponse2004 get_rulesets(application_id, campaign_id, opts)
|
|
3872
|
+
> InlineResponse2003 get_rulesets(application_id, campaign_id, opts)
|
|
3773
3873
|
|
|
3774
3874
|
List Campaign Rulesets
|
|
3775
3875
|
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
3876
|
### Example
|
|
3877
|
+
|
|
3779
3878
|
```ruby
|
|
3780
3879
|
# load the gem
|
|
3781
3880
|
require 'talon_one'
|
|
@@ -3788,12 +3887,9 @@ TalonOne.configure do |config|
|
|
|
3788
3887
|
end
|
|
3789
3888
|
|
|
3790
3889
|
api_instance = TalonOne::ManagementApi.new
|
|
3791
|
-
|
|
3792
3890
|
application_id = 56 # Integer |
|
|
3793
|
-
|
|
3794
3891
|
campaign_id = 56 # Integer |
|
|
3795
|
-
|
|
3796
|
-
opts = {
|
|
3892
|
+
opts = {
|
|
3797
3893
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3798
3894
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3799
3895
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -3810,6 +3906,7 @@ end
|
|
|
3810
3906
|
|
|
3811
3907
|
### Parameters
|
|
3812
3908
|
|
|
3909
|
+
|
|
3813
3910
|
Name | Type | Description | Notes
|
|
3814
3911
|
------------- | ------------- | ------------- | -------------
|
|
3815
3912
|
**application_id** | **Integer**| |
|
|
@@ -3820,7 +3917,7 @@ Name | Type | Description | Notes
|
|
|
3820
3917
|
|
|
3821
3918
|
### Return type
|
|
3822
3919
|
|
|
3823
|
-
[**
|
|
3920
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
|
3824
3921
|
|
|
3825
3922
|
### Authorization
|
|
3826
3923
|
|
|
@@ -3828,12 +3925,12 @@ Name | Type | Description | Notes
|
|
|
3828
3925
|
|
|
3829
3926
|
### HTTP request headers
|
|
3830
3927
|
|
|
3831
|
-
|
|
3832
|
-
|
|
3928
|
+
- **Content-Type**: Not defined
|
|
3929
|
+
- **Accept**: application/json
|
|
3833
3930
|
|
|
3834
3931
|
|
|
3932
|
+
## get_user
|
|
3835
3933
|
|
|
3836
|
-
# **get_user**
|
|
3837
3934
|
> User get_user(user_id)
|
|
3838
3935
|
|
|
3839
3936
|
Get a single User
|
|
@@ -3841,6 +3938,7 @@ Get a single User
|
|
|
3841
3938
|
Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves.
|
|
3842
3939
|
|
|
3843
3940
|
### Example
|
|
3941
|
+
|
|
3844
3942
|
```ruby
|
|
3845
3943
|
# load the gem
|
|
3846
3944
|
require 'talon_one'
|
|
@@ -3853,10 +3951,8 @@ TalonOne.configure do |config|
|
|
|
3853
3951
|
end
|
|
3854
3952
|
|
|
3855
3953
|
api_instance = TalonOne::ManagementApi.new
|
|
3856
|
-
|
|
3857
3954
|
user_id = 56 # Integer |
|
|
3858
3955
|
|
|
3859
|
-
|
|
3860
3956
|
begin
|
|
3861
3957
|
#Get a single User
|
|
3862
3958
|
result = api_instance.get_user(user_id)
|
|
@@ -3868,6 +3964,7 @@ end
|
|
|
3868
3964
|
|
|
3869
3965
|
### Parameters
|
|
3870
3966
|
|
|
3967
|
+
|
|
3871
3968
|
Name | Type | Description | Notes
|
|
3872
3969
|
------------- | ------------- | ------------- | -------------
|
|
3873
3970
|
**user_id** | **Integer**| |
|
|
@@ -3882,19 +3979,20 @@ Name | Type | Description | Notes
|
|
|
3882
3979
|
|
|
3883
3980
|
### HTTP request headers
|
|
3884
3981
|
|
|
3885
|
-
|
|
3886
|
-
|
|
3982
|
+
- **Content-Type**: Not defined
|
|
3983
|
+
- **Accept**: application/json
|
|
3887
3984
|
|
|
3888
3985
|
|
|
3986
|
+
## get_users
|
|
3889
3987
|
|
|
3890
|
-
|
|
3891
|
-
> InlineResponse20024 get_users(opts)
|
|
3988
|
+
> InlineResponse20026 get_users(opts)
|
|
3892
3989
|
|
|
3893
3990
|
List Users in your account
|
|
3894
3991
|
|
|
3895
3992
|
Retrieve all users in your account.
|
|
3896
3993
|
|
|
3897
3994
|
### Example
|
|
3995
|
+
|
|
3898
3996
|
```ruby
|
|
3899
3997
|
# load the gem
|
|
3900
3998
|
require 'talon_one'
|
|
@@ -3907,8 +4005,7 @@ TalonOne.configure do |config|
|
|
|
3907
4005
|
end
|
|
3908
4006
|
|
|
3909
4007
|
api_instance = TalonOne::ManagementApi.new
|
|
3910
|
-
|
|
3911
|
-
opts = {
|
|
4008
|
+
opts = {
|
|
3912
4009
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3913
4010
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3914
4011
|
sort: 'sort_example' # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -3925,6 +4022,7 @@ end
|
|
|
3925
4022
|
|
|
3926
4023
|
### Parameters
|
|
3927
4024
|
|
|
4025
|
+
|
|
3928
4026
|
Name | Type | Description | Notes
|
|
3929
4027
|
------------- | ------------- | ------------- | -------------
|
|
3930
4028
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3933,7 +4031,7 @@ Name | Type | Description | Notes
|
|
|
3933
4031
|
|
|
3934
4032
|
### Return type
|
|
3935
4033
|
|
|
3936
|
-
[**
|
|
4034
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
|
3937
4035
|
|
|
3938
4036
|
### Authorization
|
|
3939
4037
|
|
|
@@ -3941,12 +4039,12 @@ Name | Type | Description | Notes
|
|
|
3941
4039
|
|
|
3942
4040
|
### HTTP request headers
|
|
3943
4041
|
|
|
3944
|
-
|
|
3945
|
-
|
|
4042
|
+
- **Content-Type**: Not defined
|
|
4043
|
+
- **Accept**: application/json
|
|
3946
4044
|
|
|
3947
4045
|
|
|
4046
|
+
## get_webhook
|
|
3948
4047
|
|
|
3949
|
-
# **get_webhook**
|
|
3950
4048
|
> Webhook get_webhook(webhook_id)
|
|
3951
4049
|
|
|
3952
4050
|
Get Webhook
|
|
@@ -3954,6 +4052,7 @@ Get Webhook
|
|
|
3954
4052
|
Returns an webhook by its id.
|
|
3955
4053
|
|
|
3956
4054
|
### Example
|
|
4055
|
+
|
|
3957
4056
|
```ruby
|
|
3958
4057
|
# load the gem
|
|
3959
4058
|
require 'talon_one'
|
|
@@ -3966,10 +4065,8 @@ TalonOne.configure do |config|
|
|
|
3966
4065
|
end
|
|
3967
4066
|
|
|
3968
4067
|
api_instance = TalonOne::ManagementApi.new
|
|
3969
|
-
|
|
3970
4068
|
webhook_id = 56 # Integer |
|
|
3971
4069
|
|
|
3972
|
-
|
|
3973
4070
|
begin
|
|
3974
4071
|
#Get Webhook
|
|
3975
4072
|
result = api_instance.get_webhook(webhook_id)
|
|
@@ -3981,6 +4078,7 @@ end
|
|
|
3981
4078
|
|
|
3982
4079
|
### Parameters
|
|
3983
4080
|
|
|
4081
|
+
|
|
3984
4082
|
Name | Type | Description | Notes
|
|
3985
4083
|
------------- | ------------- | ------------- | -------------
|
|
3986
4084
|
**webhook_id** | **Integer**| |
|
|
@@ -3995,19 +4093,20 @@ Name | Type | Description | Notes
|
|
|
3995
4093
|
|
|
3996
4094
|
### HTTP request headers
|
|
3997
4095
|
|
|
3998
|
-
|
|
3999
|
-
|
|
4096
|
+
- **Content-Type**: Not defined
|
|
4097
|
+
- **Accept**: application/json
|
|
4000
4098
|
|
|
4001
4099
|
|
|
4100
|
+
## get_webhook_activation_logs
|
|
4002
4101
|
|
|
4003
|
-
|
|
4004
|
-
> InlineResponse20021 get_webhook_activation_logs(opts)
|
|
4102
|
+
> InlineResponse20023 get_webhook_activation_logs(opts)
|
|
4005
4103
|
|
|
4006
4104
|
List Webhook activation Log Entries
|
|
4007
4105
|
|
|
4008
4106
|
Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
|
|
4009
4107
|
|
|
4010
4108
|
### Example
|
|
4109
|
+
|
|
4011
4110
|
```ruby
|
|
4012
4111
|
# load the gem
|
|
4013
4112
|
require 'talon_one'
|
|
@@ -4020,15 +4119,14 @@ TalonOne.configure do |config|
|
|
|
4020
4119
|
end
|
|
4021
4120
|
|
|
4022
4121
|
api_instance = TalonOne::ManagementApi.new
|
|
4023
|
-
|
|
4024
|
-
opts = {
|
|
4122
|
+
opts = {
|
|
4025
4123
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4026
4124
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4027
4125
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
4028
4126
|
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
|
4029
|
-
webhook_id:
|
|
4030
|
-
application_id:
|
|
4031
|
-
campaign_id:
|
|
4127
|
+
webhook_id: 3.4, # Float | Filter results by Webhook.
|
|
4128
|
+
application_id: 3.4, # Float |
|
|
4129
|
+
campaign_id: 3.4, # Float | Filter results by campaign.
|
|
4032
4130
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date.
|
|
4033
4131
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
|
4034
4132
|
}
|
|
@@ -4044,6 +4142,7 @@ end
|
|
|
4044
4142
|
|
|
4045
4143
|
### Parameters
|
|
4046
4144
|
|
|
4145
|
+
|
|
4047
4146
|
Name | Type | Description | Notes
|
|
4048
4147
|
------------- | ------------- | ------------- | -------------
|
|
4049
4148
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -4058,7 +4157,7 @@ Name | Type | Description | Notes
|
|
|
4058
4157
|
|
|
4059
4158
|
### Return type
|
|
4060
4159
|
|
|
4061
|
-
[**
|
|
4160
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
4062
4161
|
|
|
4063
4162
|
### Authorization
|
|
4064
4163
|
|
|
@@ -4066,19 +4165,18 @@ Name | Type | Description | Notes
|
|
|
4066
4165
|
|
|
4067
4166
|
### HTTP request headers
|
|
4068
4167
|
|
|
4069
|
-
|
|
4070
|
-
|
|
4168
|
+
- **Content-Type**: Not defined
|
|
4169
|
+
- **Accept**: application/json
|
|
4071
4170
|
|
|
4072
4171
|
|
|
4172
|
+
## get_webhook_logs
|
|
4073
4173
|
|
|
4074
|
-
|
|
4075
|
-
> InlineResponse20022 get_webhook_logs(opts)
|
|
4174
|
+
> InlineResponse20024 get_webhook_logs(opts)
|
|
4076
4175
|
|
|
4077
4176
|
List Webhook Log Entries
|
|
4078
4177
|
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
4178
|
### Example
|
|
4179
|
+
|
|
4082
4180
|
```ruby
|
|
4083
4181
|
# load the gem
|
|
4084
4182
|
require 'talon_one'
|
|
@@ -4091,15 +4189,14 @@ TalonOne.configure do |config|
|
|
|
4091
4189
|
end
|
|
4092
4190
|
|
|
4093
4191
|
api_instance = TalonOne::ManagementApi.new
|
|
4094
|
-
|
|
4095
|
-
opts = {
|
|
4192
|
+
opts = {
|
|
4096
4193
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4097
4194
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4098
4195
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
4099
4196
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
4100
|
-
webhook_id:
|
|
4101
|
-
application_id:
|
|
4102
|
-
campaign_id:
|
|
4197
|
+
webhook_id: 3.4, # Float | Filter results by Webhook.
|
|
4198
|
+
application_id: 3.4, # Float |
|
|
4199
|
+
campaign_id: 3.4, # Float | Filter results by campaign.
|
|
4103
4200
|
request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
|
|
4104
4201
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
|
|
4105
4202
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
|
@@ -4116,6 +4213,7 @@ end
|
|
|
4116
4213
|
|
|
4117
4214
|
### Parameters
|
|
4118
4215
|
|
|
4216
|
+
|
|
4119
4217
|
Name | Type | Description | Notes
|
|
4120
4218
|
------------- | ------------- | ------------- | -------------
|
|
4121
4219
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -4131,7 +4229,7 @@ Name | Type | Description | Notes
|
|
|
4131
4229
|
|
|
4132
4230
|
### Return type
|
|
4133
4231
|
|
|
4134
|
-
[**
|
|
4232
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
4135
4233
|
|
|
4136
4234
|
### Authorization
|
|
4137
4235
|
|
|
@@ -4139,19 +4237,18 @@ Name | Type | Description | Notes
|
|
|
4139
4237
|
|
|
4140
4238
|
### HTTP request headers
|
|
4141
4239
|
|
|
4142
|
-
|
|
4143
|
-
|
|
4240
|
+
- **Content-Type**: Not defined
|
|
4241
|
+
- **Accept**: application/json
|
|
4144
4242
|
|
|
4145
4243
|
|
|
4244
|
+
## get_webhooks
|
|
4146
4245
|
|
|
4147
|
-
|
|
4148
|
-
> InlineResponse20020 get_webhooks(opts)
|
|
4246
|
+
> InlineResponse20022 get_webhooks(opts)
|
|
4149
4247
|
|
|
4150
4248
|
List Webhooks
|
|
4151
4249
|
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
4250
|
### Example
|
|
4251
|
+
|
|
4155
4252
|
```ruby
|
|
4156
4253
|
# load the gem
|
|
4157
4254
|
require 'talon_one'
|
|
@@ -4164,8 +4261,7 @@ TalonOne.configure do |config|
|
|
|
4164
4261
|
end
|
|
4165
4262
|
|
|
4166
4263
|
api_instance = TalonOne::ManagementApi.new
|
|
4167
|
-
|
|
4168
|
-
opts = {
|
|
4264
|
+
opts = {
|
|
4169
4265
|
application_ids: 'application_ids_example', # String | Filter by one or more application ids separated by comma
|
|
4170
4266
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
4171
4267
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
@@ -4183,6 +4279,7 @@ end
|
|
|
4183
4279
|
|
|
4184
4280
|
### Parameters
|
|
4185
4281
|
|
|
4282
|
+
|
|
4186
4283
|
Name | Type | Description | Notes
|
|
4187
4284
|
------------- | ------------- | ------------- | -------------
|
|
4188
4285
|
**application_ids** | **String**| Filter by one or more application ids separated by comma | [optional]
|
|
@@ -4192,54 +4289,7 @@ Name | Type | Description | Notes
|
|
|
4192
4289
|
|
|
4193
4290
|
### Return type
|
|
4194
4291
|
|
|
4195
|
-
[**
|
|
4196
|
-
|
|
4197
|
-
### Authorization
|
|
4198
|
-
|
|
4199
|
-
[manager_auth](../README.md#manager_auth)
|
|
4200
|
-
|
|
4201
|
-
### HTTP request headers
|
|
4202
|
-
|
|
4203
|
-
- **Content-Type**: application/json
|
|
4204
|
-
- **Accept**: application/json
|
|
4205
|
-
|
|
4206
|
-
|
|
4207
|
-
|
|
4208
|
-
# **refresh_analytics**
|
|
4209
|
-
> refresh_analytics
|
|
4210
|
-
|
|
4211
|
-
Trigger refresh on stale analytics.
|
|
4212
|
-
|
|
4213
|
-
Should be used to trigger a manual refresh of analytics.
|
|
4214
|
-
|
|
4215
|
-
### Example
|
|
4216
|
-
```ruby
|
|
4217
|
-
# load the gem
|
|
4218
|
-
require 'talon_one'
|
|
4219
|
-
# setup authorization
|
|
4220
|
-
TalonOne.configure do |config|
|
|
4221
|
-
# Configure API key authorization: manager_auth
|
|
4222
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4223
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4224
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4225
|
-
end
|
|
4226
|
-
|
|
4227
|
-
api_instance = TalonOne::ManagementApi.new
|
|
4228
|
-
|
|
4229
|
-
begin
|
|
4230
|
-
#Trigger refresh on stale analytics.
|
|
4231
|
-
api_instance.refresh_analytics
|
|
4232
|
-
rescue TalonOne::ApiError => e
|
|
4233
|
-
puts "Exception when calling ManagementApi->refresh_analytics: #{e}"
|
|
4234
|
-
end
|
|
4235
|
-
```
|
|
4236
|
-
|
|
4237
|
-
### Parameters
|
|
4238
|
-
This endpoint does not need any parameter.
|
|
4239
|
-
|
|
4240
|
-
### Return type
|
|
4241
|
-
|
|
4242
|
-
nil (empty response body)
|
|
4292
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
|
4243
4293
|
|
|
4244
4294
|
### Authorization
|
|
4245
4295
|
|
|
@@ -4247,19 +4297,18 @@ nil (empty response body)
|
|
|
4247
4297
|
|
|
4248
4298
|
### HTTP request headers
|
|
4249
4299
|
|
|
4250
|
-
|
|
4251
|
-
|
|
4300
|
+
- **Content-Type**: Not defined
|
|
4301
|
+
- **Accept**: application/json
|
|
4252
4302
|
|
|
4253
4303
|
|
|
4304
|
+
## remove_loyalty_points
|
|
4254
4305
|
|
|
4255
|
-
# **remove_loyalty_points**
|
|
4256
4306
|
> remove_loyalty_points(program_id, integration_id, body)
|
|
4257
4307
|
|
|
4258
4308
|
Deduct points in a certain loyalty program for the specified customer
|
|
4259
4309
|
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
4310
|
### Example
|
|
4311
|
+
|
|
4263
4312
|
```ruby
|
|
4264
4313
|
# load the gem
|
|
4265
4314
|
require 'talon_one'
|
|
@@ -4272,14 +4321,10 @@ TalonOne.configure do |config|
|
|
|
4272
4321
|
end
|
|
4273
4322
|
|
|
4274
4323
|
api_instance = TalonOne::ManagementApi.new
|
|
4275
|
-
|
|
4276
4324
|
program_id = 'program_id_example' # String |
|
|
4277
|
-
|
|
4278
4325
|
integration_id = 'integration_id_example' # String |
|
|
4279
|
-
|
|
4280
4326
|
body = TalonOne::LoyaltyPoints.new # LoyaltyPoints |
|
|
4281
4327
|
|
|
4282
|
-
|
|
4283
4328
|
begin
|
|
4284
4329
|
#Deduct points in a certain loyalty program for the specified customer
|
|
4285
4330
|
api_instance.remove_loyalty_points(program_id, integration_id, body)
|
|
@@ -4290,6 +4335,7 @@ end
|
|
|
4290
4335
|
|
|
4291
4336
|
### Parameters
|
|
4292
4337
|
|
|
4338
|
+
|
|
4293
4339
|
Name | Type | Description | Notes
|
|
4294
4340
|
------------- | ------------- | ------------- | -------------
|
|
4295
4341
|
**program_id** | **String**| |
|
|
@@ -4306,12 +4352,12 @@ nil (empty response body)
|
|
|
4306
4352
|
|
|
4307
4353
|
### HTTP request headers
|
|
4308
4354
|
|
|
4309
|
-
|
|
4310
|
-
|
|
4355
|
+
- **Content-Type**: application/json
|
|
4356
|
+
- **Accept**: Not defined
|
|
4311
4357
|
|
|
4312
4358
|
|
|
4359
|
+
## reset_password
|
|
4313
4360
|
|
|
4314
|
-
# **reset_password**
|
|
4315
4361
|
> NewPassword reset_password(body)
|
|
4316
4362
|
|
|
4317
4363
|
Reset password
|
|
@@ -4319,6 +4365,7 @@ Reset password
|
|
|
4319
4365
|
Consumes the supplied password reset token and updates the password for the associated account.
|
|
4320
4366
|
|
|
4321
4367
|
### Example
|
|
4368
|
+
|
|
4322
4369
|
```ruby
|
|
4323
4370
|
# load the gem
|
|
4324
4371
|
require 'talon_one'
|
|
@@ -4331,10 +4378,8 @@ TalonOne.configure do |config|
|
|
|
4331
4378
|
end
|
|
4332
4379
|
|
|
4333
4380
|
api_instance = TalonOne::ManagementApi.new
|
|
4334
|
-
|
|
4335
4381
|
body = TalonOne::NewPassword.new # NewPassword |
|
|
4336
4382
|
|
|
4337
|
-
|
|
4338
4383
|
begin
|
|
4339
4384
|
#Reset password
|
|
4340
4385
|
result = api_instance.reset_password(body)
|
|
@@ -4346,6 +4391,7 @@ end
|
|
|
4346
4391
|
|
|
4347
4392
|
### Parameters
|
|
4348
4393
|
|
|
4394
|
+
|
|
4349
4395
|
Name | Type | Description | Notes
|
|
4350
4396
|
------------- | ------------- | ------------- | -------------
|
|
4351
4397
|
**body** | [**NewPassword**](NewPassword.md)| |
|
|
@@ -4360,19 +4406,20 @@ Name | Type | Description | Notes
|
|
|
4360
4406
|
|
|
4361
4407
|
### HTTP request headers
|
|
4362
4408
|
|
|
4363
|
-
|
|
4364
|
-
|
|
4409
|
+
- **Content-Type**: application/json
|
|
4410
|
+
- **Accept**: application/json
|
|
4365
4411
|
|
|
4366
4412
|
|
|
4413
|
+
## search_coupons_advanced
|
|
4367
4414
|
|
|
4368
|
-
|
|
4369
|
-
> InlineResponse2001 search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4415
|
+
> InlineResponse2004 search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4370
4416
|
|
|
4371
|
-
Get a list of the coupons that match the given attributes
|
|
4417
|
+
Get a list of the coupons that match the given attributes (with total count)
|
|
4372
4418
|
|
|
4373
4419
|
Gets a list of all the coupons with attributes matching the query criteria
|
|
4374
4420
|
|
|
4375
4421
|
### Example
|
|
4422
|
+
|
|
4376
4423
|
```ruby
|
|
4377
4424
|
# load the gem
|
|
4378
4425
|
require 'talon_one'
|
|
@@ -4385,14 +4432,10 @@ TalonOne.configure do |config|
|
|
|
4385
4432
|
end
|
|
4386
4433
|
|
|
4387
4434
|
api_instance = TalonOne::ManagementApi.new
|
|
4388
|
-
|
|
4389
4435
|
application_id = 56 # Integer |
|
|
4390
|
-
|
|
4391
4436
|
campaign_id = 56 # Integer |
|
|
4392
|
-
|
|
4393
|
-
|
|
4394
|
-
|
|
4395
|
-
opts = {
|
|
4437
|
+
body = nil # Object |
|
|
4438
|
+
opts = {
|
|
4396
4439
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4397
4440
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4398
4441
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -4403,12 +4446,12 @@ opts = {
|
|
|
4403
4446
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
4404
4447
|
referral_id: 56, # Integer | 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.
|
|
4405
4448
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4406
|
-
exact_match: false, #
|
|
4449
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4407
4450
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
4408
4451
|
}
|
|
4409
4452
|
|
|
4410
4453
|
begin
|
|
4411
|
-
#Get a list of the coupons that match the given attributes
|
|
4454
|
+
#Get a list of the coupons that match the given attributes (with total count)
|
|
4412
4455
|
result = api_instance.search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4413
4456
|
p result
|
|
4414
4457
|
rescue TalonOne::ApiError => e
|
|
@@ -4418,11 +4461,12 @@ end
|
|
|
4418
4461
|
|
|
4419
4462
|
### Parameters
|
|
4420
4463
|
|
|
4464
|
+
|
|
4421
4465
|
Name | Type | Description | Notes
|
|
4422
4466
|
------------- | ------------- | ------------- | -------------
|
|
4423
4467
|
**application_id** | **Integer**| |
|
|
4424
4468
|
**campaign_id** | **Integer**| |
|
|
4425
|
-
**body** |
|
|
4469
|
+
**body** | **Object**| |
|
|
4426
4470
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4427
4471
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4428
4472
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
@@ -4433,12 +4477,12 @@ Name | Type | Description | Notes
|
|
|
4433
4477
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
|
4434
4478
|
**referral_id** | **Integer**| 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. | [optional]
|
|
4435
4479
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4436
|
-
**exact_match** | **
|
|
4480
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4437
4481
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4438
4482
|
|
|
4439
4483
|
### Return type
|
|
4440
4484
|
|
|
4441
|
-
[**
|
|
4485
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
4442
4486
|
|
|
4443
4487
|
### Authorization
|
|
4444
4488
|
|
|
@@ -4446,19 +4490,20 @@ Name | Type | Description | Notes
|
|
|
4446
4490
|
|
|
4447
4491
|
### HTTP request headers
|
|
4448
4492
|
|
|
4449
|
-
|
|
4450
|
-
|
|
4493
|
+
- **Content-Type**: application/json
|
|
4494
|
+
- **Accept**: application/json
|
|
4451
4495
|
|
|
4452
4496
|
|
|
4497
|
+
## search_coupons_advanced_application_wide
|
|
4453
4498
|
|
|
4454
|
-
|
|
4455
|
-
> InlineResponse2001 search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4499
|
+
> InlineResponse2004 search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4456
4500
|
|
|
4457
|
-
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
4501
|
+
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
4458
4502
|
|
|
4459
4503
|
Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
|
4460
4504
|
|
|
4461
4505
|
### Example
|
|
4506
|
+
|
|
4462
4507
|
```ruby
|
|
4463
4508
|
# load the gem
|
|
4464
4509
|
require 'talon_one'
|
|
@@ -4471,12 +4516,9 @@ TalonOne.configure do |config|
|
|
|
4471
4516
|
end
|
|
4472
4517
|
|
|
4473
4518
|
api_instance = TalonOne::ManagementApi.new
|
|
4474
|
-
|
|
4475
4519
|
application_id = 56 # Integer |
|
|
4476
|
-
|
|
4477
|
-
|
|
4478
|
-
|
|
4479
|
-
opts = {
|
|
4520
|
+
body = nil # Object |
|
|
4521
|
+
opts = {
|
|
4480
4522
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4481
4523
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4482
4524
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -4488,12 +4530,12 @@ opts = {
|
|
|
4488
4530
|
referral_id: 56, # Integer | 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.
|
|
4489
4531
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4490
4532
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
4491
|
-
exact_match: false, #
|
|
4533
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4492
4534
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
4493
4535
|
}
|
|
4494
4536
|
|
|
4495
4537
|
begin
|
|
4496
|
-
#Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
4538
|
+
#Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
4497
4539
|
result = api_instance.search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4498
4540
|
p result
|
|
4499
4541
|
rescue TalonOne::ApiError => e
|
|
@@ -4503,10 +4545,11 @@ end
|
|
|
4503
4545
|
|
|
4504
4546
|
### Parameters
|
|
4505
4547
|
|
|
4548
|
+
|
|
4506
4549
|
Name | Type | Description | Notes
|
|
4507
4550
|
------------- | ------------- | ------------- | -------------
|
|
4508
4551
|
**application_id** | **Integer**| |
|
|
4509
|
-
**body** |
|
|
4552
|
+
**body** | **Object**| |
|
|
4510
4553
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4511
4554
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4512
4555
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
@@ -4518,12 +4561,12 @@ Name | Type | Description | Notes
|
|
|
4518
4561
|
**referral_id** | **Integer**| 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. | [optional]
|
|
4519
4562
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4520
4563
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4521
|
-
**exact_match** | **
|
|
4564
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4522
4565
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
4523
4566
|
|
|
4524
4567
|
### Return type
|
|
4525
4568
|
|
|
4526
|
-
[**
|
|
4569
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
4527
4570
|
|
|
4528
4571
|
### Authorization
|
|
4529
4572
|
|
|
@@ -4531,12 +4574,12 @@ Name | Type | Description | Notes
|
|
|
4531
4574
|
|
|
4532
4575
|
### HTTP request headers
|
|
4533
4576
|
|
|
4534
|
-
|
|
4535
|
-
|
|
4577
|
+
- **Content-Type**: application/json
|
|
4578
|
+
- **Accept**: application/json
|
|
4536
4579
|
|
|
4537
4580
|
|
|
4581
|
+
## search_coupons_advanced_application_wide_without_total_count
|
|
4538
4582
|
|
|
4539
|
-
# **search_coupons_advanced_application_wide_without_total_count**
|
|
4540
4583
|
> InlineResponse2005 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
|
4541
4584
|
|
|
4542
4585
|
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
@@ -4544,6 +4587,7 @@ Get a list of the coupons that match the given attributes in all active campaign
|
|
|
4544
4587
|
Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
|
4545
4588
|
|
|
4546
4589
|
### Example
|
|
4590
|
+
|
|
4547
4591
|
```ruby
|
|
4548
4592
|
# load the gem
|
|
4549
4593
|
require 'talon_one'
|
|
@@ -4556,12 +4600,9 @@ TalonOne.configure do |config|
|
|
|
4556
4600
|
end
|
|
4557
4601
|
|
|
4558
4602
|
api_instance = TalonOne::ManagementApi.new
|
|
4559
|
-
|
|
4560
4603
|
application_id = 56 # Integer |
|
|
4561
|
-
|
|
4562
|
-
|
|
4563
|
-
|
|
4564
|
-
opts = {
|
|
4604
|
+
body = nil # Object |
|
|
4605
|
+
opts = {
|
|
4565
4606
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4566
4607
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4567
4608
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -4573,7 +4614,7 @@ opts = {
|
|
|
4573
4614
|
referral_id: 56, # Integer | 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.
|
|
4574
4615
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4575
4616
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
4576
|
-
exact_match: false, #
|
|
4617
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4577
4618
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
4578
4619
|
}
|
|
4579
4620
|
|
|
@@ -4588,10 +4629,11 @@ end
|
|
|
4588
4629
|
|
|
4589
4630
|
### Parameters
|
|
4590
4631
|
|
|
4632
|
+
|
|
4591
4633
|
Name | Type | Description | Notes
|
|
4592
4634
|
------------- | ------------- | ------------- | -------------
|
|
4593
4635
|
**application_id** | **Integer**| |
|
|
4594
|
-
**body** |
|
|
4636
|
+
**body** | **Object**| |
|
|
4595
4637
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4596
4638
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4597
4639
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
@@ -4603,7 +4645,7 @@ Name | Type | Description | Notes
|
|
|
4603
4645
|
**referral_id** | **Integer**| 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. | [optional]
|
|
4604
4646
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4605
4647
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4606
|
-
**exact_match** | **
|
|
4648
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4607
4649
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
4608
4650
|
|
|
4609
4651
|
### Return type
|
|
@@ -4616,12 +4658,12 @@ Name | Type | Description | Notes
|
|
|
4616
4658
|
|
|
4617
4659
|
### HTTP request headers
|
|
4618
4660
|
|
|
4619
|
-
|
|
4620
|
-
|
|
4661
|
+
- **Content-Type**: application/json
|
|
4662
|
+
- **Accept**: application/json
|
|
4621
4663
|
|
|
4622
4664
|
|
|
4665
|
+
## search_coupons_advanced_without_total_count
|
|
4623
4666
|
|
|
4624
|
-
# **search_coupons_advanced_without_total_count**
|
|
4625
4667
|
> InlineResponse2005 search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts)
|
|
4626
4668
|
|
|
4627
4669
|
Get a list of the coupons that match the given attributes
|
|
@@ -4629,6 +4671,7 @@ Get a list of the coupons that match the given attributes
|
|
|
4629
4671
|
Gets a list of all the coupons with attributes matching the query criteria
|
|
4630
4672
|
|
|
4631
4673
|
### Example
|
|
4674
|
+
|
|
4632
4675
|
```ruby
|
|
4633
4676
|
# load the gem
|
|
4634
4677
|
require 'talon_one'
|
|
@@ -4641,14 +4684,10 @@ TalonOne.configure do |config|
|
|
|
4641
4684
|
end
|
|
4642
4685
|
|
|
4643
4686
|
api_instance = TalonOne::ManagementApi.new
|
|
4644
|
-
|
|
4645
4687
|
application_id = 56 # Integer |
|
|
4646
|
-
|
|
4647
4688
|
campaign_id = 56 # Integer |
|
|
4648
|
-
|
|
4649
|
-
|
|
4650
|
-
|
|
4651
|
-
opts = {
|
|
4689
|
+
body = nil # Object |
|
|
4690
|
+
opts = {
|
|
4652
4691
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4653
4692
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4654
4693
|
sort: 'sort_example', # String | The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order.
|
|
@@ -4659,7 +4698,7 @@ opts = {
|
|
|
4659
4698
|
usable: 'usable_example', # String | Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`.
|
|
4660
4699
|
referral_id: 56, # Integer | 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.
|
|
4661
4700
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4662
|
-
exact_match: false, #
|
|
4701
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4663
4702
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
4664
4703
|
}
|
|
4665
4704
|
|
|
@@ -4674,11 +4713,12 @@ end
|
|
|
4674
4713
|
|
|
4675
4714
|
### Parameters
|
|
4676
4715
|
|
|
4716
|
+
|
|
4677
4717
|
Name | Type | Description | Notes
|
|
4678
4718
|
------------- | ------------- | ------------- | -------------
|
|
4679
4719
|
**application_id** | **Integer**| |
|
|
4680
4720
|
**campaign_id** | **Integer**| |
|
|
4681
|
-
**body** |
|
|
4721
|
+
**body** | **Object**| |
|
|
4682
4722
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4683
4723
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4684
4724
|
**sort** | **String**| The field by which results should be sorted. Sorting defaults to ascending order, prefix the field name with `-` to sort in descending order. | [optional]
|
|
@@ -4689,7 +4729,7 @@ Name | Type | Description | Notes
|
|
|
4689
4729
|
**usable** | **String**| Either \"true\" or \"false\". If \"true\", only coupons where `usageCounter < usageLimit` will be returned, \"false\" will return only coupons where `usageCounter >= usageLimit`. | [optional]
|
|
4690
4730
|
**referral_id** | **Integer**| 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. | [optional]
|
|
4691
4731
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4692
|
-
**exact_match** | **
|
|
4732
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4693
4733
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4694
4734
|
|
|
4695
4735
|
### Return type
|
|
@@ -4702,19 +4742,20 @@ Name | Type | Description | Notes
|
|
|
4702
4742
|
|
|
4703
4743
|
### HTTP request headers
|
|
4704
4744
|
|
|
4705
|
-
|
|
4706
|
-
|
|
4745
|
+
- **Content-Type**: application/json
|
|
4746
|
+
- **Accept**: application/json
|
|
4707
4747
|
|
|
4708
4748
|
|
|
4749
|
+
## update_additional_cost
|
|
4709
4750
|
|
|
4710
|
-
|
|
4711
|
-
> set_account_limits(account_id, body)
|
|
4751
|
+
> AccountAdditionalCost update_additional_cost(additional_cost_id, body)
|
|
4712
4752
|
|
|
4713
|
-
|
|
4753
|
+
Update an additional cost
|
|
4714
4754
|
|
|
4715
|
-
|
|
4755
|
+
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.
|
|
4716
4756
|
|
|
4717
4757
|
### Example
|
|
4758
|
+
|
|
4718
4759
|
```ruby
|
|
4719
4760
|
# load the gem
|
|
4720
4761
|
require 'talon_one'
|
|
@@ -4727,30 +4768,29 @@ TalonOne.configure do |config|
|
|
|
4727
4768
|
end
|
|
4728
4769
|
|
|
4729
4770
|
api_instance = TalonOne::ManagementApi.new
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
body = TalonOne::AccountLimits.new # AccountLimits |
|
|
4734
|
-
|
|
4771
|
+
additional_cost_id = 56 # Integer |
|
|
4772
|
+
body = TalonOne::NewAdditionalCost.new # NewAdditionalCost |
|
|
4735
4773
|
|
|
4736
4774
|
begin
|
|
4737
|
-
#
|
|
4738
|
-
api_instance.
|
|
4775
|
+
#Update an additional cost
|
|
4776
|
+
result = api_instance.update_additional_cost(additional_cost_id, body)
|
|
4777
|
+
p result
|
|
4739
4778
|
rescue TalonOne::ApiError => e
|
|
4740
|
-
puts "Exception when calling ManagementApi->
|
|
4779
|
+
puts "Exception when calling ManagementApi->update_additional_cost: #{e}"
|
|
4741
4780
|
end
|
|
4742
4781
|
```
|
|
4743
4782
|
|
|
4744
4783
|
### Parameters
|
|
4745
4784
|
|
|
4785
|
+
|
|
4746
4786
|
Name | Type | Description | Notes
|
|
4747
4787
|
------------- | ------------- | ------------- | -------------
|
|
4748
|
-
**
|
|
4749
|
-
**body** | [**
|
|
4788
|
+
**additional_cost_id** | **Integer**| |
|
|
4789
|
+
**body** | [**NewAdditionalCost**](NewAdditionalCost.md)| |
|
|
4750
4790
|
|
|
4751
4791
|
### Return type
|
|
4752
4792
|
|
|
4753
|
-
|
|
4793
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
4754
4794
|
|
|
4755
4795
|
### Authorization
|
|
4756
4796
|
|
|
@@ -4758,19 +4798,20 @@ nil (empty response body)
|
|
|
4758
4798
|
|
|
4759
4799
|
### HTTP request headers
|
|
4760
4800
|
|
|
4761
|
-
|
|
4762
|
-
|
|
4763
|
-
|
|
4801
|
+
- **Content-Type**: application/json
|
|
4802
|
+
- **Accept**: application/json
|
|
4764
4803
|
|
|
4765
4804
|
|
|
4766
|
-
|
|
4767
|
-
> Campaign update_campaign(application_id, campaign_id, body)
|
|
4805
|
+
## update_attribute
|
|
4768
4806
|
|
|
4769
|
-
|
|
4807
|
+
> Attribute update_attribute(attribute_id, body)
|
|
4770
4808
|
|
|
4809
|
+
Update a custom attribute
|
|
4771
4810
|
|
|
4811
|
+
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.
|
|
4772
4812
|
|
|
4773
4813
|
### Example
|
|
4814
|
+
|
|
4774
4815
|
```ruby
|
|
4775
4816
|
# load the gem
|
|
4776
4817
|
require 'talon_one'
|
|
@@ -4783,34 +4824,29 @@ TalonOne.configure do |config|
|
|
|
4783
4824
|
end
|
|
4784
4825
|
|
|
4785
4826
|
api_instance = TalonOne::ManagementApi.new
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
|
|
4789
|
-
campaign_id = 56 # Integer |
|
|
4790
|
-
|
|
4791
|
-
body = TalonOne::UpdateCampaign.new # UpdateCampaign |
|
|
4792
|
-
|
|
4827
|
+
attribute_id = 56 # Integer |
|
|
4828
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
|
4793
4829
|
|
|
4794
4830
|
begin
|
|
4795
|
-
#Update a
|
|
4796
|
-
result = api_instance.
|
|
4831
|
+
#Update a custom attribute
|
|
4832
|
+
result = api_instance.update_attribute(attribute_id, body)
|
|
4797
4833
|
p result
|
|
4798
4834
|
rescue TalonOne::ApiError => e
|
|
4799
|
-
puts "Exception when calling ManagementApi->
|
|
4835
|
+
puts "Exception when calling ManagementApi->update_attribute: #{e}"
|
|
4800
4836
|
end
|
|
4801
4837
|
```
|
|
4802
4838
|
|
|
4803
4839
|
### Parameters
|
|
4804
4840
|
|
|
4841
|
+
|
|
4805
4842
|
Name | Type | Description | Notes
|
|
4806
4843
|
------------- | ------------- | ------------- | -------------
|
|
4807
|
-
**
|
|
4808
|
-
**
|
|
4809
|
-
**body** | [**UpdateCampaign**](UpdateCampaign.md)| |
|
|
4844
|
+
**attribute_id** | **Integer**| |
|
|
4845
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
|
4810
4846
|
|
|
4811
4847
|
### Return type
|
|
4812
4848
|
|
|
4813
|
-
[**
|
|
4849
|
+
[**Attribute**](Attribute.md)
|
|
4814
4850
|
|
|
4815
4851
|
### Authorization
|
|
4816
4852
|
|
|
@@ -4818,19 +4854,18 @@ Name | Type | Description | Notes
|
|
|
4818
4854
|
|
|
4819
4855
|
### HTTP request headers
|
|
4820
4856
|
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4857
|
+
- **Content-Type**: application/json
|
|
4858
|
+
- **Accept**: application/json
|
|
4824
4859
|
|
|
4825
4860
|
|
|
4826
|
-
|
|
4827
|
-
> CampaignSet update_campaign_set(application_id, body)
|
|
4828
|
-
|
|
4829
|
-
Update a Campaign Set
|
|
4861
|
+
## update_campaign
|
|
4830
4862
|
|
|
4863
|
+
> Campaign update_campaign(application_id, campaign_id, body)
|
|
4831
4864
|
|
|
4865
|
+
Update a Campaign
|
|
4832
4866
|
|
|
4833
4867
|
### Example
|
|
4868
|
+
|
|
4834
4869
|
```ruby
|
|
4835
4870
|
# load the gem
|
|
4836
4871
|
require 'talon_one'
|
|
@@ -4843,31 +4878,31 @@ TalonOne.configure do |config|
|
|
|
4843
4878
|
end
|
|
4844
4879
|
|
|
4845
4880
|
api_instance = TalonOne::ManagementApi.new
|
|
4846
|
-
|
|
4847
4881
|
application_id = 56 # Integer |
|
|
4848
|
-
|
|
4849
|
-
body = TalonOne::
|
|
4850
|
-
|
|
4882
|
+
campaign_id = 56 # Integer |
|
|
4883
|
+
body = TalonOne::UpdateCampaign.new # UpdateCampaign |
|
|
4851
4884
|
|
|
4852
4885
|
begin
|
|
4853
|
-
#Update a Campaign
|
|
4854
|
-
result = api_instance.
|
|
4886
|
+
#Update a Campaign
|
|
4887
|
+
result = api_instance.update_campaign(application_id, campaign_id, body)
|
|
4855
4888
|
p result
|
|
4856
4889
|
rescue TalonOne::ApiError => e
|
|
4857
|
-
puts "Exception when calling ManagementApi->
|
|
4890
|
+
puts "Exception when calling ManagementApi->update_campaign: #{e}"
|
|
4858
4891
|
end
|
|
4859
4892
|
```
|
|
4860
4893
|
|
|
4861
4894
|
### Parameters
|
|
4862
4895
|
|
|
4896
|
+
|
|
4863
4897
|
Name | Type | Description | Notes
|
|
4864
4898
|
------------- | ------------- | ------------- | -------------
|
|
4865
4899
|
**application_id** | **Integer**| |
|
|
4866
|
-
**
|
|
4900
|
+
**campaign_id** | **Integer**| |
|
|
4901
|
+
**body** | [**UpdateCampaign**](UpdateCampaign.md)| |
|
|
4867
4902
|
|
|
4868
4903
|
### Return type
|
|
4869
4904
|
|
|
4870
|
-
[**
|
|
4905
|
+
[**Campaign**](Campaign.md)
|
|
4871
4906
|
|
|
4872
4907
|
### Authorization
|
|
4873
4908
|
|
|
@@ -4875,19 +4910,18 @@ Name | Type | Description | Notes
|
|
|
4875
4910
|
|
|
4876
4911
|
### HTTP request headers
|
|
4877
4912
|
|
|
4878
|
-
|
|
4879
|
-
|
|
4913
|
+
- **Content-Type**: application/json
|
|
4914
|
+
- **Accept**: application/json
|
|
4880
4915
|
|
|
4881
4916
|
|
|
4917
|
+
## update_coupon
|
|
4882
4918
|
|
|
4883
|
-
# **update_coupon**
|
|
4884
4919
|
> Coupon update_coupon(application_id, campaign_id, coupon_id, body)
|
|
4885
4920
|
|
|
4886
4921
|
Update a Coupon
|
|
4887
4922
|
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
4923
|
### Example
|
|
4924
|
+
|
|
4891
4925
|
```ruby
|
|
4892
4926
|
# load the gem
|
|
4893
4927
|
require 'talon_one'
|
|
@@ -4900,16 +4934,11 @@ TalonOne.configure do |config|
|
|
|
4900
4934
|
end
|
|
4901
4935
|
|
|
4902
4936
|
api_instance = TalonOne::ManagementApi.new
|
|
4903
|
-
|
|
4904
4937
|
application_id = 56 # Integer |
|
|
4905
|
-
|
|
4906
4938
|
campaign_id = 56 # Integer |
|
|
4907
|
-
|
|
4908
4939
|
coupon_id = 'coupon_id_example' # String | The ID of the coupon code to update
|
|
4909
|
-
|
|
4910
4940
|
body = TalonOne::UpdateCoupon.new # UpdateCoupon |
|
|
4911
4941
|
|
|
4912
|
-
|
|
4913
4942
|
begin
|
|
4914
4943
|
#Update a Coupon
|
|
4915
4944
|
result = api_instance.update_coupon(application_id, campaign_id, coupon_id, body)
|
|
@@ -4921,6 +4950,7 @@ end
|
|
|
4921
4950
|
|
|
4922
4951
|
### Parameters
|
|
4923
4952
|
|
|
4953
|
+
|
|
4924
4954
|
Name | Type | Description | Notes
|
|
4925
4955
|
------------- | ------------- | ------------- | -------------
|
|
4926
4956
|
**application_id** | **Integer**| |
|
|
@@ -4938,19 +4968,18 @@ Name | Type | Description | Notes
|
|
|
4938
4968
|
|
|
4939
4969
|
### HTTP request headers
|
|
4940
4970
|
|
|
4941
|
-
|
|
4942
|
-
|
|
4971
|
+
- **Content-Type**: application/json
|
|
4972
|
+
- **Accept**: application/json
|
|
4943
4973
|
|
|
4944
4974
|
|
|
4975
|
+
## update_coupon_batch
|
|
4945
4976
|
|
|
4946
|
-
# **update_coupon_batch**
|
|
4947
4977
|
> update_coupon_batch(application_id, campaign_id, body)
|
|
4948
4978
|
|
|
4949
4979
|
Update a Batch of Coupons
|
|
4950
4980
|
|
|
4951
|
-
|
|
4952
|
-
|
|
4953
4981
|
### Example
|
|
4982
|
+
|
|
4954
4983
|
```ruby
|
|
4955
4984
|
# load the gem
|
|
4956
4985
|
require 'talon_one'
|
|
@@ -4963,14 +4992,10 @@ TalonOne.configure do |config|
|
|
|
4963
4992
|
end
|
|
4964
4993
|
|
|
4965
4994
|
api_instance = TalonOne::ManagementApi.new
|
|
4966
|
-
|
|
4967
4995
|
application_id = 56 # Integer |
|
|
4968
|
-
|
|
4969
4996
|
campaign_id = 56 # Integer |
|
|
4970
|
-
|
|
4971
4997
|
body = TalonOne::UpdateCouponBatch.new # UpdateCouponBatch |
|
|
4972
4998
|
|
|
4973
|
-
|
|
4974
4999
|
begin
|
|
4975
5000
|
#Update a Batch of Coupons
|
|
4976
5001
|
api_instance.update_coupon_batch(application_id, campaign_id, body)
|
|
@@ -4981,6 +5006,7 @@ end
|
|
|
4981
5006
|
|
|
4982
5007
|
### Parameters
|
|
4983
5008
|
|
|
5009
|
+
|
|
4984
5010
|
Name | Type | Description | Notes
|
|
4985
5011
|
------------- | ------------- | ------------- | -------------
|
|
4986
5012
|
**application_id** | **Integer**| |
|
|
@@ -4997,19 +5023,18 @@ nil (empty response body)
|
|
|
4997
5023
|
|
|
4998
5024
|
### HTTP request headers
|
|
4999
5025
|
|
|
5000
|
-
|
|
5001
|
-
|
|
5026
|
+
- **Content-Type**: application/json
|
|
5027
|
+
- **Accept**: Not defined
|
|
5002
5028
|
|
|
5003
5029
|
|
|
5030
|
+
## update_ruleset
|
|
5004
5031
|
|
|
5005
|
-
# **update_ruleset**
|
|
5006
5032
|
> Ruleset update_ruleset(application_id, campaign_id, ruleset_id, body)
|
|
5007
5033
|
|
|
5008
5034
|
Update a Ruleset
|
|
5009
5035
|
|
|
5010
|
-
|
|
5011
|
-
|
|
5012
5036
|
### Example
|
|
5037
|
+
|
|
5013
5038
|
```ruby
|
|
5014
5039
|
# load the gem
|
|
5015
5040
|
require 'talon_one'
|
|
@@ -5022,16 +5047,11 @@ TalonOne.configure do |config|
|
|
|
5022
5047
|
end
|
|
5023
5048
|
|
|
5024
5049
|
api_instance = TalonOne::ManagementApi.new
|
|
5025
|
-
|
|
5026
5050
|
application_id = 56 # Integer |
|
|
5027
|
-
|
|
5028
5051
|
campaign_id = 56 # Integer |
|
|
5029
|
-
|
|
5030
5052
|
ruleset_id = 56 # Integer |
|
|
5031
|
-
|
|
5032
5053
|
body = TalonOne::NewRuleset.new # NewRuleset |
|
|
5033
5054
|
|
|
5034
|
-
|
|
5035
5055
|
begin
|
|
5036
5056
|
#Update a Ruleset
|
|
5037
5057
|
result = api_instance.update_ruleset(application_id, campaign_id, ruleset_id, body)
|
|
@@ -5043,6 +5063,7 @@ end
|
|
|
5043
5063
|
|
|
5044
5064
|
### Parameters
|
|
5045
5065
|
|
|
5066
|
+
|
|
5046
5067
|
Name | Type | Description | Notes
|
|
5047
5068
|
------------- | ------------- | ------------- | -------------
|
|
5048
5069
|
**application_id** | **Integer**| |
|
|
@@ -5060,8 +5081,6 @@ Name | Type | Description | Notes
|
|
|
5060
5081
|
|
|
5061
5082
|
### HTTP request headers
|
|
5062
5083
|
|
|
5063
|
-
|
|
5064
|
-
|
|
5065
|
-
|
|
5066
|
-
|
|
5084
|
+
- **Content-Type**: application/json
|
|
5085
|
+
- **Accept**: application/json
|
|
5067
5086
|
|