@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.
Files changed (254) hide show
  1. package/@wix/ambassador-app-settings-v1-settings/build/cjs/builders.impl.js +1 -1
  2. package/@wix/ambassador-app-settings-v1-settings/build/cjs/builders.impl.js.map +1 -1
  3. package/@wix/ambassador-app-settings-v1-settings/build/cjs/http.impl.js +26 -0
  4. package/@wix/ambassador-app-settings-v1-settings/build/cjs/http.impl.js.map +1 -1
  5. package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.d.ts +29 -0
  6. package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.js +176 -0
  7. package/@wix/ambassador-app-settings-v1-settings/build/cjs/meta.impl.js.map +1 -0
  8. package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/client/proto-generated.d.ts +256 -50
  9. package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/proto-generated.d.ts +129 -25
  10. package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/proto-generated.js +4366 -2869
  11. package/@wix/ambassador-app-settings-v1-settings/build/cjs/proto/server/proto-generated.d.ts +253 -50
  12. package/@wix/ambassador-app-settings-v1-settings/build/cjs/types.impl.d.ts +2 -2
  13. package/@wix/ambassador-app-settings-v1-settings/build/es/builders.impl.js +1 -1
  14. package/@wix/ambassador-app-settings-v1-settings/build/es/builders.impl.js.map +1 -1
  15. package/@wix/ambassador-app-settings-v1-settings/build/es/http.impl.js +26 -0
  16. package/@wix/ambassador-app-settings-v1-settings/build/es/http.impl.js.map +1 -1
  17. package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.d.ts +29 -0
  18. package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.js +146 -0
  19. package/@wix/ambassador-app-settings-v1-settings/build/es/meta.impl.js.map +1 -0
  20. package/@wix/ambassador-app-settings-v1-settings/build/es/types.impl.d.ts +2 -2
  21. package/@wix/ambassador-app-settings-v1-settings/meta/package.json +7 -0
  22. package/@wix/ambassador-app-settings-v1-settings/package.json +6 -3
  23. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/app-settings.proto +15 -2
  24. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/user-preferences.proto +58 -1
  25. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/annotations.proto +19 -1
  26. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/callback.proto +24 -2
  27. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/entity.proto +6 -1
  28. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/subscription.proto +2 -1
  29. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/validations.proto +4 -3
  30. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/http/field_mask.proto +1 -0
  31. package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/spi/definitions.proto +1 -1
  32. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.d.ts +3 -1
  33. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.js +15 -1
  34. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/builders.impl.js.map +1 -1
  35. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.d.ts +1 -0
  36. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.js +2 -1
  37. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/crud/rpc.impl.js.map +1 -1
  38. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.d.ts +17 -1
  39. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.js +44 -1
  40. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/http.impl.js.map +1 -1
  41. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.d.ts +16 -0
  42. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.js +119 -0
  43. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/meta.impl.js.map +1 -0
  44. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/client/proto-generated.d.ts +3229 -341
  45. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/proto-generated.d.ts +1546 -102
  46. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/proto-generated.js +35849 -2496
  47. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/proto/server/proto-generated.d.ts +3258 -371
  48. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.d.ts +2 -1
  49. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.js +14 -1
  50. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/rpc.impl.js.map +1 -1
  51. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/cjs/types.impl.d.ts +6 -0
  52. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.d.ts +3 -1
  53. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.js +12 -0
  54. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/builders.impl.js.map +1 -1
  55. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.d.ts +1 -0
  56. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.js +1 -0
  57. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/crud/rpc.impl.js.map +1 -1
  58. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.d.ts +17 -1
  59. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.js +42 -0
  60. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/http.impl.js.map +1 -1
  61. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.d.ts +16 -0
  62. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.js +92 -0
  63. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/meta.impl.js.map +1 -0
  64. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.d.ts +2 -1
  65. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.js +12 -0
  66. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/rpc.impl.js.map +1 -1
  67. package/@wix/ambassador-data-extensions-v1-data-extension-schema/build/es/types.impl.d.ts +6 -0
  68. package/@wix/ambassador-data-extensions-v1-data-extension-schema/meta/package.json +7 -0
  69. package/@wix/ambassador-data-extensions-v1-data-extension-schema/package.json +6 -3
  70. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/com/wixpress/appservice/api/components_catalog_type.proto +18 -2
  71. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_common.proto +11 -3
  72. 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
  73. 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
  74. 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
  75. 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
  76. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/back_office_extension.proto +5 -0
  77. 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
  78. 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
  79. 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
  80. 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
  81. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/contact_notification.proto +86 -0
  82. 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
  83. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/dev_center_component_test.proto +4 -0
  84. 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
  85. 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
  86. 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
  87. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/editor_addon.proto +29 -7
  88. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/embedded_script.proto +2 -2
  89. 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
  90. 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
  91. 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
  92. 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
  93. 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
  94. 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
  95. 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
  96. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/notification_topic.proto +27 -0
  97. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/notifications_common.proto +242 -0
  98. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page.proto +0 -27
  99. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page_out_of_iframe.proto +2 -0
  100. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/page_replace/page_replace.proto +27 -1
  101. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/plugin-interface.proto +6 -0
  102. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/pricing_plans_form_configuration.proto +107 -0
  103. 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
  104. 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
  105. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/slot.proto +3 -0
  106. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/studio_widget.proto +6 -0
  107. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/shared.proto +24 -0
  108. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/unified_page.proto +48 -0
  109. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/unified_components/unified_widget.proto +26 -0
  110. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/user_notification.proto +91 -0
  111. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/web.proto +8 -2
  112. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/widget_out_of_iframe.proto +2 -0
  113. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data/widget_plugin.proto +17 -2
  114. 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
  115. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/components_catalog_data.proto +59 -12
  116. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/annotations.proto +1 -0
  117. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/subscription.proto +1 -0
  118. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/api/validations.proto +4 -3
  119. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/common/query.proto +120 -4
  120. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/common/tags.proto +55 -0
  121. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema.proto +6 -1
  122. package/@wix/ambassador-data-extensions-v1-data-extension-schema/src/main/proto/wix/infra/dataextensions/v1/data_extension_schema_service.proto +16 -0
  123. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/builders.impl.js +2 -2
  124. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/builders.impl.js.map +1 -1
  125. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/http.impl.js +4 -0
  126. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/http.impl.js.map +1 -1
  127. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.d.ts +21 -0
  128. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.js +100 -0
  129. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/meta.impl.js.map +1 -0
  130. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/client/proto-generated.d.ts +694 -42
  131. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/proto-generated.d.ts +349 -22
  132. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/proto-generated.js +7034 -304
  133. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/proto/server/proto-generated.d.ts +687 -42
  134. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/types.impl.d.ts +0 -1
  135. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/cjs/types.impl.js.map +1 -1
  136. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/builders.impl.js +2 -2
  137. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/builders.impl.js.map +1 -1
  138. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/http.impl.js +4 -0
  139. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/http.impl.js.map +1 -1
  140. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.d.ts +21 -0
  141. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.js +74 -0
  142. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/meta.impl.js.map +1 -0
  143. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/types.impl.d.ts +0 -1
  144. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/build/es/types.impl.js.map +1 -1
  145. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/meta/package.json +7 -0
  146. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/package.json +6 -3
  147. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/catalog_reference.proto +11 -3
  148. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/description_line.proto +2 -2
  149. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/item_data.proto +4 -2
  150. 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
  151. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/product_name.proto +4 -4
  152. 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
  153. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/commons/api/platformQuery.proto +30 -0
  154. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/commons/api/platform_search.proto +23 -0
  155. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/address.proto +1 -0
  156. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/channel_type.proto +2 -0
  157. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/price.proto +1 -1
  158. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/annotations.proto +14 -1
  159. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/callback.proto +2 -2
  160. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/entity.proto +1 -1
  161. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/subscription.proto +2 -1
  162. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/validations.proto +4 -3
  163. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/catalog.proto +141 -7
  164. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/product.proto +2 -2
  165. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v2/collectionRead.proto +25 -1
  166. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/bulk.proto +5 -4
  167. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/query.proto +120 -4
  168. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/tags.proto +55 -0
  169. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/coupons-manager-ui.proto +15 -0
  170. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservice/v1/export.proto +4 -0
  171. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/fedinfra/exportservice/v1/export_service.proto +26 -3
  172. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/infra/asyncjobs/v1/AsyncJobService.proto +1 -0
  173. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/inventory/api/v1/preOrderInfo.proto +6 -6
  174. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payment-methods.proto +5 -2
  175. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/payments.proto +17 -0
  176. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/order-description.proto +5 -2
  177. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/payment-method.proto +12 -4
  178. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/resources/payment.proto +6 -2
  179. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/double-payment-events.proto +26 -0
  180. package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/double-payment-event.proto +18 -0
  181. package/@wix/ambassador-os-tags-v1-tag/build/cjs/builders.impl.js +4 -3
  182. package/@wix/ambassador-os-tags-v1-tag/build/cjs/builders.impl.js.map +1 -1
  183. package/@wix/ambassador-os-tags-v1-tag/build/cjs/http.impl.js +5 -0
  184. package/@wix/ambassador-os-tags-v1-tag/build/cjs/http.impl.js.map +1 -1
  185. package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.d.ts +22 -0
  186. package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.js +119 -0
  187. package/@wix/ambassador-os-tags-v1-tag/build/cjs/meta.impl.js.map +1 -0
  188. package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/client/proto-generated.d.ts +170 -58
  189. package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/proto-generated.d.ts +85 -29
  190. package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/proto-generated.js +3128 -531
  191. package/@wix/ambassador-os-tags-v1-tag/build/cjs/proto/server/proto-generated.d.ts +170 -58
  192. package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.d.ts +6 -0
  193. package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.js +1 -0
  194. package/@wix/ambassador-os-tags-v1-tag/build/cjs/types.impl.js.map +1 -1
  195. package/@wix/ambassador-os-tags-v1-tag/build/es/builders.impl.js +4 -3
  196. package/@wix/ambassador-os-tags-v1-tag/build/es/builders.impl.js.map +1 -1
  197. package/@wix/ambassador-os-tags-v1-tag/build/es/http.impl.js +5 -0
  198. package/@wix/ambassador-os-tags-v1-tag/build/es/http.impl.js.map +1 -1
  199. package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.d.ts +22 -0
  200. package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.js +92 -0
  201. package/@wix/ambassador-os-tags-v1-tag/build/es/meta.impl.js.map +1 -0
  202. package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.d.ts +6 -0
  203. package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js +1 -0
  204. package/@wix/ambassador-os-tags-v1-tag/build/es/types.impl.js.map +1 -1
  205. package/@wix/ambassador-os-tags-v1-tag/meta/package.json +7 -0
  206. package/@wix/ambassador-os-tags-v1-tag/package.json +4 -3
  207. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/annotations.proto +0 -7
  208. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/callback.proto +2 -2
  209. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/entity.proto +1 -1
  210. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/subscription.proto +2 -1
  211. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/validations.proto +3 -0
  212. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/bulk.proto +5 -4
  213. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/data/errors.proto +0 -5
  214. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/query.proto +120 -4
  215. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/tags.proto +2 -2
  216. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tag.proto +4 -1
  217. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tag_exposure.proto +1 -1
  218. package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tags_service.proto +7 -2
  219. package/@wix/bi-logger-cairo-os/dist/cjs/index.js +3 -0
  220. package/@wix/bi-logger-cairo-os/dist/cjs/index.js.map +1 -1
  221. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js +7 -0
  222. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/client-testkit.js.map +1 -1
  223. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js +854 -3
  224. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/common.js.map +1 -1
  225. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js +7 -0
  226. package/@wix/bi-logger-cairo-os/dist/cjs/testkit/node-testkit.js.map +1 -1
  227. package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js +183 -2
  228. package/@wix/bi-logger-cairo-os/dist/cjs/v2/index.js.map +1 -1
  229. package/@wix/bi-logger-cairo-os/dist/esm/index.js +3 -0
  230. package/@wix/bi-logger-cairo-os/dist/esm/index.js.map +1 -1
  231. package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js +7 -0
  232. package/@wix/bi-logger-cairo-os/dist/esm/testkit/client-testkit.js.map +1 -1
  233. package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js +854 -3
  234. package/@wix/bi-logger-cairo-os/dist/esm/testkit/common.js.map +1 -1
  235. package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js +7 -0
  236. package/@wix/bi-logger-cairo-os/dist/esm/testkit/node-testkit.js.map +1 -1
  237. package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js +180 -0
  238. package/@wix/bi-logger-cairo-os/dist/esm/v2/index.js.map +1 -1
  239. package/@wix/bi-logger-cairo-os/dist/types/index.d.ts +3 -2
  240. package/@wix/bi-logger-cairo-os/dist/types/testkit/client-testkit.d.ts +171 -0
  241. package/@wix/bi-logger-cairo-os/dist/types/testkit/node-testkit.d.ts +171 -0
  242. package/@wix/bi-logger-cairo-os/dist/types/types.d.ts +171 -0
  243. package/@wix/bi-logger-cairo-os/dist/types/v2/index.d.ts +179 -1
  244. package/@wix/bi-logger-cairo-os/package.json +2 -2
  245. package/@wix/bi-logger-cairo-os/src/index.ts +6 -2
  246. package/@wix/bi-logger-cairo-os/src/testkit/client-testkit.ts +174 -0
  247. package/@wix/bi-logger-cairo-os/src/testkit/common.ts +854 -3
  248. package/@wix/bi-logger-cairo-os/src/testkit/node-testkit.ts +174 -0
  249. package/@wix/bi-logger-cairo-os/src/types.ts +187 -0
  250. package/@wix/bi-logger-cairo-os/src/v2/index.ts +182 -1
  251. package/@wix/wix-i18n-config/dist/tsconfig.tsbuildinfo +1 -1
  252. package/@wix/wix-i18n-config/package.json +4 -4
  253. package/package.json +3 -3
  254. 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
@@ -4,12 +4,14 @@
4
4
  * Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
5
5
  *
6
6
  * @param {componentDismissedParams} params - The parameters for this event
7
+ * @property {string} appId
7
8
  * @property {string} artifactId - Artifact that owns the component
8
9
  * @property {string} cairoVersion
9
10
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
10
11
  * @property {string} componentType - Picker Modal / Picker Dropdown
11
12
  * @property {GUID} csid
12
13
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
14
+ * @property {boolean} isTPA
13
15
  * @property {string} origin - X button/Cancel button
14
16
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
15
17
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -24,6 +26,7 @@ export function componentDismissed(params) {
24
26
  * Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
25
27
  *
26
28
  * @param {loadMoreParams} params - The parameters for this event
29
+ * @property {string} appId
27
30
  * @property {string} artifactId - Artifact that owns the component
28
31
  * @property {string} cairoVersion
29
32
  * @property {string} componentName - Component name, if there are two components of the same type per artifact
@@ -35,6 +38,7 @@ export function componentDismissed(params) {
35
38
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
36
39
  * @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
37
40
  * @property {number} filteredListSize - How many items are to be presented (filtered)
41
+ * @property {boolean} isTPA
38
42
  * @property {number} loadedItems - How many new items were loaded in this action
39
43
  * @property {number} loadingTime - Component loading time in ms
40
44
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -50,6 +54,7 @@ export function loadMore(params) {
50
54
  * Event description: Sent when a user finish to drag an item
51
55
  *
52
56
  * @param {cairoDragItemEndDropParams} params - The parameters for this event
57
+ * @property {string} appId
53
58
  * @property {string} artifactId - Artifact that owns the component
54
59
  * @property {string} cairoVersion - cairo version
55
60
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -71,6 +76,7 @@ export function loadMore(params) {
71
76
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
72
77
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
73
78
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
79
+ * @property {boolean} isTPA
74
80
  * @property {string} itemId - ID of the item that the user tries to drag
75
81
  * @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
76
82
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -90,6 +96,7 @@ export function cairoDragItemEndDrop(params) {
90
96
  *
91
97
  * @param {pickerPickerOpenButtonParams} params - The parameters for this event
92
98
  * @property {string} action - Any picker button option (render/hover/click)
99
+ * @property {string} appId
93
100
  * @property {string} artifactId - Artifact that owns the component
94
101
  * @property {string} cairoVersion
95
102
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -98,6 +105,7 @@ export function cairoDragItemEndDrop(params) {
98
105
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
99
106
  * @property {number} filteredListSize - How many items are to presented (filtered)
100
107
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
108
+ * @property {boolean} isTPA
101
109
  * @property {number} listSize - How many items exist (full list)
102
110
  * @property {number} maxItems - Max items to select in picker
103
111
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -114,6 +122,7 @@ export function pickerPickerOpenButton(params) {
114
122
  * 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.
115
123
  *
116
124
  * @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
125
+ * @property {string} appId
117
126
  * @property {string} artifactId - Artifact that owns the component
118
127
  * @property {string} cairoVersion - Cairo version
119
128
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -122,6 +131,7 @@ export function pickerPickerOpenButton(params) {
122
131
  * @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)
123
132
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
124
133
  * @property {string} feature - Filters / Drag and Drop
134
+ * @property {boolean} isTPA
125
135
  * @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)
126
136
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
127
137
  * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
@@ -139,6 +149,7 @@ export function cairoDiscardChangesBeforeApply(params) {
139
149
  * Event description: Sent when a user select/deselects an item(s) in a list
140
150
  *
141
151
  * @param {cairoItemSelectionToggledParams} params - The parameters for this event
152
+ * @property {string} appId
142
153
  * @property {string} artifactId - Artifact that owns the component
143
154
  * @property {string} cairoVersion
144
155
  * @property {string} clickType - The click purpose : "Selection" / "Deselection"
@@ -156,6 +167,7 @@ export function cairoDiscardChangesBeforeApply(params) {
156
167
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
157
168
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
158
169
  * @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").
170
+ * @property {boolean} isTPA
159
171
  * @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
160
172
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
161
173
  * ** isSelectAll = TRUE --> itemIndex = 0
@@ -180,6 +192,7 @@ export function cairoItemSelectionToggled(params) {
180
192
  * Event description: Cairo picker finished loading
181
193
  *
182
194
  * @param {pickerEndLoadParams} params - The parameters for this event
195
+ * @property {string} appId
183
196
  * @property {string} artifactId - Artifact that owns the component
184
197
  * @property {string} cairoVersion
185
198
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -188,6 +201,7 @@ export function cairoItemSelectionToggled(params) {
188
201
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
189
202
  * @property {number} filteredListSize - How many items are to presented (filtered)
190
203
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
204
+ * @property {boolean} isTPA
191
205
  * @property {number} listSize - How many items exist (full list)
192
206
  * @property {number} loadingTime - ms
193
207
  * @property {number} maxItems - Max items to select in picker
@@ -205,6 +219,7 @@ export function pickerEndLoad(params) {
205
219
  * 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)
206
220
  *
207
221
  * @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
222
+ * @property {string} appId
208
223
  * @property {string} artifactId - Artifact that owns the component
209
224
  * @property {string} cairoVersion - cairo version
210
225
  * @property {string} clickType - The click purpose : "Collapse" / "Expand"
@@ -221,6 +236,7 @@ export function pickerEndLoad(params) {
221
236
  * @property {number} filteredListSize - How many items are to be presented (filtered)
222
237
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
223
238
  * @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
239
+ * @property {boolean} isTPA
224
240
  * @property {string} itemId - ID of the clicked item .If "Is select all"= true, then Null
225
241
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If "Is select all"= true, then Null
226
242
  * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
@@ -238,6 +254,7 @@ export function cairoNestedTableCollapseAndExpand(params) {
238
254
  * Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
239
255
  *
240
256
  * @param {loadEndParams} params - The parameters for this event
257
+ * @property {string} appId
241
258
  * @property {string} artifactId - Artifact that owns the component
242
259
  * @property {string} cairoVersion
243
260
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -252,6 +269,7 @@ export function cairoNestedTableCollapseAndExpand(params) {
252
269
  * @property {number} filteredListSize - How many items are to be presented (filtered)
253
270
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
254
271
  * @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
272
+ * @property {boolean} isTPA
255
273
  * @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
256
274
  * @property {number} loadingTime - Component loading time in ms
257
275
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -269,6 +287,7 @@ export function loadEnd(params) {
269
287
  *
270
288
  * @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
271
289
  * @property {string} actionName - Add / Delete / Rename
290
+ * @property {string} appId
272
291
  * @property {string} artifactId - Artifact that owns the component
273
292
  * @property {string} cairoVersion - Cairo version
274
293
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -276,6 +295,7 @@ export function loadEnd(params) {
276
295
  * @property {GUID} csid - Cairo session ID
277
296
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
278
297
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
298
+ * @property {boolean} isTPA
279
299
  * @property {number} numTags - How many tags are in the modal after this action?
280
300
  * @property {string} origin - Where did the user make the action from? Tags Modal /
281
301
  * @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
@@ -293,6 +313,7 @@ export function cairoTagsAddDeleteTag(params) {
293
313
  * Event description: Sent when the export process begins
294
314
  *
295
315
  * @param {cairoExportProcessStartParams} params - The parameters for this event
316
+ * @property {string} appId
296
317
  * @property {string} artifactId - Artifact that owns the component
297
318
  * @property {string} cairoVersion
298
319
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -300,6 +321,7 @@ export function cairoTagsAddDeleteTag(params) {
300
321
  * @property {GUID} csid
301
322
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
302
323
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
324
+ * @property {boolean} isTPA
303
325
  * @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.
304
326
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
305
327
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -317,6 +339,7 @@ export function cairoExportProcessStart(params) {
317
339
  * Event description: Sent when the user clicks a CTA in the "Export Failed" modal
318
340
  *
319
341
  * @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
342
+ * @property {string} appId
320
343
  * @property {string} artifactId - Artifact that owns the component
321
344
  * @property {string} cairoVersion
322
345
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -325,6 +348,7 @@ export function cairoExportProcessStart(params) {
325
348
  * @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)
326
349
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
327
350
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
351
+ * @property {boolean} isTPA
328
352
  * @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
329
353
  * @property {number} numItemsExported - How many items were exported before the export failed.
330
354
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -343,6 +367,7 @@ export function cairoExportFailedModalCtaClicked(params) {
343
367
  * 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.
344
368
  *
345
369
  * @param {cairoSearchViewInViewsParams} params - The parameters for this event
370
+ * @property {string} appId
346
371
  * @property {string} artifactId - Artifact that owns the component
347
372
  * @property {string} cairoVersion - Cairo version
348
373
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -350,6 +375,7 @@ export function cairoExportFailedModalCtaClicked(params) {
350
375
  * @property {GUID} csid
351
376
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
352
377
  * @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).
378
+ * @property {boolean} isTPA
353
379
  * @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are from type of "categories"?
354
380
  * @property {number} numViews - The distinct views IDs the users has when he searches a view
355
381
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -367,6 +393,7 @@ export function cairoSearchViewInViews(params) {
367
393
  * Event description: Cairo picker starts loading
368
394
  *
369
395
  * @param {pickerStartLoadParams} params - The parameters for this event
396
+ * @property {string} appId
370
397
  * @property {string} artifactId - Artifact that owns the component
371
398
  * @property {string} cairoVersion
372
399
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -375,6 +402,7 @@ export function cairoSearchViewInViews(params) {
375
402
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
376
403
  * @property {number} filteredListSize - How many items are to presented (filtered)
377
404
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
405
+ * @property {boolean} isTPA
378
406
  * @property {number} listSize - How many items exist (full list)
379
407
  * @property {number} maxItems - Max items to select in picker
380
408
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -392,6 +420,7 @@ export function pickerStartLoad(params) {
392
420
  *
393
421
  * @param {loadStartParams} params - The parameters for this event
394
422
  * @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
423
+ * @property {string} appId
395
424
  * @property {string} artifactId - Artifact that owns the component
396
425
  * @property {string} cairoVersion - cairo version
397
426
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -403,6 +432,7 @@ export function pickerStartLoad(params) {
403
432
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
404
433
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
405
434
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
435
+ * @property {boolean} isTPA
406
436
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
407
437
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
408
438
  * @property {Url} url - The page's url (new from 03/2023)
@@ -417,12 +447,14 @@ export function loadStart(params) {
417
447
  * Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
418
448
  *
419
449
  * @param {pikachuItemCategorySelectedParams} params - The parameters for this event
450
+ * @property {string} appId
420
451
  * @property {string} artifactId - Artifact that owns the component
421
452
  * @property {string} cairoVersion
422
453
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
423
454
  * @property {string} componentType
424
455
  * @property {GUID} csid
425
456
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
457
+ * @property {boolean} isTPA
426
458
  * @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
427
459
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
428
460
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -437,6 +469,7 @@ export function pikachuItemCategorySelected(params) {
437
469
  * Event description: Sent when a user clicks the "Export" CTA in a Cairo component
438
470
  *
439
471
  * @param {cairoExportCtaClickedParams} params - The parameters for this event
472
+ * @property {string} appId
440
473
  * @property {string} artifactId - Artifact that owns the component
441
474
  * @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}
442
475
  * @property {string} cairoVersion
@@ -447,6 +480,7 @@ export function pikachuItemCategorySelected(params) {
447
480
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
448
481
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
449
482
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
483
+ * @property {boolean} isTPA
450
484
  * @property {number} numSelectedItems - How many items does the user wish to export
451
485
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
452
486
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -461,6 +495,7 @@ export function cairoExportCtaClicked(params) {
461
495
  * Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
462
496
  *
463
497
  * @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
498
+ * @property {string} appId
464
499
  * @property {string} artifactId - Artifact that owns the component
465
500
  * @property {string} cairoVersion
466
501
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -470,6 +505,7 @@ export function cairoExportCtaClicked(params) {
470
505
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
471
506
  * @property {number} duration - How much time (in ms) did it take since the export process began
472
507
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
508
+ * @property {boolean} isTPA
473
509
  * @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
474
510
  * @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.
475
511
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
@@ -489,12 +525,14 @@ export function cairoCancelExportModalCtaClicked(params) {
489
525
  * 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)
490
526
  *
491
527
  * @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
528
+ * @property {string} appId
492
529
  * @property {string} artifactId - Artifact that owns the component
493
530
  * @property {string} cairoVersion - Cairo version
494
531
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
495
532
  * @property {string} componentType - Table/Cards / Picker
496
533
  * @property {GUID} csid - Cairo session ID
497
534
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
535
+ * @property {boolean} isTPA
498
536
  * @property {number} numOfActions - Number of changed fields that their changes can be lost
499
537
  * @property {number} numOfFields - How many fields are there that can be change in this page?
500
538
  * @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
@@ -512,6 +550,7 @@ export function cairoPageDiscardChangesBeforeSave(params) {
512
550
  * Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
513
551
  *
514
552
  * @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
553
+ * @property {string} appId
515
554
  * @property {string} artifactId - Artifact that owns the component
516
555
  * @property {string} cairoVersion
517
556
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -521,6 +560,7 @@ export function cairoPageDiscardChangesBeforeSave(params) {
521
560
  * @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
522
561
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
523
562
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
563
+ * @property {boolean} isTPA
524
564
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
525
565
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
526
566
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -529,12 +569,42 @@ export function cairoPageDiscardChangesBeforeSave(params) {
529
569
  export function cairoFileDownloadToastDownloadButtonClicked(params) {
530
570
  return { evid: 134, src: 144, endpoint: 'cairo-os', params: params };
531
571
  }
572
+ /**
573
+ * A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
574
+ *
575
+ * 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.
576
+ *
577
+ * @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
578
+ * @property {string} actionName - Visibility / Reorder
579
+ * @property {string} appId
580
+ * @property {string} artifactId - Artifact that owns the component
581
+ * @property {string} cairoVersion - version
582
+ * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
583
+ * @property {string} componentType - Table/Cards
584
+ * @property {GUID} csid - cairo session id
585
+ * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
586
+ * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
587
+ * @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)
588
+ * @property {boolean} isTPA
589
+ * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
590
+ * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
591
+ * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
592
+ * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
593
+ * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
594
+ * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
595
+ * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
596
+ * @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
597
+ */
598
+ export function cairoCustomizeColumnsInSidePanel(params) {
599
+ return { evid: 177, src: 144, endpoint: 'cairo-os', params: params };
600
+ }
532
601
  /**
533
602
  * A function to create a log object for the 'cairoTabSelected' event (evid: 121)
534
603
  *
535
604
  * Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
536
605
  *
537
606
  * @param {cairoTabSelectedParams} params - The parameters for this event
607
+ * @property {string} appId
538
608
  * @property {string} artifactId - Artifact that owns the component
539
609
  * @property {string} cairoVersion
540
610
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -543,6 +613,7 @@ export function cairoFileDownloadToastDownloadButtonClicked(params) {
543
613
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
544
614
  * @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
545
615
  * @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
616
+ * @property {boolean} isTPA
546
617
  * @property {string} newTabId - Name of the newly selected tab
547
618
  * @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
548
619
  * @property {number} numTabs - How many tabs are dispalyed to the user
@@ -562,6 +633,7 @@ export function cairoTabSelected(params) {
562
633
  *
563
634
  * @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
564
635
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
636
+ * @property {string} appId
565
637
  * @property {string} artifactId - Artifact that owns the component
566
638
  * @property {string} cairoVersion - cairo version
567
639
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -576,6 +648,7 @@ export function cairoTabSelected(params) {
576
648
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
577
649
  * @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.
578
650
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
651
+ * @property {boolean} isTPA
579
652
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
580
653
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
581
654
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -593,6 +666,7 @@ export function cairoViewsUnsuccessfulUpdateInServer(params) {
593
666
  * Event description: Sent when a user clicks on a CTA in an an opened modal
594
667
  *
595
668
  * @param {cairoModalCtaClickedParams} params - The parameters for this event
669
+ * @property {string} appId
596
670
  * @property {string} artifactId - Artifact that owns the component
597
671
  * @property {string} cairoVersion - cairo version
598
672
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -600,6 +674,7 @@ export function cairoViewsUnsuccessfulUpdateInServer(params) {
600
674
  * @property {GUID} csid - Cairo session id
601
675
  * @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
602
676
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
677
+ * @property {boolean} isTPA
603
678
  * @property {string} localizedCtaName - The CTA name, localized
604
679
  * @property {string} modalName - The modal's title (Archive custom field, etc.)
605
680
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -615,6 +690,7 @@ export function cairoModalCtaClicked(params) {
615
690
  * Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
616
691
  *
617
692
  * @param {cairoAllFiltersClearedParams} params - The parameters for this event
693
+ * @property {string} appId
618
694
  * @property {string} artifactId - Artifact that owns the component
619
695
  * @property {string} cairoVersion
620
696
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -623,6 +699,7 @@ export function cairoModalCtaClicked(params) {
623
699
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
624
700
  * @property {string} filterNames - Comma separated list of filter names that have been cleared
625
701
  * @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
702
+ * @property {boolean} isTPA
626
703
  * @property {number} numFiltersCleared - How many filters have been cleared
627
704
  * @property {string} origin - "sidebar"/"toolbar"
628
705
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -638,6 +715,7 @@ export function cairoAllFiltersCleared(params) {
638
715
  * 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.
639
716
  *
640
717
  * @param {cairoCtaClickedParams} params - The parameters for this event
718
+ * @property {string} appId
641
719
  * @property {string} artifactId - Artifact that owns the component
642
720
  * @property {string} cairoVersion
643
721
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -649,6 +727,7 @@ export function cairoAllFiltersCleared(params) {
649
727
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
650
728
  * @property {number} filteredListSize - How many items are to be presented (filtered)
651
729
  * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
730
+ * @property {boolean} isTPA
652
731
  * @property {string} itemId - ID of the item that the user clicked on its CTA
653
732
  * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
654
733
  * @property {string} localizedCtaName - The CTA name, localized
@@ -672,6 +751,7 @@ export function cairoCtaClicked(params) {
672
751
  * 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.
673
752
  *
674
753
  * @param {cairoChangesBeforeApplyParams} params - The parameters for this event
754
+ * @property {string} appId
675
755
  * @property {string} artifactId - Artifact that owns the component
676
756
  * @property {string} cairoVersion - Cairo version
677
757
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -682,6 +762,7 @@ export function cairoCtaClicked(params) {
682
762
  * @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
683
763
  * @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
684
764
  * @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
765
+ * @property {boolean} isTPA
685
766
  * @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)
686
767
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
687
768
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -697,12 +778,14 @@ export function cairoChangesBeforeApply(params) {
697
778
  *
698
779
  * @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
699
780
  * @property {string} actionName - Assign tags / Create tags / Manage tags
781
+ * @property {string} appId
700
782
  * @property {string} artifactId - Artifact that owns the component
701
783
  * @property {string} cairoVersion - Cairo version
702
784
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
703
785
  * @property {string} componentType - Component type
704
786
  * @property {GUID} csid - Cairo session ID
705
787
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
788
+ * @property {boolean} isTPA
706
789
  * @property {string} itemId - The entity ID
707
790
  * @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
708
791
  * @property {number} numTagsAssigned - How many tags are already assigned to that item?
@@ -720,6 +803,7 @@ export function cairoTagsWidgetClickOnCta(params) {
720
803
  *
721
804
  * @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
722
805
  * @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
806
+ * @property {string} appId
723
807
  * @property {string} artifactId - Artifact that owns the component
724
808
  * @property {string} cairoVersion - cairo version
725
809
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -729,6 +813,7 @@ export function cairoTagsWidgetClickOnCta(params) {
729
813
  * @property {string} errorType - What is the type of the error? Technical issue / Network error / 10k Limitation
730
814
  * @property {string} fieldName - The name the user typed
731
815
  * @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
816
+ * @property {boolean} isTPA
732
817
  * @property {string} key - The key value
733
818
  * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
734
819
  * @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.
@@ -745,6 +830,7 @@ export function cairoDataExtensionUnsuccessfulUpdateInServer(params) {
745
830
  * Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
746
831
  *
747
832
  * @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
833
+ * @property {string} appId
748
834
  * @property {string} artifactId - Artifact that owns the component
749
835
  * @property {string} cairoVersion - cairo version
750
836
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -759,6 +845,7 @@ export function cairoDataExtensionUnsuccessfulUpdateInServer(params) {
759
845
  * InitCustomFieldsDataExtensionFailed /
760
846
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
761
847
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
848
+ * @property {boolean} isTPA
762
849
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
763
850
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
764
851
  * @property {Url} url - The page's url
@@ -773,6 +860,7 @@ export function cairoErrorInLoadingAComponent(params) {
773
860
  * Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
774
861
  *
775
862
  * @param {cairoReloadErrorStateParams} params - The parameters for this event
863
+ * @property {string} appId
776
864
  * @property {string} artifactId - Artifact that owns the component
777
865
  * @property {string} cairoVersion - cairo version
778
866
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -788,6 +876,7 @@ export function cairoErrorInLoadingAComponent(params) {
788
876
  * InitCustomFieldsDataExtensionFailed /
789
877
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
790
878
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
879
+ * @property {boolean} isTPA
791
880
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
792
881
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
793
882
  * @property {Url} url - The page's url
@@ -802,6 +891,7 @@ export function cairoReloadErrorState(params) {
802
891
  * Event description: Sent when the "create new" process ends (and the result is shown to the user)
803
892
  *
804
893
  * @param {newItemCreationEndParams} params - The parameters for this event
894
+ * @property {string} appId
805
895
  * @property {string} artifactId - Artifact that owns the component
806
896
  * @property {string} cairoVersion
807
897
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -811,6 +901,7 @@ export function cairoReloadErrorState(params) {
811
901
  * @property {string} currentSortOrder - sort order
812
902
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
813
903
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
904
+ * @property {boolean} isTPA
814
905
  * @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
815
906
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
816
907
  * @property {number} maxItems - Max number of items that can be selected
@@ -835,12 +926,14 @@ export function newItemCreationEnd(params) {
835
926
  * Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
836
927
  *
837
928
  * @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
929
+ * @property {string} appId
838
930
  * @property {string} artifactId - Artifact that owns the component
839
931
  * @property {string} cairoVersion - Cairo version
840
932
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
841
933
  * @property {string} componentType - Component type
842
934
  * @property {GUID} csid - Cairo session ID
843
935
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
936
+ * @property {boolean} isTPA
844
937
  * @property {string} itemId - The entity ID (that the widget was loaded in its page)
845
938
  * @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
846
939
  * @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
@@ -857,6 +950,7 @@ export function cairoTagsWidgetLoaded(params) {
857
950
  * Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
858
951
  *
859
952
  * @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
953
+ * @property {string} appId
860
954
  * @property {string} artifactId - Artifact that owns the component
861
955
  * @property {string} cairoVersion
862
956
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -866,6 +960,7 @@ export function cairoTagsWidgetLoaded(params) {
866
960
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
867
961
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
868
962
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
963
+ * @property {boolean} isTPA
869
964
  * @property {string} notificationText - What is displayed to the user, localized
870
965
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
871
966
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -880,6 +975,7 @@ export function cairoTableTopNotificationDismissed(params) {
880
975
  * Event description: Send when a user click on a section CTA (show more / show less etc.)
881
976
  *
882
977
  * @param {cairoSectionCtaClickedParams} params - The parameters for this event
978
+ * @property {string} appId
883
979
  * @property {string} artifactId - Artifact that owns the component
884
980
  * @property {string} cairoVersion - Cairo version
885
981
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -889,6 +985,7 @@ export function cairoTableTopNotificationDismissed(params) {
889
985
  * @property {string} ctaName - cta key (show more / show less etc.)
890
986
  * @property {string} ctaType - Main / Secondary / More actions
891
987
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
988
+ * @property {boolean} isTPA
892
989
  * @property {string} localizedCtaName - The CTA name, localized
893
990
  * @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
894
991
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -905,6 +1002,7 @@ export function cairoSectionCtaClicked(params) {
905
1002
  * Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
906
1003
  *
907
1004
  * @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
1005
+ * @property {string} appId
908
1006
  * @property {string} artifactId - Artifact that owns the component
909
1007
  * @property {string} cairoVersion
910
1008
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -913,6 +1011,7 @@ export function cairoSectionCtaClicked(params) {
913
1011
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
914
1012
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
915
1013
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1014
+ * @property {boolean} isTPA
916
1015
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
917
1016
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
918
1017
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -928,12 +1027,14 @@ export function cairoFileDownloadToastDisplayed(params) {
928
1027
  * 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.
929
1028
  *
930
1029
  * @param {cairoSearchResultsParams} params - The parameters for this event
1030
+ * @property {string} appId
931
1031
  * @property {string} artifactId - Artifact that owns the component
932
1032
  * @property {string} cairoVersion
933
1033
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
934
1034
  * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
935
1035
  * @property {GUID} csid
936
1036
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1037
+ * @property {boolean} isTPA
937
1038
  * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
938
1039
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
939
1040
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -950,6 +1051,7 @@ export function cairoSearchResults(params) {
950
1051
  * Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
951
1052
  *
952
1053
  * @param {cairoTagsModalEndProcessParams} params - The parameters for this event
1054
+ * @property {string} appId
953
1055
  * @property {string} artifactId - Artifact that owns the component
954
1056
  * @property {string} cairoVersion - Cairo version
955
1057
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -957,6 +1059,7 @@ export function cairoSearchResults(params) {
957
1059
  * @property {GUID} csid - Cairo session ID
958
1060
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
959
1061
  * @property {string} endType - Close without changes
1062
+ * @property {boolean} isTPA
960
1063
  * @property {number} numTags - How many tags are in the modal?
961
1064
  * @property {string} origin - Where did the user open Manage Tags modal from?
962
1065
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -972,6 +1075,7 @@ export function cairoTagsModalEndProcess(params) {
972
1075
  * Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
973
1076
  *
974
1077
  * @param {cairoManageViewClickedParams} params - The parameters for this event
1078
+ * @property {string} appId
975
1079
  * @property {string} artifactId - Artifact that owns the component
976
1080
  * @property {string} cairoVersion - Cairo version
977
1081
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -980,6 +1084,7 @@ export function cairoTagsModalEndProcess(params) {
980
1084
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
981
1085
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
982
1086
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1087
+ * @property {boolean} isTPA
983
1088
  * @property {number} numFiltersInView - How many filters comprise the saved view
984
1089
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
985
1090
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -994,12 +1099,14 @@ export function cairoManageViewClicked(params) {
994
1099
  * Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
995
1100
  *
996
1101
  * @param {cairoTagsModalStartLoadParams} params - The parameters for this event
1102
+ * @property {string} appId
997
1103
  * @property {string} artifactId - Artifact that owns the component
998
1104
  * @property {string} cairoVersion - Cairo version
999
1105
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1000
1106
  * @property {string} componentType - Component type
1001
1107
  * @property {GUID} csid - Cairo session ID
1002
1108
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1109
+ * @property {boolean} isTPA
1003
1110
  * @property {number} numTags - How many tags are to be presented?
1004
1111
  * @property {string} origin - Where did the user open Manage Tags modal from?
1005
1112
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1016,6 +1123,7 @@ export function cairoTagsModalStartLoad(params) {
1016
1123
  *
1017
1124
  * @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
1018
1125
  * @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)
1126
+ * @property {string} appId
1019
1127
  * @property {string} artifactId - Artifact that owns the component
1020
1128
  * @property {string} cairoVersion - cairo version
1021
1129
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1030,6 +1138,7 @@ export function cairoTagsModalStartLoad(params) {
1030
1138
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1031
1139
  * @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.
1032
1140
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
1141
+ * @property {boolean} isTPA
1033
1142
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
1034
1143
  * @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
1035
1144
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1052,6 +1161,7 @@ export function cairoSortUnsuccessfulUpdateInServer(params) {
1052
1161
  * Event description: Sent when user changes selection in the Cairo export modal
1053
1162
  *
1054
1163
  * @param {cairoItemToggledInExportModalParams} params - The parameters for this event
1164
+ * @property {string} appId
1055
1165
  * @property {string} artifactId - Artifact that owns the component
1056
1166
  * @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}
1057
1167
  * @property {string} cairoVersion
@@ -1061,6 +1171,7 @@ export function cairoSortUnsuccessfulUpdateInServer(params) {
1061
1171
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1062
1172
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1063
1173
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1174
+ * @property {boolean} isTPA
1064
1175
  * @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
1065
1176
  * @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
1066
1177
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1076,6 +1187,7 @@ export function cairoItemToggledInExportModal(params) {
1076
1187
  * Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
1077
1188
  *
1078
1189
  * @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
1190
+ * @property {string} appId
1079
1191
  * @property {string} artifactId - Artifact that owns the component
1080
1192
  * @property {string} cairoVersion - cairo version
1081
1193
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1088,6 +1200,7 @@ export function cairoItemToggledInExportModal(params) {
1088
1200
  * @property {number} filteredListSize - How many items are to be presented (filtered)?
1089
1201
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1090
1202
  * @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.
1203
+ * @property {boolean} isTPA
1091
1204
  * @property {string} itemId - ID of the item that the user tries to drag
1092
1205
  * @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
1093
1206
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -1113,6 +1226,7 @@ export function cairoDragActionUnsuccessfulUpdateInServer(params) {
1113
1226
  * Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
1114
1227
  *
1115
1228
  * @param {cairoSearchForTagsParams} params - The parameters for this event
1229
+ * @property {string} appId
1116
1230
  * @property {string} artifactId - Artifact that owns the component
1117
1231
  * @property {string} cairoVersion - Cairo version
1118
1232
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1120,6 +1234,7 @@ export function cairoDragActionUnsuccessfulUpdateInServer(params) {
1120
1234
  * @property {GUID} csid - Cairo session id
1121
1235
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1122
1236
  * @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
1237
+ * @property {boolean} isTPA
1123
1238
  * @property {string} location - Where did the user search for the tag? Manage tags modal /
1124
1239
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1125
1240
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1138,6 +1253,7 @@ export function cairoSearchForTags(params) {
1138
1253
  * @param {cairoManageViewActionSelectedParams} params - The parameters for this event
1139
1254
  * @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
1140
1255
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
1256
+ * @property {string} appId
1141
1257
  * @property {string} artifactId - Artifact that owns the component
1142
1258
  * @property {string} cairoVersion - cairo version
1143
1259
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1145,6 +1261,7 @@ export function cairoSearchForTags(params) {
1145
1261
  * @property {GUID} csid
1146
1262
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1147
1263
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1264
+ * @property {boolean} isTPA
1148
1265
  * @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
1149
1266
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1150
1267
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1159,12 +1276,14 @@ export function cairoManageViewActionSelected(params) {
1159
1276
  * Event description: Send when a user click on "Learn More" from Cairo component.
1160
1277
  *
1161
1278
  * @param {cairoLearnMoreParams} params - The parameters for this event
1279
+ * @property {string} appId
1162
1280
  * @property {string} artifactId - Artifact that owns the component
1163
1281
  * @property {string} cairoVersion - Cairo version
1164
1282
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1165
1283
  * @property {string} componentType - Section name (Folders)
1166
1284
  * @property {GUID} csid - Cairo session ID
1167
1285
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1286
+ * @property {boolean} isTPA
1168
1287
  * @property {string} origin - Where did the user click on "Learn more" from? Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
1169
1288
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1170
1289
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1180,6 +1299,7 @@ export function cairoLearnMore(params) {
1180
1299
  *
1181
1300
  * @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
1182
1301
  * @property {string} actionName - Assign / Remove
1302
+ * @property {string} appId
1183
1303
  * @property {string} artifactId - Artifact that owns the component
1184
1304
  * @property {string} assignedTags - array of tags that were assigned (empty array if none)
1185
1305
  * @property {string} cairoVersion - Cairo version
@@ -1188,6 +1308,7 @@ export function cairoLearnMore(params) {
1188
1308
  * @property {GUID} csid - Cairo session ID
1189
1309
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1190
1310
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
1311
+ * @property {boolean} isTPA
1191
1312
  * @property {string} itemIds - array of items ids that were selected
1192
1313
  * @property {number} numItems - How many items have been selected?
1193
1314
  * @property {string} origin - Where did the user make the action from?
@@ -1205,6 +1326,7 @@ export function cairoAssignTagsToEntities(params) {
1205
1326
  * Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
1206
1327
  *
1207
1328
  * @param {cairoPageCtaClickedParams} params - The parameters for this event
1329
+ * @property {string} appId
1208
1330
  * @property {string} artifactId - Artifact that owns the component
1209
1331
  * @property {string} cairoVersion - Cairo version
1210
1332
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1213,6 +1335,7 @@ export function cairoAssignTagsToEntities(params) {
1213
1335
  * @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
1214
1336
  * @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
1215
1337
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1338
+ * @property {boolean} isTPA
1216
1339
  * @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
1217
1340
  * @property {string} location - CTA location: TBD
1218
1341
  * @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
@@ -1232,6 +1355,7 @@ export function cairoPageCtaClicked(params) {
1232
1355
  * Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
1233
1356
  *
1234
1357
  * @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
1358
+ * @property {string} appId
1235
1359
  * @property {string} artifactId - Artifact that owns the component
1236
1360
  * @property {string} cairoVersion
1237
1361
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1239,6 +1363,7 @@ export function cairoPageCtaClicked(params) {
1239
1363
  * @property {GUID} csid
1240
1364
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1241
1365
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1366
+ * @property {boolean} isTPA
1242
1367
  * @property {string} notificationText - What is displayed to the user, localized
1243
1368
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1244
1369
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1254,6 +1379,7 @@ export function cairoTableTopNotificationDisplayed(params) {
1254
1379
  *
1255
1380
  * @param {cairoTryAgainClickedParams} params - The parameters for this event
1256
1381
  * @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
1382
+ * @property {string} appId
1257
1383
  * @property {string} artifactId - Artifact that owns the component
1258
1384
  * @property {string} cairoVersion - cairo version
1259
1385
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1262,6 +1388,7 @@ export function cairoTableTopNotificationDisplayed(params) {
1262
1388
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1263
1389
  * @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
1264
1390
  * @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
1391
+ * @property {boolean} isTPA
1265
1392
  * @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
1266
1393
  * @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
1267
1394
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1277,6 +1404,7 @@ export function cairoTryAgainClicked(params) {
1277
1404
  * 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.
1278
1405
  *
1279
1406
  * @param {cairoFiltersPanelUsedParams} params - The parameters for this event
1407
+ * @property {string} appId
1280
1408
  * @property {string} artifactId - Artifact that owns the component
1281
1409
  * @property {string} cairoVersion
1282
1410
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1288,6 +1416,7 @@ export function cairoTryAgainClicked(params) {
1288
1416
  * @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
1289
1417
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
1290
1418
  * @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)
1419
+ * @property {boolean} isTPA
1291
1420
  * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
1292
1421
  * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
1293
1422
  * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
@@ -1308,6 +1437,7 @@ export function cairoFiltersPanelUsed(params) {
1308
1437
  * Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
1309
1438
  *
1310
1439
  * @param {cairoDragItemParams} params - The parameters for this event
1440
+ * @property {string} appId
1311
1441
  * @property {string} artifactId - Artifact that owns the component
1312
1442
  * @property {string} cairoVersion - cairo version
1313
1443
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1323,6 +1453,7 @@ export function cairoFiltersPanelUsed(params) {
1323
1453
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1324
1454
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
1325
1455
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
1456
+ * @property {boolean} isTPA
1326
1457
  * @property {string} itemId - ID of the item that the user tries to drag.
1327
1458
  * @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
1328
1459
  * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
@@ -1340,6 +1471,7 @@ export function cairoDragItem(params) {
1340
1471
  * 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).
1341
1472
  *
1342
1473
  * @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
1474
+ * @property {string} appId
1343
1475
  * @property {string} artifactId - Artifact that owns the component
1344
1476
  * @property {string} cairoVersion
1345
1477
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1350,6 +1482,7 @@ export function cairoDragItem(params) {
1350
1482
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
1351
1483
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1352
1484
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1485
+ * @property {boolean} isTPA
1353
1486
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
1354
1487
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1355
1488
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1364,6 +1497,7 @@ export function cairoFileDownloadToastDismissed(params) {
1364
1497
  * Event description: Sent when the user tries to cancel the export process AFTER it has begun
1365
1498
  *
1366
1499
  * @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
1500
+ * @property {string} appId
1367
1501
  * @property {string} artifactId - Artifact that owns the component
1368
1502
  * @property {string} cairoVersion
1369
1503
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1372,6 +1506,7 @@ export function cairoFileDownloadToastDismissed(params) {
1372
1506
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1373
1507
  * @property {number} duration - How much time (in ms) did it take since the export process began
1374
1508
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1509
+ * @property {boolean} isTPA
1375
1510
  * @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.
1376
1511
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
1377
1512
  * @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
@@ -1391,6 +1526,7 @@ export function cairoUserAttemptsToCancelTheExport(params) {
1391
1526
  * Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
1392
1527
  *
1393
1528
  * @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
1529
+ * @property {string} appId
1394
1530
  * @property {string} artifactId - Artifact that owns the component
1395
1531
  * @property {string} cairoVersion
1396
1532
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1400,6 +1536,7 @@ export function cairoUserAttemptsToCancelTheExport(params) {
1400
1536
  * @property {number} filteredListSize - How many items are to presented (filtered)
1401
1537
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1402
1538
  * @property {boolean} isImmediate - Is it an immediate CTA
1539
+ * @property {boolean} isTPA
1403
1540
  * @property {number} itemsCnt - Number of total items picked
1404
1541
  * @property {number} listSize - How many items exist (full list)
1405
1542
  * @property {number} maxItems - Max items to select in picker
@@ -1417,6 +1554,7 @@ export function pickerPickModalCtaButtonClickOrImmediateCta(params) {
1417
1554
  * Event description: Sent when the user clicks the "create new" button
1418
1555
  *
1419
1556
  * @param {newItemCreationStartParams} params - The parameters for this event
1557
+ * @property {string} appId
1420
1558
  * @property {string} artifactId - Artifact that owns the component
1421
1559
  * @property {string} cairoVersion
1422
1560
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1426,6 +1564,7 @@ export function pickerPickModalCtaButtonClickOrImmediateCta(params) {
1426
1564
  * @property {string} currentSortOrder - sorts
1427
1565
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
1428
1566
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1567
+ * @property {boolean} isTPA
1429
1568
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
1430
1569
  * @property {number} maxItems - Max number of items that can be selected
1431
1570
  * @property {number} numColumns - columns
@@ -1448,6 +1587,7 @@ export function newItemCreationStart(params) {
1448
1587
  * Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
1449
1588
  *
1450
1589
  * @param {cairoViewSelectedParams} params - The parameters for this event
1590
+ * @property {string} appId
1451
1591
  * @property {string} artifactId - Artifact that owns the component
1452
1592
  * @property {string} cairoVersion
1453
1593
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1460,6 +1600,7 @@ export function newItemCreationStart(params) {
1460
1600
  * @property {boolean} isDefault - Is the selected view defined as default view?
1461
1601
  * @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
1462
1602
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1603
+ * @property {boolean} isTPA
1463
1604
  * @property {string} newViewName - Name of the newly selected view
1464
1605
  * @property {number} numFiltersActive - How many filters are active after view selection
1465
1606
  * @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
@@ -1477,12 +1618,14 @@ export function cairoViewSelected(params) {
1477
1618
  * Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
1478
1619
  *
1479
1620
  * @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
1621
+ * @property {string} appId
1480
1622
  * @property {string} artifactId - Artifact that owns the component
1481
1623
  * @property {string} cairoVersion - Cairo version
1482
1624
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1483
1625
  * @property {string} componentType - Component type
1484
1626
  * @property {GUID} csid - Cairo session ID
1485
1627
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1628
+ * @property {boolean} isTPA
1486
1629
  * @property {number} numColumns - How many columns are shown?
1487
1630
  * @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)
1488
1631
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1500,6 +1643,7 @@ export function cairoDataExAddCustomField(params) {
1500
1643
  *
1501
1644
  * @param {cairoFilterToggledParams} params - The parameters for this event
1502
1645
  * @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
1646
+ * @property {string} appId
1503
1647
  * @property {string} artifactId - Artifact that owns the component
1504
1648
  * @property {string} cairoVersion
1505
1649
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1510,6 +1654,7 @@ export function cairoDataExAddCustomField(params) {
1510
1654
  * @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
1511
1655
  * @property {string} filterValue - JSON containing filterName's new value
1512
1656
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1657
+ * @property {boolean} isTPA
1513
1658
  * @property {number} listSize - How many items exist (full list, unfiltered)
1514
1659
  * @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
1515
1660
  * @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
@@ -1527,12 +1672,14 @@ export function cairoFilterToggled(params) {
1527
1672
  *
1528
1673
  * @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
1529
1674
  * @property {string} actionName - Open / Close the advanced settings
1675
+ * @property {string} appId
1530
1676
  * @property {string} artifactId - Artifact that owns the component
1531
1677
  * @property {string} cairoVersion - Cairo version
1532
1678
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1533
1679
  * @property {string} componentType - Component type
1534
1680
  * @property {GUID} csid - Cairo session ID
1535
1681
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1682
+ * @property {boolean} isTPA
1536
1683
  * @property {string} origin - Where did the user click on "Advanced Settings" from? Add Custom Field Modal / Edit Custom Field Modal
1537
1684
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1538
1685
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1547,6 +1694,7 @@ export function cairoDataExCustomFieldAdvancesSettings(params) {
1547
1694
  * Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
1548
1695
  *
1549
1696
  * @param {cairoViewSavedParams} params - The parameters for this event
1697
+ * @property {string} appId
1550
1698
  * @property {string} artifactId - Artifact that owns the component
1551
1699
  * @property {string} cairoVersion - Cairo version
1552
1700
  * @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)
@@ -1558,6 +1706,7 @@ export function cairoDataExCustomFieldAdvancesSettings(params) {
1558
1706
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1559
1707
  * @property {boolean} isDefault - Is the saved view defined as default view?
1560
1708
  * @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)
1709
+ * @property {boolean} isTPA
1561
1710
  * @property {string} newViewName - Name of the newly created/saved/renamed view
1562
1711
  * @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
1563
1712
  * @property {number} numFiltersInView - How many filters comprise the saved view
@@ -1580,6 +1729,7 @@ export function cairoViewSaved(params) {
1580
1729
  * Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
1581
1730
  *
1582
1731
  * @param {cairoViewDeletedParams} params - The parameters for this event
1732
+ * @property {string} appId
1583
1733
  * @property {string} artifactId - Artifact that owns the component
1584
1734
  * @property {string} cairoVersion
1585
1735
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1587,6 +1737,7 @@ export function cairoViewSaved(params) {
1587
1737
  * @property {GUID} csid
1588
1738
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1589
1739
  * @property {boolean} isDefault - Was the deleted view defined as default view?
1740
+ * @property {boolean} isTPA
1590
1741
  * @property {number} numFiltersInView - How many filters comprised the deleted view
1591
1742
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1592
1743
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1606,6 +1757,7 @@ export function cairoViewDeleted(params) {
1606
1757
  *
1607
1758
  * @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
1608
1759
  * @property {string} actionName - Add/ Edit
1760
+ * @property {string} appId
1609
1761
  * @property {string} artifactId - Artifact that owns the component
1610
1762
  * @property {string} cairoVersion - Cairo version
1611
1763
  * @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
@@ -1617,6 +1769,7 @@ export function cairoViewDeleted(params) {
1617
1769
  * @property {string} endType - What did the user chose in the modal? Add field / Cancel
1618
1770
  * @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
1619
1771
  * @property {string} fieldType - (Relevant when a field was added) What type is the added field? Long text / Date / Number etc.
1772
+ * @property {boolean} isTPA
1620
1773
  * @property {string} key - The key value
1621
1774
  * @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
1622
1775
  * @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
@@ -1635,6 +1788,7 @@ export function cairoDataExCustomFieldEndProcess(params) {
1635
1788
  * Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
1636
1789
  *
1637
1790
  * @param {cairoComponentSortedParams} params - The parameters for this event
1791
+ * @property {string} appId
1638
1792
  * @property {string} artifactId - Artifact that owns the component
1639
1793
  * @property {string} cairoVersion - Cairo version
1640
1794
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1643,6 +1797,7 @@ export function cairoDataExCustomFieldEndProcess(params) {
1643
1797
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1644
1798
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1645
1799
  * @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)
1800
+ * @property {boolean} isTPA
1646
1801
  * @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)
1647
1802
  * @property {number} listSize - How many items exist (full list, unfiltered)
1648
1803
  * @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)
@@ -1667,6 +1822,7 @@ export function cairoComponentSorted(params) {
1667
1822
  * Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
1668
1823
  *
1669
1824
  * @param {cairoReorderingSortColumnsParams} params - The parameters for this event
1825
+ * @property {string} appId
1670
1826
  * @property {string} artifactId - Artifact that owns the component
1671
1827
  * @property {string} cairoVersion - Cairo version
1672
1828
  * @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)
@@ -1676,6 +1832,7 @@ export function cairoComponentSorted(params) {
1676
1832
  * @property {GUID} csid
1677
1833
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1678
1834
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1835
+ * @property {boolean} isTPA
1679
1836
  * @property {number} listSize - How many items exist (full list, unfiltered)
1680
1837
  * @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.
1681
1838
  * @property {number} numSortingColumns - How many columns are been used for sorting the component?
@@ -1695,6 +1852,7 @@ export function cairoReorderingSortColumns(params) {
1695
1852
  * Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
1696
1853
  *
1697
1854
  * @param {cairoExportProcessEndParams} params - The parameters for this event
1855
+ * @property {string} appId
1698
1856
  * @property {string} artifactId - Artifact that owns the component
1699
1857
  * @property {string} cairoVersion
1700
1858
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1704,6 +1862,7 @@ export function cairoReorderingSortColumns(params) {
1704
1862
  * @property {number} duration - How much time (in ms) did it take since the export process began
1705
1863
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1706
1864
  * @property {string} fileName - (Optional) Name of the file to be exported
1865
+ * @property {boolean} isTPA
1707
1866
  * @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.
1708
1867
  * @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
1709
1868
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1723,6 +1882,7 @@ export function cairoExportProcessEnd(params) {
1723
1882
  * Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
1724
1883
  *
1725
1884
  * @param {cairoApplyButtonClickedParams} params - The parameters for this event
1885
+ * @property {string} appId
1726
1886
  * @property {string} artifactId
1727
1887
  * @property {string} cairoVersion - Cairo version
1728
1888
  * @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
@@ -1733,6 +1893,7 @@ export function cairoExportProcessEnd(params) {
1733
1893
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1734
1894
  * @property {string} feature - Filters / Drag and Drop
1735
1895
  * @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
1896
+ * @property {boolean} isTPA
1736
1897
  * @property {number} listSize - How many items exist (full list, unfiltered)
1737
1898
  * @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)
1738
1899
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
@@ -1752,6 +1913,7 @@ export function cairoApplyButtonClicked(params) {
1752
1913
  *
1753
1914
  * @param {cairoExportModalCtaClickedParams} params - The parameters for this event
1754
1915
  * @property {string} action - Does the user want to proceed with the export or dismiss the modal
1916
+ * @property {string} appId
1755
1917
  * @property {string} artifactId - Artifact that owns the component
1756
1918
  * @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
1757
1919
  * @property {string} cairoVersion
@@ -1760,6 +1922,7 @@ export function cairoApplyButtonClicked(params) {
1760
1922
  * @property {GUID} csid
1761
1923
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1762
1924
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1925
+ * @property {boolean} isTPA
1763
1926
  * @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.
1764
1927
  * @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
1765
1928
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1778,6 +1941,7 @@ export function cairoExportModalCtaClicked(params) {
1778
1941
  *
1779
1942
  * @param {cairoUndoClickedParams} params - The parameters for this event
1780
1943
  * @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.)
1944
+ * @property {string} appId
1781
1945
  * @property {string} artifactId - Artifact that owns the component
1782
1946
  * @property {string} cairoVersion - cairo version
1783
1947
  * @property {string} changedAttributes - Which attributes have changed from the saved status to the current
@@ -1791,6 +1955,7 @@ export function cairoExportModalCtaClicked(params) {
1791
1955
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1792
1956
  * @property {number} filteredListSize - How many items are to be presented (filtered)
1793
1957
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
1958
+ * @property {boolean} isTPA
1794
1959
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1795
1960
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1796
1961
  * @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"}
@@ -1808,6 +1973,7 @@ export function cairoUndoClicked(params) {
1808
1973
  * Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
1809
1974
  *
1810
1975
  * @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
1976
+ * @property {string} appId
1811
1977
  * @property {string} artifactId - Artifact that owns the component
1812
1978
  * @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
1813
1979
  * @property {string} cairoVersion - Cairo version
@@ -1816,6 +1982,7 @@ export function cairoUndoClicked(params) {
1816
1982
  * @property {GUID} csid
1817
1983
  * @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)
1818
1984
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1985
+ * @property {boolean} isTPA
1819
1986
  * @property {string} pageType - Collection Page
1820
1987
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1821
1988
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1840,6 +2007,7 @@ export function cairoPageBackOrBreadcrumbClicked(params) {
1840
2007
  * @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
1841
2008
  * @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
1842
2009
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2010
+ * @property {boolean} isTPA
1843
2011
  * @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
1844
2012
  * @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
1845
2013
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1856,12 +2024,14 @@ export function cairoTpaSCtaClicked(params) {
1856
2024
  * Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
1857
2025
  *
1858
2026
  * @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
2027
+ * @property {string} appId
1859
2028
  * @property {string} artifactId - Artifact that owns the component
1860
2029
  * @property {string} cairoVersion
1861
2030
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1862
2031
  * @property {string} componentType
1863
2032
  * @property {GUID} csid
1864
2033
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
2034
+ * @property {boolean} isTPA
1865
2035
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1866
2036
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1867
2037
  * @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
@@ -1876,6 +2046,7 @@ export function pikachuCategoriesDropdownButtonClicked(params) {
1876
2046
  *
1877
2047
  * @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
1878
2048
  * @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
2049
+ * @property {string} appId
1879
2050
  * @property {string} artifactId - Artifact that owns the component
1880
2051
  * @property {string} cairoVersion - Cairo version
1881
2052
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1883,6 +2054,7 @@ export function pikachuCategoriesDropdownButtonClicked(params) {
1883
2054
  * @property {GUID} csid - Cairo session ID
1884
2055
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1885
2056
  * @property {string} errorType - What is the type of the error? Technical issue / Network error
2057
+ * @property {boolean} isTPA
1886
2058
  * @property {number} numTags - How many tags are in the modal after this action?
1887
2059
  * @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
1888
2060
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1900,6 +2072,7 @@ export function cairoTagsUnsuccessfulUpdateInServer(params) {
1900
2072
  *
1901
2073
  * @param {pickerModalUsabilityParams} params - The parameters for this event
1902
2074
  * @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
2075
+ * @property {string} appId
1903
2076
  * @property {string} artifactId - Artifact that owns the component
1904
2077
  * @property {string} cairoVersion
1905
2078
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1907,6 +2080,7 @@ export function cairoTagsUnsuccessfulUpdateInServer(params) {
1907
2080
  * @property {GUID} csid
1908
2081
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
1909
2082
  * @property {number} filteredListSize - How many items are to presented (filtered)
2083
+ * @property {boolean} isTPA
1910
2084
  * @property {string} itemId - (Optional) ID of item checked
1911
2085
  * @property {number} itemsCnt - (Optional) Number of total items checked
1912
2086
  * @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
@@ -1930,6 +2104,7 @@ export function pickerModalUsability(params) {
1930
2104
  * Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
1931
2105
  *
1932
2106
  * @param {cairoSortPanelUsedParams} params - The parameters for this event
2107
+ * @property {string} appId
1933
2108
  * @property {string} artifactId
1934
2109
  * @property {string} cairoVersion - Cairo version
1935
2110
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1938,6 +2113,7 @@ export function pickerModalUsability(params) {
1938
2113
  * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
1939
2114
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1940
2115
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
2116
+ * @property {boolean} isTPA
1941
2117
  * @property {number} numSortedColumns - How many columns actively sort the data?
1942
2118
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1943
2119
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1953,6 +2129,7 @@ export function cairoSortPanelUsed(params) {
1953
2129
  *
1954
2130
  * @param {cairoTagsAssignTagParams} params - The parameters for this event
1955
2131
  * @property {string} actionName - Assign / Remove
2132
+ * @property {string} appId
1956
2133
  * @property {string} artifactId - Artifact that owns the component
1957
2134
  * @property {string} cairoVersion - Cairo version
1958
2135
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1960,6 +2137,7 @@ export function cairoSortPanelUsed(params) {
1960
2137
  * @property {GUID} csid - Cairo session ID
1961
2138
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1962
2139
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
2140
+ * @property {boolean} isTPA
1963
2141
  * @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
1964
2142
  * @property {number} numItems - How many items have been selected?
1965
2143
  * @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
@@ -1979,6 +2157,7 @@ export function cairoTagsAssignTag(params) {
1979
2157
  * Event description: Sent when a Cairo's page can't be saved due to an error.
1980
2158
  *
1981
2159
  * @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
2160
+ * @property {string} appId
1982
2161
  * @property {string} artifactId - Artifact that owns the component
1983
2162
  * @property {string} cairoVersion - Cairo version
1984
2163
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1993,6 +2172,7 @@ export function cairoTagsAssignTag(params) {
1993
2172
  * @property {string} errorType - Technical issue / Logic error / Network error / External error
1994
2173
  * @property {number} filteredListSize - How many items are to be presented (filtered)
1995
2174
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
2175
+ * @property {boolean} isTPA
1996
2176
  * @property {string} pageType - Entity / Collection
1997
2177
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1998
2178
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)