@wix/bex-utils 1.28.0 → 1.30.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.
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/builders.impl.js +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/builders.impl.js.map +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/http.impl.js +26 -0
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/http.impl.js.map +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.d.ts +29 -0
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.js +176 -0
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.js.map +1 -0
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/client/proto-generated.d.ts +256 -50
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/proto-generated.d.ts +129 -25
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/proto-generated.js +4366 -2869
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/server/proto-generated.d.ts +253 -50
- package/@wix/ambassador-app-settings-v1-settings/build/cjs/types.impl.d.ts +2 -2
- package/@wix/ambassador-app-settings-v1-settings/build/es/builders.impl.js +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/es/builders.impl.js.map +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/es/http.impl.js +26 -0
- package/@wix/ambassador-app-settings-v1-settings/build/es/http.impl.js.map +1 -1
- package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.d.ts +29 -0
- package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.js +146 -0
- package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.js.map +1 -0
- package/@wix/ambassador-app-settings-v1-settings/build/es/types.impl.d.ts +2 -2
- package/@wix/ambassador-app-settings-v1-settings/meta/package.json +7 -0
- package/@wix/ambassador-app-settings-v1-settings/package.json +6 -3
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/app-settings.proto +15 -2
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/user-preferences.proto +58 -1
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/annotations.proto +19 -1
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/callback.proto +24 -2
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/entity.proto +6 -1
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/subscription.proto +2 -1
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/validations.proto +4 -3
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/http/field_mask.proto +1 -0
- package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/spi/definitions.proto +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.d.ts +3 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.js +15 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.d.ts +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.js +2 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.d.ts +17 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.js +44 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.d.ts +16 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.js +119 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.js.map +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/client/proto-generated.d.ts +3229 -341
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/proto-generated.d.ts +1546 -102
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/proto-generated.js +35849 -2496
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/server/proto-generated.d.ts +3258 -371
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.d.ts +2 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.js +14 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/types.impl.d.ts +6 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.d.ts +3 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.js +12 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.d.ts +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.js +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.d.ts +17 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.js +42 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.d.ts +16 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.js +92 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.js.map +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.d.ts +2 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.js +12 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.js.map +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/types.impl.d.ts +6 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/meta/package.json +7 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/package.json +6 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/com/wixpress/appservice/api/components_catalog_type.proto +18 -2
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_common.proto +11 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/application_automation/com/wixpress/appservice/api/upstream/com/wixpress/automations/service/application_automation_component.proto +33 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/automations_action_provider/com/wixpress/appservice/api/upstream/com/wixpress/esb/spi/action/v1/action_spi_provider.proto +2 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/automations_velo_action_provider/com/wixpress/appservice/api/upstream/com/wixpress/automations/velo_spi/v1/velo_spi.proto +12 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/availability_time_slots_configuration_provider/com/wixpress/appservice/api/upstream/com/wixpress/bookings/availability/spi/v2/availability_time_slots_configuration_provider.proto +17 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/back_office_extension.proto +5 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/{entitlement_policy_provider/com/wixpress/appservice/api/upstream/wix/entitlements → benefit_programs_policy_provider/com/wixpress/appservice/api/upstream/wix/benefit_programs}/spi/v1/policy_provider_spi.proto +3 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/bookings_resource_types_provider/com/wixpress/appservice/api/upstream/com/wixpress/bookings/resources/spi/v2/bookings_resource_types_provider.proto +22 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/calendar_event_type_provider/com/wixpress/appservice/api/upstream/wix/calendar/events/spi/v3/event_type_provider_config.proto +22 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/comments_context_provider/com/wixpress/appservice/api/upstream/wix/comments/context/v1/spi/comments_context_provider.proto +33 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/contact_notification.proto +86 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/custom_table_reservations_provider/com/wixpress/appservice/api/upstream/wix/reservations/v1/custom_reservation_approval.proto +14 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/dev_center_component_test.proto +4 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/ecom_additional_fees/com/wixpress/appservice/api/upstream/com/wix/ecommerce/additional_fees_spi/api/v1/additional_fees_spi_config.proto +6 -7
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/ecom_payment_settings/com/wixpress/appservice/api/upstream/com/wix/ecommerce/payment_settings_spi/v1/payment_settings_spi_config.proto +18 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/ecom_validations/com/wixpress/appservice/api/upstream/com/wix/ecommerce/validations_spi/v1/validations_spi_config.proto +5 -7
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/editor_addon.proto +29 -7
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/embedded_script.proto +2 -2
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/external_database/com/wixpress/appservice/api/upstream/com/wixpress/cloud/external-database-spi/v1/external_database_spi.proto +19 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/forms_schema_provider/com/wixpress/appservice/api/upstream/wix/forms/v4/form_schema_spi.proto +6 -4
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/forms_spam_submission_reports_provider/com/wixpress/appservice/api/upstream/wix/forms/v4/form_spam_submission_report_permissions.proto +23 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/forms_spam_submission_reports_provider/com/wixpress/appservice/api/upstream/wix/forms/v4/form_spam_submission_report_spi.proto +25 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/forms_submissions_provider/com/wixpress/appservice/api/upstream/wix/forms/v4/form_submission_spi.proto +8 -7
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/items_selection_provider/com/wixpress/appservice/api/upstream/src/main/proto/com/wixpress/items_selection/spi/v1/items_selection_config.proto +24 -15
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/notification_preferences_filter_provider/wix/notifications/preferences/v1/NotificationPreferencesFilterConfig.proto +11 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/notification_topic.proto +27 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/notifications_common.proto +242 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page.proto +0 -27
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page_out_of_iframe.proto +2 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page_replace/page_replace.proto +27 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/plugin-interface.proto +6 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/pricing_plans_form_configuration.proto +107 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/proposal-editor-provider/com/wixpress/appservice/api/upstream/wix/proposals/spi/v1/proposals-editor-provider.proto +22 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/seo_keywords_suggestions/com/wixpress/appservice/api/upstream/wix/promote/seo_keywords_suggestions_spi/v1/seo_keywords_suggestions_spi.proto +1 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/slot.proto +3 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/studio_widget.proto +6 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/shared.proto +24 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/unified_page.proto +48 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/unified_widget.proto +26 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/user_notification.proto +91 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/web.proto +8 -2
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/widget_out_of_iframe.proto +2 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/widget_plugin.proto +17 -2
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/wix_reviews/com/wixpress/appservice/api/upstream/wix/reviews/product/catalog/spi/v1/reviews_product_catalog_provider.proto +6 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data.proto +59 -12
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/annotations.proto +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/subscription.proto +1 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/validations.proto +4 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/common/query.proto +120 -4
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/common/tags.proto +55 -0
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema.proto +6 -1
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema_service.proto +16 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/builders.impl.js +2 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/builders.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/http.impl.js +4 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/http.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.d.ts +21 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.js +100 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.js.map +1 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/client/proto-generated.d.ts +694 -42
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/proto-generated.d.ts +349 -22
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/proto-generated.js +7034 -304
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/server/proto-generated.d.ts +687 -42
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/types.impl.d.ts +0 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/types.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/builders.impl.js +2 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/builders.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/http.impl.js +4 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/http.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.d.ts +21 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.js +74 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.js.map +1 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/types.impl.d.ts +0 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/types.impl.js.map +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/meta/package.json +7 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/package.json +6 -3
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/catalog_reference.proto +11 -3
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/description_line.proto +2 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/item_data.proto +4 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/platform_catalog_spi.proto +5 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/product_name.proto +4 -4
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/subscription_option_info.proto +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/commons/api/platformQuery.proto +30 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/commons/api/platform_search.proto +23 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/address.proto +1 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/channel_type.proto +2 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/price.proto +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/annotations.proto +14 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/callback.proto +2 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/entity.proto +1 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/subscription.proto +2 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/validations.proto +4 -3
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/catalog.proto +141 -7
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/product.proto +2 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v2/collectionRead.proto +25 -1
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/bulk.proto +5 -4
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/query.proto +120 -4
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/tags.proto +55 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/coupons-manager-ui.proto +15 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservice/v1/export.proto +4 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservice/v1/export_service.proto +26 -3
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/infra/asyncjobs/v1/AsyncJobService.proto +1 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/inventory/api/v1/preOrderInfo.proto +6 -6
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payment-methods.proto +5 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payments.proto +17 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/order-description.proto +5 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/payment-method.proto +12 -4
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/payment.proto +6 -2
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/double-payment-events.proto +26 -0
- package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/double-payment-event.proto +18 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/builders.impl.js +4 -3
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/builders.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/http.impl.js +5 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/http.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.d.ts +22 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.js +119 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.js.map +1 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/client/proto-generated.d.ts +170 -58
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/proto-generated.d.ts +85 -29
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/proto-generated.js +3128 -531
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/server/proto-generated.d.ts +170 -58
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.d.ts +6 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.js +1 -0
- package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/build/es/builders.impl.js +4 -3
- package/@wix/ambassador-os-tags-v1-tag/build/es/builders.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/build/es/http.impl.js +5 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/http.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.d.ts +22 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.js +92 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.js.map +1 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.d.ts +6 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js +1 -0
- package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js.map +1 -1
- package/@wix/ambassador-os-tags-v1-tag/meta/package.json +7 -0
- package/@wix/ambassador-os-tags-v1-tag/package.json +4 -3
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/annotations.proto +0 -7
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/callback.proto +2 -2
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/entity.proto +1 -1
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/subscription.proto +2 -1
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/validations.proto +3 -0
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/bulk.proto +5 -4
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/data/errors.proto +0 -5
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/query.proto +120 -4
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/tags.proto +2 -2
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tag.proto +4 -1
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tag_exposure.proto +1 -1
- package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tags_service.proto +7 -2
- package/@wix/bi-logger-cairo-os/dist/cjs/index.js +3 -0
- package/@wix/bi-logger-cairo-os/dist/cjs/index.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js +7 -0
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js +854 -3
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js +7 -0
- package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js +183 -2
- package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/esm/index.js +3 -0
- package/@wix/bi-logger-cairo-os/dist/esm/index.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js +7 -0
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js +854 -3
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js +7 -0
- package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js +180 -0
- package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js.map +1 -1
- package/@wix/bi-logger-cairo-os/dist/types/index.d.ts +3 -2
- package/@wix/bi-logger-cairo-os/dist/types/testkit/client-testkit.d.ts +171 -0
- package/@wix/bi-logger-cairo-os/dist/types/testkit/node-testkit.d.ts +171 -0
- package/@wix/bi-logger-cairo-os/dist/types/types.d.ts +171 -0
- package/@wix/bi-logger-cairo-os/dist/types/v2/index.d.ts +179 -1
- package/@wix/bi-logger-cairo-os/package.json +2 -2
- package/@wix/bi-logger-cairo-os/src/index.ts +6 -2
- package/@wix/bi-logger-cairo-os/src/testkit/client-testkit.ts +174 -0
- package/@wix/bi-logger-cairo-os/src/testkit/common.ts +854 -3
- package/@wix/bi-logger-cairo-os/src/testkit/node-testkit.ts +174 -0
- package/@wix/bi-logger-cairo-os/src/types.ts +187 -0
- package/@wix/bi-logger-cairo-os/src/v2/index.ts +182 -1
- package/@wix/wix-i18n-config/dist/tsconfig.tsbuildinfo +1 -1
- package/@wix/wix-i18n-config/package.json +4 -4
- package/package.json +3 -3
- package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/entitlement_provider/com/wixpress/appservice/api/upstream/wix/entitlements/spi/v1/entitlement_provider_spi.proto +0 -19
|
@@ -1,16 +1,18 @@
|
|
|
1
|
-
import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndParams, cairoApplyButtonClickedParams, cairoAssignTagsToEntitiesParams, cairoCancelExportModalCtaClickedParams, cairoChangesBeforeApplyParams, cairoComponentSortedParams, cairoCtaClickedParams, cairoDataExAddCustomFieldParams, cairoDataExCustomFieldAdvancesSettingsParams, cairoDataExCustomFieldEndProcessParams, cairoDataExtensionUnsuccessfulUpdateInServerParams, cairoDiscardChangesBeforeApplyParams, cairoDragActionUnsuccessfulUpdateInServerParams, cairoDragItemEndDropParams, cairoDragItemParams, cairoErrorInLoadingAComponentParams, cairoExportCtaClickedParams, cairoExportFailedModalCtaClickedParams, cairoExportModalCtaClickedParams, cairoExportProcessEndParams, cairoExportProcessStartParams, cairoFileDownloadToastDismissedParams, cairoFileDownloadToastDisplayedParams, cairoFileDownloadToastDownloadButtonClickedParams, cairoFilterToggledParams, cairoFiltersPanelUsedParams, cairoItemSelectionToggledParams, cairoItemToggledInExportModalParams, cairoLearnMoreParams, cairoManageViewActionSelectedParams, cairoManageViewClickedParams, cairoModalCtaClickedParams, cairoNestedTableCollapseAndExpandParams, cairoPageBackOrBreadcrumbClickedParams, cairoPageCtaClickedParams, cairoPageDiscardChangesBeforeSaveParams, cairoReloadErrorStateParams, cairoReorderingSortColumnsParams, cairoSearchForTagsParams, cairoSearchResultsParams, cairoSearchViewInViewsParams, cairoSectionCtaClickedParams, cairoSortPanelUsedParams, cairoSortUnsuccessfulUpdateInServerParams, cairoTabSelectedParams, cairoTableTopNotificationDismissedParams, cairoTableTopNotificationDisplayedParams, cairoTagsAddDeleteTagParams, cairoTagsAssignTagParams, cairoTagsModalEndProcessParams, cairoTagsModalStartLoadParams, cairoTagsUnsuccessfulUpdateInServerParams, cairoTagsWidgetClickOnCtaParams, cairoTagsWidgetLoadedParams, cairoTpaSCtaClickedParams, cairoTryAgainClickedParams, cairoUndoClickedParams, cairoUserAttemptsToCancelTheExportParams, cairoViewDeletedParams, cairoViewSavedParams, cairoViewSelectedParams, cairoViewsUnsuccessfulUpdateInServerParams, componentDismissedParams, loadEndParams, loadMoreParams, loadStartParams, newItemCreationEndParams, newItemCreationStartParams, pickerEndLoadParams, pickerModalUsabilityParams, pickerPickModalCtaButtonClickOrImmediateCtaParams, pickerPickerOpenButtonParams, pickerStartLoadParams, pikachuCategoriesDropdownButtonClickedParams, pikachuItemCategorySelectedParams } from '../types';
|
|
1
|
+
import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndParams, cairoApplyButtonClickedParams, cairoAssignTagsToEntitiesParams, cairoCancelExportModalCtaClickedParams, cairoChangesBeforeApplyParams, cairoComponentSortedParams, cairoCtaClickedParams, cairoCustomizeColumnsInSidePanelParams, cairoDataExAddCustomFieldParams, cairoDataExCustomFieldAdvancesSettingsParams, cairoDataExCustomFieldEndProcessParams, cairoDataExtensionUnsuccessfulUpdateInServerParams, cairoDiscardChangesBeforeApplyParams, cairoDragActionUnsuccessfulUpdateInServerParams, cairoDragItemEndDropParams, cairoDragItemParams, cairoErrorInLoadingAComponentParams, cairoExportCtaClickedParams, cairoExportFailedModalCtaClickedParams, cairoExportModalCtaClickedParams, cairoExportProcessEndParams, cairoExportProcessStartParams, cairoFileDownloadToastDismissedParams, cairoFileDownloadToastDisplayedParams, cairoFileDownloadToastDownloadButtonClickedParams, cairoFilterToggledParams, cairoFiltersPanelUsedParams, cairoItemSelectionToggledParams, cairoItemToggledInExportModalParams, cairoLearnMoreParams, cairoManageViewActionSelectedParams, cairoManageViewClickedParams, cairoModalCtaClickedParams, cairoNestedTableCollapseAndExpandParams, cairoPageBackOrBreadcrumbClickedParams, cairoPageCtaClickedParams, cairoPageDiscardChangesBeforeSaveParams, cairoReloadErrorStateParams, cairoReorderingSortColumnsParams, cairoSearchForTagsParams, cairoSearchResultsParams, cairoSearchViewInViewsParams, cairoSectionCtaClickedParams, cairoSortPanelUsedParams, cairoSortUnsuccessfulUpdateInServerParams, cairoTabSelectedParams, cairoTableTopNotificationDismissedParams, cairoTableTopNotificationDisplayedParams, cairoTagsAddDeleteTagParams, cairoTagsAssignTagParams, cairoTagsModalEndProcessParams, cairoTagsModalStartLoadParams, cairoTagsUnsuccessfulUpdateInServerParams, cairoTagsWidgetClickOnCtaParams, cairoTagsWidgetLoadedParams, cairoTpaSCtaClickedParams, cairoTryAgainClickedParams, cairoUndoClickedParams, cairoUserAttemptsToCancelTheExportParams, cairoViewDeletedParams, cairoViewSavedParams, cairoViewSelectedParams, cairoViewsUnsuccessfulUpdateInServerParams, componentDismissedParams, loadEndParams, loadMoreParams, loadStartParams, newItemCreationEndParams, newItemCreationStartParams, pickerEndLoadParams, pickerModalUsabilityParams, pickerPickModalCtaButtonClickOrImmediateCtaParams, pickerPickerOpenButtonParams, pickerStartLoadParams, pikachuCategoriesDropdownButtonClickedParams, pikachuItemCategorySelectedParams } from '../types';
|
|
2
2
|
/**
|
|
3
3
|
* A function to create a log object for the 'componentDismissed' event (evid: 113)
|
|
4
4
|
*
|
|
5
5
|
* Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
|
|
6
6
|
*
|
|
7
7
|
* @param {componentDismissedParams} params - The parameters for this event
|
|
8
|
+
* @property {string} appId
|
|
8
9
|
* @property {string} artifactId - Artifact that owns the component
|
|
9
10
|
* @property {string} cairoVersion
|
|
10
11
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
11
12
|
* @property {string} componentType - Picker Modal / Picker Dropdown
|
|
12
13
|
* @property {GUID} csid
|
|
13
14
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
15
|
+
* @property {boolean} isTPA
|
|
14
16
|
* @property {string} origin - X button/Cancel button
|
|
15
17
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
16
18
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -23,6 +25,7 @@ export declare function componentDismissed(params: componentDismissedParams): Lo
|
|
|
23
25
|
* Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
|
|
24
26
|
*
|
|
25
27
|
* @param {loadMoreParams} params - The parameters for this event
|
|
28
|
+
* @property {string} appId
|
|
26
29
|
* @property {string} artifactId - Artifact that owns the component
|
|
27
30
|
* @property {string} cairoVersion
|
|
28
31
|
* @property {string} componentName - Component name, if there are two components of the same type per artifact
|
|
@@ -34,6 +37,7 @@ export declare function componentDismissed(params: componentDismissedParams): Lo
|
|
|
34
37
|
* @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
|
|
35
38
|
* @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
|
|
36
39
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
40
|
+
* @property {boolean} isTPA
|
|
37
41
|
* @property {number} loadedItems - How many new items were loaded in this action
|
|
38
42
|
* @property {number} loadingTime - Component loading time in ms
|
|
39
43
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -47,6 +51,7 @@ export declare function loadMore(params: loadMoreParams): LogObject<loadMorePara
|
|
|
47
51
|
* Event description: Sent when a user finish to drag an item
|
|
48
52
|
*
|
|
49
53
|
* @param {cairoDragItemEndDropParams} params - The parameters for this event
|
|
54
|
+
* @property {string} appId
|
|
50
55
|
* @property {string} artifactId - Artifact that owns the component
|
|
51
56
|
* @property {string} cairoVersion - cairo version
|
|
52
57
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -68,6 +73,7 @@ export declare function loadMore(params: loadMoreParams): LogObject<loadMorePara
|
|
|
68
73
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
69
74
|
* @property {boolean} isFromHandle - Is the item dragged from the handle area?
|
|
70
75
|
* @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
|
|
76
|
+
* @property {boolean} isTPA
|
|
71
77
|
* @property {string} itemId - ID of the item that the user tries to drag
|
|
72
78
|
* @property {number} itemIndexAfter - Out of the list of results, what is the new index of the dragged item (after dragging). ** filteredListSize = X --> (1 <= itemIndexAfter <= X) **when endType <> drop succeeded --> itemIndexAfter = itemIndexBefore
|
|
73
79
|
* @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
|
|
@@ -85,6 +91,7 @@ export declare function cairoDragItemEndDrop(params: cairoDragItemEndDropParams)
|
|
|
85
91
|
*
|
|
86
92
|
* @param {pickerPickerOpenButtonParams} params - The parameters for this event
|
|
87
93
|
* @property {string} action - Any picker button option (render/hover/click)
|
|
94
|
+
* @property {string} appId
|
|
88
95
|
* @property {string} artifactId - Artifact that owns the component
|
|
89
96
|
* @property {string} cairoVersion
|
|
90
97
|
* @property {string} componentName - Optional in case having 2 pickers under the same artifact
|
|
@@ -93,6 +100,7 @@ export declare function cairoDragItemEndDrop(params: cairoDragItemEndDropParams)
|
|
|
93
100
|
* @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
|
|
94
101
|
* @property {number} filteredListSize - How many items are to presented (filtered)
|
|
95
102
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
103
|
+
* @property {boolean} isTPA
|
|
96
104
|
* @property {number} listSize - How many items exist (full list)
|
|
97
105
|
* @property {number} maxItems - Max items to select in picker
|
|
98
106
|
* @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
|
|
@@ -107,6 +115,7 @@ export declare function pickerPickerOpenButton(params: pickerPickerOpenButtonPar
|
|
|
107
115
|
* Event description: Sent when a user chose to discard his changes in a Cairo component. Relevant components: Table, with apply behavior in the filters panel, or with custom fields option.
|
|
108
116
|
*
|
|
109
117
|
* @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
|
|
118
|
+
* @property {string} appId
|
|
110
119
|
* @property {string} artifactId - Artifact that owns the component
|
|
111
120
|
* @property {string} cairoVersion - Cairo version
|
|
112
121
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -115,6 +124,7 @@ export declare function pickerPickerOpenButton(params: pickerPickerOpenButtonPar
|
|
|
115
124
|
* @property {string} currentStatus - (Optional, relevant for Filters) Json field: The state of feature, if the user would have clicked on the apply button. [{"fieldName": "FIELD_NAME1", "field_value": "VALUE1"}] (for filters -all the filters will appear in this list, filters that not active will get NULL in the filters' value)
|
|
116
125
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
117
126
|
* @property {string} feature - Filters / Drag and Drop
|
|
127
|
+
* @property {boolean} isTPA
|
|
118
128
|
* @property {number} numActiveFields - (Optional, relevant for Filters) How many fields are active after the apply button is clicked? (fields that their value is not NULL)
|
|
119
129
|
* @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
|
|
120
130
|
* @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
|
|
@@ -130,6 +140,7 @@ export declare function cairoDiscardChangesBeforeApply(params: cairoDiscardChang
|
|
|
130
140
|
* Event description: Sent when a user select/deselects an item(s) in a list
|
|
131
141
|
*
|
|
132
142
|
* @param {cairoItemSelectionToggledParams} params - The parameters for this event
|
|
143
|
+
* @property {string} appId
|
|
133
144
|
* @property {string} artifactId - Artifact that owns the component
|
|
134
145
|
* @property {string} cairoVersion
|
|
135
146
|
* @property {string} clickType - The click purpose : "Selection" / "Deselection"
|
|
@@ -147,6 +158,7 @@ export declare function cairoDiscardChangesBeforeApply(params: cairoDiscardChang
|
|
|
147
158
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
148
159
|
* @property {boolean} isFromSearch - Is the item selected from a list of search results
|
|
149
160
|
* @property {boolean} isSelectAll - Did the user click the "Select All" check box (will get "true" regardless the label attached to the check box: "Select All" or "Deselect All").
|
|
161
|
+
* @property {boolean} isTPA
|
|
150
162
|
* @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
|
|
151
163
|
* @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
|
|
152
164
|
* ** isSelectAll = TRUE --> itemIndex = 0
|
|
@@ -169,6 +181,7 @@ export declare function cairoItemSelectionToggled(params: cairoItemSelectionTogg
|
|
|
169
181
|
* Event description: Cairo picker finished loading
|
|
170
182
|
*
|
|
171
183
|
* @param {pickerEndLoadParams} params - The parameters for this event
|
|
184
|
+
* @property {string} appId
|
|
172
185
|
* @property {string} artifactId - Artifact that owns the component
|
|
173
186
|
* @property {string} cairoVersion
|
|
174
187
|
* @property {string} componentName - Optional in case having 2 pickers under the same artifact
|
|
@@ -177,6 +190,7 @@ export declare function cairoItemSelectionToggled(params: cairoItemSelectionTogg
|
|
|
177
190
|
* @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
|
|
178
191
|
* @property {number} filteredListSize - How many items are to presented (filtered)
|
|
179
192
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
193
|
+
* @property {boolean} isTPA
|
|
180
194
|
* @property {number} listSize - How many items exist (full list)
|
|
181
195
|
* @property {number} loadingTime - ms
|
|
182
196
|
* @property {number} maxItems - Max items to select in picker
|
|
@@ -192,6 +206,7 @@ export declare function pickerEndLoad(params: pickerEndLoadParams): LogObject<pi
|
|
|
192
206
|
* Event description: Sent when a user clicks on a category item in a nested table, to collapse or expand it (to hide or unhide the items under this category)
|
|
193
207
|
*
|
|
194
208
|
* @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
|
|
209
|
+
* @property {string} appId
|
|
195
210
|
* @property {string} artifactId - Artifact that owns the component
|
|
196
211
|
* @property {string} cairoVersion - cairo version
|
|
197
212
|
* @property {string} clickType - The click purpose : "Collapse" / "Expand"
|
|
@@ -208,6 +223,7 @@ export declare function pickerEndLoad(params: pickerEndLoadParams): LogObject<pi
|
|
|
208
223
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
209
224
|
* @property {boolean} isFromSearch - Is the item selected from a list of search results
|
|
210
225
|
* @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
|
|
226
|
+
* @property {boolean} isTPA
|
|
211
227
|
* @property {string} itemId - ID of the clicked item .If "Is select all"= true, then Null
|
|
212
228
|
* @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If "Is select all"= true, then Null
|
|
213
229
|
* @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
|
|
@@ -223,6 +239,7 @@ export declare function cairoNestedTableCollapseAndExpand(params: cairoNestedTab
|
|
|
223
239
|
* Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
|
|
224
240
|
*
|
|
225
241
|
* @param {loadEndParams} params - The parameters for this event
|
|
242
|
+
* @property {string} appId
|
|
226
243
|
* @property {string} artifactId - Artifact that owns the component
|
|
227
244
|
* @property {string} cairoVersion
|
|
228
245
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -237,6 +254,7 @@ export declare function cairoNestedTableCollapseAndExpand(params: cairoNestedTab
|
|
|
237
254
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
238
255
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
239
256
|
* @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
|
|
257
|
+
* @property {boolean} isTPA
|
|
240
258
|
* @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
|
|
241
259
|
* @property {number} loadingTime - Component loading time in ms
|
|
242
260
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -252,6 +270,7 @@ export declare function loadEnd(params: loadEndParams): LogObject<loadEndParams>
|
|
|
252
270
|
*
|
|
253
271
|
* @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
|
|
254
272
|
* @property {string} actionName - Add / Delete / Rename
|
|
273
|
+
* @property {string} appId
|
|
255
274
|
* @property {string} artifactId - Artifact that owns the component
|
|
256
275
|
* @property {string} cairoVersion - Cairo version
|
|
257
276
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
@@ -259,6 +278,7 @@ export declare function loadEnd(params: loadEndParams): LogObject<loadEndParams>
|
|
|
259
278
|
* @property {GUID} csid - Cairo session ID
|
|
260
279
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
261
280
|
* @property {boolean} isFromSearch - Is the action made from a list of tags search results?
|
|
281
|
+
* @property {boolean} isTPA
|
|
262
282
|
* @property {number} numTags - How many tags are in the modal after this action?
|
|
263
283
|
* @property {string} origin - Where did the user make the action from? Tags Modal /
|
|
264
284
|
* @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
|
|
@@ -274,6 +294,7 @@ export declare function cairoTagsAddDeleteTag(params: cairoTagsAddDeleteTagParam
|
|
|
274
294
|
* Event description: Sent when the export process begins
|
|
275
295
|
*
|
|
276
296
|
* @param {cairoExportProcessStartParams} params - The parameters for this event
|
|
297
|
+
* @property {string} appId
|
|
277
298
|
* @property {string} artifactId - Artifact that owns the component
|
|
278
299
|
* @property {string} cairoVersion
|
|
279
300
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -281,6 +302,7 @@ export declare function cairoTagsAddDeleteTag(params: cairoTagsAddDeleteTagParam
|
|
|
281
302
|
* @property {GUID} csid
|
|
282
303
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
283
304
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
305
|
+
* @property {boolean} isTPA
|
|
284
306
|
* @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
285
307
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
286
308
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -296,6 +318,7 @@ export declare function cairoExportProcessStart(params: cairoExportProcessStartP
|
|
|
296
318
|
* Event description: Sent when the user clicks a CTA in the "Export Failed" modal
|
|
297
319
|
*
|
|
298
320
|
* @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
|
|
321
|
+
* @property {string} appId
|
|
299
322
|
* @property {string} artifactId - Artifact that owns the component
|
|
300
323
|
* @property {string} cairoVersion
|
|
301
324
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -304,6 +327,7 @@ export declare function cairoExportProcessStart(params: cairoExportProcessStartP
|
|
|
304
327
|
* @property {string} ctaName - Which CTA did the user click in the Export Failed modal: "Cancel"/"X Button" (export is cancelled) OR "Try Again" (export process restarts) OR "learn more" (user is led to contact support)
|
|
305
328
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
306
329
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
330
|
+
* @property {boolean} isTPA
|
|
307
331
|
* @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
308
332
|
* @property {number} numItemsExported - How many items were exported before the export failed.
|
|
309
333
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -320,6 +344,7 @@ export declare function cairoExportFailedModalCtaClicked(params: cairoExportFail
|
|
|
320
344
|
* Event description: Sent when the search results are displayed, after a user searches for a view in a Cairo views list. Relevant components: Table, Cards.
|
|
321
345
|
*
|
|
322
346
|
* @param {cairoSearchViewInViewsParams} params - The parameters for this event
|
|
347
|
+
* @property {string} appId
|
|
323
348
|
* @property {string} artifactId - Artifact that owns the component
|
|
324
349
|
* @property {string} cairoVersion - Cairo version
|
|
325
350
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -327,6 +352,7 @@ export declare function cairoExportFailedModalCtaClicked(params: cairoExportFail
|
|
|
327
352
|
* @property {GUID} csid
|
|
328
353
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
329
354
|
* @property {string} endType - How did the search action end? "View selected"- the user chose one of the search results, "Search dismissed"- the user cancel the search by any other action. When the "end Type" is "view selected" but "search term" is null= then the user typed and searched, deleted his term and then manually selected a view from his views (not from search results).
|
|
355
|
+
* @property {boolean} isTPA
|
|
330
356
|
* @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are from type of "categories"?
|
|
331
357
|
* @property {number} numViews - The distinct views IDs the users has when he searches a view
|
|
332
358
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -342,6 +368,7 @@ export declare function cairoSearchViewInViews(params: cairoSearchViewInViewsPar
|
|
|
342
368
|
* Event description: Cairo picker starts loading
|
|
343
369
|
*
|
|
344
370
|
* @param {pickerStartLoadParams} params - The parameters for this event
|
|
371
|
+
* @property {string} appId
|
|
345
372
|
* @property {string} artifactId - Artifact that owns the component
|
|
346
373
|
* @property {string} cairoVersion
|
|
347
374
|
* @property {string} componentName - Optional in case having 2 pickers under the same artifact
|
|
@@ -350,6 +377,7 @@ export declare function cairoSearchViewInViews(params: cairoSearchViewInViewsPar
|
|
|
350
377
|
* @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
|
|
351
378
|
* @property {number} filteredListSize - How many items are to presented (filtered)
|
|
352
379
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
380
|
+
* @property {boolean} isTPA
|
|
353
381
|
* @property {number} listSize - How many items exist (full list)
|
|
354
382
|
* @property {number} maxItems - Max items to select in picker
|
|
355
383
|
* @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
|
|
@@ -365,6 +393,7 @@ export declare function pickerStartLoad(params: pickerStartLoadParams): LogObjec
|
|
|
365
393
|
*
|
|
366
394
|
* @param {loadStartParams} params - The parameters for this event
|
|
367
395
|
* @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
|
|
396
|
+
* @property {string} appId
|
|
368
397
|
* @property {string} artifactId - Artifact that owns the component
|
|
369
398
|
* @property {string} cairoVersion - cairo version
|
|
370
399
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -376,6 +405,7 @@ export declare function pickerStartLoad(params: pickerStartLoadParams): LogObjec
|
|
|
376
405
|
* @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
|
|
377
406
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
378
407
|
* @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
|
|
408
|
+
* @property {boolean} isTPA
|
|
379
409
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
380
410
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
381
411
|
* @property {Url} url - The page's url (new from 03/2023)
|
|
@@ -388,12 +418,14 @@ export declare function loadStart(params: loadStartParams): LogObject<loadStartP
|
|
|
388
418
|
* Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
|
|
389
419
|
*
|
|
390
420
|
* @param {pikachuItemCategorySelectedParams} params - The parameters for this event
|
|
421
|
+
* @property {string} appId
|
|
391
422
|
* @property {string} artifactId - Artifact that owns the component
|
|
392
423
|
* @property {string} cairoVersion
|
|
393
424
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
394
425
|
* @property {string} componentType
|
|
395
426
|
* @property {GUID} csid
|
|
396
427
|
* @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
|
|
428
|
+
* @property {boolean} isTPA
|
|
397
429
|
* @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
|
|
398
430
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
399
431
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -406,6 +438,7 @@ export declare function pikachuItemCategorySelected(params: pikachuItemCategoryS
|
|
|
406
438
|
* Event description: Sent when a user clicks the "Export" CTA in a Cairo component
|
|
407
439
|
*
|
|
408
440
|
* @param {cairoExportCtaClickedParams} params - The parameters for this event
|
|
441
|
+
* @property {string} appId
|
|
409
442
|
* @property {string} artifactId - Artifact that owns the component
|
|
410
443
|
* @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options. E.g. {"All Items": 100, "Filtered Items": 80, "Selected Items": 10}
|
|
411
444
|
* @property {string} cairoVersion
|
|
@@ -416,6 +449,7 @@ export declare function pikachuItemCategorySelected(params: pikachuItemCategoryS
|
|
|
416
449
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
417
450
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
418
451
|
* @property {number} filteredListSize - How many items are currently presented to user (filtered)
|
|
452
|
+
* @property {boolean} isTPA
|
|
419
453
|
* @property {number} numSelectedItems - How many items does the user wish to export
|
|
420
454
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
421
455
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -428,6 +462,7 @@ export declare function cairoExportCtaClicked(params: cairoExportCtaClickedParam
|
|
|
428
462
|
* Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
|
|
429
463
|
*
|
|
430
464
|
* @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
|
|
465
|
+
* @property {string} appId
|
|
431
466
|
* @property {string} artifactId - Artifact that owns the component
|
|
432
467
|
* @property {string} cairoVersion
|
|
433
468
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -437,6 +472,7 @@ export declare function cairoExportCtaClicked(params: cairoExportCtaClickedParam
|
|
|
437
472
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
438
473
|
* @property {number} duration - How much time (in ms) did it take since the export process began
|
|
439
474
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
475
|
+
* @property {boolean} isTPA
|
|
440
476
|
* @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
|
|
441
477
|
* @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
442
478
|
* @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
|
|
@@ -454,12 +490,14 @@ export declare function cairoCancelExportModalCtaClicked(params: cairoCancelExpo
|
|
|
454
490
|
* Event description: Sent when a user chose to discard his changes in a Cairo's page. (by clicking on cancel / navigate to another page / click on the back button / click on the breadcrumb button)
|
|
455
491
|
*
|
|
456
492
|
* @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
|
|
493
|
+
* @property {string} appId
|
|
457
494
|
* @property {string} artifactId - Artifact that owns the component
|
|
458
495
|
* @property {string} cairoVersion - Cairo version
|
|
459
496
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
460
497
|
* @property {string} componentType - Table/Cards / Picker
|
|
461
498
|
* @property {GUID} csid - Cairo session ID
|
|
462
499
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
500
|
+
* @property {boolean} isTPA
|
|
463
501
|
* @property {number} numOfActions - Number of changed fields that their changes can be lost
|
|
464
502
|
* @property {number} numOfFields - How many fields are there that can be change in this page?
|
|
465
503
|
* @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
|
|
@@ -475,6 +513,7 @@ export declare function cairoPageDiscardChangesBeforeSave(params: cairoPageDisca
|
|
|
475
513
|
* Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
|
|
476
514
|
*
|
|
477
515
|
* @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
|
|
516
|
+
* @property {string} appId
|
|
478
517
|
* @property {string} artifactId - Artifact that owns the component
|
|
479
518
|
* @property {string} cairoVersion
|
|
480
519
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -484,18 +523,47 @@ export declare function cairoPageDiscardChangesBeforeSave(params: cairoPageDisca
|
|
|
484
523
|
* @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
|
|
485
524
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
486
525
|
* @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
|
|
526
|
+
* @property {boolean} isTPA
|
|
487
527
|
* @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
488
528
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
489
529
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
490
530
|
* @return {LogObject<cairoFileDownloadToastDownloadButtonClickedParams>} LogObject<cairoFileDownloadToastDownloadButtonClickedParams>
|
|
491
531
|
*/
|
|
492
532
|
export declare function cairoFileDownloadToastDownloadButtonClicked(params: cairoFileDownloadToastDownloadButtonClickedParams): LogObject<cairoFileDownloadToastDownloadButtonClickedParams>;
|
|
533
|
+
/**
|
|
534
|
+
* A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
|
|
535
|
+
*
|
|
536
|
+
* Event description: Sent when a user is making his first change in visible columns- add / remove / reorder them- for every time he opened the side panel. Relevant components: Table, Cards.
|
|
537
|
+
*
|
|
538
|
+
* @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
|
|
539
|
+
* @property {string} actionName - Visibility / Reorder
|
|
540
|
+
* @property {string} appId
|
|
541
|
+
* @property {string} artifactId - Artifact that owns the component
|
|
542
|
+
* @property {string} cairoVersion - version
|
|
543
|
+
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
544
|
+
* @property {string} componentType - Table/Cards
|
|
545
|
+
* @property {GUID} csid - cairo session id
|
|
546
|
+
* @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
|
|
547
|
+
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
548
|
+
* @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view, "false" if it's a user view and "null" if the action wasn't made over any view (new field from 01/2023)
|
|
549
|
+
* @property {boolean} isTPA
|
|
550
|
+
* @property {number} numColumns - How many columns are shown? (new field from 01/2023)
|
|
551
|
+
* @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
|
|
552
|
+
* @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
|
|
553
|
+
* @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
|
|
554
|
+
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
555
|
+
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
556
|
+
* @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
|
|
557
|
+
* @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
|
|
558
|
+
*/
|
|
559
|
+
export declare function cairoCustomizeColumnsInSidePanel(params: cairoCustomizeColumnsInSidePanelParams): LogObject<cairoCustomizeColumnsInSidePanelParams>;
|
|
493
560
|
/**
|
|
494
561
|
* A function to create a log object for the 'cairoTabSelected' event (evid: 121)
|
|
495
562
|
*
|
|
496
563
|
* Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
|
|
497
564
|
*
|
|
498
565
|
* @param {cairoTabSelectedParams} params - The parameters for this event
|
|
566
|
+
* @property {string} appId
|
|
499
567
|
* @property {string} artifactId - Artifact that owns the component
|
|
500
568
|
* @property {string} cairoVersion
|
|
501
569
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -504,6 +572,7 @@ export declare function cairoFileDownloadToastDownloadButtonClicked(params: cair
|
|
|
504
572
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
505
573
|
* @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
|
|
506
574
|
* @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
|
|
575
|
+
* @property {boolean} isTPA
|
|
507
576
|
* @property {string} newTabId - Name of the newly selected tab
|
|
508
577
|
* @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
|
|
509
578
|
* @property {number} numTabs - How many tabs are dispalyed to the user
|
|
@@ -521,6 +590,7 @@ export declare function cairoTabSelected(params: cairoTabSelectedParams): LogObj
|
|
|
521
590
|
*
|
|
522
591
|
* @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
|
|
523
592
|
* @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
|
|
593
|
+
* @property {string} appId
|
|
524
594
|
* @property {string} artifactId - Artifact that owns the component
|
|
525
595
|
* @property {string} cairoVersion - cairo version
|
|
526
596
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -535,6 +605,7 @@ export declare function cairoTabSelected(params: cairoTabSelectedParams): LogObj
|
|
|
535
605
|
* @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
|
|
536
606
|
* @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
|
|
537
607
|
* @property {boolean} isFromSearch - Was the failed action made on a search results?
|
|
608
|
+
* @property {boolean} isTPA
|
|
538
609
|
* @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
|
|
539
610
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
540
611
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -550,6 +621,7 @@ export declare function cairoViewsUnsuccessfulUpdateInServer(params: cairoViewsU
|
|
|
550
621
|
* Event description: Sent when a user clicks on a CTA in an an opened modal
|
|
551
622
|
*
|
|
552
623
|
* @param {cairoModalCtaClickedParams} params - The parameters for this event
|
|
624
|
+
* @property {string} appId
|
|
553
625
|
* @property {string} artifactId - Artifact that owns the component
|
|
554
626
|
* @property {string} cairoVersion - cairo version
|
|
555
627
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -557,6 +629,7 @@ export declare function cairoViewsUnsuccessfulUpdateInServer(params: cairoViewsU
|
|
|
557
629
|
* @property {GUID} csid - Cairo session id
|
|
558
630
|
* @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
|
|
559
631
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
632
|
+
* @property {boolean} isTPA
|
|
560
633
|
* @property {string} localizedCtaName - The CTA name, localized
|
|
561
634
|
* @property {string} modalName - The modal's title (Archive custom field, etc.)
|
|
562
635
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -570,6 +643,7 @@ export declare function cairoModalCtaClicked(params: cairoModalCtaClickedParams)
|
|
|
570
643
|
* Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
|
|
571
644
|
*
|
|
572
645
|
* @param {cairoAllFiltersClearedParams} params - The parameters for this event
|
|
646
|
+
* @property {string} appId
|
|
573
647
|
* @property {string} artifactId - Artifact that owns the component
|
|
574
648
|
* @property {string} cairoVersion
|
|
575
649
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -578,6 +652,7 @@ export declare function cairoModalCtaClicked(params: cairoModalCtaClickedParams)
|
|
|
578
652
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
579
653
|
* @property {string} filterNames - Comma separated list of filter names that have been cleared
|
|
580
654
|
* @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
|
|
655
|
+
* @property {boolean} isTPA
|
|
581
656
|
* @property {number} numFiltersCleared - How many filters have been cleared
|
|
582
657
|
* @property {string} origin - "sidebar"/"toolbar"
|
|
583
658
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -591,6 +666,7 @@ export declare function cairoAllFiltersCleared(params: cairoAllFiltersClearedPar
|
|
|
591
666
|
* Event description: Sent when a user clicks a CTA ('save', 'add', 'delete', 'continue', etc.) in a Cairo component. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
|
|
592
667
|
*
|
|
593
668
|
* @param {cairoCtaClickedParams} params - The parameters for this event
|
|
669
|
+
* @property {string} appId
|
|
594
670
|
* @property {string} artifactId - Artifact that owns the component
|
|
595
671
|
* @property {string} cairoVersion
|
|
596
672
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -602,6 +678,7 @@ export declare function cairoAllFiltersCleared(params: cairoAllFiltersClearedPar
|
|
|
602
678
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
603
679
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
604
680
|
* @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
|
|
681
|
+
* @property {boolean} isTPA
|
|
605
682
|
* @property {string} itemId - ID of the item that the user clicked on its CTA
|
|
606
683
|
* @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
|
|
607
684
|
* @property {string} localizedCtaName - The CTA name, localized
|
|
@@ -623,6 +700,7 @@ export declare function cairoCtaClicked(params: cairoCtaClickedParams): LogObjec
|
|
|
623
700
|
* Event description: Sent when a user changes his choices before he clicks on the apply button in a Cairo component. Relevant components: Table, with apply behavior in the filters panel, or with custom fields option.
|
|
624
701
|
*
|
|
625
702
|
* @param {cairoChangesBeforeApplyParams} params - The parameters for this event
|
|
703
|
+
* @property {string} appId
|
|
626
704
|
* @property {string} artifactId - Artifact that owns the component
|
|
627
705
|
* @property {string} cairoVersion - Cairo version
|
|
628
706
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -633,6 +711,7 @@ export declare function cairoCtaClicked(params: cairoCtaClickedParams): LogObjec
|
|
|
633
711
|
* @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
|
|
634
712
|
* @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
|
|
635
713
|
* @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
|
|
714
|
+
* @property {boolean} isTPA
|
|
636
715
|
* @property {number} numActiveFields - (relevant only when click on "clear") How many fields were active when the user clicked on the clear button? (fields that their value were not NULL)
|
|
637
716
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
638
717
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -646,12 +725,14 @@ export declare function cairoChangesBeforeApply(params: cairoChangesBeforeApplyP
|
|
|
646
725
|
*
|
|
647
726
|
* @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
|
|
648
727
|
* @property {string} actionName - Assign tags / Create tags / Manage tags
|
|
728
|
+
* @property {string} appId
|
|
649
729
|
* @property {string} artifactId - Artifact that owns the component
|
|
650
730
|
* @property {string} cairoVersion - Cairo version
|
|
651
731
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
652
732
|
* @property {string} componentType - Component type
|
|
653
733
|
* @property {GUID} csid - Cairo session ID
|
|
654
734
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
735
|
+
* @property {boolean} isTPA
|
|
655
736
|
* @property {string} itemId - The entity ID
|
|
656
737
|
* @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
|
|
657
738
|
* @property {number} numTagsAssigned - How many tags are already assigned to that item?
|
|
@@ -667,6 +748,7 @@ export declare function cairoTagsWidgetClickOnCta(params: cairoTagsWidgetClickOn
|
|
|
667
748
|
*
|
|
668
749
|
* @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
|
|
669
750
|
* @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
|
|
751
|
+
* @property {string} appId
|
|
670
752
|
* @property {string} artifactId - Artifact that owns the component
|
|
671
753
|
* @property {string} cairoVersion - cairo version
|
|
672
754
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -676,6 +758,7 @@ export declare function cairoTagsWidgetClickOnCta(params: cairoTagsWidgetClickOn
|
|
|
676
758
|
* @property {string} errorType - What is the type of the error? Technical issue / Network error / 10k Limitation
|
|
677
759
|
* @property {string} fieldName - The name the user typed
|
|
678
760
|
* @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
|
|
761
|
+
* @property {boolean} isTPA
|
|
679
762
|
* @property {string} key - The key value
|
|
680
763
|
* @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
|
|
681
764
|
* @property {string} permissions - Json field: {"Installed apps": "Value", "Site visitors": "Value"}. The value can be: Null (the user didn't chose anything), Read, Write, Read and Write.
|
|
@@ -690,6 +773,7 @@ export declare function cairoDataExtensionUnsuccessfulUpdateInServer(params: cai
|
|
|
690
773
|
* Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
|
|
691
774
|
*
|
|
692
775
|
* @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
|
|
776
|
+
* @property {string} appId
|
|
693
777
|
* @property {string} artifactId - Artifact that owns the component
|
|
694
778
|
* @property {string} cairoVersion - cairo version
|
|
695
779
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -704,6 +788,7 @@ export declare function cairoDataExtensionUnsuccessfulUpdateInServer(params: cai
|
|
|
704
788
|
* InitCustomFieldsDataExtensionFailed /
|
|
705
789
|
* InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
|
|
706
790
|
* @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
|
|
791
|
+
* @property {boolean} isTPA
|
|
707
792
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
708
793
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
709
794
|
* @property {Url} url - The page's url
|
|
@@ -716,6 +801,7 @@ export declare function cairoErrorInLoadingAComponent(params: cairoErrorInLoadin
|
|
|
716
801
|
* Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
|
|
717
802
|
*
|
|
718
803
|
* @param {cairoReloadErrorStateParams} params - The parameters for this event
|
|
804
|
+
* @property {string} appId
|
|
719
805
|
* @property {string} artifactId - Artifact that owns the component
|
|
720
806
|
* @property {string} cairoVersion - cairo version
|
|
721
807
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -731,6 +817,7 @@ export declare function cairoErrorInLoadingAComponent(params: cairoErrorInLoadin
|
|
|
731
817
|
* InitCustomFieldsDataExtensionFailed /
|
|
732
818
|
* InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
|
|
733
819
|
* @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
|
|
820
|
+
* @property {boolean} isTPA
|
|
734
821
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
735
822
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
736
823
|
* @property {Url} url - The page's url
|
|
@@ -743,6 +830,7 @@ export declare function cairoReloadErrorState(params: cairoReloadErrorStateParam
|
|
|
743
830
|
* Event description: Sent when the "create new" process ends (and the result is shown to the user)
|
|
744
831
|
*
|
|
745
832
|
* @param {newItemCreationEndParams} params - The parameters for this event
|
|
833
|
+
* @property {string} appId
|
|
746
834
|
* @property {string} artifactId - Artifact that owns the component
|
|
747
835
|
* @property {string} cairoVersion
|
|
748
836
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -752,6 +840,7 @@ export declare function cairoReloadErrorState(params: cairoReloadErrorStateParam
|
|
|
752
840
|
* @property {string} currentSortOrder - sort order
|
|
753
841
|
* @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
|
|
754
842
|
* @property {number} filteredListSize - How many items are currently presented to user (filtered)
|
|
843
|
+
* @property {boolean} isTPA
|
|
755
844
|
* @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
|
|
756
845
|
* @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
|
|
757
846
|
* @property {number} maxItems - Max number of items that can be selected
|
|
@@ -774,12 +863,14 @@ export declare function newItemCreationEnd(params: newItemCreationEndParams): Lo
|
|
|
774
863
|
* Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
|
|
775
864
|
*
|
|
776
865
|
* @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
|
|
866
|
+
* @property {string} appId
|
|
777
867
|
* @property {string} artifactId - Artifact that owns the component
|
|
778
868
|
* @property {string} cairoVersion - Cairo version
|
|
779
869
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
780
870
|
* @property {string} componentType - Component type
|
|
781
871
|
* @property {GUID} csid - Cairo session ID
|
|
782
872
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
873
|
+
* @property {boolean} isTPA
|
|
783
874
|
* @property {string} itemId - The entity ID (that the widget was loaded in its page)
|
|
784
875
|
* @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
|
|
785
876
|
* @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
|
|
@@ -794,6 +885,7 @@ export declare function cairoTagsWidgetLoaded(params: cairoTagsWidgetLoadedParam
|
|
|
794
885
|
* Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
|
|
795
886
|
*
|
|
796
887
|
* @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
|
|
888
|
+
* @property {string} appId
|
|
797
889
|
* @property {string} artifactId - Artifact that owns the component
|
|
798
890
|
* @property {string} cairoVersion
|
|
799
891
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -803,6 +895,7 @@ export declare function cairoTagsWidgetLoaded(params: cairoTagsWidgetLoadedParam
|
|
|
803
895
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
804
896
|
* @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
|
|
805
897
|
* @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
|
|
898
|
+
* @property {boolean} isTPA
|
|
806
899
|
* @property {string} notificationText - What is displayed to the user, localized
|
|
807
900
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
808
901
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -815,6 +908,7 @@ export declare function cairoTableTopNotificationDismissed(params: cairoTableTop
|
|
|
815
908
|
* Event description: Send when a user click on a section CTA (show more / show less etc.)
|
|
816
909
|
*
|
|
817
910
|
* @param {cairoSectionCtaClickedParams} params - The parameters for this event
|
|
911
|
+
* @property {string} appId
|
|
818
912
|
* @property {string} artifactId - Artifact that owns the component
|
|
819
913
|
* @property {string} cairoVersion - Cairo version
|
|
820
914
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
@@ -824,6 +918,7 @@ export declare function cairoTableTopNotificationDismissed(params: cairoTableTop
|
|
|
824
918
|
* @property {string} ctaName - cta key (show more / show less etc.)
|
|
825
919
|
* @property {string} ctaType - Main / Secondary / More actions
|
|
826
920
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
921
|
+
* @property {boolean} isTPA
|
|
827
922
|
* @property {string} localizedCtaName - The CTA name, localized
|
|
828
923
|
* @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
|
|
829
924
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -838,6 +933,7 @@ export declare function cairoSectionCtaClicked(params: cairoSectionCtaClickedPar
|
|
|
838
933
|
* Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
|
|
839
934
|
*
|
|
840
935
|
* @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
|
|
936
|
+
* @property {string} appId
|
|
841
937
|
* @property {string} artifactId - Artifact that owns the component
|
|
842
938
|
* @property {string} cairoVersion
|
|
843
939
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -846,6 +942,7 @@ export declare function cairoSectionCtaClicked(params: cairoSectionCtaClickedPar
|
|
|
846
942
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
847
943
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
848
944
|
* @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
|
|
945
|
+
* @property {boolean} isTPA
|
|
849
946
|
* @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
850
947
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
851
948
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -859,12 +956,14 @@ export declare function cairoFileDownloadToastDisplayed(params: cairoFileDownloa
|
|
|
859
956
|
* Event description: Sent when the search results are displayed, after a user searches for something in a Cairo component. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
|
|
860
957
|
*
|
|
861
958
|
* @param {cairoSearchResultsParams} params - The parameters for this event
|
|
959
|
+
* @property {string} appId
|
|
862
960
|
* @property {string} artifactId - Artifact that owns the component
|
|
863
961
|
* @property {string} cairoVersion
|
|
864
962
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
865
963
|
* @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
|
|
866
964
|
* @property {GUID} csid
|
|
867
965
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
966
|
+
* @property {boolean} isTPA
|
|
868
967
|
* @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
|
|
869
968
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
870
969
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -879,6 +978,7 @@ export declare function cairoSearchResults(params: cairoSearchResultsParams): Lo
|
|
|
879
978
|
* Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
|
|
880
979
|
*
|
|
881
980
|
* @param {cairoTagsModalEndProcessParams} params - The parameters for this event
|
|
981
|
+
* @property {string} appId
|
|
882
982
|
* @property {string} artifactId - Artifact that owns the component
|
|
883
983
|
* @property {string} cairoVersion - Cairo version
|
|
884
984
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
@@ -886,6 +986,7 @@ export declare function cairoSearchResults(params: cairoSearchResultsParams): Lo
|
|
|
886
986
|
* @property {GUID} csid - Cairo session ID
|
|
887
987
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
888
988
|
* @property {string} endType - Close without changes
|
|
989
|
+
* @property {boolean} isTPA
|
|
889
990
|
* @property {number} numTags - How many tags are in the modal?
|
|
890
991
|
* @property {string} origin - Where did the user open Manage Tags modal from?
|
|
891
992
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -899,6 +1000,7 @@ export declare function cairoTagsModalEndProcess(params: cairoTagsModalEndProces
|
|
|
899
1000
|
* Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
|
|
900
1001
|
*
|
|
901
1002
|
* @param {cairoManageViewClickedParams} params - The parameters for this event
|
|
1003
|
+
* @property {string} appId
|
|
902
1004
|
* @property {string} artifactId - Artifact that owns the component
|
|
903
1005
|
* @property {string} cairoVersion - Cairo version
|
|
904
1006
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -907,6 +1009,7 @@ export declare function cairoTagsModalEndProcess(params: cairoTagsModalEndProces
|
|
|
907
1009
|
* @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
|
|
908
1010
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
909
1011
|
* @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
|
|
1012
|
+
* @property {boolean} isTPA
|
|
910
1013
|
* @property {number} numFiltersInView - How many filters comprise the saved view
|
|
911
1014
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
912
1015
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -919,12 +1022,14 @@ export declare function cairoManageViewClicked(params: cairoManageViewClickedPar
|
|
|
919
1022
|
* Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
|
|
920
1023
|
*
|
|
921
1024
|
* @param {cairoTagsModalStartLoadParams} params - The parameters for this event
|
|
1025
|
+
* @property {string} appId
|
|
922
1026
|
* @property {string} artifactId - Artifact that owns the component
|
|
923
1027
|
* @property {string} cairoVersion - Cairo version
|
|
924
1028
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
925
1029
|
* @property {string} componentType - Component type
|
|
926
1030
|
* @property {GUID} csid - Cairo session ID
|
|
927
1031
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1032
|
+
* @property {boolean} isTPA
|
|
928
1033
|
* @property {number} numTags - How many tags are to be presented?
|
|
929
1034
|
* @property {string} origin - Where did the user open Manage Tags modal from?
|
|
930
1035
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -939,6 +1044,7 @@ export declare function cairoTagsModalStartLoad(params: cairoTagsModalStartLoadP
|
|
|
939
1044
|
*
|
|
940
1045
|
* @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
|
|
941
1046
|
* @property {string} actionName - The action the user tried to do on the sorting column: "Add new sort"/"Change sort column"/"Change sort type"/"Remove sort" / "Reorder sort columns".(in English, not localized)
|
|
1047
|
+
* @property {string} appId
|
|
942
1048
|
* @property {string} artifactId - Artifact that owns the component
|
|
943
1049
|
* @property {string} cairoVersion - cairo version
|
|
944
1050
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -953,6 +1059,7 @@ export declare function cairoTagsModalStartLoad(params: cairoTagsModalStartLoadP
|
|
|
953
1059
|
* @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
|
|
954
1060
|
* @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
|
|
955
1061
|
* @property {boolean} isFromSearch - Was the failed action made on a search results?
|
|
1062
|
+
* @property {boolean} isTPA
|
|
956
1063
|
* @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
|
|
957
1064
|
* @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
|
|
958
1065
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -973,6 +1080,7 @@ export declare function cairoSortUnsuccessfulUpdateInServer(params: cairoSortUns
|
|
|
973
1080
|
* Event description: Sent when user changes selection in the Cairo export modal
|
|
974
1081
|
*
|
|
975
1082
|
* @param {cairoItemToggledInExportModalParams} params - The parameters for this event
|
|
1083
|
+
* @property {string} appId
|
|
976
1084
|
* @property {string} artifactId - Artifact that owns the component
|
|
977
1085
|
* @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options. E.g. {"All Items": 100, "Filtered Items": 80, "Selected Items": 10}
|
|
978
1086
|
* @property {string} cairoVersion
|
|
@@ -982,6 +1090,7 @@ export declare function cairoSortUnsuccessfulUpdateInServer(params: cairoSortUns
|
|
|
982
1090
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
983
1091
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
984
1092
|
* @property {number} filteredListSize - How many items are currently presented to user (filtered)
|
|
1093
|
+
* @property {boolean} isTPA
|
|
985
1094
|
* @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
|
|
986
1095
|
* @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
|
|
987
1096
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -995,6 +1104,7 @@ export declare function cairoItemToggledInExportModal(params: cairoItemToggledIn
|
|
|
995
1104
|
* Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
|
|
996
1105
|
*
|
|
997
1106
|
* @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
|
|
1107
|
+
* @property {string} appId
|
|
998
1108
|
* @property {string} artifactId - Artifact that owns the component
|
|
999
1109
|
* @property {string} cairoVersion - cairo version
|
|
1000
1110
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1007,6 +1117,7 @@ export declare function cairoItemToggledInExportModal(params: cairoItemToggledIn
|
|
|
1007
1117
|
* @property {number} filteredListSize - How many items are to be presented (filtered)?
|
|
1008
1118
|
* @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
|
|
1009
1119
|
* @property {string} filtersApplied - A list of filters that were displayed to user when he made the failed action: {"filter1": "filterValue1", "filter2": "filterValue2a", "filterValue2b"}. Relevant for Table and Cards.
|
|
1120
|
+
* @property {boolean} isTPA
|
|
1010
1121
|
* @property {string} itemId - ID of the item that the user tries to drag
|
|
1011
1122
|
* @property {number} itemIndexAfter - Out of the list of results, what is the new index of the clicked item (after dragging, the new index). ** filteredListSize = X --> (1 <= itemIndexAfter <= X) **when endType <> drop succeeded --> itemIndexAfter = itemIndexBefore
|
|
1012
1123
|
* @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
|
|
@@ -1030,6 +1141,7 @@ export declare function cairoDragActionUnsuccessfulUpdateInServer(params: cairoD
|
|
|
1030
1141
|
* Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
|
|
1031
1142
|
*
|
|
1032
1143
|
* @param {cairoSearchForTagsParams} params - The parameters for this event
|
|
1144
|
+
* @property {string} appId
|
|
1033
1145
|
* @property {string} artifactId - Artifact that owns the component
|
|
1034
1146
|
* @property {string} cairoVersion - Cairo version
|
|
1035
1147
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1037,6 +1149,7 @@ export declare function cairoDragActionUnsuccessfulUpdateInServer(params: cairoD
|
|
|
1037
1149
|
* @property {GUID} csid - Cairo session id
|
|
1038
1150
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1039
1151
|
* @property {string} endType - How did the search action end? "Tag selected"- the user chose one of the search results, "Search dismissed"- the user cancel the search by any other action, "Add new tag"- when the searched tag doesn't exist and the user choose to add it as new
|
|
1152
|
+
* @property {boolean} isTPA
|
|
1040
1153
|
* @property {string} location - Where did the user search for the tag? Manage tags modal /
|
|
1041
1154
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1042
1155
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1053,6 +1166,7 @@ export declare function cairoSearchForTags(params: cairoSearchForTagsParams): Lo
|
|
|
1053
1166
|
* @param {cairoManageViewActionSelectedParams} params - The parameters for this event
|
|
1054
1167
|
* @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
|
|
1055
1168
|
* @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
|
|
1169
|
+
* @property {string} appId
|
|
1056
1170
|
* @property {string} artifactId - Artifact that owns the component
|
|
1057
1171
|
* @property {string} cairoVersion - cairo version
|
|
1058
1172
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1060,6 +1174,7 @@ export declare function cairoSearchForTags(params: cairoSearchForTagsParams): Lo
|
|
|
1060
1174
|
* @property {GUID} csid
|
|
1061
1175
|
* @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
|
|
1062
1176
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1177
|
+
* @property {boolean} isTPA
|
|
1063
1178
|
* @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
|
|
1064
1179
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1065
1180
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1072,12 +1187,14 @@ export declare function cairoManageViewActionSelected(params: cairoManageViewAct
|
|
|
1072
1187
|
* Event description: Send when a user click on "Learn More" from Cairo component.
|
|
1073
1188
|
*
|
|
1074
1189
|
* @param {cairoLearnMoreParams} params - The parameters for this event
|
|
1190
|
+
* @property {string} appId
|
|
1075
1191
|
* @property {string} artifactId - Artifact that owns the component
|
|
1076
1192
|
* @property {string} cairoVersion - Cairo version
|
|
1077
1193
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
1078
1194
|
* @property {string} componentType - Section name (Folders)
|
|
1079
1195
|
* @property {GUID} csid - Cairo session ID
|
|
1080
1196
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1197
|
+
* @property {boolean} isTPA
|
|
1081
1198
|
* @property {string} origin - Where did the user click on "Learn more" from? Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
|
|
1082
1199
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1083
1200
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1091,6 +1208,7 @@ export declare function cairoLearnMore(params: cairoLearnMoreParams): LogObject<
|
|
|
1091
1208
|
*
|
|
1092
1209
|
* @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
|
|
1093
1210
|
* @property {string} actionName - Assign / Remove
|
|
1211
|
+
* @property {string} appId
|
|
1094
1212
|
* @property {string} artifactId - Artifact that owns the component
|
|
1095
1213
|
* @property {string} assignedTags - array of tags that were assigned (empty array if none)
|
|
1096
1214
|
* @property {string} cairoVersion - Cairo version
|
|
@@ -1099,6 +1217,7 @@ export declare function cairoLearnMore(params: cairoLearnMoreParams): LogObject<
|
|
|
1099
1217
|
* @property {GUID} csid - Cairo session ID
|
|
1100
1218
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1101
1219
|
* @property {boolean} isFromSearch - Is the action made from a list of tags search results?
|
|
1220
|
+
* @property {boolean} isTPA
|
|
1102
1221
|
* @property {string} itemIds - array of items ids that were selected
|
|
1103
1222
|
* @property {number} numItems - How many items have been selected?
|
|
1104
1223
|
* @property {string} origin - Where did the user make the action from?
|
|
@@ -1114,6 +1233,7 @@ export declare function cairoAssignTagsToEntities(params: cairoAssignTagsToEntit
|
|
|
1114
1233
|
* Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
|
|
1115
1234
|
*
|
|
1116
1235
|
* @param {cairoPageCtaClickedParams} params - The parameters for this event
|
|
1236
|
+
* @property {string} appId
|
|
1117
1237
|
* @property {string} artifactId - Artifact that owns the component
|
|
1118
1238
|
* @property {string} cairoVersion - Cairo version
|
|
1119
1239
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
@@ -1122,6 +1242,7 @@ export declare function cairoAssignTagsToEntities(params: cairoAssignTagsToEntit
|
|
|
1122
1242
|
* @property {string} ctaName - "Add New"/"More Actions"... (in English only, not localized). For section= vertical / Cairo - it will be defined as unique title. For section=TPA: it will be the component_id of the TPA. To get the TPA app_id - use the table mysql.app_service.components- join on table.component_id= event.ctaName
|
|
1123
1243
|
* @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
|
|
1124
1244
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1245
|
+
* @property {boolean} isTPA
|
|
1125
1246
|
* @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
|
|
1126
1247
|
* @property {string} location - CTA location: TBD
|
|
1127
1248
|
* @property {number} moreActionsIndex - (Relevant only for 'More Action Option' CTA) 0 <= moreActionsIndex <= numCtas -- the number of the CTA out of all CTAs in the more action dropdown
|
|
@@ -1139,6 +1260,7 @@ export declare function cairoPageCtaClicked(params: cairoPageCtaClickedParams):
|
|
|
1139
1260
|
* Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
|
|
1140
1261
|
*
|
|
1141
1262
|
* @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
|
|
1263
|
+
* @property {string} appId
|
|
1142
1264
|
* @property {string} artifactId - Artifact that owns the component
|
|
1143
1265
|
* @property {string} cairoVersion
|
|
1144
1266
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1146,6 +1268,7 @@ export declare function cairoPageCtaClicked(params: cairoPageCtaClickedParams):
|
|
|
1146
1268
|
* @property {GUID} csid
|
|
1147
1269
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1148
1270
|
* @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
|
|
1271
|
+
* @property {boolean} isTPA
|
|
1149
1272
|
* @property {string} notificationText - What is displayed to the user, localized
|
|
1150
1273
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1151
1274
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1159,6 +1282,7 @@ export declare function cairoTableTopNotificationDisplayed(params: cairoTableTop
|
|
|
1159
1282
|
*
|
|
1160
1283
|
* @param {cairoTryAgainClickedParams} params - The parameters for this event
|
|
1161
1284
|
* @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
|
|
1285
|
+
* @property {string} appId
|
|
1162
1286
|
* @property {string} artifactId - Artifact that owns the component
|
|
1163
1287
|
* @property {string} cairoVersion - cairo version
|
|
1164
1288
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1167,6 +1291,7 @@ export declare function cairoTableTopNotificationDisplayed(params: cairoTableTop
|
|
|
1167
1291
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
1168
1292
|
* @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
|
|
1169
1293
|
* @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
|
|
1294
|
+
* @property {boolean} isTPA
|
|
1170
1295
|
* @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
|
|
1171
1296
|
* @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
|
|
1172
1297
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1180,6 +1305,7 @@ export declare function cairoTryAgainClicked(params: cairoTryAgainClickedParams)
|
|
|
1180
1305
|
* Event description: (This event was changed in 01/2023 from filter panel used to more generic - any feature panel). Sent when a feature sidebar/menu in a Cairo component is opened or closed. Relevant features: Filters, Sort, Views, Costume Columns. Relevant components: Table, Cards.
|
|
1181
1306
|
*
|
|
1182
1307
|
* @param {cairoFiltersPanelUsedParams} params - The parameters for this event
|
|
1308
|
+
* @property {string} appId
|
|
1183
1309
|
* @property {string} artifactId - Artifact that owns the component
|
|
1184
1310
|
* @property {string} cairoVersion
|
|
1185
1311
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1191,6 +1317,7 @@ export declare function cairoTryAgainClicked(params: cairoTryAgainClickedParams)
|
|
|
1191
1317
|
* @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
|
|
1192
1318
|
* @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
|
|
1193
1319
|
* @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view, "false" if it's a user view and "null" if the action wasn't made over any view (new field from 01/2023)
|
|
1320
|
+
* @property {boolean} isTPA
|
|
1194
1321
|
* @property {number} numColumns - How many columns are shown? (new field from 01/2023)
|
|
1195
1322
|
* @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
|
|
1196
1323
|
* @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
|
|
@@ -1209,6 +1336,7 @@ export declare function cairoFiltersPanelUsed(params: cairoFiltersPanelUsedParam
|
|
|
1209
1336
|
* Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
|
|
1210
1337
|
*
|
|
1211
1338
|
* @param {cairoDragItemParams} params - The parameters for this event
|
|
1339
|
+
* @property {string} appId
|
|
1212
1340
|
* @property {string} artifactId - Artifact that owns the component
|
|
1213
1341
|
* @property {string} cairoVersion - cairo version
|
|
1214
1342
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1224,6 +1352,7 @@ export declare function cairoFiltersPanelUsed(params: cairoFiltersPanelUsedParam
|
|
|
1224
1352
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
1225
1353
|
* @property {boolean} isFromHandle - Is the item dragged from the handle area?
|
|
1226
1354
|
* @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
|
|
1355
|
+
* @property {boolean} isTPA
|
|
1227
1356
|
* @property {string} itemId - ID of the item that the user tries to drag.
|
|
1228
1357
|
* @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
|
|
1229
1358
|
* @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
|
|
@@ -1239,6 +1368,7 @@ export declare function cairoDragItem(params: cairoDragItemParams): LogObject<ca
|
|
|
1239
1368
|
* Event description: Sent when the toast that tells the user that the export is done and the file is being downloaded is dismissed (by user or automatically).
|
|
1240
1369
|
*
|
|
1241
1370
|
* @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
|
|
1371
|
+
* @property {string} appId
|
|
1242
1372
|
* @property {string} artifactId - Artifact that owns the component
|
|
1243
1373
|
* @property {string} cairoVersion
|
|
1244
1374
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1249,6 +1379,7 @@ export declare function cairoDragItem(params: cairoDragItemParams): LogObject<ca
|
|
|
1249
1379
|
* @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
|
|
1250
1380
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
1251
1381
|
* @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
|
|
1382
|
+
* @property {boolean} isTPA
|
|
1252
1383
|
* @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
1253
1384
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1254
1385
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1261,6 +1392,7 @@ export declare function cairoFileDownloadToastDismissed(params: cairoFileDownloa
|
|
|
1261
1392
|
* Event description: Sent when the user tries to cancel the export process AFTER it has begun
|
|
1262
1393
|
*
|
|
1263
1394
|
* @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
|
|
1395
|
+
* @property {string} appId
|
|
1264
1396
|
* @property {string} artifactId - Artifact that owns the component
|
|
1265
1397
|
* @property {string} cairoVersion
|
|
1266
1398
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1269,6 +1401,7 @@ export declare function cairoFileDownloadToastDismissed(params: cairoFileDownloa
|
|
|
1269
1401
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1270
1402
|
* @property {number} duration - How much time (in ms) did it take since the export process began
|
|
1271
1403
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
1404
|
+
* @property {boolean} isTPA
|
|
1272
1405
|
* @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
1273
1406
|
* @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
|
|
1274
1407
|
* @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
|
|
@@ -1286,6 +1419,7 @@ export declare function cairoUserAttemptsToCancelTheExport(params: cairoUserAtte
|
|
|
1286
1419
|
* Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
|
|
1287
1420
|
*
|
|
1288
1421
|
* @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
|
|
1422
|
+
* @property {string} appId
|
|
1289
1423
|
* @property {string} artifactId - Artifact that owns the component
|
|
1290
1424
|
* @property {string} cairoVersion
|
|
1291
1425
|
* @property {string} componentName - Optional in case having 2 pickers under the same artifact
|
|
@@ -1295,6 +1429,7 @@ export declare function cairoUserAttemptsToCancelTheExport(params: cairoUserAtte
|
|
|
1295
1429
|
* @property {number} filteredListSize - How many items are to presented (filtered)
|
|
1296
1430
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
1297
1431
|
* @property {boolean} isImmediate - Is it an immediate CTA
|
|
1432
|
+
* @property {boolean} isTPA
|
|
1298
1433
|
* @property {number} itemsCnt - Number of total items picked
|
|
1299
1434
|
* @property {number} listSize - How many items exist (full list)
|
|
1300
1435
|
* @property {number} maxItems - Max items to select in picker
|
|
@@ -1310,6 +1445,7 @@ export declare function pickerPickModalCtaButtonClickOrImmediateCta(params: pick
|
|
|
1310
1445
|
* Event description: Sent when the user clicks the "create new" button
|
|
1311
1446
|
*
|
|
1312
1447
|
* @param {newItemCreationStartParams} params - The parameters for this event
|
|
1448
|
+
* @property {string} appId
|
|
1313
1449
|
* @property {string} artifactId - Artifact that owns the component
|
|
1314
1450
|
* @property {string} cairoVersion
|
|
1315
1451
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1319,6 +1455,7 @@ export declare function pickerPickModalCtaButtonClickOrImmediateCta(params: pick
|
|
|
1319
1455
|
* @property {string} currentSortOrder - sorts
|
|
1320
1456
|
* @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
|
|
1321
1457
|
* @property {number} filteredListSize - How many items are currently presented to user (filtered)
|
|
1458
|
+
* @property {boolean} isTPA
|
|
1322
1459
|
* @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
|
|
1323
1460
|
* @property {number} maxItems - Max number of items that can be selected
|
|
1324
1461
|
* @property {number} numColumns - columns
|
|
@@ -1339,6 +1476,7 @@ export declare function newItemCreationStart(params: newItemCreationStartParams)
|
|
|
1339
1476
|
* Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
|
|
1340
1477
|
*
|
|
1341
1478
|
* @param {cairoViewSelectedParams} params - The parameters for this event
|
|
1479
|
+
* @property {string} appId
|
|
1342
1480
|
* @property {string} artifactId - Artifact that owns the component
|
|
1343
1481
|
* @property {string} cairoVersion
|
|
1344
1482
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1351,6 +1489,7 @@ export declare function newItemCreationStart(params: newItemCreationStartParams)
|
|
|
1351
1489
|
* @property {boolean} isDefault - Is the selected view defined as default view?
|
|
1352
1490
|
* @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
|
|
1353
1491
|
* @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
|
|
1492
|
+
* @property {boolean} isTPA
|
|
1354
1493
|
* @property {string} newViewName - Name of the newly selected view
|
|
1355
1494
|
* @property {number} numFiltersActive - How many filters are active after view selection
|
|
1356
1495
|
* @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
|
|
@@ -1366,12 +1505,14 @@ export declare function cairoViewSelected(params: cairoViewSelectedParams): LogO
|
|
|
1366
1505
|
* Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
|
|
1367
1506
|
*
|
|
1368
1507
|
* @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
|
|
1508
|
+
* @property {string} appId
|
|
1369
1509
|
* @property {string} artifactId - Artifact that owns the component
|
|
1370
1510
|
* @property {string} cairoVersion - Cairo version
|
|
1371
1511
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
1372
1512
|
* @property {string} componentType - Component type
|
|
1373
1513
|
* @property {GUID} csid - Cairo session ID
|
|
1374
1514
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1515
|
+
* @property {boolean} isTPA
|
|
1375
1516
|
* @property {number} numColumns - How many columns are shown?
|
|
1376
1517
|
* @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page / Manage custom fields / Custom fields widget / External (the origin is external to Cairo)
|
|
1377
1518
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1387,6 +1528,7 @@ export declare function cairoDataExAddCustomField(params: cairoDataExAddCustomFi
|
|
|
1387
1528
|
*
|
|
1388
1529
|
* @param {cairoFilterToggledParams} params - The parameters for this event
|
|
1389
1530
|
* @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
|
|
1531
|
+
* @property {string} appId
|
|
1390
1532
|
* @property {string} artifactId - Artifact that owns the component
|
|
1391
1533
|
* @property {string} cairoVersion
|
|
1392
1534
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1397,6 +1539,7 @@ export declare function cairoDataExAddCustomField(params: cairoDataExAddCustomFi
|
|
|
1397
1539
|
* @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
|
|
1398
1540
|
* @property {string} filterValue - JSON containing filterName's new value
|
|
1399
1541
|
* @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
|
|
1542
|
+
* @property {boolean} isTPA
|
|
1400
1543
|
* @property {number} listSize - How many items exist (full list, unfiltered)
|
|
1401
1544
|
* @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
|
|
1402
1545
|
* @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
|
|
@@ -1412,12 +1555,14 @@ export declare function cairoFilterToggled(params: cairoFilterToggledParams): Lo
|
|
|
1412
1555
|
*
|
|
1413
1556
|
* @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
|
|
1414
1557
|
* @property {string} actionName - Open / Close the advanced settings
|
|
1558
|
+
* @property {string} appId
|
|
1415
1559
|
* @property {string} artifactId - Artifact that owns the component
|
|
1416
1560
|
* @property {string} cairoVersion - Cairo version
|
|
1417
1561
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
1418
1562
|
* @property {string} componentType - Component type
|
|
1419
1563
|
* @property {GUID} csid - Cairo session ID
|
|
1420
1564
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1565
|
+
* @property {boolean} isTPA
|
|
1421
1566
|
* @property {string} origin - Where did the user click on "Advanced Settings" from? Add Custom Field Modal / Edit Custom Field Modal
|
|
1422
1567
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1423
1568
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1430,6 +1575,7 @@ export declare function cairoDataExCustomFieldAdvancesSettings(params: cairoData
|
|
|
1430
1575
|
* Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
|
|
1431
1576
|
*
|
|
1432
1577
|
* @param {cairoViewSavedParams} params - The parameters for this event
|
|
1578
|
+
* @property {string} appId
|
|
1433
1579
|
* @property {string} artifactId - Artifact that owns the component
|
|
1434
1580
|
* @property {string} cairoVersion - Cairo version
|
|
1435
1581
|
* @property {string} changedAttributes - Which attributes have changed from the last view version? If it's a new view - all the attributes that define the view will be noted. The attributes can be: Filters, Columns Order, Columns Visibility, Sorting, Search (new field from 11/2022)
|
|
@@ -1441,6 +1587,7 @@ export declare function cairoDataExCustomFieldAdvancesSettings(params: cairoData
|
|
|
1441
1587
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1442
1588
|
* @property {boolean} isDefault - Is the saved view defined as default view?
|
|
1443
1589
|
* @property {boolean} isPredefined - (Relevant only for "save as new view" action, will get null in other cases). Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view. (new field from 11/2022)
|
|
1590
|
+
* @property {boolean} isTPA
|
|
1444
1591
|
* @property {string} newViewName - Name of the newly created/saved/renamed view
|
|
1445
1592
|
* @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
|
|
1446
1593
|
* @property {number} numFiltersInView - How many filters comprise the saved view
|
|
@@ -1461,6 +1608,7 @@ export declare function cairoViewSaved(params: cairoViewSavedParams): LogObject<
|
|
|
1461
1608
|
* Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
|
|
1462
1609
|
*
|
|
1463
1610
|
* @param {cairoViewDeletedParams} params - The parameters for this event
|
|
1611
|
+
* @property {string} appId
|
|
1464
1612
|
* @property {string} artifactId - Artifact that owns the component
|
|
1465
1613
|
* @property {string} cairoVersion
|
|
1466
1614
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1468,6 +1616,7 @@ export declare function cairoViewSaved(params: cairoViewSavedParams): LogObject<
|
|
|
1468
1616
|
* @property {GUID} csid
|
|
1469
1617
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1470
1618
|
* @property {boolean} isDefault - Was the deleted view defined as default view?
|
|
1619
|
+
* @property {boolean} isTPA
|
|
1471
1620
|
* @property {number} numFiltersInView - How many filters comprised the deleted view
|
|
1472
1621
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1473
1622
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1485,6 +1634,7 @@ export declare function cairoViewDeleted(params: cairoViewDeletedParams): LogObj
|
|
|
1485
1634
|
*
|
|
1486
1635
|
* @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
|
|
1487
1636
|
* @property {string} actionName - Add/ Edit
|
|
1637
|
+
* @property {string} appId
|
|
1488
1638
|
* @property {string} artifactId - Artifact that owns the component
|
|
1489
1639
|
* @property {string} cairoVersion - Cairo version
|
|
1490
1640
|
* @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
|
|
@@ -1496,6 +1646,7 @@ export declare function cairoViewDeleted(params: cairoViewDeletedParams): LogObj
|
|
|
1496
1646
|
* @property {string} endType - What did the user chose in the modal? Add field / Cancel
|
|
1497
1647
|
* @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
|
|
1498
1648
|
* @property {string} fieldType - (Relevant when a field was added) What type is the added field? Long text / Date / Number etc.
|
|
1649
|
+
* @property {boolean} isTPA
|
|
1499
1650
|
* @property {string} key - The key value
|
|
1500
1651
|
* @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
|
|
1501
1652
|
* @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
|
|
@@ -1512,6 +1663,7 @@ export declare function cairoDataExCustomFieldEndProcess(params: cairoDataExCust
|
|
|
1512
1663
|
* Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
|
|
1513
1664
|
*
|
|
1514
1665
|
* @param {cairoComponentSortedParams} params - The parameters for this event
|
|
1666
|
+
* @property {string} appId
|
|
1515
1667
|
* @property {string} artifactId - Artifact that owns the component
|
|
1516
1668
|
* @property {string} cairoVersion - Cairo version
|
|
1517
1669
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1520,6 +1672,7 @@ export declare function cairoDataExCustomFieldEndProcess(params: cairoDataExCust
|
|
|
1520
1672
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1521
1673
|
* @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
|
|
1522
1674
|
* @property {boolean} isAddNewSort - Indication for adding new sort. Will get "true" for cases the event was sent for adding new sort (and "false" for changing the sorted column, sorted order or remove sort) (new from 12/2022)
|
|
1675
|
+
* @property {boolean} isTPA
|
|
1523
1676
|
* @property {number} itemIndex - The item index inside the sort panel. First row will get 0. In case of simple sort (only 1 column sorts the table) from the column header - the index will be 0. In case a sorting column was removed from sorting- will get (-1)
|
|
1524
1677
|
* @property {number} listSize - How many items exist (full list, unfiltered)
|
|
1525
1678
|
* @property {string} newSortOrder - Which columns are currently used to sort the list, by the order the user defined: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards. (new field from 11/2022)
|
|
@@ -1542,6 +1695,7 @@ export declare function cairoComponentSorted(params: cairoComponentSortedParams)
|
|
|
1542
1695
|
* Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
|
|
1543
1696
|
*
|
|
1544
1697
|
* @param {cairoReorderingSortColumnsParams} params - The parameters for this event
|
|
1698
|
+
* @property {string} appId
|
|
1545
1699
|
* @property {string} artifactId - Artifact that owns the component
|
|
1546
1700
|
* @property {string} cairoVersion - Cairo version
|
|
1547
1701
|
* @property {number} columnIndexAfter - Out of the list of sorting columns, what is the index of the sorting column (after reordering). ** numSortingColumns = X --> (1 <= columnIndexAfter <= X)
|
|
@@ -1551,6 +1705,7 @@ export declare function cairoComponentSorted(params: cairoComponentSortedParams)
|
|
|
1551
1705
|
* @property {GUID} csid
|
|
1552
1706
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1553
1707
|
* @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
|
|
1708
|
+
* @property {boolean} isTPA
|
|
1554
1709
|
* @property {number} listSize - How many items exist (full list, unfiltered)
|
|
1555
1710
|
* @property {string} newSortOrder - Which columns are currently used to sort the list, by the new order the user defined: [{"fieldName": "FIELD_NAME", "order": "asc"}, {"fieldName": "FIELD_NAME_1", "order": "desc"}]. Relevant for Table and Cards.
|
|
1556
1711
|
* @property {number} numSortingColumns - How many columns are been used for sorting the component?
|
|
@@ -1568,6 +1723,7 @@ export declare function cairoReorderingSortColumns(params: cairoReorderingSortCo
|
|
|
1568
1723
|
* Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
|
|
1569
1724
|
*
|
|
1570
1725
|
* @param {cairoExportProcessEndParams} params - The parameters for this event
|
|
1726
|
+
* @property {string} appId
|
|
1571
1727
|
* @property {string} artifactId - Artifact that owns the component
|
|
1572
1728
|
* @property {string} cairoVersion
|
|
1573
1729
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1577,6 +1733,7 @@ export declare function cairoReorderingSortColumns(params: cairoReorderingSortCo
|
|
|
1577
1733
|
* @property {number} duration - How much time (in ms) did it take since the export process began
|
|
1578
1734
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
1579
1735
|
* @property {string} fileName - (Optional) Name of the file to be exported
|
|
1736
|
+
* @property {boolean} isTPA
|
|
1580
1737
|
* @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
1581
1738
|
* @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
|
|
1582
1739
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1594,6 +1751,7 @@ export declare function cairoExportProcessEnd(params: cairoExportProcessEndParam
|
|
|
1594
1751
|
* Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
|
|
1595
1752
|
*
|
|
1596
1753
|
* @param {cairoApplyButtonClickedParams} params - The parameters for this event
|
|
1754
|
+
* @property {string} appId
|
|
1597
1755
|
* @property {string} artifactId
|
|
1598
1756
|
* @property {string} cairoVersion - Cairo version
|
|
1599
1757
|
* @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
|
|
@@ -1604,6 +1762,7 @@ export declare function cairoExportProcessEnd(params: cairoExportProcessEndParam
|
|
|
1604
1762
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
1605
1763
|
* @property {string} feature - Filters / Drag and Drop
|
|
1606
1764
|
* @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
|
|
1765
|
+
* @property {boolean} isTPA
|
|
1607
1766
|
* @property {number} listSize - How many items exist (full list, unfiltered)
|
|
1608
1767
|
* @property {number} numActiveFields - (Optional, relevant for Filters) How many fields are active after the apply button is clicked? (fields that their value is not NULL)
|
|
1609
1768
|
* @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
|
|
@@ -1621,6 +1780,7 @@ export declare function cairoApplyButtonClicked(params: cairoApplyButtonClickedP
|
|
|
1621
1780
|
*
|
|
1622
1781
|
* @param {cairoExportModalCtaClickedParams} params - The parameters for this event
|
|
1623
1782
|
* @property {string} action - Does the user want to proceed with the export or dismiss the modal
|
|
1783
|
+
* @property {string} appId
|
|
1624
1784
|
* @property {string} artifactId - Artifact that owns the component
|
|
1625
1785
|
* @property {string} availableExportTypes - A list of all of the available export types, along with the number of items that would be exported using each of the options
|
|
1626
1786
|
* @property {string} cairoVersion
|
|
@@ -1629,6 +1789,7 @@ export declare function cairoApplyButtonClicked(params: cairoApplyButtonClickedP
|
|
|
1629
1789
|
* @property {GUID} csid
|
|
1630
1790
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1631
1791
|
* @property {string} exportId - A unique ID that will help join all events related to a specific export process
|
|
1792
|
+
* @property {boolean} isTPA
|
|
1632
1793
|
* @property {number} numItems - How many items does the user want to export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
|
|
1633
1794
|
* @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
|
|
1634
1795
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1645,6 +1806,7 @@ export declare function cairoExportModalCtaClicked(params: cairoExportModalCtaCl
|
|
|
1645
1806
|
*
|
|
1646
1807
|
* @param {cairoUndoClickedParams} params - The parameters for this event
|
|
1647
1808
|
* @property {string} actionName - The action's name the user wants to undo and triggered the toast (for example: view- save changes, view- rename, view- delete etc.)
|
|
1809
|
+
* @property {string} appId
|
|
1648
1810
|
* @property {string} artifactId - Artifact that owns the component
|
|
1649
1811
|
* @property {string} cairoVersion - cairo version
|
|
1650
1812
|
* @property {string} changedAttributes - Which attributes have changed from the saved status to the current
|
|
@@ -1658,6 +1820,7 @@ export declare function cairoExportModalCtaClicked(params: cairoExportModalCtaCl
|
|
|
1658
1820
|
* @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
|
|
1659
1821
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
1660
1822
|
* @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
|
|
1823
|
+
* @property {boolean} isTPA
|
|
1661
1824
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1662
1825
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
1663
1826
|
* @property {string} sortOrderApplied - Which columns were used to sort the list when the user made the action he wants to undo: [{"fieldName": "FIELD_NAME", "order": "asc"}
|
|
@@ -1673,6 +1836,7 @@ export declare function cairoUndoClicked(params: cairoUndoClickedParams): LogObj
|
|
|
1673
1836
|
* Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
|
|
1674
1837
|
*
|
|
1675
1838
|
* @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
|
|
1839
|
+
* @property {string} appId
|
|
1676
1840
|
* @property {string} artifactId - Artifact that owns the component
|
|
1677
1841
|
* @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
|
|
1678
1842
|
* @property {string} cairoVersion - Cairo version
|
|
@@ -1681,6 +1845,7 @@ export declare function cairoUndoClicked(params: cairoUndoClickedParams): LogObj
|
|
|
1681
1845
|
* @property {GUID} csid
|
|
1682
1846
|
* @property {string} destination_page_type - Higher hierarchy (can be relevant both for back button and breadcrumb clicked )/ Last page in BM (relevant only for back button clicked)
|
|
1683
1847
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1848
|
+
* @property {boolean} isTPA
|
|
1684
1849
|
* @property {string} pageType - Collection Page
|
|
1685
1850
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1686
1851
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1703,6 +1868,7 @@ export declare function cairoPageBackOrBreadcrumbClicked(params: cairoPageBackOr
|
|
|
1703
1868
|
* @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
|
|
1704
1869
|
* @property {string} ctaName - TPA's component_id. To get the TPA app_id - use the table mysql.app_service.components- join on table.component_id= event.ctaName
|
|
1705
1870
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1871
|
+
* @property {boolean} isTPA
|
|
1706
1872
|
* @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
|
|
1707
1873
|
* @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
|
|
1708
1874
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1717,12 +1883,14 @@ export declare function cairoTpaSCtaClicked(params: cairoTpaSCtaClickedParams):
|
|
|
1717
1883
|
* Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
|
|
1718
1884
|
*
|
|
1719
1885
|
* @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
|
|
1886
|
+
* @property {string} appId
|
|
1720
1887
|
* @property {string} artifactId - Artifact that owns the component
|
|
1721
1888
|
* @property {string} cairoVersion
|
|
1722
1889
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
1723
1890
|
* @property {string} componentType
|
|
1724
1891
|
* @property {GUID} csid
|
|
1725
1892
|
* @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
|
|
1893
|
+
* @property {boolean} isTPA
|
|
1726
1894
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1727
1895
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
1728
1896
|
* @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
|
|
@@ -1735,6 +1903,7 @@ export declare function pikachuCategoriesDropdownButtonClicked(params: pikachuCa
|
|
|
1735
1903
|
*
|
|
1736
1904
|
* @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
|
|
1737
1905
|
* @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
|
|
1906
|
+
* @property {string} appId
|
|
1738
1907
|
* @property {string} artifactId - Artifact that owns the component
|
|
1739
1908
|
* @property {string} cairoVersion - Cairo version
|
|
1740
1909
|
* @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
|
|
@@ -1742,6 +1911,7 @@ export declare function pikachuCategoriesDropdownButtonClicked(params: pikachuCa
|
|
|
1742
1911
|
* @property {GUID} csid - Cairo session ID
|
|
1743
1912
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1744
1913
|
* @property {string} errorType - What is the type of the error? Technical issue / Network error
|
|
1914
|
+
* @property {boolean} isTPA
|
|
1745
1915
|
* @property {number} numTags - How many tags are in the modal after this action?
|
|
1746
1916
|
* @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
|
|
1747
1917
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
@@ -1757,6 +1927,7 @@ export declare function cairoTagsUnsuccessfulUpdateInServer(params: cairoTagsUns
|
|
|
1757
1927
|
*
|
|
1758
1928
|
* @param {pickerModalUsabilityParams} params - The parameters for this event
|
|
1759
1929
|
* @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
|
|
1930
|
+
* @property {string} appId
|
|
1760
1931
|
* @property {string} artifactId - Artifact that owns the component
|
|
1761
1932
|
* @property {string} cairoVersion
|
|
1762
1933
|
* @property {string} componentName - Optional in case having 2 pickers under the same artifact
|
|
@@ -1764,6 +1935,7 @@ export declare function cairoTagsUnsuccessfulUpdateInServer(params: cairoTagsUns
|
|
|
1764
1935
|
* @property {GUID} csid
|
|
1765
1936
|
* @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
|
|
1766
1937
|
* @property {number} filteredListSize - How many items are to presented (filtered)
|
|
1938
|
+
* @property {boolean} isTPA
|
|
1767
1939
|
* @property {string} itemId - (Optional) ID of item checked
|
|
1768
1940
|
* @property {number} itemsCnt - (Optional) Number of total items checked
|
|
1769
1941
|
* @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
|
|
@@ -1785,6 +1957,7 @@ export declare function pickerModalUsability(params: pickerModalUsabilityParams)
|
|
|
1785
1957
|
* Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
|
|
1786
1958
|
*
|
|
1787
1959
|
* @param {cairoSortPanelUsedParams} params - The parameters for this event
|
|
1960
|
+
* @property {string} appId
|
|
1788
1961
|
* @property {string} artifactId
|
|
1789
1962
|
* @property {string} cairoVersion - Cairo version
|
|
1790
1963
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1793,6 +1966,7 @@ export declare function pickerModalUsability(params: pickerModalUsabilityParams)
|
|
|
1793
1966
|
* @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
|
|
1794
1967
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1795
1968
|
* @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
|
|
1969
|
+
* @property {boolean} isTPA
|
|
1796
1970
|
* @property {number} numSortedColumns - How many columns actively sort the data?
|
|
1797
1971
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1798
1972
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|
|
@@ -1806,6 +1980,7 @@ export declare function cairoSortPanelUsed(params: cairoSortPanelUsedParams): Lo
|
|
|
1806
1980
|
*
|
|
1807
1981
|
* @param {cairoTagsAssignTagParams} params - The parameters for this event
|
|
1808
1982
|
* @property {string} actionName - Assign / Remove
|
|
1983
|
+
* @property {string} appId
|
|
1809
1984
|
* @property {string} artifactId - Artifact that owns the component
|
|
1810
1985
|
* @property {string} cairoVersion - Cairo version
|
|
1811
1986
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1813,6 +1988,7 @@ export declare function cairoSortPanelUsed(params: cairoSortPanelUsedParams): Lo
|
|
|
1813
1988
|
* @property {GUID} csid - Cairo session ID
|
|
1814
1989
|
* @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
|
|
1815
1990
|
* @property {boolean} isFromSearch - Is the action made from a list of tags search results?
|
|
1991
|
+
* @property {boolean} isTPA
|
|
1816
1992
|
* @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
|
|
1817
1993
|
* @property {number} numItems - How many items have been selected?
|
|
1818
1994
|
* @property {number} numTags - How many tags are existing? will get 0 if the user didn't create any tag and an empty state will be opened
|
|
@@ -1830,6 +2006,7 @@ export declare function cairoTagsAssignTag(params: cairoTagsAssignTagParams): Lo
|
|
|
1830
2006
|
* Event description: Sent when a Cairo's page can't be saved due to an error.
|
|
1831
2007
|
*
|
|
1832
2008
|
* @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
|
|
2009
|
+
* @property {string} appId
|
|
1833
2010
|
* @property {string} artifactId - Artifact that owns the component
|
|
1834
2011
|
* @property {string} cairoVersion - Cairo version
|
|
1835
2012
|
* @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
|
|
@@ -1844,6 +2021,7 @@ export declare function cairoTagsAssignTag(params: cairoTagsAssignTagParams): Lo
|
|
|
1844
2021
|
* @property {string} errorType - Technical issue / Logic error / Network error / External error
|
|
1845
2022
|
* @property {number} filteredListSize - How many items are to be presented (filtered)
|
|
1846
2023
|
* @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
|
|
2024
|
+
* @property {boolean} isTPA
|
|
1847
2025
|
* @property {string} pageType - Entity / Collection
|
|
1848
2026
|
* @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
|
|
1849
2027
|
* @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
|