@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,19 +1,21 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.cairoFiltersPanelUsed = exports.cairoTryAgainClicked = exports.cairoTableTopNotificationDisplayed = exports.cairoPageCtaClicked = exports.cairoAssignTagsToEntities = exports.cairoLearnMore = exports.cairoManageViewActionSelected = exports.cairoSearchForTags = exports.cairoDragActionUnsuccessfulUpdateInServer = exports.cairoItemToggledInExportModal = exports.cairoSortUnsuccessfulUpdateInServer = exports.cairoTagsModalStartLoad = exports.cairoManageViewClicked = exports.cairoTagsModalEndProcess = exports.cairoSearchResults = exports.cairoFileDownloadToastDisplayed = exports.cairoSectionCtaClicked = exports.cairoTableTopNotificationDismissed = exports.cairoTagsWidgetLoaded = exports.newItemCreationEnd = exports.cairoReloadErrorState = exports.cairoErrorInLoadingAComponent = exports.cairoDataExtensionUnsuccessfulUpdateInServer = exports.cairoTagsWidgetClickOnCta = exports.cairoChangesBeforeApply = exports.cairoCtaClicked = exports.cairoAllFiltersCleared = exports.cairoModalCtaClicked = exports.cairoViewsUnsuccessfulUpdateInServer = exports.cairoTabSelected = exports.cairoFileDownloadToastDownloadButtonClicked = exports.cairoPageDiscardChangesBeforeSave = exports.cairoCancelExportModalCtaClicked = exports.cairoExportCtaClicked = exports.pikachuItemCategorySelected = exports.loadStart = exports.pickerStartLoad = exports.cairoSearchViewInViews = exports.cairoExportFailedModalCtaClicked = exports.cairoExportProcessStart = exports.cairoTagsAddDeleteTag = exports.loadEnd = exports.cairoNestedTableCollapseAndExpand = exports.pickerEndLoad = exports.cairoItemSelectionToggled = exports.cairoDiscardChangesBeforeApply = exports.pickerPickerOpenButton = exports.cairoDragItemEndDrop = exports.loadMore = exports.componentDismissed = void 0;
4
- exports.cairoApiRequestDataLoadEnd = exports.cairoTagsAssignTag = exports.cairoSortPanelUsed = exports.pickerModalUsability = exports.cairoTagsUnsuccessfulUpdateInServer = exports.pikachuCategoriesDropdownButtonClicked = exports.cairoTpaSCtaClicked = exports.cairoPageBackOrBreadcrumbClicked = exports.cairoUndoClicked = exports.cairoExportModalCtaClicked = exports.cairoApplyButtonClicked = exports.cairoExportProcessEnd = exports.cairoReorderingSortColumns = exports.cairoComponentSorted = exports.cairoDataExCustomFieldEndProcess = exports.cairoViewDeleted = exports.cairoViewSaved = exports.cairoDataExCustomFieldAdvancesSettings = exports.cairoFilterToggled = exports.cairoDataExAddCustomField = exports.cairoViewSelected = exports.newItemCreationStart = exports.pickerPickModalCtaButtonClickOrImmediateCta = exports.cairoUserAttemptsToCancelTheExport = exports.cairoFileDownloadToastDismissed = exports.cairoDragItem = void 0;
3
+ exports.cairoTryAgainClicked = exports.cairoTableTopNotificationDisplayed = exports.cairoPageCtaClicked = exports.cairoAssignTagsToEntities = exports.cairoLearnMore = exports.cairoManageViewActionSelected = exports.cairoSearchForTags = exports.cairoDragActionUnsuccessfulUpdateInServer = exports.cairoItemToggledInExportModal = exports.cairoSortUnsuccessfulUpdateInServer = exports.cairoTagsModalStartLoad = exports.cairoManageViewClicked = exports.cairoTagsModalEndProcess = exports.cairoSearchResults = exports.cairoFileDownloadToastDisplayed = exports.cairoSectionCtaClicked = exports.cairoTableTopNotificationDismissed = exports.cairoTagsWidgetLoaded = exports.newItemCreationEnd = exports.cairoReloadErrorState = exports.cairoErrorInLoadingAComponent = exports.cairoDataExtensionUnsuccessfulUpdateInServer = exports.cairoTagsWidgetClickOnCta = exports.cairoChangesBeforeApply = exports.cairoCtaClicked = exports.cairoAllFiltersCleared = exports.cairoModalCtaClicked = exports.cairoViewsUnsuccessfulUpdateInServer = exports.cairoTabSelected = exports.cairoCustomizeColumnsInSidePanel = exports.cairoFileDownloadToastDownloadButtonClicked = exports.cairoPageDiscardChangesBeforeSave = exports.cairoCancelExportModalCtaClicked = exports.cairoExportCtaClicked = exports.pikachuItemCategorySelected = exports.loadStart = exports.pickerStartLoad = exports.cairoSearchViewInViews = exports.cairoExportFailedModalCtaClicked = exports.cairoExportProcessStart = exports.cairoTagsAddDeleteTag = exports.loadEnd = exports.cairoNestedTableCollapseAndExpand = exports.pickerEndLoad = exports.cairoItemSelectionToggled = exports.cairoDiscardChangesBeforeApply = exports.pickerPickerOpenButton = exports.cairoDragItemEndDrop = exports.loadMore = exports.componentDismissed = void 0;
4
+ exports.cairoApiRequestDataLoadEnd = exports.cairoTagsAssignTag = exports.cairoSortPanelUsed = exports.pickerModalUsability = exports.cairoTagsUnsuccessfulUpdateInServer = exports.pikachuCategoriesDropdownButtonClicked = exports.cairoTpaSCtaClicked = exports.cairoPageBackOrBreadcrumbClicked = exports.cairoUndoClicked = exports.cairoExportModalCtaClicked = exports.cairoApplyButtonClicked = exports.cairoExportProcessEnd = exports.cairoReorderingSortColumns = exports.cairoComponentSorted = exports.cairoDataExCustomFieldEndProcess = exports.cairoViewDeleted = exports.cairoViewSaved = exports.cairoDataExCustomFieldAdvancesSettings = exports.cairoFilterToggled = exports.cairoDataExAddCustomField = exports.cairoViewSelected = exports.newItemCreationStart = exports.pickerPickModalCtaButtonClickOrImmediateCta = exports.cairoUserAttemptsToCancelTheExport = exports.cairoFileDownloadToastDismissed = exports.cairoDragItem = exports.cairoFiltersPanelUsed = void 0;
5
5
  /**
6
6
  * A function to create a log object for the 'componentDismissed' event (evid: 113)
7
7
  *
8
8
  * Event description: Sent when a component is dismissed. Relevant components: Picker Modal.
9
9
  *
10
10
  * @param {componentDismissedParams} params - The parameters for this event
11
+ * @property {string} appId
11
12
  * @property {string} artifactId - Artifact that owns the component
12
13
  * @property {string} cairoVersion
13
14
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
14
15
  * @property {string} componentType - Picker Modal / Picker Dropdown
15
16
  * @property {GUID} csid
16
17
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
18
+ * @property {boolean} isTPA
17
19
  * @property {string} origin - X button/Cancel button
18
20
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
19
21
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -29,6 +31,7 @@ exports.componentDismissed = componentDismissed;
29
31
  * Event description: Sent when a Cairo component is done loading more items (after scrolling). Relevant components: Picker Standalone, Picker Modal, Table, Cards.
30
32
  *
31
33
  * @param {loadMoreParams} params - The parameters for this event
34
+ * @property {string} appId
32
35
  * @property {string} artifactId - Artifact that owns the component
33
36
  * @property {string} cairoVersion
34
37
  * @property {string} componentName - Component name, if there are two components of the same type per artifact
@@ -40,6 +43,7 @@ exports.componentDismissed = componentDismissed;
40
43
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
41
44
  * @property {string} domain - Optional domain name from FQDN (crm, stores, etc.)
42
45
  * @property {number} filteredListSize - How many items are to be presented (filtered)
46
+ * @property {boolean} isTPA
43
47
  * @property {number} loadedItems - How many new items were loaded in this action
44
48
  * @property {number} loadingTime - Component loading time in ms
45
49
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -56,6 +60,7 @@ exports.loadMore = loadMore;
56
60
  * Event description: Sent when a user finish to drag an item
57
61
  *
58
62
  * @param {cairoDragItemEndDropParams} params - The parameters for this event
63
+ * @property {string} appId
59
64
  * @property {string} artifactId - Artifact that owns the component
60
65
  * @property {string} cairoVersion - cairo version
61
66
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -77,6 +82,7 @@ exports.loadMore = loadMore;
77
82
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
78
83
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
79
84
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
85
+ * @property {boolean} isTPA
80
86
  * @property {string} itemId - ID of the item that the user tries to drag
81
87
  * @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
82
88
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -97,6 +103,7 @@ exports.cairoDragItemEndDrop = cairoDragItemEndDrop;
97
103
  *
98
104
  * @param {pickerPickerOpenButtonParams} params - The parameters for this event
99
105
  * @property {string} action - Any picker button option (render/hover/click)
106
+ * @property {string} appId
100
107
  * @property {string} artifactId - Artifact that owns the component
101
108
  * @property {string} cairoVersion
102
109
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -105,6 +112,7 @@ exports.cairoDragItemEndDrop = cairoDragItemEndDrop;
105
112
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
106
113
  * @property {number} filteredListSize - How many items are to presented (filtered)
107
114
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
115
+ * @property {boolean} isTPA
108
116
  * @property {number} listSize - How many items exist (full list)
109
117
  * @property {number} maxItems - Max items to select in picker
110
118
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -122,6 +130,7 @@ exports.pickerPickerOpenButton = pickerPickerOpenButton;
122
130
  * 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.
123
131
  *
124
132
  * @param {cairoDiscardChangesBeforeApplyParams} params - The parameters for this event
133
+ * @property {string} appId
125
134
  * @property {string} artifactId - Artifact that owns the component
126
135
  * @property {string} cairoVersion - Cairo version
127
136
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -130,6 +139,7 @@ exports.pickerPickerOpenButton = pickerPickerOpenButton;
130
139
  * @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)
131
140
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
132
141
  * @property {string} feature - Filters / Drag and Drop
142
+ * @property {boolean} isTPA
133
143
  * @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)
134
144
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
135
145
  * @property {number} numOptionalFields - (Optional, relevant for Filters) If there is an optional fields list (like for filters)- how many options are there?
@@ -148,6 +158,7 @@ exports.cairoDiscardChangesBeforeApply = cairoDiscardChangesBeforeApply;
148
158
  * Event description: Sent when a user select/deselects an item(s) in a list
149
159
  *
150
160
  * @param {cairoItemSelectionToggledParams} params - The parameters for this event
161
+ * @property {string} appId
151
162
  * @property {string} artifactId - Artifact that owns the component
152
163
  * @property {string} cairoVersion
153
164
  * @property {string} clickType - The click purpose : "Selection" / "Deselection"
@@ -165,6 +176,7 @@ exports.cairoDiscardChangesBeforeApply = cairoDiscardChangesBeforeApply;
165
176
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
166
177
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
167
178
  * @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").
179
+ * @property {boolean} isTPA
168
180
  * @property {string} itemId - ID of item that is checked/unchecked (isSelectAll = TRUE --> itemId = "All")
169
181
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item.
170
182
  * ** isSelectAll = TRUE --> itemIndex = 0
@@ -190,6 +202,7 @@ exports.cairoItemSelectionToggled = cairoItemSelectionToggled;
190
202
  * Event description: Cairo picker finished loading
191
203
  *
192
204
  * @param {pickerEndLoadParams} params - The parameters for this event
205
+ * @property {string} appId
193
206
  * @property {string} artifactId - Artifact that owns the component
194
207
  * @property {string} cairoVersion
195
208
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -198,6 +211,7 @@ exports.cairoItemSelectionToggled = cairoItemSelectionToggled;
198
211
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
199
212
  * @property {number} filteredListSize - How many items are to presented (filtered)
200
213
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
214
+ * @property {boolean} isTPA
201
215
  * @property {number} listSize - How many items exist (full list)
202
216
  * @property {number} loadingTime - ms
203
217
  * @property {number} maxItems - Max items to select in picker
@@ -216,6 +230,7 @@ exports.pickerEndLoad = pickerEndLoad;
216
230
  * 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)
217
231
  *
218
232
  * @param {cairoNestedTableCollapseAndExpandParams} params - The parameters for this event
233
+ * @property {string} appId
219
234
  * @property {string} artifactId - Artifact that owns the component
220
235
  * @property {string} cairoVersion - cairo version
221
236
  * @property {string} clickType - The click purpose : "Collapse" / "Expand"
@@ -232,6 +247,7 @@ exports.pickerEndLoad = pickerEndLoad;
232
247
  * @property {number} filteredListSize - How many items are to be presented (filtered)
233
248
  * @property {boolean} isFromSearch - Is the item selected from a list of search results
234
249
  * @property {boolean} isSelectAll - True if the user chose to collapse / expand all categories simultaneously
250
+ * @property {boolean} isTPA
235
251
  * @property {string} itemId - ID of the clicked item .If "Is select all"= true, then Null
236
252
  * @property {number} itemIndex - Out of the list of results, what is the index of the clicked item .If "Is select all"= true, then Null
237
253
  * @property {number} numLevels - How many levels (or steps) exist in the selected item's hierarchy?
@@ -250,6 +266,7 @@ exports.cairoNestedTableCollapseAndExpand = cairoNestedTableCollapseAndExpand;
250
266
  * Event description: Sent when a Cairo component is done loading. Relevant components: Picker Standalone, Picker Modal, Table, Cards.
251
267
  *
252
268
  * @param {loadEndParams} params - The parameters for this event
269
+ * @property {string} appId
253
270
  * @property {string} artifactId - Artifact that owns the component
254
271
  * @property {string} cairoVersion
255
272
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -264,6 +281,7 @@ exports.cairoNestedTableCollapseAndExpand = cairoNestedTableCollapseAndExpand;
264
281
  * @property {number} filteredListSize - How many items are to be presented (filtered)
265
282
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
266
283
  * @property {boolean} isInternalPage - Is under bo.wix.com (new from 03/2023)
284
+ * @property {boolean} isTPA
267
285
  * @property {number} listSize - How many items exist (full list, unfiltered). Relevant for Picker.
268
286
  * @property {number} loadingTime - Component loading time in ms
269
287
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -282,6 +300,7 @@ exports.loadEnd = loadEnd;
282
300
  *
283
301
  * @param {cairoTagsAddDeleteTagParams} params - The parameters for this event
284
302
  * @property {string} actionName - Add / Delete / Rename
303
+ * @property {string} appId
285
304
  * @property {string} artifactId - Artifact that owns the component
286
305
  * @property {string} cairoVersion - Cairo version
287
306
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -289,6 +308,7 @@ exports.loadEnd = loadEnd;
289
308
  * @property {GUID} csid - Cairo session ID
290
309
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
291
310
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
311
+ * @property {boolean} isTPA
292
312
  * @property {number} numTags - How many tags are in the modal after this action?
293
313
  * @property {string} origin - Where did the user make the action from? Tags Modal /
294
314
  * @property {string} previousName - (Relevant only for action name=Rename) The tag's name, before the change
@@ -307,6 +327,7 @@ exports.cairoTagsAddDeleteTag = cairoTagsAddDeleteTag;
307
327
  * Event description: Sent when the export process begins
308
328
  *
309
329
  * @param {cairoExportProcessStartParams} params - The parameters for this event
330
+ * @property {string} appId
310
331
  * @property {string} artifactId - Artifact that owns the component
311
332
  * @property {string} cairoVersion
312
333
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -314,6 +335,7 @@ exports.cairoTagsAddDeleteTag = cairoTagsAddDeleteTag;
314
335
  * @property {GUID} csid
315
336
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
316
337
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
338
+ * @property {boolean} isTPA
317
339
  * @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.
318
340
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
319
341
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -332,6 +354,7 @@ exports.cairoExportProcessStart = cairoExportProcessStart;
332
354
  * Event description: Sent when the user clicks a CTA in the "Export Failed" modal
333
355
  *
334
356
  * @param {cairoExportFailedModalCtaClickedParams} params - The parameters for this event
357
+ * @property {string} appId
335
358
  * @property {string} artifactId - Artifact that owns the component
336
359
  * @property {string} cairoVersion
337
360
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -340,6 +363,7 @@ exports.cairoExportProcessStart = cairoExportProcessStart;
340
363
  * @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)
341
364
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
342
365
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
366
+ * @property {boolean} isTPA
343
367
  * @property {number} numItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
344
368
  * @property {number} numItemsExported - How many items were exported before the export failed.
345
369
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -359,6 +383,7 @@ exports.cairoExportFailedModalCtaClicked = cairoExportFailedModalCtaClicked;
359
383
  * 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.
360
384
  *
361
385
  * @param {cairoSearchViewInViewsParams} params - The parameters for this event
386
+ * @property {string} appId
362
387
  * @property {string} artifactId - Artifact that owns the component
363
388
  * @property {string} cairoVersion - Cairo version
364
389
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -366,6 +391,7 @@ exports.cairoExportFailedModalCtaClicked = cairoExportFailedModalCtaClicked;
366
391
  * @property {GUID} csid
367
392
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
368
393
  * @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).
394
+ * @property {boolean} isTPA
369
395
  * @property {number} numCategoriesInResults - Out of searchResultsCnt - how many results are from type of "categories"?
370
396
  * @property {number} numViews - The distinct views IDs the users has when he searches a view
371
397
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -384,6 +410,7 @@ exports.cairoSearchViewInViews = cairoSearchViewInViews;
384
410
  * Event description: Cairo picker starts loading
385
411
  *
386
412
  * @param {pickerStartLoadParams} params - The parameters for this event
413
+ * @property {string} appId
387
414
  * @property {string} artifactId - Artifact that owns the component
388
415
  * @property {string} cairoVersion
389
416
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -392,6 +419,7 @@ exports.cairoSearchViewInViews = cairoSearchViewInViews;
392
419
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
393
420
  * @property {number} filteredListSize - How many items are to presented (filtered)
394
421
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
422
+ * @property {boolean} isTPA
395
423
  * @property {number} listSize - How many items exist (full list)
396
424
  * @property {number} maxItems - Max items to select in picker
397
425
  * @property {string} product - Name of the product / api. E.g. contacts, booking, site_properties, etc. from FDQN
@@ -410,6 +438,7 @@ exports.pickerStartLoad = pickerStartLoad;
410
438
  *
411
439
  * @param {loadStartParams} params - The parameters for this event
412
440
  * @property {string} additionalFeaturesAvailability - Json field :({featureName: boolean}) (new from 06/2023), for features that don't suppose to impact performance
441
+ * @property {string} appId
413
442
  * @property {string} artifactId - Artifact that owns the component
414
443
  * @property {string} cairoVersion - cairo version
415
444
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -421,6 +450,7 @@ exports.pickerStartLoad = pickerStartLoad;
421
450
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
422
451
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
423
452
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
453
+ * @property {boolean} isTPA
424
454
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
425
455
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
426
456
  * @property {Url} url - The page's url (new from 03/2023)
@@ -436,12 +466,14 @@ exports.loadStart = loadStart;
436
466
  * Event description: Sent when user selects a category from the Pikachu category menu (e.g. Coupons/Services/Products)
437
467
  *
438
468
  * @param {pikachuItemCategorySelectedParams} params - The parameters for this event
469
+ * @property {string} appId
439
470
  * @property {string} artifactId - Artifact that owns the component
440
471
  * @property {string} cairoVersion
441
472
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
442
473
  * @property {string} componentType
443
474
  * @property {GUID} csid
444
475
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
476
+ * @property {boolean} isTPA
445
477
  * @property {string} itemCategory - Which type of item would we like to pick: 'Collection'/'Product'/'Service'/'Coupon'/'Standalone form'/'Invoice'/'Price quote'
446
478
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
447
479
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -457,6 +489,7 @@ exports.pikachuItemCategorySelected = pikachuItemCategorySelected;
457
489
  * Event description: Sent when a user clicks the "Export" CTA in a Cairo component
458
490
  *
459
491
  * @param {cairoExportCtaClickedParams} params - The parameters for this event
492
+ * @property {string} appId
460
493
  * @property {string} artifactId - Artifact that owns the component
461
494
  * @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}
462
495
  * @property {string} cairoVersion
@@ -467,6 +500,7 @@ exports.pikachuItemCategorySelected = pikachuItemCategorySelected;
467
500
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
468
501
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
469
502
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
503
+ * @property {boolean} isTPA
470
504
  * @property {number} numSelectedItems - How many items does the user wish to export
471
505
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
472
506
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -482,6 +516,7 @@ exports.cairoExportCtaClicked = cairoExportCtaClicked;
482
516
  * Event description: Sent when the user clicks any of the CTAs in the "Cancel the export?" modal
483
517
  *
484
518
  * @param {cairoCancelExportModalCtaClickedParams} params - The parameters for this event
519
+ * @property {string} appId
485
520
  * @property {string} artifactId - Artifact that owns the component
486
521
  * @property {string} cairoVersion
487
522
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -491,6 +526,7 @@ exports.cairoExportCtaClicked = cairoExportCtaClicked;
491
526
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
492
527
  * @property {number} duration - How much time (in ms) did it take since the export process began
493
528
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
529
+ * @property {boolean} isTPA
494
530
  * @property {string} modalType - Did the user try to close the tab ("Browser") or cancel the export ("Export")
495
531
  * @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.
496
532
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
@@ -511,12 +547,14 @@ exports.cairoCancelExportModalCtaClicked = cairoCancelExportModalCtaClicked;
511
547
  * 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)
512
548
  *
513
549
  * @param {cairoPageDiscardChangesBeforeSaveParams} params - The parameters for this event
550
+ * @property {string} appId
514
551
  * @property {string} artifactId - Artifact that owns the component
515
552
  * @property {string} cairoVersion - Cairo version
516
553
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
517
554
  * @property {string} componentType - Table/Cards / Picker
518
555
  * @property {GUID} csid - Cairo session ID
519
556
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
557
+ * @property {boolean} isTPA
520
558
  * @property {number} numOfActions - Number of changed fields that their changes can be lost
521
559
  * @property {number} numOfFields - How many fields are there that can be change in this page?
522
560
  * @property {string} origin - Cancel CTA / Breadcrumbs / Back button / Navigation
@@ -535,6 +573,7 @@ exports.cairoPageDiscardChangesBeforeSave = cairoPageDiscardChangesBeforeSave;
535
573
  * Event description: Sent when the user clicks the "Download Manually" button in the toast that is displayed after the export process is complete
536
574
  *
537
575
  * @param {cairoFileDownloadToastDownloadButtonClickedParams} params - The parameters for this event
576
+ * @property {string} appId
538
577
  * @property {string} artifactId - Artifact that owns the component
539
578
  * @property {string} cairoVersion
540
579
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -544,6 +583,7 @@ exports.cairoPageDiscardChangesBeforeSave = cairoPageDiscardChangesBeforeSave;
544
583
  * @property {number} duration - How much time (in ms) was the notification displayed before the button was clicked
545
584
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
546
585
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
586
+ * @property {boolean} isTPA
547
587
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
548
588
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
549
589
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -553,12 +593,43 @@ function cairoFileDownloadToastDownloadButtonClicked(params) {
553
593
  return { evid: 134, src: 144, endpoint: 'cairo-os', params: params };
554
594
  }
555
595
  exports.cairoFileDownloadToastDownloadButtonClicked = cairoFileDownloadToastDownloadButtonClicked;
596
+ /**
597
+ * A function to create a log object for the 'cairoCustomizeColumnsInSidePanel' event (evid: 177)
598
+ *
599
+ * 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.
600
+ *
601
+ * @param {cairoCustomizeColumnsInSidePanelParams} params - The parameters for this event
602
+ * @property {string} actionName - Visibility / Reorder
603
+ * @property {string} appId
604
+ * @property {string} artifactId - Artifact that owns the component
605
+ * @property {string} cairoVersion - version
606
+ * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
607
+ * @property {string} componentType - Table/Cards
608
+ * @property {GUID} csid - cairo session id
609
+ * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards. (new field from 01/2023)
610
+ * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
611
+ * @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)
612
+ * @property {boolean} isTPA
613
+ * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
614
+ * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
615
+ * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
616
+ * @property {number} numSortedColumns - How many columns actively sort the data? (new field from 01/2023)
617
+ * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
618
+ * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
619
+ * @property {string} visibleColumnsOrder - Which columns are currently shown to the user - by the order the user defined (new field from 01/2023)
620
+ * @return {LogObject<cairoCustomizeColumnsInSidePanelParams>} LogObject<cairoCustomizeColumnsInSidePanelParams>
621
+ */
622
+ function cairoCustomizeColumnsInSidePanel(params) {
623
+ return { evid: 177, src: 144, endpoint: 'cairo-os', params: params };
624
+ }
625
+ exports.cairoCustomizeColumnsInSidePanel = cairoCustomizeColumnsInSidePanel;
556
626
  /**
557
627
  * A function to create a log object for the 'cairoTabSelected' event (evid: 121)
558
628
  *
559
629
  * Event description: Sent when a user selects a tab in a Cairo component. Relevant components: Table, Cards.
560
630
  *
561
631
  * @param {cairoTabSelectedParams} params - The parameters for this event
632
+ * @property {string} appId
562
633
  * @property {string} artifactId - Artifact that owns the component
563
634
  * @property {string} cairoVersion
564
635
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -567,6 +638,7 @@ exports.cairoFileDownloadToastDownloadButtonClicked = cairoFileDownloadToastDown
567
638
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
568
639
  * @property {number} filteredListSize - How many items are currently presented to user, after new tab selection
569
640
  * @property {boolean} hasAllTab - TRUE if "All" tab is displayed for this component; FALSE otherwise
641
+ * @property {boolean} isTPA
570
642
  * @property {string} newTabId - Name of the newly selected tab
571
643
  * @property {number} newTabIndex - Index of the newly selected tab. 1 <= newTabIndex <= numTabs.
572
644
  * @property {number} numTabs - How many tabs are dispalyed to the user
@@ -587,6 +659,7 @@ exports.cairoTabSelected = cairoTabSelected;
587
659
  *
588
660
  * @param {cairoViewsUnsuccessfulUpdateInServerParams} params - The parameters for this event
589
661
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
662
+ * @property {string} appId
590
663
  * @property {string} artifactId - Artifact that owns the component
591
664
  * @property {string} cairoVersion - cairo version
592
665
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -601,6 +674,7 @@ exports.cairoTabSelected = cairoTabSelected;
601
674
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
602
675
  * @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.
603
676
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
677
+ * @property {boolean} isTPA
604
678
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
605
679
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
606
680
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -619,6 +693,7 @@ exports.cairoViewsUnsuccessfulUpdateInServer = cairoViewsUnsuccessfulUpdateInSer
619
693
  * Event description: Sent when a user clicks on a CTA in an an opened modal
620
694
  *
621
695
  * @param {cairoModalCtaClickedParams} params - The parameters for this event
696
+ * @property {string} appId
622
697
  * @property {string} artifactId - Artifact that owns the component
623
698
  * @property {string} cairoVersion - cairo version
624
699
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -626,6 +701,7 @@ exports.cairoViewsUnsuccessfulUpdateInServer = cairoViewsUnsuccessfulUpdateInSer
626
701
  * @property {GUID} csid - Cairo session id
627
702
  * @property {string} ctaName - The CTA name the user chose to do in the modal (for example: save, cancel, archive etc.). English only, not localized
628
703
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
704
+ * @property {boolean} isTPA
629
705
  * @property {string} localizedCtaName - The CTA name, localized
630
706
  * @property {string} modalName - The modal's title (Archive custom field, etc.)
631
707
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -642,6 +718,7 @@ exports.cairoModalCtaClicked = cairoModalCtaClicked;
642
718
  * Event description: Sent when a user clears all of the filters used in a Cairo component. Relevant components: Table, Cards.
643
719
  *
644
720
  * @param {cairoAllFiltersClearedParams} params - The parameters for this event
721
+ * @property {string} appId
645
722
  * @property {string} artifactId - Artifact that owns the component
646
723
  * @property {string} cairoVersion
647
724
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -650,6 +727,7 @@ exports.cairoModalCtaClicked = cairoModalCtaClicked;
650
727
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
651
728
  * @property {string} filterNames - Comma separated list of filter names that have been cleared
652
729
  * @property {number} filteredListSize - How many items were presented to user, before all of the filters were cleared
730
+ * @property {boolean} isTPA
653
731
  * @property {number} numFiltersCleared - How many filters have been cleared
654
732
  * @property {string} origin - "sidebar"/"toolbar"
655
733
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -666,6 +744,7 @@ exports.cairoAllFiltersCleared = cairoAllFiltersCleared;
666
744
  * 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.
667
745
  *
668
746
  * @param {cairoCtaClickedParams} params - The parameters for this event
747
+ * @property {string} appId
669
748
  * @property {string} artifactId - Artifact that owns the component
670
749
  * @property {string} cairoVersion
671
750
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -677,6 +756,7 @@ exports.cairoAllFiltersCleared = cairoAllFiltersCleared;
677
756
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
678
757
  * @property {number} filteredListSize - How many items are to be presented (filtered)
679
758
  * @property {boolean} isSelectAll - Are all items in the list selected. numItems = filteredListSize ==> isSelectAll = TRUE
759
+ * @property {boolean} isTPA
680
760
  * @property {string} itemId - ID of the item that the user clicked on its CTA
681
761
  * @property {number} itemIndex - Out of the list of items, what is the index of the clicked item . ** filteredListSize = X --> (1 <= itemIndex <= X)
682
762
  * @property {string} localizedCtaName - The CTA name, localized
@@ -701,6 +781,7 @@ exports.cairoCtaClicked = cairoCtaClicked;
701
781
  * 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.
702
782
  *
703
783
  * @param {cairoChangesBeforeApplyParams} params - The parameters for this event
784
+ * @property {string} appId
704
785
  * @property {string} artifactId - Artifact that owns the component
705
786
  * @property {string} cairoVersion - Cairo version
706
787
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -711,6 +792,7 @@ exports.cairoCtaClicked = cairoCtaClicked;
711
792
  * @property {string} fieldName - The field that the user chose to change (not necessary to save) (Null if the user clicked on "clear")
712
793
  * @property {string} fieldValue - The chosen value of the field (Null if the user clicked on "clear")
713
794
  * @property {boolean} isClearButton - True if the user clicked on the clear button, False otherwise .
795
+ * @property {boolean} isTPA
714
796
  * @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)
715
797
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
716
798
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -727,12 +809,14 @@ exports.cairoChangesBeforeApply = cairoChangesBeforeApply;
727
809
  *
728
810
  * @param {cairoTagsWidgetClickOnCtaParams} params - The parameters for this event
729
811
  * @property {string} actionName - Assign tags / Create tags / Manage tags
812
+ * @property {string} appId
730
813
  * @property {string} artifactId - Artifact that owns the component
731
814
  * @property {string} cairoVersion - Cairo version
732
815
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
733
816
  * @property {string} componentType - Component type
734
817
  * @property {GUID} csid - Cairo session ID
735
818
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
819
+ * @property {boolean} isTPA
736
820
  * @property {string} itemId - The entity ID
737
821
  * @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
738
822
  * @property {number} numTagsAssigned - How many tags are already assigned to that item?
@@ -751,6 +835,7 @@ exports.cairoTagsWidgetClickOnCta = cairoTagsWidgetClickOnCta;
751
835
  *
752
836
  * @param {cairoDataExtensionUnsuccessfulUpdateInServerParams} params - The parameters for this event
753
837
  * @property {string} actionName - The action the user tried to do: Add/ Edit etc. (in English, not localized)
838
+ * @property {string} appId
754
839
  * @property {string} artifactId - Artifact that owns the component
755
840
  * @property {string} cairoVersion - cairo version
756
841
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -760,6 +845,7 @@ exports.cairoTagsWidgetClickOnCta = cairoTagsWidgetClickOnCta;
760
845
  * @property {string} errorType - What is the type of the error? Technical issue / Network error / 10k Limitation
761
846
  * @property {string} fieldName - The name the user typed
762
847
  * @property {string} fieldType - What type is the added field? Long text / Date / Number etc.
848
+ * @property {boolean} isTPA
763
849
  * @property {string} key - The key value
764
850
  * @property {string} origin - Where did the user click on "add custom field" from? Custom columns panel / Entity page
765
851
  * @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.
@@ -777,6 +863,7 @@ exports.cairoDataExtensionUnsuccessfulUpdateInServer = cairoDataExtensionUnsucce
777
863
  * Event description: Sent when a an error in Cairo component loading process happen . Relevant components: Picker Standalone, Picker Modal, Table, Cards.
778
864
  *
779
865
  * @param {cairoErrorInLoadingAComponentParams} params - The parameters for this event
866
+ * @property {string} appId
780
867
  * @property {string} artifactId - Artifact that owns the component
781
868
  * @property {string} cairoVersion - cairo version
782
869
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -791,6 +878,7 @@ exports.cairoDataExtensionUnsuccessfulUpdateInServer = cairoDataExtensionUnsucce
791
878
  * InitCustomFieldsDataExtensionFailed /
792
879
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
793
880
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
881
+ * @property {boolean} isTPA
794
882
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
795
883
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
796
884
  * @property {Url} url - The page's url
@@ -806,6 +894,7 @@ exports.cairoErrorInLoadingAComponent = cairoErrorInLoadingAComponent;
806
894
  * Event description: Sent when a an error in Cairo component loading process happened and the user reload the state
807
895
  *
808
896
  * @param {cairoReloadErrorStateParams} params - The parameters for this event
897
+ * @property {string} appId
809
898
  * @property {string} artifactId - Artifact that owns the component
810
899
  * @property {string} cairoVersion - cairo version
811
900
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -821,6 +910,7 @@ exports.cairoErrorInLoadingAComponent = cairoErrorInLoadingAComponent;
821
910
  * InitCustomFieldsDataExtensionFailed /
822
911
  * InitCustomFieldsWidgetContainerFailed / InitCustomFieldsDataExtensionFailed
823
912
  * @property {string} featuresAvailability - Json field :({featureName: boolean}) (new from 03/2023)
913
+ * @property {boolean} isTPA
824
914
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
825
915
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
826
916
  * @property {Url} url - The page's url
@@ -836,6 +926,7 @@ exports.cairoReloadErrorState = cairoReloadErrorState;
836
926
  * Event description: Sent when the "create new" process ends (and the result is shown to the user)
837
927
  *
838
928
  * @param {newItemCreationEndParams} params - The parameters for this event
929
+ * @property {string} appId
839
930
  * @property {string} artifactId - Artifact that owns the component
840
931
  * @property {string} cairoVersion
841
932
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -845,6 +936,7 @@ exports.cairoReloadErrorState = cairoReloadErrorState;
845
936
  * @property {string} currentSortOrder - sort order
846
937
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
847
938
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
939
+ * @property {boolean} isTPA
848
940
  * @property {string} itemId - resultType= "success" --> itemId = ID of newly created item; resultType = "dismissed" --> itemId = null
849
941
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
850
942
  * @property {number} maxItems - Max number of items that can be selected
@@ -870,12 +962,14 @@ exports.newItemCreationEnd = newItemCreationEnd;
870
962
  * Event description: Send when a Tags' widget is loaded. Relevant for Verticals who allow use tags in their tables.
871
963
  *
872
964
  * @param {cairoTagsWidgetLoadedParams} params - The parameters for this event
965
+ * @property {string} appId
873
966
  * @property {string} artifactId - Artifact that owns the component
874
967
  * @property {string} cairoVersion - Cairo version
875
968
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
876
969
  * @property {string} componentType - Component type
877
970
  * @property {GUID} csid - Cairo session ID
878
971
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
972
+ * @property {boolean} isTPA
879
973
  * @property {string} itemId - The entity ID (that the widget was loaded in its page)
880
974
  * @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
881
975
  * @property {number} numTagsAssigned - How many tags are assigned to that entity when the widget is loaded?
@@ -893,6 +987,7 @@ exports.cairoTagsWidgetLoaded = cairoTagsWidgetLoaded;
893
987
  * Event description: Sent when the notification at the top of the table is dismissed, either manually or automatically
894
988
  *
895
989
  * @param {cairoTableTopNotificationDismissedParams} params - The parameters for this event
990
+ * @property {string} appId
896
991
  * @property {string} artifactId - Artifact that owns the component
897
992
  * @property {string} cairoVersion
898
993
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -902,6 +997,7 @@ exports.cairoTagsWidgetLoaded = cairoTagsWidgetLoaded;
902
997
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
903
998
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
904
999
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1000
+ * @property {boolean} isTPA
905
1001
  * @property {string} notificationText - What is displayed to the user, localized
906
1002
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
907
1003
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -917,6 +1013,7 @@ exports.cairoTableTopNotificationDismissed = cairoTableTopNotificationDismissed;
917
1013
  * Event description: Send when a user click on a section CTA (show more / show less etc.)
918
1014
  *
919
1015
  * @param {cairoSectionCtaClickedParams} params - The parameters for this event
1016
+ * @property {string} appId
920
1017
  * @property {string} artifactId - Artifact that owns the component
921
1018
  * @property {string} cairoVersion - Cairo version
922
1019
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -926,6 +1023,7 @@ exports.cairoTableTopNotificationDismissed = cairoTableTopNotificationDismissed;
926
1023
  * @property {string} ctaName - cta key (show more / show less etc.)
927
1024
  * @property {string} ctaType - Main / Secondary / More actions
928
1025
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1026
+ * @property {boolean} isTPA
929
1027
  * @property {string} localizedCtaName - The CTA name, localized
930
1028
  * @property {string} loaction - CTA location: Section Toolbar, Collection Toolbar
931
1029
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -943,6 +1041,7 @@ exports.cairoSectionCtaClicked = cairoSectionCtaClicked;
943
1041
  * Event description: Sent when the export ends successfully and the user is prompted that the file is being downloaded
944
1042
  *
945
1043
  * @param {cairoFileDownloadToastDisplayedParams} params - The parameters for this event
1044
+ * @property {string} appId
946
1045
  * @property {string} artifactId - Artifact that owns the component
947
1046
  * @property {string} cairoVersion
948
1047
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -951,6 +1050,7 @@ exports.cairoSectionCtaClicked = cairoSectionCtaClicked;
951
1050
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
952
1051
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
953
1052
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1053
+ * @property {boolean} isTPA
954
1054
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
955
1055
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
956
1056
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -967,12 +1067,14 @@ exports.cairoFileDownloadToastDisplayed = cairoFileDownloadToastDisplayed;
967
1067
  * 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.
968
1068
  *
969
1069
  * @param {cairoSearchResultsParams} params - The parameters for this event
1070
+ * @property {string} appId
970
1071
  * @property {string} artifactId - Artifact that owns the component
971
1072
  * @property {string} cairoVersion
972
1073
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
973
1074
  * @property {string} componentType - Picker Standalone/Picker Modal/Table/Cards
974
1075
  * @property {GUID} csid
975
1076
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1077
+ * @property {boolean} isTPA
976
1078
  * @property {number} loadingTime - How much time (in ms) did it take to load the results for searchQuery
977
1079
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
978
1080
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -990,6 +1092,7 @@ exports.cairoSearchResults = cairoSearchResults;
990
1092
  * Event description: Send when a user click on button that will close "Tags Modal". Relevant for Verticals who allow use tags in their tables.
991
1093
  *
992
1094
  * @param {cairoTagsModalEndProcessParams} params - The parameters for this event
1095
+ * @property {string} appId
993
1096
  * @property {string} artifactId - Artifact that owns the component
994
1097
  * @property {string} cairoVersion - Cairo version
995
1098
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -997,6 +1100,7 @@ exports.cairoSearchResults = cairoSearchResults;
997
1100
  * @property {GUID} csid - Cairo session ID
998
1101
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
999
1102
  * @property {string} endType - Close without changes
1103
+ * @property {boolean} isTPA
1000
1104
  * @property {number} numTags - How many tags are in the modal?
1001
1105
  * @property {string} origin - Where did the user open Manage Tags modal from?
1002
1106
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1013,6 +1117,7 @@ exports.cairoTagsModalEndProcess = cairoTagsModalEndProcess;
1013
1117
  * Event description: Sent when a user clicks on "Manage View" in a Cairo component. Relevant components: Table, Cards.
1014
1118
  *
1015
1119
  * @param {cairoManageViewClickedParams} params - The parameters for this event
1120
+ * @property {string} appId
1016
1121
  * @property {string} artifactId - Artifact that owns the component
1017
1122
  * @property {string} cairoVersion - Cairo version
1018
1123
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1021,6 +1126,7 @@ exports.cairoTagsModalEndProcess = cairoTagsModalEndProcess;
1021
1126
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1022
1127
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1023
1128
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1129
+ * @property {boolean} isTPA
1024
1130
  * @property {number} numFiltersInView - How many filters comprise the saved view
1025
1131
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1026
1132
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1036,12 +1142,14 @@ exports.cairoManageViewClicked = cairoManageViewClicked;
1036
1142
  * Event description: Send when a user click on a "Tags Modal". Relevant for Verticals who allow use tags in their tables.
1037
1143
  *
1038
1144
  * @param {cairoTagsModalStartLoadParams} params - The parameters for this event
1145
+ * @property {string} appId
1039
1146
  * @property {string} artifactId - Artifact that owns the component
1040
1147
  * @property {string} cairoVersion - Cairo version
1041
1148
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1042
1149
  * @property {string} componentType - Component type
1043
1150
  * @property {GUID} csid - Cairo session ID
1044
1151
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1152
+ * @property {boolean} isTPA
1045
1153
  * @property {number} numTags - How many tags are to be presented?
1046
1154
  * @property {string} origin - Where did the user open Manage Tags modal from?
1047
1155
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1059,6 +1167,7 @@ exports.cairoTagsModalStartLoad = cairoTagsModalStartLoad;
1059
1167
  *
1060
1168
  * @param {cairoSortUnsuccessfulUpdateInServerParams} params - The parameters for this event
1061
1169
  * @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)
1170
+ * @property {string} appId
1062
1171
  * @property {string} artifactId - Artifact that owns the component
1063
1172
  * @property {string} cairoVersion - cairo version
1064
1173
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1073,6 +1182,7 @@ exports.cairoTagsModalStartLoad = cairoTagsModalStartLoad;
1073
1182
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1074
1183
  * @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.
1075
1184
  * @property {boolean} isFromSearch - Was the failed action made on a search results?
1185
+ * @property {boolean} isTPA
1076
1186
  * @property {number} numOfWaitingUpdates - number of updates in the sequence that follow the failed action
1077
1187
  * @property {string} origin - The location thefailed sort action was made from :"SidePanel"/"ColumnHeader"
1078
1188
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1096,6 +1206,7 @@ exports.cairoSortUnsuccessfulUpdateInServer = cairoSortUnsuccessfulUpdateInServe
1096
1206
  * Event description: Sent when user changes selection in the Cairo export modal
1097
1207
  *
1098
1208
  * @param {cairoItemToggledInExportModalParams} params - The parameters for this event
1209
+ * @property {string} appId
1099
1210
  * @property {string} artifactId - Artifact that owns the component
1100
1211
  * @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}
1101
1212
  * @property {string} cairoVersion
@@ -1105,6 +1216,7 @@ exports.cairoSortUnsuccessfulUpdateInServer = cairoSortUnsuccessfulUpdateInServe
1105
1216
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1106
1217
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1107
1218
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1219
+ * @property {boolean} isTPA
1108
1220
  * @property {string} newSelectedExportType - What type of export did the user switch to: "All Items"/"Filtered Items"/"Selected Items"
1109
1221
  * @property {string} prevSelectedExportType - What type of export did the user have selected before swiching to newSelectedExportType: "All Items"/"Filtered Items"/"Selected Items"
1110
1222
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1121,6 +1233,7 @@ exports.cairoItemToggledInExportModal = cairoItemToggledInExportModal;
1121
1233
  * Event description: Sent when a user finish to drag items but those changes weren't update in the server from different reasons
1122
1234
  *
1123
1235
  * @param {cairoDragActionUnsuccessfulUpdateInServerParams} params - The parameters for this event
1236
+ * @property {string} appId
1124
1237
  * @property {string} artifactId - Artifact that owns the component
1125
1238
  * @property {string} cairoVersion - cairo version
1126
1239
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1133,6 +1246,7 @@ exports.cairoItemToggledInExportModal = cairoItemToggledInExportModal;
1133
1246
  * @property {number} filteredListSize - How many items are to be presented (filtered)?
1134
1247
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the failed action?
1135
1248
  * @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.
1249
+ * @property {boolean} isTPA
1136
1250
  * @property {string} itemId - ID of the item that the user tries to drag
1137
1251
  * @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
1138
1252
  * @property {number} itemIndexBefore - Out of the list of results, what was the index of the clicked item (before dragging). ** filteredListSize = X --> (1 <= itemIndexBefore <= X)
@@ -1159,6 +1273,7 @@ exports.cairoDragActionUnsuccessfulUpdateInServer = cairoDragActionUnsuccessfulU
1159
1273
  * Event description: Sent when the search results are displayed, after a user searches for a tag. Relevant for tables that enabled using tags.
1160
1274
  *
1161
1275
  * @param {cairoSearchForTagsParams} params - The parameters for this event
1276
+ * @property {string} appId
1162
1277
  * @property {string} artifactId - Artifact that owns the component
1163
1278
  * @property {string} cairoVersion - Cairo version
1164
1279
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1166,6 +1281,7 @@ exports.cairoDragActionUnsuccessfulUpdateInServer = cairoDragActionUnsuccessfulU
1166
1281
  * @property {GUID} csid - Cairo session id
1167
1282
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1168
1283
  * @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
1284
+ * @property {boolean} isTPA
1169
1285
  * @property {string} location - Where did the user search for the tag? Manage tags modal /
1170
1286
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1171
1287
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1185,6 +1301,7 @@ exports.cairoSearchForTags = cairoSearchForTags;
1185
1301
  * @param {cairoManageViewActionSelectedParams} params - The parameters for this event
1186
1302
  * @property {number} actionIndex - 1 <= actionIndex <= numActions -- the number of the action out of all actions in the menu
1187
1303
  * @property {string} actionName - "Save as New View"/"Save Changes"/"Rename"/"Delete" etc... (in English, not localized)
1304
+ * @property {string} appId
1188
1305
  * @property {string} artifactId - Artifact that owns the component
1189
1306
  * @property {string} cairoVersion - cairo version
1190
1307
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1192,6 +1309,7 @@ exports.cairoSearchForTags = cairoSearchForTags;
1192
1309
  * @property {GUID} csid
1193
1310
  * @property {string} currentView - Which view is currently displayed to the user. Relevant for Table and Cards.
1194
1311
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1312
+ * @property {boolean} isTPA
1195
1313
  * @property {number} numActions - How many actions are existing in the current menu (including disabled actions)?
1196
1314
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1197
1315
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1207,12 +1325,14 @@ exports.cairoManageViewActionSelected = cairoManageViewActionSelected;
1207
1325
  * Event description: Send when a user click on "Learn More" from Cairo component.
1208
1326
  *
1209
1327
  * @param {cairoLearnMoreParams} params - The parameters for this event
1328
+ * @property {string} appId
1210
1329
  * @property {string} artifactId - Artifact that owns the component
1211
1330
  * @property {string} cairoVersion - Cairo version
1212
1331
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1213
1332
  * @property {string} componentType - Section name (Folders)
1214
1333
  * @property {GUID} csid - Cairo session ID
1215
1334
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1335
+ * @property {boolean} isTPA
1216
1336
  * @property {string} origin - Where did the user click on "Learn more" from? Add Custom Field Modal/ Edit Custom Field Modal / Table Toolbar
1217
1337
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1218
1338
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1229,6 +1349,7 @@ exports.cairoLearnMore = cairoLearnMore;
1229
1349
  *
1230
1350
  * @param {cairoAssignTagsToEntitiesParams} params - The parameters for this event
1231
1351
  * @property {string} actionName - Assign / Remove
1352
+ * @property {string} appId
1232
1353
  * @property {string} artifactId - Artifact that owns the component
1233
1354
  * @property {string} assignedTags - array of tags that were assigned (empty array if none)
1234
1355
  * @property {string} cairoVersion - Cairo version
@@ -1237,6 +1358,7 @@ exports.cairoLearnMore = cairoLearnMore;
1237
1358
  * @property {GUID} csid - Cairo session ID
1238
1359
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1239
1360
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
1361
+ * @property {boolean} isTPA
1240
1362
  * @property {string} itemIds - array of items ids that were selected
1241
1363
  * @property {number} numItems - How many items have been selected?
1242
1364
  * @property {string} origin - Where did the user make the action from?
@@ -1255,6 +1377,7 @@ exports.cairoAssignTagsToEntities = cairoAssignTagsToEntities;
1255
1377
  * Event description: Sent when a user clicks a Page CTA ('add', 'more actions' etc.).
1256
1378
  *
1257
1379
  * @param {cairoPageCtaClickedParams} params - The parameters for this event
1380
+ * @property {string} appId
1258
1381
  * @property {string} artifactId - Artifact that owns the component
1259
1382
  * @property {string} cairoVersion - Cairo version
1260
1383
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1263,6 +1386,7 @@ exports.cairoAssignTagsToEntities = cairoAssignTagsToEntities;
1263
1386
  * @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
1264
1387
  * @property {string} ctaType - Main / Secondary / More Actions Dropdown / More Actions Option
1265
1388
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1389
+ * @property {boolean} isTPA
1266
1390
  * @property {boolean} isValid - (Relevant only for Save CTA) True=if all fields are validated, False= if there are validation errors
1267
1391
  * @property {string} location - CTA location: TBD
1268
1392
  * @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
@@ -1283,6 +1407,7 @@ exports.cairoPageCtaClicked = cairoPageCtaClicked;
1283
1407
  * Event description: Sent when a notification is displayed, showing a message that appears between the table header and the table rows
1284
1408
  *
1285
1409
  * @param {cairoTableTopNotificationDisplayedParams} params - The parameters for this event
1410
+ * @property {string} appId
1286
1411
  * @property {string} artifactId - Artifact that owns the component
1287
1412
  * @property {string} cairoVersion
1288
1413
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1290,6 +1415,7 @@ exports.cairoPageCtaClicked = cairoPageCtaClicked;
1290
1415
  * @property {GUID} csid
1291
1416
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1292
1417
  * @property {number} filteredListSize - How many items are currently presented to user (full list, filtered)
1418
+ * @property {boolean} isTPA
1293
1419
  * @property {string} notificationText - What is displayed to the user, localized
1294
1420
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1295
1421
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1306,6 +1432,7 @@ exports.cairoTableTopNotificationDisplayed = cairoTableTopNotificationDisplayed;
1306
1432
  *
1307
1433
  * @param {cairoTryAgainClickedParams} params - The parameters for this event
1308
1434
  * @property {string} actionName - the action name that failed and triggered the notification (for example: drag, column reorder etc.)
1435
+ * @property {string} appId
1309
1436
  * @property {string} artifactId - Artifact that owns the component
1310
1437
  * @property {string} cairoVersion - cairo version
1311
1438
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1314,6 +1441,7 @@ exports.cairoTableTopNotificationDisplayed = cairoTableTopNotificationDisplayed;
1314
1441
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1315
1442
  * @property {number} filteredListSize - How many items were presented when the user made the failed action (filtered)
1316
1443
  * @property {boolean} isFromSearch - Did the user made the failed action on a list of search results
1444
+ * @property {boolean} isTPA
1317
1445
  * @property {string} loaction - Toast / Custom fields widget / View only widget / Component error state
1318
1446
  * @property {number} numOfWaitingUpdates - (optional) number of updates in the sequence that follow the failed action
1319
1447
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1330,6 +1458,7 @@ exports.cairoTryAgainClicked = cairoTryAgainClicked;
1330
1458
  * 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.
1331
1459
  *
1332
1460
  * @param {cairoFiltersPanelUsedParams} params - The parameters for this event
1461
+ * @property {string} appId
1333
1462
  * @property {string} artifactId - Artifact that owns the component
1334
1463
  * @property {string} cairoVersion
1335
1464
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1341,6 +1470,7 @@ exports.cairoTryAgainClicked = cairoTryAgainClicked;
1341
1470
  * @property {string} feature - Filter / Sort / Costume Columns / Manage Views / Manage custom fields (new field from 01/2023)/Tags
1342
1471
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
1343
1472
  * @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)
1473
+ * @property {boolean} isTPA
1344
1474
  * @property {number} numColumns - How many columns are shown? (new field from 01/2023)
1345
1475
  * @property {number} numFiltersActive - The number of active filters when the user opened/closed the panel/menu
1346
1476
  * @property {number} numFiltersInView - How many filters comprise the saved view (new field from 01/2023)
@@ -1362,6 +1492,7 @@ exports.cairoFiltersPanelUsed = cairoFiltersPanelUsed;
1362
1492
  * Event description: Sent when a user clicks on an item and tries to drag it, in order to sort the items manually
1363
1493
  *
1364
1494
  * @param {cairoDragItemParams} params - The parameters for this event
1495
+ * @property {string} appId
1365
1496
  * @property {string} artifactId - Artifact that owns the component
1366
1497
  * @property {string} cairoVersion - cairo version
1367
1498
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1377,6 +1508,7 @@ exports.cairoFiltersPanelUsed = cairoFiltersPanelUsed;
1377
1508
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1378
1509
  * @property {boolean} isFromHandle - Is the item dragged from the handle area?
1379
1510
  * @property {boolean} isFromSearch - Did the user try to drag the item from a list of search results (relate to ticket 521).
1511
+ * @property {boolean} isTPA
1380
1512
  * @property {string} itemId - ID of the item that the user tries to drag.
1381
1513
  * @property {number} itemIndex - Out of the list of results, what was the index of the dragged item (before dragging). ** filteredListSize = X --> (1 <= itemIndex <= X)
1382
1514
  * @property {number} numItemsBefore - (relate to ticket 526). How many items have been selected before user clicks item and starts the drag action?
@@ -1395,6 +1527,7 @@ exports.cairoDragItem = cairoDragItem;
1395
1527
  * 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).
1396
1528
  *
1397
1529
  * @param {cairoFileDownloadToastDismissedParams} params - The parameters for this event
1530
+ * @property {string} appId
1398
1531
  * @property {string} artifactId - Artifact that owns the component
1399
1532
  * @property {string} cairoVersion
1400
1533
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1405,6 +1538,7 @@ exports.cairoDragItem = cairoDragItem;
1405
1538
  * @property {number} duration - How much time (in ms) was the notification displayed before it was dismissed
1406
1539
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1407
1540
  * @property {string} exportType - What type of export did the user choose: "All Items"/"Filtered Items"/"Selected Items"
1541
+ * @property {boolean} isTPA
1408
1542
  * @property {number} numSelectedItems - How many items did the user export. If no items have been selected (selectedExportType = "All Items"), then all items in list.
1409
1543
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1410
1544
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1420,6 +1554,7 @@ exports.cairoFileDownloadToastDismissed = cairoFileDownloadToastDismissed;
1420
1554
  * Event description: Sent when the user tries to cancel the export process AFTER it has begun
1421
1555
  *
1422
1556
  * @param {cairoUserAttemptsToCancelTheExportParams} params - The parameters for this event
1557
+ * @property {string} appId
1423
1558
  * @property {string} artifactId - Artifact that owns the component
1424
1559
  * @property {string} cairoVersion
1425
1560
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1428,6 +1563,7 @@ exports.cairoFileDownloadToastDismissed = cairoFileDownloadToastDismissed;
1428
1563
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1429
1564
  * @property {number} duration - How much time (in ms) did it take since the export process began
1430
1565
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1566
+ * @property {boolean} isTPA
1431
1567
  * @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.
1432
1568
  * @property {number} numItemsExported - How many items were exported before the user tried to cancel the export
1433
1569
  * @property {string} origin - How did the user try to cancel the export process: "Tab Closed"/"Cancel Buton"/"X Button"
@@ -1448,6 +1584,7 @@ exports.cairoUserAttemptsToCancelTheExport = cairoUserAttemptsToCancelTheExport;
1448
1584
  * Event description: Actual pick inside the Cairo picker (CTA button or immediate CTA)
1449
1585
  *
1450
1586
  * @param {pickerPickModalCtaButtonClickOrImmediateCtaParams} params - The parameters for this event
1587
+ * @property {string} appId
1451
1588
  * @property {string} artifactId - Artifact that owns the component
1452
1589
  * @property {string} cairoVersion
1453
1590
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1457,6 +1594,7 @@ exports.cairoUserAttemptsToCancelTheExport = cairoUserAttemptsToCancelTheExport;
1457
1594
  * @property {number} filteredListSize - How many items are to presented (filtered)
1458
1595
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
1459
1596
  * @property {boolean} isImmediate - Is it an immediate CTA
1597
+ * @property {boolean} isTPA
1460
1598
  * @property {number} itemsCnt - Number of total items picked
1461
1599
  * @property {number} listSize - How many items exist (full list)
1462
1600
  * @property {number} maxItems - Max items to select in picker
@@ -1475,6 +1613,7 @@ exports.pickerPickModalCtaButtonClickOrImmediateCta = pickerPickModalCtaButtonCl
1475
1613
  * Event description: Sent when the user clicks the "create new" button
1476
1614
  *
1477
1615
  * @param {newItemCreationStartParams} params - The parameters for this event
1616
+ * @property {string} appId
1478
1617
  * @property {string} artifactId - Artifact that owns the component
1479
1618
  * @property {string} cairoVersion
1480
1619
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1484,6 +1623,7 @@ exports.pickerPickModalCtaButtonClickOrImmediateCta = pickerPickModalCtaButtonCl
1484
1623
  * @property {string} currentSortOrder - sorts
1485
1624
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
1486
1625
  * @property {number} filteredListSize - How many items are currently presented to user (filtered)
1626
+ * @property {boolean} isTPA
1487
1627
  * @property {number} listSize - How many items exist, after item creation (full list, unfiltered)
1488
1628
  * @property {number} maxItems - Max number of items that can be selected
1489
1629
  * @property {number} numColumns - columns
@@ -1507,6 +1647,7 @@ exports.newItemCreationStart = newItemCreationStart;
1507
1647
  * Event description: Sent when a user selects a view in a Cairo component. Relevant components: Table, Cards.
1508
1648
  *
1509
1649
  * @param {cairoViewSelectedParams} params - The parameters for this event
1650
+ * @property {string} appId
1510
1651
  * @property {string} artifactId - Artifact that owns the component
1511
1652
  * @property {string} cairoVersion
1512
1653
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1519,6 +1660,7 @@ exports.newItemCreationStart = newItemCreationStart;
1519
1660
  * @property {boolean} isDefault - Is the selected view defined as default view?
1520
1661
  * @property {boolean} isFromSearchView - True if the view was selected from "search view in views dropdown" results (new from 01/2023)
1521
1662
  * @property {boolean} isPredefined - Is it a view that was predefined by the vertical. Will get "true" for predefined views include "All Items" view.
1663
+ * @property {boolean} isTPA
1522
1664
  * @property {string} newViewName - Name of the newly selected view
1523
1665
  * @property {number} numFiltersActive - How many filters are active after view selection
1524
1666
  * @property {string} prevFilters - (Optional) The prevoius state of filters, before the new view selection
@@ -1537,12 +1679,14 @@ exports.cairoViewSelected = cairoViewSelected;
1537
1679
  * Event description: Send when a user click on a "Add Custom Field". Relevant for Verticals who allow data extensions
1538
1680
  *
1539
1681
  * @param {cairoDataExAddCustomFieldParams} params - The parameters for this event
1682
+ * @property {string} appId
1540
1683
  * @property {string} artifactId - Artifact that owns the component
1541
1684
  * @property {string} cairoVersion - Cairo version
1542
1685
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1543
1686
  * @property {string} componentType - Component type
1544
1687
  * @property {GUID} csid - Cairo session ID
1545
1688
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1689
+ * @property {boolean} isTPA
1546
1690
  * @property {number} numColumns - How many columns are shown?
1547
1691
  * @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)
1548
1692
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1561,6 +1705,7 @@ exports.cairoDataExAddCustomField = cairoDataExAddCustomField;
1561
1705
  *
1562
1706
  * @param {cairoFilterToggledParams} params - The parameters for this event
1563
1707
  * @property {string} actionType - "add"/"remove" -- Did we add or remove filterName from the list of filters
1708
+ * @property {string} appId
1564
1709
  * @property {string} artifactId - Artifact that owns the component
1565
1710
  * @property {string} cairoVersion
1566
1711
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1571,6 +1716,7 @@ exports.cairoDataExAddCustomField = cairoDataExAddCustomField;
1571
1716
  * @property {string} filterName - Which column filter do we want to toggle now, e.g. Beginner / Amateur
1572
1717
  * @property {string} filterValue - JSON containing filterName's new value
1573
1718
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1719
+ * @property {boolean} isTPA
1574
1720
  * @property {number} listSize - How many items exist (full list, unfiltered)
1575
1721
  * @property {number} numFiltersActive - How many filters are active after filterName is toggled. actionType = "add" --> numFiltersActive >= 1; actionType = "remove" --> numFiltersActive < numColumns
1576
1722
  * @property {string} origin - "Panel"/"SubToolbar"/"Toolbar"
@@ -1589,12 +1735,14 @@ exports.cairoFilterToggled = cairoFilterToggled;
1589
1735
  *
1590
1736
  * @param {cairoDataExCustomFieldAdvancesSettingsParams} params - The parameters for this event
1591
1737
  * @property {string} actionName - Open / Close the advanced settings
1738
+ * @property {string} appId
1592
1739
  * @property {string} artifactId - Artifact that owns the component
1593
1740
  * @property {string} cairoVersion - Cairo version
1594
1741
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
1595
1742
  * @property {string} componentType - Component type
1596
1743
  * @property {GUID} csid - Cairo session ID
1597
1744
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1745
+ * @property {boolean} isTPA
1598
1746
  * @property {string} origin - Where did the user click on "Advanced Settings" from? Add Custom Field Modal / Edit Custom Field Modal
1599
1747
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1600
1748
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1610,6 +1758,7 @@ exports.cairoDataExCustomFieldAdvancesSettings = cairoDataExCustomFieldAdvancesS
1610
1758
  * Event description: Sent when a user creates/saves a view in a Cairo component. Relevant components: Table, Cards.
1611
1759
  *
1612
1760
  * @param {cairoViewSavedParams} params - The parameters for this event
1761
+ * @property {string} appId
1613
1762
  * @property {string} artifactId - Artifact that owns the component
1614
1763
  * @property {string} cairoVersion - Cairo version
1615
1764
  * @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)
@@ -1621,6 +1770,7 @@ exports.cairoDataExCustomFieldAdvancesSettings = cairoDataExCustomFieldAdvancesS
1621
1770
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1622
1771
  * @property {boolean} isDefault - Is the saved view defined as default view?
1623
1772
  * @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)
1773
+ * @property {boolean} isTPA
1624
1774
  * @property {string} newViewName - Name of the newly created/saved/renamed view
1625
1775
  * @property {number} numColumnsInView - How many columns comprise the saved view (new field from 11/2022)
1626
1776
  * @property {number} numFiltersInView - How many filters comprise the saved view
@@ -1644,6 +1794,7 @@ exports.cairoViewSaved = cairoViewSaved;
1644
1794
  * Event description: Sent when a user deletes a view in a Cairo component. Relevant components: Table, Cards.
1645
1795
  *
1646
1796
  * @param {cairoViewDeletedParams} params - The parameters for this event
1797
+ * @property {string} appId
1647
1798
  * @property {string} artifactId - Artifact that owns the component
1648
1799
  * @property {string} cairoVersion
1649
1800
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1651,6 +1802,7 @@ exports.cairoViewSaved = cairoViewSaved;
1651
1802
  * @property {GUID} csid
1652
1803
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1653
1804
  * @property {boolean} isDefault - Was the deleted view defined as default view?
1805
+ * @property {boolean} isTPA
1654
1806
  * @property {number} numFiltersInView - How many filters comprised the deleted view
1655
1807
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1656
1808
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1671,6 +1823,7 @@ exports.cairoViewDeleted = cairoViewDeleted;
1671
1823
  *
1672
1824
  * @param {cairoDataExCustomFieldEndProcessParams} params - The parameters for this event
1673
1825
  * @property {string} actionName - Add/ Edit
1826
+ * @property {string} appId
1674
1827
  * @property {string} artifactId - Artifact that owns the component
1675
1828
  * @property {string} cairoVersion - Cairo version
1676
1829
  * @property {string} changedFields - (Relevant when action type is edit) Name / Permission / Name and Permission / No changes
@@ -1682,6 +1835,7 @@ exports.cairoViewDeleted = cairoViewDeleted;
1682
1835
  * @property {string} endType - What did the user chose in the modal? Add field / Cancel
1683
1836
  * @property {string} fieldName - (Relevant when a field was added/edited) The name the user typed
1684
1837
  * @property {string} fieldType - (Relevant when a field was added) What type is the added field? Long text / Date / Number etc.
1838
+ * @property {boolean} isTPA
1685
1839
  * @property {string} key - The key value
1686
1840
  * @property {number} numAdded - (Relevant when a field was added/edited) How many added fields are there in the component (including the current added field)
1687
1841
  * @property {number} numDropdownOptions - Only for fieldType= dropdown, how many options were saved?
@@ -1701,6 +1855,7 @@ exports.cairoDataExCustomFieldEndProcess = cairoDataExCustomFieldEndProcess;
1701
1855
  * Event description: Sent when a user sorts a Cairo component. Relevant components: Table, Cards.
1702
1856
  *
1703
1857
  * @param {cairoComponentSortedParams} params - The parameters for this event
1858
+ * @property {string} appId
1704
1859
  * @property {string} artifactId - Artifact that owns the component
1705
1860
  * @property {string} cairoVersion - Cairo version
1706
1861
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1709,6 +1864,7 @@ exports.cairoDataExCustomFieldEndProcess = cairoDataExCustomFieldEndProcess;
1709
1864
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1710
1865
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1711
1866
  * @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)
1867
+ * @property {boolean} isTPA
1712
1868
  * @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)
1713
1869
  * @property {number} listSize - How many items exist (full list, unfiltered)
1714
1870
  * @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)
@@ -1734,6 +1890,7 @@ exports.cairoComponentSorted = cairoComponentSorted;
1734
1890
  * Event description: Sent when a user changes the order of the columns that sort a Cairo component. Relevant components: Table, Cards.
1735
1891
  *
1736
1892
  * @param {cairoReorderingSortColumnsParams} params - The parameters for this event
1893
+ * @property {string} appId
1737
1894
  * @property {string} artifactId - Artifact that owns the component
1738
1895
  * @property {string} cairoVersion - Cairo version
1739
1896
  * @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)
@@ -1743,6 +1900,7 @@ exports.cairoComponentSorted = cairoComponentSorted;
1743
1900
  * @property {GUID} csid
1744
1901
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1745
1902
  * @property {number} filteredListSize - How many items are currently presented to user, after filter toggle (filtered)
1903
+ * @property {boolean} isTPA
1746
1904
  * @property {number} listSize - How many items exist (full list, unfiltered)
1747
1905
  * @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.
1748
1906
  * @property {number} numSortingColumns - How many columns are been used for sorting the component?
@@ -1763,6 +1921,7 @@ exports.cairoReorderingSortColumns = cairoReorderingSortColumns;
1763
1921
  * Event description: Sent when the export process ends, either successfully or not (failed/stopped by user)
1764
1922
  *
1765
1923
  * @param {cairoExportProcessEndParams} params - The parameters for this event
1924
+ * @property {string} appId
1766
1925
  * @property {string} artifactId - Artifact that owns the component
1767
1926
  * @property {string} cairoVersion
1768
1927
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -1772,6 +1931,7 @@ exports.cairoReorderingSortColumns = cairoReorderingSortColumns;
1772
1931
  * @property {number} duration - How much time (in ms) did it take since the export process began
1773
1932
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1774
1933
  * @property {string} fileName - (Optional) Name of the file to be exported
1934
+ * @property {boolean} isTPA
1775
1935
  * @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.
1776
1936
  * @property {number} numItemsExported - How many items were exported before the export ended, either successfully or not.
1777
1937
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1792,6 +1952,7 @@ exports.cairoExportProcessEnd = cairoExportProcessEnd;
1792
1952
  * Event description: Sent when a user clicks on apply button in a Cairo component. Relevant components: Table, Cards.
1793
1953
  *
1794
1954
  * @param {cairoApplyButtonClickedParams} params - The parameters for this event
1955
+ * @property {string} appId
1795
1956
  * @property {string} artifactId
1796
1957
  * @property {string} cairoVersion - Cairo version
1797
1958
  * @property {string} changedLevels - In which levels of hierarchy the user changed the order? (numbers with commas between them, 1=the highest parent level )
@@ -1802,6 +1963,7 @@ exports.cairoExportProcessEnd = cairoExportProcessEnd;
1802
1963
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1803
1964
  * @property {string} feature - Filters / Drag and Drop
1804
1965
  * @property {number} filteredListSize - How many items are currently presented to user, after filters toggled (filtered)
1966
+ * @property {boolean} isTPA
1805
1967
  * @property {number} listSize - How many items exist (full list, unfiltered)
1806
1968
  * @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)
1807
1969
  * @property {number} numOfActions - (Optional, relevant for Drag and Drop) Number of actions/changes that are applied together
@@ -1822,6 +1984,7 @@ exports.cairoApplyButtonClicked = cairoApplyButtonClicked;
1822
1984
  *
1823
1985
  * @param {cairoExportModalCtaClickedParams} params - The parameters for this event
1824
1986
  * @property {string} action - Does the user want to proceed with the export or dismiss the modal
1987
+ * @property {string} appId
1825
1988
  * @property {string} artifactId - Artifact that owns the component
1826
1989
  * @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
1827
1990
  * @property {string} cairoVersion
@@ -1830,6 +1993,7 @@ exports.cairoApplyButtonClicked = cairoApplyButtonClicked;
1830
1993
  * @property {GUID} csid
1831
1994
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1832
1995
  * @property {string} exportId - A unique ID that will help join all events related to a specific export process
1996
+ * @property {boolean} isTPA
1833
1997
  * @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.
1834
1998
  * @property {string} origin - From where did the user close the modal: "Export Button"/"Cancel Button"/"X Button"
1835
1999
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1849,6 +2013,7 @@ exports.cairoExportModalCtaClicked = cairoExportModalCtaClicked;
1849
2013
  *
1850
2014
  * @param {cairoUndoClickedParams} params - The parameters for this event
1851
2015
  * @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.)
2016
+ * @property {string} appId
1852
2017
  * @property {string} artifactId - Artifact that owns the component
1853
2018
  * @property {string} cairoVersion - cairo version
1854
2019
  * @property {string} changedAttributes - Which attributes have changed from the saved status to the current
@@ -1862,6 +2027,7 @@ exports.cairoExportModalCtaClicked = cairoExportModalCtaClicked;
1862
2027
  * @property {string} domain - (Optional) Domain name from FQDN (crm, stores, etc.)
1863
2028
  * @property {number} filteredListSize - How many items are to be presented (filtered)
1864
2029
  * @property {number} filteredListSizeShown - How many items were presented (filtered) to the user when he made the action he wants to undo?
2030
+ * @property {boolean} isTPA
1865
2031
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1866
2032
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1867
2033
  * @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"}
@@ -1880,6 +2046,7 @@ exports.cairoUndoClicked = cairoUndoClicked;
1880
2046
  * Event description: Sent when a user clicks a Back button or on the higher hierarchy in the breadcrumbs
1881
2047
  *
1882
2048
  * @param {cairoPageBackOrBreadcrumbClickedParams} params - The parameters for this event
2049
+ * @property {string} appId
1883
2050
  * @property {string} artifactId - Artifact that owns the component
1884
2051
  * @property {string} buttonName - 'Back' (for back button clicked) / The category's name the users clicked on.
1885
2052
  * @property {string} cairoVersion - Cairo version
@@ -1888,6 +2055,7 @@ exports.cairoUndoClicked = cairoUndoClicked;
1888
2055
  * @property {GUID} csid
1889
2056
  * @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)
1890
2057
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2058
+ * @property {boolean} isTPA
1891
2059
  * @property {string} pageType - Collection Page
1892
2060
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1893
2061
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -1913,6 +2081,7 @@ exports.cairoPageBackOrBreadcrumbClicked = cairoPageBackOrBreadcrumbClicked;
1913
2081
  * @property {number} ctaIndex - 0 <= ctaIndex <= numCtas -- the number of the CTA out of all CTAs in the page dropdown menu/ Toolbar
1914
2082
  * @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
1915
2083
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2084
+ * @property {boolean} isTPA
1916
2085
  * @property {string} location - Page More Action Dropdown / Component Bulk action Toolbar
1917
2086
  * @property {number} numCtas - How many CTAs are available in the page dropdown menu / toolbar?
1918
2087
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1930,12 +2099,14 @@ exports.cairoTpaSCtaClicked = cairoTpaSCtaClicked;
1930
2099
  * Event description: Sent when user clicks the general "+"/"Add Items" button that opens Pikachu
1931
2100
  *
1932
2101
  * @param {pikachuCategoriesDropdownButtonClickedParams} params - The parameters for this event
2102
+ * @property {string} appId
1933
2103
  * @property {string} artifactId - Artifact that owns the component
1934
2104
  * @property {string} cairoVersion
1935
2105
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
1936
2106
  * @property {string} componentType
1937
2107
  * @property {GUID} csid
1938
2108
  * @property {string} domain - Optional domain name from FQDN (CRM, Store, etc.)
2109
+ * @property {boolean} isTPA
1939
2110
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
1940
2111
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
1941
2112
  * @return {LogObject<pikachuCategoriesDropdownButtonClickedParams>} LogObject<pikachuCategoriesDropdownButtonClickedParams>
@@ -1951,6 +2122,7 @@ exports.pikachuCategoriesDropdownButtonClicked = pikachuCategoriesDropdownButton
1951
2122
  *
1952
2123
  * @param {cairoTagsUnsuccessfulUpdateInServerParams} params - The parameters for this event
1953
2124
  * @property {string} actionName - Add / Delete / Rename / Assign / Remove assign / Add and assign / Load tags widget
2125
+ * @property {string} appId
1954
2126
  * @property {string} artifactId - Artifact that owns the component
1955
2127
  * @property {string} cairoVersion - Cairo version
1956
2128
  * @property {string} componentName - (Optional) Page name, if there are two pages of the same type per artifact
@@ -1958,6 +2130,7 @@ exports.pikachuCategoriesDropdownButtonClicked = pikachuCategoriesDropdownButton
1958
2130
  * @property {GUID} csid - Cairo session ID
1959
2131
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
1960
2132
  * @property {string} errorType - What is the type of the error? Technical issue / Network error
2133
+ * @property {boolean} isTPA
1961
2134
  * @property {number} numTags - How many tags are in the modal after this action?
1962
2135
  * @property {string} origin - Where did the user make the action from? Tags Modal / Entity page
1963
2136
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
@@ -1976,6 +2149,7 @@ exports.cairoTagsUnsuccessfulUpdateInServer = cairoTagsUnsuccessfulUpdateInServe
1976
2149
  *
1977
2150
  * @param {pickerModalUsabilityParams} params - The parameters for this event
1978
2151
  * @property {string} action - Use cases: search/search results/checkbox/continue/dismiss/load more
2152
+ * @property {string} appId
1979
2153
  * @property {string} artifactId - Artifact that owns the component
1980
2154
  * @property {string} cairoVersion
1981
2155
  * @property {string} componentName - Optional in case having 2 pickers under the same artifact
@@ -1983,6 +2157,7 @@ exports.cairoTagsUnsuccessfulUpdateInServer = cairoTagsUnsuccessfulUpdateInServe
1983
2157
  * @property {GUID} csid
1984
2158
  * @property {string} domain - Optional domain name from FDQN (CRM, Store, etc.)
1985
2159
  * @property {number} filteredListSize - How many items are to presented (filtered)
2160
+ * @property {boolean} isTPA
1986
2161
  * @property {string} itemId - (Optional) ID of item checked
1987
2162
  * @property {number} itemsCnt - (Optional) Number of total items checked
1988
2163
  * @property {number} itemsLoadedCnt - (Optional) Number of additional items loaded
@@ -2007,6 +2182,7 @@ exports.pickerModalUsability = pickerModalUsability;
2007
2182
  * Event description: Sent when the sort sidebar in a Cairo component is opened or closed. Relevant components: Table, Cards.
2008
2183
  *
2009
2184
  * @param {cairoSortPanelUsedParams} params - The parameters for this event
2185
+ * @property {string} appId
2010
2186
  * @property {string} artifactId
2011
2187
  * @property {string} cairoVersion - Cairo version
2012
2188
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2015,6 +2191,7 @@ exports.pickerModalUsability = pickerModalUsability;
2015
2191
  * @property {string} currentSortOrder - Which columns are currently used to sort the list: [{"fieldName": "FIELD_NAME", "order": "asc"}
2016
2192
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2017
2193
  * @property {boolean} isOpened - TRUE if the user just opened the sidebar; FALSE if closed
2194
+ * @property {boolean} isTPA
2018
2195
  * @property {number} numSortedColumns - How many columns actively sort the data?
2019
2196
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2020
2197
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)
@@ -2031,6 +2208,7 @@ exports.cairoSortPanelUsed = cairoSortPanelUsed;
2031
2208
  *
2032
2209
  * @param {cairoTagsAssignTagParams} params - The parameters for this event
2033
2210
  * @property {string} actionName - Assign / Remove
2211
+ * @property {string} appId
2034
2212
  * @property {string} artifactId - Artifact that owns the component
2035
2213
  * @property {string} cairoVersion - Cairo version
2036
2214
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2038,6 +2216,7 @@ exports.cairoSortPanelUsed = cairoSortPanelUsed;
2038
2216
  * @property {GUID} csid - Cairo session ID
2039
2217
  * @property {string} domain - (Optional) Domain name from FQDN (CRM, Store, etc.)
2040
2218
  * @property {boolean} isFromSearch - Is the action made from a list of tags search results?
2219
+ * @property {boolean} isTPA
2041
2220
  * @property {string} itemId - (Relevant if numItems=1) The Item which the tag was assigned to / removed from
2042
2221
  * @property {number} numItems - How many items have been selected?
2043
2222
  * @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
@@ -2058,6 +2237,7 @@ exports.cairoTagsAssignTag = cairoTagsAssignTag;
2058
2237
  * Event description: Sent when a Cairo's page can't be saved due to an error.
2059
2238
  *
2060
2239
  * @param {cairoApiRequestDataLoadEndParams} params - The parameters for this event
2240
+ * @property {string} appId
2061
2241
  * @property {string} artifactId - Artifact that owns the component
2062
2242
  * @property {string} cairoVersion - Cairo version
2063
2243
  * @property {string} componentName - (Optional) Component name, if there are two components of the same type per artifact
@@ -2072,6 +2252,7 @@ exports.cairoTagsAssignTag = cairoTagsAssignTag;
2072
2252
  * @property {string} errorType - Technical issue / Logic error / Network error / External error
2073
2253
  * @property {number} filteredListSize - How many items are to be presented (filtered)
2074
2254
  * @property {number} initialItems - Initial number of items loaded (before scroll and autoload)
2255
+ * @property {boolean} isTPA
2075
2256
  * @property {string} pageType - Entity / Collection
2076
2257
  * @property {string} product - Name of the product/api from FQDN (contacts, booking, site_properties, etc.)
2077
2258
  * @property {string} resource - Singular form of the resource name from FQDN, "goal" of component (order, contact, etc.)