talon_one 8.0.0 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +42 -8
- data/docs/Account.md +1 -1
- data/docs/AccountAdditionalCost.md +1 -1
- data/docs/Achievement.md +2 -2
- data/docs/AchievementBase.md +35 -0
- data/docs/AchievementProgressWithDefinition.md +45 -0
- data/docs/AchievementStatusEntry.md +45 -0
- data/docs/AddPriceAdjustmentCatalogAction.md +19 -0
- data/docs/AddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/AnalyticsSKU.md +23 -0
- data/docs/Application.md +1 -1
- data/docs/ApplicationCIF.md +1 -1
- data/docs/ApplicationCIFExpression.md +1 -1
- data/docs/ApplicationCIFReferences.md +19 -0
- data/docs/ApplicationCustomer.md +2 -2
- data/docs/ApplicationEvent.md +1 -1
- data/docs/ApplicationSession.md +1 -1
- data/docs/Attribute.md +1 -1
- data/docs/Audience.md +1 -1
- data/docs/AudienceCustomer.md +2 -2
- data/docs/BaseNotificationWebhook.md +1 -1
- data/docs/Binding.md +9 -1
- data/docs/CampaignCollection.md +1 -1
- data/docs/CampaignCollectionWithoutPayload.md +1 -1
- data/docs/CampaignDeactivationRequest.md +17 -0
- data/docs/CampaignDetail.md +19 -0
- data/docs/CampaignGroup.md +1 -1
- data/docs/CampaignSet.md +1 -1
- data/docs/CampaignStoreBudget.md +1 -1
- data/docs/CampaignStoreBudgetLimitConfig.md +25 -0
- data/docs/CampaignTemplate.md +4 -2
- data/docs/CardAddedDeductedPointsBalancesNotificationPolicy.md +19 -0
- data/docs/CartItem.md +12 -2
- data/docs/Catalog.md +1 -1
- data/docs/CatalogItem.md +1 -1
- data/docs/Change.md +1 -1
- data/docs/Collection.md +1 -1
- data/docs/CollectionWithoutPayload.md +1 -1
- data/docs/Coupon.md +2 -2
- data/docs/CouponCreationJob.md +1 -1
- data/docs/CouponDeletionJob.md +1 -1
- data/docs/CouponEntity.md +19 -0
- data/docs/CreateAchievement.md +1 -1
- data/docs/CustomEffect.md +1 -1
- data/docs/CustomerProfile.md +2 -2
- data/docs/CustomerProfileEntity.md +19 -0
- data/docs/CustomerSessionV2.md +1 -1
- data/docs/Effect.md +6 -0
- data/docs/EffectEntity.md +7 -1
- data/docs/Entity.md +1 -1
- data/docs/Environment.md +4 -2
- data/docs/Event.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExtendLoyaltyPointsExpiryDateEffectProps.md +25 -0
- data/docs/Giveaway.md +1 -1
- data/docs/GiveawaysPool.md +1 -1
- data/docs/HiddenConditionsEffects.md +23 -0
- data/docs/Import.md +1 -1
- data/docs/InlineResponse20048.md +17 -0
- data/docs/InlineResponse20049.md +17 -0
- data/docs/InlineResponse20050.md +19 -0
- data/docs/InlineResponse20051.md +19 -0
- data/docs/IntegrationApi.md +6 -4
- data/docs/IntegrationCoupon.md +2 -2
- data/docs/IntegrationCustomerProfileAudienceRequest.md +17 -0
- data/docs/IntegrationCustomerProfileAudienceRequestItem.md +21 -0
- data/docs/IntegrationEventV2Request.md +2 -0
- data/docs/InventoryCoupon.md +2 -2
- data/docs/InventoryReferral.md +1 -1
- data/docs/LedgerEntry.md +1 -1
- data/docs/LedgerInfo.md +2 -2
- data/docs/LedgerTransactionLogEntryIntegrationAPI.md +3 -1
- data/docs/LoyaltyCard.md +1 -1
- data/docs/LoyaltyLedgerEntryFlags.md +17 -0
- data/docs/LoyaltyProgramBalance.md +2 -2
- data/docs/LoyaltyProgramTransaction.md +3 -1
- data/docs/LoyaltyTier.md +1 -1
- data/docs/ManagementApi.md +824 -220
- data/docs/MessageTest.md +27 -0
- data/docs/ModelReturn.md +1 -1
- data/docs/MultipleAudiencesItem.md +1 -1
- data/docs/NewMessageTest.md +29 -0
- data/docs/NewPriceAdjustment.md +27 -0
- data/docs/NewPriceType.md +23 -0
- data/docs/NewWebhook.md +2 -0
- data/docs/Picklist.md +1 -1
- data/docs/PriceDetail.md +23 -0
- data/docs/PriceType.md +33 -0
- data/docs/ProductUnitAnalyticsDataPoint.md +25 -0
- data/docs/ProductUnitAnalyticsTotals.md +17 -0
- data/docs/Referral.md +1 -1
- data/docs/RevisionActivationRequest.md +19 -0
- data/docs/Role.md +1 -1
- data/docs/RoleV2.md +1 -1
- data/docs/Ruleset.md +1 -1
- data/docs/SamlConnection.md +1 -1
- data/docs/ScimBaseGroup.md +19 -0
- data/docs/ScimGroup.md +21 -0
- data/docs/ScimGroupMember.md +19 -0
- data/docs/ScimGroupsListResponse.md +21 -0
- data/docs/SkuUnitAnalytics.md +19 -0
- data/docs/SkuUnitAnalyticsDataPoint.md +23 -0
- data/docs/Store.md +1 -1
- data/docs/StrikethroughLabelingNotification.md +2 -0
- data/docs/TemplateDef.md +1 -1
- data/docs/UpdateAchievement.md +1 -1
- data/docs/User.md +1 -1
- data/docs/Webhook.md +3 -1
- data/docs/WebhookAuthentication.md +33 -0
- data/docs/WebhookAuthenticationBase.md +21 -0
- data/docs/WebhookAuthenticationDataBasic.md +19 -0
- data/docs/WebhookAuthenticationDataCustom.md +17 -0
- data/docs/WebhookAuthenticationWebhookRef.md +21 -0
- data/docs/WebhookWithOutgoingIntegrationDetails.md +3 -1
- data/lib/talon_one/api/integration_api.rb +9 -6
- data/lib/talon_one/api/management_api.rb +1009 -304
- data/lib/talon_one/models/account.rb +1 -1
- data/lib/talon_one/models/account_additional_cost.rb +1 -1
- data/lib/talon_one/models/achievement.rb +4 -4
- data/lib/talon_one/models/achievement_base.rb +377 -0
- data/lib/talon_one/models/achievement_progress_with_definition.rb +490 -0
- data/lib/talon_one/models/achievement_status_entry.rb +472 -0
- data/lib/talon_one/models/add_price_adjustment_catalog_action.rb +230 -0
- data/lib/talon_one/models/added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/analytics_sku.rb +246 -0
- data/lib/talon_one/models/application.rb +1 -1
- data/lib/talon_one/models/application_cif.rb +1 -1
- data/lib/talon_one/models/application_cif_expression.rb +1 -1
- data/lib/talon_one/models/application_cif_references.rb +219 -0
- data/lib/talon_one/models/application_customer.rb +2 -2
- data/lib/talon_one/models/application_event.rb +1 -1
- data/lib/talon_one/models/application_session.rb +1 -1
- data/lib/talon_one/models/attribute.rb +1 -1
- data/lib/talon_one/models/audience.rb +1 -1
- data/lib/talon_one/models/audience_customer.rb +2 -2
- data/lib/talon_one/models/base_notification.rb +2 -2
- data/lib/talon_one/models/base_notification_webhook.rb +1 -1
- data/lib/talon_one/models/binding.rb +44 -4
- data/lib/talon_one/models/campaign_collection.rb +1 -1
- data/lib/talon_one/models/campaign_collection_without_payload.rb +1 -1
- data/lib/talon_one/models/campaign_deactivation_request.rb +214 -0
- data/lib/talon_one/models/campaign_detail.rb +232 -0
- data/lib/talon_one/models/campaign_group.rb +1 -1
- data/lib/talon_one/models/campaign_set.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget.rb +1 -1
- data/lib/talon_one/models/campaign_store_budget_limit_config.rb +322 -0
- data/lib/talon_one/models/campaign_template.rb +17 -5
- data/lib/talon_one/models/card_added_deducted_points_balances_notification_policy.rb +269 -0
- data/lib/talon_one/models/cart_item.rb +57 -5
- data/lib/talon_one/models/catalog.rb +1 -1
- data/lib/talon_one/models/catalog_action.rb +2 -2
- data/lib/talon_one/models/catalog_item.rb +1 -1
- data/lib/talon_one/models/change.rb +1 -1
- data/lib/talon_one/models/collection.rb +1 -1
- data/lib/talon_one/models/collection_without_payload.rb +1 -1
- data/lib/talon_one/models/coupon.rb +7 -7
- data/lib/talon_one/models/coupon_constraints.rb +5 -5
- data/lib/talon_one/models/coupon_creation_job.rb +6 -6
- data/lib/talon_one/models/coupon_deletion_job.rb +1 -1
- data/lib/talon_one/models/coupon_entity.rb +227 -0
- data/lib/talon_one/models/create_achievement.rb +3 -3
- data/lib/talon_one/models/custom_effect.rb +1 -1
- data/lib/talon_one/models/customer_profile.rb +2 -2
- data/lib/talon_one/models/customer_profile_entity.rb +227 -0
- data/lib/talon_one/models/customer_session_v2.rb +1 -1
- data/lib/talon_one/models/delete_user_request.rb +0 -1
- data/lib/talon_one/models/effect.rb +31 -1
- data/lib/talon_one/models/effect_entity.rb +34 -4
- data/lib/talon_one/models/entity.rb +1 -1
- data/lib/talon_one/models/environment.rb +17 -5
- data/lib/talon_one/models/event.rb +1 -1
- data/lib/talon_one/models/event_type.rb +1 -1
- data/lib/talon_one/models/export.rb +1 -1
- data/lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb +270 -0
- data/lib/talon_one/models/giveaway.rb +1 -1
- data/lib/talon_one/models/giveaways_pool.rb +1 -1
- data/lib/talon_one/models/hidden_conditions_effects.rb +246 -0
- data/lib/talon_one/models/import.rb +1 -1
- data/lib/talon_one/models/inline_response20048.rb +208 -0
- data/lib/talon_one/models/inline_response20049.rb +208 -0
- data/lib/talon_one/models/inline_response20050.rb +222 -0
- data/lib/talon_one/models/inline_response20051.rb +227 -0
- data/lib/talon_one/models/integration_coupon.rb +7 -7
- data/lib/talon_one/models/integration_customer_profile_audience_request.rb +208 -0
- data/lib/talon_one/models/integration_customer_profile_audience_request_item.rb +295 -0
- data/lib/talon_one/models/integration_event_v2_request.rb +13 -1
- data/lib/talon_one/models/inventory_coupon.rb +7 -7
- data/lib/talon_one/models/inventory_referral.rb +1 -1
- data/lib/talon_one/models/ledger_entry.rb +1 -1
- data/lib/talon_one/models/ledger_info.rb +0 -10
- data/lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb +13 -4
- data/lib/talon_one/models/loyalty_card.rb +1 -1
- data/lib/talon_one/models/loyalty_ledger_entry_flags.rb +208 -0
- data/lib/talon_one/models/loyalty_program_balance.rb +0 -10
- data/lib/talon_one/models/loyalty_program_transaction.rb +13 -4
- data/lib/talon_one/models/loyalty_tier.rb +1 -1
- data/lib/talon_one/models/message_test.rb +227 -0
- data/lib/talon_one/models/model_return.rb +1 -1
- data/lib/talon_one/models/multiple_audiences_item.rb +1 -1
- data/lib/talon_one/models/new_coupon_creation_job.rb +5 -5
- data/lib/talon_one/models/new_coupons.rb +5 -5
- data/lib/talon_one/models/new_coupons_for_multiple_recipients.rb +5 -5
- data/lib/talon_one/models/new_message_test.rb +322 -0
- data/lib/talon_one/models/new_price_adjustment.rb +268 -0
- data/lib/talon_one/models/new_price_type.rb +270 -0
- data/lib/talon_one/models/new_webhook.rb +16 -1
- data/lib/talon_one/models/picklist.rb +1 -1
- data/lib/talon_one/models/price_detail.rb +237 -0
- data/lib/talon_one/models/price_type.rb +347 -0
- data/lib/talon_one/models/product_unit_analytics_data_point.rb +271 -0
- data/lib/talon_one/models/product_unit_analytics_totals.rb +206 -0
- data/lib/talon_one/models/referral.rb +1 -1
- data/lib/talon_one/models/revision_activation_request.rb +224 -0
- data/lib/talon_one/models/role.rb +1 -1
- data/lib/talon_one/models/role_v2.rb +1 -1
- data/lib/talon_one/models/ruleset.rb +1 -1
- data/lib/talon_one/models/saml_connection.rb +1 -1
- data/lib/talon_one/models/scim_base_group.rb +220 -0
- data/lib/talon_one/models/scim_group.rb +235 -0
- data/lib/talon_one/models/scim_group_member.rb +218 -0
- data/lib/talon_one/models/scim_groups_list_response.rb +236 -0
- data/lib/talon_one/models/sku_unit_analytics.rb +227 -0
- data/lib/talon_one/models/sku_unit_analytics_data_point.rb +256 -0
- data/lib/talon_one/models/store.rb +1 -1
- data/lib/talon_one/models/strikethrough_labeling_notification.rb +11 -1
- data/lib/talon_one/models/template_def.rb +1 -1
- data/lib/talon_one/models/update_achievement.rb +3 -3
- data/lib/talon_one/models/update_coupon.rb +5 -5
- data/lib/talon_one/models/update_coupon_batch.rb +5 -5
- data/lib/talon_one/models/user.rb +1 -1
- data/lib/talon_one/models/webhook.rb +17 -2
- data/lib/talon_one/models/webhook_authentication.rb +365 -0
- data/lib/talon_one/models/webhook_authentication_base.rb +274 -0
- data/lib/talon_one/models/webhook_authentication_data_basic.rb +227 -0
- data/lib/talon_one/models/webhook_authentication_data_custom.rb +213 -0
- data/lib/talon_one/models/webhook_authentication_webhook_ref.rb +258 -0
- data/lib/talon_one/models/webhook_with_outgoing_integration_details.rb +17 -2
- data/lib/talon_one/version.rb +1 -1
- data/lib/talon_one.rb +26 -1
- data/spec/api/integration_api_spec.rb +4 -3
- data/spec/api/management_api_spec.rb +227 -90
- data/spec/models/achievement_base_spec.rb +1 -1
- data/spec/models/achievement_progress_with_definition_spec.rb +1 -1
- data/spec/models/achievement_spec.rb +1 -1
- data/spec/models/achievement_status_entry_spec.rb +1 -1
- data/spec/models/add_price_adjustment_catalog_action_spec.rb +47 -0
- data/spec/models/added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/base_notification_spec.rb +1 -1
- data/spec/models/binding_spec.rb +24 -0
- data/spec/models/campaign_deactivation_request_spec.rb +41 -0
- data/spec/models/campaign_template_spec.rb +6 -0
- data/spec/models/card_added_deducted_points_balances_notification_policy_spec.rb +51 -0
- data/spec/models/cart_item_spec.rb +30 -0
- data/spec/models/catalog_action_spec.rb +1 -1
- data/spec/models/coupon_entity_spec.rb +47 -0
- data/spec/models/create_achievement_spec.rb +1 -1
- data/spec/models/customer_profile_entity_spec.rb +47 -0
- data/spec/models/effect_entity_spec.rb +18 -0
- data/spec/models/effect_spec.rb +18 -0
- data/spec/models/environment_spec.rb +6 -0
- data/spec/models/extend_loyalty_points_expiry_date_effect_props_spec.rb +65 -0
- data/spec/models/inline_response20048_spec.rb +0 -6
- data/spec/models/inline_response20049_spec.rb +0 -6
- data/spec/models/inline_response20050_spec.rb +47 -0
- data/spec/models/inline_response20051_spec.rb +47 -0
- data/spec/models/integration_customer_profile_audience_request_item_spec.rb +57 -0
- data/spec/models/integration_customer_profile_audience_request_spec.rb +41 -0
- data/spec/models/integration_event_v2_request_spec.rb +6 -0
- data/spec/models/ledger_transaction_log_entry_integration_api_spec.rb +6 -0
- data/spec/models/loyalty_program_transaction_spec.rb +6 -0
- data/spec/models/new_message_test_spec.rb +1 -1
- data/spec/models/new_price_adjustment_spec.rb +71 -0
- data/spec/models/new_price_type_spec.rb +59 -0
- data/spec/models/new_webhook_spec.rb +6 -0
- data/spec/models/price_detail_spec.rb +59 -0
- data/spec/models/price_type_spec.rb +89 -0
- data/spec/models/revision_activation_request_spec.rb +47 -0
- data/spec/models/scim_base_group_spec.rb +47 -0
- data/spec/models/scim_group_member_spec.rb +47 -0
- data/spec/models/scim_group_spec.rb +53 -0
- data/spec/models/scim_groups_list_response_spec.rb +53 -0
- data/spec/models/strikethrough_labeling_notification_spec.rb +6 -0
- data/spec/models/update_achievement_spec.rb +1 -1
- data/spec/models/webhook_authentication_base_spec.rb +57 -0
- data/spec/models/webhook_authentication_data_basic_spec.rb +47 -0
- data/spec/models/webhook_authentication_data_custom_spec.rb +41 -0
- data/spec/models/webhook_authentication_spec.rb +93 -0
- data/spec/models/webhook_authentication_webhook_ref_spec.rb +53 -0
- data/spec/models/webhook_spec.rb +6 -0
- data/spec/models/webhook_with_outgoing_integration_details_spec.rb +6 -0
- metadata +661 -527
@@ -162,6 +162,20 @@ describe 'ManagementApi' do
|
|
162
162
|
end
|
163
163
|
end
|
164
164
|
|
165
|
+
# unit tests for create_campaign_store_budget
|
166
|
+
# Create campaign store budget
|
167
|
+
# Create a new store budget for a given campaign.
|
168
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
169
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
170
|
+
# @param body body
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @return [nil]
|
173
|
+
describe 'create_campaign_store_budget test' do
|
174
|
+
it 'should work' do
|
175
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
165
179
|
# unit tests for create_collection
|
166
180
|
# Create campaign-level collection
|
167
181
|
# Create a campaign-level collection in a given campaign.
|
@@ -360,6 +374,21 @@ describe 'ManagementApi' do
|
|
360
374
|
end
|
361
375
|
end
|
362
376
|
|
377
|
+
# unit tests for delete_campaign_store_budgets
|
378
|
+
# Delete campaign store budgets
|
379
|
+
# Delete the store budgets for a given campaign.
|
380
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
381
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @option opts [String] :action The action that this budget is limiting.
|
384
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
385
|
+
# @return [nil]
|
386
|
+
describe 'delete_campaign_store_budgets test' do
|
387
|
+
it 'should work' do
|
388
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
389
|
+
end
|
390
|
+
end
|
391
|
+
|
363
392
|
# unit tests for delete_collection
|
364
393
|
# Delete campaign-level collection
|
365
394
|
# Delete a given campaign-level collection.
|
@@ -540,6 +569,21 @@ describe 'ManagementApi' do
|
|
540
569
|
end
|
541
570
|
end
|
542
571
|
|
572
|
+
# unit tests for export_campaign_store_budgets
|
573
|
+
# Export campaign store budgets
|
574
|
+
# Download a CSV file containing the store budgets for a given campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store.
|
575
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
576
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
577
|
+
# @param [Hash] opts the optional parameters
|
578
|
+
# @option opts [String] :action The action that this budget is limiting.
|
579
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
580
|
+
# @return [String]
|
581
|
+
describe 'export_campaign_store_budgets test' do
|
582
|
+
it 'should work' do
|
583
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
584
|
+
end
|
585
|
+
end
|
586
|
+
|
543
587
|
# unit tests for export_campaign_stores
|
544
588
|
# Export stores
|
545
589
|
# Download a CSV file containing the stores linked to a specific campaign. **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). The CSV file contains the following column: - `store_integration_id`: The identifier of the store.
|
@@ -573,7 +617,7 @@ describe 'ManagementApi' do
|
|
573
617
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
574
618
|
# @param [Hash] opts the optional parameters
|
575
619
|
# @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:**
|
620
|
+
# @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
621
|
# @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
622
|
# @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
623
|
# @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.
|
@@ -595,7 +639,7 @@ describe 'ManagementApi' do
|
|
595
639
|
|
596
640
|
# unit tests for export_customer_sessions
|
597
641
|
# Export customer sessions
|
598
|
-
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/
|
642
|
+
# Download a CSV file containing the customer sessions that match the request. **Important:** Archived sessions cannot be exported. See the [retention policy](https://docs.talon.one/docs/dev/server-infrastructure-and-data-retention). **Tip:** If the exported CSV file is too large to view, you can [split it into multiple files](https://www.makeuseof.com/tag/how-to-split-a-huge-csv-excel-workbook-into-seperate-files/). - `id`: The internal ID of the session. - `firstsession`: Whether this is a first session. - `integrationid`: The integration ID of the session. - `applicationid`: The ID of the Application. - `profileid`: The internal ID of the customer profile. - `profileintegrationid`: The integration ID of the customer profile. - `created`: The timestamp when the session was created. - `state`: The [state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states) of the session. - `cartitems`: The cart items in the session. - `discounts`: The discounts in the session. - `total`: The total value of cart items and additional costs in the session, before any discounts are applied. - `attributes`: The attributes set in the session. - `closedat`: Timestamp when the session was closed. - `cancelledat`: Timestamp when the session was cancelled. - `referral`: The referral code in the session. - `identifiers`: The identifiers in the session. - `additional_costs`: The [additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs) in the session. - `updated`: Timestamp of the last session update. - `store_integration_id`: The integration ID of the store. - `coupons`: Coupon codes in the session.
|
599
643
|
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
600
644
|
# @param [Hash] opts the optional parameters
|
601
645
|
# @option opts [DateTime] :created_before Filter results comparing the parameter value, expected to be an RFC3339 timestamp string.
|
@@ -701,6 +745,8 @@ describe 'ManagementApi' do
|
|
701
745
|
# @param loyalty_program_id Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the [List loyalty programs](https://docs.talon.one/management-api#tag/Loyalty/operation/getLoyaltyPrograms) endpoint.
|
702
746
|
# @param [Hash] opts the optional parameters
|
703
747
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
748
|
+
# @option opts [DateTime] :created_before Only return loyalty cards created before this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
749
|
+
# @option opts [DateTime] :created_after Only return loyalty cards created after this timestamp. **Note:** - This must be an RFC3339 timestamp string.
|
704
750
|
# @option opts [String] :date_format Determines the format of dates in the export document.
|
705
751
|
# @return [String]
|
706
752
|
describe 'export_loyalty_cards test' do
|
@@ -711,7 +757,7 @@ describe 'ManagementApi' do
|
|
711
757
|
|
712
758
|
# unit tests for export_loyalty_ledger
|
713
759
|
# 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.
|
760
|
+
# 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
761
|
# @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
762
|
# @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
763
|
# @param loyalty_program_id The identifier for the loyalty program.
|
@@ -770,7 +816,7 @@ describe 'ManagementApi' do
|
|
770
816
|
# @option opts [String] :status Filter results by HTTP status codes.
|
771
817
|
# @option opts [Integer] :page_size The number of items in the response.
|
772
818
|
# @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:**
|
819
|
+
# @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
820
|
# @return [InlineResponse20022]
|
775
821
|
describe 'get_access_logs_without_total_count test' do
|
776
822
|
it 'should work' do
|
@@ -846,7 +892,7 @@ describe 'ManagementApi' do
|
|
846
892
|
# @param [Hash] opts the optional parameters
|
847
893
|
# @option opts [Integer] :page_size The number of items in the response.
|
848
894
|
# @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:**
|
895
|
+
# @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
896
|
# @return [InlineResponse20038]
|
851
897
|
describe 'get_additional_costs test' do
|
852
898
|
it 'should work' do
|
@@ -899,7 +945,7 @@ describe 'ManagementApi' do
|
|
899
945
|
# @param [Hash] opts the optional parameters
|
900
946
|
# @option opts [Integer] :page_size The number of items in the response.
|
901
947
|
# @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:**
|
948
|
+
# @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
949
|
# @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
950
|
# @return [InlineResponse20035]
|
905
951
|
describe 'get_application_customer_friends test' do
|
@@ -947,7 +993,7 @@ describe 'ManagementApi' do
|
|
947
993
|
# @param [Hash] opts the optional parameters
|
948
994
|
# @option opts [Integer] :page_size The number of items in the response.
|
949
995
|
# @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:**
|
996
|
+
# @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
997
|
# @return [InlineResponse20031]
|
952
998
|
describe 'get_application_event_types test' do
|
953
999
|
it 'should work' do
|
@@ -962,7 +1008,7 @@ describe 'ManagementApi' do
|
|
962
1008
|
# @param [Hash] opts the optional parameters
|
963
1009
|
# @option opts [Integer] :page_size The number of items in the response.
|
964
1010
|
# @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:**
|
1011
|
+
# @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
1012
|
# @option opts [String] :type Comma-separated list of types by which to filter events. Must be exact match(es).
|
967
1013
|
# @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
1014
|
# @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.
|
@@ -1001,7 +1047,7 @@ describe 'ManagementApi' do
|
|
1001
1047
|
# @param [Hash] opts the optional parameters
|
1002
1048
|
# @option opts [Integer] :page_size The number of items in the response.
|
1003
1049
|
# @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:**
|
1050
|
+
# @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
1051
|
# @option opts [String] :profile Profile integration ID filter for sessions. Must be exact match.
|
1006
1052
|
# @option opts [String] :state Filter by sessions with this state. Must be exact match.
|
1007
1053
|
# @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.
|
@@ -1023,7 +1069,7 @@ describe 'ManagementApi' do
|
|
1023
1069
|
# @param [Hash] opts the optional parameters
|
1024
1070
|
# @option opts [Integer] :page_size The number of items in the response.
|
1025
1071
|
# @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:**
|
1072
|
+
# @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
1073
|
# @return [InlineResponse2007]
|
1028
1074
|
describe 'get_applications test' do
|
1029
1075
|
it 'should work' do
|
@@ -1049,7 +1095,7 @@ describe 'ManagementApi' do
|
|
1049
1095
|
# @param [Hash] opts the optional parameters
|
1050
1096
|
# @option opts [Integer] :page_size The number of items in the response.
|
1051
1097
|
# @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:**
|
1098
|
+
# @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
1099
|
# @option opts [String] :entity Returned attributes will be filtered by supplied entity.
|
1054
1100
|
# @return [InlineResponse20036]
|
1055
1101
|
describe 'get_attributes test' do
|
@@ -1065,7 +1111,7 @@ describe 'ManagementApi' do
|
|
1065
1111
|
# @param [Hash] opts the optional parameters
|
1066
1112
|
# @option opts [Integer] :page_size The number of items in the response.
|
1067
1113
|
# @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:**
|
1114
|
+
# @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
1115
|
# @option opts [String] :profile_query The filter to select a profile.
|
1070
1116
|
# @return [InlineResponse20034]
|
1071
1117
|
describe 'get_audience_memberships test' do
|
@@ -1080,7 +1126,7 @@ describe 'ManagementApi' do
|
|
1080
1126
|
# @param [Hash] opts the optional parameters
|
1081
1127
|
# @option opts [Integer] :page_size The number of items in the response.
|
1082
1128
|
# @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:**
|
1129
|
+
# @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
1130
|
# @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
1131
|
# @return [InlineResponse20032]
|
1086
1132
|
describe 'get_audiences test' do
|
@@ -1094,7 +1140,7 @@ describe 'ManagementApi' do
|
|
1094
1140
|
# Get a list of audience IDs and their member count.
|
1095
1141
|
# @param audience_ids The IDs of one or more audiences, separated by commas, by which to filter results.
|
1096
1142
|
# @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:**
|
1143
|
+
# @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
1144
|
# @return [InlineResponse20033]
|
1099
1145
|
describe 'get_audiences_analytics test' do
|
1100
1146
|
it 'should work' do
|
@@ -1139,7 +1185,7 @@ describe 'ManagementApi' do
|
|
1139
1185
|
# @param [Hash] opts the optional parameters
|
1140
1186
|
# @option opts [Integer] :page_size The number of items in the response.
|
1141
1187
|
# @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:**
|
1188
|
+
# @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
1189
|
# @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
1190
|
# @return [InlineResponse2008]
|
1145
1191
|
describe 'get_campaign_by_attributes test' do
|
@@ -1166,7 +1212,7 @@ describe 'ManagementApi' do
|
|
1166
1212
|
# @param [Hash] opts the optional parameters
|
1167
1213
|
# @option opts [Integer] :page_size The number of items in the response.
|
1168
1214
|
# @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:**
|
1215
|
+
# @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
1216
|
# @return [InlineResponse20013]
|
1171
1217
|
describe 'get_campaign_groups test' do
|
1172
1218
|
it 'should work' do
|
@@ -1180,7 +1226,7 @@ describe 'ManagementApi' do
|
|
1180
1226
|
# @param [Hash] opts the optional parameters
|
1181
1227
|
# @option opts [Integer] :page_size The number of items in the response.
|
1182
1228
|
# @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:**
|
1229
|
+
# @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
1230
|
# @option opts [String] :state Filter results by the state of the campaign template.
|
1185
1231
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign template.
|
1186
1232
|
# @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.
|
@@ -1199,7 +1245,7 @@ describe 'ManagementApi' do
|
|
1199
1245
|
# @param [Hash] opts the optional parameters
|
1200
1246
|
# @option opts [Integer] :page_size The number of items in the response.
|
1201
1247
|
# @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:**
|
1248
|
+
# @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
1249
|
# @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
1250
|
# @option opts [String] :name Filter results performing case-insensitive matching against the name of the campaign.
|
1205
1251
|
# @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
|
@@ -1221,7 +1267,7 @@ describe 'ManagementApi' do
|
|
1221
1267
|
# @param [Hash] opts the optional parameters
|
1222
1268
|
# @option opts [Integer] :page_size The number of items in the response.
|
1223
1269
|
# @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:**
|
1270
|
+
# @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
1271
|
# @option opts [Float] :application_id Filter results by Application ID.
|
1226
1272
|
# @option opts [String] :entity_path Filter results on a case insensitive matching of the url path of the entity
|
1227
1273
|
# @option opts [Integer] :user_id Filter results by user ID.
|
@@ -1273,7 +1319,7 @@ describe 'ManagementApi' do
|
|
1273
1319
|
# @param [Hash] opts the optional parameters
|
1274
1320
|
# @option opts [Integer] :page_size The number of items in the response.
|
1275
1321
|
# @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:**
|
1322
|
+
# @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
1323
|
# @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
1324
|
# @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
1325
|
# @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.
|
@@ -1322,7 +1368,7 @@ describe 'ManagementApi' do
|
|
1322
1368
|
# @param [Hash] opts the optional parameters
|
1323
1369
|
# @option opts [Integer] :page_size The number of items in the response.
|
1324
1370
|
# @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:**
|
1371
|
+
# @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
1372
|
# @option opts [String] :name Only return reports matching the customer name.
|
1327
1373
|
# @option opts [String] :integration_id Filter results performing an exact matching against the profile integration identifier.
|
1328
1374
|
# @option opts [String] :campaign_name Only return reports matching the campaign name.
|
@@ -1342,7 +1388,7 @@ describe 'ManagementApi' do
|
|
1342
1388
|
# @param [Hash] opts the optional parameters
|
1343
1389
|
# @option opts [Integer] :page_size The number of items in the response.
|
1344
1390
|
# @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:**
|
1391
|
+
# @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
1392
|
# @return [CustomerAnalytics]
|
1347
1393
|
describe 'get_customer_analytics test' do
|
1348
1394
|
it 'should work' do
|
@@ -1372,7 +1418,7 @@ describe 'ManagementApi' do
|
|
1372
1418
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1373
1419
|
# @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
1420
|
# @option opts [String] :title Filter results by the `title` of an achievement.
|
1375
|
-
# @return [
|
1421
|
+
# @return [InlineResponse20051]
|
1376
1422
|
describe 'get_customer_profile_achievement_progress test' do
|
1377
1423
|
it 'should work' do
|
1378
1424
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1431,7 +1477,7 @@ describe 'ManagementApi' do
|
|
1431
1477
|
# @option opts [Boolean] :include_old_versions Include all versions of every event type.
|
1432
1478
|
# @option opts [Integer] :page_size The number of items in the response.
|
1433
1479
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
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:**
|
1480
|
+
# @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
1481
|
# @return [InlineResponse20042]
|
1436
1482
|
describe 'get_event_types test' do
|
1437
1483
|
it 'should work' do
|
@@ -1493,7 +1539,7 @@ describe 'ManagementApi' do
|
|
1493
1539
|
# @param [Hash] opts the optional parameters
|
1494
1540
|
# @option opts [Integer] :page_size The number of items in the response.
|
1495
1541
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
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:**
|
1542
|
+
# @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.
|
1497
1543
|
# @option opts [String] :identifier The card code by which to filter loyalty cards in the response.
|
1498
1544
|
# @option opts [Integer] :profile_id Filter results by customer profile ID.
|
1499
1545
|
# @option opts [String] :batch_id Filter results by loyalty card batch ID.
|
@@ -1570,6 +1616,31 @@ describe 'ManagementApi' do
|
|
1570
1616
|
end
|
1571
1617
|
end
|
1572
1618
|
|
1619
|
+
# unit tests for get_message_logs
|
1620
|
+
# List message log entries
|
1621
|
+
# Retrieve all message log entries.
|
1622
|
+
# @param entity_type The entity type the log is related to.
|
1623
|
+
# @param [Hash] opts the optional parameters
|
1624
|
+
# @option opts [String] :message_id Filter results by message ID.
|
1625
|
+
# @option opts [String] :change_type Filter results by change type.
|
1626
|
+
# @option opts [String] :notification_i_ds Filter results by notification ID (include up to 30 values, separated by a comma).
|
1627
|
+
# @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.
|
1628
|
+
# @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.
|
1629
|
+
# @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.
|
1630
|
+
# @option opts [String] :period Filter results by time period. Choose between the available relative time frames.
|
1631
|
+
# @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.
|
1632
|
+
# @option opts [Float] :application_id Filter results by Application ID.
|
1633
|
+
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
1634
|
+
# @option opts [Integer] :loyalty_program_id Identifier of the loyalty program.
|
1635
|
+
# @option opts [Integer] :response_code Filter results by response status code.
|
1636
|
+
# @option opts [String] :webhook_i_ds Filter results by webhook ID (include up to 30 values, separated by a comma).
|
1637
|
+
# @return [MessageLogEntries]
|
1638
|
+
describe 'get_message_logs test' do
|
1639
|
+
it 'should work' do
|
1640
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1641
|
+
end
|
1642
|
+
end
|
1643
|
+
|
1573
1644
|
# unit tests for get_referrals_without_total_count
|
1574
1645
|
# List referrals
|
1575
1646
|
# List all referrals of the specified campaign.
|
@@ -1578,7 +1649,7 @@ describe 'ManagementApi' do
|
|
1578
1649
|
# @param [Hash] opts the optional parameters
|
1579
1650
|
# @option opts [Integer] :page_size The number of items in the response.
|
1580
1651
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1581
|
-
# @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:**
|
1652
|
+
# @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.
|
1582
1653
|
# @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.
|
1583
1654
|
# @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.
|
1584
1655
|
# @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.
|
@@ -1626,7 +1697,7 @@ describe 'ManagementApi' do
|
|
1626
1697
|
# @param [Hash] opts the optional parameters
|
1627
1698
|
# @option opts [Integer] :page_size The number of items in the response.
|
1628
1699
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1629
|
-
# @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:**
|
1700
|
+
# @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.
|
1630
1701
|
# @return [InlineResponse2009]
|
1631
1702
|
describe 'get_rulesets test' do
|
1632
1703
|
it 'should work' do
|
@@ -1665,7 +1736,7 @@ describe 'ManagementApi' do
|
|
1665
1736
|
# @param [Hash] opts the optional parameters
|
1666
1737
|
# @option opts [Integer] :page_size The number of items in the response.
|
1667
1738
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1668
|
-
# @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.
|
1669
1740
|
# @return [InlineResponse20043]
|
1670
1741
|
describe 'get_users test' do
|
1671
1742
|
it 'should work' do
|
@@ -1691,7 +1762,7 @@ describe 'ManagementApi' do
|
|
1691
1762
|
# @param [Hash] opts the optional parameters
|
1692
1763
|
# @option opts [Integer] :page_size The number of items in the response.
|
1693
1764
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1694
|
-
# @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:**
|
1765
|
+
# @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.
|
1695
1766
|
# @option opts [String] :integration_request_uuid Filter results by integration request UUID.
|
1696
1767
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
1697
1768
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -1711,7 +1782,7 @@ describe 'ManagementApi' do
|
|
1711
1782
|
# @param [Hash] opts the optional parameters
|
1712
1783
|
# @option opts [Integer] :page_size The number of items in the response.
|
1713
1784
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1714
|
-
# @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:**
|
1785
|
+
# @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.
|
1715
1786
|
# @option opts [String] :status Filter results by HTTP status codes.
|
1716
1787
|
# @option opts [Float] :webhook_id Filter results by webhook id.
|
1717
1788
|
# @option opts [Float] :application_id Filter results by Application ID.
|
@@ -1731,7 +1802,7 @@ describe 'ManagementApi' do
|
|
1731
1802
|
# List all webhooks.
|
1732
1803
|
# @param [Hash] opts the optional parameters
|
1733
1804
|
# @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.
|
1734
|
-
# @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:**
|
1805
|
+
# @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.
|
1735
1806
|
# @option opts [Integer] :page_size The number of items in the response.
|
1736
1807
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1737
1808
|
# @option opts [String] :creation_type Filter results by creation type.
|
@@ -1784,6 +1855,22 @@ describe 'ManagementApi' do
|
|
1784
1855
|
end
|
1785
1856
|
end
|
1786
1857
|
|
1858
|
+
# unit tests for import_campaign_store_budget
|
1859
|
+
# Import campaign store budgets
|
1860
|
+
# Upload a CSV file containing store budgets for a given campaign. Send the file as multipart data. The CSV file **must** only contain the following columns: - `store_integration_id`: The identifier of the store. - `limit`: The budget limit for the store. The import **replaces** the previous list of store budgets.
|
1861
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
1862
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
1863
|
+
# @param [Hash] opts the optional parameters
|
1864
|
+
# @option opts [String] :action The action that this budget is limiting.
|
1865
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
1866
|
+
# @option opts [String] :up_file The file containing the data that is being imported.
|
1867
|
+
# @return [Import]
|
1868
|
+
describe 'import_campaign_store_budget test' do
|
1869
|
+
it 'should work' do
|
1870
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
1871
|
+
end
|
1872
|
+
end
|
1873
|
+
|
1787
1874
|
# unit tests for import_campaign_stores
|
1788
1875
|
# Import stores
|
1789
1876
|
# Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file **must** only contain the following column: - `store_integration_id`: The identifier of the store. The import **replaces** the previous list of stores linked to the campaign.
|
@@ -1859,6 +1946,7 @@ describe 'ManagementApi' do
|
|
1859
1946
|
# Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - `customerprofileid` (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. **Note**: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - `identifier` (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - `amount`: The amount of points to award to the customer profile. - `startdate` (optional): The earliest date when the points can be redeemed. The points are `active` from this date until the expiration date. **Note**: It must be an RFC3339 timestamp string or string `immediate`. Empty or missing values are considered `immediate`. - `expirydate` (optional): The latest date when the points can be redeemed. The points are `expired` after this date. **Note**: It must be an RFC3339 timestamp string or string `unlimited`. Empty or missing values are considered `unlimited`. - `subledgerid` (optional): The ID of the subledger that should received the points. - `reason` (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. **Note:** For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for `startdate`. If `startdate` matches the current date, the imported points are _active_. If it is later, the points are _pending_ until the date provided for `startdate` is reached. **Note:** We recommend limiting your file size to 500MB. **Example for profile-based programs:** ```text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ``` **Example for card-based programs:** ```text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement ```
|
1860
1947
|
# @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.
|
1861
1948
|
# @param [Hash] opts the optional parameters
|
1949
|
+
# @option opts [Boolean] :notifications_enabled Indicates whether the points import triggers notifications about its effects. For example, a notification is sent if the import upgrades a customer's tier or offsets their negative points balance. This parameter is optional and defaults to `true`.
|
1862
1950
|
# @option opts [String] :up_file The file containing the data that is being imported.
|
1863
1951
|
# @return [Import]
|
1864
1952
|
describe 'import_loyalty_points test' do
|
@@ -1912,7 +2000,7 @@ describe 'ManagementApi' do
|
|
1912
2000
|
# @param [Hash] opts the optional parameters
|
1913
2001
|
# @option opts [Integer] :page_size The number of items in the response.
|
1914
2002
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1915
|
-
# @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:**
|
2003
|
+
# @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.
|
1916
2004
|
# @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.
|
1917
2005
|
# @option opts [String] :name Filter by collection name.
|
1918
2006
|
# @return [InlineResponse20020]
|
@@ -1931,7 +2019,7 @@ describe 'ManagementApi' do
|
|
1931
2019
|
# @option opts [Integer] :page_size The number of items in the response.
|
1932
2020
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1933
2021
|
# @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.
|
1934
|
-
# @return [
|
2022
|
+
# @return [InlineResponse20050]
|
1935
2023
|
describe 'list_achievements test' do
|
1936
2024
|
it 'should work' do
|
1937
2025
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -1949,6 +2037,21 @@ describe 'ManagementApi' do
|
|
1949
2037
|
end
|
1950
2038
|
end
|
1951
2039
|
|
2040
|
+
# unit tests for list_campaign_store_budget_limits
|
2041
|
+
# List campaign store budget limits
|
2042
|
+
# Return the store budget limits for a given campaign.
|
2043
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2044
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2045
|
+
# @param [Hash] opts the optional parameters
|
2046
|
+
# @option opts [String] :action The action that this budget is limiting.
|
2047
|
+
# @option opts [String] :period The period to which the limit applies. **Note**: For budgets with no period, set this to `overall`.
|
2048
|
+
# @return [InlineResponse20048]
|
2049
|
+
describe 'list_campaign_store_budget_limits test' do
|
2050
|
+
it 'should work' do
|
2051
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2052
|
+
end
|
2053
|
+
end
|
2054
|
+
|
1952
2055
|
# unit tests for list_catalog_items
|
1953
2056
|
# List items in a catalog
|
1954
2057
|
# Return a paginated list of cart items in the given catalog.
|
@@ -1974,7 +2077,7 @@ describe 'ManagementApi' do
|
|
1974
2077
|
# @param [Hash] opts the optional parameters
|
1975
2078
|
# @option opts [Integer] :page_size The number of items in the response.
|
1976
2079
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1977
|
-
# @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:**
|
2080
|
+
# @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.
|
1978
2081
|
# @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.
|
1979
2082
|
# @option opts [String] :name Filter by collection name.
|
1980
2083
|
# @return [InlineResponse20020]
|
@@ -1991,7 +2094,7 @@ describe 'ManagementApi' do
|
|
1991
2094
|
# @param [Hash] opts the optional parameters
|
1992
2095
|
# @option opts [Integer] :page_size The number of items in the response.
|
1993
2096
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
1994
|
-
# @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:**
|
2097
|
+
# @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.
|
1995
2098
|
# @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.
|
1996
2099
|
# @option opts [String] :name Filter by collection name.
|
1997
2100
|
# @return [InlineResponse20020]
|
@@ -2008,7 +2111,7 @@ describe 'ManagementApi' do
|
|
2008
2111
|
# @param [Hash] opts the optional parameters
|
2009
2112
|
# @option opts [Integer] :page_size The number of items in the response.
|
2010
2113
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
2011
|
-
# @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:**
|
2114
|
+
# @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.
|
2012
2115
|
# @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.
|
2013
2116
|
# @option opts [Float] :campaign_id Filter results by campaign ID.
|
2014
2117
|
# @option opts [String] :name The name of the store.
|
@@ -2021,19 +2124,6 @@ describe 'ManagementApi' do
|
|
2021
2124
|
end
|
2022
2125
|
end
|
2023
2126
|
|
2024
|
-
# unit tests for notification_activation
|
2025
|
-
# Activate or deactivate notification
|
2026
|
-
# Activate or deactivate the given notification. When `enabled` is false, updates will no longer be sent for the given notification.
|
2027
|
-
# @param notification_id The ID of the notification. Get it with the appropriate _List notifications_ endpoint.
|
2028
|
-
# @param body body
|
2029
|
-
# @param [Hash] opts the optional parameters
|
2030
|
-
# @return [nil]
|
2031
|
-
describe 'notification_activation test' do
|
2032
|
-
it 'should work' do
|
2033
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2034
|
-
end
|
2035
|
-
end
|
2036
|
-
|
2037
2127
|
# unit tests for okta_event_handler_challenge
|
2038
2128
|
# Validate Okta API ownership
|
2039
2129
|
# 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.
|
@@ -2045,45 +2135,6 @@ describe 'ManagementApi' do
|
|
2045
2135
|
end
|
2046
2136
|
end
|
2047
2137
|
|
2048
|
-
# unit tests for post_added_deducted_points_notification
|
2049
|
-
# Create notification about added or deducted loyalty points
|
2050
|
-
# Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
2051
|
-
# @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.
|
2052
|
-
# @param body body
|
2053
|
-
# @param [Hash] opts the optional parameters
|
2054
|
-
# @return [BaseNotification]
|
2055
|
-
describe 'post_added_deducted_points_notification test' do
|
2056
|
-
it 'should work' do
|
2057
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2058
|
-
end
|
2059
|
-
end
|
2060
|
-
|
2061
|
-
# unit tests for post_catalogs_strikethrough_notification
|
2062
|
-
# Create strikethrough notification
|
2063
|
-
# Create a notification for the in the given Application. For more information, see [Application notifications](https://docs.talon.one/docs/product/applications/application-notifications/overview). See the [payload](https://docs.talon.one/outbound-notifications) you will receive.
|
2064
|
-
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2065
|
-
# @param body body
|
2066
|
-
# @param [Hash] opts the optional parameters
|
2067
|
-
# @return [BaseNotification]
|
2068
|
-
describe 'post_catalogs_strikethrough_notification test' do
|
2069
|
-
it 'should work' do
|
2070
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2071
|
-
end
|
2072
|
-
end
|
2073
|
-
|
2074
|
-
# unit tests for post_pending_points_notification
|
2075
|
-
# Create notification about pending loyalty points
|
2076
|
-
# Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see [Loyalty notifications](https://docs.talon.one/docs/product/loyalty-programs/loyalty-notifications/overview).
|
2077
|
-
# @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.
|
2078
|
-
# @param body body
|
2079
|
-
# @param [Hash] opts the optional parameters
|
2080
|
-
# @return [BaseNotification]
|
2081
|
-
describe 'post_pending_points_notification test' do
|
2082
|
-
it 'should work' do
|
2083
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2084
|
-
end
|
2085
|
-
end
|
2086
|
-
|
2087
2138
|
# unit tests for remove_loyalty_points
|
2088
2139
|
# Deduct points from customer profile
|
2089
2140
|
# 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.
|
@@ -2110,6 +2161,18 @@ describe 'ManagementApi' do
|
|
2110
2161
|
end
|
2111
2162
|
end
|
2112
2163
|
|
2164
|
+
# unit tests for scim_create_group
|
2165
|
+
# Create SCIM group
|
2166
|
+
# Create a new Talon.One group using the SCIM Group provisioning protocol with an identity provider, for example, Microsoft Entra ID, and assign members from the payload to the new group. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2167
|
+
# @param body body
|
2168
|
+
# @param [Hash] opts the optional parameters
|
2169
|
+
# @return [ScimGroup]
|
2170
|
+
describe 'scim_create_group test' do
|
2171
|
+
it 'should work' do
|
2172
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2173
|
+
end
|
2174
|
+
end
|
2175
|
+
|
2113
2176
|
# unit tests for scim_create_user
|
2114
2177
|
# Create SCIM user
|
2115
2178
|
# Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
@@ -2122,6 +2185,18 @@ describe 'ManagementApi' do
|
|
2122
2185
|
end
|
2123
2186
|
end
|
2124
2187
|
|
2188
|
+
# unit tests for scim_delete_group
|
2189
|
+
# Delete SCIM group
|
2190
|
+
# Delete a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2191
|
+
# @param group_id The ID of the group.
|
2192
|
+
# @param [Hash] opts the optional parameters
|
2193
|
+
# @return [nil]
|
2194
|
+
describe 'scim_delete_group test' do
|
2195
|
+
it 'should work' do
|
2196
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2197
|
+
end
|
2198
|
+
end
|
2199
|
+
|
2125
2200
|
# unit tests for scim_delete_user
|
2126
2201
|
# Delete SCIM user
|
2127
2202
|
# Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.
|
@@ -2134,6 +2209,29 @@ describe 'ManagementApi' do
|
|
2134
2209
|
end
|
2135
2210
|
end
|
2136
2211
|
|
2212
|
+
# unit tests for scim_get_group
|
2213
|
+
# Get SCIM group
|
2214
|
+
# Retrieve data for a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2215
|
+
# @param group_id The ID of the group.
|
2216
|
+
# @param [Hash] opts the optional parameters
|
2217
|
+
# @return [ScimGroup]
|
2218
|
+
describe 'scim_get_group test' do
|
2219
|
+
it 'should work' do
|
2220
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2221
|
+
end
|
2222
|
+
end
|
2223
|
+
|
2224
|
+
# unit tests for scim_get_groups
|
2225
|
+
# List SCIM groups
|
2226
|
+
# Retrieve a paginated list of groups created using the SCIM protocol with an identity provider, for example, Microsoft Entra ID. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2227
|
+
# @param [Hash] opts the optional parameters
|
2228
|
+
# @return [ScimGroupsListResponse]
|
2229
|
+
describe 'scim_get_groups test' do
|
2230
|
+
it 'should work' do
|
2231
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2232
|
+
end
|
2233
|
+
end
|
2234
|
+
|
2137
2235
|
# unit tests for scim_get_resource_types
|
2138
2236
|
# List supported SCIM resource types
|
2139
2237
|
# Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.
|
@@ -2190,6 +2288,19 @@ describe 'ManagementApi' do
|
|
2190
2288
|
end
|
2191
2289
|
end
|
2192
2290
|
|
2291
|
+
# unit tests for scim_patch_group
|
2292
|
+
# Update SCIM group attributes
|
2293
|
+
# Update certain attributes of a group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing of specific group attributes while other attributes remain unchanged. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2294
|
+
# @param group_id The ID of the group.
|
2295
|
+
# @param body body
|
2296
|
+
# @param [Hash] opts the optional parameters
|
2297
|
+
# @return [ScimGroup]
|
2298
|
+
describe 'scim_patch_group test' do
|
2299
|
+
it 'should work' do
|
2300
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2301
|
+
end
|
2302
|
+
end
|
2303
|
+
|
2193
2304
|
# unit tests for scim_patch_user
|
2194
2305
|
# Update SCIM user attributes
|
2195
2306
|
# Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.
|
@@ -2203,6 +2314,19 @@ describe 'ManagementApi' do
|
|
2203
2314
|
end
|
2204
2315
|
end
|
2205
2316
|
|
2317
|
+
# unit tests for scim_replace_group_attributes
|
2318
|
+
# Update SCIM group
|
2319
|
+
# Update the details of a specific group created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the given group with the attributes provided in the request payload. In Talon.One, a `Group` corresponds to a [role](https://docs.talon.one/docs/product/account/account-settings/managing-roles), and `members` are the [users](https://docs.talon.one/docs/product/account/account-settings/managing-users) assigned to that role.
|
2320
|
+
# @param group_id The ID of the group.
|
2321
|
+
# @param body body
|
2322
|
+
# @param [Hash] opts the optional parameters
|
2323
|
+
# @return [ScimGroup]
|
2324
|
+
describe 'scim_replace_group_attributes test' do
|
2325
|
+
it 'should work' do
|
2326
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2327
|
+
end
|
2328
|
+
end
|
2329
|
+
|
2206
2330
|
# unit tests for scim_replace_user_attributes
|
2207
2331
|
# Update SCIM user
|
2208
2332
|
# Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.
|
@@ -2224,7 +2348,7 @@ describe 'ManagementApi' do
|
|
2224
2348
|
# @param [Hash] opts the optional parameters
|
2225
2349
|
# @option opts [Integer] :page_size The number of items in the response.
|
2226
2350
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
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:**
|
2351
|
+
# @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.
|
2228
2352
|
# @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.
|
2229
2353
|
# @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.
|
2230
2354
|
# @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.
|
@@ -2251,7 +2375,7 @@ describe 'ManagementApi' do
|
|
2251
2375
|
# @param [Hash] opts the optional parameters
|
2252
2376
|
# @option opts [Integer] :page_size The number of items in the response.
|
2253
2377
|
# @option opts [Integer] :skip The number of items to skip when paging through large result sets.
|
2254
|
-
# @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:**
|
2378
|
+
# @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.
|
2255
2379
|
# @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.
|
2256
2380
|
# @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.
|
2257
2381
|
# @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.
|
@@ -2268,6 +2392,19 @@ describe 'ManagementApi' do
|
|
2268
2392
|
end
|
2269
2393
|
end
|
2270
2394
|
|
2395
|
+
# unit tests for summarize_campaign_store_budget
|
2396
|
+
# Get summary of campaign store budgets
|
2397
|
+
# Fetch a summary of all store budget information for a given campaign.
|
2398
|
+
# @param application_id The ID of the Application. It is displayed in your Talon.One deployment URL.
|
2399
|
+
# @param campaign_id The ID of the campaign. It is displayed in your Talon.One deployment URL.
|
2400
|
+
# @param [Hash] opts the optional parameters
|
2401
|
+
# @return [InlineResponse20049]
|
2402
|
+
describe 'summarize_campaign_store_budget test' do
|
2403
|
+
it 'should work' do
|
2404
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
2405
|
+
end
|
2406
|
+
end
|
2407
|
+
|
2271
2408
|
# unit tests for transfer_loyalty_card
|
2272
2409
|
# Transfer card data
|
2273
2410
|
# Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. **Important:** - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is _active_.
|