dub 0.24.3 → 0.24.4

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 (80) hide show
  1. package/README.md +1 -0
  2. package/docs/sdks/links/README.md +3 -0
  3. package/lib/config.d.ts +2 -2
  4. package/lib/config.js +2 -2
  5. package/models/components/linkschema.d.ts +6 -0
  6. package/models/components/linkschema.d.ts.map +1 -1
  7. package/models/components/linkschema.js +4 -0
  8. package/models/components/linkschema.js.map +1 -1
  9. package/models/operations/bulkcreatelinks.d.ts +12 -6
  10. package/models/operations/bulkcreatelinks.d.ts.map +1 -1
  11. package/models/operations/bulkcreatelinks.js +8 -4
  12. package/models/operations/bulkcreatelinks.js.map +1 -1
  13. package/models/operations/createlink.d.ts +12 -6
  14. package/models/operations/createlink.d.ts.map +1 -1
  15. package/models/operations/createlink.js +8 -4
  16. package/models/operations/createlink.js.map +1 -1
  17. package/models/operations/editlink.d.ts +12 -6
  18. package/models/operations/editlink.d.ts.map +1 -1
  19. package/models/operations/editlink.js +8 -4
  20. package/models/operations/editlink.js.map +1 -1
  21. package/models/operations/getbrowseranalytics.d.ts +12 -0
  22. package/models/operations/getbrowseranalytics.d.ts.map +1 -1
  23. package/models/operations/getbrowseranalytics.js +8 -0
  24. package/models/operations/getbrowseranalytics.js.map +1 -1
  25. package/models/operations/getcityanalytics.d.ts +12 -0
  26. package/models/operations/getcityanalytics.d.ts.map +1 -1
  27. package/models/operations/getcityanalytics.js +8 -0
  28. package/models/operations/getcityanalytics.js.map +1 -1
  29. package/models/operations/getclicksanalytics.d.ts +12 -0
  30. package/models/operations/getclicksanalytics.d.ts.map +1 -1
  31. package/models/operations/getclicksanalytics.js +8 -0
  32. package/models/operations/getclicksanalytics.js.map +1 -1
  33. package/models/operations/getcountryanalytics.d.ts +12 -0
  34. package/models/operations/getcountryanalytics.d.ts.map +1 -1
  35. package/models/operations/getcountryanalytics.js +8 -0
  36. package/models/operations/getcountryanalytics.js.map +1 -1
  37. package/models/operations/getdeviceanalytics.d.ts +12 -0
  38. package/models/operations/getdeviceanalytics.d.ts.map +1 -1
  39. package/models/operations/getdeviceanalytics.js +8 -0
  40. package/models/operations/getdeviceanalytics.js.map +1 -1
  41. package/models/operations/getosanalytics.d.ts +12 -0
  42. package/models/operations/getosanalytics.d.ts.map +1 -1
  43. package/models/operations/getosanalytics.js +8 -0
  44. package/models/operations/getosanalytics.js.map +1 -1
  45. package/models/operations/getrefereranalytics.d.ts +12 -0
  46. package/models/operations/getrefereranalytics.d.ts.map +1 -1
  47. package/models/operations/getrefereranalytics.js +8 -0
  48. package/models/operations/getrefereranalytics.js.map +1 -1
  49. package/models/operations/gettimeseriesanalytics.d.ts +12 -0
  50. package/models/operations/gettimeseriesanalytics.d.ts.map +1 -1
  51. package/models/operations/gettimeseriesanalytics.js +8 -0
  52. package/models/operations/gettimeseriesanalytics.js.map +1 -1
  53. package/models/operations/gettoplinks.d.ts +12 -0
  54. package/models/operations/gettoplinks.d.ts.map +1 -1
  55. package/models/operations/gettoplinks.js +8 -0
  56. package/models/operations/gettoplinks.js.map +1 -1
  57. package/models/operations/gettopurls.d.ts +12 -0
  58. package/models/operations/gettopurls.d.ts.map +1 -1
  59. package/models/operations/gettopurls.js +8 -0
  60. package/models/operations/gettopurls.js.map +1 -1
  61. package/package.json +1 -1
  62. package/sdk/analytics.d.ts.map +1 -1
  63. package/sdk/analytics.js +50 -0
  64. package/sdk/analytics.js.map +1 -1
  65. package/src/lib/config.ts +2 -2
  66. package/src/models/components/linkschema.ts +10 -0
  67. package/src/models/operations/bulkcreatelinks.ts +20 -10
  68. package/src/models/operations/createlink.ts +20 -10
  69. package/src/models/operations/editlink.ts +20 -10
  70. package/src/models/operations/getbrowseranalytics.ts +20 -0
  71. package/src/models/operations/getcityanalytics.ts +20 -0
  72. package/src/models/operations/getclicksanalytics.ts +20 -0
  73. package/src/models/operations/getcountryanalytics.ts +20 -0
  74. package/src/models/operations/getdeviceanalytics.ts +20 -0
  75. package/src/models/operations/getosanalytics.ts +20 -0
  76. package/src/models/operations/getrefereranalytics.ts +20 -0
  77. package/src/models/operations/gettimeseriesanalytics.ts +20 -0
  78. package/src/models/operations/gettoplinks.ts +20 -0
  79. package/src/models/operations/gettopurls.ts +20 -0
  80. package/src/sdk/analytics.ts +50 -0
package/src/models/operations/gettoplinks.ts CHANGED
@@ -291,6 +291,14 @@ export type GetTopLinksRequest = {
291
291
  * The short link slug.
292
292
  */
293
293
  key?: string | undefined;
294
+ /**
295
+ * The unique ID of the short link on Dub.
296
+ */
297
+ linkId?: string | undefined;
298
+ /**
299
+ * This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
300
+ */
301
+ externalId?: string | undefined;
294
302
  /**
295
303
  * The interval to retrieve analytics for.
296
304
  */
@@ -361,6 +369,8 @@ export namespace GetTopLinksRequest$ {
361
369
  export type Inbound = {
362
370
  domain?: string | undefined;
363
371
  key?: string | undefined;
372
+ linkId?: string | undefined;
373
+ externalId?: string | undefined;
364
374
  interval?: GetTopLinksQueryParamInterval | undefined;
365
375
  country?: GetTopLinksQueryParamCountry | undefined;
366
376
  city?: string | undefined;
@@ -378,6 +388,8 @@ export namespace GetTopLinksRequest$ {
378
388
  .object({
379
389
  domain: z.string().optional(),
380
390
  key: z.string().optional(),
391
+ linkId: z.string().optional(),
392
+ externalId: z.string().optional(),
381
393
  interval: GetTopLinksQueryParamInterval$.optional(),
382
394
  country: GetTopLinksQueryParamCountry$.optional(),
383
395
  city: z.string().optional(),
@@ -394,6 +406,8 @@ export namespace GetTopLinksRequest$ {
394
406
  return {
395
407
  ...(v.domain === undefined ? null : { domain: v.domain }),
396
408
  ...(v.key === undefined ? null : { key: v.key }),
409
+ ...(v.linkId === undefined ? null : { linkId: v.linkId }),
410
+ ...(v.externalId === undefined ? null : { externalId: v.externalId }),
397
411
  ...(v.interval === undefined ? null : { interval: v.interval }),
398
412
  ...(v.country === undefined ? null : { country: v.country }),
399
413
  ...(v.city === undefined ? null : { city: v.city }),
@@ -411,6 +425,8 @@ export namespace GetTopLinksRequest$ {
411
425
  export type Outbound = {
412
426
  domain?: string | undefined;
413
427
  key?: string | undefined;
428
+ linkId?: string | undefined;
429
+ externalId?: string | undefined;
414
430
  interval?: GetTopLinksQueryParamInterval | undefined;
415
431
  country?: GetTopLinksQueryParamCountry | undefined;
416
432
  city?: string | undefined;
@@ -428,6 +444,8 @@ export namespace GetTopLinksRequest$ {
428
444
  .object({
429
445
  domain: z.string().optional(),
430
446
  key: z.string().optional(),
447
+ linkId: z.string().optional(),
448
+ externalId: z.string().optional(),
431
449
  interval: GetTopLinksQueryParamInterval$.optional(),
432
450
  country: GetTopLinksQueryParamCountry$.optional(),
433
451
  city: z.string().optional(),
@@ -444,6 +462,8 @@ export namespace GetTopLinksRequest$ {
444
462
  return {
445
463
  ...(v.domain === undefined ? null : { domain: v.domain }),
446
464
  ...(v.key === undefined ? null : { key: v.key }),
465
+ ...(v.linkId === undefined ? null : { linkId: v.linkId }),
466
+ ...(v.externalId === undefined ? null : { externalId: v.externalId }),
447
467
  ...(v.interval === undefined ? null : { interval: v.interval }),
448
468
  ...(v.country === undefined ? null : { country: v.country }),
449
469
  ...(v.city === undefined ? null : { city: v.city }),
package/src/models/operations/gettopurls.ts CHANGED
@@ -291,6 +291,14 @@ export type GetTopURLsRequest = {
291
291
  * The short link slug.
292
292
  */
293
293
  key?: string | undefined;
294
+ /**
295
+ * The unique ID of the short link on Dub.
296
+ */
297
+ linkId?: string | undefined;
298
+ /**
299
+ * This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
300
+ */
301
+ externalId?: string | undefined;
294
302
  /**
295
303
  * The interval to retrieve analytics for.
296
304
  */
@@ -361,6 +369,8 @@ export namespace GetTopURLsRequest$ {
361
369
  export type Inbound = {
362
370
  domain?: string | undefined;
363
371
  key?: string | undefined;
372
+ linkId?: string | undefined;
373
+ externalId?: string | undefined;
364
374
  interval?: GetTopURLsQueryParamInterval | undefined;
365
375
  country?: GetTopURLsQueryParamCountry | undefined;
366
376
  city?: string | undefined;
@@ -378,6 +388,8 @@ export namespace GetTopURLsRequest$ {
378
388
  .object({
379
389
  domain: z.string().optional(),
380
390
  key: z.string().optional(),
391
+ linkId: z.string().optional(),
392
+ externalId: z.string().optional(),
381
393
  interval: GetTopURLsQueryParamInterval$.optional(),
382
394
  country: GetTopURLsQueryParamCountry$.optional(),
383
395
  city: z.string().optional(),
@@ -394,6 +406,8 @@ export namespace GetTopURLsRequest$ {
394
406
  return {
395
407
  ...(v.domain === undefined ? null : { domain: v.domain }),
396
408
  ...(v.key === undefined ? null : { key: v.key }),
409
+ ...(v.linkId === undefined ? null : { linkId: v.linkId }),
410
+ ...(v.externalId === undefined ? null : { externalId: v.externalId }),
397
411
  ...(v.interval === undefined ? null : { interval: v.interval }),
398
412
  ...(v.country === undefined ? null : { country: v.country }),
399
413
  ...(v.city === undefined ? null : { city: v.city }),
@@ -411,6 +425,8 @@ export namespace GetTopURLsRequest$ {
411
425
  export type Outbound = {
412
426
  domain?: string | undefined;
413
427
  key?: string | undefined;
428
+ linkId?: string | undefined;
429
+ externalId?: string | undefined;
414
430
  interval?: GetTopURLsQueryParamInterval | undefined;
415
431
  country?: GetTopURLsQueryParamCountry | undefined;
416
432
  city?: string | undefined;
@@ -428,6 +444,8 @@ export namespace GetTopURLsRequest$ {
428
444
  .object({
429
445
  domain: z.string().optional(),
430
446
  key: z.string().optional(),
447
+ linkId: z.string().optional(),
448
+ externalId: z.string().optional(),
431
449
  interval: GetTopURLsQueryParamInterval$.optional(),
432
450
  country: GetTopURLsQueryParamCountry$.optional(),
433
451
  city: z.string().optional(),
@@ -444,6 +462,8 @@ export namespace GetTopURLsRequest$ {
444
462
  return {
445
463
  ...(v.domain === undefined ? null : { domain: v.domain }),
446
464
  ...(v.key === undefined ? null : { key: v.key }),
465
+ ...(v.linkId === undefined ? null : { linkId: v.linkId }),
466
+ ...(v.externalId === undefined ? null : { externalId: v.externalId }),
447
467
  ...(v.interval === undefined ? null : { interval: v.interval }),
448
468
  ...(v.country === undefined ? null : { country: v.country }),
449
469
  ...(v.city === undefined ? null : { city: v.city }),
package/src/sdk/analytics.ts CHANGED
@@ -74,11 +74,16 @@ export class Analytics extends ClientSDK {
74
74
  }),
75
75
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
76
76
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
77
+ enc$.encodeForm("externalId", payload$.externalId, {
78
+ explode: true,
79
+ charEncoding: "percent",
80
+ }),
77
81
  enc$.encodeForm("interval", payload$.interval, {
78
82
  explode: true,
79
83
  charEncoding: "percent",
80
84
  }),
81
85
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
86
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
82
87
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
83
88
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
84
89
  explode: true,
@@ -320,11 +325,16 @@ export class Analytics extends ClientSDK {
320
325
  }),
321
326
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
322
327
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
328
+ enc$.encodeForm("externalId", payload$.externalId, {
329
+ explode: true,
330
+ charEncoding: "percent",
331
+ }),
323
332
  enc$.encodeForm("interval", payload$.interval, {
324
333
  explode: true,
325
334
  charEncoding: "percent",
326
335
  }),
327
336
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
337
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
328
338
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
329
339
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
330
340
  explode: true,
@@ -566,11 +576,16 @@ export class Analytics extends ClientSDK {
566
576
  }),
567
577
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
568
578
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
579
+ enc$.encodeForm("externalId", payload$.externalId, {
580
+ explode: true,
581
+ charEncoding: "percent",
582
+ }),
569
583
  enc$.encodeForm("interval", payload$.interval, {
570
584
  explode: true,
571
585
  charEncoding: "percent",
572
586
  }),
573
587
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
588
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
574
589
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
575
590
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
576
591
  explode: true,
@@ -814,11 +829,16 @@ export class Analytics extends ClientSDK {
814
829
  }),
815
830
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
816
831
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
832
+ enc$.encodeForm("externalId", payload$.externalId, {
833
+ explode: true,
834
+ charEncoding: "percent",
835
+ }),
817
836
  enc$.encodeForm("interval", payload$.interval, {
818
837
  explode: true,
819
838
  charEncoding: "percent",
820
839
  }),
821
840
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
841
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
822
842
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
823
843
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
824
844
  explode: true,
@@ -1062,11 +1082,16 @@ export class Analytics extends ClientSDK {
1062
1082
  }),
1063
1083
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
1064
1084
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
1085
+ enc$.encodeForm("externalId", payload$.externalId, {
1086
+ explode: true,
1087
+ charEncoding: "percent",
1088
+ }),
1065
1089
  enc$.encodeForm("interval", payload$.interval, {
1066
1090
  explode: true,
1067
1091
  charEncoding: "percent",
1068
1092
  }),
1069
1093
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
1094
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
1070
1095
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
1071
1096
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
1072
1097
  explode: true,
@@ -1310,11 +1335,16 @@ export class Analytics extends ClientSDK {
1310
1335
  }),
1311
1336
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
1312
1337
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
1338
+ enc$.encodeForm("externalId", payload$.externalId, {
1339
+ explode: true,
1340
+ charEncoding: "percent",
1341
+ }),
1313
1342
  enc$.encodeForm("interval", payload$.interval, {
1314
1343
  explode: true,
1315
1344
  charEncoding: "percent",
1316
1345
  }),
1317
1346
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
1347
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
1318
1348
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
1319
1349
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
1320
1350
  explode: true,
@@ -1558,11 +1588,16 @@ export class Analytics extends ClientSDK {
1558
1588
  }),
1559
1589
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
1560
1590
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
1591
+ enc$.encodeForm("externalId", payload$.externalId, {
1592
+ explode: true,
1593
+ charEncoding: "percent",
1594
+ }),
1561
1595
  enc$.encodeForm("interval", payload$.interval, {
1562
1596
  explode: true,
1563
1597
  charEncoding: "percent",
1564
1598
  }),
1565
1599
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
1600
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
1566
1601
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
1567
1602
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
1568
1603
  explode: true,
@@ -1806,11 +1841,16 @@ export class Analytics extends ClientSDK {
1806
1841
  }),
1807
1842
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
1808
1843
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
1844
+ enc$.encodeForm("externalId", payload$.externalId, {
1845
+ explode: true,
1846
+ charEncoding: "percent",
1847
+ }),
1809
1848
  enc$.encodeForm("interval", payload$.interval, {
1810
1849
  explode: true,
1811
1850
  charEncoding: "percent",
1812
1851
  }),
1813
1852
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
1853
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
1814
1854
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
1815
1855
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
1816
1856
  explode: true,
@@ -2054,11 +2094,16 @@ export class Analytics extends ClientSDK {
2054
2094
  }),
2055
2095
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
2056
2096
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
2097
+ enc$.encodeForm("externalId", payload$.externalId, {
2098
+ explode: true,
2099
+ charEncoding: "percent",
2100
+ }),
2057
2101
  enc$.encodeForm("interval", payload$.interval, {
2058
2102
  explode: true,
2059
2103
  charEncoding: "percent",
2060
2104
  }),
2061
2105
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
2106
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
2062
2107
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
2063
2108
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
2064
2109
  explode: true,
@@ -2300,11 +2345,16 @@ export class Analytics extends ClientSDK {
2300
2345
  }),
2301
2346
  enc$.encodeForm("device", payload$.device, { explode: true, charEncoding: "percent" }),
2302
2347
  enc$.encodeForm("domain", payload$.domain, { explode: true, charEncoding: "percent" }),
2348
+ enc$.encodeForm("externalId", payload$.externalId, {
2349
+ explode: true,
2350
+ charEncoding: "percent",
2351
+ }),
2303
2352
  enc$.encodeForm("interval", payload$.interval, {
2304
2353
  explode: true,
2305
2354
  charEncoding: "percent",
2306
2355
  }),
2307
2356
  enc$.encodeForm("key", payload$.key, { explode: true, charEncoding: "percent" }),
2357
+ enc$.encodeForm("linkId", payload$.linkId, { explode: true, charEncoding: "percent" }),
2308
2358
  enc$.encodeForm("os", payload$.os, { explode: true, charEncoding: "percent" }),
2309
2359
  enc$.encodeForm("projectSlug", this.options$.projectSlug, {
2310
2360
  explode: true,