@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.
- package/lib/enums/src/dictionary.d.ts +3 -0
- package/lib/enums/src/goal-data-key.d.ts +6 -1
- package/lib/index.d.ts +2 -1
- package/lib/index.js +203 -157
- package/lib/index.js.map +1 -1
- package/lib/index.min.js +1 -1
- package/lib/index.min.js.map +1 -1
- package/lib/index.min.mjs +1 -1
- package/lib/index.min.mjs.map +1 -1
- package/lib/index.mjs +203 -157
- package/lib/index.mjs.map +1 -1
- package/lib/legacy/index.js +180 -134
- package/lib/legacy/index.js.map +1 -1
- package/lib/legacy/index.min.js +1 -1
- package/lib/legacy/index.min.js.map +1 -1
- package/lib/package.json +5 -5
- package/lib/rules/src/interfaces/rule-manager.d.ts +1 -0
- package/lib/rules/src/rule-manager.d.ts +1 -1
- package/lib/types/index.d.ts +1 -0
- package/lib/types/src/config/index.d.ts +1 -192
- package/lib/types/src/config/types.gen.d.ts +2494 -0
- package/lib/utils/src/string-utils.d.ts +12 -0
- package/package.json +5 -5
- package/lib/types/src/config/models/Base64Image.d.ts +0 -6
- package/lib/types/src/config/models/BaseMatch.d.ts +0 -8
- package/lib/types/src/config/models/BaseRule.d.ts +0 -6
- package/lib/types/src/config/models/BaseRuleWithBooleanValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithBrowserNameValue.d.ts +0 -21
- package/lib/types/src/config/models/BaseRuleWithCountryCodeValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithDayOfWeekValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithExperienceBucketedValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithGoalTriggeredValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithHourOfDayValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithJsCodeValue.d.ts +0 -9
- package/lib/types/src/config/models/BaseRuleWithLanguageCodeValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithMinuteOfHourValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithNumericValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithOsValue.d.ts +0 -21
- package/lib/types/src/config/models/BaseRuleWithSegmentBucketedValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithStringValue.d.ts +0 -7
- package/lib/types/src/config/models/BaseRuleWithVisitorTypeValue.d.ts +0 -16
- package/lib/types/src/config/models/BaseRuleWithWeatherConditionValue.d.ts +0 -34
- package/lib/types/src/config/models/BoolMatchRulesTypes.d.ts +0 -6
- package/lib/types/src/config/models/BrowserNameMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/BrowserNameMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/BucketingEvent.d.ts +0 -15
- package/lib/types/src/config/models/ChoiceContainsOptions.d.ts +0 -3
- package/lib/types/src/config/models/ChoiceMatchingOptions.d.ts +0 -3
- package/lib/types/src/config/models/ClicksElementGoal.d.ts +0 -11
- package/lib/types/src/config/models/ClicksElementGoalSettings.d.ts +0 -6
- package/lib/types/src/config/models/ClicksLinkGoal.d.ts +0 -11
- package/lib/types/src/config/models/ClicksLinkGoalSettings.d.ts +0 -6
- package/lib/types/src/config/models/ConfigAudience.d.ts +0 -21
- package/lib/types/src/config/models/ConfigAudienceTypes.d.ts +0 -10
- package/lib/types/src/config/models/ConfigExperience.d.ts +0 -98
- package/lib/types/src/config/models/ConfigFeature.d.ts +0 -22
- package/lib/types/src/config/models/ConfigGoal.d.ts +0 -9
- package/lib/types/src/config/models/ConfigGoalBase.d.ts +0 -24
- package/lib/types/src/config/models/ConfigLocation.d.ts +0 -21
- package/lib/types/src/config/models/ConfigProject.d.ts +0 -151
- package/lib/types/src/config/models/ConfigResponseData.d.ts +0 -45
- package/lib/types/src/config/models/ConfigSegment.d.ts +0 -19
- package/lib/types/src/config/models/ConversionEvent.d.ts +0 -30
- package/lib/types/src/config/models/CookieMatchRule.d.ts +0 -14
- package/lib/types/src/config/models/CookieMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/CountryMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/CountryMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/DayOfWeekMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/DayOfWeekMatchRulesTypes.d.ts +0 -4
- package/lib/types/src/config/models/DomInteractionGoal.d.ts +0 -11
- package/lib/types/src/config/models/DomInteractionGoalSettings.d.ts +0 -15
- package/lib/types/src/config/models/ErrorData.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceBucketedMatchRule.d.ts +0 -9
- package/lib/types/src/config/models/ExperienceChange.d.ts +0 -10
- package/lib/types/src/config/models/ExperienceChangeAdd.d.ts +0 -10
- package/lib/types/src/config/models/ExperienceChangeBase.d.ts +0 -27
- package/lib/types/src/config/models/ExperienceChangeCustomCodeData.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeCustomCodeDataAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeCustomCodeDataBase.d.ts +0 -29
- package/lib/types/src/config/models/ExperienceChangeCustomCodeDataUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeCustomCodeDataUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeData.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataBase.d.ts +0 -29
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeDataUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageData.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataBase.d.ts +0 -33
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultCodeMultipageDataUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeDefaultRedirectData.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataBase.d.ts +0 -29
- package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeDefaultRedirectDataUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeFullStackFeature.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeFullStackFeatureAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeFullStackFeatureBase.d.ts +0 -25
- package/lib/types/src/config/models/ExperienceChangeFullStackFeatureUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeFullStackFeatureUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeId.d.ts +0 -9
- package/lib/types/src/config/models/ExperienceChangeIdReadOnly.d.ts +0 -9
- package/lib/types/src/config/models/ExperienceChangeRichStructureData.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeRichStructureDataAdd.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeRichStructureDataBase.d.ts +0 -16
- package/lib/types/src/config/models/ExperienceChangeRichStructureDataUpdate.d.ts +0 -6
- package/lib/types/src/config/models/ExperienceChangeRichStructureDataUpdateNoId.d.ts +0 -5
- package/lib/types/src/config/models/ExperienceChangeUpdate.d.ts +0 -10
- package/lib/types/src/config/models/ExperienceChangeUpdateNoId.d.ts +0 -10
- package/lib/types/src/config/models/ExperienceIntegrationBaidu.d.ts +0 -7
- package/lib/types/src/config/models/ExperienceIntegrationBase.d.ts +0 -10
- package/lib/types/src/config/models/ExperienceIntegrationClicktale.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationClicky.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationCnzz.d.ts +0 -7
- package/lib/types/src/config/models/ExperienceIntegrationCrazyegg.d.ts +0 -9
- package/lib/types/src/config/models/ExperienceIntegrationEconda.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationEulerian.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationGA3.d.ts +0 -9
- package/lib/types/src/config/models/ExperienceIntegrationGA4.d.ts +0 -8
- package/lib/types/src/config/models/ExperienceIntegrationGA4Base.d.ts +0 -4
- package/lib/types/src/config/models/ExperienceIntegrationGAServing.d.ts +0 -3
- package/lib/types/src/config/models/ExperienceIntegrationGoogleAnalytics.d.ts +0 -3
- package/lib/types/src/config/models/ExperienceIntegrationGosquared.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationHeapanalytics.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationHotjar.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationMixpanel.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationMouseflow.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationPiwik.d.ts +0 -7
- package/lib/types/src/config/models/ExperienceIntegrationSegmentio.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationSitecatalyst.d.ts +0 -7
- package/lib/types/src/config/models/ExperienceIntegrationWoopra.d.ts +0 -2
- package/lib/types/src/config/models/ExperienceIntegrationYsance.d.ts +0 -7
- package/lib/types/src/config/models/ExperienceTypes.d.ts +0 -8
- package/lib/types/src/config/models/ExperienceVariationConfig.d.ts +0 -30
- package/lib/types/src/config/models/Extra.d.ts +0 -4
- package/lib/types/src/config/models/FeatureVariableItemData.d.ts +0 -25
- package/lib/types/src/config/models/GA_Settings.d.ts +0 -3
- package/lib/types/src/config/models/GA_SettingsBase.d.ts +0 -6
- package/lib/types/src/config/models/GaGoal.d.ts +0 -11
- package/lib/types/src/config/models/GaGoalSettings.d.ts +0 -6
- package/lib/types/src/config/models/GenericBoolKeyValueMatchRule.d.ts +0 -11
- package/lib/types/src/config/models/GenericBoolKeyValueMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/GenericBoolMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/GenericKey.d.ts +0 -6
- package/lib/types/src/config/models/GenericNumericKeyValueMatchRule.d.ts +0 -11
- package/lib/types/src/config/models/GenericNumericKeyValueMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/GenericNumericMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/GenericSetMatchRule.d.ts +0 -9
- package/lib/types/src/config/models/GenericTextKeyValueMatchRule.d.ts +0 -11
- package/lib/types/src/config/models/GenericTextKeyValueMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/GenericTextMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/GoalTriggeredMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/GoalTriggeredMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/GoalTypes.d.ts +0 -10
- package/lib/types/src/config/models/HourOfDayMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/HourOfDayMatchRulesTypes.d.ts +0 -4
- package/lib/types/src/config/models/IntegrationGA3.d.ts +0 -12
- package/lib/types/src/config/models/IntegrationGA4.d.ts +0 -7
- package/lib/types/src/config/models/IntegrationGA4Base.d.ts +0 -12
- package/lib/types/src/config/models/IntegrationProvider.d.ts +0 -23
- package/lib/types/src/config/models/JsConditionMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/JsConditionMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/KeyValueMatchRulesTypes.d.ts +0 -4
- package/lib/types/src/config/models/LanguageMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/LanguageMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/LocationTrigger.d.ts +0 -5
- package/lib/types/src/config/models/LocationTriggerBase.d.ts +0 -14
- package/lib/types/src/config/models/LocationTriggerCallback.d.ts +0 -13
- package/lib/types/src/config/models/LocationTriggerDomChange.d.ts +0 -17
- package/lib/types/src/config/models/LocationTriggerManual.d.ts +0 -9
- package/lib/types/src/config/models/LocationTriggerUrlChange.d.ts +0 -9
- package/lib/types/src/config/models/MinuteOfHourMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/MinuteOfHourMatchRulesTypes.d.ts +0 -4
- package/lib/types/src/config/models/NoSettingsGoal.d.ts +0 -11
- package/lib/types/src/config/models/NumericMatchRulesTypes.d.ts +0 -8
- package/lib/types/src/config/models/NumericMatchingOptions.d.ts +0 -5
- package/lib/types/src/config/models/OnlyCount.d.ts +0 -7
- package/lib/types/src/config/models/OsMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/OsMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/PageNumber.d.ts +0 -9
- package/lib/types/src/config/models/Pagination.d.ts +0 -18
- package/lib/types/src/config/models/ProjectGASettingsBase.d.ts +0 -7
- package/lib/types/src/config/models/ProjectIntegrationGA3.d.ts +0 -3
- package/lib/types/src/config/models/ProjectIntegrationGA4.d.ts +0 -8
- package/lib/types/src/config/models/ResultsPerPage.d.ts +0 -10
- package/lib/types/src/config/models/RevenueGoal.d.ts +0 -11
- package/lib/types/src/config/models/RevenueGoalSettings.d.ts +0 -25
- package/lib/types/src/config/models/RuleElement.d.ts +0 -20
- package/lib/types/src/config/models/RuleElementNoUrl.d.ts +0 -20
- package/lib/types/src/config/models/RuleObject.d.ts +0 -20
- package/lib/types/src/config/models/RuleObjectNoUrl.d.ts +0 -20
- package/lib/types/src/config/models/RulesTypes.d.ts +0 -17
- package/lib/types/src/config/models/ScrollPercentageGoal.d.ts +0 -11
- package/lib/types/src/config/models/ScrollPercentageGoalSettings.d.ts +0 -6
- package/lib/types/src/config/models/SegmentBucketedMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/SegmentBucketedMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/SendTrackingEventsRequestData.d.ts +0 -39
- package/lib/types/src/config/models/SetMatchingOptions.d.ts +0 -3
- package/lib/types/src/config/models/SortDirection.d.ts +0 -21
- package/lib/types/src/config/models/SubmitsFormGoal.d.ts +0 -11
- package/lib/types/src/config/models/SubmitsFormGoalSettings.d.ts +0 -6
- package/lib/types/src/config/models/SuccessData.d.ts +0 -4
- package/lib/types/src/config/models/TextMatchRulesTypes.d.ts +0 -23
- package/lib/types/src/config/models/TextMatchingOptions.d.ts +0 -7
- package/lib/types/src/config/models/UTC_Offset.d.ts +0 -4
- package/lib/types/src/config/models/UpdateExperienceChangeRequestData.d.ts +0 -2
- package/lib/types/src/config/models/VariationStatuses.d.ts +0 -7
- package/lib/types/src/config/models/VisitorSegments.d.ts +0 -78
- package/lib/types/src/config/models/VisitorTrackingEvents.d.ts +0 -21
- package/lib/types/src/config/models/VisitorTypeMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/VisitorTypeMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/WeatherConditionMatchRule.d.ts +0 -10
- package/lib/types/src/config/models/WeatherConditionMatchRulesTypes.d.ts +0 -3
- package/lib/types/src/config/models/WeatherConditions.d.ts +0 -30
|
@@ -0,0 +1,2494 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Base Audience object
|
|
3
|
+
*/
|
|
4
|
+
export type ConfigAudience = {
|
|
5
|
+
/**
|
|
6
|
+
* Audience ID
|
|
7
|
+
*/
|
|
8
|
+
id?: string;
|
|
9
|
+
/**
|
|
10
|
+
* Audience unique key
|
|
11
|
+
*/
|
|
12
|
+
key?: string;
|
|
13
|
+
/**
|
|
14
|
+
* Audience Name
|
|
15
|
+
*/
|
|
16
|
+
name?: string;
|
|
17
|
+
type?: ConfigAudienceTypes;
|
|
18
|
+
rules?: ((RuleObject) | null);
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Type of the Audience. Can be one of the following: `permanent`, `transient`. For full-stack projects, `transient` is the only valid option, the rest will be ignored.
|
|
22
|
+
* * **permanent** - A permanent audience is one that is checked only at the time the user is being bucketed into the experience
|
|
23
|
+
* * **transient** - A transient audience is one that is checked every time the user is being bucketed into the experience
|
|
24
|
+
*
|
|
25
|
+
*/
|
|
26
|
+
export type ConfigAudienceTypes = 'permanent' | 'transient';
|
|
27
|
+
/**
|
|
28
|
+
* Type of the Audience. Can be one of the following: `permanent`, `transient`. For full-stack projects, `transient` is the only valid option, the rest will be ignored.
|
|
29
|
+
* * **permanent** - A permanent audience is one that is checked only at the time the user is being bucketed into the experience
|
|
30
|
+
* * **transient** - A transient audience is one that is checked every time the user is being bucketed into the experience
|
|
31
|
+
*
|
|
32
|
+
*/
|
|
33
|
+
export declare const ConfigAudienceTypes: {
|
|
34
|
+
readonly PERMANENT: "permanent";
|
|
35
|
+
readonly TRANSIENT: "transient";
|
|
36
|
+
};
|
|
37
|
+
export type PageNumber = {
|
|
38
|
+
/**
|
|
39
|
+
* Describes the page number of the fetched results. "results_per_page" results are gonna be returned for each page
|
|
40
|
+
*
|
|
41
|
+
* Defaults to 1 when not sent
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
page?: number;
|
|
45
|
+
};
|
|
46
|
+
export type Pagination = {
|
|
47
|
+
/**
|
|
48
|
+
* Current page number
|
|
49
|
+
*/
|
|
50
|
+
current_page?: number;
|
|
51
|
+
/**
|
|
52
|
+
* Total number of records
|
|
53
|
+
*/
|
|
54
|
+
items_count?: number;
|
|
55
|
+
/**
|
|
56
|
+
* Number of records per page
|
|
57
|
+
*/
|
|
58
|
+
items_per_page?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Limitation number of records per page
|
|
61
|
+
*/
|
|
62
|
+
pages_count?: number;
|
|
63
|
+
};
|
|
64
|
+
export type ResultsPerPage = {
|
|
65
|
+
/**
|
|
66
|
+
* A value that would be used for setting the number of records that
|
|
67
|
+
* would be returned per page.
|
|
68
|
+
*
|
|
69
|
+
* Defaults to 30 when not sent
|
|
70
|
+
*
|
|
71
|
+
*/
|
|
72
|
+
results_per_page?: (number) | null;
|
|
73
|
+
};
|
|
74
|
+
export type SortDirection = {
|
|
75
|
+
/**
|
|
76
|
+
* Data sorting direction using "sort_by" field. "asc" for ascending direction, "desc" for descending direction
|
|
77
|
+
*
|
|
78
|
+
* Defaults to **desc** when not sent in a request
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
sort_direction?: ('asc' | 'desc') | null;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Data sorting direction using "sort_by" field. "asc" for ascending direction, "desc" for descending direction
|
|
85
|
+
*
|
|
86
|
+
* Defaults to **desc** when not sent in a request
|
|
87
|
+
*
|
|
88
|
+
*/
|
|
89
|
+
export type sort_direction = 'asc' | 'desc';
|
|
90
|
+
/**
|
|
91
|
+
* Data sorting direction using "sort_by" field. "asc" for ascending direction, "desc" for descending direction
|
|
92
|
+
*
|
|
93
|
+
* Defaults to **desc** when not sent in a request
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export declare const sort_direction: {
|
|
97
|
+
readonly ASC: "asc";
|
|
98
|
+
readonly DESC: "desc";
|
|
99
|
+
};
|
|
100
|
+
export type OnlyCount = {
|
|
101
|
+
/**
|
|
102
|
+
* When provided in requests that allow it, the response would only contain count of records and no real records' data
|
|
103
|
+
*
|
|
104
|
+
*/
|
|
105
|
+
onlyCount?: boolean;
|
|
106
|
+
};
|
|
107
|
+
export type Extra = {
|
|
108
|
+
pagination?: Pagination;
|
|
109
|
+
};
|
|
110
|
+
export type BaseRule = {
|
|
111
|
+
/**
|
|
112
|
+
* It defines the type of the rule
|
|
113
|
+
*/
|
|
114
|
+
rule_type: string;
|
|
115
|
+
};
|
|
116
|
+
export type BaseRuleWithStringValue = BaseRule & {
|
|
117
|
+
/**
|
|
118
|
+
* The value used to match against 'rule_type' using 'matching'
|
|
119
|
+
*/
|
|
120
|
+
value?: string;
|
|
121
|
+
};
|
|
122
|
+
export type BaseRuleWithJsCodeValue = BaseRule & {
|
|
123
|
+
/**
|
|
124
|
+
* The JS code that would be executed when rule is checked. The return value of this JS code is what is gonna be matched
|
|
125
|
+
* against **true**(or **false** if **matching.negated = true** is provided)
|
|
126
|
+
*
|
|
127
|
+
*/
|
|
128
|
+
value?: string;
|
|
129
|
+
};
|
|
130
|
+
export type BaseRuleWithBooleanValue = BaseRule & {
|
|
131
|
+
/**
|
|
132
|
+
* The value used to match against 'rule_type' using 'matching'
|
|
133
|
+
*/
|
|
134
|
+
value?: boolean;
|
|
135
|
+
};
|
|
136
|
+
export type BaseRuleWithNumericValue = BaseRule & {
|
|
137
|
+
/**
|
|
138
|
+
* The value used to match against 'rule_type' using 'matching'
|
|
139
|
+
*/
|
|
140
|
+
value?: number;
|
|
141
|
+
};
|
|
142
|
+
export type BaseRuleWithCountryCodeValue = BaseRule & {
|
|
143
|
+
/**
|
|
144
|
+
* The 2 letter ISO country code used for matching
|
|
145
|
+
*/
|
|
146
|
+
value?: string;
|
|
147
|
+
};
|
|
148
|
+
export type BaseRuleWithLanguageCodeValue = BaseRule & {
|
|
149
|
+
/**
|
|
150
|
+
* The 2 letter ISO language code used for matching
|
|
151
|
+
*/
|
|
152
|
+
value?: string;
|
|
153
|
+
};
|
|
154
|
+
export type BaseRuleWithGoalTriggeredValue = BaseRule & {
|
|
155
|
+
/**
|
|
156
|
+
* ID of the goal used for matching
|
|
157
|
+
*/
|
|
158
|
+
value?: number;
|
|
159
|
+
};
|
|
160
|
+
export type BaseRuleWithVisitorTypeValue = BaseRule & {
|
|
161
|
+
/**
|
|
162
|
+
* Type of the visitors
|
|
163
|
+
*/
|
|
164
|
+
value?: 'new' | 'returning';
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Type of the visitors
|
|
168
|
+
*/
|
|
169
|
+
export type value = 'new' | 'returning';
|
|
170
|
+
/**
|
|
171
|
+
* Type of the visitors
|
|
172
|
+
*/
|
|
173
|
+
export declare const value: {
|
|
174
|
+
readonly NEW: "new";
|
|
175
|
+
readonly RETURNING: "returning";
|
|
176
|
+
};
|
|
177
|
+
export type BaseRuleWithExperienceBucketedValue = BaseRule & {
|
|
178
|
+
/**
|
|
179
|
+
* ID of the experience used for matching
|
|
180
|
+
*/
|
|
181
|
+
value?: number;
|
|
182
|
+
};
|
|
183
|
+
export type BaseRuleWithSegmentBucketedValue = BaseRule & {
|
|
184
|
+
/**
|
|
185
|
+
* ID of the segment used for matching
|
|
186
|
+
*/
|
|
187
|
+
value?: number;
|
|
188
|
+
};
|
|
189
|
+
export type BaseRuleWithDayOfWeekValue = BaseRule & {
|
|
190
|
+
/**
|
|
191
|
+
* Day of week used for matching
|
|
192
|
+
*/
|
|
193
|
+
value?: number;
|
|
194
|
+
};
|
|
195
|
+
export type BaseRuleWithHourOfDayValue = BaseRule & {
|
|
196
|
+
/**
|
|
197
|
+
* Hour of day used for matching
|
|
198
|
+
*/
|
|
199
|
+
value?: number;
|
|
200
|
+
};
|
|
201
|
+
export type BaseRuleWithMinuteOfHourValue = BaseRule & {
|
|
202
|
+
/**
|
|
203
|
+
* Minute of hour used for matching
|
|
204
|
+
*/
|
|
205
|
+
value?: number;
|
|
206
|
+
};
|
|
207
|
+
export type BaseRuleWithBrowserNameValue = BaseRule & {
|
|
208
|
+
/**
|
|
209
|
+
* Browser name used for matching
|
|
210
|
+
*/
|
|
211
|
+
value?: 'chrome' | 'microsoft_ie' | 'firefox' | 'microsoft_edge' | 'mozilla' | 'opera' | 'safari';
|
|
212
|
+
};
|
|
213
|
+
/**
|
|
214
|
+
* Browser name used for matching
|
|
215
|
+
*/
|
|
216
|
+
export type value2 = 'chrome' | 'microsoft_ie' | 'firefox' | 'microsoft_edge' | 'mozilla' | 'opera' | 'safari';
|
|
217
|
+
/**
|
|
218
|
+
* Browser name used for matching
|
|
219
|
+
*/
|
|
220
|
+
export declare const value2: {
|
|
221
|
+
readonly CHROME: "chrome";
|
|
222
|
+
readonly MICROSOFT_IE: "microsoft_ie";
|
|
223
|
+
readonly FIREFOX: "firefox";
|
|
224
|
+
readonly MICROSOFT_EDGE: "microsoft_edge";
|
|
225
|
+
readonly MOZILLA: "mozilla";
|
|
226
|
+
readonly OPERA: "opera";
|
|
227
|
+
readonly SAFARI: "safari";
|
|
228
|
+
};
|
|
229
|
+
export type BaseRuleWithOsValue = BaseRule & {
|
|
230
|
+
/**
|
|
231
|
+
* Operating System name used for matching
|
|
232
|
+
*/
|
|
233
|
+
value?: 'android' | 'iphone' | 'ipod' | 'ipad' | 'windows' | 'macos' | 'linux';
|
|
234
|
+
};
|
|
235
|
+
/**
|
|
236
|
+
* Operating System name used for matching
|
|
237
|
+
*/
|
|
238
|
+
export type value3 = 'android' | 'iphone' | 'ipod' | 'ipad' | 'windows' | 'macos' | 'linux';
|
|
239
|
+
/**
|
|
240
|
+
* Operating System name used for matching
|
|
241
|
+
*/
|
|
242
|
+
export declare const value3: {
|
|
243
|
+
readonly ANDROID: "android";
|
|
244
|
+
readonly IPHONE: "iphone";
|
|
245
|
+
readonly IPOD: "ipod";
|
|
246
|
+
readonly IPAD: "ipad";
|
|
247
|
+
readonly WINDOWS: "windows";
|
|
248
|
+
readonly MACOS: "macos";
|
|
249
|
+
readonly LINUX: "linux";
|
|
250
|
+
};
|
|
251
|
+
export type BaseRuleWithWeatherConditionValue = BaseRule & {
|
|
252
|
+
/**
|
|
253
|
+
* Weather Condition name used for matching. Full or partial condition.
|
|
254
|
+
* The weather provider used by Convert detects the following conditions:
|
|
255
|
+
* - Blizzard
|
|
256
|
+
* - Blowing snow
|
|
257
|
+
* - Cloudy
|
|
258
|
+
* - Fog
|
|
259
|
+
* - Freezing drizzle
|
|
260
|
+
* - Freezing fog
|
|
261
|
+
* - Heavy freezing drizzle
|
|
262
|
+
* - Heavy rain
|
|
263
|
+
* - Heavy rain at times
|
|
264
|
+
* - Light drizzle
|
|
265
|
+
* - Light freezing rain
|
|
266
|
+
* - Light rain
|
|
267
|
+
* - Mist
|
|
268
|
+
* - Moderate rain
|
|
269
|
+
* - Moderate rain at times
|
|
270
|
+
* - Overcast
|
|
271
|
+
* - Partly cloudy
|
|
272
|
+
* - Patchy freezing drizzle possible
|
|
273
|
+
* - Patchy light drizzle
|
|
274
|
+
* - Patchy light rain
|
|
275
|
+
* - Patchy rain possible
|
|
276
|
+
* - Patchy sleet possible
|
|
277
|
+
* - Patchy snow possible
|
|
278
|
+
* - Sunny
|
|
279
|
+
* - Thundery outbreaks possible
|
|
280
|
+
*
|
|
281
|
+
*/
|
|
282
|
+
value?: string;
|
|
283
|
+
};
|
|
284
|
+
/**
|
|
285
|
+
* Weather Conditions
|
|
286
|
+
*/
|
|
287
|
+
export type WeatherConditions = 'Blizzard' | 'Blowing snow' | 'Cloudy' | 'Fog' | 'Freezing drizzle' | 'Freezing fog' | 'Heavy freezing drizzle' | 'Heavy rain' | 'Heavy rain at times' | 'Light drizzle' | 'Light freezing rain' | 'Light rain' | 'Mist' | 'Moderate rain' | 'Moderate rain at times' | 'Overcast' | 'Partly cloudy' | 'Patchy freezing drizzle possible' | 'Patchy light drizzle' | 'Patchy light rain' | 'Patchy rain possible' | 'Patchy sleet possible' | 'Patchy snow possible' | 'Sunny' | 'Thundery outbreaks possible';
|
|
288
|
+
/**
|
|
289
|
+
* Weather Conditions
|
|
290
|
+
*/
|
|
291
|
+
export declare const WeatherConditions: {
|
|
292
|
+
readonly BLIZZARD: "Blizzard";
|
|
293
|
+
readonly BLOWING_SNOW: "Blowing snow";
|
|
294
|
+
readonly CLOUDY: "Cloudy";
|
|
295
|
+
readonly FOG: "Fog";
|
|
296
|
+
readonly FREEZING_DRIZZLE: "Freezing drizzle";
|
|
297
|
+
readonly FREEZING_FOG: "Freezing fog";
|
|
298
|
+
readonly HEAVY_FREEZING_DRIZZLE: "Heavy freezing drizzle";
|
|
299
|
+
readonly HEAVY_RAIN: "Heavy rain";
|
|
300
|
+
readonly HEAVY_RAIN_AT_TIMES: "Heavy rain at times";
|
|
301
|
+
readonly LIGHT_DRIZZLE: "Light drizzle";
|
|
302
|
+
readonly LIGHT_FREEZING_RAIN: "Light freezing rain";
|
|
303
|
+
readonly LIGHT_RAIN: "Light rain";
|
|
304
|
+
readonly MIST: "Mist";
|
|
305
|
+
readonly MODERATE_RAIN: "Moderate rain";
|
|
306
|
+
readonly MODERATE_RAIN_AT_TIMES: "Moderate rain at times";
|
|
307
|
+
readonly OVERCAST: "Overcast";
|
|
308
|
+
readonly PARTLY_CLOUDY: "Partly cloudy";
|
|
309
|
+
readonly PATCHY_FREEZING_DRIZZLE_POSSIBLE: "Patchy freezing drizzle possible";
|
|
310
|
+
readonly PATCHY_LIGHT_DRIZZLE: "Patchy light drizzle";
|
|
311
|
+
readonly PATCHY_LIGHT_RAIN: "Patchy light rain";
|
|
312
|
+
readonly PATCHY_RAIN_POSSIBLE: "Patchy rain possible";
|
|
313
|
+
readonly PATCHY_SLEET_POSSIBLE: "Patchy sleet possible";
|
|
314
|
+
readonly PATCHY_SNOW_POSSIBLE: "Patchy snow possible";
|
|
315
|
+
readonly SUNNY: "Sunny";
|
|
316
|
+
readonly THUNDERY_OUTBREAKS_POSSIBLE: "Thundery outbreaks possible";
|
|
317
|
+
};
|
|
318
|
+
export type BaseMatch = {
|
|
319
|
+
/**
|
|
320
|
+
* When true, the rule result is gonna be negated.
|
|
321
|
+
* example: `url contains "test"` with *negated* = true becomes `url does not contain "test"`
|
|
322
|
+
*
|
|
323
|
+
*/
|
|
324
|
+
negated?: boolean;
|
|
325
|
+
};
|
|
326
|
+
export type TextMatchRulesTypes = 'url' | 'url_with_query' | 'query_string' | 'campaign' | 'keyword' | 'medium' | 'source_name' | 'city' | 'region' | 'browser_version' | 'user_agent' | 'page_tag_page_type' | 'page_tag_category_id' | 'page_tag_category_name' | 'page_tag_product_sku' | 'page_tag_product_name' | 'page_tag_customer_id' | 'page_tag_custom_1' | 'page_tag_custom_2' | 'page_tag_custom_3' | 'page_tag_custom_4';
|
|
327
|
+
export declare const TextMatchRulesTypes: {
|
|
328
|
+
readonly URL: "url";
|
|
329
|
+
readonly URL_WITH_QUERY: "url_with_query";
|
|
330
|
+
readonly QUERY_STRING: "query_string";
|
|
331
|
+
readonly CAMPAIGN: "campaign";
|
|
332
|
+
readonly KEYWORD: "keyword";
|
|
333
|
+
readonly MEDIUM: "medium";
|
|
334
|
+
readonly SOURCE_NAME: "source_name";
|
|
335
|
+
readonly CITY: "city";
|
|
336
|
+
readonly REGION: "region";
|
|
337
|
+
readonly BROWSER_VERSION: "browser_version";
|
|
338
|
+
readonly USER_AGENT: "user_agent";
|
|
339
|
+
readonly PAGE_TAG_PAGE_TYPE: "page_tag_page_type";
|
|
340
|
+
readonly PAGE_TAG_CATEGORY_ID: "page_tag_category_id";
|
|
341
|
+
readonly PAGE_TAG_CATEGORY_NAME: "page_tag_category_name";
|
|
342
|
+
readonly PAGE_TAG_PRODUCT_SKU: "page_tag_product_sku";
|
|
343
|
+
readonly PAGE_TAG_PRODUCT_NAME: "page_tag_product_name";
|
|
344
|
+
readonly PAGE_TAG_CUSTOMER_ID: "page_tag_customer_id";
|
|
345
|
+
readonly PAGE_TAG_CUSTOM_1: "page_tag_custom_1";
|
|
346
|
+
readonly PAGE_TAG_CUSTOM_2: "page_tag_custom_2";
|
|
347
|
+
readonly PAGE_TAG_CUSTOM_3: "page_tag_custom_3";
|
|
348
|
+
readonly PAGE_TAG_CUSTOM_4: "page_tag_custom_4";
|
|
349
|
+
};
|
|
350
|
+
export type NumericMatchRulesTypes = 'avg_time_page' | 'days_since_last_visit' | 'pages_visited_count' | 'visit_duration' | 'visits_count' | 'page_tag_product_price';
|
|
351
|
+
export declare const NumericMatchRulesTypes: {
|
|
352
|
+
readonly AVG_TIME_PAGE: "avg_time_page";
|
|
353
|
+
readonly DAYS_SINCE_LAST_VISIT: "days_since_last_visit";
|
|
354
|
+
readonly PAGES_VISITED_COUNT: "pages_visited_count";
|
|
355
|
+
readonly VISIT_DURATION: "visit_duration";
|
|
356
|
+
readonly VISITS_COUNT: "visits_count";
|
|
357
|
+
readonly PAGE_TAG_PRODUCT_PRICE: "page_tag_product_price";
|
|
358
|
+
};
|
|
359
|
+
export type BoolMatchRulesTypes = 'bucketed_into_experience' | 'is_desktop' | 'is_mobile' | 'is_tablet';
|
|
360
|
+
export declare const BoolMatchRulesTypes: {
|
|
361
|
+
readonly BUCKETED_INTO_EXPERIENCE: "bucketed_into_experience";
|
|
362
|
+
readonly IS_DESKTOP: "is_desktop";
|
|
363
|
+
readonly IS_MOBILE: "is_mobile";
|
|
364
|
+
readonly IS_TABLET: "is_tablet";
|
|
365
|
+
};
|
|
366
|
+
export type GenericTextKeyValueMatchRulesTypes = 'generic_text_key_value';
|
|
367
|
+
export declare const GenericTextKeyValueMatchRulesTypes: {
|
|
368
|
+
readonly GENERIC_TEXT_KEY_VALUE: "generic_text_key_value";
|
|
369
|
+
};
|
|
370
|
+
export type GenericNumericKeyValueMatchRulesTypes = 'generic_numeric_key_value';
|
|
371
|
+
export declare const GenericNumericKeyValueMatchRulesTypes: {
|
|
372
|
+
readonly GENERIC_NUMERIC_KEY_VALUE: "generic_numeric_key_value";
|
|
373
|
+
};
|
|
374
|
+
export type GenericBoolKeyValueMatchRulesTypes = 'generic_bool_key_value';
|
|
375
|
+
export declare const GenericBoolKeyValueMatchRulesTypes: {
|
|
376
|
+
readonly GENERIC_BOOL_KEY_VALUE: "generic_bool_key_value";
|
|
377
|
+
};
|
|
378
|
+
export type JsConditionMatchRulesTypes = 'js_condition';
|
|
379
|
+
export declare const JsConditionMatchRulesTypes: {
|
|
380
|
+
readonly JS_CONDITION: "js_condition";
|
|
381
|
+
};
|
|
382
|
+
export type KeyValueMatchRulesTypes = GenericTextKeyValueMatchRulesTypes & GenericNumericKeyValueMatchRulesTypes & GenericBoolKeyValueMatchRulesTypes;
|
|
383
|
+
export type CookieMatchRulesTypes = 'cookie';
|
|
384
|
+
export declare const CookieMatchRulesTypes: {
|
|
385
|
+
readonly COOKIE: "cookie";
|
|
386
|
+
};
|
|
387
|
+
export type CountryMatchRulesTypes = 'country';
|
|
388
|
+
export declare const CountryMatchRulesTypes: {
|
|
389
|
+
readonly COUNTRY: "country";
|
|
390
|
+
};
|
|
391
|
+
export type VisitorTypeMatchRulesTypes = 'visitor_type';
|
|
392
|
+
export declare const VisitorTypeMatchRulesTypes: {
|
|
393
|
+
readonly VISITOR_TYPE: "visitor_type";
|
|
394
|
+
};
|
|
395
|
+
export type LanguageMatchRulesTypes = 'language';
|
|
396
|
+
export declare const LanguageMatchRulesTypes: {
|
|
397
|
+
readonly LANGUAGE: "language";
|
|
398
|
+
};
|
|
399
|
+
export type GoalTriggeredMatchRulesTypes = 'goal_triggered';
|
|
400
|
+
export declare const GoalTriggeredMatchRulesTypes: {
|
|
401
|
+
readonly GOAL_TRIGGERED: "goal_triggered";
|
|
402
|
+
};
|
|
403
|
+
export type SegmentBucketedMatchRulesTypes = 'bucketed_into_segment';
|
|
404
|
+
export declare const SegmentBucketedMatchRulesTypes: {
|
|
405
|
+
readonly BUCKETED_INTO_SEGMENT: "bucketed_into_segment";
|
|
406
|
+
};
|
|
407
|
+
export type DayOfWeekMatchRulesTypes = 'local_time_day_of_week' | 'project_time_day_of_week';
|
|
408
|
+
export declare const DayOfWeekMatchRulesTypes: {
|
|
409
|
+
readonly LOCAL_TIME_DAY_OF_WEEK: "local_time_day_of_week";
|
|
410
|
+
readonly PROJECT_TIME_DAY_OF_WEEK: "project_time_day_of_week";
|
|
411
|
+
};
|
|
412
|
+
export type HourOfDayMatchRulesTypes = 'local_time_hour_of_day' | 'project_time_hour_of_day';
|
|
413
|
+
export declare const HourOfDayMatchRulesTypes: {
|
|
414
|
+
readonly LOCAL_TIME_HOUR_OF_DAY: "local_time_hour_of_day";
|
|
415
|
+
readonly PROJECT_TIME_HOUR_OF_DAY: "project_time_hour_of_day";
|
|
416
|
+
};
|
|
417
|
+
export type MinuteOfHourMatchRulesTypes = 'local_time_minute_of_hour' | 'project_time_minute_of_hour';
|
|
418
|
+
export declare const MinuteOfHourMatchRulesTypes: {
|
|
419
|
+
readonly LOCAL_TIME_MINUTE_OF_HOUR: "local_time_minute_of_hour";
|
|
420
|
+
readonly PROJECT_TIME_MINUTE_OF_HOUR: "project_time_minute_of_hour";
|
|
421
|
+
};
|
|
422
|
+
export type BrowserNameMatchRulesTypes = 'browser_name';
|
|
423
|
+
export declare const BrowserNameMatchRulesTypes: {
|
|
424
|
+
readonly BROWSER_NAME: "browser_name";
|
|
425
|
+
};
|
|
426
|
+
export type OsMatchRulesTypes = 'os';
|
|
427
|
+
export declare const OsMatchRulesTypes: {
|
|
428
|
+
readonly OS: "os";
|
|
429
|
+
};
|
|
430
|
+
export type WeatherConditionMatchRulesTypes = 'weather_condition';
|
|
431
|
+
export declare const WeatherConditionMatchRulesTypes: {
|
|
432
|
+
readonly WEATHER_CONDITION: "weather_condition";
|
|
433
|
+
};
|
|
434
|
+
export type RulesTypes = TextMatchRulesTypes & NumericMatchRulesTypes & BoolMatchRulesTypes & KeyValueMatchRulesTypes & CookieMatchRulesTypes & CountryMatchRulesTypes & VisitorTypeMatchRulesTypes & LanguageMatchRulesTypes & GoalTriggeredMatchRulesTypes & SegmentBucketedMatchRulesTypes & DayOfWeekMatchRulesTypes & HourOfDayMatchRulesTypes & MinuteOfHourMatchRulesTypes & BrowserNameMatchRulesTypes & OsMatchRulesTypes & WeatherConditionMatchRulesTypes;
|
|
435
|
+
export type GenericTextMatchRule = BaseRuleWithStringValue & {
|
|
436
|
+
rule_type: TextMatchRulesTypes;
|
|
437
|
+
matching?: (BaseMatch & {
|
|
438
|
+
match_type?: TextMatchingOptions;
|
|
439
|
+
});
|
|
440
|
+
};
|
|
441
|
+
export type GenericNumericMatchRule = BaseRuleWithNumericValue & {
|
|
442
|
+
rule_type: NumericMatchRulesTypes;
|
|
443
|
+
matching?: (BaseMatch & {
|
|
444
|
+
match_type?: NumericMatchingOptions;
|
|
445
|
+
});
|
|
446
|
+
};
|
|
447
|
+
export type GenericBoolMatchRule = BaseRuleWithBooleanValue & {
|
|
448
|
+
rule_type: BoolMatchRulesTypes;
|
|
449
|
+
matching?: (BaseMatch & {
|
|
450
|
+
match_type?: ChoiceMatchingOptions;
|
|
451
|
+
});
|
|
452
|
+
};
|
|
453
|
+
export type GenericSetMatchRule = BaseRuleWithStringValue & {
|
|
454
|
+
rule_type: string;
|
|
455
|
+
matching?: (BaseMatch & {
|
|
456
|
+
match_type?: SetMatchingOptions;
|
|
457
|
+
});
|
|
458
|
+
};
|
|
459
|
+
export type GenericKey = {
|
|
460
|
+
/**
|
|
461
|
+
* The key used to identify the data that would be matched against rule **value**
|
|
462
|
+
*/
|
|
463
|
+
key?: string;
|
|
464
|
+
};
|
|
465
|
+
export type GenericTextKeyValueMatchRule = BaseRuleWithStringValue & {
|
|
466
|
+
rule_type: GenericTextKeyValueMatchRulesTypes;
|
|
467
|
+
matching?: (BaseMatch & {
|
|
468
|
+
match_type?: TextMatchingOptions;
|
|
469
|
+
});
|
|
470
|
+
} & GenericKey;
|
|
471
|
+
export type GenericNumericKeyValueMatchRule = BaseRuleWithNumericValue & {
|
|
472
|
+
rule_type: GenericNumericKeyValueMatchRulesTypes;
|
|
473
|
+
matching?: (BaseMatch & {
|
|
474
|
+
match_type?: NumericMatchingOptions;
|
|
475
|
+
});
|
|
476
|
+
} & GenericKey;
|
|
477
|
+
export type GenericBoolKeyValueMatchRule = BaseRuleWithBooleanValue & {
|
|
478
|
+
rule_type: GenericBoolKeyValueMatchRulesTypes;
|
|
479
|
+
matching?: (BaseMatch & {
|
|
480
|
+
match_type?: ChoiceMatchingOptions;
|
|
481
|
+
});
|
|
482
|
+
} & GenericKey;
|
|
483
|
+
export type CookieMatchRule = BaseRuleWithStringValue & {
|
|
484
|
+
rule_type: CookieMatchRulesTypes;
|
|
485
|
+
matching?: (BaseMatch & {
|
|
486
|
+
match_type?: TextMatchingOptions;
|
|
487
|
+
});
|
|
488
|
+
/**
|
|
489
|
+
* The name of the cookie which value is compared to the given rule value
|
|
490
|
+
*/
|
|
491
|
+
key?: string;
|
|
492
|
+
};
|
|
493
|
+
export type CountryMatchRule = BaseRuleWithCountryCodeValue & {
|
|
494
|
+
rule_type: CountryMatchRulesTypes;
|
|
495
|
+
matching?: (BaseMatch & {
|
|
496
|
+
match_type?: ChoiceMatchingOptions;
|
|
497
|
+
});
|
|
498
|
+
};
|
|
499
|
+
export type JsConditionMatchRule = BaseRuleWithJsCodeValue & {
|
|
500
|
+
rule_type: JsConditionMatchRulesTypes;
|
|
501
|
+
matching?: (BaseMatch & {
|
|
502
|
+
match_type?: ChoiceMatchingOptions;
|
|
503
|
+
});
|
|
504
|
+
};
|
|
505
|
+
export type VisitorTypeMatchRule = BaseRuleWithVisitorTypeValue & {
|
|
506
|
+
rule_type: VisitorTypeMatchRulesTypes;
|
|
507
|
+
matching?: (BaseMatch & {
|
|
508
|
+
match_type?: ChoiceMatchingOptions;
|
|
509
|
+
});
|
|
510
|
+
};
|
|
511
|
+
export type LanguageMatchRule = BaseRuleWithLanguageCodeValue & {
|
|
512
|
+
rule_type: LanguageMatchRulesTypes;
|
|
513
|
+
matching?: (BaseMatch & {
|
|
514
|
+
match_type?: ChoiceMatchingOptions;
|
|
515
|
+
});
|
|
516
|
+
};
|
|
517
|
+
export type GoalTriggeredMatchRule = BaseRuleWithGoalTriggeredValue & {
|
|
518
|
+
rule_type: GoalTriggeredMatchRulesTypes;
|
|
519
|
+
matching?: (BaseMatch & {
|
|
520
|
+
match_type?: ChoiceMatchingOptions;
|
|
521
|
+
});
|
|
522
|
+
};
|
|
523
|
+
export type SegmentBucketedMatchRule = BaseRuleWithSegmentBucketedValue & {
|
|
524
|
+
rule_type: SegmentBucketedMatchRulesTypes;
|
|
525
|
+
matching?: (BaseMatch & {
|
|
526
|
+
match_type?: ChoiceMatchingOptions;
|
|
527
|
+
});
|
|
528
|
+
};
|
|
529
|
+
export type ExperienceBucketedMatchRule = BaseRuleWithExperienceBucketedValue & {
|
|
530
|
+
rule_type: string;
|
|
531
|
+
matching?: (BaseMatch & {
|
|
532
|
+
match_type?: ChoiceMatchingOptions;
|
|
533
|
+
});
|
|
534
|
+
};
|
|
535
|
+
export type DayOfWeekMatchRule = BaseRuleWithDayOfWeekValue & {
|
|
536
|
+
rule_type: DayOfWeekMatchRulesTypes;
|
|
537
|
+
matching?: (BaseMatch & {
|
|
538
|
+
match_type?: NumericMatchingOptions;
|
|
539
|
+
});
|
|
540
|
+
};
|
|
541
|
+
export type HourOfDayMatchRule = BaseRuleWithHourOfDayValue & {
|
|
542
|
+
rule_type: HourOfDayMatchRulesTypes;
|
|
543
|
+
matching?: (BaseMatch & {
|
|
544
|
+
match_type?: NumericMatchingOptions;
|
|
545
|
+
});
|
|
546
|
+
};
|
|
547
|
+
export type MinuteOfHourMatchRule = BaseRuleWithMinuteOfHourValue & {
|
|
548
|
+
rule_type: MinuteOfHourMatchRulesTypes;
|
|
549
|
+
matching?: (BaseMatch & {
|
|
550
|
+
match_type?: NumericMatchingOptions;
|
|
551
|
+
});
|
|
552
|
+
};
|
|
553
|
+
export type BrowserNameMatchRule = BaseRuleWithBrowserNameValue & {
|
|
554
|
+
rule_type: BrowserNameMatchRulesTypes;
|
|
555
|
+
matching?: (BaseMatch & {
|
|
556
|
+
match_type?: ChoiceMatchingOptions;
|
|
557
|
+
});
|
|
558
|
+
};
|
|
559
|
+
export type OsMatchRule = BaseRuleWithOsValue & {
|
|
560
|
+
rule_type: OsMatchRulesTypes;
|
|
561
|
+
matching?: (BaseMatch & {
|
|
562
|
+
match_type?: ChoiceMatchingOptions;
|
|
563
|
+
});
|
|
564
|
+
};
|
|
565
|
+
export type WeatherConditionMatchRule = BaseRuleWithWeatherConditionValue & {
|
|
566
|
+
rule_type: WeatherConditionMatchRulesTypes;
|
|
567
|
+
matching?: (BaseMatch & {
|
|
568
|
+
match_type?: TextMatchingOptions;
|
|
569
|
+
});
|
|
570
|
+
};
|
|
571
|
+
export type RuleElementNoUrl = GenericTextMatchRule | GenericNumericMatchRule | GenericBoolMatchRule | CookieMatchRule | GenericTextKeyValueMatchRule | GenericNumericKeyValueMatchRule | GenericBoolKeyValueMatchRule | CountryMatchRule | LanguageMatchRule | GoalTriggeredMatchRule | SegmentBucketedMatchRule | DayOfWeekMatchRule | HourOfDayMatchRule | MinuteOfHourMatchRule | BrowserNameMatchRule | OsMatchRule | WeatherConditionMatchRule | VisitorTypeMatchRule | JsConditionMatchRule;
|
|
572
|
+
export type RuleElement = GenericTextMatchRule | GenericNumericMatchRule | GenericBoolMatchRule | GenericTextKeyValueMatchRule | GenericNumericKeyValueMatchRule | GenericBoolKeyValueMatchRule | CookieMatchRule | CountryMatchRule | LanguageMatchRule | GoalTriggeredMatchRule | SegmentBucketedMatchRule | DayOfWeekMatchRule | HourOfDayMatchRule | MinuteOfHourMatchRule | BrowserNameMatchRule | OsMatchRule | WeatherConditionMatchRule | VisitorTypeMatchRule | JsConditionMatchRule;
|
|
573
|
+
export type TextMatchingOptions = 'matches' | 'regexMatches' | 'contains' | 'endsWith' | 'startsWith';
|
|
574
|
+
export declare const TextMatchingOptions: {
|
|
575
|
+
readonly MATCHES: "matches";
|
|
576
|
+
readonly REGEX_MATCHES: "regexMatches";
|
|
577
|
+
readonly CONTAINS: "contains";
|
|
578
|
+
readonly ENDS_WITH: "endsWith";
|
|
579
|
+
readonly STARTS_WITH: "startsWith";
|
|
580
|
+
};
|
|
581
|
+
export type NumericMatchingOptions = 'equalsNumber' | 'less' | 'lessEqual';
|
|
582
|
+
export declare const NumericMatchingOptions: {
|
|
583
|
+
readonly EQUALS_NUMBER: "equalsNumber";
|
|
584
|
+
readonly LESS: "less";
|
|
585
|
+
readonly LESS_EQUAL: "lessEqual";
|
|
586
|
+
};
|
|
587
|
+
export type ChoiceMatchingOptions = 'equals';
|
|
588
|
+
export declare const ChoiceMatchingOptions: {
|
|
589
|
+
readonly EQUALS: "equals";
|
|
590
|
+
};
|
|
591
|
+
export type ChoiceContainsOptions = 'contains';
|
|
592
|
+
export declare const ChoiceContainsOptions: {
|
|
593
|
+
readonly CONTAINS: "contains";
|
|
594
|
+
};
|
|
595
|
+
export type SetMatchingOptions = 'isIn';
|
|
596
|
+
export declare const SetMatchingOptions: {
|
|
597
|
+
readonly IS_IN: "isIn";
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* This one describes a logical rule that is being used inside the app for triggering goals, matching audiences etc
|
|
601
|
+
*/
|
|
602
|
+
export type RuleObject = {
|
|
603
|
+
/**
|
|
604
|
+
* This describes an outer set of blocks which are evaluated using OR's between them
|
|
605
|
+
*/
|
|
606
|
+
OR?: Array<{
|
|
607
|
+
/**
|
|
608
|
+
* This describes a colections of logical blocks which are evaluated using AND's between them
|
|
609
|
+
*/
|
|
610
|
+
AND?: Array<{
|
|
611
|
+
/**
|
|
612
|
+
* This describes a colections of logical blocks which are evaluated using OR's between them
|
|
613
|
+
*/
|
|
614
|
+
OR_WHEN?: Array<RuleElement>;
|
|
615
|
+
}>;
|
|
616
|
+
}>;
|
|
617
|
+
} | null;
|
|
618
|
+
/**
|
|
619
|
+
* This one describes a logical rule that is being used inside the app for triggering goals, matching audiences etc
|
|
620
|
+
*/
|
|
621
|
+
export type RuleObjectNoUrl = {
|
|
622
|
+
/**
|
|
623
|
+
* This describes an outer set of blocks which are evaluated using OR's between them
|
|
624
|
+
*/
|
|
625
|
+
OR?: Array<{
|
|
626
|
+
/**
|
|
627
|
+
* This describes a colections of logical blocks which are evaluated using AND's between them
|
|
628
|
+
*/
|
|
629
|
+
AND?: Array<{
|
|
630
|
+
/**
|
|
631
|
+
* This describes a colections of logical blocks which are evaluated using OR's between them
|
|
632
|
+
*/
|
|
633
|
+
OR_WHEN?: Array<RuleElementNoUrl>;
|
|
634
|
+
}>;
|
|
635
|
+
}>;
|
|
636
|
+
} | null;
|
|
637
|
+
export type Base64Image = {
|
|
638
|
+
/**
|
|
639
|
+
* Image's content, base64 encoded
|
|
640
|
+
*/
|
|
641
|
+
data?: string;
|
|
642
|
+
};
|
|
643
|
+
export type ErrorData = {
|
|
644
|
+
code?: number;
|
|
645
|
+
message?: string;
|
|
646
|
+
fields?: string;
|
|
647
|
+
};
|
|
648
|
+
export type SuccessData = {
|
|
649
|
+
code?: number;
|
|
650
|
+
message?: string;
|
|
651
|
+
};
|
|
652
|
+
export type ImportProjectDataSuccess = SuccessData & {
|
|
653
|
+
/**
|
|
654
|
+
* List of imported objects
|
|
655
|
+
*/
|
|
656
|
+
imported?: {
|
|
657
|
+
/**
|
|
658
|
+
* List of created experiences. Empty if nothing imported
|
|
659
|
+
*/
|
|
660
|
+
experiences?: Array<(number)>;
|
|
661
|
+
/**
|
|
662
|
+
* List of created audiences. Empty if nothing imported
|
|
663
|
+
*/
|
|
664
|
+
audiences?: Array<(number)>;
|
|
665
|
+
/**
|
|
666
|
+
* List of created locations. Empty if nothing imported
|
|
667
|
+
*/
|
|
668
|
+
locations?: Array<(number)>;
|
|
669
|
+
/**
|
|
670
|
+
* List of created goals. Empty if nothing imported
|
|
671
|
+
*/
|
|
672
|
+
goals?: Array<(number)>;
|
|
673
|
+
/**
|
|
674
|
+
* List of created hypothesis. Empty if nothing imported
|
|
675
|
+
*/
|
|
676
|
+
hypothesis?: Array<(number)>;
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
export type BulkSuccessData = SuccessData & {
|
|
680
|
+
code?: number;
|
|
681
|
+
/**
|
|
682
|
+
* List of unprocessed entities. Would be empty, if all passed entities processed
|
|
683
|
+
*/
|
|
684
|
+
errors?: Array<BulkEntityError>;
|
|
685
|
+
};
|
|
686
|
+
export type BulkEntityError = {
|
|
687
|
+
/**
|
|
688
|
+
* ID of entity which has not been processed
|
|
689
|
+
*/
|
|
690
|
+
id?: number;
|
|
691
|
+
/**
|
|
692
|
+
* A reason explaining why entity has not been processed
|
|
693
|
+
*/
|
|
694
|
+
message?: string;
|
|
695
|
+
};
|
|
696
|
+
/**
|
|
697
|
+
* Offset in seconds, from UTC time, for the give timezone
|
|
698
|
+
*/
|
|
699
|
+
export type UTC_Offset = number;
|
|
700
|
+
export type GA_SettingsBase = {
|
|
701
|
+
/**
|
|
702
|
+
* Flag indicating whether Google Analytics integration is enabled or not.
|
|
703
|
+
*/
|
|
704
|
+
enabled?: boolean;
|
|
705
|
+
};
|
|
706
|
+
export type IntegrationGA3 = {
|
|
707
|
+
type?: 'ga3';
|
|
708
|
+
/**
|
|
709
|
+
* Universal Analytics property to be used for tracking
|
|
710
|
+
*/
|
|
711
|
+
property_UA?: (string) | null;
|
|
712
|
+
};
|
|
713
|
+
export type type = 'ga3';
|
|
714
|
+
export declare const type: {
|
|
715
|
+
readonly GA3: "ga3";
|
|
716
|
+
};
|
|
717
|
+
export type IntegrationGA4Base = {
|
|
718
|
+
type?: 'ga4';
|
|
719
|
+
/**
|
|
720
|
+
* ID of the ga4 property where data will be sent. Used internally for API calls to GoogleAnalytics
|
|
721
|
+
*/
|
|
722
|
+
measurementId?: string;
|
|
723
|
+
};
|
|
724
|
+
export type type2 = 'ga4';
|
|
725
|
+
export declare const type2: {
|
|
726
|
+
readonly GA4: "ga4";
|
|
727
|
+
};
|
|
728
|
+
export type IntegrationGA4 = IntegrationGA4Base & {
|
|
729
|
+
/**
|
|
730
|
+
* ID of the ga4 property where data will be sent. Used internally for API calls to GoogleAnalytics
|
|
731
|
+
*/
|
|
732
|
+
propertyId?: string;
|
|
733
|
+
};
|
|
734
|
+
/**
|
|
735
|
+
* The way the list is processed. `any` means at least one element in the list is matched.
|
|
736
|
+
* `all` means all elements in the list are matched. Default is any.
|
|
737
|
+
*
|
|
738
|
+
*/
|
|
739
|
+
export type GenericListMatchingOptions = 'any' | 'all';
|
|
740
|
+
/**
|
|
741
|
+
* The way the list is processed. `any` means at least one element in the list is matched.
|
|
742
|
+
* `all` means all elements in the list are matched. Default is any.
|
|
743
|
+
*
|
|
744
|
+
*/
|
|
745
|
+
export declare const GenericListMatchingOptions: {
|
|
746
|
+
readonly ANY: "any";
|
|
747
|
+
readonly ALL: "all";
|
|
748
|
+
};
|
|
749
|
+
export type VisitorInsightsBase = {
|
|
750
|
+
/**
|
|
751
|
+
* Flag indicating whether Visitor Insights is enabled or not.
|
|
752
|
+
*/
|
|
753
|
+
enabled?: boolean;
|
|
754
|
+
};
|
|
755
|
+
/**
|
|
756
|
+
* Type of the outlier detection mechanism
|
|
757
|
+
*/
|
|
758
|
+
export type NumericOutlierTypes = 'none' | 'min_max' | 'percentile';
|
|
759
|
+
/**
|
|
760
|
+
* Type of the outlier detection mechanism
|
|
761
|
+
*/
|
|
762
|
+
export declare const NumericOutlierTypes: {
|
|
763
|
+
readonly NONE: "none";
|
|
764
|
+
readonly MIN_MAX: "min_max";
|
|
765
|
+
readonly PERCENTILE: "percentile";
|
|
766
|
+
};
|
|
767
|
+
export type NumericOutlierBase = {
|
|
768
|
+
detection_type: NumericOutlierTypes;
|
|
769
|
+
};
|
|
770
|
+
export type NumericOutlierNone = NumericOutlierBase & {
|
|
771
|
+
detection_type?: 'none';
|
|
772
|
+
};
|
|
773
|
+
export type detection_type = 'none';
|
|
774
|
+
export declare const detection_type: {
|
|
775
|
+
readonly NONE: "none";
|
|
776
|
+
};
|
|
777
|
+
export type NumericOutlierMinMax = NumericOutlierBase & {
|
|
778
|
+
detection_type?: 'min_max';
|
|
779
|
+
/**
|
|
780
|
+
* Minimum value for the outlier detection, under which, the value is considered an outlier
|
|
781
|
+
*/
|
|
782
|
+
min?: number;
|
|
783
|
+
/**
|
|
784
|
+
* Maximum value for the outlier detection, over which, the value is considered an outlier
|
|
785
|
+
*/
|
|
786
|
+
max?: number;
|
|
787
|
+
};
|
|
788
|
+
export type detection_type2 = 'min_max';
|
|
789
|
+
export declare const detection_type2: {
|
|
790
|
+
readonly MIN_MAX: "min_max";
|
|
791
|
+
};
|
|
792
|
+
export type NumericOutlierPercentile = NumericOutlierBase & {
|
|
793
|
+
detection_type?: 'percentile';
|
|
794
|
+
min?: (unknown & Percentiles);
|
|
795
|
+
max?: (unknown & Percentiles);
|
|
796
|
+
};
|
|
797
|
+
export type detection_type3 = 'percentile';
|
|
798
|
+
export declare const detection_type3: {
|
|
799
|
+
readonly PERCENTILE: "percentile";
|
|
800
|
+
};
|
|
801
|
+
export type NumericOutlier = NumericOutlierNone | NumericOutlierMinMax | NumericOutlierPercentile;
|
|
802
|
+
/**
|
|
803
|
+
* List of supported percentiles
|
|
804
|
+
*/
|
|
805
|
+
export type Percentiles = 1 | 5 | 10 | 25 | 50 | 75 | 90 | 95 | 99;
|
|
806
|
+
/**
|
|
807
|
+
* List of supported percentiles
|
|
808
|
+
*/
|
|
809
|
+
export declare const Percentiles: {
|
|
810
|
+
readonly _1: 1;
|
|
811
|
+
readonly _5: 5;
|
|
812
|
+
readonly _10: 10;
|
|
813
|
+
readonly _25: 25;
|
|
814
|
+
readonly _50: 50;
|
|
815
|
+
readonly _75: 75;
|
|
816
|
+
readonly _90: 90;
|
|
817
|
+
readonly _95: 95;
|
|
818
|
+
readonly _99: 99;
|
|
819
|
+
};
|
|
820
|
+
export type TimeRange = {
|
|
821
|
+
/**
|
|
822
|
+
* Unix timestamp when reporting period should start, provided in the given **utc_time_offset**
|
|
823
|
+
*/
|
|
824
|
+
start_time?: (number) | null;
|
|
825
|
+
/**
|
|
826
|
+
* Unix timestamp when reporting period should end, provided in the given **utc_time_offset**
|
|
827
|
+
*/
|
|
828
|
+
end_time?: (number) | null;
|
|
829
|
+
utc_offset?: UTC_Offset;
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* Response containing project's config data needed in order to serve experiences
|
|
833
|
+
*/
|
|
834
|
+
export type ConfigResponseData = {
|
|
835
|
+
/**
|
|
836
|
+
* Account ID under which the project exists
|
|
837
|
+
*/
|
|
838
|
+
account_id?: string;
|
|
839
|
+
project?: ConfigProject;
|
|
840
|
+
/**
|
|
841
|
+
* List of goals to be tracked in the project
|
|
842
|
+
*/
|
|
843
|
+
goals?: Array<ConfigGoal>;
|
|
844
|
+
/**
|
|
845
|
+
* List of locations that are used inside this project
|
|
846
|
+
*/
|
|
847
|
+
locations?: Array<ConfigLocation>;
|
|
848
|
+
/**
|
|
849
|
+
* List of audiences that are used inside this project
|
|
850
|
+
*/
|
|
851
|
+
audiences?: Array<ConfigAudience>;
|
|
852
|
+
/**
|
|
853
|
+
* List of custom that are devined inside this project
|
|
854
|
+
*/
|
|
855
|
+
segments?: Array<ConfigSegment>;
|
|
856
|
+
/**
|
|
857
|
+
* List of active experiences inside this project
|
|
858
|
+
*/
|
|
859
|
+
experiences?: Array<ConfigExperience>;
|
|
860
|
+
/**
|
|
861
|
+
* List of archived experiences inside this project, which were archived within the last 8 months
|
|
862
|
+
*/
|
|
863
|
+
archived_experiences?: Array<(string)>;
|
|
864
|
+
/**
|
|
865
|
+
* List of features inside this project. Presented only for fullstack projects
|
|
866
|
+
*/
|
|
867
|
+
features?: Array<ConfigFeature>;
|
|
868
|
+
/**
|
|
869
|
+
* Flag indicating if the returned config is in debug mode
|
|
870
|
+
*/
|
|
871
|
+
is_debug?: boolean;
|
|
872
|
+
};
|
|
873
|
+
export type ConfigMinimalResponseData = {
|
|
874
|
+
/**
|
|
875
|
+
* Account ID
|
|
876
|
+
*/
|
|
877
|
+
account_id?: string;
|
|
878
|
+
/**
|
|
879
|
+
* Project ID
|
|
880
|
+
*/
|
|
881
|
+
project_id?: string;
|
|
882
|
+
} & ConfigProjectMinimalSettings;
|
|
883
|
+
/**
|
|
884
|
+
* Limited data containing optional properties required for decision-making when assembling and
|
|
885
|
+
* tracking various bundles (e.g., tracking scripts).
|
|
886
|
+
*
|
|
887
|
+
*/
|
|
888
|
+
export type ConfigOptionalResponseData = {
|
|
889
|
+
/**
|
|
890
|
+
* Account ID
|
|
891
|
+
*/
|
|
892
|
+
account_id?: string;
|
|
893
|
+
/**
|
|
894
|
+
* Project ID
|
|
895
|
+
*/
|
|
896
|
+
project_id?: string;
|
|
897
|
+
visitor_insights?: VisitorInsightsData;
|
|
898
|
+
};
|
|
899
|
+
/**
|
|
900
|
+
* Object that represents the change done inside an experience
|
|
901
|
+
*/
|
|
902
|
+
export type ExperienceChangeBase = {
|
|
903
|
+
type?: 'richStructure' | 'customCode' | 'defaultCode' | 'defaultCodeMultipage' | 'defaultRedirect' | 'fullStackFeature';
|
|
904
|
+
/**
|
|
905
|
+
* This contains all data of this change, any code, settings etc
|
|
906
|
+
*
|
|
907
|
+
* This is sent by default in the following requests responses: **getExperienceChange**;
|
|
908
|
+
*
|
|
909
|
+
* All other responses that return this field, will only return it if "include" request parameter contains its name
|
|
910
|
+
*
|
|
911
|
+
* Data object structure will correspond to the "type" field
|
|
912
|
+
*
|
|
913
|
+
*/
|
|
914
|
+
data?: {
|
|
915
|
+
[key: string]: unknown;
|
|
916
|
+
};
|
|
917
|
+
};
|
|
918
|
+
export type type3 = 'richStructure' | 'customCode' | 'defaultCode' | 'defaultCodeMultipage' | 'defaultRedirect' | 'fullStackFeature';
|
|
919
|
+
export declare const type3: {
|
|
920
|
+
readonly RICH_STRUCTURE: "richStructure";
|
|
921
|
+
readonly CUSTOM_CODE: "customCode";
|
|
922
|
+
readonly DEFAULT_CODE: "defaultCode";
|
|
923
|
+
readonly DEFAULT_CODE_MULTIPAGE: "defaultCodeMultipage";
|
|
924
|
+
readonly DEFAULT_REDIRECT: "defaultRedirect";
|
|
925
|
+
readonly FULL_STACK_FEATURE: "fullStackFeature";
|
|
926
|
+
};
|
|
927
|
+
/**
|
|
928
|
+
* Object that represents id of the change done inside an experience
|
|
929
|
+
*/
|
|
930
|
+
export type ExperienceChangeId = {
|
|
931
|
+
/**
|
|
932
|
+
* The ID of the experience change
|
|
933
|
+
*/
|
|
934
|
+
id: number;
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* Object that represents id of the change done inside an experience
|
|
938
|
+
*/
|
|
939
|
+
export type ExperienceChangeIdReadOnly = {
|
|
940
|
+
/**
|
|
941
|
+
* The ID of the experience change
|
|
942
|
+
*/
|
|
943
|
+
readonly id?: number;
|
|
944
|
+
};
|
|
945
|
+
/**
|
|
946
|
+
* Object that represents one change done inside an experience
|
|
947
|
+
*/
|
|
948
|
+
export type ExperienceChange = ExperienceChangeDefaultCodeData | ExperienceChangeDefaultCodeMultipageData | ExperienceChangeDefaultRedirectData | ExperienceChangeCustomCodeData | ExperienceChangeRichStructureData | ExperienceChangeFullStackFeature;
|
|
949
|
+
/**
|
|
950
|
+
* Object that represents one change done inside an experience, used when adding changes
|
|
951
|
+
*/
|
|
952
|
+
export type ExperienceChangeAdd = ExperienceChangeDefaultCodeDataAdd | ExperienceChangeDefaultCodeMultipageDataAdd | ExperienceChangeDefaultRedirectDataAdd | ExperienceChangeCustomCodeDataAdd | ExperienceChangeRichStructureDataAdd | ExperienceChangeFullStackFeatureAdd;
|
|
953
|
+
/**
|
|
954
|
+
* Object that represents one change done inside an experience
|
|
955
|
+
*/
|
|
956
|
+
export type ExperienceChangeUpdate = ExperienceChangeDefaultCodeDataUpdate | ExperienceChangeDefaultCodeMultipageDataUpdate | ExperienceChangeDefaultRedirectDataUpdate | ExperienceChangeRichStructureDataUpdate | ExperienceChangeCustomCodeDataUpdate | ExperienceChangeFullStackFeatureUpdate;
|
|
957
|
+
/**
|
|
958
|
+
* Object that represents one change done inside an experience
|
|
959
|
+
*/
|
|
960
|
+
export type ExperienceChangeUpdateNoId = ExperienceChangeDefaultCodeDataUpdateNoId | ExperienceChangeDefaultCodeMultipageDataUpdateNoId | ExperienceChangeDefaultRedirectDataUpdateNoId | ExperienceChangeRichStructureDataUpdateNoId | ExperienceChangeCustomCodeDataUpdateNoId | ExperienceChangeFullStackFeatureUpdateNoId;
|
|
961
|
+
/**
|
|
962
|
+
* Describes structure for "defaultCode" type of experience change
|
|
963
|
+
*/
|
|
964
|
+
export type ExperienceChangeDefaultCodeDataBase = ExperienceChangeBase & {
|
|
965
|
+
type?: 'defaultCode';
|
|
966
|
+
/**
|
|
967
|
+
* Describes structure for "defaultCode" type of experience change
|
|
968
|
+
*/
|
|
969
|
+
data?: {
|
|
970
|
+
/**
|
|
971
|
+
* CSS code to be applied by this change
|
|
972
|
+
*/
|
|
973
|
+
css?: (string) | null;
|
|
974
|
+
/**
|
|
975
|
+
* Javascript code generated by the visual editor or written in the same structure, to be applied by this experience change
|
|
976
|
+
*/
|
|
977
|
+
js?: (string) | null;
|
|
978
|
+
/**
|
|
979
|
+
* Custom javascript code to be applied by this change
|
|
980
|
+
*/
|
|
981
|
+
custom_js?: (string) | null;
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
export type type4 = 'defaultCode';
|
|
985
|
+
export declare const type4: {
|
|
986
|
+
readonly DEFAULT_CODE: "defaultCode";
|
|
987
|
+
};
|
|
988
|
+
/**
|
|
989
|
+
* Describes structure for "defaultCode" type of experience change
|
|
990
|
+
*/
|
|
991
|
+
export type ExperienceChangeDefaultCodeData = ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeDataBase;
|
|
992
|
+
/**
|
|
993
|
+
* Describes structure for adding a "defaultCode" type of experience change
|
|
994
|
+
*/
|
|
995
|
+
export type ExperienceChangeDefaultCodeDataAdd = ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeDataBase & {
|
|
996
|
+
data: unknown;
|
|
997
|
+
};
|
|
998
|
+
/**
|
|
999
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1000
|
+
*/
|
|
1001
|
+
export type ExperienceChangeDefaultCodeDataUpdateNoId = ExperienceChangeDefaultCodeDataBase & unknown;
|
|
1002
|
+
/**
|
|
1003
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1004
|
+
*/
|
|
1005
|
+
export type ExperienceChangeDefaultCodeDataUpdate = ExperienceChangeId & ExperienceChangeDefaultCodeDataBase & unknown;
|
|
1006
|
+
/**
|
|
1007
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1008
|
+
*/
|
|
1009
|
+
export type ExperienceChangeDefaultRedirectDataBase = ExperienceChangeBase & {
|
|
1010
|
+
type?: 'defaultRedirect';
|
|
1011
|
+
/**
|
|
1012
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1013
|
+
*/
|
|
1014
|
+
data?: {
|
|
1015
|
+
/**
|
|
1016
|
+
* Defines whether the URL matching is case sensitive or not
|
|
1017
|
+
*/
|
|
1018
|
+
case_sensitive?: boolean;
|
|
1019
|
+
/**
|
|
1020
|
+
* Pattern for matching the Original URL in order to construct the redirect URL
|
|
1021
|
+
*/
|
|
1022
|
+
original_pattern?: string;
|
|
1023
|
+
/**
|
|
1024
|
+
* String used to construct the variation redirect URL. This string can contain matches from original_url or it can be a standard URL
|
|
1025
|
+
*/
|
|
1026
|
+
variation_pattern?: string;
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
export type type5 = 'defaultRedirect';
|
|
1030
|
+
export declare const type5: {
|
|
1031
|
+
readonly DEFAULT_REDIRECT: "defaultRedirect";
|
|
1032
|
+
};
|
|
1033
|
+
/**
|
|
1034
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1035
|
+
*/
|
|
1036
|
+
export type ExperienceChangeDefaultRedirectData = ExperienceChangeIdReadOnly & ExperienceChangeDefaultRedirectDataBase;
|
|
1037
|
+
/**
|
|
1038
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1039
|
+
*/
|
|
1040
|
+
export type ExperienceChangeDefaultRedirectDataAdd = ExperienceChangeIdReadOnly & ExperienceChangeDefaultRedirectDataBase & {
|
|
1041
|
+
data: unknown;
|
|
1042
|
+
};
|
|
1043
|
+
/**
|
|
1044
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1045
|
+
*/
|
|
1046
|
+
export type ExperienceChangeDefaultRedirectDataUpdateNoId = ExperienceChangeDefaultRedirectDataBase & unknown;
|
|
1047
|
+
/**
|
|
1048
|
+
* Describes structure for "defaultRedirect" type of experience change
|
|
1049
|
+
*/
|
|
1050
|
+
export type ExperienceChangeDefaultRedirectDataUpdate = ExperienceChangeId & ExperienceChangeDefaultRedirectDataBase & unknown;
|
|
1051
|
+
/**
|
|
1052
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1053
|
+
*/
|
|
1054
|
+
export type ExperienceChangeDefaultCodeMultipageDataBase = ExperienceChangeBase & {
|
|
1055
|
+
type?: 'defaultCodeMultipage';
|
|
1056
|
+
/**
|
|
1057
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1058
|
+
*/
|
|
1059
|
+
data?: {
|
|
1060
|
+
/**
|
|
1061
|
+
* CSS code to be applied by this change
|
|
1062
|
+
*/
|
|
1063
|
+
css?: (string) | null;
|
|
1064
|
+
/**
|
|
1065
|
+
* Javascript code generated by the visual editor or written in the same structure, to be applied by this experience change
|
|
1066
|
+
*/
|
|
1067
|
+
js?: (string) | null;
|
|
1068
|
+
/**
|
|
1069
|
+
* Custom javascript code to be applied by this change
|
|
1070
|
+
*/
|
|
1071
|
+
custom_js?: (string) | null;
|
|
1072
|
+
/**
|
|
1073
|
+
* The **id** of the page connected to this change.
|
|
1074
|
+
*/
|
|
1075
|
+
page_id?: string;
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
export type type6 = 'defaultCodeMultipage';
|
|
1079
|
+
export declare const type6: {
|
|
1080
|
+
readonly DEFAULT_CODE_MULTIPAGE: "defaultCodeMultipage";
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1084
|
+
*/
|
|
1085
|
+
export type ExperienceChangeDefaultCodeMultipageData = ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeMultipageDataBase;
|
|
1086
|
+
/**
|
|
1087
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1088
|
+
*/
|
|
1089
|
+
export type ExperienceChangeDefaultCodeMultipageDataAdd = ExperienceChangeIdReadOnly & ExperienceChangeDefaultCodeMultipageDataBase & {
|
|
1090
|
+
data: unknown;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1094
|
+
*/
|
|
1095
|
+
export type ExperienceChangeDefaultCodeMultipageDataUpdateNoId = ExperienceChangeDefaultCodeMultipageDataBase & unknown;
|
|
1096
|
+
/**
|
|
1097
|
+
* Describes structure for "defaultCodeMultipage" type of experience change
|
|
1098
|
+
*/
|
|
1099
|
+
export type ExperienceChangeDefaultCodeMultipageDataUpdate = ExperienceChangeId & ExperienceChangeDefaultCodeMultipageDataBase & unknown;
|
|
1100
|
+
/**
|
|
1101
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1102
|
+
*/
|
|
1103
|
+
export type ExperienceChangeRichStructureDataBase = ExperienceChangeBase & {
|
|
1104
|
+
type?: 'richStructure';
|
|
1105
|
+
/**
|
|
1106
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1107
|
+
*/
|
|
1108
|
+
data?: {
|
|
1109
|
+
/**
|
|
1110
|
+
* Javascript code generated by the visual editor or written in the same structure, to be applied by this experience change
|
|
1111
|
+
*/
|
|
1112
|
+
js?: (string) | null;
|
|
1113
|
+
/**
|
|
1114
|
+
* CSS selector of the element to which the change refers to, if this is a change concerning one DOM element
|
|
1115
|
+
*/
|
|
1116
|
+
selector?: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* The **id** of the page connected to this change, in case this is a **multi-page** experiment
|
|
1119
|
+
*/
|
|
1120
|
+
page_id?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* Various key - value data
|
|
1123
|
+
*/
|
|
1124
|
+
[key: string]: (string) | undefined;
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
export type type7 = 'richStructure';
|
|
1128
|
+
export declare const type7: {
|
|
1129
|
+
readonly RICH_STRUCTURE: "richStructure";
|
|
1130
|
+
};
|
|
1131
|
+
/**
|
|
1132
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1133
|
+
*/
|
|
1134
|
+
export type ExperienceChangeRichStructureData = ExperienceChangeIdReadOnly & ExperienceChangeRichStructureDataBase;
|
|
1135
|
+
/**
|
|
1136
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1137
|
+
*/
|
|
1138
|
+
export type ExperienceChangeRichStructureDataAdd = ExperienceChangeIdReadOnly & ExperienceChangeRichStructureDataBase & {
|
|
1139
|
+
data: unknown;
|
|
1140
|
+
};
|
|
1141
|
+
/**
|
|
1142
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1143
|
+
*/
|
|
1144
|
+
export type ExperienceChangeRichStructureDataUpdateNoId = ExperienceChangeRichStructureDataBase & unknown;
|
|
1145
|
+
/**
|
|
1146
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1147
|
+
*/
|
|
1148
|
+
export type ExperienceChangeRichStructureDataUpdate = ExperienceChangeId & ExperienceChangeRichStructureDataBase & unknown;
|
|
1149
|
+
/**
|
|
1150
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1151
|
+
*/
|
|
1152
|
+
export type ExperienceChangeCustomCodeDataBase = ExperienceChangeBase & {
|
|
1153
|
+
type?: 'customCode';
|
|
1154
|
+
/**
|
|
1155
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1156
|
+
*/
|
|
1157
|
+
data?: {
|
|
1158
|
+
/**
|
|
1159
|
+
* CSS code to be applied by this change
|
|
1160
|
+
*/
|
|
1161
|
+
css?: (string) | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* Custom javascript code to be applied by this change
|
|
1164
|
+
*/
|
|
1165
|
+
js?: (string) | null;
|
|
1166
|
+
/**
|
|
1167
|
+
* The **id** of the page connected to this change, in case this is a **multi-page** experiment
|
|
1168
|
+
*/
|
|
1169
|
+
page_id?: string;
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
export type type8 = 'customCode';
|
|
1173
|
+
export declare const type8: {
|
|
1174
|
+
readonly CUSTOM_CODE: "customCode";
|
|
1175
|
+
};
|
|
1176
|
+
/**
|
|
1177
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1178
|
+
*/
|
|
1179
|
+
export type ExperienceChangeCustomCodeData = ExperienceChangeIdReadOnly & ExperienceChangeCustomCodeDataBase;
|
|
1180
|
+
/**
|
|
1181
|
+
* Describes structure for "defaultCode" type of experience change
|
|
1182
|
+
*/
|
|
1183
|
+
export type ExperienceChangeCustomCodeDataAdd = ExperienceChangeIdReadOnly & ExperienceChangeCustomCodeDataBase & {
|
|
1184
|
+
data: unknown;
|
|
1185
|
+
};
|
|
1186
|
+
/**
|
|
1187
|
+
* Describes structure for "customCode" type of experience change
|
|
1188
|
+
*/
|
|
1189
|
+
export type ExperienceChangeCustomCodeDataUpdateNoId = ExperienceChangeCustomCodeDataBase & unknown;
|
|
1190
|
+
/**
|
|
1191
|
+
* Describes structure for "customCode" type of experience change
|
|
1192
|
+
*/
|
|
1193
|
+
export type ExperienceChangeCustomCodeDataUpdate = ExperienceChangeId & ExperienceChangeCustomCodeDataBase & unknown;
|
|
1194
|
+
/**
|
|
1195
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1196
|
+
*/
|
|
1197
|
+
export type ExperienceChangeFullStackFeatureBase = ExperienceChangeBase & {
|
|
1198
|
+
type?: 'fullStackFeature';
|
|
1199
|
+
/**
|
|
1200
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1201
|
+
*/
|
|
1202
|
+
data?: {
|
|
1203
|
+
/**
|
|
1204
|
+
* The **id** of the feature connected to this change
|
|
1205
|
+
*/
|
|
1206
|
+
feature_id?: number;
|
|
1207
|
+
/**
|
|
1208
|
+
* A key-value object defined by user which describes the variables values. Where the key is variable name defined in connected feature and value is a variable's value with corresponding type
|
|
1209
|
+
*/
|
|
1210
|
+
variables_data?: {
|
|
1211
|
+
[key: string]: unknown;
|
|
1212
|
+
};
|
|
1213
|
+
};
|
|
1214
|
+
};
|
|
1215
|
+
export type type9 = 'fullStackFeature';
|
|
1216
|
+
export declare const type9: {
|
|
1217
|
+
readonly FULL_STACK_FEATURE: "fullStackFeature";
|
|
1218
|
+
};
|
|
1219
|
+
/**
|
|
1220
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1221
|
+
*/
|
|
1222
|
+
export type ExperienceChangeFullStackFeature = ExperienceChangeIdReadOnly & ExperienceChangeFullStackFeatureBase;
|
|
1223
|
+
/**
|
|
1224
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1225
|
+
*/
|
|
1226
|
+
export type ExperienceChangeFullStackFeatureAdd = ExperienceChangeIdReadOnly & ExperienceChangeFullStackFeatureBase & {
|
|
1227
|
+
data: unknown;
|
|
1228
|
+
};
|
|
1229
|
+
/**
|
|
1230
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1231
|
+
*/
|
|
1232
|
+
export type ExperienceChangeFullStackFeatureUpdate = ExperienceChangeId & ExperienceChangeFullStackFeatureBase & unknown;
|
|
1233
|
+
/**
|
|
1234
|
+
* Describes structure for "fullStackFeature" type of experience change
|
|
1235
|
+
*/
|
|
1236
|
+
export type ExperienceChangeFullStackFeatureUpdateNoId = ExperienceChangeFullStackFeatureBase & unknown;
|
|
1237
|
+
export type UpdateExperienceChangeRequestData = ExperienceChangeAdd;
|
|
1238
|
+
/**
|
|
1239
|
+
* Describes the provider with which Convert integrates to send experience data
|
|
1240
|
+
*/
|
|
1241
|
+
export type IntegrationProvider = 'baidu' | 'clicktale' | 'clicky' | 'cnzz' | 'crazyegg' | 'econda' | 'eulerian' | 'google_analytics' | 'gosquared' | 'heapanalytics' | 'hotjar' | 'mixpanel' | 'mouseflow' | 'piwik' | 'segmentio' | 'sitecatalyst' | 'woopra' | 'ysance';
|
|
1242
|
+
/**
|
|
1243
|
+
* Describes the provider with which Convert integrates to send experience data
|
|
1244
|
+
*/
|
|
1245
|
+
export declare const IntegrationProvider: {
|
|
1246
|
+
readonly BAIDU: "baidu";
|
|
1247
|
+
readonly CLICKTALE: "clicktale";
|
|
1248
|
+
readonly CLICKY: "clicky";
|
|
1249
|
+
readonly CNZZ: "cnzz";
|
|
1250
|
+
readonly CRAZYEGG: "crazyegg";
|
|
1251
|
+
readonly ECONDA: "econda";
|
|
1252
|
+
readonly EULERIAN: "eulerian";
|
|
1253
|
+
readonly GOOGLE_ANALYTICS: "google_analytics";
|
|
1254
|
+
readonly GOSQUARED: "gosquared";
|
|
1255
|
+
readonly HEAPANALYTICS: "heapanalytics";
|
|
1256
|
+
readonly HOTJAR: "hotjar";
|
|
1257
|
+
readonly MIXPANEL: "mixpanel";
|
|
1258
|
+
readonly MOUSEFLOW: "mouseflow";
|
|
1259
|
+
readonly PIWIK: "piwik";
|
|
1260
|
+
readonly SEGMENTIO: "segmentio";
|
|
1261
|
+
readonly SITECATALYST: "sitecatalyst";
|
|
1262
|
+
readonly WOOPRA: "woopra";
|
|
1263
|
+
readonly YSANCE: "ysance";
|
|
1264
|
+
};
|
|
1265
|
+
export type ExperienceIntegrationBase = {
|
|
1266
|
+
provider: IntegrationProvider;
|
|
1267
|
+
/**
|
|
1268
|
+
* Boolean flag indicating whether the integration is enabled or not. When updating experience's integrations,
|
|
1269
|
+
* to disable an integration, this flag needs to be passed as **false**. If not passed, integration is assumed to be **enabled=true**
|
|
1270
|
+
*
|
|
1271
|
+
*/
|
|
1272
|
+
enabled?: (boolean) | null;
|
|
1273
|
+
};
|
|
1274
|
+
export type ExperienceIntegrationBaidu = ExperienceIntegrationBase & {
|
|
1275
|
+
/**
|
|
1276
|
+
* Custom dimension where experience data should be sent to.
|
|
1277
|
+
*/
|
|
1278
|
+
custom_dimension: string;
|
|
1279
|
+
};
|
|
1280
|
+
export type ExperienceIntegrationClicktale = ExperienceIntegrationBase;
|
|
1281
|
+
export type ExperienceIntegrationClicky = ExperienceIntegrationBase;
|
|
1282
|
+
export type ExperienceIntegrationCnzz = ExperienceIntegrationBase & {
|
|
1283
|
+
/**
|
|
1284
|
+
* Custom dimension where experience data should be sent to.
|
|
1285
|
+
*/
|
|
1286
|
+
custom_dimension: string;
|
|
1287
|
+
};
|
|
1288
|
+
/**
|
|
1289
|
+
* Crazyegg integration requires API key and secret which are set at the project level and can be
|
|
1290
|
+
* updated using updateProject operation
|
|
1291
|
+
*
|
|
1292
|
+
* **Important:** Not having API key and secret set for the project, would cause integration to fail
|
|
1293
|
+
*
|
|
1294
|
+
*/
|
|
1295
|
+
export type ExperienceIntegrationCrazyegg = ExperienceIntegrationBase;
|
|
1296
|
+
export type ExperienceIntegrationEconda = ExperienceIntegrationBase;
|
|
1297
|
+
export type ExperienceIntegrationEulerian = ExperienceIntegrationBase;
|
|
1298
|
+
export type ExperienceIntegrationGA3 = GA_SettingsBase & ExperienceIntegrationBase & IntegrationGA3 & {
|
|
1299
|
+
/**
|
|
1300
|
+
* Custom dimension where experience data should be sent to.
|
|
1301
|
+
*/
|
|
1302
|
+
custom_dimension?: string;
|
|
1303
|
+
};
|
|
1304
|
+
export type ExperienceIntegrationGA4Base = GA_SettingsBase & ExperienceIntegrationBase & IntegrationGA4Base;
|
|
1305
|
+
export type ExperienceIntegrationGA4 = ExperienceIntegrationGA4Base & IntegrationGA4 & {
|
|
1306
|
+
/**
|
|
1307
|
+
* List of GA audiences created for each of this experience's variations
|
|
1308
|
+
*/
|
|
1309
|
+
audiences?: {
|
|
1310
|
+
[key: string]: (string);
|
|
1311
|
+
};
|
|
1312
|
+
};
|
|
1313
|
+
export type ExperienceIntegrationGoogleAnalytics = ExperienceIntegrationGA3 | ExperienceIntegrationGA4;
|
|
1314
|
+
export type ExperienceIntegrationGosquared = ExperienceIntegrationBase;
|
|
1315
|
+
export type ExperienceIntegrationHeapanalytics = ExperienceIntegrationBase;
|
|
1316
|
+
export type ExperienceIntegrationHotjar = ExperienceIntegrationBase;
|
|
1317
|
+
export type ExperienceIntegrationMixpanel = ExperienceIntegrationBase;
|
|
1318
|
+
export type ExperienceIntegrationMouseflow = ExperienceIntegrationBase;
|
|
1319
|
+
export type ExperienceIntegrationPiwik = ExperienceIntegrationBase & {
|
|
1320
|
+
/**
|
|
1321
|
+
* Custom dimension where experience data should be sent to.
|
|
1322
|
+
*/
|
|
1323
|
+
custom_dimension: string;
|
|
1324
|
+
};
|
|
1325
|
+
export type ExperienceIntegrationSegmentio = ExperienceIntegrationBase;
|
|
1326
|
+
export type ExperienceIntegrationSitecatalyst = ExperienceIntegrationBase & {
|
|
1327
|
+
/**
|
|
1328
|
+
* Custom dimension where experience data should be sent to.
|
|
1329
|
+
*/
|
|
1330
|
+
evar: string;
|
|
1331
|
+
};
|
|
1332
|
+
export type ExperienceIntegrationWoopra = ExperienceIntegrationBase;
|
|
1333
|
+
export type ExperienceIntegrationYsance = ExperienceIntegrationBase & {
|
|
1334
|
+
/**
|
|
1335
|
+
* Custom dimension where experience data should be sent to.
|
|
1336
|
+
*/
|
|
1337
|
+
custom_dimension: string;
|
|
1338
|
+
};
|
|
1339
|
+
export type ConfigExperience = {
|
|
1340
|
+
/**
|
|
1341
|
+
* Experience ID
|
|
1342
|
+
*/
|
|
1343
|
+
id?: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* Experience Name
|
|
1346
|
+
*/
|
|
1347
|
+
name?: string;
|
|
1348
|
+
/**
|
|
1349
|
+
* Experience readable key that uniquely identifies this experience
|
|
1350
|
+
*/
|
|
1351
|
+
key?: string;
|
|
1352
|
+
/**
|
|
1353
|
+
* List of locations IDs on which this experience is presented. Either this or **site_area** is given but should not be both.
|
|
1354
|
+
*/
|
|
1355
|
+
locations?: Array<(string)> | null;
|
|
1356
|
+
/**
|
|
1357
|
+
* Rules that define where the experience is gonna run. Either this or **locations** is given but should not be both.
|
|
1358
|
+
*/
|
|
1359
|
+
site_area?: ((RuleObject) | null);
|
|
1360
|
+
/**
|
|
1361
|
+
* List of audiences IDs to which this experience is presented to
|
|
1362
|
+
*/
|
|
1363
|
+
audiences?: Array<(string)> | null;
|
|
1364
|
+
/**
|
|
1365
|
+
* List of goals IDs to which will be tracked for this experience
|
|
1366
|
+
*/
|
|
1367
|
+
goals?: Array<(string)>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Only for multipage experience type
|
|
1370
|
+
*/
|
|
1371
|
+
multipage_pages?: Array<MultipageExperiencePage>;
|
|
1372
|
+
status?: ExperienceStatuses;
|
|
1373
|
+
/**
|
|
1374
|
+
* Global Experience's JavaScript that will run for this experience before its changes are applied
|
|
1375
|
+
*
|
|
1376
|
+
*/
|
|
1377
|
+
global_js?: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Global Experience's StyleSheet that will run for this experience before its changes are applied
|
|
1380
|
+
*
|
|
1381
|
+
*/
|
|
1382
|
+
global_css?: string;
|
|
1383
|
+
type?: ExperienceTypes;
|
|
1384
|
+
/**
|
|
1385
|
+
* Experience's version number
|
|
1386
|
+
*/
|
|
1387
|
+
version?: number;
|
|
1388
|
+
/**
|
|
1389
|
+
* Experience's variations list
|
|
1390
|
+
*/
|
|
1391
|
+
variations?: Array<ExperienceVariationConfig>;
|
|
1392
|
+
/**
|
|
1393
|
+
* List of integrations that this experience's data is sent to
|
|
1394
|
+
*/
|
|
1395
|
+
integrations?: Array<(ExperienceIntegrationBaidu | ExperienceIntegrationClicktale | ExperienceIntegrationClicky | ExperienceIntegrationCnzz | ExperienceIntegrationCrazyegg | ExperienceIntegrationEconda | ExperienceIntegrationEulerian | ExperienceIntegrationGAServing | ExperienceIntegrationGosquared | ExperienceIntegrationHeapanalytics | ExperienceIntegrationHotjar | ExperienceIntegrationMixpanel | ExperienceIntegrationMouseflow | ExperienceIntegrationPiwik | ExperienceIntegrationSegmentio | ExperienceIntegrationSitecatalyst | ExperienceIntegrationWoopra | ExperienceIntegrationYsance)>;
|
|
1396
|
+
/**
|
|
1397
|
+
* List of environments that this experience is supposed to run on. The full list of available environments is defined at
|
|
1398
|
+
* project level. If this list is empty, the experience will run on all environments.
|
|
1399
|
+
*
|
|
1400
|
+
* @deprecated
|
|
1401
|
+
*/
|
|
1402
|
+
environments?: Array<(string)>;
|
|
1403
|
+
/**
|
|
1404
|
+
* The environment where this experience will run. It has to be one of the environments defined at the project level
|
|
1405
|
+
*/
|
|
1406
|
+
environment?: string;
|
|
1407
|
+
/**
|
|
1408
|
+
* Various experience's settings
|
|
1409
|
+
*/
|
|
1410
|
+
settings?: {
|
|
1411
|
+
/**
|
|
1412
|
+
* Minimum order value for transactions outliers
|
|
1413
|
+
* @deprecated
|
|
1414
|
+
*/
|
|
1415
|
+
min_order_value?: number;
|
|
1416
|
+
/**
|
|
1417
|
+
* Maximum order value for transactions outliers
|
|
1418
|
+
* @deprecated
|
|
1419
|
+
*/
|
|
1420
|
+
max_order_value?: number;
|
|
1421
|
+
/**
|
|
1422
|
+
* Various settings used by the stats engine to detect outliers
|
|
1423
|
+
*/
|
|
1424
|
+
outliers?: {
|
|
1425
|
+
/**
|
|
1426
|
+
* Order value outlier settings
|
|
1427
|
+
*/
|
|
1428
|
+
order_value?: (NumericOutlier);
|
|
1429
|
+
/**
|
|
1430
|
+
* Products Ordered count outlier settings
|
|
1431
|
+
*/
|
|
1432
|
+
products_ordered_count?: (NumericOutlier);
|
|
1433
|
+
};
|
|
1434
|
+
/**
|
|
1435
|
+
* A couple of settings only applicable to Split URL experiments
|
|
1436
|
+
*/
|
|
1437
|
+
split_url_settings?: {
|
|
1438
|
+
/**
|
|
1439
|
+
* Whether regular expressions are supported in original/variation URLs of a split URL experiment or not.
|
|
1440
|
+
*
|
|
1441
|
+
* It only applies to **experience_type** - **split_url**
|
|
1442
|
+
*
|
|
1443
|
+
*/
|
|
1444
|
+
split_regex_support?: boolean;
|
|
1445
|
+
};
|
|
1446
|
+
/**
|
|
1447
|
+
* Various settings used for matching the list of Audiences and Locations
|
|
1448
|
+
*/
|
|
1449
|
+
matching_options?: {
|
|
1450
|
+
audiences?: GenericListMatchingOptions;
|
|
1451
|
+
locations?: GenericListMatchingOptions;
|
|
1452
|
+
};
|
|
1453
|
+
};
|
|
1454
|
+
};
|
|
1455
|
+
/**
|
|
1456
|
+
* Multipage Experience Page object
|
|
1457
|
+
*/
|
|
1458
|
+
export type MultipageExperiencePage = {
|
|
1459
|
+
/**
|
|
1460
|
+
* The ID of the page.
|
|
1461
|
+
*/
|
|
1462
|
+
id?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* Name of the page
|
|
1465
|
+
*/
|
|
1466
|
+
name?: string;
|
|
1467
|
+
/**
|
|
1468
|
+
* The url of page to load
|
|
1469
|
+
*/
|
|
1470
|
+
url?: string;
|
|
1471
|
+
};
|
|
1472
|
+
/**
|
|
1473
|
+
* Variation Object
|
|
1474
|
+
*/
|
|
1475
|
+
export type ExperienceVariationConfig = {
|
|
1476
|
+
/**
|
|
1477
|
+
* Variation ID
|
|
1478
|
+
*/
|
|
1479
|
+
id?: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* Variation name
|
|
1482
|
+
*/
|
|
1483
|
+
name?: string;
|
|
1484
|
+
/**
|
|
1485
|
+
* Variation Key
|
|
1486
|
+
*/
|
|
1487
|
+
key?: string;
|
|
1488
|
+
/**
|
|
1489
|
+
* Percentage of traffic allocation for this variation, as a number from 0 to 10000.
|
|
1490
|
+
* For an experience, the sum of the traffic allocations for all variations cannot be greater than 10000.
|
|
1491
|
+
*
|
|
1492
|
+
*/
|
|
1493
|
+
traffic_allocation?: number;
|
|
1494
|
+
status?: VariationStatuses;
|
|
1495
|
+
/**
|
|
1496
|
+
* List of changes that this variation is exposing.
|
|
1497
|
+
*/
|
|
1498
|
+
changes?: Array<ExperienceChange>;
|
|
1499
|
+
};
|
|
1500
|
+
export type ExperienceStatuses = 'draft' | 'active' | 'paused' | 'completed' | 'scheduled';
|
|
1501
|
+
export declare const ExperienceStatuses: {
|
|
1502
|
+
readonly DRAFT: "draft";
|
|
1503
|
+
readonly ACTIVE: "active";
|
|
1504
|
+
readonly PAUSED: "paused";
|
|
1505
|
+
readonly COMPLETED: "completed";
|
|
1506
|
+
readonly SCHEDULED: "scheduled";
|
|
1507
|
+
};
|
|
1508
|
+
export type ExperienceTypes = 'a/b' | 'a/a' | 'mvt' | 'split_url' | 'multipage' | 'deploy';
|
|
1509
|
+
export declare const ExperienceTypes: {
|
|
1510
|
+
readonly A_B: "a/b";
|
|
1511
|
+
readonly A_A: "a/a";
|
|
1512
|
+
readonly MVT: "mvt";
|
|
1513
|
+
readonly SPLIT_URL: "split_url";
|
|
1514
|
+
readonly MULTIPAGE: "multipage";
|
|
1515
|
+
readonly DEPLOY: "deploy";
|
|
1516
|
+
};
|
|
1517
|
+
/**
|
|
1518
|
+
* Variation status
|
|
1519
|
+
*/
|
|
1520
|
+
export type VariationStatuses = 'stopped' | 'running';
|
|
1521
|
+
/**
|
|
1522
|
+
* Variation status
|
|
1523
|
+
*/
|
|
1524
|
+
export declare const VariationStatuses: {
|
|
1525
|
+
readonly STOPPED: "stopped";
|
|
1526
|
+
readonly RUNNING: "running";
|
|
1527
|
+
};
|
|
1528
|
+
export type ExperienceIntegrationGAServing = ExperienceIntegrationGA3 | ExperienceIntegrationGA4Base;
|
|
1529
|
+
/**
|
|
1530
|
+
* Base Feature Object
|
|
1531
|
+
*/
|
|
1532
|
+
export type ConfigFeature = {
|
|
1533
|
+
/**
|
|
1534
|
+
* Feature ID
|
|
1535
|
+
*/
|
|
1536
|
+
id?: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* A name given to the feature to identify it easily
|
|
1539
|
+
*/
|
|
1540
|
+
name?: string;
|
|
1541
|
+
/**
|
|
1542
|
+
* A unique per project level identifier
|
|
1543
|
+
*/
|
|
1544
|
+
key?: string;
|
|
1545
|
+
/**
|
|
1546
|
+
* An array of user-defined variables of a feature.
|
|
1547
|
+
*/
|
|
1548
|
+
variables?: Array<FeatureVariableItemData>;
|
|
1549
|
+
};
|
|
1550
|
+
/**
|
|
1551
|
+
* An object which describes the variable of a feature. Where key is variable name and value is one of the possible types [boolean, float, json, integer, string]
|
|
1552
|
+
*/
|
|
1553
|
+
export type FeatureVariableItemData = {
|
|
1554
|
+
/**
|
|
1555
|
+
* A user-defined variable name
|
|
1556
|
+
*/
|
|
1557
|
+
key?: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* A variable's type
|
|
1560
|
+
*/
|
|
1561
|
+
type?: 'boolean' | 'float' | 'json' | 'integer' | 'string';
|
|
1562
|
+
};
|
|
1563
|
+
/**
|
|
1564
|
+
* A variable's type
|
|
1565
|
+
*/
|
|
1566
|
+
export type type10 = 'boolean' | 'float' | 'json' | 'integer' | 'string';
|
|
1567
|
+
/**
|
|
1568
|
+
* A variable's type
|
|
1569
|
+
*/
|
|
1570
|
+
export declare const type10: {
|
|
1571
|
+
readonly BOOLEAN: "boolean";
|
|
1572
|
+
readonly FLOAT: "float";
|
|
1573
|
+
readonly JSON: "json";
|
|
1574
|
+
readonly INTEGER: "integer";
|
|
1575
|
+
readonly STRING: "string";
|
|
1576
|
+
};
|
|
1577
|
+
/**
|
|
1578
|
+
* Goal item to be tracked inside a project
|
|
1579
|
+
*/
|
|
1580
|
+
export type ConfigGoalBase = {
|
|
1581
|
+
/**
|
|
1582
|
+
* Goal ID
|
|
1583
|
+
*/
|
|
1584
|
+
id?: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* Goal Name.
|
|
1587
|
+
*/
|
|
1588
|
+
name?: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* Goal Key
|
|
1591
|
+
*/
|
|
1592
|
+
key?: string;
|
|
1593
|
+
/**
|
|
1594
|
+
* List of goal types to be returned
|
|
1595
|
+
*/
|
|
1596
|
+
type?: Array<GoalTypes>;
|
|
1597
|
+
rules?: ((RuleObject) | null);
|
|
1598
|
+
};
|
|
1599
|
+
export type ConfigGoal = DomInteractionGoal | ScrollPercentageGoal | RevenueGoal | NoSettingsGoal | GaGoal | SubmitsFormGoal | ClicksLinkGoal | ClicksElementGoal;
|
|
1600
|
+
export type DomInteractionGoal = ConfigGoalBase & {
|
|
1601
|
+
type?: 'dom_interaction';
|
|
1602
|
+
settings?: DomInteractionGoalSettings;
|
|
1603
|
+
};
|
|
1604
|
+
export type type11 = 'dom_interaction';
|
|
1605
|
+
export declare const type11: {
|
|
1606
|
+
readonly DOM_INTERACTION: "dom_interaction";
|
|
1607
|
+
};
|
|
1608
|
+
export type ScrollPercentageGoal = ConfigGoalBase & {
|
|
1609
|
+
type?: 'scroll_percentage';
|
|
1610
|
+
settings?: ScrollPercentageGoalSettings;
|
|
1611
|
+
};
|
|
1612
|
+
export type type12 = 'scroll_percentage';
|
|
1613
|
+
export declare const type12: {
|
|
1614
|
+
readonly SCROLL_PERCENTAGE: "scroll_percentage";
|
|
1615
|
+
};
|
|
1616
|
+
export type RevenueGoal = ConfigGoalBase & {
|
|
1617
|
+
type?: 'revenue';
|
|
1618
|
+
settings?: RevenueGoalSettings;
|
|
1619
|
+
};
|
|
1620
|
+
export type type13 = 'revenue';
|
|
1621
|
+
export declare const type13: {
|
|
1622
|
+
readonly REVENUE: "revenue";
|
|
1623
|
+
};
|
|
1624
|
+
export type NoSettingsGoal = ConfigGoalBase & {
|
|
1625
|
+
type?: 'advanced' | 'visits_page' | 'code_trigger';
|
|
1626
|
+
};
|
|
1627
|
+
export type type14 = 'advanced' | 'visits_page' | 'code_trigger';
|
|
1628
|
+
export declare const type14: {
|
|
1629
|
+
readonly ADVANCED: "advanced";
|
|
1630
|
+
readonly VISITS_PAGE: "visits_page";
|
|
1631
|
+
readonly CODE_TRIGGER: "code_trigger";
|
|
1632
|
+
};
|
|
1633
|
+
export type GaGoal = ConfigGoalBase & {
|
|
1634
|
+
type?: 'ga_import';
|
|
1635
|
+
settings?: GaGoalSettings;
|
|
1636
|
+
};
|
|
1637
|
+
export type type15 = 'ga_import';
|
|
1638
|
+
export declare const type15: {
|
|
1639
|
+
readonly GA_IMPORT: "ga_import";
|
|
1640
|
+
};
|
|
1641
|
+
export type SubmitsFormGoal = ConfigGoalBase & {
|
|
1642
|
+
type?: 'submits_form';
|
|
1643
|
+
settings?: SubmitsFormGoalSettings;
|
|
1644
|
+
};
|
|
1645
|
+
export type type16 = 'submits_form';
|
|
1646
|
+
export declare const type16: {
|
|
1647
|
+
readonly SUBMITS_FORM: "submits_form";
|
|
1648
|
+
};
|
|
1649
|
+
export type ClicksLinkGoal = ConfigGoalBase & {
|
|
1650
|
+
type?: 'clicks_link';
|
|
1651
|
+
settings?: ClicksLinkGoalSettings;
|
|
1652
|
+
};
|
|
1653
|
+
export type type17 = 'clicks_link';
|
|
1654
|
+
export declare const type17: {
|
|
1655
|
+
readonly CLICKS_LINK: "clicks_link";
|
|
1656
|
+
};
|
|
1657
|
+
export type ClicksElementGoal = ConfigGoalBase & {
|
|
1658
|
+
type?: 'clicks_element';
|
|
1659
|
+
settings?: ClicksElementGoalSettings;
|
|
1660
|
+
};
|
|
1661
|
+
export type type18 = 'clicks_element';
|
|
1662
|
+
export declare const type18: {
|
|
1663
|
+
readonly CLICKS_ELEMENT: "clicks_element";
|
|
1664
|
+
};
|
|
1665
|
+
export type DomInteractionGoalSettings = {
|
|
1666
|
+
/**
|
|
1667
|
+
* Array of Events to be tracked by this goal
|
|
1668
|
+
*/
|
|
1669
|
+
tracked_items: Array<{
|
|
1670
|
+
/**
|
|
1671
|
+
* Css selector that identifies the DOM element(s) on which 'event' is to be monitored in order to fire the goal.
|
|
1672
|
+
*/
|
|
1673
|
+
selector?: string;
|
|
1674
|
+
/**
|
|
1675
|
+
* The event to monitor in order to fire the goal.
|
|
1676
|
+
*/
|
|
1677
|
+
event?: string;
|
|
1678
|
+
}>;
|
|
1679
|
+
};
|
|
1680
|
+
export type ScrollPercentageGoalSettings = {
|
|
1681
|
+
/**
|
|
1682
|
+
* The percentage of scrolling after which the goal will be fired
|
|
1683
|
+
*/
|
|
1684
|
+
percentage: number;
|
|
1685
|
+
};
|
|
1686
|
+
export type GaGoalSettings = {
|
|
1687
|
+
/**
|
|
1688
|
+
* GA4 event name
|
|
1689
|
+
*/
|
|
1690
|
+
ga_event?: string;
|
|
1691
|
+
};
|
|
1692
|
+
export type RevenueGoalSettings = {
|
|
1693
|
+
/**
|
|
1694
|
+
* Type of the revenue goal tracking, one of the below.
|
|
1695
|
+
* * "manual" - goal will be triggered through the given revenue tracking code;
|
|
1696
|
+
* An empty **triggering_rule** has to be provided as that takes priority over manual triggering
|
|
1697
|
+
* * "ga" - Convert will attempt to pick revenue from GA revenue tracking code and attach it to this goal,
|
|
1698
|
+
* when on page where this goal is triggered via "triggering_rule"
|
|
1699
|
+
*
|
|
1700
|
+
*/
|
|
1701
|
+
triggering_type: 'manual' | 'ga';
|
|
1702
|
+
};
|
|
1703
|
+
/**
|
|
1704
|
+
* Type of the revenue goal tracking, one of the below.
|
|
1705
|
+
* * "manual" - goal will be triggered through the given revenue tracking code;
|
|
1706
|
+
* An empty **triggering_rule** has to be provided as that takes priority over manual triggering
|
|
1707
|
+
* * "ga" - Convert will attempt to pick revenue from GA revenue tracking code and attach it to this goal,
|
|
1708
|
+
* when on page where this goal is triggered via "triggering_rule"
|
|
1709
|
+
*
|
|
1710
|
+
*/
|
|
1711
|
+
export type triggering_type = 'manual' | 'ga';
|
|
1712
|
+
/**
|
|
1713
|
+
* Type of the revenue goal tracking, one of the below.
|
|
1714
|
+
* * "manual" - goal will be triggered through the given revenue tracking code;
|
|
1715
|
+
* An empty **triggering_rule** has to be provided as that takes priority over manual triggering
|
|
1716
|
+
* * "ga" - Convert will attempt to pick revenue from GA revenue tracking code and attach it to this goal,
|
|
1717
|
+
* when on page where this goal is triggered via "triggering_rule"
|
|
1718
|
+
*
|
|
1719
|
+
*/
|
|
1720
|
+
export declare const triggering_type: {
|
|
1721
|
+
readonly MANUAL: "manual";
|
|
1722
|
+
readonly GA: "ga";
|
|
1723
|
+
};
|
|
1724
|
+
export type SubmitsFormGoalSettings = {
|
|
1725
|
+
/**
|
|
1726
|
+
* Url representing form's action attribute used to identify forms which will be tracked for submit event.
|
|
1727
|
+
*/
|
|
1728
|
+
action: string;
|
|
1729
|
+
};
|
|
1730
|
+
export type ClicksLinkGoalSettings = {
|
|
1731
|
+
/**
|
|
1732
|
+
* Url representing link's href attribute used to identify links which will be tracked for click event
|
|
1733
|
+
*/
|
|
1734
|
+
href: string;
|
|
1735
|
+
};
|
|
1736
|
+
export type ClicksElementGoalSettings = {
|
|
1737
|
+
/**
|
|
1738
|
+
* Css selector that identifies the DOM element(s) on which will track clicks in order to fire the goal.
|
|
1739
|
+
*/
|
|
1740
|
+
selector: string;
|
|
1741
|
+
};
|
|
1742
|
+
/**
|
|
1743
|
+
* Goals type, one of below.
|
|
1744
|
+
*/
|
|
1745
|
+
export type GoalTypes = 'advanced' | 'dom_interaction' | 'scroll_percentage' | 'code_trigger' | 'revenue';
|
|
1746
|
+
/**
|
|
1747
|
+
* Goals type, one of below.
|
|
1748
|
+
*/
|
|
1749
|
+
export declare const GoalTypes: {
|
|
1750
|
+
readonly ADVANCED: "advanced";
|
|
1751
|
+
readonly DOM_INTERACTION: "dom_interaction";
|
|
1752
|
+
readonly SCROLL_PERCENTAGE: "scroll_percentage";
|
|
1753
|
+
readonly CODE_TRIGGER: "code_trigger";
|
|
1754
|
+
readonly REVENUE: "revenue";
|
|
1755
|
+
};
|
|
1756
|
+
/**
|
|
1757
|
+
* This one describes a logical triggering rule that is being used inside the app
|
|
1758
|
+
*/
|
|
1759
|
+
export type LocationTrigger = LocationTriggerDomElement | LocationTriggerCallback | LocationTriggerManual | LocationTriggerUponRun;
|
|
1760
|
+
/**
|
|
1761
|
+
* Describes possible location trigger types.
|
|
1762
|
+
* Note that `upon_run` is always the case for **fullstack** projects.
|
|
1763
|
+
*
|
|
1764
|
+
*/
|
|
1765
|
+
export type LocationTriggerTypes = 'upon_run' | 'manual' | 'dom_element' | 'callback';
|
|
1766
|
+
/**
|
|
1767
|
+
* Describes possible location trigger types.
|
|
1768
|
+
* Note that `upon_run` is always the case for **fullstack** projects.
|
|
1769
|
+
*
|
|
1770
|
+
*/
|
|
1771
|
+
export declare const LocationTriggerTypes: {
|
|
1772
|
+
readonly UPON_RUN: "upon_run";
|
|
1773
|
+
readonly MANUAL: "manual";
|
|
1774
|
+
readonly DOM_ELEMENT: "dom_element";
|
|
1775
|
+
readonly CALLBACK: "callback";
|
|
1776
|
+
};
|
|
1777
|
+
export type LocationTriggerBase = {
|
|
1778
|
+
type: LocationTriggerTypes;
|
|
1779
|
+
};
|
|
1780
|
+
export type LocationTriggerUponRun = LocationTriggerBase & {
|
|
1781
|
+
type?: 'upon_run';
|
|
1782
|
+
};
|
|
1783
|
+
export type type19 = 'upon_run';
|
|
1784
|
+
export declare const type19: {
|
|
1785
|
+
readonly UPON_RUN: "upon_run";
|
|
1786
|
+
};
|
|
1787
|
+
export type LocationTriggerManual = LocationTriggerBase & {
|
|
1788
|
+
type?: 'manual';
|
|
1789
|
+
};
|
|
1790
|
+
export type type20 = 'manual';
|
|
1791
|
+
export declare const type20: {
|
|
1792
|
+
readonly MANUAL: "manual";
|
|
1793
|
+
};
|
|
1794
|
+
/**
|
|
1795
|
+
* Allowed events for LocationTriggerDomElement
|
|
1796
|
+
*/
|
|
1797
|
+
export type LocationDomTriggerEvents = 'click' | 'hover' | 'in_view' | 'change';
|
|
1798
|
+
/**
|
|
1799
|
+
* Allowed events for LocationTriggerDomElement
|
|
1800
|
+
*/
|
|
1801
|
+
export declare const LocationDomTriggerEvents: {
|
|
1802
|
+
readonly CLICK: "click";
|
|
1803
|
+
readonly HOVER: "hover";
|
|
1804
|
+
readonly IN_VIEW: "in_view";
|
|
1805
|
+
readonly CHANGE: "change";
|
|
1806
|
+
};
|
|
1807
|
+
export type LocationTriggerDomElement = LocationTriggerBase & {
|
|
1808
|
+
type?: 'dom_element';
|
|
1809
|
+
/**
|
|
1810
|
+
* Describes html selector
|
|
1811
|
+
*/
|
|
1812
|
+
selector: string;
|
|
1813
|
+
/**
|
|
1814
|
+
* Events for LocationTriggerDomElement
|
|
1815
|
+
*/
|
|
1816
|
+
events: Array<LocationDomTriggerEvents>;
|
|
1817
|
+
};
|
|
1818
|
+
export type type21 = 'dom_element';
|
|
1819
|
+
export declare const type21: {
|
|
1820
|
+
readonly DOM_ELEMENT: "dom_element";
|
|
1821
|
+
};
|
|
1822
|
+
export type LocationTriggerCallback = LocationTriggerBase & {
|
|
1823
|
+
type?: 'callback';
|
|
1824
|
+
/**
|
|
1825
|
+
* Describes the js callback that will be executed in order to fire the experience.
|
|
1826
|
+
* It is called with two arguments:
|
|
1827
|
+
* - `activate` - a function that should be called when the experience should be activated
|
|
1828
|
+
* - `options` - an object with the following properties:
|
|
1829
|
+
* - `locationId` - id of the location that is being activated
|
|
1830
|
+
* - `isActive` - boolean flag that indicates if the location is active
|
|
1831
|
+
*
|
|
1832
|
+
* Example:
|
|
1833
|
+
* ```
|
|
1834
|
+
* function(activate, options) {
|
|
1835
|
+
* if (options.isActive) {
|
|
1836
|
+
* setTimeout(function() {
|
|
1837
|
+
* * it activates the experiences 1 second after the
|
|
1838
|
+
* location trigger is initialized - at the load of the tracking script*
|
|
1839
|
+
* activate();
|
|
1840
|
+
* }, 1000);
|
|
1841
|
+
* }
|
|
1842
|
+
* }
|
|
1843
|
+
* ```
|
|
1844
|
+
*
|
|
1845
|
+
*/
|
|
1846
|
+
js: string;
|
|
1847
|
+
};
|
|
1848
|
+
export type type22 = 'callback';
|
|
1849
|
+
export declare const type22: {
|
|
1850
|
+
readonly CALLBACK: "callback";
|
|
1851
|
+
};
|
|
1852
|
+
/**
|
|
1853
|
+
* Base Location object
|
|
1854
|
+
*/
|
|
1855
|
+
export type ConfigLocation = {
|
|
1856
|
+
/**
|
|
1857
|
+
* Location ID
|
|
1858
|
+
*/
|
|
1859
|
+
id?: string;
|
|
1860
|
+
/**
|
|
1861
|
+
* Location unique key
|
|
1862
|
+
*/
|
|
1863
|
+
key?: string;
|
|
1864
|
+
/**
|
|
1865
|
+
* Location Name
|
|
1866
|
+
*/
|
|
1867
|
+
name?: string;
|
|
1868
|
+
trigger?: LocationTrigger;
|
|
1869
|
+
rules?: ((RuleObject) | null);
|
|
1870
|
+
};
|
|
1871
|
+
export type ConfigProjectMinimalSettings = {
|
|
1872
|
+
/**
|
|
1873
|
+
* 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
|
|
1874
|
+
*/
|
|
1875
|
+
include_jquery?: boolean;
|
|
1876
|
+
/**
|
|
1877
|
+
* Whether to include jQuery library or not into the v1 javascript tracking file served by Convert and loaded via the tracking snippet.
|
|
1878
|
+
*/
|
|
1879
|
+
include_jquery_v1?: boolean;
|
|
1880
|
+
/**
|
|
1881
|
+
* 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
|
|
1882
|
+
*/
|
|
1883
|
+
disable_spa_functionality?: boolean;
|
|
1884
|
+
/**
|
|
1885
|
+
* Tracks the project's version, updated with each change done inside the project, which would affect the config of that project. The format is [ISO_datetime]-[incremental_number].
|
|
1886
|
+
*
|
|
1887
|
+
*/
|
|
1888
|
+
readonly version?: (string) | null;
|
|
1889
|
+
tracking_script?: TrackingScriptReleaseBase;
|
|
1890
|
+
};
|
|
1891
|
+
/**
|
|
1892
|
+
* Project Object under which experiences would get created
|
|
1893
|
+
*/
|
|
1894
|
+
export type ConfigProject = {
|
|
1895
|
+
/**
|
|
1896
|
+
* Project ID
|
|
1897
|
+
*/
|
|
1898
|
+
id?: string;
|
|
1899
|
+
/**
|
|
1900
|
+
* Project Name. If **settings.data_anonymization** is turned on, the name will be generated from **id** field
|
|
1901
|
+
*/
|
|
1902
|
+
name?: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* Value which describes project product type
|
|
1905
|
+
*/
|
|
1906
|
+
type?: 'fullstack' | 'web';
|
|
1907
|
+
utc_offset?: UTC_Offset;
|
|
1908
|
+
/**
|
|
1909
|
+
* Object representing the custom domain that is used for loading the tracking scripts and
|
|
1910
|
+
* sending tracking requests to Convert servers instead of the standard Convert domain
|
|
1911
|
+
*
|
|
1912
|
+
*/
|
|
1913
|
+
custom_domain?: {
|
|
1914
|
+
/**
|
|
1915
|
+
* Custom domain to be used instead of standard Convert's one
|
|
1916
|
+
*/
|
|
1917
|
+
domain?: string;
|
|
1918
|
+
} | null;
|
|
1919
|
+
/**
|
|
1920
|
+
* List of domains allowed to be tracked under this project
|
|
1921
|
+
*/
|
|
1922
|
+
domains?: Array<{
|
|
1923
|
+
/**
|
|
1924
|
+
* Top level domain, used for setting cookies where applicable
|
|
1925
|
+
*/
|
|
1926
|
+
tld?: string;
|
|
1927
|
+
/**
|
|
1928
|
+
* List of host names under **tld** which are allowed to be tracked under this project
|
|
1929
|
+
*/
|
|
1930
|
+
hosts?: unknown;
|
|
1931
|
+
}>;
|
|
1932
|
+
/**
|
|
1933
|
+
* The global javascript code that will be loaded on all pages where
|
|
1934
|
+
* the tracking script is installed, prior do processing any of
|
|
1935
|
+
* experiences, goals, audiences etc.
|
|
1936
|
+
*
|
|
1937
|
+
*/
|
|
1938
|
+
global_javascript?: (string) | null;
|
|
1939
|
+
settings?: ({
|
|
1940
|
+
/**
|
|
1941
|
+
* Flag indicating whether decoration of outgoing links (appending tracking cookies inside the link URL in order to
|
|
1942
|
+
* make cross domain tracking possible) is done automatically on page
|
|
1943
|
+
*
|
|
1944
|
+
*/
|
|
1945
|
+
allow_crossdomain_tracking?: boolean;
|
|
1946
|
+
/**
|
|
1947
|
+
* Whether or not data is [anonymized](https://convert.zendesk.com/hc/en-us/articles/204506339-Prevent-Experiment-Details-Data-Leak-with-Data-Anonymization).
|
|
1948
|
+
*/
|
|
1949
|
+
data_anonymization?: boolean;
|
|
1950
|
+
/**
|
|
1951
|
+
* Follow the 'Do not track' browser settings for users in the mentioned area of the world.
|
|
1952
|
+
*/
|
|
1953
|
+
do_not_track?: 'OFF' | 'EU ONLY' | 'EEA ONLY' | 'Worldwide';
|
|
1954
|
+
/**
|
|
1955
|
+
* Follow Global Privacy Control (GPC) signals for users in the mentioned area of the world.
|
|
1956
|
+
* - OFF: Do not follow GPC signals.
|
|
1957
|
+
* - EU ONLY: Follow GPC signals for users in the European Union only.
|
|
1958
|
+
* - EEA ONLY: Follow GPC signals for users in the European Economic Area only.
|
|
1959
|
+
* - Worldwide: Follow GPC signals for users worldwide.
|
|
1960
|
+
*
|
|
1961
|
+
*/
|
|
1962
|
+
global_privacy_control?: 'OFF' | 'EU ONLY' | 'EEA ONLY' | 'Worldwide';
|
|
1963
|
+
/**
|
|
1964
|
+
* 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.
|
|
1965
|
+
*/
|
|
1966
|
+
do_not_track_referral?: boolean;
|
|
1967
|
+
/**
|
|
1968
|
+
* This holds project wide settings used by integrations
|
|
1969
|
+
*/
|
|
1970
|
+
integrations?: {
|
|
1971
|
+
google_analytics?: GA_Settings;
|
|
1972
|
+
visitor_insights?: {
|
|
1973
|
+
tracking_id?: VisitorInsightsTrackingId;
|
|
1974
|
+
};
|
|
1975
|
+
kissmetrics?: {
|
|
1976
|
+
/**
|
|
1977
|
+
* Flag indicating whether Kissmetrics integration is enabled or not for this project
|
|
1978
|
+
*/
|
|
1979
|
+
enabled?: boolean;
|
|
1980
|
+
};
|
|
1981
|
+
};
|
|
1982
|
+
/**
|
|
1983
|
+
* Minimum order value for transactions outliers
|
|
1984
|
+
* @deprecated
|
|
1985
|
+
*/
|
|
1986
|
+
min_order_value?: number;
|
|
1987
|
+
/**
|
|
1988
|
+
* Maximum order value for transactions outliers
|
|
1989
|
+
* @deprecated
|
|
1990
|
+
*/
|
|
1991
|
+
max_order_value?: number;
|
|
1992
|
+
/**
|
|
1993
|
+
* Various settings used by the stats engine to detect outliers
|
|
1994
|
+
*/
|
|
1995
|
+
outliers?: {
|
|
1996
|
+
/**
|
|
1997
|
+
* Order value outlier settings
|
|
1998
|
+
*/
|
|
1999
|
+
order_value?: (NumericOutlier);
|
|
2000
|
+
/**
|
|
2001
|
+
* Products Ordered count outlier settings
|
|
2002
|
+
*/
|
|
2003
|
+
products_ordered_count?: (NumericOutlier);
|
|
2004
|
+
};
|
|
2005
|
+
} & ConfigProjectMinimalSettings);
|
|
2006
|
+
/**
|
|
2007
|
+
* A user-defined key-value object which describes environments available for the project. The number of environments a user can add depends on their plan, by default only one environment is allowed.
|
|
2008
|
+
*/
|
|
2009
|
+
environments?: {
|
|
2010
|
+
[key: string]: {
|
|
2011
|
+
/**
|
|
2012
|
+
* The display name of the environment.
|
|
2013
|
+
*/
|
|
2014
|
+
label: string;
|
|
2015
|
+
/**
|
|
2016
|
+
* Specifies whether this environment is set as the default environment for the project.
|
|
2017
|
+
*/
|
|
2018
|
+
is_default: boolean;
|
|
2019
|
+
};
|
|
2020
|
+
};
|
|
2021
|
+
};
|
|
2022
|
+
/**
|
|
2023
|
+
* Value which describes project product type
|
|
2024
|
+
*/
|
|
2025
|
+
export type type23 = 'fullstack' | 'web';
|
|
2026
|
+
/**
|
|
2027
|
+
* Value which describes project product type
|
|
2028
|
+
*/
|
|
2029
|
+
export declare const type23: {
|
|
2030
|
+
readonly FULLSTACK: "fullstack";
|
|
2031
|
+
readonly WEB: "web";
|
|
2032
|
+
};
|
|
2033
|
+
/**
|
|
2034
|
+
* Follow the 'Do not track' browser settings for users in the mentioned area of the world.
|
|
2035
|
+
*/
|
|
2036
|
+
export type do_not_track = 'OFF' | 'EU ONLY' | 'EEA ONLY' | 'Worldwide';
|
|
2037
|
+
/**
|
|
2038
|
+
* Follow the 'Do not track' browser settings for users in the mentioned area of the world.
|
|
2039
|
+
*/
|
|
2040
|
+
export declare const do_not_track: {
|
|
2041
|
+
readonly OFF: "OFF";
|
|
2042
|
+
readonly EU_ONLY: "EU ONLY";
|
|
2043
|
+
readonly EEA_ONLY: "EEA ONLY";
|
|
2044
|
+
readonly WORLDWIDE: "Worldwide";
|
|
2045
|
+
};
|
|
2046
|
+
/**
|
|
2047
|
+
* Follow Global Privacy Control (GPC) signals for users in the mentioned area of the world.
|
|
2048
|
+
* - OFF: Do not follow GPC signals.
|
|
2049
|
+
* - EU ONLY: Follow GPC signals for users in the European Union only.
|
|
2050
|
+
* - EEA ONLY: Follow GPC signals for users in the European Economic Area only.
|
|
2051
|
+
* - Worldwide: Follow GPC signals for users worldwide.
|
|
2052
|
+
*
|
|
2053
|
+
*/
|
|
2054
|
+
export type global_privacy_control = 'OFF' | 'EU ONLY' | 'EEA ONLY' | 'Worldwide';
|
|
2055
|
+
/**
|
|
2056
|
+
* Follow Global Privacy Control (GPC) signals for users in the mentioned area of the world.
|
|
2057
|
+
* - OFF: Do not follow GPC signals.
|
|
2058
|
+
* - EU ONLY: Follow GPC signals for users in the European Union only.
|
|
2059
|
+
* - EEA ONLY: Follow GPC signals for users in the European Economic Area only.
|
|
2060
|
+
* - Worldwide: Follow GPC signals for users worldwide.
|
|
2061
|
+
*
|
|
2062
|
+
*/
|
|
2063
|
+
export declare const global_privacy_control: {
|
|
2064
|
+
readonly OFF: "OFF";
|
|
2065
|
+
readonly EU_ONLY: "EU ONLY";
|
|
2066
|
+
readonly EEA_ONLY: "EEA ONLY";
|
|
2067
|
+
readonly WORLDWIDE: "Worldwide";
|
|
2068
|
+
};
|
|
2069
|
+
/**
|
|
2070
|
+
* Settings to identify which tracking script version will be applied to the project.
|
|
2071
|
+
*/
|
|
2072
|
+
export type TrackingScriptReleaseBase = {
|
|
2073
|
+
/**
|
|
2074
|
+
* Current version of the tracking script bundle
|
|
2075
|
+
*/
|
|
2076
|
+
readonly current_version?: string;
|
|
2077
|
+
/**
|
|
2078
|
+
* Latest available version of the tracking script bundle.
|
|
2079
|
+
*/
|
|
2080
|
+
readonly latest_version?: (string) | null;
|
|
2081
|
+
} | null;
|
|
2082
|
+
/**
|
|
2083
|
+
* The tracking ID for Visitor Insights.
|
|
2084
|
+
*/
|
|
2085
|
+
export type VisitorInsightsTrackingId = string;
|
|
2086
|
+
export type VisitorInsightsData = VisitorInsightsBase & {
|
|
2087
|
+
tracking_id?: VisitorInsightsTrackingId;
|
|
2088
|
+
/**
|
|
2089
|
+
* The sampling rate for tracking events.
|
|
2090
|
+
*/
|
|
2091
|
+
sampling_rate?: number;
|
|
2092
|
+
};
|
|
2093
|
+
export type ProjectGASettingsBase = GA_SettingsBase & {
|
|
2094
|
+
/**
|
|
2095
|
+
* Attempt to pull revenue data from Google Analytics Revenue Tracking code.
|
|
2096
|
+
*/
|
|
2097
|
+
auto_revenue_tracking?: boolean;
|
|
2098
|
+
};
|
|
2099
|
+
export type ProjectIntegrationGA3 = ProjectGASettingsBase & IntegrationGA3;
|
|
2100
|
+
export type ProjectIntegrationGA4 = ProjectGASettingsBase & IntegrationGA4Base & {
|
|
2101
|
+
/**
|
|
2102
|
+
* Boolean indicating whether to wait for the page view event to complete before sending other events.
|
|
2103
|
+
*/
|
|
2104
|
+
no_wait_pageview?: boolean;
|
|
2105
|
+
};
|
|
2106
|
+
export type GA_Settings = ProjectIntegrationGA3 | ProjectIntegrationGA4;
|
|
2107
|
+
/**
|
|
2108
|
+
* Base Segment object
|
|
2109
|
+
*/
|
|
2110
|
+
export type ConfigSegment = {
|
|
2111
|
+
/**
|
|
2112
|
+
* Segment ID
|
|
2113
|
+
*/
|
|
2114
|
+
id?: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* Segment unique key
|
|
2117
|
+
*/
|
|
2118
|
+
key?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* Segment Name
|
|
2121
|
+
*/
|
|
2122
|
+
name?: string;
|
|
2123
|
+
rules?: ((RuleObject) | null);
|
|
2124
|
+
};
|
|
2125
|
+
/**
|
|
2126
|
+
* Tracking Request's data
|
|
2127
|
+
*/
|
|
2128
|
+
export type SendTrackingEventsRequestData = {
|
|
2129
|
+
/**
|
|
2130
|
+
* ID of the account under which the project is setup
|
|
2131
|
+
*/
|
|
2132
|
+
accountId?: string;
|
|
2133
|
+
/**
|
|
2134
|
+
* ID of the project under which the tracking occurs
|
|
2135
|
+
*/
|
|
2136
|
+
projectId?: string;
|
|
2137
|
+
/**
|
|
2138
|
+
* Flag to determine whether the data is gonna be enriched before the events are stored for reporting.
|
|
2139
|
+
* For example, in case of a conversion event, if this flag is on and bucketing is not provided, the bucketing stored on the backend datastore for the given visitor
|
|
2140
|
+
* ID would be used. Same applies for segments.
|
|
2141
|
+
*
|
|
2142
|
+
* *Note*: this flag is only available for some plans
|
|
2143
|
+
*
|
|
2144
|
+
*/
|
|
2145
|
+
enrichData?: boolean;
|
|
2146
|
+
/**
|
|
2147
|
+
* List of visitors tracked. Each visitor can have multiple events.
|
|
2148
|
+
*
|
|
2149
|
+
*/
|
|
2150
|
+
visitors?: Array<{
|
|
2151
|
+
segments?: VisitorSegments;
|
|
2152
|
+
/**
|
|
2153
|
+
* Id of the visitor tracked
|
|
2154
|
+
*/
|
|
2155
|
+
visitorId?: string;
|
|
2156
|
+
/**
|
|
2157
|
+
* List of events fired for the given visitor
|
|
2158
|
+
*/
|
|
2159
|
+
events?: Array<VisitorTrackingEvents>;
|
|
2160
|
+
}>;
|
|
2161
|
+
};
|
|
2162
|
+
/**
|
|
2163
|
+
* Tracking events related to the same user ID
|
|
2164
|
+
*/
|
|
2165
|
+
export type VisitorTrackingEvents = {
|
|
2166
|
+
/**
|
|
2167
|
+
* Type of the event. It can be a bucketing or a conversion event
|
|
2168
|
+
*/
|
|
2169
|
+
eventType?: 'bucketing' | 'conversion';
|
|
2170
|
+
data?: (BucketingEvent | ConversionEvent);
|
|
2171
|
+
};
|
|
2172
|
+
/**
|
|
2173
|
+
* Type of the event. It can be a bucketing or a conversion event
|
|
2174
|
+
*/
|
|
2175
|
+
export type eventType = 'bucketing' | 'conversion';
|
|
2176
|
+
/**
|
|
2177
|
+
* Type of the event. It can be a bucketing or a conversion event
|
|
2178
|
+
*/
|
|
2179
|
+
export declare const eventType: {
|
|
2180
|
+
readonly BUCKETING: "bucketing";
|
|
2181
|
+
readonly CONVERSION: "conversion";
|
|
2182
|
+
};
|
|
2183
|
+
/**
|
|
2184
|
+
* Bucketing event data
|
|
2185
|
+
*/
|
|
2186
|
+
export type BucketingEvent = {
|
|
2187
|
+
/**
|
|
2188
|
+
* Experience ID to which the visitor is bucketed. In case that **enrichData=true** flag is being sent, only unique events are gonna be recorded. Otherwise, it's
|
|
2189
|
+
* up to the client to ensure that duplicates of the same event for the same visitor do not get sent to the tracking endpoint.
|
|
2190
|
+
*
|
|
2191
|
+
*/
|
|
2192
|
+
experienceId: string;
|
|
2193
|
+
/**
|
|
2194
|
+
* Variation ID corresponding to the experience identified by experienceID, that is assigned to the visitor.
|
|
2195
|
+
*/
|
|
2196
|
+
variationId: string;
|
|
2197
|
+
};
|
|
2198
|
+
/**
|
|
2199
|
+
* Conversion event data
|
|
2200
|
+
*/
|
|
2201
|
+
export type ConversionEvent = {
|
|
2202
|
+
/**
|
|
2203
|
+
* Id of the conversion goal to be fired
|
|
2204
|
+
*/
|
|
2205
|
+
goalId: string;
|
|
2206
|
+
/**
|
|
2207
|
+
* Data connected to this conversion, for non binomial metrics, eg revenue
|
|
2208
|
+
*/
|
|
2209
|
+
goalData?: Array<{
|
|
2210
|
+
/**
|
|
2211
|
+
* Key of the metric
|
|
2212
|
+
*/
|
|
2213
|
+
key?: 'amount' | 'productsCount' | 'transactionId' | 'customDimension1' | 'customDimension2' | 'customDimension3' | 'customDimension4' | 'customDimension5';
|
|
2214
|
+
/**
|
|
2215
|
+
* Value of the metric
|
|
2216
|
+
*/
|
|
2217
|
+
value?: (number | string | Array<string>);
|
|
2218
|
+
}>;
|
|
2219
|
+
/**
|
|
2220
|
+
* Bucketing data (experiences that this visitor is currently part of) for the visitor. In case that **enrichData=true** flag is being sent and
|
|
2221
|
+
* 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
|
|
2222
|
+
* **bucketingData**, the **bucketingData** is gonna be merged with the stored data inside the backend data source, the request provided data having the
|
|
2223
|
+
* biggest overwriting bucketing for the same experience which might exist on the backend
|
|
2224
|
+
*
|
|
2225
|
+
*/
|
|
2226
|
+
bucketingData?: {
|
|
2227
|
+
[key: string]: (string);
|
|
2228
|
+
};
|
|
2229
|
+
};
|
|
2230
|
+
/**
|
|
2231
|
+
* Segments under which this visitor is placed. Some defaults keys are accepted and any other free field **key value** could be used
|
|
2232
|
+
* for fullstack projects
|
|
2233
|
+
*
|
|
2234
|
+
*/
|
|
2235
|
+
export type VisitorSegments = {
|
|
2236
|
+
/**
|
|
2237
|
+
* Browser used:
|
|
2238
|
+
* IE - Internet Explorer
|
|
2239
|
+
* CH - Chrome
|
|
2240
|
+
* FF - Firefox
|
|
2241
|
+
* OP - Opera
|
|
2242
|
+
* SF - Safari
|
|
2243
|
+
* OTH - Other
|
|
2244
|
+
*
|
|
2245
|
+
*/
|
|
2246
|
+
browser?: 'IE' | 'CH' | 'FF' | 'OP' | 'SF' | 'OTH';
|
|
2247
|
+
/**
|
|
2248
|
+
* List of device classes that the visitor device falls into
|
|
2249
|
+
*/
|
|
2250
|
+
devices?: Array<('ALLPH' | 'IPH' | 'OTHPH' | 'ALLTAB' | 'IPAD' | 'OTHTAB' | 'DESK' | 'OTHDEV')>;
|
|
2251
|
+
/**
|
|
2252
|
+
* Traffic source
|
|
2253
|
+
*/
|
|
2254
|
+
source?: 'campaign' | 'search' | 'referral' | 'direct';
|
|
2255
|
+
/**
|
|
2256
|
+
* Campaign string
|
|
2257
|
+
*/
|
|
2258
|
+
campaign?: string;
|
|
2259
|
+
/**
|
|
2260
|
+
* Type of the visitor
|
|
2261
|
+
*/
|
|
2262
|
+
visitorType?: 'new' | 'returning';
|
|
2263
|
+
/**
|
|
2264
|
+
* Two ISO country code for visitor's country
|
|
2265
|
+
*/
|
|
2266
|
+
country?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* Custom Segments as defined inside Convert app. This will be the list of segments' IDs
|
|
2269
|
+
*/
|
|
2270
|
+
customSegments?: Array<(string)>;
|
|
2271
|
+
};
|
|
2272
|
+
/**
|
|
2273
|
+
* Browser used:
|
|
2274
|
+
* IE - Internet Explorer
|
|
2275
|
+
* CH - Chrome
|
|
2276
|
+
* FF - Firefox
|
|
2277
|
+
* OP - Opera
|
|
2278
|
+
* SF - Safari
|
|
2279
|
+
* OTH - Other
|
|
2280
|
+
*
|
|
2281
|
+
*/
|
|
2282
|
+
export type browser = 'IE' | 'CH' | 'FF' | 'OP' | 'SF' | 'OTH';
|
|
2283
|
+
/**
|
|
2284
|
+
* Browser used:
|
|
2285
|
+
* IE - Internet Explorer
|
|
2286
|
+
* CH - Chrome
|
|
2287
|
+
* FF - Firefox
|
|
2288
|
+
* OP - Opera
|
|
2289
|
+
* SF - Safari
|
|
2290
|
+
* OTH - Other
|
|
2291
|
+
*
|
|
2292
|
+
*/
|
|
2293
|
+
export declare const browser: {
|
|
2294
|
+
readonly IE: "IE";
|
|
2295
|
+
readonly CH: "CH";
|
|
2296
|
+
readonly FF: "FF";
|
|
2297
|
+
readonly OP: "OP";
|
|
2298
|
+
readonly SF: "SF";
|
|
2299
|
+
readonly OTH: "OTH";
|
|
2300
|
+
};
|
|
2301
|
+
/**
|
|
2302
|
+
* Traffic source
|
|
2303
|
+
*/
|
|
2304
|
+
export type source = 'campaign' | 'search' | 'referral' | 'direct';
|
|
2305
|
+
/**
|
|
2306
|
+
* Traffic source
|
|
2307
|
+
*/
|
|
2308
|
+
export declare const source: {
|
|
2309
|
+
readonly CAMPAIGN: "campaign";
|
|
2310
|
+
readonly SEARCH: "search";
|
|
2311
|
+
readonly REFERRAL: "referral";
|
|
2312
|
+
readonly DIRECT: "direct";
|
|
2313
|
+
};
|
|
2314
|
+
/**
|
|
2315
|
+
* Type of the visitor
|
|
2316
|
+
*/
|
|
2317
|
+
export type visitorType = 'new' | 'returning';
|
|
2318
|
+
/**
|
|
2319
|
+
* Type of the visitor
|
|
2320
|
+
*/
|
|
2321
|
+
export declare const visitorType: {
|
|
2322
|
+
readonly NEW: "new";
|
|
2323
|
+
readonly RETURNING: "returning";
|
|
2324
|
+
};
|
|
2325
|
+
export type GetProjectConfigData = {
|
|
2326
|
+
/**
|
|
2327
|
+
* ID of the account that owns the retrieved/saved data
|
|
2328
|
+
*/
|
|
2329
|
+
accountId: number;
|
|
2330
|
+
/**
|
|
2331
|
+
* Filter experiences based on environment.
|
|
2332
|
+
*/
|
|
2333
|
+
environment?: string;
|
|
2334
|
+
/**
|
|
2335
|
+
* ID of the project to be retrieved
|
|
2336
|
+
*/
|
|
2337
|
+
projectId: number;
|
|
2338
|
+
};
|
|
2339
|
+
export type GetProjectConfigResponse = (ConfigResponseData);
|
|
2340
|
+
export type GetProjectConfigBySdkKeyData = {
|
|
2341
|
+
/**
|
|
2342
|
+
* Filter experiences based on environment.
|
|
2343
|
+
*/
|
|
2344
|
+
environment?: string;
|
|
2345
|
+
/**
|
|
2346
|
+
* The SDK key used to retrieve the project's config
|
|
2347
|
+
*/
|
|
2348
|
+
sdkKey: string;
|
|
2349
|
+
};
|
|
2350
|
+
export type GetProjectConfigBySdkKeyResponse = (ConfigResponseData);
|
|
2351
|
+
export type GetProjectSettingsData = {
|
|
2352
|
+
/**
|
|
2353
|
+
* ID of the account that owns the retrieved/saved data
|
|
2354
|
+
*/
|
|
2355
|
+
accountId: number;
|
|
2356
|
+
/**
|
|
2357
|
+
* ID of the project to be retrieved
|
|
2358
|
+
*/
|
|
2359
|
+
projectId: number;
|
|
2360
|
+
};
|
|
2361
|
+
export type GetProjectSettingsResponse = (ConfigMinimalResponseData);
|
|
2362
|
+
export type GetProjectOptionalSettingsData = {
|
|
2363
|
+
/**
|
|
2364
|
+
* ID of the account that owns the retrieved/saved data
|
|
2365
|
+
*/
|
|
2366
|
+
accountId: number;
|
|
2367
|
+
/**
|
|
2368
|
+
* ID of the project to be retrieved
|
|
2369
|
+
*/
|
|
2370
|
+
projectId: number;
|
|
2371
|
+
};
|
|
2372
|
+
export type GetProjectOptionalSettingsResponse = (ConfigOptionalResponseData);
|
|
2373
|
+
export type SendTrackingEventsSdkKeyData = {
|
|
2374
|
+
/**
|
|
2375
|
+
* A JSON object containing the tracking events sent to the Convert tracking servers.
|
|
2376
|
+
*/
|
|
2377
|
+
requestBody: SendTrackingEventsRequestData;
|
|
2378
|
+
/**
|
|
2379
|
+
* The SDK key used to identify the project where that the data belongs to
|
|
2380
|
+
*/
|
|
2381
|
+
sdkKey: string;
|
|
2382
|
+
};
|
|
2383
|
+
export type SendTrackingEventsSdkKeyResponse = (SuccessData);
|
|
2384
|
+
export type SendTrackingEventsData = {
|
|
2385
|
+
/**
|
|
2386
|
+
* ID of the account that owns the given project
|
|
2387
|
+
*/
|
|
2388
|
+
accountId: number;
|
|
2389
|
+
/**
|
|
2390
|
+
* ID of the project to which the events belong to
|
|
2391
|
+
*/
|
|
2392
|
+
projectId: number;
|
|
2393
|
+
/**
|
|
2394
|
+
* A JSON object containing the tracking events sent to the Convert tracking servers.
|
|
2395
|
+
*/
|
|
2396
|
+
requestBody: SendTrackingEventsRequestData;
|
|
2397
|
+
};
|
|
2398
|
+
export type SendTrackingEventsResponse = (SuccessData);
|
|
2399
|
+
export type $OpenApiTs = {
|
|
2400
|
+
'/config/{account_id}/{project_id}': {
|
|
2401
|
+
get: {
|
|
2402
|
+
req: GetProjectConfigData;
|
|
2403
|
+
res: {
|
|
2404
|
+
/**
|
|
2405
|
+
* Object consumed by SDKs
|
|
2406
|
+
*
|
|
2407
|
+
*/
|
|
2408
|
+
200: ConfigResponseData;
|
|
2409
|
+
/**
|
|
2410
|
+
* A response signaling an error
|
|
2411
|
+
*/
|
|
2412
|
+
default: ErrorData;
|
|
2413
|
+
};
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
'/config/{sdk_key}': {
|
|
2417
|
+
get: {
|
|
2418
|
+
req: GetProjectConfigBySdkKeyData;
|
|
2419
|
+
res: {
|
|
2420
|
+
/**
|
|
2421
|
+
* Object consumed by SDKs
|
|
2422
|
+
*
|
|
2423
|
+
*/
|
|
2424
|
+
200: ConfigResponseData;
|
|
2425
|
+
/**
|
|
2426
|
+
* A response signaling an error
|
|
2427
|
+
*/
|
|
2428
|
+
default: ErrorData;
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
};
|
|
2432
|
+
'/project-settings/{account_id}/{project_id}': {
|
|
2433
|
+
get: {
|
|
2434
|
+
req: GetProjectSettingsData;
|
|
2435
|
+
res: {
|
|
2436
|
+
/**
|
|
2437
|
+
* Object consumed by SDKs
|
|
2438
|
+
*
|
|
2439
|
+
*/
|
|
2440
|
+
200: ConfigMinimalResponseData;
|
|
2441
|
+
/**
|
|
2442
|
+
* A response signaling an error
|
|
2443
|
+
*/
|
|
2444
|
+
default: ErrorData;
|
|
2445
|
+
};
|
|
2446
|
+
};
|
|
2447
|
+
};
|
|
2448
|
+
'/project-optional-settings/{account_id}/{project_id}': {
|
|
2449
|
+
get: {
|
|
2450
|
+
req: GetProjectOptionalSettingsData;
|
|
2451
|
+
res: {
|
|
2452
|
+
/**
|
|
2453
|
+
* Object consumed by SDKs
|
|
2454
|
+
*
|
|
2455
|
+
*/
|
|
2456
|
+
200: ConfigOptionalResponseData;
|
|
2457
|
+
/**
|
|
2458
|
+
* A response signaling an error
|
|
2459
|
+
*/
|
|
2460
|
+
default: ErrorData;
|
|
2461
|
+
};
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
'/track/{sdk_key}': {
|
|
2465
|
+
post: {
|
|
2466
|
+
req: SendTrackingEventsSdkKeyData;
|
|
2467
|
+
res: {
|
|
2468
|
+
/**
|
|
2469
|
+
* A response signaling a generic success
|
|
2470
|
+
*/
|
|
2471
|
+
200: SuccessData;
|
|
2472
|
+
/**
|
|
2473
|
+
* A response signaling an error
|
|
2474
|
+
*/
|
|
2475
|
+
default: ErrorData;
|
|
2476
|
+
};
|
|
2477
|
+
};
|
|
2478
|
+
};
|
|
2479
|
+
'/track/{account_id}/{project_id}': {
|
|
2480
|
+
post: {
|
|
2481
|
+
req: SendTrackingEventsData;
|
|
2482
|
+
res: {
|
|
2483
|
+
/**
|
|
2484
|
+
* A response signaling a generic success
|
|
2485
|
+
*/
|
|
2486
|
+
200: SuccessData;
|
|
2487
|
+
/**
|
|
2488
|
+
* A response signaling an error
|
|
2489
|
+
*/
|
|
2490
|
+
default: ErrorData;
|
|
2491
|
+
};
|
|
2492
|
+
};
|
|
2493
|
+
};
|
|
2494
|
+
};
|