@oursprivacy/server-sdk 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (325) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/LICENSE +201 -0
  3. package/README.md +357 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +176 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +176 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +453 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +449 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +35 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +32 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +137 -0
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +2 -0
  234. package/resource.d.ts.map +1 -0
  235. package/resource.js +6 -0
  236. package/resource.js.map +1 -0
  237. package/resource.mjs +2 -0
  238. package/resource.mjs.map +1 -0
  239. package/resources/index.d.mts +3 -0
  240. package/resources/index.d.mts.map +1 -0
  241. package/resources/index.d.ts +3 -0
  242. package/resources/index.d.ts.map +1 -0
  243. package/resources/index.js +9 -0
  244. package/resources/index.js.map +1 -0
  245. package/resources/index.mjs +4 -0
  246. package/resources/index.mjs.map +1 -0
  247. package/resources/track.d.mts +405 -0
  248. package/resources/track.d.mts.map +1 -0
  249. package/resources/track.d.ts +405 -0
  250. package/resources/track.d.ts.map +1 -0
  251. package/resources/track.js +22 -0
  252. package/resources/track.js.map +1 -0
  253. package/resources/track.mjs +18 -0
  254. package/resources/track.mjs.map +1 -0
  255. package/resources/visitor.d.mts +386 -0
  256. package/resources/visitor.d.mts.map +1 -0
  257. package/resources/visitor.d.ts +386 -0
  258. package/resources/visitor.d.ts.map +1 -0
  259. package/resources/visitor.js +21 -0
  260. package/resources/visitor.js.map +1 -0
  261. package/resources/visitor.mjs +17 -0
  262. package/resources/visitor.mjs.map +1 -0
  263. package/resources.d.mts +2 -0
  264. package/resources.d.mts.map +1 -0
  265. package/resources.d.ts +2 -0
  266. package/resources.d.ts.map +1 -0
  267. package/resources.js +5 -0
  268. package/resources.js.map +1 -0
  269. package/resources.mjs +2 -0
  270. package/resources.mjs.map +1 -0
  271. package/src/api-promise.ts +2 -0
  272. package/src/client.ts +712 -0
  273. package/src/core/README.md +3 -0
  274. package/src/core/api-promise.ts +92 -0
  275. package/src/core/error.ts +130 -0
  276. package/src/core/resource.ts +11 -0
  277. package/src/core/uploads.ts +2 -0
  278. package/src/error.ts +2 -0
  279. package/src/index.ts +22 -0
  280. package/src/internal/README.md +3 -0
  281. package/src/internal/builtin-types.ts +93 -0
  282. package/src/internal/detect-platform.ts +196 -0
  283. package/src/internal/errors.ts +33 -0
  284. package/src/internal/headers.ts +97 -0
  285. package/src/internal/parse.ts +50 -0
  286. package/src/internal/request-options.ts +91 -0
  287. package/src/internal/shim-types.ts +26 -0
  288. package/src/internal/shims.ts +107 -0
  289. package/src/internal/to-file.ts +154 -0
  290. package/src/internal/types.ts +95 -0
  291. package/src/internal/uploads.ts +187 -0
  292. package/src/internal/utils/base64.ts +40 -0
  293. package/src/internal/utils/bytes.ts +32 -0
  294. package/src/internal/utils/env.ts +18 -0
  295. package/src/internal/utils/log.ts +126 -0
  296. package/src/internal/utils/path.ts +88 -0
  297. package/src/internal/utils/sleep.ts +3 -0
  298. package/src/internal/utils/uuid.ts +17 -0
  299. package/src/internal/utils/values.ts +105 -0
  300. package/src/internal/utils.ts +8 -0
  301. package/src/lib/.keep +4 -0
  302. package/src/resource.ts +2 -0
  303. package/src/resources/index.ts +4 -0
  304. package/src/resources/track.ts +533 -0
  305. package/src/resources/visitor.ts +515 -0
  306. package/src/resources.ts +1 -0
  307. package/src/tsconfig.json +11 -0
  308. package/src/uploads.ts +2 -0
  309. package/src/version.ts +1 -0
  310. package/uploads.d.mts +2 -0
  311. package/uploads.d.mts.map +1 -0
  312. package/uploads.d.ts +2 -0
  313. package/uploads.d.ts.map +1 -0
  314. package/uploads.js +6 -0
  315. package/uploads.js.map +1 -0
  316. package/uploads.mjs +2 -0
  317. package/uploads.mjs.map +1 -0
  318. package/version.d.mts +2 -0
  319. package/version.d.mts.map +1 -0
  320. package/version.d.ts +2 -0
  321. package/version.d.ts.map +1 -0
  322. package/version.js +5 -0
  323. package/version.js.map +1 -0
  324. package/version.mjs +2 -0
  325. package/version.mjs.map +1 -0
@@ -0,0 +1,386 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import { APIPromise } from "../core/api-promise.mjs";
3
+ import { RequestOptions } from "../internal/request-options.mjs";
4
+ export declare class Visitor extends APIResource {
5
+ /**
6
+ * Define visitor properties on an existing visitor or create a new visitor. Note:
7
+ * This does not fire an event. If you want to fire an event, use the track method
8
+ * and include properties for the visitor.
9
+ */
10
+ upsert(body: VisitorUpsertParams, options?: RequestOptions): APIPromise<VisitorUpsertResponse>;
11
+ }
12
+ export interface VisitorUpsertResponse {
13
+ success: true;
14
+ }
15
+ export interface VisitorUpsertParams {
16
+ /**
17
+ * The token for your Ours Privacy Source. You can find this in the Ours dashboard.
18
+ */
19
+ token: string;
20
+ /**
21
+ * User properties to associate with this user. The existing user properties will
22
+ * be updated. And all future events will have these properties associated with
23
+ * them.
24
+ */
25
+ userProperties: VisitorUpsertParams.UserProperties;
26
+ /**
27
+ * These properties are used throughout the Ours app to pass known values onto
28
+ * destinations
29
+ */
30
+ defaultProperties?: VisitorUpsertParams.DefaultProperties | null;
31
+ /**
32
+ * The email address of a user. We will associate this event with the user or
33
+ * create a user. Used for lookup if externalId and userId are not included in the
34
+ * request.
35
+ */
36
+ email?: string | null;
37
+ /**
38
+ * The externalId (the ID in your system) of a user. We will associate this event
39
+ * with the user or create a user. If included in the request, email lookup is
40
+ * ignored.
41
+ */
42
+ externalId?: string | null;
43
+ /**
44
+ * The Ours user id stored in local storage and cookies on your web properties. If
45
+ * userId is included in the request, we do not lookup the user by email or
46
+ * externalId.
47
+ */
48
+ userId?: string | null;
49
+ }
50
+ export declare namespace VisitorUpsertParams {
51
+ /**
52
+ * User properties to associate with this user. The existing user properties will
53
+ * be updated. And all future events will have these properties associated with
54
+ * them.
55
+ */
56
+ interface UserProperties {
57
+ ad_id?: string | null;
58
+ adset_id?: string | null;
59
+ campaign_id?: string | null;
60
+ city?: string | null;
61
+ clickid?: string | null;
62
+ clid?: string | null;
63
+ company_name?: string | null;
64
+ consent?: {
65
+ [key: string]: unknown;
66
+ } | null;
67
+ country?: string | null;
68
+ custom_properties?: {
69
+ [key: string]: unknown;
70
+ } | null;
71
+ date_of_birth?: string | null;
72
+ dclid?: string | null;
73
+ email?: string | null;
74
+ epik?: string | null;
75
+ external_id?: string | null;
76
+ fbc?: string | null;
77
+ fbclid?: string | null;
78
+ fbp?: string | null;
79
+ first_name?: string | null;
80
+ gad_source?: string | null;
81
+ gbraid?: string | null;
82
+ gclid?: string | null;
83
+ gender?: string | null;
84
+ /**
85
+ * The IP address of the user
86
+ */
87
+ ip?: string | null;
88
+ is_bot?: unknown;
89
+ job_title?: string | null;
90
+ last_name?: string | null;
91
+ li_fat_id?: string | null;
92
+ msclkid?: string | null;
93
+ ndclid?: string | null;
94
+ phone_number?: unknown;
95
+ qclid?: string | null;
96
+ rdt_cid?: string | null;
97
+ referrer?: string | null;
98
+ sacid?: string | null;
99
+ sccid?: string | null;
100
+ sid?: string | null;
101
+ state?: string | null;
102
+ ttclid?: string | null;
103
+ twclid?: string | null;
104
+ user_agent?: string | null;
105
+ user_agent_full_list?: string | null;
106
+ utm_campaign?: string | null;
107
+ utm_content?: string | null;
108
+ utm_medium?: string | null;
109
+ utm_name?: string | null;
110
+ utm_source?: string | null;
111
+ utm_term?: string | null;
112
+ wbraid?: string | null;
113
+ zip?: unknown;
114
+ }
115
+ /**
116
+ * These properties are used throughout the Ours app to pass known values onto
117
+ * destinations
118
+ */
119
+ interface DefaultProperties {
120
+ /**
121
+ * The active time in milliseconds that the user had this tab active
122
+ */
123
+ activeDuration?: number | null;
124
+ /**
125
+ * The ad id for detected in the session. This is set by the web sdk automatically.
126
+ */
127
+ ad_id?: string | null;
128
+ /**
129
+ * The adset id for detected in the session. This is set by the web sdk
130
+ * automatically.
131
+ */
132
+ adset_id?: string | null;
133
+ /**
134
+ * The language of the browser. Ex: en-US
135
+ */
136
+ browser_language?: string | null;
137
+ /**
138
+ * The name of the browser. Ex: Chrome
139
+ */
140
+ browser_name?: string | null;
141
+ /**
142
+ * The version of the browser. Ex: 114.0
143
+ */
144
+ browser_version?: string | null;
145
+ /**
146
+ * The campaign id for detected in the session. This is set by the web sdk
147
+ * automatically.
148
+ */
149
+ campaign_id?: string | null;
150
+ /**
151
+ * The Click ID. Ex: clickid123
152
+ */
153
+ clickid?: string | null;
154
+ /**
155
+ * The Generic Click ID. Ex: clid123
156
+ */
157
+ clid?: string | null;
158
+ /**
159
+ * The architecture of the CPU. Ex: x64
160
+ */
161
+ cpu_architecture?: string | null;
162
+ /**
163
+ * The full url (including query params) of the current page
164
+ */
165
+ current_url?: string | null;
166
+ /**
167
+ * The DoubleClick Click ID. Ex: dclid123
168
+ */
169
+ dclid?: string | null;
170
+ /**
171
+ * The model of the device. Ex: iPhone 13
172
+ */
173
+ device_model?: string | null;
174
+ /**
175
+ * The type of device the user is using. Ex: mobile
176
+ */
177
+ device_type?: string | null;
178
+ /**
179
+ * The vendor of the device. Ex: Apple
180
+ */
181
+ device_vendor?: string | null;
182
+ /**
183
+ * The time in milliseconds since the page was loaded // script was loaded
184
+ */
185
+ duration?: number | null;
186
+ /**
187
+ * The browsers encoding. Ex: UTF-8
188
+ */
189
+ encoding?: string | null;
190
+ /**
191
+ * The name of the browser engine. Ex: Blink
192
+ */
193
+ engine_name?: string | null;
194
+ /**
195
+ * The version of the browser engine. Ex: 114.0
196
+ */
197
+ engine_version?: string | null;
198
+ /**
199
+ * The Pinterest Click ID. Ex: epik456
200
+ */
201
+ epik?: string | null;
202
+ /**
203
+ * Facebook Click ID with prefix format for Conversions API tracking. Ex:
204
+ * fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890
205
+ */
206
+ fbc?: string | null;
207
+ /**
208
+ * Raw Facebook Click ID query parameter without prefix from ad clicks. Ex:
209
+ * AbCdEfGhIjKlMnOpQrStUvWxYz1234567890
210
+ */
211
+ fbclid?: string | null;
212
+ /**
213
+ * Facebook Browser ID parameter for identifying browsers and attributing events.
214
+ * Ex: fb.1.1554763741205.1098115397
215
+ */
216
+ fbp?: string | null;
217
+ /**
218
+ * Deprecated
219
+ */
220
+ fv?: boolean | null;
221
+ /**
222
+ * The Google Ad Source. Ex: google
223
+ */
224
+ gad_source?: string | null;
225
+ /**
226
+ * The Google Braid ID. Ex: gbraid123
227
+ */
228
+ gbraid?: string | null;
229
+ /**
230
+ * The Google Click ID. Ex: gclid123
231
+ */
232
+ gclid?: string | null;
233
+ /**
234
+ * The host of the current page. Ex: example.com
235
+ */
236
+ host?: string | null;
237
+ /**
238
+ * Whether the user is in an iframe. Ex: true
239
+ */
240
+ iframe?: boolean | null;
241
+ /**
242
+ * The IP address of the user. Ex: 127.0.0.1
243
+ */
244
+ ip?: string | null;
245
+ /**
246
+ * Whether we have detected that the user is a bot. This is set automatically by
247
+ * the Ours server primarily for events tracked through the web SDK.
248
+ */
249
+ is_bot?: unknown;
250
+ /**
251
+ * The LinkedIn Click ID. Ex: li_fat_id123
252
+ */
253
+ li_fat_id?: string | null;
254
+ /**
255
+ * The Microsoft Click ID. Ex: msclkid123
256
+ */
257
+ msclkid?: string | null;
258
+ /**
259
+ * The NextDoor Click ID. Ex: ndclid123
260
+ */
261
+ ndclid?: string | null;
262
+ /**
263
+ * Deprecated
264
+ */
265
+ new_s?: boolean | null;
266
+ /**
267
+ * The name of the operating system. Ex: Windows
268
+ */
269
+ os_name?: string | null;
270
+ /**
271
+ * The version of the operating system. Ex: 10.0
272
+ */
273
+ os_version?: string | null;
274
+ /**
275
+ * A random set of numbers for the page load
276
+ */
277
+ page_hash?: number | null;
278
+ /**
279
+ * The pathname of the current page. Ex: /home
280
+ */
281
+ pathname?: string | null;
282
+ /**
283
+ * The Quora Click ID. Ex: qclid123
284
+ */
285
+ qclid?: string | null;
286
+ /**
287
+ * The Reddit Click ID. Ex: rdt_cid123
288
+ */
289
+ rdt_cid?: string | null;
290
+ /**
291
+ * The time the event was received by an Ours server in ISO format
292
+ */
293
+ received_at?: string | null;
294
+ /**
295
+ * The referrer URL of the current page
296
+ */
297
+ referrer?: string | null;
298
+ /**
299
+ * The StackAdapt Tracking ID. Ex: sacid123
300
+ */
301
+ sacid?: string | null;
302
+ /**
303
+ * The SnapChat Click ID. Ex: sccid123
304
+ */
305
+ sccid?: string | null;
306
+ /**
307
+ * The height of the screen. Ex: 1080
308
+ */
309
+ screen_height?: number | null;
310
+ /**
311
+ * The width of the screen. Ex: 1920
312
+ */
313
+ screen_width?: number | null;
314
+ /**
315
+ * The number of sessions the user has had. Ex: 3
316
+ */
317
+ sessionCount?: number | null;
318
+ /**
319
+ * The session ID as assigned automatically by the web SDK. This is required for
320
+ * session replay
321
+ */
322
+ sid?: string | null;
323
+ sr?: string | null;
324
+ /**
325
+ * The title of the current page
326
+ */
327
+ title?: string | null;
328
+ /**
329
+ * The TikTok Click ID. Ex: ttclid123
330
+ */
331
+ ttclid?: string | null;
332
+ /**
333
+ * The Twitter Click ID. Ex: twclid123
334
+ */
335
+ twclid?: string | null;
336
+ /**
337
+ * User agent as a full list of strings.
338
+ */
339
+ uafvl?: string | null;
340
+ /**
341
+ * The user agent of the browser
342
+ */
343
+ user_agent?: string | null;
344
+ /**
345
+ * The UTM Campaign. The web SDK automatically captures this from the query params.
346
+ */
347
+ utm_campaign?: string | null;
348
+ /**
349
+ * The UTM Content. The web SDK automatically captures this from the query params.
350
+ */
351
+ utm_content?: string | null;
352
+ /**
353
+ * The UTM Medium. The web SDK automatically captures this from the query params.
354
+ */
355
+ utm_medium?: string | null;
356
+ /**
357
+ * The UTM Name. The web SDK automatically captures this from the query params.
358
+ */
359
+ utm_name?: string | null;
360
+ /**
361
+ * The UTM Source. The web SDK automatically captures this from the query params.
362
+ */
363
+ utm_source?: string | null;
364
+ /**
365
+ * The UTM Term. The web SDK automatically captures this from the query params.
366
+ */
367
+ utm_term?: string | null;
368
+ /**
369
+ * The version of the web SDK
370
+ */
371
+ version?: string | null;
372
+ /**
373
+ * The WBRAID Identifier. The web SDK automatically captures this from the query
374
+ * params.
375
+ */
376
+ wbraid?: string | null;
377
+ /**
378
+ * Whether the user is in a webview. Ex: true
379
+ */
380
+ webview?: boolean | null;
381
+ }
382
+ }
383
+ export declare namespace Visitor {
384
+ export { type VisitorUpsertResponse as VisitorUpsertResponse, type VisitorUpsertParams as VisitorUpsertParams, };
385
+ }
386
+ //# sourceMappingURL=visitor.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"visitor.d.mts","sourceRoot":"","sources":["../src/resources/visitor.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAO/F;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,cAAc,EAAE,mBAAmB,CAAC,cAAc,CAAC;IAEnD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEjE;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAE5C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,iBAAiB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEtD,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,GAAG,CAAC,EAAE,OAAO,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,EAAE,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;WAGG;QACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC1B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}