talon_one 10.0.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/autorelease.yml +123 -0
- data/README.md +55 -11
- data/docker-compose.yml +2 -2
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +2 -0
- data/docs/AchievementBase.md +3 -1
- data/docs/AchievementProgressWithDefinition.md +3 -1
- data/docs/AchievementStatusEntry.md +2 -0
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/ApplicationCustomer.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/AudienceCustomer.md +1 -1
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BestPriorPrice.md +27 -0
- data/docs/BestPriorPriceMetadata.md +19 -0
- data/docs/BestPriorPriceRequest.md +25 -0
- data/docs/BestPriorPriceRequestTarget.md +19 -0
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeletedNotification.md +6 -4
- data/docs/CampaignDeletedNotificationItem.md +21 -0
- data/docs/CampaignEditedNotification.md +6 -6
- data/docs/CampaignEditedNotificationItem.md +23 -0
- data/docs/CampaignEvaluationTreeChangedMessage.md +21 -0
- data/docs/CampaignNotificationBase.md +19 -0
- data/docs/CampaignNotificationGeneric.md +21 -0
- data/docs/CampaignNotificationItemBase.md +17 -0
- data/docs/CampaignNotificationPolicy.md +1 -1
- data/docs/CampaignRulesetChangedNotification.md +6 -6
- data/docs/CampaignRulesetChangedNotificationItem.md +23 -0
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CardAddedDeductedPointsNotification.md +45 -0
- data/docs/CardExpiringPointsNotificationPolicy.md +1 -1
- data/docs/CardLedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/CardLedgerTransactionLogEntry.md +3 -1
- data/docs/CardLedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +3 -1
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomerProfile.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +1 -1
- data/docs/ExpiringCardPointsData.md +29 -0
- data/docs/ExpiringCardPointsNotification.md +21 -0
- data/docs/ExpiringCouponsData.md +35 -0
- data/docs/ExpiringCouponsNotification.md +21 -0
- data/docs/ExpiringCouponsNotificationPolicy.md +1 -1
- data/docs/ExpiringPointsData.md +25 -0
- data/docs/ExpiringPointsNotification.md +21 -0
- data/docs/ExpiringPointsNotificationPolicy.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +2 -4
- data/docs/ExtendedCoupon.md +61 -0
- data/docs/GenerateAuditLogSummary.md +17 -0
- data/docs/GenerateCampaignDescription.md +3 -1
- data/docs/GenerateCouponFailureDetailedSummary.md +25 -0
- data/docs/GenerateCouponFailureSummary.md +19 -0
- data/docs/GenerateUserSessionSummary.md +19 -0
- data/docs/GetIntegrationCouponRequest.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +1 -1
- data/docs/InlineResponse20042.md +4 -2
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +2 -4
- data/docs/InlineResponse20045.md +5 -3
- data/docs/InlineResponse20046.md +2 -4
- data/docs/InlineResponse20047.md +2 -6
- data/docs/InlineResponse20048.md +4 -2
- data/docs/InlineResponse20049.md +4 -2
- data/docs/IntegrationApi.md +88 -3
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/ManagementApi.md +1083 -366
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +3 -1
- data/docs/NewPriceType.md +4 -4
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +3 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/PriceDetail.md +2 -0
- data/docs/PriceType.md +4 -4
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TierDowngradeData.md +31 -0
- data/docs/TierDowngradeNotification.md +21 -0
- data/docs/TierDowngradeNotificationPolicy.md +1 -1
- data/docs/TierUpgradeData.md +35 -0
- data/docs/TierUpgradeNotification.md +21 -0
- data/docs/TierUpgradeNotificationPolicy.md +1 -1
- data/docs/TierWillDowngradeData.md +31 -0
- data/docs/TierWillDowngradeNotification.md +21 -0
- data/docs/TierWillDowngradeNotificationPolicy.md +1 -1
- data/docs/UpdateAchievement.md +3 -1
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/Webhook.md +3 -1
- data/docs/WebhookWithOutgoingIntegrationDetails.md +2 -0
- data/lib/talon_one/api/integration_api.rb +104 -2
- data/lib/talon_one/api/management_api.rb +226 -400
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +11 -1
- data/lib/talon_one/models/achievement_base.rb +14 -4
- data/lib/talon_one/models/achievement_progress_with_definition.rb +14 -4
- data/lib/talon_one/models/achievement_status_entry.rb +11 -1
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/added_deducted_points_notification.rb +478 -0
- data/lib/talon_one/models/analytics_sku.rb +23 -3
- data/lib/talon_one/models/application_customer.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/audience_customer.rb +1 -1
- data/lib/talon_one/models/audience_reference.rb +256 -0
- data/lib/talon_one/models/base_loyalty_program.rb +1 -1
- data/lib/talon_one/models/best_prior_price.rb +285 -0
- data/lib/talon_one/models/best_prior_price_metadata.rb +219 -0
- data/lib/talon_one/models/best_prior_price_request.rb +268 -0
- data/lib/talon_one/models/best_prior_price_request_target.rb +257 -0
- data/lib/talon_one/models/campaign_collection_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_collection_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_created_notification.rb +30 -26
- data/lib/talon_one/models/campaign_created_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_deleted_notification.rb +33 -21
- data/lib/talon_one/models/campaign_deleted_notification_item.rb +242 -0
- data/lib/talon_one/models/campaign_edited_notification.rb +30 -26
- data/lib/talon_one/models/campaign_edited_notification_item.rb +250 -0
- data/lib/talon_one/models/campaign_evaluation_tree_changed_message.rb +239 -0
- data/lib/talon_one/models/campaign_notification_base.rb +227 -0
- data/lib/talon_one/models/campaign_notification_generic.rb +244 -0
- data/lib/talon_one/models/campaign_notification_item_base.rb +212 -0
- data/lib/talon_one/models/campaign_notification_policy.rb +2 -0
- data/lib/talon_one/models/campaign_ruleset_changed_notification.rb +32 -23
- data/lib/talon_one/models/campaign_ruleset_changed_notification_item.rb +245 -0
- data/lib/talon_one/models/campaign_state_changed_notification.rb +30 -42
- data/lib/talon_one/models/campaign_state_changed_notification_item.rb +266 -0
- data/lib/talon_one/models/card_added_deducted_points_notification.rb +510 -0
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/card_ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry.rb +16 -1
- data/lib/talon_one/models/card_ledger_transaction_log_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/coupons_notification_data.rb +278 -0
- data/lib/talon_one/models/coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/create_achievement.rb +14 -4
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/customer_profile.rb +1 -1
- data/lib/talon_one/models/deduct_loyalty_points.rb +0 -9
- data/lib/talon_one/models/delete_coupons_data.rb +310 -0
- data/lib/talon_one/models/effect.rb +0 -1
- data/lib/talon_one/models/expiring_card_points_data.rb +342 -0
- data/lib/talon_one/models/expiring_card_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_data.rb +369 -0
- data/lib/talon_one/models/expiring_coupons_notification.rb +277 -0
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +2 -0
- data/lib/talon_one/models/expiring_points_data.rb +291 -0
- data/lib/talon_one/models/expiring_points_notification.rb +277 -0
- data/lib/talon_one/models/expiring_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +9 -24
- data/lib/talon_one/models/extended_coupon.rb +578 -0
- data/lib/talon_one/models/generate_audit_log_summary.rb +212 -0
- data/lib/talon_one/models/generate_campaign_description.rb +16 -1
- data/lib/talon_one/models/generate_coupon_failure_detailed_summary.rb +286 -0
- data/lib/talon_one/models/generate_coupon_failure_summary.rb +222 -0
- data/lib/talon_one/models/generate_user_session_summary.rb +227 -0
- data/lib/talon_one/models/get_integration_coupon_request.rb +2 -0
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +1 -1
- data/lib/talon_one/models/inline_response20042.rb +11 -7
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +7 -11
- data/lib/talon_one/models/inline_response20045.rb +11 -7
- data/lib/talon_one/models/inline_response20046.rb +2 -21
- data/lib/talon_one/models/inline_response20047.rb +2 -25
- data/lib/talon_one/models/inline_response20048.rb +16 -2
- data/lib/talon_one/models/inline_response20049.rb +21 -2
- data/lib/talon_one/models/jwt.rb +228 -0
- data/lib/talon_one/models/label_target_audience.rb +260 -0
- data/lib/talon_one/models/label_target_none.rb +246 -0
- data/lib/talon_one/models/ledger_points_entry_integration_api.rb +16 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +17 -2
- data/lib/talon_one/models/loyalty_dashboard_data.rb +16 -1
- data/lib/talon_one/models/loyalty_ledger_entry_expiry_date_change.rb +238 -0
- data/lib/talon_one/models/loyalty_program.rb +1 -1
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/new_loyalty_program.rb +1 -1
- data/lib/talon_one/models/new_message_test.rb +28 -43
- data/lib/talon_one/models/new_price_adjustment.rb +33 -4
- data/lib/talon_one/models/new_price_type.rb +3 -3
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +14 -4
- data/lib/talon_one/models/pending_active_points_data.rb +308 -0
- data/lib/talon_one/models/pending_active_points_notification.rb +277 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +2 -0
- data/lib/talon_one/models/price_detail.rb +11 -1
- data/lib/talon_one/models/price_type.rb +3 -3
- data/lib/talon_one/models/price_type_reference_detail.rb +286 -0
- data/lib/talon_one/models/price_type_references.rb +224 -0
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/secondary_deployment.rb +367 -0
- data/lib/talon_one/models/set_loyalty_points_expiry_date_effect_props.rb +255 -0
- data/lib/talon_one/models/strikethrough_changed_item.rb +13 -1
- data/lib/talon_one/models/strikethrough_effect.rb +46 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +19 -4
- data/lib/talon_one/models/tier_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_upgrade_data.rb +353 -0
- data/lib/talon_one/models/tier_upgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/tier_will_downgrade_data.rb +328 -0
- data/lib/talon_one/models/tier_will_downgrade_notification.rb +277 -0
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +2 -0
- data/lib/talon_one/models/update_achievement.rb +14 -4
- data/lib/talon_one/models/update_coupons_data.rb +296 -0
- data/lib/talon_one/models/update_loyalty_program.rb +1 -1
- data/lib/talon_one/models/update_price_type.rb +239 -0
- data/lib/talon_one/models/webhook.rb +14 -4
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +11 -1
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +51 -6
- data/spec/api/integration_api_spec.rb +23 -1
- data/spec/api/management_api_spec.rb +18 -54
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +6 -0
- data/spec/models/achievement_progress_with_definition_spec.rb +6 -0
- data/spec/models/achievement_spec.rb +6 -0
- data/spec/models/achievement_status_entry_spec.rb +6 -0
- data/spec/models/added_deducted_points_notification_spec.rb +125 -0
- data/spec/models/analytics_sku_spec.rb +12 -0
- data/spec/models/async_coupons_data_spec.rb +65 -0
- data/spec/models/audience_reference_spec.rb +53 -0
- data/spec/models/best_prior_price_metadata_spec.rb +47 -0
- data/spec/models/best_prior_price_request_spec.rb +65 -0
- data/spec/models/best_prior_price_request_target_spec.rb +51 -0
- data/spec/models/best_prior_price_spec.rb +71 -0
- data/spec/models/campaign_collection_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_collection_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_created_notification_item_spec.rb +59 -0
- data/spec/models/campaign_created_notification_spec.rb +3 -3
- data/spec/models/campaign_deleted_notification_item_spec.rb +53 -0
- data/spec/models/campaign_deleted_notification_spec.rb +8 -2
- data/spec/models/campaign_edited_notification_item_spec.rb +59 -0
- data/spec/models/campaign_edited_notification_spec.rb +3 -3
- data/spec/models/campaign_evaluation_tree_changed_message_spec.rb +53 -0
- data/spec/models/campaign_notification_base_spec.rb +47 -0
- data/spec/models/campaign_notification_generic_spec.rb +53 -0
- data/spec/models/campaign_notification_item_base_spec.rb +41 -0
- data/spec/models/campaign_ruleset_changed_notification_item_spec.rb +59 -0
- data/spec/models/campaign_ruleset_changed_notification_spec.rb +3 -3
- data/spec/models/campaign_state_changed_notification_item_spec.rb +65 -0
- data/spec/models/campaign_state_changed_notification_spec.rb +3 -9
- data/spec/models/card_added_deducted_points_notification_spec.rb +137 -0
- data/spec/models/card_ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/card_ledger_transaction_log_entry_spec.rb +6 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +6 -0
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/expiring_card_points_data_spec.rb +77 -0
- data/spec/models/expiring_card_points_notification_spec.rb +57 -0
- data/spec/models/expiring_coupons_data_spec.rb +95 -0
- data/spec/models/expiring_coupons_notification_spec.rb +57 -0
- data/spec/models/expiring_points_data_spec.rb +65 -0
- data/spec/models/expiring_points_notification_spec.rb +57 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +1 -7
- data/spec/models/extended_coupon_spec.rb +173 -0
- data/spec/models/generate_audit_log_summary_spec.rb +41 -0
- data/spec/models/generate_campaign_description_spec.rb +6 -0
- data/spec/models/generate_coupon_failure_detailed_summary_spec.rb +65 -0
- data/spec/models/generate_coupon_failure_summary_spec.rb +47 -0
- data/spec/models/generate_user_session_summary_spec.rb +47 -0
- data/spec/models/inline_response20042_spec.rb +6 -0
- data/spec/models/inline_response20044_spec.rb +0 -6
- data/spec/models/inline_response20045_spec.rb +6 -0
- data/spec/models/inline_response20046_spec.rb +0 -6
- data/spec/models/inline_response20047_spec.rb +0 -12
- data/spec/models/inline_response20048_spec.rb +6 -0
- data/spec/models/inline_response20049_spec.rb +6 -0
- data/spec/models/jwt_spec.rb +47 -0
- data/spec/models/label_target_audience_spec.rb +51 -0
- data/spec/models/label_target_none_spec.rb +45 -0
- data/spec/models/ledger_points_entry_integration_api_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_dashboard_data_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_expiry_date_change_spec.rb +53 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +10 -14
- data/spec/models/new_price_adjustment_spec.rb +6 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/pending_active_points_data_spec.rb +77 -0
- data/spec/models/pending_active_points_notification_spec.rb +57 -0
- data/spec/models/price_detail_spec.rb +6 -0
- data/spec/models/price_type_reference_detail_spec.rb +63 -0
- data/spec/models/price_type_references_spec.rb +47 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/secondary_deployment_spec.rb +87 -0
- data/spec/models/set_loyalty_points_expiry_date_effect_props_spec.rb +59 -0
- data/spec/models/strikethrough_changed_item_spec.rb +6 -0
- data/spec/models/strikethrough_effect_spec.rb +24 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/tier_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_downgrade_notification_spec.rb +57 -0
- data/spec/models/tier_upgrade_data_spec.rb +95 -0
- data/spec/models/tier_upgrade_notification_spec.rb +57 -0
- data/spec/models/tier_will_downgrade_data_spec.rb +83 -0
- data/spec/models/tier_will_downgrade_notification_spec.rb +57 -0
- data/spec/models/update_achievement_spec.rb +6 -0
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +206 -2
- data/.github/dependabot.yml +0 -10
data/docs/ManagementApi.md
CHANGED
|
@@ -120,8 +120,6 @@ Method | HTTP request | Description
|
|
|
120
120
|
[**get_user**](ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get user
|
|
121
121
|
[**get_users**](ManagementApi.md#get_users) | **GET** /v1/users | List users in account
|
|
122
122
|
[**get_webhook**](ManagementApi.md#get_webhook) | **GET** /v1/webhooks/{webhookId} | Get webhook
|
|
123
|
-
[**get_webhook_activation_logs**](ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List webhook activation log entries
|
|
124
|
-
[**get_webhook_logs**](ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List webhook log entries
|
|
125
123
|
[**get_webhooks**](ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List webhooks
|
|
126
124
|
[**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
|
127
125
|
[**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
|
@@ -197,6 +195,11 @@ Enable a [disabled user](https://docs.talon.one/docs/product/account/account-set
|
|
|
197
195
|
require 'talon_one'
|
|
198
196
|
# setup authorization
|
|
199
197
|
TalonOne.configure do |config|
|
|
198
|
+
# Configure API key authorization: api_key_v1
|
|
199
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
201
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
202
|
+
|
|
200
203
|
# Configure API key authorization: management_key
|
|
201
204
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
202
205
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -232,7 +235,7 @@ nil (empty response body)
|
|
|
232
235
|
|
|
233
236
|
### Authorization
|
|
234
237
|
|
|
235
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
238
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
236
239
|
|
|
237
240
|
### HTTP request headers
|
|
238
241
|
|
|
@@ -255,6 +258,11 @@ Add points to the given loyalty card in the specified card-based loyalty program
|
|
|
255
258
|
require 'talon_one'
|
|
256
259
|
# setup authorization
|
|
257
260
|
TalonOne.configure do |config|
|
|
261
|
+
# Configure API key authorization: api_key_v1
|
|
262
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
263
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
264
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
265
|
+
|
|
258
266
|
# Configure API key authorization: management_key
|
|
259
267
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
260
268
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -294,7 +302,7 @@ nil (empty response body)
|
|
|
294
302
|
|
|
295
303
|
### Authorization
|
|
296
304
|
|
|
297
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
305
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
298
306
|
|
|
299
307
|
### HTTP request headers
|
|
300
308
|
|
|
@@ -317,6 +325,11 @@ Add points in the specified loyalty program for the given customer. To get the
|
|
|
317
325
|
require 'talon_one'
|
|
318
326
|
# setup authorization
|
|
319
327
|
TalonOne.configure do |config|
|
|
328
|
+
# Configure API key authorization: api_key_v1
|
|
329
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
330
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
331
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
332
|
+
|
|
320
333
|
# Configure API key authorization: management_key
|
|
321
334
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
322
335
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -356,7 +369,7 @@ nil (empty response body)
|
|
|
356
369
|
|
|
357
370
|
### Authorization
|
|
358
371
|
|
|
359
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
372
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
360
373
|
|
|
361
374
|
### HTTP request headers
|
|
362
375
|
|
|
@@ -379,6 +392,11 @@ Copy the campaign into all specified Applications.
|
|
|
379
392
|
require 'talon_one'
|
|
380
393
|
# setup authorization
|
|
381
394
|
TalonOne.configure do |config|
|
|
395
|
+
# Configure API key authorization: api_key_v1
|
|
396
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
397
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
398
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
399
|
+
|
|
382
400
|
# Configure API key authorization: management_key
|
|
383
401
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
384
402
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -419,7 +437,7 @@ Name | Type | Description | Notes
|
|
|
419
437
|
|
|
420
438
|
### Authorization
|
|
421
439
|
|
|
422
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
440
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
423
441
|
|
|
424
442
|
### HTTP request headers
|
|
425
443
|
|
|
@@ -442,6 +460,11 @@ Create an account-level collection.
|
|
|
442
460
|
require 'talon_one'
|
|
443
461
|
# setup authorization
|
|
444
462
|
TalonOne.configure do |config|
|
|
463
|
+
# Configure API key authorization: api_key_v1
|
|
464
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
465
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
466
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
467
|
+
|
|
445
468
|
# Configure API key authorization: management_key
|
|
446
469
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
447
470
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -478,7 +501,7 @@ Name | Type | Description | Notes
|
|
|
478
501
|
|
|
479
502
|
### Authorization
|
|
480
503
|
|
|
481
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
504
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
482
505
|
|
|
483
506
|
### HTTP request headers
|
|
484
507
|
|
|
@@ -501,6 +524,11 @@ Create a new achievement in a specific campaign.
|
|
|
501
524
|
require 'talon_one'
|
|
502
525
|
# setup authorization
|
|
503
526
|
TalonOne.configure do |config|
|
|
527
|
+
# Configure API key authorization: api_key_v1
|
|
528
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
530
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
531
|
+
|
|
504
532
|
# Configure API key authorization: management_key
|
|
505
533
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
506
534
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -541,7 +569,7 @@ Name | Type | Description | Notes
|
|
|
541
569
|
|
|
542
570
|
### Authorization
|
|
543
571
|
|
|
544
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
572
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
545
573
|
|
|
546
574
|
### HTTP request headers
|
|
547
575
|
|
|
@@ -564,6 +592,11 @@ Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tool
|
|
|
564
592
|
require 'talon_one'
|
|
565
593
|
# setup authorization
|
|
566
594
|
TalonOne.configure do |config|
|
|
595
|
+
# Configure API key authorization: api_key_v1
|
|
596
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
597
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
598
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
599
|
+
|
|
567
600
|
# Configure API key authorization: management_key
|
|
568
601
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
569
602
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -600,7 +633,7 @@ Name | Type | Description | Notes
|
|
|
600
633
|
|
|
601
634
|
### Authorization
|
|
602
635
|
|
|
603
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
636
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
604
637
|
|
|
605
638
|
### HTTP request headers
|
|
606
639
|
|
|
@@ -623,6 +656,11 @@ Create a _custom attribute_ in this account. [Custom attributes](https://docs.ta
|
|
|
623
656
|
require 'talon_one'
|
|
624
657
|
# setup authorization
|
|
625
658
|
TalonOne.configure do |config|
|
|
659
|
+
# Configure API key authorization: api_key_v1
|
|
660
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
661
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
662
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
663
|
+
|
|
626
664
|
# Configure API key authorization: management_key
|
|
627
665
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
628
666
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -659,7 +697,7 @@ Name | Type | Description | Notes
|
|
|
659
697
|
|
|
660
698
|
### Authorization
|
|
661
699
|
|
|
662
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
700
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
663
701
|
|
|
664
702
|
### HTTP request headers
|
|
665
703
|
|
|
@@ -682,6 +720,11 @@ Create a batch of loyalty cards in a specified [card-based loyalty program](http
|
|
|
682
720
|
require 'talon_one'
|
|
683
721
|
# setup authorization
|
|
684
722
|
TalonOne.configure do |config|
|
|
723
|
+
# Configure API key authorization: api_key_v1
|
|
724
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
725
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
726
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
727
|
+
|
|
685
728
|
# Configure API key authorization: management_key
|
|
686
729
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
687
730
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -720,7 +763,7 @@ Name | Type | Description | Notes
|
|
|
720
763
|
|
|
721
764
|
### Authorization
|
|
722
765
|
|
|
723
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
766
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
724
767
|
|
|
725
768
|
### HTTP request headers
|
|
726
769
|
|
|
@@ -743,6 +786,11 @@ Use the campaign template referenced in the request body to create a new campaig
|
|
|
743
786
|
require 'talon_one'
|
|
744
787
|
# setup authorization
|
|
745
788
|
TalonOne.configure do |config|
|
|
789
|
+
# Configure API key authorization: api_key_v1
|
|
790
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
791
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
792
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
793
|
+
|
|
746
794
|
# Configure API key authorization: management_key
|
|
747
795
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
748
796
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -781,7 +829,7 @@ Name | Type | Description | Notes
|
|
|
781
829
|
|
|
782
830
|
### Authorization
|
|
783
831
|
|
|
784
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
832
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
785
833
|
|
|
786
834
|
### HTTP request headers
|
|
787
835
|
|
|
@@ -804,6 +852,11 @@ Create a new store budget for a given campaign.
|
|
|
804
852
|
require 'talon_one'
|
|
805
853
|
# setup authorization
|
|
806
854
|
TalonOne.configure do |config|
|
|
855
|
+
# Configure API key authorization: api_key_v1
|
|
856
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
857
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
858
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
859
|
+
|
|
807
860
|
# Configure API key authorization: management_key
|
|
808
861
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
809
862
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -843,7 +896,7 @@ nil (empty response body)
|
|
|
843
896
|
|
|
844
897
|
### Authorization
|
|
845
898
|
|
|
846
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
899
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
847
900
|
|
|
848
901
|
### HTTP request headers
|
|
849
902
|
|
|
@@ -866,6 +919,11 @@ Create a campaign-level collection in a given campaign.
|
|
|
866
919
|
require 'talon_one'
|
|
867
920
|
# setup authorization
|
|
868
921
|
TalonOne.configure do |config|
|
|
922
|
+
# Configure API key authorization: api_key_v1
|
|
923
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
924
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
925
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
926
|
+
|
|
869
927
|
# Configure API key authorization: management_key
|
|
870
928
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
871
929
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -906,7 +964,7 @@ Name | Type | Description | Notes
|
|
|
906
964
|
|
|
907
965
|
### Authorization
|
|
908
966
|
|
|
909
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
967
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
910
968
|
|
|
911
969
|
### HTTP request headers
|
|
912
970
|
|
|
@@ -929,6 +987,11 @@ Create coupons according to some pattern. Up to 20.000 coupons can be created wi
|
|
|
929
987
|
require 'talon_one'
|
|
930
988
|
# setup authorization
|
|
931
989
|
TalonOne.configure do |config|
|
|
990
|
+
# Configure API key authorization: api_key_v1
|
|
991
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
992
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
993
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
994
|
+
|
|
932
995
|
# Configure API key authorization: management_key
|
|
933
996
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
934
997
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -973,7 +1036,7 @@ Name | Type | Description | Notes
|
|
|
973
1036
|
|
|
974
1037
|
### Authorization
|
|
975
1038
|
|
|
976
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1039
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
977
1040
|
|
|
978
1041
|
### HTTP request headers
|
|
979
1042
|
|
|
@@ -996,6 +1059,11 @@ Create up to 5,000,000 coupons asynchronously. You should typically use this enp
|
|
|
996
1059
|
require 'talon_one'
|
|
997
1060
|
# setup authorization
|
|
998
1061
|
TalonOne.configure do |config|
|
|
1062
|
+
# Configure API key authorization: api_key_v1
|
|
1063
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1064
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1065
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1066
|
+
|
|
999
1067
|
# Configure API key authorization: management_key
|
|
1000
1068
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1001
1069
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1036,7 +1104,7 @@ Name | Type | Description | Notes
|
|
|
1036
1104
|
|
|
1037
1105
|
### Authorization
|
|
1038
1106
|
|
|
1039
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1107
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1040
1108
|
|
|
1041
1109
|
### HTTP request headers
|
|
1042
1110
|
|
|
@@ -1059,6 +1127,11 @@ This endpoint handles creating a job to delete coupons asynchronously.
|
|
|
1059
1127
|
require 'talon_one'
|
|
1060
1128
|
# setup authorization
|
|
1061
1129
|
TalonOne.configure do |config|
|
|
1130
|
+
# Configure API key authorization: api_key_v1
|
|
1131
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1133
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1134
|
+
|
|
1062
1135
|
# Configure API key authorization: management_key
|
|
1063
1136
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1064
1137
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1099,7 +1172,7 @@ Name | Type | Description | Notes
|
|
|
1099
1172
|
|
|
1100
1173
|
### Authorization
|
|
1101
1174
|
|
|
1102
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1175
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1103
1176
|
|
|
1104
1177
|
### HTTP request headers
|
|
1105
1178
|
|
|
@@ -1122,6 +1195,11 @@ Create coupons according to some pattern for up to 1000 recipients.
|
|
|
1122
1195
|
require 'talon_one'
|
|
1123
1196
|
# setup authorization
|
|
1124
1197
|
TalonOne.configure do |config|
|
|
1198
|
+
# Configure API key authorization: api_key_v1
|
|
1199
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1201
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1202
|
+
|
|
1125
1203
|
# Configure API key authorization: management_key
|
|
1126
1204
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1127
1205
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1166,7 +1244,7 @@ Name | Type | Description | Notes
|
|
|
1166
1244
|
|
|
1167
1245
|
### Authorization
|
|
1168
1246
|
|
|
1169
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1247
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1170
1248
|
|
|
1171
1249
|
### HTTP request headers
|
|
1172
1250
|
|
|
@@ -1189,6 +1267,11 @@ Resend an email invitation to an existing user. **Note:** The invitation token
|
|
|
1189
1267
|
require 'talon_one'
|
|
1190
1268
|
# setup authorization
|
|
1191
1269
|
TalonOne.configure do |config|
|
|
1270
|
+
# Configure API key authorization: api_key_v1
|
|
1271
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1272
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1273
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1274
|
+
|
|
1192
1275
|
# Configure API key authorization: management_key
|
|
1193
1276
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1194
1277
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1225,7 +1308,7 @@ Name | Type | Description | Notes
|
|
|
1225
1308
|
|
|
1226
1309
|
### Authorization
|
|
1227
1310
|
|
|
1228
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1311
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1229
1312
|
|
|
1230
1313
|
### HTTP request headers
|
|
1231
1314
|
|
|
@@ -1248,6 +1331,11 @@ Create a new user in the account and send an invitation to their email address.
|
|
|
1248
1331
|
require 'talon_one'
|
|
1249
1332
|
# setup authorization
|
|
1250
1333
|
TalonOne.configure do |config|
|
|
1334
|
+
# Configure API key authorization: api_key_v1
|
|
1335
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1336
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1337
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1338
|
+
|
|
1251
1339
|
# Configure API key authorization: management_key
|
|
1252
1340
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1253
1341
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1284,7 +1372,7 @@ Name | Type | Description | Notes
|
|
|
1284
1372
|
|
|
1285
1373
|
### Authorization
|
|
1286
1374
|
|
|
1287
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1375
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1288
1376
|
|
|
1289
1377
|
### HTTP request headers
|
|
1290
1378
|
|
|
@@ -1307,6 +1395,11 @@ Send an email with a password recovery link to the email address of an existing
|
|
|
1307
1395
|
require 'talon_one'
|
|
1308
1396
|
# setup authorization
|
|
1309
1397
|
TalonOne.configure do |config|
|
|
1398
|
+
# Configure API key authorization: api_key_v1
|
|
1399
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1400
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1401
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1402
|
+
|
|
1310
1403
|
# Configure API key authorization: management_key
|
|
1311
1404
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1312
1405
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1343,7 +1436,7 @@ Name | Type | Description | Notes
|
|
|
1343
1436
|
|
|
1344
1437
|
### Authorization
|
|
1345
1438
|
|
|
1346
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1439
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1347
1440
|
|
|
1348
1441
|
### HTTP request headers
|
|
1349
1442
|
|
|
@@ -1366,6 +1459,11 @@ Create a session to use the Management API endpoints. Use the value of the `toke
|
|
|
1366
1459
|
require 'talon_one'
|
|
1367
1460
|
# setup authorization
|
|
1368
1461
|
TalonOne.configure do |config|
|
|
1462
|
+
# Configure API key authorization: api_key_v1
|
|
1463
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1465
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1466
|
+
|
|
1369
1467
|
# Configure API key authorization: management_key
|
|
1370
1468
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1371
1469
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1402,7 +1500,7 @@ Name | Type | Description | Notes
|
|
|
1402
1500
|
|
|
1403
1501
|
### Authorization
|
|
1404
1502
|
|
|
1405
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1503
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1406
1504
|
|
|
1407
1505
|
### HTTP request headers
|
|
1408
1506
|
|
|
@@ -1425,6 +1523,11 @@ Create a new store in a specific Application.
|
|
|
1425
1523
|
require 'talon_one'
|
|
1426
1524
|
# setup authorization
|
|
1427
1525
|
TalonOne.configure do |config|
|
|
1526
|
+
# Configure API key authorization: api_key_v1
|
|
1527
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1528
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1529
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1530
|
+
|
|
1428
1531
|
# Configure API key authorization: management_key
|
|
1429
1532
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1430
1533
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1463,7 +1566,7 @@ Name | Type | Description | Notes
|
|
|
1463
1566
|
|
|
1464
1567
|
### Authorization
|
|
1465
1568
|
|
|
1466
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1569
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1467
1570
|
|
|
1468
1571
|
### HTTP request headers
|
|
1469
1572
|
|
|
@@ -1486,6 +1589,11 @@ Disable user by email address
|
|
|
1486
1589
|
require 'talon_one'
|
|
1487
1590
|
# setup authorization
|
|
1488
1591
|
TalonOne.configure do |config|
|
|
1592
|
+
# Configure API key authorization: api_key_v1
|
|
1593
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1594
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1595
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1596
|
+
|
|
1489
1597
|
# Configure API key authorization: management_key
|
|
1490
1598
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1491
1599
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1521,7 +1629,7 @@ nil (empty response body)
|
|
|
1521
1629
|
|
|
1522
1630
|
### Authorization
|
|
1523
1631
|
|
|
1524
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1632
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1525
1633
|
|
|
1526
1634
|
### HTTP request headers
|
|
1527
1635
|
|
|
@@ -1544,6 +1652,11 @@ Deduct points from the given loyalty card in the specified card-based loyalty pr
|
|
|
1544
1652
|
require 'talon_one'
|
|
1545
1653
|
# setup authorization
|
|
1546
1654
|
TalonOne.configure do |config|
|
|
1655
|
+
# Configure API key authorization: api_key_v1
|
|
1656
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1657
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1658
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1659
|
+
|
|
1547
1660
|
# Configure API key authorization: management_key
|
|
1548
1661
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1549
1662
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1583,7 +1696,7 @@ nil (empty response body)
|
|
|
1583
1696
|
|
|
1584
1697
|
### Authorization
|
|
1585
1698
|
|
|
1586
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1699
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1587
1700
|
|
|
1588
1701
|
### HTTP request headers
|
|
1589
1702
|
|
|
@@ -1606,6 +1719,11 @@ Delete a given account-level collection.
|
|
|
1606
1719
|
require 'talon_one'
|
|
1607
1720
|
# setup authorization
|
|
1608
1721
|
TalonOne.configure do |config|
|
|
1722
|
+
# Configure API key authorization: api_key_v1
|
|
1723
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1724
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1725
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1726
|
+
|
|
1609
1727
|
# Configure API key authorization: management_key
|
|
1610
1728
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1611
1729
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1641,7 +1759,7 @@ nil (empty response body)
|
|
|
1641
1759
|
|
|
1642
1760
|
### Authorization
|
|
1643
1761
|
|
|
1644
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1762
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1645
1763
|
|
|
1646
1764
|
### HTTP request headers
|
|
1647
1765
|
|
|
@@ -1664,6 +1782,11 @@ Delete the specified achievement.
|
|
|
1664
1782
|
require 'talon_one'
|
|
1665
1783
|
# setup authorization
|
|
1666
1784
|
TalonOne.configure do |config|
|
|
1785
|
+
# Configure API key authorization: api_key_v1
|
|
1786
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1787
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1788
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1789
|
+
|
|
1667
1790
|
# Configure API key authorization: management_key
|
|
1668
1791
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1669
1792
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1703,7 +1826,7 @@ nil (empty response body)
|
|
|
1703
1826
|
|
|
1704
1827
|
### Authorization
|
|
1705
1828
|
|
|
1706
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1829
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1707
1830
|
|
|
1708
1831
|
### HTTP request headers
|
|
1709
1832
|
|
|
@@ -1726,6 +1849,11 @@ Delete the given campaign.
|
|
|
1726
1849
|
require 'talon_one'
|
|
1727
1850
|
# setup authorization
|
|
1728
1851
|
TalonOne.configure do |config|
|
|
1852
|
+
# Configure API key authorization: api_key_v1
|
|
1853
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1854
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1855
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1856
|
+
|
|
1729
1857
|
# Configure API key authorization: management_key
|
|
1730
1858
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1731
1859
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1763,7 +1891,7 @@ nil (empty response body)
|
|
|
1763
1891
|
|
|
1764
1892
|
### Authorization
|
|
1765
1893
|
|
|
1766
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1894
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1767
1895
|
|
|
1768
1896
|
### HTTP request headers
|
|
1769
1897
|
|
|
@@ -1786,6 +1914,11 @@ Delete the store budgets for a given campaign.
|
|
|
1786
1914
|
require 'talon_one'
|
|
1787
1915
|
# setup authorization
|
|
1788
1916
|
TalonOne.configure do |config|
|
|
1917
|
+
# Configure API key authorization: api_key_v1
|
|
1918
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1919
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1920
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1921
|
+
|
|
1789
1922
|
# Configure API key authorization: management_key
|
|
1790
1923
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1791
1924
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1829,7 +1962,7 @@ nil (empty response body)
|
|
|
1829
1962
|
|
|
1830
1963
|
### Authorization
|
|
1831
1964
|
|
|
1832
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1965
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1833
1966
|
|
|
1834
1967
|
### HTTP request headers
|
|
1835
1968
|
|
|
@@ -1852,6 +1985,11 @@ Delete a given campaign-level collection.
|
|
|
1852
1985
|
require 'talon_one'
|
|
1853
1986
|
# setup authorization
|
|
1854
1987
|
TalonOne.configure do |config|
|
|
1988
|
+
# Configure API key authorization: api_key_v1
|
|
1989
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1990
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1991
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1992
|
+
|
|
1855
1993
|
# Configure API key authorization: management_key
|
|
1856
1994
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1857
1995
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1891,7 +2029,7 @@ nil (empty response body)
|
|
|
1891
2029
|
|
|
1892
2030
|
### Authorization
|
|
1893
2031
|
|
|
1894
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2032
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1895
2033
|
|
|
1896
2034
|
### HTTP request headers
|
|
1897
2035
|
|
|
@@ -1914,6 +2052,11 @@ Delete the specified coupon.
|
|
|
1914
2052
|
require 'talon_one'
|
|
1915
2053
|
# setup authorization
|
|
1916
2054
|
TalonOne.configure do |config|
|
|
2055
|
+
# Configure API key authorization: api_key_v1
|
|
2056
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2057
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2058
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2059
|
+
|
|
1917
2060
|
# Configure API key authorization: management_key
|
|
1918
2061
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1919
2062
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1953,7 +2096,7 @@ nil (empty response body)
|
|
|
1953
2096
|
|
|
1954
2097
|
### Authorization
|
|
1955
2098
|
|
|
1956
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2099
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1957
2100
|
|
|
1958
2101
|
### HTTP request headers
|
|
1959
2102
|
|
|
@@ -1976,6 +2119,11 @@ Deletes all the coupons matching the specified criteria.
|
|
|
1976
2119
|
require 'talon_one'
|
|
1977
2120
|
# setup authorization
|
|
1978
2121
|
TalonOne.configure do |config|
|
|
2122
|
+
# Configure API key authorization: api_key_v1
|
|
2123
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2125
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2126
|
+
|
|
1979
2127
|
# Configure API key authorization: management_key
|
|
1980
2128
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1981
2129
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2041,7 +2189,7 @@ nil (empty response body)
|
|
|
2041
2189
|
|
|
2042
2190
|
### Authorization
|
|
2043
2191
|
|
|
2044
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2192
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2045
2193
|
|
|
2046
2194
|
### HTTP request headers
|
|
2047
2195
|
|
|
@@ -2064,6 +2212,11 @@ Delete the given loyalty card.
|
|
|
2064
2212
|
require 'talon_one'
|
|
2065
2213
|
# setup authorization
|
|
2066
2214
|
TalonOne.configure do |config|
|
|
2215
|
+
# Configure API key authorization: api_key_v1
|
|
2216
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2217
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2218
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2219
|
+
|
|
2067
2220
|
# Configure API key authorization: management_key
|
|
2068
2221
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2069
2222
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2101,7 +2254,7 @@ nil (empty response body)
|
|
|
2101
2254
|
|
|
2102
2255
|
### Authorization
|
|
2103
2256
|
|
|
2104
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2257
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2105
2258
|
|
|
2106
2259
|
### HTTP request headers
|
|
2107
2260
|
|
|
@@ -2124,6 +2277,11 @@ Delete the specified referral.
|
|
|
2124
2277
|
require 'talon_one'
|
|
2125
2278
|
# setup authorization
|
|
2126
2279
|
TalonOne.configure do |config|
|
|
2280
|
+
# Configure API key authorization: api_key_v1
|
|
2281
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2283
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2284
|
+
|
|
2127
2285
|
# Configure API key authorization: management_key
|
|
2128
2286
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2129
2287
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2163,7 +2321,7 @@ nil (empty response body)
|
|
|
2163
2321
|
|
|
2164
2322
|
### Authorization
|
|
2165
2323
|
|
|
2166
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2324
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2167
2325
|
|
|
2168
2326
|
### HTTP request headers
|
|
2169
2327
|
|
|
@@ -2186,6 +2344,11 @@ Delete the specified store.
|
|
|
2186
2344
|
require 'talon_one'
|
|
2187
2345
|
# setup authorization
|
|
2188
2346
|
TalonOne.configure do |config|
|
|
2347
|
+
# Configure API key authorization: api_key_v1
|
|
2348
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2349
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2350
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2351
|
+
|
|
2189
2352
|
# Configure API key authorization: management_key
|
|
2190
2353
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2191
2354
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2223,7 +2386,7 @@ nil (empty response body)
|
|
|
2223
2386
|
|
|
2224
2387
|
### Authorization
|
|
2225
2388
|
|
|
2226
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2389
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2227
2390
|
|
|
2228
2391
|
### HTTP request headers
|
|
2229
2392
|
|
|
@@ -2246,6 +2409,11 @@ Delete a specific user.
|
|
|
2246
2409
|
require 'talon_one'
|
|
2247
2410
|
# setup authorization
|
|
2248
2411
|
TalonOne.configure do |config|
|
|
2412
|
+
# Configure API key authorization: api_key_v1
|
|
2413
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2414
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2415
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2416
|
+
|
|
2249
2417
|
# Configure API key authorization: management_key
|
|
2250
2418
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2251
2419
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2281,7 +2449,7 @@ nil (empty response body)
|
|
|
2281
2449
|
|
|
2282
2450
|
### Authorization
|
|
2283
2451
|
|
|
2284
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2452
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2285
2453
|
|
|
2286
2454
|
### HTTP request headers
|
|
2287
2455
|
|
|
@@ -2304,6 +2472,11 @@ Delete user by email address
|
|
|
2304
2472
|
require 'talon_one'
|
|
2305
2473
|
# setup authorization
|
|
2306
2474
|
TalonOne.configure do |config|
|
|
2475
|
+
# Configure API key authorization: api_key_v1
|
|
2476
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2477
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2478
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2479
|
+
|
|
2307
2480
|
# Configure API key authorization: management_key
|
|
2308
2481
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2309
2482
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2339,7 +2512,7 @@ nil (empty response body)
|
|
|
2339
2512
|
|
|
2340
2513
|
### Authorization
|
|
2341
2514
|
|
|
2342
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2515
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2343
2516
|
|
|
2344
2517
|
### HTTP request headers
|
|
2345
2518
|
|
|
@@ -2362,6 +2535,11 @@ Destroys the session.
|
|
|
2362
2535
|
require 'talon_one'
|
|
2363
2536
|
# setup authorization
|
|
2364
2537
|
TalonOne.configure do |config|
|
|
2538
|
+
# Configure API key authorization: api_key_v1
|
|
2539
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2540
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2541
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2542
|
+
|
|
2365
2543
|
# Configure API key authorization: management_key
|
|
2366
2544
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2367
2545
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2393,7 +2571,7 @@ nil (empty response body)
|
|
|
2393
2571
|
|
|
2394
2572
|
### Authorization
|
|
2395
2573
|
|
|
2396
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2574
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2397
2575
|
|
|
2398
2576
|
### HTTP request headers
|
|
2399
2577
|
|
|
@@ -2416,6 +2594,11 @@ Disconnect the stores linked to a specific campaign.
|
|
|
2416
2594
|
require 'talon_one'
|
|
2417
2595
|
# setup authorization
|
|
2418
2596
|
TalonOne.configure do |config|
|
|
2597
|
+
# Configure API key authorization: api_key_v1
|
|
2598
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2599
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2600
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2601
|
+
|
|
2419
2602
|
# Configure API key authorization: management_key
|
|
2420
2603
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2421
2604
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2453,7 +2636,7 @@ nil (empty response body)
|
|
|
2453
2636
|
|
|
2454
2637
|
### Authorization
|
|
2455
2638
|
|
|
2456
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2639
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2457
2640
|
|
|
2458
2641
|
### HTTP request headers
|
|
2459
2642
|
|
|
@@ -2476,6 +2659,11 @@ Download a CSV file containing items from a given account-level collection. **T
|
|
|
2476
2659
|
require 'talon_one'
|
|
2477
2660
|
# setup authorization
|
|
2478
2661
|
TalonOne.configure do |config|
|
|
2662
|
+
# Configure API key authorization: api_key_v1
|
|
2663
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2664
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2665
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2666
|
+
|
|
2479
2667
|
# Configure API key authorization: management_key
|
|
2480
2668
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2481
2669
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2512,7 +2700,7 @@ Name | Type | Description | Notes
|
|
|
2512
2700
|
|
|
2513
2701
|
### Authorization
|
|
2514
2702
|
|
|
2515
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2703
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2516
2704
|
|
|
2517
2705
|
### HTTP request headers
|
|
2518
2706
|
|
|
@@ -2535,6 +2723,11 @@ Download a CSV file containing a list of all the customers who have participated
|
|
|
2535
2723
|
require 'talon_one'
|
|
2536
2724
|
# setup authorization
|
|
2537
2725
|
TalonOne.configure do |config|
|
|
2726
|
+
# Configure API key authorization: api_key_v1
|
|
2727
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2728
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2729
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2730
|
+
|
|
2538
2731
|
# Configure API key authorization: management_key
|
|
2539
2732
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2540
2733
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2575,7 +2768,7 @@ Name | Type | Description | Notes
|
|
|
2575
2768
|
|
|
2576
2769
|
### Authorization
|
|
2577
2770
|
|
|
2578
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2771
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2579
2772
|
|
|
2580
2773
|
### HTTP request headers
|
|
2581
2774
|
|
|
@@ -2598,6 +2791,11 @@ Download a CSV file containing the integration IDs of the members of an audience
|
|
|
2598
2791
|
require 'talon_one'
|
|
2599
2792
|
# setup authorization
|
|
2600
2793
|
TalonOne.configure do |config|
|
|
2794
|
+
# Configure API key authorization: api_key_v1
|
|
2795
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2796
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2797
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2798
|
+
|
|
2601
2799
|
# Configure API key authorization: management_key
|
|
2602
2800
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2603
2801
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2634,7 +2832,7 @@ Name | Type | Description | Notes
|
|
|
2634
2832
|
|
|
2635
2833
|
### Authorization
|
|
2636
2834
|
|
|
2637
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2835
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2638
2836
|
|
|
2639
2837
|
### HTTP request headers
|
|
2640
2838
|
|
|
@@ -2657,6 +2855,11 @@ Download a CSV file containing the store budgets for a given campaign. **Tip:**
|
|
|
2657
2855
|
require 'talon_one'
|
|
2658
2856
|
# setup authorization
|
|
2659
2857
|
TalonOne.configure do |config|
|
|
2858
|
+
# Configure API key authorization: api_key_v1
|
|
2859
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2860
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2861
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2862
|
+
|
|
2660
2863
|
# Configure API key authorization: management_key
|
|
2661
2864
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2662
2865
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2701,7 +2904,7 @@ Name | Type | Description | Notes
|
|
|
2701
2904
|
|
|
2702
2905
|
### Authorization
|
|
2703
2906
|
|
|
2704
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2907
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2705
2908
|
|
|
2706
2909
|
### HTTP request headers
|
|
2707
2910
|
|
|
@@ -2724,6 +2927,11 @@ Download a CSV file containing the stores linked to a specific campaign. **Tip:
|
|
|
2724
2927
|
require 'talon_one'
|
|
2725
2928
|
# setup authorization
|
|
2726
2929
|
TalonOne.configure do |config|
|
|
2930
|
+
# Configure API key authorization: api_key_v1
|
|
2931
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2932
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2933
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2934
|
+
|
|
2727
2935
|
# Configure API key authorization: management_key
|
|
2728
2936
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2729
2937
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2762,7 +2970,7 @@ Name | Type | Description | Notes
|
|
|
2762
2970
|
|
|
2763
2971
|
### Authorization
|
|
2764
2972
|
|
|
2765
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2973
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2766
2974
|
|
|
2767
2975
|
### HTTP request headers
|
|
2768
2976
|
|
|
@@ -2785,6 +2993,11 @@ Download a CSV file containing items from a given campaign-level collection. **
|
|
|
2785
2993
|
require 'talon_one'
|
|
2786
2994
|
# setup authorization
|
|
2787
2995
|
TalonOne.configure do |config|
|
|
2996
|
+
# Configure API key authorization: api_key_v1
|
|
2997
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2998
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2999
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3000
|
+
|
|
2788
3001
|
# Configure API key authorization: management_key
|
|
2789
3002
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2790
3003
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2825,7 +3038,7 @@ Name | Type | Description | Notes
|
|
|
2825
3038
|
|
|
2826
3039
|
### Authorization
|
|
2827
3040
|
|
|
2828
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3041
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2829
3042
|
|
|
2830
3043
|
### HTTP request headers
|
|
2831
3044
|
|
|
@@ -2848,6 +3061,11 @@ Download a CSV file containing the coupons that match the given properties. **T
|
|
|
2848
3061
|
require 'talon_one'
|
|
2849
3062
|
# setup authorization
|
|
2850
3063
|
TalonOne.configure do |config|
|
|
3064
|
+
# Configure API key authorization: api_key_v1
|
|
3065
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3066
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3067
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3068
|
+
|
|
2851
3069
|
# Configure API key authorization: management_key
|
|
2852
3070
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2853
3071
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2914,7 +3132,7 @@ Name | Type | Description | Notes
|
|
|
2914
3132
|
|
|
2915
3133
|
### Authorization
|
|
2916
3134
|
|
|
2917
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3135
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2918
3136
|
|
|
2919
3137
|
### HTTP request headers
|
|
2920
3138
|
|
|
@@ -2937,6 +3155,11 @@ Download a CSV file containing the customer sessions that match the request. **
|
|
|
2937
3155
|
require 'talon_one'
|
|
2938
3156
|
# setup authorization
|
|
2939
3157
|
TalonOne.configure do |config|
|
|
3158
|
+
# Configure API key authorization: api_key_v1
|
|
3159
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3161
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3162
|
+
|
|
2940
3163
|
# Configure API key authorization: management_key
|
|
2941
3164
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2942
3165
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2985,7 +3208,7 @@ Name | Type | Description | Notes
|
|
|
2985
3208
|
|
|
2986
3209
|
### Authorization
|
|
2987
3210
|
|
|
2988
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3211
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2989
3212
|
|
|
2990
3213
|
### HTTP request headers
|
|
2991
3214
|
|
|
@@ -3008,6 +3231,11 @@ Download a CSV file containing the tier information for customers of the specifi
|
|
|
3008
3231
|
require 'talon_one'
|
|
3009
3232
|
# setup authorization
|
|
3010
3233
|
TalonOne.configure do |config|
|
|
3234
|
+
# Configure API key authorization: api_key_v1
|
|
3235
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3236
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3237
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3238
|
+
|
|
3011
3239
|
# Configure API key authorization: management_key
|
|
3012
3240
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3013
3241
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3050,7 +3278,7 @@ Name | Type | Description | Notes
|
|
|
3050
3278
|
|
|
3051
3279
|
### Authorization
|
|
3052
3280
|
|
|
3053
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3281
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3054
3282
|
|
|
3055
3283
|
### HTTP request headers
|
|
3056
3284
|
|
|
@@ -3073,6 +3301,11 @@ Download a CSV file containing the triggered effects that match the given attrib
|
|
|
3073
3301
|
require 'talon_one'
|
|
3074
3302
|
# setup authorization
|
|
3075
3303
|
TalonOne.configure do |config|
|
|
3304
|
+
# Configure API key authorization: api_key_v1
|
|
3305
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3307
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3308
|
+
|
|
3076
3309
|
# Configure API key authorization: management_key
|
|
3077
3310
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3078
3311
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3119,7 +3352,7 @@ Name | Type | Description | Notes
|
|
|
3119
3352
|
|
|
3120
3353
|
### Authorization
|
|
3121
3354
|
|
|
3122
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3355
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3123
3356
|
|
|
3124
3357
|
### HTTP request headers
|
|
3125
3358
|
|
|
@@ -3142,6 +3375,11 @@ Export customer loyalty balance to CSV
|
|
|
3142
3375
|
require 'talon_one'
|
|
3143
3376
|
# setup authorization
|
|
3144
3377
|
TalonOne.configure do |config|
|
|
3378
|
+
# Configure API key authorization: api_key_v1
|
|
3379
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3380
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3381
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3382
|
+
|
|
3145
3383
|
# Configure API key authorization: management_key
|
|
3146
3384
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3147
3385
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3182,7 +3420,7 @@ Name | Type | Description | Notes
|
|
|
3182
3420
|
|
|
3183
3421
|
### Authorization
|
|
3184
3422
|
|
|
3185
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3423
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3186
3424
|
|
|
3187
3425
|
### HTTP request headers
|
|
3188
3426
|
|
|
@@ -3205,6 +3443,11 @@ Download a CSV file containing the balance of each customer in the loyalty progr
|
|
|
3205
3443
|
require 'talon_one'
|
|
3206
3444
|
# setup authorization
|
|
3207
3445
|
TalonOne.configure do |config|
|
|
3446
|
+
# Configure API key authorization: api_key_v1
|
|
3447
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3448
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3449
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3450
|
+
|
|
3208
3451
|
# Configure API key authorization: management_key
|
|
3209
3452
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3210
3453
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3245,7 +3488,7 @@ Name | Type | Description | Notes
|
|
|
3245
3488
|
|
|
3246
3489
|
### Authorization
|
|
3247
3490
|
|
|
3248
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3491
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3249
3492
|
|
|
3250
3493
|
### HTTP request headers
|
|
3251
3494
|
|
|
@@ -3268,6 +3511,11 @@ Download a CSV file containing the balances of all cards in the loyalty program.
|
|
|
3268
3511
|
require 'talon_one'
|
|
3269
3512
|
# setup authorization
|
|
3270
3513
|
TalonOne.configure do |config|
|
|
3514
|
+
# Configure API key authorization: api_key_v1
|
|
3515
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3516
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3517
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3518
|
+
|
|
3271
3519
|
# Configure API key authorization: management_key
|
|
3272
3520
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3273
3521
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3308,7 +3556,7 @@ Name | Type | Description | Notes
|
|
|
3308
3556
|
|
|
3309
3557
|
### Authorization
|
|
3310
3558
|
|
|
3311
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3559
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3312
3560
|
|
|
3313
3561
|
### HTTP request headers
|
|
3314
3562
|
|
|
@@ -3331,6 +3579,11 @@ Download a CSV file containing a loyalty card ledger log of the loyalty program.
|
|
|
3331
3579
|
require 'talon_one'
|
|
3332
3580
|
# setup authorization
|
|
3333
3581
|
TalonOne.configure do |config|
|
|
3582
|
+
# Configure API key authorization: api_key_v1
|
|
3583
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3584
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3585
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3586
|
+
|
|
3334
3587
|
# Configure API key authorization: management_key
|
|
3335
3588
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3336
3589
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3377,7 +3630,7 @@ Name | Type | Description | Notes
|
|
|
3377
3630
|
|
|
3378
3631
|
### Authorization
|
|
3379
3632
|
|
|
3380
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3633
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3381
3634
|
|
|
3382
3635
|
### HTTP request headers
|
|
3383
3636
|
|
|
@@ -3400,6 +3653,11 @@ Download a CSV file containing the loyalty cards from a specified loyalty progra
|
|
|
3400
3653
|
require 'talon_one'
|
|
3401
3654
|
# setup authorization
|
|
3402
3655
|
TalonOne.configure do |config|
|
|
3656
|
+
# Configure API key authorization: api_key_v1
|
|
3657
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3658
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3659
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3660
|
+
|
|
3403
3661
|
# Configure API key authorization: management_key
|
|
3404
3662
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3405
3663
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3446,7 +3704,7 @@ Name | Type | Description | Notes
|
|
|
3446
3704
|
|
|
3447
3705
|
### Authorization
|
|
3448
3706
|
|
|
3449
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3707
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3450
3708
|
|
|
3451
3709
|
### HTTP request headers
|
|
3452
3710
|
|
|
@@ -3460,7 +3718,7 @@ Name | Type | Description | Notes
|
|
|
3460
3718
|
|
|
3461
3719
|
Export customer's transaction logs
|
|
3462
3720
|
|
|
3463
|
-
Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
|
3721
|
+
Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance. - `transactionUUID`: Unique identifier of the transaction in the UUID format.
|
|
3464
3722
|
|
|
3465
3723
|
### Example
|
|
3466
3724
|
|
|
@@ -3469,6 +3727,11 @@ Download a CSV file containing a customer's transaction logs in the loyalty prog
|
|
|
3469
3727
|
require 'talon_one'
|
|
3470
3728
|
# setup authorization
|
|
3471
3729
|
TalonOne.configure do |config|
|
|
3730
|
+
# Configure API key authorization: api_key_v1
|
|
3731
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3732
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3733
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3734
|
+
|
|
3472
3735
|
# Configure API key authorization: management_key
|
|
3473
3736
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3474
3737
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3515,7 +3778,7 @@ Name | Type | Description | Notes
|
|
|
3515
3778
|
|
|
3516
3779
|
### Authorization
|
|
3517
3780
|
|
|
3518
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3781
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3519
3782
|
|
|
3520
3783
|
### HTTP request headers
|
|
3521
3784
|
|
|
@@ -3538,6 +3801,11 @@ Download a CSV file containing the giveaway codes of a specific giveaway pool.
|
|
|
3538
3801
|
require 'talon_one'
|
|
3539
3802
|
# setup authorization
|
|
3540
3803
|
TalonOne.configure do |config|
|
|
3804
|
+
# Configure API key authorization: api_key_v1
|
|
3805
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3806
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3807
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3808
|
+
|
|
3541
3809
|
# Configure API key authorization: management_key
|
|
3542
3810
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3543
3811
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3580,7 +3848,7 @@ Name | Type | Description | Notes
|
|
|
3580
3848
|
|
|
3581
3849
|
### Authorization
|
|
3582
3850
|
|
|
3583
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3851
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3584
3852
|
|
|
3585
3853
|
### HTTP request headers
|
|
3586
3854
|
|
|
@@ -3603,6 +3871,11 @@ Download a CSV file containing the referrals that match the given parameters. *
|
|
|
3603
3871
|
require 'talon_one'
|
|
3604
3872
|
# setup authorization
|
|
3605
3873
|
TalonOne.configure do |config|
|
|
3874
|
+
# Configure API key authorization: api_key_v1
|
|
3875
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3876
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3877
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3878
|
+
|
|
3606
3879
|
# Configure API key authorization: management_key
|
|
3607
3880
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3608
3881
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3655,7 +3928,7 @@ Name | Type | Description | Notes
|
|
|
3655
3928
|
|
|
3656
3929
|
### Authorization
|
|
3657
3930
|
|
|
3658
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3931
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3659
3932
|
|
|
3660
3933
|
### HTTP request headers
|
|
3661
3934
|
|
|
@@ -3678,6 +3951,11 @@ Retrieve the list of API calls sent to the specified Application.
|
|
|
3678
3951
|
require 'talon_one'
|
|
3679
3952
|
# setup authorization
|
|
3680
3953
|
TalonOne.configure do |config|
|
|
3954
|
+
# Configure API key authorization: api_key_v1
|
|
3955
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3956
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
3957
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
3958
|
+
|
|
3681
3959
|
# Configure API key authorization: management_key
|
|
3682
3960
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3683
3961
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3732,7 +4010,7 @@ Name | Type | Description | Notes
|
|
|
3732
4010
|
|
|
3733
4011
|
### Authorization
|
|
3734
4012
|
|
|
3735
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4013
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3736
4014
|
|
|
3737
4015
|
### HTTP request headers
|
|
3738
4016
|
|
|
@@ -3755,6 +4033,11 @@ Return the details of your companies Talon.One account.
|
|
|
3755
4033
|
require 'talon_one'
|
|
3756
4034
|
# setup authorization
|
|
3757
4035
|
TalonOne.configure do |config|
|
|
4036
|
+
# Configure API key authorization: api_key_v1
|
|
4037
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4038
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4039
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4040
|
+
|
|
3758
4041
|
# Configure API key authorization: management_key
|
|
3759
4042
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3760
4043
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3791,7 +4074,7 @@ Name | Type | Description | Notes
|
|
|
3791
4074
|
|
|
3792
4075
|
### Authorization
|
|
3793
4076
|
|
|
3794
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4077
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3795
4078
|
|
|
3796
4079
|
### HTTP request headers
|
|
3797
4080
|
|
|
@@ -3814,6 +4097,11 @@ Return the analytics of your Talon.One account.
|
|
|
3814
4097
|
require 'talon_one'
|
|
3815
4098
|
# setup authorization
|
|
3816
4099
|
TalonOne.configure do |config|
|
|
4100
|
+
# Configure API key authorization: api_key_v1
|
|
4101
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4103
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4104
|
+
|
|
3817
4105
|
# Configure API key authorization: management_key
|
|
3818
4106
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3819
4107
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3850,7 +4138,7 @@ Name | Type | Description | Notes
|
|
|
3850
4138
|
|
|
3851
4139
|
### Authorization
|
|
3852
4140
|
|
|
3853
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4141
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3854
4142
|
|
|
3855
4143
|
### HTTP request headers
|
|
3856
4144
|
|
|
@@ -3873,6 +4161,11 @@ Retrieve a given account-level collection.
|
|
|
3873
4161
|
require 'talon_one'
|
|
3874
4162
|
# setup authorization
|
|
3875
4163
|
TalonOne.configure do |config|
|
|
4164
|
+
# Configure API key authorization: api_key_v1
|
|
4165
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4167
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4168
|
+
|
|
3876
4169
|
# Configure API key authorization: management_key
|
|
3877
4170
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3878
4171
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3909,7 +4202,7 @@ Name | Type | Description | Notes
|
|
|
3909
4202
|
|
|
3910
4203
|
### Authorization
|
|
3911
4204
|
|
|
3912
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4205
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3913
4206
|
|
|
3914
4207
|
### HTTP request headers
|
|
3915
4208
|
|
|
@@ -3932,6 +4225,11 @@ Get the details of a specific achievement.
|
|
|
3932
4225
|
require 'talon_one'
|
|
3933
4226
|
# setup authorization
|
|
3934
4227
|
TalonOne.configure do |config|
|
|
4228
|
+
# Configure API key authorization: api_key_v1
|
|
4229
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4230
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4231
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4232
|
+
|
|
3935
4233
|
# Configure API key authorization: management_key
|
|
3936
4234
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3937
4235
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3972,7 +4270,7 @@ Name | Type | Description | Notes
|
|
|
3972
4270
|
|
|
3973
4271
|
### Authorization
|
|
3974
4272
|
|
|
3975
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4273
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
3976
4274
|
|
|
3977
4275
|
### HTTP request headers
|
|
3978
4276
|
|
|
@@ -3995,6 +4293,11 @@ Returns the additional cost.
|
|
|
3995
4293
|
require 'talon_one'
|
|
3996
4294
|
# setup authorization
|
|
3997
4295
|
TalonOne.configure do |config|
|
|
4296
|
+
# Configure API key authorization: api_key_v1
|
|
4297
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4298
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4299
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4300
|
+
|
|
3998
4301
|
# Configure API key authorization: management_key
|
|
3999
4302
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4000
4303
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4031,7 +4334,7 @@ Name | Type | Description | Notes
|
|
|
4031
4334
|
|
|
4032
4335
|
### Authorization
|
|
4033
4336
|
|
|
4034
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4337
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4035
4338
|
|
|
4036
4339
|
### HTTP request headers
|
|
4037
4340
|
|
|
@@ -4054,6 +4357,11 @@ Returns all the defined additional costs for the account.
|
|
|
4054
4357
|
require 'talon_one'
|
|
4055
4358
|
# setup authorization
|
|
4056
4359
|
TalonOne.configure do |config|
|
|
4360
|
+
# Configure API key authorization: api_key_v1
|
|
4361
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4362
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4363
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4364
|
+
|
|
4057
4365
|
# Configure API key authorization: management_key
|
|
4058
4366
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4059
4367
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4096,7 +4404,7 @@ Name | Type | Description | Notes
|
|
|
4096
4404
|
|
|
4097
4405
|
### Authorization
|
|
4098
4406
|
|
|
4099
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4407
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4100
4408
|
|
|
4101
4409
|
### HTTP request headers
|
|
4102
4410
|
|
|
@@ -4119,6 +4427,11 @@ Get the application specified by the ID.
|
|
|
4119
4427
|
require 'talon_one'
|
|
4120
4428
|
# setup authorization
|
|
4121
4429
|
TalonOne.configure do |config|
|
|
4430
|
+
# Configure API key authorization: api_key_v1
|
|
4431
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4432
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4433
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4434
|
+
|
|
4122
4435
|
# Configure API key authorization: management_key
|
|
4123
4436
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4124
4437
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4155,7 +4468,7 @@ Name | Type | Description | Notes
|
|
|
4155
4468
|
|
|
4156
4469
|
### Authorization
|
|
4157
4470
|
|
|
4158
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4471
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4159
4472
|
|
|
4160
4473
|
### HTTP request headers
|
|
4161
4474
|
|
|
@@ -4178,6 +4491,11 @@ Display the health of the Application and show the last time the Application was
|
|
|
4178
4491
|
require 'talon_one'
|
|
4179
4492
|
# setup authorization
|
|
4180
4493
|
TalonOne.configure do |config|
|
|
4494
|
+
# Configure API key authorization: api_key_v1
|
|
4495
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4496
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4497
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4498
|
+
|
|
4181
4499
|
# Configure API key authorization: management_key
|
|
4182
4500
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4183
4501
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4214,7 +4532,7 @@ Name | Type | Description | Notes
|
|
|
4214
4532
|
|
|
4215
4533
|
### Authorization
|
|
4216
4534
|
|
|
4217
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4535
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4218
4536
|
|
|
4219
4537
|
### HTTP request headers
|
|
4220
4538
|
|
|
@@ -4237,6 +4555,11 @@ Retrieve the customers of the specified application.
|
|
|
4237
4555
|
require 'talon_one'
|
|
4238
4556
|
# setup authorization
|
|
4239
4557
|
TalonOne.configure do |config|
|
|
4558
|
+
# Configure API key authorization: api_key_v1
|
|
4559
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4560
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4561
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4562
|
+
|
|
4240
4563
|
# Configure API key authorization: management_key
|
|
4241
4564
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4242
4565
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4275,7 +4598,7 @@ Name | Type | Description | Notes
|
|
|
4275
4598
|
|
|
4276
4599
|
### Authorization
|
|
4277
4600
|
|
|
4278
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4601
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4279
4602
|
|
|
4280
4603
|
### HTTP request headers
|
|
4281
4604
|
|
|
@@ -4298,6 +4621,11 @@ List the friends referred by the specified customer profile in this Application.
|
|
|
4298
4621
|
require 'talon_one'
|
|
4299
4622
|
# setup authorization
|
|
4300
4623
|
TalonOne.configure do |config|
|
|
4624
|
+
# Configure API key authorization: api_key_v1
|
|
4625
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4626
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4627
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4628
|
+
|
|
4301
4629
|
# Configure API key authorization: management_key
|
|
4302
4630
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4303
4631
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4346,7 +4674,7 @@ Name | Type | Description | Notes
|
|
|
4346
4674
|
|
|
4347
4675
|
### Authorization
|
|
4348
4676
|
|
|
4349
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4677
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4350
4678
|
|
|
4351
4679
|
### HTTP request headers
|
|
4352
4680
|
|
|
@@ -4369,6 +4697,11 @@ List all the customers of the specified application.
|
|
|
4369
4697
|
require 'talon_one'
|
|
4370
4698
|
# setup authorization
|
|
4371
4699
|
TalonOne.configure do |config|
|
|
4700
|
+
# Configure API key authorization: api_key_v1
|
|
4701
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4702
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4703
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4704
|
+
|
|
4372
4705
|
# Configure API key authorization: management_key
|
|
4373
4706
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4374
4707
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4415,7 +4748,7 @@ Name | Type | Description | Notes
|
|
|
4415
4748
|
|
|
4416
4749
|
### Authorization
|
|
4417
4750
|
|
|
4418
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4751
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4419
4752
|
|
|
4420
4753
|
### HTTP request headers
|
|
4421
4754
|
|
|
@@ -4438,6 +4771,11 @@ Get a list of the application customers matching the provided criteria. The mat
|
|
|
4438
4771
|
require 'talon_one'
|
|
4439
4772
|
# setup authorization
|
|
4440
4773
|
TalonOne.configure do |config|
|
|
4774
|
+
# Configure API key authorization: api_key_v1
|
|
4775
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4776
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4777
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4778
|
+
|
|
4441
4779
|
# Configure API key authorization: management_key
|
|
4442
4780
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4443
4781
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4484,7 +4822,7 @@ Name | Type | Description | Notes
|
|
|
4484
4822
|
|
|
4485
4823
|
### Authorization
|
|
4486
4824
|
|
|
4487
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4825
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4488
4826
|
|
|
4489
4827
|
### HTTP request headers
|
|
4490
4828
|
|
|
@@ -4507,6 +4845,11 @@ Get all of the distinct values of the Event `type` property for events recorded
|
|
|
4507
4845
|
require 'talon_one'
|
|
4508
4846
|
# setup authorization
|
|
4509
4847
|
TalonOne.configure do |config|
|
|
4848
|
+
# Configure API key authorization: api_key_v1
|
|
4849
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4850
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4851
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4852
|
+
|
|
4510
4853
|
# Configure API key authorization: management_key
|
|
4511
4854
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4512
4855
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4551,7 +4894,7 @@ Name | Type | Description | Notes
|
|
|
4551
4894
|
|
|
4552
4895
|
### Authorization
|
|
4553
4896
|
|
|
4554
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4897
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4555
4898
|
|
|
4556
4899
|
### HTTP request headers
|
|
4557
4900
|
|
|
@@ -4574,6 +4917,11 @@ Lists all events recorded for an application. Instead of having the total number
|
|
|
4574
4917
|
require 'talon_one'
|
|
4575
4918
|
# setup authorization
|
|
4576
4919
|
TalonOne.configure do |config|
|
|
4920
|
+
# Configure API key authorization: api_key_v1
|
|
4921
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4922
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
4923
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
4924
|
+
|
|
4577
4925
|
# Configure API key authorization: management_key
|
|
4578
4926
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4579
4927
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4601,7 +4949,8 @@ opts = {
|
|
|
4601
4949
|
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
4602
4950
|
referral_code: 'referral_code_example', # String | Referral code
|
|
4603
4951
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
4604
|
-
campaign_query: 'campaign_query_example' # String | Campaign name filter for events
|
|
4952
|
+
campaign_query: 'campaign_query_example', # String | Campaign name filter for events
|
|
4953
|
+
effect_type: 'effect_type_example' # String | The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).
|
|
4605
4954
|
}
|
|
4606
4955
|
|
|
4607
4956
|
begin
|
|
@@ -4633,6 +4982,7 @@ Name | Type | Description | Notes
|
|
|
4633
4982
|
**referral_code** | **String**| Referral code | [optional]
|
|
4634
4983
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
4635
4984
|
**campaign_query** | **String**| Campaign name filter for events | [optional]
|
|
4985
|
+
**effect_type** | **String**| The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). | [optional]
|
|
4636
4986
|
|
|
4637
4987
|
### Return type
|
|
4638
4988
|
|
|
@@ -4640,7 +4990,7 @@ Name | Type | Description | Notes
|
|
|
4640
4990
|
|
|
4641
4991
|
### Authorization
|
|
4642
4992
|
|
|
4643
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4993
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4644
4994
|
|
|
4645
4995
|
### HTTP request headers
|
|
4646
4996
|
|
|
@@ -4663,6 +5013,11 @@ Get the details of the given session. You can list the sessions with the [List A
|
|
|
4663
5013
|
require 'talon_one'
|
|
4664
5014
|
# setup authorization
|
|
4665
5015
|
TalonOne.configure do |config|
|
|
5016
|
+
# Configure API key authorization: api_key_v1
|
|
5017
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5018
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5019
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5020
|
+
|
|
4666
5021
|
# Configure API key authorization: management_key
|
|
4667
5022
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4668
5023
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4701,7 +5056,7 @@ Name | Type | Description | Notes
|
|
|
4701
5056
|
|
|
4702
5057
|
### Authorization
|
|
4703
5058
|
|
|
4704
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5059
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4705
5060
|
|
|
4706
5061
|
### HTTP request headers
|
|
4707
5062
|
|
|
@@ -4724,6 +5079,11 @@ List all the sessions of the specified Application.
|
|
|
4724
5079
|
require 'talon_one'
|
|
4725
5080
|
# setup authorization
|
|
4726
5081
|
TalonOne.configure do |config|
|
|
5082
|
+
# Configure API key authorization: api_key_v1
|
|
5083
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5084
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5085
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5086
|
+
|
|
4727
5087
|
# Configure API key authorization: management_key
|
|
4728
5088
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4729
5089
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4784,7 +5144,7 @@ Name | Type | Description | Notes
|
|
|
4784
5144
|
|
|
4785
5145
|
### Authorization
|
|
4786
5146
|
|
|
4787
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5147
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4788
5148
|
|
|
4789
5149
|
### HTTP request headers
|
|
4790
5150
|
|
|
@@ -4807,6 +5167,11 @@ List all applications in the current account.
|
|
|
4807
5167
|
require 'talon_one'
|
|
4808
5168
|
# setup authorization
|
|
4809
5169
|
TalonOne.configure do |config|
|
|
5170
|
+
# Configure API key authorization: api_key_v1
|
|
5171
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5173
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5174
|
+
|
|
4810
5175
|
# Configure API key authorization: management_key
|
|
4811
5176
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4812
5177
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4849,7 +5214,7 @@ Name | Type | Description | Notes
|
|
|
4849
5214
|
|
|
4850
5215
|
### Authorization
|
|
4851
5216
|
|
|
4852
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5217
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4853
5218
|
|
|
4854
5219
|
### HTTP request headers
|
|
4855
5220
|
|
|
@@ -4872,6 +5237,11 @@ Retrieve the specified custom attribute.
|
|
|
4872
5237
|
require 'talon_one'
|
|
4873
5238
|
# setup authorization
|
|
4874
5239
|
TalonOne.configure do |config|
|
|
5240
|
+
# Configure API key authorization: api_key_v1
|
|
5241
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5242
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5243
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5244
|
+
|
|
4875
5245
|
# Configure API key authorization: management_key
|
|
4876
5246
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4877
5247
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4908,7 +5278,7 @@ Name | Type | Description | Notes
|
|
|
4908
5278
|
|
|
4909
5279
|
### Authorization
|
|
4910
5280
|
|
|
4911
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5281
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4912
5282
|
|
|
4913
5283
|
### HTTP request headers
|
|
4914
5284
|
|
|
@@ -4931,6 +5301,11 @@ Return all the custom attributes for the account.
|
|
|
4931
5301
|
require 'talon_one'
|
|
4932
5302
|
# setup authorization
|
|
4933
5303
|
TalonOne.configure do |config|
|
|
5304
|
+
# Configure API key authorization: api_key_v1
|
|
5305
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5306
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5307
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5308
|
+
|
|
4934
5309
|
# Configure API key authorization: management_key
|
|
4935
5310
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4936
5311
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4975,7 +5350,7 @@ Name | Type | Description | Notes
|
|
|
4975
5350
|
|
|
4976
5351
|
### Authorization
|
|
4977
5352
|
|
|
4978
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5353
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
4979
5354
|
|
|
4980
5355
|
### HTTP request headers
|
|
4981
5356
|
|
|
@@ -4998,6 +5373,11 @@ Get a paginated list of the customer profiles in a given audience. A maximum of
|
|
|
4998
5373
|
require 'talon_one'
|
|
4999
5374
|
# setup authorization
|
|
5000
5375
|
TalonOne.configure do |config|
|
|
5376
|
+
# Configure API key authorization: api_key_v1
|
|
5377
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5378
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5379
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5380
|
+
|
|
5001
5381
|
# Configure API key authorization: management_key
|
|
5002
5382
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5003
5383
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5044,7 +5424,7 @@ Name | Type | Description | Notes
|
|
|
5044
5424
|
|
|
5045
5425
|
### Authorization
|
|
5046
5426
|
|
|
5047
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5427
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5048
5428
|
|
|
5049
5429
|
### HTTP request headers
|
|
5050
5430
|
|
|
@@ -5067,6 +5447,11 @@ Get all audiences created in the account. To create an audience, use [Create aud
|
|
|
5067
5447
|
require 'talon_one'
|
|
5068
5448
|
# setup authorization
|
|
5069
5449
|
TalonOne.configure do |config|
|
|
5450
|
+
# Configure API key authorization: api_key_v1
|
|
5451
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5453
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5454
|
+
|
|
5070
5455
|
# Configure API key authorization: management_key
|
|
5071
5456
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5072
5457
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5111,7 +5496,7 @@ Name | Type | Description | Notes
|
|
|
5111
5496
|
|
|
5112
5497
|
### Authorization
|
|
5113
5498
|
|
|
5114
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5499
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5115
5500
|
|
|
5116
5501
|
### HTTP request headers
|
|
5117
5502
|
|
|
@@ -5134,6 +5519,11 @@ Get a list of audience IDs and their member count.
|
|
|
5134
5519
|
require 'talon_one'
|
|
5135
5520
|
# setup authorization
|
|
5136
5521
|
TalonOne.configure do |config|
|
|
5522
|
+
# Configure API key authorization: api_key_v1
|
|
5523
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5524
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5525
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5526
|
+
|
|
5137
5527
|
# Configure API key authorization: management_key
|
|
5138
5528
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5139
5529
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5174,7 +5564,7 @@ Name | Type | Description | Notes
|
|
|
5174
5564
|
|
|
5175
5565
|
### Authorization
|
|
5176
5566
|
|
|
5177
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5567
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5178
5568
|
|
|
5179
5569
|
### HTTP request headers
|
|
5180
5570
|
|
|
@@ -5197,6 +5587,11 @@ Retrieve the given campaign.
|
|
|
5197
5587
|
require 'talon_one'
|
|
5198
5588
|
# setup authorization
|
|
5199
5589
|
TalonOne.configure do |config|
|
|
5590
|
+
# Configure API key authorization: api_key_v1
|
|
5591
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5592
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5593
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5594
|
+
|
|
5200
5595
|
# Configure API key authorization: management_key
|
|
5201
5596
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5202
5597
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5235,7 +5630,7 @@ Name | Type | Description | Notes
|
|
|
5235
5630
|
|
|
5236
5631
|
### Authorization
|
|
5237
5632
|
|
|
5238
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5633
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5239
5634
|
|
|
5240
5635
|
### HTTP request headers
|
|
5241
5636
|
|
|
@@ -5258,6 +5653,11 @@ Retrieve statistical data about the performance of the given campaign.
|
|
|
5258
5653
|
require 'talon_one'
|
|
5259
5654
|
# setup authorization
|
|
5260
5655
|
TalonOne.configure do |config|
|
|
5656
|
+
# Configure API key authorization: api_key_v1
|
|
5657
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5658
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5659
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5660
|
+
|
|
5261
5661
|
# Configure API key authorization: management_key
|
|
5262
5662
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5263
5663
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5304,7 +5704,7 @@ Name | Type | Description | Notes
|
|
|
5304
5704
|
|
|
5305
5705
|
### Authorization
|
|
5306
5706
|
|
|
5307
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5707
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5308
5708
|
|
|
5309
5709
|
### HTTP request headers
|
|
5310
5710
|
|
|
@@ -5327,6 +5727,11 @@ Get a list of all the campaigns that match a set of attributes.
|
|
|
5327
5727
|
require 'talon_one'
|
|
5328
5728
|
# setup authorization
|
|
5329
5729
|
TalonOne.configure do |config|
|
|
5730
|
+
# Configure API key authorization: api_key_v1
|
|
5731
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5732
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5733
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5734
|
+
|
|
5330
5735
|
# Configure API key authorization: management_key
|
|
5331
5736
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5332
5737
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5375,7 +5780,7 @@ Name | Type | Description | Notes
|
|
|
5375
5780
|
|
|
5376
5781
|
### Authorization
|
|
5377
5782
|
|
|
5378
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5783
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5379
5784
|
|
|
5380
5785
|
### HTTP request headers
|
|
5381
5786
|
|
|
@@ -5398,6 +5803,11 @@ Get a campaign access group specified by its ID.
|
|
|
5398
5803
|
require 'talon_one'
|
|
5399
5804
|
# setup authorization
|
|
5400
5805
|
TalonOne.configure do |config|
|
|
5806
|
+
# Configure API key authorization: api_key_v1
|
|
5807
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5808
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5809
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5810
|
+
|
|
5401
5811
|
# Configure API key authorization: management_key
|
|
5402
5812
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5403
5813
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5434,7 +5844,7 @@ Name | Type | Description | Notes
|
|
|
5434
5844
|
|
|
5435
5845
|
### Authorization
|
|
5436
5846
|
|
|
5437
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5847
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5438
5848
|
|
|
5439
5849
|
### HTTP request headers
|
|
5440
5850
|
|
|
@@ -5457,6 +5867,11 @@ List the campaign access groups in the current account.
|
|
|
5457
5867
|
require 'talon_one'
|
|
5458
5868
|
# setup authorization
|
|
5459
5869
|
TalonOne.configure do |config|
|
|
5870
|
+
# Configure API key authorization: api_key_v1
|
|
5871
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5872
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5873
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5874
|
+
|
|
5460
5875
|
# Configure API key authorization: management_key
|
|
5461
5876
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5462
5877
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5499,7 +5914,7 @@ Name | Type | Description | Notes
|
|
|
5499
5914
|
|
|
5500
5915
|
### Authorization
|
|
5501
5916
|
|
|
5502
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5917
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5503
5918
|
|
|
5504
5919
|
### HTTP request headers
|
|
5505
5920
|
|
|
@@ -5522,6 +5937,11 @@ Retrieve a list of campaign templates.
|
|
|
5522
5937
|
require 'talon_one'
|
|
5523
5938
|
# setup authorization
|
|
5524
5939
|
TalonOne.configure do |config|
|
|
5940
|
+
# Configure API key authorization: api_key_v1
|
|
5941
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5942
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5943
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
5944
|
+
|
|
5525
5945
|
# Configure API key authorization: management_key
|
|
5526
5946
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5527
5947
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5572,7 +5992,7 @@ Name | Type | Description | Notes
|
|
|
5572
5992
|
|
|
5573
5993
|
### Authorization
|
|
5574
5994
|
|
|
5575
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5995
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5576
5996
|
|
|
5577
5997
|
### HTTP request headers
|
|
5578
5998
|
|
|
@@ -5595,6 +6015,11 @@ List the campaigns of the specified application that match your filter criteria.
|
|
|
5595
6015
|
require 'talon_one'
|
|
5596
6016
|
# setup authorization
|
|
5597
6017
|
TalonOne.configure do |config|
|
|
6018
|
+
# Configure API key authorization: api_key_v1
|
|
6019
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6020
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6021
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6022
|
+
|
|
5598
6023
|
# Configure API key authorization: management_key
|
|
5599
6024
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5600
6025
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5655,7 +6080,7 @@ Name | Type | Description | Notes
|
|
|
5655
6080
|
|
|
5656
6081
|
### Authorization
|
|
5657
6082
|
|
|
5658
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6083
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5659
6084
|
|
|
5660
6085
|
### HTTP request headers
|
|
5661
6086
|
|
|
@@ -5665,7 +6090,7 @@ Name | Type | Description | Notes
|
|
|
5665
6090
|
|
|
5666
6091
|
## get_changes
|
|
5667
6092
|
|
|
5668
|
-
>
|
|
6093
|
+
> InlineResponse20042 get_changes(opts)
|
|
5669
6094
|
|
|
5670
6095
|
Get audit logs for an account
|
|
5671
6096
|
|
|
@@ -5678,6 +6103,11 @@ Retrieve the audit logs displayed in **Accounts > Audit logs**.
|
|
|
5678
6103
|
require 'talon_one'
|
|
5679
6104
|
# setup authorization
|
|
5680
6105
|
TalonOne.configure do |config|
|
|
6106
|
+
# Configure API key authorization: api_key_v1
|
|
6107
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6108
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6109
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6110
|
+
|
|
5681
6111
|
# Configure API key authorization: management_key
|
|
5682
6112
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5683
6113
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5732,11 +6162,11 @@ Name | Type | Description | Notes
|
|
|
5732
6162
|
|
|
5733
6163
|
### Return type
|
|
5734
6164
|
|
|
5735
|
-
[**
|
|
6165
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
|
5736
6166
|
|
|
5737
6167
|
### Authorization
|
|
5738
6168
|
|
|
5739
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6169
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5740
6170
|
|
|
5741
6171
|
### HTTP request headers
|
|
5742
6172
|
|
|
@@ -5759,6 +6189,11 @@ Retrieve a given campaign-level collection.
|
|
|
5759
6189
|
require 'talon_one'
|
|
5760
6190
|
# setup authorization
|
|
5761
6191
|
TalonOne.configure do |config|
|
|
6192
|
+
# Configure API key authorization: api_key_v1
|
|
6193
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6195
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6196
|
+
|
|
5762
6197
|
# Configure API key authorization: management_key
|
|
5763
6198
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5764
6199
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5799,7 +6234,7 @@ Name | Type | Description | Notes
|
|
|
5799
6234
|
|
|
5800
6235
|
### Authorization
|
|
5801
6236
|
|
|
5802
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6237
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5803
6238
|
|
|
5804
6239
|
### HTTP request headers
|
|
5805
6240
|
|
|
@@ -5822,6 +6257,11 @@ Retrieve items from a given collection. You can retrieve items from both accoun
|
|
|
5822
6257
|
require 'talon_one'
|
|
5823
6258
|
# setup authorization
|
|
5824
6259
|
TalonOne.configure do |config|
|
|
6260
|
+
# Configure API key authorization: api_key_v1
|
|
6261
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6262
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6263
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6264
|
+
|
|
5825
6265
|
# Configure API key authorization: management_key
|
|
5826
6266
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5827
6267
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5864,7 +6304,7 @@ Name | Type | Description | Notes
|
|
|
5864
6304
|
|
|
5865
6305
|
### Authorization
|
|
5866
6306
|
|
|
5867
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6307
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5868
6308
|
|
|
5869
6309
|
### HTTP request headers
|
|
5870
6310
|
|
|
@@ -5887,6 +6327,11 @@ List all the coupons matching the specified criteria.
|
|
|
5887
6327
|
require 'talon_one'
|
|
5888
6328
|
# setup authorization
|
|
5889
6329
|
TalonOne.configure do |config|
|
|
6330
|
+
# Configure API key authorization: api_key_v1
|
|
6331
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6333
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6334
|
+
|
|
5890
6335
|
# Configure API key authorization: management_key
|
|
5891
6336
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5892
6337
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5963,7 +6408,7 @@ Name | Type | Description | Notes
|
|
|
5963
6408
|
|
|
5964
6409
|
### Authorization
|
|
5965
6410
|
|
|
5966
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6411
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
5967
6412
|
|
|
5968
6413
|
### HTTP request headers
|
|
5969
6414
|
|
|
@@ -5986,6 +6431,11 @@ Fetch the summary report of a given customer in the given application, in a time
|
|
|
5986
6431
|
require 'talon_one'
|
|
5987
6432
|
# setup authorization
|
|
5988
6433
|
TalonOne.configure do |config|
|
|
6434
|
+
# Configure API key authorization: api_key_v1
|
|
6435
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6436
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6437
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6438
|
+
|
|
5989
6439
|
# Configure API key authorization: management_key
|
|
5990
6440
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5991
6441
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6034,7 +6484,7 @@ Name | Type | Description | Notes
|
|
|
6034
6484
|
|
|
6035
6485
|
### Authorization
|
|
6036
6486
|
|
|
6037
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6487
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6038
6488
|
|
|
6039
6489
|
### HTTP request headers
|
|
6040
6490
|
|
|
@@ -6057,6 +6507,11 @@ Fetch summary reports for all application customers based on a time range. Inste
|
|
|
6057
6507
|
require 'talon_one'
|
|
6058
6508
|
# setup authorization
|
|
6059
6509
|
TalonOne.configure do |config|
|
|
6510
|
+
# Configure API key authorization: api_key_v1
|
|
6511
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6512
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6513
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6514
|
+
|
|
6060
6515
|
# Configure API key authorization: management_key
|
|
6061
6516
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6062
6517
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6113,7 +6568,7 @@ Name | Type | Description | Notes
|
|
|
6113
6568
|
|
|
6114
6569
|
### Authorization
|
|
6115
6570
|
|
|
6116
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6571
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6117
6572
|
|
|
6118
6573
|
### HTTP request headers
|
|
6119
6574
|
|
|
@@ -6136,6 +6591,11 @@ Fetch analytics for a given customer in the given application.
|
|
|
6136
6591
|
require 'talon_one'
|
|
6137
6592
|
# setup authorization
|
|
6138
6593
|
TalonOne.configure do |config|
|
|
6594
|
+
# Configure API key authorization: api_key_v1
|
|
6595
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6596
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6597
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6598
|
+
|
|
6139
6599
|
# Configure API key authorization: management_key
|
|
6140
6600
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6141
6601
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6182,7 +6642,7 @@ Name | Type | Description | Notes
|
|
|
6182
6642
|
|
|
6183
6643
|
### Authorization
|
|
6184
6644
|
|
|
6185
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6645
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6186
6646
|
|
|
6187
6647
|
### HTTP request headers
|
|
6188
6648
|
|
|
@@ -6205,6 +6665,11 @@ Return the details of the specified customer profile. <div class=\"redoc-sectio
|
|
|
6205
6665
|
require 'talon_one'
|
|
6206
6666
|
# setup authorization
|
|
6207
6667
|
TalonOne.configure do |config|
|
|
6668
|
+
# Configure API key authorization: api_key_v1
|
|
6669
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6670
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6671
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6672
|
+
|
|
6208
6673
|
# Configure API key authorization: management_key
|
|
6209
6674
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6210
6675
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6241,7 +6706,7 @@ Name | Type | Description | Notes
|
|
|
6241
6706
|
|
|
6242
6707
|
### Authorization
|
|
6243
6708
|
|
|
6244
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6709
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6245
6710
|
|
|
6246
6711
|
### HTTP request headers
|
|
6247
6712
|
|
|
@@ -6251,7 +6716,7 @@ Name | Type | Description | Notes
|
|
|
6251
6716
|
|
|
6252
6717
|
## get_customer_profile_achievement_progress
|
|
6253
6718
|
|
|
6254
|
-
>
|
|
6719
|
+
> InlineResponse20049 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
|
6255
6720
|
|
|
6256
6721
|
List customer achievements
|
|
6257
6722
|
|
|
@@ -6264,6 +6729,11 @@ For the given customer profile, list all the achievements that match your filter
|
|
|
6264
6729
|
require 'talon_one'
|
|
6265
6730
|
# setup authorization
|
|
6266
6731
|
TalonOne.configure do |config|
|
|
6732
|
+
# Configure API key authorization: api_key_v1
|
|
6733
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6734
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6735
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6736
|
+
|
|
6267
6737
|
# Configure API key authorization: management_key
|
|
6268
6738
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6269
6739
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6308,11 +6778,11 @@ Name | Type | Description | Notes
|
|
|
6308
6778
|
|
|
6309
6779
|
### Return type
|
|
6310
6780
|
|
|
6311
|
-
[**
|
|
6781
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
|
6312
6782
|
|
|
6313
6783
|
### Authorization
|
|
6314
6784
|
|
|
6315
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6785
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6316
6786
|
|
|
6317
6787
|
### HTTP request headers
|
|
6318
6788
|
|
|
@@ -6335,6 +6805,11 @@ List all customer profiles.
|
|
|
6335
6805
|
require 'talon_one'
|
|
6336
6806
|
# setup authorization
|
|
6337
6807
|
TalonOne.configure do |config|
|
|
6808
|
+
# Configure API key authorization: api_key_v1
|
|
6809
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6810
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6811
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6812
|
+
|
|
6338
6813
|
# Configure API key authorization: management_key
|
|
6339
6814
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6340
6815
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6377,7 +6852,7 @@ Name | Type | Description | Notes
|
|
|
6377
6852
|
|
|
6378
6853
|
### Authorization
|
|
6379
6854
|
|
|
6380
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6855
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6381
6856
|
|
|
6382
6857
|
### HTTP request headers
|
|
6383
6858
|
|
|
@@ -6400,6 +6875,11 @@ Get a list of the customer profiles matching the provided criteria. The match i
|
|
|
6400
6875
|
require 'talon_one'
|
|
6401
6876
|
# setup authorization
|
|
6402
6877
|
TalonOne.configure do |config|
|
|
6878
|
+
# Configure API key authorization: api_key_v1
|
|
6879
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6880
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6881
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6882
|
+
|
|
6403
6883
|
# Configure API key authorization: management_key
|
|
6404
6884
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6405
6885
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6444,7 +6924,7 @@ Name | Type | Description | Notes
|
|
|
6444
6924
|
|
|
6445
6925
|
### Authorization
|
|
6446
6926
|
|
|
6447
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6927
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6448
6928
|
|
|
6449
6929
|
### HTTP request headers
|
|
6450
6930
|
|
|
@@ -6467,6 +6947,11 @@ Retrieve the statistics displayed on the specified loyalty program's dashboard,
|
|
|
6467
6947
|
require 'talon_one'
|
|
6468
6948
|
# setup authorization
|
|
6469
6949
|
TalonOne.configure do |config|
|
|
6950
|
+
# Configure API key authorization: api_key_v1
|
|
6951
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6952
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
6953
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
6954
|
+
|
|
6470
6955
|
# Configure API key authorization: management_key
|
|
6471
6956
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6472
6957
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6511,7 +6996,7 @@ Name | Type | Description | Notes
|
|
|
6511
6996
|
|
|
6512
6997
|
### Authorization
|
|
6513
6998
|
|
|
6514
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6999
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6515
7000
|
|
|
6516
7001
|
### HTTP request headers
|
|
6517
7002
|
|
|
@@ -6521,7 +7006,7 @@ Name | Type | Description | Notes
|
|
|
6521
7006
|
|
|
6522
7007
|
## get_event_types
|
|
6523
7008
|
|
|
6524
|
-
>
|
|
7009
|
+
> InlineResponse20040 get_event_types(opts)
|
|
6525
7010
|
|
|
6526
7011
|
List event types
|
|
6527
7012
|
|
|
@@ -6534,6 +7019,11 @@ Fetch all event type definitions for your account.
|
|
|
6534
7019
|
require 'talon_one'
|
|
6535
7020
|
# setup authorization
|
|
6536
7021
|
TalonOne.configure do |config|
|
|
7022
|
+
# Configure API key authorization: api_key_v1
|
|
7023
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7024
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7025
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7026
|
+
|
|
6537
7027
|
# Configure API key authorization: management_key
|
|
6538
7028
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6539
7029
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6576,11 +7066,11 @@ Name | Type | Description | Notes
|
|
|
6576
7066
|
|
|
6577
7067
|
### Return type
|
|
6578
7068
|
|
|
6579
|
-
[**
|
|
7069
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
|
6580
7070
|
|
|
6581
7071
|
### Authorization
|
|
6582
7072
|
|
|
6583
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7073
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6584
7074
|
|
|
6585
7075
|
### HTTP request headers
|
|
6586
7076
|
|
|
@@ -6590,7 +7080,7 @@ Name | Type | Description | Notes
|
|
|
6590
7080
|
|
|
6591
7081
|
## get_exports
|
|
6592
7082
|
|
|
6593
|
-
>
|
|
7083
|
+
> InlineResponse20043 get_exports(opts)
|
|
6594
7084
|
|
|
6595
7085
|
Get exports
|
|
6596
7086
|
|
|
@@ -6603,6 +7093,11 @@ List all past exports
|
|
|
6603
7093
|
require 'talon_one'
|
|
6604
7094
|
# setup authorization
|
|
6605
7095
|
TalonOne.configure do |config|
|
|
7096
|
+
# Configure API key authorization: api_key_v1
|
|
7097
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7098
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7099
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7100
|
+
|
|
6606
7101
|
# Configure API key authorization: management_key
|
|
6607
7102
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6608
7103
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6645,11 +7140,11 @@ Name | Type | Description | Notes
|
|
|
6645
7140
|
|
|
6646
7141
|
### Return type
|
|
6647
7142
|
|
|
6648
|
-
[**
|
|
7143
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
|
6649
7144
|
|
|
6650
7145
|
### Authorization
|
|
6651
7146
|
|
|
6652
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7147
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6653
7148
|
|
|
6654
7149
|
### HTTP request headers
|
|
6655
7150
|
|
|
@@ -6672,6 +7167,11 @@ Get the given loyalty card.
|
|
|
6672
7167
|
require 'talon_one'
|
|
6673
7168
|
# setup authorization
|
|
6674
7169
|
TalonOne.configure do |config|
|
|
7170
|
+
# Configure API key authorization: api_key_v1
|
|
7171
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7172
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7173
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7174
|
+
|
|
6675
7175
|
# Configure API key authorization: management_key
|
|
6676
7176
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6677
7177
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6710,7 +7210,7 @@ Name | Type | Description | Notes
|
|
|
6710
7210
|
|
|
6711
7211
|
### Authorization
|
|
6712
7212
|
|
|
6713
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7213
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6714
7214
|
|
|
6715
7215
|
### HTTP request headers
|
|
6716
7216
|
|
|
@@ -6733,6 +7233,11 @@ Retrieve the transaction logs for the given [loyalty card](https://docs.talon.on
|
|
|
6733
7233
|
require 'talon_one'
|
|
6734
7234
|
# setup authorization
|
|
6735
7235
|
TalonOne.configure do |config|
|
|
7236
|
+
# Configure API key authorization: api_key_v1
|
|
7237
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7238
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7239
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7240
|
+
|
|
6736
7241
|
# Configure API key authorization: management_key
|
|
6737
7242
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6738
7243
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6752,7 +7257,9 @@ opts = {
|
|
|
6752
7257
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
6753
7258
|
page_size: 1000, # Integer | The number of items in the response.
|
|
6754
7259
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
6755
|
-
subledger_id: 'subledger_id_example' # String | The ID of the subledger by which we filter the data.
|
|
7260
|
+
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
7261
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
7262
|
+
transaction_uui_ds: ['transaction_uui_ds_example'] # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
6756
7263
|
}
|
|
6757
7264
|
|
|
6758
7265
|
begin
|
|
@@ -6776,6 +7283,8 @@ Name | Type | Description | Notes
|
|
|
6776
7283
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
|
6777
7284
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
6778
7285
|
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
7286
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
7287
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
6779
7288
|
|
|
6780
7289
|
### Return type
|
|
6781
7290
|
|
|
@@ -6783,7 +7292,7 @@ Name | Type | Description | Notes
|
|
|
6783
7292
|
|
|
6784
7293
|
### Authorization
|
|
6785
7294
|
|
|
6786
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7295
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6787
7296
|
|
|
6788
7297
|
### HTTP request headers
|
|
6789
7298
|
|
|
@@ -6806,6 +7315,11 @@ For the given card-based loyalty program, list the loyalty cards that match your
|
|
|
6806
7315
|
require 'talon_one'
|
|
6807
7316
|
# setup authorization
|
|
6808
7317
|
TalonOne.configure do |config|
|
|
7318
|
+
# Configure API key authorization: api_key_v1
|
|
7319
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7320
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7321
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7322
|
+
|
|
6809
7323
|
# Configure API key authorization: management_key
|
|
6810
7324
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6811
7325
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6856,7 +7370,7 @@ Name | Type | Description | Notes
|
|
|
6856
7370
|
|
|
6857
7371
|
### Authorization
|
|
6858
7372
|
|
|
6859
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7373
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6860
7374
|
|
|
6861
7375
|
### HTTP request headers
|
|
6862
7376
|
|
|
@@ -6879,6 +7393,11 @@ Get the loyalty ledger for this profile integration ID. To get the `integration
|
|
|
6879
7393
|
require 'talon_one'
|
|
6880
7394
|
# setup authorization
|
|
6881
7395
|
TalonOne.configure do |config|
|
|
7396
|
+
# Configure API key authorization: api_key_v1
|
|
7397
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7398
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7399
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7400
|
+
|
|
6882
7401
|
# Configure API key authorization: management_key
|
|
6883
7402
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6884
7403
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6917,7 +7436,7 @@ Name | Type | Description | Notes
|
|
|
6917
7436
|
|
|
6918
7437
|
### Authorization
|
|
6919
7438
|
|
|
6920
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7439
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6921
7440
|
|
|
6922
7441
|
### HTTP request headers
|
|
6923
7442
|
|
|
@@ -6940,6 +7459,11 @@ Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-
|
|
|
6940
7459
|
require 'talon_one'
|
|
6941
7460
|
# setup authorization
|
|
6942
7461
|
TalonOne.configure do |config|
|
|
7462
|
+
# Configure API key authorization: api_key_v1
|
|
7463
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7465
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7466
|
+
|
|
6943
7467
|
# Configure API key authorization: management_key
|
|
6944
7468
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6945
7469
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6976,7 +7500,7 @@ Name | Type | Description | Notes
|
|
|
6976
7500
|
|
|
6977
7501
|
### Authorization
|
|
6978
7502
|
|
|
6979
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7503
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
6980
7504
|
|
|
6981
7505
|
### HTTP request headers
|
|
6982
7506
|
|
|
@@ -6999,6 +7523,11 @@ Retrieve loyalty program transaction logs in a given loyalty program with filter
|
|
|
6999
7523
|
require 'talon_one'
|
|
7000
7524
|
# setup authorization
|
|
7001
7525
|
TalonOne.configure do |config|
|
|
7526
|
+
# Configure API key authorization: api_key_v1
|
|
7527
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7528
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7529
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7530
|
+
|
|
7002
7531
|
# Configure API key authorization: management_key
|
|
7003
7532
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7004
7533
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7015,6 +7544,8 @@ loyalty_program_id = 56 # Integer | Identifier of the loyalty program. You can g
|
|
|
7015
7544
|
opts = {
|
|
7016
7545
|
loyalty_transaction_type: 'loyalty_transaction_type_example', # String | Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
|
7017
7546
|
subledger_id: 'subledger_id_example', # String | The ID of the subledger by which we filter the data.
|
|
7547
|
+
customer_session_i_ds: ['customer_session_i_ds_example'], # Array<String> | Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions.
|
|
7548
|
+
transaction_uui_ds: ['transaction_uui_ds_example'], # Array<String> | Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions.
|
|
7018
7549
|
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
7019
7550
|
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
|
7020
7551
|
page_size: 50, # Integer | The number of items in the response.
|
|
@@ -7038,6 +7569,8 @@ Name | Type | Description | Notes
|
|
|
7038
7569
|
**loyalty_program_id** | **Integer**| Identifier of the loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
7039
7570
|
**loyalty_transaction_type** | **String**| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | [optional]
|
|
7040
7571
|
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
|
7572
|
+
**customer_session_i_ds** | [**Array<String>**](String.md)| Filter the results by a list of customer session IDs. To include multiple IDs, repeat the parameter for each one, for example, `?customerSessionIDs=id1&customerSessionIDs=id2`. The response contains only data associated with the specified sessions. | [optional]
|
|
7573
|
+
**transaction_uui_ds** | [**Array<String>**](String.md)| Filter the results by a list of transaction UUIDs. To include multiple IDs, repeat the parameter for each one, for example, `?transactionUUIDs=uuid1&transactionUUIDs=uuid2`. The response contains only data associated with the specified transactions. | [optional]
|
|
7041
7574
|
**start_date** | **DateTime**| Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
|
7042
7575
|
**end_date** | **DateTime**| Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | [optional]
|
|
7043
7576
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
|
@@ -7049,7 +7582,7 @@ Name | Type | Description | Notes
|
|
|
7049
7582
|
|
|
7050
7583
|
### Authorization
|
|
7051
7584
|
|
|
7052
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7585
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7053
7586
|
|
|
7054
7587
|
### HTTP request headers
|
|
7055
7588
|
|
|
@@ -7072,6 +7605,11 @@ List the loyalty programs of the account.
|
|
|
7072
7605
|
require 'talon_one'
|
|
7073
7606
|
# setup authorization
|
|
7074
7607
|
TalonOne.configure do |config|
|
|
7608
|
+
# Configure API key authorization: api_key_v1
|
|
7609
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7610
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7611
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7612
|
+
|
|
7075
7613
|
# Configure API key authorization: management_key
|
|
7076
7614
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7077
7615
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7104,7 +7642,7 @@ This endpoint does not need any parameter.
|
|
|
7104
7642
|
|
|
7105
7643
|
### Authorization
|
|
7106
7644
|
|
|
7107
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7645
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7108
7646
|
|
|
7109
7647
|
### HTTP request headers
|
|
7110
7648
|
|
|
@@ -7127,6 +7665,11 @@ Get loyalty program statistics
|
|
|
7127
7665
|
require 'talon_one'
|
|
7128
7666
|
# setup authorization
|
|
7129
7667
|
TalonOne.configure do |config|
|
|
7668
|
+
# Configure API key authorization: api_key_v1
|
|
7669
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7670
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7671
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7672
|
+
|
|
7130
7673
|
# Configure API key authorization: management_key
|
|
7131
7674
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7132
7675
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7163,7 +7706,7 @@ Name | Type | Description | Notes
|
|
|
7163
7706
|
|
|
7164
7707
|
### Authorization
|
|
7165
7708
|
|
|
7166
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7709
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7167
7710
|
|
|
7168
7711
|
### HTTP request headers
|
|
7169
7712
|
|
|
@@ -7186,6 +7729,11 @@ Retrieve all message log entries.
|
|
|
7186
7729
|
require 'talon_one'
|
|
7187
7730
|
# setup authorization
|
|
7188
7731
|
TalonOne.configure do |config|
|
|
7732
|
+
# Configure API key authorization: api_key_v1
|
|
7733
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7734
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7735
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7736
|
+
|
|
7189
7737
|
# Configure API key authorization: management_key
|
|
7190
7738
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7191
7739
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7203,8 +7751,8 @@ opts = {
|
|
|
7203
7751
|
message_id: 'message_id_example', # String | Filter results by message ID.
|
|
7204
7752
|
change_type: 'change_type_example', # String | Filter results by change type.
|
|
7205
7753
|
notification_i_ds: 'notification_i_ds_example', # String | Filter results by notification ID (include up to 30 values, separated by a comma).
|
|
7206
|
-
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.
|
|
7207
|
-
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.
|
|
7754
|
+
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. Use UTC time.
|
|
7755
|
+
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. Use UTC time.
|
|
7208
7756
|
cursor: 'cursor_example', # String | A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
|
7209
7757
|
period: 'period_example', # String | Filter results by time period. Choose between the available relative time frames.
|
|
7210
7758
|
is_successful: true, # Boolean | Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
|
|
@@ -7233,8 +7781,8 @@ Name | Type | Description | Notes
|
|
|
7233
7781
|
**message_id** | **String**| Filter results by message ID. | [optional]
|
|
7234
7782
|
**change_type** | **String**| Filter results by change type. | [optional]
|
|
7235
7783
|
**notification_i_ds** | **String**| Filter results by notification ID (include up to 30 values, separated by a comma). | [optional]
|
|
7236
|
-
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
|
|
7237
|
-
**created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string.
|
|
7784
|
+
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. Use UTC time. | [optional]
|
|
7785
|
+
**created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. Use UTC time. | [optional]
|
|
7238
7786
|
**cursor** | **String**| A specific unique value in the database. If this value is not given, the server fetches results starting with the first record. | [optional]
|
|
7239
7787
|
**period** | **String**| Filter results by time period. Choose between the available relative time frames. | [optional]
|
|
7240
7788
|
**is_successful** | **Boolean**| Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned. | [optional]
|
|
@@ -7250,7 +7798,7 @@ Name | Type | Description | Notes
|
|
|
7250
7798
|
|
|
7251
7799
|
### Authorization
|
|
7252
7800
|
|
|
7253
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7801
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7254
7802
|
|
|
7255
7803
|
### HTTP request headers
|
|
7256
7804
|
|
|
@@ -7273,6 +7821,11 @@ List all referrals of the specified campaign.
|
|
|
7273
7821
|
require 'talon_one'
|
|
7274
7822
|
# setup authorization
|
|
7275
7823
|
TalonOne.configure do |config|
|
|
7824
|
+
# Configure API key authorization: api_key_v1
|
|
7825
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7826
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7827
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7828
|
+
|
|
7276
7829
|
# Configure API key authorization: management_key
|
|
7277
7830
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7278
7831
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7331,7 +7884,7 @@ Name | Type | Description | Notes
|
|
|
7331
7884
|
|
|
7332
7885
|
### Authorization
|
|
7333
7886
|
|
|
7334
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7887
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7335
7888
|
|
|
7336
7889
|
### HTTP request headers
|
|
7337
7890
|
|
|
@@ -7354,6 +7907,11 @@ Get the details of a specific role. To see all the roles, use the [List roles](/
|
|
|
7354
7907
|
require 'talon_one'
|
|
7355
7908
|
# setup authorization
|
|
7356
7909
|
TalonOne.configure do |config|
|
|
7910
|
+
# Configure API key authorization: api_key_v1
|
|
7911
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7912
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7913
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7914
|
+
|
|
7357
7915
|
# Configure API key authorization: management_key
|
|
7358
7916
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7359
7917
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7390,7 +7948,7 @@ Name | Type | Description | Notes
|
|
|
7390
7948
|
|
|
7391
7949
|
### Authorization
|
|
7392
7950
|
|
|
7393
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7951
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7394
7952
|
|
|
7395
7953
|
### HTTP request headers
|
|
7396
7954
|
|
|
@@ -7413,6 +7971,11 @@ Retrieve the specified ruleset.
|
|
|
7413
7971
|
require 'talon_one'
|
|
7414
7972
|
# setup authorization
|
|
7415
7973
|
TalonOne.configure do |config|
|
|
7974
|
+
# Configure API key authorization: api_key_v1
|
|
7975
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7976
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7977
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7978
|
+
|
|
7416
7979
|
# Configure API key authorization: management_key
|
|
7417
7980
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7418
7981
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7453,7 +8016,7 @@ Name | Type | Description | Notes
|
|
|
7453
8016
|
|
|
7454
8017
|
### Authorization
|
|
7455
8018
|
|
|
7456
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8019
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7457
8020
|
|
|
7458
8021
|
### HTTP request headers
|
|
7459
8022
|
|
|
@@ -7476,6 +8039,11 @@ List all rulesets of this campaign. A ruleset is a revision of the rules of a ca
|
|
|
7476
8039
|
require 'talon_one'
|
|
7477
8040
|
# setup authorization
|
|
7478
8041
|
TalonOne.configure do |config|
|
|
8042
|
+
# Configure API key authorization: api_key_v1
|
|
8043
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8044
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8045
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8046
|
+
|
|
7479
8047
|
# Configure API key authorization: management_key
|
|
7480
8048
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7481
8049
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7522,7 +8090,7 @@ Name | Type | Description | Notes
|
|
|
7522
8090
|
|
|
7523
8091
|
### Authorization
|
|
7524
8092
|
|
|
7525
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8093
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7526
8094
|
|
|
7527
8095
|
### HTTP request headers
|
|
7528
8096
|
|
|
@@ -7545,6 +8113,11 @@ Get store details for a specific store ID.
|
|
|
7545
8113
|
require 'talon_one'
|
|
7546
8114
|
# setup authorization
|
|
7547
8115
|
TalonOne.configure do |config|
|
|
8116
|
+
# Configure API key authorization: api_key_v1
|
|
8117
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8118
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8119
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8120
|
+
|
|
7548
8121
|
# Configure API key authorization: management_key
|
|
7549
8122
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7550
8123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7583,7 +8156,7 @@ Name | Type | Description | Notes
|
|
|
7583
8156
|
|
|
7584
8157
|
### Authorization
|
|
7585
8158
|
|
|
7586
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8159
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7587
8160
|
|
|
7588
8161
|
### HTTP request headers
|
|
7589
8162
|
|
|
@@ -7606,6 +8179,11 @@ Retrieve the data (including an invitation code) for a user. Non-admin users can
|
|
|
7606
8179
|
require 'talon_one'
|
|
7607
8180
|
# setup authorization
|
|
7608
8181
|
TalonOne.configure do |config|
|
|
8182
|
+
# Configure API key authorization: api_key_v1
|
|
8183
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8184
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8185
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8186
|
+
|
|
7609
8187
|
# Configure API key authorization: management_key
|
|
7610
8188
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7611
8189
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7642,7 +8220,7 @@ Name | Type | Description | Notes
|
|
|
7642
8220
|
|
|
7643
8221
|
### Authorization
|
|
7644
8222
|
|
|
7645
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8223
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7646
8224
|
|
|
7647
8225
|
### HTTP request headers
|
|
7648
8226
|
|
|
@@ -7652,7 +8230,7 @@ Name | Type | Description | Notes
|
|
|
7652
8230
|
|
|
7653
8231
|
## get_users
|
|
7654
8232
|
|
|
7655
|
-
>
|
|
8233
|
+
> InlineResponse20041 get_users(opts)
|
|
7656
8234
|
|
|
7657
8235
|
List users in account
|
|
7658
8236
|
|
|
@@ -7665,6 +8243,11 @@ Retrieve all users in your account.
|
|
|
7665
8243
|
require 'talon_one'
|
|
7666
8244
|
# setup authorization
|
|
7667
8245
|
TalonOne.configure do |config|
|
|
8246
|
+
# Configure API key authorization: api_key_v1
|
|
8247
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8249
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8250
|
+
|
|
7668
8251
|
# Configure API key authorization: management_key
|
|
7669
8252
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7670
8253
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7703,11 +8286,11 @@ Name | Type | Description | Notes
|
|
|
7703
8286
|
|
|
7704
8287
|
### Return type
|
|
7705
8288
|
|
|
7706
|
-
[**
|
|
8289
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
|
7707
8290
|
|
|
7708
8291
|
### Authorization
|
|
7709
8292
|
|
|
7710
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8293
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7711
8294
|
|
|
7712
8295
|
### HTTP request headers
|
|
7713
8296
|
|
|
@@ -7730,173 +8313,31 @@ Returns a webhook by its id.
|
|
|
7730
8313
|
require 'talon_one'
|
|
7731
8314
|
# setup authorization
|
|
7732
8315
|
TalonOne.configure do |config|
|
|
7733
|
-
# Configure API key authorization:
|
|
7734
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7735
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7736
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7737
|
-
|
|
7738
|
-
# Configure API key authorization: manager_auth
|
|
8316
|
+
# Configure API key authorization: api_key_v1
|
|
7739
8317
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7740
8318
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7741
8319
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7742
|
-
end
|
|
7743
|
-
|
|
7744
|
-
api_instance = TalonOne::ManagementApi.new
|
|
7745
|
-
webhook_id = 56 # Integer | The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**.
|
|
7746
|
-
|
|
7747
|
-
begin
|
|
7748
|
-
#Get webhook
|
|
7749
|
-
result = api_instance.get_webhook(webhook_id)
|
|
7750
|
-
p result
|
|
7751
|
-
rescue TalonOne::ApiError => e
|
|
7752
|
-
puts "Exception when calling ManagementApi->get_webhook: #{e}"
|
|
7753
|
-
end
|
|
7754
|
-
```
|
|
7755
|
-
|
|
7756
|
-
### Parameters
|
|
7757
|
-
|
|
7758
|
-
|
|
7759
|
-
Name | Type | Description | Notes
|
|
7760
|
-
------------- | ------------- | ------------- | -------------
|
|
7761
|
-
**webhook_id** | **Integer**| The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**. |
|
|
7762
|
-
|
|
7763
|
-
### Return type
|
|
7764
|
-
|
|
7765
|
-
[**Webhook**](Webhook.md)
|
|
7766
|
-
|
|
7767
|
-
### Authorization
|
|
7768
|
-
|
|
7769
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7770
|
-
|
|
7771
|
-
### HTTP request headers
|
|
7772
|
-
|
|
7773
|
-
- **Content-Type**: Not defined
|
|
7774
|
-
- **Accept**: application/json
|
|
7775
|
-
|
|
7776
|
-
|
|
7777
|
-
## get_webhook_activation_logs
|
|
7778
|
-
|
|
7779
|
-
> InlineResponse20040 get_webhook_activation_logs(opts)
|
|
7780
|
-
|
|
7781
|
-
List webhook activation log entries
|
|
7782
|
-
|
|
7783
|
-
Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the [docs](https://docs.talon.one/docs/dev/getting-started/webhooks).
|
|
7784
8320
|
|
|
7785
|
-
### Example
|
|
7786
|
-
|
|
7787
|
-
```ruby
|
|
7788
|
-
# load the gem
|
|
7789
|
-
require 'talon_one'
|
|
7790
|
-
# setup authorization
|
|
7791
|
-
TalonOne.configure do |config|
|
|
7792
8321
|
# Configure API key authorization: management_key
|
|
7793
8322
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7794
8323
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7795
8324
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7796
8325
|
|
|
7797
8326
|
# Configure API key authorization: manager_auth
|
|
7798
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7799
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7800
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7801
|
-
end
|
|
7802
|
-
|
|
7803
|
-
api_instance = TalonOne::ManagementApi.new
|
|
7804
|
-
|
|
7805
|
-
page_size: 1000, # Integer | The number of items in the response.
|
|
7806
|
-
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
7807
|
-
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
7808
|
-
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
|
7809
|
-
webhook_id: 3.4, # Float | Filter results by webhook id.
|
|
7810
|
-
application_id: 3.4, # Float | Filter results by Application ID.
|
|
7811
|
-
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
|
7812
|
-
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
7813
|
-
created_after: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
7814
|
-
}
|
|
7815
|
-
|
|
7816
|
-
begin
|
|
7817
|
-
#List webhook activation log entries
|
|
7818
|
-
result = api_instance.get_webhook_activation_logs(opts)
|
|
7819
|
-
p result
|
|
7820
|
-
rescue TalonOne::ApiError => e
|
|
7821
|
-
puts "Exception when calling ManagementApi->get_webhook_activation_logs: #{e}"
|
|
7822
|
-
end
|
|
7823
|
-
```
|
|
7824
|
-
|
|
7825
|
-
### Parameters
|
|
7826
|
-
|
|
7827
|
-
|
|
7828
|
-
Name | Type | Description | Notes
|
|
7829
|
-
------------- | ------------- | ------------- | -------------
|
|
7830
|
-
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
|
7831
|
-
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
7832
|
-
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
|
|
7833
|
-
**integration_request_uuid** | **String**| Filter results by integration request UUID. | [optional]
|
|
7834
|
-
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
|
7835
|
-
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
|
7836
|
-
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
|
7837
|
-
**created_before** | **DateTime**| Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
|
7838
|
-
**created_after** | **DateTime**| Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
|
7839
|
-
|
|
7840
|
-
### Return type
|
|
7841
|
-
|
|
7842
|
-
[**InlineResponse20040**](InlineResponse20040.md)
|
|
7843
|
-
|
|
7844
|
-
### Authorization
|
|
7845
|
-
|
|
7846
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7847
|
-
|
|
7848
|
-
### HTTP request headers
|
|
7849
|
-
|
|
7850
|
-
- **Content-Type**: Not defined
|
|
7851
|
-
- **Accept**: application/json
|
|
7852
|
-
|
|
7853
|
-
|
|
7854
|
-
## get_webhook_logs
|
|
7855
|
-
|
|
7856
|
-
> InlineResponse20041 get_webhook_logs(opts)
|
|
7857
|
-
|
|
7858
|
-
List webhook log entries
|
|
7859
|
-
|
|
7860
|
-
Retrieve all webhook log entries.
|
|
7861
|
-
|
|
7862
|
-
### Example
|
|
7863
|
-
|
|
7864
|
-
```ruby
|
|
7865
|
-
# load the gem
|
|
7866
|
-
require 'talon_one'
|
|
7867
|
-
# setup authorization
|
|
7868
|
-
TalonOne.configure do |config|
|
|
7869
|
-
# Configure API key authorization: management_key
|
|
7870
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7871
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7872
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7873
|
-
|
|
7874
|
-
# Configure API key authorization: manager_auth
|
|
7875
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7876
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7877
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7878
|
-
end
|
|
7879
|
-
|
|
7880
|
-
api_instance = TalonOne::ManagementApi.new
|
|
7881
|
-
opts = {
|
|
7882
|
-
page_size: 1000, # Integer | The number of items in the response.
|
|
7883
|
-
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
7884
|
-
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
|
7885
|
-
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
7886
|
-
webhook_id: 3.4, # Float | Filter results by webhook id.
|
|
7887
|
-
application_id: 3.4, # Float | Filter results by Application ID.
|
|
7888
|
-
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
|
7889
|
-
request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
|
|
7890
|
-
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. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
7891
|
-
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. You can use any time zone setting. Talon.One will convert to UTC internally.
|
|
7892
|
-
}
|
|
8327
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8328
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8329
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8330
|
+
end
|
|
8331
|
+
|
|
8332
|
+
api_instance = TalonOne::ManagementApi.new
|
|
8333
|
+
webhook_id = 56 # Integer | The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**.
|
|
7893
8334
|
|
|
7894
8335
|
begin
|
|
7895
|
-
#
|
|
7896
|
-
result = api_instance.
|
|
8336
|
+
#Get webhook
|
|
8337
|
+
result = api_instance.get_webhook(webhook_id)
|
|
7897
8338
|
p result
|
|
7898
8339
|
rescue TalonOne::ApiError => e
|
|
7899
|
-
puts "Exception when calling ManagementApi->
|
|
8340
|
+
puts "Exception when calling ManagementApi->get_webhook: #{e}"
|
|
7900
8341
|
end
|
|
7901
8342
|
```
|
|
7902
8343
|
|
|
@@ -7905,24 +8346,15 @@ end
|
|
|
7905
8346
|
|
|
7906
8347
|
Name | Type | Description | Notes
|
|
7907
8348
|
------------- | ------------- | ------------- | -------------
|
|
7908
|
-
**
|
|
7909
|
-
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
7910
|
-
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
|
|
7911
|
-
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
7912
|
-
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
|
7913
|
-
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
|
7914
|
-
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
|
7915
|
-
**request_uuid** | **String**| Filter results by request UUID. | [optional]
|
|
7916
|
-
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
|
7917
|
-
**created_after** | **DateTime**| Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
|
8349
|
+
**webhook_id** | **Integer**| The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in **Account** > **Webhooks**. |
|
|
7918
8350
|
|
|
7919
8351
|
### Return type
|
|
7920
8352
|
|
|
7921
|
-
[**
|
|
8353
|
+
[**Webhook**](Webhook.md)
|
|
7922
8354
|
|
|
7923
8355
|
### Authorization
|
|
7924
8356
|
|
|
7925
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8357
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7926
8358
|
|
|
7927
8359
|
### HTTP request headers
|
|
7928
8360
|
|
|
@@ -7945,6 +8377,11 @@ List all webhooks.
|
|
|
7945
8377
|
require 'talon_one'
|
|
7946
8378
|
# setup authorization
|
|
7947
8379
|
TalonOne.configure do |config|
|
|
8380
|
+
# Configure API key authorization: api_key_v1
|
|
8381
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8382
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8383
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8384
|
+
|
|
7948
8385
|
# Configure API key authorization: management_key
|
|
7949
8386
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7950
8387
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7997,7 +8434,7 @@ Name | Type | Description | Notes
|
|
|
7997
8434
|
|
|
7998
8435
|
### Authorization
|
|
7999
8436
|
|
|
8000
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8437
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8001
8438
|
|
|
8002
8439
|
### HTTP request headers
|
|
8003
8440
|
|
|
@@ -8020,6 +8457,11 @@ Upload a CSV file containing the collection of string values that should be atta
|
|
|
8020
8457
|
require 'talon_one'
|
|
8021
8458
|
# setup authorization
|
|
8022
8459
|
TalonOne.configure do |config|
|
|
8460
|
+
# Configure API key authorization: api_key_v1
|
|
8461
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8462
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8463
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8464
|
+
|
|
8023
8465
|
# Configure API key authorization: management_key
|
|
8024
8466
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8025
8467
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8060,7 +8502,7 @@ Name | Type | Description | Notes
|
|
|
8060
8502
|
|
|
8061
8503
|
### Authorization
|
|
8062
8504
|
|
|
8063
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8505
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8064
8506
|
|
|
8065
8507
|
### HTTP request headers
|
|
8066
8508
|
|
|
@@ -8083,6 +8525,11 @@ Upload a CSV file containing a list of [picklist values](https://docs.talon.one/
|
|
|
8083
8525
|
require 'talon_one'
|
|
8084
8526
|
# setup authorization
|
|
8085
8527
|
TalonOne.configure do |config|
|
|
8528
|
+
# Configure API key authorization: api_key_v1
|
|
8529
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8530
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8531
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8532
|
+
|
|
8086
8533
|
# Configure API key authorization: management_key
|
|
8087
8534
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8088
8535
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8123,7 +8570,7 @@ Name | Type | Description | Notes
|
|
|
8123
8570
|
|
|
8124
8571
|
### Authorization
|
|
8125
8572
|
|
|
8126
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8573
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8127
8574
|
|
|
8128
8575
|
### HTTP request headers
|
|
8129
8576
|
|
|
@@ -8146,6 +8593,11 @@ Upload a CSV file containing the integration IDs of the members you want to add
|
|
|
8146
8593
|
require 'talon_one'
|
|
8147
8594
|
# setup authorization
|
|
8148
8595
|
TalonOne.configure do |config|
|
|
8596
|
+
# Configure API key authorization: api_key_v1
|
|
8597
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8598
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8599
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8600
|
+
|
|
8149
8601
|
# Configure API key authorization: management_key
|
|
8150
8602
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8151
8603
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8186,7 +8638,7 @@ Name | Type | Description | Notes
|
|
|
8186
8638
|
|
|
8187
8639
|
### Authorization
|
|
8188
8640
|
|
|
8189
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8641
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8190
8642
|
|
|
8191
8643
|
### HTTP request headers
|
|
8192
8644
|
|
|
@@ -8209,6 +8661,11 @@ Upload a CSV file containing store budgets for a given campaign. Send the file
|
|
|
8209
8661
|
require 'talon_one'
|
|
8210
8662
|
# setup authorization
|
|
8211
8663
|
TalonOne.configure do |config|
|
|
8664
|
+
# Configure API key authorization: api_key_v1
|
|
8665
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8666
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8667
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8668
|
+
|
|
8212
8669
|
# Configure API key authorization: management_key
|
|
8213
8670
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8214
8671
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8255,7 +8712,7 @@ Name | Type | Description | Notes
|
|
|
8255
8712
|
|
|
8256
8713
|
### Authorization
|
|
8257
8714
|
|
|
8258
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8715
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8259
8716
|
|
|
8260
8717
|
### HTTP request headers
|
|
8261
8718
|
|
|
@@ -8278,6 +8735,11 @@ Upload a CSV file containing the stores you want to link to a specific campaign.
|
|
|
8278
8735
|
require 'talon_one'
|
|
8279
8736
|
# setup authorization
|
|
8280
8737
|
TalonOne.configure do |config|
|
|
8738
|
+
# Configure API key authorization: api_key_v1
|
|
8739
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8740
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8741
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8742
|
+
|
|
8281
8743
|
# Configure API key authorization: management_key
|
|
8282
8744
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8283
8745
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8320,7 +8782,7 @@ Name | Type | Description | Notes
|
|
|
8320
8782
|
|
|
8321
8783
|
### Authorization
|
|
8322
8784
|
|
|
8323
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8785
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8324
8786
|
|
|
8325
8787
|
### HTTP request headers
|
|
8326
8788
|
|
|
@@ -8343,6 +8805,11 @@ Upload a CSV file containing the collection of string values that should be atta
|
|
|
8343
8805
|
require 'talon_one'
|
|
8344
8806
|
# setup authorization
|
|
8345
8807
|
TalonOne.configure do |config|
|
|
8808
|
+
# Configure API key authorization: api_key_v1
|
|
8809
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8810
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8811
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8812
|
+
|
|
8346
8813
|
# Configure API key authorization: management_key
|
|
8347
8814
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8348
8815
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8387,7 +8854,7 @@ Name | Type | Description | Notes
|
|
|
8387
8854
|
|
|
8388
8855
|
### Authorization
|
|
8389
8856
|
|
|
8390
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8857
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8391
8858
|
|
|
8392
8859
|
### HTTP request headers
|
|
8393
8860
|
|
|
@@ -8410,6 +8877,11 @@ Upload a CSV file containing the coupons that should be created. The file should
|
|
|
8410
8877
|
require 'talon_one'
|
|
8411
8878
|
# setup authorization
|
|
8412
8879
|
TalonOne.configure do |config|
|
|
8880
|
+
# Configure API key authorization: api_key_v1
|
|
8881
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8882
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8883
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8884
|
+
|
|
8413
8885
|
# Configure API key authorization: management_key
|
|
8414
8886
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8415
8887
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8454,7 +8926,7 @@ Name | Type | Description | Notes
|
|
|
8454
8926
|
|
|
8455
8927
|
### Authorization
|
|
8456
8928
|
|
|
8457
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8929
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8458
8930
|
|
|
8459
8931
|
### HTTP request headers
|
|
8460
8932
|
|
|
@@ -8477,6 +8949,11 @@ Upload a CSV file containing the loyalty cards that you want to use in your card
|
|
|
8477
8949
|
require 'talon_one'
|
|
8478
8950
|
# setup authorization
|
|
8479
8951
|
TalonOne.configure do |config|
|
|
8952
|
+
# Configure API key authorization: api_key_v1
|
|
8953
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8954
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8955
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8956
|
+
|
|
8480
8957
|
# Configure API key authorization: management_key
|
|
8481
8958
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8482
8959
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8517,7 +8994,7 @@ Name | Type | Description | Notes
|
|
|
8517
8994
|
|
|
8518
8995
|
### Authorization
|
|
8519
8996
|
|
|
8520
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8997
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8521
8998
|
|
|
8522
8999
|
### HTTP request headers
|
|
8523
9000
|
|
|
@@ -8540,6 +9017,11 @@ Upload a CSV file containing existing customers to be assigned to existing tiers
|
|
|
8540
9017
|
require 'talon_one'
|
|
8541
9018
|
# setup authorization
|
|
8542
9019
|
TalonOne.configure do |config|
|
|
9020
|
+
# Configure API key authorization: api_key_v1
|
|
9021
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9022
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9023
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9024
|
+
|
|
8543
9025
|
# Configure API key authorization: management_key
|
|
8544
9026
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8545
9027
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8580,7 +9062,7 @@ Name | Type | Description | Notes
|
|
|
8580
9062
|
|
|
8581
9063
|
### Authorization
|
|
8582
9064
|
|
|
8583
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9065
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8584
9066
|
|
|
8585
9067
|
### HTTP request headers
|
|
8586
9068
|
|
|
@@ -8603,6 +9085,11 @@ Upload a CSV file containing the loyalty points you want to import into a given
|
|
|
8603
9085
|
require 'talon_one'
|
|
8604
9086
|
# setup authorization
|
|
8605
9087
|
TalonOne.configure do |config|
|
|
9088
|
+
# Configure API key authorization: api_key_v1
|
|
9089
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9090
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9091
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9092
|
+
|
|
8606
9093
|
# Configure API key authorization: management_key
|
|
8607
9094
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8608
9095
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8645,7 +9132,7 @@ Name | Type | Description | Notes
|
|
|
8645
9132
|
|
|
8646
9133
|
### Authorization
|
|
8647
9134
|
|
|
8648
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9135
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8649
9136
|
|
|
8650
9137
|
### HTTP request headers
|
|
8651
9138
|
|
|
@@ -8668,6 +9155,11 @@ Upload a CSV file containing the giveaway codes that should be created. Send the
|
|
|
8668
9155
|
require 'talon_one'
|
|
8669
9156
|
# setup authorization
|
|
8670
9157
|
TalonOne.configure do |config|
|
|
9158
|
+
# Configure API key authorization: api_key_v1
|
|
9159
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9160
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9161
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9162
|
+
|
|
8671
9163
|
# Configure API key authorization: management_key
|
|
8672
9164
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8673
9165
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8708,7 +9200,7 @@ Name | Type | Description | Notes
|
|
|
8708
9200
|
|
|
8709
9201
|
### Authorization
|
|
8710
9202
|
|
|
8711
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9203
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8712
9204
|
|
|
8713
9205
|
### HTTP request headers
|
|
8714
9206
|
|
|
@@ -8731,6 +9223,11 @@ Upload a CSV file containing the referrals that should be created. The file shou
|
|
|
8731
9223
|
require 'talon_one'
|
|
8732
9224
|
# setup authorization
|
|
8733
9225
|
TalonOne.configure do |config|
|
|
9226
|
+
# Configure API key authorization: api_key_v1
|
|
9227
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9228
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9229
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9230
|
+
|
|
8734
9231
|
# Configure API key authorization: management_key
|
|
8735
9232
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8736
9233
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8773,7 +9270,7 @@ Name | Type | Description | Notes
|
|
|
8773
9270
|
|
|
8774
9271
|
### Authorization
|
|
8775
9272
|
|
|
8776
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9273
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8777
9274
|
|
|
8778
9275
|
### HTTP request headers
|
|
8779
9276
|
|
|
@@ -8796,6 +9293,11 @@ Invite user from identity provider
|
|
|
8796
9293
|
require 'talon_one'
|
|
8797
9294
|
# setup authorization
|
|
8798
9295
|
TalonOne.configure do |config|
|
|
9296
|
+
# Configure API key authorization: api_key_v1
|
|
9297
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9298
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9299
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9300
|
+
|
|
8799
9301
|
# Configure API key authorization: management_key
|
|
8800
9302
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8801
9303
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8831,7 +9333,7 @@ nil (empty response body)
|
|
|
8831
9333
|
|
|
8832
9334
|
### Authorization
|
|
8833
9335
|
|
|
8834
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9336
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8835
9337
|
|
|
8836
9338
|
### HTTP request headers
|
|
8837
9339
|
|
|
@@ -8854,6 +9356,11 @@ List account-level collections in the account.
|
|
|
8854
9356
|
require 'talon_one'
|
|
8855
9357
|
# setup authorization
|
|
8856
9358
|
TalonOne.configure do |config|
|
|
9359
|
+
# Configure API key authorization: api_key_v1
|
|
9360
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9361
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9362
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9363
|
+
|
|
8857
9364
|
# Configure API key authorization: management_key
|
|
8858
9365
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8859
9366
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8900,7 +9407,7 @@ Name | Type | Description | Notes
|
|
|
8900
9407
|
|
|
8901
9408
|
### Authorization
|
|
8902
9409
|
|
|
8903
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9410
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8904
9411
|
|
|
8905
9412
|
### HTTP request headers
|
|
8906
9413
|
|
|
@@ -8910,7 +9417,7 @@ Name | Type | Description | Notes
|
|
|
8910
9417
|
|
|
8911
9418
|
## list_achievements
|
|
8912
9419
|
|
|
8913
|
-
>
|
|
9420
|
+
> InlineResponse20048 list_achievements(application_id, campaign_id, opts)
|
|
8914
9421
|
|
|
8915
9422
|
List achievements
|
|
8916
9423
|
|
|
@@ -8923,6 +9430,11 @@ List all the achievements for a specific campaign.
|
|
|
8923
9430
|
require 'talon_one'
|
|
8924
9431
|
# setup authorization
|
|
8925
9432
|
TalonOne.configure do |config|
|
|
9433
|
+
# Configure API key authorization: api_key_v1
|
|
9434
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9435
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9436
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9437
|
+
|
|
8926
9438
|
# Configure API key authorization: management_key
|
|
8927
9439
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8928
9440
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8965,11 +9477,11 @@ Name | Type | Description | Notes
|
|
|
8965
9477
|
|
|
8966
9478
|
### Return type
|
|
8967
9479
|
|
|
8968
|
-
[**
|
|
9480
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
|
8969
9481
|
|
|
8970
9482
|
### Authorization
|
|
8971
9483
|
|
|
8972
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9484
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
8973
9485
|
|
|
8974
9486
|
### HTTP request headers
|
|
8975
9487
|
|
|
@@ -8979,7 +9491,7 @@ Name | Type | Description | Notes
|
|
|
8979
9491
|
|
|
8980
9492
|
## list_all_roles_v2
|
|
8981
9493
|
|
|
8982
|
-
>
|
|
9494
|
+
> InlineResponse20044 list_all_roles_v2
|
|
8983
9495
|
|
|
8984
9496
|
List roles
|
|
8985
9497
|
|
|
@@ -8992,6 +9504,11 @@ List all roles.
|
|
|
8992
9504
|
require 'talon_one'
|
|
8993
9505
|
# setup authorization
|
|
8994
9506
|
TalonOne.configure do |config|
|
|
9507
|
+
# Configure API key authorization: api_key_v1
|
|
9508
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9509
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9510
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9511
|
+
|
|
8995
9512
|
# Configure API key authorization: management_key
|
|
8996
9513
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8997
9514
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9020,11 +9537,11 @@ This endpoint does not need any parameter.
|
|
|
9020
9537
|
|
|
9021
9538
|
### Return type
|
|
9022
9539
|
|
|
9023
|
-
[**
|
|
9540
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
|
9024
9541
|
|
|
9025
9542
|
### Authorization
|
|
9026
9543
|
|
|
9027
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9544
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9028
9545
|
|
|
9029
9546
|
### HTTP request headers
|
|
9030
9547
|
|
|
@@ -9034,7 +9551,7 @@ This endpoint does not need any parameter.
|
|
|
9034
9551
|
|
|
9035
9552
|
## list_campaign_store_budget_limits
|
|
9036
9553
|
|
|
9037
|
-
>
|
|
9554
|
+
> InlineResponse20046 list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
|
9038
9555
|
|
|
9039
9556
|
List campaign store budget limits
|
|
9040
9557
|
|
|
@@ -9047,6 +9564,11 @@ Return the store budget limits for a given campaign.
|
|
|
9047
9564
|
require 'talon_one'
|
|
9048
9565
|
# setup authorization
|
|
9049
9566
|
TalonOne.configure do |config|
|
|
9567
|
+
# Configure API key authorization: api_key_v1
|
|
9568
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9569
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9570
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9571
|
+
|
|
9050
9572
|
# Configure API key authorization: management_key
|
|
9051
9573
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9052
9574
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9087,11 +9609,11 @@ Name | Type | Description | Notes
|
|
|
9087
9609
|
|
|
9088
9610
|
### Return type
|
|
9089
9611
|
|
|
9090
|
-
[**
|
|
9612
|
+
[**InlineResponse20046**](InlineResponse20046.md)
|
|
9091
9613
|
|
|
9092
9614
|
### Authorization
|
|
9093
9615
|
|
|
9094
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9616
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9095
9617
|
|
|
9096
9618
|
### HTTP request headers
|
|
9097
9619
|
|
|
@@ -9114,6 +9636,11 @@ Return a paginated list of cart items in the given catalog.
|
|
|
9114
9636
|
require 'talon_one'
|
|
9115
9637
|
# setup authorization
|
|
9116
9638
|
TalonOne.configure do |config|
|
|
9639
|
+
# Configure API key authorization: api_key_v1
|
|
9640
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9641
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9642
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9643
|
+
|
|
9117
9644
|
# Configure API key authorization: management_key
|
|
9118
9645
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9119
9646
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9162,7 +9689,7 @@ Name | Type | Description | Notes
|
|
|
9162
9689
|
|
|
9163
9690
|
### Authorization
|
|
9164
9691
|
|
|
9165
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9692
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9166
9693
|
|
|
9167
9694
|
### HTTP request headers
|
|
9168
9695
|
|
|
@@ -9185,6 +9712,11 @@ List collections in a given campaign.
|
|
|
9185
9712
|
require 'talon_one'
|
|
9186
9713
|
# setup authorization
|
|
9187
9714
|
TalonOne.configure do |config|
|
|
9715
|
+
# Configure API key authorization: api_key_v1
|
|
9716
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9717
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9718
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9719
|
+
|
|
9188
9720
|
# Configure API key authorization: management_key
|
|
9189
9721
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9190
9722
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9235,7 +9767,7 @@ Name | Type | Description | Notes
|
|
|
9235
9767
|
|
|
9236
9768
|
### Authorization
|
|
9237
9769
|
|
|
9238
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9770
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9239
9771
|
|
|
9240
9772
|
### HTTP request headers
|
|
9241
9773
|
|
|
@@ -9258,6 +9790,11 @@ List campaign-level collections from all campaigns in a given Application.
|
|
|
9258
9790
|
require 'talon_one'
|
|
9259
9791
|
# setup authorization
|
|
9260
9792
|
TalonOne.configure do |config|
|
|
9793
|
+
# Configure API key authorization: api_key_v1
|
|
9794
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9795
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9796
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9797
|
+
|
|
9261
9798
|
# Configure API key authorization: management_key
|
|
9262
9799
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9263
9800
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9306,7 +9843,7 @@ Name | Type | Description | Notes
|
|
|
9306
9843
|
|
|
9307
9844
|
### Authorization
|
|
9308
9845
|
|
|
9309
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9846
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9310
9847
|
|
|
9311
9848
|
### HTTP request headers
|
|
9312
9849
|
|
|
@@ -9316,7 +9853,7 @@ Name | Type | Description | Notes
|
|
|
9316
9853
|
|
|
9317
9854
|
## list_stores
|
|
9318
9855
|
|
|
9319
|
-
>
|
|
9856
|
+
> InlineResponse20045 list_stores(application_id, opts)
|
|
9320
9857
|
|
|
9321
9858
|
List stores
|
|
9322
9859
|
|
|
@@ -9329,6 +9866,11 @@ List all stores for a specific Application.
|
|
|
9329
9866
|
require 'talon_one'
|
|
9330
9867
|
# setup authorization
|
|
9331
9868
|
TalonOne.configure do |config|
|
|
9869
|
+
# Configure API key authorization: api_key_v1
|
|
9870
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9871
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9872
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9873
|
+
|
|
9332
9874
|
# Configure API key authorization: management_key
|
|
9333
9875
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9334
9876
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9379,11 +9921,11 @@ Name | Type | Description | Notes
|
|
|
9379
9921
|
|
|
9380
9922
|
### Return type
|
|
9381
9923
|
|
|
9382
|
-
[**
|
|
9924
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
|
9383
9925
|
|
|
9384
9926
|
### Authorization
|
|
9385
9927
|
|
|
9386
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9928
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9387
9929
|
|
|
9388
9930
|
### HTTP request headers
|
|
9389
9931
|
|
|
@@ -9406,6 +9948,11 @@ Validate the ownership of the API through a challenge-response mechanism. This
|
|
|
9406
9948
|
require 'talon_one'
|
|
9407
9949
|
# setup authorization
|
|
9408
9950
|
TalonOne.configure do |config|
|
|
9951
|
+
# Configure API key authorization: api_key_v1
|
|
9952
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9953
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9954
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9955
|
+
|
|
9409
9956
|
# Configure API key authorization: management_key
|
|
9410
9957
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9411
9958
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9437,7 +9984,7 @@ nil (empty response body)
|
|
|
9437
9984
|
|
|
9438
9985
|
### Authorization
|
|
9439
9986
|
|
|
9440
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9987
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9441
9988
|
|
|
9442
9989
|
### HTTP request headers
|
|
9443
9990
|
|
|
@@ -9460,6 +10007,11 @@ Deduct points from the specified loyalty program and specified customer profile.
|
|
|
9460
10007
|
require 'talon_one'
|
|
9461
10008
|
# setup authorization
|
|
9462
10009
|
TalonOne.configure do |config|
|
|
10010
|
+
# Configure API key authorization: api_key_v1
|
|
10011
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10012
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10013
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10014
|
+
|
|
9463
10015
|
# Configure API key authorization: management_key
|
|
9464
10016
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9465
10017
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9499,7 +10051,7 @@ nil (empty response body)
|
|
|
9499
10051
|
|
|
9500
10052
|
### Authorization
|
|
9501
10053
|
|
|
9502
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10054
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9503
10055
|
|
|
9504
10056
|
### HTTP request headers
|
|
9505
10057
|
|
|
@@ -9522,6 +10074,11 @@ Consumes the supplied password reset token and updates the password for the asso
|
|
|
9522
10074
|
require 'talon_one'
|
|
9523
10075
|
# setup authorization
|
|
9524
10076
|
TalonOne.configure do |config|
|
|
10077
|
+
# Configure API key authorization: api_key_v1
|
|
10078
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10079
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10080
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10081
|
+
|
|
9525
10082
|
# Configure API key authorization: management_key
|
|
9526
10083
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9527
10084
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9558,7 +10115,7 @@ Name | Type | Description | Notes
|
|
|
9558
10115
|
|
|
9559
10116
|
### Authorization
|
|
9560
10117
|
|
|
9561
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10118
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9562
10119
|
|
|
9563
10120
|
### HTTP request headers
|
|
9564
10121
|
|
|
@@ -9581,6 +10138,11 @@ Create a new Talon.One group using the SCIM Group provisioning protocol with an
|
|
|
9581
10138
|
require 'talon_one'
|
|
9582
10139
|
# setup authorization
|
|
9583
10140
|
TalonOne.configure do |config|
|
|
10141
|
+
# Configure API key authorization: api_key_v1
|
|
10142
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10143
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10144
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10145
|
+
|
|
9584
10146
|
# Configure API key authorization: management_key
|
|
9585
10147
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9586
10148
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9617,7 +10179,7 @@ Name | Type | Description | Notes
|
|
|
9617
10179
|
|
|
9618
10180
|
### Authorization
|
|
9619
10181
|
|
|
9620
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10182
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9621
10183
|
|
|
9622
10184
|
### HTTP request headers
|
|
9623
10185
|
|
|
@@ -9640,6 +10202,11 @@ Create a new Talon.One user using the SCIM provisioning protocol with an identit
|
|
|
9640
10202
|
require 'talon_one'
|
|
9641
10203
|
# setup authorization
|
|
9642
10204
|
TalonOne.configure do |config|
|
|
10205
|
+
# Configure API key authorization: api_key_v1
|
|
10206
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10207
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10208
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10209
|
+
|
|
9643
10210
|
# Configure API key authorization: management_key
|
|
9644
10211
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9645
10212
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9676,7 +10243,7 @@ Name | Type | Description | Notes
|
|
|
9676
10243
|
|
|
9677
10244
|
### Authorization
|
|
9678
10245
|
|
|
9679
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10246
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9680
10247
|
|
|
9681
10248
|
### HTTP request headers
|
|
9682
10249
|
|
|
@@ -9699,6 +10266,11 @@ Delete a specific group created using the SCIM provisioning protocol with an ide
|
|
|
9699
10266
|
require 'talon_one'
|
|
9700
10267
|
# setup authorization
|
|
9701
10268
|
TalonOne.configure do |config|
|
|
10269
|
+
# Configure API key authorization: api_key_v1
|
|
10270
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10271
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10272
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10273
|
+
|
|
9702
10274
|
# Configure API key authorization: management_key
|
|
9703
10275
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9704
10276
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9734,7 +10306,7 @@ nil (empty response body)
|
|
|
9734
10306
|
|
|
9735
10307
|
### Authorization
|
|
9736
10308
|
|
|
9737
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10309
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9738
10310
|
|
|
9739
10311
|
### HTTP request headers
|
|
9740
10312
|
|
|
@@ -9757,6 +10329,11 @@ Delete a specific Talon.One user created using the SCIM provisioning protocol wi
|
|
|
9757
10329
|
require 'talon_one'
|
|
9758
10330
|
# setup authorization
|
|
9759
10331
|
TalonOne.configure do |config|
|
|
10332
|
+
# Configure API key authorization: api_key_v1
|
|
10333
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10335
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10336
|
+
|
|
9760
10337
|
# Configure API key authorization: management_key
|
|
9761
10338
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9762
10339
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9792,7 +10369,7 @@ nil (empty response body)
|
|
|
9792
10369
|
|
|
9793
10370
|
### Authorization
|
|
9794
10371
|
|
|
9795
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10372
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9796
10373
|
|
|
9797
10374
|
### HTTP request headers
|
|
9798
10375
|
|
|
@@ -9815,6 +10392,11 @@ Retrieve data for a specific group created using the SCIM provisioning protocol
|
|
|
9815
10392
|
require 'talon_one'
|
|
9816
10393
|
# setup authorization
|
|
9817
10394
|
TalonOne.configure do |config|
|
|
10395
|
+
# Configure API key authorization: api_key_v1
|
|
10396
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10397
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10398
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10399
|
+
|
|
9818
10400
|
# Configure API key authorization: management_key
|
|
9819
10401
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9820
10402
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9851,7 +10433,7 @@ Name | Type | Description | Notes
|
|
|
9851
10433
|
|
|
9852
10434
|
### Authorization
|
|
9853
10435
|
|
|
9854
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10436
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9855
10437
|
|
|
9856
10438
|
### HTTP request headers
|
|
9857
10439
|
|
|
@@ -9874,6 +10456,11 @@ Retrieve a paginated list of groups created using the SCIM protocol with an iden
|
|
|
9874
10456
|
require 'talon_one'
|
|
9875
10457
|
# setup authorization
|
|
9876
10458
|
TalonOne.configure do |config|
|
|
10459
|
+
# Configure API key authorization: api_key_v1
|
|
10460
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10461
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10462
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10463
|
+
|
|
9877
10464
|
# Configure API key authorization: management_key
|
|
9878
10465
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9879
10466
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9906,7 +10493,7 @@ This endpoint does not need any parameter.
|
|
|
9906
10493
|
|
|
9907
10494
|
### Authorization
|
|
9908
10495
|
|
|
9909
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10496
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9910
10497
|
|
|
9911
10498
|
### HTTP request headers
|
|
9912
10499
|
|
|
@@ -9929,6 +10516,11 @@ Retrieve a list of resource types supported by the SCIM provisioning protocol.
|
|
|
9929
10516
|
require 'talon_one'
|
|
9930
10517
|
# setup authorization
|
|
9931
10518
|
TalonOne.configure do |config|
|
|
10519
|
+
# Configure API key authorization: api_key_v1
|
|
10520
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10521
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10522
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10523
|
+
|
|
9932
10524
|
# Configure API key authorization: management_key
|
|
9933
10525
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9934
10526
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9961,7 +10553,7 @@ This endpoint does not need any parameter.
|
|
|
9961
10553
|
|
|
9962
10554
|
### Authorization
|
|
9963
10555
|
|
|
9964
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10556
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9965
10557
|
|
|
9966
10558
|
### HTTP request headers
|
|
9967
10559
|
|
|
@@ -9984,6 +10576,11 @@ Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas
|
|
|
9984
10576
|
require 'talon_one'
|
|
9985
10577
|
# setup authorization
|
|
9986
10578
|
TalonOne.configure do |config|
|
|
10579
|
+
# Configure API key authorization: api_key_v1
|
|
10580
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10581
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10582
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10583
|
+
|
|
9987
10584
|
# Configure API key authorization: management_key
|
|
9988
10585
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9989
10586
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10016,7 +10613,7 @@ This endpoint does not need any parameter.
|
|
|
10016
10613
|
|
|
10017
10614
|
### Authorization
|
|
10018
10615
|
|
|
10019
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10616
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10020
10617
|
|
|
10021
10618
|
### HTTP request headers
|
|
10022
10619
|
|
|
@@ -10039,6 +10636,11 @@ Retrieve the configuration settings of the SCIM service provider. It provides de
|
|
|
10039
10636
|
require 'talon_one'
|
|
10040
10637
|
# setup authorization
|
|
10041
10638
|
TalonOne.configure do |config|
|
|
10639
|
+
# Configure API key authorization: api_key_v1
|
|
10640
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10641
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10642
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10643
|
+
|
|
10042
10644
|
# Configure API key authorization: management_key
|
|
10043
10645
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10044
10646
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10071,7 +10673,7 @@ This endpoint does not need any parameter.
|
|
|
10071
10673
|
|
|
10072
10674
|
### Authorization
|
|
10073
10675
|
|
|
10074
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10676
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10075
10677
|
|
|
10076
10678
|
### HTTP request headers
|
|
10077
10679
|
|
|
@@ -10094,6 +10696,11 @@ Retrieve data for a specific Talon.One user created using the SCIM provisioning
|
|
|
10094
10696
|
require 'talon_one'
|
|
10095
10697
|
# setup authorization
|
|
10096
10698
|
TalonOne.configure do |config|
|
|
10699
|
+
# Configure API key authorization: api_key_v1
|
|
10700
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10701
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10702
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10703
|
+
|
|
10097
10704
|
# Configure API key authorization: management_key
|
|
10098
10705
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10099
10706
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10130,7 +10737,7 @@ Name | Type | Description | Notes
|
|
|
10130
10737
|
|
|
10131
10738
|
### Authorization
|
|
10132
10739
|
|
|
10133
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10740
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10134
10741
|
|
|
10135
10742
|
### HTTP request headers
|
|
10136
10743
|
|
|
@@ -10153,6 +10760,11 @@ Retrieve a paginated list of users that have been provisioned using the SCIM pro
|
|
|
10153
10760
|
require 'talon_one'
|
|
10154
10761
|
# setup authorization
|
|
10155
10762
|
TalonOne.configure do |config|
|
|
10763
|
+
# Configure API key authorization: api_key_v1
|
|
10764
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10765
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10766
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10767
|
+
|
|
10156
10768
|
# Configure API key authorization: management_key
|
|
10157
10769
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10158
10770
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10185,7 +10797,7 @@ This endpoint does not need any parameter.
|
|
|
10185
10797
|
|
|
10186
10798
|
### Authorization
|
|
10187
10799
|
|
|
10188
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10800
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10189
10801
|
|
|
10190
10802
|
### HTTP request headers
|
|
10191
10803
|
|
|
@@ -10208,6 +10820,11 @@ Update certain attributes of a group created using the SCIM provisioning protoco
|
|
|
10208
10820
|
require 'talon_one'
|
|
10209
10821
|
# setup authorization
|
|
10210
10822
|
TalonOne.configure do |config|
|
|
10823
|
+
# Configure API key authorization: api_key_v1
|
|
10824
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10825
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10826
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10827
|
+
|
|
10211
10828
|
# Configure API key authorization: management_key
|
|
10212
10829
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10213
10830
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10246,7 +10863,7 @@ Name | Type | Description | Notes
|
|
|
10246
10863
|
|
|
10247
10864
|
### Authorization
|
|
10248
10865
|
|
|
10249
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10866
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10250
10867
|
|
|
10251
10868
|
### HTTP request headers
|
|
10252
10869
|
|
|
@@ -10269,6 +10886,11 @@ Update certain attributes of a specific Talon.One user created using the SCIM pr
|
|
|
10269
10886
|
require 'talon_one'
|
|
10270
10887
|
# setup authorization
|
|
10271
10888
|
TalonOne.configure do |config|
|
|
10889
|
+
# Configure API key authorization: api_key_v1
|
|
10890
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10891
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10892
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10893
|
+
|
|
10272
10894
|
# Configure API key authorization: management_key
|
|
10273
10895
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10274
10896
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10307,7 +10929,7 @@ Name | Type | Description | Notes
|
|
|
10307
10929
|
|
|
10308
10930
|
### Authorization
|
|
10309
10931
|
|
|
10310
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10932
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10311
10933
|
|
|
10312
10934
|
### HTTP request headers
|
|
10313
10935
|
|
|
@@ -10330,6 +10952,11 @@ Update the details of a specific group created using the SCIM provisioning proto
|
|
|
10330
10952
|
require 'talon_one'
|
|
10331
10953
|
# setup authorization
|
|
10332
10954
|
TalonOne.configure do |config|
|
|
10955
|
+
# Configure API key authorization: api_key_v1
|
|
10956
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10957
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10958
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10959
|
+
|
|
10333
10960
|
# Configure API key authorization: management_key
|
|
10334
10961
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10335
10962
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10368,7 +10995,7 @@ Name | Type | Description | Notes
|
|
|
10368
10995
|
|
|
10369
10996
|
### Authorization
|
|
10370
10997
|
|
|
10371
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10998
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10372
10999
|
|
|
10373
11000
|
### HTTP request headers
|
|
10374
11001
|
|
|
@@ -10391,6 +11018,11 @@ Update the details of a specific Talon.One user created using the SCIM provision
|
|
|
10391
11018
|
require 'talon_one'
|
|
10392
11019
|
# setup authorization
|
|
10393
11020
|
TalonOne.configure do |config|
|
|
11021
|
+
# Configure API key authorization: api_key_v1
|
|
11022
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11023
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11024
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11025
|
+
|
|
10394
11026
|
# Configure API key authorization: management_key
|
|
10395
11027
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10396
11028
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10429,7 +11061,7 @@ Name | Type | Description | Notes
|
|
|
10429
11061
|
|
|
10430
11062
|
### Authorization
|
|
10431
11063
|
|
|
10432
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11064
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10433
11065
|
|
|
10434
11066
|
### HTTP request headers
|
|
10435
11067
|
|
|
@@ -10452,6 +11084,11 @@ List the coupons whose attributes match the query criteria in all the campaigns
|
|
|
10452
11084
|
require 'talon_one'
|
|
10453
11085
|
# setup authorization
|
|
10454
11086
|
TalonOne.configure do |config|
|
|
11087
|
+
# Configure API key authorization: api_key_v1
|
|
11088
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11089
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11090
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11091
|
+
|
|
10455
11092
|
# Configure API key authorization: management_key
|
|
10456
11093
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10457
11094
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10518,7 +11155,7 @@ Name | Type | Description | Notes
|
|
|
10518
11155
|
|
|
10519
11156
|
### Authorization
|
|
10520
11157
|
|
|
10521
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11158
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10522
11159
|
|
|
10523
11160
|
### HTTP request headers
|
|
10524
11161
|
|
|
@@ -10541,6 +11178,11 @@ List the coupons whose attributes match the query criteria in the given campaign
|
|
|
10541
11178
|
require 'talon_one'
|
|
10542
11179
|
# setup authorization
|
|
10543
11180
|
TalonOne.configure do |config|
|
|
11181
|
+
# Configure API key authorization: api_key_v1
|
|
11182
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11183
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11184
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11185
|
+
|
|
10544
11186
|
# Configure API key authorization: management_key
|
|
10545
11187
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10546
11188
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10607,7 +11249,7 @@ Name | Type | Description | Notes
|
|
|
10607
11249
|
|
|
10608
11250
|
### Authorization
|
|
10609
11251
|
|
|
10610
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11252
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10611
11253
|
|
|
10612
11254
|
### HTTP request headers
|
|
10613
11255
|
|
|
@@ -10617,7 +11259,7 @@ Name | Type | Description | Notes
|
|
|
10617
11259
|
|
|
10618
11260
|
## summarize_campaign_store_budget
|
|
10619
11261
|
|
|
10620
|
-
>
|
|
11262
|
+
> InlineResponse20047 summarize_campaign_store_budget(application_id, campaign_id)
|
|
10621
11263
|
|
|
10622
11264
|
Get summary of campaign store budgets
|
|
10623
11265
|
|
|
@@ -10630,6 +11272,11 @@ Fetch a summary of all store budget information for a given campaign.
|
|
|
10630
11272
|
require 'talon_one'
|
|
10631
11273
|
# setup authorization
|
|
10632
11274
|
TalonOne.configure do |config|
|
|
11275
|
+
# Configure API key authorization: api_key_v1
|
|
11276
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11277
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11278
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11279
|
+
|
|
10633
11280
|
# Configure API key authorization: management_key
|
|
10634
11281
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10635
11282
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10664,11 +11311,11 @@ Name | Type | Description | Notes
|
|
|
10664
11311
|
|
|
10665
11312
|
### Return type
|
|
10666
11313
|
|
|
10667
|
-
[**
|
|
11314
|
+
[**InlineResponse20047**](InlineResponse20047.md)
|
|
10668
11315
|
|
|
10669
11316
|
### Authorization
|
|
10670
11317
|
|
|
10671
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11318
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10672
11319
|
|
|
10673
11320
|
### HTTP request headers
|
|
10674
11321
|
|
|
@@ -10691,6 +11338,11 @@ Transfer loyalty card data, such as linked customers, loyalty balances and trans
|
|
|
10691
11338
|
require 'talon_one'
|
|
10692
11339
|
# setup authorization
|
|
10693
11340
|
TalonOne.configure do |config|
|
|
11341
|
+
# Configure API key authorization: api_key_v1
|
|
11342
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11343
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11344
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11345
|
+
|
|
10694
11346
|
# Configure API key authorization: management_key
|
|
10695
11347
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10696
11348
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10730,7 +11382,7 @@ nil (empty response body)
|
|
|
10730
11382
|
|
|
10731
11383
|
### Authorization
|
|
10732
11384
|
|
|
10733
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11385
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10734
11386
|
|
|
10735
11387
|
### HTTP request headers
|
|
10736
11388
|
|
|
@@ -10753,6 +11405,11 @@ Edit the description of a given account-level collection and enable or disable t
|
|
|
10753
11405
|
require 'talon_one'
|
|
10754
11406
|
# setup authorization
|
|
10755
11407
|
TalonOne.configure do |config|
|
|
11408
|
+
# Configure API key authorization: api_key_v1
|
|
11409
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11410
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11411
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11412
|
+
|
|
10756
11413
|
# Configure API key authorization: management_key
|
|
10757
11414
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10758
11415
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10791,7 +11448,7 @@ Name | Type | Description | Notes
|
|
|
10791
11448
|
|
|
10792
11449
|
### Authorization
|
|
10793
11450
|
|
|
10794
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11451
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10795
11452
|
|
|
10796
11453
|
### HTTP request headers
|
|
10797
11454
|
|
|
@@ -10814,6 +11471,11 @@ Update the details of a specific achievement.
|
|
|
10814
11471
|
require 'talon_one'
|
|
10815
11472
|
# setup authorization
|
|
10816
11473
|
TalonOne.configure do |config|
|
|
11474
|
+
# Configure API key authorization: api_key_v1
|
|
11475
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11476
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11477
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11478
|
+
|
|
10817
11479
|
# Configure API key authorization: management_key
|
|
10818
11480
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10819
11481
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10856,7 +11518,7 @@ Name | Type | Description | Notes
|
|
|
10856
11518
|
|
|
10857
11519
|
### Authorization
|
|
10858
11520
|
|
|
10859
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11521
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10860
11522
|
|
|
10861
11523
|
### HTTP request headers
|
|
10862
11524
|
|
|
@@ -10879,6 +11541,11 @@ Updates an existing additional cost. Once created, the only property of an addit
|
|
|
10879
11541
|
require 'talon_one'
|
|
10880
11542
|
# setup authorization
|
|
10881
11543
|
TalonOne.configure do |config|
|
|
11544
|
+
# Configure API key authorization: api_key_v1
|
|
11545
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11546
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11547
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11548
|
+
|
|
10882
11549
|
# Configure API key authorization: management_key
|
|
10883
11550
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10884
11551
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10917,7 +11584,7 @@ Name | Type | Description | Notes
|
|
|
10917
11584
|
|
|
10918
11585
|
### Authorization
|
|
10919
11586
|
|
|
10920
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11587
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10921
11588
|
|
|
10922
11589
|
### HTTP request headers
|
|
10923
11590
|
|
|
@@ -10940,6 +11607,11 @@ Update an existing custom attribute. Once created, the only property of a custom
|
|
|
10940
11607
|
require 'talon_one'
|
|
10941
11608
|
# setup authorization
|
|
10942
11609
|
TalonOne.configure do |config|
|
|
11610
|
+
# Configure API key authorization: api_key_v1
|
|
11611
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11612
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11613
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11614
|
+
|
|
10943
11615
|
# Configure API key authorization: management_key
|
|
10944
11616
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10945
11617
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10978,7 +11650,7 @@ Name | Type | Description | Notes
|
|
|
10978
11650
|
|
|
10979
11651
|
### Authorization
|
|
10980
11652
|
|
|
10981
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11653
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10982
11654
|
|
|
10983
11655
|
### HTTP request headers
|
|
10984
11656
|
|
|
@@ -11001,6 +11673,11 @@ Update the given campaign. **Important:** You cannot use this endpoint to updat
|
|
|
11001
11673
|
require 'talon_one'
|
|
11002
11674
|
# setup authorization
|
|
11003
11675
|
TalonOne.configure do |config|
|
|
11676
|
+
# Configure API key authorization: api_key_v1
|
|
11677
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11678
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11679
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11680
|
+
|
|
11004
11681
|
# Configure API key authorization: management_key
|
|
11005
11682
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11006
11683
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11041,7 +11718,7 @@ Name | Type | Description | Notes
|
|
|
11041
11718
|
|
|
11042
11719
|
### Authorization
|
|
11043
11720
|
|
|
11044
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11721
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11045
11722
|
|
|
11046
11723
|
### HTTP request headers
|
|
11047
11724
|
|
|
@@ -11064,6 +11741,11 @@ Edit the description of a given campaign-level collection.
|
|
|
11064
11741
|
require 'talon_one'
|
|
11065
11742
|
# setup authorization
|
|
11066
11743
|
TalonOne.configure do |config|
|
|
11744
|
+
# Configure API key authorization: api_key_v1
|
|
11745
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11746
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11747
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11748
|
+
|
|
11067
11749
|
# Configure API key authorization: management_key
|
|
11068
11750
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11069
11751
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11106,7 +11788,7 @@ Name | Type | Description | Notes
|
|
|
11106
11788
|
|
|
11107
11789
|
### Authorization
|
|
11108
11790
|
|
|
11109
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11791
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11110
11792
|
|
|
11111
11793
|
### HTTP request headers
|
|
11112
11794
|
|
|
@@ -11129,6 +11811,11 @@ Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\"
|
|
|
11129
11811
|
require 'talon_one'
|
|
11130
11812
|
# setup authorization
|
|
11131
11813
|
TalonOne.configure do |config|
|
|
11814
|
+
# Configure API key authorization: api_key_v1
|
|
11815
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11816
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11817
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11818
|
+
|
|
11132
11819
|
# Configure API key authorization: management_key
|
|
11133
11820
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11134
11821
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11171,7 +11858,7 @@ Name | Type | Description | Notes
|
|
|
11171
11858
|
|
|
11172
11859
|
### Authorization
|
|
11173
11860
|
|
|
11174
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11861
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11175
11862
|
|
|
11176
11863
|
### HTTP request headers
|
|
11177
11864
|
|
|
@@ -11194,6 +11881,11 @@ Update all coupons or a specific batch of coupons in the given campaign. You can
|
|
|
11194
11881
|
require 'talon_one'
|
|
11195
11882
|
# setup authorization
|
|
11196
11883
|
TalonOne.configure do |config|
|
|
11884
|
+
# Configure API key authorization: api_key_v1
|
|
11885
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11886
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11887
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11888
|
+
|
|
11197
11889
|
# Configure API key authorization: management_key
|
|
11198
11890
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11199
11891
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11233,7 +11925,7 @@ nil (empty response body)
|
|
|
11233
11925
|
|
|
11234
11926
|
### Authorization
|
|
11235
11927
|
|
|
11236
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11928
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11237
11929
|
|
|
11238
11930
|
### HTTP request headers
|
|
11239
11931
|
|
|
@@ -11256,6 +11948,11 @@ Update the status of the given loyalty card. A card can be _active_ or _inactive
|
|
|
11256
11948
|
require 'talon_one'
|
|
11257
11949
|
# setup authorization
|
|
11258
11950
|
TalonOne.configure do |config|
|
|
11951
|
+
# Configure API key authorization: api_key_v1
|
|
11952
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11953
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11954
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11955
|
+
|
|
11259
11956
|
# Configure API key authorization: management_key
|
|
11260
11957
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11261
11958
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11296,7 +11993,7 @@ Name | Type | Description | Notes
|
|
|
11296
11993
|
|
|
11297
11994
|
### Authorization
|
|
11298
11995
|
|
|
11299
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11996
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11300
11997
|
|
|
11301
11998
|
### HTTP request headers
|
|
11302
11999
|
|
|
@@ -11319,6 +12016,11 @@ Update the specified referral.
|
|
|
11319
12016
|
require 'talon_one'
|
|
11320
12017
|
# setup authorization
|
|
11321
12018
|
TalonOne.configure do |config|
|
|
12019
|
+
# Configure API key authorization: api_key_v1
|
|
12020
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
12021
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
12022
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
12023
|
+
|
|
11322
12024
|
# Configure API key authorization: management_key
|
|
11323
12025
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11324
12026
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11361,7 +12063,7 @@ Name | Type | Description | Notes
|
|
|
11361
12063
|
|
|
11362
12064
|
### Authorization
|
|
11363
12065
|
|
|
11364
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
12066
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11365
12067
|
|
|
11366
12068
|
### HTTP request headers
|
|
11367
12069
|
|
|
@@ -11384,6 +12086,11 @@ Update a specific role.
|
|
|
11384
12086
|
require 'talon_one'
|
|
11385
12087
|
# setup authorization
|
|
11386
12088
|
TalonOne.configure do |config|
|
|
12089
|
+
# Configure API key authorization: api_key_v1
|
|
12090
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
12091
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
12092
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
12093
|
+
|
|
11387
12094
|
# Configure API key authorization: management_key
|
|
11388
12095
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11389
12096
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11422,7 +12129,7 @@ Name | Type | Description | Notes
|
|
|
11422
12129
|
|
|
11423
12130
|
### Authorization
|
|
11424
12131
|
|
|
11425
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
12132
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11426
12133
|
|
|
11427
12134
|
### HTTP request headers
|
|
11428
12135
|
|
|
@@ -11445,6 +12152,11 @@ Update store details for a specific store ID.
|
|
|
11445
12152
|
require 'talon_one'
|
|
11446
12153
|
# setup authorization
|
|
11447
12154
|
TalonOne.configure do |config|
|
|
12155
|
+
# Configure API key authorization: api_key_v1
|
|
12156
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
12157
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
12158
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
12159
|
+
|
|
11448
12160
|
# Configure API key authorization: management_key
|
|
11449
12161
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11450
12162
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11485,7 +12197,7 @@ Name | Type | Description | Notes
|
|
|
11485
12197
|
|
|
11486
12198
|
### Authorization
|
|
11487
12199
|
|
|
11488
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
12200
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11489
12201
|
|
|
11490
12202
|
### HTTP request headers
|
|
11491
12203
|
|
|
@@ -11508,6 +12220,11 @@ Update the details of a specific user.
|
|
|
11508
12220
|
require 'talon_one'
|
|
11509
12221
|
# setup authorization
|
|
11510
12222
|
TalonOne.configure do |config|
|
|
12223
|
+
# Configure API key authorization: api_key_v1
|
|
12224
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
12225
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
12226
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
12227
|
+
|
|
11511
12228
|
# Configure API key authorization: management_key
|
|
11512
12229
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11513
12230
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -11546,7 +12263,7 @@ Name | Type | Description | Notes
|
|
|
11546
12263
|
|
|
11547
12264
|
### Authorization
|
|
11548
12265
|
|
|
11549
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
12266
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11550
12267
|
|
|
11551
12268
|
### HTTP request headers
|
|
11552
12269
|
|