talon_one 9.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 +89 -9
- data/docker-compose.yml +2 -2
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/AccountLimits.md +5 -1
- data/docs/Achievement.md +4 -2
- data/docs/AchievementBase.md +4 -2
- data/docs/AchievementProgressWithDefinition.md +4 -2
- data/docs/AchievementStatusEntry.md +4 -2
- data/docs/AddLoyaltyPoints.md +1 -1
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AddedDeductedPointsNotification.md +41 -0
- data/docs/AnalyticsSKU.md +6 -2
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCustomer.md +3 -3
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/AsyncCouponsData.md +25 -0
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +3 -3
- data/docs/AudienceReference.md +21 -0
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/BaseNotificationWebhook.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/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionEditedNotification.md +6 -6
- data/docs/CampaignCollectionEditedNotificationItem.md +23 -0
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignCreatedNotification.md +6 -6
- data/docs/CampaignCreatedNotificationItem.md +23 -0
- data/docs/CampaignDeactivationRequest.md +17 -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/CampaignGroup.md +1 -1
- 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/CampaignSet.md +1 -1
- data/docs/CampaignStateChangedNotification.md +6 -8
- data/docs/CampaignStateChangedNotificationItem.md +25 -0
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignTemplate.md +1 -1
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -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/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CouponsNotificationData.md +27 -0
- data/docs/CouponsNotificationPolicy.md +1 -1
- data/docs/CreateAchievement.md +4 -2
- data/docs/CreateCouponData.md +29 -0
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +3 -3
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/DeleteCouponsData.md +31 -0
- data/docs/Effect.md +7 -1
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.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/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +23 -0
- 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/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/Import.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/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +91 -6
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/JWT.md +19 -0
- data/docs/LabelTargetAudience.md +19 -0
- data/docs/LabelTargetNone.md +17 -0
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerPointsEntryIntegrationAPI.md +2 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyDashboardData.md +2 -0
- data/docs/LoyaltyLedgerEntryExpiryDateChange.md +21 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +2 -0
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +1819 -339
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewMessageTest.md +6 -6
- data/docs/NewPriceAdjustment.md +29 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewSecondaryDeployment.md +17 -0
- data/docs/NewWebhook.md +5 -1
- data/docs/PendingActivePointsData.md +29 -0
- data/docs/PendingActivePointsNotification.md +21 -0
- data/docs/PendingPointsNotificationPolicy.md +1 -1
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +25 -0
- data/docs/PriceType.md +33 -0
- data/docs/PriceTypeReferenceDetail.md +23 -0
- data/docs/PriceTypeReferences.md +19 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/RoleV2RolesGroup.md +3 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SecondaryDeployment.md +31 -0
- data/docs/SetLoyaltyPointsExpiryDateEffectProps.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughChangedItem.md +2 -0
- data/docs/StrikethroughEffect.md +9 -1
- data/docs/StrikethroughLabelingNotification.md +3 -1
- data/docs/TemplateDef.md +1 -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 +4 -2
- data/docs/UpdateCouponsData.md +29 -0
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/docs/UpdatePriceType.md +21 -0
- data/docs/User.md +1 -1
- data/docs/Webhook.md +6 -2
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +5 -1
- data/lib/talon_one/api/integration_api.rb +110 -8
- data/lib/talon_one/api/management_api.rb +1123 -429
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/account_limits.rb +34 -4
- data/lib/talon_one/models/achievement.rb +15 -5
- data/lib/talon_one/models/achievement_base.rb +17 -7
- data/lib/talon_one/models/achievement_progress_with_definition.rb +17 -7
- data/lib/talon_one/models/achievement_status_entry.rb +15 -5
- data/lib/talon_one/models/add_loyalty_points.rb +1 -10
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- 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.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_customer.rb +3 -3
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/async_coupons_data.rb +272 -0
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +3 -3
- 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/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.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/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- 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_collection_without_payload.rb +1 -1
- 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_deactivation_request.rb +214 -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_group.rb +1 -1
- 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_set.rb +1 -1
- 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/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_template.rb +1 -1
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -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/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +16 -4
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- 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 +17 -7
- data/lib/talon_one/models/create_coupon_data.rb +288 -0
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +3 -3
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.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 +31 -2
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -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/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +255 -0
- 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/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/import.rb +1 -1
- 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_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- 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_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- 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_card.rb +1 -1
- 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_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +16 -1
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- 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 +297 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_secondary_deployment.rb +242 -0
- data/lib/talon_one/models/new_webhook.rb +29 -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/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +247 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- 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/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/role_v2_roles_group.rb +14 -4
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- 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/store.rb +1 -1
- 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/template_def.rb +1 -1
- 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 +17 -7
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- 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/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +30 -5
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +27 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +73 -4
- data/spec/api/integration_api_spec.rb +26 -4
- data/spec/api/management_api_spec.rb +179 -51
- data/spec/models/account_limits_spec.rb +12 -0
- data/spec/models/achievement_base_spec.rb +7 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +7 -1
- data/spec/models/achievement_spec.rb +7 -1
- data/spec/models/achievement_status_entry_spec.rb +7 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -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/base_notification_spec.rb +1 -1
- 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/binding_spec.rb +24 -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_deactivation_request_spec.rb +41 -0
- 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_balances_notification_policy_spec.rb +51 -0
- 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/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/coupons_notification_data_spec.rb +71 -0
- data/spec/models/create_achievement_spec.rb +7 -1
- data/spec/models/create_coupon_data_spec.rb +77 -0
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/delete_coupons_data_spec.rb +83 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -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 +59 -0
- 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_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_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 +77 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_secondary_deployment_spec.rb +41 -0
- data/spec/models/new_webhook_spec.rb +12 -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 +65 -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/price_type_spec.rb +89 -0
- data/spec/models/role_v2_roles_group_spec.rb +6 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -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 +7 -1
- data/spec/models/update_coupons_data_spec.rb +77 -0
- data/spec/models/update_price_type_spec.rb +53 -0
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +12 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +12 -0
- metadata +305 -3
- data/.github/dependabot.yml +0 -10
data/docs/ManagementApi.md
CHANGED
|
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**create_attribute**](ManagementApi.md#create_attribute) | **POST** /v1/attributes | Create custom attribute
|
|
15
15
|
[**create_batch_loyalty_cards**](ManagementApi.md#create_batch_loyalty_cards) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/cards/batch | Create loyalty cards
|
|
16
16
|
[**create_campaign_from_template**](ManagementApi.md#create_campaign_from_template) | **POST** /v1/applications/{applicationId}/create_campaign_from_template | Create campaign from campaign template
|
|
17
|
+
[**create_campaign_store_budget**](ManagementApi.md#create_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Create campaign store budget
|
|
17
18
|
[**create_collection**](ManagementApi.md#create_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | Create campaign-level collection
|
|
18
19
|
[**create_coupons**](ManagementApi.md#create_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Create coupons
|
|
19
20
|
[**create_coupons_async**](ManagementApi.md#create_coupons_async) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_async | Create coupons asynchronously
|
|
@@ -29,6 +30,7 @@ Method | HTTP request | Description
|
|
|
29
30
|
[**delete_account_collection**](ManagementApi.md#delete_account_collection) | **DELETE** /v1/collections/{collectionId} | Delete account-level collection
|
|
30
31
|
[**delete_achievement**](ManagementApi.md#delete_achievement) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Delete achievement
|
|
31
32
|
[**delete_campaign**](ManagementApi.md#delete_campaign) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId} | Delete campaign
|
|
33
|
+
[**delete_campaign_store_budgets**](ManagementApi.md#delete_campaign_store_budgets) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | Delete campaign store budgets
|
|
32
34
|
[**delete_collection**](ManagementApi.md#delete_collection) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId} | Delete campaign-level collection
|
|
33
35
|
[**delete_coupon**](ManagementApi.md#delete_coupon) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons/{couponId} | Delete coupon
|
|
34
36
|
[**delete_coupons**](ManagementApi.md#delete_coupons) | **DELETE** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons | Delete coupons
|
|
@@ -42,6 +44,7 @@ Method | HTTP request | Description
|
|
|
42
44
|
[**export_account_collection_items**](ManagementApi.md#export_account_collection_items) | **GET** /v1/collections/{collectionId}/export | Export account-level collection's items
|
|
43
45
|
[**export_achievements**](ManagementApi.md#export_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId}/export | Export achievement customer data
|
|
44
46
|
[**export_audiences_memberships**](ManagementApi.md#export_audiences_memberships) | **GET** /v1/audiences/{audienceId}/memberships/export | Export audience members
|
|
47
|
+
[**export_campaign_store_budgets**](ManagementApi.md#export_campaign_store_budgets) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/export | Export campaign store budgets
|
|
45
48
|
[**export_campaign_stores**](ManagementApi.md#export_campaign_stores) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/export | Export stores
|
|
46
49
|
[**export_collection_items**](ManagementApi.md#export_collection_items) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/export | Export campaign-level collection's items
|
|
47
50
|
[**export_coupons**](ManagementApi.md#export_coupons) | **GET** /v1/applications/{applicationId}/export_coupons | Export coupons
|
|
@@ -117,12 +120,11 @@ Method | HTTP request | Description
|
|
|
117
120
|
[**get_user**](ManagementApi.md#get_user) | **GET** /v1/users/{userId} | Get user
|
|
118
121
|
[**get_users**](ManagementApi.md#get_users) | **GET** /v1/users | List users in account
|
|
119
122
|
[**get_webhook**](ManagementApi.md#get_webhook) | **GET** /v1/webhooks/{webhookId} | Get webhook
|
|
120
|
-
[**get_webhook_activation_logs**](ManagementApi.md#get_webhook_activation_logs) | **GET** /v1/webhook_activation_logs | List webhook activation log entries
|
|
121
|
-
[**get_webhook_logs**](ManagementApi.md#get_webhook_logs) | **GET** /v1/webhook_logs | List webhook log entries
|
|
122
123
|
[**get_webhooks**](ManagementApi.md#get_webhooks) | **GET** /v1/webhooks | List webhooks
|
|
123
124
|
[**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
|
124
125
|
[**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
|
125
126
|
[**import_audiences_memberships**](ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
|
127
|
+
[**import_campaign_store_budget**](ManagementApi.md#import_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
|
|
126
128
|
[**import_campaign_stores**](ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
|
127
129
|
[**import_collection**](ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
|
128
130
|
[**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
|
@@ -135,6 +137,7 @@ Method | HTTP request | Description
|
|
|
135
137
|
[**list_account_collections**](ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
|
136
138
|
[**list_achievements**](ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
|
137
139
|
[**list_all_roles_v2**](ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
|
140
|
+
[**list_campaign_store_budget_limits**](ManagementApi.md#list_campaign_store_budget_limits) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets | List campaign store budget limits
|
|
138
141
|
[**list_catalog_items**](ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
|
139
142
|
[**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
|
140
143
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
|
@@ -142,17 +145,24 @@ Method | HTTP request | Description
|
|
|
142
145
|
[**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
|
143
146
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
|
144
147
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
|
148
|
+
[**scim_create_group**](ManagementApi.md#scim_create_group) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
|
|
145
149
|
[**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
|
150
|
+
[**scim_delete_group**](ManagementApi.md#scim_delete_group) | **DELETE** /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
|
|
146
151
|
[**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
|
152
|
+
[**scim_get_group**](ManagementApi.md#scim_get_group) | **GET** /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
|
|
153
|
+
[**scim_get_groups**](ManagementApi.md#scim_get_groups) | **GET** /v1/provisioning/scim/Groups | List SCIM groups
|
|
147
154
|
[**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
|
148
155
|
[**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
|
149
156
|
[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
|
150
157
|
[**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
|
151
158
|
[**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
|
159
|
+
[**scim_patch_group**](ManagementApi.md#scim_patch_group) | **PATCH** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
|
|
152
160
|
[**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
|
161
|
+
[**scim_replace_group_attributes**](ManagementApi.md#scim_replace_group_attributes) | **PUT** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
|
|
153
162
|
[**scim_replace_user_attributes**](ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
|
154
163
|
[**search_coupons_advanced_application_wide_without_total_count**](ManagementApi.md#search_coupons_advanced_application_wide_without_total_count) | **POST** /v1/applications/{applicationId}/coupons_search_advanced/no_total | List coupons that match the given attributes (without total count)
|
|
155
164
|
[**search_coupons_advanced_without_total_count**](ManagementApi.md#search_coupons_advanced_without_total_count) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/coupons_search_advanced/no_total | List coupons that match the given attributes in campaign (without total count)
|
|
165
|
+
[**summarize_campaign_store_budget**](ManagementApi.md#summarize_campaign_store_budget) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/summary | Get summary of campaign store budgets
|
|
156
166
|
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
|
157
167
|
[**update_account_collection**](ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
|
158
168
|
[**update_achievement**](ManagementApi.md#update_achievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
|
|
@@ -185,6 +195,11 @@ Enable a [disabled user](https://docs.talon.one/docs/product/account/account-set
|
|
|
185
195
|
require 'talon_one'
|
|
186
196
|
# setup authorization
|
|
187
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
|
+
|
|
188
203
|
# Configure API key authorization: management_key
|
|
189
204
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
190
205
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -220,7 +235,7 @@ nil (empty response body)
|
|
|
220
235
|
|
|
221
236
|
### Authorization
|
|
222
237
|
|
|
223
|
-
[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)
|
|
224
239
|
|
|
225
240
|
### HTTP request headers
|
|
226
241
|
|
|
@@ -243,6 +258,11 @@ Add points to the given loyalty card in the specified card-based loyalty program
|
|
|
243
258
|
require 'talon_one'
|
|
244
259
|
# setup authorization
|
|
245
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
|
+
|
|
246
266
|
# Configure API key authorization: management_key
|
|
247
267
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
248
268
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -282,7 +302,7 @@ nil (empty response body)
|
|
|
282
302
|
|
|
283
303
|
### Authorization
|
|
284
304
|
|
|
285
|
-
[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)
|
|
286
306
|
|
|
287
307
|
### HTTP request headers
|
|
288
308
|
|
|
@@ -305,6 +325,11 @@ Add points in the specified loyalty program for the given customer. To get the
|
|
|
305
325
|
require 'talon_one'
|
|
306
326
|
# setup authorization
|
|
307
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
|
+
|
|
308
333
|
# Configure API key authorization: management_key
|
|
309
334
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
310
335
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -344,7 +369,7 @@ nil (empty response body)
|
|
|
344
369
|
|
|
345
370
|
### Authorization
|
|
346
371
|
|
|
347
|
-
[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)
|
|
348
373
|
|
|
349
374
|
### HTTP request headers
|
|
350
375
|
|
|
@@ -367,6 +392,11 @@ Copy the campaign into all specified Applications.
|
|
|
367
392
|
require 'talon_one'
|
|
368
393
|
# setup authorization
|
|
369
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
|
+
|
|
370
400
|
# Configure API key authorization: management_key
|
|
371
401
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
372
402
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -407,7 +437,7 @@ Name | Type | Description | Notes
|
|
|
407
437
|
|
|
408
438
|
### Authorization
|
|
409
439
|
|
|
410
|
-
[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)
|
|
411
441
|
|
|
412
442
|
### HTTP request headers
|
|
413
443
|
|
|
@@ -430,6 +460,11 @@ Create an account-level collection.
|
|
|
430
460
|
require 'talon_one'
|
|
431
461
|
# setup authorization
|
|
432
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
|
+
|
|
433
468
|
# Configure API key authorization: management_key
|
|
434
469
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
435
470
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -466,7 +501,7 @@ Name | Type | Description | Notes
|
|
|
466
501
|
|
|
467
502
|
### Authorization
|
|
468
503
|
|
|
469
|
-
[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)
|
|
470
505
|
|
|
471
506
|
### HTTP request headers
|
|
472
507
|
|
|
@@ -489,6 +524,11 @@ Create a new achievement in a specific campaign.
|
|
|
489
524
|
require 'talon_one'
|
|
490
525
|
# setup authorization
|
|
491
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
|
+
|
|
492
532
|
# Configure API key authorization: management_key
|
|
493
533
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
494
534
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -529,7 +569,7 @@ Name | Type | Description | Notes
|
|
|
529
569
|
|
|
530
570
|
### Authorization
|
|
531
571
|
|
|
532
|
-
[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)
|
|
533
573
|
|
|
534
574
|
### HTTP request headers
|
|
535
575
|
|
|
@@ -552,6 +592,11 @@ Create an [additional cost](https://docs.talon.one/docs/product/account/dev-tool
|
|
|
552
592
|
require 'talon_one'
|
|
553
593
|
# setup authorization
|
|
554
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
|
+
|
|
555
600
|
# Configure API key authorization: management_key
|
|
556
601
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
557
602
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -588,7 +633,7 @@ Name | Type | Description | Notes
|
|
|
588
633
|
|
|
589
634
|
### Authorization
|
|
590
635
|
|
|
591
|
-
[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)
|
|
592
637
|
|
|
593
638
|
### HTTP request headers
|
|
594
639
|
|
|
@@ -611,6 +656,11 @@ Create a _custom attribute_ in this account. [Custom attributes](https://docs.ta
|
|
|
611
656
|
require 'talon_one'
|
|
612
657
|
# setup authorization
|
|
613
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
|
+
|
|
614
664
|
# Configure API key authorization: management_key
|
|
615
665
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
616
666
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -647,7 +697,7 @@ Name | Type | Description | Notes
|
|
|
647
697
|
|
|
648
698
|
### Authorization
|
|
649
699
|
|
|
650
|
-
[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)
|
|
651
701
|
|
|
652
702
|
### HTTP request headers
|
|
653
703
|
|
|
@@ -670,6 +720,11 @@ Create a batch of loyalty cards in a specified [card-based loyalty program](http
|
|
|
670
720
|
require 'talon_one'
|
|
671
721
|
# setup authorization
|
|
672
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
|
+
|
|
673
728
|
# Configure API key authorization: management_key
|
|
674
729
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
675
730
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -708,7 +763,7 @@ Name | Type | Description | Notes
|
|
|
708
763
|
|
|
709
764
|
### Authorization
|
|
710
765
|
|
|
711
|
-
[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)
|
|
712
767
|
|
|
713
768
|
### HTTP request headers
|
|
714
769
|
|
|
@@ -731,6 +786,11 @@ Use the campaign template referenced in the request body to create a new campaig
|
|
|
731
786
|
require 'talon_one'
|
|
732
787
|
# setup authorization
|
|
733
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
|
+
|
|
734
794
|
# Configure API key authorization: management_key
|
|
735
795
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
736
796
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -769,7 +829,74 @@ Name | Type | Description | Notes
|
|
|
769
829
|
|
|
770
830
|
### Authorization
|
|
771
831
|
|
|
772
|
-
[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)
|
|
833
|
+
|
|
834
|
+
### HTTP request headers
|
|
835
|
+
|
|
836
|
+
- **Content-Type**: application/json
|
|
837
|
+
- **Accept**: application/json
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
## create_campaign_store_budget
|
|
841
|
+
|
|
842
|
+
> create_campaign_store_budget(application_id, campaign_id, body)
|
|
843
|
+
|
|
844
|
+
Create campaign store budget
|
|
845
|
+
|
|
846
|
+
Create a new store budget for a given campaign.
|
|
847
|
+
|
|
848
|
+
### Example
|
|
849
|
+
|
|
850
|
+
```ruby
|
|
851
|
+
# load the gem
|
|
852
|
+
require 'talon_one'
|
|
853
|
+
# setup authorization
|
|
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
|
+
|
|
860
|
+
# Configure API key authorization: management_key
|
|
861
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
862
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
863
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
864
|
+
|
|
865
|
+
# Configure API key authorization: manager_auth
|
|
866
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
867
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
868
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
869
|
+
end
|
|
870
|
+
|
|
871
|
+
api_instance = TalonOne::ManagementApi.new
|
|
872
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
873
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
874
|
+
body = TalonOne::NewCampaignStoreBudget.new # NewCampaignStoreBudget | body
|
|
875
|
+
|
|
876
|
+
begin
|
|
877
|
+
#Create campaign store budget
|
|
878
|
+
api_instance.create_campaign_store_budget(application_id, campaign_id, body)
|
|
879
|
+
rescue TalonOne::ApiError => e
|
|
880
|
+
puts "Exception when calling ManagementApi->create_campaign_store_budget: #{e}"
|
|
881
|
+
end
|
|
882
|
+
```
|
|
883
|
+
|
|
884
|
+
### Parameters
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
Name | Type | Description | Notes
|
|
888
|
+
------------- | ------------- | ------------- | -------------
|
|
889
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
890
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
891
|
+
**body** | [**NewCampaignStoreBudget**](NewCampaignStoreBudget.md)| body |
|
|
892
|
+
|
|
893
|
+
### Return type
|
|
894
|
+
|
|
895
|
+
nil (empty response body)
|
|
896
|
+
|
|
897
|
+
### Authorization
|
|
898
|
+
|
|
899
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
773
900
|
|
|
774
901
|
### HTTP request headers
|
|
775
902
|
|
|
@@ -792,6 +919,11 @@ Create a campaign-level collection in a given campaign.
|
|
|
792
919
|
require 'talon_one'
|
|
793
920
|
# setup authorization
|
|
794
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
|
+
|
|
795
927
|
# Configure API key authorization: management_key
|
|
796
928
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
797
929
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -832,7 +964,7 @@ Name | Type | Description | Notes
|
|
|
832
964
|
|
|
833
965
|
### Authorization
|
|
834
966
|
|
|
835
|
-
[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)
|
|
836
968
|
|
|
837
969
|
### HTTP request headers
|
|
838
970
|
|
|
@@ -855,6 +987,11 @@ Create coupons according to some pattern. Up to 20.000 coupons can be created wi
|
|
|
855
987
|
require 'talon_one'
|
|
856
988
|
# setup authorization
|
|
857
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
|
+
|
|
858
995
|
# Configure API key authorization: management_key
|
|
859
996
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
860
997
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -899,7 +1036,7 @@ Name | Type | Description | Notes
|
|
|
899
1036
|
|
|
900
1037
|
### Authorization
|
|
901
1038
|
|
|
902
|
-
[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)
|
|
903
1040
|
|
|
904
1041
|
### HTTP request headers
|
|
905
1042
|
|
|
@@ -922,6 +1059,11 @@ Create up to 5,000,000 coupons asynchronously. You should typically use this enp
|
|
|
922
1059
|
require 'talon_one'
|
|
923
1060
|
# setup authorization
|
|
924
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
|
+
|
|
925
1067
|
# Configure API key authorization: management_key
|
|
926
1068
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
927
1069
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -962,7 +1104,7 @@ Name | Type | Description | Notes
|
|
|
962
1104
|
|
|
963
1105
|
### Authorization
|
|
964
1106
|
|
|
965
|
-
[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)
|
|
966
1108
|
|
|
967
1109
|
### HTTP request headers
|
|
968
1110
|
|
|
@@ -985,6 +1127,11 @@ This endpoint handles creating a job to delete coupons asynchronously.
|
|
|
985
1127
|
require 'talon_one'
|
|
986
1128
|
# setup authorization
|
|
987
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
|
+
|
|
988
1135
|
# Configure API key authorization: management_key
|
|
989
1136
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
990
1137
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1025,7 +1172,7 @@ Name | Type | Description | Notes
|
|
|
1025
1172
|
|
|
1026
1173
|
### Authorization
|
|
1027
1174
|
|
|
1028
|
-
[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)
|
|
1029
1176
|
|
|
1030
1177
|
### HTTP request headers
|
|
1031
1178
|
|
|
@@ -1048,6 +1195,11 @@ Create coupons according to some pattern for up to 1000 recipients.
|
|
|
1048
1195
|
require 'talon_one'
|
|
1049
1196
|
# setup authorization
|
|
1050
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
|
+
|
|
1051
1203
|
# Configure API key authorization: management_key
|
|
1052
1204
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1053
1205
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1092,7 +1244,7 @@ Name | Type | Description | Notes
|
|
|
1092
1244
|
|
|
1093
1245
|
### Authorization
|
|
1094
1246
|
|
|
1095
|
-
[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)
|
|
1096
1248
|
|
|
1097
1249
|
### HTTP request headers
|
|
1098
1250
|
|
|
@@ -1115,6 +1267,11 @@ Resend an email invitation to an existing user. **Note:** The invitation token
|
|
|
1115
1267
|
require 'talon_one'
|
|
1116
1268
|
# setup authorization
|
|
1117
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
|
+
|
|
1118
1275
|
# Configure API key authorization: management_key
|
|
1119
1276
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1120
1277
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1151,7 +1308,7 @@ Name | Type | Description | Notes
|
|
|
1151
1308
|
|
|
1152
1309
|
### Authorization
|
|
1153
1310
|
|
|
1154
|
-
[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)
|
|
1155
1312
|
|
|
1156
1313
|
### HTTP request headers
|
|
1157
1314
|
|
|
@@ -1174,6 +1331,11 @@ Create a new user in the account and send an invitation to their email address.
|
|
|
1174
1331
|
require 'talon_one'
|
|
1175
1332
|
# setup authorization
|
|
1176
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
|
+
|
|
1177
1339
|
# Configure API key authorization: management_key
|
|
1178
1340
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1179
1341
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1210,7 +1372,7 @@ Name | Type | Description | Notes
|
|
|
1210
1372
|
|
|
1211
1373
|
### Authorization
|
|
1212
1374
|
|
|
1213
|
-
[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)
|
|
1214
1376
|
|
|
1215
1377
|
### HTTP request headers
|
|
1216
1378
|
|
|
@@ -1233,6 +1395,11 @@ Send an email with a password recovery link to the email address of an existing
|
|
|
1233
1395
|
require 'talon_one'
|
|
1234
1396
|
# setup authorization
|
|
1235
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
|
+
|
|
1236
1403
|
# Configure API key authorization: management_key
|
|
1237
1404
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1238
1405
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1269,7 +1436,7 @@ Name | Type | Description | Notes
|
|
|
1269
1436
|
|
|
1270
1437
|
### Authorization
|
|
1271
1438
|
|
|
1272
|
-
[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)
|
|
1273
1440
|
|
|
1274
1441
|
### HTTP request headers
|
|
1275
1442
|
|
|
@@ -1292,6 +1459,11 @@ Create a session to use the Management API endpoints. Use the value of the `toke
|
|
|
1292
1459
|
require 'talon_one'
|
|
1293
1460
|
# setup authorization
|
|
1294
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
|
+
|
|
1295
1467
|
# Configure API key authorization: management_key
|
|
1296
1468
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1297
1469
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1328,7 +1500,7 @@ Name | Type | Description | Notes
|
|
|
1328
1500
|
|
|
1329
1501
|
### Authorization
|
|
1330
1502
|
|
|
1331
|
-
[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)
|
|
1332
1504
|
|
|
1333
1505
|
### HTTP request headers
|
|
1334
1506
|
|
|
@@ -1351,6 +1523,11 @@ Create a new store in a specific Application.
|
|
|
1351
1523
|
require 'talon_one'
|
|
1352
1524
|
# setup authorization
|
|
1353
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
|
+
|
|
1354
1531
|
# Configure API key authorization: management_key
|
|
1355
1532
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1356
1533
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1389,7 +1566,7 @@ Name | Type | Description | Notes
|
|
|
1389
1566
|
|
|
1390
1567
|
### Authorization
|
|
1391
1568
|
|
|
1392
|
-
[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)
|
|
1393
1570
|
|
|
1394
1571
|
### HTTP request headers
|
|
1395
1572
|
|
|
@@ -1412,6 +1589,11 @@ Disable user by email address
|
|
|
1412
1589
|
require 'talon_one'
|
|
1413
1590
|
# setup authorization
|
|
1414
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
|
+
|
|
1415
1597
|
# Configure API key authorization: management_key
|
|
1416
1598
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1417
1599
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1447,7 +1629,7 @@ nil (empty response body)
|
|
|
1447
1629
|
|
|
1448
1630
|
### Authorization
|
|
1449
1631
|
|
|
1450
|
-
[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)
|
|
1451
1633
|
|
|
1452
1634
|
### HTTP request headers
|
|
1453
1635
|
|
|
@@ -1470,6 +1652,11 @@ Deduct points from the given loyalty card in the specified card-based loyalty pr
|
|
|
1470
1652
|
require 'talon_one'
|
|
1471
1653
|
# setup authorization
|
|
1472
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
|
+
|
|
1473
1660
|
# Configure API key authorization: management_key
|
|
1474
1661
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1475
1662
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1509,7 +1696,7 @@ nil (empty response body)
|
|
|
1509
1696
|
|
|
1510
1697
|
### Authorization
|
|
1511
1698
|
|
|
1512
|
-
[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)
|
|
1513
1700
|
|
|
1514
1701
|
### HTTP request headers
|
|
1515
1702
|
|
|
@@ -1532,6 +1719,11 @@ Delete a given account-level collection.
|
|
|
1532
1719
|
require 'talon_one'
|
|
1533
1720
|
# setup authorization
|
|
1534
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
|
+
|
|
1535
1727
|
# Configure API key authorization: management_key
|
|
1536
1728
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1537
1729
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1567,7 +1759,7 @@ nil (empty response body)
|
|
|
1567
1759
|
|
|
1568
1760
|
### Authorization
|
|
1569
1761
|
|
|
1570
|
-
[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)
|
|
1571
1763
|
|
|
1572
1764
|
### HTTP request headers
|
|
1573
1765
|
|
|
@@ -1590,6 +1782,11 @@ Delete the specified achievement.
|
|
|
1590
1782
|
require 'talon_one'
|
|
1591
1783
|
# setup authorization
|
|
1592
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
|
+
|
|
1593
1790
|
# Configure API key authorization: management_key
|
|
1594
1791
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1595
1792
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1629,7 +1826,7 @@ nil (empty response body)
|
|
|
1629
1826
|
|
|
1630
1827
|
### Authorization
|
|
1631
1828
|
|
|
1632
|
-
[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)
|
|
1633
1830
|
|
|
1634
1831
|
### HTTP request headers
|
|
1635
1832
|
|
|
@@ -1652,6 +1849,11 @@ Delete the given campaign.
|
|
|
1652
1849
|
require 'talon_one'
|
|
1653
1850
|
# setup authorization
|
|
1654
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
|
+
|
|
1655
1857
|
# Configure API key authorization: management_key
|
|
1656
1858
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1657
1859
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1689,7 +1891,7 @@ nil (empty response body)
|
|
|
1689
1891
|
|
|
1690
1892
|
### Authorization
|
|
1691
1893
|
|
|
1692
|
-
[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)
|
|
1693
1895
|
|
|
1694
1896
|
### HTTP request headers
|
|
1695
1897
|
|
|
@@ -1697,6 +1899,77 @@ nil (empty response body)
|
|
|
1697
1899
|
- **Accept**: Not defined
|
|
1698
1900
|
|
|
1699
1901
|
|
|
1902
|
+
## delete_campaign_store_budgets
|
|
1903
|
+
|
|
1904
|
+
> delete_campaign_store_budgets(application_id, campaign_id, opts)
|
|
1905
|
+
|
|
1906
|
+
Delete campaign store budgets
|
|
1907
|
+
|
|
1908
|
+
Delete the store budgets for a given campaign.
|
|
1909
|
+
|
|
1910
|
+
### Example
|
|
1911
|
+
|
|
1912
|
+
```ruby
|
|
1913
|
+
# load the gem
|
|
1914
|
+
require 'talon_one'
|
|
1915
|
+
# setup authorization
|
|
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
|
+
|
|
1922
|
+
# Configure API key authorization: management_key
|
|
1923
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1924
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1925
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1926
|
+
|
|
1927
|
+
# Configure API key authorization: manager_auth
|
|
1928
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1929
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1930
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1931
|
+
end
|
|
1932
|
+
|
|
1933
|
+
api_instance = TalonOne::ManagementApi.new
|
|
1934
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
1935
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
1936
|
+
opts = {
|
|
1937
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
|
1938
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
begin
|
|
1942
|
+
#Delete campaign store budgets
|
|
1943
|
+
api_instance.delete_campaign_store_budgets(application_id, campaign_id, opts)
|
|
1944
|
+
rescue TalonOne::ApiError => e
|
|
1945
|
+
puts "Exception when calling ManagementApi->delete_campaign_store_budgets: #{e}"
|
|
1946
|
+
end
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
### Parameters
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
Name | Type | Description | Notes
|
|
1953
|
+
------------- | ------------- | ------------- | -------------
|
|
1954
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
1955
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
1956
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
|
1957
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
|
1958
|
+
|
|
1959
|
+
### Return type
|
|
1960
|
+
|
|
1961
|
+
nil (empty response body)
|
|
1962
|
+
|
|
1963
|
+
### Authorization
|
|
1964
|
+
|
|
1965
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
1966
|
+
|
|
1967
|
+
### HTTP request headers
|
|
1968
|
+
|
|
1969
|
+
- **Content-Type**: Not defined
|
|
1970
|
+
- **Accept**: application/json
|
|
1971
|
+
|
|
1972
|
+
|
|
1700
1973
|
## delete_collection
|
|
1701
1974
|
|
|
1702
1975
|
> delete_collection(application_id, campaign_id, collection_id)
|
|
@@ -1712,6 +1985,11 @@ Delete a given campaign-level collection.
|
|
|
1712
1985
|
require 'talon_one'
|
|
1713
1986
|
# setup authorization
|
|
1714
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
|
+
|
|
1715
1993
|
# Configure API key authorization: management_key
|
|
1716
1994
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1717
1995
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1751,7 +2029,7 @@ nil (empty response body)
|
|
|
1751
2029
|
|
|
1752
2030
|
### Authorization
|
|
1753
2031
|
|
|
1754
|
-
[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)
|
|
1755
2033
|
|
|
1756
2034
|
### HTTP request headers
|
|
1757
2035
|
|
|
@@ -1774,6 +2052,11 @@ Delete the specified coupon.
|
|
|
1774
2052
|
require 'talon_one'
|
|
1775
2053
|
# setup authorization
|
|
1776
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
|
+
|
|
1777
2060
|
# Configure API key authorization: management_key
|
|
1778
2061
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1779
2062
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1813,7 +2096,7 @@ nil (empty response body)
|
|
|
1813
2096
|
|
|
1814
2097
|
### Authorization
|
|
1815
2098
|
|
|
1816
|
-
[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)
|
|
1817
2100
|
|
|
1818
2101
|
### HTTP request headers
|
|
1819
2102
|
|
|
@@ -1836,6 +2119,11 @@ Deletes all the coupons matching the specified criteria.
|
|
|
1836
2119
|
require 'talon_one'
|
|
1837
2120
|
# setup authorization
|
|
1838
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
|
+
|
|
1839
2127
|
# Configure API key authorization: management_key
|
|
1840
2128
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1841
2129
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1901,7 +2189,7 @@ nil (empty response body)
|
|
|
1901
2189
|
|
|
1902
2190
|
### Authorization
|
|
1903
2191
|
|
|
1904
|
-
[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)
|
|
1905
2193
|
|
|
1906
2194
|
### HTTP request headers
|
|
1907
2195
|
|
|
@@ -1924,6 +2212,11 @@ Delete the given loyalty card.
|
|
|
1924
2212
|
require 'talon_one'
|
|
1925
2213
|
# setup authorization
|
|
1926
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
|
+
|
|
1927
2220
|
# Configure API key authorization: management_key
|
|
1928
2221
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1929
2222
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -1961,7 +2254,7 @@ nil (empty response body)
|
|
|
1961
2254
|
|
|
1962
2255
|
### Authorization
|
|
1963
2256
|
|
|
1964
|
-
[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)
|
|
1965
2258
|
|
|
1966
2259
|
### HTTP request headers
|
|
1967
2260
|
|
|
@@ -1984,6 +2277,11 @@ Delete the specified referral.
|
|
|
1984
2277
|
require 'talon_one'
|
|
1985
2278
|
# setup authorization
|
|
1986
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
|
+
|
|
1987
2285
|
# Configure API key authorization: management_key
|
|
1988
2286
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1989
2287
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2023,7 +2321,7 @@ nil (empty response body)
|
|
|
2023
2321
|
|
|
2024
2322
|
### Authorization
|
|
2025
2323
|
|
|
2026
|
-
[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)
|
|
2027
2325
|
|
|
2028
2326
|
### HTTP request headers
|
|
2029
2327
|
|
|
@@ -2046,6 +2344,11 @@ Delete the specified store.
|
|
|
2046
2344
|
require 'talon_one'
|
|
2047
2345
|
# setup authorization
|
|
2048
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
|
+
|
|
2049
2352
|
# Configure API key authorization: management_key
|
|
2050
2353
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2051
2354
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2083,7 +2386,7 @@ nil (empty response body)
|
|
|
2083
2386
|
|
|
2084
2387
|
### Authorization
|
|
2085
2388
|
|
|
2086
|
-
[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)
|
|
2087
2390
|
|
|
2088
2391
|
### HTTP request headers
|
|
2089
2392
|
|
|
@@ -2106,6 +2409,11 @@ Delete a specific user.
|
|
|
2106
2409
|
require 'talon_one'
|
|
2107
2410
|
# setup authorization
|
|
2108
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
|
+
|
|
2109
2417
|
# Configure API key authorization: management_key
|
|
2110
2418
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2111
2419
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2141,7 +2449,7 @@ nil (empty response body)
|
|
|
2141
2449
|
|
|
2142
2450
|
### Authorization
|
|
2143
2451
|
|
|
2144
|
-
[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)
|
|
2145
2453
|
|
|
2146
2454
|
### HTTP request headers
|
|
2147
2455
|
|
|
@@ -2164,6 +2472,11 @@ Delete user by email address
|
|
|
2164
2472
|
require 'talon_one'
|
|
2165
2473
|
# setup authorization
|
|
2166
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
|
+
|
|
2167
2480
|
# Configure API key authorization: management_key
|
|
2168
2481
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2169
2482
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2199,7 +2512,7 @@ nil (empty response body)
|
|
|
2199
2512
|
|
|
2200
2513
|
### Authorization
|
|
2201
2514
|
|
|
2202
|
-
[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)
|
|
2203
2516
|
|
|
2204
2517
|
### HTTP request headers
|
|
2205
2518
|
|
|
@@ -2222,6 +2535,11 @@ Destroys the session.
|
|
|
2222
2535
|
require 'talon_one'
|
|
2223
2536
|
# setup authorization
|
|
2224
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
|
+
|
|
2225
2543
|
# Configure API key authorization: management_key
|
|
2226
2544
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2227
2545
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2253,7 +2571,7 @@ nil (empty response body)
|
|
|
2253
2571
|
|
|
2254
2572
|
### Authorization
|
|
2255
2573
|
|
|
2256
|
-
[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)
|
|
2257
2575
|
|
|
2258
2576
|
### HTTP request headers
|
|
2259
2577
|
|
|
@@ -2276,6 +2594,11 @@ Disconnect the stores linked to a specific campaign.
|
|
|
2276
2594
|
require 'talon_one'
|
|
2277
2595
|
# setup authorization
|
|
2278
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
|
+
|
|
2279
2602
|
# Configure API key authorization: management_key
|
|
2280
2603
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2281
2604
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2313,7 +2636,7 @@ nil (empty response body)
|
|
|
2313
2636
|
|
|
2314
2637
|
### Authorization
|
|
2315
2638
|
|
|
2316
|
-
[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)
|
|
2317
2640
|
|
|
2318
2641
|
### HTTP request headers
|
|
2319
2642
|
|
|
@@ -2336,12 +2659,17 @@ Download a CSV file containing items from a given account-level collection. **T
|
|
|
2336
2659
|
require 'talon_one'
|
|
2337
2660
|
# setup authorization
|
|
2338
2661
|
TalonOne.configure do |config|
|
|
2339
|
-
# Configure API key authorization:
|
|
2662
|
+
# Configure API key authorization: api_key_v1
|
|
2340
2663
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2341
2664
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2342
2665
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2343
2666
|
|
|
2344
|
-
# Configure API key authorization:
|
|
2667
|
+
# Configure API key authorization: management_key
|
|
2668
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2669
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2670
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2671
|
+
|
|
2672
|
+
# Configure API key authorization: manager_auth
|
|
2345
2673
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2346
2674
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2347
2675
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
@@ -2372,7 +2700,7 @@ Name | Type | Description | Notes
|
|
|
2372
2700
|
|
|
2373
2701
|
### Authorization
|
|
2374
2702
|
|
|
2375
|
-
[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)
|
|
2376
2704
|
|
|
2377
2705
|
### HTTP request headers
|
|
2378
2706
|
|
|
@@ -2395,6 +2723,11 @@ Download a CSV file containing a list of all the customers who have participated
|
|
|
2395
2723
|
require 'talon_one'
|
|
2396
2724
|
# setup authorization
|
|
2397
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
|
+
|
|
2398
2731
|
# Configure API key authorization: management_key
|
|
2399
2732
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2400
2733
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2435,7 +2768,7 @@ Name | Type | Description | Notes
|
|
|
2435
2768
|
|
|
2436
2769
|
### Authorization
|
|
2437
2770
|
|
|
2438
|
-
[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)
|
|
2439
2772
|
|
|
2440
2773
|
### HTTP request headers
|
|
2441
2774
|
|
|
@@ -2458,6 +2791,11 @@ Download a CSV file containing the integration IDs of the members of an audience
|
|
|
2458
2791
|
require 'talon_one'
|
|
2459
2792
|
# setup authorization
|
|
2460
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
|
+
|
|
2461
2799
|
# Configure API key authorization: management_key
|
|
2462
2800
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2463
2801
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2494,7 +2832,79 @@ Name | Type | Description | Notes
|
|
|
2494
2832
|
|
|
2495
2833
|
### Authorization
|
|
2496
2834
|
|
|
2497
|
-
[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)
|
|
2836
|
+
|
|
2837
|
+
### HTTP request headers
|
|
2838
|
+
|
|
2839
|
+
- **Content-Type**: Not defined
|
|
2840
|
+
- **Accept**: application/csv
|
|
2841
|
+
|
|
2842
|
+
|
|
2843
|
+
## export_campaign_store_budgets
|
|
2844
|
+
|
|
2845
|
+
> String export_campaign_store_budgets(application_id, campaign_id, opts)
|
|
2846
|
+
|
|
2847
|
+
Export campaign store budgets
|
|
2848
|
+
|
|
2849
|
+
Download a CSV file containing the store budgets for a given campaign. **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 CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
|
2850
|
+
|
|
2851
|
+
### Example
|
|
2852
|
+
|
|
2853
|
+
```ruby
|
|
2854
|
+
# load the gem
|
|
2855
|
+
require 'talon_one'
|
|
2856
|
+
# setup authorization
|
|
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
|
+
|
|
2863
|
+
# Configure API key authorization: management_key
|
|
2864
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2865
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2866
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2867
|
+
|
|
2868
|
+
# Configure API key authorization: manager_auth
|
|
2869
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2870
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
2871
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
2872
|
+
end
|
|
2873
|
+
|
|
2874
|
+
api_instance = TalonOne::ManagementApi.new
|
|
2875
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
2876
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
2877
|
+
opts = {
|
|
2878
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
|
2879
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
2880
|
+
}
|
|
2881
|
+
|
|
2882
|
+
begin
|
|
2883
|
+
#Export campaign store budgets
|
|
2884
|
+
result = api_instance.export_campaign_store_budgets(application_id, campaign_id, opts)
|
|
2885
|
+
p result
|
|
2886
|
+
rescue TalonOne::ApiError => e
|
|
2887
|
+
puts "Exception when calling ManagementApi->export_campaign_store_budgets: #{e}"
|
|
2888
|
+
end
|
|
2889
|
+
```
|
|
2890
|
+
|
|
2891
|
+
### Parameters
|
|
2892
|
+
|
|
2893
|
+
|
|
2894
|
+
Name | Type | Description | Notes
|
|
2895
|
+
------------- | ------------- | ------------- | -------------
|
|
2896
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
2897
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
2898
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
|
2899
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
|
2900
|
+
|
|
2901
|
+
### Return type
|
|
2902
|
+
|
|
2903
|
+
**String**
|
|
2904
|
+
|
|
2905
|
+
### Authorization
|
|
2906
|
+
|
|
2907
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
2498
2908
|
|
|
2499
2909
|
### HTTP request headers
|
|
2500
2910
|
|
|
@@ -2517,6 +2927,11 @@ Download a CSV file containing the stores linked to a specific campaign. **Tip:
|
|
|
2517
2927
|
require 'talon_one'
|
|
2518
2928
|
# setup authorization
|
|
2519
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
|
+
|
|
2520
2935
|
# Configure API key authorization: management_key
|
|
2521
2936
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2522
2937
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2555,7 +2970,7 @@ Name | Type | Description | Notes
|
|
|
2555
2970
|
|
|
2556
2971
|
### Authorization
|
|
2557
2972
|
|
|
2558
|
-
[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)
|
|
2559
2974
|
|
|
2560
2975
|
### HTTP request headers
|
|
2561
2976
|
|
|
@@ -2578,6 +2993,11 @@ Download a CSV file containing items from a given campaign-level collection. **
|
|
|
2578
2993
|
require 'talon_one'
|
|
2579
2994
|
# setup authorization
|
|
2580
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
|
+
|
|
2581
3001
|
# Configure API key authorization: management_key
|
|
2582
3002
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2583
3003
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2618,7 +3038,7 @@ Name | Type | Description | Notes
|
|
|
2618
3038
|
|
|
2619
3039
|
### Authorization
|
|
2620
3040
|
|
|
2621
|
-
[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)
|
|
2622
3042
|
|
|
2623
3043
|
### HTTP request headers
|
|
2624
3044
|
|
|
@@ -2641,6 +3061,11 @@ Download a CSV file containing the coupons that match the given properties. **T
|
|
|
2641
3061
|
require 'talon_one'
|
|
2642
3062
|
# setup authorization
|
|
2643
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
|
+
|
|
2644
3069
|
# Configure API key authorization: management_key
|
|
2645
3070
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2646
3071
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2707,7 +3132,7 @@ Name | Type | Description | Notes
|
|
|
2707
3132
|
|
|
2708
3133
|
### Authorization
|
|
2709
3134
|
|
|
2710
|
-
[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)
|
|
2711
3136
|
|
|
2712
3137
|
### HTTP request headers
|
|
2713
3138
|
|
|
@@ -2721,7 +3146,7 @@ Name | Type | Description | Notes
|
|
|
2721
3146
|
|
|
2722
3147
|
Export customer sessions
|
|
2723
3148
|
|
|
2724
|
-
Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
|
3149
|
+
Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **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/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
|
2725
3150
|
|
|
2726
3151
|
### Example
|
|
2727
3152
|
|
|
@@ -2730,6 +3155,11 @@ Download a CSV file containing the customer sessions that match the request. **
|
|
|
2730
3155
|
require 'talon_one'
|
|
2731
3156
|
# setup authorization
|
|
2732
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
|
+
|
|
2733
3163
|
# Configure API key authorization: management_key
|
|
2734
3164
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2735
3165
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2778,7 +3208,7 @@ Name | Type | Description | Notes
|
|
|
2778
3208
|
|
|
2779
3209
|
### Authorization
|
|
2780
3210
|
|
|
2781
|
-
[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)
|
|
2782
3212
|
|
|
2783
3213
|
### HTTP request headers
|
|
2784
3214
|
|
|
@@ -2801,6 +3231,11 @@ Download a CSV file containing the tier information for customers of the specifi
|
|
|
2801
3231
|
require 'talon_one'
|
|
2802
3232
|
# setup authorization
|
|
2803
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
|
+
|
|
2804
3239
|
# Configure API key authorization: management_key
|
|
2805
3240
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2806
3241
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2843,7 +3278,7 @@ Name | Type | Description | Notes
|
|
|
2843
3278
|
|
|
2844
3279
|
### Authorization
|
|
2845
3280
|
|
|
2846
|
-
[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)
|
|
2847
3282
|
|
|
2848
3283
|
### HTTP request headers
|
|
2849
3284
|
|
|
@@ -2866,6 +3301,11 @@ Download a CSV file containing the triggered effects that match the given attrib
|
|
|
2866
3301
|
require 'talon_one'
|
|
2867
3302
|
# setup authorization
|
|
2868
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
|
+
|
|
2869
3309
|
# Configure API key authorization: management_key
|
|
2870
3310
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2871
3311
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2912,7 +3352,7 @@ Name | Type | Description | Notes
|
|
|
2912
3352
|
|
|
2913
3353
|
### Authorization
|
|
2914
3354
|
|
|
2915
|
-
[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)
|
|
2916
3356
|
|
|
2917
3357
|
### HTTP request headers
|
|
2918
3358
|
|
|
@@ -2935,6 +3375,11 @@ Export customer loyalty balance to CSV
|
|
|
2935
3375
|
require 'talon_one'
|
|
2936
3376
|
# setup authorization
|
|
2937
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
|
+
|
|
2938
3383
|
# Configure API key authorization: management_key
|
|
2939
3384
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
2940
3385
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -2975,7 +3420,7 @@ Name | Type | Description | Notes
|
|
|
2975
3420
|
|
|
2976
3421
|
### Authorization
|
|
2977
3422
|
|
|
2978
|
-
[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)
|
|
2979
3424
|
|
|
2980
3425
|
### HTTP request headers
|
|
2981
3426
|
|
|
@@ -2998,6 +3443,11 @@ Download a CSV file containing the balance of each customer in the loyalty progr
|
|
|
2998
3443
|
require 'talon_one'
|
|
2999
3444
|
# setup authorization
|
|
3000
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
|
+
|
|
3001
3451
|
# Configure API key authorization: management_key
|
|
3002
3452
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3003
3453
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3038,7 +3488,7 @@ Name | Type | Description | Notes
|
|
|
3038
3488
|
|
|
3039
3489
|
### Authorization
|
|
3040
3490
|
|
|
3041
|
-
[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)
|
|
3042
3492
|
|
|
3043
3493
|
### HTTP request headers
|
|
3044
3494
|
|
|
@@ -3061,6 +3511,11 @@ Download a CSV file containing the balances of all cards in the loyalty program.
|
|
|
3061
3511
|
require 'talon_one'
|
|
3062
3512
|
# setup authorization
|
|
3063
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
|
+
|
|
3064
3519
|
# Configure API key authorization: management_key
|
|
3065
3520
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3066
3521
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3101,7 +3556,7 @@ Name | Type | Description | Notes
|
|
|
3101
3556
|
|
|
3102
3557
|
### Authorization
|
|
3103
3558
|
|
|
3104
|
-
[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)
|
|
3105
3560
|
|
|
3106
3561
|
### HTTP request headers
|
|
3107
3562
|
|
|
@@ -3124,6 +3579,11 @@ Download a CSV file containing a loyalty card ledger log of the loyalty program.
|
|
|
3124
3579
|
require 'talon_one'
|
|
3125
3580
|
# setup authorization
|
|
3126
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
|
+
|
|
3127
3587
|
# Configure API key authorization: management_key
|
|
3128
3588
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3129
3589
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3170,7 +3630,7 @@ Name | Type | Description | Notes
|
|
|
3170
3630
|
|
|
3171
3631
|
### Authorization
|
|
3172
3632
|
|
|
3173
|
-
[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)
|
|
3174
3634
|
|
|
3175
3635
|
### HTTP request headers
|
|
3176
3636
|
|
|
@@ -3193,6 +3653,11 @@ Download a CSV file containing the loyalty cards from a specified loyalty progra
|
|
|
3193
3653
|
require 'talon_one'
|
|
3194
3654
|
# setup authorization
|
|
3195
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
|
+
|
|
3196
3661
|
# Configure API key authorization: management_key
|
|
3197
3662
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3198
3663
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3208,6 +3673,8 @@ api_instance = TalonOne::ManagementApi.new
|
|
|
3208
3673
|
loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
|
3209
3674
|
opts = {
|
|
3210
3675
|
batch_id: 'batch_id_example', # String | Filter results by loyalty card batch ID.
|
|
3676
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3677
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
|
3211
3678
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
|
3212
3679
|
}
|
|
3213
3680
|
|
|
@@ -3227,6 +3694,8 @@ Name | Type | Description | Notes
|
|
|
3227
3694
|
------------- | ------------- | ------------- | -------------
|
|
3228
3695
|
**loyalty_program_id** | **Integer**| Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
|
3229
3696
|
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
|
3697
|
+
**created_before** | **DateTime**| Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
|
3698
|
+
**created_after** | **DateTime**| Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
|
3230
3699
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
|
3231
3700
|
|
|
3232
3701
|
### Return type
|
|
@@ -3235,7 +3704,7 @@ Name | Type | Description | Notes
|
|
|
3235
3704
|
|
|
3236
3705
|
### Authorization
|
|
3237
3706
|
|
|
3238
|
-
[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)
|
|
3239
3708
|
|
|
3240
3709
|
### HTTP request headers
|
|
3241
3710
|
|
|
@@ -3249,7 +3718,7 @@ Name | Type | Description | Notes
|
|
|
3249
3718
|
|
|
3250
3719
|
Export customer's transaction logs
|
|
3251
3720
|
|
|
3252
|
-
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.
|
|
3253
3722
|
|
|
3254
3723
|
### Example
|
|
3255
3724
|
|
|
@@ -3258,6 +3727,11 @@ Download a CSV file containing a customer's transaction logs in the loyalty prog
|
|
|
3258
3727
|
require 'talon_one'
|
|
3259
3728
|
# setup authorization
|
|
3260
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
|
+
|
|
3261
3735
|
# Configure API key authorization: management_key
|
|
3262
3736
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3263
3737
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3304,7 +3778,7 @@ Name | Type | Description | Notes
|
|
|
3304
3778
|
|
|
3305
3779
|
### Authorization
|
|
3306
3780
|
|
|
3307
|
-
[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)
|
|
3308
3782
|
|
|
3309
3783
|
### HTTP request headers
|
|
3310
3784
|
|
|
@@ -3327,6 +3801,11 @@ Download a CSV file containing the giveaway codes of a specific giveaway pool.
|
|
|
3327
3801
|
require 'talon_one'
|
|
3328
3802
|
# setup authorization
|
|
3329
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
|
+
|
|
3330
3809
|
# Configure API key authorization: management_key
|
|
3331
3810
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3332
3811
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3369,7 +3848,7 @@ Name | Type | Description | Notes
|
|
|
3369
3848
|
|
|
3370
3849
|
### Authorization
|
|
3371
3850
|
|
|
3372
|
-
[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)
|
|
3373
3852
|
|
|
3374
3853
|
### HTTP request headers
|
|
3375
3854
|
|
|
@@ -3392,6 +3871,11 @@ Download a CSV file containing the referrals that match the given parameters. *
|
|
|
3392
3871
|
require 'talon_one'
|
|
3393
3872
|
# setup authorization
|
|
3394
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
|
+
|
|
3395
3879
|
# Configure API key authorization: management_key
|
|
3396
3880
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3397
3881
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3444,7 +3928,7 @@ Name | Type | Description | Notes
|
|
|
3444
3928
|
|
|
3445
3929
|
### Authorization
|
|
3446
3930
|
|
|
3447
|
-
[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)
|
|
3448
3932
|
|
|
3449
3933
|
### HTTP request headers
|
|
3450
3934
|
|
|
@@ -3467,6 +3951,11 @@ Retrieve the list of API calls sent to the specified Application.
|
|
|
3467
3951
|
require 'talon_one'
|
|
3468
3952
|
# setup authorization
|
|
3469
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
|
+
|
|
3470
3959
|
# Configure API key authorization: management_key
|
|
3471
3960
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3472
3961
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3521,7 +4010,7 @@ Name | Type | Description | Notes
|
|
|
3521
4010
|
|
|
3522
4011
|
### Authorization
|
|
3523
4012
|
|
|
3524
|
-
[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)
|
|
3525
4014
|
|
|
3526
4015
|
### HTTP request headers
|
|
3527
4016
|
|
|
@@ -3544,6 +4033,11 @@ Return the details of your companies Talon.One account.
|
|
|
3544
4033
|
require 'talon_one'
|
|
3545
4034
|
# setup authorization
|
|
3546
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
|
+
|
|
3547
4041
|
# Configure API key authorization: management_key
|
|
3548
4042
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3549
4043
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3580,7 +4074,7 @@ Name | Type | Description | Notes
|
|
|
3580
4074
|
|
|
3581
4075
|
### Authorization
|
|
3582
4076
|
|
|
3583
|
-
[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)
|
|
3584
4078
|
|
|
3585
4079
|
### HTTP request headers
|
|
3586
4080
|
|
|
@@ -3603,6 +4097,11 @@ Return the analytics of your Talon.One account.
|
|
|
3603
4097
|
require 'talon_one'
|
|
3604
4098
|
# setup authorization
|
|
3605
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
|
+
|
|
3606
4105
|
# Configure API key authorization: management_key
|
|
3607
4106
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3608
4107
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3639,7 +4138,7 @@ Name | Type | Description | Notes
|
|
|
3639
4138
|
|
|
3640
4139
|
### Authorization
|
|
3641
4140
|
|
|
3642
|
-
[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)
|
|
3643
4142
|
|
|
3644
4143
|
### HTTP request headers
|
|
3645
4144
|
|
|
@@ -3662,6 +4161,11 @@ Retrieve a given account-level collection.
|
|
|
3662
4161
|
require 'talon_one'
|
|
3663
4162
|
# setup authorization
|
|
3664
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
|
+
|
|
3665
4169
|
# Configure API key authorization: management_key
|
|
3666
4170
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3667
4171
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3698,7 +4202,7 @@ Name | Type | Description | Notes
|
|
|
3698
4202
|
|
|
3699
4203
|
### Authorization
|
|
3700
4204
|
|
|
3701
|
-
[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)
|
|
3702
4206
|
|
|
3703
4207
|
### HTTP request headers
|
|
3704
4208
|
|
|
@@ -3721,6 +4225,11 @@ Get the details of a specific achievement.
|
|
|
3721
4225
|
require 'talon_one'
|
|
3722
4226
|
# setup authorization
|
|
3723
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
|
+
|
|
3724
4233
|
# Configure API key authorization: management_key
|
|
3725
4234
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3726
4235
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3761,7 +4270,7 @@ Name | Type | Description | Notes
|
|
|
3761
4270
|
|
|
3762
4271
|
### Authorization
|
|
3763
4272
|
|
|
3764
|
-
[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)
|
|
3765
4274
|
|
|
3766
4275
|
### HTTP request headers
|
|
3767
4276
|
|
|
@@ -3784,6 +4293,11 @@ Returns the additional cost.
|
|
|
3784
4293
|
require 'talon_one'
|
|
3785
4294
|
# setup authorization
|
|
3786
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
|
+
|
|
3787
4301
|
# Configure API key authorization: management_key
|
|
3788
4302
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3789
4303
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3820,7 +4334,7 @@ Name | Type | Description | Notes
|
|
|
3820
4334
|
|
|
3821
4335
|
### Authorization
|
|
3822
4336
|
|
|
3823
|
-
[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)
|
|
3824
4338
|
|
|
3825
4339
|
### HTTP request headers
|
|
3826
4340
|
|
|
@@ -3843,6 +4357,11 @@ Returns all the defined additional costs for the account.
|
|
|
3843
4357
|
require 'talon_one'
|
|
3844
4358
|
# setup authorization
|
|
3845
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
|
+
|
|
3846
4365
|
# Configure API key authorization: management_key
|
|
3847
4366
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3848
4367
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3885,7 +4404,7 @@ Name | Type | Description | Notes
|
|
|
3885
4404
|
|
|
3886
4405
|
### Authorization
|
|
3887
4406
|
|
|
3888
|
-
[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)
|
|
3889
4408
|
|
|
3890
4409
|
### HTTP request headers
|
|
3891
4410
|
|
|
@@ -3908,6 +4427,11 @@ Get the application specified by the ID.
|
|
|
3908
4427
|
require 'talon_one'
|
|
3909
4428
|
# setup authorization
|
|
3910
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
|
+
|
|
3911
4435
|
# Configure API key authorization: management_key
|
|
3912
4436
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3913
4437
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -3944,7 +4468,7 @@ Name | Type | Description | Notes
|
|
|
3944
4468
|
|
|
3945
4469
|
### Authorization
|
|
3946
4470
|
|
|
3947
|
-
[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)
|
|
3948
4472
|
|
|
3949
4473
|
### HTTP request headers
|
|
3950
4474
|
|
|
@@ -3967,6 +4491,11 @@ Display the health of the Application and show the last time the Application was
|
|
|
3967
4491
|
require 'talon_one'
|
|
3968
4492
|
# setup authorization
|
|
3969
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
|
+
|
|
3970
4499
|
# Configure API key authorization: management_key
|
|
3971
4500
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
3972
4501
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4003,7 +4532,7 @@ Name | Type | Description | Notes
|
|
|
4003
4532
|
|
|
4004
4533
|
### Authorization
|
|
4005
4534
|
|
|
4006
|
-
[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)
|
|
4007
4536
|
|
|
4008
4537
|
### HTTP request headers
|
|
4009
4538
|
|
|
@@ -4026,6 +4555,11 @@ Retrieve the customers of the specified application.
|
|
|
4026
4555
|
require 'talon_one'
|
|
4027
4556
|
# setup authorization
|
|
4028
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
|
+
|
|
4029
4563
|
# Configure API key authorization: management_key
|
|
4030
4564
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4031
4565
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4064,7 +4598,7 @@ Name | Type | Description | Notes
|
|
|
4064
4598
|
|
|
4065
4599
|
### Authorization
|
|
4066
4600
|
|
|
4067
|
-
[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)
|
|
4068
4602
|
|
|
4069
4603
|
### HTTP request headers
|
|
4070
4604
|
|
|
@@ -4087,6 +4621,11 @@ List the friends referred by the specified customer profile in this Application.
|
|
|
4087
4621
|
require 'talon_one'
|
|
4088
4622
|
# setup authorization
|
|
4089
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
|
+
|
|
4090
4629
|
# Configure API key authorization: management_key
|
|
4091
4630
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4092
4631
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4135,7 +4674,7 @@ Name | Type | Description | Notes
|
|
|
4135
4674
|
|
|
4136
4675
|
### Authorization
|
|
4137
4676
|
|
|
4138
|
-
[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)
|
|
4139
4678
|
|
|
4140
4679
|
### HTTP request headers
|
|
4141
4680
|
|
|
@@ -4158,6 +4697,11 @@ List all the customers of the specified application.
|
|
|
4158
4697
|
require 'talon_one'
|
|
4159
4698
|
# setup authorization
|
|
4160
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
|
+
|
|
4161
4705
|
# Configure API key authorization: management_key
|
|
4162
4706
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4163
4707
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4204,7 +4748,7 @@ Name | Type | Description | Notes
|
|
|
4204
4748
|
|
|
4205
4749
|
### Authorization
|
|
4206
4750
|
|
|
4207
|
-
[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)
|
|
4208
4752
|
|
|
4209
4753
|
### HTTP request headers
|
|
4210
4754
|
|
|
@@ -4227,6 +4771,11 @@ Get a list of the application customers matching the provided criteria. The mat
|
|
|
4227
4771
|
require 'talon_one'
|
|
4228
4772
|
# setup authorization
|
|
4229
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
|
+
|
|
4230
4779
|
# Configure API key authorization: management_key
|
|
4231
4780
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4232
4781
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4273,7 +4822,7 @@ Name | Type | Description | Notes
|
|
|
4273
4822
|
|
|
4274
4823
|
### Authorization
|
|
4275
4824
|
|
|
4276
|
-
[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)
|
|
4277
4826
|
|
|
4278
4827
|
### HTTP request headers
|
|
4279
4828
|
|
|
@@ -4296,6 +4845,11 @@ Get all of the distinct values of the Event `type` property for events recorded
|
|
|
4296
4845
|
require 'talon_one'
|
|
4297
4846
|
# setup authorization
|
|
4298
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
|
+
|
|
4299
4853
|
# Configure API key authorization: management_key
|
|
4300
4854
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4301
4855
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4340,7 +4894,7 @@ Name | Type | Description | Notes
|
|
|
4340
4894
|
|
|
4341
4895
|
### Authorization
|
|
4342
4896
|
|
|
4343
|
-
[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)
|
|
4344
4898
|
|
|
4345
4899
|
### HTTP request headers
|
|
4346
4900
|
|
|
@@ -4363,6 +4917,11 @@ Lists all events recorded for an application. Instead of having the total number
|
|
|
4363
4917
|
require 'talon_one'
|
|
4364
4918
|
# setup authorization
|
|
4365
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
|
+
|
|
4366
4925
|
# Configure API key authorization: management_key
|
|
4367
4926
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4368
4927
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4390,7 +4949,8 @@ opts = {
|
|
|
4390
4949
|
coupon_code: 'coupon_code_example', # String | Coupon code
|
|
4391
4950
|
referral_code: 'referral_code_example', # String | Referral code
|
|
4392
4951
|
rule_query: 'rule_query_example', # String | Rule name filter for events
|
|
4393
|
-
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).
|
|
4394
4954
|
}
|
|
4395
4955
|
|
|
4396
4956
|
begin
|
|
@@ -4422,6 +4982,7 @@ Name | Type | Description | Notes
|
|
|
4422
4982
|
**referral_code** | **String**| Referral code | [optional]
|
|
4423
4983
|
**rule_query** | **String**| Rule name filter for events | [optional]
|
|
4424
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]
|
|
4425
4986
|
|
|
4426
4987
|
### Return type
|
|
4427
4988
|
|
|
@@ -4429,7 +4990,7 @@ Name | Type | Description | Notes
|
|
|
4429
4990
|
|
|
4430
4991
|
### Authorization
|
|
4431
4992
|
|
|
4432
|
-
[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)
|
|
4433
4994
|
|
|
4434
4995
|
### HTTP request headers
|
|
4435
4996
|
|
|
@@ -4452,6 +5013,11 @@ Get the details of the given session. You can list the sessions with the [List A
|
|
|
4452
5013
|
require 'talon_one'
|
|
4453
5014
|
# setup authorization
|
|
4454
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
|
+
|
|
4455
5021
|
# Configure API key authorization: management_key
|
|
4456
5022
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4457
5023
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4490,7 +5056,7 @@ Name | Type | Description | Notes
|
|
|
4490
5056
|
|
|
4491
5057
|
### Authorization
|
|
4492
5058
|
|
|
4493
|
-
[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)
|
|
4494
5060
|
|
|
4495
5061
|
### HTTP request headers
|
|
4496
5062
|
|
|
@@ -4513,6 +5079,11 @@ List all the sessions of the specified Application.
|
|
|
4513
5079
|
require 'talon_one'
|
|
4514
5080
|
# setup authorization
|
|
4515
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
|
+
|
|
4516
5087
|
# Configure API key authorization: management_key
|
|
4517
5088
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4518
5089
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4573,7 +5144,7 @@ Name | Type | Description | Notes
|
|
|
4573
5144
|
|
|
4574
5145
|
### Authorization
|
|
4575
5146
|
|
|
4576
|
-
[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)
|
|
4577
5148
|
|
|
4578
5149
|
### HTTP request headers
|
|
4579
5150
|
|
|
@@ -4596,6 +5167,11 @@ List all applications in the current account.
|
|
|
4596
5167
|
require 'talon_one'
|
|
4597
5168
|
# setup authorization
|
|
4598
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
|
+
|
|
4599
5175
|
# Configure API key authorization: management_key
|
|
4600
5176
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4601
5177
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4638,7 +5214,7 @@ Name | Type | Description | Notes
|
|
|
4638
5214
|
|
|
4639
5215
|
### Authorization
|
|
4640
5216
|
|
|
4641
|
-
[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)
|
|
4642
5218
|
|
|
4643
5219
|
### HTTP request headers
|
|
4644
5220
|
|
|
@@ -4661,6 +5237,11 @@ Retrieve the specified custom attribute.
|
|
|
4661
5237
|
require 'talon_one'
|
|
4662
5238
|
# setup authorization
|
|
4663
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
|
+
|
|
4664
5245
|
# Configure API key authorization: management_key
|
|
4665
5246
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4666
5247
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4697,7 +5278,7 @@ Name | Type | Description | Notes
|
|
|
4697
5278
|
|
|
4698
5279
|
### Authorization
|
|
4699
5280
|
|
|
4700
|
-
[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)
|
|
4701
5282
|
|
|
4702
5283
|
### HTTP request headers
|
|
4703
5284
|
|
|
@@ -4720,6 +5301,11 @@ Return all the custom attributes for the account.
|
|
|
4720
5301
|
require 'talon_one'
|
|
4721
5302
|
# setup authorization
|
|
4722
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
|
+
|
|
4723
5309
|
# Configure API key authorization: management_key
|
|
4724
5310
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4725
5311
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4764,7 +5350,7 @@ Name | Type | Description | Notes
|
|
|
4764
5350
|
|
|
4765
5351
|
### Authorization
|
|
4766
5352
|
|
|
4767
|
-
[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)
|
|
4768
5354
|
|
|
4769
5355
|
### HTTP request headers
|
|
4770
5356
|
|
|
@@ -4787,6 +5373,11 @@ Get a paginated list of the customer profiles in a given audience. A maximum of
|
|
|
4787
5373
|
require 'talon_one'
|
|
4788
5374
|
# setup authorization
|
|
4789
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
|
+
|
|
4790
5381
|
# Configure API key authorization: management_key
|
|
4791
5382
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4792
5383
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4833,7 +5424,7 @@ Name | Type | Description | Notes
|
|
|
4833
5424
|
|
|
4834
5425
|
### Authorization
|
|
4835
5426
|
|
|
4836
|
-
[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)
|
|
4837
5428
|
|
|
4838
5429
|
### HTTP request headers
|
|
4839
5430
|
|
|
@@ -4856,6 +5447,11 @@ Get all audiences created in the account. To create an audience, use [Create aud
|
|
|
4856
5447
|
require 'talon_one'
|
|
4857
5448
|
# setup authorization
|
|
4858
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
|
+
|
|
4859
5455
|
# Configure API key authorization: management_key
|
|
4860
5456
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4861
5457
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4900,7 +5496,7 @@ Name | Type | Description | Notes
|
|
|
4900
5496
|
|
|
4901
5497
|
### Authorization
|
|
4902
5498
|
|
|
4903
|
-
[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)
|
|
4904
5500
|
|
|
4905
5501
|
### HTTP request headers
|
|
4906
5502
|
|
|
@@ -4923,6 +5519,11 @@ Get a list of audience IDs and their member count.
|
|
|
4923
5519
|
require 'talon_one'
|
|
4924
5520
|
# setup authorization
|
|
4925
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
|
+
|
|
4926
5527
|
# Configure API key authorization: management_key
|
|
4927
5528
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4928
5529
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -4963,7 +5564,7 @@ Name | Type | Description | Notes
|
|
|
4963
5564
|
|
|
4964
5565
|
### Authorization
|
|
4965
5566
|
|
|
4966
|
-
[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)
|
|
4967
5568
|
|
|
4968
5569
|
### HTTP request headers
|
|
4969
5570
|
|
|
@@ -4986,6 +5587,11 @@ Retrieve the given campaign.
|
|
|
4986
5587
|
require 'talon_one'
|
|
4987
5588
|
# setup authorization
|
|
4988
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
|
+
|
|
4989
5595
|
# Configure API key authorization: management_key
|
|
4990
5596
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
4991
5597
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5024,7 +5630,7 @@ Name | Type | Description | Notes
|
|
|
5024
5630
|
|
|
5025
5631
|
### Authorization
|
|
5026
5632
|
|
|
5027
|
-
[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)
|
|
5028
5634
|
|
|
5029
5635
|
### HTTP request headers
|
|
5030
5636
|
|
|
@@ -5047,6 +5653,11 @@ Retrieve statistical data about the performance of the given campaign.
|
|
|
5047
5653
|
require 'talon_one'
|
|
5048
5654
|
# setup authorization
|
|
5049
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
|
+
|
|
5050
5661
|
# Configure API key authorization: management_key
|
|
5051
5662
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5052
5663
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5093,7 +5704,7 @@ Name | Type | Description | Notes
|
|
|
5093
5704
|
|
|
5094
5705
|
### Authorization
|
|
5095
5706
|
|
|
5096
|
-
[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)
|
|
5097
5708
|
|
|
5098
5709
|
### HTTP request headers
|
|
5099
5710
|
|
|
@@ -5116,6 +5727,11 @@ Get a list of all the campaigns that match a set of attributes.
|
|
|
5116
5727
|
require 'talon_one'
|
|
5117
5728
|
# setup authorization
|
|
5118
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
|
+
|
|
5119
5735
|
# Configure API key authorization: management_key
|
|
5120
5736
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5121
5737
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5164,7 +5780,7 @@ Name | Type | Description | Notes
|
|
|
5164
5780
|
|
|
5165
5781
|
### Authorization
|
|
5166
5782
|
|
|
5167
|
-
[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)
|
|
5168
5784
|
|
|
5169
5785
|
### HTTP request headers
|
|
5170
5786
|
|
|
@@ -5187,6 +5803,11 @@ Get a campaign access group specified by its ID.
|
|
|
5187
5803
|
require 'talon_one'
|
|
5188
5804
|
# setup authorization
|
|
5189
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
|
+
|
|
5190
5811
|
# Configure API key authorization: management_key
|
|
5191
5812
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5192
5813
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5223,7 +5844,7 @@ Name | Type | Description | Notes
|
|
|
5223
5844
|
|
|
5224
5845
|
### Authorization
|
|
5225
5846
|
|
|
5226
|
-
[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)
|
|
5227
5848
|
|
|
5228
5849
|
### HTTP request headers
|
|
5229
5850
|
|
|
@@ -5246,6 +5867,11 @@ List the campaign access groups in the current account.
|
|
|
5246
5867
|
require 'talon_one'
|
|
5247
5868
|
# setup authorization
|
|
5248
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
|
+
|
|
5249
5875
|
# Configure API key authorization: management_key
|
|
5250
5876
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5251
5877
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5288,7 +5914,7 @@ Name | Type | Description | Notes
|
|
|
5288
5914
|
|
|
5289
5915
|
### Authorization
|
|
5290
5916
|
|
|
5291
|
-
[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)
|
|
5292
5918
|
|
|
5293
5919
|
### HTTP request headers
|
|
5294
5920
|
|
|
@@ -5311,6 +5937,11 @@ Retrieve a list of campaign templates.
|
|
|
5311
5937
|
require 'talon_one'
|
|
5312
5938
|
# setup authorization
|
|
5313
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
|
+
|
|
5314
5945
|
# Configure API key authorization: management_key
|
|
5315
5946
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5316
5947
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5361,7 +5992,7 @@ Name | Type | Description | Notes
|
|
|
5361
5992
|
|
|
5362
5993
|
### Authorization
|
|
5363
5994
|
|
|
5364
|
-
[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)
|
|
5365
5996
|
|
|
5366
5997
|
### HTTP request headers
|
|
5367
5998
|
|
|
@@ -5384,6 +6015,11 @@ List the campaigns of the specified application that match your filter criteria.
|
|
|
5384
6015
|
require 'talon_one'
|
|
5385
6016
|
# setup authorization
|
|
5386
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
|
+
|
|
5387
6023
|
# Configure API key authorization: management_key
|
|
5388
6024
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5389
6025
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5444,7 +6080,7 @@ Name | Type | Description | Notes
|
|
|
5444
6080
|
|
|
5445
6081
|
### Authorization
|
|
5446
6082
|
|
|
5447
|
-
[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)
|
|
5448
6084
|
|
|
5449
6085
|
### HTTP request headers
|
|
5450
6086
|
|
|
@@ -5454,7 +6090,7 @@ Name | Type | Description | Notes
|
|
|
5454
6090
|
|
|
5455
6091
|
## get_changes
|
|
5456
6092
|
|
|
5457
|
-
>
|
|
6093
|
+
> InlineResponse20042 get_changes(opts)
|
|
5458
6094
|
|
|
5459
6095
|
Get audit logs for an account
|
|
5460
6096
|
|
|
@@ -5467,6 +6103,11 @@ Retrieve the audit logs displayed in **Accounts > Audit logs**.
|
|
|
5467
6103
|
require 'talon_one'
|
|
5468
6104
|
# setup authorization
|
|
5469
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
|
+
|
|
5470
6111
|
# Configure API key authorization: management_key
|
|
5471
6112
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5472
6113
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5521,11 +6162,11 @@ Name | Type | Description | Notes
|
|
|
5521
6162
|
|
|
5522
6163
|
### Return type
|
|
5523
6164
|
|
|
5524
|
-
[**
|
|
6165
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
|
5525
6166
|
|
|
5526
6167
|
### Authorization
|
|
5527
6168
|
|
|
5528
|
-
[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)
|
|
5529
6170
|
|
|
5530
6171
|
### HTTP request headers
|
|
5531
6172
|
|
|
@@ -5548,7 +6189,12 @@ Retrieve a given campaign-level collection.
|
|
|
5548
6189
|
require 'talon_one'
|
|
5549
6190
|
# setup authorization
|
|
5550
6191
|
TalonOne.configure do |config|
|
|
5551
|
-
# Configure API key authorization:
|
|
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
|
+
|
|
6197
|
+
# Configure API key authorization: management_key
|
|
5552
6198
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5553
6199
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
5554
6200
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
@@ -5588,7 +6234,7 @@ Name | Type | Description | Notes
|
|
|
5588
6234
|
|
|
5589
6235
|
### Authorization
|
|
5590
6236
|
|
|
5591
|
-
[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)
|
|
5592
6238
|
|
|
5593
6239
|
### HTTP request headers
|
|
5594
6240
|
|
|
@@ -5611,6 +6257,11 @@ Retrieve items from a given collection. You can retrieve items from both accoun
|
|
|
5611
6257
|
require 'talon_one'
|
|
5612
6258
|
# setup authorization
|
|
5613
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
|
+
|
|
5614
6265
|
# Configure API key authorization: management_key
|
|
5615
6266
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5616
6267
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5653,7 +6304,7 @@ Name | Type | Description | Notes
|
|
|
5653
6304
|
|
|
5654
6305
|
### Authorization
|
|
5655
6306
|
|
|
5656
|
-
[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)
|
|
5657
6308
|
|
|
5658
6309
|
### HTTP request headers
|
|
5659
6310
|
|
|
@@ -5676,6 +6327,11 @@ List all the coupons matching the specified criteria.
|
|
|
5676
6327
|
require 'talon_one'
|
|
5677
6328
|
# setup authorization
|
|
5678
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
|
+
|
|
5679
6335
|
# Configure API key authorization: management_key
|
|
5680
6336
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5681
6337
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5752,7 +6408,7 @@ Name | Type | Description | Notes
|
|
|
5752
6408
|
|
|
5753
6409
|
### Authorization
|
|
5754
6410
|
|
|
5755
|
-
[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)
|
|
5756
6412
|
|
|
5757
6413
|
### HTTP request headers
|
|
5758
6414
|
|
|
@@ -5775,6 +6431,11 @@ Fetch the summary report of a given customer in the given application, in a time
|
|
|
5775
6431
|
require 'talon_one'
|
|
5776
6432
|
# setup authorization
|
|
5777
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
|
+
|
|
5778
6439
|
# Configure API key authorization: management_key
|
|
5779
6440
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5780
6441
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5823,7 +6484,7 @@ Name | Type | Description | Notes
|
|
|
5823
6484
|
|
|
5824
6485
|
### Authorization
|
|
5825
6486
|
|
|
5826
|
-
[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)
|
|
5827
6488
|
|
|
5828
6489
|
### HTTP request headers
|
|
5829
6490
|
|
|
@@ -5846,6 +6507,11 @@ Fetch summary reports for all application customers based on a time range. Inste
|
|
|
5846
6507
|
require 'talon_one'
|
|
5847
6508
|
# setup authorization
|
|
5848
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
|
+
|
|
5849
6515
|
# Configure API key authorization: management_key
|
|
5850
6516
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5851
6517
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5902,7 +6568,7 @@ Name | Type | Description | Notes
|
|
|
5902
6568
|
|
|
5903
6569
|
### Authorization
|
|
5904
6570
|
|
|
5905
|
-
[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)
|
|
5906
6572
|
|
|
5907
6573
|
### HTTP request headers
|
|
5908
6574
|
|
|
@@ -5925,6 +6591,11 @@ Fetch analytics for a given customer in the given application.
|
|
|
5925
6591
|
require 'talon_one'
|
|
5926
6592
|
# setup authorization
|
|
5927
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
|
+
|
|
5928
6599
|
# Configure API key authorization: management_key
|
|
5929
6600
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5930
6601
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -5971,7 +6642,7 @@ Name | Type | Description | Notes
|
|
|
5971
6642
|
|
|
5972
6643
|
### Authorization
|
|
5973
6644
|
|
|
5974
|
-
[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)
|
|
5975
6646
|
|
|
5976
6647
|
### HTTP request headers
|
|
5977
6648
|
|
|
@@ -5994,6 +6665,11 @@ Return the details of the specified customer profile. <div class=\"redoc-sectio
|
|
|
5994
6665
|
require 'talon_one'
|
|
5995
6666
|
# setup authorization
|
|
5996
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
|
+
|
|
5997
6673
|
# Configure API key authorization: management_key
|
|
5998
6674
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
5999
6675
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6030,7 +6706,7 @@ Name | Type | Description | Notes
|
|
|
6030
6706
|
|
|
6031
6707
|
### Authorization
|
|
6032
6708
|
|
|
6033
|
-
[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)
|
|
6034
6710
|
|
|
6035
6711
|
### HTTP request headers
|
|
6036
6712
|
|
|
@@ -6053,6 +6729,11 @@ For the given customer profile, list all the achievements that match your filter
|
|
|
6053
6729
|
require 'talon_one'
|
|
6054
6730
|
# setup authorization
|
|
6055
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
|
+
|
|
6056
6737
|
# Configure API key authorization: management_key
|
|
6057
6738
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6058
6739
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6101,7 +6782,7 @@ Name | Type | Description | Notes
|
|
|
6101
6782
|
|
|
6102
6783
|
### Authorization
|
|
6103
6784
|
|
|
6104
|
-
[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)
|
|
6105
6786
|
|
|
6106
6787
|
### HTTP request headers
|
|
6107
6788
|
|
|
@@ -6124,6 +6805,11 @@ List all customer profiles.
|
|
|
6124
6805
|
require 'talon_one'
|
|
6125
6806
|
# setup authorization
|
|
6126
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
|
+
|
|
6127
6813
|
# Configure API key authorization: management_key
|
|
6128
6814
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6129
6815
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6166,7 +6852,7 @@ Name | Type | Description | Notes
|
|
|
6166
6852
|
|
|
6167
6853
|
### Authorization
|
|
6168
6854
|
|
|
6169
|
-
[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)
|
|
6170
6856
|
|
|
6171
6857
|
### HTTP request headers
|
|
6172
6858
|
|
|
@@ -6189,6 +6875,11 @@ Get a list of the customer profiles matching the provided criteria. The match i
|
|
|
6189
6875
|
require 'talon_one'
|
|
6190
6876
|
# setup authorization
|
|
6191
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
|
+
|
|
6192
6883
|
# Configure API key authorization: management_key
|
|
6193
6884
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6194
6885
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6233,7 +6924,7 @@ Name | Type | Description | Notes
|
|
|
6233
6924
|
|
|
6234
6925
|
### Authorization
|
|
6235
6926
|
|
|
6236
|
-
[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)
|
|
6237
6928
|
|
|
6238
6929
|
### HTTP request headers
|
|
6239
6930
|
|
|
@@ -6256,6 +6947,11 @@ Retrieve the statistics displayed on the specified loyalty program's dashboard,
|
|
|
6256
6947
|
require 'talon_one'
|
|
6257
6948
|
# setup authorization
|
|
6258
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
|
+
|
|
6259
6955
|
# Configure API key authorization: management_key
|
|
6260
6956
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6261
6957
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6300,7 +6996,7 @@ Name | Type | Description | Notes
|
|
|
6300
6996
|
|
|
6301
6997
|
### Authorization
|
|
6302
6998
|
|
|
6303
|
-
[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)
|
|
6304
7000
|
|
|
6305
7001
|
### HTTP request headers
|
|
6306
7002
|
|
|
@@ -6310,7 +7006,7 @@ Name | Type | Description | Notes
|
|
|
6310
7006
|
|
|
6311
7007
|
## get_event_types
|
|
6312
7008
|
|
|
6313
|
-
>
|
|
7009
|
+
> InlineResponse20040 get_event_types(opts)
|
|
6314
7010
|
|
|
6315
7011
|
List event types
|
|
6316
7012
|
|
|
@@ -6323,6 +7019,11 @@ Fetch all event type definitions for your account.
|
|
|
6323
7019
|
require 'talon_one'
|
|
6324
7020
|
# setup authorization
|
|
6325
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
|
+
|
|
6326
7027
|
# Configure API key authorization: management_key
|
|
6327
7028
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6328
7029
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6365,11 +7066,11 @@ Name | Type | Description | Notes
|
|
|
6365
7066
|
|
|
6366
7067
|
### Return type
|
|
6367
7068
|
|
|
6368
|
-
[**
|
|
7069
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
|
6369
7070
|
|
|
6370
7071
|
### Authorization
|
|
6371
7072
|
|
|
6372
|
-
[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)
|
|
6373
7074
|
|
|
6374
7075
|
### HTTP request headers
|
|
6375
7076
|
|
|
@@ -6379,7 +7080,7 @@ Name | Type | Description | Notes
|
|
|
6379
7080
|
|
|
6380
7081
|
## get_exports
|
|
6381
7082
|
|
|
6382
|
-
>
|
|
7083
|
+
> InlineResponse20043 get_exports(opts)
|
|
6383
7084
|
|
|
6384
7085
|
Get exports
|
|
6385
7086
|
|
|
@@ -6392,6 +7093,11 @@ List all past exports
|
|
|
6392
7093
|
require 'talon_one'
|
|
6393
7094
|
# setup authorization
|
|
6394
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
|
+
|
|
6395
7101
|
# Configure API key authorization: management_key
|
|
6396
7102
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6397
7103
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6434,11 +7140,11 @@ Name | Type | Description | Notes
|
|
|
6434
7140
|
|
|
6435
7141
|
### Return type
|
|
6436
7142
|
|
|
6437
|
-
[**
|
|
7143
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
|
6438
7144
|
|
|
6439
7145
|
### Authorization
|
|
6440
7146
|
|
|
6441
|
-
[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)
|
|
6442
7148
|
|
|
6443
7149
|
### HTTP request headers
|
|
6444
7150
|
|
|
@@ -6461,6 +7167,11 @@ Get the given loyalty card.
|
|
|
6461
7167
|
require 'talon_one'
|
|
6462
7168
|
# setup authorization
|
|
6463
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
|
+
|
|
6464
7175
|
# Configure API key authorization: management_key
|
|
6465
7176
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6466
7177
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6499,7 +7210,7 @@ Name | Type | Description | Notes
|
|
|
6499
7210
|
|
|
6500
7211
|
### Authorization
|
|
6501
7212
|
|
|
6502
|
-
[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)
|
|
6503
7214
|
|
|
6504
7215
|
### HTTP request headers
|
|
6505
7216
|
|
|
@@ -6522,6 +7233,11 @@ Retrieve the transaction logs for the given [loyalty card](https://docs.talon.on
|
|
|
6522
7233
|
require 'talon_one'
|
|
6523
7234
|
# setup authorization
|
|
6524
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
|
+
|
|
6525
7241
|
# Configure API key authorization: management_key
|
|
6526
7242
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6527
7243
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6541,7 +7257,9 @@ opts = {
|
|
|
6541
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.
|
|
6542
7258
|
page_size: 1000, # Integer | The number of items in the response.
|
|
6543
7259
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
6544
|
-
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.
|
|
6545
7263
|
}
|
|
6546
7264
|
|
|
6547
7265
|
begin
|
|
@@ -6565,6 +7283,8 @@ Name | Type | Description | Notes
|
|
|
6565
7283
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
|
6566
7284
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
6567
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]
|
|
6568
7288
|
|
|
6569
7289
|
### Return type
|
|
6570
7290
|
|
|
@@ -6572,7 +7292,7 @@ Name | Type | Description | Notes
|
|
|
6572
7292
|
|
|
6573
7293
|
### Authorization
|
|
6574
7294
|
|
|
6575
|
-
[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)
|
|
6576
7296
|
|
|
6577
7297
|
### HTTP request headers
|
|
6578
7298
|
|
|
@@ -6595,6 +7315,11 @@ For the given card-based loyalty program, list the loyalty cards that match your
|
|
|
6595
7315
|
require 'talon_one'
|
|
6596
7316
|
# setup authorization
|
|
6597
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
|
+
|
|
6598
7323
|
# Configure API key authorization: management_key
|
|
6599
7324
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6600
7325
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6645,7 +7370,7 @@ Name | Type | Description | Notes
|
|
|
6645
7370
|
|
|
6646
7371
|
### Authorization
|
|
6647
7372
|
|
|
6648
|
-
[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)
|
|
6649
7374
|
|
|
6650
7375
|
### HTTP request headers
|
|
6651
7376
|
|
|
@@ -6668,6 +7393,11 @@ Get the loyalty ledger for this profile integration ID. To get the `integration
|
|
|
6668
7393
|
require 'talon_one'
|
|
6669
7394
|
# setup authorization
|
|
6670
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
|
+
|
|
6671
7401
|
# Configure API key authorization: management_key
|
|
6672
7402
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6673
7403
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6706,7 +7436,7 @@ Name | Type | Description | Notes
|
|
|
6706
7436
|
|
|
6707
7437
|
### Authorization
|
|
6708
7438
|
|
|
6709
|
-
[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)
|
|
6710
7440
|
|
|
6711
7441
|
### HTTP request headers
|
|
6712
7442
|
|
|
@@ -6729,6 +7459,11 @@ Get the specified [loyalty program](https://docs.talon.one/docs/product/loyalty-
|
|
|
6729
7459
|
require 'talon_one'
|
|
6730
7460
|
# setup authorization
|
|
6731
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
|
+
|
|
6732
7467
|
# Configure API key authorization: management_key
|
|
6733
7468
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6734
7469
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6765,7 +7500,7 @@ Name | Type | Description | Notes
|
|
|
6765
7500
|
|
|
6766
7501
|
### Authorization
|
|
6767
7502
|
|
|
6768
|
-
[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)
|
|
6769
7504
|
|
|
6770
7505
|
### HTTP request headers
|
|
6771
7506
|
|
|
@@ -6788,6 +7523,11 @@ Retrieve loyalty program transaction logs in a given loyalty program with filter
|
|
|
6788
7523
|
require 'talon_one'
|
|
6789
7524
|
# setup authorization
|
|
6790
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
|
+
|
|
6791
7531
|
# Configure API key authorization: management_key
|
|
6792
7532
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6793
7533
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6804,6 +7544,8 @@ loyalty_program_id = 56 # Integer | Identifier of the loyalty program. You can g
|
|
|
6804
7544
|
opts = {
|
|
6805
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.
|
|
6806
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.
|
|
6807
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.
|
|
6808
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.
|
|
6809
7551
|
page_size: 50, # Integer | The number of items in the response.
|
|
@@ -6827,6 +7569,8 @@ Name | Type | Description | Notes
|
|
|
6827
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. |
|
|
6828
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]
|
|
6829
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]
|
|
6830
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]
|
|
6831
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]
|
|
6832
7576
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
|
@@ -6838,7 +7582,7 @@ Name | Type | Description | Notes
|
|
|
6838
7582
|
|
|
6839
7583
|
### Authorization
|
|
6840
7584
|
|
|
6841
|
-
[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)
|
|
6842
7586
|
|
|
6843
7587
|
### HTTP request headers
|
|
6844
7588
|
|
|
@@ -6861,6 +7605,11 @@ List the loyalty programs of the account.
|
|
|
6861
7605
|
require 'talon_one'
|
|
6862
7606
|
# setup authorization
|
|
6863
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
|
+
|
|
6864
7613
|
# Configure API key authorization: management_key
|
|
6865
7614
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6866
7615
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6893,7 +7642,7 @@ This endpoint does not need any parameter.
|
|
|
6893
7642
|
|
|
6894
7643
|
### Authorization
|
|
6895
7644
|
|
|
6896
|
-
[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)
|
|
6897
7646
|
|
|
6898
7647
|
### HTTP request headers
|
|
6899
7648
|
|
|
@@ -6916,6 +7665,11 @@ Get loyalty program statistics
|
|
|
6916
7665
|
require 'talon_one'
|
|
6917
7666
|
# setup authorization
|
|
6918
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
|
+
|
|
6919
7673
|
# Configure API key authorization: management_key
|
|
6920
7674
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6921
7675
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6952,7 +7706,7 @@ Name | Type | Description | Notes
|
|
|
6952
7706
|
|
|
6953
7707
|
### Authorization
|
|
6954
7708
|
|
|
6955
|
-
[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)
|
|
6956
7710
|
|
|
6957
7711
|
### HTTP request headers
|
|
6958
7712
|
|
|
@@ -6975,6 +7729,11 @@ Retrieve all message log entries.
|
|
|
6975
7729
|
require 'talon_one'
|
|
6976
7730
|
# setup authorization
|
|
6977
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
|
+
|
|
6978
7737
|
# Configure API key authorization: management_key
|
|
6979
7738
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
6980
7739
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -6992,8 +7751,8 @@ opts = {
|
|
|
6992
7751
|
message_id: 'message_id_example', # String | Filter results by message ID.
|
|
6993
7752
|
change_type: 'change_type_example', # String | Filter results by change type.
|
|
6994
7753
|
notification_i_ds: 'notification_i_ds_example', # String | Filter results by notification ID (include up to 30 values, separated by a comma).
|
|
6995
|
-
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.
|
|
6996
|
-
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.
|
|
6997
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.
|
|
6998
7757
|
period: 'period_example', # String | Filter results by time period. Choose between the available relative time frames.
|
|
6999
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.
|
|
@@ -7022,8 +7781,8 @@ Name | Type | Description | Notes
|
|
|
7022
7781
|
**message_id** | **String**| Filter results by message ID. | [optional]
|
|
7023
7782
|
**change_type** | **String**| Filter results by change type. | [optional]
|
|
7024
7783
|
**notification_i_ds** | **String**| Filter results by notification ID (include up to 30 values, separated by a comma). | [optional]
|
|
7025
|
-
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string.
|
|
7026
|
-
**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]
|
|
7027
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]
|
|
7028
7787
|
**period** | **String**| Filter results by time period. Choose between the available relative time frames. | [optional]
|
|
7029
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]
|
|
@@ -7039,7 +7798,7 @@ Name | Type | Description | Notes
|
|
|
7039
7798
|
|
|
7040
7799
|
### Authorization
|
|
7041
7800
|
|
|
7042
|
-
[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)
|
|
7043
7802
|
|
|
7044
7803
|
### HTTP request headers
|
|
7045
7804
|
|
|
@@ -7062,6 +7821,11 @@ List all referrals of the specified campaign.
|
|
|
7062
7821
|
require 'talon_one'
|
|
7063
7822
|
# setup authorization
|
|
7064
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
|
+
|
|
7065
7829
|
# Configure API key authorization: management_key
|
|
7066
7830
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7067
7831
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7120,7 +7884,7 @@ Name | Type | Description | Notes
|
|
|
7120
7884
|
|
|
7121
7885
|
### Authorization
|
|
7122
7886
|
|
|
7123
|
-
[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)
|
|
7124
7888
|
|
|
7125
7889
|
### HTTP request headers
|
|
7126
7890
|
|
|
@@ -7143,6 +7907,11 @@ Get the details of a specific role. To see all the roles, use the [List roles](/
|
|
|
7143
7907
|
require 'talon_one'
|
|
7144
7908
|
# setup authorization
|
|
7145
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
|
+
|
|
7146
7915
|
# Configure API key authorization: management_key
|
|
7147
7916
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7148
7917
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7179,7 +7948,7 @@ Name | Type | Description | Notes
|
|
|
7179
7948
|
|
|
7180
7949
|
### Authorization
|
|
7181
7950
|
|
|
7182
|
-
[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)
|
|
7183
7952
|
|
|
7184
7953
|
### HTTP request headers
|
|
7185
7954
|
|
|
@@ -7202,6 +7971,11 @@ Retrieve the specified ruleset.
|
|
|
7202
7971
|
require 'talon_one'
|
|
7203
7972
|
# setup authorization
|
|
7204
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
|
+
|
|
7205
7979
|
# Configure API key authorization: management_key
|
|
7206
7980
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7207
7981
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7242,7 +8016,7 @@ Name | Type | Description | Notes
|
|
|
7242
8016
|
|
|
7243
8017
|
### Authorization
|
|
7244
8018
|
|
|
7245
|
-
[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)
|
|
7246
8020
|
|
|
7247
8021
|
### HTTP request headers
|
|
7248
8022
|
|
|
@@ -7265,6 +8039,11 @@ List all rulesets of this campaign. A ruleset is a revision of the rules of a ca
|
|
|
7265
8039
|
require 'talon_one'
|
|
7266
8040
|
# setup authorization
|
|
7267
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
|
+
|
|
7268
8047
|
# Configure API key authorization: management_key
|
|
7269
8048
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7270
8049
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7311,7 +8090,7 @@ Name | Type | Description | Notes
|
|
|
7311
8090
|
|
|
7312
8091
|
### Authorization
|
|
7313
8092
|
|
|
7314
|
-
[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)
|
|
7315
8094
|
|
|
7316
8095
|
### HTTP request headers
|
|
7317
8096
|
|
|
@@ -7334,6 +8113,11 @@ Get store details for a specific store ID.
|
|
|
7334
8113
|
require 'talon_one'
|
|
7335
8114
|
# setup authorization
|
|
7336
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
|
+
|
|
7337
8121
|
# Configure API key authorization: management_key
|
|
7338
8122
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7339
8123
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7372,7 +8156,7 @@ Name | Type | Description | Notes
|
|
|
7372
8156
|
|
|
7373
8157
|
### Authorization
|
|
7374
8158
|
|
|
7375
|
-
[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)
|
|
7376
8160
|
|
|
7377
8161
|
### HTTP request headers
|
|
7378
8162
|
|
|
@@ -7395,6 +8179,11 @@ Retrieve the data (including an invitation code) for a user. Non-admin users can
|
|
|
7395
8179
|
require 'talon_one'
|
|
7396
8180
|
# setup authorization
|
|
7397
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
|
+
|
|
7398
8187
|
# Configure API key authorization: management_key
|
|
7399
8188
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7400
8189
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7431,7 +8220,7 @@ Name | Type | Description | Notes
|
|
|
7431
8220
|
|
|
7432
8221
|
### Authorization
|
|
7433
8222
|
|
|
7434
|
-
[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)
|
|
7435
8224
|
|
|
7436
8225
|
### HTTP request headers
|
|
7437
8226
|
|
|
@@ -7441,7 +8230,7 @@ Name | Type | Description | Notes
|
|
|
7441
8230
|
|
|
7442
8231
|
## get_users
|
|
7443
8232
|
|
|
7444
|
-
>
|
|
8233
|
+
> InlineResponse20041 get_users(opts)
|
|
7445
8234
|
|
|
7446
8235
|
List users in account
|
|
7447
8236
|
|
|
@@ -7454,6 +8243,11 @@ Retrieve all users in your account.
|
|
|
7454
8243
|
require 'talon_one'
|
|
7455
8244
|
# setup authorization
|
|
7456
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
|
+
|
|
7457
8251
|
# Configure API key authorization: management_key
|
|
7458
8252
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7459
8253
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7492,11 +8286,11 @@ Name | Type | Description | Notes
|
|
|
7492
8286
|
|
|
7493
8287
|
### Return type
|
|
7494
8288
|
|
|
7495
|
-
[**
|
|
8289
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
|
7496
8290
|
|
|
7497
8291
|
### Authorization
|
|
7498
8292
|
|
|
7499
|
-
[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)
|
|
7500
8294
|
|
|
7501
8295
|
### HTTP request headers
|
|
7502
8296
|
|
|
@@ -7519,6 +8313,11 @@ Returns a webhook by its id.
|
|
|
7519
8313
|
require 'talon_one'
|
|
7520
8314
|
# setup authorization
|
|
7521
8315
|
TalonOne.configure do |config|
|
|
8316
|
+
# Configure API key authorization: api_key_v1
|
|
8317
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8318
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
8319
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
8320
|
+
|
|
7522
8321
|
# Configure API key authorization: management_key
|
|
7523
8322
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7524
8323
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7555,7 +8354,7 @@ Name | Type | Description | Notes
|
|
|
7555
8354
|
|
|
7556
8355
|
### Authorization
|
|
7557
8356
|
|
|
7558
|
-
[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)
|
|
7559
8358
|
|
|
7560
8359
|
### HTTP request headers
|
|
7561
8360
|
|
|
@@ -7563,13 +8362,13 @@ Name | Type | Description | Notes
|
|
|
7563
8362
|
- **Accept**: application/json
|
|
7564
8363
|
|
|
7565
8364
|
|
|
7566
|
-
##
|
|
8365
|
+
## get_webhooks
|
|
7567
8366
|
|
|
7568
|
-
>
|
|
8367
|
+
> InlineResponse20039 get_webhooks(opts)
|
|
7569
8368
|
|
|
7570
|
-
List
|
|
8369
|
+
List webhooks
|
|
7571
8370
|
|
|
7572
|
-
|
|
8371
|
+
List all webhooks.
|
|
7573
8372
|
|
|
7574
8373
|
### Example
|
|
7575
8374
|
|
|
@@ -7578,6 +8377,11 @@ Webhook activation log entries are created as soon as an integration request tri
|
|
|
7578
8377
|
require 'talon_one'
|
|
7579
8378
|
# setup authorization
|
|
7580
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
|
+
|
|
7581
8385
|
# Configure API key authorization: management_key
|
|
7582
8386
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7583
8387
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7591,23 +8395,22 @@ end
|
|
|
7591
8395
|
|
|
7592
8396
|
api_instance = TalonOne::ManagementApi.new
|
|
7593
8397
|
opts = {
|
|
8398
|
+
application_ids: 'application_ids_example', # String | Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
|
8399
|
+
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.
|
|
7594
8400
|
page_size: 1000, # Integer | The number of items in the response.
|
|
7595
8401
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
7596
|
-
|
|
7597
|
-
|
|
7598
|
-
|
|
7599
|
-
|
|
7600
|
-
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
|
7601
|
-
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.
|
|
7602
|
-
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.
|
|
8402
|
+
creation_type: 'creation_type_example', # String | Filter results by creation type.
|
|
8403
|
+
visibility: 'visibility_example', # String | Filter results by visibility.
|
|
8404
|
+
outgoing_integrations_type_id: 56, # Integer | Filter results by outgoing integration type ID.
|
|
8405
|
+
title: 'title_example' # String | Filter results performing case-insensitive matching against the webhook title.
|
|
7603
8406
|
}
|
|
7604
8407
|
|
|
7605
8408
|
begin
|
|
7606
|
-
#List
|
|
7607
|
-
result = api_instance.
|
|
8409
|
+
#List webhooks
|
|
8410
|
+
result = api_instance.get_webhooks(opts)
|
|
7608
8411
|
p result
|
|
7609
8412
|
rescue TalonOne::ApiError => e
|
|
7610
|
-
puts "Exception when calling ManagementApi->
|
|
8413
|
+
puts "Exception when calling ManagementApi->get_webhooks: #{e}"
|
|
7611
8414
|
end
|
|
7612
8415
|
```
|
|
7613
8416
|
|
|
@@ -7616,23 +8419,22 @@ end
|
|
|
7616
8419
|
|
|
7617
8420
|
Name | Type | Description | Notes
|
|
7618
8421
|
------------- | ------------- | ------------- | -------------
|
|
8422
|
+
**application_ids** | **String**| Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications. | [optional]
|
|
8423
|
+
**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]
|
|
7619
8424
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
|
7620
8425
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
7621
|
-
**
|
|
7622
|
-
**
|
|
7623
|
-
**
|
|
7624
|
-
**
|
|
7625
|
-
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
|
7626
|
-
**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]
|
|
7627
|
-
**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]
|
|
8426
|
+
**creation_type** | **String**| Filter results by creation type. | [optional]
|
|
8427
|
+
**visibility** | **String**| Filter results by visibility. | [optional]
|
|
8428
|
+
**outgoing_integrations_type_id** | **Integer**| Filter results by outgoing integration type ID. | [optional]
|
|
8429
|
+
**title** | **String**| Filter results performing case-insensitive matching against the webhook title. | [optional]
|
|
7628
8430
|
|
|
7629
8431
|
### Return type
|
|
7630
8432
|
|
|
7631
|
-
[**
|
|
8433
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
|
7632
8434
|
|
|
7633
8435
|
### Authorization
|
|
7634
8436
|
|
|
7635
|
-
[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)
|
|
7636
8438
|
|
|
7637
8439
|
### HTTP request headers
|
|
7638
8440
|
|
|
@@ -7640,13 +8442,13 @@ Name | Type | Description | Notes
|
|
|
7640
8442
|
- **Accept**: application/json
|
|
7641
8443
|
|
|
7642
8444
|
|
|
7643
|
-
##
|
|
8445
|
+
## import_account_collection
|
|
7644
8446
|
|
|
7645
|
-
>
|
|
8447
|
+
> Import import_account_collection(collection_id, opts)
|
|
7646
8448
|
|
|
7647
|
-
|
|
8449
|
+
Import data into existing account-level collection
|
|
7648
8450
|
|
|
7649
|
-
|
|
8451
|
+
Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import **replaces** the initial content of the collection. The CSV file **must** only contain the following column: - `item`: the values in your collection. A collection is limited to 500,000 items. Example: ``` item Addidas Nike Asics ``` **Note:** Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.
|
|
7650
8452
|
|
|
7651
8453
|
### Example
|
|
7652
8454
|
|
|
@@ -7655,6 +8457,11 @@ Retrieve all webhook log entries.
|
|
|
7655
8457
|
require 'talon_one'
|
|
7656
8458
|
# setup authorization
|
|
7657
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
|
+
|
|
7658
8465
|
# Configure API key authorization: management_key
|
|
7659
8466
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7660
8467
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7667,25 +8474,17 @@ TalonOne.configure do |config|
|
|
|
7667
8474
|
end
|
|
7668
8475
|
|
|
7669
8476
|
api_instance = TalonOne::ManagementApi.new
|
|
8477
|
+
collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint.
|
|
7670
8478
|
opts = {
|
|
7671
|
-
|
|
7672
|
-
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
7673
|
-
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.
|
|
7674
|
-
status: 'status_example', # String | Filter results by HTTP status codes.
|
|
7675
|
-
webhook_id: 3.4, # Float | Filter results by webhook id.
|
|
7676
|
-
application_id: 3.4, # Float | Filter results by Application ID.
|
|
7677
|
-
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
|
7678
|
-
request_uuid: 'request_uuid_example', # String | Filter results by request UUID.
|
|
7679
|
-
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.
|
|
7680
|
-
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.
|
|
8479
|
+
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
7681
8480
|
}
|
|
7682
8481
|
|
|
7683
8482
|
begin
|
|
7684
|
-
#
|
|
7685
|
-
result = api_instance.
|
|
8483
|
+
#Import data into existing account-level collection
|
|
8484
|
+
result = api_instance.import_account_collection(collection_id, opts)
|
|
7686
8485
|
p result
|
|
7687
8486
|
rescue TalonOne::ApiError => e
|
|
7688
|
-
puts "Exception when calling ManagementApi->
|
|
8487
|
+
puts "Exception when calling ManagementApi->import_account_collection: #{e}"
|
|
7689
8488
|
end
|
|
7690
8489
|
```
|
|
7691
8490
|
|
|
@@ -7694,38 +8493,30 @@ end
|
|
|
7694
8493
|
|
|
7695
8494
|
Name | Type | Description | Notes
|
|
7696
8495
|
------------- | ------------- | ------------- | -------------
|
|
7697
|
-
**
|
|
7698
|
-
**
|
|
7699
|
-
**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]
|
|
7700
|
-
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
|
7701
|
-
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
|
7702
|
-
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
|
7703
|
-
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
|
7704
|
-
**request_uuid** | **String**| Filter results by request UUID. | [optional]
|
|
7705
|
-
**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]
|
|
7706
|
-
**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]
|
|
8496
|
+
**collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in account](#operation/listAccountCollections) endpoint. |
|
|
8497
|
+
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
7707
8498
|
|
|
7708
8499
|
### Return type
|
|
7709
8500
|
|
|
7710
|
-
[**
|
|
8501
|
+
[**Import**](Import.md)
|
|
7711
8502
|
|
|
7712
8503
|
### Authorization
|
|
7713
8504
|
|
|
7714
|
-
[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)
|
|
7715
8506
|
|
|
7716
8507
|
### HTTP request headers
|
|
7717
8508
|
|
|
7718
|
-
- **Content-Type**:
|
|
8509
|
+
- **Content-Type**: multipart/form-data
|
|
7719
8510
|
- **Accept**: application/json
|
|
7720
8511
|
|
|
7721
8512
|
|
|
7722
|
-
##
|
|
8513
|
+
## import_allowed_list
|
|
7723
8514
|
|
|
7724
|
-
>
|
|
8515
|
+
> Import import_allowed_list(attribute_id, opts)
|
|
7725
8516
|
|
|
7726
|
-
|
|
8517
|
+
Import allowed values for attribute
|
|
7727
8518
|
|
|
7728
|
-
|
|
8519
|
+
Upload a CSV file containing a list of [picklist values](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#picklist-values) for the specified attribute. The file should be sent as multipart data. The import **replaces** the previous list of allowed values for this attribute, if any. The CSV file **must** only contain the following column: - `item` (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: ```text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07 ```
|
|
7729
8520
|
|
|
7730
8521
|
### Example
|
|
7731
8522
|
|
|
@@ -7734,6 +8525,11 @@ List all webhooks.
|
|
|
7734
8525
|
require 'talon_one'
|
|
7735
8526
|
# setup authorization
|
|
7736
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
|
+
|
|
7737
8533
|
# Configure API key authorization: management_key
|
|
7738
8534
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7739
8535
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7746,23 +8542,17 @@ TalonOne.configure do |config|
|
|
|
7746
8542
|
end
|
|
7747
8543
|
|
|
7748
8544
|
api_instance = TalonOne::ManagementApi.new
|
|
8545
|
+
attribute_id = 56 # Integer | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
|
7749
8546
|
opts = {
|
|
7750
|
-
|
|
7751
|
-
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.
|
|
7752
|
-
page_size: 1000, # Integer | The number of items in the response.
|
|
7753
|
-
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
|
7754
|
-
creation_type: 'creation_type_example', # String | Filter results by creation type.
|
|
7755
|
-
visibility: 'visibility_example', # String | Filter results by visibility.
|
|
7756
|
-
outgoing_integrations_type_id: 56, # Integer | Filter results by outgoing integration type ID.
|
|
7757
|
-
title: 'title_example' # String | Filter results performing case-insensitive matching against the webhook title.
|
|
8547
|
+
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
7758
8548
|
}
|
|
7759
8549
|
|
|
7760
8550
|
begin
|
|
7761
|
-
#
|
|
7762
|
-
result = api_instance.
|
|
8551
|
+
#Import allowed values for attribute
|
|
8552
|
+
result = api_instance.import_allowed_list(attribute_id, opts)
|
|
7763
8553
|
p result
|
|
7764
8554
|
rescue TalonOne::ApiError => e
|
|
7765
|
-
puts "Exception when calling ManagementApi->
|
|
8555
|
+
puts "Exception when calling ManagementApi->import_allowed_list: #{e}"
|
|
7766
8556
|
end
|
|
7767
8557
|
```
|
|
7768
8558
|
|
|
@@ -7771,36 +8561,30 @@ end
|
|
|
7771
8561
|
|
|
7772
8562
|
Name | Type | Description | Notes
|
|
7773
8563
|
------------- | ------------- | ------------- | -------------
|
|
7774
|
-
**
|
|
7775
|
-
**
|
|
7776
|
-
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
|
7777
|
-
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
|
7778
|
-
**creation_type** | **String**| Filter results by creation type. | [optional]
|
|
7779
|
-
**visibility** | **String**| Filter results by visibility. | [optional]
|
|
7780
|
-
**outgoing_integrations_type_id** | **Integer**| Filter results by outgoing integration type ID. | [optional]
|
|
7781
|
-
**title** | **String**| Filter results performing case-insensitive matching against the webhook title. | [optional]
|
|
8564
|
+
**attribute_id** | **Integer**| The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. |
|
|
8565
|
+
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
7782
8566
|
|
|
7783
8567
|
### Return type
|
|
7784
8568
|
|
|
7785
|
-
[**
|
|
8569
|
+
[**Import**](Import.md)
|
|
7786
8570
|
|
|
7787
8571
|
### Authorization
|
|
7788
8572
|
|
|
7789
|
-
[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)
|
|
7790
8574
|
|
|
7791
8575
|
### HTTP request headers
|
|
7792
8576
|
|
|
7793
|
-
- **Content-Type**:
|
|
8577
|
+
- **Content-Type**: multipart/form-data
|
|
7794
8578
|
- **Accept**: application/json
|
|
7795
8579
|
|
|
7796
8580
|
|
|
7797
|
-
##
|
|
8581
|
+
## import_audiences_memberships
|
|
7798
8582
|
|
|
7799
|
-
> Import
|
|
8583
|
+
> Import import_audiences_memberships(audience_id, opts)
|
|
7800
8584
|
|
|
7801
|
-
Import
|
|
8585
|
+
Import audience members
|
|
7802
8586
|
|
|
7803
|
-
Upload a CSV file containing the
|
|
8587
|
+
Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
|
|
7804
8588
|
|
|
7805
8589
|
### Example
|
|
7806
8590
|
|
|
@@ -7809,6 +8593,11 @@ Upload a CSV file containing the collection of string values that should be atta
|
|
|
7809
8593
|
require 'talon_one'
|
|
7810
8594
|
# setup authorization
|
|
7811
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
|
+
|
|
7812
8601
|
# Configure API key authorization: management_key
|
|
7813
8602
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7814
8603
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7821,17 +8610,17 @@ TalonOne.configure do |config|
|
|
|
7821
8610
|
end
|
|
7822
8611
|
|
|
7823
8612
|
api_instance = TalonOne::ManagementApi.new
|
|
7824
|
-
|
|
8613
|
+
audience_id = 56 # Integer | The ID of the audience.
|
|
7825
8614
|
opts = {
|
|
7826
8615
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
7827
8616
|
}
|
|
7828
8617
|
|
|
7829
8618
|
begin
|
|
7830
|
-
#Import
|
|
7831
|
-
result = api_instance.
|
|
8619
|
+
#Import audience members
|
|
8620
|
+
result = api_instance.import_audiences_memberships(audience_id, opts)
|
|
7832
8621
|
p result
|
|
7833
8622
|
rescue TalonOne::ApiError => e
|
|
7834
|
-
puts "Exception when calling ManagementApi->
|
|
8623
|
+
puts "Exception when calling ManagementApi->import_audiences_memberships: #{e}"
|
|
7835
8624
|
end
|
|
7836
8625
|
```
|
|
7837
8626
|
|
|
@@ -7840,7 +8629,7 @@ end
|
|
|
7840
8629
|
|
|
7841
8630
|
Name | Type | Description | Notes
|
|
7842
8631
|
------------- | ------------- | ------------- | -------------
|
|
7843
|
-
**
|
|
8632
|
+
**audience_id** | **Integer**| The ID of the audience. |
|
|
7844
8633
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
7845
8634
|
|
|
7846
8635
|
### Return type
|
|
@@ -7849,7 +8638,7 @@ Name | Type | Description | Notes
|
|
|
7849
8638
|
|
|
7850
8639
|
### Authorization
|
|
7851
8640
|
|
|
7852
|
-
[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)
|
|
7853
8642
|
|
|
7854
8643
|
### HTTP request headers
|
|
7855
8644
|
|
|
@@ -7857,13 +8646,13 @@ Name | Type | Description | Notes
|
|
|
7857
8646
|
- **Accept**: application/json
|
|
7858
8647
|
|
|
7859
8648
|
|
|
7860
|
-
##
|
|
8649
|
+
## import_campaign_store_budget
|
|
7861
8650
|
|
|
7862
|
-
> Import
|
|
8651
|
+
> Import import_campaign_store_budget(application_id, campaign_id, opts)
|
|
7863
8652
|
|
|
7864
|
-
Import
|
|
8653
|
+
Import campaign store budgets
|
|
7865
8654
|
|
|
7866
|
-
Upload a CSV file containing
|
|
8655
|
+
Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
|
7867
8656
|
|
|
7868
8657
|
### Example
|
|
7869
8658
|
|
|
@@ -7872,69 +8661,11 @@ Upload a CSV file containing a list of [picklist values](https://docs.talon.one/
|
|
|
7872
8661
|
require 'talon_one'
|
|
7873
8662
|
# setup authorization
|
|
7874
8663
|
TalonOne.configure do |config|
|
|
7875
|
-
# Configure API key authorization:
|
|
8664
|
+
# Configure API key authorization: api_key_v1
|
|
7876
8665
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7877
8666
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7878
8667
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7879
8668
|
|
|
7880
|
-
# Configure API key authorization: manager_auth
|
|
7881
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7882
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
7883
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
7884
|
-
end
|
|
7885
|
-
|
|
7886
|
-
api_instance = TalonOne::ManagementApi.new
|
|
7887
|
-
attribute_id = 56 # Integer | The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**.
|
|
7888
|
-
opts = {
|
|
7889
|
-
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
7890
|
-
}
|
|
7891
|
-
|
|
7892
|
-
begin
|
|
7893
|
-
#Import allowed values for attribute
|
|
7894
|
-
result = api_instance.import_allowed_list(attribute_id, opts)
|
|
7895
|
-
p result
|
|
7896
|
-
rescue TalonOne::ApiError => e
|
|
7897
|
-
puts "Exception when calling ManagementApi->import_allowed_list: #{e}"
|
|
7898
|
-
end
|
|
7899
|
-
```
|
|
7900
|
-
|
|
7901
|
-
### Parameters
|
|
7902
|
-
|
|
7903
|
-
|
|
7904
|
-
Name | Type | Description | Notes
|
|
7905
|
-
------------- | ------------- | ------------- | -------------
|
|
7906
|
-
**attribute_id** | **Integer**| The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in **Account** > **Tools** > **Attributes**. |
|
|
7907
|
-
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
7908
|
-
|
|
7909
|
-
### Return type
|
|
7910
|
-
|
|
7911
|
-
[**Import**](Import.md)
|
|
7912
|
-
|
|
7913
|
-
### Authorization
|
|
7914
|
-
|
|
7915
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
7916
|
-
|
|
7917
|
-
### HTTP request headers
|
|
7918
|
-
|
|
7919
|
-
- **Content-Type**: multipart/form-data
|
|
7920
|
-
- **Accept**: application/json
|
|
7921
|
-
|
|
7922
|
-
|
|
7923
|
-
## import_audiences_memberships
|
|
7924
|
-
|
|
7925
|
-
> Import import_audiences_memberships(audience_id, opts)
|
|
7926
|
-
|
|
7927
|
-
Import audience members
|
|
7928
|
-
|
|
7929
|
-
Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - `profileintegrationid`: The integration ID of the customer profile. The import **replaces** the previous list of audience members. **Note:** We recommend limiting your file size to 500MB. Example: ```text profileintegrationid charles alexa ```
|
|
7930
|
-
|
|
7931
|
-
### Example
|
|
7932
|
-
|
|
7933
|
-
```ruby
|
|
7934
|
-
# load the gem
|
|
7935
|
-
require 'talon_one'
|
|
7936
|
-
# setup authorization
|
|
7937
|
-
TalonOne.configure do |config|
|
|
7938
8669
|
# Configure API key authorization: management_key
|
|
7939
8670
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
7940
8671
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -7947,17 +8678,20 @@ TalonOne.configure do |config|
|
|
|
7947
8678
|
end
|
|
7948
8679
|
|
|
7949
8680
|
api_instance = TalonOne::ManagementApi.new
|
|
7950
|
-
|
|
8681
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
8682
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
7951
8683
|
opts = {
|
|
8684
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
|
8685
|
+
period: 'period_example', # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
7952
8686
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
7953
8687
|
}
|
|
7954
8688
|
|
|
7955
8689
|
begin
|
|
7956
|
-
#Import
|
|
7957
|
-
result = api_instance.
|
|
8690
|
+
#Import campaign store budgets
|
|
8691
|
+
result = api_instance.import_campaign_store_budget(application_id, campaign_id, opts)
|
|
7958
8692
|
p result
|
|
7959
8693
|
rescue TalonOne::ApiError => e
|
|
7960
|
-
puts "Exception when calling ManagementApi->
|
|
8694
|
+
puts "Exception when calling ManagementApi->import_campaign_store_budget: #{e}"
|
|
7961
8695
|
end
|
|
7962
8696
|
```
|
|
7963
8697
|
|
|
@@ -7966,7 +8700,10 @@ end
|
|
|
7966
8700
|
|
|
7967
8701
|
Name | Type | Description | Notes
|
|
7968
8702
|
------------- | ------------- | ------------- | -------------
|
|
7969
|
-
**
|
|
8703
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
8704
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
8705
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
|
8706
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
|
7970
8707
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
7971
8708
|
|
|
7972
8709
|
### Return type
|
|
@@ -7975,7 +8712,7 @@ Name | Type | Description | Notes
|
|
|
7975
8712
|
|
|
7976
8713
|
### Authorization
|
|
7977
8714
|
|
|
7978
|
-
[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)
|
|
7979
8716
|
|
|
7980
8717
|
### HTTP request headers
|
|
7981
8718
|
|
|
@@ -7998,6 +8735,11 @@ Upload a CSV file containing the stores you want to link to a specific campaign.
|
|
|
7998
8735
|
require 'talon_one'
|
|
7999
8736
|
# setup authorization
|
|
8000
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
|
+
|
|
8001
8743
|
# Configure API key authorization: management_key
|
|
8002
8744
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8003
8745
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8040,7 +8782,7 @@ Name | Type | Description | Notes
|
|
|
8040
8782
|
|
|
8041
8783
|
### Authorization
|
|
8042
8784
|
|
|
8043
|
-
[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)
|
|
8044
8786
|
|
|
8045
8787
|
### HTTP request headers
|
|
8046
8788
|
|
|
@@ -8063,6 +8805,11 @@ Upload a CSV file containing the collection of string values that should be atta
|
|
|
8063
8805
|
require 'talon_one'
|
|
8064
8806
|
# setup authorization
|
|
8065
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
|
+
|
|
8066
8813
|
# Configure API key authorization: management_key
|
|
8067
8814
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8068
8815
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8107,7 +8854,7 @@ Name | Type | Description | Notes
|
|
|
8107
8854
|
|
|
8108
8855
|
### Authorization
|
|
8109
8856
|
|
|
8110
|
-
[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)
|
|
8111
8858
|
|
|
8112
8859
|
### HTTP request headers
|
|
8113
8860
|
|
|
@@ -8130,6 +8877,11 @@ Upload a CSV file containing the coupons that should be created. The file should
|
|
|
8130
8877
|
require 'talon_one'
|
|
8131
8878
|
# setup authorization
|
|
8132
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
|
+
|
|
8133
8885
|
# Configure API key authorization: management_key
|
|
8134
8886
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8135
8887
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8174,7 +8926,7 @@ Name | Type | Description | Notes
|
|
|
8174
8926
|
|
|
8175
8927
|
### Authorization
|
|
8176
8928
|
|
|
8177
|
-
[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)
|
|
8178
8930
|
|
|
8179
8931
|
### HTTP request headers
|
|
8180
8932
|
|
|
@@ -8197,6 +8949,11 @@ Upload a CSV file containing the loyalty cards that you want to use in your card
|
|
|
8197
8949
|
require 'talon_one'
|
|
8198
8950
|
# setup authorization
|
|
8199
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
|
+
|
|
8200
8957
|
# Configure API key authorization: management_key
|
|
8201
8958
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8202
8959
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8237,7 +8994,7 @@ Name | Type | Description | Notes
|
|
|
8237
8994
|
|
|
8238
8995
|
### Authorization
|
|
8239
8996
|
|
|
8240
|
-
[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)
|
|
8241
8998
|
|
|
8242
8999
|
### HTTP request headers
|
|
8243
9000
|
|
|
@@ -8260,6 +9017,11 @@ Upload a CSV file containing existing customers to be assigned to existing tiers
|
|
|
8260
9017
|
require 'talon_one'
|
|
8261
9018
|
# setup authorization
|
|
8262
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
|
+
|
|
8263
9025
|
# Configure API key authorization: management_key
|
|
8264
9026
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8265
9027
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8300,7 +9062,7 @@ Name | Type | Description | Notes
|
|
|
8300
9062
|
|
|
8301
9063
|
### Authorization
|
|
8302
9064
|
|
|
8303
|
-
[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)
|
|
8304
9066
|
|
|
8305
9067
|
### HTTP request headers
|
|
8306
9068
|
|
|
@@ -8323,6 +9085,11 @@ Upload a CSV file containing the loyalty points you want to import into a given
|
|
|
8323
9085
|
require 'talon_one'
|
|
8324
9086
|
# setup authorization
|
|
8325
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
|
+
|
|
8326
9093
|
# Configure API key authorization: management_key
|
|
8327
9094
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8328
9095
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8337,6 +9104,7 @@ end
|
|
|
8337
9104
|
api_instance = TalonOne::ManagementApi.new
|
|
8338
9105
|
loyalty_program_id = 56 # 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.
|
|
8339
9106
|
opts = {
|
|
9107
|
+
notifications_enabled: true, # Boolean | Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
|
8340
9108
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
|
8341
9109
|
}
|
|
8342
9110
|
|
|
@@ -8355,6 +9123,7 @@ end
|
|
|
8355
9123
|
Name | Type | Description | Notes
|
|
8356
9124
|
------------- | ------------- | ------------- | -------------
|
|
8357
9125
|
**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. |
|
|
9126
|
+
**notifications_enabled** | **Boolean**| Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`. | [optional]
|
|
8358
9127
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
|
8359
9128
|
|
|
8360
9129
|
### Return type
|
|
@@ -8363,7 +9132,7 @@ Name | Type | Description | Notes
|
|
|
8363
9132
|
|
|
8364
9133
|
### Authorization
|
|
8365
9134
|
|
|
8366
|
-
[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)
|
|
8367
9136
|
|
|
8368
9137
|
### HTTP request headers
|
|
8369
9138
|
|
|
@@ -8386,6 +9155,11 @@ Upload a CSV file containing the giveaway codes that should be created. Send the
|
|
|
8386
9155
|
require 'talon_one'
|
|
8387
9156
|
# setup authorization
|
|
8388
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
|
+
|
|
8389
9163
|
# Configure API key authorization: management_key
|
|
8390
9164
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8391
9165
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8426,7 +9200,7 @@ Name | Type | Description | Notes
|
|
|
8426
9200
|
|
|
8427
9201
|
### Authorization
|
|
8428
9202
|
|
|
8429
|
-
[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)
|
|
8430
9204
|
|
|
8431
9205
|
### HTTP request headers
|
|
8432
9206
|
|
|
@@ -8449,6 +9223,11 @@ Upload a CSV file containing the referrals that should be created. The file shou
|
|
|
8449
9223
|
require 'talon_one'
|
|
8450
9224
|
# setup authorization
|
|
8451
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
|
+
|
|
8452
9231
|
# Configure API key authorization: management_key
|
|
8453
9232
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8454
9233
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8491,7 +9270,7 @@ Name | Type | Description | Notes
|
|
|
8491
9270
|
|
|
8492
9271
|
### Authorization
|
|
8493
9272
|
|
|
8494
|
-
[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)
|
|
8495
9274
|
|
|
8496
9275
|
### HTTP request headers
|
|
8497
9276
|
|
|
@@ -8514,6 +9293,11 @@ Invite user from identity provider
|
|
|
8514
9293
|
require 'talon_one'
|
|
8515
9294
|
# setup authorization
|
|
8516
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
|
+
|
|
8517
9301
|
# Configure API key authorization: management_key
|
|
8518
9302
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8519
9303
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8549,7 +9333,7 @@ nil (empty response body)
|
|
|
8549
9333
|
|
|
8550
9334
|
### Authorization
|
|
8551
9335
|
|
|
8552
|
-
[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)
|
|
8553
9337
|
|
|
8554
9338
|
### HTTP request headers
|
|
8555
9339
|
|
|
@@ -8572,6 +9356,11 @@ List account-level collections in the account.
|
|
|
8572
9356
|
require 'talon_one'
|
|
8573
9357
|
# setup authorization
|
|
8574
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
|
+
|
|
8575
9364
|
# Configure API key authorization: management_key
|
|
8576
9365
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8577
9366
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8618,7 +9407,7 @@ Name | Type | Description | Notes
|
|
|
8618
9407
|
|
|
8619
9408
|
### Authorization
|
|
8620
9409
|
|
|
8621
|
-
[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)
|
|
8622
9411
|
|
|
8623
9412
|
### HTTP request headers
|
|
8624
9413
|
|
|
@@ -8641,6 +9430,11 @@ List all the achievements for a specific campaign.
|
|
|
8641
9430
|
require 'talon_one'
|
|
8642
9431
|
# setup authorization
|
|
8643
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
|
+
|
|
8644
9438
|
# Configure API key authorization: management_key
|
|
8645
9439
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8646
9440
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8687,7 +9481,7 @@ Name | Type | Description | Notes
|
|
|
8687
9481
|
|
|
8688
9482
|
### Authorization
|
|
8689
9483
|
|
|
8690
|
-
[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)
|
|
8691
9485
|
|
|
8692
9486
|
### HTTP request headers
|
|
8693
9487
|
|
|
@@ -8697,7 +9491,7 @@ Name | Type | Description | Notes
|
|
|
8697
9491
|
|
|
8698
9492
|
## list_all_roles_v2
|
|
8699
9493
|
|
|
8700
|
-
>
|
|
9494
|
+
> InlineResponse20044 list_all_roles_v2
|
|
8701
9495
|
|
|
8702
9496
|
List roles
|
|
8703
9497
|
|
|
@@ -8710,6 +9504,11 @@ List all roles.
|
|
|
8710
9504
|
require 'talon_one'
|
|
8711
9505
|
# setup authorization
|
|
8712
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
|
+
|
|
8713
9512
|
# Configure API key authorization: management_key
|
|
8714
9513
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8715
9514
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8738,11 +9537,83 @@ This endpoint does not need any parameter.
|
|
|
8738
9537
|
|
|
8739
9538
|
### Return type
|
|
8740
9539
|
|
|
9540
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
|
9541
|
+
|
|
9542
|
+
### Authorization
|
|
9543
|
+
|
|
9544
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9545
|
+
|
|
9546
|
+
### HTTP request headers
|
|
9547
|
+
|
|
9548
|
+
- **Content-Type**: Not defined
|
|
9549
|
+
- **Accept**: application/json
|
|
9550
|
+
|
|
9551
|
+
|
|
9552
|
+
## list_campaign_store_budget_limits
|
|
9553
|
+
|
|
9554
|
+
> InlineResponse20046 list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
|
9555
|
+
|
|
9556
|
+
List campaign store budget limits
|
|
9557
|
+
|
|
9558
|
+
Return the store budget limits for a given campaign.
|
|
9559
|
+
|
|
9560
|
+
### Example
|
|
9561
|
+
|
|
9562
|
+
```ruby
|
|
9563
|
+
# load the gem
|
|
9564
|
+
require 'talon_one'
|
|
9565
|
+
# setup authorization
|
|
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
|
+
|
|
9572
|
+
# Configure API key authorization: management_key
|
|
9573
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9574
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9575
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9576
|
+
|
|
9577
|
+
# Configure API key authorization: manager_auth
|
|
9578
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9579
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
9580
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
9581
|
+
end
|
|
9582
|
+
|
|
9583
|
+
api_instance = TalonOne::ManagementApi.new
|
|
9584
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
9585
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
9586
|
+
opts = {
|
|
9587
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
|
9588
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
|
9589
|
+
}
|
|
9590
|
+
|
|
9591
|
+
begin
|
|
9592
|
+
#List campaign store budget limits
|
|
9593
|
+
result = api_instance.list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
|
9594
|
+
p result
|
|
9595
|
+
rescue TalonOne::ApiError => e
|
|
9596
|
+
puts "Exception when calling ManagementApi->list_campaign_store_budget_limits: #{e}"
|
|
9597
|
+
end
|
|
9598
|
+
```
|
|
9599
|
+
|
|
9600
|
+
### Parameters
|
|
9601
|
+
|
|
9602
|
+
|
|
9603
|
+
Name | Type | Description | Notes
|
|
9604
|
+
------------- | ------------- | ------------- | -------------
|
|
9605
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
9606
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
9607
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
|
9608
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
|
9609
|
+
|
|
9610
|
+
### Return type
|
|
9611
|
+
|
|
8741
9612
|
[**InlineResponse20046**](InlineResponse20046.md)
|
|
8742
9613
|
|
|
8743
9614
|
### Authorization
|
|
8744
9615
|
|
|
8745
|
-
[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)
|
|
8746
9617
|
|
|
8747
9618
|
### HTTP request headers
|
|
8748
9619
|
|
|
@@ -8765,6 +9636,11 @@ Return a paginated list of cart items in the given catalog.
|
|
|
8765
9636
|
require 'talon_one'
|
|
8766
9637
|
# setup authorization
|
|
8767
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
|
+
|
|
8768
9644
|
# Configure API key authorization: management_key
|
|
8769
9645
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8770
9646
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8813,7 +9689,7 @@ Name | Type | Description | Notes
|
|
|
8813
9689
|
|
|
8814
9690
|
### Authorization
|
|
8815
9691
|
|
|
8816
|
-
[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)
|
|
8817
9693
|
|
|
8818
9694
|
### HTTP request headers
|
|
8819
9695
|
|
|
@@ -8836,6 +9712,11 @@ List collections in a given campaign.
|
|
|
8836
9712
|
require 'talon_one'
|
|
8837
9713
|
# setup authorization
|
|
8838
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
|
+
|
|
8839
9720
|
# Configure API key authorization: management_key
|
|
8840
9721
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8841
9722
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8886,7 +9767,7 @@ Name | Type | Description | Notes
|
|
|
8886
9767
|
|
|
8887
9768
|
### Authorization
|
|
8888
9769
|
|
|
8889
|
-
[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)
|
|
8890
9771
|
|
|
8891
9772
|
### HTTP request headers
|
|
8892
9773
|
|
|
@@ -8909,6 +9790,11 @@ List campaign-level collections from all campaigns in a given Application.
|
|
|
8909
9790
|
require 'talon_one'
|
|
8910
9791
|
# setup authorization
|
|
8911
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
|
+
|
|
8912
9798
|
# Configure API key authorization: management_key
|
|
8913
9799
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8914
9800
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -8957,7 +9843,7 @@ Name | Type | Description | Notes
|
|
|
8957
9843
|
|
|
8958
9844
|
### Authorization
|
|
8959
9845
|
|
|
8960
|
-
[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)
|
|
8961
9847
|
|
|
8962
9848
|
### HTTP request headers
|
|
8963
9849
|
|
|
@@ -8967,7 +9853,7 @@ Name | Type | Description | Notes
|
|
|
8967
9853
|
|
|
8968
9854
|
## list_stores
|
|
8969
9855
|
|
|
8970
|
-
>
|
|
9856
|
+
> InlineResponse20045 list_stores(application_id, opts)
|
|
8971
9857
|
|
|
8972
9858
|
List stores
|
|
8973
9859
|
|
|
@@ -8980,6 +9866,11 @@ List all stores for a specific Application.
|
|
|
8980
9866
|
require 'talon_one'
|
|
8981
9867
|
# setup authorization
|
|
8982
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
|
+
|
|
8983
9874
|
# Configure API key authorization: management_key
|
|
8984
9875
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
8985
9876
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9030,11 +9921,11 @@ Name | Type | Description | Notes
|
|
|
9030
9921
|
|
|
9031
9922
|
### Return type
|
|
9032
9923
|
|
|
9033
|
-
[**
|
|
9924
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
|
9034
9925
|
|
|
9035
9926
|
### Authorization
|
|
9036
9927
|
|
|
9037
|
-
[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)
|
|
9038
9929
|
|
|
9039
9930
|
### HTTP request headers
|
|
9040
9931
|
|
|
@@ -9057,6 +9948,11 @@ Validate the ownership of the API through a challenge-response mechanism. This
|
|
|
9057
9948
|
require 'talon_one'
|
|
9058
9949
|
# setup authorization
|
|
9059
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
|
+
|
|
9060
9956
|
# Configure API key authorization: management_key
|
|
9061
9957
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9062
9958
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9088,7 +9984,7 @@ nil (empty response body)
|
|
|
9088
9984
|
|
|
9089
9985
|
### Authorization
|
|
9090
9986
|
|
|
9091
|
-
[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)
|
|
9092
9988
|
|
|
9093
9989
|
### HTTP request headers
|
|
9094
9990
|
|
|
@@ -9111,6 +10007,11 @@ Deduct points from the specified loyalty program and specified customer profile.
|
|
|
9111
10007
|
require 'talon_one'
|
|
9112
10008
|
# setup authorization
|
|
9113
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
|
+
|
|
9114
10015
|
# Configure API key authorization: management_key
|
|
9115
10016
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9116
10017
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9150,7 +10051,7 @@ nil (empty response body)
|
|
|
9150
10051
|
|
|
9151
10052
|
### Authorization
|
|
9152
10053
|
|
|
9153
|
-
[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)
|
|
9154
10055
|
|
|
9155
10056
|
### HTTP request headers
|
|
9156
10057
|
|
|
@@ -9173,6 +10074,11 @@ Consumes the supplied password reset token and updates the password for the asso
|
|
|
9173
10074
|
require 'talon_one'
|
|
9174
10075
|
# setup authorization
|
|
9175
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
|
+
|
|
9176
10082
|
# Configure API key authorization: management_key
|
|
9177
10083
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9178
10084
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9209,7 +10115,71 @@ Name | Type | Description | Notes
|
|
|
9209
10115
|
|
|
9210
10116
|
### Authorization
|
|
9211
10117
|
|
|
9212
|
-
[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)
|
|
10119
|
+
|
|
10120
|
+
### HTTP request headers
|
|
10121
|
+
|
|
10122
|
+
- **Content-Type**: application/json
|
|
10123
|
+
- **Accept**: application/json
|
|
10124
|
+
|
|
10125
|
+
|
|
10126
|
+
## scim_create_group
|
|
10127
|
+
|
|
10128
|
+
> ScimGroup scim_create_group(body)
|
|
10129
|
+
|
|
10130
|
+
Create SCIM group
|
|
10131
|
+
|
|
10132
|
+
Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10133
|
+
|
|
10134
|
+
### Example
|
|
10135
|
+
|
|
10136
|
+
```ruby
|
|
10137
|
+
# load the gem
|
|
10138
|
+
require 'talon_one'
|
|
10139
|
+
# setup authorization
|
|
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
|
+
|
|
10146
|
+
# Configure API key authorization: management_key
|
|
10147
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10148
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10149
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10150
|
+
|
|
10151
|
+
# Configure API key authorization: manager_auth
|
|
10152
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10154
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10155
|
+
end
|
|
10156
|
+
|
|
10157
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10158
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
|
10159
|
+
|
|
10160
|
+
begin
|
|
10161
|
+
#Create SCIM group
|
|
10162
|
+
result = api_instance.scim_create_group(body)
|
|
10163
|
+
p result
|
|
10164
|
+
rescue TalonOne::ApiError => e
|
|
10165
|
+
puts "Exception when calling ManagementApi->scim_create_group: #{e}"
|
|
10166
|
+
end
|
|
10167
|
+
```
|
|
10168
|
+
|
|
10169
|
+
### Parameters
|
|
10170
|
+
|
|
10171
|
+
|
|
10172
|
+
Name | Type | Description | Notes
|
|
10173
|
+
------------- | ------------- | ------------- | -------------
|
|
10174
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
|
10175
|
+
|
|
10176
|
+
### Return type
|
|
10177
|
+
|
|
10178
|
+
[**ScimGroup**](ScimGroup.md)
|
|
10179
|
+
|
|
10180
|
+
### Authorization
|
|
10181
|
+
|
|
10182
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9213
10183
|
|
|
9214
10184
|
### HTTP request headers
|
|
9215
10185
|
|
|
@@ -9232,6 +10202,11 @@ Create a new Talon.One user using the SCIM provisioning protocol with an identit
|
|
|
9232
10202
|
require 'talon_one'
|
|
9233
10203
|
# setup authorization
|
|
9234
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
|
+
|
|
9235
10210
|
# Configure API key authorization: management_key
|
|
9236
10211
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9237
10212
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9268,7 +10243,7 @@ Name | Type | Description | Notes
|
|
|
9268
10243
|
|
|
9269
10244
|
### Authorization
|
|
9270
10245
|
|
|
9271
|
-
[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)
|
|
9272
10247
|
|
|
9273
10248
|
### HTTP request headers
|
|
9274
10249
|
|
|
@@ -9276,6 +10251,69 @@ Name | Type | Description | Notes
|
|
|
9276
10251
|
- **Accept**: application/json
|
|
9277
10252
|
|
|
9278
10253
|
|
|
10254
|
+
## scim_delete_group
|
|
10255
|
+
|
|
10256
|
+
> scim_delete_group(group_id)
|
|
10257
|
+
|
|
10258
|
+
Delete SCIM group
|
|
10259
|
+
|
|
10260
|
+
Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10261
|
+
|
|
10262
|
+
### Example
|
|
10263
|
+
|
|
10264
|
+
```ruby
|
|
10265
|
+
# load the gem
|
|
10266
|
+
require 'talon_one'
|
|
10267
|
+
# setup authorization
|
|
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
|
+
|
|
10274
|
+
# Configure API key authorization: management_key
|
|
10275
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10276
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10277
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10278
|
+
|
|
10279
|
+
# Configure API key authorization: manager_auth
|
|
10280
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10281
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10282
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10283
|
+
end
|
|
10284
|
+
|
|
10285
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10286
|
+
group_id = 56 # Integer | The ID of the group.
|
|
10287
|
+
|
|
10288
|
+
begin
|
|
10289
|
+
#Delete SCIM group
|
|
10290
|
+
api_instance.scim_delete_group(group_id)
|
|
10291
|
+
rescue TalonOne::ApiError => e
|
|
10292
|
+
puts "Exception when calling ManagementApi->scim_delete_group: #{e}"
|
|
10293
|
+
end
|
|
10294
|
+
```
|
|
10295
|
+
|
|
10296
|
+
### Parameters
|
|
10297
|
+
|
|
10298
|
+
|
|
10299
|
+
Name | Type | Description | Notes
|
|
10300
|
+
------------- | ------------- | ------------- | -------------
|
|
10301
|
+
**group_id** | **Integer**| The ID of the group. |
|
|
10302
|
+
|
|
10303
|
+
### Return type
|
|
10304
|
+
|
|
10305
|
+
nil (empty response body)
|
|
10306
|
+
|
|
10307
|
+
### Authorization
|
|
10308
|
+
|
|
10309
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10310
|
+
|
|
10311
|
+
### HTTP request headers
|
|
10312
|
+
|
|
10313
|
+
- **Content-Type**: Not defined
|
|
10314
|
+
- **Accept**: Not defined
|
|
10315
|
+
|
|
10316
|
+
|
|
9279
10317
|
## scim_delete_user
|
|
9280
10318
|
|
|
9281
10319
|
> scim_delete_user(user_id)
|
|
@@ -9291,6 +10329,11 @@ Delete a specific Talon.One user created using the SCIM provisioning protocol wi
|
|
|
9291
10329
|
require 'talon_one'
|
|
9292
10330
|
# setup authorization
|
|
9293
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
|
+
|
|
9294
10337
|
# Configure API key authorization: management_key
|
|
9295
10338
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9296
10339
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9326,7 +10369,7 @@ nil (empty response body)
|
|
|
9326
10369
|
|
|
9327
10370
|
### Authorization
|
|
9328
10371
|
|
|
9329
|
-
[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)
|
|
9330
10373
|
|
|
9331
10374
|
### HTTP request headers
|
|
9332
10375
|
|
|
@@ -9334,6 +10377,130 @@ nil (empty response body)
|
|
|
9334
10377
|
- **Accept**: Not defined
|
|
9335
10378
|
|
|
9336
10379
|
|
|
10380
|
+
## scim_get_group
|
|
10381
|
+
|
|
10382
|
+
> ScimGroup scim_get_group(group_id)
|
|
10383
|
+
|
|
10384
|
+
Get SCIM group
|
|
10385
|
+
|
|
10386
|
+
Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10387
|
+
|
|
10388
|
+
### Example
|
|
10389
|
+
|
|
10390
|
+
```ruby
|
|
10391
|
+
# load the gem
|
|
10392
|
+
require 'talon_one'
|
|
10393
|
+
# setup authorization
|
|
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
|
+
|
|
10400
|
+
# Configure API key authorization: management_key
|
|
10401
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10402
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10403
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10404
|
+
|
|
10405
|
+
# Configure API key authorization: manager_auth
|
|
10406
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10407
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10408
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10409
|
+
end
|
|
10410
|
+
|
|
10411
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10412
|
+
group_id = 56 # Integer | The ID of the group.
|
|
10413
|
+
|
|
10414
|
+
begin
|
|
10415
|
+
#Get SCIM group
|
|
10416
|
+
result = api_instance.scim_get_group(group_id)
|
|
10417
|
+
p result
|
|
10418
|
+
rescue TalonOne::ApiError => e
|
|
10419
|
+
puts "Exception when calling ManagementApi->scim_get_group: #{e}"
|
|
10420
|
+
end
|
|
10421
|
+
```
|
|
10422
|
+
|
|
10423
|
+
### Parameters
|
|
10424
|
+
|
|
10425
|
+
|
|
10426
|
+
Name | Type | Description | Notes
|
|
10427
|
+
------------- | ------------- | ------------- | -------------
|
|
10428
|
+
**group_id** | **Integer**| The ID of the group. |
|
|
10429
|
+
|
|
10430
|
+
### Return type
|
|
10431
|
+
|
|
10432
|
+
[**ScimGroup**](ScimGroup.md)
|
|
10433
|
+
|
|
10434
|
+
### Authorization
|
|
10435
|
+
|
|
10436
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10437
|
+
|
|
10438
|
+
### HTTP request headers
|
|
10439
|
+
|
|
10440
|
+
- **Content-Type**: Not defined
|
|
10441
|
+
- **Accept**: application/json
|
|
10442
|
+
|
|
10443
|
+
|
|
10444
|
+
## scim_get_groups
|
|
10445
|
+
|
|
10446
|
+
> ScimGroupsListResponse scim_get_groups
|
|
10447
|
+
|
|
10448
|
+
List SCIM groups
|
|
10449
|
+
|
|
10450
|
+
Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10451
|
+
|
|
10452
|
+
### Example
|
|
10453
|
+
|
|
10454
|
+
```ruby
|
|
10455
|
+
# load the gem
|
|
10456
|
+
require 'talon_one'
|
|
10457
|
+
# setup authorization
|
|
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
|
+
|
|
10464
|
+
# Configure API key authorization: management_key
|
|
10465
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10466
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10467
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10468
|
+
|
|
10469
|
+
# Configure API key authorization: manager_auth
|
|
10470
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10471
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10472
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10473
|
+
end
|
|
10474
|
+
|
|
10475
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10476
|
+
|
|
10477
|
+
begin
|
|
10478
|
+
#List SCIM groups
|
|
10479
|
+
result = api_instance.scim_get_groups
|
|
10480
|
+
p result
|
|
10481
|
+
rescue TalonOne::ApiError => e
|
|
10482
|
+
puts "Exception when calling ManagementApi->scim_get_groups: #{e}"
|
|
10483
|
+
end
|
|
10484
|
+
```
|
|
10485
|
+
|
|
10486
|
+
### Parameters
|
|
10487
|
+
|
|
10488
|
+
This endpoint does not need any parameter.
|
|
10489
|
+
|
|
10490
|
+
### Return type
|
|
10491
|
+
|
|
10492
|
+
[**ScimGroupsListResponse**](ScimGroupsListResponse.md)
|
|
10493
|
+
|
|
10494
|
+
### Authorization
|
|
10495
|
+
|
|
10496
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10497
|
+
|
|
10498
|
+
### HTTP request headers
|
|
10499
|
+
|
|
10500
|
+
- **Content-Type**: Not defined
|
|
10501
|
+
- **Accept**: application/json
|
|
10502
|
+
|
|
10503
|
+
|
|
9337
10504
|
## scim_get_resource_types
|
|
9338
10505
|
|
|
9339
10506
|
> ScimResourceTypesListResponse scim_get_resource_types
|
|
@@ -9349,6 +10516,11 @@ Retrieve a list of resource types supported by the SCIM provisioning protocol.
|
|
|
9349
10516
|
require 'talon_one'
|
|
9350
10517
|
# setup authorization
|
|
9351
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
|
+
|
|
9352
10524
|
# Configure API key authorization: management_key
|
|
9353
10525
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9354
10526
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9381,7 +10553,7 @@ This endpoint does not need any parameter.
|
|
|
9381
10553
|
|
|
9382
10554
|
### Authorization
|
|
9383
10555
|
|
|
9384
|
-
[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)
|
|
9385
10557
|
|
|
9386
10558
|
### HTTP request headers
|
|
9387
10559
|
|
|
@@ -9404,6 +10576,11 @@ Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas
|
|
|
9404
10576
|
require 'talon_one'
|
|
9405
10577
|
# setup authorization
|
|
9406
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
|
+
|
|
9407
10584
|
# Configure API key authorization: management_key
|
|
9408
10585
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9409
10586
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9436,7 +10613,7 @@ This endpoint does not need any parameter.
|
|
|
9436
10613
|
|
|
9437
10614
|
### Authorization
|
|
9438
10615
|
|
|
9439
|
-
[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)
|
|
9440
10617
|
|
|
9441
10618
|
### HTTP request headers
|
|
9442
10619
|
|
|
@@ -9459,6 +10636,11 @@ Retrieve the configuration settings of the SCIM service provider. It provides de
|
|
|
9459
10636
|
require 'talon_one'
|
|
9460
10637
|
# setup authorization
|
|
9461
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
|
+
|
|
9462
10644
|
# Configure API key authorization: management_key
|
|
9463
10645
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9464
10646
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9491,7 +10673,7 @@ This endpoint does not need any parameter.
|
|
|
9491
10673
|
|
|
9492
10674
|
### Authorization
|
|
9493
10675
|
|
|
9494
|
-
[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)
|
|
9495
10677
|
|
|
9496
10678
|
### HTTP request headers
|
|
9497
10679
|
|
|
@@ -9514,6 +10696,11 @@ Retrieve data for a specific Talon.One user created using the SCIM provisioning
|
|
|
9514
10696
|
require 'talon_one'
|
|
9515
10697
|
# setup authorization
|
|
9516
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
|
+
|
|
9517
10704
|
# Configure API key authorization: management_key
|
|
9518
10705
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9519
10706
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9550,7 +10737,7 @@ Name | Type | Description | Notes
|
|
|
9550
10737
|
|
|
9551
10738
|
### Authorization
|
|
9552
10739
|
|
|
9553
|
-
[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)
|
|
9554
10741
|
|
|
9555
10742
|
### HTTP request headers
|
|
9556
10743
|
|
|
@@ -9573,6 +10760,11 @@ Retrieve a paginated list of users that have been provisioned using the SCIM pro
|
|
|
9573
10760
|
require 'talon_one'
|
|
9574
10761
|
# setup authorization
|
|
9575
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
|
+
|
|
9576
10768
|
# Configure API key authorization: management_key
|
|
9577
10769
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9578
10770
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9605,7 +10797,7 @@ This endpoint does not need any parameter.
|
|
|
9605
10797
|
|
|
9606
10798
|
### Authorization
|
|
9607
10799
|
|
|
9608
|
-
[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)
|
|
9609
10801
|
|
|
9610
10802
|
### HTTP request headers
|
|
9611
10803
|
|
|
@@ -9613,6 +10805,72 @@ This endpoint does not need any parameter.
|
|
|
9613
10805
|
- **Accept**: application/json
|
|
9614
10806
|
|
|
9615
10807
|
|
|
10808
|
+
## scim_patch_group
|
|
10809
|
+
|
|
10810
|
+
> ScimGroup scim_patch_group(group_id, body)
|
|
10811
|
+
|
|
10812
|
+
Update SCIM group attributes
|
|
10813
|
+
|
|
10814
|
+
Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10815
|
+
|
|
10816
|
+
### Example
|
|
10817
|
+
|
|
10818
|
+
```ruby
|
|
10819
|
+
# load the gem
|
|
10820
|
+
require 'talon_one'
|
|
10821
|
+
# setup authorization
|
|
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
|
+
|
|
10828
|
+
# Configure API key authorization: management_key
|
|
10829
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10830
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10831
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10832
|
+
|
|
10833
|
+
# Configure API key authorization: manager_auth
|
|
10834
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10835
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10836
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10837
|
+
end
|
|
10838
|
+
|
|
10839
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10840
|
+
group_id = 56 # Integer | The ID of the group.
|
|
10841
|
+
body = TalonOne::ScimPatchRequest.new # ScimPatchRequest | body
|
|
10842
|
+
|
|
10843
|
+
begin
|
|
10844
|
+
#Update SCIM group attributes
|
|
10845
|
+
result = api_instance.scim_patch_group(group_id, body)
|
|
10846
|
+
p result
|
|
10847
|
+
rescue TalonOne::ApiError => e
|
|
10848
|
+
puts "Exception when calling ManagementApi->scim_patch_group: #{e}"
|
|
10849
|
+
end
|
|
10850
|
+
```
|
|
10851
|
+
|
|
10852
|
+
### Parameters
|
|
10853
|
+
|
|
10854
|
+
|
|
10855
|
+
Name | Type | Description | Notes
|
|
10856
|
+
------------- | ------------- | ------------- | -------------
|
|
10857
|
+
**group_id** | **Integer**| The ID of the group. |
|
|
10858
|
+
**body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body |
|
|
10859
|
+
|
|
10860
|
+
### Return type
|
|
10861
|
+
|
|
10862
|
+
[**ScimGroup**](ScimGroup.md)
|
|
10863
|
+
|
|
10864
|
+
### Authorization
|
|
10865
|
+
|
|
10866
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
10867
|
+
|
|
10868
|
+
### HTTP request headers
|
|
10869
|
+
|
|
10870
|
+
- **Content-Type**: application/json
|
|
10871
|
+
- **Accept**: application/json
|
|
10872
|
+
|
|
10873
|
+
|
|
9616
10874
|
## scim_patch_user
|
|
9617
10875
|
|
|
9618
10876
|
> ScimUser scim_patch_user(user_id, body)
|
|
@@ -9628,6 +10886,11 @@ Update certain attributes of a specific Talon.One user created using the SCIM pr
|
|
|
9628
10886
|
require 'talon_one'
|
|
9629
10887
|
# setup authorization
|
|
9630
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
|
+
|
|
9631
10894
|
# Configure API key authorization: management_key
|
|
9632
10895
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9633
10896
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9666,7 +10929,73 @@ Name | Type | Description | Notes
|
|
|
9666
10929
|
|
|
9667
10930
|
### Authorization
|
|
9668
10931
|
|
|
9669
|
-
[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)
|
|
10933
|
+
|
|
10934
|
+
### HTTP request headers
|
|
10935
|
+
|
|
10936
|
+
- **Content-Type**: application/json
|
|
10937
|
+
- **Accept**: application/json
|
|
10938
|
+
|
|
10939
|
+
|
|
10940
|
+
## scim_replace_group_attributes
|
|
10941
|
+
|
|
10942
|
+
> ScimGroup scim_replace_group_attributes(group_id, body)
|
|
10943
|
+
|
|
10944
|
+
Update SCIM group
|
|
10945
|
+
|
|
10946
|
+
Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
|
10947
|
+
|
|
10948
|
+
### Example
|
|
10949
|
+
|
|
10950
|
+
```ruby
|
|
10951
|
+
# load the gem
|
|
10952
|
+
require 'talon_one'
|
|
10953
|
+
# setup authorization
|
|
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
|
+
|
|
10960
|
+
# Configure API key authorization: management_key
|
|
10961
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10962
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10963
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10964
|
+
|
|
10965
|
+
# Configure API key authorization: manager_auth
|
|
10966
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10967
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
10968
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
10969
|
+
end
|
|
10970
|
+
|
|
10971
|
+
api_instance = TalonOne::ManagementApi.new
|
|
10972
|
+
group_id = 56 # Integer | The ID of the group.
|
|
10973
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
|
10974
|
+
|
|
10975
|
+
begin
|
|
10976
|
+
#Update SCIM group
|
|
10977
|
+
result = api_instance.scim_replace_group_attributes(group_id, body)
|
|
10978
|
+
p result
|
|
10979
|
+
rescue TalonOne::ApiError => e
|
|
10980
|
+
puts "Exception when calling ManagementApi->scim_replace_group_attributes: #{e}"
|
|
10981
|
+
end
|
|
10982
|
+
```
|
|
10983
|
+
|
|
10984
|
+
### Parameters
|
|
10985
|
+
|
|
10986
|
+
|
|
10987
|
+
Name | Type | Description | Notes
|
|
10988
|
+
------------- | ------------- | ------------- | -------------
|
|
10989
|
+
**group_id** | **Integer**| The ID of the group. |
|
|
10990
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
|
10991
|
+
|
|
10992
|
+
### Return type
|
|
10993
|
+
|
|
10994
|
+
[**ScimGroup**](ScimGroup.md)
|
|
10995
|
+
|
|
10996
|
+
### Authorization
|
|
10997
|
+
|
|
10998
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
9670
10999
|
|
|
9671
11000
|
### HTTP request headers
|
|
9672
11001
|
|
|
@@ -9689,6 +11018,11 @@ Update the details of a specific Talon.One user created using the SCIM provision
|
|
|
9689
11018
|
require 'talon_one'
|
|
9690
11019
|
# setup authorization
|
|
9691
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
|
+
|
|
9692
11026
|
# Configure API key authorization: management_key
|
|
9693
11027
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9694
11028
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9727,7 +11061,7 @@ Name | Type | Description | Notes
|
|
|
9727
11061
|
|
|
9728
11062
|
### Authorization
|
|
9729
11063
|
|
|
9730
|
-
[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)
|
|
9731
11065
|
|
|
9732
11066
|
### HTTP request headers
|
|
9733
11067
|
|
|
@@ -9750,6 +11084,11 @@ List the coupons whose attributes match the query criteria in all the campaigns
|
|
|
9750
11084
|
require 'talon_one'
|
|
9751
11085
|
# setup authorization
|
|
9752
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
|
+
|
|
9753
11092
|
# Configure API key authorization: management_key
|
|
9754
11093
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9755
11094
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9816,7 +11155,7 @@ Name | Type | Description | Notes
|
|
|
9816
11155
|
|
|
9817
11156
|
### Authorization
|
|
9818
11157
|
|
|
9819
|
-
[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)
|
|
9820
11159
|
|
|
9821
11160
|
### HTTP request headers
|
|
9822
11161
|
|
|
@@ -9839,6 +11178,11 @@ List the coupons whose attributes match the query criteria in the given campaign
|
|
|
9839
11178
|
require 'talon_one'
|
|
9840
11179
|
# setup authorization
|
|
9841
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
|
+
|
|
9842
11186
|
# Configure API key authorization: management_key
|
|
9843
11187
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9844
11188
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9905,7 +11249,7 @@ Name | Type | Description | Notes
|
|
|
9905
11249
|
|
|
9906
11250
|
### Authorization
|
|
9907
11251
|
|
|
9908
|
-
[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)
|
|
9909
11253
|
|
|
9910
11254
|
### HTTP request headers
|
|
9911
11255
|
|
|
@@ -9913,6 +11257,72 @@ Name | Type | Description | Notes
|
|
|
9913
11257
|
- **Accept**: application/json
|
|
9914
11258
|
|
|
9915
11259
|
|
|
11260
|
+
## summarize_campaign_store_budget
|
|
11261
|
+
|
|
11262
|
+
> InlineResponse20047 summarize_campaign_store_budget(application_id, campaign_id)
|
|
11263
|
+
|
|
11264
|
+
Get summary of campaign store budgets
|
|
11265
|
+
|
|
11266
|
+
Fetch a summary of all store budget information for a given campaign.
|
|
11267
|
+
|
|
11268
|
+
### Example
|
|
11269
|
+
|
|
11270
|
+
```ruby
|
|
11271
|
+
# load the gem
|
|
11272
|
+
require 'talon_one'
|
|
11273
|
+
# setup authorization
|
|
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
|
+
|
|
11280
|
+
# Configure API key authorization: management_key
|
|
11281
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11282
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11283
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11284
|
+
|
|
11285
|
+
# Configure API key authorization: manager_auth
|
|
11286
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
11287
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
11288
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
11289
|
+
end
|
|
11290
|
+
|
|
11291
|
+
api_instance = TalonOne::ManagementApi.new
|
|
11292
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
|
11293
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
|
11294
|
+
|
|
11295
|
+
begin
|
|
11296
|
+
#Get summary of campaign store budgets
|
|
11297
|
+
result = api_instance.summarize_campaign_store_budget(application_id, campaign_id)
|
|
11298
|
+
p result
|
|
11299
|
+
rescue TalonOne::ApiError => e
|
|
11300
|
+
puts "Exception when calling ManagementApi->summarize_campaign_store_budget: #{e}"
|
|
11301
|
+
end
|
|
11302
|
+
```
|
|
11303
|
+
|
|
11304
|
+
### Parameters
|
|
11305
|
+
|
|
11306
|
+
|
|
11307
|
+
Name | Type | Description | Notes
|
|
11308
|
+
------------- | ------------- | ------------- | -------------
|
|
11309
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
|
11310
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
|
11311
|
+
|
|
11312
|
+
### Return type
|
|
11313
|
+
|
|
11314
|
+
[**InlineResponse20047**](InlineResponse20047.md)
|
|
11315
|
+
|
|
11316
|
+
### Authorization
|
|
11317
|
+
|
|
11318
|
+
[api_key_v1](../README.md#api_key_v1), [management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
|
11319
|
+
|
|
11320
|
+
### HTTP request headers
|
|
11321
|
+
|
|
11322
|
+
- **Content-Type**: Not defined
|
|
11323
|
+
- **Accept**: application/json
|
|
11324
|
+
|
|
11325
|
+
|
|
9916
11326
|
## transfer_loyalty_card
|
|
9917
11327
|
|
|
9918
11328
|
> transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
|
@@ -9928,6 +11338,11 @@ Transfer loyalty card data, such as linked customers, loyalty balances and trans
|
|
|
9928
11338
|
require 'talon_one'
|
|
9929
11339
|
# setup authorization
|
|
9930
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
|
+
|
|
9931
11346
|
# Configure API key authorization: management_key
|
|
9932
11347
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9933
11348
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -9967,7 +11382,7 @@ nil (empty response body)
|
|
|
9967
11382
|
|
|
9968
11383
|
### Authorization
|
|
9969
11384
|
|
|
9970
|
-
[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)
|
|
9971
11386
|
|
|
9972
11387
|
### HTTP request headers
|
|
9973
11388
|
|
|
@@ -9990,6 +11405,11 @@ Edit the description of a given account-level collection and enable or disable t
|
|
|
9990
11405
|
require 'talon_one'
|
|
9991
11406
|
# setup authorization
|
|
9992
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
|
+
|
|
9993
11413
|
# Configure API key authorization: management_key
|
|
9994
11414
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
9995
11415
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10028,7 +11448,7 @@ Name | Type | Description | Notes
|
|
|
10028
11448
|
|
|
10029
11449
|
### Authorization
|
|
10030
11450
|
|
|
10031
|
-
[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)
|
|
10032
11452
|
|
|
10033
11453
|
### HTTP request headers
|
|
10034
11454
|
|
|
@@ -10051,6 +11471,11 @@ Update the details of a specific achievement.
|
|
|
10051
11471
|
require 'talon_one'
|
|
10052
11472
|
# setup authorization
|
|
10053
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
|
+
|
|
10054
11479
|
# Configure API key authorization: management_key
|
|
10055
11480
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10056
11481
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10093,7 +11518,7 @@ Name | Type | Description | Notes
|
|
|
10093
11518
|
|
|
10094
11519
|
### Authorization
|
|
10095
11520
|
|
|
10096
|
-
[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)
|
|
10097
11522
|
|
|
10098
11523
|
### HTTP request headers
|
|
10099
11524
|
|
|
@@ -10116,6 +11541,11 @@ Updates an existing additional cost. Once created, the only property of an addit
|
|
|
10116
11541
|
require 'talon_one'
|
|
10117
11542
|
# setup authorization
|
|
10118
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
|
+
|
|
10119
11549
|
# Configure API key authorization: management_key
|
|
10120
11550
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10121
11551
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10154,7 +11584,7 @@ Name | Type | Description | Notes
|
|
|
10154
11584
|
|
|
10155
11585
|
### Authorization
|
|
10156
11586
|
|
|
10157
|
-
[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)
|
|
10158
11588
|
|
|
10159
11589
|
### HTTP request headers
|
|
10160
11590
|
|
|
@@ -10177,6 +11607,11 @@ Update an existing custom attribute. Once created, the only property of a custom
|
|
|
10177
11607
|
require 'talon_one'
|
|
10178
11608
|
# setup authorization
|
|
10179
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
|
+
|
|
10180
11615
|
# Configure API key authorization: management_key
|
|
10181
11616
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10182
11617
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10215,7 +11650,7 @@ Name | Type | Description | Notes
|
|
|
10215
11650
|
|
|
10216
11651
|
### Authorization
|
|
10217
11652
|
|
|
10218
|
-
[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)
|
|
10219
11654
|
|
|
10220
11655
|
### HTTP request headers
|
|
10221
11656
|
|
|
@@ -10238,6 +11673,11 @@ Update the given campaign. **Important:** You cannot use this endpoint to updat
|
|
|
10238
11673
|
require 'talon_one'
|
|
10239
11674
|
# setup authorization
|
|
10240
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
|
+
|
|
10241
11681
|
# Configure API key authorization: management_key
|
|
10242
11682
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10243
11683
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10278,7 +11718,7 @@ Name | Type | Description | Notes
|
|
|
10278
11718
|
|
|
10279
11719
|
### Authorization
|
|
10280
11720
|
|
|
10281
|
-
[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)
|
|
10282
11722
|
|
|
10283
11723
|
### HTTP request headers
|
|
10284
11724
|
|
|
@@ -10301,6 +11741,11 @@ Edit the description of a given campaign-level collection.
|
|
|
10301
11741
|
require 'talon_one'
|
|
10302
11742
|
# setup authorization
|
|
10303
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
|
+
|
|
10304
11749
|
# Configure API key authorization: management_key
|
|
10305
11750
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10306
11751
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10343,7 +11788,7 @@ Name | Type | Description | Notes
|
|
|
10343
11788
|
|
|
10344
11789
|
### Authorization
|
|
10345
11790
|
|
|
10346
|
-
[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)
|
|
10347
11792
|
|
|
10348
11793
|
### HTTP request headers
|
|
10349
11794
|
|
|
@@ -10366,6 +11811,11 @@ Update the specified coupon. <div class=\"redoc-section\"> <p class=\"title\"
|
|
|
10366
11811
|
require 'talon_one'
|
|
10367
11812
|
# setup authorization
|
|
10368
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
|
+
|
|
10369
11819
|
# Configure API key authorization: management_key
|
|
10370
11820
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10371
11821
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10408,7 +11858,7 @@ Name | Type | Description | Notes
|
|
|
10408
11858
|
|
|
10409
11859
|
### Authorization
|
|
10410
11860
|
|
|
10411
|
-
[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)
|
|
10412
11862
|
|
|
10413
11863
|
### HTTP request headers
|
|
10414
11864
|
|
|
@@ -10431,6 +11881,11 @@ Update all coupons or a specific batch of coupons in the given campaign. You can
|
|
|
10431
11881
|
require 'talon_one'
|
|
10432
11882
|
# setup authorization
|
|
10433
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
|
+
|
|
10434
11889
|
# Configure API key authorization: management_key
|
|
10435
11890
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10436
11891
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10470,7 +11925,7 @@ nil (empty response body)
|
|
|
10470
11925
|
|
|
10471
11926
|
### Authorization
|
|
10472
11927
|
|
|
10473
|
-
[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)
|
|
10474
11929
|
|
|
10475
11930
|
### HTTP request headers
|
|
10476
11931
|
|
|
@@ -10493,6 +11948,11 @@ Update the status of the given loyalty card. A card can be _active_ or _inactive
|
|
|
10493
11948
|
require 'talon_one'
|
|
10494
11949
|
# setup authorization
|
|
10495
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
|
+
|
|
10496
11956
|
# Configure API key authorization: management_key
|
|
10497
11957
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10498
11958
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10533,7 +11993,7 @@ Name | Type | Description | Notes
|
|
|
10533
11993
|
|
|
10534
11994
|
### Authorization
|
|
10535
11995
|
|
|
10536
|
-
[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)
|
|
10537
11997
|
|
|
10538
11998
|
### HTTP request headers
|
|
10539
11999
|
|
|
@@ -10556,6 +12016,11 @@ Update the specified referral.
|
|
|
10556
12016
|
require 'talon_one'
|
|
10557
12017
|
# setup authorization
|
|
10558
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
|
+
|
|
10559
12024
|
# Configure API key authorization: management_key
|
|
10560
12025
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10561
12026
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10598,7 +12063,7 @@ Name | Type | Description | Notes
|
|
|
10598
12063
|
|
|
10599
12064
|
### Authorization
|
|
10600
12065
|
|
|
10601
|
-
[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)
|
|
10602
12067
|
|
|
10603
12068
|
### HTTP request headers
|
|
10604
12069
|
|
|
@@ -10621,6 +12086,11 @@ Update a specific role.
|
|
|
10621
12086
|
require 'talon_one'
|
|
10622
12087
|
# setup authorization
|
|
10623
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
|
+
|
|
10624
12094
|
# Configure API key authorization: management_key
|
|
10625
12095
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10626
12096
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10659,7 +12129,7 @@ Name | Type | Description | Notes
|
|
|
10659
12129
|
|
|
10660
12130
|
### Authorization
|
|
10661
12131
|
|
|
10662
|
-
[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)
|
|
10663
12133
|
|
|
10664
12134
|
### HTTP request headers
|
|
10665
12135
|
|
|
@@ -10682,6 +12152,11 @@ Update store details for a specific store ID.
|
|
|
10682
12152
|
require 'talon_one'
|
|
10683
12153
|
# setup authorization
|
|
10684
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
|
+
|
|
10685
12160
|
# Configure API key authorization: management_key
|
|
10686
12161
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10687
12162
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10722,7 +12197,7 @@ Name | Type | Description | Notes
|
|
|
10722
12197
|
|
|
10723
12198
|
### Authorization
|
|
10724
12199
|
|
|
10725
|
-
[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)
|
|
10726
12201
|
|
|
10727
12202
|
### HTTP request headers
|
|
10728
12203
|
|
|
@@ -10745,6 +12220,11 @@ Update the details of a specific user.
|
|
|
10745
12220
|
require 'talon_one'
|
|
10746
12221
|
# setup authorization
|
|
10747
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
|
+
|
|
10748
12228
|
# Configure API key authorization: management_key
|
|
10749
12229
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
10750
12230
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
@@ -10783,7 +12263,7 @@ Name | Type | Description | Notes
|
|
|
10783
12263
|
|
|
10784
12264
|
### Authorization
|
|
10785
12265
|
|
|
10786
|
-
[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)
|
|
10787
12267
|
|
|
10788
12268
|
### HTTP request headers
|
|
10789
12269
|
|