talon_one 1.3.0 → 2.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rspec +2 -0
- data/Gemfile +3 -1
- data/README.md +196 -30
- data/Rakefile +2 -0
- data/docs/APIError.md +11 -0
- data/docs/AcceptCouponEffectProps.md +17 -0
- data/docs/AcceptReferralEffectProps.md +17 -0
- data/docs/AccessLogEntry.md +15 -0
- data/docs/Account.md +28 -2
- data/docs/AccountAdditionalCost.md +29 -0
- data/docs/AccountAnalytics.md +44 -14
- data/docs/AccountEntity.md +9 -0
- data/docs/AccountLimits.md +32 -11
- data/docs/AddFreeItemEffectProps.md +19 -0
- data/docs/AddLoyaltyPointsEffectProps.md +29 -0
- data/docs/AdditionalCost.md +17 -0
- data/docs/Application.md +33 -2
- data/docs/ApplicationAPIKey.md +19 -2
- data/docs/ApplicationApiHealth.md +10 -0
- data/docs/ApplicationCustomer.md +21 -2
- data/docs/ApplicationCustomerEntity.md +9 -0
- data/docs/ApplicationCustomerSearch.md +12 -1
- data/docs/ApplicationEntity.md +9 -0
- data/docs/ApplicationEvent.md +17 -1
- data/docs/ApplicationSession.md +25 -3
- data/docs/ApplicationSessionEntity.md +9 -0
- data/docs/Attribute.md +23 -2
- data/docs/AttributesMandatory.md +19 -0
- data/docs/AttributesSettings.md +17 -0
- data/docs/Audience.md +27 -0
- data/docs/AudienceMembership.md +19 -0
- data/docs/BaseSamlConnection.md +31 -0
- data/docs/Binding.md +10 -0
- data/docs/Campaign.md +36 -1
- data/docs/CampaignAnalytics.md +46 -3
- data/docs/CampaignCopy.md +19 -1
- data/docs/CampaignEntity.md +9 -0
- data/docs/CampaignGroup.md +31 -0
- data/docs/CampaignGroupEntity.md +17 -0
- data/docs/CampaignSearch.md +10 -1
- data/docs/CampaignSet.md +14 -0
- data/docs/CampaignSetBranchNode.md +12 -0
- data/docs/CampaignSetLeafNode.md +10 -0
- data/docs/CampaignSetNode.md +9 -0
- data/docs/CartItem.md +21 -1
- data/docs/CartItemAdjustment.md +11 -0
- data/docs/Change.md +16 -2
- data/docs/ChangeProfilePassword.md +19 -0
- data/docs/CodeGeneratorSettings.md +10 -0
- data/docs/Coupon.md +31 -3
- data/docs/CouponConstraints.md +13 -0
- data/docs/CouponCreatedEffectProps.md +19 -0
- data/docs/CouponRejectionReason.md +11 -0
- data/docs/CouponReservations.md +9 -0
- data/docs/CouponSearch.md +10 -1
- data/docs/CouponValue.md +9 -0
- data/docs/CreateApplicationAPIKey.md +12 -0
- data/docs/CustomerActivityReport.md +22 -1
- data/docs/CustomerAnalytics.md +15 -0
- data/docs/CustomerInventory.md +23 -0
- data/docs/CustomerProfile.md +20 -2
- data/docs/CustomerProfileAudienceRequest.md +17 -0
- data/docs/CustomerProfileAudienceRequestItem.md +21 -0
- data/docs/CustomerProfileIntegrationRequestV2.md +19 -0
- data/docs/CustomerProfileSearchQuery.md +12 -1
- data/docs/CustomerSession.md +24 -3
- data/docs/CustomerSessionV2.md +45 -0
- data/docs/DeductLoyaltyPointsEffectProps.md +23 -0
- data/docs/Effect.md +27 -0
- data/docs/EffectEntity.md +25 -0
- data/docs/EmailEntity.md +9 -0
- data/docs/Entity.md +10 -0
- data/docs/EntityWithTalangVisibleID.md +19 -0
- data/docs/Environment.md +15 -0
- data/docs/ErrorEffectProps.md +17 -0
- data/docs/ErrorResponse.md +10 -0
- data/docs/ErrorSource.md +12 -0
- data/docs/Event.md +19 -1
- data/docs/EventType.md +21 -1
- data/docs/Export.md +15 -1
- data/docs/FeatureFlag.md +12 -0
- data/docs/FeatureFlags.md +15 -3
- data/docs/FeaturesFeed.md +10 -0
- data/docs/FeedNotification.md +27 -0
- data/docs/FuncArgDef.md +10 -0
- data/docs/FunctionDef.md +13 -0
- data/docs/Import.md +14 -0
- data/docs/ImportCoupons.md +9 -0
- data/docs/InlineResponse200.md +10 -0
- data/docs/InlineResponse2001.md +11 -1
- data/docs/InlineResponse20010.md +11 -1
- data/docs/InlineResponse20011.md +10 -0
- data/docs/InlineResponse20012.md +13 -1
- data/docs/InlineResponse20013.md +11 -1
- data/docs/InlineResponse20014.md +10 -0
- data/docs/InlineResponse20015.md +11 -1
- data/docs/InlineResponse20016.md +11 -1
- data/docs/InlineResponse20017.md +10 -0
- data/docs/InlineResponse20018.md +11 -1
- data/docs/InlineResponse20019.md +10 -0
- data/docs/InlineResponse2002.md +11 -1
- data/docs/InlineResponse20020.md +11 -1
- data/docs/InlineResponse20021.md +11 -1
- data/docs/InlineResponse20022.md +11 -1
- data/docs/InlineResponse20023.md +11 -1
- data/docs/InlineResponse20024.md +11 -1
- data/docs/InlineResponse20025.md +12 -3
- data/docs/InlineResponse20026.md +11 -1
- data/docs/InlineResponse20027.md +14 -2
- data/docs/InlineResponse20028.md +11 -1
- data/docs/InlineResponse20029.md +19 -0
- data/docs/InlineResponse2003.md +11 -1
- data/docs/InlineResponse20030.md +19 -0
- data/docs/InlineResponse2004.md +11 -1
- data/docs/InlineResponse2005.md +11 -1
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +11 -1
- data/docs/InlineResponse2008.md +10 -0
- data/docs/InlineResponse2009.md +10 -0
- data/docs/IntegrationApi.md +327 -72
- data/docs/IntegrationEntity.md +11 -1
- data/docs/IntegrationEvent.md +12 -1
- data/docs/IntegrationProfileEntity.md +9 -0
- data/docs/IntegrationRequest.md +19 -0
- data/docs/IntegrationState.md +13 -0
- data/docs/IntegrationStateV2.md +35 -0
- data/docs/LedgerEntry.md +18 -0
- data/docs/LibraryAttribute.md +15 -0
- data/docs/LimitConfig.md +11 -0
- data/docs/LoginParams.md +10 -0
- data/docs/Loyalty.md +9 -0
- data/docs/LoyaltyLedger.md +11 -1
- data/docs/LoyaltyLedgerEntry.md +23 -1
- data/docs/LoyaltyMembership.md +10 -0
- data/docs/LoyaltyPoints.md +15 -1
- data/docs/LoyaltyProgram.md +20 -2
- data/docs/LoyaltyProgramBalance.md +9 -0
- data/docs/LoyaltyProgramLedgers.md +14 -2
- data/docs/LoyaltyStatistics.md +23 -0
- data/docs/LoyaltySubLedger.md +28 -3
- data/docs/ManagementApi.md +927 -853
- data/docs/ManagerConfig.md +9 -0
- data/docs/Meta.md +16 -3
- data/docs/MultiApplicationEntity.md +9 -0
- data/docs/MultipleCustomerProfileIntegrationRequest.md +17 -0
- data/docs/MultipleCustomerProfileIntegrationRequestItem.md +19 -0
- data/docs/MultipleCustomerProfileIntegrationResponseV2.md +17 -0
- data/docs/MutableEntity.md +9 -0
- data/docs/NewAccount.md +9 -0
- data/docs/NewAccountSignUp.md +11 -0
- data/docs/NewAdditionalCost.md +23 -0
- data/docs/NewApplication.md +29 -1
- data/docs/NewApplicationAPIKey.md +20 -2
- data/docs/NewAttribute.md +20 -2
- data/docs/NewAudience.md +21 -0
- data/docs/NewCampaign.md +23 -1
- data/docs/NewCampaignGroup.md +23 -0
- data/docs/NewCampaignSet.md +12 -0
- data/docs/NewCoupons.md +20 -1
- data/docs/NewCustomerProfile.md +10 -1
- data/docs/NewCustomerSession.md +17 -1
- data/docs/NewCustomerSessionV2.md +31 -0
- data/docs/NewEvent.md +13 -1
- data/docs/NewEventType.md +19 -1
- data/docs/NewFeatureFlags.md +14 -3
- data/docs/NewImport.md +9 -0
- data/docs/NewInvitation.md +12 -0
- data/docs/NewInviteEmail.md +10 -0
- data/docs/NewLoyaltyProgram.md +18 -2
- data/docs/NewPassword.md +10 -0
- data/docs/NewPasswordEmail.md +9 -0
- data/docs/NewReferral.md +13 -0
- data/docs/NewRole.md +12 -0
- data/docs/NewRuleset.md +13 -1
- data/docs/NewSamlConnection.md +21 -3
- data/docs/NewTemplateDef.md +16 -1
- data/docs/NewUser.md +12 -0
- data/docs/NewWebhook.md +17 -1
- data/docs/Notification.md +11 -0
- data/docs/RedeemReferralEffectProps.md +19 -0
- data/docs/Referral.md +18 -0
- data/docs/ReferralCreatedEffectProps.md +17 -0
- data/docs/ReferralRejectionReason.md +11 -0
- data/docs/RejectCouponEffectProps.md +19 -0
- data/docs/RejectReferralEffectProps.md +19 -0
- data/docs/Role.md +18 -2
- data/docs/RoleAssign.md +10 -0
- data/docs/RoleMembership.md +10 -0
- data/docs/RollbackCouponEffectProps.md +17 -0
- data/docs/RollbackDiscountEffectProps.md +19 -0
- data/docs/Rule.md +13 -0
- data/docs/Ruleset.md +18 -1
- data/docs/SamlConnection.md +24 -6
- data/docs/SamlConnectionMetadata.md +23 -0
- data/docs/SamlLoginEndpoint.md +19 -0
- data/docs/Session.md +11 -0
- data/docs/SetDiscountEffectProps.md +21 -0
- data/docs/SetDiscountPerItemEffectProps.md +23 -0
- data/docs/ShowBundleMetadataEffectProps.md +21 -0
- data/docs/ShowNotificationEffectProps.md +21 -0
- data/docs/SlotDef.md +15 -1
- data/docs/TemplateArgDef.md +13 -1
- data/docs/TemplateDef.md +20 -1
- data/docs/TriggerWebhookEffectProps.md +19 -0
- data/docs/UpdateAccount.md +16 -1
- data/docs/UpdateApplication.md +28 -1
- data/docs/UpdateAttributeEffectProps.md +19 -0
- data/docs/UpdateAudience.md +17 -0
- data/docs/UpdateCampaign.md +23 -1
- data/docs/UpdateCampaignGroup.md +23 -0
- data/docs/UpdateCoupon.md +16 -1
- data/docs/UpdateCouponBatch.md +16 -1
- data/docs/UpdateLoyaltyProgram.md +17 -2
- data/docs/UpdateRole.md +13 -1
- data/docs/UpdateUser.md +14 -6
- data/docs/UpdateUserLatestFeedTimestamp.md +17 -0
- data/docs/User.md +25 -5
- data/docs/UserEntity.md +9 -0
- data/docs/UserFeedNotifications.md +19 -0
- data/docs/Webhook.md +20 -1
- data/docs/WebhookActivationLogEntry.md +13 -0
- data/docs/WebhookLogEntry.md +18 -0
- data/lib/talon_one.rb +88 -35
- data/lib/talon_one/api/integration_api.rb +518 -138
- data/lib/talon_one/api/management_api.rb +2328 -1477
- data/lib/talon_one/api_client.rb +45 -46
- data/lib/talon_one/api_error.rb +22 -3
- data/lib/talon_one/configuration.rb +48 -9
- data/lib/talon_one/models/accept_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/accept_referral_effect_props.rb +213 -0
- data/lib/talon_one/models/access_log_entry.rb +47 -24
- data/lib/talon_one/models/account.rb +72 -49
- data/lib/talon_one/models/account_additional_cost.rb +300 -0
- data/lib/talon_one/models/account_analytics.rb +151 -68
- data/lib/talon_one/models/account_entity.rb +39 -16
- data/lib/talon_one/models/account_limits.rb +83 -45
- data/lib/talon_one/models/add_free_item_effect_props.rb +228 -0
- data/lib/talon_one/models/add_loyalty_points_effect_props.rb +293 -0
- data/lib/talon_one/models/additional_cost.rb +211 -0
- data/lib/talon_one/models/api_error.rb +40 -17
- data/lib/talon_one/models/application.rb +131 -77
- data/lib/talon_one/models/application_api_health.rb +43 -20
- data/lib/talon_one/models/application_api_key.rb +121 -53
- data/lib/talon_one/models/application_customer.rb +66 -31
- data/lib/talon_one/models/application_customer_entity.rb +39 -16
- data/lib/talon_one/models/application_customer_search.rb +42 -19
- data/lib/talon_one/models/application_entity.rb +39 -16
- data/lib/talon_one/models/application_event.rb +48 -25
- data/lib/talon_one/models/application_session.rb +73 -35
- data/lib/talon_one/models/application_session_entity.rb +39 -16
- data/lib/talon_one/models/attribute.rb +73 -38
- data/lib/talon_one/models/attributes_mandatory.rb +222 -0
- data/lib/talon_one/models/attributes_settings.rb +207 -0
- data/lib/talon_one/models/audience.rb +360 -0
- data/lib/talon_one/models/audience_membership.rb +227 -0
- data/lib/talon_one/models/base_saml_connection.rb +359 -0
- data/lib/talon_one/models/binding.rb +39 -16
- data/lib/talon_one/models/campaign.rb +93 -58
- data/lib/talon_one/models/campaign_analytics.rb +223 -50
- data/lib/talon_one/models/campaign_copy.rb +86 -21
- data/lib/talon_one/models/campaign_entity.rb +39 -16
- data/lib/talon_one/models/campaign_group.rb +326 -0
- data/lib/talon_one/models/campaign_group_entity.rb +209 -0
- data/lib/talon_one/models/campaign_search.rb +38 -15
- data/lib/talon_one/models/campaign_set.rb +77 -20
- data/lib/talon_one/models/campaign_set_branch_node.rb +47 -24
- data/lib/talon_one/models/campaign_set_leaf_node.rb +43 -20
- data/lib/talon_one/models/campaign_set_node.rb +38 -15
- data/lib/talon_one/models/cart_item.rb +49 -26
- data/lib/talon_one/models/cart_item_adjustment.rb +43 -20
- data/lib/talon_one/models/change.rb +46 -23
- data/lib/talon_one/models/change_profile_password.rb +227 -0
- data/lib/talon_one/models/code_generator_settings.rb +41 -18
- data/lib/talon_one/models/coupon.rb +117 -40
- data/lib/talon_one/models/coupon_constraints.rb +78 -21
- data/lib/talon_one/models/coupon_created_effect_props.rb +228 -0
- data/lib/talon_one/models/coupon_rejection_reason.rb +45 -22
- data/lib/talon_one/models/coupon_reservations.rb +39 -16
- data/lib/talon_one/models/coupon_search.rb +38 -15
- data/lib/talon_one/models/coupon_value.rb +38 -15
- data/lib/talon_one/models/create_application_api_key.rb +87 -20
- data/lib/talon_one/models/customer_activity_report.rb +62 -39
- data/lib/talon_one/models/customer_analytics.rb +51 -28
- data/lib/talon_one/models/customer_inventory.rb +237 -0
- data/lib/talon_one/models/customer_profile.rb +65 -30
- data/lib/talon_one/models/customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/customer_profile_audience_request_item.rb +273 -0
- data/lib/talon_one/models/customer_profile_integration_request_v2.rb +242 -0
- data/lib/talon_one/models/customer_profile_search_query.rb +42 -19
- data/lib/talon_one/models/customer_session.rb +60 -37
- data/lib/talon_one/models/customer_session_v2.rb +447 -0
- data/lib/talon_one/models/deduct_loyalty_points_effect_props.rb +258 -0
- data/lib/talon_one/models/effect.rb +287 -0
- data/lib/talon_one/models/effect_entity.rb +273 -0
- data/lib/talon_one/models/email_entity.rb +38 -15
- data/lib/talon_one/models/entity.rb +39 -16
- data/lib/talon_one/models/entity_with_talang_visible_id.rb +227 -0
- data/lib/talon_one/models/environment.rb +45 -22
- data/lib/talon_one/models/error_effect_props.rb +213 -0
- data/lib/talon_one/models/error_response.rb +39 -16
- data/lib/talon_one/models/error_source.rb +41 -18
- data/lib/talon_one/models/event.rb +51 -28
- data/lib/talon_one/models/event_type.rb +59 -36
- data/lib/talon_one/models/export.rb +48 -25
- data/lib/talon_one/models/feature_flag.rb +41 -18
- data/lib/talon_one/models/feature_flags.rb +46 -23
- data/lib/talon_one/models/features_feed.rb +40 -17
- data/lib/talon_one/models/feed_notification.rb +322 -0
- data/lib/talon_one/models/func_arg_def.rb +42 -19
- data/lib/talon_one/models/function_def.rb +42 -19
- data/lib/talon_one/models/import.rb +48 -25
- data/lib/talon_one/models/import_coupons.rb +38 -15
- data/lib/talon_one/models/{inline_response_200.rb → inline_response200.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_2.rb → inline_response2001.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_10.rb → inline_response20010.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_11.rb → inline_response20011.rb} +40 -17
- data/lib/talon_one/models/inline_response20012.rb +231 -0
- data/lib/talon_one/models/{inline_response_200_13.rb → inline_response20013.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_14.rb → inline_response20014.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_15.rb → inline_response20015.rb} +41 -18
- data/lib/talon_one/models/inline_response20016.rb +222 -0
- data/lib/talon_one/models/{inline_response_200_17.rb → inline_response20017.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_18.rb → inline_response20018.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_19.rb → inline_response20019.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_3.rb → inline_response2002.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_12.rb → inline_response20020.rb} +42 -19
- data/lib/talon_one/models/inline_response20021.rb +227 -0
- data/lib/talon_one/models/{inline_response_200_20.rb → inline_response20022.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_21.rb → inline_response20023.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_22.rb → inline_response20024.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_23.rb → inline_response20025.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_24.rb → inline_response20026.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_25.rb → inline_response20027.rb} +44 -21
- data/lib/talon_one/models/{inline_response_200_26.rb → inline_response20028.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_27.rb → inline_response20029.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_4.rb → inline_response2003.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_28.rb → inline_response20030.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_1.rb → inline_response2004.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_5.rb → inline_response2005.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_6.rb → inline_response2006.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_7.rb → inline_response2007.rb} +41 -18
- data/lib/talon_one/models/{inline_response_200_8.rb → inline_response2008.rb} +40 -17
- data/lib/talon_one/models/{inline_response_200_9.rb → inline_response2009.rb} +40 -17
- data/lib/talon_one/models/integration_entity.rb +41 -18
- data/lib/talon_one/models/integration_event.rb +41 -18
- data/lib/talon_one/models/integration_profile_entity.rb +39 -16
- data/lib/talon_one/models/integration_request.rb +246 -0
- data/lib/talon_one/models/integration_state.rb +42 -19
- data/lib/talon_one/models/integration_state_v2.rb +313 -0
- data/lib/talon_one/models/ledger_entry.rb +53 -30
- data/lib/talon_one/models/library_attribute.rb +50 -27
- data/lib/talon_one/models/limit_config.rb +43 -20
- data/lib/talon_one/models/login_params.rb +39 -16
- data/lib/talon_one/models/loyalty.rb +38 -15
- data/lib/talon_one/models/loyalty_ledger.rb +40 -18
- data/lib/talon_one/models/loyalty_ledger_entry.rb +76 -67
- data/lib/talon_one/models/loyalty_membership.rb +40 -17
- data/lib/talon_one/models/loyalty_points.rb +59 -26
- data/lib/talon_one/models/loyalty_program.rb +67 -29
- data/lib/talon_one/models/loyalty_program_balance.rb +39 -16
- data/lib/talon_one/models/loyalty_program_ledgers.rb +43 -21
- data/lib/talon_one/models/loyalty_statistics.rb +258 -0
- data/lib/talon_one/models/loyalty_sub_ledger.rb +144 -24
- data/lib/talon_one/models/manager_config.rb +39 -16
- data/lib/talon_one/models/meta.rb +45 -21
- data/lib/talon_one/models/multi_application_entity.rb +39 -16
- data/lib/talon_one/models/multiple_customer_profile_integration_request.rb +208 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_request_item.rb +223 -0
- data/lib/talon_one/models/multiple_customer_profile_integration_response_v2.rb +208 -0
- data/lib/talon_one/models/mutable_entity.rb +38 -15
- data/lib/talon_one/models/new_account.rb +39 -16
- data/lib/talon_one/models/new_account_sign_up.rb +41 -18
- data/lib/talon_one/models/new_additional_cost.rb +255 -0
- data/lib/talon_one/models/new_application.rb +138 -48
- data/lib/talon_one/models/new_application_api_key.rb +119 -52
- data/lib/talon_one/models/new_attribute.rb +69 -34
- data/lib/talon_one/models/new_audience.rb +314 -0
- data/lib/talon_one/models/new_campaign.rb +73 -38
- data/lib/talon_one/models/new_campaign_group.rb +265 -0
- data/lib/talon_one/models/new_campaign_set.rb +75 -18
- data/lib/talon_one/models/new_coupons.rb +89 -32
- data/lib/talon_one/models/new_customer_profile.rb +38 -15
- data/lib/talon_one/models/new_customer_session.rb +50 -27
- data/lib/talon_one/models/new_customer_session_v2.rb +322 -0
- data/lib/talon_one/models/new_event.rb +43 -20
- data/lib/talon_one/models/new_event_type.rb +57 -34
- data/lib/talon_one/models/new_feature_flags.rb +44 -21
- data/lib/talon_one/models/new_import.rb +41 -18
- data/lib/talon_one/models/new_invitation.rb +41 -18
- data/lib/talon_one/models/new_invite_email.rb +39 -16
- data/lib/talon_one/models/new_loyalty_program.rb +64 -26
- data/lib/talon_one/models/new_password.rb +40 -17
- data/lib/talon_one/models/new_password_email.rb +38 -15
- data/lib/talon_one/models/new_referral.rb +47 -24
- data/lib/talon_one/models/new_role.rb +41 -18
- data/lib/talon_one/models/new_ruleset.rb +43 -20
- data/lib/talon_one/models/new_saml_connection.rb +105 -67
- data/lib/talon_one/models/new_template_def.rb +45 -22
- data/lib/talon_one/models/new_user.rb +42 -19
- data/lib/talon_one/models/new_webhook.rb +50 -27
- data/lib/talon_one/models/notification.rb +40 -17
- data/lib/talon_one/models/redeem_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/referral.rb +54 -31
- data/lib/talon_one/models/referral_created_effect_props.rb +213 -0
- data/lib/talon_one/models/referral_rejection_reason.rb +45 -22
- data/lib/talon_one/models/reject_coupon_effect_props.rb +228 -0
- data/lib/talon_one/models/reject_referral_effect_props.rb +228 -0
- data/lib/talon_one/models/role.rb +58 -25
- data/lib/talon_one/models/role_assign.rb +39 -16
- data/lib/talon_one/models/role_membership.rb +41 -18
- data/lib/talon_one/models/rollback_coupon_effect_props.rb +213 -0
- data/lib/talon_one/models/rollback_discount_effect_props.rb +228 -0
- data/lib/talon_one/models/rule.rb +42 -19
- data/lib/talon_one/models/ruleset.rb +51 -28
- data/lib/talon_one/models/saml_connection.rb +93 -103
- data/lib/talon_one/models/saml_connection_metadata.rb +294 -0
- data/lib/talon_one/models/saml_login_endpoint.rb +265 -0
- data/lib/talon_one/models/session.rb +41 -18
- data/lib/talon_one/models/set_discount_effect_props.rb +238 -0
- data/lib/talon_one/models/set_discount_per_item_effect_props.rb +253 -0
- data/lib/talon_one/models/show_bundle_metadata_effect_props.rb +247 -0
- data/lib/talon_one/models/show_notification_effect_props.rb +243 -0
- data/lib/talon_one/models/slot_def.rb +44 -21
- data/lib/talon_one/models/template_arg_def.rb +44 -21
- data/lib/talon_one/models/template_def.rb +50 -27
- data/lib/talon_one/models/trigger_webhook_effect_props.rb +228 -0
- data/lib/talon_one/models/update_account.rb +100 -23
- data/lib/talon_one/models/update_application.rb +135 -29
- data/lib/talon_one/models/update_attribute_effect_props.rb +228 -0
- data/lib/talon_one/models/update_audience.rb +231 -0
- data/lib/talon_one/models/update_campaign.rb +73 -38
- data/lib/talon_one/models/update_campaign_group.rb +266 -0
- data/lib/talon_one/models/update_coupon.rb +81 -24
- data/lib/talon_one/models/update_coupon_batch.rb +81 -24
- data/lib/talon_one/models/update_loyalty_program.rb +58 -25
- data/lib/talon_one/models/update_role.rb +42 -19
- data/lib/talon_one/models/update_user.rb +47 -80
- data/lib/talon_one/models/update_user_latest_feed_timestamp.rb +213 -0
- data/lib/talon_one/models/user.rb +67 -59
- data/lib/talon_one/models/user_entity.rb +39 -16
- data/lib/talon_one/models/user_feed_notifications.rb +230 -0
- data/lib/talon_one/models/webhook.rb +53 -30
- data/lib/talon_one/models/webhook_activation_log_entry.rb +46 -23
- data/lib/talon_one/models/webhook_log_entry.rb +52 -29
- data/lib/talon_one/version.rb +4 -4
- data/spec/api/integration_api_spec.rb +76 -15
- data/spec/api/management_api_spec.rb +155 -143
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +6 -6
- data/spec/models/{misc_update_user_latest_feature_spec.rb → accept_coupon_effect_props_spec.rb} +11 -11
- data/spec/models/accept_referral_effect_props_spec.rb +41 -0
- data/spec/models/access_log_entry_spec.rb +4 -4
- data/spec/models/account_additional_cost_spec.rb +77 -0
- data/spec/models/account_analytics_spec.rb +33 -9
- data/spec/models/account_entity_spec.rb +4 -4
- data/spec/models/account_limits_spec.rb +10 -4
- data/spec/models/account_spec.rb +5 -5
- data/spec/models/add_free_item_effect_props_spec.rb +47 -0
- data/spec/models/add_loyalty_points_effect_props_spec.rb +77 -0
- data/spec/models/additional_cost_spec.rb +41 -0
- data/spec/models/api_error_spec.rb +4 -4
- data/spec/models/application_api_health_spec.rb +4 -4
- data/spec/models/application_api_key_spec.rb +21 -11
- data/spec/models/application_customer_entity_spec.rb +4 -4
- data/spec/models/application_customer_search_spec.rb +4 -4
- data/spec/models/application_customer_spec.rb +10 -4
- data/spec/models/application_entity_spec.rb +4 -4
- data/spec/models/application_event_spec.rb +4 -4
- data/spec/models/application_session_entity_spec.rb +4 -4
- data/spec/models/application_session_spec.rb +10 -4
- data/spec/models/application_spec.rb +43 -5
- data/spec/models/attribute_spec.rb +10 -4
- data/spec/models/attributes_mandatory_spec.rb +47 -0
- data/spec/models/attributes_settings_spec.rb +41 -0
- data/spec/models/audience_membership_spec.rb +47 -0
- data/spec/models/audience_spec.rb +75 -0
- data/spec/models/base_saml_connection_spec.rb +83 -0
- data/spec/models/binding_spec.rb +4 -4
- data/spec/models/campaign_analytics_spec.rb +64 -4
- data/spec/models/campaign_copy_spec.rb +28 -4
- data/spec/models/campaign_entity_spec.rb +4 -4
- data/spec/models/campaign_group_entity_spec.rb +41 -0
- data/spec/models/campaign_group_spec.rb +83 -0
- data/spec/models/campaign_search_spec.rb +4 -4
- data/spec/models/campaign_set_branch_node_spec.rb +4 -4
- data/spec/models/campaign_set_leaf_node_spec.rb +4 -4
- data/spec/models/campaign_set_node_spec.rb +4 -4
- data/spec/models/campaign_set_spec.rb +10 -4
- data/spec/models/campaign_spec.rb +10 -4
- data/spec/models/cart_item_adjustment_spec.rb +4 -4
- data/spec/models/cart_item_spec.rb +4 -4
- data/spec/models/change_profile_password_spec.rb +47 -0
- data/spec/models/change_spec.rb +4 -4
- data/spec/models/code_generator_settings_spec.rb +4 -4
- data/spec/models/coupon_constraints_spec.rb +10 -4
- data/spec/models/coupon_created_effect_props_spec.rb +47 -0
- data/spec/models/coupon_rejection_reason_spec.rb +5 -5
- data/spec/models/coupon_reservations_spec.rb +4 -4
- data/spec/models/coupon_search_spec.rb +4 -4
- data/spec/models/coupon_spec.rb +22 -4
- data/spec/models/coupon_value_spec.rb +4 -4
- data/spec/models/create_application_api_key_spec.rb +14 -4
- data/spec/models/customer_activity_report_spec.rb +4 -4
- data/spec/models/customer_analytics_spec.rb +4 -4
- data/spec/models/customer_inventory_spec.rb +59 -0
- data/spec/models/customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/customer_profile_integration_request_v2_spec.rb +51 -0
- data/spec/models/customer_profile_search_query_spec.rb +4 -4
- data/spec/models/customer_profile_spec.rb +10 -4
- data/spec/models/customer_session_spec.rb +4 -4
- data/spec/models/customer_session_v2_spec.rb +129 -0
- data/spec/models/deduct_loyalty_points_effect_props_spec.rb +59 -0
- data/spec/models/effect_entity_spec.rb +65 -0
- data/spec/models/effect_spec.rb +71 -0
- data/spec/models/email_entity_spec.rb +4 -4
- data/spec/models/entity_spec.rb +4 -4
- data/spec/models/entity_with_talang_visible_id_spec.rb +47 -0
- data/spec/models/environment_spec.rb +4 -4
- data/spec/models/error_effect_props_spec.rb +41 -0
- data/spec/models/error_response_spec.rb +4 -4
- data/spec/models/error_source_spec.rb +4 -4
- data/spec/models/event_spec.rb +4 -4
- data/spec/models/event_type_spec.rb +4 -4
- data/spec/models/export_spec.rb +4 -4
- data/spec/models/feature_flag_spec.rb +4 -4
- data/spec/models/feature_flags_spec.rb +4 -4
- data/spec/models/features_feed_spec.rb +4 -4
- data/spec/models/feed_notification_spec.rb +75 -0
- data/spec/models/func_arg_def_spec.rb +4 -4
- data/spec/models/function_def_spec.rb +4 -4
- data/spec/models/import_coupons_spec.rb +4 -4
- data/spec/models/import_spec.rb +4 -4
- data/spec/models/{inline_response_200_10_spec.rb → inline_response20010_spec.rb} +4 -4
- data/spec/models/{inline_response_200_11_spec.rb → inline_response20011_spec.rb} +4 -4
- data/spec/models/{inline_response_200_12_spec.rb → inline_response20012_spec.rb} +10 -4
- data/spec/models/{inline_response_200_13_spec.rb → inline_response20013_spec.rb} +4 -4
- data/spec/models/{inline_response_200_14_spec.rb → inline_response20014_spec.rb} +4 -4
- data/spec/models/{inline_response_200_15_spec.rb → inline_response20015_spec.rb} +4 -4
- data/spec/models/{inline_response_200_16_spec.rb → inline_response20016_spec.rb} +5 -5
- data/spec/models/{inline_response_200_17_spec.rb → inline_response20017_spec.rb} +4 -4
- data/spec/models/{inline_response_200_18_spec.rb → inline_response20018_spec.rb} +4 -4
- data/spec/models/{inline_response_200_19_spec.rb → inline_response20019_spec.rb} +4 -4
- data/spec/models/{inline_response_200_1_spec.rb → inline_response2001_spec.rb} +4 -4
- data/spec/models/{inline_response_200_20_spec.rb → inline_response20020_spec.rb} +4 -4
- data/spec/models/{inline_response_200_21_spec.rb → inline_response20021_spec.rb} +4 -4
- data/spec/models/{inline_response_200_22_spec.rb → inline_response20022_spec.rb} +4 -4
- data/spec/models/{inline_response_200_23_spec.rb → inline_response20023_spec.rb} +4 -4
- data/spec/models/{inline_response_200_24_spec.rb → inline_response20024_spec.rb} +4 -4
- data/spec/models/{inline_response_200_25_spec.rb → inline_response20025_spec.rb} +4 -10
- data/spec/models/{inline_response_200_26_spec.rb → inline_response20026_spec.rb} +4 -4
- data/spec/models/{inline_response_200_27_spec.rb → inline_response20027_spec.rb} +10 -4
- data/spec/models/{inline_response_200_28_spec.rb → inline_response20028_spec.rb} +4 -4
- data/spec/models/inline_response20029_spec.rb +47 -0
- data/spec/models/{inline_response_200_2_spec.rb → inline_response2002_spec.rb} +4 -4
- data/spec/models/inline_response20030_spec.rb +47 -0
- data/spec/models/{inline_response_200_3_spec.rb → inline_response2003_spec.rb} +4 -4
- data/spec/models/{inline_response_200_4_spec.rb → inline_response2004_spec.rb} +4 -4
- data/spec/models/{inline_response_200_5_spec.rb → inline_response2005_spec.rb} +4 -4
- data/spec/models/{inline_response_200_6_spec.rb → inline_response2006_spec.rb} +4 -4
- data/spec/models/{inline_response_200_7_spec.rb → inline_response2007_spec.rb} +4 -4
- data/spec/models/{inline_response_200_8_spec.rb → inline_response2008_spec.rb} +4 -4
- data/spec/models/{inline_response_200_9_spec.rb → inline_response2009_spec.rb} +4 -4
- data/spec/models/{inline_response_200_spec.rb → inline_response200_spec.rb} +4 -4
- data/spec/models/integration_entity_spec.rb +4 -4
- data/spec/models/integration_event_spec.rb +4 -4
- data/spec/models/integration_profile_entity_spec.rb +4 -4
- data/spec/models/integration_request_spec.rb +51 -0
- data/spec/models/integration_state_spec.rb +4 -4
- data/spec/models/integration_state_v2_spec.rb +95 -0
- data/spec/models/ledger_entry_spec.rb +4 -4
- data/spec/models/library_attribute_spec.rb +4 -4
- data/spec/models/limit_config_spec.rb +4 -4
- data/spec/models/login_params_spec.rb +4 -4
- data/spec/models/loyalty_ledger_entry_spec.rb +16 -8
- data/spec/models/loyalty_ledger_spec.rb +4 -4
- data/spec/models/loyalty_membership_spec.rb +4 -4
- data/spec/models/loyalty_points_spec.rb +11 -5
- data/spec/models/loyalty_program_balance_spec.rb +4 -4
- data/spec/models/loyalty_program_ledgers_spec.rb +4 -4
- data/spec/models/loyalty_program_spec.rb +10 -4
- data/spec/models/loyalty_spec.rb +4 -4
- data/spec/models/loyalty_statistics_spec.rb +59 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +46 -4
- data/spec/models/manager_config_spec.rb +4 -4
- data/spec/models/meta_spec.rb +4 -4
- data/spec/models/multi_application_entity_spec.rb +4 -4
- data/spec/models/multiple_customer_profile_integration_request_item_spec.rb +47 -0
- data/spec/models/multiple_customer_profile_integration_request_spec.rb +41 -0
- data/spec/models/multiple_customer_profile_integration_response_v2_spec.rb +41 -0
- data/spec/models/mutable_entity_spec.rb +4 -4
- data/spec/models/new_account_sign_up_spec.rb +4 -4
- data/spec/models/new_account_spec.rb +4 -4
- data/spec/models/new_additional_cost_spec.rb +59 -0
- data/spec/models/new_application_api_key_spec.rb +21 -11
- data/spec/models/new_application_spec.rb +48 -4
- data/spec/models/new_attribute_spec.rb +10 -4
- data/spec/models/new_audience_spec.rb +57 -0
- data/spec/models/new_campaign_group_spec.rb +59 -0
- data/spec/models/new_campaign_set_spec.rb +10 -4
- data/spec/models/new_campaign_spec.rb +10 -4
- data/spec/models/new_coupons_spec.rb +10 -4
- data/spec/models/new_customer_profile_spec.rb +4 -4
- data/spec/models/new_customer_session_spec.rb +4 -4
- data/spec/models/new_customer_session_v2_spec.rb +87 -0
- data/spec/models/new_event_spec.rb +4 -4
- data/spec/models/new_event_type_spec.rb +4 -4
- data/spec/models/new_feature_flags_spec.rb +4 -4
- data/spec/models/new_import_spec.rb +4 -4
- data/spec/models/new_invitation_spec.rb +4 -4
- data/spec/models/new_invite_email_spec.rb +4 -4
- data/spec/models/new_loyalty_program_spec.rb +10 -4
- data/spec/models/new_password_email_spec.rb +4 -4
- data/spec/models/new_password_spec.rb +4 -4
- data/spec/models/new_referral_spec.rb +4 -4
- data/spec/models/new_role_spec.rb +4 -4
- data/spec/models/new_ruleset_spec.rb +4 -4
- data/spec/models/new_saml_connection_spec.rb +17 -11
- data/spec/models/new_template_def_spec.rb +4 -4
- data/spec/models/new_user_spec.rb +4 -4
- data/spec/models/new_webhook_spec.rb +4 -4
- data/spec/models/notification_spec.rb +4 -4
- data/spec/models/redeem_referral_effect_props_spec.rb +47 -0
- data/spec/models/referral_created_effect_props_spec.rb +41 -0
- data/spec/models/referral_rejection_reason_spec.rb +5 -5
- data/spec/models/referral_spec.rb +4 -4
- data/spec/models/reject_coupon_effect_props_spec.rb +47 -0
- data/spec/models/reject_referral_effect_props_spec.rb +47 -0
- data/spec/models/role_assign_spec.rb +4 -4
- data/spec/models/role_membership_spec.rb +4 -4
- data/spec/models/role_spec.rb +10 -4
- data/spec/models/rollback_coupon_effect_props_spec.rb +41 -0
- data/spec/models/rollback_discount_effect_props_spec.rb +47 -0
- data/spec/models/rule_spec.rb +4 -4
- data/spec/models/ruleset_spec.rb +4 -4
- data/spec/models/saml_connection_metadata_spec.rb +59 -0
- data/spec/models/saml_connection_spec.rb +13 -19
- data/spec/models/saml_login_endpoint_spec.rb +47 -0
- data/spec/models/session_spec.rb +4 -4
- data/spec/models/set_discount_effect_props_spec.rb +53 -0
- data/spec/models/set_discount_per_item_effect_props_spec.rb +59 -0
- data/spec/models/show_bundle_metadata_effect_props_spec.rb +53 -0
- data/spec/models/show_notification_effect_props_spec.rb +53 -0
- data/spec/models/slot_def_spec.rb +4 -4
- data/spec/models/template_arg_def_spec.rb +4 -4
- data/spec/models/template_def_spec.rb +4 -4
- data/spec/models/trigger_webhook_effect_props_spec.rb +47 -0
- data/spec/models/update_account_spec.rb +20 -4
- data/spec/models/update_application_spec.rb +48 -4
- data/spec/models/update_attribute_effect_props_spec.rb +47 -0
- data/spec/models/update_audience_spec.rb +41 -0
- data/spec/models/update_campaign_group_spec.rb +59 -0
- data/spec/models/update_campaign_spec.rb +10 -4
- data/spec/models/update_coupon_batch_spec.rb +10 -4
- data/spec/models/update_coupon_spec.rb +10 -4
- data/spec/models/update_loyalty_program_spec.rb +10 -4
- data/spec/models/update_role_spec.rb +4 -4
- data/spec/models/update_user_latest_feed_timestamp_spec.rb +41 -0
- data/spec/models/update_user_spec.rb +4 -34
- data/spec/models/user_entity_spec.rb +4 -4
- data/spec/models/user_feed_notifications_spec.rb +47 -0
- data/spec/models/user_spec.rb +5 -11
- data/spec/models/webhook_activation_log_entry_spec.rb +4 -4
- data/spec/models/webhook_log_entry_spec.rb +4 -4
- data/spec/models/webhook_spec.rb +4 -4
- data/spec/spec_helper.rb +3 -3
- data/talon_one.gemspec +6 -11
- metadata +314 -228
- data/CHANGELOG.md +0 -63
- data/docs/AttributeQuery.md +0 -7
- data/docs/MiscUpdateUserLatestFeature.md +0 -8
- data/docs/Notifications.md +0 -7
- data/git_push.sh +0 -55
- data/lib/talon_one/models/attribute_query.rb +0 -174
- data/lib/talon_one/models/inline_response_200_16.rb +0 -204
- data/lib/talon_one/models/misc_update_user_latest_feature.rb +0 -183
- data/lib/talon_one/models/notifications.rb +0 -174
- data/spec/models/attribute_query_spec.rb +0 -35
- data/spec/models/notifications_spec.rb +0 -35
- data/talon_one-1.0.0.gem +0 -0
- data/talon_one-1.1.0.gem +0 -0
- data/talon_one-1.1.1.gem +0 -0
- data/talon_one-1.1.2.gem +0 -0
- data/talon_one-1.2.0.gem +0 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TalonOne::LoyaltyStatistics
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**total_active_points** | **Float** | Total of active points for this loyalty program |
|
|
8
|
+
**total_pending_points** | **Float** | Total of pending points for this loyalty program |
|
|
9
|
+
**total_spent_points** | **Float** | Total of spent points for this loyalty program |
|
|
10
|
+
**total_expired_points** | **Float** | Total of expired points for this loyalty program |
|
|
11
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'TalonOne'
|
|
16
|
+
|
|
17
|
+
instance = TalonOne::LoyaltyStatistics.new(total_active_points: null,
|
|
18
|
+
total_pending_points: null,
|
|
19
|
+
total_spent_points: null,
|
|
20
|
+
total_expired_points: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
data/docs/LoyaltySubLedger.md
CHANGED
|
@@ -1,10 +1,35 @@
|
|
|
1
1
|
# TalonOne::LoyaltySubLedger
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
|
+
|
|
4
5
|
Name | Type | Description | Notes
|
|
5
6
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**total** | **Float** | |
|
|
7
|
-
**
|
|
8
|
-
**
|
|
7
|
+
**total** | **Float** | ⚠️ Deprecated: Please use 'totalActivePoints' property instead. Total amount of currently active and available points in the customer's balance |
|
|
8
|
+
**total_active_points** | **Float** | Total amount of currently active and available points in the customer's balance |
|
|
9
|
+
**total_pending_points** | **Float** | Total amount of pending points, which are not active yet but will become active in the future |
|
|
10
|
+
**total_spent_points** | **Float** | Total amount of points already spent by this customer |
|
|
11
|
+
**total_expired_points** | **Float** | Total amount of points, that expired without ever being spent |
|
|
12
|
+
**transactions** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all events that have happened such as additions, subtractions and expiries | [optional]
|
|
13
|
+
**expiring_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points that will expire | [optional]
|
|
14
|
+
**active_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all currently active points | [optional]
|
|
15
|
+
**pending_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of all points pending activation | [optional]
|
|
16
|
+
**expired_points** | [**Array<LoyaltyLedgerEntry>**](LoyaltyLedgerEntry.md) | List of expired points | [optional]
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'TalonOne'
|
|
22
|
+
|
|
23
|
+
instance = TalonOne::LoyaltySubLedger.new(total: null,
|
|
24
|
+
total_active_points: null,
|
|
25
|
+
total_pending_points: null,
|
|
26
|
+
total_spent_points: null,
|
|
27
|
+
total_expired_points: null,
|
|
28
|
+
transactions: null,
|
|
29
|
+
expiring_points: null,
|
|
30
|
+
active_points: null,
|
|
31
|
+
pending_points: null,
|
|
32
|
+
expired_points: null)
|
|
33
|
+
```
|
|
9
34
|
|
|
10
35
|
|
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,8 @@ 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
|
-
[**
|
|
64
|
+
[**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{programID}/statistics | Get loyalty program statistics by loyalty program ID
|
|
65
|
+
[**get_referrals**](ManagementApi.md#get_referrals) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals | List Referrals (with total count)
|
|
62
66
|
[**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List Referrals
|
|
63
67
|
[**get_role**](ManagementApi.md#get_role) | **GET** /v1/roles/{roleId} | Get information for the specified role.
|
|
64
68
|
[**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get a Ruleset
|
|
@@ -69,29 +73,29 @@ Method | HTTP request | Description
|
|
|
69
73
|
[**get_webhook_activation_logs**](ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List Webhook activation Log Entries
|
|
70
74
|
[**get_webhook_logs**](ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List Webhook Log Entries
|
|
71
75
|
[**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
76
|
[**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
77
|
[**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
|
|
78
|
+
[**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)
|
|
79
|
+
[**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
80
|
[**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
81
|
[**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
|
-
[**
|
|
82
|
+
[**update_additional_cost**](ManagementApi.md#update_additional_cost) | **PUT** /v1/additional_costs/{additionalCostId} | Update an additional cost
|
|
83
|
+
[**update_attribute**](ManagementApi.md#update_attribute) | **PUT** /v1/attributes/{attributeId} | Update a custom attribute
|
|
80
84
|
[**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
85
|
[**update_coupon**](ManagementApi.md#update_coupon) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Update a Coupon
|
|
83
86
|
[**update_coupon_batch**](ManagementApi.md#update_coupon_batch) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Update a Batch of Coupons
|
|
84
87
|
[**update_ruleset**](ManagementApi.md#update_ruleset) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Update a Ruleset
|
|
85
88
|
|
|
86
89
|
|
|
87
|
-
# **add_loyalty_points**
|
|
88
|
-
> add_loyalty_points(program_id, integration_id, body)
|
|
89
90
|
|
|
90
|
-
|
|
91
|
+
## add_loyalty_points
|
|
91
92
|
|
|
93
|
+
> add_loyalty_points(program_id, integration_id, body)
|
|
92
94
|
|
|
95
|
+
Add points in a certain loyalty program for the specified customer
|
|
93
96
|
|
|
94
97
|
### Example
|
|
98
|
+
|
|
95
99
|
```ruby
|
|
96
100
|
# load the gem
|
|
97
101
|
require 'talon_one'
|
|
@@ -104,14 +108,10 @@ TalonOne.configure do |config|
|
|
|
104
108
|
end
|
|
105
109
|
|
|
106
110
|
api_instance = TalonOne::ManagementApi.new
|
|
107
|
-
|
|
108
111
|
program_id = 'program_id_example' # String |
|
|
109
|
-
|
|
110
112
|
integration_id = 'integration_id_example' # String |
|
|
111
|
-
|
|
112
113
|
body = TalonOne::LoyaltyPoints.new # LoyaltyPoints |
|
|
113
114
|
|
|
114
|
-
|
|
115
115
|
begin
|
|
116
116
|
#Add points in a certain loyalty program for the specified customer
|
|
117
117
|
api_instance.add_loyalty_points(program_id, integration_id, body)
|
|
@@ -122,6 +122,7 @@ end
|
|
|
122
122
|
|
|
123
123
|
### Parameters
|
|
124
124
|
|
|
125
|
+
|
|
125
126
|
Name | Type | Description | Notes
|
|
126
127
|
------------- | ------------- | ------------- | -------------
|
|
127
128
|
**program_id** | **String**| |
|
|
@@ -138,19 +139,20 @@ nil (empty response body)
|
|
|
138
139
|
|
|
139
140
|
### HTTP request headers
|
|
140
141
|
|
|
141
|
-
|
|
142
|
-
|
|
142
|
+
- **Content-Type**: application/json
|
|
143
|
+
- **Accept**: Not defined
|
|
143
144
|
|
|
144
145
|
|
|
146
|
+
## copy_campaign_to_applications
|
|
145
147
|
|
|
146
|
-
|
|
147
|
-
> InlineResponse2003 copy_campaign_to_applications(application_id, campaign_id, body)
|
|
148
|
+
> InlineResponse2002 copy_campaign_to_applications(application_id, campaign_id, body)
|
|
148
149
|
|
|
149
150
|
Copy the campaign into every specified application
|
|
150
151
|
|
|
151
152
|
Copy the campaign into every specified application.
|
|
152
153
|
|
|
153
154
|
### Example
|
|
155
|
+
|
|
154
156
|
```ruby
|
|
155
157
|
# load the gem
|
|
156
158
|
require 'talon_one'
|
|
@@ -163,14 +165,10 @@ TalonOne.configure do |config|
|
|
|
163
165
|
end
|
|
164
166
|
|
|
165
167
|
api_instance = TalonOne::ManagementApi.new
|
|
166
|
-
|
|
167
168
|
application_id = 56 # Integer |
|
|
168
|
-
|
|
169
169
|
campaign_id = 56 # Integer |
|
|
170
|
-
|
|
171
170
|
body = TalonOne::CampaignCopy.new # CampaignCopy |
|
|
172
171
|
|
|
173
|
-
|
|
174
172
|
begin
|
|
175
173
|
#Copy the campaign into every specified application
|
|
176
174
|
result = api_instance.copy_campaign_to_applications(application_id, campaign_id, body)
|
|
@@ -182,6 +180,7 @@ end
|
|
|
182
180
|
|
|
183
181
|
### Parameters
|
|
184
182
|
|
|
183
|
+
|
|
185
184
|
Name | Type | Description | Notes
|
|
186
185
|
------------- | ------------- | ------------- | -------------
|
|
187
186
|
**application_id** | **Integer**| |
|
|
@@ -190,7 +189,7 @@ Name | Type | Description | Notes
|
|
|
190
189
|
|
|
191
190
|
### Return type
|
|
192
191
|
|
|
193
|
-
[**
|
|
192
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
194
193
|
|
|
195
194
|
### Authorization
|
|
196
195
|
|
|
@@ -198,19 +197,74 @@ Name | Type | Description | Notes
|
|
|
198
197
|
|
|
199
198
|
### HTTP request headers
|
|
200
199
|
|
|
201
|
-
|
|
202
|
-
|
|
200
|
+
- **Content-Type**: application/json
|
|
201
|
+
- **Accept**: application/json
|
|
203
202
|
|
|
204
203
|
|
|
204
|
+
## create_additional_cost
|
|
205
205
|
|
|
206
|
-
|
|
207
|
-
> Campaign create_campaign(application_id, body)
|
|
206
|
+
> AccountAdditionalCost create_additional_cost(body)
|
|
208
207
|
|
|
209
|
-
|
|
208
|
+
Define a new additional cost
|
|
209
|
+
|
|
210
|
+
Defines a new _additional cost_ in this account. These additional costs are shared across all applications in your account, and are never required.
|
|
211
|
+
|
|
212
|
+
### Example
|
|
213
|
+
|
|
214
|
+
```ruby
|
|
215
|
+
# load the gem
|
|
216
|
+
require 'talon_one'
|
|
217
|
+
# setup authorization
|
|
218
|
+
TalonOne.configure do |config|
|
|
219
|
+
# Configure API key authorization: manager_auth
|
|
220
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
221
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
222
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
api_instance = TalonOne::ManagementApi.new
|
|
226
|
+
body = TalonOne::NewAdditionalCost.new # NewAdditionalCost |
|
|
210
227
|
|
|
228
|
+
begin
|
|
229
|
+
#Define a new additional cost
|
|
230
|
+
result = api_instance.create_additional_cost(body)
|
|
231
|
+
p result
|
|
232
|
+
rescue TalonOne::ApiError => e
|
|
233
|
+
puts "Exception when calling ManagementApi->create_additional_cost: #{e}"
|
|
234
|
+
end
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### Parameters
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
Name | Type | Description | Notes
|
|
241
|
+
------------- | ------------- | ------------- | -------------
|
|
242
|
+
**body** | [**NewAdditionalCost**](NewAdditionalCost.md)| |
|
|
211
243
|
|
|
244
|
+
### Return type
|
|
245
|
+
|
|
246
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
247
|
+
|
|
248
|
+
### Authorization
|
|
249
|
+
|
|
250
|
+
[manager_auth](../README.md#manager_auth)
|
|
251
|
+
|
|
252
|
+
### HTTP request headers
|
|
253
|
+
|
|
254
|
+
- **Content-Type**: application/json
|
|
255
|
+
- **Accept**: application/json
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
## create_attribute
|
|
259
|
+
|
|
260
|
+
> Attribute create_attribute(body)
|
|
261
|
+
|
|
262
|
+
Define a new custom attribute
|
|
263
|
+
|
|
264
|
+
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
265
|
|
|
213
266
|
### Example
|
|
267
|
+
|
|
214
268
|
```ruby
|
|
215
269
|
# load the gem
|
|
216
270
|
require 'talon_one'
|
|
@@ -223,12 +277,61 @@ TalonOne.configure do |config|
|
|
|
223
277
|
end
|
|
224
278
|
|
|
225
279
|
api_instance = TalonOne::ManagementApi.new
|
|
280
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
|
226
281
|
|
|
227
|
-
|
|
282
|
+
begin
|
|
283
|
+
#Define a new custom attribute
|
|
284
|
+
result = api_instance.create_attribute(body)
|
|
285
|
+
p result
|
|
286
|
+
rescue TalonOne::ApiError => e
|
|
287
|
+
puts "Exception when calling ManagementApi->create_attribute: #{e}"
|
|
288
|
+
end
|
|
289
|
+
```
|
|
228
290
|
|
|
229
|
-
|
|
291
|
+
### Parameters
|
|
230
292
|
|
|
231
293
|
|
|
294
|
+
Name | Type | Description | Notes
|
|
295
|
+
------------- | ------------- | ------------- | -------------
|
|
296
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
|
297
|
+
|
|
298
|
+
### Return type
|
|
299
|
+
|
|
300
|
+
[**Attribute**](Attribute.md)
|
|
301
|
+
|
|
302
|
+
### Authorization
|
|
303
|
+
|
|
304
|
+
[manager_auth](../README.md#manager_auth)
|
|
305
|
+
|
|
306
|
+
### HTTP request headers
|
|
307
|
+
|
|
308
|
+
- **Content-Type**: application/json
|
|
309
|
+
- **Accept**: application/json
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
## create_campaign
|
|
313
|
+
|
|
314
|
+
> Campaign create_campaign(application_id, body)
|
|
315
|
+
|
|
316
|
+
Create a Campaign
|
|
317
|
+
|
|
318
|
+
### Example
|
|
319
|
+
|
|
320
|
+
```ruby
|
|
321
|
+
# load the gem
|
|
322
|
+
require 'talon_one'
|
|
323
|
+
# setup authorization
|
|
324
|
+
TalonOne.configure do |config|
|
|
325
|
+
# Configure API key authorization: manager_auth
|
|
326
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
327
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
328
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
329
|
+
end
|
|
330
|
+
|
|
331
|
+
api_instance = TalonOne::ManagementApi.new
|
|
332
|
+
application_id = 56 # Integer |
|
|
333
|
+
body = TalonOne::NewCampaign.new # NewCampaign |
|
|
334
|
+
|
|
232
335
|
begin
|
|
233
336
|
#Create a Campaign
|
|
234
337
|
result = api_instance.create_campaign(application_id, body)
|
|
@@ -240,6 +343,7 @@ end
|
|
|
240
343
|
|
|
241
344
|
### Parameters
|
|
242
345
|
|
|
346
|
+
|
|
243
347
|
Name | Type | Description | Notes
|
|
244
348
|
------------- | ------------- | ------------- | -------------
|
|
245
349
|
**application_id** | **Integer**| |
|
|
@@ -255,19 +359,20 @@ Name | Type | Description | Notes
|
|
|
255
359
|
|
|
256
360
|
### HTTP request headers
|
|
257
361
|
|
|
258
|
-
|
|
259
|
-
|
|
362
|
+
- **Content-Type**: application/json
|
|
363
|
+
- **Accept**: application/json
|
|
260
364
|
|
|
261
365
|
|
|
366
|
+
## create_coupons
|
|
262
367
|
|
|
263
|
-
|
|
264
|
-
> InlineResponse2001 create_coupons(application_id, campaign_id, body, opts)
|
|
368
|
+
> InlineResponse2004 create_coupons(application_id, campaign_id, body, opts)
|
|
265
369
|
|
|
266
370
|
Create Coupons
|
|
267
371
|
|
|
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
|
|
372
|
+
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
373
|
|
|
270
374
|
### Example
|
|
375
|
+
|
|
271
376
|
```ruby
|
|
272
377
|
# load the gem
|
|
273
378
|
require 'talon_one'
|
|
@@ -280,14 +385,10 @@ TalonOne.configure do |config|
|
|
|
280
385
|
end
|
|
281
386
|
|
|
282
387
|
api_instance = TalonOne::ManagementApi.new
|
|
283
|
-
|
|
284
388
|
application_id = 56 # Integer |
|
|
285
|
-
|
|
286
389
|
campaign_id = 56 # Integer |
|
|
287
|
-
|
|
288
390
|
body = TalonOne::NewCoupons.new # NewCoupons |
|
|
289
|
-
|
|
290
|
-
opts = {
|
|
391
|
+
opts = {
|
|
291
392
|
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
393
|
}
|
|
293
394
|
|
|
@@ -302,6 +403,7 @@ end
|
|
|
302
403
|
|
|
303
404
|
### Parameters
|
|
304
405
|
|
|
406
|
+
|
|
305
407
|
Name | Type | Description | Notes
|
|
306
408
|
------------- | ------------- | ------------- | -------------
|
|
307
409
|
**application_id** | **Integer**| |
|
|
@@ -311,7 +413,7 @@ Name | Type | Description | Notes
|
|
|
311
413
|
|
|
312
414
|
### Return type
|
|
313
415
|
|
|
314
|
-
[**
|
|
416
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
315
417
|
|
|
316
418
|
### Authorization
|
|
317
419
|
|
|
@@ -319,12 +421,12 @@ Name | Type | Description | Notes
|
|
|
319
421
|
|
|
320
422
|
### HTTP request headers
|
|
321
423
|
|
|
322
|
-
|
|
323
|
-
|
|
424
|
+
- **Content-Type**: application/json
|
|
425
|
+
- **Accept**: application/json
|
|
324
426
|
|
|
325
427
|
|
|
428
|
+
## create_password_recovery_email
|
|
326
429
|
|
|
327
|
-
# **create_password_recovery_email**
|
|
328
430
|
> NewPasswordEmail create_password_recovery_email(body)
|
|
329
431
|
|
|
330
432
|
Request a password reset
|
|
@@ -332,6 +434,7 @@ Request a password reset
|
|
|
332
434
|
Sends an email with a password recovery link to the email of an existing account.
|
|
333
435
|
|
|
334
436
|
### Example
|
|
437
|
+
|
|
335
438
|
```ruby
|
|
336
439
|
# load the gem
|
|
337
440
|
require 'talon_one'
|
|
@@ -344,10 +447,8 @@ TalonOne.configure do |config|
|
|
|
344
447
|
end
|
|
345
448
|
|
|
346
449
|
api_instance = TalonOne::ManagementApi.new
|
|
347
|
-
|
|
348
450
|
body = TalonOne::NewPasswordEmail.new # NewPasswordEmail |
|
|
349
451
|
|
|
350
|
-
|
|
351
452
|
begin
|
|
352
453
|
#Request a password reset
|
|
353
454
|
result = api_instance.create_password_recovery_email(body)
|
|
@@ -359,6 +460,7 @@ end
|
|
|
359
460
|
|
|
360
461
|
### Parameters
|
|
361
462
|
|
|
463
|
+
|
|
362
464
|
Name | Type | Description | Notes
|
|
363
465
|
------------- | ------------- | ------------- | -------------
|
|
364
466
|
**body** | [**NewPasswordEmail**](NewPasswordEmail.md)| |
|
|
@@ -373,19 +475,18 @@ Name | Type | Description | Notes
|
|
|
373
475
|
|
|
374
476
|
### HTTP request headers
|
|
375
477
|
|
|
376
|
-
|
|
377
|
-
|
|
478
|
+
- **Content-Type**: application/json
|
|
479
|
+
- **Accept**: application/json
|
|
378
480
|
|
|
379
481
|
|
|
482
|
+
## create_ruleset
|
|
380
483
|
|
|
381
|
-
# **create_ruleset**
|
|
382
484
|
> Ruleset create_ruleset(application_id, campaign_id, body)
|
|
383
485
|
|
|
384
486
|
Create a Ruleset
|
|
385
487
|
|
|
386
|
-
|
|
387
|
-
|
|
388
488
|
### Example
|
|
489
|
+
|
|
389
490
|
```ruby
|
|
390
491
|
# load the gem
|
|
391
492
|
require 'talon_one'
|
|
@@ -398,14 +499,10 @@ TalonOne.configure do |config|
|
|
|
398
499
|
end
|
|
399
500
|
|
|
400
501
|
api_instance = TalonOne::ManagementApi.new
|
|
401
|
-
|
|
402
502
|
application_id = 56 # Integer |
|
|
403
|
-
|
|
404
503
|
campaign_id = 56 # Integer |
|
|
405
|
-
|
|
406
504
|
body = TalonOne::NewRuleset.new # NewRuleset |
|
|
407
505
|
|
|
408
|
-
|
|
409
506
|
begin
|
|
410
507
|
#Create a Ruleset
|
|
411
508
|
result = api_instance.create_ruleset(application_id, campaign_id, body)
|
|
@@ -417,6 +514,7 @@ end
|
|
|
417
514
|
|
|
418
515
|
### Parameters
|
|
419
516
|
|
|
517
|
+
|
|
420
518
|
Name | Type | Description | Notes
|
|
421
519
|
------------- | ------------- | ------------- | -------------
|
|
422
520
|
**application_id** | **Integer**| |
|
|
@@ -433,19 +531,18 @@ Name | Type | Description | Notes
|
|
|
433
531
|
|
|
434
532
|
### HTTP request headers
|
|
435
533
|
|
|
436
|
-
|
|
437
|
-
|
|
534
|
+
- **Content-Type**: application/json
|
|
535
|
+
- **Accept**: application/json
|
|
438
536
|
|
|
439
537
|
|
|
538
|
+
## create_session
|
|
440
539
|
|
|
441
|
-
# **create_session**
|
|
442
540
|
> Session create_session(body)
|
|
443
541
|
|
|
444
542
|
Create a Session
|
|
445
543
|
|
|
446
|
-
|
|
447
|
-
|
|
448
544
|
### Example
|
|
545
|
+
|
|
449
546
|
```ruby
|
|
450
547
|
# load the gem
|
|
451
548
|
require 'talon_one'
|
|
@@ -458,10 +555,8 @@ TalonOne.configure do |config|
|
|
|
458
555
|
end
|
|
459
556
|
|
|
460
557
|
api_instance = TalonOne::ManagementApi.new
|
|
461
|
-
|
|
462
558
|
body = TalonOne::LoginParams.new # LoginParams |
|
|
463
559
|
|
|
464
|
-
|
|
465
560
|
begin
|
|
466
561
|
#Create a Session
|
|
467
562
|
result = api_instance.create_session(body)
|
|
@@ -473,6 +568,7 @@ end
|
|
|
473
568
|
|
|
474
569
|
### Parameters
|
|
475
570
|
|
|
571
|
+
|
|
476
572
|
Name | Type | Description | Notes
|
|
477
573
|
------------- | ------------- | ------------- | -------------
|
|
478
574
|
**body** | [**LoginParams**](LoginParams.md)| |
|
|
@@ -487,19 +583,18 @@ Name | Type | Description | Notes
|
|
|
487
583
|
|
|
488
584
|
### HTTP request headers
|
|
489
585
|
|
|
490
|
-
|
|
491
|
-
|
|
586
|
+
- **Content-Type**: application/json
|
|
587
|
+
- **Accept**: application/json
|
|
492
588
|
|
|
493
589
|
|
|
590
|
+
## delete_campaign
|
|
494
591
|
|
|
495
|
-
# **delete_campaign**
|
|
496
592
|
> delete_campaign(application_id, campaign_id)
|
|
497
593
|
|
|
498
594
|
Delete a Campaign
|
|
499
595
|
|
|
500
|
-
|
|
501
|
-
|
|
502
596
|
### Example
|
|
597
|
+
|
|
503
598
|
```ruby
|
|
504
599
|
# load the gem
|
|
505
600
|
require 'talon_one'
|
|
@@ -512,12 +607,9 @@ TalonOne.configure do |config|
|
|
|
512
607
|
end
|
|
513
608
|
|
|
514
609
|
api_instance = TalonOne::ManagementApi.new
|
|
515
|
-
|
|
516
610
|
application_id = 56 # Integer |
|
|
517
|
-
|
|
518
611
|
campaign_id = 56 # Integer |
|
|
519
612
|
|
|
520
|
-
|
|
521
613
|
begin
|
|
522
614
|
#Delete a Campaign
|
|
523
615
|
api_instance.delete_campaign(application_id, campaign_id)
|
|
@@ -528,6 +620,7 @@ end
|
|
|
528
620
|
|
|
529
621
|
### Parameters
|
|
530
622
|
|
|
623
|
+
|
|
531
624
|
Name | Type | Description | Notes
|
|
532
625
|
------------- | ------------- | ------------- | -------------
|
|
533
626
|
**application_id** | **Integer**| |
|
|
@@ -543,19 +636,18 @@ nil (empty response body)
|
|
|
543
636
|
|
|
544
637
|
### HTTP request headers
|
|
545
638
|
|
|
546
|
-
|
|
547
|
-
|
|
639
|
+
- **Content-Type**: Not defined
|
|
640
|
+
- **Accept**: Not defined
|
|
548
641
|
|
|
549
642
|
|
|
643
|
+
## delete_coupon
|
|
550
644
|
|
|
551
|
-
# **delete_coupon**
|
|
552
645
|
> delete_coupon(application_id, campaign_id, coupon_id)
|
|
553
646
|
|
|
554
647
|
Delete one Coupon
|
|
555
648
|
|
|
556
|
-
|
|
557
|
-
|
|
558
649
|
### Example
|
|
650
|
+
|
|
559
651
|
```ruby
|
|
560
652
|
# load the gem
|
|
561
653
|
require 'talon_one'
|
|
@@ -568,14 +660,10 @@ TalonOne.configure do |config|
|
|
|
568
660
|
end
|
|
569
661
|
|
|
570
662
|
api_instance = TalonOne::ManagementApi.new
|
|
571
|
-
|
|
572
663
|
application_id = 56 # Integer |
|
|
573
|
-
|
|
574
664
|
campaign_id = 56 # Integer |
|
|
575
|
-
|
|
576
665
|
coupon_id = 'coupon_id_example' # String | The ID of the coupon code to delete
|
|
577
666
|
|
|
578
|
-
|
|
579
667
|
begin
|
|
580
668
|
#Delete one Coupon
|
|
581
669
|
api_instance.delete_coupon(application_id, campaign_id, coupon_id)
|
|
@@ -586,6 +674,7 @@ end
|
|
|
586
674
|
|
|
587
675
|
### Parameters
|
|
588
676
|
|
|
677
|
+
|
|
589
678
|
Name | Type | Description | Notes
|
|
590
679
|
------------- | ------------- | ------------- | -------------
|
|
591
680
|
**application_id** | **Integer**| |
|
|
@@ -602,19 +691,18 @@ nil (empty response body)
|
|
|
602
691
|
|
|
603
692
|
### HTTP request headers
|
|
604
693
|
|
|
605
|
-
|
|
606
|
-
|
|
694
|
+
- **Content-Type**: Not defined
|
|
695
|
+
- **Accept**: Not defined
|
|
607
696
|
|
|
608
697
|
|
|
698
|
+
## delete_coupons
|
|
609
699
|
|
|
610
|
-
# **delete_coupons**
|
|
611
700
|
> delete_coupons(application_id, campaign_id, opts)
|
|
612
701
|
|
|
613
702
|
Delete Coupons
|
|
614
703
|
|
|
615
|
-
|
|
616
|
-
|
|
617
704
|
### Example
|
|
705
|
+
|
|
618
706
|
```ruby
|
|
619
707
|
# load the gem
|
|
620
708
|
require 'talon_one'
|
|
@@ -627,12 +715,9 @@ TalonOne.configure do |config|
|
|
|
627
715
|
end
|
|
628
716
|
|
|
629
717
|
api_instance = TalonOne::ManagementApi.new
|
|
630
|
-
|
|
631
718
|
application_id = 56 # Integer |
|
|
632
|
-
|
|
633
719
|
campaign_id = 56 # Integer |
|
|
634
|
-
|
|
635
|
-
opts = {
|
|
720
|
+
opts = {
|
|
636
721
|
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
722
|
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
723
|
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 +730,7 @@ opts = {
|
|
|
645
730
|
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
731
|
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
732
|
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 #
|
|
733
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
649
734
|
}
|
|
650
735
|
|
|
651
736
|
begin
|
|
@@ -658,6 +743,7 @@ end
|
|
|
658
743
|
|
|
659
744
|
### Parameters
|
|
660
745
|
|
|
746
|
+
|
|
661
747
|
Name | Type | Description | Notes
|
|
662
748
|
------------- | ------------- | ------------- | -------------
|
|
663
749
|
**application_id** | **Integer**| |
|
|
@@ -674,7 +760,7 @@ Name | Type | Description | Notes
|
|
|
674
760
|
**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
761
|
**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
762
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
677
|
-
**exact_match** | **
|
|
763
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
678
764
|
|
|
679
765
|
### Return type
|
|
680
766
|
|
|
@@ -686,19 +772,18 @@ nil (empty response body)
|
|
|
686
772
|
|
|
687
773
|
### HTTP request headers
|
|
688
774
|
|
|
689
|
-
|
|
690
|
-
|
|
775
|
+
- **Content-Type**: Not defined
|
|
776
|
+
- **Accept**: Not defined
|
|
691
777
|
|
|
692
778
|
|
|
779
|
+
## delete_referral
|
|
693
780
|
|
|
694
|
-
# **delete_referral**
|
|
695
781
|
> delete_referral(application_id, campaign_id, referral_id)
|
|
696
782
|
|
|
697
783
|
Delete one Referral
|
|
698
784
|
|
|
699
|
-
|
|
700
|
-
|
|
701
785
|
### Example
|
|
786
|
+
|
|
702
787
|
```ruby
|
|
703
788
|
# load the gem
|
|
704
789
|
require 'talon_one'
|
|
@@ -711,14 +796,10 @@ TalonOne.configure do |config|
|
|
|
711
796
|
end
|
|
712
797
|
|
|
713
798
|
api_instance = TalonOne::ManagementApi.new
|
|
714
|
-
|
|
715
799
|
application_id = 56 # Integer |
|
|
716
|
-
|
|
717
800
|
campaign_id = 56 # Integer |
|
|
718
|
-
|
|
719
801
|
referral_id = 'referral_id_example' # String | The ID of the referral code to delete
|
|
720
802
|
|
|
721
|
-
|
|
722
803
|
begin
|
|
723
804
|
#Delete one Referral
|
|
724
805
|
api_instance.delete_referral(application_id, campaign_id, referral_id)
|
|
@@ -729,6 +810,7 @@ end
|
|
|
729
810
|
|
|
730
811
|
### Parameters
|
|
731
812
|
|
|
813
|
+
|
|
732
814
|
Name | Type | Description | Notes
|
|
733
815
|
------------- | ------------- | ------------- | -------------
|
|
734
816
|
**application_id** | **Integer**| |
|
|
@@ -745,19 +827,18 @@ nil (empty response body)
|
|
|
745
827
|
|
|
746
828
|
### HTTP request headers
|
|
747
829
|
|
|
748
|
-
|
|
749
|
-
|
|
830
|
+
- **Content-Type**: Not defined
|
|
831
|
+
- **Accept**: Not defined
|
|
750
832
|
|
|
751
833
|
|
|
834
|
+
## delete_ruleset
|
|
752
835
|
|
|
753
|
-
# **delete_ruleset**
|
|
754
836
|
> delete_ruleset(application_id, campaign_id, ruleset_id)
|
|
755
837
|
|
|
756
838
|
Delete a Ruleset
|
|
757
839
|
|
|
758
|
-
|
|
759
|
-
|
|
760
840
|
### Example
|
|
841
|
+
|
|
761
842
|
```ruby
|
|
762
843
|
# load the gem
|
|
763
844
|
require 'talon_one'
|
|
@@ -770,14 +851,10 @@ TalonOne.configure do |config|
|
|
|
770
851
|
end
|
|
771
852
|
|
|
772
853
|
api_instance = TalonOne::ManagementApi.new
|
|
773
|
-
|
|
774
854
|
application_id = 56 # Integer |
|
|
775
|
-
|
|
776
855
|
campaign_id = 56 # Integer |
|
|
777
|
-
|
|
778
856
|
ruleset_id = 56 # Integer |
|
|
779
857
|
|
|
780
|
-
|
|
781
858
|
begin
|
|
782
859
|
#Delete a Ruleset
|
|
783
860
|
api_instance.delete_ruleset(application_id, campaign_id, ruleset_id)
|
|
@@ -788,6 +865,7 @@ end
|
|
|
788
865
|
|
|
789
866
|
### Parameters
|
|
790
867
|
|
|
868
|
+
|
|
791
869
|
Name | Type | Description | Notes
|
|
792
870
|
------------- | ------------- | ------------- | -------------
|
|
793
871
|
**application_id** | **Integer**| |
|
|
@@ -804,19 +882,18 @@ nil (empty response body)
|
|
|
804
882
|
|
|
805
883
|
### HTTP request headers
|
|
806
884
|
|
|
807
|
-
|
|
808
|
-
|
|
885
|
+
- **Content-Type**: Not defined
|
|
886
|
+
- **Accept**: Not defined
|
|
809
887
|
|
|
810
888
|
|
|
889
|
+
## get_access_logs
|
|
811
890
|
|
|
812
|
-
# **get_access_logs**
|
|
813
891
|
> InlineResponse2009 get_access_logs(application_id, range_start, range_end, opts)
|
|
814
892
|
|
|
815
|
-
Get access logs for application
|
|
816
|
-
|
|
817
|
-
|
|
893
|
+
Get access logs for application (with total count)
|
|
818
894
|
|
|
819
895
|
### Example
|
|
896
|
+
|
|
820
897
|
```ruby
|
|
821
898
|
# load the gem
|
|
822
899
|
require 'talon_one'
|
|
@@ -829,16 +906,12 @@ TalonOne.configure do |config|
|
|
|
829
906
|
end
|
|
830
907
|
|
|
831
908
|
api_instance = TalonOne::ManagementApi.new
|
|
832
|
-
|
|
833
909
|
application_id = 56 # Integer |
|
|
834
|
-
|
|
835
910
|
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
911
|
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.
|
|
912
|
+
opts = {
|
|
913
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
914
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
842
915
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
843
916
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
844
917
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -846,7 +919,7 @@ opts = {
|
|
|
846
919
|
}
|
|
847
920
|
|
|
848
921
|
begin
|
|
849
|
-
#Get access logs for application
|
|
922
|
+
#Get access logs for application (with total count)
|
|
850
923
|
result = api_instance.get_access_logs(application_id, range_start, range_end, opts)
|
|
851
924
|
p result
|
|
852
925
|
rescue TalonOne::ApiError => e
|
|
@@ -856,13 +929,14 @@ end
|
|
|
856
929
|
|
|
857
930
|
### Parameters
|
|
858
931
|
|
|
932
|
+
|
|
859
933
|
Name | Type | Description | Notes
|
|
860
934
|
------------- | ------------- | ------------- | -------------
|
|
861
935
|
**application_id** | **Integer**| |
|
|
862
936
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
863
937
|
**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
|
|
938
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
939
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
866
940
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
867
941
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
868
942
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -878,19 +952,18 @@ Name | Type | Description | Notes
|
|
|
878
952
|
|
|
879
953
|
### HTTP request headers
|
|
880
954
|
|
|
881
|
-
|
|
882
|
-
|
|
955
|
+
- **Content-Type**: Not defined
|
|
956
|
+
- **Accept**: application/json
|
|
883
957
|
|
|
884
958
|
|
|
959
|
+
## get_access_logs_without_total_count
|
|
885
960
|
|
|
886
|
-
# **get_access_logs_without_total_count**
|
|
887
961
|
> InlineResponse20010 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
|
|
888
962
|
|
|
889
963
|
Get access logs for application
|
|
890
964
|
|
|
891
|
-
|
|
892
|
-
|
|
893
965
|
### Example
|
|
966
|
+
|
|
894
967
|
```ruby
|
|
895
968
|
# load the gem
|
|
896
969
|
require 'talon_one'
|
|
@@ -903,16 +976,12 @@ TalonOne.configure do |config|
|
|
|
903
976
|
end
|
|
904
977
|
|
|
905
978
|
api_instance = TalonOne::ManagementApi.new
|
|
906
|
-
|
|
907
979
|
application_id = 56 # Integer |
|
|
908
|
-
|
|
909
980
|
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
981
|
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.
|
|
982
|
+
opts = {
|
|
983
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
984
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
916
985
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
917
986
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
918
987
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -930,13 +999,14 @@ end
|
|
|
930
999
|
|
|
931
1000
|
### Parameters
|
|
932
1001
|
|
|
1002
|
+
|
|
933
1003
|
Name | Type | Description | Notes
|
|
934
1004
|
------------- | ------------- | ------------- | -------------
|
|
935
1005
|
**application_id** | **Integer**| |
|
|
936
1006
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
937
1007
|
**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
|
|
1008
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
1009
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
940
1010
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
941
1011
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
942
1012
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -952,12 +1022,12 @@ Name | Type | Description | Notes
|
|
|
952
1022
|
|
|
953
1023
|
### HTTP request headers
|
|
954
1024
|
|
|
955
|
-
|
|
956
|
-
|
|
1025
|
+
- **Content-Type**: Not defined
|
|
1026
|
+
- **Accept**: application/json
|
|
957
1027
|
|
|
958
1028
|
|
|
1029
|
+
## get_account
|
|
959
1030
|
|
|
960
|
-
# **get_account**
|
|
961
1031
|
> Account get_account(account_id)
|
|
962
1032
|
|
|
963
1033
|
Get Account Details
|
|
@@ -965,6 +1035,7 @@ Get Account Details
|
|
|
965
1035
|
Return the details of your companies Talon.One account.
|
|
966
1036
|
|
|
967
1037
|
### Example
|
|
1038
|
+
|
|
968
1039
|
```ruby
|
|
969
1040
|
# load the gem
|
|
970
1041
|
require 'talon_one'
|
|
@@ -977,10 +1048,8 @@ TalonOne.configure do |config|
|
|
|
977
1048
|
end
|
|
978
1049
|
|
|
979
1050
|
api_instance = TalonOne::ManagementApi.new
|
|
980
|
-
|
|
981
1051
|
account_id = 56 # Integer |
|
|
982
1052
|
|
|
983
|
-
|
|
984
1053
|
begin
|
|
985
1054
|
#Get Account Details
|
|
986
1055
|
result = api_instance.get_account(account_id)
|
|
@@ -992,6 +1061,7 @@ end
|
|
|
992
1061
|
|
|
993
1062
|
### Parameters
|
|
994
1063
|
|
|
1064
|
+
|
|
995
1065
|
Name | Type | Description | Notes
|
|
996
1066
|
------------- | ------------- | ------------- | -------------
|
|
997
1067
|
**account_id** | **Integer**| |
|
|
@@ -1006,12 +1076,12 @@ Name | Type | Description | Notes
|
|
|
1006
1076
|
|
|
1007
1077
|
### HTTP request headers
|
|
1008
1078
|
|
|
1009
|
-
|
|
1010
|
-
|
|
1079
|
+
- **Content-Type**: Not defined
|
|
1080
|
+
- **Accept**: application/json
|
|
1011
1081
|
|
|
1012
1082
|
|
|
1083
|
+
## get_account_analytics
|
|
1013
1084
|
|
|
1014
|
-
# **get_account_analytics**
|
|
1015
1085
|
> AccountAnalytics get_account_analytics(account_id)
|
|
1016
1086
|
|
|
1017
1087
|
Get Account Analytics
|
|
@@ -1019,6 +1089,7 @@ Get Account Analytics
|
|
|
1019
1089
|
Return the analytics of your companies Talon.One account.
|
|
1020
1090
|
|
|
1021
1091
|
### Example
|
|
1092
|
+
|
|
1022
1093
|
```ruby
|
|
1023
1094
|
# load the gem
|
|
1024
1095
|
require 'talon_one'
|
|
@@ -1031,10 +1102,8 @@ TalonOne.configure do |config|
|
|
|
1031
1102
|
end
|
|
1032
1103
|
|
|
1033
1104
|
api_instance = TalonOne::ManagementApi.new
|
|
1034
|
-
|
|
1035
1105
|
account_id = 56 # Integer |
|
|
1036
1106
|
|
|
1037
|
-
|
|
1038
1107
|
begin
|
|
1039
1108
|
#Get Account Analytics
|
|
1040
1109
|
result = api_instance.get_account_analytics(account_id)
|
|
@@ -1046,6 +1115,7 @@ end
|
|
|
1046
1115
|
|
|
1047
1116
|
### Parameters
|
|
1048
1117
|
|
|
1118
|
+
|
|
1049
1119
|
Name | Type | Description | Notes
|
|
1050
1120
|
------------- | ------------- | ------------- | -------------
|
|
1051
1121
|
**account_id** | **Integer**| |
|
|
@@ -1060,19 +1130,20 @@ Name | Type | Description | Notes
|
|
|
1060
1130
|
|
|
1061
1131
|
### HTTP request headers
|
|
1062
1132
|
|
|
1063
|
-
|
|
1064
|
-
|
|
1133
|
+
- **Content-Type**: Not defined
|
|
1134
|
+
- **Accept**: application/json
|
|
1065
1135
|
|
|
1066
1136
|
|
|
1137
|
+
## get_additional_cost
|
|
1067
1138
|
|
|
1068
|
-
|
|
1069
|
-
> AccountLimits get_account_limits(account_id)
|
|
1139
|
+
> AccountAdditionalCost get_additional_cost(additional_cost_id)
|
|
1070
1140
|
|
|
1071
|
-
Get
|
|
1141
|
+
Get an additional cost
|
|
1072
1142
|
|
|
1073
|
-
Returns
|
|
1143
|
+
Returns additional cost for the account by its id.
|
|
1074
1144
|
|
|
1075
1145
|
### Example
|
|
1146
|
+
|
|
1076
1147
|
```ruby
|
|
1077
1148
|
# load the gem
|
|
1078
1149
|
require 'talon_one'
|
|
@@ -1085,28 +1156,87 @@ TalonOne.configure do |config|
|
|
|
1085
1156
|
end
|
|
1086
1157
|
|
|
1087
1158
|
api_instance = TalonOne::ManagementApi.new
|
|
1159
|
+
additional_cost_id = 56 # Integer |
|
|
1088
1160
|
|
|
1089
|
-
|
|
1161
|
+
begin
|
|
1162
|
+
#Get an additional cost
|
|
1163
|
+
result = api_instance.get_additional_cost(additional_cost_id)
|
|
1164
|
+
p result
|
|
1165
|
+
rescue TalonOne::ApiError => e
|
|
1166
|
+
puts "Exception when calling ManagementApi->get_additional_cost: #{e}"
|
|
1167
|
+
end
|
|
1168
|
+
```
|
|
1169
|
+
|
|
1170
|
+
### Parameters
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
Name | Type | Description | Notes
|
|
1174
|
+
------------- | ------------- | ------------- | -------------
|
|
1175
|
+
**additional_cost_id** | **Integer**| |
|
|
1176
|
+
|
|
1177
|
+
### Return type
|
|
1178
|
+
|
|
1179
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
1180
|
+
|
|
1181
|
+
### Authorization
|
|
1182
|
+
|
|
1183
|
+
[manager_auth](../README.md#manager_auth)
|
|
1184
|
+
|
|
1185
|
+
### HTTP request headers
|
|
1186
|
+
|
|
1187
|
+
- **Content-Type**: Not defined
|
|
1188
|
+
- **Accept**: application/json
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
## get_additional_costs
|
|
1192
|
+
|
|
1193
|
+
> InlineResponse20021 get_additional_costs(opts)
|
|
1194
|
+
|
|
1195
|
+
List additional costs
|
|
1196
|
+
|
|
1197
|
+
Returns all the defined additional costs for the account.
|
|
1198
|
+
|
|
1199
|
+
### Example
|
|
1200
|
+
|
|
1201
|
+
```ruby
|
|
1202
|
+
# load the gem
|
|
1203
|
+
require 'talon_one'
|
|
1204
|
+
# setup authorization
|
|
1205
|
+
TalonOne.configure do |config|
|
|
1206
|
+
# Configure API key authorization: manager_auth
|
|
1207
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1208
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1209
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1210
|
+
end
|
|
1090
1211
|
|
|
1212
|
+
api_instance = TalonOne::ManagementApi.new
|
|
1213
|
+
opts = {
|
|
1214
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1215
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1216
|
+
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.
|
|
1217
|
+
}
|
|
1091
1218
|
|
|
1092
1219
|
begin
|
|
1093
|
-
#
|
|
1094
|
-
result = api_instance.
|
|
1220
|
+
#List additional costs
|
|
1221
|
+
result = api_instance.get_additional_costs(opts)
|
|
1095
1222
|
p result
|
|
1096
1223
|
rescue TalonOne::ApiError => e
|
|
1097
|
-
puts "Exception when calling ManagementApi->
|
|
1224
|
+
puts "Exception when calling ManagementApi->get_additional_costs: #{e}"
|
|
1098
1225
|
end
|
|
1099
1226
|
```
|
|
1100
1227
|
|
|
1101
1228
|
### Parameters
|
|
1102
1229
|
|
|
1230
|
+
|
|
1103
1231
|
Name | Type | Description | Notes
|
|
1104
1232
|
------------- | ------------- | ------------- | -------------
|
|
1105
|
-
**
|
|
1233
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
1234
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
1235
|
+
**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
1236
|
|
|
1107
1237
|
### Return type
|
|
1108
1238
|
|
|
1109
|
-
[**
|
|
1239
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
|
1110
1240
|
|
|
1111
1241
|
### Authorization
|
|
1112
1242
|
|
|
@@ -1114,12 +1244,12 @@ Name | Type | Description | Notes
|
|
|
1114
1244
|
|
|
1115
1245
|
### HTTP request headers
|
|
1116
1246
|
|
|
1117
|
-
|
|
1118
|
-
|
|
1247
|
+
- **Content-Type**: Not defined
|
|
1248
|
+
- **Accept**: application/json
|
|
1119
1249
|
|
|
1120
1250
|
|
|
1251
|
+
## get_all_access_logs
|
|
1121
1252
|
|
|
1122
|
-
# **get_all_access_logs**
|
|
1123
1253
|
> InlineResponse2009 get_all_access_logs(range_start, range_end, opts)
|
|
1124
1254
|
|
|
1125
1255
|
Get all access logs
|
|
@@ -1127,6 +1257,7 @@ Get all access logs
|
|
|
1127
1257
|
Fetches the access logs for the entire account. Sensitive requests (logins) are _always_ filtered from the logs.
|
|
1128
1258
|
|
|
1129
1259
|
### Example
|
|
1260
|
+
|
|
1130
1261
|
```ruby
|
|
1131
1262
|
# load the gem
|
|
1132
1263
|
require 'talon_one'
|
|
@@ -1139,14 +1270,11 @@ TalonOne.configure do |config|
|
|
|
1139
1270
|
end
|
|
1140
1271
|
|
|
1141
1272
|
api_instance = TalonOne::ManagementApi.new
|
|
1142
|
-
|
|
1143
1273
|
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
1274
|
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.
|
|
1275
|
+
opts = {
|
|
1276
|
+
path: 'path_example', # String | Only return results where the request path matches the given regular expression.
|
|
1277
|
+
method: 'method_example', # String | Only return results where the request method matches the given regular expression.
|
|
1150
1278
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
1151
1279
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1152
1280
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
@@ -1164,12 +1292,13 @@ end
|
|
|
1164
1292
|
|
|
1165
1293
|
### Parameters
|
|
1166
1294
|
|
|
1295
|
+
|
|
1167
1296
|
Name | Type | Description | Notes
|
|
1168
1297
|
------------- | ------------- | ------------- | -------------
|
|
1169
1298
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
1170
1299
|
**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
|
|
1300
|
+
**path** | **String**| Only return results where the request path matches the given regular expression. | [optional]
|
|
1301
|
+
**method** | **String**| Only return results where the request method matches the given regular expression. | [optional]
|
|
1173
1302
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
1174
1303
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
1175
1304
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
@@ -1185,17 +1314,18 @@ Name | Type | Description | Notes
|
|
|
1185
1314
|
|
|
1186
1315
|
### HTTP request headers
|
|
1187
1316
|
|
|
1188
|
-
|
|
1189
|
-
|
|
1317
|
+
- **Content-Type**: Not defined
|
|
1318
|
+
- **Accept**: application/json
|
|
1190
1319
|
|
|
1191
1320
|
|
|
1321
|
+
## get_all_roles
|
|
1192
1322
|
|
|
1193
|
-
|
|
1194
|
-
> InlineResponse20028 get_all_roles
|
|
1323
|
+
> InlineResponse20030 get_all_roles
|
|
1195
1324
|
|
|
1196
1325
|
Get all roles.
|
|
1197
1326
|
|
|
1198
1327
|
### Example
|
|
1328
|
+
|
|
1199
1329
|
```ruby
|
|
1200
1330
|
# load the gem
|
|
1201
1331
|
require 'talon_one'
|
|
@@ -1219,11 +1349,12 @@ end
|
|
|
1219
1349
|
```
|
|
1220
1350
|
|
|
1221
1351
|
### Parameters
|
|
1352
|
+
|
|
1222
1353
|
This endpoint does not need any parameter.
|
|
1223
1354
|
|
|
1224
1355
|
### Return type
|
|
1225
1356
|
|
|
1226
|
-
[**
|
|
1357
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
|
1227
1358
|
|
|
1228
1359
|
### Authorization
|
|
1229
1360
|
|
|
@@ -1231,12 +1362,12 @@ This endpoint does not need any parameter.
|
|
|
1231
1362
|
|
|
1232
1363
|
### HTTP request headers
|
|
1233
1364
|
|
|
1234
|
-
|
|
1235
|
-
|
|
1365
|
+
- **Content-Type**: Not defined
|
|
1366
|
+
- **Accept**: application/json
|
|
1236
1367
|
|
|
1237
1368
|
|
|
1369
|
+
## get_application
|
|
1238
1370
|
|
|
1239
|
-
# **get_application**
|
|
1240
1371
|
> Application get_application(application_id)
|
|
1241
1372
|
|
|
1242
1373
|
Get Application
|
|
@@ -1244,6 +1375,7 @@ Get Application
|
|
|
1244
1375
|
Get the application specified by the ID.
|
|
1245
1376
|
|
|
1246
1377
|
### Example
|
|
1378
|
+
|
|
1247
1379
|
```ruby
|
|
1248
1380
|
# load the gem
|
|
1249
1381
|
require 'talon_one'
|
|
@@ -1256,10 +1388,8 @@ TalonOne.configure do |config|
|
|
|
1256
1388
|
end
|
|
1257
1389
|
|
|
1258
1390
|
api_instance = TalonOne::ManagementApi.new
|
|
1259
|
-
|
|
1260
1391
|
application_id = 56 # Integer |
|
|
1261
1392
|
|
|
1262
|
-
|
|
1263
1393
|
begin
|
|
1264
1394
|
#Get Application
|
|
1265
1395
|
result = api_instance.get_application(application_id)
|
|
@@ -1271,6 +1401,7 @@ end
|
|
|
1271
1401
|
|
|
1272
1402
|
### Parameters
|
|
1273
1403
|
|
|
1404
|
+
|
|
1274
1405
|
Name | Type | Description | Notes
|
|
1275
1406
|
------------- | ------------- | ------------- | -------------
|
|
1276
1407
|
**application_id** | **Integer**| |
|
|
@@ -1285,19 +1416,18 @@ Name | Type | Description | Notes
|
|
|
1285
1416
|
|
|
1286
1417
|
### HTTP request headers
|
|
1287
1418
|
|
|
1288
|
-
|
|
1289
|
-
|
|
1419
|
+
- **Content-Type**: Not defined
|
|
1420
|
+
- **Accept**: application/json
|
|
1290
1421
|
|
|
1291
1422
|
|
|
1423
|
+
## get_application_api_health
|
|
1292
1424
|
|
|
1293
|
-
# **get_application_api_health**
|
|
1294
1425
|
> ApplicationApiHealth get_application_api_health(application_id)
|
|
1295
1426
|
|
|
1296
1427
|
Get report of health of application API
|
|
1297
1428
|
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
1429
|
### Example
|
|
1430
|
+
|
|
1301
1431
|
```ruby
|
|
1302
1432
|
# load the gem
|
|
1303
1433
|
require 'talon_one'
|
|
@@ -1310,10 +1440,8 @@ TalonOne.configure do |config|
|
|
|
1310
1440
|
end
|
|
1311
1441
|
|
|
1312
1442
|
api_instance = TalonOne::ManagementApi.new
|
|
1313
|
-
|
|
1314
1443
|
application_id = 56 # Integer |
|
|
1315
1444
|
|
|
1316
|
-
|
|
1317
1445
|
begin
|
|
1318
1446
|
#Get report of health of application API
|
|
1319
1447
|
result = api_instance.get_application_api_health(application_id)
|
|
@@ -1325,6 +1453,7 @@ end
|
|
|
1325
1453
|
|
|
1326
1454
|
### Parameters
|
|
1327
1455
|
|
|
1456
|
+
|
|
1328
1457
|
Name | Type | Description | Notes
|
|
1329
1458
|
------------- | ------------- | ------------- | -------------
|
|
1330
1459
|
**application_id** | **Integer**| |
|
|
@@ -1339,19 +1468,18 @@ Name | Type | Description | Notes
|
|
|
1339
1468
|
|
|
1340
1469
|
### HTTP request headers
|
|
1341
1470
|
|
|
1342
|
-
|
|
1343
|
-
|
|
1471
|
+
- **Content-Type**: Not defined
|
|
1472
|
+
- **Accept**: application/json
|
|
1344
1473
|
|
|
1345
1474
|
|
|
1475
|
+
## get_application_customer
|
|
1346
1476
|
|
|
1347
|
-
# **get_application_customer**
|
|
1348
1477
|
> ApplicationCustomer get_application_customer(application_id, customer_id)
|
|
1349
1478
|
|
|
1350
1479
|
Get Application Customer
|
|
1351
1480
|
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
1481
|
### Example
|
|
1482
|
+
|
|
1355
1483
|
```ruby
|
|
1356
1484
|
# load the gem
|
|
1357
1485
|
require 'talon_one'
|
|
@@ -1364,12 +1492,9 @@ TalonOne.configure do |config|
|
|
|
1364
1492
|
end
|
|
1365
1493
|
|
|
1366
1494
|
api_instance = TalonOne::ManagementApi.new
|
|
1367
|
-
|
|
1368
1495
|
application_id = 56 # Integer |
|
|
1369
|
-
|
|
1370
1496
|
customer_id = 56 # Integer |
|
|
1371
1497
|
|
|
1372
|
-
|
|
1373
1498
|
begin
|
|
1374
1499
|
#Get Application Customer
|
|
1375
1500
|
result = api_instance.get_application_customer(application_id, customer_id)
|
|
@@ -1381,6 +1506,7 @@ end
|
|
|
1381
1506
|
|
|
1382
1507
|
### Parameters
|
|
1383
1508
|
|
|
1509
|
+
|
|
1384
1510
|
Name | Type | Description | Notes
|
|
1385
1511
|
------------- | ------------- | ------------- | -------------
|
|
1386
1512
|
**application_id** | **Integer**| |
|
|
@@ -1396,19 +1522,18 @@ Name | Type | Description | Notes
|
|
|
1396
1522
|
|
|
1397
1523
|
### HTTP request headers
|
|
1398
1524
|
|
|
1399
|
-
|
|
1400
|
-
|
|
1525
|
+
- **Content-Type**: Not defined
|
|
1526
|
+
- **Accept**: application/json
|
|
1401
1527
|
|
|
1402
1528
|
|
|
1529
|
+
## get_application_customers
|
|
1403
1530
|
|
|
1404
|
-
|
|
1405
|
-
> InlineResponse20012 get_application_customers(application_id)
|
|
1531
|
+
> InlineResponse20012 get_application_customers(application_id, opts)
|
|
1406
1532
|
|
|
1407
1533
|
List Application Customers
|
|
1408
1534
|
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
1535
|
### Example
|
|
1536
|
+
|
|
1412
1537
|
```ruby
|
|
1413
1538
|
# load the gem
|
|
1414
1539
|
require 'talon_one'
|
|
@@ -1421,13 +1546,17 @@ TalonOne.configure do |config|
|
|
|
1421
1546
|
end
|
|
1422
1547
|
|
|
1423
1548
|
api_instance = TalonOne::ManagementApi.new
|
|
1424
|
-
|
|
1425
1549
|
application_id = 56 # Integer |
|
|
1426
|
-
|
|
1550
|
+
opts = {
|
|
1551
|
+
integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
|
|
1552
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1553
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1554
|
+
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.
|
|
1555
|
+
}
|
|
1427
1556
|
|
|
1428
1557
|
begin
|
|
1429
1558
|
#List Application Customers
|
|
1430
|
-
result = api_instance.get_application_customers(application_id)
|
|
1559
|
+
result = api_instance.get_application_customers(application_id, opts)
|
|
1431
1560
|
p result
|
|
1432
1561
|
rescue TalonOne::ApiError => e
|
|
1433
1562
|
puts "Exception when calling ManagementApi->get_application_customers: #{e}"
|
|
@@ -1436,9 +1565,14 @@ end
|
|
|
1436
1565
|
|
|
1437
1566
|
### Parameters
|
|
1438
1567
|
|
|
1568
|
+
|
|
1439
1569
|
Name | Type | Description | Notes
|
|
1440
1570
|
------------- | ------------- | ------------- | -------------
|
|
1441
1571
|
**application_id** | **Integer**| |
|
|
1572
|
+
**integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
|
|
1573
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
1574
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
1575
|
+
**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]
|
|
1442
1576
|
|
|
1443
1577
|
### Return type
|
|
1444
1578
|
|
|
@@ -1450,19 +1584,20 @@ Name | Type | Description | Notes
|
|
|
1450
1584
|
|
|
1451
1585
|
### HTTP request headers
|
|
1452
1586
|
|
|
1453
|
-
|
|
1454
|
-
|
|
1587
|
+
- **Content-Type**: Not defined
|
|
1588
|
+
- **Accept**: application/json
|
|
1455
1589
|
|
|
1456
1590
|
|
|
1591
|
+
## get_application_customers_by_attributes
|
|
1457
1592
|
|
|
1458
|
-
# **get_application_customers_by_attributes**
|
|
1459
1593
|
> InlineResponse20013 get_application_customers_by_attributes(body)
|
|
1460
1594
|
|
|
1461
|
-
Get a list of the customer profiles that match the given attributes
|
|
1595
|
+
Get a list of the customer profiles that match the given attributes (with total count)
|
|
1462
1596
|
|
|
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]:
|
|
1597
|
+
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
1598
|
|
|
1465
1599
|
### Example
|
|
1600
|
+
|
|
1466
1601
|
```ruby
|
|
1467
1602
|
# load the gem
|
|
1468
1603
|
require 'talon_one'
|
|
@@ -1475,12 +1610,10 @@ TalonOne.configure do |config|
|
|
|
1475
1610
|
end
|
|
1476
1611
|
|
|
1477
1612
|
api_instance = TalonOne::ManagementApi.new
|
|
1478
|
-
|
|
1479
1613
|
body = TalonOne::ApplicationCustomerSearch.new # ApplicationCustomerSearch |
|
|
1480
1614
|
|
|
1481
|
-
|
|
1482
1615
|
begin
|
|
1483
|
-
#Get a list of the customer profiles that match the given attributes
|
|
1616
|
+
#Get a list of the customer profiles that match the given attributes (with total count)
|
|
1484
1617
|
result = api_instance.get_application_customers_by_attributes(body)
|
|
1485
1618
|
p result
|
|
1486
1619
|
rescue TalonOne::ApiError => e
|
|
@@ -1490,6 +1623,7 @@ end
|
|
|
1490
1623
|
|
|
1491
1624
|
### Parameters
|
|
1492
1625
|
|
|
1626
|
+
|
|
1493
1627
|
Name | Type | Description | Notes
|
|
1494
1628
|
------------- | ------------- | ------------- | -------------
|
|
1495
1629
|
**body** | [**ApplicationCustomerSearch**](ApplicationCustomerSearch.md)| |
|
|
@@ -1504,12 +1638,12 @@ Name | Type | Description | Notes
|
|
|
1504
1638
|
|
|
1505
1639
|
### HTTP request headers
|
|
1506
1640
|
|
|
1507
|
-
|
|
1508
|
-
|
|
1641
|
+
- **Content-Type**: application/json
|
|
1642
|
+
- **Accept**: application/json
|
|
1509
1643
|
|
|
1510
1644
|
|
|
1645
|
+
## get_application_event_types
|
|
1511
1646
|
|
|
1512
|
-
# **get_application_event_types**
|
|
1513
1647
|
> InlineResponse20019 get_application_event_types(application_id, opts)
|
|
1514
1648
|
|
|
1515
1649
|
List Applications Event Types
|
|
@@ -1517,6 +1651,7 @@ List Applications Event Types
|
|
|
1517
1651
|
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
1652
|
|
|
1519
1653
|
### Example
|
|
1654
|
+
|
|
1520
1655
|
```ruby
|
|
1521
1656
|
# load the gem
|
|
1522
1657
|
require 'talon_one'
|
|
@@ -1529,10 +1664,8 @@ TalonOne.configure do |config|
|
|
|
1529
1664
|
end
|
|
1530
1665
|
|
|
1531
1666
|
api_instance = TalonOne::ManagementApi.new
|
|
1532
|
-
|
|
1533
1667
|
application_id = 56 # Integer |
|
|
1534
|
-
|
|
1535
|
-
opts = {
|
|
1668
|
+
opts = {
|
|
1536
1669
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1537
1670
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1538
1671
|
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 +1682,7 @@ end
|
|
|
1549
1682
|
|
|
1550
1683
|
### Parameters
|
|
1551
1684
|
|
|
1685
|
+
|
|
1552
1686
|
Name | Type | Description | Notes
|
|
1553
1687
|
------------- | ------------- | ------------- | -------------
|
|
1554
1688
|
**application_id** | **Integer**| |
|
|
@@ -1566,19 +1700,20 @@ Name | Type | Description | Notes
|
|
|
1566
1700
|
|
|
1567
1701
|
### HTTP request headers
|
|
1568
1702
|
|
|
1569
|
-
|
|
1570
|
-
|
|
1703
|
+
- **Content-Type**: Not defined
|
|
1704
|
+
- **Accept**: application/json
|
|
1571
1705
|
|
|
1572
1706
|
|
|
1707
|
+
## get_application_events
|
|
1573
1708
|
|
|
1574
|
-
# **get_application_events**
|
|
1575
1709
|
> InlineResponse20017 get_application_events(application_id, opts)
|
|
1576
1710
|
|
|
1577
|
-
List Applications Events
|
|
1711
|
+
List Applications Events (with total count)
|
|
1578
1712
|
|
|
1579
1713
|
Lists all events recorded for an application.
|
|
1580
1714
|
|
|
1581
1715
|
### Example
|
|
1716
|
+
|
|
1582
1717
|
```ruby
|
|
1583
1718
|
# load the gem
|
|
1584
1719
|
require 'talon_one'
|
|
@@ -1591,10 +1726,8 @@ TalonOne.configure do |config|
|
|
|
1591
1726
|
end
|
|
1592
1727
|
|
|
1593
1728
|
api_instance = TalonOne::ManagementApi.new
|
|
1594
|
-
|
|
1595
1729
|
application_id = 56 # Integer |
|
|
1596
|
-
|
|
1597
|
-
opts = {
|
|
1730
|
+
opts = {
|
|
1598
1731
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1599
1732
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1600
1733
|
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 +1738,14 @@ opts = {
|
|
|
1605
1738
|
profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
|
|
1606
1739
|
customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
|
|
1607
1740
|
customer_email: 'customer_email_example', # String | Customer e-mail address filter for events. Will match substrings case-insensitively.
|
|
1608
|
-
|
|
1609
|
-
|
|
1741
|
+
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
1742
|
+
referral_code: 'referral_code_example', # String | Referral code
|
|
1610
1743
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
1611
1744
|
campaign_query: 'campaign_query_example' # String | Campaign name filter for events
|
|
1612
1745
|
}
|
|
1613
1746
|
|
|
1614
1747
|
begin
|
|
1615
|
-
#List Applications Events
|
|
1748
|
+
#List Applications Events (with total count)
|
|
1616
1749
|
result = api_instance.get_application_events(application_id, opts)
|
|
1617
1750
|
p result
|
|
1618
1751
|
rescue TalonOne::ApiError => e
|
|
@@ -1622,6 +1755,7 @@ end
|
|
|
1622
1755
|
|
|
1623
1756
|
### Parameters
|
|
1624
1757
|
|
|
1758
|
+
|
|
1625
1759
|
Name | Type | Description | Notes
|
|
1626
1760
|
------------- | ------------- | ------------- | -------------
|
|
1627
1761
|
**application_id** | **Integer**| |
|
|
@@ -1635,8 +1769,8 @@ Name | Type | Description | Notes
|
|
|
1635
1769
|
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
|
|
1636
1770
|
**customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
|
|
1637
1771
|
**customer_email** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
|
|
1638
|
-
**
|
|
1639
|
-
**
|
|
1772
|
+
**coupon_code** | **String**| Coupon code | [optional]
|
|
1773
|
+
**referral_code** | **String**| Referral code | [optional]
|
|
1640
1774
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
1641
1775
|
**campaign_query** | **String**| Campaign name filter for events | [optional]
|
|
1642
1776
|
|
|
@@ -1650,12 +1784,12 @@ Name | Type | Description | Notes
|
|
|
1650
1784
|
|
|
1651
1785
|
### HTTP request headers
|
|
1652
1786
|
|
|
1653
|
-
|
|
1654
|
-
|
|
1787
|
+
- **Content-Type**: Not defined
|
|
1788
|
+
- **Accept**: application/json
|
|
1655
1789
|
|
|
1656
1790
|
|
|
1791
|
+
## get_application_events_without_total_count
|
|
1657
1792
|
|
|
1658
|
-
# **get_application_events_without_total_count**
|
|
1659
1793
|
> InlineResponse20018 get_application_events_without_total_count(application_id, opts)
|
|
1660
1794
|
|
|
1661
1795
|
List Applications Events
|
|
@@ -1663,6 +1797,7 @@ List Applications Events
|
|
|
1663
1797
|
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
1798
|
|
|
1665
1799
|
### Example
|
|
1800
|
+
|
|
1666
1801
|
```ruby
|
|
1667
1802
|
# load the gem
|
|
1668
1803
|
require 'talon_one'
|
|
@@ -1675,10 +1810,8 @@ TalonOne.configure do |config|
|
|
|
1675
1810
|
end
|
|
1676
1811
|
|
|
1677
1812
|
api_instance = TalonOne::ManagementApi.new
|
|
1678
|
-
|
|
1679
1813
|
application_id = 56 # Integer |
|
|
1680
|
-
|
|
1681
|
-
opts = {
|
|
1814
|
+
opts = {
|
|
1682
1815
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1683
1816
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1684
1817
|
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 +1822,8 @@ opts = {
|
|
|
1689
1822
|
profile: 'profile_example', # String | Profile integration ID filter for events. Must be exact match.
|
|
1690
1823
|
customer_name: 'customer_name_example', # String | Customer name filter for events. Will match substrings case-insensitively.
|
|
1691
1824
|
customer_email: 'customer_email_example', # String | Customer e-mail address filter for events. Will match substrings case-insensitively.
|
|
1692
|
-
|
|
1693
|
-
|
|
1825
|
+
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
1826
|
+
referral_code: 'referral_code_example', # String | Referral code
|
|
1694
1827
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
1695
1828
|
campaign_query: 'campaign_query_example' # String | Campaign name filter for events
|
|
1696
1829
|
}
|
|
@@ -1706,6 +1839,7 @@ end
|
|
|
1706
1839
|
|
|
1707
1840
|
### Parameters
|
|
1708
1841
|
|
|
1842
|
+
|
|
1709
1843
|
Name | Type | Description | Notes
|
|
1710
1844
|
------------- | ------------- | ------------- | -------------
|
|
1711
1845
|
**application_id** | **Integer**| |
|
|
@@ -1719,8 +1853,8 @@ Name | Type | Description | Notes
|
|
|
1719
1853
|
**profile** | **String**| Profile integration ID filter for events. Must be exact match. | [optional]
|
|
1720
1854
|
**customer_name** | **String**| Customer name filter for events. Will match substrings case-insensitively. | [optional]
|
|
1721
1855
|
**customer_email** | **String**| Customer e-mail address filter for events. Will match substrings case-insensitively. | [optional]
|
|
1722
|
-
**
|
|
1723
|
-
**
|
|
1856
|
+
**coupon_code** | **String**| Coupon code | [optional]
|
|
1857
|
+
**referral_code** | **String**| Referral code | [optional]
|
|
1724
1858
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
1725
1859
|
**campaign_query** | **String**| Campaign name filter for events | [optional]
|
|
1726
1860
|
|
|
@@ -1734,19 +1868,18 @@ Name | Type | Description | Notes
|
|
|
1734
1868
|
|
|
1735
1869
|
### HTTP request headers
|
|
1736
1870
|
|
|
1737
|
-
|
|
1738
|
-
|
|
1871
|
+
- **Content-Type**: Not defined
|
|
1872
|
+
- **Accept**: application/json
|
|
1739
1873
|
|
|
1740
1874
|
|
|
1875
|
+
## get_application_session
|
|
1741
1876
|
|
|
1742
|
-
# **get_application_session**
|
|
1743
1877
|
> ApplicationSession get_application_session(application_id, session_id)
|
|
1744
1878
|
|
|
1745
1879
|
Get Application Session
|
|
1746
1880
|
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
1881
|
### Example
|
|
1882
|
+
|
|
1750
1883
|
```ruby
|
|
1751
1884
|
# load the gem
|
|
1752
1885
|
require 'talon_one'
|
|
@@ -1759,12 +1892,9 @@ TalonOne.configure do |config|
|
|
|
1759
1892
|
end
|
|
1760
1893
|
|
|
1761
1894
|
api_instance = TalonOne::ManagementApi.new
|
|
1762
|
-
|
|
1763
1895
|
application_id = 56 # Integer |
|
|
1764
|
-
|
|
1765
1896
|
session_id = 56 # Integer |
|
|
1766
1897
|
|
|
1767
|
-
|
|
1768
1898
|
begin
|
|
1769
1899
|
#Get Application Session
|
|
1770
1900
|
result = api_instance.get_application_session(application_id, session_id)
|
|
@@ -1776,6 +1906,7 @@ end
|
|
|
1776
1906
|
|
|
1777
1907
|
### Parameters
|
|
1778
1908
|
|
|
1909
|
+
|
|
1779
1910
|
Name | Type | Description | Notes
|
|
1780
1911
|
------------- | ------------- | ------------- | -------------
|
|
1781
1912
|
**application_id** | **Integer**| |
|
|
@@ -1791,19 +1922,18 @@ Name | Type | Description | Notes
|
|
|
1791
1922
|
|
|
1792
1923
|
### HTTP request headers
|
|
1793
1924
|
|
|
1794
|
-
|
|
1795
|
-
|
|
1925
|
+
- **Content-Type**: Not defined
|
|
1926
|
+
- **Accept**: application/json
|
|
1796
1927
|
|
|
1797
1928
|
|
|
1929
|
+
## get_application_sessions
|
|
1798
1930
|
|
|
1799
|
-
# **get_application_sessions**
|
|
1800
1931
|
> InlineResponse20016 get_application_sessions(application_id, opts)
|
|
1801
1932
|
|
|
1802
1933
|
List Application Sessions
|
|
1803
1934
|
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
1935
|
### Example
|
|
1936
|
+
|
|
1807
1937
|
```ruby
|
|
1808
1938
|
# load the gem
|
|
1809
1939
|
require 'talon_one'
|
|
@@ -1816,16 +1946,18 @@ TalonOne.configure do |config|
|
|
|
1816
1946
|
end
|
|
1817
1947
|
|
|
1818
1948
|
api_instance = TalonOne::ManagementApi.new
|
|
1819
|
-
|
|
1820
1949
|
application_id = 56 # Integer |
|
|
1821
|
-
|
|
1822
|
-
opts = {
|
|
1950
|
+
opts = {
|
|
1823
1951
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1824
1952
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1825
1953
|
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
1954
|
profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
|
|
1827
1955
|
state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
|
|
1828
|
-
|
|
1956
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date
|
|
1957
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created after this date
|
|
1958
|
+
coupon: 'coupon_example', # String | Filter by sessions with this coupon. Must be exact match.
|
|
1959
|
+
referral: 'referral_example', # String | Filter by sessions with this referral. Must be exact match.
|
|
1960
|
+
integration_id: 'integration_id_example' # String | Filter by sessions with this integrationId. Must be exact match.
|
|
1829
1961
|
}
|
|
1830
1962
|
|
|
1831
1963
|
begin
|
|
@@ -1839,6 +1971,7 @@ end
|
|
|
1839
1971
|
|
|
1840
1972
|
### Parameters
|
|
1841
1973
|
|
|
1974
|
+
|
|
1842
1975
|
Name | Type | Description | Notes
|
|
1843
1976
|
------------- | ------------- | ------------- | -------------
|
|
1844
1977
|
**application_id** | **Integer**| |
|
|
@@ -1847,7 +1980,11 @@ Name | Type | Description | Notes
|
|
|
1847
1980
|
**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]
|
|
1848
1981
|
**profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
|
|
1849
1982
|
**state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
|
|
1983
|
+
**created_before** | **DateTime**| Only return events created before this date | [optional]
|
|
1984
|
+
**created_after** | **DateTime**| Only return events created after this date | [optional]
|
|
1850
1985
|
**coupon** | **String**| Filter by sessions with this coupon. Must be exact match. | [optional]
|
|
1986
|
+
**referral** | **String**| Filter by sessions with this referral. Must be exact match. | [optional]
|
|
1987
|
+
**integration_id** | **String**| Filter by sessions with this integrationId. Must be exact match. | [optional]
|
|
1851
1988
|
|
|
1852
1989
|
### Return type
|
|
1853
1990
|
|
|
@@ -1859,19 +1996,20 @@ Name | Type | Description | Notes
|
|
|
1859
1996
|
|
|
1860
1997
|
### HTTP request headers
|
|
1861
1998
|
|
|
1862
|
-
|
|
1863
|
-
|
|
1999
|
+
- **Content-Type**: Not defined
|
|
2000
|
+
- **Accept**: application/json
|
|
1864
2001
|
|
|
1865
2002
|
|
|
2003
|
+
## get_applications
|
|
1866
2004
|
|
|
1867
|
-
|
|
1868
|
-
> InlineResponse2002 get_applications(opts)
|
|
2005
|
+
> InlineResponse2001 get_applications(opts)
|
|
1869
2006
|
|
|
1870
2007
|
List Applications
|
|
1871
2008
|
|
|
1872
2009
|
List all application in the current account.
|
|
1873
2010
|
|
|
1874
2011
|
### Example
|
|
2012
|
+
|
|
1875
2013
|
```ruby
|
|
1876
2014
|
# load the gem
|
|
1877
2015
|
require 'talon_one'
|
|
@@ -1884,8 +2022,7 @@ TalonOne.configure do |config|
|
|
|
1884
2022
|
end
|
|
1885
2023
|
|
|
1886
2024
|
api_instance = TalonOne::ManagementApi.new
|
|
1887
|
-
|
|
1888
|
-
opts = {
|
|
2025
|
+
opts = {
|
|
1889
2026
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
1890
2027
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
1891
2028
|
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,15 +2039,70 @@ end
|
|
|
1902
2039
|
|
|
1903
2040
|
### Parameters
|
|
1904
2041
|
|
|
2042
|
+
|
|
2043
|
+
Name | Type | Description | Notes
|
|
2044
|
+
------------- | ------------- | ------------- | -------------
|
|
2045
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
2046
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
2047
|
+
**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]
|
|
2048
|
+
|
|
2049
|
+
### Return type
|
|
2050
|
+
|
|
2051
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
2052
|
+
|
|
2053
|
+
### Authorization
|
|
2054
|
+
|
|
2055
|
+
[manager_auth](../README.md#manager_auth)
|
|
2056
|
+
|
|
2057
|
+
### HTTP request headers
|
|
2058
|
+
|
|
2059
|
+
- **Content-Type**: Not defined
|
|
2060
|
+
- **Accept**: application/json
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
## get_attribute
|
|
2064
|
+
|
|
2065
|
+
> Attribute get_attribute(attribute_id)
|
|
2066
|
+
|
|
2067
|
+
Get a custom attribute
|
|
2068
|
+
|
|
2069
|
+
Returns custom attribute for the account by its id.
|
|
2070
|
+
|
|
2071
|
+
### Example
|
|
2072
|
+
|
|
2073
|
+
```ruby
|
|
2074
|
+
# load the gem
|
|
2075
|
+
require 'talon_one'
|
|
2076
|
+
# setup authorization
|
|
2077
|
+
TalonOne.configure do |config|
|
|
2078
|
+
# Configure API key authorization: manager_auth
|
|
2079
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2080
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2081
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2082
|
+
end
|
|
2083
|
+
|
|
2084
|
+
api_instance = TalonOne::ManagementApi.new
|
|
2085
|
+
attribute_id = 56 # Integer |
|
|
2086
|
+
|
|
2087
|
+
begin
|
|
2088
|
+
#Get a custom attribute
|
|
2089
|
+
result = api_instance.get_attribute(attribute_id)
|
|
2090
|
+
p result
|
|
2091
|
+
rescue TalonOne::ApiError => e
|
|
2092
|
+
puts "Exception when calling ManagementApi->get_attribute: #{e}"
|
|
2093
|
+
end
|
|
2094
|
+
```
|
|
2095
|
+
|
|
2096
|
+
### Parameters
|
|
2097
|
+
|
|
2098
|
+
|
|
1905
2099
|
Name | Type | Description | Notes
|
|
1906
2100
|
------------- | ------------- | ------------- | -------------
|
|
1907
|
-
**
|
|
1908
|
-
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
1909
|
-
**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]
|
|
2101
|
+
**attribute_id** | **Integer**| |
|
|
1910
2102
|
|
|
1911
2103
|
### Return type
|
|
1912
2104
|
|
|
1913
|
-
[**
|
|
2105
|
+
[**Attribute**](Attribute.md)
|
|
1914
2106
|
|
|
1915
2107
|
### Authorization
|
|
1916
2108
|
|
|
@@ -1918,19 +2110,20 @@ Name | Type | Description | Notes
|
|
|
1918
2110
|
|
|
1919
2111
|
### HTTP request headers
|
|
1920
2112
|
|
|
1921
|
-
|
|
1922
|
-
|
|
2113
|
+
- **Content-Type**: Not defined
|
|
2114
|
+
- **Accept**: application/json
|
|
1923
2115
|
|
|
1924
2116
|
|
|
2117
|
+
## get_attributes
|
|
1925
2118
|
|
|
1926
|
-
|
|
1927
|
-
> Attribute get_attribute(attribute_id)
|
|
2119
|
+
> InlineResponse20020 get_attributes(opts)
|
|
1928
2120
|
|
|
1929
|
-
|
|
2121
|
+
List custom attributes
|
|
1930
2122
|
|
|
1931
|
-
Returns custom
|
|
2123
|
+
Returns all the defined custom attributes for the account.
|
|
1932
2124
|
|
|
1933
2125
|
### Example
|
|
2126
|
+
|
|
1934
2127
|
```ruby
|
|
1935
2128
|
# load the gem
|
|
1936
2129
|
require 'talon_one'
|
|
@@ -1943,28 +2136,33 @@ TalonOne.configure do |config|
|
|
|
1943
2136
|
end
|
|
1944
2137
|
|
|
1945
2138
|
api_instance = TalonOne::ManagementApi.new
|
|
1946
|
-
|
|
1947
|
-
|
|
1948
|
-
|
|
2139
|
+
opts = {
|
|
2140
|
+
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2141
|
+
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2142
|
+
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.
|
|
2143
|
+
}
|
|
1949
2144
|
|
|
1950
2145
|
begin
|
|
1951
|
-
#
|
|
1952
|
-
result = api_instance.
|
|
2146
|
+
#List custom attributes
|
|
2147
|
+
result = api_instance.get_attributes(opts)
|
|
1953
2148
|
p result
|
|
1954
2149
|
rescue TalonOne::ApiError => e
|
|
1955
|
-
puts "Exception when calling ManagementApi->
|
|
2150
|
+
puts "Exception when calling ManagementApi->get_attributes: #{e}"
|
|
1956
2151
|
end
|
|
1957
2152
|
```
|
|
1958
2153
|
|
|
1959
2154
|
### Parameters
|
|
1960
2155
|
|
|
2156
|
+
|
|
1961
2157
|
Name | Type | Description | Notes
|
|
1962
2158
|
------------- | ------------- | ------------- | -------------
|
|
1963
|
-
**
|
|
2159
|
+
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
2160
|
+
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
2161
|
+
**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]
|
|
1964
2162
|
|
|
1965
2163
|
### Return type
|
|
1966
2164
|
|
|
1967
|
-
[**
|
|
2165
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
|
1968
2166
|
|
|
1969
2167
|
### Authorization
|
|
1970
2168
|
|
|
@@ -1972,19 +2170,18 @@ Name | Type | Description | Notes
|
|
|
1972
2170
|
|
|
1973
2171
|
### HTTP request headers
|
|
1974
2172
|
|
|
1975
|
-
|
|
1976
|
-
|
|
2173
|
+
- **Content-Type**: Not defined
|
|
2174
|
+
- **Accept**: application/json
|
|
1977
2175
|
|
|
1978
2176
|
|
|
2177
|
+
## get_campaign
|
|
1979
2178
|
|
|
1980
|
-
# **get_campaign**
|
|
1981
2179
|
> Campaign get_campaign(application_id, campaign_id)
|
|
1982
2180
|
|
|
1983
2181
|
Get a Campaign
|
|
1984
2182
|
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
2183
|
### Example
|
|
2184
|
+
|
|
1988
2185
|
```ruby
|
|
1989
2186
|
# load the gem
|
|
1990
2187
|
require 'talon_one'
|
|
@@ -1997,12 +2194,9 @@ TalonOne.configure do |config|
|
|
|
1997
2194
|
end
|
|
1998
2195
|
|
|
1999
2196
|
api_instance = TalonOne::ManagementApi.new
|
|
2000
|
-
|
|
2001
2197
|
application_id = 56 # Integer |
|
|
2002
|
-
|
|
2003
2198
|
campaign_id = 56 # Integer |
|
|
2004
2199
|
|
|
2005
|
-
|
|
2006
2200
|
begin
|
|
2007
2201
|
#Get a Campaign
|
|
2008
2202
|
result = api_instance.get_campaign(application_id, campaign_id)
|
|
@@ -2014,6 +2208,7 @@ end
|
|
|
2014
2208
|
|
|
2015
2209
|
### Parameters
|
|
2016
2210
|
|
|
2211
|
+
|
|
2017
2212
|
Name | Type | Description | Notes
|
|
2018
2213
|
------------- | ------------- | ------------- | -------------
|
|
2019
2214
|
**application_id** | **Integer**| |
|
|
@@ -2029,19 +2224,18 @@ Name | Type | Description | Notes
|
|
|
2029
2224
|
|
|
2030
2225
|
### HTTP request headers
|
|
2031
2226
|
|
|
2032
|
-
|
|
2033
|
-
|
|
2227
|
+
- **Content-Type**: Not defined
|
|
2228
|
+
- **Accept**: application/json
|
|
2034
2229
|
|
|
2035
2230
|
|
|
2231
|
+
## get_campaign_analytics
|
|
2036
2232
|
|
|
2037
|
-
# **get_campaign_analytics**
|
|
2038
2233
|
> InlineResponse20011 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
|
2039
2234
|
|
|
2040
2235
|
Get analytics of campaigns
|
|
2041
2236
|
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
2237
|
### Example
|
|
2238
|
+
|
|
2045
2239
|
```ruby
|
|
2046
2240
|
# load the gem
|
|
2047
2241
|
require 'talon_one'
|
|
@@ -2054,16 +2248,11 @@ TalonOne.configure do |config|
|
|
|
2054
2248
|
end
|
|
2055
2249
|
|
|
2056
2250
|
api_instance = TalonOne::ManagementApi.new
|
|
2057
|
-
|
|
2058
2251
|
application_id = 56 # Integer |
|
|
2059
|
-
|
|
2060
2252
|
campaign_id = 56 # Integer |
|
|
2061
|
-
|
|
2062
2253
|
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
2254
|
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 = {
|
|
2255
|
+
opts = {
|
|
2067
2256
|
granularity: 'granularity_example' # String | The time interval between the results in the returned time-series.
|
|
2068
2257
|
}
|
|
2069
2258
|
|
|
@@ -2078,6 +2267,7 @@ end
|
|
|
2078
2267
|
|
|
2079
2268
|
### Parameters
|
|
2080
2269
|
|
|
2270
|
+
|
|
2081
2271
|
Name | Type | Description | Notes
|
|
2082
2272
|
------------- | ------------- | ------------- | -------------
|
|
2083
2273
|
**application_id** | **Integer**| |
|
|
@@ -2096,19 +2286,20 @@ Name | Type | Description | Notes
|
|
|
2096
2286
|
|
|
2097
2287
|
### HTTP request headers
|
|
2098
2288
|
|
|
2099
|
-
|
|
2100
|
-
|
|
2289
|
+
- **Content-Type**: Not defined
|
|
2290
|
+
- **Accept**: application/json
|
|
2101
2291
|
|
|
2102
2292
|
|
|
2293
|
+
## get_campaign_by_attributes
|
|
2103
2294
|
|
|
2104
|
-
|
|
2105
|
-
> InlineResponse2003 get_campaign_by_attributes(application_id, body, opts)
|
|
2295
|
+
> InlineResponse2002 get_campaign_by_attributes(application_id, body, opts)
|
|
2106
2296
|
|
|
2107
2297
|
Get a list of all campaigns that match the given attributes
|
|
2108
2298
|
|
|
2109
2299
|
Gets a list of all the campaigns that exactly match a set of attributes.
|
|
2110
2300
|
|
|
2111
2301
|
### Example
|
|
2302
|
+
|
|
2112
2303
|
```ruby
|
|
2113
2304
|
# load the gem
|
|
2114
2305
|
require 'talon_one'
|
|
@@ -2121,12 +2312,9 @@ TalonOne.configure do |config|
|
|
|
2121
2312
|
end
|
|
2122
2313
|
|
|
2123
2314
|
api_instance = TalonOne::ManagementApi.new
|
|
2124
|
-
|
|
2125
2315
|
application_id = 56 # Integer |
|
|
2126
|
-
|
|
2127
2316
|
body = TalonOne::CampaignSearch.new # CampaignSearch |
|
|
2128
|
-
|
|
2129
|
-
opts = {
|
|
2317
|
+
opts = {
|
|
2130
2318
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2131
2319
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2132
2320
|
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.
|
|
@@ -2144,6 +2332,7 @@ end
|
|
|
2144
2332
|
|
|
2145
2333
|
### Parameters
|
|
2146
2334
|
|
|
2335
|
+
|
|
2147
2336
|
Name | Type | Description | Notes
|
|
2148
2337
|
------------- | ------------- | ------------- | -------------
|
|
2149
2338
|
**application_id** | **Integer**| |
|
|
@@ -2155,61 +2344,7 @@ Name | Type | Description | Notes
|
|
|
2155
2344
|
|
|
2156
2345
|
### Return type
|
|
2157
2346
|
|
|
2158
|
-
[**
|
|
2159
|
-
|
|
2160
|
-
### Authorization
|
|
2161
|
-
|
|
2162
|
-
[manager_auth](../README.md#manager_auth)
|
|
2163
|
-
|
|
2164
|
-
### HTTP request headers
|
|
2165
|
-
|
|
2166
|
-
- **Content-Type**: application/json
|
|
2167
|
-
- **Accept**: application/json
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
# **get_campaign_set**
|
|
2172
|
-
> CampaignSet get_campaign_set(application_id)
|
|
2173
|
-
|
|
2174
|
-
List CampaignSet
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
### Example
|
|
2179
|
-
```ruby
|
|
2180
|
-
# load the gem
|
|
2181
|
-
require 'talon_one'
|
|
2182
|
-
# setup authorization
|
|
2183
|
-
TalonOne.configure do |config|
|
|
2184
|
-
# Configure API key authorization: manager_auth
|
|
2185
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2186
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2187
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2188
|
-
end
|
|
2189
|
-
|
|
2190
|
-
api_instance = TalonOne::ManagementApi.new
|
|
2191
|
-
|
|
2192
|
-
application_id = 56 # Integer |
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
begin
|
|
2196
|
-
#List CampaignSet
|
|
2197
|
-
result = api_instance.get_campaign_set(application_id)
|
|
2198
|
-
p result
|
|
2199
|
-
rescue TalonOne::ApiError => e
|
|
2200
|
-
puts "Exception when calling ManagementApi->get_campaign_set: #{e}"
|
|
2201
|
-
end
|
|
2202
|
-
```
|
|
2203
|
-
|
|
2204
|
-
### Parameters
|
|
2205
|
-
|
|
2206
|
-
Name | Type | Description | Notes
|
|
2207
|
-
------------- | ------------- | ------------- | -------------
|
|
2208
|
-
**application_id** | **Integer**| |
|
|
2209
|
-
|
|
2210
|
-
### Return type
|
|
2211
|
-
|
|
2212
|
-
[**CampaignSet**](CampaignSet.md)
|
|
2347
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
2213
2348
|
|
|
2214
2349
|
### Authorization
|
|
2215
2350
|
|
|
@@ -2217,19 +2352,18 @@ Name | Type | Description | Notes
|
|
|
2217
2352
|
|
|
2218
2353
|
### HTTP request headers
|
|
2219
2354
|
|
|
2220
|
-
|
|
2221
|
-
|
|
2355
|
+
- **Content-Type**: application/json
|
|
2356
|
+
- **Accept**: application/json
|
|
2222
2357
|
|
|
2223
2358
|
|
|
2359
|
+
## get_campaigns
|
|
2224
2360
|
|
|
2225
|
-
|
|
2226
|
-
> InlineResponse2003 get_campaigns(application_id, opts)
|
|
2361
|
+
> InlineResponse2002 get_campaigns(application_id, opts)
|
|
2227
2362
|
|
|
2228
2363
|
List your Campaigns
|
|
2229
2364
|
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
2365
|
### Example
|
|
2366
|
+
|
|
2233
2367
|
```ruby
|
|
2234
2368
|
# load the gem
|
|
2235
2369
|
require 'talon_one'
|
|
@@ -2242,10 +2376,8 @@ TalonOne.configure do |config|
|
|
|
2242
2376
|
end
|
|
2243
2377
|
|
|
2244
2378
|
api_instance = TalonOne::ManagementApi.new
|
|
2245
|
-
|
|
2246
2379
|
application_id = 56 # Integer |
|
|
2247
|
-
|
|
2248
|
-
opts = {
|
|
2380
|
+
opts = {
|
|
2249
2381
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2250
2382
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2251
2383
|
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.
|
|
@@ -2253,7 +2385,8 @@ opts = {
|
|
|
2253
2385
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
|
|
2254
2386
|
tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
|
2255
2387
|
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 campaign creation timestamp.
|
|
2256
|
-
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 campaign creation timestamp.
|
|
2388
|
+
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 campaign creation timestamp.
|
|
2389
|
+
campaign_group_id: 56 # Integer | Filter results to campaigns owned by the specified campaign group ID.
|
|
2257
2390
|
}
|
|
2258
2391
|
|
|
2259
2392
|
begin
|
|
@@ -2267,6 +2400,7 @@ end
|
|
|
2267
2400
|
|
|
2268
2401
|
### Parameters
|
|
2269
2402
|
|
|
2403
|
+
|
|
2270
2404
|
Name | Type | Description | Notes
|
|
2271
2405
|
------------- | ------------- | ------------- | -------------
|
|
2272
2406
|
**application_id** | **Integer**| |
|
|
@@ -2278,10 +2412,11 @@ Name | Type | Description | Notes
|
|
|
2278
2412
|
**tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
|
|
2279
2413
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
|
|
2280
2414
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. | [optional]
|
|
2415
|
+
**campaign_group_id** | **Integer**| Filter results to campaigns owned by the specified campaign group ID. | [optional]
|
|
2281
2416
|
|
|
2282
2417
|
### Return type
|
|
2283
2418
|
|
|
2284
|
-
[**
|
|
2419
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
|
2285
2420
|
|
|
2286
2421
|
### Authorization
|
|
2287
2422
|
|
|
@@ -2289,19 +2424,20 @@ Name | Type | Description | Notes
|
|
|
2289
2424
|
|
|
2290
2425
|
### HTTP request headers
|
|
2291
2426
|
|
|
2292
|
-
|
|
2293
|
-
|
|
2427
|
+
- **Content-Type**: Not defined
|
|
2428
|
+
- **Accept**: application/json
|
|
2294
2429
|
|
|
2295
2430
|
|
|
2431
|
+
## get_changes
|
|
2296
2432
|
|
|
2297
|
-
|
|
2298
|
-
> InlineResponse20025 get_changes(opts)
|
|
2433
|
+
> InlineResponse20027 get_changes(opts)
|
|
2299
2434
|
|
|
2300
2435
|
Get audit log for an account
|
|
2301
2436
|
|
|
2302
2437
|
Get list of changes caused by API calls for an account. Only accessible for admins.
|
|
2303
2438
|
|
|
2304
2439
|
### Example
|
|
2440
|
+
|
|
2305
2441
|
```ruby
|
|
2306
2442
|
# load the gem
|
|
2307
2443
|
require 'talon_one'
|
|
@@ -2314,16 +2450,15 @@ TalonOne.configure do |config|
|
|
|
2314
2450
|
end
|
|
2315
2451
|
|
|
2316
2452
|
api_instance = TalonOne::ManagementApi.new
|
|
2317
|
-
|
|
2318
|
-
opts = {
|
|
2453
|
+
opts = {
|
|
2319
2454
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2320
2455
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2321
2456
|
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.
|
|
2322
2457
|
application_id: 56, # Integer |
|
|
2323
2458
|
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.
|
|
2324
2459
|
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.
|
|
2325
|
-
with_total_result_size: true, #
|
|
2326
|
-
include_old: true #
|
|
2460
|
+
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.
|
|
2461
|
+
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.
|
|
2327
2462
|
}
|
|
2328
2463
|
|
|
2329
2464
|
begin
|
|
@@ -2337,6 +2472,7 @@ end
|
|
|
2337
2472
|
|
|
2338
2473
|
### Parameters
|
|
2339
2474
|
|
|
2475
|
+
|
|
2340
2476
|
Name | Type | Description | Notes
|
|
2341
2477
|
------------- | ------------- | ------------- | -------------
|
|
2342
2478
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -2345,12 +2481,12 @@ Name | Type | Description | Notes
|
|
|
2345
2481
|
**application_id** | **Integer**| | [optional]
|
|
2346
2482
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
|
|
2347
2483
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. | [optional]
|
|
2348
|
-
**with_total_result_size** | **
|
|
2349
|
-
**include_old** | **
|
|
2484
|
+
**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]
|
|
2485
|
+
**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]
|
|
2350
2486
|
|
|
2351
2487
|
### Return type
|
|
2352
2488
|
|
|
2353
|
-
[**
|
|
2489
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
|
2354
2490
|
|
|
2355
2491
|
### Authorization
|
|
2356
2492
|
|
|
@@ -2358,19 +2494,18 @@ Name | Type | Description | Notes
|
|
|
2358
2494
|
|
|
2359
2495
|
### HTTP request headers
|
|
2360
2496
|
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2497
|
+
- **Content-Type**: Not defined
|
|
2498
|
+
- **Accept**: application/json
|
|
2365
2499
|
|
|
2366
|
-
# **get_coupons**
|
|
2367
|
-
> InlineResponse2001 get_coupons(application_id, campaign_id, opts)
|
|
2368
2500
|
|
|
2369
|
-
|
|
2501
|
+
## get_coupons
|
|
2370
2502
|
|
|
2503
|
+
> InlineResponse2004 get_coupons(application_id, campaign_id, opts)
|
|
2371
2504
|
|
|
2505
|
+
List Coupons (with total count)
|
|
2372
2506
|
|
|
2373
2507
|
### Example
|
|
2508
|
+
|
|
2374
2509
|
```ruby
|
|
2375
2510
|
# load the gem
|
|
2376
2511
|
require 'talon_one'
|
|
@@ -2383,12 +2518,9 @@ TalonOne.configure do |config|
|
|
|
2383
2518
|
end
|
|
2384
2519
|
|
|
2385
2520
|
api_instance = TalonOne::ManagementApi.new
|
|
2386
|
-
|
|
2387
2521
|
application_id = 56 # Integer |
|
|
2388
|
-
|
|
2389
2522
|
campaign_id = 56 # Integer |
|
|
2390
|
-
|
|
2391
|
-
opts = {
|
|
2523
|
+
opts = {
|
|
2392
2524
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2393
2525
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2394
2526
|
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.
|
|
@@ -2404,11 +2536,11 @@ opts = {
|
|
|
2404
2536
|
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`.
|
|
2405
2537
|
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.
|
|
2406
2538
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2407
|
-
exact_match: false #
|
|
2539
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2408
2540
|
}
|
|
2409
2541
|
|
|
2410
2542
|
begin
|
|
2411
|
-
#List Coupons
|
|
2543
|
+
#List Coupons (with total count)
|
|
2412
2544
|
result = api_instance.get_coupons(application_id, campaign_id, opts)
|
|
2413
2545
|
p result
|
|
2414
2546
|
rescue TalonOne::ApiError => e
|
|
@@ -2418,6 +2550,7 @@ end
|
|
|
2418
2550
|
|
|
2419
2551
|
### Parameters
|
|
2420
2552
|
|
|
2553
|
+
|
|
2421
2554
|
Name | Type | Description | Notes
|
|
2422
2555
|
------------- | ------------- | ------------- | -------------
|
|
2423
2556
|
**application_id** | **Integer**| |
|
|
@@ -2437,11 +2570,11 @@ Name | Type | Description | Notes
|
|
|
2437
2570
|
**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]
|
|
2438
2571
|
**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]
|
|
2439
2572
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2440
|
-
**exact_match** | **
|
|
2573
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2441
2574
|
|
|
2442
2575
|
### Return type
|
|
2443
2576
|
|
|
2444
|
-
[**
|
|
2577
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2445
2578
|
|
|
2446
2579
|
### Authorization
|
|
2447
2580
|
|
|
@@ -2449,19 +2582,20 @@ Name | Type | Description | Notes
|
|
|
2449
2582
|
|
|
2450
2583
|
### HTTP request headers
|
|
2451
2584
|
|
|
2452
|
-
|
|
2453
|
-
|
|
2585
|
+
- **Content-Type**: Not defined
|
|
2586
|
+
- **Accept**: application/json
|
|
2454
2587
|
|
|
2455
2588
|
|
|
2589
|
+
## get_coupons_by_attributes
|
|
2456
2590
|
|
|
2457
|
-
|
|
2458
|
-
> InlineResponse2001 get_coupons_by_attributes(application_id, campaign_id, body, opts)
|
|
2591
|
+
> InlineResponse2004 get_coupons_by_attributes(application_id, campaign_id, body, opts)
|
|
2459
2592
|
|
|
2460
2593
|
Get a list of the coupons that match the given attributes
|
|
2461
2594
|
|
|
2462
2595
|
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.
|
|
2463
2596
|
|
|
2464
2597
|
### Example
|
|
2598
|
+
|
|
2465
2599
|
```ruby
|
|
2466
2600
|
# load the gem
|
|
2467
2601
|
require 'talon_one'
|
|
@@ -2474,14 +2608,10 @@ TalonOne.configure do |config|
|
|
|
2474
2608
|
end
|
|
2475
2609
|
|
|
2476
2610
|
api_instance = TalonOne::ManagementApi.new
|
|
2477
|
-
|
|
2478
2611
|
application_id = 56 # Integer |
|
|
2479
|
-
|
|
2480
2612
|
campaign_id = 56 # Integer |
|
|
2481
|
-
|
|
2482
2613
|
body = TalonOne::CouponSearch.new # CouponSearch |
|
|
2483
|
-
|
|
2484
|
-
opts = {
|
|
2614
|
+
opts = {
|
|
2485
2615
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2486
2616
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2487
2617
|
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.
|
|
@@ -2492,7 +2622,7 @@ opts = {
|
|
|
2492
2622
|
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`.
|
|
2493
2623
|
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.
|
|
2494
2624
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2495
|
-
exact_match: false, #
|
|
2625
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2496
2626
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
2497
2627
|
}
|
|
2498
2628
|
|
|
@@ -2507,6 +2637,7 @@ end
|
|
|
2507
2637
|
|
|
2508
2638
|
### Parameters
|
|
2509
2639
|
|
|
2640
|
+
|
|
2510
2641
|
Name | Type | Description | Notes
|
|
2511
2642
|
------------- | ------------- | ------------- | -------------
|
|
2512
2643
|
**application_id** | **Integer**| |
|
|
@@ -2522,12 +2653,12 @@ Name | Type | Description | Notes
|
|
|
2522
2653
|
**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]
|
|
2523
2654
|
**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]
|
|
2524
2655
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2525
|
-
**exact_match** | **
|
|
2656
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2526
2657
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2527
2658
|
|
|
2528
2659
|
### Return type
|
|
2529
2660
|
|
|
2530
|
-
[**
|
|
2661
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2531
2662
|
|
|
2532
2663
|
### Authorization
|
|
2533
2664
|
|
|
@@ -2535,19 +2666,20 @@ Name | Type | Description | Notes
|
|
|
2535
2666
|
|
|
2536
2667
|
### HTTP request headers
|
|
2537
2668
|
|
|
2538
|
-
|
|
2539
|
-
|
|
2669
|
+
- **Content-Type**: application/json
|
|
2670
|
+
- **Accept**: application/json
|
|
2540
2671
|
|
|
2541
2672
|
|
|
2673
|
+
## get_coupons_by_attributes_application_wide
|
|
2542
2674
|
|
|
2543
|
-
|
|
2544
|
-
> InlineResponse2001 get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2675
|
+
> InlineResponse2004 get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2545
2676
|
|
|
2546
|
-
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
2677
|
+
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
2547
2678
|
|
|
2548
2679
|
Gets a list of all the coupons with attributes matching the query criteria Application wide
|
|
2549
2680
|
|
|
2550
2681
|
### Example
|
|
2682
|
+
|
|
2551
2683
|
```ruby
|
|
2552
2684
|
# load the gem
|
|
2553
2685
|
require 'talon_one'
|
|
@@ -2560,12 +2692,9 @@ TalonOne.configure do |config|
|
|
|
2560
2692
|
end
|
|
2561
2693
|
|
|
2562
2694
|
api_instance = TalonOne::ManagementApi.new
|
|
2563
|
-
|
|
2564
2695
|
application_id = 56 # Integer |
|
|
2565
|
-
|
|
2566
2696
|
body = TalonOne::CouponSearch.new # CouponSearch |
|
|
2567
|
-
|
|
2568
|
-
opts = {
|
|
2697
|
+
opts = {
|
|
2569
2698
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2570
2699
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2571
2700
|
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.
|
|
@@ -2577,12 +2706,12 @@ opts = {
|
|
|
2577
2706
|
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.
|
|
2578
2707
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2579
2708
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
2580
|
-
exact_match: false, #
|
|
2709
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2581
2710
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
2582
2711
|
}
|
|
2583
2712
|
|
|
2584
2713
|
begin
|
|
2585
|
-
#Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
2714
|
+
#Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
2586
2715
|
result = api_instance.get_coupons_by_attributes_application_wide(application_id, body, opts)
|
|
2587
2716
|
p result
|
|
2588
2717
|
rescue TalonOne::ApiError => e
|
|
@@ -2592,6 +2721,7 @@ end
|
|
|
2592
2721
|
|
|
2593
2722
|
### Parameters
|
|
2594
2723
|
|
|
2724
|
+
|
|
2595
2725
|
Name | Type | Description | Notes
|
|
2596
2726
|
------------- | ------------- | ------------- | -------------
|
|
2597
2727
|
**application_id** | **Integer**| |
|
|
@@ -2607,12 +2737,12 @@ Name | Type | Description | Notes
|
|
|
2607
2737
|
**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]
|
|
2608
2738
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2609
2739
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2610
|
-
**exact_match** | **
|
|
2740
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2611
2741
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
2612
2742
|
|
|
2613
2743
|
### Return type
|
|
2614
2744
|
|
|
2615
|
-
[**
|
|
2745
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
2616
2746
|
|
|
2617
2747
|
### Authorization
|
|
2618
2748
|
|
|
@@ -2620,19 +2750,18 @@ Name | Type | Description | Notes
|
|
|
2620
2750
|
|
|
2621
2751
|
### HTTP request headers
|
|
2622
2752
|
|
|
2623
|
-
|
|
2624
|
-
|
|
2753
|
+
- **Content-Type**: application/json
|
|
2754
|
+
- **Accept**: application/json
|
|
2625
2755
|
|
|
2626
2756
|
|
|
2757
|
+
## get_coupons_without_total_count
|
|
2627
2758
|
|
|
2628
|
-
# **get_coupons_without_total_count**
|
|
2629
2759
|
> InlineResponse2005 get_coupons_without_total_count(application_id, campaign_id, opts)
|
|
2630
2760
|
|
|
2631
2761
|
List Coupons
|
|
2632
2762
|
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
2763
|
### Example
|
|
2764
|
+
|
|
2636
2765
|
```ruby
|
|
2637
2766
|
# load the gem
|
|
2638
2767
|
require 'talon_one'
|
|
@@ -2645,12 +2774,9 @@ TalonOne.configure do |config|
|
|
|
2645
2774
|
end
|
|
2646
2775
|
|
|
2647
2776
|
api_instance = TalonOne::ManagementApi.new
|
|
2648
|
-
|
|
2649
2777
|
application_id = 56 # Integer |
|
|
2650
|
-
|
|
2651
2778
|
campaign_id = 56 # Integer |
|
|
2652
|
-
|
|
2653
|
-
opts = {
|
|
2779
|
+
opts = {
|
|
2654
2780
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2655
2781
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2656
2782
|
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.
|
|
@@ -2662,7 +2788,7 @@ opts = {
|
|
|
2662
2788
|
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.
|
|
2663
2789
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
2664
2790
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
2665
|
-
exact_match: false #
|
|
2791
|
+
exact_match: false # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
2666
2792
|
}
|
|
2667
2793
|
|
|
2668
2794
|
begin
|
|
@@ -2676,6 +2802,7 @@ end
|
|
|
2676
2802
|
|
|
2677
2803
|
### Parameters
|
|
2678
2804
|
|
|
2805
|
+
|
|
2679
2806
|
Name | Type | Description | Notes
|
|
2680
2807
|
------------- | ------------- | ------------- | -------------
|
|
2681
2808
|
**application_id** | **Integer**| |
|
|
@@ -2691,7 +2818,7 @@ Name | Type | Description | Notes
|
|
|
2691
2818
|
**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]
|
|
2692
2819
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
2693
2820
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
2694
|
-
**exact_match** | **
|
|
2821
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
2695
2822
|
|
|
2696
2823
|
### Return type
|
|
2697
2824
|
|
|
@@ -2703,12 +2830,12 @@ Name | Type | Description | Notes
|
|
|
2703
2830
|
|
|
2704
2831
|
### HTTP request headers
|
|
2705
2832
|
|
|
2706
|
-
|
|
2707
|
-
|
|
2833
|
+
- **Content-Type**: Not defined
|
|
2834
|
+
- **Accept**: application/json
|
|
2708
2835
|
|
|
2709
2836
|
|
|
2837
|
+
## get_customer_activity_report
|
|
2710
2838
|
|
|
2711
|
-
# **get_customer_activity_report**
|
|
2712
2839
|
> CustomerActivityReport get_customer_activity_report(range_start, range_end, application_id, customer_id, opts)
|
|
2713
2840
|
|
|
2714
2841
|
Get Activity Report for Single Customer
|
|
@@ -2716,6 +2843,7 @@ Get Activity Report for Single Customer
|
|
|
2716
2843
|
Fetch summary report for single application customer based on a time range
|
|
2717
2844
|
|
|
2718
2845
|
### Example
|
|
2846
|
+
|
|
2719
2847
|
```ruby
|
|
2720
2848
|
# load the gem
|
|
2721
2849
|
require 'talon_one'
|
|
@@ -2728,16 +2856,11 @@ TalonOne.configure do |config|
|
|
|
2728
2856
|
end
|
|
2729
2857
|
|
|
2730
2858
|
api_instance = TalonOne::ManagementApi.new
|
|
2731
|
-
|
|
2732
2859
|
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
|
|
2733
|
-
|
|
2734
2860
|
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
|
|
2735
|
-
|
|
2736
2861
|
application_id = 56 # Integer |
|
|
2737
|
-
|
|
2738
2862
|
customer_id = 56 # Integer |
|
|
2739
|
-
|
|
2740
|
-
opts = {
|
|
2863
|
+
opts = {
|
|
2741
2864
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2742
2865
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
2743
2866
|
}
|
|
@@ -2753,6 +2876,7 @@ end
|
|
|
2753
2876
|
|
|
2754
2877
|
### Parameters
|
|
2755
2878
|
|
|
2879
|
+
|
|
2756
2880
|
Name | Type | Description | Notes
|
|
2757
2881
|
------------- | ------------- | ------------- | -------------
|
|
2758
2882
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2772,19 +2896,20 @@ Name | Type | Description | Notes
|
|
|
2772
2896
|
|
|
2773
2897
|
### HTTP request headers
|
|
2774
2898
|
|
|
2775
|
-
|
|
2776
|
-
|
|
2899
|
+
- **Content-Type**: Not defined
|
|
2900
|
+
- **Accept**: application/json
|
|
2777
2901
|
|
|
2778
2902
|
|
|
2903
|
+
## get_customer_activity_reports
|
|
2779
2904
|
|
|
2780
|
-
# **get_customer_activity_reports**
|
|
2781
2905
|
> InlineResponse20014 get_customer_activity_reports(range_start, range_end, application_id, opts)
|
|
2782
2906
|
|
|
2783
|
-
Get Activity Reports for Application Customers
|
|
2907
|
+
Get Activity Reports for Application Customers (with total count)
|
|
2784
2908
|
|
|
2785
2909
|
Fetch summary reports for all application customers based on a time range
|
|
2786
2910
|
|
|
2787
2911
|
### Example
|
|
2912
|
+
|
|
2788
2913
|
```ruby
|
|
2789
2914
|
# load the gem
|
|
2790
2915
|
require 'talon_one'
|
|
@@ -2797,14 +2922,10 @@ TalonOne.configure do |config|
|
|
|
2797
2922
|
end
|
|
2798
2923
|
|
|
2799
2924
|
api_instance = TalonOne::ManagementApi.new
|
|
2800
|
-
|
|
2801
2925
|
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
|
|
2802
|
-
|
|
2803
2926
|
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
|
|
2804
|
-
|
|
2805
2927
|
application_id = 56 # Integer |
|
|
2806
|
-
|
|
2807
|
-
opts = {
|
|
2928
|
+
opts = {
|
|
2808
2929
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2809
2930
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2810
2931
|
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.
|
|
@@ -2815,7 +2936,7 @@ opts = {
|
|
|
2815
2936
|
}
|
|
2816
2937
|
|
|
2817
2938
|
begin
|
|
2818
|
-
#Get Activity Reports for Application Customers
|
|
2939
|
+
#Get Activity Reports for Application Customers (with total count)
|
|
2819
2940
|
result = api_instance.get_customer_activity_reports(range_start, range_end, application_id, opts)
|
|
2820
2941
|
p result
|
|
2821
2942
|
rescue TalonOne::ApiError => e
|
|
@@ -2825,6 +2946,7 @@ end
|
|
|
2825
2946
|
|
|
2826
2947
|
### Parameters
|
|
2827
2948
|
|
|
2949
|
+
|
|
2828
2950
|
Name | Type | Description | Notes
|
|
2829
2951
|
------------- | ------------- | ------------- | -------------
|
|
2830
2952
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2848,12 +2970,12 @@ Name | Type | Description | Notes
|
|
|
2848
2970
|
|
|
2849
2971
|
### HTTP request headers
|
|
2850
2972
|
|
|
2851
|
-
|
|
2852
|
-
|
|
2973
|
+
- **Content-Type**: Not defined
|
|
2974
|
+
- **Accept**: application/json
|
|
2853
2975
|
|
|
2854
2976
|
|
|
2977
|
+
## get_customer_activity_reports_without_total_count
|
|
2855
2978
|
|
|
2856
|
-
# **get_customer_activity_reports_without_total_count**
|
|
2857
2979
|
> InlineResponse20015 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
|
2858
2980
|
|
|
2859
2981
|
Get Activity Reports for Application Customers
|
|
@@ -2861,6 +2983,7 @@ Get Activity Reports for Application Customers
|
|
|
2861
2983
|
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.
|
|
2862
2984
|
|
|
2863
2985
|
### Example
|
|
2986
|
+
|
|
2864
2987
|
```ruby
|
|
2865
2988
|
# load the gem
|
|
2866
2989
|
require 'talon_one'
|
|
@@ -2873,14 +2996,10 @@ TalonOne.configure do |config|
|
|
|
2873
2996
|
end
|
|
2874
2997
|
|
|
2875
2998
|
api_instance = TalonOne::ManagementApi.new
|
|
2876
|
-
|
|
2877
2999
|
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
|
|
2878
|
-
|
|
2879
3000
|
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
|
|
2880
|
-
|
|
2881
3001
|
application_id = 56 # Integer |
|
|
2882
|
-
|
|
2883
|
-
opts = {
|
|
3002
|
+
opts = {
|
|
2884
3003
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2885
3004
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2886
3005
|
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.
|
|
@@ -2901,6 +3020,7 @@ end
|
|
|
2901
3020
|
|
|
2902
3021
|
### Parameters
|
|
2903
3022
|
|
|
3023
|
+
|
|
2904
3024
|
Name | Type | Description | Notes
|
|
2905
3025
|
------------- | ------------- | ------------- | -------------
|
|
2906
3026
|
**range_start** | **DateTime**| Only return results from after this timestamp, must be an RFC3339 timestamp string |
|
|
@@ -2924,12 +3044,12 @@ Name | Type | Description | Notes
|
|
|
2924
3044
|
|
|
2925
3045
|
### HTTP request headers
|
|
2926
3046
|
|
|
2927
|
-
|
|
2928
|
-
|
|
3047
|
+
- **Content-Type**: Not defined
|
|
3048
|
+
- **Accept**: application/json
|
|
2929
3049
|
|
|
2930
3050
|
|
|
3051
|
+
## get_customer_analytics
|
|
2931
3052
|
|
|
2932
|
-
# **get_customer_analytics**
|
|
2933
3053
|
> CustomerAnalytics get_customer_analytics(application_id, customer_id, opts)
|
|
2934
3054
|
|
|
2935
3055
|
Get Analytics Report for a Customer
|
|
@@ -2937,6 +3057,7 @@ Get Analytics Report for a Customer
|
|
|
2937
3057
|
Fetch analytics for single application customer
|
|
2938
3058
|
|
|
2939
3059
|
### Example
|
|
3060
|
+
|
|
2940
3061
|
```ruby
|
|
2941
3062
|
# load the gem
|
|
2942
3063
|
require 'talon_one'
|
|
@@ -2949,12 +3070,9 @@ TalonOne.configure do |config|
|
|
|
2949
3070
|
end
|
|
2950
3071
|
|
|
2951
3072
|
api_instance = TalonOne::ManagementApi.new
|
|
2952
|
-
|
|
2953
3073
|
application_id = 56 # Integer |
|
|
2954
|
-
|
|
2955
3074
|
customer_id = 56 # Integer |
|
|
2956
|
-
|
|
2957
|
-
opts = {
|
|
3075
|
+
opts = {
|
|
2958
3076
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
2959
3077
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
2960
3078
|
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.
|
|
@@ -2971,6 +3089,7 @@ end
|
|
|
2971
3089
|
|
|
2972
3090
|
### Parameters
|
|
2973
3091
|
|
|
3092
|
+
|
|
2974
3093
|
Name | Type | Description | Notes
|
|
2975
3094
|
------------- | ------------- | ------------- | -------------
|
|
2976
3095
|
**application_id** | **Integer**| |
|
|
@@ -2989,19 +3108,18 @@ Name | Type | Description | Notes
|
|
|
2989
3108
|
|
|
2990
3109
|
### HTTP request headers
|
|
2991
3110
|
|
|
2992
|
-
|
|
2993
|
-
|
|
3111
|
+
- **Content-Type**: Not defined
|
|
3112
|
+
- **Accept**: application/json
|
|
2994
3113
|
|
|
2995
3114
|
|
|
3115
|
+
## get_customer_profile
|
|
2996
3116
|
|
|
2997
|
-
|
|
2998
|
-
> ApplicationCustomer get_customer_profile(application_id, customer_id)
|
|
3117
|
+
> ApplicationCustomer get_customer_profile(customer_id)
|
|
2999
3118
|
|
|
3000
3119
|
Get Customer Profile
|
|
3001
3120
|
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
3121
|
### Example
|
|
3122
|
+
|
|
3005
3123
|
```ruby
|
|
3006
3124
|
# load the gem
|
|
3007
3125
|
require 'talon_one'
|
|
@@ -3014,15 +3132,11 @@ TalonOne.configure do |config|
|
|
|
3014
3132
|
end
|
|
3015
3133
|
|
|
3016
3134
|
api_instance = TalonOne::ManagementApi.new
|
|
3017
|
-
|
|
3018
|
-
application_id = 56 # Integer |
|
|
3019
|
-
|
|
3020
3135
|
customer_id = 56 # Integer |
|
|
3021
3136
|
|
|
3022
|
-
|
|
3023
3137
|
begin
|
|
3024
3138
|
#Get Customer Profile
|
|
3025
|
-
result = api_instance.get_customer_profile(
|
|
3139
|
+
result = api_instance.get_customer_profile(customer_id)
|
|
3026
3140
|
p result
|
|
3027
3141
|
rescue TalonOne::ApiError => e
|
|
3028
3142
|
puts "Exception when calling ManagementApi->get_customer_profile: #{e}"
|
|
@@ -3031,9 +3145,9 @@ end
|
|
|
3031
3145
|
|
|
3032
3146
|
### Parameters
|
|
3033
3147
|
|
|
3148
|
+
|
|
3034
3149
|
Name | Type | Description | Notes
|
|
3035
3150
|
------------- | ------------- | ------------- | -------------
|
|
3036
|
-
**application_id** | **Integer**| |
|
|
3037
3151
|
**customer_id** | **Integer**| |
|
|
3038
3152
|
|
|
3039
3153
|
### Return type
|
|
@@ -3046,19 +3160,18 @@ Name | Type | Description | Notes
|
|
|
3046
3160
|
|
|
3047
3161
|
### HTTP request headers
|
|
3048
3162
|
|
|
3049
|
-
|
|
3050
|
-
|
|
3163
|
+
- **Content-Type**: Not defined
|
|
3164
|
+
- **Accept**: application/json
|
|
3051
3165
|
|
|
3052
3166
|
|
|
3167
|
+
## get_customer_profiles
|
|
3053
3168
|
|
|
3054
|
-
# **get_customer_profiles**
|
|
3055
3169
|
> InlineResponse20013 get_customer_profiles(opts)
|
|
3056
3170
|
|
|
3057
3171
|
List Customer Profiles
|
|
3058
3172
|
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
3173
|
### Example
|
|
3174
|
+
|
|
3062
3175
|
```ruby
|
|
3063
3176
|
# load the gem
|
|
3064
3177
|
require 'talon_one'
|
|
@@ -3071,8 +3184,7 @@ TalonOne.configure do |config|
|
|
|
3071
3184
|
end
|
|
3072
3185
|
|
|
3073
3186
|
api_instance = TalonOne::ManagementApi.new
|
|
3074
|
-
|
|
3075
|
-
opts = {
|
|
3187
|
+
opts = {
|
|
3076
3188
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3077
3189
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3078
3190
|
}
|
|
@@ -3088,6 +3200,7 @@ end
|
|
|
3088
3200
|
|
|
3089
3201
|
### Parameters
|
|
3090
3202
|
|
|
3203
|
+
|
|
3091
3204
|
Name | Type | Description | Notes
|
|
3092
3205
|
------------- | ------------- | ------------- | -------------
|
|
3093
3206
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3103,19 +3216,20 @@ Name | Type | Description | Notes
|
|
|
3103
3216
|
|
|
3104
3217
|
### HTTP request headers
|
|
3105
3218
|
|
|
3106
|
-
|
|
3107
|
-
|
|
3219
|
+
- **Content-Type**: Not defined
|
|
3220
|
+
- **Accept**: application/json
|
|
3108
3221
|
|
|
3109
3222
|
|
|
3223
|
+
## get_customers_by_attributes
|
|
3110
3224
|
|
|
3111
|
-
# **get_customers_by_attributes**
|
|
3112
3225
|
> InlineResponse20013 get_customers_by_attributes(body, opts)
|
|
3113
3226
|
|
|
3114
3227
|
Get a list of the customer profiles that match the given attributes
|
|
3115
3228
|
|
|
3116
|
-
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]:
|
|
3229
|
+
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
|
|
3117
3230
|
|
|
3118
3231
|
### Example
|
|
3232
|
+
|
|
3119
3233
|
```ruby
|
|
3120
3234
|
# load the gem
|
|
3121
3235
|
require 'talon_one'
|
|
@@ -3128,10 +3242,8 @@ TalonOne.configure do |config|
|
|
|
3128
3242
|
end
|
|
3129
3243
|
|
|
3130
3244
|
api_instance = TalonOne::ManagementApi.new
|
|
3131
|
-
|
|
3132
3245
|
body = TalonOne::ApplicationCustomerSearch.new # ApplicationCustomerSearch |
|
|
3133
|
-
|
|
3134
|
-
opts = {
|
|
3246
|
+
opts = {
|
|
3135
3247
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3136
3248
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3137
3249
|
}
|
|
@@ -3147,6 +3259,7 @@ end
|
|
|
3147
3259
|
|
|
3148
3260
|
### Parameters
|
|
3149
3261
|
|
|
3262
|
+
|
|
3150
3263
|
Name | Type | Description | Notes
|
|
3151
3264
|
------------- | ------------- | ------------- | -------------
|
|
3152
3265
|
**body** | [**ApplicationCustomerSearch**](ApplicationCustomerSearch.md)| |
|
|
@@ -3163,19 +3276,20 @@ Name | Type | Description | Notes
|
|
|
3163
3276
|
|
|
3164
3277
|
### HTTP request headers
|
|
3165
3278
|
|
|
3166
|
-
|
|
3167
|
-
|
|
3279
|
+
- **Content-Type**: application/json
|
|
3280
|
+
- **Accept**: application/json
|
|
3168
3281
|
|
|
3169
3282
|
|
|
3283
|
+
## get_event_types
|
|
3170
3284
|
|
|
3171
|
-
|
|
3172
|
-
> InlineResponse20023 get_event_types(opts)
|
|
3285
|
+
> InlineResponse20025 get_event_types(opts)
|
|
3173
3286
|
|
|
3174
3287
|
List Event Types
|
|
3175
3288
|
|
|
3176
3289
|
Fetch all event type definitions for your account. Each event type can be
|
|
3177
3290
|
|
|
3178
3291
|
### Example
|
|
3292
|
+
|
|
3179
3293
|
```ruby
|
|
3180
3294
|
# load the gem
|
|
3181
3295
|
require 'talon_one'
|
|
@@ -3188,11 +3302,10 @@ TalonOne.configure do |config|
|
|
|
3188
3302
|
end
|
|
3189
3303
|
|
|
3190
3304
|
api_instance = TalonOne::ManagementApi.new
|
|
3191
|
-
|
|
3192
|
-
opts = {
|
|
3305
|
+
opts = {
|
|
3193
3306
|
application_ids: 'application_ids_example', # String | Filter by one or more application ids separated by comma
|
|
3194
3307
|
name: 'name_example', # String | Filter results to event types with the given name. This parameter implies `includeOldVersions`.
|
|
3195
|
-
include_old_versions: false, #
|
|
3308
|
+
include_old_versions: false, # Boolean | Include all versions of every event type.
|
|
3196
3309
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3197
3310
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3198
3311
|
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.
|
|
@@ -3209,18 +3322,19 @@ end
|
|
|
3209
3322
|
|
|
3210
3323
|
### Parameters
|
|
3211
3324
|
|
|
3325
|
+
|
|
3212
3326
|
Name | Type | Description | Notes
|
|
3213
3327
|
------------- | ------------- | ------------- | -------------
|
|
3214
3328
|
**application_ids** | **String**| Filter by one or more application ids separated by comma | [optional]
|
|
3215
3329
|
**name** | **String**| Filter results to event types with the given name. This parameter implies `includeOldVersions`. | [optional]
|
|
3216
|
-
**include_old_versions** | **
|
|
3330
|
+
**include_old_versions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
|
|
3217
3331
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
3218
3332
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
3219
3333
|
**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]
|
|
3220
3334
|
|
|
3221
3335
|
### Return type
|
|
3222
3336
|
|
|
3223
|
-
[**
|
|
3337
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
|
3224
3338
|
|
|
3225
3339
|
### Authorization
|
|
3226
3340
|
|
|
@@ -3228,19 +3342,20 @@ Name | Type | Description | Notes
|
|
|
3228
3342
|
|
|
3229
3343
|
### HTTP request headers
|
|
3230
3344
|
|
|
3231
|
-
|
|
3232
|
-
|
|
3345
|
+
- **Content-Type**: Not defined
|
|
3346
|
+
- **Accept**: application/json
|
|
3233
3347
|
|
|
3234
3348
|
|
|
3349
|
+
## get_exports
|
|
3235
3350
|
|
|
3236
|
-
|
|
3237
|
-
> InlineResponse20026 get_exports(opts)
|
|
3351
|
+
> InlineResponse20028 get_exports(opts)
|
|
3238
3352
|
|
|
3239
3353
|
Get Exports
|
|
3240
3354
|
|
|
3241
3355
|
Get a list of all past exports
|
|
3242
3356
|
|
|
3243
3357
|
### Example
|
|
3358
|
+
|
|
3244
3359
|
```ruby
|
|
3245
3360
|
# load the gem
|
|
3246
3361
|
require 'talon_one'
|
|
@@ -3253,8 +3368,7 @@ TalonOne.configure do |config|
|
|
|
3253
3368
|
end
|
|
3254
3369
|
|
|
3255
3370
|
api_instance = TalonOne::ManagementApi.new
|
|
3256
|
-
|
|
3257
|
-
opts = {
|
|
3371
|
+
opts = {
|
|
3258
3372
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3259
3373
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3260
3374
|
application_id: 56, # Integer |
|
|
@@ -3273,6 +3387,7 @@ end
|
|
|
3273
3387
|
|
|
3274
3388
|
### Parameters
|
|
3275
3389
|
|
|
3390
|
+
|
|
3276
3391
|
Name | Type | Description | Notes
|
|
3277
3392
|
------------- | ------------- | ------------- | -------------
|
|
3278
3393
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3283,7 +3398,7 @@ Name | Type | Description | Notes
|
|
|
3283
3398
|
|
|
3284
3399
|
### Return type
|
|
3285
3400
|
|
|
3286
|
-
[**
|
|
3401
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
|
3287
3402
|
|
|
3288
3403
|
### Authorization
|
|
3289
3404
|
|
|
@@ -3291,19 +3406,20 @@ Name | Type | Description | Notes
|
|
|
3291
3406
|
|
|
3292
3407
|
### HTTP request headers
|
|
3293
3408
|
|
|
3294
|
-
|
|
3295
|
-
|
|
3409
|
+
- **Content-Type**: Not defined
|
|
3410
|
+
- **Accept**: application/json
|
|
3296
3411
|
|
|
3297
3412
|
|
|
3413
|
+
## get_imports
|
|
3298
3414
|
|
|
3299
|
-
|
|
3300
|
-
> InlineResponse20027 get_imports(opts)
|
|
3415
|
+
> InlineResponse20029 get_imports(opts)
|
|
3301
3416
|
|
|
3302
3417
|
Get Imports
|
|
3303
3418
|
|
|
3304
3419
|
Get a list of all past imports
|
|
3305
3420
|
|
|
3306
3421
|
### Example
|
|
3422
|
+
|
|
3307
3423
|
```ruby
|
|
3308
3424
|
# load the gem
|
|
3309
3425
|
require 'talon_one'
|
|
@@ -3316,8 +3432,7 @@ TalonOne.configure do |config|
|
|
|
3316
3432
|
end
|
|
3317
3433
|
|
|
3318
3434
|
api_instance = TalonOne::ManagementApi.new
|
|
3319
|
-
|
|
3320
|
-
opts = {
|
|
3435
|
+
opts = {
|
|
3321
3436
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3322
3437
|
skip: 56 # Integer | Skips the given number of items when paging through large result sets.
|
|
3323
3438
|
}
|
|
@@ -3333,6 +3448,7 @@ end
|
|
|
3333
3448
|
|
|
3334
3449
|
### Parameters
|
|
3335
3450
|
|
|
3451
|
+
|
|
3336
3452
|
Name | Type | Description | Notes
|
|
3337
3453
|
------------- | ------------- | ------------- | -------------
|
|
3338
3454
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3340,7 +3456,7 @@ Name | Type | Description | Notes
|
|
|
3340
3456
|
|
|
3341
3457
|
### Return type
|
|
3342
3458
|
|
|
3343
|
-
[**
|
|
3459
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
|
3344
3460
|
|
|
3345
3461
|
### Authorization
|
|
3346
3462
|
|
|
@@ -3348,12 +3464,12 @@ Name | Type | Description | Notes
|
|
|
3348
3464
|
|
|
3349
3465
|
### HTTP request headers
|
|
3350
3466
|
|
|
3351
|
-
|
|
3352
|
-
|
|
3467
|
+
- **Content-Type**: Not defined
|
|
3468
|
+
- **Accept**: application/json
|
|
3353
3469
|
|
|
3354
3470
|
|
|
3471
|
+
## get_loyalty_points
|
|
3355
3472
|
|
|
3356
|
-
# **get_loyalty_points**
|
|
3357
3473
|
> LoyaltyLedger get_loyalty_points(program_id, integration_id)
|
|
3358
3474
|
|
|
3359
3475
|
get the Loyalty Ledger for this integrationID
|
|
@@ -3361,6 +3477,7 @@ get the Loyalty Ledger for this integrationID
|
|
|
3361
3477
|
Get the Loyalty Ledger for this profile integration ID.
|
|
3362
3478
|
|
|
3363
3479
|
### Example
|
|
3480
|
+
|
|
3364
3481
|
```ruby
|
|
3365
3482
|
# load the gem
|
|
3366
3483
|
require 'talon_one'
|
|
@@ -3373,12 +3490,9 @@ TalonOne.configure do |config|
|
|
|
3373
3490
|
end
|
|
3374
3491
|
|
|
3375
3492
|
api_instance = TalonOne::ManagementApi.new
|
|
3376
|
-
|
|
3377
3493
|
program_id = 'program_id_example' # String | The identifier for the application, must be unique within the account.
|
|
3378
|
-
|
|
3379
3494
|
integration_id = 'integration_id_example' # String | The identifier for the application, must be unique within the account.
|
|
3380
3495
|
|
|
3381
|
-
|
|
3382
3496
|
begin
|
|
3383
3497
|
#get the Loyalty Ledger for this integrationID
|
|
3384
3498
|
result = api_instance.get_loyalty_points(program_id, integration_id)
|
|
@@ -3390,6 +3504,7 @@ end
|
|
|
3390
3504
|
|
|
3391
3505
|
### Parameters
|
|
3392
3506
|
|
|
3507
|
+
|
|
3393
3508
|
Name | Type | Description | Notes
|
|
3394
3509
|
------------- | ------------- | ------------- | -------------
|
|
3395
3510
|
**program_id** | **String**| The identifier for the application, must be unique within the account. |
|
|
@@ -3405,19 +3520,70 @@ Name | Type | Description | Notes
|
|
|
3405
3520
|
|
|
3406
3521
|
### HTTP request headers
|
|
3407
3522
|
|
|
3408
|
-
|
|
3409
|
-
|
|
3523
|
+
- **Content-Type**: Not defined
|
|
3524
|
+
- **Accept**: application/json
|
|
3410
3525
|
|
|
3411
3526
|
|
|
3527
|
+
## get_loyalty_program
|
|
3412
3528
|
|
|
3413
|
-
# **get_loyalty_program**
|
|
3414
3529
|
> LoyaltyProgram get_loyalty_program(program_id)
|
|
3415
3530
|
|
|
3416
3531
|
Get a loyalty program
|
|
3417
3532
|
|
|
3533
|
+
### Example
|
|
3534
|
+
|
|
3535
|
+
```ruby
|
|
3536
|
+
# load the gem
|
|
3537
|
+
require 'talon_one'
|
|
3538
|
+
# setup authorization
|
|
3539
|
+
TalonOne.configure do |config|
|
|
3540
|
+
# Configure API key authorization: manager_auth
|
|
3541
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3542
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3543
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3544
|
+
end
|
|
3545
|
+
|
|
3546
|
+
api_instance = TalonOne::ManagementApi.new
|
|
3547
|
+
program_id = 'program_id_example' # String |
|
|
3548
|
+
|
|
3549
|
+
begin
|
|
3550
|
+
#Get a loyalty program
|
|
3551
|
+
result = api_instance.get_loyalty_program(program_id)
|
|
3552
|
+
p result
|
|
3553
|
+
rescue TalonOne::ApiError => e
|
|
3554
|
+
puts "Exception when calling ManagementApi->get_loyalty_program: #{e}"
|
|
3555
|
+
end
|
|
3556
|
+
```
|
|
3557
|
+
|
|
3558
|
+
### Parameters
|
|
3559
|
+
|
|
3560
|
+
|
|
3561
|
+
Name | Type | Description | Notes
|
|
3562
|
+
------------- | ------------- | ------------- | -------------
|
|
3563
|
+
**program_id** | **String**| |
|
|
3564
|
+
|
|
3565
|
+
### Return type
|
|
3566
|
+
|
|
3567
|
+
[**LoyaltyProgram**](LoyaltyProgram.md)
|
|
3568
|
+
|
|
3569
|
+
### Authorization
|
|
3570
|
+
|
|
3571
|
+
[manager_auth](../README.md#manager_auth)
|
|
3572
|
+
|
|
3573
|
+
### HTTP request headers
|
|
3574
|
+
|
|
3575
|
+
- **Content-Type**: Not defined
|
|
3576
|
+
- **Accept**: application/json
|
|
3577
|
+
|
|
3578
|
+
|
|
3579
|
+
## get_loyalty_programs
|
|
3418
3580
|
|
|
3581
|
+
> InlineResponse2008 get_loyalty_programs
|
|
3582
|
+
|
|
3583
|
+
List all loyalty Programs
|
|
3419
3584
|
|
|
3420
3585
|
### Example
|
|
3586
|
+
|
|
3421
3587
|
```ruby
|
|
3422
3588
|
# load the gem
|
|
3423
3589
|
require 'talon_one'
|
|
@@ -3431,27 +3597,22 @@ end
|
|
|
3431
3597
|
|
|
3432
3598
|
api_instance = TalonOne::ManagementApi.new
|
|
3433
3599
|
|
|
3434
|
-
program_id = 'program_id_example' # String |
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
3600
|
begin
|
|
3438
|
-
#
|
|
3439
|
-
result = api_instance.
|
|
3601
|
+
#List all loyalty Programs
|
|
3602
|
+
result = api_instance.get_loyalty_programs
|
|
3440
3603
|
p result
|
|
3441
3604
|
rescue TalonOne::ApiError => e
|
|
3442
|
-
puts "Exception when calling ManagementApi->
|
|
3605
|
+
puts "Exception when calling ManagementApi->get_loyalty_programs: #{e}"
|
|
3443
3606
|
end
|
|
3444
3607
|
```
|
|
3445
3608
|
|
|
3446
3609
|
### Parameters
|
|
3447
3610
|
|
|
3448
|
-
|
|
3449
|
-
------------- | ------------- | ------------- | -------------
|
|
3450
|
-
**program_id** | **String**| |
|
|
3611
|
+
This endpoint does not need any parameter.
|
|
3451
3612
|
|
|
3452
3613
|
### Return type
|
|
3453
3614
|
|
|
3454
|
-
[**
|
|
3615
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
3455
3616
|
|
|
3456
3617
|
### Authorization
|
|
3457
3618
|
|
|
@@ -3459,19 +3620,18 @@ Name | Type | Description | Notes
|
|
|
3459
3620
|
|
|
3460
3621
|
### HTTP request headers
|
|
3461
3622
|
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
|
|
3623
|
+
- **Content-Type**: Not defined
|
|
3624
|
+
- **Accept**: application/json
|
|
3465
3625
|
|
|
3466
3626
|
|
|
3467
|
-
|
|
3468
|
-
> InlineResponse2008 get_loyalty_programs
|
|
3469
|
-
|
|
3470
|
-
List all loyalty Programs
|
|
3627
|
+
## get_loyalty_statistics
|
|
3471
3628
|
|
|
3629
|
+
> LoyaltyStatistics get_loyalty_statistics(program_id)
|
|
3472
3630
|
|
|
3631
|
+
Get loyalty program statistics by loyalty program ID
|
|
3473
3632
|
|
|
3474
3633
|
### Example
|
|
3634
|
+
|
|
3475
3635
|
```ruby
|
|
3476
3636
|
# load the gem
|
|
3477
3637
|
require 'talon_one'
|
|
@@ -3484,22 +3644,27 @@ TalonOne.configure do |config|
|
|
|
3484
3644
|
end
|
|
3485
3645
|
|
|
3486
3646
|
api_instance = TalonOne::ManagementApi.new
|
|
3647
|
+
program_id = 'program_id_example' # String |
|
|
3487
3648
|
|
|
3488
3649
|
begin
|
|
3489
|
-
#
|
|
3490
|
-
result = api_instance.
|
|
3650
|
+
#Get loyalty program statistics by loyalty program ID
|
|
3651
|
+
result = api_instance.get_loyalty_statistics(program_id)
|
|
3491
3652
|
p result
|
|
3492
3653
|
rescue TalonOne::ApiError => e
|
|
3493
|
-
puts "Exception when calling ManagementApi->
|
|
3654
|
+
puts "Exception when calling ManagementApi->get_loyalty_statistics: #{e}"
|
|
3494
3655
|
end
|
|
3495
3656
|
```
|
|
3496
3657
|
|
|
3497
3658
|
### Parameters
|
|
3498
|
-
|
|
3659
|
+
|
|
3660
|
+
|
|
3661
|
+
Name | Type | Description | Notes
|
|
3662
|
+
------------- | ------------- | ------------- | -------------
|
|
3663
|
+
**program_id** | **String**| |
|
|
3499
3664
|
|
|
3500
3665
|
### Return type
|
|
3501
3666
|
|
|
3502
|
-
[**
|
|
3667
|
+
[**LoyaltyStatistics**](LoyaltyStatistics.md)
|
|
3503
3668
|
|
|
3504
3669
|
### Authorization
|
|
3505
3670
|
|
|
@@ -3507,19 +3672,18 @@ This endpoint does not need any parameter.
|
|
|
3507
3672
|
|
|
3508
3673
|
### HTTP request headers
|
|
3509
3674
|
|
|
3510
|
-
|
|
3511
|
-
|
|
3675
|
+
- **Content-Type**: Not defined
|
|
3676
|
+
- **Accept**: application/json
|
|
3512
3677
|
|
|
3513
3678
|
|
|
3679
|
+
## get_referrals
|
|
3514
3680
|
|
|
3515
|
-
# **get_referrals**
|
|
3516
3681
|
> InlineResponse2006 get_referrals(application_id, campaign_id, opts)
|
|
3517
3682
|
|
|
3518
|
-
List Referrals
|
|
3519
|
-
|
|
3520
|
-
|
|
3683
|
+
List Referrals (with total count)
|
|
3521
3684
|
|
|
3522
3685
|
### Example
|
|
3686
|
+
|
|
3523
3687
|
```ruby
|
|
3524
3688
|
# load the gem
|
|
3525
3689
|
require 'talon_one'
|
|
@@ -3532,12 +3696,9 @@ TalonOne.configure do |config|
|
|
|
3532
3696
|
end
|
|
3533
3697
|
|
|
3534
3698
|
api_instance = TalonOne::ManagementApi.new
|
|
3535
|
-
|
|
3536
3699
|
application_id = 56 # Integer |
|
|
3537
|
-
|
|
3538
3700
|
campaign_id = 56 # Integer |
|
|
3539
|
-
|
|
3540
|
-
opts = {
|
|
3701
|
+
opts = {
|
|
3541
3702
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3542
3703
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3543
3704
|
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.
|
|
@@ -3550,7 +3711,7 @@ opts = {
|
|
|
3550
3711
|
}
|
|
3551
3712
|
|
|
3552
3713
|
begin
|
|
3553
|
-
#List Referrals
|
|
3714
|
+
#List Referrals (with total count)
|
|
3554
3715
|
result = api_instance.get_referrals(application_id, campaign_id, opts)
|
|
3555
3716
|
p result
|
|
3556
3717
|
rescue TalonOne::ApiError => e
|
|
@@ -3560,6 +3721,7 @@ end
|
|
|
3560
3721
|
|
|
3561
3722
|
### Parameters
|
|
3562
3723
|
|
|
3724
|
+
|
|
3563
3725
|
Name | Type | Description | Notes
|
|
3564
3726
|
------------- | ------------- | ------------- | -------------
|
|
3565
3727
|
**application_id** | **Integer**| |
|
|
@@ -3584,19 +3746,18 @@ Name | Type | Description | Notes
|
|
|
3584
3746
|
|
|
3585
3747
|
### HTTP request headers
|
|
3586
3748
|
|
|
3587
|
-
|
|
3588
|
-
|
|
3749
|
+
- **Content-Type**: Not defined
|
|
3750
|
+
- **Accept**: application/json
|
|
3589
3751
|
|
|
3590
3752
|
|
|
3753
|
+
## get_referrals_without_total_count
|
|
3591
3754
|
|
|
3592
|
-
# **get_referrals_without_total_count**
|
|
3593
3755
|
> InlineResponse2007 get_referrals_without_total_count(application_id, campaign_id, opts)
|
|
3594
3756
|
|
|
3595
3757
|
List Referrals
|
|
3596
3758
|
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
3759
|
### Example
|
|
3760
|
+
|
|
3600
3761
|
```ruby
|
|
3601
3762
|
# load the gem
|
|
3602
3763
|
require 'talon_one'
|
|
@@ -3609,12 +3770,9 @@ TalonOne.configure do |config|
|
|
|
3609
3770
|
end
|
|
3610
3771
|
|
|
3611
3772
|
api_instance = TalonOne::ManagementApi.new
|
|
3612
|
-
|
|
3613
3773
|
application_id = 56 # Integer |
|
|
3614
|
-
|
|
3615
3774
|
campaign_id = 56 # Integer |
|
|
3616
|
-
|
|
3617
|
-
opts = {
|
|
3775
|
+
opts = {
|
|
3618
3776
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3619
3777
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3620
3778
|
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.
|
|
@@ -3637,6 +3795,7 @@ end
|
|
|
3637
3795
|
|
|
3638
3796
|
### Parameters
|
|
3639
3797
|
|
|
3798
|
+
|
|
3640
3799
|
Name | Type | Description | Notes
|
|
3641
3800
|
------------- | ------------- | ------------- | -------------
|
|
3642
3801
|
**application_id** | **Integer**| |
|
|
@@ -3661,17 +3820,18 @@ Name | Type | Description | Notes
|
|
|
3661
3820
|
|
|
3662
3821
|
### HTTP request headers
|
|
3663
3822
|
|
|
3664
|
-
|
|
3665
|
-
|
|
3823
|
+
- **Content-Type**: Not defined
|
|
3824
|
+
- **Accept**: application/json
|
|
3666
3825
|
|
|
3667
3826
|
|
|
3827
|
+
## get_role
|
|
3668
3828
|
|
|
3669
|
-
# **get_role**
|
|
3670
3829
|
> Role get_role(role_id)
|
|
3671
3830
|
|
|
3672
3831
|
Get information for the specified role.
|
|
3673
3832
|
|
|
3674
3833
|
### Example
|
|
3834
|
+
|
|
3675
3835
|
```ruby
|
|
3676
3836
|
# load the gem
|
|
3677
3837
|
require 'talon_one'
|
|
@@ -3684,10 +3844,8 @@ TalonOne.configure do |config|
|
|
|
3684
3844
|
end
|
|
3685
3845
|
|
|
3686
3846
|
api_instance = TalonOne::ManagementApi.new
|
|
3687
|
-
|
|
3688
3847
|
role_id = 56 # Integer |
|
|
3689
3848
|
|
|
3690
|
-
|
|
3691
3849
|
begin
|
|
3692
3850
|
#Get information for the specified role.
|
|
3693
3851
|
result = api_instance.get_role(role_id)
|
|
@@ -3699,6 +3857,7 @@ end
|
|
|
3699
3857
|
|
|
3700
3858
|
### Parameters
|
|
3701
3859
|
|
|
3860
|
+
|
|
3702
3861
|
Name | Type | Description | Notes
|
|
3703
3862
|
------------- | ------------- | ------------- | -------------
|
|
3704
3863
|
**role_id** | **Integer**| |
|
|
@@ -3713,19 +3872,18 @@ Name | Type | Description | Notes
|
|
|
3713
3872
|
|
|
3714
3873
|
### HTTP request headers
|
|
3715
3874
|
|
|
3716
|
-
|
|
3717
|
-
|
|
3875
|
+
- **Content-Type**: Not defined
|
|
3876
|
+
- **Accept**: application/json
|
|
3718
3877
|
|
|
3719
3878
|
|
|
3879
|
+
## get_ruleset
|
|
3720
3880
|
|
|
3721
|
-
# **get_ruleset**
|
|
3722
3881
|
> Ruleset get_ruleset(application_id, campaign_id, ruleset_id)
|
|
3723
3882
|
|
|
3724
3883
|
Get a Ruleset
|
|
3725
3884
|
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
3885
|
### Example
|
|
3886
|
+
|
|
3729
3887
|
```ruby
|
|
3730
3888
|
# load the gem
|
|
3731
3889
|
require 'talon_one'
|
|
@@ -3738,14 +3896,10 @@ TalonOne.configure do |config|
|
|
|
3738
3896
|
end
|
|
3739
3897
|
|
|
3740
3898
|
api_instance = TalonOne::ManagementApi.new
|
|
3741
|
-
|
|
3742
3899
|
application_id = 56 # Integer |
|
|
3743
|
-
|
|
3744
3900
|
campaign_id = 56 # Integer |
|
|
3745
|
-
|
|
3746
3901
|
ruleset_id = 56 # Integer |
|
|
3747
3902
|
|
|
3748
|
-
|
|
3749
3903
|
begin
|
|
3750
3904
|
#Get a Ruleset
|
|
3751
3905
|
result = api_instance.get_ruleset(application_id, campaign_id, ruleset_id)
|
|
@@ -3757,6 +3911,7 @@ end
|
|
|
3757
3911
|
|
|
3758
3912
|
### Parameters
|
|
3759
3913
|
|
|
3914
|
+
|
|
3760
3915
|
Name | Type | Description | Notes
|
|
3761
3916
|
------------- | ------------- | ------------- | -------------
|
|
3762
3917
|
**application_id** | **Integer**| |
|
|
@@ -3773,19 +3928,18 @@ Name | Type | Description | Notes
|
|
|
3773
3928
|
|
|
3774
3929
|
### HTTP request headers
|
|
3775
3930
|
|
|
3776
|
-
|
|
3777
|
-
|
|
3931
|
+
- **Content-Type**: Not defined
|
|
3932
|
+
- **Accept**: application/json
|
|
3778
3933
|
|
|
3779
3934
|
|
|
3935
|
+
## get_rulesets
|
|
3780
3936
|
|
|
3781
|
-
|
|
3782
|
-
> InlineResponse2004 get_rulesets(application_id, campaign_id, opts)
|
|
3937
|
+
> InlineResponse2003 get_rulesets(application_id, campaign_id, opts)
|
|
3783
3938
|
|
|
3784
3939
|
List Campaign Rulesets
|
|
3785
3940
|
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
3941
|
### Example
|
|
3942
|
+
|
|
3789
3943
|
```ruby
|
|
3790
3944
|
# load the gem
|
|
3791
3945
|
require 'talon_one'
|
|
@@ -3798,12 +3952,9 @@ TalonOne.configure do |config|
|
|
|
3798
3952
|
end
|
|
3799
3953
|
|
|
3800
3954
|
api_instance = TalonOne::ManagementApi.new
|
|
3801
|
-
|
|
3802
3955
|
application_id = 56 # Integer |
|
|
3803
|
-
|
|
3804
3956
|
campaign_id = 56 # Integer |
|
|
3805
|
-
|
|
3806
|
-
opts = {
|
|
3957
|
+
opts = {
|
|
3807
3958
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3808
3959
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3809
3960
|
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.
|
|
@@ -3820,6 +3971,7 @@ end
|
|
|
3820
3971
|
|
|
3821
3972
|
### Parameters
|
|
3822
3973
|
|
|
3974
|
+
|
|
3823
3975
|
Name | Type | Description | Notes
|
|
3824
3976
|
------------- | ------------- | ------------- | -------------
|
|
3825
3977
|
**application_id** | **Integer**| |
|
|
@@ -3830,7 +3982,7 @@ Name | Type | Description | Notes
|
|
|
3830
3982
|
|
|
3831
3983
|
### Return type
|
|
3832
3984
|
|
|
3833
|
-
[**
|
|
3985
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
|
3834
3986
|
|
|
3835
3987
|
### Authorization
|
|
3836
3988
|
|
|
@@ -3838,12 +3990,12 @@ Name | Type | Description | Notes
|
|
|
3838
3990
|
|
|
3839
3991
|
### HTTP request headers
|
|
3840
3992
|
|
|
3841
|
-
|
|
3842
|
-
|
|
3993
|
+
- **Content-Type**: Not defined
|
|
3994
|
+
- **Accept**: application/json
|
|
3843
3995
|
|
|
3844
3996
|
|
|
3997
|
+
## get_user
|
|
3845
3998
|
|
|
3846
|
-
# **get_user**
|
|
3847
3999
|
> User get_user(user_id)
|
|
3848
4000
|
|
|
3849
4001
|
Get a single User
|
|
@@ -3851,6 +4003,7 @@ Get a single User
|
|
|
3851
4003
|
Retrieves the data (including an invitation code) for a user. Non-admin users can only get themselves.
|
|
3852
4004
|
|
|
3853
4005
|
### Example
|
|
4006
|
+
|
|
3854
4007
|
```ruby
|
|
3855
4008
|
# load the gem
|
|
3856
4009
|
require 'talon_one'
|
|
@@ -3863,10 +4016,8 @@ TalonOne.configure do |config|
|
|
|
3863
4016
|
end
|
|
3864
4017
|
|
|
3865
4018
|
api_instance = TalonOne::ManagementApi.new
|
|
3866
|
-
|
|
3867
4019
|
user_id = 56 # Integer |
|
|
3868
4020
|
|
|
3869
|
-
|
|
3870
4021
|
begin
|
|
3871
4022
|
#Get a single User
|
|
3872
4023
|
result = api_instance.get_user(user_id)
|
|
@@ -3878,6 +4029,7 @@ end
|
|
|
3878
4029
|
|
|
3879
4030
|
### Parameters
|
|
3880
4031
|
|
|
4032
|
+
|
|
3881
4033
|
Name | Type | Description | Notes
|
|
3882
4034
|
------------- | ------------- | ------------- | -------------
|
|
3883
4035
|
**user_id** | **Integer**| |
|
|
@@ -3892,19 +4044,20 @@ Name | Type | Description | Notes
|
|
|
3892
4044
|
|
|
3893
4045
|
### HTTP request headers
|
|
3894
4046
|
|
|
3895
|
-
|
|
3896
|
-
|
|
4047
|
+
- **Content-Type**: Not defined
|
|
4048
|
+
- **Accept**: application/json
|
|
3897
4049
|
|
|
3898
4050
|
|
|
4051
|
+
## get_users
|
|
3899
4052
|
|
|
3900
|
-
|
|
3901
|
-
> InlineResponse20024 get_users(opts)
|
|
4053
|
+
> InlineResponse20026 get_users(opts)
|
|
3902
4054
|
|
|
3903
4055
|
List Users in your account
|
|
3904
4056
|
|
|
3905
4057
|
Retrieve all users in your account.
|
|
3906
4058
|
|
|
3907
4059
|
### Example
|
|
4060
|
+
|
|
3908
4061
|
```ruby
|
|
3909
4062
|
# load the gem
|
|
3910
4063
|
require 'talon_one'
|
|
@@ -3917,8 +4070,7 @@ TalonOne.configure do |config|
|
|
|
3917
4070
|
end
|
|
3918
4071
|
|
|
3919
4072
|
api_instance = TalonOne::ManagementApi.new
|
|
3920
|
-
|
|
3921
|
-
opts = {
|
|
4073
|
+
opts = {
|
|
3922
4074
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
3923
4075
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
3924
4076
|
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.
|
|
@@ -3935,6 +4087,7 @@ end
|
|
|
3935
4087
|
|
|
3936
4088
|
### Parameters
|
|
3937
4089
|
|
|
4090
|
+
|
|
3938
4091
|
Name | Type | Description | Notes
|
|
3939
4092
|
------------- | ------------- | ------------- | -------------
|
|
3940
4093
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -3943,7 +4096,7 @@ Name | Type | Description | Notes
|
|
|
3943
4096
|
|
|
3944
4097
|
### Return type
|
|
3945
4098
|
|
|
3946
|
-
[**
|
|
4099
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
|
3947
4100
|
|
|
3948
4101
|
### Authorization
|
|
3949
4102
|
|
|
@@ -3951,12 +4104,12 @@ Name | Type | Description | Notes
|
|
|
3951
4104
|
|
|
3952
4105
|
### HTTP request headers
|
|
3953
4106
|
|
|
3954
|
-
|
|
3955
|
-
|
|
4107
|
+
- **Content-Type**: Not defined
|
|
4108
|
+
- **Accept**: application/json
|
|
3956
4109
|
|
|
3957
4110
|
|
|
4111
|
+
## get_webhook
|
|
3958
4112
|
|
|
3959
|
-
# **get_webhook**
|
|
3960
4113
|
> Webhook get_webhook(webhook_id)
|
|
3961
4114
|
|
|
3962
4115
|
Get Webhook
|
|
@@ -3964,6 +4117,7 @@ Get Webhook
|
|
|
3964
4117
|
Returns an webhook by its id.
|
|
3965
4118
|
|
|
3966
4119
|
### Example
|
|
4120
|
+
|
|
3967
4121
|
```ruby
|
|
3968
4122
|
# load the gem
|
|
3969
4123
|
require 'talon_one'
|
|
@@ -3976,10 +4130,8 @@ TalonOne.configure do |config|
|
|
|
3976
4130
|
end
|
|
3977
4131
|
|
|
3978
4132
|
api_instance = TalonOne::ManagementApi.new
|
|
3979
|
-
|
|
3980
4133
|
webhook_id = 56 # Integer |
|
|
3981
4134
|
|
|
3982
|
-
|
|
3983
4135
|
begin
|
|
3984
4136
|
#Get Webhook
|
|
3985
4137
|
result = api_instance.get_webhook(webhook_id)
|
|
@@ -3991,6 +4143,7 @@ end
|
|
|
3991
4143
|
|
|
3992
4144
|
### Parameters
|
|
3993
4145
|
|
|
4146
|
+
|
|
3994
4147
|
Name | Type | Description | Notes
|
|
3995
4148
|
------------- | ------------- | ------------- | -------------
|
|
3996
4149
|
**webhook_id** | **Integer**| |
|
|
@@ -4005,19 +4158,20 @@ Name | Type | Description | Notes
|
|
|
4005
4158
|
|
|
4006
4159
|
### HTTP request headers
|
|
4007
4160
|
|
|
4008
|
-
|
|
4009
|
-
|
|
4161
|
+
- **Content-Type**: Not defined
|
|
4162
|
+
- **Accept**: application/json
|
|
4010
4163
|
|
|
4011
4164
|
|
|
4165
|
+
## get_webhook_activation_logs
|
|
4012
4166
|
|
|
4013
|
-
|
|
4014
|
-
> InlineResponse20021 get_webhook_activation_logs(opts)
|
|
4167
|
+
> InlineResponse20023 get_webhook_activation_logs(opts)
|
|
4015
4168
|
|
|
4016
4169
|
List Webhook activation Log Entries
|
|
4017
4170
|
|
|
4018
4171
|
Webhook activation log entries would be created as soon as an integration request triggered an effect with a webhook
|
|
4019
4172
|
|
|
4020
4173
|
### Example
|
|
4174
|
+
|
|
4021
4175
|
```ruby
|
|
4022
4176
|
# load the gem
|
|
4023
4177
|
require 'talon_one'
|
|
@@ -4030,15 +4184,14 @@ TalonOne.configure do |config|
|
|
|
4030
4184
|
end
|
|
4031
4185
|
|
|
4032
4186
|
api_instance = TalonOne::ManagementApi.new
|
|
4033
|
-
|
|
4034
|
-
opts = {
|
|
4187
|
+
opts = {
|
|
4035
4188
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4036
4189
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4037
4190
|
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.
|
|
4038
4191
|
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
|
4039
|
-
webhook_id:
|
|
4040
|
-
application_id:
|
|
4041
|
-
campaign_id:
|
|
4192
|
+
webhook_id: 3.4, # Float | Filter results by Webhook.
|
|
4193
|
+
application_id: 3.4, # Float |
|
|
4194
|
+
campaign_id: 3.4, # Float | Filter results by campaign.
|
|
4042
4195
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date.
|
|
4043
4196
|
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.
|
|
4044
4197
|
}
|
|
@@ -4054,6 +4207,7 @@ end
|
|
|
4054
4207
|
|
|
4055
4208
|
### Parameters
|
|
4056
4209
|
|
|
4210
|
+
|
|
4057
4211
|
Name | Type | Description | Notes
|
|
4058
4212
|
------------- | ------------- | ------------- | -------------
|
|
4059
4213
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -4068,7 +4222,7 @@ Name | Type | Description | Notes
|
|
|
4068
4222
|
|
|
4069
4223
|
### Return type
|
|
4070
4224
|
|
|
4071
|
-
[**
|
|
4225
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
|
4072
4226
|
|
|
4073
4227
|
### Authorization
|
|
4074
4228
|
|
|
@@ -4076,19 +4230,18 @@ Name | Type | Description | Notes
|
|
|
4076
4230
|
|
|
4077
4231
|
### HTTP request headers
|
|
4078
4232
|
|
|
4079
|
-
|
|
4080
|
-
|
|
4233
|
+
- **Content-Type**: Not defined
|
|
4234
|
+
- **Accept**: application/json
|
|
4081
4235
|
|
|
4082
4236
|
|
|
4237
|
+
## get_webhook_logs
|
|
4083
4238
|
|
|
4084
|
-
|
|
4085
|
-
> InlineResponse20022 get_webhook_logs(opts)
|
|
4239
|
+
> InlineResponse20024 get_webhook_logs(opts)
|
|
4086
4240
|
|
|
4087
4241
|
List Webhook Log Entries
|
|
4088
4242
|
|
|
4089
|
-
|
|
4090
|
-
|
|
4091
4243
|
### Example
|
|
4244
|
+
|
|
4092
4245
|
```ruby
|
|
4093
4246
|
# load the gem
|
|
4094
4247
|
require 'talon_one'
|
|
@@ -4101,15 +4254,14 @@ TalonOne.configure do |config|
|
|
|
4101
4254
|
end
|
|
4102
4255
|
|
|
4103
4256
|
api_instance = TalonOne::ManagementApi.new
|
|
4104
|
-
|
|
4105
|
-
opts = {
|
|
4257
|
+
opts = {
|
|
4106
4258
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4107
4259
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4108
4260
|
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.
|
|
4109
4261
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
4110
|
-
webhook_id:
|
|
4111
|
-
application_id:
|
|
4112
|
-
campaign_id:
|
|
4262
|
+
webhook_id: 3.4, # Float | Filter results by Webhook.
|
|
4263
|
+
application_id: 3.4, # Float |
|
|
4264
|
+
campaign_id: 3.4, # Float | Filter results by campaign.
|
|
4113
4265
|
request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
|
|
4114
4266
|
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.
|
|
4115
4267
|
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.
|
|
@@ -4126,6 +4278,7 @@ end
|
|
|
4126
4278
|
|
|
4127
4279
|
### Parameters
|
|
4128
4280
|
|
|
4281
|
+
|
|
4129
4282
|
Name | Type | Description | Notes
|
|
4130
4283
|
------------- | ------------- | ------------- | -------------
|
|
4131
4284
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
@@ -4141,7 +4294,7 @@ Name | Type | Description | Notes
|
|
|
4141
4294
|
|
|
4142
4295
|
### Return type
|
|
4143
4296
|
|
|
4144
|
-
[**
|
|
4297
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
|
4145
4298
|
|
|
4146
4299
|
### Authorization
|
|
4147
4300
|
|
|
@@ -4149,19 +4302,18 @@ Name | Type | Description | Notes
|
|
|
4149
4302
|
|
|
4150
4303
|
### HTTP request headers
|
|
4151
4304
|
|
|
4152
|
-
|
|
4153
|
-
|
|
4305
|
+
- **Content-Type**: Not defined
|
|
4306
|
+
- **Accept**: application/json
|
|
4154
4307
|
|
|
4155
4308
|
|
|
4309
|
+
## get_webhooks
|
|
4156
4310
|
|
|
4157
|
-
|
|
4158
|
-
> InlineResponse20020 get_webhooks(opts)
|
|
4311
|
+
> InlineResponse20022 get_webhooks(opts)
|
|
4159
4312
|
|
|
4160
4313
|
List Webhooks
|
|
4161
4314
|
|
|
4162
|
-
|
|
4163
|
-
|
|
4164
4315
|
### Example
|
|
4316
|
+
|
|
4165
4317
|
```ruby
|
|
4166
4318
|
# load the gem
|
|
4167
4319
|
require 'talon_one'
|
|
@@ -4174,8 +4326,7 @@ TalonOne.configure do |config|
|
|
|
4174
4326
|
end
|
|
4175
4327
|
|
|
4176
4328
|
api_instance = TalonOne::ManagementApi.new
|
|
4177
|
-
|
|
4178
|
-
opts = {
|
|
4329
|
+
opts = {
|
|
4179
4330
|
application_ids: 'application_ids_example', # String | Filter by one or more application ids separated by comma
|
|
4180
4331
|
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.
|
|
4181
4332
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
@@ -4193,6 +4344,7 @@ end
|
|
|
4193
4344
|
|
|
4194
4345
|
### Parameters
|
|
4195
4346
|
|
|
4347
|
+
|
|
4196
4348
|
Name | Type | Description | Notes
|
|
4197
4349
|
------------- | ------------- | ------------- | -------------
|
|
4198
4350
|
**application_ids** | **String**| Filter by one or more application ids separated by comma | [optional]
|
|
@@ -4202,54 +4354,7 @@ Name | Type | Description | Notes
|
|
|
4202
4354
|
|
|
4203
4355
|
### Return type
|
|
4204
4356
|
|
|
4205
|
-
[**
|
|
4206
|
-
|
|
4207
|
-
### Authorization
|
|
4208
|
-
|
|
4209
|
-
[manager_auth](../README.md#manager_auth)
|
|
4210
|
-
|
|
4211
|
-
### HTTP request headers
|
|
4212
|
-
|
|
4213
|
-
- **Content-Type**: application/json
|
|
4214
|
-
- **Accept**: application/json
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
# **refresh_analytics**
|
|
4219
|
-
> refresh_analytics
|
|
4220
|
-
|
|
4221
|
-
Trigger refresh on stale analytics.
|
|
4222
|
-
|
|
4223
|
-
Should be used to trigger a manual refresh of analytics.
|
|
4224
|
-
|
|
4225
|
-
### Example
|
|
4226
|
-
```ruby
|
|
4227
|
-
# load the gem
|
|
4228
|
-
require 'talon_one'
|
|
4229
|
-
# setup authorization
|
|
4230
|
-
TalonOne.configure do |config|
|
|
4231
|
-
# Configure API key authorization: manager_auth
|
|
4232
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4233
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4234
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4235
|
-
end
|
|
4236
|
-
|
|
4237
|
-
api_instance = TalonOne::ManagementApi.new
|
|
4238
|
-
|
|
4239
|
-
begin
|
|
4240
|
-
#Trigger refresh on stale analytics.
|
|
4241
|
-
api_instance.refresh_analytics
|
|
4242
|
-
rescue TalonOne::ApiError => e
|
|
4243
|
-
puts "Exception when calling ManagementApi->refresh_analytics: #{e}"
|
|
4244
|
-
end
|
|
4245
|
-
```
|
|
4246
|
-
|
|
4247
|
-
### Parameters
|
|
4248
|
-
This endpoint does not need any parameter.
|
|
4249
|
-
|
|
4250
|
-
### Return type
|
|
4251
|
-
|
|
4252
|
-
nil (empty response body)
|
|
4357
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
|
4253
4358
|
|
|
4254
4359
|
### Authorization
|
|
4255
4360
|
|
|
@@ -4257,19 +4362,18 @@ nil (empty response body)
|
|
|
4257
4362
|
|
|
4258
4363
|
### HTTP request headers
|
|
4259
4364
|
|
|
4260
|
-
|
|
4261
|
-
|
|
4365
|
+
- **Content-Type**: Not defined
|
|
4366
|
+
- **Accept**: application/json
|
|
4262
4367
|
|
|
4263
4368
|
|
|
4369
|
+
## remove_loyalty_points
|
|
4264
4370
|
|
|
4265
|
-
# **remove_loyalty_points**
|
|
4266
4371
|
> remove_loyalty_points(program_id, integration_id, body)
|
|
4267
4372
|
|
|
4268
4373
|
Deduct points in a certain loyalty program for the specified customer
|
|
4269
4374
|
|
|
4270
|
-
|
|
4271
|
-
|
|
4272
4375
|
### Example
|
|
4376
|
+
|
|
4273
4377
|
```ruby
|
|
4274
4378
|
# load the gem
|
|
4275
4379
|
require 'talon_one'
|
|
@@ -4282,14 +4386,10 @@ TalonOne.configure do |config|
|
|
|
4282
4386
|
end
|
|
4283
4387
|
|
|
4284
4388
|
api_instance = TalonOne::ManagementApi.new
|
|
4285
|
-
|
|
4286
4389
|
program_id = 'program_id_example' # String |
|
|
4287
|
-
|
|
4288
4390
|
integration_id = 'integration_id_example' # String |
|
|
4289
|
-
|
|
4290
4391
|
body = TalonOne::LoyaltyPoints.new # LoyaltyPoints |
|
|
4291
4392
|
|
|
4292
|
-
|
|
4293
4393
|
begin
|
|
4294
4394
|
#Deduct points in a certain loyalty program for the specified customer
|
|
4295
4395
|
api_instance.remove_loyalty_points(program_id, integration_id, body)
|
|
@@ -4300,6 +4400,7 @@ end
|
|
|
4300
4400
|
|
|
4301
4401
|
### Parameters
|
|
4302
4402
|
|
|
4403
|
+
|
|
4303
4404
|
Name | Type | Description | Notes
|
|
4304
4405
|
------------- | ------------- | ------------- | -------------
|
|
4305
4406
|
**program_id** | **String**| |
|
|
@@ -4316,12 +4417,12 @@ nil (empty response body)
|
|
|
4316
4417
|
|
|
4317
4418
|
### HTTP request headers
|
|
4318
4419
|
|
|
4319
|
-
|
|
4320
|
-
|
|
4420
|
+
- **Content-Type**: application/json
|
|
4421
|
+
- **Accept**: Not defined
|
|
4321
4422
|
|
|
4322
4423
|
|
|
4424
|
+
## reset_password
|
|
4323
4425
|
|
|
4324
|
-
# **reset_password**
|
|
4325
4426
|
> NewPassword reset_password(body)
|
|
4326
4427
|
|
|
4327
4428
|
Reset password
|
|
@@ -4329,6 +4430,7 @@ Reset password
|
|
|
4329
4430
|
Consumes the supplied password reset token and updates the password for the associated account.
|
|
4330
4431
|
|
|
4331
4432
|
### Example
|
|
4433
|
+
|
|
4332
4434
|
```ruby
|
|
4333
4435
|
# load the gem
|
|
4334
4436
|
require 'talon_one'
|
|
@@ -4341,10 +4443,8 @@ TalonOne.configure do |config|
|
|
|
4341
4443
|
end
|
|
4342
4444
|
|
|
4343
4445
|
api_instance = TalonOne::ManagementApi.new
|
|
4344
|
-
|
|
4345
4446
|
body = TalonOne::NewPassword.new # NewPassword |
|
|
4346
4447
|
|
|
4347
|
-
|
|
4348
4448
|
begin
|
|
4349
4449
|
#Reset password
|
|
4350
4450
|
result = api_instance.reset_password(body)
|
|
@@ -4356,6 +4456,7 @@ end
|
|
|
4356
4456
|
|
|
4357
4457
|
### Parameters
|
|
4358
4458
|
|
|
4459
|
+
|
|
4359
4460
|
Name | Type | Description | Notes
|
|
4360
4461
|
------------- | ------------- | ------------- | -------------
|
|
4361
4462
|
**body** | [**NewPassword**](NewPassword.md)| |
|
|
@@ -4370,19 +4471,20 @@ Name | Type | Description | Notes
|
|
|
4370
4471
|
|
|
4371
4472
|
### HTTP request headers
|
|
4372
4473
|
|
|
4373
|
-
|
|
4374
|
-
|
|
4474
|
+
- **Content-Type**: application/json
|
|
4475
|
+
- **Accept**: application/json
|
|
4375
4476
|
|
|
4376
4477
|
|
|
4478
|
+
## search_coupons_advanced
|
|
4377
4479
|
|
|
4378
|
-
|
|
4379
|
-
> InlineResponse2001 search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4480
|
+
> InlineResponse2004 search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4380
4481
|
|
|
4381
|
-
Get a list of the coupons that match the given attributes
|
|
4482
|
+
Get a list of the coupons that match the given attributes (with total count)
|
|
4382
4483
|
|
|
4383
4484
|
Gets a list of all the coupons with attributes matching the query criteria
|
|
4384
4485
|
|
|
4385
4486
|
### Example
|
|
4487
|
+
|
|
4386
4488
|
```ruby
|
|
4387
4489
|
# load the gem
|
|
4388
4490
|
require 'talon_one'
|
|
@@ -4395,14 +4497,10 @@ TalonOne.configure do |config|
|
|
|
4395
4497
|
end
|
|
4396
4498
|
|
|
4397
4499
|
api_instance = TalonOne::ManagementApi.new
|
|
4398
|
-
|
|
4399
4500
|
application_id = 56 # Integer |
|
|
4400
|
-
|
|
4401
4501
|
campaign_id = 56 # Integer |
|
|
4402
|
-
|
|
4403
|
-
|
|
4404
|
-
|
|
4405
|
-
opts = {
|
|
4502
|
+
body = nil # Object |
|
|
4503
|
+
opts = {
|
|
4406
4504
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4407
4505
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4408
4506
|
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.
|
|
@@ -4413,12 +4511,12 @@ opts = {
|
|
|
4413
4511
|
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`.
|
|
4414
4512
|
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.
|
|
4415
4513
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4416
|
-
exact_match: false, #
|
|
4514
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4417
4515
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
4418
4516
|
}
|
|
4419
4517
|
|
|
4420
4518
|
begin
|
|
4421
|
-
#Get a list of the coupons that match the given attributes
|
|
4519
|
+
#Get a list of the coupons that match the given attributes (with total count)
|
|
4422
4520
|
result = api_instance.search_coupons_advanced(application_id, campaign_id, body, opts)
|
|
4423
4521
|
p result
|
|
4424
4522
|
rescue TalonOne::ApiError => e
|
|
@@ -4428,11 +4526,12 @@ end
|
|
|
4428
4526
|
|
|
4429
4527
|
### Parameters
|
|
4430
4528
|
|
|
4529
|
+
|
|
4431
4530
|
Name | Type | Description | Notes
|
|
4432
4531
|
------------- | ------------- | ------------- | -------------
|
|
4433
4532
|
**application_id** | **Integer**| |
|
|
4434
4533
|
**campaign_id** | **Integer**| |
|
|
4435
|
-
**body** |
|
|
4534
|
+
**body** | **Object**| |
|
|
4436
4535
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4437
4536
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4438
4537
|
**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]
|
|
@@ -4443,12 +4542,12 @@ Name | Type | Description | Notes
|
|
|
4443
4542
|
**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]
|
|
4444
4543
|
**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]
|
|
4445
4544
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4446
|
-
**exact_match** | **
|
|
4545
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4447
4546
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4448
4547
|
|
|
4449
4548
|
### Return type
|
|
4450
4549
|
|
|
4451
|
-
[**
|
|
4550
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
4452
4551
|
|
|
4453
4552
|
### Authorization
|
|
4454
4553
|
|
|
@@ -4456,19 +4555,20 @@ Name | Type | Description | Notes
|
|
|
4456
4555
|
|
|
4457
4556
|
### HTTP request headers
|
|
4458
4557
|
|
|
4459
|
-
|
|
4460
|
-
|
|
4558
|
+
- **Content-Type**: application/json
|
|
4559
|
+
- **Accept**: application/json
|
|
4461
4560
|
|
|
4462
4561
|
|
|
4562
|
+
## search_coupons_advanced_application_wide
|
|
4463
4563
|
|
|
4464
|
-
|
|
4465
|
-
> InlineResponse2001 search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4564
|
+
> InlineResponse2004 search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4466
4565
|
|
|
4467
|
-
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
4566
|
+
Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
4468
4567
|
|
|
4469
4568
|
Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
|
4470
4569
|
|
|
4471
4570
|
### Example
|
|
4571
|
+
|
|
4472
4572
|
```ruby
|
|
4473
4573
|
# load the gem
|
|
4474
4574
|
require 'talon_one'
|
|
@@ -4481,12 +4581,9 @@ TalonOne.configure do |config|
|
|
|
4481
4581
|
end
|
|
4482
4582
|
|
|
4483
4583
|
api_instance = TalonOne::ManagementApi.new
|
|
4484
|
-
|
|
4485
4584
|
application_id = 56 # Integer |
|
|
4486
|
-
|
|
4487
|
-
|
|
4488
|
-
|
|
4489
|
-
opts = {
|
|
4585
|
+
body = nil # Object |
|
|
4586
|
+
opts = {
|
|
4490
4587
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4491
4588
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4492
4589
|
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.
|
|
@@ -4498,12 +4595,12 @@ opts = {
|
|
|
4498
4595
|
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.
|
|
4499
4596
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4500
4597
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
4501
|
-
exact_match: false, #
|
|
4598
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4502
4599
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
4503
4600
|
}
|
|
4504
4601
|
|
|
4505
4602
|
begin
|
|
4506
|
-
#Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
4603
|
+
#Get a list of the coupons that match the given attributes in all active campaigns of an application (with total count)
|
|
4507
4604
|
result = api_instance.search_coupons_advanced_application_wide(application_id, body, opts)
|
|
4508
4605
|
p result
|
|
4509
4606
|
rescue TalonOne::ApiError => e
|
|
@@ -4513,10 +4610,11 @@ end
|
|
|
4513
4610
|
|
|
4514
4611
|
### Parameters
|
|
4515
4612
|
|
|
4613
|
+
|
|
4516
4614
|
Name | Type | Description | Notes
|
|
4517
4615
|
------------- | ------------- | ------------- | -------------
|
|
4518
4616
|
**application_id** | **Integer**| |
|
|
4519
|
-
**body** |
|
|
4617
|
+
**body** | **Object**| |
|
|
4520
4618
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4521
4619
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4522
4620
|
**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]
|
|
@@ -4528,12 +4626,12 @@ Name | Type | Description | Notes
|
|
|
4528
4626
|
**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]
|
|
4529
4627
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4530
4628
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4531
|
-
**exact_match** | **
|
|
4629
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4532
4630
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
4533
4631
|
|
|
4534
4632
|
### Return type
|
|
4535
4633
|
|
|
4536
|
-
[**
|
|
4634
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
4537
4635
|
|
|
4538
4636
|
### Authorization
|
|
4539
4637
|
|
|
@@ -4541,12 +4639,12 @@ Name | Type | Description | Notes
|
|
|
4541
4639
|
|
|
4542
4640
|
### HTTP request headers
|
|
4543
4641
|
|
|
4544
|
-
|
|
4545
|
-
|
|
4642
|
+
- **Content-Type**: application/json
|
|
4643
|
+
- **Accept**: application/json
|
|
4546
4644
|
|
|
4547
4645
|
|
|
4646
|
+
## search_coupons_advanced_application_wide_without_total_count
|
|
4548
4647
|
|
|
4549
|
-
# **search_coupons_advanced_application_wide_without_total_count**
|
|
4550
4648
|
> InlineResponse2005 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
|
4551
4649
|
|
|
4552
4650
|
Get a list of the coupons that match the given attributes in all active campaigns of an application
|
|
@@ -4554,6 +4652,7 @@ Get a list of the coupons that match the given attributes in all active campaign
|
|
|
4554
4652
|
Gets a list of all the coupons with attributes matching the query criteria in all active campaigns of an application
|
|
4555
4653
|
|
|
4556
4654
|
### Example
|
|
4655
|
+
|
|
4557
4656
|
```ruby
|
|
4558
4657
|
# load the gem
|
|
4559
4658
|
require 'talon_one'
|
|
@@ -4566,12 +4665,9 @@ TalonOne.configure do |config|
|
|
|
4566
4665
|
end
|
|
4567
4666
|
|
|
4568
4667
|
api_instance = TalonOne::ManagementApi.new
|
|
4569
|
-
|
|
4570
4668
|
application_id = 56 # Integer |
|
|
4571
|
-
|
|
4572
|
-
|
|
4573
|
-
|
|
4574
|
-
opts = {
|
|
4669
|
+
body = nil # Object |
|
|
4670
|
+
opts = {
|
|
4575
4671
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4576
4672
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4577
4673
|
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.
|
|
@@ -4583,7 +4679,7 @@ opts = {
|
|
|
4583
4679
|
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.
|
|
4584
4680
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4585
4681
|
batch_id: 'batch_id_example', # String | Filter results by batches of coupons
|
|
4586
|
-
exact_match: false, #
|
|
4682
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4587
4683
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign.
|
|
4588
4684
|
}
|
|
4589
4685
|
|
|
@@ -4598,10 +4694,11 @@ end
|
|
|
4598
4694
|
|
|
4599
4695
|
### Parameters
|
|
4600
4696
|
|
|
4697
|
+
|
|
4601
4698
|
Name | Type | Description | Notes
|
|
4602
4699
|
------------- | ------------- | ------------- | -------------
|
|
4603
4700
|
**application_id** | **Integer**| |
|
|
4604
|
-
**body** |
|
|
4701
|
+
**body** | **Object**| |
|
|
4605
4702
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4606
4703
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4607
4704
|
**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]
|
|
@@ -4613,7 +4710,7 @@ Name | Type | Description | Notes
|
|
|
4613
4710
|
**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]
|
|
4614
4711
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4615
4712
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4616
|
-
**exact_match** | **
|
|
4713
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4617
4714
|
**campaign_state** | **String**| Filter results by the state of the campaign. | [optional]
|
|
4618
4715
|
|
|
4619
4716
|
### Return type
|
|
@@ -4626,12 +4723,12 @@ Name | Type | Description | Notes
|
|
|
4626
4723
|
|
|
4627
4724
|
### HTTP request headers
|
|
4628
4725
|
|
|
4629
|
-
|
|
4630
|
-
|
|
4726
|
+
- **Content-Type**: application/json
|
|
4727
|
+
- **Accept**: application/json
|
|
4631
4728
|
|
|
4632
4729
|
|
|
4730
|
+
## search_coupons_advanced_without_total_count
|
|
4633
4731
|
|
|
4634
|
-
# **search_coupons_advanced_without_total_count**
|
|
4635
4732
|
> InlineResponse2005 search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts)
|
|
4636
4733
|
|
|
4637
4734
|
Get a list of the coupons that match the given attributes
|
|
@@ -4639,6 +4736,7 @@ Get a list of the coupons that match the given attributes
|
|
|
4639
4736
|
Gets a list of all the coupons with attributes matching the query criteria
|
|
4640
4737
|
|
|
4641
4738
|
### Example
|
|
4739
|
+
|
|
4642
4740
|
```ruby
|
|
4643
4741
|
# load the gem
|
|
4644
4742
|
require 'talon_one'
|
|
@@ -4651,14 +4749,10 @@ TalonOne.configure do |config|
|
|
|
4651
4749
|
end
|
|
4652
4750
|
|
|
4653
4751
|
api_instance = TalonOne::ManagementApi.new
|
|
4654
|
-
|
|
4655
4752
|
application_id = 56 # Integer |
|
|
4656
|
-
|
|
4657
4753
|
campaign_id = 56 # Integer |
|
|
4658
|
-
|
|
4659
|
-
|
|
4660
|
-
|
|
4661
|
-
opts = {
|
|
4754
|
+
body = nil # Object |
|
|
4755
|
+
opts = {
|
|
4662
4756
|
page_size: 56, # Integer | The number of items to include in this response. When omitted, the maximum value of 1000 will be used.
|
|
4663
4757
|
skip: 56, # Integer | Skips the given number of items when paging through large result sets.
|
|
4664
4758
|
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.
|
|
@@ -4669,7 +4763,7 @@ opts = {
|
|
|
4669
4763
|
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`.
|
|
4670
4764
|
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.
|
|
4671
4765
|
recipient_integration_id: 'recipient_integration_id_example', # String | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field
|
|
4672
|
-
exact_match: false, #
|
|
4766
|
+
exact_match: false, # Boolean | Filter results to an exact case-insensitive matching against the coupon code
|
|
4673
4767
|
batch_id: 'batch_id_example' # String | Filter results by batches of coupons
|
|
4674
4768
|
}
|
|
4675
4769
|
|
|
@@ -4684,11 +4778,12 @@ end
|
|
|
4684
4778
|
|
|
4685
4779
|
### Parameters
|
|
4686
4780
|
|
|
4781
|
+
|
|
4687
4782
|
Name | Type | Description | Notes
|
|
4688
4783
|
------------- | ------------- | ------------- | -------------
|
|
4689
4784
|
**application_id** | **Integer**| |
|
|
4690
4785
|
**campaign_id** | **Integer**| |
|
|
4691
|
-
**body** |
|
|
4786
|
+
**body** | **Object**| |
|
|
4692
4787
|
**page_size** | **Integer**| The number of items to include in this response. When omitted, the maximum value of 1000 will be used. | [optional]
|
|
4693
4788
|
**skip** | **Integer**| Skips the given number of items when paging through large result sets. | [optional]
|
|
4694
4789
|
**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]
|
|
@@ -4699,7 +4794,7 @@ Name | Type | Description | Notes
|
|
|
4699
4794
|
**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]
|
|
4700
4795
|
**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]
|
|
4701
4796
|
**recipient_integration_id** | **String**| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | [optional]
|
|
4702
|
-
**exact_match** | **
|
|
4797
|
+
**exact_match** | **Boolean**| Filter results to an exact case-insensitive matching against the coupon code | [optional] [default to false]
|
|
4703
4798
|
**batch_id** | **String**| Filter results by batches of coupons | [optional]
|
|
4704
4799
|
|
|
4705
4800
|
### Return type
|
|
@@ -4712,19 +4807,20 @@ Name | Type | Description | Notes
|
|
|
4712
4807
|
|
|
4713
4808
|
### HTTP request headers
|
|
4714
4809
|
|
|
4715
|
-
|
|
4716
|
-
|
|
4810
|
+
- **Content-Type**: application/json
|
|
4811
|
+
- **Accept**: application/json
|
|
4717
4812
|
|
|
4718
4813
|
|
|
4814
|
+
## update_additional_cost
|
|
4719
4815
|
|
|
4720
|
-
|
|
4721
|
-
> set_account_limits(account_id, body)
|
|
4816
|
+
> AccountAdditionalCost update_additional_cost(additional_cost_id, body)
|
|
4722
4817
|
|
|
4723
|
-
|
|
4818
|
+
Update an additional cost
|
|
4724
4819
|
|
|
4725
|
-
|
|
4820
|
+
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.
|
|
4726
4821
|
|
|
4727
4822
|
### Example
|
|
4823
|
+
|
|
4728
4824
|
```ruby
|
|
4729
4825
|
# load the gem
|
|
4730
4826
|
require 'talon_one'
|
|
@@ -4737,30 +4833,29 @@ TalonOne.configure do |config|
|
|
|
4737
4833
|
end
|
|
4738
4834
|
|
|
4739
4835
|
api_instance = TalonOne::ManagementApi.new
|
|
4740
|
-
|
|
4741
|
-
|
|
4742
|
-
|
|
4743
|
-
body = TalonOne::AccountLimits.new # AccountLimits |
|
|
4744
|
-
|
|
4836
|
+
additional_cost_id = 56 # Integer |
|
|
4837
|
+
body = TalonOne::NewAdditionalCost.new # NewAdditionalCost |
|
|
4745
4838
|
|
|
4746
4839
|
begin
|
|
4747
|
-
#
|
|
4748
|
-
api_instance.
|
|
4840
|
+
#Update an additional cost
|
|
4841
|
+
result = api_instance.update_additional_cost(additional_cost_id, body)
|
|
4842
|
+
p result
|
|
4749
4843
|
rescue TalonOne::ApiError => e
|
|
4750
|
-
puts "Exception when calling ManagementApi->
|
|
4844
|
+
puts "Exception when calling ManagementApi->update_additional_cost: #{e}"
|
|
4751
4845
|
end
|
|
4752
4846
|
```
|
|
4753
4847
|
|
|
4754
4848
|
### Parameters
|
|
4755
4849
|
|
|
4850
|
+
|
|
4756
4851
|
Name | Type | Description | Notes
|
|
4757
4852
|
------------- | ------------- | ------------- | -------------
|
|
4758
|
-
**
|
|
4759
|
-
**body** | [**
|
|
4853
|
+
**additional_cost_id** | **Integer**| |
|
|
4854
|
+
**body** | [**NewAdditionalCost**](NewAdditionalCost.md)| |
|
|
4760
4855
|
|
|
4761
4856
|
### Return type
|
|
4762
4857
|
|
|
4763
|
-
|
|
4858
|
+
[**AccountAdditionalCost**](AccountAdditionalCost.md)
|
|
4764
4859
|
|
|
4765
4860
|
### Authorization
|
|
4766
4861
|
|
|
@@ -4768,19 +4863,20 @@ nil (empty response body)
|
|
|
4768
4863
|
|
|
4769
4864
|
### HTTP request headers
|
|
4770
4865
|
|
|
4771
|
-
|
|
4772
|
-
|
|
4773
|
-
|
|
4866
|
+
- **Content-Type**: application/json
|
|
4867
|
+
- **Accept**: application/json
|
|
4774
4868
|
|
|
4775
4869
|
|
|
4776
|
-
|
|
4777
|
-
> Campaign update_campaign(application_id, campaign_id, body)
|
|
4870
|
+
## update_attribute
|
|
4778
4871
|
|
|
4779
|
-
|
|
4872
|
+
> Attribute update_attribute(attribute_id, body)
|
|
4780
4873
|
|
|
4874
|
+
Update a custom attribute
|
|
4781
4875
|
|
|
4876
|
+
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.
|
|
4782
4877
|
|
|
4783
4878
|
### Example
|
|
4879
|
+
|
|
4784
4880
|
```ruby
|
|
4785
4881
|
# load the gem
|
|
4786
4882
|
require 'talon_one'
|
|
@@ -4793,34 +4889,29 @@ TalonOne.configure do |config|
|
|
|
4793
4889
|
end
|
|
4794
4890
|
|
|
4795
4891
|
api_instance = TalonOne::ManagementApi.new
|
|
4796
|
-
|
|
4797
|
-
|
|
4798
|
-
|
|
4799
|
-
campaign_id = 56 # Integer |
|
|
4800
|
-
|
|
4801
|
-
body = TalonOne::UpdateCampaign.new # UpdateCampaign |
|
|
4802
|
-
|
|
4892
|
+
attribute_id = 56 # Integer |
|
|
4893
|
+
body = TalonOne::NewAttribute.new # NewAttribute |
|
|
4803
4894
|
|
|
4804
4895
|
begin
|
|
4805
|
-
#Update a
|
|
4806
|
-
result = api_instance.
|
|
4896
|
+
#Update a custom attribute
|
|
4897
|
+
result = api_instance.update_attribute(attribute_id, body)
|
|
4807
4898
|
p result
|
|
4808
4899
|
rescue TalonOne::ApiError => e
|
|
4809
|
-
puts "Exception when calling ManagementApi->
|
|
4900
|
+
puts "Exception when calling ManagementApi->update_attribute: #{e}"
|
|
4810
4901
|
end
|
|
4811
4902
|
```
|
|
4812
4903
|
|
|
4813
4904
|
### Parameters
|
|
4814
4905
|
|
|
4906
|
+
|
|
4815
4907
|
Name | Type | Description | Notes
|
|
4816
4908
|
------------- | ------------- | ------------- | -------------
|
|
4817
|
-
**
|
|
4818
|
-
**
|
|
4819
|
-
**body** | [**UpdateCampaign**](UpdateCampaign.md)| |
|
|
4909
|
+
**attribute_id** | **Integer**| |
|
|
4910
|
+
**body** | [**NewAttribute**](NewAttribute.md)| |
|
|
4820
4911
|
|
|
4821
4912
|
### Return type
|
|
4822
4913
|
|
|
4823
|
-
[**
|
|
4914
|
+
[**Attribute**](Attribute.md)
|
|
4824
4915
|
|
|
4825
4916
|
### Authorization
|
|
4826
4917
|
|
|
@@ -4828,19 +4919,18 @@ Name | Type | Description | Notes
|
|
|
4828
4919
|
|
|
4829
4920
|
### HTTP request headers
|
|
4830
4921
|
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
|
|
4922
|
+
- **Content-Type**: application/json
|
|
4923
|
+
- **Accept**: application/json
|
|
4834
4924
|
|
|
4835
4925
|
|
|
4836
|
-
|
|
4837
|
-
> CampaignSet update_campaign_set(application_id, body)
|
|
4838
|
-
|
|
4839
|
-
Update a Campaign Set
|
|
4926
|
+
## update_campaign
|
|
4840
4927
|
|
|
4928
|
+
> Campaign update_campaign(application_id, campaign_id, body)
|
|
4841
4929
|
|
|
4930
|
+
Update a Campaign
|
|
4842
4931
|
|
|
4843
4932
|
### Example
|
|
4933
|
+
|
|
4844
4934
|
```ruby
|
|
4845
4935
|
# load the gem
|
|
4846
4936
|
require 'talon_one'
|
|
@@ -4853,31 +4943,31 @@ TalonOne.configure do |config|
|
|
|
4853
4943
|
end
|
|
4854
4944
|
|
|
4855
4945
|
api_instance = TalonOne::ManagementApi.new
|
|
4856
|
-
|
|
4857
4946
|
application_id = 56 # Integer |
|
|
4858
|
-
|
|
4859
|
-
body = TalonOne::
|
|
4860
|
-
|
|
4947
|
+
campaign_id = 56 # Integer |
|
|
4948
|
+
body = TalonOne::UpdateCampaign.new # UpdateCampaign |
|
|
4861
4949
|
|
|
4862
4950
|
begin
|
|
4863
|
-
#Update a Campaign
|
|
4864
|
-
result = api_instance.
|
|
4951
|
+
#Update a Campaign
|
|
4952
|
+
result = api_instance.update_campaign(application_id, campaign_id, body)
|
|
4865
4953
|
p result
|
|
4866
4954
|
rescue TalonOne::ApiError => e
|
|
4867
|
-
puts "Exception when calling ManagementApi->
|
|
4955
|
+
puts "Exception when calling ManagementApi->update_campaign: #{e}"
|
|
4868
4956
|
end
|
|
4869
4957
|
```
|
|
4870
4958
|
|
|
4871
4959
|
### Parameters
|
|
4872
4960
|
|
|
4961
|
+
|
|
4873
4962
|
Name | Type | Description | Notes
|
|
4874
4963
|
------------- | ------------- | ------------- | -------------
|
|
4875
4964
|
**application_id** | **Integer**| |
|
|
4876
|
-
**
|
|
4965
|
+
**campaign_id** | **Integer**| |
|
|
4966
|
+
**body** | [**UpdateCampaign**](UpdateCampaign.md)| |
|
|
4877
4967
|
|
|
4878
4968
|
### Return type
|
|
4879
4969
|
|
|
4880
|
-
[**
|
|
4970
|
+
[**Campaign**](Campaign.md)
|
|
4881
4971
|
|
|
4882
4972
|
### Authorization
|
|
4883
4973
|
|
|
@@ -4885,19 +4975,18 @@ Name | Type | Description | Notes
|
|
|
4885
4975
|
|
|
4886
4976
|
### HTTP request headers
|
|
4887
4977
|
|
|
4888
|
-
|
|
4889
|
-
|
|
4978
|
+
- **Content-Type**: application/json
|
|
4979
|
+
- **Accept**: application/json
|
|
4890
4980
|
|
|
4891
4981
|
|
|
4982
|
+
## update_coupon
|
|
4892
4983
|
|
|
4893
|
-
# **update_coupon**
|
|
4894
4984
|
> Coupon update_coupon(application_id, campaign_id, coupon_id, body)
|
|
4895
4985
|
|
|
4896
4986
|
Update a Coupon
|
|
4897
4987
|
|
|
4898
|
-
|
|
4899
|
-
|
|
4900
4988
|
### Example
|
|
4989
|
+
|
|
4901
4990
|
```ruby
|
|
4902
4991
|
# load the gem
|
|
4903
4992
|
require 'talon_one'
|
|
@@ -4910,16 +4999,11 @@ TalonOne.configure do |config|
|
|
|
4910
4999
|
end
|
|
4911
5000
|
|
|
4912
5001
|
api_instance = TalonOne::ManagementApi.new
|
|
4913
|
-
|
|
4914
5002
|
application_id = 56 # Integer |
|
|
4915
|
-
|
|
4916
5003
|
campaign_id = 56 # Integer |
|
|
4917
|
-
|
|
4918
5004
|
coupon_id = 'coupon_id_example' # String | The ID of the coupon code to update
|
|
4919
|
-
|
|
4920
5005
|
body = TalonOne::UpdateCoupon.new # UpdateCoupon |
|
|
4921
5006
|
|
|
4922
|
-
|
|
4923
5007
|
begin
|
|
4924
5008
|
#Update a Coupon
|
|
4925
5009
|
result = api_instance.update_coupon(application_id, campaign_id, coupon_id, body)
|
|
@@ -4931,6 +5015,7 @@ end
|
|
|
4931
5015
|
|
|
4932
5016
|
### Parameters
|
|
4933
5017
|
|
|
5018
|
+
|
|
4934
5019
|
Name | Type | Description | Notes
|
|
4935
5020
|
------------- | ------------- | ------------- | -------------
|
|
4936
5021
|
**application_id** | **Integer**| |
|
|
@@ -4948,19 +5033,18 @@ Name | Type | Description | Notes
|
|
|
4948
5033
|
|
|
4949
5034
|
### HTTP request headers
|
|
4950
5035
|
|
|
4951
|
-
|
|
4952
|
-
|
|
5036
|
+
- **Content-Type**: application/json
|
|
5037
|
+
- **Accept**: application/json
|
|
4953
5038
|
|
|
4954
5039
|
|
|
5040
|
+
## update_coupon_batch
|
|
4955
5041
|
|
|
4956
|
-
# **update_coupon_batch**
|
|
4957
5042
|
> update_coupon_batch(application_id, campaign_id, body)
|
|
4958
5043
|
|
|
4959
5044
|
Update a Batch of Coupons
|
|
4960
5045
|
|
|
4961
|
-
|
|
4962
|
-
|
|
4963
5046
|
### Example
|
|
5047
|
+
|
|
4964
5048
|
```ruby
|
|
4965
5049
|
# load the gem
|
|
4966
5050
|
require 'talon_one'
|
|
@@ -4973,14 +5057,10 @@ TalonOne.configure do |config|
|
|
|
4973
5057
|
end
|
|
4974
5058
|
|
|
4975
5059
|
api_instance = TalonOne::ManagementApi.new
|
|
4976
|
-
|
|
4977
5060
|
application_id = 56 # Integer |
|
|
4978
|
-
|
|
4979
5061
|
campaign_id = 56 # Integer |
|
|
4980
|
-
|
|
4981
5062
|
body = TalonOne::UpdateCouponBatch.new # UpdateCouponBatch |
|
|
4982
5063
|
|
|
4983
|
-
|
|
4984
5064
|
begin
|
|
4985
5065
|
#Update a Batch of Coupons
|
|
4986
5066
|
api_instance.update_coupon_batch(application_id, campaign_id, body)
|
|
@@ -4991,6 +5071,7 @@ end
|
|
|
4991
5071
|
|
|
4992
5072
|
### Parameters
|
|
4993
5073
|
|
|
5074
|
+
|
|
4994
5075
|
Name | Type | Description | Notes
|
|
4995
5076
|
------------- | ------------- | ------------- | -------------
|
|
4996
5077
|
**application_id** | **Integer**| |
|
|
@@ -5007,19 +5088,18 @@ nil (empty response body)
|
|
|
5007
5088
|
|
|
5008
5089
|
### HTTP request headers
|
|
5009
5090
|
|
|
5010
|
-
|
|
5011
|
-
|
|
5091
|
+
- **Content-Type**: application/json
|
|
5092
|
+
- **Accept**: Not defined
|
|
5012
5093
|
|
|
5013
5094
|
|
|
5095
|
+
## update_ruleset
|
|
5014
5096
|
|
|
5015
|
-
# **update_ruleset**
|
|
5016
5097
|
> Ruleset update_ruleset(application_id, campaign_id, ruleset_id, body)
|
|
5017
5098
|
|
|
5018
5099
|
Update a Ruleset
|
|
5019
5100
|
|
|
5020
|
-
|
|
5021
|
-
|
|
5022
5101
|
### Example
|
|
5102
|
+
|
|
5023
5103
|
```ruby
|
|
5024
5104
|
# load the gem
|
|
5025
5105
|
require 'talon_one'
|
|
@@ -5032,16 +5112,11 @@ TalonOne.configure do |config|
|
|
|
5032
5112
|
end
|
|
5033
5113
|
|
|
5034
5114
|
api_instance = TalonOne::ManagementApi.new
|
|
5035
|
-
|
|
5036
5115
|
application_id = 56 # Integer |
|
|
5037
|
-
|
|
5038
5116
|
campaign_id = 56 # Integer |
|
|
5039
|
-
|
|
5040
5117
|
ruleset_id = 56 # Integer |
|
|
5041
|
-
|
|
5042
5118
|
body = TalonOne::NewRuleset.new # NewRuleset |
|
|
5043
5119
|
|
|
5044
|
-
|
|
5045
5120
|
begin
|
|
5046
5121
|
#Update a Ruleset
|
|
5047
5122
|
result = api_instance.update_ruleset(application_id, campaign_id, ruleset_id, body)
|
|
@@ -5053,6 +5128,7 @@ end
|
|
|
5053
5128
|
|
|
5054
5129
|
### Parameters
|
|
5055
5130
|
|
|
5131
|
+
|
|
5056
5132
|
Name | Type | Description | Notes
|
|
5057
5133
|
------------- | ------------- | ------------- | -------------
|
|
5058
5134
|
**application_id** | **Integer**| |
|
|
@@ -5070,8 +5146,6 @@ Name | Type | Description | Notes
|
|
|
5070
5146
|
|
|
5071
5147
|
### HTTP request headers
|
|
5072
5148
|
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5149
|
+
- **Content-Type**: application/json
|
|
5150
|
+
- **Accept**: application/json
|
|
5077
5151
|
|