@convertcom/js-sdk-rules 2.1.0 → 2.1.3

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 (215) hide show
  1. package/lib/enums/src/dictionary.d.ts +3 -0
  2. package/lib/enums/src/goal-data-key.d.ts +6 -1
  3. package/lib/index.d.ts +2 -1
  4. package/lib/index.js +203 -157
  5. package/lib/index.js.map +1 -1
  6. package/lib/index.min.js +1 -1
  7. package/lib/index.min.js.map +1 -1
  8. package/lib/index.min.mjs +1 -1
  9. package/lib/index.min.mjs.map +1 -1
  10. package/lib/index.mjs +203 -157
  11. package/lib/index.mjs.map +1 -1
  12. package/lib/legacy/index.js +180 -134
  13. package/lib/legacy/index.js.map +1 -1
  14. package/lib/legacy/index.min.js +1 -1
  15. package/lib/legacy/index.min.js.map +1 -1
  16. package/lib/package.json +5 -5
  17. package/lib/rules/src/interfaces/rule-manager.d.ts +1 -0
  18. package/lib/rules/src/rule-manager.d.ts +1 -1
  19. package/lib/types/index.d.ts +1 -0
  20. package/lib/types/src/config/index.d.ts +1 -192
  21. package/lib/types/src/config/types.gen.d.ts +2494 -0
  22. package/lib/utils/src/string-utils.d.ts +12 -0
  23. package/package.json +5 -5
  24. package/lib/types/src/config/models/Base64Image.d.ts +0 -6
  25. package/lib/types/src/config/models/BaseMatch.d.ts +0 -8
  26. package/lib/types/src/config/models/BaseRule.d.ts +0 -6
  27. package/lib/types/src/config/models/BaseRuleWithBooleanValue.d.ts +0 -7
  28. package/lib/types/src/config/models/BaseRuleWithBrowserNameValue.d.ts +0 -21
  29. package/lib/types/src/config/models/BaseRuleWithCountryCodeValue.d.ts +0 -7
  30. package/lib/types/src/config/models/BaseRuleWithDayOfWeekValue.d.ts +0 -7
  31. package/lib/types/src/config/models/BaseRuleWithExperienceBucketedValue.d.ts +0 -7
  32. package/lib/types/src/config/models/BaseRuleWithGoalTriggeredValue.d.ts +0 -7
  33. package/lib/types/src/config/models/BaseRuleWithHourOfDayValue.d.ts +0 -7
  34. package/lib/types/src/config/models/BaseRuleWithJsCodeValue.d.ts +0 -9
  35. package/lib/types/src/config/models/BaseRuleWithLanguageCodeValue.d.ts +0 -7
  36. package/lib/types/src/config/models/BaseRuleWithMinuteOfHourValue.d.ts +0 -7
  37. package/lib/types/src/config/models/BaseRuleWithNumericValue.d.ts +0 -7
  38. package/lib/types/src/config/models/BaseRuleWithOsValue.d.ts +0 -21
  39. package/lib/types/src/config/models/BaseRuleWithSegmentBucketedValue.d.ts +0 -7
  40. package/lib/types/src/config/models/BaseRuleWithStringValue.d.ts +0 -7
  41. package/lib/types/src/config/models/BaseRuleWithVisitorTypeValue.d.ts +0 -16
  42. package/lib/types/src/config/models/BaseRuleWithWeatherConditionValue.d.ts +0 -34
  43. package/lib/types/src/config/models/BoolMatchRulesTypes.d.ts +0 -6
  44. package/lib/types/src/config/models/BrowserNameMatchRule.d.ts +0 -10
  45. package/lib/types/src/config/models/BrowserNameMatchRulesTypes.d.ts +0 -3
  46. package/lib/types/src/config/models/BucketingEvent.d.ts +0 -15
  47. package/lib/types/src/config/models/ChoiceContainsOptions.d.ts +0 -3
  48. package/lib/types/src/config/models/ChoiceMatchingOptions.d.ts +0 -3
  49. package/lib/types/src/config/models/ClicksElementGoal.d.ts +0 -11
  50. package/lib/types/src/config/models/ClicksElementGoalSettings.d.ts +0 -6
  51. package/lib/types/src/config/models/ClicksLinkGoal.d.ts +0 -11
  52. package/lib/types/src/config/models/ClicksLinkGoalSettings.d.ts +0 -6
  53. package/lib/types/src/config/models/ConfigAudience.d.ts +0 -21
  54. package/lib/types/src/config/models/ConfigAudienceTypes.d.ts +0 -10
  55. package/lib/types/src/config/models/ConfigExperience.d.ts +0 -98
  56. package/lib/types/src/config/models/ConfigFeature.d.ts +0 -22
  57. package/lib/types/src/config/models/ConfigGoal.d.ts +0 -9
  58. package/lib/types/src/config/models/ConfigGoalBase.d.ts +0 -24
  59. package/lib/types/src/config/models/ConfigLocation.d.ts +0 -21
  60. package/lib/types/src/config/models/ConfigProject.d.ts +0 -151
  61. package/lib/types/src/config/models/ConfigResponseData.d.ts +0 -45
  62. package/lib/types/src/config/models/ConfigSegment.d.ts +0 -19
  63. package/lib/types/src/config/models/ConversionEvent.d.ts +0 -30
  64. package/lib/types/src/config/models/CookieMatchRule.d.ts +0 -14
  65. package/lib/types/src/config/models/CookieMatchRulesTypes.d.ts +0 -3
  66. package/lib/types/src/config/models/CountryMatchRule.d.ts +0 -10
  67. package/lib/types/src/config/models/CountryMatchRulesTypes.d.ts +0 -3
  68. package/lib/types/src/config/models/DayOfWeekMatchRule.d.ts +0 -10
  69. package/lib/types/src/config/models/DayOfWeekMatchRulesTypes.d.ts +0 -4
  70. package/lib/types/src/config/models/DomInteractionGoal.d.ts +0 -11
  71. package/lib/types/src/config/models/DomInteractionGoalSettings.d.ts +0 -15
  72. package/lib/types/src/config/models/ErrorData.d.ts +0 -5
  73. package/lib/types/src/config/models/ExperienceBucketedMatchRule.d.ts +0 -9
  74. package/lib/types/src/config/models/ExperienceChange.d.ts +0 -10
  75. package/lib/types/src/config/models/ExperienceChangeAdd.d.ts +0 -10
  76. package/lib/types/src/config/models/ExperienceChangeBase.d.ts +0 -27
  77. package/lib/types/src/config/models/ExperienceChangeCustomCodeData.d.ts +0 -6
  78. package/lib/types/src/config/models/ExperienceChangeCustomCodeDataAdd.d.ts +0 -6
  79. package/lib/types/src/config/models/ExperienceChangeCustomCodeDataBase.d.ts +0 -29
  80. package/lib/types/src/config/models/ExperienceChangeCustomCodeDataUpdate.d.ts +0 -6
  81. package/lib/types/src/config/models/ExperienceChangeCustomCodeDataUpdateNoId.d.ts +0 -5
  82. package/lib/types/src/config/models/ExperienceChangeDefaultCodeData.d.ts +0 -6
  83. package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataAdd.d.ts +0 -6
  84. package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataBase.d.ts +0 -29
  85. package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataUpdate.d.ts +0 -6
  86. package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataUpdateNoId.d.ts +0 -5
  87. package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageData.d.ts +0 -6
  88. package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataAdd.d.ts +0 -6
  89. package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataBase.d.ts +0 -33
  90. package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataUpdate.d.ts +0 -6
  91. package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataUpdateNoId.d.ts +0 -5
  92. package/lib/types/src/config/models/ExperienceChangeDefaultRedirectData.d.ts +0 -6
  93. package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataAdd.d.ts +0 -6
  94. package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataBase.d.ts +0 -29
  95. package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataUpdate.d.ts +0 -6
  96. package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataUpdateNoId.d.ts +0 -5
  97. package/lib/types/src/config/models/ExperienceChangeFullStackFeature.d.ts +0 -6
  98. package/lib/types/src/config/models/ExperienceChangeFullStackFeatureAdd.d.ts +0 -6
  99. package/lib/types/src/config/models/ExperienceChangeFullStackFeatureBase.d.ts +0 -25
  100. package/lib/types/src/config/models/ExperienceChangeFullStackFeatureUpdate.d.ts +0 -6
  101. package/lib/types/src/config/models/ExperienceChangeFullStackFeatureUpdateNoId.d.ts +0 -5
  102. package/lib/types/src/config/models/ExperienceChangeId.d.ts +0 -9
  103. package/lib/types/src/config/models/ExperienceChangeIdReadOnly.d.ts +0 -9
  104. package/lib/types/src/config/models/ExperienceChangeRichStructureData.d.ts +0 -6
  105. package/lib/types/src/config/models/ExperienceChangeRichStructureDataAdd.d.ts +0 -6
  106. package/lib/types/src/config/models/ExperienceChangeRichStructureDataBase.d.ts +0 -16
  107. package/lib/types/src/config/models/ExperienceChangeRichStructureDataUpdate.d.ts +0 -6
  108. package/lib/types/src/config/models/ExperienceChangeRichStructureDataUpdateNoId.d.ts +0 -5
  109. package/lib/types/src/config/models/ExperienceChangeUpdate.d.ts +0 -10
  110. package/lib/types/src/config/models/ExperienceChangeUpdateNoId.d.ts +0 -10
  111. package/lib/types/src/config/models/ExperienceIntegrationBaidu.d.ts +0 -7
  112. package/lib/types/src/config/models/ExperienceIntegrationBase.d.ts +0 -10
  113. package/lib/types/src/config/models/ExperienceIntegrationClicktale.d.ts +0 -2
  114. package/lib/types/src/config/models/ExperienceIntegrationClicky.d.ts +0 -2
  115. package/lib/types/src/config/models/ExperienceIntegrationCnzz.d.ts +0 -7
  116. package/lib/types/src/config/models/ExperienceIntegrationCrazyegg.d.ts +0 -9
  117. package/lib/types/src/config/models/ExperienceIntegrationEconda.d.ts +0 -2
  118. package/lib/types/src/config/models/ExperienceIntegrationEulerian.d.ts +0 -2
  119. package/lib/types/src/config/models/ExperienceIntegrationGA3.d.ts +0 -9
  120. package/lib/types/src/config/models/ExperienceIntegrationGA4.d.ts +0 -8
  121. package/lib/types/src/config/models/ExperienceIntegrationGA4Base.d.ts +0 -4
  122. package/lib/types/src/config/models/ExperienceIntegrationGAServing.d.ts +0 -3
  123. package/lib/types/src/config/models/ExperienceIntegrationGoogleAnalytics.d.ts +0 -3
  124. package/lib/types/src/config/models/ExperienceIntegrationGosquared.d.ts +0 -2
  125. package/lib/types/src/config/models/ExperienceIntegrationHeapanalytics.d.ts +0 -2
  126. package/lib/types/src/config/models/ExperienceIntegrationHotjar.d.ts +0 -2
  127. package/lib/types/src/config/models/ExperienceIntegrationMixpanel.d.ts +0 -2
  128. package/lib/types/src/config/models/ExperienceIntegrationMouseflow.d.ts +0 -2
  129. package/lib/types/src/config/models/ExperienceIntegrationPiwik.d.ts +0 -7
  130. package/lib/types/src/config/models/ExperienceIntegrationSegmentio.d.ts +0 -2
  131. package/lib/types/src/config/models/ExperienceIntegrationSitecatalyst.d.ts +0 -7
  132. package/lib/types/src/config/models/ExperienceIntegrationWoopra.d.ts +0 -2
  133. package/lib/types/src/config/models/ExperienceIntegrationYsance.d.ts +0 -7
  134. package/lib/types/src/config/models/ExperienceTypes.d.ts +0 -8
  135. package/lib/types/src/config/models/ExperienceVariationConfig.d.ts +0 -30
  136. package/lib/types/src/config/models/Extra.d.ts +0 -4
  137. package/lib/types/src/config/models/FeatureVariableItemData.d.ts +0 -25
  138. package/lib/types/src/config/models/GA_Settings.d.ts +0 -3
  139. package/lib/types/src/config/models/GA_SettingsBase.d.ts +0 -6
  140. package/lib/types/src/config/models/GaGoal.d.ts +0 -11
  141. package/lib/types/src/config/models/GaGoalSettings.d.ts +0 -6
  142. package/lib/types/src/config/models/GenericBoolKeyValueMatchRule.d.ts +0 -11
  143. package/lib/types/src/config/models/GenericBoolKeyValueMatchRulesTypes.d.ts +0 -3
  144. package/lib/types/src/config/models/GenericBoolMatchRule.d.ts +0 -10
  145. package/lib/types/src/config/models/GenericKey.d.ts +0 -6
  146. package/lib/types/src/config/models/GenericNumericKeyValueMatchRule.d.ts +0 -11
  147. package/lib/types/src/config/models/GenericNumericKeyValueMatchRulesTypes.d.ts +0 -3
  148. package/lib/types/src/config/models/GenericNumericMatchRule.d.ts +0 -10
  149. package/lib/types/src/config/models/GenericSetMatchRule.d.ts +0 -9
  150. package/lib/types/src/config/models/GenericTextKeyValueMatchRule.d.ts +0 -11
  151. package/lib/types/src/config/models/GenericTextKeyValueMatchRulesTypes.d.ts +0 -3
  152. package/lib/types/src/config/models/GenericTextMatchRule.d.ts +0 -10
  153. package/lib/types/src/config/models/GoalTriggeredMatchRule.d.ts +0 -10
  154. package/lib/types/src/config/models/GoalTriggeredMatchRulesTypes.d.ts +0 -3
  155. package/lib/types/src/config/models/GoalTypes.d.ts +0 -10
  156. package/lib/types/src/config/models/HourOfDayMatchRule.d.ts +0 -10
  157. package/lib/types/src/config/models/HourOfDayMatchRulesTypes.d.ts +0 -4
  158. package/lib/types/src/config/models/IntegrationGA3.d.ts +0 -12
  159. package/lib/types/src/config/models/IntegrationGA4.d.ts +0 -7
  160. package/lib/types/src/config/models/IntegrationGA4Base.d.ts +0 -12
  161. package/lib/types/src/config/models/IntegrationProvider.d.ts +0 -23
  162. package/lib/types/src/config/models/JsConditionMatchRule.d.ts +0 -10
  163. package/lib/types/src/config/models/JsConditionMatchRulesTypes.d.ts +0 -3
  164. package/lib/types/src/config/models/KeyValueMatchRulesTypes.d.ts +0 -4
  165. package/lib/types/src/config/models/LanguageMatchRule.d.ts +0 -10
  166. package/lib/types/src/config/models/LanguageMatchRulesTypes.d.ts +0 -3
  167. package/lib/types/src/config/models/LocationTrigger.d.ts +0 -5
  168. package/lib/types/src/config/models/LocationTriggerBase.d.ts +0 -14
  169. package/lib/types/src/config/models/LocationTriggerCallback.d.ts +0 -13
  170. package/lib/types/src/config/models/LocationTriggerDomChange.d.ts +0 -17
  171. package/lib/types/src/config/models/LocationTriggerManual.d.ts +0 -9
  172. package/lib/types/src/config/models/LocationTriggerUrlChange.d.ts +0 -9
  173. package/lib/types/src/config/models/MinuteOfHourMatchRule.d.ts +0 -10
  174. package/lib/types/src/config/models/MinuteOfHourMatchRulesTypes.d.ts +0 -4
  175. package/lib/types/src/config/models/NoSettingsGoal.d.ts +0 -11
  176. package/lib/types/src/config/models/NumericMatchRulesTypes.d.ts +0 -8
  177. package/lib/types/src/config/models/NumericMatchingOptions.d.ts +0 -5
  178. package/lib/types/src/config/models/OnlyCount.d.ts +0 -7
  179. package/lib/types/src/config/models/OsMatchRule.d.ts +0 -10
  180. package/lib/types/src/config/models/OsMatchRulesTypes.d.ts +0 -3
  181. package/lib/types/src/config/models/PageNumber.d.ts +0 -9
  182. package/lib/types/src/config/models/Pagination.d.ts +0 -18
  183. package/lib/types/src/config/models/ProjectGASettingsBase.d.ts +0 -7
  184. package/lib/types/src/config/models/ProjectIntegrationGA3.d.ts +0 -3
  185. package/lib/types/src/config/models/ProjectIntegrationGA4.d.ts +0 -8
  186. package/lib/types/src/config/models/ResultsPerPage.d.ts +0 -10
  187. package/lib/types/src/config/models/RevenueGoal.d.ts +0 -11
  188. package/lib/types/src/config/models/RevenueGoalSettings.d.ts +0 -25
  189. package/lib/types/src/config/models/RuleElement.d.ts +0 -20
  190. package/lib/types/src/config/models/RuleElementNoUrl.d.ts +0 -20
  191. package/lib/types/src/config/models/RuleObject.d.ts +0 -20
  192. package/lib/types/src/config/models/RuleObjectNoUrl.d.ts +0 -20
  193. package/lib/types/src/config/models/RulesTypes.d.ts +0 -17
  194. package/lib/types/src/config/models/ScrollPercentageGoal.d.ts +0 -11
  195. package/lib/types/src/config/models/ScrollPercentageGoalSettings.d.ts +0 -6
  196. package/lib/types/src/config/models/SegmentBucketedMatchRule.d.ts +0 -10
  197. package/lib/types/src/config/models/SegmentBucketedMatchRulesTypes.d.ts +0 -3
  198. package/lib/types/src/config/models/SendTrackingEventsRequestData.d.ts +0 -39
  199. package/lib/types/src/config/models/SetMatchingOptions.d.ts +0 -3
  200. package/lib/types/src/config/models/SortDirection.d.ts +0 -21
  201. package/lib/types/src/config/models/SubmitsFormGoal.d.ts +0 -11
  202. package/lib/types/src/config/models/SubmitsFormGoalSettings.d.ts +0 -6
  203. package/lib/types/src/config/models/SuccessData.d.ts +0 -4
  204. package/lib/types/src/config/models/TextMatchRulesTypes.d.ts +0 -23
  205. package/lib/types/src/config/models/TextMatchingOptions.d.ts +0 -7
  206. package/lib/types/src/config/models/UTC_Offset.d.ts +0 -4
  207. package/lib/types/src/config/models/UpdateExperienceChangeRequestData.d.ts +0 -2
  208. package/lib/types/src/config/models/VariationStatuses.d.ts +0 -7
  209. package/lib/types/src/config/models/VisitorSegments.d.ts +0 -78
  210. package/lib/types/src/config/models/VisitorTrackingEvents.d.ts +0 -21
  211. package/lib/types/src/config/models/VisitorTypeMatchRule.d.ts +0 -10
  212. package/lib/types/src/config/models/VisitorTypeMatchRulesTypes.d.ts +0 -3
  213. package/lib/types/src/config/models/WeatherConditionMatchRule.d.ts +0 -10
  214. package/lib/types/src/config/models/WeatherConditionMatchRulesTypes.d.ts +0 -3
  215. package/lib/types/src/config/models/WeatherConditions.d.ts +0 -30
@@ -1,151 +0,0 @@
1
- import type { GA_Settings } from './GA_Settings';
2
- import type { UTC_Offset } from './UTC_Offset';
3
- /**
4
- * Project Object under which experiences would get created
5
- */
6
- export type ConfigProject = {
7
- /**
8
- * Project ID
9
- */
10
- id?: string;
11
- /**
12
- * Project Name. If **settings.data_anonymization** is turned on, the name will be generated from **id** field
13
- */
14
- name?: string;
15
- /**
16
- * Value which describes project product type
17
- */
18
- type?: ConfigProject.type;
19
- utc_offset?: UTC_Offset;
20
- /**
21
- * Object representing the custom domain that is used for loading the tracking scripts and
22
- * sending tracking requests to Convert servers instead of the standard Convert domain
23
- *
24
- */
25
- custom_domain?: {
26
- /**
27
- * Custom domain to be used instead of standard Convert's one
28
- */
29
- domain?: string;
30
- } | null;
31
- /**
32
- * List of domains allowed to be tracked under this project
33
- */
34
- domains?: Array<{
35
- /**
36
- * Top level domain, used for setting cookies where applicable
37
- */
38
- tld?: string;
39
- /**
40
- * List of host names under **tld** which are allowed to be tracked under this project
41
- */
42
- hosts?: any;
43
- }>;
44
- /**
45
- * The global javascript code that will be loaded on all pages where
46
- * the tracking script is installed, prior do processing any of
47
- * experiences, goals, audiences etc.
48
- *
49
- */
50
- global_javascript?: string | null;
51
- /**
52
- * Various project's settings
53
- */
54
- settings?: {
55
- /**
56
- * Flag indicating whether decoration of outgoing links (appending tracking cookies inside the link URL in order to
57
- * make cross domain tracking possible) is done automatically on page
58
- *
59
- */
60
- allow_crossdomain_tracking?: boolean;
61
- /**
62
- * Whether or not data is [anonymized](https://convert.zendesk.com/hc/en-us/articles/204506339-Prevent-Experiment-Details-Data-Leak-with-Data-Anonymization).
63
- */
64
- data_anonymization?: boolean;
65
- /**
66
- * Follow the 'Do not track' browser settings for users in the mentioned area of the world.
67
- */
68
- do_not_track?: ConfigProject.do_not_track;
69
- /**
70
- * Follow Global Privacy Control (GPC) signals for users in the mentioned area of the world.
71
- * - OFF: Do not follow GPC signals.
72
- * - EU ONLY: Follow GPC signals for users in the European Union only.
73
- * - EEA ONLY: Follow GPC signals for users in the European Economic Area only.
74
- * - Worldwide: Follow GPC signals for users worldwide.
75
- *
76
- */
77
- global_privacy_control?: ConfigProject.global_privacy_control;
78
- /**
79
- * Whether to include jQuery library or not into the javascript tracking file served by Convert and loaded via the tracking snippet. If jQuery is not included, it has to be loaded on page, before Convert's tracking code
80
- */
81
- include_jquery?: boolean;
82
- /**
83
- * Whether to include jQuery library or not into the v1 javascript tracking file served by Convert and loaded via the tracking snippet.
84
- */
85
- include_jquery_v1?: boolean;
86
- /**
87
- * Whether to disable the SPA (Single Page Application) related functionalities from the tracking scripts V1. Most websites work fine without disabling SPA functionality regardless of the fact they are Single Page Apps or not. In edge situation, this setting might prove handy
88
- */
89
- disable_spa_functionality?: boolean;
90
- /**
91
- * When this is turned to true, Convert won't track any referral data like http referral, utm query strings etc. Those will be used on the current page if available but won't be stored in cookies in order to be used on subsequent pages.
92
- */
93
- do_not_track_referral?: boolean;
94
- /**
95
- * This holds project wide settings used by integrations
96
- */
97
- integrations?: {
98
- google_analytics?: GA_Settings;
99
- kissmetrics?: {
100
- /**
101
- * Flag indicating whether Kissmetrics integration is enabled or not for this project
102
- */
103
- enabled?: boolean;
104
- };
105
- };
106
- /**
107
- * Minimum order value for transactions outliers
108
- */
109
- min_order_value?: number;
110
- /**
111
- * Maximum order value for transactions outliers
112
- */
113
- max_order_value?: number;
114
- };
115
- /**
116
- * A user-defined key-value object which describes environments available for the project.
117
- */
118
- environments?: Record<string, any>;
119
- };
120
- export declare namespace ConfigProject {
121
- /**
122
- * Value which describes project product type
123
- */
124
- enum type {
125
- FULLSTACK = "fullstack",
126
- WEB = "web"
127
- }
128
- /**
129
- * Follow the 'Do not track' browser settings for users in the mentioned area of the world.
130
- */
131
- enum do_not_track {
132
- OFF = "OFF",
133
- EU_ONLY = "EU ONLY",
134
- EEA_ONLY = "EEA ONLY",
135
- WORLDWIDE = "Worldwide"
136
- }
137
- /**
138
- * Follow Global Privacy Control (GPC) signals for users in the mentioned area of the world.
139
- * - OFF: Do not follow GPC signals.
140
- * - EU ONLY: Follow GPC signals for users in the European Union only.
141
- * - EEA ONLY: Follow GPC signals for users in the European Economic Area only.
142
- * - Worldwide: Follow GPC signals for users worldwide.
143
- *
144
- */
145
- enum global_privacy_control {
146
- OFF = "OFF",
147
- EU_ONLY = "EU ONLY",
148
- EEA_ONLY = "EEA ONLY",
149
- WORLDWIDE = "Worldwide"
150
- }
151
- }
@@ -1,45 +0,0 @@
1
- import type { ConfigAudience } from './ConfigAudience';
2
- import type { ConfigExperience } from './ConfigExperience';
3
- import type { ConfigFeature } from './ConfigFeature';
4
- import type { ConfigGoal } from './ConfigGoal';
5
- import type { ConfigLocation } from './ConfigLocation';
6
- import type { ConfigProject } from './ConfigProject';
7
- import type { ConfigSegment } from './ConfigSegment';
8
- /**
9
- * Response containing project's config data needed in order to serve experiences
10
- */
11
- export type ConfigResponseData = {
12
- /**
13
- * Account ID under which the project exists
14
- */
15
- account_id?: string;
16
- project?: ConfigProject;
17
- /**
18
- * List of goals to be tracked in the project
19
- */
20
- goals?: Array<ConfigGoal>;
21
- /**
22
- * List of locations that are used inside this project
23
- */
24
- locations?: Array<ConfigLocation>;
25
- /**
26
- * List of audiences that are used inside this project
27
- */
28
- audiences?: Array<ConfigAudience>;
29
- /**
30
- * List of custom that are devined inside this project
31
- */
32
- segments?: Array<ConfigSegment>;
33
- /**
34
- * List of active experiences inside this project
35
- */
36
- experiences?: Array<ConfigExperience>;
37
- /**
38
- * List of archived experiences inside this project, which were archived within the last 8 months
39
- */
40
- archived_experiences?: Array<string>;
41
- /**
42
- * List of features inside this project. Presented only for fullstack projects
43
- */
44
- features?: Array<ConfigFeature>;
45
- };
@@ -1,19 +0,0 @@
1
- import type { RuleObject } from './RuleObject';
2
- /**
3
- * Base Segment object
4
- */
5
- export type ConfigSegment = {
6
- /**
7
- * Segment ID
8
- */
9
- id?: string;
10
- /**
11
- * Segment unique key
12
- */
13
- key?: string;
14
- /**
15
- * Segment Name
16
- */
17
- name?: string;
18
- rules?: RuleObject | null;
19
- };
@@ -1,30 +0,0 @@
1
- /**
2
- * Conversion event data
3
- */
4
- export type ConversionEvent = {
5
- /**
6
- * Id of the conversion goal to be fired
7
- */
8
- goalId: string;
9
- /**
10
- * Data connected to this conversion, for non binomial metrics, eg revenue
11
- */
12
- goalData?: Array<{
13
- /**
14
- * Key of the metric
15
- */
16
- key?: 'amount' | 'productsCount' | 'transactionId';
17
- /**
18
- * Value of the metric
19
- */
20
- value?: (number | string);
21
- }>;
22
- /**
23
- * Bucketing data (experiences that this visitor is currently part of) for the visitor. In case that **enrichData=true** flag is being sent and
24
- * this attribute is not provided, the bucketing stored on the backend datastore for the given visitor is gonna be used. If both **enrichData=true** and
25
- * **bucketingData**, the **bucketingData** is gonna be merged with the stored data inside the backend data source, the request provided data having the
26
- * biggest overwriting bucketing for the same experience which might exist on the backend
27
- *
28
- */
29
- bucketingData?: Record<string, string>;
30
- };
@@ -1,14 +0,0 @@
1
- import type { BaseMatch } from './BaseMatch';
2
- import type { BaseRuleWithStringValue } from './BaseRuleWithStringValue';
3
- import type { CookieMatchRulesTypes } from './CookieMatchRulesTypes';
4
- import type { TextMatchingOptions } from './TextMatchingOptions';
5
- export type CookieMatchRule = (BaseRuleWithStringValue & {
6
- rule_type: CookieMatchRulesTypes;
7
- matching?: (BaseMatch & {
8
- match_type?: TextMatchingOptions;
9
- });
10
- /**
11
- * The name of the cookie which value is compared to the given rule value
12
- */
13
- key?: string;
14
- });
@@ -1,3 +0,0 @@
1
- export declare enum CookieMatchRulesTypes {
2
- COOKIE = "cookie"
3
- }
@@ -1,10 +0,0 @@
1
- import type { BaseMatch } from './BaseMatch';
2
- import type { BaseRuleWithCountryCodeValue } from './BaseRuleWithCountryCodeValue';
3
- import type { ChoiceMatchingOptions } from './ChoiceMatchingOptions';
4
- import type { CountryMatchRulesTypes } from './CountryMatchRulesTypes';
5
- export type CountryMatchRule = (BaseRuleWithCountryCodeValue & {
6
- rule_type: CountryMatchRulesTypes;
7
- matching?: (BaseMatch & {
8
- match_type?: ChoiceMatchingOptions;
9
- });
10
- });
@@ -1,3 +0,0 @@
1
- export declare enum CountryMatchRulesTypes {
2
- COUNTRY = "country"
3
- }
@@ -1,10 +0,0 @@
1
- import type { BaseMatch } from './BaseMatch';
2
- import type { BaseRuleWithDayOfWeekValue } from './BaseRuleWithDayOfWeekValue';
3
- import type { DayOfWeekMatchRulesTypes } from './DayOfWeekMatchRulesTypes';
4
- import type { NumericMatchingOptions } from './NumericMatchingOptions';
5
- export type DayOfWeekMatchRule = (BaseRuleWithDayOfWeekValue & {
6
- rule_type: DayOfWeekMatchRulesTypes;
7
- matching?: (BaseMatch & {
8
- match_type?: NumericMatchingOptions;
9
- });
10
- });
@@ -1,4 +0,0 @@
1
- export declare enum DayOfWeekMatchRulesTypes {
2
- LOCAL_TIME_DAY_OF_WEEK = "local_time_day_of_week",
3
- PROJECT_TIME_DAY_OF_WEEK = "project_time_day_of_week"
4
- }
@@ -1,11 +0,0 @@
1
- import type { ConfigGoalBase } from './ConfigGoalBase';
2
- import type { DomInteractionGoalSettings } from './DomInteractionGoalSettings';
3
- export type DomInteractionGoal = (ConfigGoalBase & {
4
- type?: DomInteractionGoal.type;
5
- settings?: DomInteractionGoalSettings;
6
- });
7
- export declare namespace DomInteractionGoal {
8
- enum type {
9
- DOM_INTERACTION = "dom_interaction"
10
- }
11
- }
@@ -1,15 +0,0 @@
1
- export type DomInteractionGoalSettings = {
2
- /**
3
- * Array of Events to be tracked by this goal
4
- */
5
- tracked_items: Array<{
6
- /**
7
- * Css selector that identifies the DOM element(s) on which 'event' is to be monitored in order to fire the goal.
8
- */
9
- selector?: string;
10
- /**
11
- * The event to monitor in order to fire the goal.
12
- */
13
- event?: string;
14
- }>;
15
- };
@@ -1,5 +0,0 @@
1
- export type ErrorData = {
2
- code?: number;
3
- message?: string;
4
- fields?: string;
5
- };
@@ -1,9 +0,0 @@
1
- import type { BaseMatch } from './BaseMatch';
2
- import type { BaseRuleWithExperienceBucketedValue } from './BaseRuleWithExperienceBucketedValue';
3
- import type { ChoiceMatchingOptions } from './ChoiceMatchingOptions';
4
- export type ExperienceBucketedMatchRule = (BaseRuleWithExperienceBucketedValue & {
5
- rule_type: string;
6
- matching?: (BaseMatch & {
7
- match_type?: ChoiceMatchingOptions;
8
- });
9
- });
@@ -1,10 +0,0 @@
1
- import type { ExperienceChangeCustomCodeData } from './ExperienceChangeCustomCodeData';
2
- import type { ExperienceChangeDefaultCodeData } from './ExperienceChangeDefaultCodeData';
3
- import type { ExperienceChangeDefaultCodeMultipageData } from './ExperienceChangeDefaultCodeMultipageData';
4
- import type { ExperienceChangeDefaultRedirectData } from './ExperienceChangeDefaultRedirectData';
5
- import type { ExperienceChangeFullStackFeature } from './ExperienceChangeFullStackFeature';
6
- import type { ExperienceChangeRichStructureData } from './ExperienceChangeRichStructureData';
7
- /**
8
- * Object that represents one change done inside an experience
9
- */
10
- export type ExperienceChange = (ExperienceChangeDefaultCodeData | ExperienceChangeDefaultCodeMultipageData | ExperienceChangeDefaultRedirectData | ExperienceChangeCustomCodeData | ExperienceChangeRichStructureData | ExperienceChangeFullStackFeature);
@@ -1,10 +0,0 @@
1
- import type { ExperienceChangeCustomCodeDataAdd } from './ExperienceChangeCustomCodeDataAdd';
2
- import type { ExperienceChangeDefaultCodeDataAdd } from './ExperienceChangeDefaultCodeDataAdd';
3
- import type { ExperienceChangeDefaultCodeMultipageDataAdd } from './ExperienceChangeDefaultCodeMultipageDataAdd';
4
- import type { ExperienceChangeDefaultRedirectDataAdd } from './ExperienceChangeDefaultRedirectDataAdd';
5
- import type { ExperienceChangeFullStackFeatureAdd } from './ExperienceChangeFullStackFeatureAdd';
6
- import type { ExperienceChangeRichStructureDataAdd } from './ExperienceChangeRichStructureDataAdd';
7
- /**
8
- * Object that represents one change done inside an experience, used when adding changes
9
- */
10
- export type ExperienceChangeAdd = (ExperienceChangeDefaultCodeDataAdd | ExperienceChangeDefaultCodeMultipageDataAdd | ExperienceChangeDefaultRedirectDataAdd | ExperienceChangeCustomCodeDataAdd | ExperienceChangeRichStructureDataAdd | ExperienceChangeFullStackFeatureAdd);
@@ -1,27 +0,0 @@
1
- /**
2
- * Object that represents the change done inside an experience
3
- */
4
- export type ExperienceChangeBase = {
5
- type?: ExperienceChangeBase.type;
6
- /**
7
- * This contains all data of this change, any code, settings etc
8
- *
9
- * This is sent by default in the following requests responses: **getExperienceChange**;
10
- *
11
- * All other responses that return this field, will only return it if "include" request parameter contains its name
12
- *
13
- * Data object structure will correspond to the "type" field
14
- *
15
- */
16
- data?: Record<string, any>;
17
- };
18
- export declare namespace ExperienceChangeBase {
19
- enum type {
20
- RICH_STRUCTURE = "richStructure",
21
- CUSTOM_CODE = "customCode",
22
- DEFAULT_CODE = "defaultCode",
23
- DEFAULT_CODE_MULTIPAGE = "defaultCodeMultipage",
24
- DEFAULT_REDIRECT = "defaultRedirect",
25
- FULL_STACK_FEATURE = "fullStackFeature"
26
- }
27
- }
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeCustomCodeDataBase } from './ExperienceChangeCustomCodeDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultCode" type of experience change
5
- */
6
- export type ExperienceChangeCustomCodeData = (ExperienceChangeIdReadOnly & ExperienceChangeCustomCodeDataBase);
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeCustomCodeDataBase } from './ExperienceChangeCustomCodeDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultCode" type of experience change
5
- */
6
- export type ExperienceChangeCustomCodeDataAdd = (ExperienceChangeIdReadOnly & ExperienceChangeCustomCodeDataBase);
@@ -1,29 +0,0 @@
1
- import type { ExperienceChangeBase } from './ExperienceChangeBase';
2
- /**
3
- * Describes structure for "defaultCode" type of experience change
4
- */
5
- export type ExperienceChangeCustomCodeDataBase = (ExperienceChangeBase & {
6
- type?: ExperienceChangeCustomCodeDataBase.type;
7
- /**
8
- * Describes structure for "defaultCode" type of experience change
9
- */
10
- data?: {
11
- /**
12
- * CSS code to be applied by this change
13
- */
14
- css?: string | null;
15
- /**
16
- * Custom javascript code to be applied by this change
17
- */
18
- js?: string | null;
19
- /**
20
- * The **id** of the page connected to this change, in case this is a **multi-page** experiment
21
- */
22
- page_id?: string;
23
- };
24
- });
25
- export declare namespace ExperienceChangeCustomCodeDataBase {
26
- enum type {
27
- CUSTOM_CODE = "customCode"
28
- }
29
- }
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeCustomCodeDataBase } from './ExperienceChangeCustomCodeDataBase';
2
- import type { ExperienceChangeId } from './ExperienceChangeId';
3
- /**
4
- * Describes structure for "customCode" type of experience change
5
- */
6
- export type ExperienceChangeCustomCodeDataUpdate = (ExperienceChangeId & ExperienceChangeCustomCodeDataBase);
@@ -1,5 +0,0 @@
1
- import type { ExperienceChangeCustomCodeDataBase } from './ExperienceChangeCustomCodeDataBase';
2
- /**
3
- * Describes structure for "customCode" type of experience change
4
- */
5
- export type ExperienceChangeCustomCodeDataUpdateNoId = ExperienceChangeCustomCodeDataBase;
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeDataBase } from './ExperienceChangeDefaultCodeDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultCode" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeData = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeDataBase);
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeDataBase } from './ExperienceChangeDefaultCodeDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for adding a "defaultCode" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeDataAdd = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeDataBase);
@@ -1,29 +0,0 @@
1
- import type { ExperienceChangeBase } from './ExperienceChangeBase';
2
- /**
3
- * Describes structure for "defaultCode" type of experience change
4
- */
5
- export type ExperienceChangeDefaultCodeDataBase = (ExperienceChangeBase & {
6
- type?: ExperienceChangeDefaultCodeDataBase.type;
7
- /**
8
- * Describes structure for "defaultCode" type of experience change
9
- */
10
- data?: {
11
- /**
12
- * CSS code to be applied by this change
13
- */
14
- css?: string | null;
15
- /**
16
- * Javascript code generated by the visual editor or written in the same structure, to be applied by this experience change
17
- */
18
- js?: string | null;
19
- /**
20
- * Custom javascript code to be applied by this change
21
- */
22
- custom_js?: string | null;
23
- };
24
- });
25
- export declare namespace ExperienceChangeDefaultCodeDataBase {
26
- enum type {
27
- DEFAULT_CODE = "defaultCode"
28
- }
29
- }
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeDataBase } from './ExperienceChangeDefaultCodeDataBase';
2
- import type { ExperienceChangeId } from './ExperienceChangeId';
3
- /**
4
- * Describes structure for "defaultCode" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeDataUpdate = (ExperienceChangeId & ExperienceChangeDefaultCodeDataBase);
@@ -1,5 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeDataBase } from './ExperienceChangeDefaultCodeDataBase';
2
- /**
3
- * Describes structure for "defaultCode" type of experience change
4
- */
5
- export type ExperienceChangeDefaultCodeDataUpdateNoId = ExperienceChangeDefaultCodeDataBase;
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeMultipageDataBase } from './ExperienceChangeDefaultCodeMultipageDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultCodeMultipage" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeMultipageData = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeMultipageDataBase);
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeMultipageDataBase } from './ExperienceChangeDefaultCodeMultipageDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultCodeMultipage" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeMultipageDataAdd = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeMultipageDataBase);
@@ -1,33 +0,0 @@
1
- import type { ExperienceChangeBase } from './ExperienceChangeBase';
2
- /**
3
- * Describes structure for "defaultCodeMultipage" type of experience change
4
- */
5
- export type ExperienceChangeDefaultCodeMultipageDataBase = (ExperienceChangeBase & {
6
- type?: ExperienceChangeDefaultCodeMultipageDataBase.type;
7
- /**
8
- * Describes structure for "defaultCodeMultipage" type of experience change
9
- */
10
- data?: {
11
- /**
12
- * CSS code to be applied by this change
13
- */
14
- css?: string | null;
15
- /**
16
- * Javascript code generated by the visual editor or written in the same structure, to be applied by this experience change
17
- */
18
- js?: string | null;
19
- /**
20
- * Custom javascript code to be applied by this change
21
- */
22
- custom_js?: string | null;
23
- /**
24
- * The **id** of the page connected to this change.
25
- */
26
- page_id?: string;
27
- };
28
- });
29
- export declare namespace ExperienceChangeDefaultCodeMultipageDataBase {
30
- enum type {
31
- DEFAULT_CODE_MULTIPAGE = "defaultCodeMultipage"
32
- }
33
- }
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeMultipageDataBase } from './ExperienceChangeDefaultCodeMultipageDataBase';
2
- import type { ExperienceChangeId } from './ExperienceChangeId';
3
- /**
4
- * Describes structure for "defaultCodeMultipage" type of experience change
5
- */
6
- export type ExperienceChangeDefaultCodeMultipageDataUpdate = (ExperienceChangeId & ExperienceChangeDefaultCodeMultipageDataBase);
@@ -1,5 +0,0 @@
1
- import type { ExperienceChangeDefaultCodeMultipageDataBase } from './ExperienceChangeDefaultCodeMultipageDataBase';
2
- /**
3
- * Describes structure for "defaultCodeMultipage" type of experience change
4
- */
5
- export type ExperienceChangeDefaultCodeMultipageDataUpdateNoId = ExperienceChangeDefaultCodeMultipageDataBase;
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultRedirectDataBase } from './ExperienceChangeDefaultRedirectDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultRedirect" type of experience change
5
- */
6
- export type ExperienceChangeDefaultRedirectData = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultRedirectDataBase);
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultRedirectDataBase } from './ExperienceChangeDefaultRedirectDataBase';
2
- import type { ExperienceChangeIdReadOnly } from './ExperienceChangeIdReadOnly';
3
- /**
4
- * Describes structure for "defaultRedirect" type of experience change
5
- */
6
- export type ExperienceChangeDefaultRedirectDataAdd = (ExperienceChangeIdReadOnly & ExperienceChangeDefaultRedirectDataBase);
@@ -1,29 +0,0 @@
1
- import type { ExperienceChangeBase } from './ExperienceChangeBase';
2
- /**
3
- * Describes structure for "defaultRedirect" type of experience change
4
- */
5
- export type ExperienceChangeDefaultRedirectDataBase = (ExperienceChangeBase & {
6
- type?: ExperienceChangeDefaultRedirectDataBase.type;
7
- /**
8
- * Describes structure for "defaultRedirect" type of experience change
9
- */
10
- data?: {
11
- /**
12
- * Defines whether the URL matching is case sensitive or not
13
- */
14
- case_sensitive?: boolean;
15
- /**
16
- * Pattern for matching the Original URL in order to construct the redirect URL
17
- */
18
- original_pattern?: string;
19
- /**
20
- * String used to construct the variation redirect URL. This string can contain matches from original_url or it can be a standard URL
21
- */
22
- variation_pattern?: string;
23
- };
24
- });
25
- export declare namespace ExperienceChangeDefaultRedirectDataBase {
26
- enum type {
27
- DEFAULT_REDIRECT = "defaultRedirect"
28
- }
29
- }
@@ -1,6 +0,0 @@
1
- import type { ExperienceChangeDefaultRedirectDataBase } from './ExperienceChangeDefaultRedirectDataBase';
2
- import type { ExperienceChangeId } from './ExperienceChangeId';
3
- /**
4
- * Describes structure for "defaultRedirect" type of experience change
5
- */
6
- export type ExperienceChangeDefaultRedirectDataUpdate = (ExperienceChangeId & ExperienceChangeDefaultRedirectDataBase);