talon_one 8.0.0 → 10.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/README.md +42 -8
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/Achievement.md +2 -2
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +4 -2
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -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/CreateAchievement.md +1 -1
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/Effect.md +6 -0
- 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/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20048.md +17 -0
- data/docs/InlineResponse20049.md +17 -0
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +6 -4
- 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/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +824 -220
- data/docs/MessageTest.md +27 -0
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewMessageTest.md +29 -0
- data/docs/NewPriceAdjustment.md +27 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewWebhook.md +2 -0
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +23 -0
- data/docs/PriceType.md +33 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -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/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/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/docs/TemplateDef.md +1 -1
- data/docs/UpdateAchievement.md +1 -1
- data/docs/User.md +1 -1
- data/docs/Webhook.md +3 -1
- 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 +3 -1
- data/lib/talon_one/api/integration_api.rb +9 -6
- data/lib/talon_one/api/management_api.rb +1009 -304
- 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/achievement.rb +4 -4
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- 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/analytics_sku.rb +246 -0
- 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_cif_references.rb +219 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- 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/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +2 -2
- 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/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +17 -5
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- 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/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/create_achievement.rb +3 -3
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +2 -2
- 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/delete_user_request.rb +0 -1
- data/lib/talon_one/models/effect.rb +31 -1
- 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/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -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/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +208 -0
- data/lib/talon_one/models/inline_response20049.rb +208 -0
- 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/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/message_test.rb +227 -0
- 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_message_test.rb +322 -0
- data/lib/talon_one/models/new_price_adjustment.rb +268 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_webhook.rb +16 -1
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +237 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -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/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/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/update_achievement.rb +3 -3
- 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/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +17 -2
- 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 +17 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +26 -1
- data/spec/api/integration_api_spec.rb +4 -3
- data/spec/api/management_api_spec.rb +227 -90
- data/spec/models/achievement_base_spec.rb +1 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
- data/spec/models/achievement_spec.rb +1 -1
- data/spec/models/achievement_status_entry_spec.rb +1 -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/base_notification_spec.rb +1 -1
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/create_achievement_spec.rb +1 -1
- data/spec/models/customer_profile_entity_spec.rb +47 -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/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
- data/spec/models/inline_response20048_spec.rb +0 -6
- data/spec/models/inline_response20049_spec.rb +0 -6
- 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/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +1 -1
- data/spec/models/new_price_adjustment_spec.rb +71 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/price_detail_spec.rb +59 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/revision_activation_request_spec.rb +47 -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/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +1 -1
- 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 +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +661 -527
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
|
@@ -108,6 +111,7 @@ Method | HTTP request | Description
|
|
108
111
|
[**get_loyalty_program_transactions**](ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
|
109
112
|
[**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
110
113
|
[**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
114
|
+
[**get_message_logs**](ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
|
111
115
|
[**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
|
112
116
|
[**get_role_v2**](ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
113
117
|
[**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
@@ -122,6 +126,7 @@ Method | HTTP request | Description
|
|
122
126
|
[**import_account_collection**](ManagementApi.md#import_account_collection) | **POST** /v1/collections/{collectionId}/import | Import data into existing account-level collection
|
123
127
|
[**import_allowed_list**](ManagementApi.md#import_allowed_list) | **POST** /v1/attributes/{attributeId}/allowed_list/import | Import allowed values for attribute
|
124
128
|
[**import_audiences_memberships**](ManagementApi.md#import_audiences_memberships) | **POST** /v1/audiences/{audienceId}/memberships/import | Import audience members
|
129
|
+
[**import_campaign_store_budget**](ManagementApi.md#import_campaign_store_budget) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/budgets/import | Import campaign store budgets
|
125
130
|
[**import_campaign_stores**](ManagementApi.md#import_campaign_stores) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/stores/import | Import stores
|
126
131
|
[**import_collection**](ManagementApi.md#import_collection) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/collections/{collectionId}/import | Import data into existing campaign-level collection
|
127
132
|
[**import_coupons**](ManagementApi.md#import_coupons) | **POST** /v1/applications/{applicationId}/campaigns/{campaignId}/import_coupons | Import coupons
|
@@ -134,28 +139,32 @@ Method | HTTP request | Description
|
|
134
139
|
[**list_account_collections**](ManagementApi.md#list_account_collections) | **GET** /v1/collections | List collections in account
|
135
140
|
[**list_achievements**](ManagementApi.md#list_achievements) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements | List achievements
|
136
141
|
[**list_all_roles_v2**](ManagementApi.md#list_all_roles_v2) | **GET** /v2/roles | List roles
|
142
|
+
[**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
|
137
143
|
[**list_catalog_items**](ManagementApi.md#list_catalog_items) | **GET** /v1/catalogs/{catalogId}/items | List items in a catalog
|
138
144
|
[**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
139
145
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
140
146
|
[**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
141
|
-
[**notification_activation**](ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
142
147
|
[**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
143
|
-
[**post_added_deducted_points_notification**](ManagementApi.md#post_added_deducted_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/added_deducted_points | Create notification about added or deducted loyalty points
|
144
|
-
[**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
145
|
-
[**post_pending_points_notification**](ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
146
148
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
147
149
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
150
|
+
[**scim_create_group**](ManagementApi.md#scim_create_group) | **POST** /v1/provisioning/scim/Groups | Create SCIM group
|
148
151
|
[**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
152
|
+
[**scim_delete_group**](ManagementApi.md#scim_delete_group) | **DELETE** /v1/provisioning/scim/Groups/{groupId} | Delete SCIM group
|
149
153
|
[**scim_delete_user**](ManagementApi.md#scim_delete_user) | **DELETE** /v1/provisioning/scim/Users/{userId} | Delete SCIM user
|
154
|
+
[**scim_get_group**](ManagementApi.md#scim_get_group) | **GET** /v1/provisioning/scim/Groups/{groupId} | Get SCIM group
|
155
|
+
[**scim_get_groups**](ManagementApi.md#scim_get_groups) | **GET** /v1/provisioning/scim/Groups | List SCIM groups
|
150
156
|
[**scim_get_resource_types**](ManagementApi.md#scim_get_resource_types) | **GET** /v1/provisioning/scim/ResourceTypes | List supported SCIM resource types
|
151
157
|
[**scim_get_schemas**](ManagementApi.md#scim_get_schemas) | **GET** /v1/provisioning/scim/Schemas | List supported SCIM schemas
|
152
158
|
[**scim_get_service_provider_config**](ManagementApi.md#scim_get_service_provider_config) | **GET** /v1/provisioning/scim/ServiceProviderConfig | Get SCIM service provider configuration
|
153
159
|
[**scim_get_user**](ManagementApi.md#scim_get_user) | **GET** /v1/provisioning/scim/Users/{userId} | Get SCIM user
|
154
160
|
[**scim_get_users**](ManagementApi.md#scim_get_users) | **GET** /v1/provisioning/scim/Users | List SCIM users
|
161
|
+
[**scim_patch_group**](ManagementApi.md#scim_patch_group) | **PATCH** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group attributes
|
155
162
|
[**scim_patch_user**](ManagementApi.md#scim_patch_user) | **PATCH** /v1/provisioning/scim/Users/{userId} | Update SCIM user attributes
|
163
|
+
[**scim_replace_group_attributes**](ManagementApi.md#scim_replace_group_attributes) | **PUT** /v1/provisioning/scim/Groups/{groupId} | Update SCIM group
|
156
164
|
[**scim_replace_user_attributes**](ManagementApi.md#scim_replace_user_attributes) | **PUT** /v1/provisioning/scim/Users/{userId} | Update SCIM user
|
157
165
|
[**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)
|
158
166
|
[**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)
|
167
|
+
[**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
|
159
168
|
[**transfer_loyalty_card**](ManagementApi.md#transfer_loyalty_card) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transfer | Transfer card data
|
160
169
|
[**update_account_collection**](ManagementApi.md#update_account_collection) | **PUT** /v1/collections/{collectionId} | Update account-level collection
|
161
170
|
[**update_achievement**](ManagementApi.md#update_achievement) | **PUT** /v1/applications/{applicationId}/campaigns/{campaignId}/achievements/{achievementId} | Update achievement
|
@@ -200,7 +209,7 @@ TalonOne.configure do |config|
|
|
200
209
|
end
|
201
210
|
|
202
211
|
api_instance = TalonOne::ManagementApi.new
|
203
|
-
body = TalonOne::
|
212
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
204
213
|
|
205
214
|
begin
|
206
215
|
#Enable user by email address
|
@@ -215,7 +224,7 @@ end
|
|
215
224
|
|
216
225
|
Name | Type | Description | Notes
|
217
226
|
------------- | ------------- | ------------- | -------------
|
218
|
-
**body** | **
|
227
|
+
**body** | **DeleteUserRequest**| body |
|
219
228
|
|
220
229
|
### Return type
|
221
230
|
|
@@ -780,6 +789,68 @@ Name | Type | Description | Notes
|
|
780
789
|
- **Accept**: application/json
|
781
790
|
|
782
791
|
|
792
|
+
## create_campaign_store_budget
|
793
|
+
|
794
|
+
> create_campaign_store_budget(application_id, campaign_id, body)
|
795
|
+
|
796
|
+
Create campaign store budget
|
797
|
+
|
798
|
+
Create a new store budget for a given campaign.
|
799
|
+
|
800
|
+
### Example
|
801
|
+
|
802
|
+
```ruby
|
803
|
+
# load the gem
|
804
|
+
require 'talon_one'
|
805
|
+
# setup authorization
|
806
|
+
TalonOne.configure do |config|
|
807
|
+
# Configure API key authorization: management_key
|
808
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
809
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
810
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
811
|
+
|
812
|
+
# Configure API key authorization: manager_auth
|
813
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
814
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
815
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
816
|
+
end
|
817
|
+
|
818
|
+
api_instance = TalonOne::ManagementApi.new
|
819
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
820
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
821
|
+
body = TalonOne::NewCampaignStoreBudget.new # NewCampaignStoreBudget | body
|
822
|
+
|
823
|
+
begin
|
824
|
+
#Create campaign store budget
|
825
|
+
api_instance.create_campaign_store_budget(application_id, campaign_id, body)
|
826
|
+
rescue TalonOne::ApiError => e
|
827
|
+
puts "Exception when calling ManagementApi->create_campaign_store_budget: #{e}"
|
828
|
+
end
|
829
|
+
```
|
830
|
+
|
831
|
+
### Parameters
|
832
|
+
|
833
|
+
|
834
|
+
Name | Type | Description | Notes
|
835
|
+
------------- | ------------- | ------------- | -------------
|
836
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
837
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
838
|
+
**body** | [**NewCampaignStoreBudget**](NewCampaignStoreBudget.md)| body |
|
839
|
+
|
840
|
+
### Return type
|
841
|
+
|
842
|
+
nil (empty response body)
|
843
|
+
|
844
|
+
### Authorization
|
845
|
+
|
846
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
847
|
+
|
848
|
+
### HTTP request headers
|
849
|
+
|
850
|
+
- **Content-Type**: application/json
|
851
|
+
- **Accept**: application/json
|
852
|
+
|
853
|
+
|
783
854
|
## create_collection
|
784
855
|
|
785
856
|
> Collection create_collection(application_id, campaign_id, body)
|
@@ -1427,7 +1498,7 @@ TalonOne.configure do |config|
|
|
1427
1498
|
end
|
1428
1499
|
|
1429
1500
|
api_instance = TalonOne::ManagementApi.new
|
1430
|
-
body = TalonOne::
|
1501
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
1431
1502
|
|
1432
1503
|
begin
|
1433
1504
|
#Disable user by email address
|
@@ -1442,7 +1513,7 @@ end
|
|
1442
1513
|
|
1443
1514
|
Name | Type | Description | Notes
|
1444
1515
|
------------- | ------------- | ------------- | -------------
|
1445
|
-
**body** |
|
1516
|
+
**body** | **DeleteUserRequest**| body |
|
1446
1517
|
|
1447
1518
|
### Return type
|
1448
1519
|
|
@@ -1700,6 +1771,72 @@ nil (empty response body)
|
|
1700
1771
|
- **Accept**: Not defined
|
1701
1772
|
|
1702
1773
|
|
1774
|
+
## delete_campaign_store_budgets
|
1775
|
+
|
1776
|
+
> delete_campaign_store_budgets(application_id, campaign_id, opts)
|
1777
|
+
|
1778
|
+
Delete campaign store budgets
|
1779
|
+
|
1780
|
+
Delete the store budgets for a given campaign.
|
1781
|
+
|
1782
|
+
### Example
|
1783
|
+
|
1784
|
+
```ruby
|
1785
|
+
# load the gem
|
1786
|
+
require 'talon_one'
|
1787
|
+
# setup authorization
|
1788
|
+
TalonOne.configure do |config|
|
1789
|
+
# Configure API key authorization: management_key
|
1790
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1791
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1792
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1793
|
+
|
1794
|
+
# Configure API key authorization: manager_auth
|
1795
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1796
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1797
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
1798
|
+
end
|
1799
|
+
|
1800
|
+
api_instance = TalonOne::ManagementApi.new
|
1801
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1802
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1803
|
+
opts = {
|
1804
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
1805
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
1806
|
+
}
|
1807
|
+
|
1808
|
+
begin
|
1809
|
+
#Delete campaign store budgets
|
1810
|
+
api_instance.delete_campaign_store_budgets(application_id, campaign_id, opts)
|
1811
|
+
rescue TalonOne::ApiError => e
|
1812
|
+
puts "Exception when calling ManagementApi->delete_campaign_store_budgets: #{e}"
|
1813
|
+
end
|
1814
|
+
```
|
1815
|
+
|
1816
|
+
### Parameters
|
1817
|
+
|
1818
|
+
|
1819
|
+
Name | Type | Description | Notes
|
1820
|
+
------------- | ------------- | ------------- | -------------
|
1821
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
1822
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
1823
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
1824
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
1825
|
+
|
1826
|
+
### Return type
|
1827
|
+
|
1828
|
+
nil (empty response body)
|
1829
|
+
|
1830
|
+
### Authorization
|
1831
|
+
|
1832
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
1833
|
+
|
1834
|
+
### HTTP request headers
|
1835
|
+
|
1836
|
+
- **Content-Type**: Not defined
|
1837
|
+
- **Accept**: application/json
|
1838
|
+
|
1839
|
+
|
1703
1840
|
## delete_collection
|
1704
1841
|
|
1705
1842
|
> delete_collection(application_id, campaign_id, collection_id)
|
@@ -2179,7 +2316,7 @@ TalonOne.configure do |config|
|
|
2179
2316
|
end
|
2180
2317
|
|
2181
2318
|
api_instance = TalonOne::ManagementApi.new
|
2182
|
-
body = TalonOne::
|
2319
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
2183
2320
|
|
2184
2321
|
begin
|
2185
2322
|
#Delete user by email address
|
@@ -2194,7 +2331,7 @@ end
|
|
2194
2331
|
|
2195
2332
|
Name | Type | Description | Notes
|
2196
2333
|
------------- | ------------- | ------------- | -------------
|
2197
|
-
**body** | **
|
2334
|
+
**body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body |
|
2198
2335
|
|
2199
2336
|
### Return type
|
2200
2337
|
|
@@ -2505,6 +2642,73 @@ Name | Type | Description | Notes
|
|
2505
2642
|
- **Accept**: application/csv
|
2506
2643
|
|
2507
2644
|
|
2645
|
+
## export_campaign_store_budgets
|
2646
|
+
|
2647
|
+
> String export_campaign_store_budgets(application_id, campaign_id, opts)
|
2648
|
+
|
2649
|
+
Export campaign store budgets
|
2650
|
+
|
2651
|
+
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.
|
2652
|
+
|
2653
|
+
### Example
|
2654
|
+
|
2655
|
+
```ruby
|
2656
|
+
# load the gem
|
2657
|
+
require 'talon_one'
|
2658
|
+
# setup authorization
|
2659
|
+
TalonOne.configure do |config|
|
2660
|
+
# Configure API key authorization: management_key
|
2661
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2662
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2663
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2664
|
+
|
2665
|
+
# Configure API key authorization: manager_auth
|
2666
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2667
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2668
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
2669
|
+
end
|
2670
|
+
|
2671
|
+
api_instance = TalonOne::ManagementApi.new
|
2672
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2673
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2674
|
+
opts = {
|
2675
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
2676
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
2677
|
+
}
|
2678
|
+
|
2679
|
+
begin
|
2680
|
+
#Export campaign store budgets
|
2681
|
+
result = api_instance.export_campaign_store_budgets(application_id, campaign_id, opts)
|
2682
|
+
p result
|
2683
|
+
rescue TalonOne::ApiError => e
|
2684
|
+
puts "Exception when calling ManagementApi->export_campaign_store_budgets: #{e}"
|
2685
|
+
end
|
2686
|
+
```
|
2687
|
+
|
2688
|
+
### Parameters
|
2689
|
+
|
2690
|
+
|
2691
|
+
Name | Type | Description | Notes
|
2692
|
+
------------- | ------------- | ------------- | -------------
|
2693
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2694
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
2695
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
2696
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
2697
|
+
|
2698
|
+
### Return type
|
2699
|
+
|
2700
|
+
**String**
|
2701
|
+
|
2702
|
+
### Authorization
|
2703
|
+
|
2704
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
2705
|
+
|
2706
|
+
### HTTP request headers
|
2707
|
+
|
2708
|
+
- **Content-Type**: Not defined
|
2709
|
+
- **Accept**: application/csv
|
2710
|
+
|
2711
|
+
|
2508
2712
|
## export_campaign_stores
|
2509
2713
|
|
2510
2714
|
> String export_campaign_stores(application_id, campaign_id)
|
@@ -2659,7 +2863,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
2659
2863
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2660
2864
|
opts = {
|
2661
2865
|
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
2662
|
-
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:**
|
2866
|
+
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.
|
2663
2867
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
2664
2868
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2665
2869
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -2690,7 +2894,7 @@ Name | Type | Description | Notes
|
|
2690
2894
|
------------- | ------------- | ------------- | -------------
|
2691
2895
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2692
2896
|
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
2693
|
-
**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:**
|
2897
|
+
**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]
|
2694
2898
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
2695
2899
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
2696
2900
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -2724,7 +2928,7 @@ Name | Type | Description | Notes
|
|
2724
2928
|
|
2725
2929
|
Export customer sessions
|
2726
2930
|
|
2727
|
-
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/
|
2931
|
+
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.
|
2728
2932
|
|
2729
2933
|
### Example
|
2730
2934
|
|
@@ -3211,6 +3415,8 @@ api_instance = TalonOne::ManagementApi.new
|
|
3211
3415
|
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.
|
3212
3416
|
opts = {
|
3213
3417
|
batch_id: 'batch_id_example', # String | Filter results by loyalty card batch ID.
|
3418
|
+
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.
|
3419
|
+
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.
|
3214
3420
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
3215
3421
|
}
|
3216
3422
|
|
@@ -3230,6 +3436,8 @@ Name | Type | Description | Notes
|
|
3230
3436
|
------------- | ------------- | ------------- | -------------
|
3231
3437
|
**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. |
|
3232
3438
|
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
3439
|
+
**created_before** | **DateTime**| Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
3440
|
+
**created_after** | **DateTime**| Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string. | [optional]
|
3233
3441
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
3234
3442
|
|
3235
3443
|
### Return type
|
@@ -3252,7 +3460,7 @@ Name | Type | Description | Notes
|
|
3252
3460
|
|
3253
3461
|
Export customer's transaction logs
|
3254
3462
|
|
3255
|
-
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.
|
3463
|
+
Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
3256
3464
|
|
3257
3465
|
### Example
|
3258
3466
|
|
@@ -3491,7 +3699,7 @@ opts = {
|
|
3491
3699
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
3492
3700
|
page_size: 1000, # Integer | The number of items in the response.
|
3493
3701
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
3494
|
-
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:**
|
3702
|
+
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.
|
3495
3703
|
}
|
3496
3704
|
|
3497
3705
|
begin
|
@@ -3516,7 +3724,7 @@ Name | Type | Description | Notes
|
|
3516
3724
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
3517
3725
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
3518
3726
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
3519
|
-
**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:**
|
3727
|
+
**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]
|
3520
3728
|
|
3521
3729
|
### Return type
|
3522
3730
|
|
@@ -3861,7 +4069,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
3861
4069
|
opts = {
|
3862
4070
|
page_size: 1000, # Integer | The number of items in the response.
|
3863
4071
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
3864
|
-
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:**
|
4072
|
+
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.
|
3865
4073
|
}
|
3866
4074
|
|
3867
4075
|
begin
|
@@ -3880,7 +4088,7 @@ Name | Type | Description | Notes
|
|
3880
4088
|
------------- | ------------- | ------------- | -------------
|
3881
4089
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
3882
4090
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
3883
|
-
**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:**
|
4091
|
+
**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]
|
3884
4092
|
|
3885
4093
|
### Return type
|
3886
4094
|
|
@@ -4107,7 +4315,7 @@ integration_id = 'integration_id_example' # String | The Integration ID of the A
|
|
4107
4315
|
opts = {
|
4108
4316
|
page_size: 1000, # Integer | The number of items in the response.
|
4109
4317
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4110
|
-
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:**
|
4318
|
+
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.
|
4111
4319
|
with_total_result_size: true # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4112
4320
|
}
|
4113
4321
|
|
@@ -4129,7 +4337,7 @@ Name | Type | Description | Notes
|
|
4129
4337
|
**integration_id** | **String**| The Integration ID of the Advocate's Profile. |
|
4130
4338
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4131
4339
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4132
|
-
**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:**
|
4340
|
+
**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]
|
4133
4341
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
4134
4342
|
|
4135
4343
|
### Return type
|
@@ -4315,7 +4523,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4315
4523
|
opts = {
|
4316
4524
|
page_size: 1000, # Integer | The number of items in the response.
|
4317
4525
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4318
|
-
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:**
|
4526
|
+
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.
|
4319
4527
|
}
|
4320
4528
|
|
4321
4529
|
begin
|
@@ -4335,7 +4543,7 @@ Name | Type | Description | Notes
|
|
4335
4543
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4336
4544
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4337
4545
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4338
|
-
**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:**
|
4546
|
+
**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]
|
4339
4547
|
|
4340
4548
|
### Return type
|
4341
4549
|
|
@@ -4382,7 +4590,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4382
4590
|
opts = {
|
4383
4591
|
page_size: 1000, # Integer | The number of items in the response.
|
4384
4592
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4385
|
-
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:**
|
4593
|
+
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.
|
4386
4594
|
type: 'type_example', # String | Comma-separated list of types by which to filter events. Must be exact match(es).
|
4387
4595
|
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.
|
4388
4596
|
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.
|
@@ -4413,7 +4621,7 @@ Name | Type | Description | Notes
|
|
4413
4621
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4414
4622
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4415
4623
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4416
|
-
**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:**
|
4624
|
+
**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]
|
4417
4625
|
**type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
|
4418
4626
|
**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]
|
4419
4627
|
**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]
|
@@ -4532,7 +4740,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4532
4740
|
opts = {
|
4533
4741
|
page_size: 1000, # Integer | The number of items in the response.
|
4534
4742
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4535
|
-
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:**
|
4743
|
+
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.
|
4536
4744
|
profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
|
4537
4745
|
state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
|
4538
4746
|
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.
|
@@ -4560,7 +4768,7 @@ Name | Type | Description | Notes
|
|
4560
4768
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4561
4769
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4562
4770
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4563
|
-
**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:**
|
4771
|
+
**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]
|
4564
4772
|
**profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
|
4565
4773
|
**state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
|
4566
4774
|
**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]
|
@@ -4614,7 +4822,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4614
4822
|
opts = {
|
4615
4823
|
page_size: 1000, # Integer | The number of items in the response.
|
4616
4824
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4617
|
-
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:**
|
4825
|
+
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.
|
4618
4826
|
}
|
4619
4827
|
|
4620
4828
|
begin
|
@@ -4633,7 +4841,7 @@ Name | Type | Description | Notes
|
|
4633
4841
|
------------- | ------------- | ------------- | -------------
|
4634
4842
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4635
4843
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4636
|
-
**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:**
|
4844
|
+
**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]
|
4637
4845
|
|
4638
4846
|
### Return type
|
4639
4847
|
|
@@ -4738,7 +4946,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4738
4946
|
opts = {
|
4739
4947
|
page_size: 1000, # Integer | The number of items in the response.
|
4740
4948
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4741
|
-
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:**
|
4949
|
+
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.
|
4742
4950
|
entity: 'entity_example' # String | Returned attributes will be filtered by supplied entity.
|
4743
4951
|
}
|
4744
4952
|
|
@@ -4758,7 +4966,7 @@ Name | Type | Description | Notes
|
|
4758
4966
|
------------- | ------------- | ------------- | -------------
|
4759
4967
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4760
4968
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4761
|
-
**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:**
|
4969
|
+
**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]
|
4762
4970
|
**entity** | **String**| Returned attributes will be filtered by supplied entity. | [optional]
|
4763
4971
|
|
4764
4972
|
### Return type
|
@@ -4806,7 +5014,7 @@ audience_id = 56 # Integer | The ID of the audience.
|
|
4806
5014
|
opts = {
|
4807
5015
|
page_size: 1000, # Integer | The number of items in the response.
|
4808
5016
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4809
|
-
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:**
|
5017
|
+
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.
|
4810
5018
|
profile_query: 'profile_query_example' # String | The filter to select a profile.
|
4811
5019
|
}
|
4812
5020
|
|
@@ -4827,7 +5035,7 @@ Name | Type | Description | Notes
|
|
4827
5035
|
**audience_id** | **Integer**| The ID of the audience. |
|
4828
5036
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4829
5037
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4830
|
-
**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:**
|
5038
|
+
**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]
|
4831
5039
|
**profile_query** | **String**| The filter to select a profile. | [optional]
|
4832
5040
|
|
4833
5041
|
### Return type
|
@@ -4874,7 +5082,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4874
5082
|
opts = {
|
4875
5083
|
page_size: 1000, # Integer | The number of items in the response.
|
4876
5084
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4877
|
-
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:**
|
5085
|
+
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.
|
4878
5086
|
with_total_result_size: true # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
4879
5087
|
}
|
4880
5088
|
|
@@ -4894,7 +5102,7 @@ Name | Type | Description | Notes
|
|
4894
5102
|
------------- | ------------- | ------------- | -------------
|
4895
5103
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4896
5104
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4897
|
-
**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:**
|
5105
|
+
**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]
|
4898
5106
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
4899
5107
|
|
4900
5108
|
### Return type
|
@@ -4940,7 +5148,7 @@ end
|
|
4940
5148
|
api_instance = TalonOne::ManagementApi.new
|
4941
5149
|
audience_ids = 'audience_ids_example' # String | The IDs of one or more audiences, separated by commas, by which to filter results.
|
4942
5150
|
opts = {
|
4943
|
-
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:**
|
5151
|
+
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.
|
4944
5152
|
}
|
4945
5153
|
|
4946
5154
|
begin
|
@@ -4958,7 +5166,7 @@ end
|
|
4958
5166
|
Name | Type | Description | Notes
|
4959
5167
|
------------- | ------------- | ------------- | -------------
|
4960
5168
|
**audience_ids** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. |
|
4961
|
-
**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:**
|
5169
|
+
**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]
|
4962
5170
|
|
4963
5171
|
### Return type
|
4964
5172
|
|
@@ -5136,7 +5344,7 @@ body = TalonOne::CampaignSearch.new # CampaignSearch | body
|
|
5136
5344
|
opts = {
|
5137
5345
|
page_size: 1000, # Integer | The number of items in the response.
|
5138
5346
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5139
|
-
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:**
|
5347
|
+
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.
|
5140
5348
|
campaign_state: 'campaign_state_example' # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5141
5349
|
}
|
5142
5350
|
|
@@ -5158,7 +5366,7 @@ Name | Type | Description | Notes
|
|
5158
5366
|
**body** | [**CampaignSearch**](CampaignSearch.md)| body |
|
5159
5367
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5160
5368
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5161
|
-
**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:**
|
5369
|
+
**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]
|
5162
5370
|
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
5163
5371
|
|
5164
5372
|
### Return type
|
@@ -5264,7 +5472,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5264
5472
|
opts = {
|
5265
5473
|
page_size: 1000, # Integer | The number of items in the response.
|
5266
5474
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5267
|
-
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:**
|
5475
|
+
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.
|
5268
5476
|
}
|
5269
5477
|
|
5270
5478
|
begin
|
@@ -5283,7 +5491,7 @@ Name | Type | Description | Notes
|
|
5283
5491
|
------------- | ------------- | ------------- | -------------
|
5284
5492
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5285
5493
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5286
|
-
**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:**
|
5494
|
+
**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]
|
5287
5495
|
|
5288
5496
|
### Return type
|
5289
5497
|
|
@@ -5329,7 +5537,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5329
5537
|
opts = {
|
5330
5538
|
page_size: 1000, # Integer | The number of items in the response.
|
5331
5539
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5332
|
-
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:**
|
5540
|
+
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.
|
5333
5541
|
state: 'state_example', # String | Filter results by the state of the campaign template.
|
5334
5542
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign template.
|
5335
5543
|
tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
@@ -5352,7 +5560,7 @@ Name | Type | Description | Notes
|
|
5352
5560
|
------------- | ------------- | ------------- | -------------
|
5353
5561
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5354
5562
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5355
|
-
**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:**
|
5563
|
+
**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]
|
5356
5564
|
**state** | **String**| Filter results by the state of the campaign template. | [optional]
|
5357
5565
|
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign template. | [optional]
|
5358
5566
|
**tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values. | [optional]
|
@@ -5403,7 +5611,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
5403
5611
|
opts = {
|
5404
5612
|
page_size: 1000, # Integer | The number of items in the response.
|
5405
5613
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5406
|
-
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:**
|
5614
|
+
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.
|
5407
5615
|
campaign_state: 'campaign_state_example', # String | Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
5408
5616
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
|
5409
5617
|
tags: 'tags_example', # String | Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
@@ -5431,7 +5639,7 @@ Name | Type | Description | Notes
|
|
5431
5639
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
5432
5640
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5433
5641
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5434
|
-
**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:**
|
5642
|
+
**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]
|
5435
5643
|
**campaign_state** | **String**| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | [optional]
|
5436
5644
|
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
|
5437
5645
|
**tags** | **String**| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values | [optional]
|
@@ -5485,7 +5693,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5485
5693
|
opts = {
|
5486
5694
|
page_size: 1000, # Integer | The number of items in the response.
|
5487
5695
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5488
|
-
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:**
|
5696
|
+
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.
|
5489
5697
|
application_id: 3.4, # Float | Filter results by Application ID.
|
5490
5698
|
entity_path: 'entity_path_example', # String | Filter results on a case insensitive matching of the url path of the entity
|
5491
5699
|
user_id: 56, # Integer | Filter results by user ID.
|
@@ -5512,7 +5720,7 @@ Name | Type | Description | Notes
|
|
5512
5720
|
------------- | ------------- | ------------- | -------------
|
5513
5721
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5514
5722
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5515
|
-
**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:**
|
5723
|
+
**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]
|
5516
5724
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
5517
5725
|
**entity_path** | **String**| Filter results on a case insensitive matching of the url path of the entity | [optional]
|
5518
5726
|
**user_id** | **Integer**| Filter results by user ID. | [optional]
|
@@ -5696,7 +5904,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
5696
5904
|
opts = {
|
5697
5905
|
page_size: 1000, # Integer | The number of items in the response.
|
5698
5906
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5699
|
-
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:**
|
5907
|
+
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.
|
5700
5908
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
5701
5909
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
5702
5910
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -5732,7 +5940,7 @@ Name | Type | Description | Notes
|
|
5732
5940
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
5733
5941
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5734
5942
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5735
|
-
**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:**
|
5943
|
+
**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]
|
5736
5944
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
5737
5945
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
5738
5946
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -5867,7 +6075,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
5867
6075
|
opts = {
|
5868
6076
|
page_size: 1000, # Integer | The number of items in the response.
|
5869
6077
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5870
|
-
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:**
|
6078
|
+
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.
|
5871
6079
|
name: 'name_example', # String | Only return reports matching the customer name.
|
5872
6080
|
integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
|
5873
6081
|
campaign_name: 'campaign_name_example', # String | Only return reports matching the campaign name.
|
@@ -5893,7 +6101,7 @@ Name | Type | Description | Notes
|
|
5893
6101
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
5894
6102
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5895
6103
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5896
|
-
**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:**
|
6104
|
+
**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]
|
5897
6105
|
**name** | **String**| Only return reports matching the customer name. | [optional]
|
5898
6106
|
**integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
|
5899
6107
|
**campaign_name** | **String**| Only return reports matching the campaign name. | [optional]
|
@@ -5945,7 +6153,7 @@ customer_id = 56 # Integer | The value of the `id` property of a customer profil
|
|
5945
6153
|
opts = {
|
5946
6154
|
page_size: 1000, # Integer | The number of items in the response.
|
5947
6155
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5948
|
-
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:**
|
6156
|
+
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.
|
5949
6157
|
}
|
5950
6158
|
|
5951
6159
|
begin
|
@@ -5966,7 +6174,7 @@ Name | Type | Description | Notes
|
|
5966
6174
|
**customer_id** | **Integer**| The value of the `id` property of a customer profile. Get it with the [List Application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint. |
|
5967
6175
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5968
6176
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5969
|
-
**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:**
|
6177
|
+
**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]
|
5970
6178
|
|
5971
6179
|
### Return type
|
5972
6180
|
|
@@ -6043,7 +6251,7 @@ Name | Type | Description | Notes
|
|
6043
6251
|
|
6044
6252
|
## get_customer_profile_achievement_progress
|
6045
6253
|
|
6046
|
-
>
|
6254
|
+
> InlineResponse20051 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
6047
6255
|
|
6048
6256
|
List customer achievements
|
6049
6257
|
|
@@ -6100,7 +6308,7 @@ Name | Type | Description | Notes
|
|
6100
6308
|
|
6101
6309
|
### Return type
|
6102
6310
|
|
6103
|
-
[**
|
6311
|
+
[**InlineResponse20051**](InlineResponse20051.md)
|
6104
6312
|
|
6105
6313
|
### Authorization
|
6106
6314
|
|
@@ -6343,7 +6551,7 @@ opts = {
|
|
6343
6551
|
include_old_versions: false, # Boolean | Include all versions of every event type.
|
6344
6552
|
page_size: 1000, # Integer | The number of items in the response.
|
6345
6553
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6346
|
-
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:**
|
6554
|
+
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.
|
6347
6555
|
}
|
6348
6556
|
|
6349
6557
|
begin
|
@@ -6364,7 +6572,7 @@ Name | Type | Description | Notes
|
|
6364
6572
|
**include_old_versions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
|
6365
6573
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6366
6574
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6367
|
-
**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:**
|
6575
|
+
**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]
|
6368
6576
|
|
6369
6577
|
### Return type
|
6370
6578
|
|
@@ -6614,7 +6822,7 @@ loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program
|
|
6614
6822
|
opts = {
|
6615
6823
|
page_size: 1000, # Integer | The number of items in the response.
|
6616
6824
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6617
|
-
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:**
|
6825
|
+
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.
|
6618
6826
|
identifier: 'identifier_example', # String | The card code by which to filter loyalty cards in the response.
|
6619
6827
|
profile_id: 56, # Integer | Filter results by customer profile ID.
|
6620
6828
|
batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
|
@@ -6637,7 +6845,7 @@ Name | Type | Description | Notes
|
|
6637
6845
|
**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. |
|
6638
6846
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6639
6847
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6640
|
-
**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:**
|
6848
|
+
**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]
|
6641
6849
|
**identifier** | **String**| The card code by which to filter loyalty cards in the response. | [optional]
|
6642
6850
|
**profile_id** | **Integer**| Filter results by customer profile ID. | [optional]
|
6643
6851
|
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
@@ -6963,6 +7171,93 @@ Name | Type | Description | Notes
|
|
6963
7171
|
- **Accept**: application/json
|
6964
7172
|
|
6965
7173
|
|
7174
|
+
## get_message_logs
|
7175
|
+
|
7176
|
+
> MessageLogEntries get_message_logs(entity_type, opts)
|
7177
|
+
|
7178
|
+
List message log entries
|
7179
|
+
|
7180
|
+
Retrieve all message log entries.
|
7181
|
+
|
7182
|
+
### Example
|
7183
|
+
|
7184
|
+
```ruby
|
7185
|
+
# load the gem
|
7186
|
+
require 'talon_one'
|
7187
|
+
# setup authorization
|
7188
|
+
TalonOne.configure do |config|
|
7189
|
+
# Configure API key authorization: management_key
|
7190
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
7191
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
7192
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
7193
|
+
|
7194
|
+
# Configure API key authorization: manager_auth
|
7195
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
7196
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
7197
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
7198
|
+
end
|
7199
|
+
|
7200
|
+
api_instance = TalonOne::ManagementApi.new
|
7201
|
+
entity_type = 'entity_type_example' # String | The entity type the log is related to.
|
7202
|
+
opts = {
|
7203
|
+
message_id: 'message_id_example', # String | Filter results by message ID.
|
7204
|
+
change_type: 'change_type_example', # String | Filter results by change type.
|
7205
|
+
notification_i_ds: 'notification_i_ds_example', # String | Filter results by notification ID (include up to 30 values, separated by a comma).
|
7206
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7207
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7208
|
+
cursor: 'cursor_example', # String | A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
7209
|
+
period: 'period_example', # String | Filter results by time period. Choose between the available relative time frames.
|
7210
|
+
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.
|
7211
|
+
application_id: 3.4, # Float | Filter results by Application ID.
|
7212
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
7213
|
+
loyalty_program_id: 56, # Integer | Identifier of the loyalty program.
|
7214
|
+
response_code: 56, # Integer | Filter results by response status code.
|
7215
|
+
webhook_i_ds: 'webhook_i_ds_example' # String | Filter results by webhook ID (include up to 30 values, separated by a comma).
|
7216
|
+
}
|
7217
|
+
|
7218
|
+
begin
|
7219
|
+
#List message log entries
|
7220
|
+
result = api_instance.get_message_logs(entity_type, opts)
|
7221
|
+
p result
|
7222
|
+
rescue TalonOne::ApiError => e
|
7223
|
+
puts "Exception when calling ManagementApi->get_message_logs: #{e}"
|
7224
|
+
end
|
7225
|
+
```
|
7226
|
+
|
7227
|
+
### Parameters
|
7228
|
+
|
7229
|
+
|
7230
|
+
Name | Type | Description | Notes
|
7231
|
+
------------- | ------------- | ------------- | -------------
|
7232
|
+
**entity_type** | **String**| The entity type the log is related to. |
|
7233
|
+
**message_id** | **String**| Filter results by message ID. | [optional]
|
7234
|
+
**change_type** | **String**| Filter results by change type. | [optional]
|
7235
|
+
**notification_i_ds** | **String**| Filter results by notification ID (include up to 30 values, separated by a comma). | [optional]
|
7236
|
+
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7237
|
+
**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]
|
7238
|
+
**cursor** | **String**| A specific unique value in the database. If this value is not given, the server fetches results starting with the first record. | [optional]
|
7239
|
+
**period** | **String**| Filter results by time period. Choose between the available relative time frames. | [optional]
|
7240
|
+
**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]
|
7241
|
+
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
7242
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
7243
|
+
**loyalty_program_id** | **Integer**| Identifier of the loyalty program. | [optional]
|
7244
|
+
**response_code** | **Integer**| Filter results by response status code. | [optional]
|
7245
|
+
**webhook_i_ds** | **String**| Filter results by webhook ID (include up to 30 values, separated by a comma). | [optional]
|
7246
|
+
|
7247
|
+
### Return type
|
7248
|
+
|
7249
|
+
[**MessageLogEntries**](MessageLogEntries.md)
|
7250
|
+
|
7251
|
+
### Authorization
|
7252
|
+
|
7253
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
7254
|
+
|
7255
|
+
### HTTP request headers
|
7256
|
+
|
7257
|
+
- **Content-Type**: Not defined
|
7258
|
+
- **Accept**: application/json
|
7259
|
+
|
7260
|
+
|
6966
7261
|
## get_referrals_without_total_count
|
6967
7262
|
|
6968
7263
|
> InlineResponse20012 get_referrals_without_total_count(application_id, campaign_id, opts)
|
@@ -6995,7 +7290,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
6995
7290
|
opts = {
|
6996
7291
|
page_size: 1000, # Integer | The number of items in the response.
|
6997
7292
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6998
|
-
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:**
|
7293
|
+
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.
|
6999
7294
|
code: 'code_example', # String | Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
7000
7295
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
7001
7296
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -7022,7 +7317,7 @@ Name | Type | Description | Notes
|
|
7022
7317
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
7023
7318
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7024
7319
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7025
|
-
**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:**
|
7320
|
+
**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]
|
7026
7321
|
**code** | **String**| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
7027
7322
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7028
7323
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -7198,7 +7493,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
7198
7493
|
opts = {
|
7199
7494
|
page_size: 1000, # Integer | The number of items in the response.
|
7200
7495
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7201
|
-
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:**
|
7496
|
+
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.
|
7202
7497
|
}
|
7203
7498
|
|
7204
7499
|
begin
|
@@ -7219,7 +7514,7 @@ Name | Type | Description | Notes
|
|
7219
7514
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
7220
7515
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7221
7516
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7222
|
-
**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:**
|
7517
|
+
**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]
|
7223
7518
|
|
7224
7519
|
### Return type
|
7225
7520
|
|
@@ -7385,7 +7680,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7385
7680
|
opts = {
|
7386
7681
|
page_size: 1000, # Integer | The number of items in the response.
|
7387
7682
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7388
|
-
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:**
|
7683
|
+
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.
|
7389
7684
|
}
|
7390
7685
|
|
7391
7686
|
begin
|
@@ -7404,7 +7699,7 @@ Name | Type | Description | Notes
|
|
7404
7699
|
------------- | ------------- | ------------- | -------------
|
7405
7700
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7406
7701
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7407
|
-
**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:**
|
7702
|
+
**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]
|
7408
7703
|
|
7409
7704
|
### Return type
|
7410
7705
|
|
@@ -7509,7 +7804,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7509
7804
|
opts = {
|
7510
7805
|
page_size: 1000, # Integer | The number of items in the response.
|
7511
7806
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7512
|
-
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:**
|
7807
|
+
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7513
7808
|
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
7514
7809
|
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7515
7810
|
application_id: 3.4, # Float | Filter results by Application ID.
|
@@ -7534,7 +7829,7 @@ Name | Type | Description | Notes
|
|
7534
7829
|
------------- | ------------- | ------------- | -------------
|
7535
7830
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7536
7831
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7537
|
-
**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:**
|
7832
|
+
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
|
7538
7833
|
**integration_request_uuid** | **String**| Filter results by integration request UUID. | [optional]
|
7539
7834
|
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7540
7835
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
@@ -7586,7 +7881,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7586
7881
|
opts = {
|
7587
7882
|
page_size: 1000, # Integer | The number of items in the response.
|
7588
7883
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7589
|
-
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:**
|
7884
|
+
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7590
7885
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
7591
7886
|
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7592
7887
|
application_id: 3.4, # Float | Filter results by Application ID.
|
@@ -7612,7 +7907,7 @@ Name | Type | Description | Notes
|
|
7612
7907
|
------------- | ------------- | ------------- | -------------
|
7613
7908
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7614
7909
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7615
|
-
**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:**
|
7910
|
+
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
|
7616
7911
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
7617
7912
|
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7618
7913
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
@@ -7664,7 +7959,7 @@ end
|
|
7664
7959
|
api_instance = TalonOne::ManagementApi.new
|
7665
7960
|
opts = {
|
7666
7961
|
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.
|
7667
|
-
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:**
|
7962
|
+
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.
|
7668
7963
|
page_size: 1000, # Integer | The number of items in the response.
|
7669
7964
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7670
7965
|
creation_type: 'creation_type_example', # String | Filter results by creation type.
|
@@ -7688,7 +7983,7 @@ end
|
|
7688
7983
|
Name | Type | Description | Notes
|
7689
7984
|
------------- | ------------- | ------------- | -------------
|
7690
7985
|
**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]
|
7691
|
-
**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:**
|
7986
|
+
**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]
|
7692
7987
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7693
7988
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7694
7989
|
**creation_type** | **String**| Filter results by creation type. | [optional]
|
@@ -7899,13 +8194,13 @@ Name | Type | Description | Notes
|
|
7899
8194
|
- **Accept**: application/json
|
7900
8195
|
|
7901
8196
|
|
7902
|
-
##
|
8197
|
+
## import_campaign_store_budget
|
7903
8198
|
|
7904
|
-
> Import
|
8199
|
+
> Import import_campaign_store_budget(application_id, campaign_id, opts)
|
7905
8200
|
|
7906
|
-
Import
|
8201
|
+
Import campaign store budgets
|
7907
8202
|
|
7908
|
-
Upload a CSV file containing
|
8203
|
+
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.
|
7909
8204
|
|
7910
8205
|
### Example
|
7911
8206
|
|
@@ -7929,15 +8224,17 @@ api_instance = TalonOne::ManagementApi.new
|
|
7929
8224
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
7930
8225
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
7931
8226
|
opts = {
|
8227
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
8228
|
+
period: 'period_example', # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
7932
8229
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
7933
8230
|
}
|
7934
8231
|
|
7935
8232
|
begin
|
7936
|
-
#Import
|
7937
|
-
result = api_instance.
|
8233
|
+
#Import campaign store budgets
|
8234
|
+
result = api_instance.import_campaign_store_budget(application_id, campaign_id, opts)
|
7938
8235
|
p result
|
7939
8236
|
rescue TalonOne::ApiError => e
|
7940
|
-
puts "Exception when calling ManagementApi->
|
8237
|
+
puts "Exception when calling ManagementApi->import_campaign_store_budget: #{e}"
|
7941
8238
|
end
|
7942
8239
|
```
|
7943
8240
|
|
@@ -7948,6 +8245,8 @@ Name | Type | Description | Notes
|
|
7948
8245
|
------------- | ------------- | ------------- | -------------
|
7949
8246
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
7950
8247
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8248
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
8249
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
7951
8250
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
7952
8251
|
|
7953
8252
|
### Return type
|
@@ -7964,13 +8263,13 @@ Name | Type | Description | Notes
|
|
7964
8263
|
- **Accept**: application/json
|
7965
8264
|
|
7966
8265
|
|
7967
|
-
##
|
8266
|
+
## import_campaign_stores
|
7968
8267
|
|
7969
|
-
> Import
|
8268
|
+
> Import import_campaign_stores(application_id, campaign_id, opts)
|
7970
8269
|
|
7971
|
-
Import
|
8270
|
+
Import stores
|
7972
8271
|
|
7973
|
-
Upload a CSV file containing the
|
8272
|
+
Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
7974
8273
|
|
7975
8274
|
### Example
|
7976
8275
|
|
@@ -7993,17 +8292,16 @@ end
|
|
7993
8292
|
api_instance = TalonOne::ManagementApi.new
|
7994
8293
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
7995
8294
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
7996
|
-
collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
7997
8295
|
opts = {
|
7998
8296
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
7999
8297
|
}
|
8000
8298
|
|
8001
8299
|
begin
|
8002
|
-
#Import
|
8003
|
-
result = api_instance.
|
8300
|
+
#Import stores
|
8301
|
+
result = api_instance.import_campaign_stores(application_id, campaign_id, opts)
|
8004
8302
|
p result
|
8005
8303
|
rescue TalonOne::ApiError => e
|
8006
|
-
puts "Exception when calling ManagementApi->
|
8304
|
+
puts "Exception when calling ManagementApi->import_campaign_stores: #{e}"
|
8007
8305
|
end
|
8008
8306
|
```
|
8009
8307
|
|
@@ -8014,7 +8312,6 @@ Name | Type | Description | Notes
|
|
8014
8312
|
------------- | ------------- | ------------- | -------------
|
8015
8313
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8016
8314
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8017
|
-
**collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
|
8018
8315
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
8019
8316
|
|
8020
8317
|
### Return type
|
@@ -8031,13 +8328,13 @@ Name | Type | Description | Notes
|
|
8031
8328
|
- **Accept**: application/json
|
8032
8329
|
|
8033
8330
|
|
8034
|
-
##
|
8331
|
+
## import_collection
|
8035
8332
|
|
8036
|
-
> Import
|
8333
|
+
> Import import_collection(application_id, campaign_id, collection_id, opts)
|
8037
8334
|
|
8038
|
-
Import
|
8335
|
+
Import data into existing campaign-level collection
|
8039
8336
|
|
8040
|
-
Upload a CSV file containing the
|
8337
|
+
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.
|
8041
8338
|
|
8042
8339
|
### Example
|
8043
8340
|
|
@@ -8060,8 +8357,75 @@ end
|
|
8060
8357
|
api_instance = TalonOne::ManagementApi.new
|
8061
8358
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
8062
8359
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8360
|
+
collection_id = 56 # Integer | The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint.
|
8063
8361
|
opts = {
|
8064
|
-
|
8362
|
+
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
8363
|
+
}
|
8364
|
+
|
8365
|
+
begin
|
8366
|
+
#Import data into existing campaign-level collection
|
8367
|
+
result = api_instance.import_collection(application_id, campaign_id, collection_id, opts)
|
8368
|
+
p result
|
8369
|
+
rescue TalonOne::ApiError => e
|
8370
|
+
puts "Exception when calling ManagementApi->import_collection: #{e}"
|
8371
|
+
end
|
8372
|
+
```
|
8373
|
+
|
8374
|
+
### Parameters
|
8375
|
+
|
8376
|
+
|
8377
|
+
Name | Type | Description | Notes
|
8378
|
+
------------- | ------------- | ------------- | -------------
|
8379
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8380
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8381
|
+
**collection_id** | **Integer**| The ID of the collection. You can get it with the [List collections in Application](#operation/listCollectionsInApplication) endpoint. |
|
8382
|
+
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
8383
|
+
|
8384
|
+
### Return type
|
8385
|
+
|
8386
|
+
[**Import**](Import.md)
|
8387
|
+
|
8388
|
+
### Authorization
|
8389
|
+
|
8390
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
8391
|
+
|
8392
|
+
### HTTP request headers
|
8393
|
+
|
8394
|
+
- **Content-Type**: multipart/form-data
|
8395
|
+
- **Accept**: application/json
|
8396
|
+
|
8397
|
+
|
8398
|
+
## import_coupons
|
8399
|
+
|
8400
|
+
> Import import_coupons(application_id, campaign_id, opts)
|
8401
|
+
|
8402
|
+
Import coupons
|
8403
|
+
|
8404
|
+
Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - `value` (required): The coupon code. - `expirydate`: The end date in RFC3339 of the code redemption period. - `startdate`: The start date in RFC3339 of the code redemption period. - `recipientintegrationid`: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - `limitval`: The maximum number of redemptions of this code. For unlimited redemptions, use `0`. Defaults to `1` when not provided. - `discountlimit`: The total discount value that the code can give. This is typically used to represent a gift card value. - `attributes`: A JSON object describing _custom_ coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a [custom attribute](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes) called `category` associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: `\"{\"category\": \"10_off\"}\"`. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** We recommend limiting your file size to 500MB. **Example:** ```text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 ``` Once imported, you can find the `batchId` in the Campaign Manager or by using [List coupons](#tag/Coupons/operation/getCouponsWithoutTotalCount).
|
8405
|
+
|
8406
|
+
### Example
|
8407
|
+
|
8408
|
+
```ruby
|
8409
|
+
# load the gem
|
8410
|
+
require 'talon_one'
|
8411
|
+
# setup authorization
|
8412
|
+
TalonOne.configure do |config|
|
8413
|
+
# Configure API key authorization: management_key
|
8414
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8415
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8416
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8417
|
+
|
8418
|
+
# Configure API key authorization: manager_auth
|
8419
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
8420
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8421
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8422
|
+
end
|
8423
|
+
|
8424
|
+
api_instance = TalonOne::ManagementApi.new
|
8425
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
8426
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
8427
|
+
opts = {
|
8428
|
+
skip_duplicates: true, # Boolean | An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`.
|
8065
8429
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
8066
8430
|
}
|
8067
8431
|
|
@@ -8253,6 +8617,7 @@ end
|
|
8253
8617
|
api_instance = TalonOne::ManagementApi.new
|
8254
8618
|
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.
|
8255
8619
|
opts = {
|
8620
|
+
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`.
|
8256
8621
|
up_file: 'up_file_example' # String | The file containing the data that is being imported.
|
8257
8622
|
}
|
8258
8623
|
|
@@ -8271,6 +8636,7 @@ end
|
|
8271
8636
|
Name | Type | Description | Notes
|
8272
8637
|
------------- | ------------- | ------------- | -------------
|
8273
8638
|
**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. |
|
8639
|
+
**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]
|
8274
8640
|
**up_file** | **String**| The file containing the data that is being imported. | [optional]
|
8275
8641
|
|
8276
8642
|
### Return type
|
@@ -8503,7 +8869,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
8503
8869
|
opts = {
|
8504
8870
|
page_size: 1000, # Integer | The number of items in the response.
|
8505
8871
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8506
|
-
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:**
|
8872
|
+
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.
|
8507
8873
|
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8508
8874
|
name: 'name_example' # String | Filter by collection name.
|
8509
8875
|
}
|
@@ -8524,7 +8890,7 @@ Name | Type | Description | Notes
|
|
8524
8890
|
------------- | ------------- | ------------- | -------------
|
8525
8891
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8526
8892
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8527
|
-
**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:**
|
8893
|
+
**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]
|
8528
8894
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
8529
8895
|
**name** | **String**| Filter by collection name. | [optional]
|
8530
8896
|
|
@@ -8544,7 +8910,7 @@ Name | Type | Description | Notes
|
|
8544
8910
|
|
8545
8911
|
## list_achievements
|
8546
8912
|
|
8547
|
-
>
|
8913
|
+
> InlineResponse20050 list_achievements(application_id, campaign_id, opts)
|
8548
8914
|
|
8549
8915
|
List achievements
|
8550
8916
|
|
@@ -8599,7 +8965,7 @@ Name | Type | Description | Notes
|
|
8599
8965
|
|
8600
8966
|
### Return type
|
8601
8967
|
|
8602
|
-
[**
|
8968
|
+
[**InlineResponse20050**](InlineResponse20050.md)
|
8603
8969
|
|
8604
8970
|
### Authorization
|
8605
8971
|
|
@@ -8666,6 +9032,73 @@ This endpoint does not need any parameter.
|
|
8666
9032
|
- **Accept**: application/json
|
8667
9033
|
|
8668
9034
|
|
9035
|
+
## list_campaign_store_budget_limits
|
9036
|
+
|
9037
|
+
> InlineResponse20048 list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
9038
|
+
|
9039
|
+
List campaign store budget limits
|
9040
|
+
|
9041
|
+
Return the store budget limits for a given campaign.
|
9042
|
+
|
9043
|
+
### Example
|
9044
|
+
|
9045
|
+
```ruby
|
9046
|
+
# load the gem
|
9047
|
+
require 'talon_one'
|
9048
|
+
# setup authorization
|
9049
|
+
TalonOne.configure do |config|
|
9050
|
+
# Configure API key authorization: management_key
|
9051
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9052
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9053
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9054
|
+
|
9055
|
+
# Configure API key authorization: manager_auth
|
9056
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
9057
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9058
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9059
|
+
end
|
9060
|
+
|
9061
|
+
api_instance = TalonOne::ManagementApi.new
|
9062
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
9063
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
9064
|
+
opts = {
|
9065
|
+
action: 'action_example', # String | The action that this budget is limiting.
|
9066
|
+
period: 'period_example' # String | The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
9067
|
+
}
|
9068
|
+
|
9069
|
+
begin
|
9070
|
+
#List campaign store budget limits
|
9071
|
+
result = api_instance.list_campaign_store_budget_limits(application_id, campaign_id, opts)
|
9072
|
+
p result
|
9073
|
+
rescue TalonOne::ApiError => e
|
9074
|
+
puts "Exception when calling ManagementApi->list_campaign_store_budget_limits: #{e}"
|
9075
|
+
end
|
9076
|
+
```
|
9077
|
+
|
9078
|
+
### Parameters
|
9079
|
+
|
9080
|
+
|
9081
|
+
Name | Type | Description | Notes
|
9082
|
+
------------- | ------------- | ------------- | -------------
|
9083
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
9084
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
9085
|
+
**action** | **String**| The action that this budget is limiting. | [optional]
|
9086
|
+
**period** | **String**| The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`. | [optional]
|
9087
|
+
|
9088
|
+
### Return type
|
9089
|
+
|
9090
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
9091
|
+
|
9092
|
+
### Authorization
|
9093
|
+
|
9094
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9095
|
+
|
9096
|
+
### HTTP request headers
|
9097
|
+
|
9098
|
+
- **Content-Type**: Not defined
|
9099
|
+
- **Accept**: application/json
|
9100
|
+
|
9101
|
+
|
8669
9102
|
## list_catalog_items
|
8670
9103
|
|
8671
9104
|
> InlineResponse20037 list_catalog_items(catalog_id, opts)
|
@@ -8769,7 +9202,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
8769
9202
|
opts = {
|
8770
9203
|
page_size: 1000, # Integer | The number of items in the response.
|
8771
9204
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8772
|
-
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:**
|
9205
|
+
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.
|
8773
9206
|
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8774
9207
|
name: 'name_example' # String | Filter by collection name.
|
8775
9208
|
}
|
@@ -8792,7 +9225,7 @@ Name | Type | Description | Notes
|
|
8792
9225
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8793
9226
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8794
9227
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8795
|
-
**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:**
|
9228
|
+
**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]
|
8796
9229
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
8797
9230
|
**name** | **String**| Filter by collection name. | [optional]
|
8798
9231
|
|
@@ -8841,7 +9274,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
8841
9274
|
opts = {
|
8842
9275
|
page_size: 1000, # Integer | The number of items in the response.
|
8843
9276
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8844
|
-
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:**
|
9277
|
+
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.
|
8845
9278
|
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8846
9279
|
name: 'name_example' # String | Filter by collection name.
|
8847
9280
|
}
|
@@ -8863,7 +9296,7 @@ Name | Type | Description | Notes
|
|
8863
9296
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8864
9297
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8865
9298
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8866
|
-
**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:**
|
9299
|
+
**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]
|
8867
9300
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
8868
9301
|
**name** | **String**| Filter by collection name. | [optional]
|
8869
9302
|
|
@@ -8912,7 +9345,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
8912
9345
|
opts = {
|
8913
9346
|
page_size: 1000, # Integer | The number of items in the response.
|
8914
9347
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8915
|
-
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:**
|
9348
|
+
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.
|
8916
9349
|
with_total_result_size: true, # Boolean | When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
8917
9350
|
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
8918
9351
|
name: 'name_example', # String | The name of the store.
|
@@ -8937,7 +9370,7 @@ Name | Type | Description | Notes
|
|
8937
9370
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8938
9371
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8939
9372
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8940
|
-
**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:**
|
9373
|
+
**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]
|
8941
9374
|
**with_total_result_size** | **Boolean**| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | [optional]
|
8942
9375
|
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
8943
9376
|
**name** | **String**| The name of the store. | [optional]
|
@@ -8958,13 +9391,13 @@ Name | Type | Description | Notes
|
|
8958
9391
|
- **Accept**: application/json
|
8959
9392
|
|
8960
9393
|
|
8961
|
-
##
|
9394
|
+
## okta_event_handler_challenge
|
8962
9395
|
|
8963
|
-
>
|
9396
|
+
> okta_event_handler_challenge
|
8964
9397
|
|
8965
|
-
|
9398
|
+
Validate Okta API ownership
|
8966
9399
|
|
8967
|
-
|
9400
|
+
Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
8968
9401
|
|
8969
9402
|
### Example
|
8970
9403
|
|
@@ -8985,24 +9418,18 @@ TalonOne.configure do |config|
|
|
8985
9418
|
end
|
8986
9419
|
|
8987
9420
|
api_instance = TalonOne::ManagementApi.new
|
8988
|
-
notification_id = 56 # Integer | The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
8989
|
-
body = TalonOne::NotificationActivation.new # NotificationActivation | body
|
8990
9421
|
|
8991
9422
|
begin
|
8992
|
-
#
|
8993
|
-
api_instance.
|
9423
|
+
#Validate Okta API ownership
|
9424
|
+
api_instance.okta_event_handler_challenge
|
8994
9425
|
rescue TalonOne::ApiError => e
|
8995
|
-
puts "Exception when calling ManagementApi->
|
9426
|
+
puts "Exception when calling ManagementApi->okta_event_handler_challenge: #{e}"
|
8996
9427
|
end
|
8997
9428
|
```
|
8998
9429
|
|
8999
9430
|
### Parameters
|
9000
9431
|
|
9001
|
-
|
9002
|
-
Name | Type | Description | Notes
|
9003
|
-
------------- | ------------- | ------------- | -------------
|
9004
|
-
**notification_id** | **Integer**| The ID of the notification. Get it with the appropriate _List notifications_ endpoint. |
|
9005
|
-
**body** | [**NotificationActivation**](NotificationActivation.md)| body |
|
9432
|
+
This endpoint does not need any parameter.
|
9006
9433
|
|
9007
9434
|
### Return type
|
9008
9435
|
|
@@ -9014,17 +9441,17 @@ nil (empty response body)
|
|
9014
9441
|
|
9015
9442
|
### HTTP request headers
|
9016
9443
|
|
9017
|
-
- **Content-Type**:
|
9444
|
+
- **Content-Type**: Not defined
|
9018
9445
|
- **Accept**: Not defined
|
9019
9446
|
|
9020
9447
|
|
9021
|
-
##
|
9448
|
+
## remove_loyalty_points
|
9022
9449
|
|
9023
|
-
>
|
9450
|
+
> remove_loyalty_points(loyalty_program_id, integration_id, body)
|
9024
9451
|
|
9025
|
-
|
9452
|
+
Deduct points from customer profile
|
9026
9453
|
|
9027
|
-
|
9454
|
+
Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
9028
9455
|
|
9029
9456
|
### Example
|
9030
9457
|
|
@@ -9045,18 +9472,26 @@ TalonOne.configure do |config|
|
|
9045
9472
|
end
|
9046
9473
|
|
9047
9474
|
api_instance = TalonOne::ManagementApi.new
|
9475
|
+
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
9476
|
+
integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
9477
|
+
body = TalonOne::DeductLoyaltyPoints.new # DeductLoyaltyPoints | body
|
9048
9478
|
|
9049
9479
|
begin
|
9050
|
-
#
|
9051
|
-
api_instance.
|
9480
|
+
#Deduct points from customer profile
|
9481
|
+
api_instance.remove_loyalty_points(loyalty_program_id, integration_id, body)
|
9052
9482
|
rescue TalonOne::ApiError => e
|
9053
|
-
puts "Exception when calling ManagementApi->
|
9483
|
+
puts "Exception when calling ManagementApi->remove_loyalty_points: #{e}"
|
9054
9484
|
end
|
9055
9485
|
```
|
9056
9486
|
|
9057
9487
|
### Parameters
|
9058
9488
|
|
9059
|
-
|
9489
|
+
|
9490
|
+
Name | Type | Description | Notes
|
9491
|
+
------------- | ------------- | ------------- | -------------
|
9492
|
+
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
9493
|
+
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
9494
|
+
**body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
|
9060
9495
|
|
9061
9496
|
### Return type
|
9062
9497
|
|
@@ -9068,17 +9503,17 @@ nil (empty response body)
|
|
9068
9503
|
|
9069
9504
|
### HTTP request headers
|
9070
9505
|
|
9071
|
-
- **Content-Type**:
|
9072
|
-
- **Accept**:
|
9506
|
+
- **Content-Type**: application/json
|
9507
|
+
- **Accept**: application/json
|
9073
9508
|
|
9074
9509
|
|
9075
|
-
##
|
9510
|
+
## reset_password
|
9076
9511
|
|
9077
|
-
>
|
9512
|
+
> NewPassword reset_password(body)
|
9078
9513
|
|
9079
|
-
|
9514
|
+
Reset password
|
9080
9515
|
|
9081
|
-
|
9516
|
+
Consumes the supplied password reset token and updates the password for the associated account.
|
9082
9517
|
|
9083
9518
|
### Example
|
9084
9519
|
|
@@ -9099,15 +9534,14 @@ TalonOne.configure do |config|
|
|
9099
9534
|
end
|
9100
9535
|
|
9101
9536
|
api_instance = TalonOne::ManagementApi.new
|
9102
|
-
|
9103
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9537
|
+
body = TalonOne::NewPassword.new # NewPassword | body
|
9104
9538
|
|
9105
9539
|
begin
|
9106
|
-
#
|
9107
|
-
result = api_instance.
|
9540
|
+
#Reset password
|
9541
|
+
result = api_instance.reset_password(body)
|
9108
9542
|
p result
|
9109
9543
|
rescue TalonOne::ApiError => e
|
9110
|
-
puts "Exception when calling ManagementApi->
|
9544
|
+
puts "Exception when calling ManagementApi->reset_password: #{e}"
|
9111
9545
|
end
|
9112
9546
|
```
|
9113
9547
|
|
@@ -9116,12 +9550,11 @@ end
|
|
9116
9550
|
|
9117
9551
|
Name | Type | Description | Notes
|
9118
9552
|
------------- | ------------- | ------------- | -------------
|
9119
|
-
**
|
9120
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9553
|
+
**body** | [**NewPassword**](NewPassword.md)| body |
|
9121
9554
|
|
9122
9555
|
### Return type
|
9123
9556
|
|
9124
|
-
[**
|
9557
|
+
[**NewPassword**](NewPassword.md)
|
9125
9558
|
|
9126
9559
|
### Authorization
|
9127
9560
|
|
@@ -9133,13 +9566,13 @@ Name | Type | Description | Notes
|
|
9133
9566
|
- **Accept**: application/json
|
9134
9567
|
|
9135
9568
|
|
9136
|
-
##
|
9569
|
+
## scim_create_group
|
9137
9570
|
|
9138
|
-
>
|
9571
|
+
> ScimGroup scim_create_group(body)
|
9139
9572
|
|
9140
|
-
Create
|
9573
|
+
Create SCIM group
|
9141
9574
|
|
9142
|
-
Create a
|
9575
|
+
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.
|
9143
9576
|
|
9144
9577
|
### Example
|
9145
9578
|
|
@@ -9160,15 +9593,14 @@ TalonOne.configure do |config|
|
|
9160
9593
|
end
|
9161
9594
|
|
9162
9595
|
api_instance = TalonOne::ManagementApi.new
|
9163
|
-
|
9164
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9596
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
9165
9597
|
|
9166
9598
|
begin
|
9167
|
-
#Create
|
9168
|
-
result = api_instance.
|
9599
|
+
#Create SCIM group
|
9600
|
+
result = api_instance.scim_create_group(body)
|
9169
9601
|
p result
|
9170
9602
|
rescue TalonOne::ApiError => e
|
9171
|
-
puts "Exception when calling ManagementApi->
|
9603
|
+
puts "Exception when calling ManagementApi->scim_create_group: #{e}"
|
9172
9604
|
end
|
9173
9605
|
```
|
9174
9606
|
|
@@ -9177,12 +9609,11 @@ end
|
|
9177
9609
|
|
9178
9610
|
Name | Type | Description | Notes
|
9179
9611
|
------------- | ------------- | ------------- | -------------
|
9180
|
-
**
|
9181
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9612
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
9182
9613
|
|
9183
9614
|
### Return type
|
9184
9615
|
|
9185
|
-
[**
|
9616
|
+
[**ScimGroup**](ScimGroup.md)
|
9186
9617
|
|
9187
9618
|
### Authorization
|
9188
9619
|
|
@@ -9194,13 +9625,13 @@ Name | Type | Description | Notes
|
|
9194
9625
|
- **Accept**: application/json
|
9195
9626
|
|
9196
9627
|
|
9197
|
-
##
|
9628
|
+
## scim_create_user
|
9198
9629
|
|
9199
|
-
>
|
9630
|
+
> ScimUser scim_create_user(body)
|
9200
9631
|
|
9201
|
-
Create
|
9632
|
+
Create SCIM user
|
9202
9633
|
|
9203
|
-
Create a
|
9634
|
+
Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
9204
9635
|
|
9205
9636
|
### Example
|
9206
9637
|
|
@@ -9221,15 +9652,14 @@ TalonOne.configure do |config|
|
|
9221
9652
|
end
|
9222
9653
|
|
9223
9654
|
api_instance = TalonOne::ManagementApi.new
|
9224
|
-
|
9225
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9655
|
+
body = TalonOne::ScimNewUser.new # ScimNewUser | body
|
9226
9656
|
|
9227
9657
|
begin
|
9228
|
-
#Create
|
9229
|
-
result = api_instance.
|
9658
|
+
#Create SCIM user
|
9659
|
+
result = api_instance.scim_create_user(body)
|
9230
9660
|
p result
|
9231
9661
|
rescue TalonOne::ApiError => e
|
9232
|
-
puts "Exception when calling ManagementApi->
|
9662
|
+
puts "Exception when calling ManagementApi->scim_create_user: #{e}"
|
9233
9663
|
end
|
9234
9664
|
```
|
9235
9665
|
|
@@ -9238,12 +9668,11 @@ end
|
|
9238
9668
|
|
9239
9669
|
Name | Type | Description | Notes
|
9240
9670
|
------------- | ------------- | ------------- | -------------
|
9241
|
-
**
|
9242
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9671
|
+
**body** | [**ScimNewUser**](ScimNewUser.md)| body |
|
9243
9672
|
|
9244
9673
|
### Return type
|
9245
9674
|
|
9246
|
-
[**
|
9675
|
+
[**ScimUser**](ScimUser.md)
|
9247
9676
|
|
9248
9677
|
### Authorization
|
9249
9678
|
|
@@ -9255,13 +9684,13 @@ Name | Type | Description | Notes
|
|
9255
9684
|
- **Accept**: application/json
|
9256
9685
|
|
9257
9686
|
|
9258
|
-
##
|
9687
|
+
## scim_delete_group
|
9259
9688
|
|
9260
|
-
>
|
9689
|
+
> scim_delete_group(group_id)
|
9261
9690
|
|
9262
|
-
|
9691
|
+
Delete SCIM group
|
9263
9692
|
|
9264
|
-
|
9693
|
+
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.
|
9265
9694
|
|
9266
9695
|
### Example
|
9267
9696
|
|
@@ -9282,15 +9711,13 @@ TalonOne.configure do |config|
|
|
9282
9711
|
end
|
9283
9712
|
|
9284
9713
|
api_instance = TalonOne::ManagementApi.new
|
9285
|
-
|
9286
|
-
integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
9287
|
-
body = TalonOne::DeductLoyaltyPoints.new # DeductLoyaltyPoints | body
|
9714
|
+
group_id = 56 # Integer | The ID of the group.
|
9288
9715
|
|
9289
9716
|
begin
|
9290
|
-
#
|
9291
|
-
api_instance.
|
9717
|
+
#Delete SCIM group
|
9718
|
+
api_instance.scim_delete_group(group_id)
|
9292
9719
|
rescue TalonOne::ApiError => e
|
9293
|
-
puts "Exception when calling ManagementApi->
|
9720
|
+
puts "Exception when calling ManagementApi->scim_delete_group: #{e}"
|
9294
9721
|
end
|
9295
9722
|
```
|
9296
9723
|
|
@@ -9299,9 +9726,7 @@ end
|
|
9299
9726
|
|
9300
9727
|
Name | Type | Description | Notes
|
9301
9728
|
------------- | ------------- | ------------- | -------------
|
9302
|
-
**
|
9303
|
-
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
9304
|
-
**body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
|
9729
|
+
**group_id** | **Integer**| The ID of the group. |
|
9305
9730
|
|
9306
9731
|
### Return type
|
9307
9732
|
|
@@ -9313,17 +9738,17 @@ nil (empty response body)
|
|
9313
9738
|
|
9314
9739
|
### HTTP request headers
|
9315
9740
|
|
9316
|
-
- **Content-Type**:
|
9317
|
-
- **Accept**:
|
9741
|
+
- **Content-Type**: Not defined
|
9742
|
+
- **Accept**: Not defined
|
9318
9743
|
|
9319
9744
|
|
9320
|
-
##
|
9745
|
+
## scim_delete_user
|
9321
9746
|
|
9322
|
-
>
|
9747
|
+
> scim_delete_user(user_id)
|
9323
9748
|
|
9324
|
-
|
9749
|
+
Delete SCIM user
|
9325
9750
|
|
9326
|
-
|
9751
|
+
Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
9327
9752
|
|
9328
9753
|
### Example
|
9329
9754
|
|
@@ -9344,14 +9769,13 @@ TalonOne.configure do |config|
|
|
9344
9769
|
end
|
9345
9770
|
|
9346
9771
|
api_instance = TalonOne::ManagementApi.new
|
9347
|
-
|
9772
|
+
user_id = 56 # Integer | The ID of the user.
|
9348
9773
|
|
9349
9774
|
begin
|
9350
|
-
#
|
9351
|
-
|
9352
|
-
p result
|
9775
|
+
#Delete SCIM user
|
9776
|
+
api_instance.scim_delete_user(user_id)
|
9353
9777
|
rescue TalonOne::ApiError => e
|
9354
|
-
puts "Exception when calling ManagementApi->
|
9778
|
+
puts "Exception when calling ManagementApi->scim_delete_user: #{e}"
|
9355
9779
|
end
|
9356
9780
|
```
|
9357
9781
|
|
@@ -9360,11 +9784,11 @@ end
|
|
9360
9784
|
|
9361
9785
|
Name | Type | Description | Notes
|
9362
9786
|
------------- | ------------- | ------------- | -------------
|
9363
|
-
**
|
9787
|
+
**user_id** | **Integer**| The ID of the user. |
|
9364
9788
|
|
9365
9789
|
### Return type
|
9366
9790
|
|
9367
|
-
|
9791
|
+
nil (empty response body)
|
9368
9792
|
|
9369
9793
|
### Authorization
|
9370
9794
|
|
@@ -9372,17 +9796,17 @@ Name | Type | Description | Notes
|
|
9372
9796
|
|
9373
9797
|
### HTTP request headers
|
9374
9798
|
|
9375
|
-
- **Content-Type**:
|
9376
|
-
- **Accept**:
|
9799
|
+
- **Content-Type**: Not defined
|
9800
|
+
- **Accept**: Not defined
|
9377
9801
|
|
9378
9802
|
|
9379
|
-
##
|
9803
|
+
## scim_get_group
|
9380
9804
|
|
9381
|
-
>
|
9805
|
+
> ScimGroup scim_get_group(group_id)
|
9382
9806
|
|
9383
|
-
|
9807
|
+
Get SCIM group
|
9384
9808
|
|
9385
|
-
|
9809
|
+
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.
|
9386
9810
|
|
9387
9811
|
### Example
|
9388
9812
|
|
@@ -9403,14 +9827,14 @@ TalonOne.configure do |config|
|
|
9403
9827
|
end
|
9404
9828
|
|
9405
9829
|
api_instance = TalonOne::ManagementApi.new
|
9406
|
-
|
9830
|
+
group_id = 56 # Integer | The ID of the group.
|
9407
9831
|
|
9408
9832
|
begin
|
9409
|
-
#
|
9410
|
-
result = api_instance.
|
9833
|
+
#Get SCIM group
|
9834
|
+
result = api_instance.scim_get_group(group_id)
|
9411
9835
|
p result
|
9412
9836
|
rescue TalonOne::ApiError => e
|
9413
|
-
puts "Exception when calling ManagementApi->
|
9837
|
+
puts "Exception when calling ManagementApi->scim_get_group: #{e}"
|
9414
9838
|
end
|
9415
9839
|
```
|
9416
9840
|
|
@@ -9419,11 +9843,11 @@ end
|
|
9419
9843
|
|
9420
9844
|
Name | Type | Description | Notes
|
9421
9845
|
------------- | ------------- | ------------- | -------------
|
9422
|
-
**
|
9846
|
+
**group_id** | **Integer**| The ID of the group. |
|
9423
9847
|
|
9424
9848
|
### Return type
|
9425
9849
|
|
9426
|
-
[**
|
9850
|
+
[**ScimGroup**](ScimGroup.md)
|
9427
9851
|
|
9428
9852
|
### Authorization
|
9429
9853
|
|
@@ -9431,17 +9855,17 @@ Name | Type | Description | Notes
|
|
9431
9855
|
|
9432
9856
|
### HTTP request headers
|
9433
9857
|
|
9434
|
-
- **Content-Type**:
|
9858
|
+
- **Content-Type**: Not defined
|
9435
9859
|
- **Accept**: application/json
|
9436
9860
|
|
9437
9861
|
|
9438
|
-
##
|
9862
|
+
## scim_get_groups
|
9439
9863
|
|
9440
|
-
>
|
9864
|
+
> ScimGroupsListResponse scim_get_groups
|
9441
9865
|
|
9442
|
-
|
9866
|
+
List SCIM groups
|
9443
9867
|
|
9444
|
-
|
9868
|
+
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.
|
9445
9869
|
|
9446
9870
|
### Example
|
9447
9871
|
|
@@ -9462,26 +9886,23 @@ TalonOne.configure do |config|
|
|
9462
9886
|
end
|
9463
9887
|
|
9464
9888
|
api_instance = TalonOne::ManagementApi.new
|
9465
|
-
user_id = 56 # Integer | The ID of the user.
|
9466
9889
|
|
9467
9890
|
begin
|
9468
|
-
#
|
9469
|
-
api_instance.
|
9891
|
+
#List SCIM groups
|
9892
|
+
result = api_instance.scim_get_groups
|
9893
|
+
p result
|
9470
9894
|
rescue TalonOne::ApiError => e
|
9471
|
-
puts "Exception when calling ManagementApi->
|
9895
|
+
puts "Exception when calling ManagementApi->scim_get_groups: #{e}"
|
9472
9896
|
end
|
9473
9897
|
```
|
9474
9898
|
|
9475
9899
|
### Parameters
|
9476
9900
|
|
9477
|
-
|
9478
|
-
Name | Type | Description | Notes
|
9479
|
-
------------- | ------------- | ------------- | -------------
|
9480
|
-
**user_id** | **Integer**| The ID of the user. |
|
9901
|
+
This endpoint does not need any parameter.
|
9481
9902
|
|
9482
9903
|
### Return type
|
9483
9904
|
|
9484
|
-
|
9905
|
+
[**ScimGroupsListResponse**](ScimGroupsListResponse.md)
|
9485
9906
|
|
9486
9907
|
### Authorization
|
9487
9908
|
|
@@ -9490,7 +9911,7 @@ nil (empty response body)
|
|
9490
9911
|
### HTTP request headers
|
9491
9912
|
|
9492
9913
|
- **Content-Type**: Not defined
|
9493
|
-
- **Accept**:
|
9914
|
+
- **Accept**: application/json
|
9494
9915
|
|
9495
9916
|
|
9496
9917
|
## scim_get_resource_types
|
@@ -9772,6 +10193,67 @@ This endpoint does not need any parameter.
|
|
9772
10193
|
- **Accept**: application/json
|
9773
10194
|
|
9774
10195
|
|
10196
|
+
## scim_patch_group
|
10197
|
+
|
10198
|
+
> ScimGroup scim_patch_group(group_id, body)
|
10199
|
+
|
10200
|
+
Update SCIM group attributes
|
10201
|
+
|
10202
|
+
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.
|
10203
|
+
|
10204
|
+
### Example
|
10205
|
+
|
10206
|
+
```ruby
|
10207
|
+
# load the gem
|
10208
|
+
require 'talon_one'
|
10209
|
+
# setup authorization
|
10210
|
+
TalonOne.configure do |config|
|
10211
|
+
# Configure API key authorization: management_key
|
10212
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10214
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10215
|
+
|
10216
|
+
# Configure API key authorization: manager_auth
|
10217
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10218
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10219
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10220
|
+
end
|
10221
|
+
|
10222
|
+
api_instance = TalonOne::ManagementApi.new
|
10223
|
+
group_id = 56 # Integer | The ID of the group.
|
10224
|
+
body = TalonOne::ScimPatchRequest.new # ScimPatchRequest | body
|
10225
|
+
|
10226
|
+
begin
|
10227
|
+
#Update SCIM group attributes
|
10228
|
+
result = api_instance.scim_patch_group(group_id, body)
|
10229
|
+
p result
|
10230
|
+
rescue TalonOne::ApiError => e
|
10231
|
+
puts "Exception when calling ManagementApi->scim_patch_group: #{e}"
|
10232
|
+
end
|
10233
|
+
```
|
10234
|
+
|
10235
|
+
### Parameters
|
10236
|
+
|
10237
|
+
|
10238
|
+
Name | Type | Description | Notes
|
10239
|
+
------------- | ------------- | ------------- | -------------
|
10240
|
+
**group_id** | **Integer**| The ID of the group. |
|
10241
|
+
**body** | [**ScimPatchRequest**](ScimPatchRequest.md)| body |
|
10242
|
+
|
10243
|
+
### Return type
|
10244
|
+
|
10245
|
+
[**ScimGroup**](ScimGroup.md)
|
10246
|
+
|
10247
|
+
### Authorization
|
10248
|
+
|
10249
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10250
|
+
|
10251
|
+
### HTTP request headers
|
10252
|
+
|
10253
|
+
- **Content-Type**: application/json
|
10254
|
+
- **Accept**: application/json
|
10255
|
+
|
10256
|
+
|
9775
10257
|
## scim_patch_user
|
9776
10258
|
|
9777
10259
|
> ScimUser scim_patch_user(user_id, body)
|
@@ -9833,6 +10315,67 @@ Name | Type | Description | Notes
|
|
9833
10315
|
- **Accept**: application/json
|
9834
10316
|
|
9835
10317
|
|
10318
|
+
## scim_replace_group_attributes
|
10319
|
+
|
10320
|
+
> ScimGroup scim_replace_group_attributes(group_id, body)
|
10321
|
+
|
10322
|
+
Update SCIM group
|
10323
|
+
|
10324
|
+
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.
|
10325
|
+
|
10326
|
+
### Example
|
10327
|
+
|
10328
|
+
```ruby
|
10329
|
+
# load the gem
|
10330
|
+
require 'talon_one'
|
10331
|
+
# setup authorization
|
10332
|
+
TalonOne.configure do |config|
|
10333
|
+
# Configure API key authorization: management_key
|
10334
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10335
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10336
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10337
|
+
|
10338
|
+
# Configure API key authorization: manager_auth
|
10339
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10341
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10342
|
+
end
|
10343
|
+
|
10344
|
+
api_instance = TalonOne::ManagementApi.new
|
10345
|
+
group_id = 56 # Integer | The ID of the group.
|
10346
|
+
body = TalonOne::ScimBaseGroup.new # ScimBaseGroup | body
|
10347
|
+
|
10348
|
+
begin
|
10349
|
+
#Update SCIM group
|
10350
|
+
result = api_instance.scim_replace_group_attributes(group_id, body)
|
10351
|
+
p result
|
10352
|
+
rescue TalonOne::ApiError => e
|
10353
|
+
puts "Exception when calling ManagementApi->scim_replace_group_attributes: #{e}"
|
10354
|
+
end
|
10355
|
+
```
|
10356
|
+
|
10357
|
+
### Parameters
|
10358
|
+
|
10359
|
+
|
10360
|
+
Name | Type | Description | Notes
|
10361
|
+
------------- | ------------- | ------------- | -------------
|
10362
|
+
**group_id** | **Integer**| The ID of the group. |
|
10363
|
+
**body** | [**ScimBaseGroup**](ScimBaseGroup.md)| body |
|
10364
|
+
|
10365
|
+
### Return type
|
10366
|
+
|
10367
|
+
[**ScimGroup**](ScimGroup.md)
|
10368
|
+
|
10369
|
+
### Authorization
|
10370
|
+
|
10371
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10372
|
+
|
10373
|
+
### HTTP request headers
|
10374
|
+
|
10375
|
+
- **Content-Type**: application/json
|
10376
|
+
- **Accept**: application/json
|
10377
|
+
|
10378
|
+
|
9836
10379
|
## scim_replace_user_attributes
|
9837
10380
|
|
9838
10381
|
> ScimUser scim_replace_user_attributes(user_id, body)
|
@@ -9926,7 +10469,7 @@ body = nil # Object | body
|
|
9926
10469
|
opts = {
|
9927
10470
|
page_size: 1000, # Integer | The number of items in the response.
|
9928
10471
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
9929
|
-
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:**
|
10472
|
+
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.
|
9930
10473
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
9931
10474
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
9932
10475
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -9957,7 +10500,7 @@ Name | Type | Description | Notes
|
|
9957
10500
|
**body** | **Object**| body |
|
9958
10501
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
9959
10502
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
9960
|
-
**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:**
|
10503
|
+
**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]
|
9961
10504
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
9962
10505
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
9963
10506
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -10016,7 +10559,7 @@ body = nil # Object | body
|
|
10016
10559
|
opts = {
|
10017
10560
|
page_size: 1000, # Integer | The number of items in the response.
|
10018
10561
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
10019
|
-
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:**
|
10562
|
+
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.
|
10020
10563
|
value: 'value_example', # String | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
10021
10564
|
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
10022
10565
|
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -10047,7 +10590,7 @@ Name | Type | Description | Notes
|
|
10047
10590
|
**body** | **Object**| body |
|
10048
10591
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
10049
10592
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
10050
|
-
**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:**
|
10593
|
+
**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]
|
10051
10594
|
**value** | **String**| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | [optional]
|
10052
10595
|
**created_before** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
10053
10596
|
**created_after** | **DateTime**| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
@@ -10072,6 +10615,67 @@ Name | Type | Description | Notes
|
|
10072
10615
|
- **Accept**: application/json
|
10073
10616
|
|
10074
10617
|
|
10618
|
+
## summarize_campaign_store_budget
|
10619
|
+
|
10620
|
+
> InlineResponse20049 summarize_campaign_store_budget(application_id, campaign_id)
|
10621
|
+
|
10622
|
+
Get summary of campaign store budgets
|
10623
|
+
|
10624
|
+
Fetch a summary of all store budget information for a given campaign.
|
10625
|
+
|
10626
|
+
### Example
|
10627
|
+
|
10628
|
+
```ruby
|
10629
|
+
# load the gem
|
10630
|
+
require 'talon_one'
|
10631
|
+
# setup authorization
|
10632
|
+
TalonOne.configure do |config|
|
10633
|
+
# Configure API key authorization: management_key
|
10634
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10635
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10636
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10637
|
+
|
10638
|
+
# Configure API key authorization: manager_auth
|
10639
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
10640
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
10641
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
10642
|
+
end
|
10643
|
+
|
10644
|
+
api_instance = TalonOne::ManagementApi.new
|
10645
|
+
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
10646
|
+
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
10647
|
+
|
10648
|
+
begin
|
10649
|
+
#Get summary of campaign store budgets
|
10650
|
+
result = api_instance.summarize_campaign_store_budget(application_id, campaign_id)
|
10651
|
+
p result
|
10652
|
+
rescue TalonOne::ApiError => e
|
10653
|
+
puts "Exception when calling ManagementApi->summarize_campaign_store_budget: #{e}"
|
10654
|
+
end
|
10655
|
+
```
|
10656
|
+
|
10657
|
+
### Parameters
|
10658
|
+
|
10659
|
+
|
10660
|
+
Name | Type | Description | Notes
|
10661
|
+
------------- | ------------- | ------------- | -------------
|
10662
|
+
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
10663
|
+
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
10664
|
+
|
10665
|
+
### Return type
|
10666
|
+
|
10667
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
10668
|
+
|
10669
|
+
### Authorization
|
10670
|
+
|
10671
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
10672
|
+
|
10673
|
+
### HTTP request headers
|
10674
|
+
|
10675
|
+
- **Content-Type**: Not defined
|
10676
|
+
- **Accept**: application/json
|
10677
|
+
|
10678
|
+
|
10075
10679
|
## transfer_loyalty_card
|
10076
10680
|
|
10077
10681
|
> transfer_loyalty_card(loyalty_program_id, loyalty_card_id, body)
|
@@ -10810,7 +11414,7 @@ end
|
|
10810
11414
|
Name | Type | Description | Notes
|
10811
11415
|
------------- | ------------- | ------------- | -------------
|
10812
11416
|
**role_id** | **Integer**| The ID of role. **Note**: To find the ID of a role, use the [List roles](/management-api#tag/Roles/operation/listAllRolesV2) endpoint. |
|
10813
|
-
**body** | **RoleV2Base
|
11417
|
+
**body** | [**RoleV2Base**](RoleV2Base.md)| body |
|
10814
11418
|
|
10815
11419
|
### Return type
|
10816
11420
|
|