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
@@ -154,7 +154,7 @@ module TalonOne
|
|
154
154
|
end
|
155
155
|
|
156
156
|
# Create referral code for an advocate
|
157
|
-
# Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
157
|
+
# Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
|
158
158
|
# @param body [NewReferral] body
|
159
159
|
# @param [Hash] opts the optional parameters
|
160
160
|
# @return [Referral]
|
@@ -164,7 +164,7 @@ module TalonOne
|
|
164
164
|
end
|
165
165
|
|
166
166
|
# Create referral code for an advocate
|
167
|
-
# Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
167
|
+
# Creates a referral code for an advocate. The code will be valid for the referral campaign for which is created, indicated in the `campaignId` parameter, and will be associated with the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
|
168
168
|
# @param body [NewReferral] body
|
169
169
|
# @param [Hash] opts the optional parameters
|
170
170
|
# @return [Array<(Referral, Integer, Hash)>] Referral data, response status code and response headers
|
@@ -218,10 +218,10 @@ module TalonOne
|
|
218
218
|
end
|
219
219
|
|
220
220
|
# Create referral codes for multiple advocates
|
221
|
-
# Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
221
|
+
# Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
|
222
222
|
# @param body [NewReferralsForMultipleAdvocates] body
|
223
223
|
# @param [Hash] opts the optional parameters
|
224
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
224
|
+
# @option opts [String] :silent 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. (default to 'yes')
|
225
225
|
# @return [InlineResponse201]
|
226
226
|
def create_referrals_for_multiple_advocates(body, opts = {})
|
227
227
|
data, _status_code, _headers = create_referrals_for_multiple_advocates_with_http_info(body, opts)
|
@@ -229,10 +229,10 @@ module TalonOne
|
|
229
229
|
end
|
230
230
|
|
231
231
|
# Create referral codes for multiple advocates
|
232
|
-
# Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile.
|
232
|
+
# Creates unique referral codes for multiple advocates. The code will be valid for the referral campaign for which it is created, indicated in the `campaignId` parameter, and one referral code will be associated with one advocate using the profile specified in the `advocateProfileIntegrationId` parameter as the advocate's profile. **Note:** Any [referral limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets#referral-limits) set are ignored when you use this endpoint.
|
233
233
|
# @param body [NewReferralsForMultipleAdvocates] body
|
234
234
|
# @param [Hash] opts the optional parameters
|
235
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
235
|
+
# @option opts [String] :silent 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.
|
236
236
|
# @return [Array<(InlineResponse201, Integer, Hash)>] InlineResponse201 data, response status code and response headers
|
237
237
|
def create_referrals_for_multiple_advocates_with_http_info(body, opts = {})
|
238
238
|
if @api_client.config.debugging
|
@@ -610,6 +610,197 @@ module TalonOne
|
|
610
610
|
return data, status_code, headers
|
611
611
|
end
|
612
612
|
|
613
|
+
# List customer's achievement history
|
614
|
+
# Retrieve all progress history of a given customer in the given achievement.
|
615
|
+
# @param 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.
|
616
|
+
# @param achievement_id [Integer] The achievement identifier.
|
617
|
+
# @param [Hash] opts the optional parameters
|
618
|
+
# @option opts [Array<String>] :progress_status Filter by customer progress status in the achievement.
|
619
|
+
# @option opts [DateTime] :start_date Timestamp that filters the results to only contain achievements created on or after the start date.
|
620
|
+
# @option opts [DateTime] :end_date Timestamp that filters the results to only contain achievements created before or on the end date.
|
621
|
+
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
622
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
623
|
+
# @return [InlineResponse2002]
|
624
|
+
def get_customer_achievement_history(integration_id, achievement_id, opts = {})
|
625
|
+
data, _status_code, _headers = get_customer_achievement_history_with_http_info(integration_id, achievement_id, opts)
|
626
|
+
data
|
627
|
+
end
|
628
|
+
|
629
|
+
# List customer's achievement history
|
630
|
+
# Retrieve all progress history of a given customer in the given achievement.
|
631
|
+
# @param 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.
|
632
|
+
# @param achievement_id [Integer] The achievement identifier.
|
633
|
+
# @param [Hash] opts the optional parameters
|
634
|
+
# @option opts [Array<String>] :progress_status Filter by customer progress status in the achievement.
|
635
|
+
# @option opts [DateTime] :start_date Timestamp that filters the results to only contain achievements created on or after the start date.
|
636
|
+
# @option opts [DateTime] :end_date Timestamp that filters the results to only contain achievements created before or on the end date.
|
637
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
638
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
639
|
+
# @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 data, response status code and response headers
|
640
|
+
def get_customer_achievement_history_with_http_info(integration_id, achievement_id, opts = {})
|
641
|
+
if @api_client.config.debugging
|
642
|
+
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_customer_achievement_history ...'
|
643
|
+
end
|
644
|
+
# verify the required parameter 'integration_id' is set
|
645
|
+
if @api_client.config.client_side_validation && integration_id.nil?
|
646
|
+
fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationApi.get_customer_achievement_history"
|
647
|
+
end
|
648
|
+
# verify the required parameter 'achievement_id' is set
|
649
|
+
if @api_client.config.client_side_validation && achievement_id.nil?
|
650
|
+
fail ArgumentError, "Missing the required parameter 'achievement_id' when calling IntegrationApi.get_customer_achievement_history"
|
651
|
+
end
|
652
|
+
allowable_values = ["inprogress", "completed", "expired"]
|
653
|
+
if @api_client.config.client_side_validation && opts[:'progress_status'] && !opts[:'progress_status'].all? { |item| allowable_values.include?(item) }
|
654
|
+
fail ArgumentError, "invalid value for \"progress_status\", must include one of #{allowable_values}"
|
655
|
+
end
|
656
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
657
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_customer_achievement_history, must be smaller than or equal to 1000.'
|
658
|
+
end
|
659
|
+
|
660
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
661
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_customer_achievement_history, must be greater than or equal to 1.'
|
662
|
+
end
|
663
|
+
|
664
|
+
# resource path
|
665
|
+
local_var_path = '/v1/customer_profiles/{integrationId}/achievements/{achievementId}'.sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s)).sub('{' + 'achievementId' + '}', CGI.escape(achievement_id.to_s))
|
666
|
+
|
667
|
+
# query parameters
|
668
|
+
query_params = opts[:query_params] || {}
|
669
|
+
query_params[:'progressStatus'] = @api_client.build_collection_param(opts[:'progress_status'], :csv) if !opts[:'progress_status'].nil?
|
670
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
671
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
672
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
673
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
674
|
+
|
675
|
+
# header parameters
|
676
|
+
header_params = opts[:header_params] || {}
|
677
|
+
# HTTP header 'Accept' (if needed)
|
678
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
679
|
+
|
680
|
+
# form parameters
|
681
|
+
form_params = opts[:form_params] || {}
|
682
|
+
|
683
|
+
# http body (model)
|
684
|
+
post_body = opts[:body]
|
685
|
+
|
686
|
+
# return_type
|
687
|
+
return_type = opts[:return_type] || 'InlineResponse2002'
|
688
|
+
|
689
|
+
# auth_names
|
690
|
+
auth_names = opts[:auth_names] || ['api_key_v1']
|
691
|
+
|
692
|
+
new_options = opts.merge(
|
693
|
+
:header_params => header_params,
|
694
|
+
:query_params => query_params,
|
695
|
+
:form_params => form_params,
|
696
|
+
:body => post_body,
|
697
|
+
:auth_names => auth_names,
|
698
|
+
:return_type => return_type
|
699
|
+
)
|
700
|
+
|
701
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
702
|
+
if @api_client.config.debugging
|
703
|
+
@api_client.config.logger.debug "API called: IntegrationApi#get_customer_achievement_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
704
|
+
end
|
705
|
+
return data, status_code, headers
|
706
|
+
end
|
707
|
+
|
708
|
+
# List customer's available achievements
|
709
|
+
# Retrieve all the achievements available to a given customer and their progress in them.
|
710
|
+
# @param 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.
|
711
|
+
# @param [Hash] opts the optional parameters
|
712
|
+
# @option opts [Array<String>] :campaign_ids Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.
|
713
|
+
# @option opts [Array<String>] :achievement_ids Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned.
|
714
|
+
# @option opts [Array<String>] :achievement_status Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned.
|
715
|
+
# @option opts [Array<String>] :current_progress_status Filter by customer progress status in the achievement.
|
716
|
+
# @option opts [Integer] :page_size The number of items in the response. (default to 1000)
|
717
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
718
|
+
# @return [InlineResponse2001]
|
719
|
+
def get_customer_achievements(integration_id, opts = {})
|
720
|
+
data, _status_code, _headers = get_customer_achievements_with_http_info(integration_id, opts)
|
721
|
+
data
|
722
|
+
end
|
723
|
+
|
724
|
+
# List customer's available achievements
|
725
|
+
# Retrieve all the achievements available to a given customer and their progress in them.
|
726
|
+
# @param 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.
|
727
|
+
# @param [Hash] opts the optional parameters
|
728
|
+
# @option opts [Array<String>] :campaign_ids Filter by one or more Campaign IDs, separated by a comma. **Note:** If no campaigns are specified, data for all the campaigns in the Application is returned.
|
729
|
+
# @option opts [Array<String>] :achievement_ids Filter by one or more Achievement IDs, separated by a comma. **Note:** If no achievements are specified, data for all the achievements in the Application is returned.
|
730
|
+
# @option opts [Array<String>] :achievement_status Filter by status of the achievement. **Note:** If the achievement status is not specified, only data for all active achievements in the Application is returned.
|
731
|
+
# @option opts [Array<String>] :current_progress_status Filter by customer progress status in the achievement.
|
732
|
+
# @option opts [Integer] :page_size The number of items in the response.
|
733
|
+
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
734
|
+
# @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
|
735
|
+
def get_customer_achievements_with_http_info(integration_id, opts = {})
|
736
|
+
if @api_client.config.debugging
|
737
|
+
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_customer_achievements ...'
|
738
|
+
end
|
739
|
+
# verify the required parameter 'integration_id' is set
|
740
|
+
if @api_client.config.client_side_validation && integration_id.nil?
|
741
|
+
fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationApi.get_customer_achievements"
|
742
|
+
end
|
743
|
+
allowable_values = ["active", "scheduled"]
|
744
|
+
if @api_client.config.client_side_validation && opts[:'achievement_status'] && !opts[:'achievement_status'].all? { |item| allowable_values.include?(item) }
|
745
|
+
fail ArgumentError, "invalid value for \"achievement_status\", must include one of #{allowable_values}"
|
746
|
+
end
|
747
|
+
allowable_values = ["inprogress", "completed", "not_started"]
|
748
|
+
if @api_client.config.client_side_validation && opts[:'current_progress_status'] && !opts[:'current_progress_status'].all? { |item| allowable_values.include?(item) }
|
749
|
+
fail ArgumentError, "invalid value for \"current_progress_status\", must include one of #{allowable_values}"
|
750
|
+
end
|
751
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
752
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_customer_achievements, must be smaller than or equal to 1000.'
|
753
|
+
end
|
754
|
+
|
755
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
756
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_customer_achievements, must be greater than or equal to 1.'
|
757
|
+
end
|
758
|
+
|
759
|
+
# resource path
|
760
|
+
local_var_path = '/v1/customer_profiles/{integrationId}/achievements'.sub('{' + 'integrationId' + '}', CGI.escape(integration_id.to_s))
|
761
|
+
|
762
|
+
# query parameters
|
763
|
+
query_params = opts[:query_params] || {}
|
764
|
+
query_params[:'campaignIds'] = @api_client.build_collection_param(opts[:'campaign_ids'], :csv) if !opts[:'campaign_ids'].nil?
|
765
|
+
query_params[:'achievementIds'] = @api_client.build_collection_param(opts[:'achievement_ids'], :csv) if !opts[:'achievement_ids'].nil?
|
766
|
+
query_params[:'achievementStatus'] = @api_client.build_collection_param(opts[:'achievement_status'], :csv) if !opts[:'achievement_status'].nil?
|
767
|
+
query_params[:'currentProgressStatus'] = @api_client.build_collection_param(opts[:'current_progress_status'], :csv) if !opts[:'current_progress_status'].nil?
|
768
|
+
query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
|
769
|
+
query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
|
770
|
+
|
771
|
+
# header parameters
|
772
|
+
header_params = opts[:header_params] || {}
|
773
|
+
# HTTP header 'Accept' (if needed)
|
774
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
775
|
+
|
776
|
+
# form parameters
|
777
|
+
form_params = opts[:form_params] || {}
|
778
|
+
|
779
|
+
# http body (model)
|
780
|
+
post_body = opts[:body]
|
781
|
+
|
782
|
+
# return_type
|
783
|
+
return_type = opts[:return_type] || 'InlineResponse2001'
|
784
|
+
|
785
|
+
# auth_names
|
786
|
+
auth_names = opts[:auth_names] || ['api_key_v1']
|
787
|
+
|
788
|
+
new_options = opts.merge(
|
789
|
+
:header_params => header_params,
|
790
|
+
:query_params => query_params,
|
791
|
+
:form_params => form_params,
|
792
|
+
:body => post_body,
|
793
|
+
:auth_names => auth_names,
|
794
|
+
:return_type => return_type
|
795
|
+
)
|
796
|
+
|
797
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
798
|
+
if @api_client.config.debugging
|
799
|
+
@api_client.config.logger.debug "API called: IntegrationApi#get_customer_achievements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
800
|
+
end
|
801
|
+
return data, status_code, headers
|
802
|
+
end
|
803
|
+
|
613
804
|
# List customer data
|
614
805
|
# Return the customer inventory regarding entities referencing this customer profile's `integrationId`. Typical entities returned are: customer profile information, referral codes, loyalty points, loyalty cards and reserved coupons. Reserved coupons also include redeemed coupons.
|
615
806
|
# @param integration_id [String] The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. - The Management API with the [List application's customers](https://docs.talon.one/management-api#operation/getApplicationCustomers) endpoint.
|
@@ -919,7 +1110,7 @@ module TalonOne
|
|
919
1110
|
# @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
|
920
1111
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
921
1112
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
922
|
-
# @return [
|
1113
|
+
# @return [InlineResponse2005]
|
923
1114
|
def get_loyalty_card_points(loyalty_program_id, loyalty_card_id, opts = {})
|
924
1115
|
data, _status_code, _headers = get_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
925
1116
|
data
|
@@ -934,7 +1125,7 @@ module TalonOne
|
|
934
1125
|
# @option opts [Array<String>] :subledger_id Filter results by one or more subledger IDs. Must be exact match.
|
935
1126
|
# @option opts [Integer] :page_size The number of items in the response.
|
936
1127
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
937
|
-
# @return [Array<(
|
1128
|
+
# @return [Array<(InlineResponse2005, Integer, Hash)>] InlineResponse2005 data, response status code and response headers
|
938
1129
|
def get_loyalty_card_points_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
939
1130
|
if @api_client.config.debugging
|
940
1131
|
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_loyalty_card_points ...'
|
@@ -955,8 +1146,8 @@ module TalonOne
|
|
955
1146
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
956
1147
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
957
1148
|
end
|
958
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
959
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_card_points, must be smaller than or equal to
|
1149
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
1150
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_card_points, must be smaller than or equal to 1000.'
|
960
1151
|
end
|
961
1152
|
|
962
1153
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
@@ -985,7 +1176,7 @@ module TalonOne
|
|
985
1176
|
post_body = opts[:body]
|
986
1177
|
|
987
1178
|
# return_type
|
988
|
-
return_type = opts[:return_type] || '
|
1179
|
+
return_type = opts[:return_type] || 'InlineResponse2005'
|
989
1180
|
|
990
1181
|
# auth_names
|
991
1182
|
auth_names = opts[:auth_names] || ['api_key_v1']
|
@@ -1015,9 +1206,9 @@ module TalonOne
|
|
1015
1206
|
# @option opts [String] :loyalty_transaction_type Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file.
|
1016
1207
|
# @option opts [DateTime] :start_date Date and time from which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
1017
1208
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
1018
|
-
# @option opts [Integer] :page_size The number of items in the response. (default to
|
1209
|
+
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
1019
1210
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1020
|
-
# @return [
|
1211
|
+
# @return [InlineResponse2003]
|
1021
1212
|
def get_loyalty_card_transactions(loyalty_program_id, loyalty_card_id, opts = {})
|
1022
1213
|
data, _status_code, _headers = get_loyalty_card_transactions_with_http_info(loyalty_program_id, loyalty_card_id, opts)
|
1023
1214
|
data
|
@@ -1034,7 +1225,7 @@ module TalonOne
|
|
1034
1225
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
1035
1226
|
# @option opts [Integer] :page_size The number of items in the response.
|
1036
1227
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1037
|
-
# @return [Array<(
|
1228
|
+
# @return [Array<(InlineResponse2003, Integer, Hash)>] InlineResponse2003 data, response status code and response headers
|
1038
1229
|
def get_loyalty_card_transactions_with_http_info(loyalty_program_id, loyalty_card_id, opts = {})
|
1039
1230
|
if @api_client.config.debugging
|
1040
1231
|
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_loyalty_card_transactions ...'
|
@@ -1087,7 +1278,7 @@ module TalonOne
|
|
1087
1278
|
post_body = opts[:body]
|
1088
1279
|
|
1089
1280
|
# return_type
|
1090
|
-
return_type = opts[:return_type] || '
|
1281
|
+
return_type = opts[:return_type] || 'InlineResponse2003'
|
1091
1282
|
|
1092
1283
|
# auth_names
|
1093
1284
|
auth_names = opts[:auth_names] || ['api_key_v1']
|
@@ -1117,7 +1308,7 @@ module TalonOne
|
|
1117
1308
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1118
1309
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
1119
1310
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1120
|
-
# @return [
|
1311
|
+
# @return [InlineResponse2006]
|
1121
1312
|
def get_loyalty_program_profile_points(loyalty_program_id, integration_id, opts = {})
|
1122
1313
|
data, _status_code, _headers = get_loyalty_program_profile_points_with_http_info(loyalty_program_id, integration_id, opts)
|
1123
1314
|
data
|
@@ -1132,7 +1323,7 @@ module TalonOne
|
|
1132
1323
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1133
1324
|
# @option opts [Integer] :page_size The number of items in the response.
|
1134
1325
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1135
|
-
# @return [Array<(
|
1326
|
+
# @return [Array<(InlineResponse2006, Integer, Hash)>] InlineResponse2006 data, response status code and response headers
|
1136
1327
|
def get_loyalty_program_profile_points_with_http_info(loyalty_program_id, integration_id, opts = {})
|
1137
1328
|
if @api_client.config.debugging
|
1138
1329
|
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_loyalty_program_profile_points ...'
|
@@ -1149,8 +1340,8 @@ module TalonOne
|
|
1149
1340
|
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
1150
1341
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
1151
1342
|
end
|
1152
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
1153
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_program_profile_points, must be smaller than or equal to
|
1343
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
1344
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_program_profile_points, must be smaller than or equal to 1000.'
|
1154
1345
|
end
|
1155
1346
|
|
1156
1347
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
@@ -1179,7 +1370,7 @@ module TalonOne
|
|
1179
1370
|
post_body = opts[:body]
|
1180
1371
|
|
1181
1372
|
# return_type
|
1182
|
-
return_type = opts[:return_type] || '
|
1373
|
+
return_type = opts[:return_type] || 'InlineResponse2006'
|
1183
1374
|
|
1184
1375
|
# auth_names
|
1185
1376
|
auth_names = opts[:auth_names] || ['api_key_v1']
|
@@ -1211,7 +1402,7 @@ module TalonOne
|
|
1211
1402
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
1212
1403
|
# @option opts [Integer] :page_size The number of items in the response. (default to 50)
|
1213
1404
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1214
|
-
# @return [
|
1405
|
+
# @return [InlineResponse2004]
|
1215
1406
|
def get_loyalty_program_profile_transactions(loyalty_program_id, integration_id, opts = {})
|
1216
1407
|
data, _status_code, _headers = get_loyalty_program_profile_transactions_with_http_info(loyalty_program_id, integration_id, opts)
|
1217
1408
|
data
|
@@ -1228,7 +1419,7 @@ module TalonOne
|
|
1228
1419
|
# @option opts [DateTime] :end_date Date and time by which results are returned. Results are filtered by transaction creation date. **Note:** - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
|
1229
1420
|
# @option opts [Integer] :page_size The number of items in the response.
|
1230
1421
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1231
|
-
# @return [Array<(
|
1422
|
+
# @return [Array<(InlineResponse2004, Integer, Hash)>] InlineResponse2004 data, response status code and response headers
|
1232
1423
|
def get_loyalty_program_profile_transactions_with_http_info(loyalty_program_id, integration_id, opts = {})
|
1233
1424
|
if @api_client.config.debugging
|
1234
1425
|
@api_client.config.logger.debug 'Calling API: IntegrationApi.get_loyalty_program_profile_transactions ...'
|
@@ -1245,8 +1436,8 @@ module TalonOne
|
|
1245
1436
|
if @api_client.config.client_side_validation && opts[:'loyalty_transaction_type'] && !allowable_values.include?(opts[:'loyalty_transaction_type'])
|
1246
1437
|
fail ArgumentError, "invalid value for \"loyalty_transaction_type\", must be one of #{allowable_values}"
|
1247
1438
|
end
|
1248
|
-
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] >
|
1249
|
-
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_program_profile_transactions, must be smaller than or equal to
|
1439
|
+
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
|
1440
|
+
fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling IntegrationApi.get_loyalty_program_profile_transactions, must be smaller than or equal to 1000.'
|
1250
1441
|
end
|
1251
1442
|
|
1252
1443
|
if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
|
@@ -1277,7 +1468,7 @@ module TalonOne
|
|
1277
1468
|
post_body = opts[:body]
|
1278
1469
|
|
1279
1470
|
# return_type
|
1280
|
-
return_type = opts[:return_type] || '
|
1471
|
+
return_type = opts[:return_type] || 'InlineResponse2004'
|
1281
1472
|
|
1282
1473
|
# auth_names
|
1283
1474
|
auth_names = opts[:auth_names] || ['api_key_v1']
|
@@ -1649,8 +1840,9 @@ module TalonOne
|
|
1649
1840
|
# Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
|
1650
1841
|
# @param body [IntegrationEventV2Request] body
|
1651
1842
|
# @param [Hash] opts the optional parameters
|
1652
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1843
|
+
# @option opts [String] :silent 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. (default to 'yes')
|
1653
1844
|
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
1845
|
+
# @option opts [Boolean] :force_complete_evaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`. (default to false)
|
1654
1846
|
# @return [TrackEventV2Response]
|
1655
1847
|
def track_event_v2(body, opts = {})
|
1656
1848
|
data, _status_code, _headers = track_event_v2_with_http_info(body, opts)
|
@@ -1661,8 +1853,9 @@ module TalonOne
|
|
1661
1853
|
# Triggers a custom event. To use this endpoint: 1. Define a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) in the Campaign Manager. 1. Update or create a rule to check for this event. 1. Trigger the event with this endpoint. After you have successfully sent an event to Talon.One, you can list the received events in the **Events** view in the Campaign Manager. Talon.One also offers a set of [built-in events](https://docs.talon.one/docs/dev/concepts/entities/events). Ensure you do not create a custom event when you can use a built-in event. For example, use this endpoint to trigger an event when a customer shares a link to a product. See the [tutorial](https://docs.talon.one/docs/product/tutorials/referrals/incentivizing-product-link-sharing). <div class=\"redoc-section\"> <p class=\"title\">Important</p> 1. `profileId` is required even though the schema does not say it. 1. If the customer profile ID is new, a new profile is automatically created but the `customer_profile_created` [built-in event ](https://docs.talon.one/docs/dev/concepts/entities/events) is **not** triggered. 1. We recommend sending requests sequentially. See [Managing parallel requests](https://docs.talon.one/docs/dev/getting-started/integration-tutorial#managing-parallel-requests). </div>
|
1662
1854
|
# @param body [IntegrationEventV2Request] body
|
1663
1855
|
# @param [Hash] opts the optional parameters
|
1664
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
1856
|
+
# @option opts [String] :silent 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.
|
1665
1857
|
# @option opts [Boolean] :dry Indicates whether to persist the changes. Changes are ignored when `dry=true`.
|
1858
|
+
# @option opts [Boolean] :force_complete_evaluation Forces evaluation for all matching campaigns regardless of the [campaign evaluation mode](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation#setting-campaign-evaluation-mode). Requires `dry=true`.
|
1666
1859
|
# @return [Array<(TrackEventV2Response, Integer, Hash)>] TrackEventV2Response data, response status code and response headers
|
1667
1860
|
def track_event_v2_with_http_info(body, opts = {})
|
1668
1861
|
if @api_client.config.debugging
|
@@ -1679,6 +1872,7 @@ module TalonOne
|
|
1679
1872
|
query_params = opts[:query_params] || {}
|
1680
1873
|
query_params[:'silent'] = opts[:'silent'] if !opts[:'silent'].nil?
|
1681
1874
|
query_params[:'dry'] = opts[:'dry'] if !opts[:'dry'].nil?
|
1875
|
+
query_params[:'forceCompleteEvaluation'] = opts[:'force_complete_evaluation'] if !opts[:'force_complete_evaluation'].nil?
|
1682
1876
|
|
1683
1877
|
# header parameters
|
1684
1878
|
header_params = opts[:header_params] || {}
|
@@ -1999,7 +2193,7 @@ module TalonOne
|
|
1999
2193
|
# Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
|
2000
2194
|
# @param body [MultipleCustomerProfileIntegrationRequest] body
|
2001
2195
|
# @param [Hash] opts the optional parameters
|
2002
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
2196
|
+
# @option opts [String] :silent 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. (default to 'yes')
|
2003
2197
|
# @return [MultipleCustomerProfileIntegrationResponseV2]
|
2004
2198
|
def update_customer_profiles_v2(body, opts = {})
|
2005
2199
|
data, _status_code, _headers = update_customer_profiles_v2_with_http_info(body, opts)
|
@@ -2010,7 +2204,7 @@ module TalonOne
|
|
2010
2204
|
# Update (or create) up to 1000 [customer profiles](https://docs.talon.one/docs/dev/concepts/entities/customer-profiles) in 1 request. The `integrationId` must be any identifier that remains stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. A customer profile [can be linked to one or more sessions](https://docs.talon.one/integration-api#tag/Customer-sessions). **Note:** This endpoint does not trigger the Rule Engine. To trigger the Rule Engine for customer profile updates, use the [Update customer profile](#tag/Customer-profiles/operation/updateCustomerProfileV2) endpoint.
|
2011
2205
|
# @param body [MultipleCustomerProfileIntegrationRequest] body
|
2012
2206
|
# @param [Hash] opts the optional parameters
|
2013
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
2207
|
+
# @option opts [String] :silent 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.
|
2014
2208
|
# @return [Array<(MultipleCustomerProfileIntegrationResponseV2, Integer, Hash)>] MultipleCustomerProfileIntegrationResponseV2 data, response status code and response headers
|
2015
2209
|
def update_customer_profiles_v2_with_http_info(body, opts = {})
|
2016
2210
|
if @api_client.config.debugging
|