@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
@@ -1,4 +1,4 @@
1
- import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndParams, cairoApplyButtonClickedParams, cairoAssignTagsToEntitiesParams, cairoCancelExportModalCtaClickedParams, cairoChangesBeforeApplyParams, cairoComponentSortedParams, cairoCtaClickedParams, cairoDataExAddCustomFieldParams, cairoDataExCustomFieldAdvancesSettingsParams, cairoDataExCustomFieldEndProcessParams, cairoDataExtensionUnsuccessfulUpdateInServerParams, cairoDiscardChangesBeforeApplyParams, cairoDragActionUnsuccessfulUpdateInServerParams, cairoDragItemEndDropParams, cairoDragItemParams, cairoErrorInLoadingAComponentParams, cairoExportCtaClickedParams, cairoExportFailedModalCtaClickedParams, cairoExportModalCtaClickedParams, cairoExportProcessEndParams, cairoExportProcessStartParams, cairoFileDownloadToastDismissedParams, cairoFileDownloadToastDisplayedParams, cairoFileDownloadToastDownloadButtonClickedParams, cairoFilterToggledParams, cairoFiltersPanelUsedParams, cairoItemSelectionToggledParams, cairoItemToggledInExportModalParams, cairoLearnMoreParams, cairoManageViewActionSelectedParams, cairoManageViewClickedParams, cairoModalCtaClickedParams, cairoNestedTableCollapseAndExpandParams, cairoPageBackOrBreadcrumbClickedParams, cairoPageCtaClickedParams, cairoPageDiscardChangesBeforeSaveParams, cairoReloadErrorStateParams, cairoReorderingSortColumnsParams, cairoSearchForTagsParams, cairoSearchResultsParams, cairoSearchViewInViewsParams, cairoSectionCtaClickedParams, cairoSortPanelUsedParams, cairoSortUnsuccessfulUpdateInServerParams, cairoTabSelectedParams, cairoTableTopNotificationDismissedParams, cairoTableTopNotificationDisplayedParams, cairoTagsAddDeleteTagParams, cairoTagsAssignTagParams, cairoTagsModalEndProcessParams, cairoTagsModalStartLoadParams, cairoTagsUnsuccessfulUpdateInServerParams, cairoTagsWidgetClickOnCtaParams, cairoTagsWidgetLoadedParams, cairoTpaSCtaClickedParams, cairoTryAgainClickedParams, cairoUndoClickedParams, cairoUserAttemptsToCancelTheExportParams, cairoViewDeletedParams, cairoViewSavedParams, cairoViewSelectedParams, cairoViewsUnsuccessfulUpdateInServerParams, componentDismissedParams, loadEndParams, loadMoreParams, loadStartParams, newItemCreationEndParams, newItemCreationStartParams, pickerEndLoadParams, pickerModalUsabilityParams, pickerPickModalCtaButtonClickOrImmediateCtaParams, pickerPickerOpenButtonParams, pickerStartLoadParams, pikachuCategoriesDropdownButtonClickedParams, pikachuItemCategorySelectedParams } from '../types';
1
+ import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndParams, cairoApplyButtonClickedParams, cairoAssignTagsToEntitiesParams, cairoCancelExportModalCtaClickedParams, cairoChangesBeforeApplyParams, cairoComponentSortedParams, cairoCtaClickedParams, cairoCustomizeColumnsInSidePanelParams, cairoDataExAddCustomFieldParams, cairoDataExCustomFieldAdvancesSettingsParams, cairoDataExCustomFieldEndProcessParams, cairoDataExtensionUnsuccessfulUpdateInServerParams, cairoDiscardChangesBeforeApplyParams, cairoDragActionUnsuccessfulUpdateInServerParams, cairoDragItemEndDropParams, cairoDragItemParams, cairoErrorInLoadingAComponentParams, cairoExportCtaClickedParams, cairoExportFailedModalCtaClickedParams, cairoExportModalCtaClickedParams, cairoExportProcessEndParams, cairoExportProcessStartParams, cairoFileDownloadToastDismissedParams, cairoFileDownloadToastDisplayedParams, cairoFileDownloadToastDownloadButtonClickedParams, cairoFilterToggledParams, cairoFiltersPanelUsedParams, cairoItemSelectionToggledParams, cairoItemToggledInExportModalParams, cairoLearnMoreParams, cairoManageViewActionSelectedParams, cairoManageViewClickedParams, cairoModalCtaClickedParams, cairoNestedTableCollapseAndExpandParams, cairoPageBackOrBreadcrumbClickedParams, cairoPageCtaClickedParams, cairoPageDiscardChangesBeforeSaveParams, cairoReloadErrorStateParams, cairoReorderingSortColumnsParams, cairoSearchForTagsParams, cairoSearchResultsParams, cairoSearchViewInViewsParams, cairoSectionCtaClickedParams, cairoSortPanelUsedParams, cairoSortUnsuccessfulUpdateInServerParams, cairoTabSelectedParams, cairoTableTopNotificationDismissedParams, cairoTableTopNotificationDisplayedParams, cairoTagsAddDeleteTagParams, cairoTagsAssignTagParams, cairoTagsModalEndProcessParams, cairoTagsModalStartLoadParams, cairoTagsUnsuccessfulUpdateInServerParams, cairoTagsWidgetClickOnCtaParams, cairoTagsWidgetLoadedParams, cairoTpaSCtaClickedParams, cairoTryAgainClickedParams, cairoUndoClickedParams, cairoUserAttemptsToCancelTheExportParams, cairoViewDeletedParams, cairoViewSavedParams, cairoViewSelectedParams, cairoViewsUnsuccessfulUpdateInServerParams, componentDismissedParams, loadEndParams, loadMoreParams, loadStartParams, newItemCreationEndParams, newItemCreationStartParams, pickerEndLoadParams, pickerModalUsabilityParams, pickerPickModalCtaButtonClickOrImmediateCtaParams, pickerPickerOpenButtonParams, pickerStartLoadParams, pikachuCategoriesDropdownButtonClickedParams, pikachuItemCategorySelectedParams } from '../types';
2
2
 
3
3
  /**
4
4
  * A function to create a log object for the 'componentDismissed' event (evid: 113)
@@ -6,12 +6,14 @@ import { LogObject, cairoAllFiltersClearedParams, cairoApiRequestDataLoadEndPara
6
6
  * Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
7
7
  *
8
8
  * @param {componentDismissedParams} params - The parameters for this event
9
+ * @property {string} appId
9
10
  * @property {string} artifactId - Artifact that owns the component
10
11
  * @property {string} cairoVersion
11
12
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
12
13
  * @property {string} componentType - Picker Modal / Picker Dropdown
13
14
  * @property {GUID} csid
14
15
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
16
+ * @property {boolean} isTPA
15
17
  * @property {string} origin - X button/Cancel button
16
18
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
17
19
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -27,6 +29,7 @@ export function componentDismissed(params: componentDismissedParams): LogObject<
27
29
  * Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
28
30
  *
29
31
  * @param {loadMoreParams} params - The parameters for this event
32
+ * @property {string} appId
30
33
  * @property {string} artifactId - Artifact that owns the component
31
34
  * @property {string} cairoVersion
32
35
  * @property {string} componentName - Component name, if there are two components of the same type per artifact
@@ -38,6 +41,7 @@ export function componentDismissed(params: componentDismissedParams): LogObject<
38
41
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
39
42
  * @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
40
43
  * @property {number} filteredListSize - How many items are to be presented (filtered)
44
+ * @property {boolean} isTPA
41
45
  * @property {number} loadedItems - How many new items were loaded in this action
42
46
  * @property {number} loadingTime - Component loading time in ms
43
47
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -54,6 +58,7 @@ export function loadMore(params: loadMoreParams): LogObject<loadMoreParams> {
54
58
  * Event description: Sent when a user finish to drag an item
55
59
  *
56
60
  * @param {cairoDragItemEndDropParams} params - The parameters for this event
61
+ * @property {string} appId
57
62
  * @property {string} artifactId - Artifact that owns the component
58
63
  * @property {string} cairoVersion - cairo version
59
64
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -75,6 +80,7 @@ export function loadMore(params: loadMoreParams): LogObject<loadMoreParams> {
75
80
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
76
81
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
77
82
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
83
+ * @property {boolean} isTPA
78
84
  * @property {string} itemId - ID of the item that the user tries to drag
79
85
  * @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
80
86
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -95,6 +101,7 @@ export function cairoDragItemEndDrop(params: cairoDragItemEndDropParams): LogObj
95
101
  *
96
102
  * @param {pickerPickerOpenButtonParams} params - The parameters for this event
97
103
  * @property {string} action - Any picker button option (render/hover/click)
104
+ * @property {string} appId
98
105
  * @property {string} artifactId - Artifact that owns the component
99
106
  * @property {string} cairoVersion
100
107
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -103,6 +110,7 @@ export function cairoDragItemEndDrop(params: cairoDragItemEndDropParams): LogObj
103
110
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
104
111
  * @property {number} filteredListSize - How many items are to presented (filtered)
105
112
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
113
+ * @property {boolean} isTPA
106
114
  * @property {number} listSize - How many items exist (full list)
107
115
  * @property {number} maxItems - Max items to select in picker
108
116
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -120,6 +128,7 @@ export function pickerPickerOpenButton(params: pickerPickerOpenButtonParams): Lo
120
128
  * 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.
121
129
  *
122
130
  * @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
131
+ * @property {string} appId
123
132
  * @property {string} artifactId - Artifact that owns the component
124
133
  * @property {string} cairoVersion - Cairo version
125
134
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -128,6 +137,7 @@ export function pickerPickerOpenButton(params: pickerPickerOpenButtonParams): Lo
128
137
  * @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)
129
138
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
130
139
  * @property {string} feature - Filters / Drag and Drop
140
+ * @property {boolean} isTPA
131
141
  * @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)
132
142
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
133
143
  * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
@@ -146,6 +156,7 @@ export function cairoDiscardChangesBeforeApply(params: cairoDiscardChangesBefore
146
156
  * Event description: Sent when a user select/deselects an item(s) in a list
147
157
  *
148
158
  * @param {cairoItemSelectionToggledParams} params - The parameters for this event
159
+ * @property {string} appId
149
160
  * @property {string} artifactId - Artifact that owns the component
150
161
  * @property {string} cairoVersion
151
162
  * @property {string} clickType - The click purpose : "Selection" / "Deselection"
@@ -163,6 +174,7 @@ export function cairoDiscardChangesBeforeApply(params: cairoDiscardChangesBefore
163
174
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
164
175
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
165
176
  * @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").
177
+ * @property {boolean} isTPA
166
178
  * @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
167
179
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
168
180
  * ** isSelectAll = TRUE --> itemIndex = 0
@@ -188,6 +200,7 @@ export function cairoItemSelectionToggled(params: cairoItemSelectionToggledParam
188
200
  * Event description: Cairo picker finished loading
189
201
  *
190
202
  * @param {pickerEndLoadParams} params - The parameters for this event
203
+ * @property {string} appId
191
204
  * @property {string} artifactId - Artifact that owns the component
192
205
  * @property {string} cairoVersion
193
206
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -196,6 +209,7 @@ export function cairoItemSelectionToggled(params: cairoItemSelectionToggledParam
196
209
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
197
210
  * @property {number} filteredListSize - How many items are to presented (filtered)
198
211
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
212
+ * @property {boolean} isTPA
199
213
  * @property {number} listSize - How many items exist (full list)
200
214
  * @property {number} loadingTime - ms
201
215
  * @property {number} maxItems - Max items to select in picker
@@ -214,6 +228,7 @@ export function pickerEndLoad(params: pickerEndLoadParams): LogObject<pickerEndL
214
228
  * 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)
215
229
  *
216
230
  * @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
231
+ * @property {string} appId
217
232
  * @property {string} artifactId - Artifact that owns the component
218
233
  * @property {string} cairoVersion - cairo version
219
234
  * @property {string} clickType - The click purpose : "Collapse" / "Expand"
@@ -230,6 +245,7 @@ export function pickerEndLoad(params: pickerEndLoadParams): LogObject<pickerEndL
230
245
  * @property {number} filteredListSize - How many items are to be presented (filtered)
231
246
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
232
247
  * @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
248
+ * @property {boolean} isTPA
233
249
  * @property {string} itemId - ID of the clicked item .If "Is select all"= true, then Null
234
250
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If "Is select all"= true, then Null
235
251
  * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
@@ -248,6 +264,7 @@ export function cairoNestedTableCollapseAndExpand(params: cairoNestedTableCollap
248
264
  * Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
249
265
  *
250
266
  * @param {loadEndParams} params - The parameters for this event
267
+ * @property {string} appId
251
268
  * @property {string} artifactId - Artifact that owns the component
252
269
  * @property {string} cairoVersion
253
270
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -262,6 +279,7 @@ export function cairoNestedTableCollapseAndExpand(params: cairoNestedTableCollap
262
279
  * @property {number} filteredListSize - How many items are to be presented (filtered)
263
280
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
264
281
  * @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
282
+ * @property {boolean} isTPA
265
283
  * @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
266
284
  * @property {number} loadingTime - Component loading time in ms
267
285
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -280,6 +298,7 @@ export function loadEnd(params: loadEndParams): LogObject<loadEndParams> {
280
298
  *
281
299
  * @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
282
300
  * @property {string} actionName - Add / Delete / Rename
301
+ * @property {string} appId
283
302
  * @property {string} artifactId - Artifact that owns the component
284
303
  * @property {string} cairoVersion - Cairo version
285
304
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -287,6 +306,7 @@ export function loadEnd(params: loadEndParams): LogObject<loadEndParams> {
287
306
  * @property {GUID} csid - Cairo session ID
288
307
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
289
308
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
309
+ * @property {boolean} isTPA
290
310
  * @property {number} numTags - How many tags are in the modal after this action?
291
311
  * @property {string} origin - Where did the user make the action from? Tags Modal /
292
312
  * @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
@@ -305,6 +325,7 @@ export function cairoTagsAddDeleteTag(params: cairoTagsAddDeleteTagParams): LogO
305
325
  * Event description: Sent when the export process begins
306
326
  *
307
327
  * @param {cairoExportProcessStartParams} params - The parameters for this event
328
+ * @property {string} appId
308
329
  * @property {string} artifactId - Artifact that owns the component
309
330
  * @property {string} cairoVersion
310
331
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -312,6 +333,7 @@ export function cairoTagsAddDeleteTag(params: cairoTagsAddDeleteTagParams): LogO
312
333
  * @property {GUID} csid
313
334
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
314
335
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
336
+ * @property {boolean} isTPA
315
337
  * @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.
316
338
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
317
339
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -330,6 +352,7 @@ export function cairoExportProcessStart(params: cairoExportProcessStartParams):
330
352
  * Event description: Sent when the user clicks a CTA in the "Export Failed" modal
331
353
  *
332
354
  * @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
355
+ * @property {string} appId
333
356
  * @property {string} artifactId - Artifact that owns the component
334
357
  * @property {string} cairoVersion
335
358
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -338,6 +361,7 @@ export function cairoExportProcessStart(params: cairoExportProcessStartParams):
338
361
  * @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)
339
362
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
340
363
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
364
+ * @property {boolean} isTPA
341
365
  * @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
342
366
  * @property {number} numItemsExported - How many items were exported before the export failed.
343
367
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -357,6 +381,7 @@ export function cairoExportFailedModalCtaClicked(params: cairoExportFailedModalC
357
381
  * 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.
358
382
  *
359
383
  * @param {cairoSearchViewInViewsParams} params - The parameters for this event
384
+ * @property {string} appId
360
385
  * @property {string} artifactId - Artifact that owns the component
361
386
  * @property {string} cairoVersion - Cairo version
362
387
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -364,6 +389,7 @@ export function cairoExportFailedModalCtaClicked(params: cairoExportFailedModalC
364
389
  * @property {GUID} csid
365
390
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
366
391
  * @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).
392
+ * @property {boolean} isTPA
367
393
  * @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are from type of "categories"?
368
394
  * @property {number} numViews - The distinct views IDs the users has when he searches a view
369
395
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -382,6 +408,7 @@ export function cairoSearchViewInViews(params: cairoSearchViewInViewsParams): Lo
382
408
  * Event description: Cairo picker starts loading
383
409
  *
384
410
  * @param {pickerStartLoadParams} params - The parameters for this event
411
+ * @property {string} appId
385
412
  * @property {string} artifactId - Artifact that owns the component
386
413
  * @property {string} cairoVersion
387
414
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -390,6 +417,7 @@ export function cairoSearchViewInViews(params: cairoSearchViewInViewsParams): Lo
390
417
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
391
418
  * @property {number} filteredListSize - How many items are to presented (filtered)
392
419
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
420
+ * @property {boolean} isTPA
393
421
  * @property {number} listSize - How many items exist (full list)
394
422
  * @property {number} maxItems - Max items to select in picker
395
423
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -408,6 +436,7 @@ export function pickerStartLoad(params: pickerStartLoadParams): LogObject<picker
408
436
  *
409
437
  * @param {loadStartParams} params - The parameters for this event
410
438
  * @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
439
+ * @property {string} appId
411
440
  * @property {string} artifactId - Artifact that owns the component
412
441
  * @property {string} cairoVersion - cairo version
413
442
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -419,6 +448,7 @@ export function pickerStartLoad(params: pickerStartLoadParams): LogObject<picker
419
448
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
420
449
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
421
450
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
451
+ * @property {boolean} isTPA
422
452
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
423
453
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
424
454
  * @property {Url} url - The page's url (new from 03/2023)
@@ -434,12 +464,14 @@ export function loadStart(params: loadStartParams): LogObject<loadStartParams> {
434
464
  * Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
435
465
  *
436
466
  * @param {pikachuItemCategorySelectedParams} params - The parameters for this event
467
+ * @property {string} appId
437
468
  * @property {string} artifactId - Artifact that owns the component
438
469
  * @property {string} cairoVersion
439
470
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
440
471
  * @property {string} componentType
441
472
  * @property {GUID} csid
442
473
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
474
+ * @property {boolean} isTPA
443
475
  * @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
444
476
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
445
477
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -455,6 +487,7 @@ export function pikachuItemCategorySelected(params: pikachuItemCategorySelectedP
455
487
  * Event description: Sent when a user clicks the "Export" CTA in a Cairo component
456
488
  *
457
489
  * @param {cairoExportCtaClickedParams} params - The parameters for this event
490
+ * @property {string} appId
458
491
  * @property {string} artifactId - Artifact that owns the component
459
492
  * @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}
460
493
  * @property {string} cairoVersion
@@ -465,6 +498,7 @@ export function pikachuItemCategorySelected(params: pikachuItemCategorySelectedP
465
498
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
466
499
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
467
500
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
501
+ * @property {boolean} isTPA
468
502
  * @property {number} numSelectedItems - How many items does the user wish to export
469
503
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
470
504
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -480,6 +514,7 @@ export function cairoExportCtaClicked(params: cairoExportCtaClickedParams): LogO
480
514
  * Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
481
515
  *
482
516
  * @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
517
+ * @property {string} appId
483
518
  * @property {string} artifactId - Artifact that owns the component
484
519
  * @property {string} cairoVersion
485
520
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -489,6 +524,7 @@ export function cairoExportCtaClicked(params: cairoExportCtaClickedParams): LogO
489
524
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
490
525
  * @property {number} duration - How much time (in ms) did it take since the export process began
491
526
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
527
+ * @property {boolean} isTPA
492
528
  * @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
493
529
  * @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.
494
530
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
@@ -509,12 +545,14 @@ export function cairoCancelExportModalCtaClicked(params: cairoCancelExportModalC
509
545
  * 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)
510
546
  *
511
547
  * @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
548
+ * @property {string} appId
512
549
  * @property {string} artifactId - Artifact that owns the component
513
550
  * @property {string} cairoVersion - Cairo version
514
551
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
515
552
  * @property {string} componentType - Table/Cards / Picker
516
553
  * @property {GUID} csid - Cairo session ID
517
554
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
555
+ * @property {boolean} isTPA
518
556
  * @property {number} numOfActions - Number of changed fields that their changes can be lost
519
557
  * @property {number} numOfFields - How many fields are there that can be change in this page?
520
558
  * @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
@@ -533,6 +571,7 @@ export function cairoPageDiscardChangesBeforeSave(params: cairoPageDiscardChange
533
571
  * Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
534
572
  *
535
573
  * @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
574
+ * @property {string} appId
536
575
  * @property {string} artifactId - Artifact that owns the component
537
576
  * @property {string} cairoVersion
538
577
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -542,6 +581,7 @@ export function cairoPageDiscardChangesBeforeSave(params: cairoPageDiscardChange
542
581
  * @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
543
582
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
544
583
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
584
+ * @property {boolean} isTPA
545
585
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
546
586
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
547
587
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -551,12 +591,43 @@ export function cairoFileDownloadToastDownloadButtonClicked(params: cairoFileDow
551
591
  return { evid: 134, src: 144, endpoint: 'cairo-os', params };
552
592
  }
553
593
 
594
+ /**
595
+ * A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
596
+ *
597
+ * 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.
598
+ *
599
+ * @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
600
+ * @property {string} actionName - Visibility / Reorder
601
+ * @property {string} appId
602
+ * @property {string} artifactId - Artifact that owns the component
603
+ * @property {string} cairoVersion - version
604
+ * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
605
+ * @property {string} componentType - Table/Cards
606
+ * @property {GUID} csid - cairo session id
607
+ * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
608
+ * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
609
+ * @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)
610
+ * @property {boolean} isTPA
611
+ * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
612
+ * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
613
+ * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
614
+ * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
615
+ * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
616
+ * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
617
+ * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
618
+ * @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
619
+ */
620
+ export function cairoCustomizeColumnsInSidePanel(params: cairoCustomizeColumnsInSidePanelParams): LogObject<cairoCustomizeColumnsInSidePanelParams> {
621
+ return { evid: 177, src: 144, endpoint: 'cairo-os', params };
622
+ }
623
+
554
624
  /**
555
625
  * A function to create a log object for the 'cairoTabSelected' event (evid: 121)
556
626
  *
557
627
  * Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
558
628
  *
559
629
  * @param {cairoTabSelectedParams} params - The parameters for this event
630
+ * @property {string} appId
560
631
  * @property {string} artifactId - Artifact that owns the component
561
632
  * @property {string} cairoVersion
562
633
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -565,6 +636,7 @@ export function cairoFileDownloadToastDownloadButtonClicked(params: cairoFileDow
565
636
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
566
637
  * @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
567
638
  * @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
639
+ * @property {boolean} isTPA
568
640
  * @property {string} newTabId - Name of the newly selected tab
569
641
  * @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
570
642
  * @property {number} numTabs - How many tabs are dispalyed to the user
@@ -585,6 +657,7 @@ export function cairoTabSelected(params: cairoTabSelectedParams): LogObject<cair
585
657
  *
586
658
  * @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
587
659
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
660
+ * @property {string} appId
588
661
  * @property {string} artifactId - Artifact that owns the component
589
662
  * @property {string} cairoVersion - cairo version
590
663
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -599,6 +672,7 @@ export function cairoTabSelected(params: cairoTabSelectedParams): LogObject<cair
599
672
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
600
673
  * @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.
601
674
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
675
+ * @property {boolean} isTPA
602
676
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
603
677
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
604
678
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -617,6 +691,7 @@ export function cairoViewsUnsuccessfulUpdateInServer(params: cairoViewsUnsuccess
617
691
  * Event description: Sent when a user clicks on a CTA in an an opened modal
618
692
  *
619
693
  * @param {cairoModalCtaClickedParams} params - The parameters for this event
694
+ * @property {string} appId
620
695
  * @property {string} artifactId - Artifact that owns the component
621
696
  * @property {string} cairoVersion - cairo version
622
697
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -624,6 +699,7 @@ export function cairoViewsUnsuccessfulUpdateInServer(params: cairoViewsUnsuccess
624
699
  * @property {GUID} csid - Cairo session id
625
700
  * @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
626
701
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
702
+ * @property {boolean} isTPA
627
703
  * @property {string} localizedCtaName - The CTA name, localized
628
704
  * @property {string} modalName - The modal's title (Archive custom field, etc.)
629
705
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -640,6 +716,7 @@ export function cairoModalCtaClicked(params: cairoModalCtaClickedParams): LogObj
640
716
  * Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
641
717
  *
642
718
  * @param {cairoAllFiltersClearedParams} params - The parameters for this event
719
+ * @property {string} appId
643
720
  * @property {string} artifactId - Artifact that owns the component
644
721
  * @property {string} cairoVersion
645
722
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -648,6 +725,7 @@ export function cairoModalCtaClicked(params: cairoModalCtaClickedParams): LogObj
648
725
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
649
726
  * @property {string} filterNames - Comma separated list of filter names that have been cleared
650
727
  * @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
728
+ * @property {boolean} isTPA
651
729
  * @property {number} numFiltersCleared - How many filters have been cleared
652
730
  * @property {string} origin - "sidebar"/"toolbar"
653
731
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -664,6 +742,7 @@ export function cairoAllFiltersCleared(params: cairoAllFiltersClearedParams): Lo
664
742
  * 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.
665
743
  *
666
744
  * @param {cairoCtaClickedParams} params - The parameters for this event
745
+ * @property {string} appId
667
746
  * @property {string} artifactId - Artifact that owns the component
668
747
  * @property {string} cairoVersion
669
748
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -675,6 +754,7 @@ export function cairoAllFiltersCleared(params: cairoAllFiltersClearedParams): Lo
675
754
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
676
755
  * @property {number} filteredListSize - How many items are to be presented (filtered)
677
756
  * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
757
+ * @property {boolean} isTPA
678
758
  * @property {string} itemId - ID of the item that the user clicked on its CTA
679
759
  * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
680
760
  * @property {string} localizedCtaName - The CTA name, localized
@@ -699,6 +779,7 @@ export function cairoCtaClicked(params: cairoCtaClickedParams): LogObject<cairoC
699
779
  * 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.
700
780
  *
701
781
  * @param {cairoChangesBeforeApplyParams} params - The parameters for this event
782
+ * @property {string} appId
702
783
  * @property {string} artifactId - Artifact that owns the component
703
784
  * @property {string} cairoVersion - Cairo version
704
785
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -709,6 +790,7 @@ export function cairoCtaClicked(params: cairoCtaClickedParams): LogObject<cairoC
709
790
  * @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
710
791
  * @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
711
792
  * @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
793
+ * @property {boolean} isTPA
712
794
  * @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)
713
795
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
714
796
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -725,12 +807,14 @@ export function cairoChangesBeforeApply(params: cairoChangesBeforeApplyParams):
725
807
  *
726
808
  * @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
727
809
  * @property {string} actionName - Assign tags / Create tags / Manage tags
810
+ * @property {string} appId
728
811
  * @property {string} artifactId - Artifact that owns the component
729
812
  * @property {string} cairoVersion - Cairo version
730
813
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
731
814
  * @property {string} componentType - Component type
732
815
  * @property {GUID} csid - Cairo session ID
733
816
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
817
+ * @property {boolean} isTPA
734
818
  * @property {string} itemId - The entity ID
735
819
  * @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
736
820
  * @property {number} numTagsAssigned - How many tags are already assigned to that item?
@@ -749,6 +833,7 @@ export function cairoTagsWidgetClickOnCta(params: cairoTagsWidgetClickOnCtaParam
749
833
  *
750
834
  * @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
751
835
  * @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
836
+ * @property {string} appId
752
837
  * @property {string} artifactId - Artifact that owns the component
753
838
  * @property {string} cairoVersion - cairo version
754
839
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -758,6 +843,7 @@ export function cairoTagsWidgetClickOnCta(params: cairoTagsWidgetClickOnCtaParam
758
843
  * @property {string} errorType - What is the type of the error? Technical issue / Network error / 10k Limitation
759
844
  * @property {string} fieldName - The name the user typed
760
845
  * @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
846
+ * @property {boolean} isTPA
761
847
  * @property {string} key - The key value
762
848
  * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
763
849
  * @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.
@@ -775,6 +861,7 @@ export function cairoDataExtensionUnsuccessfulUpdateInServer(params: cairoDataEx
775
861
  * Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
776
862
  *
777
863
  * @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
864
+ * @property {string} appId
778
865
  * @property {string} artifactId - Artifact that owns the component
779
866
  * @property {string} cairoVersion - cairo version
780
867
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -789,6 +876,7 @@ export function cairoDataExtensionUnsuccessfulUpdateInServer(params: cairoDataEx
789
876
  * InitCustomFieldsDataExtensionFailed /
790
877
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
791
878
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
879
+ * @property {boolean} isTPA
792
880
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
793
881
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
794
882
  * @property {Url} url - The page's url
@@ -804,6 +892,7 @@ export function cairoErrorInLoadingAComponent(params: cairoErrorInLoadingACompon
804
892
  * Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
805
893
  *
806
894
  * @param {cairoReloadErrorStateParams} params - The parameters for this event
895
+ * @property {string} appId
807
896
  * @property {string} artifactId - Artifact that owns the component
808
897
  * @property {string} cairoVersion - cairo version
809
898
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -819,6 +908,7 @@ export function cairoErrorInLoadingAComponent(params: cairoErrorInLoadingACompon
819
908
  * InitCustomFieldsDataExtensionFailed /
820
909
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
821
910
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
911
+ * @property {boolean} isTPA
822
912
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
823
913
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
824
914
  * @property {Url} url - The page's url
@@ -834,6 +924,7 @@ export function cairoReloadErrorState(params: cairoReloadErrorStateParams): LogO
834
924
  * Event description: Sent when the "create new" process ends (and the result is shown to the user)
835
925
  *
836
926
  * @param {newItemCreationEndParams} params - The parameters for this event
927
+ * @property {string} appId
837
928
  * @property {string} artifactId - Artifact that owns the component
838
929
  * @property {string} cairoVersion
839
930
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -843,6 +934,7 @@ export function cairoReloadErrorState(params: cairoReloadErrorStateParams): LogO
843
934
  * @property {string} currentSortOrder - sort order
844
935
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
845
936
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
937
+ * @property {boolean} isTPA
846
938
  * @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
847
939
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
848
940
  * @property {number} maxItems - Max number of items that can be selected
@@ -868,12 +960,14 @@ export function newItemCreationEnd(params: newItemCreationEndParams): LogObject<
868
960
  * Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
869
961
  *
870
962
  * @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
963
+ * @property {string} appId
871
964
  * @property {string} artifactId - Artifact that owns the component
872
965
  * @property {string} cairoVersion - Cairo version
873
966
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
874
967
  * @property {string} componentType - Component type
875
968
  * @property {GUID} csid - Cairo session ID
876
969
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
970
+ * @property {boolean} isTPA
877
971
  * @property {string} itemId - The entity ID (that the widget was loaded in its page)
878
972
  * @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
879
973
  * @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
@@ -891,6 +985,7 @@ export function cairoTagsWidgetLoaded(params: cairoTagsWidgetLoadedParams): LogO
891
985
  * Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
892
986
  *
893
987
  * @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
988
+ * @property {string} appId
894
989
  * @property {string} artifactId - Artifact that owns the component
895
990
  * @property {string} cairoVersion
896
991
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -900,6 +995,7 @@ export function cairoTagsWidgetLoaded(params: cairoTagsWidgetLoadedParams): LogO
900
995
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
901
996
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
902
997
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
998
+ * @property {boolean} isTPA
903
999
  * @property {string} notificationText - What is displayed to the user, localized
904
1000
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
905
1001
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -915,6 +1011,7 @@ export function cairoTableTopNotificationDismissed(params: cairoTableTopNotifica
915
1011
  * Event description: Send when a user click on a section CTA (show more / show less etc.)
916
1012
  *
917
1013
  * @param {cairoSectionCtaClickedParams} params - The parameters for this event
1014
+ * @property {string} appId
918
1015
  * @property {string} artifactId - Artifact that owns the component
919
1016
  * @property {string} cairoVersion - Cairo version
920
1017
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -924,6 +1021,7 @@ export function cairoTableTopNotificationDismissed(params: cairoTableTopNotifica
924
1021
  * @property {string} ctaName - cta key (show more / show less etc.)
925
1022
  * @property {string} ctaType - Main / Secondary / More actions
926
1023
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1024
+ * @property {boolean} isTPA
927
1025
  * @property {string} localizedCtaName - The CTA name, localized
928
1026
  * @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
929
1027
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -941,6 +1039,7 @@ export function cairoSectionCtaClicked(params: cairoSectionCtaClickedParams): Lo
941
1039
  * Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
942
1040
  *
943
1041
  * @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
1042
+ * @property {string} appId
944
1043
  * @property {string} artifactId - Artifact that owns the component
945
1044
  * @property {string} cairoVersion
946
1045
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -949,6 +1048,7 @@ export function cairoSectionCtaClicked(params: cairoSectionCtaClickedParams): Lo
949
1048
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
950
1049
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
951
1050
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1051
+ * @property {boolean} isTPA
952
1052
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
953
1053
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
954
1054
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -965,12 +1065,14 @@ export function cairoFileDownloadToastDisplayed(params: cairoFileDownloadToastDi
965
1065
  * 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.
966
1066
  *
967
1067
  * @param {cairoSearchResultsParams} params - The parameters for this event
1068
+ * @property {string} appId
968
1069
  * @property {string} artifactId - Artifact that owns the component
969
1070
  * @property {string} cairoVersion
970
1071
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
971
1072
  * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
972
1073
  * @property {GUID} csid
973
1074
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1075
+ * @property {boolean} isTPA
974
1076
  * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
975
1077
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
976
1078
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -988,6 +1090,7 @@ export function cairoSearchResults(params: cairoSearchResultsParams): LogObject<
988
1090
  * Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
989
1091
  *
990
1092
  * @param {cairoTagsModalEndProcessParams} params - The parameters for this event
1093
+ * @property {string} appId
991
1094
  * @property {string} artifactId - Artifact that owns the component
992
1095
  * @property {string} cairoVersion - Cairo version
993
1096
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -995,6 +1098,7 @@ export function cairoSearchResults(params: cairoSearchResultsParams): LogObject<
995
1098
  * @property {GUID} csid - Cairo session ID
996
1099
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
997
1100
  * @property {string} endType - Close without changes
1101
+ * @property {boolean} isTPA
998
1102
  * @property {number} numTags - How many tags are in the modal?
999
1103
  * @property {string} origin - Where did the user open Manage Tags modal from?
1000
1104
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1011,6 +1115,7 @@ export function cairoTagsModalEndProcess(params: cairoTagsModalEndProcessParams)
1011
1115
  * Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
1012
1116
  *
1013
1117
  * @param {cairoManageViewClickedParams} params - The parameters for this event
1118
+ * @property {string} appId
1014
1119
  * @property {string} artifactId - Artifact that owns the component
1015
1120
  * @property {string} cairoVersion - Cairo version
1016
1121
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1019,6 +1124,7 @@ export function cairoTagsModalEndProcess(params: cairoTagsModalEndProcessParams)
1019
1124
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1020
1125
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1021
1126
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1127
+ * @property {boolean} isTPA
1022
1128
  * @property {number} numFiltersInView - How many filters comprise the saved view
1023
1129
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1024
1130
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1034,12 +1140,14 @@ export function cairoManageViewClicked(params: cairoManageViewClickedParams): Lo
1034
1140
  * Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
1035
1141
  *
1036
1142
  * @param {cairoTagsModalStartLoadParams} params - The parameters for this event
1143
+ * @property {string} appId
1037
1144
  * @property {string} artifactId - Artifact that owns the component
1038
1145
  * @property {string} cairoVersion - Cairo version
1039
1146
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1040
1147
  * @property {string} componentType - Component type
1041
1148
  * @property {GUID} csid - Cairo session ID
1042
1149
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1150
+ * @property {boolean} isTPA
1043
1151
  * @property {number} numTags - How many tags are to be presented?
1044
1152
  * @property {string} origin - Where did the user open Manage Tags modal from?
1045
1153
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1057,6 +1165,7 @@ export function cairoTagsModalStartLoad(params: cairoTagsModalStartLoadParams):
1057
1165
  *
1058
1166
  * @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
1059
1167
  * @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)
1168
+ * @property {string} appId
1060
1169
  * @property {string} artifactId - Artifact that owns the component
1061
1170
  * @property {string} cairoVersion - cairo version
1062
1171
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1071,6 +1180,7 @@ export function cairoTagsModalStartLoad(params: cairoTagsModalStartLoadParams):
1071
1180
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1072
1181
  * @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.
1073
1182
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
1183
+ * @property {boolean} isTPA
1074
1184
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
1075
1185
  * @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
1076
1186
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1094,6 +1204,7 @@ export function cairoSortUnsuccessfulUpdateInServer(params: cairoSortUnsuccessfu
1094
1204
  * Event description: Sent when user changes selection in the Cairo export modal
1095
1205
  *
1096
1206
  * @param {cairoItemToggledInExportModalParams} params - The parameters for this event
1207
+ * @property {string} appId
1097
1208
  * @property {string} artifactId - Artifact that owns the component
1098
1209
  * @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}
1099
1210
  * @property {string} cairoVersion
@@ -1103,6 +1214,7 @@ export function cairoSortUnsuccessfulUpdateInServer(params: cairoSortUnsuccessfu
1103
1214
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1104
1215
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1105
1216
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1217
+ * @property {boolean} isTPA
1106
1218
  * @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
1107
1219
  * @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
1108
1220
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1119,6 +1231,7 @@ export function cairoItemToggledInExportModal(params: cairoItemToggledInExportMo
1119
1231
  * Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
1120
1232
  *
1121
1233
  * @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
1234
+ * @property {string} appId
1122
1235
  * @property {string} artifactId - Artifact that owns the component
1123
1236
  * @property {string} cairoVersion - cairo version
1124
1237
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1131,6 +1244,7 @@ export function cairoItemToggledInExportModal(params: cairoItemToggledInExportMo
1131
1244
  * @property {number} filteredListSize - How many items are to be presented (filtered)?
1132
1245
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1133
1246
  * @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.
1247
+ * @property {boolean} isTPA
1134
1248
  * @property {string} itemId - ID of the item that the user tries to drag
1135
1249
  * @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
1136
1250
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -1157,6 +1271,7 @@ export function cairoDragActionUnsuccessfulUpdateInServer(params: cairoDragActio
1157
1271
  * Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
1158
1272
  *
1159
1273
  * @param {cairoSearchForTagsParams} params - The parameters for this event
1274
+ * @property {string} appId
1160
1275
  * @property {string} artifactId - Artifact that owns the component
1161
1276
  * @property {string} cairoVersion - Cairo version
1162
1277
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1164,6 +1279,7 @@ export function cairoDragActionUnsuccessfulUpdateInServer(params: cairoDragActio
1164
1279
  * @property {GUID} csid - Cairo session id
1165
1280
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1166
1281
  * @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
1282
+ * @property {boolean} isTPA
1167
1283
  * @property {string} location - Where did the user search for the tag? Manage tags modal /
1168
1284
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1169
1285
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1183,6 +1299,7 @@ export function cairoSearchForTags(params: cairoSearchForTagsParams): LogObject<
1183
1299
  * @param {cairoManageViewActionSelectedParams} params - The parameters for this event
1184
1300
  * @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
1185
1301
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
1302
+ * @property {string} appId
1186
1303
  * @property {string} artifactId - Artifact that owns the component
1187
1304
  * @property {string} cairoVersion - cairo version
1188
1305
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1190,6 +1307,7 @@ export function cairoSearchForTags(params: cairoSearchForTagsParams): LogObject<
1190
1307
  * @property {GUID} csid
1191
1308
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1192
1309
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1310
+ * @property {boolean} isTPA
1193
1311
  * @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
1194
1312
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1195
1313
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1205,12 +1323,14 @@ export function cairoManageViewActionSelected(params: cairoManageViewActionSelec
1205
1323
  * Event description: Send when a user click on "Learn More" from Cairo component.
1206
1324
  *
1207
1325
  * @param {cairoLearnMoreParams} params - The parameters for this event
1326
+ * @property {string} appId
1208
1327
  * @property {string} artifactId - Artifact that owns the component
1209
1328
  * @property {string} cairoVersion - Cairo version
1210
1329
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1211
1330
  * @property {string} componentType - Section name (Folders)
1212
1331
  * @property {GUID} csid - Cairo session ID
1213
1332
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1333
+ * @property {boolean} isTPA
1214
1334
  * @property {string} origin - Where did the user click on "Learn more" from? Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
1215
1335
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1216
1336
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1227,6 +1347,7 @@ export function cairoLearnMore(params: cairoLearnMoreParams): LogObject<cairoLea
1227
1347
  *
1228
1348
  * @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
1229
1349
  * @property {string} actionName - Assign / Remove
1350
+ * @property {string} appId
1230
1351
  * @property {string} artifactId - Artifact that owns the component
1231
1352
  * @property {string} assignedTags - array of tags that were assigned (empty array if none)
1232
1353
  * @property {string} cairoVersion - Cairo version
@@ -1235,6 +1356,7 @@ export function cairoLearnMore(params: cairoLearnMoreParams): LogObject<cairoLea
1235
1356
  * @property {GUID} csid - Cairo session ID
1236
1357
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1237
1358
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
1359
+ * @property {boolean} isTPA
1238
1360
  * @property {string} itemIds - array of items ids that were selected
1239
1361
  * @property {number} numItems - How many items have been selected?
1240
1362
  * @property {string} origin - Where did the user make the action from?
@@ -1253,6 +1375,7 @@ export function cairoAssignTagsToEntities(params: cairoAssignTagsToEntitiesParam
1253
1375
  * Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
1254
1376
  *
1255
1377
  * @param {cairoPageCtaClickedParams} params - The parameters for this event
1378
+ * @property {string} appId
1256
1379
  * @property {string} artifactId - Artifact that owns the component
1257
1380
  * @property {string} cairoVersion - Cairo version
1258
1381
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1261,6 +1384,7 @@ export function cairoAssignTagsToEntities(params: cairoAssignTagsToEntitiesParam
1261
1384
  * @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
1262
1385
  * @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
1263
1386
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1387
+ * @property {boolean} isTPA
1264
1388
  * @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
1265
1389
  * @property {string} location - CTA location: TBD
1266
1390
  * @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
@@ -1281,6 +1405,7 @@ export function cairoPageCtaClicked(params: cairoPageCtaClickedParams): LogObjec
1281
1405
  * Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
1282
1406
  *
1283
1407
  * @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
1408
+ * @property {string} appId
1284
1409
  * @property {string} artifactId - Artifact that owns the component
1285
1410
  * @property {string} cairoVersion
1286
1411
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1288,6 +1413,7 @@ export function cairoPageCtaClicked(params: cairoPageCtaClickedParams): LogObjec
1288
1413
  * @property {GUID} csid
1289
1414
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1290
1415
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1416
+ * @property {boolean} isTPA
1291
1417
  * @property {string} notificationText - What is displayed to the user, localized
1292
1418
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1293
1419
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1304,6 +1430,7 @@ export function cairoTableTopNotificationDisplayed(params: cairoTableTopNotifica
1304
1430
  *
1305
1431
  * @param {cairoTryAgainClickedParams} params - The parameters for this event
1306
1432
  * @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
1433
+ * @property {string} appId
1307
1434
  * @property {string} artifactId - Artifact that owns the component
1308
1435
  * @property {string} cairoVersion - cairo version
1309
1436
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1312,6 +1439,7 @@ export function cairoTableTopNotificationDisplayed(params: cairoTableTopNotifica
1312
1439
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1313
1440
  * @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
1314
1441
  * @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
1442
+ * @property {boolean} isTPA
1315
1443
  * @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
1316
1444
  * @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
1317
1445
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1328,6 +1456,7 @@ export function cairoTryAgainClicked(params: cairoTryAgainClickedParams): LogObj
1328
1456
  * 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.
1329
1457
  *
1330
1458
  * @param {cairoFiltersPanelUsedParams} params - The parameters for this event
1459
+ * @property {string} appId
1331
1460
  * @property {string} artifactId - Artifact that owns the component
1332
1461
  * @property {string} cairoVersion
1333
1462
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1339,6 +1468,7 @@ export function cairoTryAgainClicked(params: cairoTryAgainClickedParams): LogObj
1339
1468
  * @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
1340
1469
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
1341
1470
  * @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)
1471
+ * @property {boolean} isTPA
1342
1472
  * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
1343
1473
  * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
1344
1474
  * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
@@ -1360,6 +1490,7 @@ export function cairoFiltersPanelUsed(params: cairoFiltersPanelUsedParams): LogO
1360
1490
  * Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
1361
1491
  *
1362
1492
  * @param {cairoDragItemParams} params - The parameters for this event
1493
+ * @property {string} appId
1363
1494
  * @property {string} artifactId - Artifact that owns the component
1364
1495
  * @property {string} cairoVersion - cairo version
1365
1496
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1375,6 +1506,7 @@ export function cairoFiltersPanelUsed(params: cairoFiltersPanelUsedParams): LogO
1375
1506
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1376
1507
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
1377
1508
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
1509
+ * @property {boolean} isTPA
1378
1510
  * @property {string} itemId - ID of the item that the user tries to drag.
1379
1511
  * @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
1380
1512
  * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
@@ -1393,6 +1525,7 @@ export function cairoDragItem(params: cairoDragItemParams): LogObject<cairoDragI
1393
1525
  * 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).
1394
1526
  *
1395
1527
  * @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
1528
+ * @property {string} appId
1396
1529
  * @property {string} artifactId - Artifact that owns the component
1397
1530
  * @property {string} cairoVersion
1398
1531
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1403,6 +1536,7 @@ export function cairoDragItem(params: cairoDragItemParams): LogObject<cairoDragI
1403
1536
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
1404
1537
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1405
1538
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1539
+ * @property {boolean} isTPA
1406
1540
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
1407
1541
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1408
1542
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1418,6 +1552,7 @@ export function cairoFileDownloadToastDismissed(params: cairoFileDownloadToastDi
1418
1552
  * Event description: Sent when the user tries to cancel the export process AFTER it has begun
1419
1553
  *
1420
1554
  * @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
1555
+ * @property {string} appId
1421
1556
  * @property {string} artifactId - Artifact that owns the component
1422
1557
  * @property {string} cairoVersion
1423
1558
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1426,6 +1561,7 @@ export function cairoFileDownloadToastDismissed(params: cairoFileDownloadToastDi
1426
1561
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1427
1562
  * @property {number} duration - How much time (in ms) did it take since the export process began
1428
1563
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1564
+ * @property {boolean} isTPA
1429
1565
  * @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.
1430
1566
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
1431
1567
  * @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
@@ -1446,6 +1582,7 @@ export function cairoUserAttemptsToCancelTheExport(params: cairoUserAttemptsToCa
1446
1582
  * Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
1447
1583
  *
1448
1584
  * @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
1585
+ * @property {string} appId
1449
1586
  * @property {string} artifactId - Artifact that owns the component
1450
1587
  * @property {string} cairoVersion
1451
1588
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1455,6 +1592,7 @@ export function cairoUserAttemptsToCancelTheExport(params: cairoUserAttemptsToCa
1455
1592
  * @property {number} filteredListSize - How many items are to presented (filtered)
1456
1593
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1457
1594
  * @property {boolean} isImmediate - Is it an immediate CTA
1595
+ * @property {boolean} isTPA
1458
1596
  * @property {number} itemsCnt - Number of total items picked
1459
1597
  * @property {number} listSize - How many items exist (full list)
1460
1598
  * @property {number} maxItems - Max items to select in picker
@@ -1473,6 +1611,7 @@ export function pickerPickModalCtaButtonClickOrImmediateCta(params: pickerPickMo
1473
1611
  * Event description: Sent when the user clicks the "create new" button
1474
1612
  *
1475
1613
  * @param {newItemCreationStartParams} params - The parameters for this event
1614
+ * @property {string} appId
1476
1615
  * @property {string} artifactId - Artifact that owns the component
1477
1616
  * @property {string} cairoVersion
1478
1617
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1482,6 +1621,7 @@ export function pickerPickModalCtaButtonClickOrImmediateCta(params: pickerPickMo
1482
1621
  * @property {string} currentSortOrder - sorts
1483
1622
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
1484
1623
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1624
+ * @property {boolean} isTPA
1485
1625
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
1486
1626
  * @property {number} maxItems - Max number of items that can be selected
1487
1627
  * @property {number} numColumns - columns
@@ -1505,6 +1645,7 @@ export function newItemCreationStart(params: newItemCreationStartParams): LogObj
1505
1645
  * Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
1506
1646
  *
1507
1647
  * @param {cairoViewSelectedParams} params - The parameters for this event
1648
+ * @property {string} appId
1508
1649
  * @property {string} artifactId - Artifact that owns the component
1509
1650
  * @property {string} cairoVersion
1510
1651
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1517,6 +1658,7 @@ export function newItemCreationStart(params: newItemCreationStartParams): LogObj
1517
1658
  * @property {boolean} isDefault - Is the selected view defined as default view?
1518
1659
  * @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
1519
1660
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1661
+ * @property {boolean} isTPA
1520
1662
  * @property {string} newViewName - Name of the newly selected view
1521
1663
  * @property {number} numFiltersActive - How many filters are active after view selection
1522
1664
  * @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
@@ -1535,12 +1677,14 @@ export function cairoViewSelected(params: cairoViewSelectedParams): LogObject<ca
1535
1677
  * Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
1536
1678
  *
1537
1679
  * @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
1680
+ * @property {string} appId
1538
1681
  * @property {string} artifactId - Artifact that owns the component
1539
1682
  * @property {string} cairoVersion - Cairo version
1540
1683
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1541
1684
  * @property {string} componentType - Component type
1542
1685
  * @property {GUID} csid - Cairo session ID
1543
1686
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1687
+ * @property {boolean} isTPA
1544
1688
  * @property {number} numColumns - How many columns are shown?
1545
1689
  * @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)
1546
1690
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1559,6 +1703,7 @@ export function cairoDataExAddCustomField(params: cairoDataExAddCustomFieldParam
1559
1703
  *
1560
1704
  * @param {cairoFilterToggledParams} params - The parameters for this event
1561
1705
  * @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
1706
+ * @property {string} appId
1562
1707
  * @property {string} artifactId - Artifact that owns the component
1563
1708
  * @property {string} cairoVersion
1564
1709
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1569,6 +1714,7 @@ export function cairoDataExAddCustomField(params: cairoDataExAddCustomFieldParam
1569
1714
  * @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
1570
1715
  * @property {string} filterValue - JSON containing filterName's new value
1571
1716
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1717
+ * @property {boolean} isTPA
1572
1718
  * @property {number} listSize - How many items exist (full list, unfiltered)
1573
1719
  * @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
1574
1720
  * @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
@@ -1587,12 +1733,14 @@ export function cairoFilterToggled(params: cairoFilterToggledParams): LogObject<
1587
1733
  *
1588
1734
  * @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
1589
1735
  * @property {string} actionName - Open / Close the advanced settings
1736
+ * @property {string} appId
1590
1737
  * @property {string} artifactId - Artifact that owns the component
1591
1738
  * @property {string} cairoVersion - Cairo version
1592
1739
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1593
1740
  * @property {string} componentType - Component type
1594
1741
  * @property {GUID} csid - Cairo session ID
1595
1742
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1743
+ * @property {boolean} isTPA
1596
1744
  * @property {string} origin - Where did the user click on "Advanced Settings" from? Add Custom Field Modal / Edit Custom Field Modal
1597
1745
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1598
1746
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1608,6 +1756,7 @@ export function cairoDataExCustomFieldAdvancesSettings(params: cairoDataExCustom
1608
1756
  * Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
1609
1757
  *
1610
1758
  * @param {cairoViewSavedParams} params - The parameters for this event
1759
+ * @property {string} appId
1611
1760
  * @property {string} artifactId - Artifact that owns the component
1612
1761
  * @property {string} cairoVersion - Cairo version
1613
1762
  * @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)
@@ -1619,6 +1768,7 @@ export function cairoDataExCustomFieldAdvancesSettings(params: cairoDataExCustom
1619
1768
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1620
1769
  * @property {boolean} isDefault - Is the saved view defined as default view?
1621
1770
  * @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)
1771
+ * @property {boolean} isTPA
1622
1772
  * @property {string} newViewName - Name of the newly created/saved/renamed view
1623
1773
  * @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
1624
1774
  * @property {number} numFiltersInView - How many filters comprise the saved view
@@ -1642,6 +1792,7 @@ export function cairoViewSaved(params: cairoViewSavedParams): LogObject<cairoVie
1642
1792
  * Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
1643
1793
  *
1644
1794
  * @param {cairoViewDeletedParams} params - The parameters for this event
1795
+ * @property {string} appId
1645
1796
  * @property {string} artifactId - Artifact that owns the component
1646
1797
  * @property {string} cairoVersion
1647
1798
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1649,6 +1800,7 @@ export function cairoViewSaved(params: cairoViewSavedParams): LogObject<cairoVie
1649
1800
  * @property {GUID} csid
1650
1801
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1651
1802
  * @property {boolean} isDefault - Was the deleted view defined as default view?
1803
+ * @property {boolean} isTPA
1652
1804
  * @property {number} numFiltersInView - How many filters comprised the deleted view
1653
1805
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1654
1806
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1669,6 +1821,7 @@ export function cairoViewDeleted(params: cairoViewDeletedParams): LogObject<cair
1669
1821
  *
1670
1822
  * @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
1671
1823
  * @property {string} actionName - Add/ Edit
1824
+ * @property {string} appId
1672
1825
  * @property {string} artifactId - Artifact that owns the component
1673
1826
  * @property {string} cairoVersion - Cairo version
1674
1827
  * @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
@@ -1680,6 +1833,7 @@ export function cairoViewDeleted(params: cairoViewDeletedParams): LogObject<cair
1680
1833
  * @property {string} endType - What did the user chose in the modal? Add field / Cancel
1681
1834
  * @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
1682
1835
  * @property {string} fieldType - (Relevant when a field was added) What type is the added field? Long text / Date / Number etc.
1836
+ * @property {boolean} isTPA
1683
1837
  * @property {string} key - The key value
1684
1838
  * @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
1685
1839
  * @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
@@ -1699,6 +1853,7 @@ export function cairoDataExCustomFieldEndProcess(params: cairoDataExCustomFieldE
1699
1853
  * Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
1700
1854
  *
1701
1855
  * @param {cairoComponentSortedParams} params - The parameters for this event
1856
+ * @property {string} appId
1702
1857
  * @property {string} artifactId - Artifact that owns the component
1703
1858
  * @property {string} cairoVersion - Cairo version
1704
1859
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1707,6 +1862,7 @@ export function cairoDataExCustomFieldEndProcess(params: cairoDataExCustomFieldE
1707
1862
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1708
1863
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1709
1864
  * @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)
1865
+ * @property {boolean} isTPA
1710
1866
  * @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)
1711
1867
  * @property {number} listSize - How many items exist (full list, unfiltered)
1712
1868
  * @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)
@@ -1732,6 +1888,7 @@ export function cairoComponentSorted(params: cairoComponentSortedParams): LogObj
1732
1888
  * Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
1733
1889
  *
1734
1890
  * @param {cairoReorderingSortColumnsParams} params - The parameters for this event
1891
+ * @property {string} appId
1735
1892
  * @property {string} artifactId - Artifact that owns the component
1736
1893
  * @property {string} cairoVersion - Cairo version
1737
1894
  * @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)
@@ -1741,6 +1898,7 @@ export function cairoComponentSorted(params: cairoComponentSortedParams): LogObj
1741
1898
  * @property {GUID} csid
1742
1899
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1743
1900
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1901
+ * @property {boolean} isTPA
1744
1902
  * @property {number} listSize - How many items exist (full list, unfiltered)
1745
1903
  * @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.
1746
1904
  * @property {number} numSortingColumns - How many columns are been used for sorting the component?
@@ -1761,6 +1919,7 @@ export function cairoReorderingSortColumns(params: cairoReorderingSortColumnsPar
1761
1919
  * Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
1762
1920
  *
1763
1921
  * @param {cairoExportProcessEndParams} params - The parameters for this event
1922
+ * @property {string} appId
1764
1923
  * @property {string} artifactId - Artifact that owns the component
1765
1924
  * @property {string} cairoVersion
1766
1925
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1770,6 +1929,7 @@ export function cairoReorderingSortColumns(params: cairoReorderingSortColumnsPar
1770
1929
  * @property {number} duration - How much time (in ms) did it take since the export process began
1771
1930
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1772
1931
  * @property {string} fileName - (Optional) Name of the file to be exported
1932
+ * @property {boolean} isTPA
1773
1933
  * @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.
1774
1934
  * @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
1775
1935
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1790,6 +1950,7 @@ export function cairoExportProcessEnd(params: cairoExportProcessEndParams): LogO
1790
1950
  * Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
1791
1951
  *
1792
1952
  * @param {cairoApplyButtonClickedParams} params - The parameters for this event
1953
+ * @property {string} appId
1793
1954
  * @property {string} artifactId
1794
1955
  * @property {string} cairoVersion - Cairo version
1795
1956
  * @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
@@ -1800,6 +1961,7 @@ export function cairoExportProcessEnd(params: cairoExportProcessEndParams): LogO
1800
1961
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1801
1962
  * @property {string} feature - Filters / Drag and Drop
1802
1963
  * @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
1964
+ * @property {boolean} isTPA
1803
1965
  * @property {number} listSize - How many items exist (full list, unfiltered)
1804
1966
  * @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)
1805
1967
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
@@ -1820,6 +1982,7 @@ export function cairoApplyButtonClicked(params: cairoApplyButtonClickedParams):
1820
1982
  *
1821
1983
  * @param {cairoExportModalCtaClickedParams} params - The parameters for this event
1822
1984
  * @property {string} action - Does the user want to proceed with the export or dismiss the modal
1985
+ * @property {string} appId
1823
1986
  * @property {string} artifactId - Artifact that owns the component
1824
1987
  * @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
1825
1988
  * @property {string} cairoVersion
@@ -1828,6 +1991,7 @@ export function cairoApplyButtonClicked(params: cairoApplyButtonClickedParams):
1828
1991
  * @property {GUID} csid
1829
1992
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1830
1993
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1994
+ * @property {boolean} isTPA
1831
1995
  * @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.
1832
1996
  * @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
1833
1997
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1847,6 +2011,7 @@ export function cairoExportModalCtaClicked(params: cairoExportModalCtaClickedPar
1847
2011
  *
1848
2012
  * @param {cairoUndoClickedParams} params - The parameters for this event
1849
2013
  * @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.)
2014
+ * @property {string} appId
1850
2015
  * @property {string} artifactId - Artifact that owns the component
1851
2016
  * @property {string} cairoVersion - cairo version
1852
2017
  * @property {string} changedAttributes - Which attributes have changed from the saved status to the current
@@ -1860,6 +2025,7 @@ export function cairoExportModalCtaClicked(params: cairoExportModalCtaClickedPar
1860
2025
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1861
2026
  * @property {number} filteredListSize - How many items are to be presented (filtered)
1862
2027
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
2028
+ * @property {boolean} isTPA
1863
2029
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1864
2030
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1865
2031
  * @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"}
@@ -1878,6 +2044,7 @@ export function cairoUndoClicked(params: cairoUndoClickedParams): LogObject<cair
1878
2044
  * Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
1879
2045
  *
1880
2046
  * @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
2047
+ * @property {string} appId
1881
2048
  * @property {string} artifactId - Artifact that owns the component
1882
2049
  * @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
1883
2050
  * @property {string} cairoVersion - Cairo version
@@ -1886,6 +2053,7 @@ export function cairoUndoClicked(params: cairoUndoClickedParams): LogObject<cair
1886
2053
  * @property {GUID} csid
1887
2054
  * @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)
1888
2055
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2056
+ * @property {boolean} isTPA
1889
2057
  * @property {string} pageType - Collection Page
1890
2058
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1891
2059
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1911,6 +2079,7 @@ export function cairoPageBackOrBreadcrumbClicked(params: cairoPageBackOrBreadcru
1911
2079
  * @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
1912
2080
  * @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
1913
2081
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2082
+ * @property {boolean} isTPA
1914
2083
  * @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
1915
2084
  * @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
1916
2085
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1928,12 +2097,14 @@ export function cairoTpaSCtaClicked(params: cairoTpaSCtaClickedParams): LogObjec
1928
2097
  * Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
1929
2098
  *
1930
2099
  * @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
2100
+ * @property {string} appId
1931
2101
  * @property {string} artifactId - Artifact that owns the component
1932
2102
  * @property {string} cairoVersion
1933
2103
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1934
2104
  * @property {string} componentType
1935
2105
  * @property {GUID} csid
1936
2106
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
2107
+ * @property {boolean} isTPA
1937
2108
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1938
2109
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1939
2110
  * @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
@@ -1949,6 +2120,7 @@ export function pikachuCategoriesDropdownButtonClicked(params: pikachuCategories
1949
2120
  *
1950
2121
  * @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
1951
2122
  * @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
2123
+ * @property {string} appId
1952
2124
  * @property {string} artifactId - Artifact that owns the component
1953
2125
  * @property {string} cairoVersion - Cairo version
1954
2126
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1956,6 +2128,7 @@ export function pikachuCategoriesDropdownButtonClicked(params: pikachuCategories
1956
2128
  * @property {GUID} csid - Cairo session ID
1957
2129
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1958
2130
  * @property {string} errorType - What is the type of the error? Technical issue / Network error
2131
+ * @property {boolean} isTPA
1959
2132
  * @property {number} numTags - How many tags are in the modal after this action?
1960
2133
  * @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
1961
2134
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1974,6 +2147,7 @@ export function cairoTagsUnsuccessfulUpdateInServer(params: cairoTagsUnsuccessfu
1974
2147
  *
1975
2148
  * @param {pickerModalUsabilityParams} params - The parameters for this event
1976
2149
  * @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
2150
+ * @property {string} appId
1977
2151
  * @property {string} artifactId - Artifact that owns the component
1978
2152
  * @property {string} cairoVersion
1979
2153
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1981,6 +2155,7 @@ export function cairoTagsUnsuccessfulUpdateInServer(params: cairoTagsUnsuccessfu
1981
2155
  * @property {GUID} csid
1982
2156
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
1983
2157
  * @property {number} filteredListSize - How many items are to presented (filtered)
2158
+ * @property {boolean} isTPA
1984
2159
  * @property {string} itemId - (Optional) ID of item checked
1985
2160
  * @property {number} itemsCnt - (Optional) Number of total items checked
1986
2161
  * @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
@@ -2005,6 +2180,7 @@ export function pickerModalUsability(params: pickerModalUsabilityParams): LogObj
2005
2180
  * Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
2006
2181
  *
2007
2182
  * @param {cairoSortPanelUsedParams} params - The parameters for this event
2183
+ * @property {string} appId
2008
2184
  * @property {string} artifactId
2009
2185
  * @property {string} cairoVersion - Cairo version
2010
2186
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2013,6 +2189,7 @@ export function pickerModalUsability(params: pickerModalUsabilityParams): LogObj
2013
2189
  * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
2014
2190
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2015
2191
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
2192
+ * @property {boolean} isTPA
2016
2193
  * @property {number} numSortedColumns - How many columns actively sort the data?
2017
2194
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2018
2195
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -2029,6 +2206,7 @@ export function cairoSortPanelUsed(params: cairoSortPanelUsedParams): LogObject<
2029
2206
  *
2030
2207
  * @param {cairoTagsAssignTagParams} params - The parameters for this event
2031
2208
  * @property {string} actionName - Assign / Remove
2209
+ * @property {string} appId
2032
2210
  * @property {string} artifactId - Artifact that owns the component
2033
2211
  * @property {string} cairoVersion - Cairo version
2034
2212
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2036,6 +2214,7 @@ export function cairoSortPanelUsed(params: cairoSortPanelUsedParams): LogObject<
2036
2214
  * @property {GUID} csid - Cairo session ID
2037
2215
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2038
2216
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
2217
+ * @property {boolean} isTPA
2039
2218
  * @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
2040
2219
  * @property {number} numItems - How many items have been selected?
2041
2220
  * @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
@@ -2056,6 +2235,7 @@ export function cairoTagsAssignTag(params: cairoTagsAssignTagParams): LogObject<
2056
2235
  * Event description: Sent when a Cairo's page can't be saved due to an error.
2057
2236
  *
2058
2237
  * @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
2238
+ * @property {string} appId
2059
2239
  * @property {string} artifactId - Artifact that owns the component
2060
2240
  * @property {string} cairoVersion - Cairo version
2061
2241
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2070,6 +2250,7 @@ export function cairoTagsAssignTag(params: cairoTagsAssignTagParams): LogObject<
2070
2250
  * @property {string} errorType - Technical issue / Logic error / Network error / External error
2071
2251
  * @property {number} filteredListSize - How many items are to be presented (filtered)
2072
2252
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
2253
+ * @property {boolean} isTPA
2073
2254
  * @property {string} pageType - Entity / Collection
2074
2255
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2075
2256
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)