dub 0.41.0 → 0.41.2

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 (130) hide show
  1. package/dist/commonjs/funcs/analyticsRetrieve.d.ts.map +1 -1
  2. package/dist/commonjs/funcs/analyticsRetrieve.js +1 -0
  3. package/dist/commonjs/funcs/analyticsRetrieve.js.map +1 -1
  4. package/dist/commonjs/funcs/eventsList.d.ts.map +1 -1
  5. package/dist/commonjs/funcs/eventsList.js +1 -0
  6. package/dist/commonjs/funcs/eventsList.js.map +1 -1
  7. package/dist/commonjs/lib/config.d.ts +3 -3
  8. package/dist/commonjs/lib/config.js +3 -3
  9. package/dist/commonjs/lib/config.js.map +1 -1
  10. package/dist/commonjs/models/components/clickevent.d.ts +2 -0
  11. package/dist/commonjs/models/components/clickevent.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/clickevent.js +2 -0
  13. package/dist/commonjs/models/components/clickevent.js.map +1 -1
  14. package/dist/commonjs/models/components/leadevent.d.ts +2 -0
  15. package/dist/commonjs/models/components/leadevent.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/leadevent.js +2 -0
  17. package/dist/commonjs/models/components/leadevent.js.map +1 -1
  18. package/dist/commonjs/models/components/saleevent.d.ts +2 -0
  19. package/dist/commonjs/models/components/saleevent.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/saleevent.js +2 -0
  21. package/dist/commonjs/models/components/saleevent.js.map +1 -1
  22. package/dist/commonjs/models/components/webhookevent.d.ts +6 -0
  23. package/dist/commonjs/models/components/webhookevent.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/webhookevent.js +6 -0
  25. package/dist/commonjs/models/components/webhookevent.js.map +1 -1
  26. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts +5 -0
  27. package/dist/commonjs/models/operations/bulkcreatelinks.d.ts.map +1 -1
  28. package/dist/commonjs/models/operations/bulkcreatelinks.js +2 -0
  29. package/dist/commonjs/models/operations/bulkcreatelinks.js.map +1 -1
  30. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts +5 -0
  31. package/dist/commonjs/models/operations/bulkupdatelinks.d.ts.map +1 -1
  32. package/dist/commonjs/models/operations/bulkupdatelinks.js +2 -0
  33. package/dist/commonjs/models/operations/bulkupdatelinks.js.map +1 -1
  34. package/dist/commonjs/models/operations/createlink.d.ts +5 -0
  35. package/dist/commonjs/models/operations/createlink.d.ts.map +1 -1
  36. package/dist/commonjs/models/operations/createlink.js +2 -0
  37. package/dist/commonjs/models/operations/createlink.js.map +1 -1
  38. package/dist/commonjs/models/operations/listevents.d.ts +5 -0
  39. package/dist/commonjs/models/operations/listevents.d.ts.map +1 -1
  40. package/dist/commonjs/models/operations/listevents.js +2 -0
  41. package/dist/commonjs/models/operations/listevents.js.map +1 -1
  42. package/dist/commonjs/models/operations/retrieveanalytics.d.ts +8 -0
  43. package/dist/commonjs/models/operations/retrieveanalytics.d.ts.map +1 -1
  44. package/dist/commonjs/models/operations/retrieveanalytics.js +3 -0
  45. package/dist/commonjs/models/operations/retrieveanalytics.js.map +1 -1
  46. package/dist/commonjs/models/operations/updatelink.d.ts +5 -0
  47. package/dist/commonjs/models/operations/updatelink.d.ts.map +1 -1
  48. package/dist/commonjs/models/operations/updatelink.js +2 -0
  49. package/dist/commonjs/models/operations/updatelink.js.map +1 -1
  50. package/dist/commonjs/models/operations/upsertlink.d.ts +5 -0
  51. package/dist/commonjs/models/operations/upsertlink.d.ts.map +1 -1
  52. package/dist/commonjs/models/operations/upsertlink.js +2 -0
  53. package/dist/commonjs/models/operations/upsertlink.js.map +1 -1
  54. package/dist/esm/funcs/analyticsRetrieve.d.ts.map +1 -1
  55. package/dist/esm/funcs/analyticsRetrieve.js +1 -0
  56. package/dist/esm/funcs/analyticsRetrieve.js.map +1 -1
  57. package/dist/esm/funcs/eventsList.d.ts.map +1 -1
  58. package/dist/esm/funcs/eventsList.js +1 -0
  59. package/dist/esm/funcs/eventsList.js.map +1 -1
  60. package/dist/esm/lib/config.d.ts +3 -3
  61. package/dist/esm/lib/config.js +3 -3
  62. package/dist/esm/lib/config.js.map +1 -1
  63. package/dist/esm/models/components/clickevent.d.ts +2 -0
  64. package/dist/esm/models/components/clickevent.d.ts.map +1 -1
  65. package/dist/esm/models/components/clickevent.js +2 -0
  66. package/dist/esm/models/components/clickevent.js.map +1 -1
  67. package/dist/esm/models/components/leadevent.d.ts +2 -0
  68. package/dist/esm/models/components/leadevent.d.ts.map +1 -1
  69. package/dist/esm/models/components/leadevent.js +2 -0
  70. package/dist/esm/models/components/leadevent.js.map +1 -1
  71. package/dist/esm/models/components/saleevent.d.ts +2 -0
  72. package/dist/esm/models/components/saleevent.d.ts.map +1 -1
  73. package/dist/esm/models/components/saleevent.js +2 -0
  74. package/dist/esm/models/components/saleevent.js.map +1 -1
  75. package/dist/esm/models/components/webhookevent.d.ts +6 -0
  76. package/dist/esm/models/components/webhookevent.d.ts.map +1 -1
  77. package/dist/esm/models/components/webhookevent.js +6 -0
  78. package/dist/esm/models/components/webhookevent.js.map +1 -1
  79. package/dist/esm/models/operations/bulkcreatelinks.d.ts +5 -0
  80. package/dist/esm/models/operations/bulkcreatelinks.d.ts.map +1 -1
  81. package/dist/esm/models/operations/bulkcreatelinks.js +2 -0
  82. package/dist/esm/models/operations/bulkcreatelinks.js.map +1 -1
  83. package/dist/esm/models/operations/bulkupdatelinks.d.ts +5 -0
  84. package/dist/esm/models/operations/bulkupdatelinks.d.ts.map +1 -1
  85. package/dist/esm/models/operations/bulkupdatelinks.js +2 -0
  86. package/dist/esm/models/operations/bulkupdatelinks.js.map +1 -1
  87. package/dist/esm/models/operations/createlink.d.ts +5 -0
  88. package/dist/esm/models/operations/createlink.d.ts.map +1 -1
  89. package/dist/esm/models/operations/createlink.js +2 -0
  90. package/dist/esm/models/operations/createlink.js.map +1 -1
  91. package/dist/esm/models/operations/listevents.d.ts +5 -0
  92. package/dist/esm/models/operations/listevents.d.ts.map +1 -1
  93. package/dist/esm/models/operations/listevents.js +2 -0
  94. package/dist/esm/models/operations/listevents.js.map +1 -1
  95. package/dist/esm/models/operations/retrieveanalytics.d.ts +8 -0
  96. package/dist/esm/models/operations/retrieveanalytics.d.ts.map +1 -1
  97. package/dist/esm/models/operations/retrieveanalytics.js +3 -0
  98. package/dist/esm/models/operations/retrieveanalytics.js.map +1 -1
  99. package/dist/esm/models/operations/updatelink.d.ts +5 -0
  100. package/dist/esm/models/operations/updatelink.d.ts.map +1 -1
  101. package/dist/esm/models/operations/updatelink.js +2 -0
  102. package/dist/esm/models/operations/updatelink.js.map +1 -1
  103. package/dist/esm/models/operations/upsertlink.d.ts +5 -0
  104. package/dist/esm/models/operations/upsertlink.d.ts.map +1 -1
  105. package/dist/esm/models/operations/upsertlink.js +2 -0
  106. package/dist/esm/models/operations/upsertlink.js.map +1 -1
  107. package/docs/sdks/analytics/README.md +3 -3
  108. package/docs/sdks/domains/README.md +10 -10
  109. package/docs/sdks/events/README.md +3 -3
  110. package/docs/sdks/links/README.md +28 -28
  111. package/docs/sdks/metatags/README.md +3 -3
  112. package/docs/sdks/qrcodes/README.md +3 -3
  113. package/docs/sdks/tags/README.md +12 -12
  114. package/docs/sdks/track/README.md +9 -9
  115. package/docs/sdks/workspaces/README.md +6 -6
  116. package/package.json +1 -1
  117. package/src/funcs/analyticsRetrieve.ts +1 -0
  118. package/src/funcs/eventsList.ts +1 -0
  119. package/src/lib/config.ts +3 -3
  120. package/src/models/components/clickevent.ts +4 -0
  121. package/src/models/components/leadevent.ts +4 -0
  122. package/src/models/components/saleevent.ts +4 -0
  123. package/src/models/components/webhookevent.ts +12 -0
  124. package/src/models/operations/bulkcreatelinks.ts +7 -0
  125. package/src/models/operations/bulkupdatelinks.ts +7 -0
  126. package/src/models/operations/createlink.ts +7 -0
  127. package/src/models/operations/listevents.ts +7 -0
  128. package/src/models/operations/retrieveanalytics.ts +8 -0
  129. package/src/models/operations/updatelink.ts +7 -0
  130. package/src/models/operations/upsertlink.ts +7 -0
@@ -88,6 +88,7 @@ export async function eventsList(
88
88
  "page": payload?.page,
89
89
  "qr": payload?.qr,
90
90
  "referer": payload?.referer,
91
+ "refererUrl": payload?.refererUrl,
91
92
  "root": payload?.root,
92
93
  "sortBy": payload?.sortBy,
93
94
  "start": payload?.start,
package/src/lib/config.ts CHANGED
@@ -57,7 +57,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
57
57
  export const SDK_METADATA = {
58
58
  language: "typescript",
59
59
  openapiDocVersion: "0.0.1",
60
- sdkVersion: "0.41.0",
61
- genVersion: "2.421.3",
62
- userAgent: "speakeasy-sdk/typescript 0.41.0 2.421.3 0.0.1 dub",
60
+ sdkVersion: "0.41.2",
61
+ genVersion: "2.422.22",
62
+ userAgent: "speakeasy-sdk/typescript 0.41.2 2.422.22 0.0.1 dub",
63
63
  } as const;
@@ -27,6 +27,7 @@ export type Click = {
27
27
  browser: string;
28
28
  os: string;
29
29
  referer: string;
30
+ refererUrl: string;
30
31
  qr?: boolean | undefined;
31
32
  ip: string;
32
33
  };
@@ -539,6 +540,7 @@ export const Click$inboundSchema: z.ZodType<Click, z.ZodTypeDef, unknown> = z
539
540
  browser: z.string(),
540
541
  os: z.string(),
541
542
  referer: z.string(),
543
+ refererUrl: z.string(),
542
544
  qr: z.boolean().optional(),
543
545
  ip: z.string(),
544
546
  });
@@ -554,6 +556,7 @@ export type Click$Outbound = {
554
556
  browser: string;
555
557
  os: string;
556
558
  referer: string;
559
+ refererUrl: string;
557
560
  qr?: boolean | undefined;
558
561
  ip: string;
559
562
  };
@@ -573,6 +576,7 @@ export const Click$outboundSchema: z.ZodType<
573
576
  browser: z.string(),
574
577
  os: z.string(),
575
578
  referer: z.string(),
579
+ refererUrl: z.string(),
576
580
  qr: z.boolean().optional(),
577
581
  ip: z.string(),
578
582
  });
@@ -27,6 +27,7 @@ export type LeadEventClick = {
27
27
  browser: string;
28
28
  os: string;
29
29
  referer: string;
30
+ refererUrl: string;
30
31
  qr?: boolean | undefined;
31
32
  ip: string;
32
33
  };
@@ -553,6 +554,7 @@ export const LeadEventClick$inboundSchema: z.ZodType<
553
554
  browser: z.string(),
554
555
  os: z.string(),
555
556
  referer: z.string(),
557
+ refererUrl: z.string(),
556
558
  qr: z.boolean().optional(),
557
559
  ip: z.string(),
558
560
  });
@@ -568,6 +570,7 @@ export type LeadEventClick$Outbound = {
568
570
  browser: string;
569
571
  os: string;
570
572
  referer: string;
573
+ refererUrl: string;
571
574
  qr?: boolean | undefined;
572
575
  ip: string;
573
576
  };
@@ -587,6 +590,7 @@ export const LeadEventClick$outboundSchema: z.ZodType<
587
590
  browser: z.string(),
588
591
  os: z.string(),
589
592
  referer: z.string(),
593
+ refererUrl: z.string(),
590
594
  qr: z.boolean().optional(),
591
595
  ip: z.string(),
592
596
  });
@@ -418,6 +418,7 @@ export type SaleEventClick = {
418
418
  browser: string;
419
419
  os: string;
420
420
  referer: string;
421
+ refererUrl: string;
421
422
  qr?: boolean | undefined;
422
423
  ip: string;
423
424
  };
@@ -2059,6 +2060,7 @@ export const SaleEventClick$inboundSchema: z.ZodType<
2059
2060
  browser: z.string(),
2060
2061
  os: z.string(),
2061
2062
  referer: z.string(),
2063
+ refererUrl: z.string(),
2062
2064
  qr: z.boolean().optional(),
2063
2065
  ip: z.string(),
2064
2066
  });
@@ -2074,6 +2076,7 @@ export type SaleEventClick$Outbound = {
2074
2076
  browser: string;
2075
2077
  os: string;
2076
2078
  referer: string;
2079
+ refererUrl: string;
2077
2080
  qr?: boolean | undefined;
2078
2081
  ip: string;
2079
2082
  };
@@ -2093,6 +2096,7 @@ export const SaleEventClick$outboundSchema: z.ZodType<
2093
2096
  browser: z.string(),
2094
2097
  os: z.string(),
2095
2098
  referer: z.string(),
2099
+ refererUrl: z.string(),
2096
2100
  qr: z.boolean().optional(),
2097
2101
  ip: z.string(),
2098
2102
  });
@@ -34,6 +34,7 @@ export type WebhookEvent4Click = {
34
34
  browser: string;
35
35
  os: string;
36
36
  referer: string;
37
+ refererUrl: string;
37
38
  qr?: boolean | undefined;
38
39
  ip: string;
39
40
  };
@@ -473,6 +474,7 @@ export type WebhookEvent3Click = {
473
474
  browser: string;
474
475
  os: string;
475
476
  referer: string;
477
+ refererUrl: string;
476
478
  qr?: boolean | undefined;
477
479
  ip: string;
478
480
  };
@@ -897,6 +899,7 @@ export type WebhookEventClick = {
897
899
  browser: string;
898
900
  os: string;
899
901
  referer: string;
902
+ refererUrl: string;
900
903
  qr?: boolean | undefined;
901
904
  ip: string;
902
905
  };
@@ -1805,6 +1808,7 @@ export const WebhookEvent4Click$inboundSchema: z.ZodType<
1805
1808
  browser: z.string(),
1806
1809
  os: z.string(),
1807
1810
  referer: z.string(),
1811
+ refererUrl: z.string(),
1808
1812
  qr: z.boolean().optional(),
1809
1813
  ip: z.string(),
1810
1814
  });
@@ -1820,6 +1824,7 @@ export type WebhookEvent4Click$Outbound = {
1820
1824
  browser: string;
1821
1825
  os: string;
1822
1826
  referer: string;
1827
+ refererUrl: string;
1823
1828
  qr?: boolean | undefined;
1824
1829
  ip: string;
1825
1830
  };
@@ -1839,6 +1844,7 @@ export const WebhookEvent4Click$outboundSchema: z.ZodType<
1839
1844
  browser: z.string(),
1840
1845
  os: z.string(),
1841
1846
  referer: z.string(),
1847
+ refererUrl: z.string(),
1842
1848
  qr: z.boolean().optional(),
1843
1849
  ip: z.string(),
1844
1850
  });
@@ -3530,6 +3536,7 @@ export const WebhookEvent3Click$inboundSchema: z.ZodType<
3530
3536
  browser: z.string(),
3531
3537
  os: z.string(),
3532
3538
  referer: z.string(),
3539
+ refererUrl: z.string(),
3533
3540
  qr: z.boolean().optional(),
3534
3541
  ip: z.string(),
3535
3542
  });
@@ -3545,6 +3552,7 @@ export type WebhookEvent3Click$Outbound = {
3545
3552
  browser: string;
3546
3553
  os: string;
3547
3554
  referer: string;
3555
+ refererUrl: string;
3548
3556
  qr?: boolean | undefined;
3549
3557
  ip: string;
3550
3558
  };
@@ -3564,6 +3572,7 @@ export const WebhookEvent3Click$outboundSchema: z.ZodType<
3564
3572
  browser: z.string(),
3565
3573
  os: z.string(),
3566
3574
  referer: z.string(),
3575
+ refererUrl: z.string(),
3567
3576
  qr: z.boolean().optional(),
3568
3577
  ip: z.string(),
3569
3578
  });
@@ -5165,6 +5174,7 @@ export const WebhookEventClick$inboundSchema: z.ZodType<
5165
5174
  browser: z.string(),
5166
5175
  os: z.string(),
5167
5176
  referer: z.string(),
5177
+ refererUrl: z.string(),
5168
5178
  qr: z.boolean().optional(),
5169
5179
  ip: z.string(),
5170
5180
  });
@@ -5180,6 +5190,7 @@ export type WebhookEventClick$Outbound = {
5180
5190
  browser: string;
5181
5191
  os: string;
5182
5192
  referer: string;
5193
+ refererUrl: string;
5183
5194
  qr?: boolean | undefined;
5184
5195
  ip: string;
5185
5196
  };
@@ -5199,6 +5210,7 @@ export const WebhookEventClick$outboundSchema: z.ZodType<
5199
5210
  browser: z.string(),
5200
5211
  os: z.string(),
5201
5212
  referer: z.string(),
5213
+ refererUrl: z.string(),
5202
5214
  qr: z.boolean().optional(),
5203
5215
  ip: z.string(),
5204
5216
  });
@@ -139,6 +139,10 @@ export type RequestBody = {
139
139
  * The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
140
140
  */
141
141
  utmContent?: string | null | undefined;
142
+ /**
143
+ * The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
144
+ */
145
+ ref?: string | null | undefined;
142
146
  };
143
147
 
144
148
  /** @internal */
@@ -237,6 +241,7 @@ export const RequestBody$inboundSchema: z.ZodType<
237
241
  utm_campaign: z.nullable(z.string()).optional(),
238
242
  utm_term: z.nullable(z.string()).optional(),
239
243
  utm_content: z.nullable(z.string()).optional(),
244
+ ref: z.nullable(z.string()).optional(),
240
245
  }).transform((v) => {
241
246
  return remap$(v, {
242
247
  "utm_source": "utmSource",
@@ -279,6 +284,7 @@ export type RequestBody$Outbound = {
279
284
  utm_campaign?: string | null | undefined;
280
285
  utm_term?: string | null | undefined;
281
286
  utm_content?: string | null | undefined;
287
+ ref?: string | null | undefined;
282
288
  };
283
289
 
284
290
  /** @internal */
@@ -317,6 +323,7 @@ export const RequestBody$outboundSchema: z.ZodType<
317
323
  utmCampaign: z.nullable(z.string()).optional(),
318
324
  utmTerm: z.nullable(z.string()).optional(),
319
325
  utmContent: z.nullable(z.string()).optional(),
326
+ ref: z.nullable(z.string()).optional(),
320
327
  }).transform((v) => {
321
328
  return remap$(v, {
322
329
  utmSource: "utm_source",
@@ -123,6 +123,10 @@ export type Data = {
123
123
  * The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
124
124
  */
125
125
  utmContent?: string | null | undefined;
126
+ /**
127
+ * The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
128
+ */
129
+ ref?: string | null | undefined;
126
130
  };
127
131
 
128
132
  export type BulkUpdateLinksRequestBody = {
@@ -219,6 +223,7 @@ export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
219
223
  utm_campaign: z.nullable(z.string()).optional(),
220
224
  utm_term: z.nullable(z.string()).optional(),
221
225
  utm_content: z.nullable(z.string()).optional(),
226
+ ref: z.nullable(z.string()).optional(),
222
227
  }).transform((v) => {
223
228
  return remap$(v, {
224
229
  "utm_source": "utmSource",
@@ -257,6 +262,7 @@ export type Data$Outbound = {
257
262
  utm_campaign?: string | null | undefined;
258
263
  utm_term?: string | null | undefined;
259
264
  utm_content?: string | null | undefined;
265
+ ref?: string | null | undefined;
260
266
  };
261
267
 
262
268
  /** @internal */
@@ -288,6 +294,7 @@ export const Data$outboundSchema: z.ZodType<Data$Outbound, z.ZodTypeDef, Data> =
288
294
  utmCampaign: z.nullable(z.string()).optional(),
289
295
  utmTerm: z.nullable(z.string()).optional(),
290
296
  utmContent: z.nullable(z.string()).optional(),
297
+ ref: z.nullable(z.string()).optional(),
291
298
  }).transform((v) => {
292
299
  return remap$(v, {
293
300
  utmSource: "utm_source",
@@ -139,6 +139,10 @@ export type CreateLinkRequestBody = {
139
139
  * The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
140
140
  */
141
141
  utmContent?: string | null | undefined;
142
+ /**
143
+ * The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
144
+ */
145
+ ref?: string | null | undefined;
142
146
  };
143
147
 
144
148
  /** @internal */
@@ -234,6 +238,7 @@ export const CreateLinkRequestBody$inboundSchema: z.ZodType<
234
238
  utm_campaign: z.nullable(z.string()).optional(),
235
239
  utm_term: z.nullable(z.string()).optional(),
236
240
  utm_content: z.nullable(z.string()).optional(),
241
+ ref: z.nullable(z.string()).optional(),
237
242
  }).transform((v) => {
238
243
  return remap$(v, {
239
244
  "utm_source": "utmSource",
@@ -276,6 +281,7 @@ export type CreateLinkRequestBody$Outbound = {
276
281
  utm_campaign?: string | null | undefined;
277
282
  utm_term?: string | null | undefined;
278
283
  utm_content?: string | null | undefined;
284
+ ref?: string | null | undefined;
279
285
  };
280
286
 
281
287
  /** @internal */
@@ -314,6 +320,7 @@ export const CreateLinkRequestBody$outboundSchema: z.ZodType<
314
320
  utmCampaign: z.nullable(z.string()).optional(),
315
321
  utmTerm: z.nullable(z.string()).optional(),
316
322
  utmContent: z.nullable(z.string()).optional(),
323
+ ref: z.nullable(z.string()).optional(),
317
324
  }).transform((v) => {
318
325
  return remap$(v, {
319
326
  utmSource: "utm_source",
@@ -112,6 +112,10 @@ export type ListEventsRequest = {
112
112
  * The referer to retrieve analytics for.
113
113
  */
114
114
  referer?: string | undefined;
115
+ /**
116
+ * The full referer URL to retrieve analytics for.
117
+ */
118
+ refererUrl?: string | undefined;
115
119
  /**
116
120
  * The URL to retrieve analytics for.
117
121
  */
@@ -245,6 +249,7 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
245
249
  browser: z.string().optional(),
246
250
  os: z.string().optional(),
247
251
  referer: z.string().optional(),
252
+ refererUrl: z.string().optional(),
248
253
  url: z.string().optional(),
249
254
  tagId: z.string().optional(),
250
255
  qr: z.boolean().optional(),
@@ -273,6 +278,7 @@ export type ListEventsRequest$Outbound = {
273
278
  browser?: string | undefined;
274
279
  os?: string | undefined;
275
280
  referer?: string | undefined;
281
+ refererUrl?: string | undefined;
276
282
  url?: string | undefined;
277
283
  tagId?: string | undefined;
278
284
  qr?: boolean | undefined;
@@ -305,6 +311,7 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
305
311
  browser: z.string().optional(),
306
312
  os: z.string().optional(),
307
313
  referer: z.string().optional(),
314
+ refererUrl: z.string().optional(),
308
315
  url: z.string().optional(),
309
316
  tagId: z.string().optional(),
310
317
  qr: z.boolean().optional(),
@@ -33,6 +33,7 @@ export const QueryParamGroupBy = {
33
33
  Browsers: "browsers",
34
34
  Os: "os",
35
35
  Referers: "referers",
36
+ RefererUrls: "referer_urls",
36
37
  TopLinks: "top_links",
37
38
  TopUrls: "top_urls",
38
39
  Trigger: "trigger",
@@ -129,6 +130,10 @@ export type RetrieveAnalyticsRequest = {
129
130
  * The referer to retrieve analytics for.
130
131
  */
131
132
  referer?: string | undefined;
133
+ /**
134
+ * The full referer URL to retrieve analytics for.
135
+ */
136
+ refererUrl?: string | undefined;
132
137
  /**
133
138
  * The URL to retrieve analytics for.
134
139
  */
@@ -245,6 +250,7 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
245
250
  browser: z.string().optional(),
246
251
  os: z.string().optional(),
247
252
  referer: z.string().optional(),
253
+ refererUrl: z.string().optional(),
248
254
  url: z.string().optional(),
249
255
  tagId: z.string().optional(),
250
256
  qr: z.boolean().optional(),
@@ -270,6 +276,7 @@ export type RetrieveAnalyticsRequest$Outbound = {
270
276
  browser?: string | undefined;
271
277
  os?: string | undefined;
272
278
  referer?: string | undefined;
279
+ refererUrl?: string | undefined;
273
280
  url?: string | undefined;
274
281
  tagId?: string | undefined;
275
282
  qr?: boolean | undefined;
@@ -299,6 +306,7 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
299
306
  browser: z.string().optional(),
300
307
  os: z.string().optional(),
301
308
  referer: z.string().optional(),
309
+ refererUrl: z.string().optional(),
302
310
  url: z.string().optional(),
303
311
  tagId: z.string().optional(),
304
312
  qr: z.boolean().optional(),
@@ -139,6 +139,10 @@ export type UpdateLinkRequestBody = {
139
139
  * The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
140
140
  */
141
141
  utmContent?: string | null | undefined;
142
+ /**
143
+ * The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
144
+ */
145
+ ref?: string | null | undefined;
142
146
  };
143
147
 
144
148
  export type UpdateLinkRequest = {
@@ -245,6 +249,7 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
245
249
  utm_campaign: z.nullable(z.string()).optional(),
246
250
  utm_term: z.nullable(z.string()).optional(),
247
251
  utm_content: z.nullable(z.string()).optional(),
252
+ ref: z.nullable(z.string()).optional(),
248
253
  }).transform((v) => {
249
254
  return remap$(v, {
250
255
  "utm_source": "utmSource",
@@ -287,6 +292,7 @@ export type UpdateLinkRequestBody$Outbound = {
287
292
  utm_campaign?: string | null | undefined;
288
293
  utm_term?: string | null | undefined;
289
294
  utm_content?: string | null | undefined;
295
+ ref?: string | null | undefined;
290
296
  };
291
297
 
292
298
  /** @internal */
@@ -325,6 +331,7 @@ export const UpdateLinkRequestBody$outboundSchema: z.ZodType<
325
331
  utmCampaign: z.nullable(z.string()).optional(),
326
332
  utmTerm: z.nullable(z.string()).optional(),
327
333
  utmContent: z.nullable(z.string()).optional(),
334
+ ref: z.nullable(z.string()).optional(),
328
335
  }).transform((v) => {
329
336
  return remap$(v, {
330
337
  utmSource: "utm_source",
@@ -139,6 +139,10 @@ export type UpsertLinkRequestBody = {
139
139
  * The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
140
140
  */
141
141
  utmContent?: string | null | undefined;
142
+ /**
143
+ * The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
144
+ */
145
+ ref?: string | null | undefined;
142
146
  };
143
147
 
144
148
  /** @internal */
@@ -237,6 +241,7 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
237
241
  utm_campaign: z.nullable(z.string()).optional(),
238
242
  utm_term: z.nullable(z.string()).optional(),
239
243
  utm_content: z.nullable(z.string()).optional(),
244
+ ref: z.nullable(z.string()).optional(),
240
245
  }).transform((v) => {
241
246
  return remap$(v, {
242
247
  "utm_source": "utmSource",
@@ -279,6 +284,7 @@ export type UpsertLinkRequestBody$Outbound = {
279
284
  utm_campaign?: string | null | undefined;
280
285
  utm_term?: string | null | undefined;
281
286
  utm_content?: string | null | undefined;
287
+ ref?: string | null | undefined;
282
288
  };
283
289
 
284
290
  /** @internal */
@@ -317,6 +323,7 @@ export const UpsertLinkRequestBody$outboundSchema: z.ZodType<
317
323
  utmCampaign: z.nullable(z.string()).optional(),
318
324
  utmTerm: z.nullable(z.string()).optional(),
319
325
  utmContent: z.nullable(z.string()).optional(),
326
+ ref: z.nullable(z.string()).optional(),
320
327
  }).transform((v) => {
321
328
  return remap$(v, {
322
329
  utmSource: "utm_source",