talon_one 7.0.0 → 9.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 +27 -12
- data/docs/Achievement.md +6 -4
- data/docs/AchievementAdditionalProperties.md +5 -3
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgress.md +3 -15
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AddFreeItemEffectProps.md +3 -1
- data/docs/AdditionalCampaignProperties.md +4 -2
- data/docs/AnalyticsProduct.md +6 -6
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/ApplicationEntity.md +1 -1
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationReferee.md +1 -1
- data/docs/ApplicationSession.md +2 -2
- data/docs/Audience.md +1 -1
- data/docs/BaseLoyaltyProgram.md +1 -1
- data/docs/Binding.md +1 -1
- data/docs/Campaign.md +4 -2
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignEvaluationGroup.md +1 -1
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +3 -1
- data/docs/CardExpiringPointsNotificationPolicy.md +3 -1
- data/docs/CatalogsStrikethroughNotificationPolicy.md +3 -1
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponsNotificationPolicy.md +5 -1
- data/docs/CreateAchievement.md +1 -1
- data/docs/CustomerInventory.md +1 -1
- data/docs/CustomerSession.md +1 -1
- data/docs/CustomerSessionV2.md +2 -4
- data/docs/Environment.md +1 -1
- data/docs/Event.md +1 -1
- data/docs/ExpiringCouponsNotificationPolicy.md +3 -1
- data/docs/ExpiringPointsNotificationPolicy.md +3 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/InlineResponse2001.md +3 -3
- data/docs/InlineResponse20010.md +3 -3
- data/docs/InlineResponse20011.md +3 -3
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +3 -3
- data/docs/InlineResponse20016.md +3 -3
- data/docs/InlineResponse20017.md +3 -5
- data/docs/InlineResponse20018.md +2 -2
- data/docs/InlineResponse20019.md +3 -3
- data/docs/InlineResponse2002.md +3 -3
- data/docs/InlineResponse20020.md +5 -3
- data/docs/InlineResponse20021.md +3 -5
- data/docs/InlineResponse20022.md +2 -4
- data/docs/InlineResponse20023.md +3 -5
- data/docs/InlineResponse20024.md +5 -3
- data/docs/InlineResponse20025.md +4 -2
- data/docs/InlineResponse20026.md +3 -1
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +3 -3
- data/docs/InlineResponse20029.md +1 -3
- data/docs/InlineResponse2003.md +1 -1
- data/docs/InlineResponse20030.md +2 -2
- data/docs/InlineResponse20031.md +3 -3
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +3 -3
- data/docs/InlineResponse20034.md +1 -3
- data/docs/InlineResponse20035.md +5 -3
- data/docs/InlineResponse20036.md +1 -1
- data/docs/InlineResponse20037.md +5 -3
- data/docs/InlineResponse20038.md +1 -1
- data/docs/InlineResponse20039.md +1 -1
- data/docs/InlineResponse2004.md +1 -1
- data/docs/InlineResponse20040.md +1 -1
- data/docs/InlineResponse20041.md +2 -4
- data/docs/InlineResponse20042.md +1 -1
- data/docs/InlineResponse20043.md +1 -1
- data/docs/InlineResponse20044.md +4 -4
- data/docs/InlineResponse20045.md +3 -3
- data/docs/InlineResponse20046.md +3 -3
- data/docs/InlineResponse20047.md +5 -3
- data/docs/InlineResponse20048.md +19 -0
- data/docs/InlineResponse20049.md +19 -0
- data/docs/InlineResponse2005.md +3 -3
- data/docs/InlineResponse2006.md +3 -3
- data/docs/InlineResponse2007.md +1 -1
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +3 -3
- data/docs/IntegrationApi.md +159 -19
- data/docs/LedgerInfo.md +4 -0
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LimitCounter.md +1 -1
- data/docs/LoyaltyBalance.md +3 -1
- data/docs/LoyaltyBalanceWithTier.md +2 -0
- data/docs/LoyaltyBalances.md +1 -1
- data/docs/LoyaltyBalancesWithTiers.md +1 -1
- data/docs/LoyaltyCardBalances.md +1 -1
- data/docs/LoyaltyLedger.md +1 -1
- data/docs/LoyaltyLedgerEntry.md +3 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +5 -1
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/LoyaltySubLedger.md +2 -0
- data/docs/ManagementApi.md +345 -436
- data/docs/ManagementKey.md +3 -1
- data/docs/MessageTest.md +27 -0
- data/docs/ModelReturn.md +1 -1
- data/docs/NewAudience.md +1 -1
- data/docs/NewCampaignSet.md +1 -1
- data/docs/NewLoyaltyProgram.md +1 -1
- data/docs/NewManagementKey.md +2 -0
- data/docs/NewMessageTest.md +29 -0
- data/docs/PendingPointsNotificationPolicy.md +3 -1
- data/docs/ProductSearchMatch.md +2 -2
- data/docs/ProductUnitAnalytics.md +4 -10
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughEffect.md +5 -1
- data/docs/StrikethroughLabelingNotification.md +6 -2
- data/docs/SummaryCampaignStoreBudget.md +3 -1
- data/docs/TemplateDef.md +1 -1
- data/docs/TierDowngradeNotificationPolicy.md +3 -1
- data/docs/TierUpgradeNotificationPolicy.md +3 -1
- data/docs/TierWillDowngradeNotificationPolicy.md +2 -0
- data/docs/UpdateAchievement.md +2 -2
- data/docs/UpdateLoyaltyProgram.md +1 -1
- data/lib/talon_one/api/integration_api.rb +223 -29
- data/lib/talon_one/api/management_api.rb +434 -518
- data/lib/talon_one/models/achievement.rb +27 -15
- data/lib/talon_one/models/achievement_additional_properties.rb +49 -10
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress.rb +4 -137
- 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_free_item_effect_props.rb +14 -4
- data/lib/talon_one/models/additional_campaign_properties.rb +16 -9
- data/lib/talon_one/models/analytics_product.rb +20 -21
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application_api_key.rb +2 -2
- 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_entity.rb +1 -1
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_referee.rb +1 -1
- data/lib/talon_one/models/application_session.rb +2 -2
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/base_loyalty_program.rb +3 -3
- data/lib/talon_one/models/campaign.rb +14 -7
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_evaluation_group.rb +1 -1
- data/lib/talon_one/models/campaign_notification_policy.rb +14 -4
- 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 +16 -4
- data/lib/talon_one/models/card_expiring_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/catalogs_strikethrough_notification_policy.rb +38 -4
- data/lib/talon_one/models/coupon_creation_job.rb +1 -1
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupons_notification_policy.rb +24 -4
- data/lib/talon_one/models/create_achievement.rb +0 -5
- data/lib/talon_one/models/create_application_api_key.rb +2 -2
- data/lib/talon_one/models/customer_inventory.rb +1 -1
- data/lib/talon_one/models/customer_session.rb +1 -1
- data/lib/talon_one/models/customer_session_v2.rb +5 -15
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/environment.rb +1 -1
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/expiring_coupons_notification_policy.rb +14 -4
- data/lib/talon_one/models/expiring_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/inline_response2001.rb +11 -11
- data/lib/talon_one/models/inline_response20010.rb +11 -11
- data/lib/talon_one/models/inline_response20011.rb +11 -11
- data/lib/talon_one/models/inline_response20012.rb +1 -1
- data/lib/talon_one/models/inline_response20013.rb +1 -1
- data/lib/talon_one/models/inline_response20014.rb +1 -1
- data/lib/talon_one/models/inline_response20015.rb +11 -11
- data/lib/talon_one/models/inline_response20016.rb +11 -13
- data/lib/talon_one/models/inline_response20017.rb +7 -11
- data/lib/talon_one/models/inline_response20018.rb +1 -1
- data/lib/talon_one/models/inline_response20019.rb +3 -1
- data/lib/talon_one/models/inline_response2002.rb +11 -11
- data/lib/talon_one/models/inline_response20020.rb +11 -7
- data/lib/talon_one/models/inline_response20021.rb +7 -11
- data/lib/talon_one/models/inline_response20022.rb +7 -11
- data/lib/talon_one/models/inline_response20023.rb +7 -11
- data/lib/talon_one/models/inline_response20024.rb +11 -7
- data/lib/talon_one/models/inline_response20025.rb +11 -7
- data/lib/talon_one/models/inline_response20026.rb +11 -2
- data/lib/talon_one/models/inline_response20027.rb +1 -1
- data/lib/talon_one/models/inline_response20028.rb +11 -11
- data/lib/talon_one/models/inline_response20029.rb +2 -11
- data/lib/talon_one/models/inline_response2003.rb +1 -1
- data/lib/talon_one/models/inline_response20030.rb +6 -1
- data/lib/talon_one/models/inline_response20031.rb +13 -8
- data/lib/talon_one/models/inline_response20032.rb +1 -1
- data/lib/talon_one/models/inline_response20033.rb +8 -13
- data/lib/talon_one/models/inline_response20034.rb +2 -11
- data/lib/talon_one/models/inline_response20035.rb +11 -7
- data/lib/talon_one/models/inline_response20036.rb +1 -1
- data/lib/talon_one/models/inline_response20037.rb +11 -7
- data/lib/talon_one/models/inline_response20038.rb +1 -1
- data/lib/talon_one/models/inline_response20039.rb +1 -1
- data/lib/talon_one/models/inline_response2004.rb +1 -1
- data/lib/talon_one/models/inline_response20040.rb +1 -1
- data/lib/talon_one/models/inline_response20041.rb +7 -11
- data/lib/talon_one/models/inline_response20042.rb +1 -1
- data/lib/talon_one/models/inline_response20043.rb +1 -1
- data/lib/talon_one/models/inline_response20044.rb +11 -11
- data/lib/talon_one/models/inline_response20045.rb +13 -8
- data/lib/talon_one/models/inline_response20046.rb +11 -11
- data/lib/talon_one/models/inline_response20047.rb +11 -7
- data/lib/talon_one/models/inline_response20048.rb +222 -0
- data/lib/talon_one/models/inline_response20049.rb +227 -0
- data/lib/talon_one/models/inline_response2005.rb +11 -11
- data/lib/talon_one/models/inline_response2006.rb +11 -11
- data/lib/talon_one/models/inline_response2007.rb +1 -1
- data/lib/talon_one/models/inline_response2008.rb +1 -1
- data/lib/talon_one/models/inline_response2009.rb +11 -11
- data/lib/talon_one/models/ledger_info.rb +31 -1
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/limit_counter.rb +1 -1
- data/lib/talon_one/models/loyalty_balance.rb +14 -4
- data/lib/talon_one/models/loyalty_balance_with_tier.rb +11 -1
- data/lib/talon_one/models/loyalty_ledger_entry.rb +13 -4
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program.rb +3 -3
- data/lib/talon_one/models/loyalty_program_balance.rb +34 -4
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/loyalty_sub_ledger.rb +16 -1
- data/lib/talon_one/models/management_key.rb +14 -4
- 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/new_application_api_key.rb +2 -2
- data/lib/talon_one/models/new_audience.rb +1 -1
- data/lib/talon_one/models/new_campaign_set.rb +1 -1
- data/lib/talon_one/models/new_loyalty_program.rb +3 -3
- data/lib/talon_one/models/new_management_key.rb +11 -1
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/pending_points_notification_policy.rb +14 -4
- data/lib/talon_one/models/product.rb +0 -19
- data/lib/talon_one/models/product_search_match.rb +1 -6
- data/lib/talon_one/models/product_unit_analytics.rb +21 -65
- 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/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_effect.rb +24 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +56 -2
- data/lib/talon_one/models/summary_campaign_store_budget.rb +18 -4
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/tier_downgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_upgrade_notification_policy.rb +14 -4
- data/lib/talon_one/models/tier_will_downgrade_notification_policy.rb +11 -1
- data/lib/talon_one/models/update_achievement.rb +2 -2
- data/lib/talon_one/models/update_loyalty_program.rb +3 -3
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +20 -5
- data/spec/api/integration_api_spec.rb +46 -9
- data/spec/api/management_api_spec.rb +132 -144
- data/spec/models/achievement_additional_properties_spec.rb +10 -0
- data/spec/models/achievement_base_spec.rb +103 -0
- data/spec/models/achievement_progress_spec.rb +1 -37
- data/spec/models/achievement_progress_with_definition_spec.rb +137 -0
- data/spec/models/achievement_spec.rb +10 -0
- data/spec/models/achievement_status_entry_spec.rb +137 -0
- data/spec/models/add_free_item_effect_props_spec.rb +6 -0
- data/spec/models/additional_campaign_properties_spec.rb +6 -0
- data/spec/models/analytics_product_spec.rb +3 -3
- data/spec/models/analytics_sku_spec.rb +59 -0
- data/spec/models/application_api_key_spec.rb +1 -1
- data/spec/models/application_cif_references_spec.rb +47 -0
- data/spec/models/base_loyalty_program_spec.rb +1 -1
- data/spec/models/campaign_detail_spec.rb +47 -0
- data/spec/models/campaign_notification_policy_spec.rb +6 -0
- data/spec/models/campaign_spec.rb +6 -0
- data/spec/models/campaign_store_budget_limit_config_spec.rb +73 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/card_expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/catalogs_strikethrough_notification_policy_spec.rb +6 -0
- data/spec/models/coupons_notification_policy_spec.rb +12 -0
- data/spec/models/create_application_api_key_spec.rb +1 -1
- data/spec/models/customer_session_v2_spec.rb +0 -6
- data/spec/models/expiring_coupons_notification_policy_spec.rb +6 -0
- data/spec/models/expiring_points_notification_policy_spec.rb +6 -0
- data/spec/models/hidden_conditions_effects_spec.rb +59 -0
- data/spec/models/inline_response20010_spec.rb +1 -1
- data/spec/models/inline_response20011_spec.rb +1 -1
- data/spec/models/inline_response20015_spec.rb +1 -1
- data/spec/models/inline_response20016_spec.rb +1 -1
- data/spec/models/inline_response20017_spec.rb +0 -6
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response20020_spec.rb +6 -0
- data/spec/models/inline_response20021_spec.rb +0 -6
- data/spec/models/inline_response20022_spec.rb +0 -6
- data/spec/models/inline_response20023_spec.rb +0 -6
- data/spec/models/inline_response20024_spec.rb +6 -0
- data/spec/models/inline_response20025_spec.rb +6 -0
- data/spec/models/inline_response20026_spec.rb +6 -0
- data/spec/models/inline_response20028_spec.rb +1 -1
- data/spec/models/inline_response20029_spec.rb +0 -6
- data/spec/models/inline_response2002_spec.rb +1 -1
- data/spec/models/inline_response20031_spec.rb +1 -1
- data/spec/models/inline_response20033_spec.rb +1 -1
- data/spec/models/inline_response20034_spec.rb +0 -6
- data/spec/models/inline_response20035_spec.rb +6 -0
- data/spec/models/inline_response20037_spec.rb +6 -0
- data/spec/models/inline_response20041_spec.rb +0 -6
- data/spec/models/inline_response20044_spec.rb +2 -2
- data/spec/models/inline_response20045_spec.rb +1 -1
- data/spec/models/inline_response20046_spec.rb +1 -1
- data/spec/models/inline_response20047_spec.rb +6 -0
- data/spec/models/inline_response20048_spec.rb +47 -0
- data/spec/models/inline_response20049_spec.rb +47 -0
- data/spec/models/inline_response2005_spec.rb +1 -1
- data/spec/models/inline_response2006_spec.rb +1 -1
- data/spec/models/inline_response2009_spec.rb +1 -1
- data/spec/models/ledger_info_spec.rb +12 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_balance_spec.rb +6 -0
- data/spec/models/loyalty_balance_with_tier_spec.rb +6 -0
- data/spec/models/loyalty_ledger_entry_flags_spec.rb +41 -0
- data/spec/models/loyalty_ledger_entry_spec.rb +6 -0
- data/spec/models/loyalty_program_balance_spec.rb +12 -0
- data/spec/models/loyalty_program_spec.rb +1 -1
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/loyalty_sub_ledger_spec.rb +6 -0
- data/spec/models/management_key_spec.rb +6 -0
- data/spec/models/message_test_spec.rb +47 -0
- data/spec/models/new_application_api_key_spec.rb +1 -1
- data/spec/models/new_loyalty_program_spec.rb +1 -1
- data/spec/models/new_management_key_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +79 -0
- data/spec/models/pending_points_notification_policy_spec.rb +6 -0
- data/spec/models/product_unit_analytics_data_point_spec.rb +65 -0
- data/spec/models/product_unit_analytics_spec.rb +2 -20
- data/spec/models/product_unit_analytics_totals_spec.rb +41 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/sku_unit_analytics_data_point_spec.rb +59 -0
- data/spec/models/sku_unit_analytics_spec.rb +47 -0
- data/spec/models/strikethrough_effect_spec.rb +12 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +16 -0
- data/spec/models/summary_campaign_store_budget_spec.rb +6 -0
- data/spec/models/tier_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_upgrade_notification_policy_spec.rb +6 -0
- data/spec/models/tier_will_downgrade_notification_policy_spec.rb +6 -0
- data/spec/models/update_loyalty_program_spec.rb +1 -1
- metadata +578 -508
data/docs/ManagementApi.md
CHANGED
@@ -97,6 +97,7 @@ Method | HTTP request | Description
|
|
97
97
|
[**get_customer_profile_achievement_progress**](ManagementApi.md#get_customer_profile_achievement_progress) | **GET** /v1/applications/{applicationId}/achievement_progress/{integrationId} | List customer achievements
|
98
98
|
[**get_customer_profiles**](ManagementApi.md#get_customer_profiles) | **GET** /v1/customers/no_total | List customer profiles
|
99
99
|
[**get_customers_by_attributes**](ManagementApi.md#get_customers_by_attributes) | **POST** /v1/customer_search/no_total | List customer profiles matching the given attributes
|
100
|
+
[**get_dashboard_statistics**](ManagementApi.md#get_dashboard_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/dashboard | Get statistics for loyalty dashboard
|
100
101
|
[**get_event_types**](ManagementApi.md#get_event_types) | **GET** /v1/event_types | List event types
|
101
102
|
[**get_exports**](ManagementApi.md#get_exports) | **GET** /v1/exports | Get exports
|
102
103
|
[**get_loyalty_card**](ManagementApi.md#get_loyalty_card) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId} | Get loyalty card
|
@@ -107,6 +108,7 @@ Method | HTTP request | Description
|
|
107
108
|
[**get_loyalty_program_transactions**](ManagementApi.md#get_loyalty_program_transactions) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/transactions | List loyalty program transactions
|
108
109
|
[**get_loyalty_programs**](ManagementApi.md#get_loyalty_programs) | **GET** /v1/loyalty_programs | List loyalty programs
|
109
110
|
[**get_loyalty_statistics**](ManagementApi.md#get_loyalty_statistics) | **GET** /v1/loyalty_programs/{loyaltyProgramId}/statistics | Get loyalty program statistics
|
111
|
+
[**get_message_logs**](ManagementApi.md#get_message_logs) | **GET** /v1/message_logs | List message log entries
|
110
112
|
[**get_referrals_without_total_count**](ManagementApi.md#get_referrals_without_total_count) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/referrals/no_total | List referrals
|
111
113
|
[**get_role_v2**](ManagementApi.md#get_role_v2) | **GET** /v2/roles/{roleId} | Get role
|
112
114
|
[**get_ruleset**](ManagementApi.md#get_ruleset) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId} | Get ruleset
|
@@ -137,11 +139,7 @@ Method | HTTP request | Description
|
|
137
139
|
[**list_collections**](ManagementApi.md#list_collections) | **GET** /v1/applications/{applicationId}/campaigns/{campaignId}/collections | List collections in campaign
|
138
140
|
[**list_collections_in_application**](ManagementApi.md#list_collections_in_application) | **GET** /v1/applications/{applicationId}/collections | List collections in Application
|
139
141
|
[**list_stores**](ManagementApi.md#list_stores) | **GET** /v1/applications/{applicationId}/stores | List stores
|
140
|
-
[**notification_activation**](ManagementApi.md#notification_activation) | **PUT** /v1/notifications/{notificationId}/activation | Activate or deactivate notification
|
141
142
|
[**okta_event_handler_challenge**](ManagementApi.md#okta_event_handler_challenge) | **GET** /v1/provisioning/okta | Validate Okta API ownership
|
142
|
-
[**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
|
143
|
-
[**post_catalogs_strikethrough_notification**](ManagementApi.md#post_catalogs_strikethrough_notification) | **POST** /v1/applications/{applicationId}/catalogs/notifications/strikethrough | Create strikethrough notification
|
144
|
-
[**post_pending_points_notification**](ManagementApi.md#post_pending_points_notification) | **POST** /v1/loyalty_programs/{loyaltyProgramId}/notifications/pending_points | Create notification about pending loyalty points
|
145
143
|
[**remove_loyalty_points**](ManagementApi.md#remove_loyalty_points) | **PUT** /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/deduct_points | Deduct points from customer profile
|
146
144
|
[**reset_password**](ManagementApi.md#reset_password) | **POST** /v1/reset_password | Reset password
|
147
145
|
[**scim_create_user**](ManagementApi.md#scim_create_user) | **POST** /v1/provisioning/scim/Users | Create SCIM user
|
@@ -199,7 +197,7 @@ TalonOne.configure do |config|
|
|
199
197
|
end
|
200
198
|
|
201
199
|
api_instance = TalonOne::ManagementApi.new
|
202
|
-
body = TalonOne::
|
200
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
203
201
|
|
204
202
|
begin
|
205
203
|
#Enable user by email address
|
@@ -214,7 +212,7 @@ end
|
|
214
212
|
|
215
213
|
Name | Type | Description | Notes
|
216
214
|
------------- | ------------- | ------------- | -------------
|
217
|
-
**body** | **
|
215
|
+
**body** | **DeleteUserRequest**| body |
|
218
216
|
|
219
217
|
### Return type
|
220
218
|
|
@@ -320,7 +318,7 @@ end
|
|
320
318
|
|
321
319
|
api_instance = TalonOne::ManagementApi.new
|
322
320
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
323
|
-
integration_id = 'integration_id_example' # String | The identifier
|
321
|
+
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.
|
324
322
|
body = TalonOne::AddLoyaltyPoints.new # AddLoyaltyPoints | body
|
325
323
|
|
326
324
|
begin
|
@@ -337,7 +335,7 @@ end
|
|
337
335
|
Name | Type | Description | Notes
|
338
336
|
------------- | ------------- | ------------- | -------------
|
339
337
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
340
|
-
**integration_id** | **String**| The identifier
|
338
|
+
**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. |
|
341
339
|
**body** | [**AddLoyaltyPoints**](AddLoyaltyPoints.md)| body |
|
342
340
|
|
343
341
|
### Return type
|
@@ -356,7 +354,7 @@ nil (empty response body)
|
|
356
354
|
|
357
355
|
## copy_campaign_to_applications
|
358
356
|
|
359
|
-
>
|
357
|
+
> InlineResponse2008 copy_campaign_to_applications(application_id, campaign_id, body)
|
360
358
|
|
361
359
|
Copy the campaign into the specified Application
|
362
360
|
|
@@ -405,7 +403,7 @@ Name | Type | Description | Notes
|
|
405
403
|
|
406
404
|
### Return type
|
407
405
|
|
408
|
-
[**
|
406
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
409
407
|
|
410
408
|
### Authorization
|
411
409
|
|
@@ -844,7 +842,7 @@ Name | Type | Description | Notes
|
|
844
842
|
|
845
843
|
## create_coupons
|
846
844
|
|
847
|
-
>
|
845
|
+
> InlineResponse20010 create_coupons(application_id, campaign_id, body, opts)
|
848
846
|
|
849
847
|
Create coupons
|
850
848
|
|
@@ -873,7 +871,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
873
871
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
874
872
|
body = TalonOne::NewCoupons.new # NewCoupons | body
|
875
873
|
opts = {
|
876
|
-
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the
|
874
|
+
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
877
875
|
}
|
878
876
|
|
879
877
|
begin
|
@@ -893,11 +891,11 @@ Name | Type | Description | Notes
|
|
893
891
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
894
892
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
895
893
|
**body** | [**NewCoupons**](NewCoupons.md)| body |
|
896
|
-
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the
|
894
|
+
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to 'yes']
|
897
895
|
|
898
896
|
### Return type
|
899
897
|
|
900
|
-
[**
|
898
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
901
899
|
|
902
900
|
### Authorization
|
903
901
|
|
@@ -1037,7 +1035,7 @@ Name | Type | Description | Notes
|
|
1037
1035
|
|
1038
1036
|
## create_coupons_for_multiple_recipients
|
1039
1037
|
|
1040
|
-
>
|
1038
|
+
> InlineResponse20010 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
|
1041
1039
|
|
1042
1040
|
Create coupons for multiple recipients
|
1043
1041
|
|
@@ -1066,7 +1064,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
1066
1064
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1067
1065
|
body = TalonOne::NewCouponsForMultipleRecipients.new # NewCouponsForMultipleRecipients | body
|
1068
1066
|
opts = {
|
1069
|
-
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the
|
1067
|
+
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles.
|
1070
1068
|
}
|
1071
1069
|
|
1072
1070
|
begin
|
@@ -1086,11 +1084,11 @@ Name | Type | Description | Notes
|
|
1086
1084
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
1087
1085
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
1088
1086
|
**body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md)| body |
|
1089
|
-
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the
|
1087
|
+
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the performance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [optional] [default to 'yes']
|
1090
1088
|
|
1091
1089
|
### Return type
|
1092
1090
|
|
1093
|
-
[**
|
1091
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
1094
1092
|
|
1095
1093
|
### Authorization
|
1096
1094
|
|
@@ -1426,7 +1424,7 @@ TalonOne.configure do |config|
|
|
1426
1424
|
end
|
1427
1425
|
|
1428
1426
|
api_instance = TalonOne::ManagementApi.new
|
1429
|
-
body = TalonOne::
|
1427
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
1430
1428
|
|
1431
1429
|
begin
|
1432
1430
|
#Disable user by email address
|
@@ -1441,7 +1439,7 @@ end
|
|
1441
1439
|
|
1442
1440
|
Name | Type | Description | Notes
|
1443
1441
|
------------- | ------------- | ------------- | -------------
|
1444
|
-
**body** |
|
1442
|
+
**body** | **DeleteUserRequest**| body |
|
1445
1443
|
|
1446
1444
|
### Return type
|
1447
1445
|
|
@@ -2178,7 +2176,7 @@ TalonOne.configure do |config|
|
|
2178
2176
|
end
|
2179
2177
|
|
2180
2178
|
api_instance = TalonOne::ManagementApi.new
|
2181
|
-
body = TalonOne::
|
2179
|
+
body = TalonOne::DeleteUserRequest.new # DeleteUserRequest | body
|
2182
2180
|
|
2183
2181
|
begin
|
2184
2182
|
#Delete user by email address
|
@@ -2193,7 +2191,7 @@ end
|
|
2193
2191
|
|
2194
2192
|
Name | Type | Description | Notes
|
2195
2193
|
------------- | ------------- | ------------- | -------------
|
2196
|
-
**body** | **
|
2194
|
+
**body** | [**DeleteUserRequest**](DeleteUserRequest.md)| body |
|
2197
2195
|
|
2198
2196
|
### Return type
|
2199
2197
|
|
@@ -2658,7 +2656,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
2658
2656
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2659
2657
|
opts = {
|
2660
2658
|
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
2661
|
-
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:**
|
2659
|
+
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.
|
2662
2660
|
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.
|
2663
2661
|
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.
|
2664
2662
|
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.
|
@@ -2689,7 +2687,7 @@ Name | Type | Description | Notes
|
|
2689
2687
|
------------- | ------------- | ------------- | -------------
|
2690
2688
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
2691
2689
|
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
2692
|
-
**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:**
|
2690
|
+
**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]
|
2693
2691
|
**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]
|
2694
2692
|
**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]
|
2695
2693
|
**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]
|
@@ -3251,7 +3249,7 @@ Name | Type | Description | Notes
|
|
3251
3249
|
|
3252
3250
|
Export customer's transaction logs
|
3253
3251
|
|
3254
|
-
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.
|
3252
|
+
Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
3255
3253
|
|
3256
3254
|
### Example
|
3257
3255
|
|
@@ -3275,7 +3273,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
3275
3273
|
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3276
3274
|
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
3277
3275
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
3278
|
-
integration_id = 'integration_id_example' # String | The identifier
|
3276
|
+
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.
|
3279
3277
|
opts = {
|
3280
3278
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
3281
3279
|
}
|
@@ -3297,7 +3295,7 @@ Name | Type | Description | Notes
|
|
3297
3295
|
**range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
3298
3296
|
**range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
3299
3297
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
3300
|
-
**integration_id** | **String**| The identifier
|
3298
|
+
**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. |
|
3301
3299
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
3302
3300
|
|
3303
3301
|
### Return type
|
@@ -3456,7 +3454,7 @@ Name | Type | Description | Notes
|
|
3456
3454
|
|
3457
3455
|
## get_access_logs_without_total_count
|
3458
3456
|
|
3459
|
-
>
|
3457
|
+
> InlineResponse20022 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
|
3460
3458
|
|
3461
3459
|
Get access logs for Application
|
3462
3460
|
|
@@ -3490,7 +3488,7 @@ opts = {
|
|
3490
3488
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
3491
3489
|
page_size: 1000, # Integer | The number of items in the response.
|
3492
3490
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
3493
|
-
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:**
|
3491
|
+
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.
|
3494
3492
|
}
|
3495
3493
|
|
3496
3494
|
begin
|
@@ -3515,11 +3513,11 @@ Name | Type | Description | Notes
|
|
3515
3513
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
3516
3514
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
3517
3515
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
3518
|
-
**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:**
|
3516
|
+
**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]
|
3519
3517
|
|
3520
3518
|
### Return type
|
3521
3519
|
|
3522
|
-
[**
|
3520
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
3523
3521
|
|
3524
3522
|
### Authorization
|
3525
3523
|
|
@@ -3832,7 +3830,7 @@ Name | Type | Description | Notes
|
|
3832
3830
|
|
3833
3831
|
## get_additional_costs
|
3834
3832
|
|
3835
|
-
>
|
3833
|
+
> InlineResponse20038 get_additional_costs(opts)
|
3836
3834
|
|
3837
3835
|
List additional costs
|
3838
3836
|
|
@@ -3860,7 +3858,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
3860
3858
|
opts = {
|
3861
3859
|
page_size: 1000, # Integer | The number of items in the response.
|
3862
3860
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
3863
|
-
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:**
|
3861
|
+
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.
|
3864
3862
|
}
|
3865
3863
|
|
3866
3864
|
begin
|
@@ -3879,11 +3877,11 @@ Name | Type | Description | Notes
|
|
3879
3877
|
------------- | ------------- | ------------- | -------------
|
3880
3878
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
3881
3879
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
3882
|
-
**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:**
|
3880
|
+
**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]
|
3883
3881
|
|
3884
3882
|
### Return type
|
3885
3883
|
|
3886
|
-
[**
|
3884
|
+
[**InlineResponse20038**](InlineResponse20038.md)
|
3887
3885
|
|
3888
3886
|
### Authorization
|
3889
3887
|
|
@@ -4076,7 +4074,7 @@ Name | Type | Description | Notes
|
|
4076
4074
|
|
4077
4075
|
## get_application_customer_friends
|
4078
4076
|
|
4079
|
-
>
|
4077
|
+
> InlineResponse20035 get_application_customer_friends(application_id, integration_id, opts)
|
4080
4078
|
|
4081
4079
|
List friends referred by customer profile
|
4082
4080
|
|
@@ -4106,7 +4104,7 @@ integration_id = 'integration_id_example' # String | The Integration ID of the A
|
|
4106
4104
|
opts = {
|
4107
4105
|
page_size: 1000, # Integer | The number of items in the response.
|
4108
4106
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4109
|
-
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:**
|
4107
|
+
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.
|
4110
4108
|
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.
|
4111
4109
|
}
|
4112
4110
|
|
@@ -4128,12 +4126,12 @@ Name | Type | Description | Notes
|
|
4128
4126
|
**integration_id** | **String**| The Integration ID of the Advocate's Profile. |
|
4129
4127
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4130
4128
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4131
|
-
**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:**
|
4129
|
+
**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]
|
4132
4130
|
**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]
|
4133
4131
|
|
4134
4132
|
### Return type
|
4135
4133
|
|
4136
|
-
[**
|
4134
|
+
[**InlineResponse20035**](InlineResponse20035.md)
|
4137
4135
|
|
4138
4136
|
### Authorization
|
4139
4137
|
|
@@ -4147,7 +4145,7 @@ Name | Type | Description | Notes
|
|
4147
4145
|
|
4148
4146
|
## get_application_customers
|
4149
4147
|
|
4150
|
-
>
|
4148
|
+
> InlineResponse20024 get_application_customers(application_id, opts)
|
4151
4149
|
|
4152
4150
|
List application's customers
|
4153
4151
|
|
@@ -4202,7 +4200,7 @@ Name | Type | Description | Notes
|
|
4202
4200
|
|
4203
4201
|
### Return type
|
4204
4202
|
|
4205
|
-
[**
|
4203
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
4206
4204
|
|
4207
4205
|
### Authorization
|
4208
4206
|
|
@@ -4216,7 +4214,7 @@ Name | Type | Description | Notes
|
|
4216
4214
|
|
4217
4215
|
## get_application_customers_by_attributes
|
4218
4216
|
|
4219
|
-
>
|
4217
|
+
> InlineResponse20025 get_application_customers_by_attributes(application_id, body, opts)
|
4220
4218
|
|
4221
4219
|
List application customers matching the given attributes
|
4222
4220
|
|
@@ -4271,7 +4269,7 @@ Name | Type | Description | Notes
|
|
4271
4269
|
|
4272
4270
|
### Return type
|
4273
4271
|
|
4274
|
-
[**
|
4272
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
4275
4273
|
|
4276
4274
|
### Authorization
|
4277
4275
|
|
@@ -4285,7 +4283,7 @@ Name | Type | Description | Notes
|
|
4285
4283
|
|
4286
4284
|
## get_application_event_types
|
4287
4285
|
|
4288
|
-
>
|
4286
|
+
> InlineResponse20031 get_application_event_types(application_id, opts)
|
4289
4287
|
|
4290
4288
|
List Applications event types
|
4291
4289
|
|
@@ -4314,7 +4312,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4314
4312
|
opts = {
|
4315
4313
|
page_size: 1000, # Integer | The number of items in the response.
|
4316
4314
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4317
|
-
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:**
|
4315
|
+
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.
|
4318
4316
|
}
|
4319
4317
|
|
4320
4318
|
begin
|
@@ -4334,11 +4332,11 @@ Name | Type | Description | Notes
|
|
4334
4332
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4335
4333
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4336
4334
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4337
|
-
**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:**
|
4335
|
+
**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]
|
4338
4336
|
|
4339
4337
|
### Return type
|
4340
4338
|
|
4341
|
-
[**
|
4339
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
4342
4340
|
|
4343
4341
|
### Authorization
|
4344
4342
|
|
@@ -4352,7 +4350,7 @@ Name | Type | Description | Notes
|
|
4352
4350
|
|
4353
4351
|
## get_application_events_without_total_count
|
4354
4352
|
|
4355
|
-
>
|
4353
|
+
> InlineResponse20030 get_application_events_without_total_count(application_id, opts)
|
4356
4354
|
|
4357
4355
|
List Applications events
|
4358
4356
|
|
@@ -4381,7 +4379,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4381
4379
|
opts = {
|
4382
4380
|
page_size: 1000, # Integer | The number of items in the response.
|
4383
4381
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4384
|
-
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:**
|
4382
|
+
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.
|
4385
4383
|
type: 'type_example', # String | Comma-separated list of types by which to filter events. Must be exact match(es).
|
4386
4384
|
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.
|
4387
4385
|
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.
|
@@ -4412,7 +4410,7 @@ Name | Type | Description | Notes
|
|
4412
4410
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4413
4411
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4414
4412
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4415
|
-
**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:**
|
4413
|
+
**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]
|
4416
4414
|
**type** | **String**| Comma-separated list of types by which to filter events. Must be exact match(es). | [optional]
|
4417
4415
|
**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]
|
4418
4416
|
**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]
|
@@ -4427,7 +4425,7 @@ Name | Type | Description | Notes
|
|
4427
4425
|
|
4428
4426
|
### Return type
|
4429
4427
|
|
4430
|
-
[**
|
4428
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
4431
4429
|
|
4432
4430
|
### Authorization
|
4433
4431
|
|
@@ -4502,7 +4500,7 @@ Name | Type | Description | Notes
|
|
4502
4500
|
|
4503
4501
|
## get_application_sessions
|
4504
4502
|
|
4505
|
-
>
|
4503
|
+
> InlineResponse20029 get_application_sessions(application_id, opts)
|
4506
4504
|
|
4507
4505
|
List Application sessions
|
4508
4506
|
|
@@ -4531,7 +4529,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
4531
4529
|
opts = {
|
4532
4530
|
page_size: 1000, # Integer | The number of items in the response.
|
4533
4531
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4534
|
-
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:**
|
4532
|
+
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.
|
4535
4533
|
profile: 'profile_example', # String | Profile integration ID filter for sessions. Must be exact match.
|
4536
4534
|
state: 'state_example', # String | Filter by sessions with this state. Must be exact match.
|
4537
4535
|
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.
|
@@ -4559,7 +4557,7 @@ Name | Type | Description | Notes
|
|
4559
4557
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
4560
4558
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4561
4559
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4562
|
-
**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:**
|
4560
|
+
**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]
|
4563
4561
|
**profile** | **String**| Profile integration ID filter for sessions. Must be exact match. | [optional]
|
4564
4562
|
**state** | **String**| Filter by sessions with this state. Must be exact match. | [optional]
|
4565
4563
|
**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]
|
@@ -4571,7 +4569,7 @@ Name | Type | Description | Notes
|
|
4571
4569
|
|
4572
4570
|
### Return type
|
4573
4571
|
|
4574
|
-
[**
|
4572
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
4575
4573
|
|
4576
4574
|
### Authorization
|
4577
4575
|
|
@@ -4585,7 +4583,7 @@ Name | Type | Description | Notes
|
|
4585
4583
|
|
4586
4584
|
## get_applications
|
4587
4585
|
|
4588
|
-
>
|
4586
|
+
> InlineResponse2007 get_applications(opts)
|
4589
4587
|
|
4590
4588
|
List Applications
|
4591
4589
|
|
@@ -4613,7 +4611,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4613
4611
|
opts = {
|
4614
4612
|
page_size: 1000, # Integer | The number of items in the response.
|
4615
4613
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4616
|
-
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:**
|
4614
|
+
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.
|
4617
4615
|
}
|
4618
4616
|
|
4619
4617
|
begin
|
@@ -4632,11 +4630,11 @@ Name | Type | Description | Notes
|
|
4632
4630
|
------------- | ------------- | ------------- | -------------
|
4633
4631
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4634
4632
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4635
|
-
**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:**
|
4633
|
+
**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]
|
4636
4634
|
|
4637
4635
|
### Return type
|
4638
4636
|
|
4639
|
-
[**
|
4637
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
4640
4638
|
|
4641
4639
|
### Authorization
|
4642
4640
|
|
@@ -4709,7 +4707,7 @@ Name | Type | Description | Notes
|
|
4709
4707
|
|
4710
4708
|
## get_attributes
|
4711
4709
|
|
4712
|
-
>
|
4710
|
+
> InlineResponse20036 get_attributes(opts)
|
4713
4711
|
|
4714
4712
|
List custom attributes
|
4715
4713
|
|
@@ -4737,7 +4735,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4737
4735
|
opts = {
|
4738
4736
|
page_size: 1000, # Integer | The number of items in the response.
|
4739
4737
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4740
|
-
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:**
|
4738
|
+
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.
|
4741
4739
|
entity: 'entity_example' # String | Returned attributes will be filtered by supplied entity.
|
4742
4740
|
}
|
4743
4741
|
|
@@ -4757,12 +4755,12 @@ Name | Type | Description | Notes
|
|
4757
4755
|
------------- | ------------- | ------------- | -------------
|
4758
4756
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4759
4757
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4760
|
-
**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:**
|
4758
|
+
**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]
|
4761
4759
|
**entity** | **String**| Returned attributes will be filtered by supplied entity. | [optional]
|
4762
4760
|
|
4763
4761
|
### Return type
|
4764
4762
|
|
4765
|
-
[**
|
4763
|
+
[**InlineResponse20036**](InlineResponse20036.md)
|
4766
4764
|
|
4767
4765
|
### Authorization
|
4768
4766
|
|
@@ -4776,7 +4774,7 @@ Name | Type | Description | Notes
|
|
4776
4774
|
|
4777
4775
|
## get_audience_memberships
|
4778
4776
|
|
4779
|
-
>
|
4777
|
+
> InlineResponse20034 get_audience_memberships(audience_id, opts)
|
4780
4778
|
|
4781
4779
|
List audience members
|
4782
4780
|
|
@@ -4805,7 +4803,7 @@ audience_id = 56 # Integer | The ID of the audience.
|
|
4805
4803
|
opts = {
|
4806
4804
|
page_size: 1000, # Integer | The number of items in the response.
|
4807
4805
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4808
|
-
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:**
|
4806
|
+
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.
|
4809
4807
|
profile_query: 'profile_query_example' # String | The filter to select a profile.
|
4810
4808
|
}
|
4811
4809
|
|
@@ -4826,12 +4824,12 @@ Name | Type | Description | Notes
|
|
4826
4824
|
**audience_id** | **Integer**| The ID of the audience. |
|
4827
4825
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4828
4826
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4829
|
-
**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:**
|
4827
|
+
**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]
|
4830
4828
|
**profile_query** | **String**| The filter to select a profile. | [optional]
|
4831
4829
|
|
4832
4830
|
### Return type
|
4833
4831
|
|
4834
|
-
[**
|
4832
|
+
[**InlineResponse20034**](InlineResponse20034.md)
|
4835
4833
|
|
4836
4834
|
### Authorization
|
4837
4835
|
|
@@ -4845,7 +4843,7 @@ Name | Type | Description | Notes
|
|
4845
4843
|
|
4846
4844
|
## get_audiences
|
4847
4845
|
|
4848
|
-
>
|
4846
|
+
> InlineResponse20032 get_audiences(opts)
|
4849
4847
|
|
4850
4848
|
List audiences
|
4851
4849
|
|
@@ -4873,7 +4871,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
4873
4871
|
opts = {
|
4874
4872
|
page_size: 1000, # Integer | The number of items in the response.
|
4875
4873
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
4876
|
-
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:**
|
4874
|
+
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.
|
4877
4875
|
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.
|
4878
4876
|
}
|
4879
4877
|
|
@@ -4893,12 +4891,12 @@ Name | Type | Description | Notes
|
|
4893
4891
|
------------- | ------------- | ------------- | -------------
|
4894
4892
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
4895
4893
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
4896
|
-
**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:**
|
4894
|
+
**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]
|
4897
4895
|
**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]
|
4898
4896
|
|
4899
4897
|
### Return type
|
4900
4898
|
|
4901
|
-
[**
|
4899
|
+
[**InlineResponse20032**](InlineResponse20032.md)
|
4902
4900
|
|
4903
4901
|
### Authorization
|
4904
4902
|
|
@@ -4912,7 +4910,7 @@ Name | Type | Description | Notes
|
|
4912
4910
|
|
4913
4911
|
## get_audiences_analytics
|
4914
4912
|
|
4915
|
-
>
|
4913
|
+
> InlineResponse20033 get_audiences_analytics(audience_ids, opts)
|
4916
4914
|
|
4917
4915
|
List audience analytics
|
4918
4916
|
|
@@ -4939,7 +4937,7 @@ end
|
|
4939
4937
|
api_instance = TalonOne::ManagementApi.new
|
4940
4938
|
audience_ids = 'audience_ids_example' # String | The IDs of one or more audiences, separated by commas, by which to filter results.
|
4941
4939
|
opts = {
|
4942
|
-
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:**
|
4940
|
+
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.
|
4943
4941
|
}
|
4944
4942
|
|
4945
4943
|
begin
|
@@ -4957,11 +4955,11 @@ end
|
|
4957
4955
|
Name | Type | Description | Notes
|
4958
4956
|
------------- | ------------- | ------------- | -------------
|
4959
4957
|
**audience_ids** | **String**| The IDs of one or more audiences, separated by commas, by which to filter results. |
|
4960
|
-
**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:**
|
4958
|
+
**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]
|
4961
4959
|
|
4962
4960
|
### Return type
|
4963
4961
|
|
4964
|
-
[**
|
4962
|
+
[**InlineResponse20033**](InlineResponse20033.md)
|
4965
4963
|
|
4966
4964
|
### Authorization
|
4967
4965
|
|
@@ -5036,7 +5034,7 @@ Name | Type | Description | Notes
|
|
5036
5034
|
|
5037
5035
|
## get_campaign_analytics
|
5038
5036
|
|
5039
|
-
>
|
5037
|
+
> InlineResponse20023 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
5040
5038
|
|
5041
5039
|
Get analytics of campaigns
|
5042
5040
|
|
@@ -5091,7 +5089,7 @@ Name | Type | Description | Notes
|
|
5091
5089
|
|
5092
5090
|
### Return type
|
5093
5091
|
|
5094
|
-
[**
|
5092
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
5095
5093
|
|
5096
5094
|
### Authorization
|
5097
5095
|
|
@@ -5105,7 +5103,7 @@ Name | Type | Description | Notes
|
|
5105
5103
|
|
5106
5104
|
## get_campaign_by_attributes
|
5107
5105
|
|
5108
|
-
>
|
5106
|
+
> InlineResponse2008 get_campaign_by_attributes(application_id, body, opts)
|
5109
5107
|
|
5110
5108
|
List campaigns that match the given attributes
|
5111
5109
|
|
@@ -5135,7 +5133,7 @@ body = TalonOne::CampaignSearch.new # CampaignSearch | body
|
|
5135
5133
|
opts = {
|
5136
5134
|
page_size: 1000, # Integer | The number of items in the response.
|
5137
5135
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5138
|
-
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:**
|
5136
|
+
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.
|
5139
5137
|
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.
|
5140
5138
|
}
|
5141
5139
|
|
@@ -5157,12 +5155,12 @@ Name | Type | Description | Notes
|
|
5157
5155
|
**body** | [**CampaignSearch**](CampaignSearch.md)| body |
|
5158
5156
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5159
5157
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5160
|
-
**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:**
|
5158
|
+
**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]
|
5161
5159
|
**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]
|
5162
5160
|
|
5163
5161
|
### Return type
|
5164
5162
|
|
5165
|
-
[**
|
5163
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
5166
5164
|
|
5167
5165
|
### Authorization
|
5168
5166
|
|
@@ -5235,7 +5233,7 @@ Name | Type | Description | Notes
|
|
5235
5233
|
|
5236
5234
|
## get_campaign_groups
|
5237
5235
|
|
5238
|
-
>
|
5236
|
+
> InlineResponse20013 get_campaign_groups(opts)
|
5239
5237
|
|
5240
5238
|
List campaign access groups
|
5241
5239
|
|
@@ -5263,7 +5261,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5263
5261
|
opts = {
|
5264
5262
|
page_size: 1000, # Integer | The number of items in the response.
|
5265
5263
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5266
|
-
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:**
|
5264
|
+
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.
|
5267
5265
|
}
|
5268
5266
|
|
5269
5267
|
begin
|
@@ -5282,11 +5280,11 @@ Name | Type | Description | Notes
|
|
5282
5280
|
------------- | ------------- | ------------- | -------------
|
5283
5281
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5284
5282
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5285
|
-
**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:**
|
5283
|
+
**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]
|
5286
5284
|
|
5287
5285
|
### Return type
|
5288
5286
|
|
5289
|
-
[**
|
5287
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
5290
5288
|
|
5291
5289
|
### Authorization
|
5292
5290
|
|
@@ -5300,7 +5298,7 @@ Name | Type | Description | Notes
|
|
5300
5298
|
|
5301
5299
|
## get_campaign_templates
|
5302
5300
|
|
5303
|
-
>
|
5301
|
+
> InlineResponse20014 get_campaign_templates(opts)
|
5304
5302
|
|
5305
5303
|
List campaign templates
|
5306
5304
|
|
@@ -5328,7 +5326,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5328
5326
|
opts = {
|
5329
5327
|
page_size: 1000, # Integer | The number of items in the response.
|
5330
5328
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5331
|
-
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:**
|
5329
|
+
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.
|
5332
5330
|
state: 'state_example', # String | Filter results by the state of the campaign template.
|
5333
5331
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign template.
|
5334
5332
|
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.
|
@@ -5351,7 +5349,7 @@ Name | Type | Description | Notes
|
|
5351
5349
|
------------- | ------------- | ------------- | -------------
|
5352
5350
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5353
5351
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5354
|
-
**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:**
|
5352
|
+
**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]
|
5355
5353
|
**state** | **String**| Filter results by the state of the campaign template. | [optional]
|
5356
5354
|
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign template. | [optional]
|
5357
5355
|
**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]
|
@@ -5359,7 +5357,7 @@ Name | Type | Description | Notes
|
|
5359
5357
|
|
5360
5358
|
### Return type
|
5361
5359
|
|
5362
|
-
[**
|
5360
|
+
[**InlineResponse20014**](InlineResponse20014.md)
|
5363
5361
|
|
5364
5362
|
### Authorization
|
5365
5363
|
|
@@ -5373,7 +5371,7 @@ Name | Type | Description | Notes
|
|
5373
5371
|
|
5374
5372
|
## get_campaigns
|
5375
5373
|
|
5376
|
-
>
|
5374
|
+
> InlineResponse2008 get_campaigns(application_id, opts)
|
5377
5375
|
|
5378
5376
|
List campaigns
|
5379
5377
|
|
@@ -5402,7 +5400,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
5402
5400
|
opts = {
|
5403
5401
|
page_size: 1000, # Integer | The number of items in the response.
|
5404
5402
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5405
|
-
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:**
|
5403
|
+
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.
|
5406
5404
|
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.
|
5407
5405
|
name: 'name_example', # String | Filter results performing case-insensitive matching against the name of the campaign.
|
5408
5406
|
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
|
@@ -5430,7 +5428,7 @@ Name | Type | Description | Notes
|
|
5430
5428
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
5431
5429
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5432
5430
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5433
|
-
**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:**
|
5431
|
+
**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]
|
5434
5432
|
**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]
|
5435
5433
|
**name** | **String**| Filter results performing case-insensitive matching against the name of the campaign. | [optional]
|
5436
5434
|
**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]
|
@@ -5442,7 +5440,7 @@ Name | Type | Description | Notes
|
|
5442
5440
|
|
5443
5441
|
### Return type
|
5444
5442
|
|
5445
|
-
[**
|
5443
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
5446
5444
|
|
5447
5445
|
### Authorization
|
5448
5446
|
|
@@ -5456,7 +5454,7 @@ Name | Type | Description | Notes
|
|
5456
5454
|
|
5457
5455
|
## get_changes
|
5458
5456
|
|
5459
|
-
>
|
5457
|
+
> InlineResponse20044 get_changes(opts)
|
5460
5458
|
|
5461
5459
|
Get audit logs for an account
|
5462
5460
|
|
@@ -5484,7 +5482,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
5484
5482
|
opts = {
|
5485
5483
|
page_size: 1000, # Integer | The number of items in the response.
|
5486
5484
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5487
|
-
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:**
|
5485
|
+
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.
|
5488
5486
|
application_id: 3.4, # Float | Filter results by Application ID.
|
5489
5487
|
entity_path: 'entity_path_example', # String | Filter results on a case insensitive matching of the url path of the entity
|
5490
5488
|
user_id: 56, # Integer | Filter results by user ID.
|
@@ -5511,7 +5509,7 @@ Name | Type | Description | Notes
|
|
5511
5509
|
------------- | ------------- | ------------- | -------------
|
5512
5510
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5513
5511
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5514
|
-
**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:**
|
5512
|
+
**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]
|
5515
5513
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
5516
5514
|
**entity_path** | **String**| Filter results on a case insensitive matching of the url path of the entity | [optional]
|
5517
5515
|
**user_id** | **Integer**| Filter results by user ID. | [optional]
|
@@ -5523,7 +5521,7 @@ Name | Type | Description | Notes
|
|
5523
5521
|
|
5524
5522
|
### Return type
|
5525
5523
|
|
5526
|
-
[**
|
5524
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
5527
5525
|
|
5528
5526
|
### Authorization
|
5529
5527
|
|
@@ -5600,7 +5598,7 @@ Name | Type | Description | Notes
|
|
5600
5598
|
|
5601
5599
|
## get_collection_items
|
5602
5600
|
|
5603
|
-
>
|
5601
|
+
> InlineResponse20021 get_collection_items(collection_id, opts)
|
5604
5602
|
|
5605
5603
|
Get collection items
|
5606
5604
|
|
@@ -5651,7 +5649,7 @@ Name | Type | Description | Notes
|
|
5651
5649
|
|
5652
5650
|
### Return type
|
5653
5651
|
|
5654
|
-
[**
|
5652
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
5655
5653
|
|
5656
5654
|
### Authorization
|
5657
5655
|
|
@@ -5665,7 +5663,7 @@ Name | Type | Description | Notes
|
|
5665
5663
|
|
5666
5664
|
## get_coupons_without_total_count
|
5667
5665
|
|
5668
|
-
>
|
5666
|
+
> InlineResponse20011 get_coupons_without_total_count(application_id, campaign_id, opts)
|
5669
5667
|
|
5670
5668
|
List coupons
|
5671
5669
|
|
@@ -5695,7 +5693,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
5695
5693
|
opts = {
|
5696
5694
|
page_size: 1000, # Integer | The number of items in the response.
|
5697
5695
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5698
|
-
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.
|
5699
5697
|
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.
|
5700
5698
|
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.
|
5701
5699
|
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.
|
@@ -5731,7 +5729,7 @@ Name | Type | Description | Notes
|
|
5731
5729
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
5732
5730
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5733
5731
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5734
|
-
**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:**
|
5732
|
+
**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]
|
5735
5733
|
**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]
|
5736
5734
|
**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]
|
5737
5735
|
**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]
|
@@ -5750,7 +5748,7 @@ Name | Type | Description | Notes
|
|
5750
5748
|
|
5751
5749
|
### Return type
|
5752
5750
|
|
5753
|
-
[**
|
5751
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
5754
5752
|
|
5755
5753
|
### Authorization
|
5756
5754
|
|
@@ -5835,7 +5833,7 @@ Name | Type | Description | Notes
|
|
5835
5833
|
|
5836
5834
|
## get_customer_activity_reports_without_total_count
|
5837
5835
|
|
5838
|
-
>
|
5836
|
+
> InlineResponse20028 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
5839
5837
|
|
5840
5838
|
Get Activity Reports for Application Customers
|
5841
5839
|
|
@@ -5866,7 +5864,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
5866
5864
|
opts = {
|
5867
5865
|
page_size: 1000, # Integer | The number of items in the response.
|
5868
5866
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5869
|
-
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:**
|
5867
|
+
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.
|
5870
5868
|
name: 'name_example', # String | Only return reports matching the customer name.
|
5871
5869
|
integration_id: 'integration_id_example', # String | Filter results performing an exact matching against the profile integration identifier.
|
5872
5870
|
campaign_name: 'campaign_name_example', # String | Only return reports matching the campaign name.
|
@@ -5892,7 +5890,7 @@ Name | Type | Description | Notes
|
|
5892
5890
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
5893
5891
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5894
5892
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5895
|
-
**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:**
|
5893
|
+
**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]
|
5896
5894
|
**name** | **String**| Only return reports matching the customer name. | [optional]
|
5897
5895
|
**integration_id** | **String**| Filter results performing an exact matching against the profile integration identifier. | [optional]
|
5898
5896
|
**campaign_name** | **String**| Only return reports matching the campaign name. | [optional]
|
@@ -5900,7 +5898,7 @@ Name | Type | Description | Notes
|
|
5900
5898
|
|
5901
5899
|
### Return type
|
5902
5900
|
|
5903
|
-
[**
|
5901
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
5904
5902
|
|
5905
5903
|
### Authorization
|
5906
5904
|
|
@@ -5944,7 +5942,7 @@ customer_id = 56 # Integer | The value of the `id` property of a customer profil
|
|
5944
5942
|
opts = {
|
5945
5943
|
page_size: 1000, # Integer | The number of items in the response.
|
5946
5944
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
5947
|
-
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:**
|
5945
|
+
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.
|
5948
5946
|
}
|
5949
5947
|
|
5950
5948
|
begin
|
@@ -5965,7 +5963,7 @@ Name | Type | Description | Notes
|
|
5965
5963
|
**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. |
|
5966
5964
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
5967
5965
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
5968
|
-
**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:**
|
5966
|
+
**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]
|
5969
5967
|
|
5970
5968
|
### Return type
|
5971
5969
|
|
@@ -6042,7 +6040,7 @@ Name | Type | Description | Notes
|
|
6042
6040
|
|
6043
6041
|
## get_customer_profile_achievement_progress
|
6044
6042
|
|
6045
|
-
>
|
6043
|
+
> InlineResponse20049 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
6046
6044
|
|
6047
6045
|
List customer achievements
|
6048
6046
|
|
@@ -6068,7 +6066,7 @@ end
|
|
6068
6066
|
|
6069
6067
|
api_instance = TalonOne::ManagementApi.new
|
6070
6068
|
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
6071
|
-
integration_id = 'integration_id_example' # String | The identifier
|
6069
|
+
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.
|
6072
6070
|
opts = {
|
6073
6071
|
page_size: 50, # Integer | The number of items in the response.
|
6074
6072
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
@@ -6091,7 +6089,7 @@ end
|
|
6091
6089
|
Name | Type | Description | Notes
|
6092
6090
|
------------- | ------------- | ------------- | -------------
|
6093
6091
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
6094
|
-
**integration_id** | **String**| The identifier
|
6092
|
+
**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. |
|
6095
6093
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
6096
6094
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6097
6095
|
**achievement_id** | **Integer**| The ID of the achievement. You can get this ID with the [List achievement](https://docs.talon.one/management-api#tag/Achievements/operation/listAchievements) endpoint. | [optional]
|
@@ -6099,7 +6097,7 @@ Name | Type | Description | Notes
|
|
6099
6097
|
|
6100
6098
|
### Return type
|
6101
6099
|
|
6102
|
-
[**
|
6100
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
6103
6101
|
|
6104
6102
|
### Authorization
|
6105
6103
|
|
@@ -6113,7 +6111,7 @@ Name | Type | Description | Notes
|
|
6113
6111
|
|
6114
6112
|
## get_customer_profiles
|
6115
6113
|
|
6116
|
-
>
|
6114
|
+
> InlineResponse20027 get_customer_profiles(opts)
|
6117
6115
|
|
6118
6116
|
List customer profiles
|
6119
6117
|
|
@@ -6164,7 +6162,7 @@ Name | Type | Description | Notes
|
|
6164
6162
|
|
6165
6163
|
### Return type
|
6166
6164
|
|
6167
|
-
[**
|
6165
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
6168
6166
|
|
6169
6167
|
### Authorization
|
6170
6168
|
|
@@ -6178,7 +6176,7 @@ Name | Type | Description | Notes
|
|
6178
6176
|
|
6179
6177
|
## get_customers_by_attributes
|
6180
6178
|
|
6181
|
-
>
|
6179
|
+
> InlineResponse20026 get_customers_by_attributes(body, opts)
|
6182
6180
|
|
6183
6181
|
List customer profiles matching the given attributes
|
6184
6182
|
|
@@ -6231,7 +6229,7 @@ Name | Type | Description | Notes
|
|
6231
6229
|
|
6232
6230
|
### Return type
|
6233
6231
|
|
6234
|
-
[**
|
6232
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
6235
6233
|
|
6236
6234
|
### Authorization
|
6237
6235
|
|
@@ -6243,9 +6241,76 @@ Name | Type | Description | Notes
|
|
6243
6241
|
- **Accept**: application/json
|
6244
6242
|
|
6245
6243
|
|
6244
|
+
## get_dashboard_statistics
|
6245
|
+
|
6246
|
+
> InlineResponse20016 get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts)
|
6247
|
+
|
6248
|
+
Get statistics for loyalty dashboard
|
6249
|
+
|
6250
|
+
Retrieve the statistics displayed on the specified loyalty program's dashboard, such as the total active points, pending points, spent points, and expired points. **Important:** The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.
|
6251
|
+
|
6252
|
+
### Example
|
6253
|
+
|
6254
|
+
```ruby
|
6255
|
+
# load the gem
|
6256
|
+
require 'talon_one'
|
6257
|
+
# setup authorization
|
6258
|
+
TalonOne.configure do |config|
|
6259
|
+
# Configure API key authorization: management_key
|
6260
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6261
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6262
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6263
|
+
|
6264
|
+
# Configure API key authorization: manager_auth
|
6265
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6266
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6267
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6268
|
+
end
|
6269
|
+
|
6270
|
+
api_instance = TalonOne::ManagementApi.new
|
6271
|
+
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.
|
6272
|
+
range_start = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
6273
|
+
range_end = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
6274
|
+
opts = {
|
6275
|
+
subledger_id: 'subledger_id_example' # String | The ID of the subledger by which we filter the data.
|
6276
|
+
}
|
6277
|
+
|
6278
|
+
begin
|
6279
|
+
#Get statistics for loyalty dashboard
|
6280
|
+
result = api_instance.get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts)
|
6281
|
+
p result
|
6282
|
+
rescue TalonOne::ApiError => e
|
6283
|
+
puts "Exception when calling ManagementApi->get_dashboard_statistics: #{e}"
|
6284
|
+
end
|
6285
|
+
```
|
6286
|
+
|
6287
|
+
### Parameters
|
6288
|
+
|
6289
|
+
|
6290
|
+
Name | Type | Description | Notes
|
6291
|
+
------------- | ------------- | ------------- | -------------
|
6292
|
+
**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. |
|
6293
|
+
**range_start** | **DateTime**| Only return results from after this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
6294
|
+
**range_end** | **DateTime**| Only return results from before this timestamp. **Note:** - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |
|
6295
|
+
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
6296
|
+
|
6297
|
+
### Return type
|
6298
|
+
|
6299
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
6300
|
+
|
6301
|
+
### Authorization
|
6302
|
+
|
6303
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
6304
|
+
|
6305
|
+
### HTTP request headers
|
6306
|
+
|
6307
|
+
- **Content-Type**: Not defined
|
6308
|
+
- **Accept**: application/json
|
6309
|
+
|
6310
|
+
|
6246
6311
|
## get_event_types
|
6247
6312
|
|
6248
|
-
>
|
6313
|
+
> InlineResponse20042 get_event_types(opts)
|
6249
6314
|
|
6250
6315
|
List event types
|
6251
6316
|
|
@@ -6275,7 +6340,7 @@ opts = {
|
|
6275
6340
|
include_old_versions: false, # Boolean | Include all versions of every event type.
|
6276
6341
|
page_size: 1000, # Integer | The number of items in the response.
|
6277
6342
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6278
|
-
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:**
|
6343
|
+
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.
|
6279
6344
|
}
|
6280
6345
|
|
6281
6346
|
begin
|
@@ -6296,11 +6361,11 @@ Name | Type | Description | Notes
|
|
6296
6361
|
**include_old_versions** | **Boolean**| Include all versions of every event type. | [optional] [default to false]
|
6297
6362
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6298
6363
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6299
|
-
**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:**
|
6364
|
+
**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]
|
6300
6365
|
|
6301
6366
|
### Return type
|
6302
6367
|
|
6303
|
-
[**
|
6368
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
6304
6369
|
|
6305
6370
|
### Authorization
|
6306
6371
|
|
@@ -6314,7 +6379,7 @@ Name | Type | Description | Notes
|
|
6314
6379
|
|
6315
6380
|
## get_exports
|
6316
6381
|
|
6317
|
-
>
|
6382
|
+
> InlineResponse20045 get_exports(opts)
|
6318
6383
|
|
6319
6384
|
Get exports
|
6320
6385
|
|
@@ -6369,7 +6434,7 @@ Name | Type | Description | Notes
|
|
6369
6434
|
|
6370
6435
|
### Return type
|
6371
6436
|
|
6372
|
-
[**
|
6437
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
6373
6438
|
|
6374
6439
|
### Authorization
|
6375
6440
|
|
@@ -6444,7 +6509,7 @@ Name | Type | Description | Notes
|
|
6444
6509
|
|
6445
6510
|
## get_loyalty_card_transaction_logs
|
6446
6511
|
|
6447
|
-
>
|
6512
|
+
> InlineResponse20019 get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
|
6448
6513
|
|
6449
6514
|
List card's transactions
|
6450
6515
|
|
@@ -6503,7 +6568,7 @@ Name | Type | Description | Notes
|
|
6503
6568
|
|
6504
6569
|
### Return type
|
6505
6570
|
|
6506
|
-
[**
|
6571
|
+
[**InlineResponse20019**](InlineResponse20019.md)
|
6507
6572
|
|
6508
6573
|
### Authorization
|
6509
6574
|
|
@@ -6517,7 +6582,7 @@ Name | Type | Description | Notes
|
|
6517
6582
|
|
6518
6583
|
## get_loyalty_cards
|
6519
6584
|
|
6520
|
-
>
|
6585
|
+
> InlineResponse20018 get_loyalty_cards(loyalty_program_id, opts)
|
6521
6586
|
|
6522
6587
|
List loyalty cards
|
6523
6588
|
|
@@ -6546,7 +6611,7 @@ loyalty_program_id = 56 # Integer | Identifier of the card-based loyalty program
|
|
6546
6611
|
opts = {
|
6547
6612
|
page_size: 1000, # Integer | The number of items in the response.
|
6548
6613
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6549
|
-
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:**
|
6614
|
+
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.
|
6550
6615
|
identifier: 'identifier_example', # String | The card code by which to filter loyalty cards in the response.
|
6551
6616
|
profile_id: 56, # Integer | Filter results by customer profile ID.
|
6552
6617
|
batch_id: 'batch_id_example' # String | Filter results by loyalty card batch ID.
|
@@ -6569,14 +6634,14 @@ Name | Type | Description | Notes
|
|
6569
6634
|
**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. |
|
6570
6635
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6571
6636
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6572
|
-
**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:**
|
6637
|
+
**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]
|
6573
6638
|
**identifier** | **String**| The card code by which to filter loyalty cards in the response. | [optional]
|
6574
6639
|
**profile_id** | **Integer**| Filter results by customer profile ID. | [optional]
|
6575
6640
|
**batch_id** | **String**| Filter results by loyalty card batch ID. | [optional]
|
6576
6641
|
|
6577
6642
|
### Return type
|
6578
6643
|
|
6579
|
-
[**
|
6644
|
+
[**InlineResponse20018**](InlineResponse20018.md)
|
6580
6645
|
|
6581
6646
|
### Authorization
|
6582
6647
|
|
@@ -6616,7 +6681,7 @@ end
|
|
6616
6681
|
|
6617
6682
|
api_instance = TalonOne::ManagementApi.new
|
6618
6683
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
6619
|
-
integration_id = 'integration_id_example' # String | The identifier
|
6684
|
+
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.
|
6620
6685
|
|
6621
6686
|
begin
|
6622
6687
|
#Get customer's full loyalty ledger
|
@@ -6633,7 +6698,7 @@ end
|
|
6633
6698
|
Name | Type | Description | Notes
|
6634
6699
|
------------- | ------------- | ------------- | -------------
|
6635
6700
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
6636
|
-
**integration_id** | **String**| The identifier
|
6701
|
+
**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. |
|
6637
6702
|
|
6638
6703
|
### Return type
|
6639
6704
|
|
@@ -6710,7 +6775,7 @@ Name | Type | Description | Notes
|
|
6710
6775
|
|
6711
6776
|
## get_loyalty_program_transactions
|
6712
6777
|
|
6713
|
-
>
|
6778
|
+
> InlineResponse20017 get_loyalty_program_transactions(loyalty_program_id, opts)
|
6714
6779
|
|
6715
6780
|
List loyalty program transactions
|
6716
6781
|
|
@@ -6769,7 +6834,7 @@ Name | Type | Description | Notes
|
|
6769
6834
|
|
6770
6835
|
### Return type
|
6771
6836
|
|
6772
|
-
[**
|
6837
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
6773
6838
|
|
6774
6839
|
### Authorization
|
6775
6840
|
|
@@ -6783,7 +6848,7 @@ Name | Type | Description | Notes
|
|
6783
6848
|
|
6784
6849
|
## get_loyalty_programs
|
6785
6850
|
|
6786
|
-
>
|
6851
|
+
> InlineResponse20015 get_loyalty_programs
|
6787
6852
|
|
6788
6853
|
List loyalty programs
|
6789
6854
|
|
@@ -6824,7 +6889,7 @@ This endpoint does not need any parameter.
|
|
6824
6889
|
|
6825
6890
|
### Return type
|
6826
6891
|
|
6827
|
-
[**
|
6892
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
6828
6893
|
|
6829
6894
|
### Authorization
|
6830
6895
|
|
@@ -6842,7 +6907,7 @@ This endpoint does not need any parameter.
|
|
6842
6907
|
|
6843
6908
|
Get loyalty program statistics
|
6844
6909
|
|
6845
|
-
|
6910
|
+
⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To retrieve statistics for a loyalty program, use the [Get statistics for loyalty dashboard](/management-api#tag/Loyalty/operation/getDashboardStatistics) endpoint. Retrieve the statistics of the specified loyalty program, such as the total active points, pending points, spent points, and expired points.
|
6846
6911
|
|
6847
6912
|
### Example
|
6848
6913
|
|
@@ -6895,9 +6960,96 @@ Name | Type | Description | Notes
|
|
6895
6960
|
- **Accept**: application/json
|
6896
6961
|
|
6897
6962
|
|
6963
|
+
## get_message_logs
|
6964
|
+
|
6965
|
+
> MessageLogEntries get_message_logs(entity_type, opts)
|
6966
|
+
|
6967
|
+
List message log entries
|
6968
|
+
|
6969
|
+
Retrieve all message log entries.
|
6970
|
+
|
6971
|
+
### Example
|
6972
|
+
|
6973
|
+
```ruby
|
6974
|
+
# load the gem
|
6975
|
+
require 'talon_one'
|
6976
|
+
# setup authorization
|
6977
|
+
TalonOne.configure do |config|
|
6978
|
+
# Configure API key authorization: management_key
|
6979
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6980
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6981
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6982
|
+
|
6983
|
+
# Configure API key authorization: manager_auth
|
6984
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6985
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6986
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6987
|
+
end
|
6988
|
+
|
6989
|
+
api_instance = TalonOne::ManagementApi.new
|
6990
|
+
entity_type = 'entity_type_example' # String | The entity type the log is related to.
|
6991
|
+
opts = {
|
6992
|
+
message_id: 'message_id_example', # String | Filter results by message ID.
|
6993
|
+
change_type: 'change_type_example', # String | Filter results by change type.
|
6994
|
+
notification_i_ds: 'notification_i_ds_example', # String | Filter results by notification ID (include up to 30 values, separated by a comma).
|
6995
|
+
created_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6996
|
+
created_after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
6997
|
+
cursor: 'cursor_example', # String | A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
6998
|
+
period: 'period_example', # String | Filter results by time period. Choose between the available relative time frames.
|
6999
|
+
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.
|
7000
|
+
application_id: 3.4, # Float | Filter results by Application ID.
|
7001
|
+
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
7002
|
+
loyalty_program_id: 56, # Integer | Identifier of the loyalty program.
|
7003
|
+
response_code: 56, # Integer | Filter results by response status code.
|
7004
|
+
webhook_i_ds: 'webhook_i_ds_example' # String | Filter results by webhook ID (include up to 30 values, separated by a comma).
|
7005
|
+
}
|
7006
|
+
|
7007
|
+
begin
|
7008
|
+
#List message log entries
|
7009
|
+
result = api_instance.get_message_logs(entity_type, opts)
|
7010
|
+
p result
|
7011
|
+
rescue TalonOne::ApiError => e
|
7012
|
+
puts "Exception when calling ManagementApi->get_message_logs: #{e}"
|
7013
|
+
end
|
7014
|
+
```
|
7015
|
+
|
7016
|
+
### Parameters
|
7017
|
+
|
7018
|
+
|
7019
|
+
Name | Type | Description | Notes
|
7020
|
+
------------- | ------------- | ------------- | -------------
|
7021
|
+
**entity_type** | **String**| The entity type the log is related to. |
|
7022
|
+
**message_id** | **String**| Filter results by message ID. | [optional]
|
7023
|
+
**change_type** | **String**| Filter results by change type. | [optional]
|
7024
|
+
**notification_i_ds** | **String**| Filter results by notification ID (include up to 30 values, separated by a comma). | [optional]
|
7025
|
+
**created_before** | **DateTime**| Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | [optional]
|
7026
|
+
**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]
|
7027
|
+
**cursor** | **String**| A specific unique value in the database. If this value is not given, the server fetches results starting with the first record. | [optional]
|
7028
|
+
**period** | **String**| Filter results by time period. Choose between the available relative time frames. | [optional]
|
7029
|
+
**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]
|
7030
|
+
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
7031
|
+
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
7032
|
+
**loyalty_program_id** | **Integer**| Identifier of the loyalty program. | [optional]
|
7033
|
+
**response_code** | **Integer**| Filter results by response status code. | [optional]
|
7034
|
+
**webhook_i_ds** | **String**| Filter results by webhook ID (include up to 30 values, separated by a comma). | [optional]
|
7035
|
+
|
7036
|
+
### Return type
|
7037
|
+
|
7038
|
+
[**MessageLogEntries**](MessageLogEntries.md)
|
7039
|
+
|
7040
|
+
### Authorization
|
7041
|
+
|
7042
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
7043
|
+
|
7044
|
+
### HTTP request headers
|
7045
|
+
|
7046
|
+
- **Content-Type**: Not defined
|
7047
|
+
- **Accept**: application/json
|
7048
|
+
|
7049
|
+
|
6898
7050
|
## get_referrals_without_total_count
|
6899
7051
|
|
6900
|
-
>
|
7052
|
+
> InlineResponse20012 get_referrals_without_total_count(application_id, campaign_id, opts)
|
6901
7053
|
|
6902
7054
|
List referrals
|
6903
7055
|
|
@@ -6927,7 +7079,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
6927
7079
|
opts = {
|
6928
7080
|
page_size: 1000, # Integer | The number of items in the response.
|
6929
7081
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
6930
|
-
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:**
|
7082
|
+
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.
|
6931
7083
|
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.
|
6932
7084
|
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.
|
6933
7085
|
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.
|
@@ -6954,7 +7106,7 @@ Name | Type | Description | Notes
|
|
6954
7106
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
6955
7107
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
6956
7108
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6957
|
-
**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:**
|
7109
|
+
**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]
|
6958
7110
|
**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]
|
6959
7111
|
**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]
|
6960
7112
|
**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]
|
@@ -6964,7 +7116,7 @@ Name | Type | Description | Notes
|
|
6964
7116
|
|
6965
7117
|
### Return type
|
6966
7118
|
|
6967
|
-
[**
|
7119
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
6968
7120
|
|
6969
7121
|
### Authorization
|
6970
7122
|
|
@@ -7100,7 +7252,7 @@ Name | Type | Description | Notes
|
|
7100
7252
|
|
7101
7253
|
## get_rulesets
|
7102
7254
|
|
7103
|
-
>
|
7255
|
+
> InlineResponse2009 get_rulesets(application_id, campaign_id, opts)
|
7104
7256
|
|
7105
7257
|
List campaign rulesets
|
7106
7258
|
|
@@ -7130,7 +7282,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
7130
7282
|
opts = {
|
7131
7283
|
page_size: 1000, # Integer | The number of items in the response.
|
7132
7284
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7133
|
-
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:**
|
7285
|
+
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.
|
7134
7286
|
}
|
7135
7287
|
|
7136
7288
|
begin
|
@@ -7151,11 +7303,11 @@ Name | Type | Description | Notes
|
|
7151
7303
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
7152
7304
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7153
7305
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7154
|
-
**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:**
|
7306
|
+
**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]
|
7155
7307
|
|
7156
7308
|
### Return type
|
7157
7309
|
|
7158
|
-
[**
|
7310
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
7159
7311
|
|
7160
7312
|
### Authorization
|
7161
7313
|
|
@@ -7289,7 +7441,7 @@ Name | Type | Description | Notes
|
|
7289
7441
|
|
7290
7442
|
## get_users
|
7291
7443
|
|
7292
|
-
>
|
7444
|
+
> InlineResponse20043 get_users(opts)
|
7293
7445
|
|
7294
7446
|
List users in account
|
7295
7447
|
|
@@ -7317,7 +7469,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7317
7469
|
opts = {
|
7318
7470
|
page_size: 1000, # Integer | The number of items in the response.
|
7319
7471
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7320
|
-
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:**
|
7472
|
+
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.
|
7321
7473
|
}
|
7322
7474
|
|
7323
7475
|
begin
|
@@ -7336,11 +7488,11 @@ Name | Type | Description | Notes
|
|
7336
7488
|
------------- | ------------- | ------------- | -------------
|
7337
7489
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7338
7490
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7339
|
-
**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:**
|
7491
|
+
**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]
|
7340
7492
|
|
7341
7493
|
### Return type
|
7342
7494
|
|
7343
|
-
[**
|
7495
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
7344
7496
|
|
7345
7497
|
### Authorization
|
7346
7498
|
|
@@ -7413,7 +7565,7 @@ Name | Type | Description | Notes
|
|
7413
7565
|
|
7414
7566
|
## get_webhook_activation_logs
|
7415
7567
|
|
7416
|
-
>
|
7568
|
+
> InlineResponse20040 get_webhook_activation_logs(opts)
|
7417
7569
|
|
7418
7570
|
List webhook activation log entries
|
7419
7571
|
|
@@ -7441,7 +7593,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7441
7593
|
opts = {
|
7442
7594
|
page_size: 1000, # Integer | The number of items in the response.
|
7443
7595
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7444
|
-
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:**
|
7596
|
+
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.
|
7445
7597
|
integration_request_uuid: 'integration_request_uuid_example', # String | Filter results by integration request UUID.
|
7446
7598
|
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7447
7599
|
application_id: 3.4, # Float | Filter results by Application ID.
|
@@ -7466,7 +7618,7 @@ Name | Type | Description | Notes
|
|
7466
7618
|
------------- | ------------- | ------------- | -------------
|
7467
7619
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7468
7620
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7469
|
-
**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:**
|
7621
|
+
**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]
|
7470
7622
|
**integration_request_uuid** | **String**| Filter results by integration request UUID. | [optional]
|
7471
7623
|
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7472
7624
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
@@ -7476,7 +7628,7 @@ Name | Type | Description | Notes
|
|
7476
7628
|
|
7477
7629
|
### Return type
|
7478
7630
|
|
7479
|
-
[**
|
7631
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
7480
7632
|
|
7481
7633
|
### Authorization
|
7482
7634
|
|
@@ -7490,7 +7642,7 @@ Name | Type | Description | Notes
|
|
7490
7642
|
|
7491
7643
|
## get_webhook_logs
|
7492
7644
|
|
7493
|
-
>
|
7645
|
+
> InlineResponse20041 get_webhook_logs(opts)
|
7494
7646
|
|
7495
7647
|
List webhook log entries
|
7496
7648
|
|
@@ -7518,7 +7670,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
7518
7670
|
opts = {
|
7519
7671
|
page_size: 1000, # Integer | The number of items in the response.
|
7520
7672
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7521
|
-
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:**
|
7673
|
+
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7522
7674
|
status: 'status_example', # String | Filter results by HTTP status codes.
|
7523
7675
|
webhook_id: 3.4, # Float | Filter results by webhook id.
|
7524
7676
|
application_id: 3.4, # Float | Filter results by Application ID.
|
@@ -7544,7 +7696,7 @@ Name | Type | Description | Notes
|
|
7544
7696
|
------------- | ------------- | ------------- | -------------
|
7545
7697
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7546
7698
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7547
|
-
**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:**
|
7699
|
+
**sort** | **String**| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations. | [optional]
|
7548
7700
|
**status** | **String**| Filter results by HTTP status codes. | [optional]
|
7549
7701
|
**webhook_id** | **Float**| Filter results by webhook id. | [optional]
|
7550
7702
|
**application_id** | **Float**| Filter results by Application ID. | [optional]
|
@@ -7555,7 +7707,7 @@ Name | Type | Description | Notes
|
|
7555
7707
|
|
7556
7708
|
### Return type
|
7557
7709
|
|
7558
|
-
[**
|
7710
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
7559
7711
|
|
7560
7712
|
### Authorization
|
7561
7713
|
|
@@ -7569,7 +7721,7 @@ Name | Type | Description | Notes
|
|
7569
7721
|
|
7570
7722
|
## get_webhooks
|
7571
7723
|
|
7572
|
-
>
|
7724
|
+
> InlineResponse20039 get_webhooks(opts)
|
7573
7725
|
|
7574
7726
|
List webhooks
|
7575
7727
|
|
@@ -7596,7 +7748,7 @@ end
|
|
7596
7748
|
api_instance = TalonOne::ManagementApi.new
|
7597
7749
|
opts = {
|
7598
7750
|
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.
|
7599
|
-
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:**
|
7751
|
+
sort: 'sort_example', # String | The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
7600
7752
|
page_size: 1000, # Integer | The number of items in the response.
|
7601
7753
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
7602
7754
|
creation_type: 'creation_type_example', # String | Filter results by creation type.
|
@@ -7620,7 +7772,7 @@ end
|
|
7620
7772
|
Name | Type | Description | Notes
|
7621
7773
|
------------- | ------------- | ------------- | -------------
|
7622
7774
|
**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]
|
7623
|
-
**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:**
|
7775
|
+
**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]
|
7624
7776
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
7625
7777
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
7626
7778
|
**creation_type** | **String**| Filter results by creation type. | [optional]
|
@@ -7630,7 +7782,7 @@ Name | Type | Description | Notes
|
|
7630
7782
|
|
7631
7783
|
### Return type
|
7632
7784
|
|
7633
|
-
[**
|
7785
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
7634
7786
|
|
7635
7787
|
### Authorization
|
7636
7788
|
|
@@ -8407,7 +8559,7 @@ nil (empty response body)
|
|
8407
8559
|
|
8408
8560
|
## list_account_collections
|
8409
8561
|
|
8410
|
-
>
|
8562
|
+
> InlineResponse20020 list_account_collections(opts)
|
8411
8563
|
|
8412
8564
|
List collections in account
|
8413
8565
|
|
@@ -8435,7 +8587,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
8435
8587
|
opts = {
|
8436
8588
|
page_size: 1000, # Integer | The number of items in the response.
|
8437
8589
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8438
|
-
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:**
|
8590
|
+
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.
|
8439
8591
|
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.
|
8440
8592
|
name: 'name_example' # String | Filter by collection name.
|
8441
8593
|
}
|
@@ -8456,13 +8608,13 @@ Name | Type | Description | Notes
|
|
8456
8608
|
------------- | ------------- | ------------- | -------------
|
8457
8609
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8458
8610
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8459
|
-
**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:**
|
8611
|
+
**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]
|
8460
8612
|
**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]
|
8461
8613
|
**name** | **String**| Filter by collection name. | [optional]
|
8462
8614
|
|
8463
8615
|
### Return type
|
8464
8616
|
|
8465
|
-
[**
|
8617
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8466
8618
|
|
8467
8619
|
### Authorization
|
8468
8620
|
|
@@ -8476,7 +8628,7 @@ Name | Type | Description | Notes
|
|
8476
8628
|
|
8477
8629
|
## list_achievements
|
8478
8630
|
|
8479
|
-
>
|
8631
|
+
> InlineResponse20048 list_achievements(application_id, campaign_id, opts)
|
8480
8632
|
|
8481
8633
|
List achievements
|
8482
8634
|
|
@@ -8531,7 +8683,7 @@ Name | Type | Description | Notes
|
|
8531
8683
|
|
8532
8684
|
### Return type
|
8533
8685
|
|
8534
|
-
[**
|
8686
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
8535
8687
|
|
8536
8688
|
### Authorization
|
8537
8689
|
|
@@ -8545,7 +8697,7 @@ Name | Type | Description | Notes
|
|
8545
8697
|
|
8546
8698
|
## list_all_roles_v2
|
8547
8699
|
|
8548
|
-
>
|
8700
|
+
> InlineResponse20046 list_all_roles_v2
|
8549
8701
|
|
8550
8702
|
List roles
|
8551
8703
|
|
@@ -8586,7 +8738,7 @@ This endpoint does not need any parameter.
|
|
8586
8738
|
|
8587
8739
|
### Return type
|
8588
8740
|
|
8589
|
-
[**
|
8741
|
+
[**InlineResponse20046**](InlineResponse20046.md)
|
8590
8742
|
|
8591
8743
|
### Authorization
|
8592
8744
|
|
@@ -8600,7 +8752,7 @@ This endpoint does not need any parameter.
|
|
8600
8752
|
|
8601
8753
|
## list_catalog_items
|
8602
8754
|
|
8603
|
-
>
|
8755
|
+
> InlineResponse20037 list_catalog_items(catalog_id, opts)
|
8604
8756
|
|
8605
8757
|
List items in a catalog
|
8606
8758
|
|
@@ -8657,7 +8809,7 @@ Name | Type | Description | Notes
|
|
8657
8809
|
|
8658
8810
|
### Return type
|
8659
8811
|
|
8660
|
-
[**
|
8812
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
8661
8813
|
|
8662
8814
|
### Authorization
|
8663
8815
|
|
@@ -8671,7 +8823,7 @@ Name | Type | Description | Notes
|
|
8671
8823
|
|
8672
8824
|
## list_collections
|
8673
8825
|
|
8674
|
-
>
|
8826
|
+
> InlineResponse20020 list_collections(application_id, campaign_id, opts)
|
8675
8827
|
|
8676
8828
|
List collections in campaign
|
8677
8829
|
|
@@ -8701,7 +8853,7 @@ campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Tal
|
|
8701
8853
|
opts = {
|
8702
8854
|
page_size: 1000, # Integer | The number of items in the response.
|
8703
8855
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8704
|
-
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:**
|
8856
|
+
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.
|
8705
8857
|
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.
|
8706
8858
|
name: 'name_example' # String | Filter by collection name.
|
8707
8859
|
}
|
@@ -8724,13 +8876,13 @@ Name | Type | Description | Notes
|
|
8724
8876
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
8725
8877
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8726
8878
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8727
|
-
**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:**
|
8879
|
+
**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]
|
8728
8880
|
**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]
|
8729
8881
|
**name** | **String**| Filter by collection name. | [optional]
|
8730
8882
|
|
8731
8883
|
### Return type
|
8732
8884
|
|
8733
|
-
[**
|
8885
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8734
8886
|
|
8735
8887
|
### Authorization
|
8736
8888
|
|
@@ -8744,7 +8896,7 @@ Name | Type | Description | Notes
|
|
8744
8896
|
|
8745
8897
|
## list_collections_in_application
|
8746
8898
|
|
8747
|
-
>
|
8899
|
+
> InlineResponse20020 list_collections_in_application(application_id, opts)
|
8748
8900
|
|
8749
8901
|
List collections in Application
|
8750
8902
|
|
@@ -8773,7 +8925,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
8773
8925
|
opts = {
|
8774
8926
|
page_size: 1000, # Integer | The number of items in the response.
|
8775
8927
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8776
|
-
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:**
|
8928
|
+
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.
|
8777
8929
|
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.
|
8778
8930
|
name: 'name_example' # String | Filter by collection name.
|
8779
8931
|
}
|
@@ -8795,13 +8947,13 @@ Name | Type | Description | Notes
|
|
8795
8947
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8796
8948
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8797
8949
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8798
|
-
**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:**
|
8950
|
+
**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]
|
8799
8951
|
**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]
|
8800
8952
|
**name** | **String**| Filter by collection name. | [optional]
|
8801
8953
|
|
8802
8954
|
### Return type
|
8803
8955
|
|
8804
|
-
[**
|
8956
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8805
8957
|
|
8806
8958
|
### Authorization
|
8807
8959
|
|
@@ -8815,7 +8967,7 @@ Name | Type | Description | Notes
|
|
8815
8967
|
|
8816
8968
|
## list_stores
|
8817
8969
|
|
8818
|
-
>
|
8970
|
+
> InlineResponse20047 list_stores(application_id, opts)
|
8819
8971
|
|
8820
8972
|
List stores
|
8821
8973
|
|
@@ -8844,7 +8996,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
8844
8996
|
opts = {
|
8845
8997
|
page_size: 1000, # Integer | The number of items in the response.
|
8846
8998
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
8847
|
-
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:**
|
8999
|
+
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.
|
8848
9000
|
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.
|
8849
9001
|
campaign_id: 3.4, # Float | Filter results by campaign ID.
|
8850
9002
|
name: 'name_example', # String | The name of the store.
|
@@ -8869,7 +9021,7 @@ Name | Type | Description | Notes
|
|
8869
9021
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
8870
9022
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
8871
9023
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
8872
|
-
**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:**
|
9024
|
+
**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]
|
8873
9025
|
**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]
|
8874
9026
|
**campaign_id** | **Float**| Filter results by campaign ID. | [optional]
|
8875
9027
|
**name** | **String**| The name of the store. | [optional]
|
@@ -8878,7 +9030,7 @@ Name | Type | Description | Notes
|
|
8878
9030
|
|
8879
9031
|
### Return type
|
8880
9032
|
|
8881
|
-
[**
|
9033
|
+
[**InlineResponse20047**](InlineResponse20047.md)
|
8882
9034
|
|
8883
9035
|
### Authorization
|
8884
9036
|
|
@@ -8890,66 +9042,6 @@ Name | Type | Description | Notes
|
|
8890
9042
|
- **Accept**: application/json
|
8891
9043
|
|
8892
9044
|
|
8893
|
-
## notification_activation
|
8894
|
-
|
8895
|
-
> notification_activation(notification_id, body)
|
8896
|
-
|
8897
|
-
Activate or deactivate notification
|
8898
|
-
|
8899
|
-
Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
8900
|
-
|
8901
|
-
### Example
|
8902
|
-
|
8903
|
-
```ruby
|
8904
|
-
# load the gem
|
8905
|
-
require 'talon_one'
|
8906
|
-
# setup authorization
|
8907
|
-
TalonOne.configure do |config|
|
8908
|
-
# Configure API key authorization: management_key
|
8909
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
8910
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8911
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8912
|
-
|
8913
|
-
# Configure API key authorization: manager_auth
|
8914
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
8915
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
8916
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
8917
|
-
end
|
8918
|
-
|
8919
|
-
api_instance = TalonOne::ManagementApi.new
|
8920
|
-
notification_id = 56 # Integer | The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
8921
|
-
body = TalonOne::NotificationActivation.new # NotificationActivation | body
|
8922
|
-
|
8923
|
-
begin
|
8924
|
-
#Activate or deactivate notification
|
8925
|
-
api_instance.notification_activation(notification_id, body)
|
8926
|
-
rescue TalonOne::ApiError => e
|
8927
|
-
puts "Exception when calling ManagementApi->notification_activation: #{e}"
|
8928
|
-
end
|
8929
|
-
```
|
8930
|
-
|
8931
|
-
### Parameters
|
8932
|
-
|
8933
|
-
|
8934
|
-
Name | Type | Description | Notes
|
8935
|
-
------------- | ------------- | ------------- | -------------
|
8936
|
-
**notification_id** | **Integer**| The ID of the notification. Get it with the appropriate _List notifications_ endpoint. |
|
8937
|
-
**body** | [**NotificationActivation**](NotificationActivation.md)| body |
|
8938
|
-
|
8939
|
-
### Return type
|
8940
|
-
|
8941
|
-
nil (empty response body)
|
8942
|
-
|
8943
|
-
### Authorization
|
8944
|
-
|
8945
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
8946
|
-
|
8947
|
-
### HTTP request headers
|
8948
|
-
|
8949
|
-
- **Content-Type**: application/json
|
8950
|
-
- **Accept**: Not defined
|
8951
|
-
|
8952
|
-
|
8953
9045
|
## okta_event_handler_challenge
|
8954
9046
|
|
8955
9047
|
> okta_event_handler_challenge
|
@@ -9004,189 +9096,6 @@ nil (empty response body)
|
|
9004
9096
|
- **Accept**: Not defined
|
9005
9097
|
|
9006
9098
|
|
9007
|
-
## post_added_deducted_points_notification
|
9008
|
-
|
9009
|
-
> BaseNotification post_added_deducted_points_notification(loyalty_program_id, body)
|
9010
|
-
|
9011
|
-
Create notification about added or deducted loyalty points
|
9012
|
-
|
9013
|
-
Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
9014
|
-
|
9015
|
-
### Example
|
9016
|
-
|
9017
|
-
```ruby
|
9018
|
-
# load the gem
|
9019
|
-
require 'talon_one'
|
9020
|
-
# setup authorization
|
9021
|
-
TalonOne.configure do |config|
|
9022
|
-
# Configure API key authorization: management_key
|
9023
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9024
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9025
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9026
|
-
|
9027
|
-
# Configure API key authorization: manager_auth
|
9028
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9029
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9030
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9031
|
-
end
|
9032
|
-
|
9033
|
-
api_instance = TalonOne::ManagementApi.new
|
9034
|
-
loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9035
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9036
|
-
|
9037
|
-
begin
|
9038
|
-
#Create notification about added or deducted loyalty points
|
9039
|
-
result = api_instance.post_added_deducted_points_notification(loyalty_program_id, body)
|
9040
|
-
p result
|
9041
|
-
rescue TalonOne::ApiError => e
|
9042
|
-
puts "Exception when calling ManagementApi->post_added_deducted_points_notification: #{e}"
|
9043
|
-
end
|
9044
|
-
```
|
9045
|
-
|
9046
|
-
### Parameters
|
9047
|
-
|
9048
|
-
|
9049
|
-
Name | Type | Description | Notes
|
9050
|
-
------------- | ------------- | ------------- | -------------
|
9051
|
-
**loyalty_program_id** | **Integer**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
9052
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9053
|
-
|
9054
|
-
### Return type
|
9055
|
-
|
9056
|
-
[**BaseNotification**](BaseNotification.md)
|
9057
|
-
|
9058
|
-
### Authorization
|
9059
|
-
|
9060
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9061
|
-
|
9062
|
-
### HTTP request headers
|
9063
|
-
|
9064
|
-
- **Content-Type**: application/json
|
9065
|
-
- **Accept**: application/json
|
9066
|
-
|
9067
|
-
|
9068
|
-
## post_catalogs_strikethrough_notification
|
9069
|
-
|
9070
|
-
> BaseNotification post_catalogs_strikethrough_notification(application_id, body)
|
9071
|
-
|
9072
|
-
Create strikethrough notification
|
9073
|
-
|
9074
|
-
Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
9075
|
-
|
9076
|
-
### Example
|
9077
|
-
|
9078
|
-
```ruby
|
9079
|
-
# load the gem
|
9080
|
-
require 'talon_one'
|
9081
|
-
# setup authorization
|
9082
|
-
TalonOne.configure do |config|
|
9083
|
-
# Configure API key authorization: management_key
|
9084
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9085
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9086
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9087
|
-
|
9088
|
-
# Configure API key authorization: manager_auth
|
9089
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9090
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9091
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9092
|
-
end
|
9093
|
-
|
9094
|
-
api_instance = TalonOne::ManagementApi.new
|
9095
|
-
application_id = 56 # Integer | The ID of the Application. It is displayed in your Talon.One deployment URL.
|
9096
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9097
|
-
|
9098
|
-
begin
|
9099
|
-
#Create strikethrough notification
|
9100
|
-
result = api_instance.post_catalogs_strikethrough_notification(application_id, body)
|
9101
|
-
p result
|
9102
|
-
rescue TalonOne::ApiError => e
|
9103
|
-
puts "Exception when calling ManagementApi->post_catalogs_strikethrough_notification: #{e}"
|
9104
|
-
end
|
9105
|
-
```
|
9106
|
-
|
9107
|
-
### Parameters
|
9108
|
-
|
9109
|
-
|
9110
|
-
Name | Type | Description | Notes
|
9111
|
-
------------- | ------------- | ------------- | -------------
|
9112
|
-
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
9113
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9114
|
-
|
9115
|
-
### Return type
|
9116
|
-
|
9117
|
-
[**BaseNotification**](BaseNotification.md)
|
9118
|
-
|
9119
|
-
### Authorization
|
9120
|
-
|
9121
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9122
|
-
|
9123
|
-
### HTTP request headers
|
9124
|
-
|
9125
|
-
- **Content-Type**: application/json
|
9126
|
-
- **Accept**: application/json
|
9127
|
-
|
9128
|
-
|
9129
|
-
## post_pending_points_notification
|
9130
|
-
|
9131
|
-
> BaseNotification post_pending_points_notification(loyalty_program_id, body)
|
9132
|
-
|
9133
|
-
Create notification about pending loyalty points
|
9134
|
-
|
9135
|
-
Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
9136
|
-
|
9137
|
-
### Example
|
9138
|
-
|
9139
|
-
```ruby
|
9140
|
-
# load the gem
|
9141
|
-
require 'talon_one'
|
9142
|
-
# setup authorization
|
9143
|
-
TalonOne.configure do |config|
|
9144
|
-
# Configure API key authorization: management_key
|
9145
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9146
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9147
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9148
|
-
|
9149
|
-
# Configure API key authorization: manager_auth
|
9150
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
9151
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
9152
|
-
#config.api_key_prefix['Authorization'] = 'Bearer'
|
9153
|
-
end
|
9154
|
-
|
9155
|
-
api_instance = TalonOne::ManagementApi.new
|
9156
|
-
loyalty_program_id = 56 # Integer | Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
9157
|
-
body = TalonOne::NewBaseNotification.new # NewBaseNotification | body
|
9158
|
-
|
9159
|
-
begin
|
9160
|
-
#Create notification about pending loyalty points
|
9161
|
-
result = api_instance.post_pending_points_notification(loyalty_program_id, body)
|
9162
|
-
p result
|
9163
|
-
rescue TalonOne::ApiError => e
|
9164
|
-
puts "Exception when calling ManagementApi->post_pending_points_notification: #{e}"
|
9165
|
-
end
|
9166
|
-
```
|
9167
|
-
|
9168
|
-
### Parameters
|
9169
|
-
|
9170
|
-
|
9171
|
-
Name | Type | Description | Notes
|
9172
|
-
------------- | ------------- | ------------- | -------------
|
9173
|
-
**loyalty_program_id** | **Integer**| Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint. |
|
9174
|
-
**body** | [**NewBaseNotification**](NewBaseNotification.md)| body |
|
9175
|
-
|
9176
|
-
### Return type
|
9177
|
-
|
9178
|
-
[**BaseNotification**](BaseNotification.md)
|
9179
|
-
|
9180
|
-
### Authorization
|
9181
|
-
|
9182
|
-
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
9183
|
-
|
9184
|
-
### HTTP request headers
|
9185
|
-
|
9186
|
-
- **Content-Type**: application/json
|
9187
|
-
- **Accept**: application/json
|
9188
|
-
|
9189
|
-
|
9190
9099
|
## remove_loyalty_points
|
9191
9100
|
|
9192
9101
|
> remove_loyalty_points(loyalty_program_id, integration_id, body)
|
@@ -9215,7 +9124,7 @@ end
|
|
9215
9124
|
|
9216
9125
|
api_instance = TalonOne::ManagementApi.new
|
9217
9126
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
9218
|
-
integration_id = 'integration_id_example' # String | The identifier
|
9127
|
+
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.
|
9219
9128
|
body = TalonOne::DeductLoyaltyPoints.new # DeductLoyaltyPoints | body
|
9220
9129
|
|
9221
9130
|
begin
|
@@ -9232,7 +9141,7 @@ end
|
|
9232
9141
|
Name | Type | Description | Notes
|
9233
9142
|
------------- | ------------- | ------------- | -------------
|
9234
9143
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
9235
|
-
**integration_id** | **String**| The identifier
|
9144
|
+
**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. |
|
9236
9145
|
**body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
|
9237
9146
|
|
9238
9147
|
### Return type
|
@@ -9828,7 +9737,7 @@ Name | Type | Description | Notes
|
|
9828
9737
|
|
9829
9738
|
## search_coupons_advanced_application_wide_without_total_count
|
9830
9739
|
|
9831
|
-
>
|
9740
|
+
> InlineResponse20011 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
9832
9741
|
|
9833
9742
|
List coupons that match the given attributes (without total count)
|
9834
9743
|
|
@@ -9858,7 +9767,7 @@ body = nil # Object | body
|
|
9858
9767
|
opts = {
|
9859
9768
|
page_size: 1000, # Integer | The number of items in the response.
|
9860
9769
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
9861
|
-
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:**
|
9770
|
+
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.
|
9862
9771
|
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.
|
9863
9772
|
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.
|
9864
9773
|
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.
|
@@ -9889,7 +9798,7 @@ Name | Type | Description | Notes
|
|
9889
9798
|
**body** | **Object**| body |
|
9890
9799
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
9891
9800
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
9892
|
-
**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:**
|
9801
|
+
**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]
|
9893
9802
|
**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]
|
9894
9803
|
**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]
|
9895
9804
|
**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]
|
@@ -9903,7 +9812,7 @@ Name | Type | Description | Notes
|
|
9903
9812
|
|
9904
9813
|
### Return type
|
9905
9814
|
|
9906
|
-
[**
|
9815
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
9907
9816
|
|
9908
9817
|
### Authorization
|
9909
9818
|
|
@@ -9917,7 +9826,7 @@ Name | Type | Description | Notes
|
|
9917
9826
|
|
9918
9827
|
## search_coupons_advanced_without_total_count
|
9919
9828
|
|
9920
|
-
>
|
9829
|
+
> InlineResponse20011 search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts)
|
9921
9830
|
|
9922
9831
|
List coupons that match the given attributes in campaign (without total count)
|
9923
9832
|
|
@@ -9948,7 +9857,7 @@ body = nil # Object | body
|
|
9948
9857
|
opts = {
|
9949
9858
|
page_size: 1000, # Integer | The number of items in the response.
|
9950
9859
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
9951
|
-
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:**
|
9860
|
+
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.
|
9952
9861
|
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.
|
9953
9862
|
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.
|
9954
9863
|
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.
|
@@ -9979,7 +9888,7 @@ Name | Type | Description | Notes
|
|
9979
9888
|
**body** | **Object**| body |
|
9980
9889
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 1000]
|
9981
9890
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
9982
|
-
**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:**
|
9891
|
+
**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]
|
9983
9892
|
**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]
|
9984
9893
|
**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]
|
9985
9894
|
**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]
|
@@ -9992,7 +9901,7 @@ Name | Type | Description | Notes
|
|
9992
9901
|
|
9993
9902
|
### Return type
|
9994
9903
|
|
9995
|
-
[**
|
9904
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
9996
9905
|
|
9997
9906
|
### Authorization
|
9998
9907
|
|
@@ -10742,7 +10651,7 @@ end
|
|
10742
10651
|
Name | Type | Description | Notes
|
10743
10652
|
------------- | ------------- | ------------- | -------------
|
10744
10653
|
**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. |
|
10745
|
-
**body** | **RoleV2Base
|
10654
|
+
**body** | [**RoleV2Base**](RoleV2Base.md)| body |
|
10746
10655
|
|
10747
10656
|
### Return type
|
10748
10657
|
|