talon_one 7.0.0 → 8.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 +24 -7
- data/docs/Achievement.md +6 -4
- data/docs/AchievementAdditionalProperties.md +5 -3
- data/docs/AchievementProgress.md +3 -15
- data/docs/AddFreeItemEffectProps.md +3 -1
- data/docs/AdditionalCampaignProperties.md +4 -2
- data/docs/AnalyticsProduct.md +6 -6
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- 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/CampaignEvaluationGroup.md +1 -1
- data/docs/CampaignNotificationPolicy.md +3 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -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/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/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 +156 -18
- data/docs/LedgerInfo.md +4 -0
- 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/LoyaltyProgram.md +1 -1
- data/docs/LoyaltyProgramBalance.md +5 -1
- data/docs/LoyaltySubLedger.md +2 -0
- data/docs/ManagementApi.md +184 -116
- data/docs/ManagementKey.md +3 -1
- 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/PendingPointsNotificationPolicy.md +3 -1
- data/docs/ProductSearchMatch.md +2 -2
- data/docs/ProductUnitAnalytics.md +4 -10
- data/docs/Store.md +1 -1
- data/docs/StrikethroughEffect.md +5 -1
- data/docs/StrikethroughLabelingNotification.md +4 -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 +220 -29
- data/lib/talon_one/api/management_api.rb +248 -169
- 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_progress.rb +4 -137
- 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/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_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_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/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/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/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_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/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_program.rb +3 -3
- data/lib/talon_one/models/loyalty_program_balance.rb +34 -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/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/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/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_effect.rb +24 -4
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +46 -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 +18 -4
- data/spec/api/integration_api_spec.rb +45 -9
- data/spec/api/management_api_spec.rb +75 -60
- 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/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/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_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/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 +10 -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 +37 -3
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
|
@@ -320,7 +321,7 @@ end
|
|
320
321
|
|
321
322
|
api_instance = TalonOne::ManagementApi.new
|
322
323
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
323
|
-
integration_id = 'integration_id_example' # String | The identifier
|
324
|
+
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
325
|
body = TalonOne::AddLoyaltyPoints.new # AddLoyaltyPoints | body
|
325
326
|
|
326
327
|
begin
|
@@ -337,7 +338,7 @@ end
|
|
337
338
|
Name | Type | Description | Notes
|
338
339
|
------------- | ------------- | ------------- | -------------
|
339
340
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
340
|
-
**integration_id** | **String**| The identifier
|
341
|
+
**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
342
|
**body** | [**AddLoyaltyPoints**](AddLoyaltyPoints.md)| body |
|
342
343
|
|
343
344
|
### Return type
|
@@ -356,7 +357,7 @@ nil (empty response body)
|
|
356
357
|
|
357
358
|
## copy_campaign_to_applications
|
358
359
|
|
359
|
-
>
|
360
|
+
> InlineResponse2008 copy_campaign_to_applications(application_id, campaign_id, body)
|
360
361
|
|
361
362
|
Copy the campaign into the specified Application
|
362
363
|
|
@@ -405,7 +406,7 @@ Name | Type | Description | Notes
|
|
405
406
|
|
406
407
|
### Return type
|
407
408
|
|
408
|
-
[**
|
409
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
409
410
|
|
410
411
|
### Authorization
|
411
412
|
|
@@ -844,7 +845,7 @@ Name | Type | Description | Notes
|
|
844
845
|
|
845
846
|
## create_coupons
|
846
847
|
|
847
|
-
>
|
848
|
+
> InlineResponse20010 create_coupons(application_id, campaign_id, body, opts)
|
848
849
|
|
849
850
|
Create coupons
|
850
851
|
|
@@ -873,7 +874,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
873
874
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
874
875
|
body = TalonOne::NewCoupons.new # NewCoupons | body
|
875
876
|
opts = {
|
876
|
-
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the
|
877
|
+
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
878
|
}
|
878
879
|
|
879
880
|
begin
|
@@ -893,11 +894,11 @@ Name | Type | Description | Notes
|
|
893
894
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
894
895
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
895
896
|
**body** | [**NewCoupons**](NewCoupons.md)| body |
|
896
|
-
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the
|
897
|
+
**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
898
|
|
898
899
|
### Return type
|
899
900
|
|
900
|
-
[**
|
901
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
901
902
|
|
902
903
|
### Authorization
|
903
904
|
|
@@ -1037,7 +1038,7 @@ Name | Type | Description | Notes
|
|
1037
1038
|
|
1038
1039
|
## create_coupons_for_multiple_recipients
|
1039
1040
|
|
1040
|
-
>
|
1041
|
+
> InlineResponse20010 create_coupons_for_multiple_recipients(application_id, campaign_id, body, opts)
|
1041
1042
|
|
1042
1043
|
Create coupons for multiple recipients
|
1043
1044
|
|
@@ -1066,7 +1067,7 @@ application_id = 56 # Integer | The ID of the Application. It is displayed in yo
|
|
1066
1067
|
campaign_id = 56 # Integer | The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1067
1068
|
body = TalonOne::NewCouponsForMultipleRecipients.new # NewCouponsForMultipleRecipients | body
|
1068
1069
|
opts = {
|
1069
|
-
silent: 'yes' # String | Possible values: `yes` or `no`. - `yes`: Increases the
|
1070
|
+
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
1071
|
}
|
1071
1072
|
|
1072
1073
|
begin
|
@@ -1086,11 +1087,11 @@ Name | Type | Description | Notes
|
|
1086
1087
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
1087
1088
|
**campaign_id** | **Integer**| The ID of the campaign. It is displayed in your Talon.One deployment URL. |
|
1088
1089
|
**body** | [**NewCouponsForMultipleRecipients**](NewCouponsForMultipleRecipients.md)| body |
|
1089
|
-
**silent** | **String**| Possible values: `yes` or `no`. - `yes`: Increases the
|
1090
|
+
**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
1091
|
|
1091
1092
|
### Return type
|
1092
1093
|
|
1093
|
-
[**
|
1094
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
1094
1095
|
|
1095
1096
|
### Authorization
|
1096
1097
|
|
@@ -3275,7 +3276,7 @@ api_instance = TalonOne::ManagementApi.new
|
|
3275
3276
|
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
3277
|
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
3278
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
3278
|
-
integration_id = 'integration_id_example' # String | The identifier
|
3279
|
+
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
3280
|
opts = {
|
3280
3281
|
date_format: 'date_format_example' # String | Determines the format of dates in the export document.
|
3281
3282
|
}
|
@@ -3297,7 +3298,7 @@ Name | Type | Description | Notes
|
|
3297
3298
|
**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
3299
|
**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
3300
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
3300
|
-
**integration_id** | **String**| The identifier
|
3301
|
+
**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
3302
|
**date_format** | **String**| Determines the format of dates in the export document. | [optional]
|
3302
3303
|
|
3303
3304
|
### Return type
|
@@ -3456,7 +3457,7 @@ Name | Type | Description | Notes
|
|
3456
3457
|
|
3457
3458
|
## get_access_logs_without_total_count
|
3458
3459
|
|
3459
|
-
>
|
3460
|
+
> InlineResponse20022 get_access_logs_without_total_count(application_id, range_start, range_end, opts)
|
3460
3461
|
|
3461
3462
|
Get access logs for Application
|
3462
3463
|
|
@@ -3519,7 +3520,7 @@ Name | Type | Description | Notes
|
|
3519
3520
|
|
3520
3521
|
### Return type
|
3521
3522
|
|
3522
|
-
[**
|
3523
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
3523
3524
|
|
3524
3525
|
### Authorization
|
3525
3526
|
|
@@ -3832,7 +3833,7 @@ Name | Type | Description | Notes
|
|
3832
3833
|
|
3833
3834
|
## get_additional_costs
|
3834
3835
|
|
3835
|
-
>
|
3836
|
+
> InlineResponse20038 get_additional_costs(opts)
|
3836
3837
|
|
3837
3838
|
List additional costs
|
3838
3839
|
|
@@ -3883,7 +3884,7 @@ Name | Type | Description | Notes
|
|
3883
3884
|
|
3884
3885
|
### Return type
|
3885
3886
|
|
3886
|
-
[**
|
3887
|
+
[**InlineResponse20038**](InlineResponse20038.md)
|
3887
3888
|
|
3888
3889
|
### Authorization
|
3889
3890
|
|
@@ -4076,7 +4077,7 @@ Name | Type | Description | Notes
|
|
4076
4077
|
|
4077
4078
|
## get_application_customer_friends
|
4078
4079
|
|
4079
|
-
>
|
4080
|
+
> InlineResponse20035 get_application_customer_friends(application_id, integration_id, opts)
|
4080
4081
|
|
4081
4082
|
List friends referred by customer profile
|
4082
4083
|
|
@@ -4133,7 +4134,7 @@ Name | Type | Description | Notes
|
|
4133
4134
|
|
4134
4135
|
### Return type
|
4135
4136
|
|
4136
|
-
[**
|
4137
|
+
[**InlineResponse20035**](InlineResponse20035.md)
|
4137
4138
|
|
4138
4139
|
### Authorization
|
4139
4140
|
|
@@ -4147,7 +4148,7 @@ Name | Type | Description | Notes
|
|
4147
4148
|
|
4148
4149
|
## get_application_customers
|
4149
4150
|
|
4150
|
-
>
|
4151
|
+
> InlineResponse20024 get_application_customers(application_id, opts)
|
4151
4152
|
|
4152
4153
|
List application's customers
|
4153
4154
|
|
@@ -4202,7 +4203,7 @@ Name | Type | Description | Notes
|
|
4202
4203
|
|
4203
4204
|
### Return type
|
4204
4205
|
|
4205
|
-
[**
|
4206
|
+
[**InlineResponse20024**](InlineResponse20024.md)
|
4206
4207
|
|
4207
4208
|
### Authorization
|
4208
4209
|
|
@@ -4216,7 +4217,7 @@ Name | Type | Description | Notes
|
|
4216
4217
|
|
4217
4218
|
## get_application_customers_by_attributes
|
4218
4219
|
|
4219
|
-
>
|
4220
|
+
> InlineResponse20025 get_application_customers_by_attributes(application_id, body, opts)
|
4220
4221
|
|
4221
4222
|
List application customers matching the given attributes
|
4222
4223
|
|
@@ -4271,7 +4272,7 @@ Name | Type | Description | Notes
|
|
4271
4272
|
|
4272
4273
|
### Return type
|
4273
4274
|
|
4274
|
-
[**
|
4275
|
+
[**InlineResponse20025**](InlineResponse20025.md)
|
4275
4276
|
|
4276
4277
|
### Authorization
|
4277
4278
|
|
@@ -4285,7 +4286,7 @@ Name | Type | Description | Notes
|
|
4285
4286
|
|
4286
4287
|
## get_application_event_types
|
4287
4288
|
|
4288
|
-
>
|
4289
|
+
> InlineResponse20031 get_application_event_types(application_id, opts)
|
4289
4290
|
|
4290
4291
|
List Applications event types
|
4291
4292
|
|
@@ -4338,7 +4339,7 @@ Name | Type | Description | Notes
|
|
4338
4339
|
|
4339
4340
|
### Return type
|
4340
4341
|
|
4341
|
-
[**
|
4342
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
4342
4343
|
|
4343
4344
|
### Authorization
|
4344
4345
|
|
@@ -4352,7 +4353,7 @@ Name | Type | Description | Notes
|
|
4352
4353
|
|
4353
4354
|
## get_application_events_without_total_count
|
4354
4355
|
|
4355
|
-
>
|
4356
|
+
> InlineResponse20030 get_application_events_without_total_count(application_id, opts)
|
4356
4357
|
|
4357
4358
|
List Applications events
|
4358
4359
|
|
@@ -4427,7 +4428,7 @@ Name | Type | Description | Notes
|
|
4427
4428
|
|
4428
4429
|
### Return type
|
4429
4430
|
|
4430
|
-
[**
|
4431
|
+
[**InlineResponse20030**](InlineResponse20030.md)
|
4431
4432
|
|
4432
4433
|
### Authorization
|
4433
4434
|
|
@@ -4502,7 +4503,7 @@ Name | Type | Description | Notes
|
|
4502
4503
|
|
4503
4504
|
## get_application_sessions
|
4504
4505
|
|
4505
|
-
>
|
4506
|
+
> InlineResponse20029 get_application_sessions(application_id, opts)
|
4506
4507
|
|
4507
4508
|
List Application sessions
|
4508
4509
|
|
@@ -4571,7 +4572,7 @@ Name | Type | Description | Notes
|
|
4571
4572
|
|
4572
4573
|
### Return type
|
4573
4574
|
|
4574
|
-
[**
|
4575
|
+
[**InlineResponse20029**](InlineResponse20029.md)
|
4575
4576
|
|
4576
4577
|
### Authorization
|
4577
4578
|
|
@@ -4585,7 +4586,7 @@ Name | Type | Description | Notes
|
|
4585
4586
|
|
4586
4587
|
## get_applications
|
4587
4588
|
|
4588
|
-
>
|
4589
|
+
> InlineResponse2007 get_applications(opts)
|
4589
4590
|
|
4590
4591
|
List Applications
|
4591
4592
|
|
@@ -4636,7 +4637,7 @@ Name | Type | Description | Notes
|
|
4636
4637
|
|
4637
4638
|
### Return type
|
4638
4639
|
|
4639
|
-
[**
|
4640
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
4640
4641
|
|
4641
4642
|
### Authorization
|
4642
4643
|
|
@@ -4709,7 +4710,7 @@ Name | Type | Description | Notes
|
|
4709
4710
|
|
4710
4711
|
## get_attributes
|
4711
4712
|
|
4712
|
-
>
|
4713
|
+
> InlineResponse20036 get_attributes(opts)
|
4713
4714
|
|
4714
4715
|
List custom attributes
|
4715
4716
|
|
@@ -4762,7 +4763,7 @@ Name | Type | Description | Notes
|
|
4762
4763
|
|
4763
4764
|
### Return type
|
4764
4765
|
|
4765
|
-
[**
|
4766
|
+
[**InlineResponse20036**](InlineResponse20036.md)
|
4766
4767
|
|
4767
4768
|
### Authorization
|
4768
4769
|
|
@@ -4776,7 +4777,7 @@ Name | Type | Description | Notes
|
|
4776
4777
|
|
4777
4778
|
## get_audience_memberships
|
4778
4779
|
|
4779
|
-
>
|
4780
|
+
> InlineResponse20034 get_audience_memberships(audience_id, opts)
|
4780
4781
|
|
4781
4782
|
List audience members
|
4782
4783
|
|
@@ -4831,7 +4832,7 @@ Name | Type | Description | Notes
|
|
4831
4832
|
|
4832
4833
|
### Return type
|
4833
4834
|
|
4834
|
-
[**
|
4835
|
+
[**InlineResponse20034**](InlineResponse20034.md)
|
4835
4836
|
|
4836
4837
|
### Authorization
|
4837
4838
|
|
@@ -4845,7 +4846,7 @@ Name | Type | Description | Notes
|
|
4845
4846
|
|
4846
4847
|
## get_audiences
|
4847
4848
|
|
4848
|
-
>
|
4849
|
+
> InlineResponse20032 get_audiences(opts)
|
4849
4850
|
|
4850
4851
|
List audiences
|
4851
4852
|
|
@@ -4898,7 +4899,7 @@ Name | Type | Description | Notes
|
|
4898
4899
|
|
4899
4900
|
### Return type
|
4900
4901
|
|
4901
|
-
[**
|
4902
|
+
[**InlineResponse20032**](InlineResponse20032.md)
|
4902
4903
|
|
4903
4904
|
### Authorization
|
4904
4905
|
|
@@ -4912,7 +4913,7 @@ Name | Type | Description | Notes
|
|
4912
4913
|
|
4913
4914
|
## get_audiences_analytics
|
4914
4915
|
|
4915
|
-
>
|
4916
|
+
> InlineResponse20033 get_audiences_analytics(audience_ids, opts)
|
4916
4917
|
|
4917
4918
|
List audience analytics
|
4918
4919
|
|
@@ -4961,7 +4962,7 @@ Name | Type | Description | Notes
|
|
4961
4962
|
|
4962
4963
|
### Return type
|
4963
4964
|
|
4964
|
-
[**
|
4965
|
+
[**InlineResponse20033**](InlineResponse20033.md)
|
4965
4966
|
|
4966
4967
|
### Authorization
|
4967
4968
|
|
@@ -5036,7 +5037,7 @@ Name | Type | Description | Notes
|
|
5036
5037
|
|
5037
5038
|
## get_campaign_analytics
|
5038
5039
|
|
5039
|
-
>
|
5040
|
+
> InlineResponse20023 get_campaign_analytics(application_id, campaign_id, range_start, range_end, opts)
|
5040
5041
|
|
5041
5042
|
Get analytics of campaigns
|
5042
5043
|
|
@@ -5091,7 +5092,7 @@ Name | Type | Description | Notes
|
|
5091
5092
|
|
5092
5093
|
### Return type
|
5093
5094
|
|
5094
|
-
[**
|
5095
|
+
[**InlineResponse20023**](InlineResponse20023.md)
|
5095
5096
|
|
5096
5097
|
### Authorization
|
5097
5098
|
|
@@ -5105,7 +5106,7 @@ Name | Type | Description | Notes
|
|
5105
5106
|
|
5106
5107
|
## get_campaign_by_attributes
|
5107
5108
|
|
5108
|
-
>
|
5109
|
+
> InlineResponse2008 get_campaign_by_attributes(application_id, body, opts)
|
5109
5110
|
|
5110
5111
|
List campaigns that match the given attributes
|
5111
5112
|
|
@@ -5162,7 +5163,7 @@ Name | Type | Description | Notes
|
|
5162
5163
|
|
5163
5164
|
### Return type
|
5164
5165
|
|
5165
|
-
[**
|
5166
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
5166
5167
|
|
5167
5168
|
### Authorization
|
5168
5169
|
|
@@ -5235,7 +5236,7 @@ Name | Type | Description | Notes
|
|
5235
5236
|
|
5236
5237
|
## get_campaign_groups
|
5237
5238
|
|
5238
|
-
>
|
5239
|
+
> InlineResponse20013 get_campaign_groups(opts)
|
5239
5240
|
|
5240
5241
|
List campaign access groups
|
5241
5242
|
|
@@ -5286,7 +5287,7 @@ Name | Type | Description | Notes
|
|
5286
5287
|
|
5287
5288
|
### Return type
|
5288
5289
|
|
5289
|
-
[**
|
5290
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
5290
5291
|
|
5291
5292
|
### Authorization
|
5292
5293
|
|
@@ -5300,7 +5301,7 @@ Name | Type | Description | Notes
|
|
5300
5301
|
|
5301
5302
|
## get_campaign_templates
|
5302
5303
|
|
5303
|
-
>
|
5304
|
+
> InlineResponse20014 get_campaign_templates(opts)
|
5304
5305
|
|
5305
5306
|
List campaign templates
|
5306
5307
|
|
@@ -5359,7 +5360,7 @@ Name | Type | Description | Notes
|
|
5359
5360
|
|
5360
5361
|
### Return type
|
5361
5362
|
|
5362
|
-
[**
|
5363
|
+
[**InlineResponse20014**](InlineResponse20014.md)
|
5363
5364
|
|
5364
5365
|
### Authorization
|
5365
5366
|
|
@@ -5373,7 +5374,7 @@ Name | Type | Description | Notes
|
|
5373
5374
|
|
5374
5375
|
## get_campaigns
|
5375
5376
|
|
5376
|
-
>
|
5377
|
+
> InlineResponse2008 get_campaigns(application_id, opts)
|
5377
5378
|
|
5378
5379
|
List campaigns
|
5379
5380
|
|
@@ -5442,7 +5443,7 @@ Name | Type | Description | Notes
|
|
5442
5443
|
|
5443
5444
|
### Return type
|
5444
5445
|
|
5445
|
-
[**
|
5446
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
5446
5447
|
|
5447
5448
|
### Authorization
|
5448
5449
|
|
@@ -5456,7 +5457,7 @@ Name | Type | Description | Notes
|
|
5456
5457
|
|
5457
5458
|
## get_changes
|
5458
5459
|
|
5459
|
-
>
|
5460
|
+
> InlineResponse20044 get_changes(opts)
|
5460
5461
|
|
5461
5462
|
Get audit logs for an account
|
5462
5463
|
|
@@ -5523,7 +5524,7 @@ Name | Type | Description | Notes
|
|
5523
5524
|
|
5524
5525
|
### Return type
|
5525
5526
|
|
5526
|
-
[**
|
5527
|
+
[**InlineResponse20044**](InlineResponse20044.md)
|
5527
5528
|
|
5528
5529
|
### Authorization
|
5529
5530
|
|
@@ -5600,7 +5601,7 @@ Name | Type | Description | Notes
|
|
5600
5601
|
|
5601
5602
|
## get_collection_items
|
5602
5603
|
|
5603
|
-
>
|
5604
|
+
> InlineResponse20021 get_collection_items(collection_id, opts)
|
5604
5605
|
|
5605
5606
|
Get collection items
|
5606
5607
|
|
@@ -5651,7 +5652,7 @@ Name | Type | Description | Notes
|
|
5651
5652
|
|
5652
5653
|
### Return type
|
5653
5654
|
|
5654
|
-
[**
|
5655
|
+
[**InlineResponse20021**](InlineResponse20021.md)
|
5655
5656
|
|
5656
5657
|
### Authorization
|
5657
5658
|
|
@@ -5665,7 +5666,7 @@ Name | Type | Description | Notes
|
|
5665
5666
|
|
5666
5667
|
## get_coupons_without_total_count
|
5667
5668
|
|
5668
|
-
>
|
5669
|
+
> InlineResponse20011 get_coupons_without_total_count(application_id, campaign_id, opts)
|
5669
5670
|
|
5670
5671
|
List coupons
|
5671
5672
|
|
@@ -5750,7 +5751,7 @@ Name | Type | Description | Notes
|
|
5750
5751
|
|
5751
5752
|
### Return type
|
5752
5753
|
|
5753
|
-
[**
|
5754
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
5754
5755
|
|
5755
5756
|
### Authorization
|
5756
5757
|
|
@@ -5835,7 +5836,7 @@ Name | Type | Description | Notes
|
|
5835
5836
|
|
5836
5837
|
## get_customer_activity_reports_without_total_count
|
5837
5838
|
|
5838
|
-
>
|
5839
|
+
> InlineResponse20028 get_customer_activity_reports_without_total_count(range_start, range_end, application_id, opts)
|
5839
5840
|
|
5840
5841
|
Get Activity Reports for Application Customers
|
5841
5842
|
|
@@ -5900,7 +5901,7 @@ Name | Type | Description | Notes
|
|
5900
5901
|
|
5901
5902
|
### Return type
|
5902
5903
|
|
5903
|
-
[**
|
5904
|
+
[**InlineResponse20028**](InlineResponse20028.md)
|
5904
5905
|
|
5905
5906
|
### Authorization
|
5906
5907
|
|
@@ -6042,7 +6043,7 @@ Name | Type | Description | Notes
|
|
6042
6043
|
|
6043
6044
|
## get_customer_profile_achievement_progress
|
6044
6045
|
|
6045
|
-
>
|
6046
|
+
> InlineResponse20049 get_customer_profile_achievement_progress(application_id, integration_id, opts)
|
6046
6047
|
|
6047
6048
|
List customer achievements
|
6048
6049
|
|
@@ -6068,7 +6069,7 @@ end
|
|
6068
6069
|
|
6069
6070
|
api_instance = TalonOne::ManagementApi.new
|
6070
6071
|
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
|
6072
|
+
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
6073
|
opts = {
|
6073
6074
|
page_size: 50, # Integer | The number of items in the response.
|
6074
6075
|
skip: 56, # Integer | The number of items to skip when paging through large result sets.
|
@@ -6091,7 +6092,7 @@ end
|
|
6091
6092
|
Name | Type | Description | Notes
|
6092
6093
|
------------- | ------------- | ------------- | -------------
|
6093
6094
|
**application_id** | **Integer**| The ID of the Application. It is displayed in your Talon.One deployment URL. |
|
6094
|
-
**integration_id** | **String**| The identifier
|
6095
|
+
**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
6096
|
**page_size** | **Integer**| The number of items in the response. | [optional] [default to 50]
|
6096
6097
|
**skip** | **Integer**| The number of items to skip when paging through large result sets. | [optional]
|
6097
6098
|
**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 +6100,7 @@ Name | Type | Description | Notes
|
|
6099
6100
|
|
6100
6101
|
### Return type
|
6101
6102
|
|
6102
|
-
[**
|
6103
|
+
[**InlineResponse20049**](InlineResponse20049.md)
|
6103
6104
|
|
6104
6105
|
### Authorization
|
6105
6106
|
|
@@ -6113,7 +6114,7 @@ Name | Type | Description | Notes
|
|
6113
6114
|
|
6114
6115
|
## get_customer_profiles
|
6115
6116
|
|
6116
|
-
>
|
6117
|
+
> InlineResponse20027 get_customer_profiles(opts)
|
6117
6118
|
|
6118
6119
|
List customer profiles
|
6119
6120
|
|
@@ -6164,7 +6165,7 @@ Name | Type | Description | Notes
|
|
6164
6165
|
|
6165
6166
|
### Return type
|
6166
6167
|
|
6167
|
-
[**
|
6168
|
+
[**InlineResponse20027**](InlineResponse20027.md)
|
6168
6169
|
|
6169
6170
|
### Authorization
|
6170
6171
|
|
@@ -6178,7 +6179,7 @@ Name | Type | Description | Notes
|
|
6178
6179
|
|
6179
6180
|
## get_customers_by_attributes
|
6180
6181
|
|
6181
|
-
>
|
6182
|
+
> InlineResponse20026 get_customers_by_attributes(body, opts)
|
6182
6183
|
|
6183
6184
|
List customer profiles matching the given attributes
|
6184
6185
|
|
@@ -6231,7 +6232,7 @@ Name | Type | Description | Notes
|
|
6231
6232
|
|
6232
6233
|
### Return type
|
6233
6234
|
|
6234
|
-
[**
|
6235
|
+
[**InlineResponse20026**](InlineResponse20026.md)
|
6235
6236
|
|
6236
6237
|
### Authorization
|
6237
6238
|
|
@@ -6243,9 +6244,76 @@ Name | Type | Description | Notes
|
|
6243
6244
|
- **Accept**: application/json
|
6244
6245
|
|
6245
6246
|
|
6247
|
+
## get_dashboard_statistics
|
6248
|
+
|
6249
|
+
> InlineResponse20016 get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts)
|
6250
|
+
|
6251
|
+
Get statistics for loyalty dashboard
|
6252
|
+
|
6253
|
+
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.
|
6254
|
+
|
6255
|
+
### Example
|
6256
|
+
|
6257
|
+
```ruby
|
6258
|
+
# load the gem
|
6259
|
+
require 'talon_one'
|
6260
|
+
# setup authorization
|
6261
|
+
TalonOne.configure do |config|
|
6262
|
+
# Configure API key authorization: management_key
|
6263
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6264
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6265
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6266
|
+
|
6267
|
+
# Configure API key authorization: manager_auth
|
6268
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
6269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
6270
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
6271
|
+
end
|
6272
|
+
|
6273
|
+
api_instance = TalonOne::ManagementApi.new
|
6274
|
+
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.
|
6275
|
+
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.
|
6276
|
+
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.
|
6277
|
+
opts = {
|
6278
|
+
subledger_id: 'subledger_id_example' # String | The ID of the subledger by which we filter the data.
|
6279
|
+
}
|
6280
|
+
|
6281
|
+
begin
|
6282
|
+
#Get statistics for loyalty dashboard
|
6283
|
+
result = api_instance.get_dashboard_statistics(loyalty_program_id, range_start, range_end, opts)
|
6284
|
+
p result
|
6285
|
+
rescue TalonOne::ApiError => e
|
6286
|
+
puts "Exception when calling ManagementApi->get_dashboard_statistics: #{e}"
|
6287
|
+
end
|
6288
|
+
```
|
6289
|
+
|
6290
|
+
### Parameters
|
6291
|
+
|
6292
|
+
|
6293
|
+
Name | Type | Description | Notes
|
6294
|
+
------------- | ------------- | ------------- | -------------
|
6295
|
+
**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. |
|
6296
|
+
**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. |
|
6297
|
+
**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. |
|
6298
|
+
**subledger_id** | **String**| The ID of the subledger by which we filter the data. | [optional]
|
6299
|
+
|
6300
|
+
### Return type
|
6301
|
+
|
6302
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
6303
|
+
|
6304
|
+
### Authorization
|
6305
|
+
|
6306
|
+
[management_key](../README.md#management_key), [manager_auth](../README.md#manager_auth)
|
6307
|
+
|
6308
|
+
### HTTP request headers
|
6309
|
+
|
6310
|
+
- **Content-Type**: Not defined
|
6311
|
+
- **Accept**: application/json
|
6312
|
+
|
6313
|
+
|
6246
6314
|
## get_event_types
|
6247
6315
|
|
6248
|
-
>
|
6316
|
+
> InlineResponse20042 get_event_types(opts)
|
6249
6317
|
|
6250
6318
|
List event types
|
6251
6319
|
|
@@ -6300,7 +6368,7 @@ Name | Type | Description | Notes
|
|
6300
6368
|
|
6301
6369
|
### Return type
|
6302
6370
|
|
6303
|
-
[**
|
6371
|
+
[**InlineResponse20042**](InlineResponse20042.md)
|
6304
6372
|
|
6305
6373
|
### Authorization
|
6306
6374
|
|
@@ -6314,7 +6382,7 @@ Name | Type | Description | Notes
|
|
6314
6382
|
|
6315
6383
|
## get_exports
|
6316
6384
|
|
6317
|
-
>
|
6385
|
+
> InlineResponse20045 get_exports(opts)
|
6318
6386
|
|
6319
6387
|
Get exports
|
6320
6388
|
|
@@ -6369,7 +6437,7 @@ Name | Type | Description | Notes
|
|
6369
6437
|
|
6370
6438
|
### Return type
|
6371
6439
|
|
6372
|
-
[**
|
6440
|
+
[**InlineResponse20045**](InlineResponse20045.md)
|
6373
6441
|
|
6374
6442
|
### Authorization
|
6375
6443
|
|
@@ -6444,7 +6512,7 @@ Name | Type | Description | Notes
|
|
6444
6512
|
|
6445
6513
|
## get_loyalty_card_transaction_logs
|
6446
6514
|
|
6447
|
-
>
|
6515
|
+
> InlineResponse20019 get_loyalty_card_transaction_logs(loyalty_program_id, loyalty_card_id, opts)
|
6448
6516
|
|
6449
6517
|
List card's transactions
|
6450
6518
|
|
@@ -6503,7 +6571,7 @@ Name | Type | Description | Notes
|
|
6503
6571
|
|
6504
6572
|
### Return type
|
6505
6573
|
|
6506
|
-
[**
|
6574
|
+
[**InlineResponse20019**](InlineResponse20019.md)
|
6507
6575
|
|
6508
6576
|
### Authorization
|
6509
6577
|
|
@@ -6517,7 +6585,7 @@ Name | Type | Description | Notes
|
|
6517
6585
|
|
6518
6586
|
## get_loyalty_cards
|
6519
6587
|
|
6520
|
-
>
|
6588
|
+
> InlineResponse20018 get_loyalty_cards(loyalty_program_id, opts)
|
6521
6589
|
|
6522
6590
|
List loyalty cards
|
6523
6591
|
|
@@ -6576,7 +6644,7 @@ Name | Type | Description | Notes
|
|
6576
6644
|
|
6577
6645
|
### Return type
|
6578
6646
|
|
6579
|
-
[**
|
6647
|
+
[**InlineResponse20018**](InlineResponse20018.md)
|
6580
6648
|
|
6581
6649
|
### Authorization
|
6582
6650
|
|
@@ -6616,7 +6684,7 @@ end
|
|
6616
6684
|
|
6617
6685
|
api_instance = TalonOne::ManagementApi.new
|
6618
6686
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
6619
|
-
integration_id = 'integration_id_example' # String | The identifier
|
6687
|
+
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
6688
|
|
6621
6689
|
begin
|
6622
6690
|
#Get customer's full loyalty ledger
|
@@ -6633,7 +6701,7 @@ end
|
|
6633
6701
|
Name | Type | Description | Notes
|
6634
6702
|
------------- | ------------- | ------------- | -------------
|
6635
6703
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
6636
|
-
**integration_id** | **String**| The identifier
|
6704
|
+
**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
6705
|
|
6638
6706
|
### Return type
|
6639
6707
|
|
@@ -6710,7 +6778,7 @@ Name | Type | Description | Notes
|
|
6710
6778
|
|
6711
6779
|
## get_loyalty_program_transactions
|
6712
6780
|
|
6713
|
-
>
|
6781
|
+
> InlineResponse20017 get_loyalty_program_transactions(loyalty_program_id, opts)
|
6714
6782
|
|
6715
6783
|
List loyalty program transactions
|
6716
6784
|
|
@@ -6769,7 +6837,7 @@ Name | Type | Description | Notes
|
|
6769
6837
|
|
6770
6838
|
### Return type
|
6771
6839
|
|
6772
|
-
[**
|
6840
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
6773
6841
|
|
6774
6842
|
### Authorization
|
6775
6843
|
|
@@ -6783,7 +6851,7 @@ Name | Type | Description | Notes
|
|
6783
6851
|
|
6784
6852
|
## get_loyalty_programs
|
6785
6853
|
|
6786
|
-
>
|
6854
|
+
> InlineResponse20015 get_loyalty_programs
|
6787
6855
|
|
6788
6856
|
List loyalty programs
|
6789
6857
|
|
@@ -6824,7 +6892,7 @@ This endpoint does not need any parameter.
|
|
6824
6892
|
|
6825
6893
|
### Return type
|
6826
6894
|
|
6827
|
-
[**
|
6895
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
6828
6896
|
|
6829
6897
|
### Authorization
|
6830
6898
|
|
@@ -6842,7 +6910,7 @@ This endpoint does not need any parameter.
|
|
6842
6910
|
|
6843
6911
|
Get loyalty program statistics
|
6844
6912
|
|
6845
|
-
|
6913
|
+
⚠️ 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
6914
|
|
6847
6915
|
### Example
|
6848
6916
|
|
@@ -6897,7 +6965,7 @@ Name | Type | Description | Notes
|
|
6897
6965
|
|
6898
6966
|
## get_referrals_without_total_count
|
6899
6967
|
|
6900
|
-
>
|
6968
|
+
> InlineResponse20012 get_referrals_without_total_count(application_id, campaign_id, opts)
|
6901
6969
|
|
6902
6970
|
List referrals
|
6903
6971
|
|
@@ -6964,7 +7032,7 @@ Name | Type | Description | Notes
|
|
6964
7032
|
|
6965
7033
|
### Return type
|
6966
7034
|
|
6967
|
-
[**
|
7035
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
6968
7036
|
|
6969
7037
|
### Authorization
|
6970
7038
|
|
@@ -7100,7 +7168,7 @@ Name | Type | Description | Notes
|
|
7100
7168
|
|
7101
7169
|
## get_rulesets
|
7102
7170
|
|
7103
|
-
>
|
7171
|
+
> InlineResponse2009 get_rulesets(application_id, campaign_id, opts)
|
7104
7172
|
|
7105
7173
|
List campaign rulesets
|
7106
7174
|
|
@@ -7155,7 +7223,7 @@ Name | Type | Description | Notes
|
|
7155
7223
|
|
7156
7224
|
### Return type
|
7157
7225
|
|
7158
|
-
[**
|
7226
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
7159
7227
|
|
7160
7228
|
### Authorization
|
7161
7229
|
|
@@ -7289,7 +7357,7 @@ Name | Type | Description | Notes
|
|
7289
7357
|
|
7290
7358
|
## get_users
|
7291
7359
|
|
7292
|
-
>
|
7360
|
+
> InlineResponse20043 get_users(opts)
|
7293
7361
|
|
7294
7362
|
List users in account
|
7295
7363
|
|
@@ -7340,7 +7408,7 @@ Name | Type | Description | Notes
|
|
7340
7408
|
|
7341
7409
|
### Return type
|
7342
7410
|
|
7343
|
-
[**
|
7411
|
+
[**InlineResponse20043**](InlineResponse20043.md)
|
7344
7412
|
|
7345
7413
|
### Authorization
|
7346
7414
|
|
@@ -7413,7 +7481,7 @@ Name | Type | Description | Notes
|
|
7413
7481
|
|
7414
7482
|
## get_webhook_activation_logs
|
7415
7483
|
|
7416
|
-
>
|
7484
|
+
> InlineResponse20040 get_webhook_activation_logs(opts)
|
7417
7485
|
|
7418
7486
|
List webhook activation log entries
|
7419
7487
|
|
@@ -7476,7 +7544,7 @@ Name | Type | Description | Notes
|
|
7476
7544
|
|
7477
7545
|
### Return type
|
7478
7546
|
|
7479
|
-
[**
|
7547
|
+
[**InlineResponse20040**](InlineResponse20040.md)
|
7480
7548
|
|
7481
7549
|
### Authorization
|
7482
7550
|
|
@@ -7490,7 +7558,7 @@ Name | Type | Description | Notes
|
|
7490
7558
|
|
7491
7559
|
## get_webhook_logs
|
7492
7560
|
|
7493
|
-
>
|
7561
|
+
> InlineResponse20041 get_webhook_logs(opts)
|
7494
7562
|
|
7495
7563
|
List webhook log entries
|
7496
7564
|
|
@@ -7555,7 +7623,7 @@ Name | Type | Description | Notes
|
|
7555
7623
|
|
7556
7624
|
### Return type
|
7557
7625
|
|
7558
|
-
[**
|
7626
|
+
[**InlineResponse20041**](InlineResponse20041.md)
|
7559
7627
|
|
7560
7628
|
### Authorization
|
7561
7629
|
|
@@ -7569,7 +7637,7 @@ Name | Type | Description | Notes
|
|
7569
7637
|
|
7570
7638
|
## get_webhooks
|
7571
7639
|
|
7572
|
-
>
|
7640
|
+
> InlineResponse20039 get_webhooks(opts)
|
7573
7641
|
|
7574
7642
|
List webhooks
|
7575
7643
|
|
@@ -7630,7 +7698,7 @@ Name | Type | Description | Notes
|
|
7630
7698
|
|
7631
7699
|
### Return type
|
7632
7700
|
|
7633
|
-
[**
|
7701
|
+
[**InlineResponse20039**](InlineResponse20039.md)
|
7634
7702
|
|
7635
7703
|
### Authorization
|
7636
7704
|
|
@@ -8407,7 +8475,7 @@ nil (empty response body)
|
|
8407
8475
|
|
8408
8476
|
## list_account_collections
|
8409
8477
|
|
8410
|
-
>
|
8478
|
+
> InlineResponse20020 list_account_collections(opts)
|
8411
8479
|
|
8412
8480
|
List collections in account
|
8413
8481
|
|
@@ -8462,7 +8530,7 @@ Name | Type | Description | Notes
|
|
8462
8530
|
|
8463
8531
|
### Return type
|
8464
8532
|
|
8465
|
-
[**
|
8533
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8466
8534
|
|
8467
8535
|
### Authorization
|
8468
8536
|
|
@@ -8476,7 +8544,7 @@ Name | Type | Description | Notes
|
|
8476
8544
|
|
8477
8545
|
## list_achievements
|
8478
8546
|
|
8479
|
-
>
|
8547
|
+
> InlineResponse20048 list_achievements(application_id, campaign_id, opts)
|
8480
8548
|
|
8481
8549
|
List achievements
|
8482
8550
|
|
@@ -8531,7 +8599,7 @@ Name | Type | Description | Notes
|
|
8531
8599
|
|
8532
8600
|
### Return type
|
8533
8601
|
|
8534
|
-
[**
|
8602
|
+
[**InlineResponse20048**](InlineResponse20048.md)
|
8535
8603
|
|
8536
8604
|
### Authorization
|
8537
8605
|
|
@@ -8545,7 +8613,7 @@ Name | Type | Description | Notes
|
|
8545
8613
|
|
8546
8614
|
## list_all_roles_v2
|
8547
8615
|
|
8548
|
-
>
|
8616
|
+
> InlineResponse20046 list_all_roles_v2
|
8549
8617
|
|
8550
8618
|
List roles
|
8551
8619
|
|
@@ -8586,7 +8654,7 @@ This endpoint does not need any parameter.
|
|
8586
8654
|
|
8587
8655
|
### Return type
|
8588
8656
|
|
8589
|
-
[**
|
8657
|
+
[**InlineResponse20046**](InlineResponse20046.md)
|
8590
8658
|
|
8591
8659
|
### Authorization
|
8592
8660
|
|
@@ -8600,7 +8668,7 @@ This endpoint does not need any parameter.
|
|
8600
8668
|
|
8601
8669
|
## list_catalog_items
|
8602
8670
|
|
8603
|
-
>
|
8671
|
+
> InlineResponse20037 list_catalog_items(catalog_id, opts)
|
8604
8672
|
|
8605
8673
|
List items in a catalog
|
8606
8674
|
|
@@ -8657,7 +8725,7 @@ Name | Type | Description | Notes
|
|
8657
8725
|
|
8658
8726
|
### Return type
|
8659
8727
|
|
8660
|
-
[**
|
8728
|
+
[**InlineResponse20037**](InlineResponse20037.md)
|
8661
8729
|
|
8662
8730
|
### Authorization
|
8663
8731
|
|
@@ -8671,7 +8739,7 @@ Name | Type | Description | Notes
|
|
8671
8739
|
|
8672
8740
|
## list_collections
|
8673
8741
|
|
8674
|
-
>
|
8742
|
+
> InlineResponse20020 list_collections(application_id, campaign_id, opts)
|
8675
8743
|
|
8676
8744
|
List collections in campaign
|
8677
8745
|
|
@@ -8730,7 +8798,7 @@ Name | Type | Description | Notes
|
|
8730
8798
|
|
8731
8799
|
### Return type
|
8732
8800
|
|
8733
|
-
[**
|
8801
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8734
8802
|
|
8735
8803
|
### Authorization
|
8736
8804
|
|
@@ -8744,7 +8812,7 @@ Name | Type | Description | Notes
|
|
8744
8812
|
|
8745
8813
|
## list_collections_in_application
|
8746
8814
|
|
8747
|
-
>
|
8815
|
+
> InlineResponse20020 list_collections_in_application(application_id, opts)
|
8748
8816
|
|
8749
8817
|
List collections in Application
|
8750
8818
|
|
@@ -8801,7 +8869,7 @@ Name | Type | Description | Notes
|
|
8801
8869
|
|
8802
8870
|
### Return type
|
8803
8871
|
|
8804
|
-
[**
|
8872
|
+
[**InlineResponse20020**](InlineResponse20020.md)
|
8805
8873
|
|
8806
8874
|
### Authorization
|
8807
8875
|
|
@@ -8815,7 +8883,7 @@ Name | Type | Description | Notes
|
|
8815
8883
|
|
8816
8884
|
## list_stores
|
8817
8885
|
|
8818
|
-
>
|
8886
|
+
> InlineResponse20047 list_stores(application_id, opts)
|
8819
8887
|
|
8820
8888
|
List stores
|
8821
8889
|
|
@@ -8878,7 +8946,7 @@ Name | Type | Description | Notes
|
|
8878
8946
|
|
8879
8947
|
### Return type
|
8880
8948
|
|
8881
|
-
[**
|
8949
|
+
[**InlineResponse20047**](InlineResponse20047.md)
|
8882
8950
|
|
8883
8951
|
### Authorization
|
8884
8952
|
|
@@ -9010,7 +9078,7 @@ nil (empty response body)
|
|
9010
9078
|
|
9011
9079
|
Create notification about added or deducted loyalty points
|
9012
9080
|
|
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 [
|
9081
|
+
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 [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
9014
9082
|
|
9015
9083
|
### Example
|
9016
9084
|
|
@@ -9071,7 +9139,7 @@ Name | Type | Description | Notes
|
|
9071
9139
|
|
9072
9140
|
Create strikethrough notification
|
9073
9141
|
|
9074
|
-
Create a notification for the in the given Application. For more information, see [
|
9142
|
+
Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
9075
9143
|
|
9076
9144
|
### Example
|
9077
9145
|
|
@@ -9132,7 +9200,7 @@ Name | Type | Description | Notes
|
|
9132
9200
|
|
9133
9201
|
Create notification about pending loyalty points
|
9134
9202
|
|
9135
|
-
Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [
|
9203
|
+
Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
9136
9204
|
|
9137
9205
|
### Example
|
9138
9206
|
|
@@ -9215,7 +9283,7 @@ end
|
|
9215
9283
|
|
9216
9284
|
api_instance = TalonOne::ManagementApi.new
|
9217
9285
|
loyalty_program_id = 'loyalty_program_id_example' # String | The identifier for the loyalty program.
|
9218
|
-
integration_id = 'integration_id_example' # String | The identifier
|
9286
|
+
integration_id = 'integration_id_example' # String | The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.
|
9219
9287
|
body = TalonOne::DeductLoyaltyPoints.new # DeductLoyaltyPoints | body
|
9220
9288
|
|
9221
9289
|
begin
|
@@ -9232,7 +9300,7 @@ end
|
|
9232
9300
|
Name | Type | Description | Notes
|
9233
9301
|
------------- | ------------- | ------------- | -------------
|
9234
9302
|
**loyalty_program_id** | **String**| The identifier for the loyalty program. |
|
9235
|
-
**integration_id** | **String**| The identifier
|
9303
|
+
**integration_id** | **String**| The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier. |
|
9236
9304
|
**body** | [**DeductLoyaltyPoints**](DeductLoyaltyPoints.md)| body |
|
9237
9305
|
|
9238
9306
|
### Return type
|
@@ -9828,7 +9896,7 @@ Name | Type | Description | Notes
|
|
9828
9896
|
|
9829
9897
|
## search_coupons_advanced_application_wide_without_total_count
|
9830
9898
|
|
9831
|
-
>
|
9899
|
+
> InlineResponse20011 search_coupons_advanced_application_wide_without_total_count(application_id, body, opts)
|
9832
9900
|
|
9833
9901
|
List coupons that match the given attributes (without total count)
|
9834
9902
|
|
@@ -9903,7 +9971,7 @@ Name | Type | Description | Notes
|
|
9903
9971
|
|
9904
9972
|
### Return type
|
9905
9973
|
|
9906
|
-
[**
|
9974
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
9907
9975
|
|
9908
9976
|
### Authorization
|
9909
9977
|
|
@@ -9917,7 +9985,7 @@ Name | Type | Description | Notes
|
|
9917
9985
|
|
9918
9986
|
## search_coupons_advanced_without_total_count
|
9919
9987
|
|
9920
|
-
>
|
9988
|
+
> InlineResponse20011 search_coupons_advanced_without_total_count(application_id, campaign_id, body, opts)
|
9921
9989
|
|
9922
9990
|
List coupons that match the given attributes in campaign (without total count)
|
9923
9991
|
|
@@ -9992,7 +10060,7 @@ Name | Type | Description | Notes
|
|
9992
10060
|
|
9993
10061
|
### Return type
|
9994
10062
|
|
9995
|
-
[**
|
10063
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
9996
10064
|
|
9997
10065
|
### Authorization
|
9998
10066
|
|