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
@@ -62,7 +62,7 @@ describe 'ManagementApi' do
|
|
62
62
|
# Add points to customer profile
|
63
63
|
# Add points in the specified loyalty program for the given customer. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
64
64
|
# @param loyalty_program_id The identifier for the loyalty program.
|
65
|
-
# @param integration_id The identifier
|
65
|
+
# @param integration_id 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.
|
66
66
|
# @param body body
|
67
67
|
# @param [Hash] opts the optional parameters
|
68
68
|
# @return [nil]
|
@@ -79,7 +79,7 @@ describe 'ManagementApi' do
|
|
79
79
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
80
80
|
# @param body body
|
81
81
|
# @param [Hash] opts the optional parameters
|
82
|
-
# @return [
|
82
|
+
# @return [InlineResponse2008]
|
83
83
|
describe 'copy_campaign_to_applications test' do
|
84
84
|
it 'should work' do
|
85
85
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -183,8 +183,8 @@ describe 'ManagementApi' do
|
|
183
183
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
184
184
|
# @param body body
|
185
185
|
# @param [Hash] opts the optional parameters
|
186
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
187
|
-
# @return [
|
186
|
+
# @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.
|
187
|
+
# @return [InlineResponse20010]
|
188
188
|
describe 'create_coupons test' do
|
189
189
|
it 'should work' do
|
190
190
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -226,8 +226,8 @@ describe 'ManagementApi' do
|
|
226
226
|
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
227
227
|
# @param body body
|
228
228
|
# @param [Hash] opts the optional parameters
|
229
|
-
# @option opts [String] :silent Possible values: `yes` or `no`. - `yes`: Increases the
|
230
|
-
# @return [
|
229
|
+
# @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.
|
230
|
+
# @return [InlineResponse20010]
|
231
231
|
describe 'create_coupons_for_multiple_recipients test' do
|
232
232
|
it 'should work' do
|
233
233
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -573,7 +573,7 @@ describe 'ManagementApi' do
|
|
573
573
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
574
574
|
# @param [Hash] opts the optional parameters
|
575
575
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
576
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
576
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
577
577
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
578
578
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
579
579
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -711,11 +711,11 @@ describe 'ManagementApi' do
|
|
711
711
|
|
712
712
|
# unit tests for export_loyalty_ledger
|
713
713
|
# Export customer's transaction logs
|
714
|
-
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign.
|
714
|
+
# Download a CSV file containing a customer's transaction logs in the loyalty program. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The generated file can contain the following columns: - `customerprofileid`: The ID of the profile. - `customersessionid`: The ID of the customer session. - `rulesetid`: The ID of the rule set. - `rulename`: The name of the rule. - `programid`: The ID of the loyalty program. - `type`: The transaction type, such as `addition` or `subtraction`. - `name`: The reason for the transaction. - `subledgerid`: The ID of the subledger, when applicable. - `startdate`: The start date of the program. - `expirydate`: The expiration date of the program. - `id`: The ID of the transaction. - `created`: The timestamp of the creation of the loyalty program. - `amount`: The number of points in that transaction. - `archived`: Whether the session related to the transaction is archived. - `campaignid`: The ID of the campaign. - `flags`: The flags of the transaction, when applicable. The `createsNegativeBalance` flag indicates whether the transaction results in a negative balance.
|
715
715
|
# @param range_start 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.
|
716
716
|
# @param range_end 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.
|
717
717
|
# @param loyalty_program_id The identifier for the loyalty program.
|
718
|
-
# @param integration_id The identifier
|
718
|
+
# @param integration_id 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.
|
719
719
|
# @param [Hash] opts the optional parameters
|
720
720
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
721
721
|
# @return [String]
|
@@ -770,8 +770,8 @@ describe 'ManagementApi' do
|
|
770
770
|
# @option opts [String] :status Filter results by HTTP status codes.
|
771
771
|
# @option opts [Integer] :page_size The number of items in the response.
|
772
772
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
773
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
774
|
-
# @return [
|
773
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
774
|
+
# @return [InlineResponse20022]
|
775
775
|
describe 'get_access_logs_without_total_count test' do
|
776
776
|
it 'should work' do
|
777
777
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -846,8 +846,8 @@ describe 'ManagementApi' do
|
|
846
846
|
# @param [Hash] opts the optional parameters
|
847
847
|
# @option opts [Integer] :page_size The number of items in the response.
|
848
848
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
849
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
850
|
-
# @return [
|
849
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
850
|
+
# @return [InlineResponse20038]
|
851
851
|
describe 'get_additional_costs test' do
|
852
852
|
it 'should work' do
|
853
853
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -899,9 +899,9 @@ describe 'ManagementApi' do
|
|
899
899
|
# @param [Hash] opts the optional parameters
|
900
900
|
# @option opts [Integer] :page_size The number of items in the response.
|
901
901
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
902
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
902
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
903
903
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
904
|
-
# @return [
|
904
|
+
# @return [InlineResponse20035]
|
905
905
|
describe 'get_application_customer_friends test' do
|
906
906
|
it 'should work' do
|
907
907
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -917,7 +917,7 @@ describe 'ManagementApi' do
|
|
917
917
|
# @option opts [Integer] :page_size The number of items in the response.
|
918
918
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
919
919
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
920
|
-
# @return [
|
920
|
+
# @return [InlineResponse20024]
|
921
921
|
describe 'get_application_customers test' do
|
922
922
|
it 'should work' do
|
923
923
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -933,7 +933,7 @@ describe 'ManagementApi' do
|
|
933
933
|
# @option opts [Integer] :page_size The number of items in the response.
|
934
934
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
935
935
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
936
|
-
# @return [
|
936
|
+
# @return [InlineResponse20025]
|
937
937
|
describe 'get_application_customers_by_attributes test' do
|
938
938
|
it 'should work' do
|
939
939
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -947,8 +947,8 @@ describe 'ManagementApi' do
|
|
947
947
|
# @param [Hash] opts the optional parameters
|
948
948
|
# @option opts [Integer] :page_size The number of items in the response.
|
949
949
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
950
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
951
|
-
# @return [
|
950
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
951
|
+
# @return [InlineResponse20031]
|
952
952
|
describe 'get_application_event_types test' do
|
953
953
|
it 'should work' do
|
954
954
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -962,7 +962,7 @@ describe 'ManagementApi' do
|
|
962
962
|
# @param [Hash] opts the optional parameters
|
963
963
|
# @option opts [Integer] :page_size The number of items in the response.
|
964
964
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
965
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
965
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
966
966
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
967
967
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
968
968
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -974,7 +974,7 @@ describe 'ManagementApi' do
|
|
974
974
|
# @option opts [String] :referral_code Referral code
|
975
975
|
# @option opts [String] :rule_query Rule name filter for events
|
976
976
|
# @option opts [String] :campaign_query Campaign name filter for events
|
977
|
-
# @return [
|
977
|
+
# @return [InlineResponse20030]
|
978
978
|
describe 'get_application_events_without_total_count test' do
|
979
979
|
it 'should work' do
|
980
980
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1001,7 +1001,7 @@ describe 'ManagementApi' do
|
|
1001
1001
|
# @param [Hash] opts the optional parameters
|
1002
1002
|
# @option opts [Integer] :page_size The number of items in the response.
|
1003
1003
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1004
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1004
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1005
1005
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
1006
1006
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
1007
1007
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -1010,7 +1010,7 @@ describe 'ManagementApi' do
|
|
1010
1010
|
# @option opts [String] :referral Filter by sessions with this referral. Must be exact match.
|
1011
1011
|
# @option opts [String] :integration_id Filter by sessions with this integration ID. Must be exact match.
|
1012
1012
|
# @option opts [String] :store_integration_id The integration ID of the store. You choose this ID when you create a store.
|
1013
|
-
# @return [
|
1013
|
+
# @return [InlineResponse20029]
|
1014
1014
|
describe 'get_application_sessions test' do
|
1015
1015
|
it 'should work' do
|
1016
1016
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1023,8 +1023,8 @@ describe 'ManagementApi' do
|
|
1023
1023
|
# @param [Hash] opts the optional parameters
|
1024
1024
|
# @option opts [Integer] :page_size The number of items in the response.
|
1025
1025
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1026
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1027
|
-
# @return [
|
1026
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1027
|
+
# @return [InlineResponse2007]
|
1028
1028
|
describe 'get_applications test' do
|
1029
1029
|
it 'should work' do
|
1030
1030
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1049,9 +1049,9 @@ describe 'ManagementApi' do
|
|
1049
1049
|
# @param [Hash] opts the optional parameters
|
1050
1050
|
# @option opts [Integer] :page_size The number of items in the response.
|
1051
1051
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1052
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1052
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1053
1053
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
1054
|
-
# @return [
|
1054
|
+
# @return [InlineResponse20036]
|
1055
1055
|
describe 'get_attributes test' do
|
1056
1056
|
it 'should work' do
|
1057
1057
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1065,9 +1065,9 @@ describe 'ManagementApi' do
|
|
1065
1065
|
# @param [Hash] opts the optional parameters
|
1066
1066
|
# @option opts [Integer] :page_size The number of items in the response.
|
1067
1067
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1068
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1068
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1069
1069
|
# @option opts [String] :profile_query The filter to select a profile.
|
1070
|
-
# @return [
|
1070
|
+
# @return [InlineResponse20034]
|
1071
1071
|
describe 'get_audience_memberships test' do
|
1072
1072
|
it 'should work' do
|
1073
1073
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1080,9 +1080,9 @@ describe 'ManagementApi' do
|
|
1080
1080
|
# @param [Hash] opts the optional parameters
|
1081
1081
|
# @option opts [Integer] :page_size The number of items in the response.
|
1082
1082
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1083
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1083
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1084
1084
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1085
|
-
# @return [
|
1085
|
+
# @return [InlineResponse20032]
|
1086
1086
|
describe 'get_audiences test' do
|
1087
1087
|
it 'should work' do
|
1088
1088
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1094,8 +1094,8 @@ describe 'ManagementApi' do
|
|
1094
1094
|
# Get a list of audience IDs and their member count.
|
1095
1095
|
# @param audience_ids The IDs of one or more audiences, separated by commas, by which to filter results.
|
1096
1096
|
# @param [Hash] opts the optional parameters
|
1097
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1098
|
-
# @return [
|
1097
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1098
|
+
# @return [InlineResponse20033]
|
1099
1099
|
describe 'get_audiences_analytics test' do
|
1100
1100
|
it 'should work' do
|
1101
1101
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1124,7 +1124,7 @@ describe 'ManagementApi' do
|
|
1124
1124
|
# @param range_end 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.
|
1125
1125
|
# @param [Hash] opts the optional parameters
|
1126
1126
|
# @option opts [String] :granularity The time interval between the results in the returned time-series.
|
1127
|
-
# @return [
|
1127
|
+
# @return [InlineResponse20023]
|
1128
1128
|
describe 'get_campaign_analytics test' do
|
1129
1129
|
it 'should work' do
|
1130
1130
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1139,9 +1139,9 @@ describe 'ManagementApi' do
|
|
1139
1139
|
# @param [Hash] opts the optional parameters
|
1140
1140
|
# @option opts [Integer] :page_size The number of items in the response.
|
1141
1141
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1142
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1142
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1143
1143
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
1144
|
-
# @return [
|
1144
|
+
# @return [InlineResponse2008]
|
1145
1145
|
describe 'get_campaign_by_attributes test' do
|
1146
1146
|
it 'should work' do
|
1147
1147
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1166,8 +1166,8 @@ describe 'ManagementApi' do
|
|
1166
1166
|
# @param [Hash] opts the optional parameters
|
1167
1167
|
# @option opts [Integer] :page_size The number of items in the response.
|
1168
1168
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1169
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1170
|
-
# @return [
|
1169
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1170
|
+
# @return [InlineResponse20013]
|
1171
1171
|
describe 'get_campaign_groups test' do
|
1172
1172
|
it 'should work' do
|
1173
1173
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1180,12 +1180,12 @@ describe 'ManagementApi' do
|
|
1180
1180
|
# @param [Hash] opts the optional parameters
|
1181
1181
|
# @option opts [Integer] :page_size The number of items in the response.
|
1182
1182
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1183
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1183
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1184
1184
|
# @option opts [String] :state Filter results by the state of the campaign template.
|
1185
1185
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
1186
1186
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values.
|
1187
1187
|
# @option opts [Integer] :user_id Filter results by user ID.
|
1188
|
-
# @return [
|
1188
|
+
# @return [InlineResponse20014]
|
1189
1189
|
describe 'get_campaign_templates test' do
|
1190
1190
|
it 'should work' do
|
1191
1191
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1199,7 +1199,7 @@ describe 'ManagementApi' do
|
|
1199
1199
|
# @param [Hash] opts the optional parameters
|
1200
1200
|
# @option opts [Integer] :page_size The number of items in the response.
|
1201
1201
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1202
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1202
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1203
1203
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
1204
1204
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
1205
1205
|
# @option opts [String] :tags Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the \"name\" query parameter, a logical OR will be performed to search both tags and name for the provided values
|
@@ -1208,7 +1208,7 @@ describe 'ManagementApi' do
|
|
1208
1208
|
# @option opts [Integer] :campaign_group_id Filter results to campaigns owned by the specified campaign access group ID.
|
1209
1209
|
# @option opts [Integer] :template_id The ID of the campaign template this campaign was created from.
|
1210
1210
|
# @option opts [Integer] :store_id Filter results to campaigns linked to the specified store ID.
|
1211
|
-
# @return [
|
1211
|
+
# @return [InlineResponse2008]
|
1212
1212
|
describe 'get_campaigns test' do
|
1213
1213
|
it 'should work' do
|
1214
1214
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1221,7 +1221,7 @@ describe 'ManagementApi' do
|
|
1221
1221
|
# @param [Hash] opts the optional parameters
|
1222
1222
|
# @option opts [Integer] :page_size The number of items in the response.
|
1223
1223
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1224
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1224
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1225
1225
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1226
1226
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
1227
1227
|
# @option opts [Integer] :user_id Filter results by user ID.
|
@@ -1230,7 +1230,7 @@ describe 'ManagementApi' do
|
|
1230
1230
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1231
1231
|
# @option opts [Integer] :management_key_id Filter results that match the given management key ID.
|
1232
1232
|
# @option opts [Boolean] :include_old When this flag is set to false, the state without the change will not be returned. The default value is true.
|
1233
|
-
# @return [
|
1233
|
+
# @return [InlineResponse20044]
|
1234
1234
|
describe 'get_changes test' do
|
1235
1235
|
it 'should work' do
|
1236
1236
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1258,7 +1258,7 @@ describe 'ManagementApi' do
|
|
1258
1258
|
# @param [Hash] opts the optional parameters
|
1259
1259
|
# @option opts [Integer] :page_size The number of items in the response.
|
1260
1260
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1261
|
-
# @return [
|
1261
|
+
# @return [InlineResponse20021]
|
1262
1262
|
describe 'get_collection_items test' do
|
1263
1263
|
it 'should work' do
|
1264
1264
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1273,7 +1273,7 @@ describe 'ManagementApi' do
|
|
1273
1273
|
# @param [Hash] opts the optional parameters
|
1274
1274
|
# @option opts [Integer] :page_size The number of items in the response.
|
1275
1275
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1276
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1276
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1277
1277
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1278
1278
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1279
1279
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -1289,7 +1289,7 @@ describe 'ManagementApi' do
|
|
1289
1289
|
# @option opts [DateTime] :starts_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1290
1290
|
# @option opts [DateTime] :starts_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1291
1291
|
# @option opts [Boolean] :values_only Filter results to only return the coupon codes (`value` column) without the associated coupon data.
|
1292
|
-
# @return [
|
1292
|
+
# @return [InlineResponse20011]
|
1293
1293
|
describe 'get_coupons_without_total_count test' do
|
1294
1294
|
it 'should work' do
|
1295
1295
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1322,12 +1322,12 @@ describe 'ManagementApi' do
|
|
1322
1322
|
# @param [Hash] opts the optional parameters
|
1323
1323
|
# @option opts [Integer] :page_size The number of items in the response.
|
1324
1324
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1325
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1325
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1326
1326
|
# @option opts [String] :name Only return reports matching the customer name.
|
1327
1327
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
1328
1328
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
1329
1329
|
# @option opts [String] :advocate_name Only return reports matching the current customer referrer name.
|
1330
|
-
# @return [
|
1330
|
+
# @return [InlineResponse20028]
|
1331
1331
|
describe 'get_customer_activity_reports_without_total_count test' do
|
1332
1332
|
it 'should work' do
|
1333
1333
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1342,7 +1342,7 @@ describe 'ManagementApi' do
|
|
1342
1342
|
# @param [Hash] opts the optional parameters
|
1343
1343
|
# @option opts [Integer] :page_size The number of items in the response.
|
1344
1344
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1345
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1345
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1346
1346
|
# @return [CustomerAnalytics]
|
1347
1347
|
describe 'get_customer_analytics test' do
|
1348
1348
|
it 'should work' do
|
@@ -1366,13 +1366,13 @@ describe 'ManagementApi' do
|
|
1366
1366
|
# List customer achievements
|
1367
1367
|
# For the given customer profile, list all the achievements that match your filter criteria.
|
1368
1368
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1369
|
-
# @param integration_id The identifier
|
1369
|
+
# @param integration_id 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.
|
1370
1370
|
# @param [Hash] opts the optional parameters
|
1371
1371
|
# @option opts [Integer] :page_size The number of items in the response.
|
1372
1372
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1373
1373
|
# @option opts [Integer] :achievement_id 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.
|
1374
1374
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
1375
|
-
# @return [
|
1375
|
+
# @return [InlineResponse20049]
|
1376
1376
|
describe 'get_customer_profile_achievement_progress test' do
|
1377
1377
|
it 'should work' do
|
1378
1378
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1386,7 +1386,7 @@ describe 'ManagementApi' do
|
|
1386
1386
|
# @option opts [Integer] :page_size The number of items in the response.
|
1387
1387
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1388
1388
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
1389
|
-
# @return [
|
1389
|
+
# @return [InlineResponse20027]
|
1390
1390
|
describe 'get_customer_profiles test' do
|
1391
1391
|
it 'should work' do
|
1392
1392
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1401,13 +1401,28 @@ describe 'ManagementApi' do
|
|
1401
1401
|
# @option opts [Integer] :page_size The number of items in the response.
|
1402
1402
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1403
1403
|
# @option opts [Boolean] :sandbox Indicates whether you are pointing to a sandbox or live customer.
|
1404
|
-
# @return [
|
1404
|
+
# @return [InlineResponse20026]
|
1405
1405
|
describe 'get_customers_by_attributes test' do
|
1406
1406
|
it 'should work' do
|
1407
1407
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1408
1408
|
end
|
1409
1409
|
end
|
1410
1410
|
|
1411
|
+
# unit tests for get_dashboard_statistics
|
1412
|
+
# Get statistics for loyalty dashboard
|
1413
|
+
# 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.
|
1414
|
+
# @param loyalty_program_id 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.
|
1415
|
+
# @param range_start 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.
|
1416
|
+
# @param range_end 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.
|
1417
|
+
# @param [Hash] opts the optional parameters
|
1418
|
+
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1419
|
+
# @return [InlineResponse20016]
|
1420
|
+
describe 'get_dashboard_statistics test' do
|
1421
|
+
it 'should work' do
|
1422
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1423
|
+
end
|
1424
|
+
end
|
1425
|
+
|
1411
1426
|
# unit tests for get_event_types
|
1412
1427
|
# List event types
|
1413
1428
|
# Fetch all event type definitions for your account.
|
@@ -1416,8 +1431,8 @@ describe 'ManagementApi' do
|
|
1416
1431
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
1417
1432
|
# @option opts [Integer] :page_size The number of items in the response.
|
1418
1433
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1419
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1420
|
-
# @return [
|
1434
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1435
|
+
# @return [InlineResponse20042]
|
1421
1436
|
describe 'get_event_types test' do
|
1422
1437
|
it 'should work' do
|
1423
1438
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1433,7 +1448,7 @@ describe 'ManagementApi' do
|
|
1433
1448
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1434
1449
|
# @option opts [Integer] :campaign_id Filter by the campaign ID on which the limit counters are used.
|
1435
1450
|
# @option opts [String] :entity The name of the entity type that was exported.
|
1436
|
-
# @return [
|
1451
|
+
# @return [InlineResponse20045]
|
1437
1452
|
describe 'get_exports test' do
|
1438
1453
|
it 'should work' do
|
1439
1454
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1464,7 +1479,7 @@ describe 'ManagementApi' do
|
|
1464
1479
|
# @option opts [Integer] :page_size The number of items in the response.
|
1465
1480
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1466
1481
|
# @option opts [String] :subledger_id The ID of the subledger by which we filter the data.
|
1467
|
-
# @return [
|
1482
|
+
# @return [InlineResponse20019]
|
1468
1483
|
describe 'get_loyalty_card_transaction_logs test' do
|
1469
1484
|
it 'should work' do
|
1470
1485
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1478,11 +1493,11 @@ describe 'ManagementApi' do
|
|
1478
1493
|
# @param [Hash] opts the optional parameters
|
1479
1494
|
# @option opts [Integer] :page_size The number of items in the response.
|
1480
1495
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1481
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1496
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1482
1497
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
1483
1498
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
1484
1499
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
1485
|
-
# @return [
|
1500
|
+
# @return [InlineResponse20018]
|
1486
1501
|
describe 'get_loyalty_cards test' do
|
1487
1502
|
it 'should work' do
|
1488
1503
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1493,7 +1508,7 @@ describe 'ManagementApi' do
|
|
1493
1508
|
# Get customer's full loyalty ledger
|
1494
1509
|
# Get the loyalty ledger for this profile integration ID. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint. **Important:** To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's [Get customer's loyalty logs](https://docs.talon.one/integration-api#tag/Loyalty/operation/getLoyaltyProgramProfileTransactions).
|
1495
1510
|
# @param loyalty_program_id The identifier for the loyalty program.
|
1496
|
-
# @param integration_id The identifier
|
1511
|
+
# @param integration_id 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.
|
1497
1512
|
# @param [Hash] opts the optional parameters
|
1498
1513
|
# @return [LoyaltyLedger]
|
1499
1514
|
describe 'get_loyalty_points test' do
|
@@ -1525,7 +1540,7 @@ describe 'ManagementApi' do
|
|
1525
1540
|
# @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.
|
1526
1541
|
# @option opts [Integer] :page_size The number of items in the response.
|
1527
1542
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1528
|
-
# @return [
|
1543
|
+
# @return [InlineResponse20017]
|
1529
1544
|
describe 'get_loyalty_program_transactions test' do
|
1530
1545
|
it 'should work' do
|
1531
1546
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1536,7 +1551,7 @@ describe 'ManagementApi' do
|
|
1536
1551
|
# List loyalty programs
|
1537
1552
|
# List the loyalty programs of the account.
|
1538
1553
|
# @param [Hash] opts the optional parameters
|
1539
|
-
# @return [
|
1554
|
+
# @return [InlineResponse20015]
|
1540
1555
|
describe 'get_loyalty_programs test' do
|
1541
1556
|
it 'should work' do
|
1542
1557
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1545,7 +1560,7 @@ describe 'ManagementApi' do
|
|
1545
1560
|
|
1546
1561
|
# unit tests for get_loyalty_statistics
|
1547
1562
|
# Get loyalty program statistics
|
1548
|
-
#
|
1563
|
+
# ⚠️ 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.
|
1549
1564
|
# @param loyalty_program_id 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.
|
1550
1565
|
# @param [Hash] opts the optional parameters
|
1551
1566
|
# @return [LoyaltyDashboardData]
|
@@ -1555,6 +1570,31 @@ describe 'ManagementApi' do
|
|
1555
1570
|
end
|
1556
1571
|
end
|
1557
1572
|
|
1573
|
+
# unit tests for get_message_logs
|
1574
|
+
# List message log entries
|
1575
|
+
# Retrieve all message log entries.
|
1576
|
+
# @param entity_type The entity type the log is related to.
|
1577
|
+
# @param [Hash] opts the optional parameters
|
1578
|
+
# @option opts [String] :message_id Filter results by message ID.
|
1579
|
+
# @option opts [String] :change_type Filter results by change type.
|
1580
|
+
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
1581
|
+
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1582
|
+
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1583
|
+
# @option opts [String] :cursor A specific unique value in the database. If this value is not given, the server fetches results starting with the first record.
|
1584
|
+
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
1585
|
+
# @option opts [Boolean] :is_successful Indicates whether to return log entries with either successful or unsuccessful HTTP response codes. When set to`true`, only log entries with `2xx` response codes are returned. When set to `false`, only log entries with `4xx` and `5xx` response codes are returned.
|
1586
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
1587
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
1588
|
+
# @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
|
1589
|
+
# @option opts [Integer] :response_code Filter results by response status code.
|
1590
|
+
# @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
|
1591
|
+
# @return [MessageLogEntries]
|
1592
|
+
describe 'get_message_logs test' do
|
1593
|
+
it 'should work' do
|
1594
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1595
|
+
end
|
1596
|
+
end
|
1597
|
+
|
1558
1598
|
# unit tests for get_referrals_without_total_count
|
1559
1599
|
# List referrals
|
1560
1600
|
# List all referrals of the specified campaign.
|
@@ -1563,14 +1603,14 @@ describe 'ManagementApi' do
|
|
1563
1603
|
# @param [Hash] opts the optional parameters
|
1564
1604
|
# @option opts [Integer] :page_size The number of items in the response.
|
1565
1605
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1566
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1606
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1567
1607
|
# @option opts [String] :code Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
1568
1608
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1569
1609
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1570
1610
|
# @option opts [String] :valid Either \"expired\", \"validNow\", or \"validFuture\". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future.
|
1571
1611
|
# @option opts [String] :usable Either \"true\" or \"false\". If \"true\", only referrals where `usageCounter < usageLimit` will be returned, \"false\" will return only referrals where `usageCounter >= usageLimit`.
|
1572
1612
|
# @option opts [String] :advocate Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field.
|
1573
|
-
# @return [
|
1613
|
+
# @return [InlineResponse20012]
|
1574
1614
|
describe 'get_referrals_without_total_count test' do
|
1575
1615
|
it 'should work' do
|
1576
1616
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1611,8 +1651,8 @@ describe 'ManagementApi' do
|
|
1611
1651
|
# @param [Hash] opts the optional parameters
|
1612
1652
|
# @option opts [Integer] :page_size The number of items in the response.
|
1613
1653
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1614
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1615
|
-
# @return [
|
1654
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1655
|
+
# @return [InlineResponse2009]
|
1616
1656
|
describe 'get_rulesets test' do
|
1617
1657
|
it 'should work' do
|
1618
1658
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1650,8 +1690,8 @@ describe 'ManagementApi' do
|
|
1650
1690
|
# @param [Hash] opts the optional parameters
|
1651
1691
|
# @option opts [Integer] :page_size The number of items in the response.
|
1652
1692
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1653
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1654
|
-
# @return [
|
1693
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1694
|
+
# @return [InlineResponse20043]
|
1655
1695
|
describe 'get_users test' do
|
1656
1696
|
it 'should work' do
|
1657
1697
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1676,14 +1716,14 @@ describe 'ManagementApi' do
|
|
1676
1716
|
# @param [Hash] opts the optional parameters
|
1677
1717
|
# @option opts [Integer] :page_size The number of items in the response.
|
1678
1718
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1679
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1719
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1680
1720
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
1681
1721
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
1682
1722
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1683
1723
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
1684
1724
|
# @option opts [DateTime] :created_before Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1685
1725
|
# @option opts [DateTime] :created_after Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1686
|
-
# @return [
|
1726
|
+
# @return [InlineResponse20040]
|
1687
1727
|
describe 'get_webhook_activation_logs test' do
|
1688
1728
|
it 'should work' do
|
1689
1729
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1696,7 +1736,7 @@ describe 'ManagementApi' do
|
|
1696
1736
|
# @param [Hash] opts the optional parameters
|
1697
1737
|
# @option opts [Integer] :page_size The number of items in the response.
|
1698
1738
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1699
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1739
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1700
1740
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1701
1741
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
1702
1742
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -1704,7 +1744,7 @@ describe 'ManagementApi' do
|
|
1704
1744
|
# @option opts [String] :request_uuid Filter results by request UUID.
|
1705
1745
|
# @option opts [DateTime] :created_before Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1706
1746
|
# @option opts [DateTime] :created_after Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
|
1707
|
-
# @return [
|
1747
|
+
# @return [InlineResponse20041]
|
1708
1748
|
describe 'get_webhook_logs test' do
|
1709
1749
|
it 'should work' do
|
1710
1750
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1716,14 +1756,14 @@ describe 'ManagementApi' do
|
|
1716
1756
|
# List all webhooks.
|
1717
1757
|
# @param [Hash] opts the optional parameters
|
1718
1758
|
# @option opts [String] :application_ids Checks if the given catalog or its attributes are referenced in the specified Application ID. **Note**: If no Application ID is provided, we check for all connected Applications.
|
1719
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1759
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1720
1760
|
# @option opts [Integer] :page_size The number of items in the response.
|
1721
1761
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1722
1762
|
# @option opts [String] :creation_type Filter results by creation type.
|
1723
1763
|
# @option opts [String] :visibility Filter results by visibility.
|
1724
1764
|
# @option opts [Integer] :outgoing_integrations_type_id Filter results by outgoing integration type ID.
|
1725
1765
|
# @option opts [String] :title Filter results performing case-insensitive matching against the webhook title.
|
1726
|
-
# @return [
|
1766
|
+
# @return [InlineResponse20039]
|
1727
1767
|
describe 'get_webhooks test' do
|
1728
1768
|
it 'should work' do
|
1729
1769
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1897,10 +1937,10 @@ describe 'ManagementApi' do
|
|
1897
1937
|
# @param [Hash] opts the optional parameters
|
1898
1938
|
# @option opts [Integer] :page_size The number of items in the response.
|
1899
1939
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1900
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
1940
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1901
1941
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1902
1942
|
# @option opts [String] :name Filter by collection name.
|
1903
|
-
# @return [
|
1943
|
+
# @return [InlineResponse20020]
|
1904
1944
|
describe 'list_account_collections test' do
|
1905
1945
|
it 'should work' do
|
1906
1946
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1916,7 +1956,7 @@ describe 'ManagementApi' do
|
|
1916
1956
|
# @option opts [Integer] :page_size The number of items in the response.
|
1917
1957
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1918
1958
|
# @option opts [String] :title Filter by the display name for the achievement in the campaign manager. **Note**: If no `title` is provided, all the achievements from the campaign are returned.
|
1919
|
-
# @return [
|
1959
|
+
# @return [InlineResponse20048]
|
1920
1960
|
describe 'list_achievements test' do
|
1921
1961
|
it 'should work' do
|
1922
1962
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1927,7 +1967,7 @@ describe 'ManagementApi' do
|
|
1927
1967
|
# List roles
|
1928
1968
|
# List all roles.
|
1929
1969
|
# @param [Hash] opts the optional parameters
|
1930
|
-
# @return [
|
1970
|
+
# @return [InlineResponse20046]
|
1931
1971
|
describe 'list_all_roles_v2 test' do
|
1932
1972
|
it 'should work' do
|
1933
1973
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1944,7 +1984,7 @@ describe 'ManagementApi' do
|
|
1944
1984
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1945
1985
|
# @option opts [Array<String>] :sku Filter results by one or more SKUs. Must be exact match.
|
1946
1986
|
# @option opts [Array<String>] :product_names Filter results by one or more product names. Must be exact match.
|
1947
|
-
# @return [
|
1987
|
+
# @return [InlineResponse20037]
|
1948
1988
|
describe 'list_catalog_items test' do
|
1949
1989
|
it 'should work' do
|
1950
1990
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1959,10 +1999,10 @@ describe 'ManagementApi' do
|
|
1959
1999
|
# @param [Hash] opts the optional parameters
|
1960
2000
|
# @option opts [Integer] :page_size The number of items in the response.
|
1961
2001
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1962
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2002
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1963
2003
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1964
2004
|
# @option opts [String] :name Filter by collection name.
|
1965
|
-
# @return [
|
2005
|
+
# @return [InlineResponse20020]
|
1966
2006
|
describe 'list_collections test' do
|
1967
2007
|
it 'should work' do
|
1968
2008
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1976,10 +2016,10 @@ describe 'ManagementApi' do
|
|
1976
2016
|
# @param [Hash] opts the optional parameters
|
1977
2017
|
# @option opts [Integer] :page_size The number of items in the response.
|
1978
2018
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1979
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2019
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1980
2020
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1981
2021
|
# @option opts [String] :name Filter by collection name.
|
1982
|
-
# @return [
|
2022
|
+
# @return [InlineResponse20020]
|
1983
2023
|
describe 'list_collections_in_application test' do
|
1984
2024
|
it 'should work' do
|
1985
2025
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1993,32 +2033,19 @@ describe 'ManagementApi' do
|
|
1993
2033
|
# @param [Hash] opts the optional parameters
|
1994
2034
|
# @option opts [Integer] :page_size The number of items in the response.
|
1995
2035
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1996
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2036
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
1997
2037
|
# @option opts [Boolean] :with_total_result_size When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
|
1998
2038
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
1999
2039
|
# @option opts [String] :name The name of the store.
|
2000
2040
|
# @option opts [String] :integration_id The integration ID of the store.
|
2001
2041
|
# @option opts [String] :query Filter results by `name` or `integrationId`.
|
2002
|
-
# @return [
|
2042
|
+
# @return [InlineResponse20047]
|
2003
2043
|
describe 'list_stores test' do
|
2004
2044
|
it 'should work' do
|
2005
2045
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2006
2046
|
end
|
2007
2047
|
end
|
2008
2048
|
|
2009
|
-
# unit tests for notification_activation
|
2010
|
-
# Activate or deactivate notification
|
2011
|
-
# Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
2012
|
-
# @param notification_id The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
2013
|
-
# @param body body
|
2014
|
-
# @param [Hash] opts the optional parameters
|
2015
|
-
# @return [nil]
|
2016
|
-
describe 'notification_activation test' do
|
2017
|
-
it 'should work' do
|
2018
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2019
|
-
end
|
2020
|
-
end
|
2021
|
-
|
2022
2049
|
# unit tests for okta_event_handler_challenge
|
2023
2050
|
# Validate Okta API ownership
|
2024
2051
|
# Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.
|
@@ -2030,50 +2057,11 @@ describe 'ManagementApi' do
|
|
2030
2057
|
end
|
2031
2058
|
end
|
2032
2059
|
|
2033
|
-
# unit tests for post_added_deducted_points_notification
|
2034
|
-
# Create notification about added or deducted loyalty points
|
2035
|
-
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
2036
|
-
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2037
|
-
# @param body body
|
2038
|
-
# @param [Hash] opts the optional parameters
|
2039
|
-
# @return [BaseNotification]
|
2040
|
-
describe 'post_added_deducted_points_notification test' do
|
2041
|
-
it 'should work' do
|
2042
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2043
|
-
end
|
2044
|
-
end
|
2045
|
-
|
2046
|
-
# unit tests for post_catalogs_strikethrough_notification
|
2047
|
-
# Create strikethrough notification
|
2048
|
-
# Create a notification for the in the given Application. For more information, see [Managing notifications](https://docs.talon.one/docs/product/applications/outbound-notifications). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
2049
|
-
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2050
|
-
# @param body body
|
2051
|
-
# @param [Hash] opts the optional parameters
|
2052
|
-
# @return [BaseNotification]
|
2053
|
-
describe 'post_catalogs_strikethrough_notification test' do
|
2054
|
-
it 'should work' do
|
2055
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2056
|
-
end
|
2057
|
-
end
|
2058
|
-
|
2059
|
-
# unit tests for post_pending_points_notification
|
2060
|
-
# Create notification about pending loyalty points
|
2061
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Managing loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/managing-loyalty-notifications).
|
2062
|
-
# @param loyalty_program_id Identifier of the profile-based loyalty program. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
2063
|
-
# @param body body
|
2064
|
-
# @param [Hash] opts the optional parameters
|
2065
|
-
# @return [BaseNotification]
|
2066
|
-
describe 'post_pending_points_notification test' do
|
2067
|
-
it 'should work' do
|
2068
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2069
|
-
end
|
2070
|
-
end
|
2071
|
-
|
2072
2060
|
# unit tests for remove_loyalty_points
|
2073
2061
|
# Deduct points from customer profile
|
2074
2062
|
# Deduct points from the specified loyalty program and specified customer profile. **Important:** - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the `integrationId` of the profile from a `sessionId`, use the [Update customer session](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint.
|
2075
2063
|
# @param loyalty_program_id The identifier for the loyalty program.
|
2076
|
-
# @param integration_id The identifier
|
2064
|
+
# @param integration_id 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.
|
2077
2065
|
# @param body body
|
2078
2066
|
# @param [Hash] opts the optional parameters
|
2079
2067
|
# @return [nil]
|
@@ -2209,7 +2197,7 @@ describe 'ManagementApi' do
|
|
2209
2197
|
# @param [Hash] opts the optional parameters
|
2210
2198
|
# @option opts [Integer] :page_size The number of items in the response.
|
2211
2199
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
2212
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2200
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
2213
2201
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
2214
2202
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2215
2203
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -2220,7 +2208,7 @@ describe 'ManagementApi' do
|
|
2220
2208
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
2221
2209
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
2222
2210
|
# @option opts [String] :campaign_state Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived.
|
2223
|
-
# @return [
|
2211
|
+
# @return [InlineResponse20011]
|
2224
2212
|
describe 'search_coupons_advanced_application_wide_without_total_count test' do
|
2225
2213
|
it 'should work' do
|
2226
2214
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -2236,7 +2224,7 @@ describe 'ManagementApi' do
|
|
2236
2224
|
# @param [Hash] opts the optional parameters
|
2237
2225
|
# @option opts [Integer] :page_size The number of items in the response.
|
2238
2226
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
2239
|
-
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:**
|
2227
|
+
# @option opts [String] :sort The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.
|
2240
2228
|
# @option opts [String] :value Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters.
|
2241
2229
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
2242
2230
|
# @option opts [DateTime] :created_after Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
|
@@ -2246,7 +2234,7 @@ describe 'ManagementApi' do
|
|
2246
2234
|
# @option opts [String] :recipient_integration_id Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field.
|
2247
2235
|
# @option opts [Boolean] :exact_match Filter results to an exact case-insensitive matching against the coupon code.
|
2248
2236
|
# @option opts [String] :batch_id Filter results by batches of coupons
|
2249
|
-
# @return [
|
2237
|
+
# @return [InlineResponse20011]
|
2250
2238
|
describe 'search_coupons_advanced_without_total_count test' do
|
2251
2239
|
it 'should work' do
|
2252
2240
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|