dub 0.36.0 → 0.36.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.
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/models/components/domainschema.js +3 -3
- package/dist/commonjs/models/components/domainschema.js.map +1 -1
- package/dist/commonjs/models/components/linkschema.d.ts +5 -0
- package/dist/commonjs/models/components/linkschema.d.ts.map +1 -1
- package/dist/commonjs/models/components/linkschema.js +8 -6
- package/dist/commonjs/models/components/linkschema.js.map +1 -1
- package/dist/commonjs/models/components/workspaceschema.d.ts +52 -17
- package/dist/commonjs/models/components/workspaceschema.d.ts.map +1 -1
- package/dist/commonjs/models/components/workspaceschema.js +26 -12
- package/dist/commonjs/models/components/workspaceschema.js.map +1 -1
- package/dist/commonjs/models/operations/bulkcreatelinks.js +6 -6
- package/dist/commonjs/models/operations/bulkcreatelinks.js.map +1 -1
- package/dist/commonjs/models/operations/bulkupdatelinks.js +6 -6
- package/dist/commonjs/models/operations/bulkupdatelinks.js.map +1 -1
- package/dist/commonjs/models/operations/createdomain.js +1 -1
- package/dist/commonjs/models/operations/createdomain.js.map +1 -1
- package/dist/commonjs/models/operations/createlink.js +6 -6
- package/dist/commonjs/models/operations/createlink.js.map +1 -1
- package/dist/commonjs/models/operations/updatedomain.js +1 -1
- package/dist/commonjs/models/operations/updatedomain.js.map +1 -1
- package/dist/commonjs/models/operations/updatelink.js +6 -6
- package/dist/commonjs/models/operations/updatelink.js.map +1 -1
- package/dist/commonjs/models/operations/upsertlink.js +6 -6
- package/dist/commonjs/models/operations/upsertlink.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/models/components/domainschema.js +3 -3
- package/dist/esm/models/components/domainschema.js.map +1 -1
- package/dist/esm/models/components/linkschema.d.ts +5 -0
- package/dist/esm/models/components/linkschema.d.ts.map +1 -1
- package/dist/esm/models/components/linkschema.js +8 -6
- package/dist/esm/models/components/linkschema.js.map +1 -1
- package/dist/esm/models/components/workspaceschema.d.ts +52 -17
- package/dist/esm/models/components/workspaceschema.d.ts.map +1 -1
- package/dist/esm/models/components/workspaceschema.js +26 -12
- package/dist/esm/models/components/workspaceschema.js.map +1 -1
- package/dist/esm/models/operations/bulkcreatelinks.js +6 -6
- package/dist/esm/models/operations/bulkcreatelinks.js.map +1 -1
- package/dist/esm/models/operations/bulkupdatelinks.js +6 -6
- package/dist/esm/models/operations/bulkupdatelinks.js.map +1 -1
- package/dist/esm/models/operations/createdomain.js +1 -1
- package/dist/esm/models/operations/createdomain.js.map +1 -1
- package/dist/esm/models/operations/createlink.js +6 -6
- package/dist/esm/models/operations/createlink.js.map +1 -1
- package/dist/esm/models/operations/updatedomain.js +1 -1
- package/dist/esm/models/operations/updatedomain.js.map +1 -1
- package/dist/esm/models/operations/updatelink.js +6 -6
- package/dist/esm/models/operations/updatelink.js.map +1 -1
- package/dist/esm/models/operations/upsertlink.js +6 -6
- package/dist/esm/models/operations/upsertlink.js.map +1 -1
- package/docs/sdks/analytics/README.md +3 -2
- package/docs/sdks/domains/README.md +9 -8
- package/docs/sdks/dub/README.md +1 -5
- package/docs/sdks/events/README.md +3 -2
- package/docs/sdks/links/README.md +19 -18
- package/docs/sdks/metatags/README.md +3 -2
- package/docs/sdks/qrcodes/README.md +3 -2
- package/docs/sdks/tags/README.md +7 -6
- package/docs/sdks/track/README.md +7 -6
- package/docs/sdks/workspaces/README.md +5 -4
- package/package.json +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/domainschema.ts +3 -3
- package/src/models/components/linkschema.ts +13 -6
- package/src/models/components/workspaceschema.ts +78 -29
- package/src/models/operations/bulkcreatelinks.ts +6 -6
- package/src/models/operations/bulkupdatelinks.ts +6 -6
- package/src/models/operations/createdomain.ts +1 -1
- package/src/models/operations/createlink.ts +6 -6
- package/src/models/operations/updatedomain.ts +1 -1
- package/src/models/operations/updatelink.ts +6 -6
- package/src/models/operations/upsertlink.ts +6 -6
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Links
|
|
2
2
|
(*links*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [list](#list) - Retrieve a list of links
|
|
@@ -37,7 +39,6 @@ async function run() {
|
|
|
37
39
|
run();
|
|
38
40
|
```
|
|
39
41
|
|
|
40
|
-
|
|
41
42
|
### Standalone function
|
|
42
43
|
|
|
43
44
|
The standalone function version of this method:
|
|
@@ -78,10 +79,10 @@ run();
|
|
|
78
79
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
79
80
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
80
81
|
|
|
81
|
-
|
|
82
82
|
### Response
|
|
83
83
|
|
|
84
84
|
**Promise\<[operations.GetLinksResponse](../../models/operations/getlinksresponse.md)\>**
|
|
85
|
+
|
|
85
86
|
### Errors
|
|
86
87
|
|
|
87
88
|
| Error Object | Status Code | Content Type |
|
|
@@ -97,6 +98,7 @@ run();
|
|
|
97
98
|
| errors.InternalServerError | 500 | application/json |
|
|
98
99
|
| errors.SDKError | 4xx-5xx | */* |
|
|
99
100
|
|
|
101
|
+
|
|
100
102
|
## create
|
|
101
103
|
|
|
102
104
|
Create a new link for the authenticated workspace.
|
|
@@ -120,7 +122,6 @@ async function run() {
|
|
|
120
122
|
run();
|
|
121
123
|
```
|
|
122
124
|
|
|
123
|
-
|
|
124
125
|
### Standalone function
|
|
125
126
|
|
|
126
127
|
The standalone function version of this method:
|
|
@@ -160,10 +161,10 @@ run();
|
|
|
160
161
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
161
162
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
162
163
|
|
|
163
|
-
|
|
164
164
|
### Response
|
|
165
165
|
|
|
166
166
|
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
167
|
+
|
|
167
168
|
### Errors
|
|
168
169
|
|
|
169
170
|
| Error Object | Status Code | Content Type |
|
|
@@ -179,6 +180,7 @@ run();
|
|
|
179
180
|
| errors.InternalServerError | 500 | application/json |
|
|
180
181
|
| errors.SDKError | 4xx-5xx | */* |
|
|
181
182
|
|
|
183
|
+
|
|
182
184
|
## count
|
|
183
185
|
|
|
184
186
|
Retrieve the number of links for the authenticated workspace.
|
|
@@ -202,7 +204,6 @@ async function run() {
|
|
|
202
204
|
run();
|
|
203
205
|
```
|
|
204
206
|
|
|
205
|
-
|
|
206
207
|
### Standalone function
|
|
207
208
|
|
|
208
209
|
The standalone function version of this method:
|
|
@@ -242,10 +243,10 @@ run();
|
|
|
242
243
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
243
244
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
244
245
|
|
|
245
|
-
|
|
246
246
|
### Response
|
|
247
247
|
|
|
248
248
|
**Promise\<[number](../../models/.md)\>**
|
|
249
|
+
|
|
249
250
|
### Errors
|
|
250
251
|
|
|
251
252
|
| Error Object | Status Code | Content Type |
|
|
@@ -261,6 +262,7 @@ run();
|
|
|
261
262
|
| errors.InternalServerError | 500 | application/json |
|
|
262
263
|
| errors.SDKError | 4xx-5xx | */* |
|
|
263
264
|
|
|
265
|
+
|
|
264
266
|
## get
|
|
265
267
|
|
|
266
268
|
Retrieve the info for a link.
|
|
@@ -284,7 +286,6 @@ async function run() {
|
|
|
284
286
|
run();
|
|
285
287
|
```
|
|
286
288
|
|
|
287
|
-
|
|
288
289
|
### Standalone function
|
|
289
290
|
|
|
290
291
|
The standalone function version of this method:
|
|
@@ -324,10 +325,10 @@ run();
|
|
|
324
325
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
325
326
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
326
327
|
|
|
327
|
-
|
|
328
328
|
### Response
|
|
329
329
|
|
|
330
330
|
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
331
|
+
|
|
331
332
|
### Errors
|
|
332
333
|
|
|
333
334
|
| Error Object | Status Code | Content Type |
|
|
@@ -343,6 +344,7 @@ run();
|
|
|
343
344
|
| errors.InternalServerError | 500 | application/json |
|
|
344
345
|
| errors.SDKError | 4xx-5xx | */* |
|
|
345
346
|
|
|
347
|
+
|
|
346
348
|
## delete
|
|
347
349
|
|
|
348
350
|
Delete a link for the authenticated workspace.
|
|
@@ -366,7 +368,6 @@ async function run() {
|
|
|
366
368
|
run();
|
|
367
369
|
```
|
|
368
370
|
|
|
369
|
-
|
|
370
371
|
### Standalone function
|
|
371
372
|
|
|
372
373
|
The standalone function version of this method:
|
|
@@ -406,10 +407,10 @@ run();
|
|
|
406
407
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
407
408
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
408
409
|
|
|
409
|
-
|
|
410
410
|
### Response
|
|
411
411
|
|
|
412
412
|
**Promise\<[operations.DeleteLinkResponseBody](../../models/operations/deletelinkresponsebody.md)\>**
|
|
413
|
+
|
|
413
414
|
### Errors
|
|
414
415
|
|
|
415
416
|
| Error Object | Status Code | Content Type |
|
|
@@ -425,6 +426,7 @@ run();
|
|
|
425
426
|
| errors.InternalServerError | 500 | application/json |
|
|
426
427
|
| errors.SDKError | 4xx-5xx | */* |
|
|
427
428
|
|
|
429
|
+
|
|
428
430
|
## update
|
|
429
431
|
|
|
430
432
|
Update a link for the authenticated workspace. If there's no change, returns it as it is.
|
|
@@ -448,7 +450,6 @@ async function run() {
|
|
|
448
450
|
run();
|
|
449
451
|
```
|
|
450
452
|
|
|
451
|
-
|
|
452
453
|
### Standalone function
|
|
453
454
|
|
|
454
455
|
The standalone function version of this method:
|
|
@@ -489,10 +490,10 @@ run();
|
|
|
489
490
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
490
491
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
491
492
|
|
|
492
|
-
|
|
493
493
|
### Response
|
|
494
494
|
|
|
495
495
|
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
496
|
+
|
|
496
497
|
### Errors
|
|
497
498
|
|
|
498
499
|
| Error Object | Status Code | Content Type |
|
|
@@ -508,6 +509,7 @@ run();
|
|
|
508
509
|
| errors.InternalServerError | 500 | application/json |
|
|
509
510
|
| errors.SDKError | 4xx-5xx | */* |
|
|
510
511
|
|
|
512
|
+
|
|
511
513
|
## createMany
|
|
512
514
|
|
|
513
515
|
Bulk create up to 100 links for the authenticated workspace.
|
|
@@ -531,7 +533,6 @@ async function run() {
|
|
|
531
533
|
run();
|
|
532
534
|
```
|
|
533
535
|
|
|
534
|
-
|
|
535
536
|
### Standalone function
|
|
536
537
|
|
|
537
538
|
The standalone function version of this method:
|
|
@@ -571,10 +572,10 @@ run();
|
|
|
571
572
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
572
573
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
573
574
|
|
|
574
|
-
|
|
575
575
|
### Response
|
|
576
576
|
|
|
577
577
|
**Promise\<[components.LinkSchema[]](../../models/.md)\>**
|
|
578
|
+
|
|
578
579
|
### Errors
|
|
579
580
|
|
|
580
581
|
| Error Object | Status Code | Content Type |
|
|
@@ -590,6 +591,7 @@ run();
|
|
|
590
591
|
| errors.InternalServerError | 500 | application/json |
|
|
591
592
|
| errors.SDKError | 4xx-5xx | */* |
|
|
592
593
|
|
|
594
|
+
|
|
593
595
|
## updateMany
|
|
594
596
|
|
|
595
597
|
Bulk update up to 100 links with the same data for the authenticated workspace.
|
|
@@ -613,7 +615,6 @@ async function run() {
|
|
|
613
615
|
run();
|
|
614
616
|
```
|
|
615
617
|
|
|
616
|
-
|
|
617
618
|
### Standalone function
|
|
618
619
|
|
|
619
620
|
The standalone function version of this method:
|
|
@@ -653,10 +654,10 @@ run();
|
|
|
653
654
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
654
655
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
655
656
|
|
|
656
|
-
|
|
657
657
|
### Response
|
|
658
658
|
|
|
659
659
|
**Promise\<[components.LinkSchema[]](../../models/.md)\>**
|
|
660
|
+
|
|
660
661
|
### Errors
|
|
661
662
|
|
|
662
663
|
| Error Object | Status Code | Content Type |
|
|
@@ -672,6 +673,7 @@ run();
|
|
|
672
673
|
| errors.InternalServerError | 500 | application/json |
|
|
673
674
|
| errors.SDKError | 4xx-5xx | */* |
|
|
674
675
|
|
|
676
|
+
|
|
675
677
|
## upsert
|
|
676
678
|
|
|
677
679
|
Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.
|
|
@@ -695,7 +697,6 @@ async function run() {
|
|
|
695
697
|
run();
|
|
696
698
|
```
|
|
697
699
|
|
|
698
|
-
|
|
699
700
|
### Standalone function
|
|
700
701
|
|
|
701
702
|
The standalone function version of this method:
|
|
@@ -735,10 +736,10 @@ run();
|
|
|
735
736
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
736
737
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
737
738
|
|
|
738
|
-
|
|
739
739
|
### Response
|
|
740
740
|
|
|
741
741
|
**Promise\<[components.LinkSchema](../../models/components/linkschema.md)\>**
|
|
742
|
+
|
|
742
743
|
### Errors
|
|
743
744
|
|
|
744
745
|
| Error Object | Status Code | Content Type |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Metatags
|
|
2
2
|
(*metatags*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [get](#get) - Retrieve the metatags for a URL
|
|
@@ -30,7 +32,6 @@ async function run() {
|
|
|
30
32
|
run();
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
34
35
|
### Standalone function
|
|
35
36
|
|
|
36
37
|
The standalone function version of this method:
|
|
@@ -72,10 +73,10 @@ run();
|
|
|
72
73
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
73
74
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
74
75
|
|
|
75
|
-
|
|
76
76
|
### Response
|
|
77
77
|
|
|
78
78
|
**Promise\<[operations.GetMetatagsResponseBody](../../models/operations/getmetatagsresponsebody.md)\>**
|
|
79
|
+
|
|
79
80
|
### Errors
|
|
80
81
|
|
|
81
82
|
| Error Object | Status Code | Content Type |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# QRCodes
|
|
2
2
|
(*qrCodes*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [get](#get) - Retrieve a QR code
|
|
@@ -30,7 +32,6 @@ async function run() {
|
|
|
30
32
|
run();
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
34
35
|
### Standalone function
|
|
35
36
|
|
|
36
37
|
The standalone function version of this method:
|
|
@@ -72,10 +73,10 @@ run();
|
|
|
72
73
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
73
74
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
74
75
|
|
|
75
|
-
|
|
76
76
|
### Response
|
|
77
77
|
|
|
78
78
|
**Promise\<[string](../../models/.md)\>**
|
|
79
|
+
|
|
79
80
|
### Errors
|
|
80
81
|
|
|
81
82
|
| Error Object | Status Code | Content Type |
|
package/docs/sdks/tags/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Tags
|
|
2
2
|
(*tags*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [list](#list) - Retrieve a list of tags
|
|
@@ -30,7 +32,6 @@ async function run() {
|
|
|
30
32
|
run();
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
34
35
|
### Standalone function
|
|
35
36
|
|
|
36
37
|
The standalone function version of this method:
|
|
@@ -69,10 +70,10 @@ run();
|
|
|
69
70
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
70
71
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
71
72
|
|
|
72
|
-
|
|
73
73
|
### Response
|
|
74
74
|
|
|
75
75
|
**Promise\<[components.TagSchema[]](../../models/.md)\>**
|
|
76
|
+
|
|
76
77
|
### Errors
|
|
77
78
|
|
|
78
79
|
| Error Object | Status Code | Content Type |
|
|
@@ -88,6 +89,7 @@ run();
|
|
|
88
89
|
| errors.InternalServerError | 500 | application/json |
|
|
89
90
|
| errors.SDKError | 4xx-5xx | */* |
|
|
90
91
|
|
|
92
|
+
|
|
91
93
|
## create
|
|
92
94
|
|
|
93
95
|
Create a new tag for the authenticated workspace.
|
|
@@ -111,7 +113,6 @@ async function run() {
|
|
|
111
113
|
run();
|
|
112
114
|
```
|
|
113
115
|
|
|
114
|
-
|
|
115
116
|
### Standalone function
|
|
116
117
|
|
|
117
118
|
The standalone function version of this method:
|
|
@@ -151,10 +152,10 @@ run();
|
|
|
151
152
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
152
153
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
153
154
|
|
|
154
|
-
|
|
155
155
|
### Response
|
|
156
156
|
|
|
157
157
|
**Promise\<[components.TagSchema](../../models/components/tagschema.md)\>**
|
|
158
|
+
|
|
158
159
|
### Errors
|
|
159
160
|
|
|
160
161
|
| Error Object | Status Code | Content Type |
|
|
@@ -170,6 +171,7 @@ run();
|
|
|
170
171
|
| errors.InternalServerError | 500 | application/json |
|
|
171
172
|
| errors.SDKError | 4xx-5xx | */* |
|
|
172
173
|
|
|
174
|
+
|
|
173
175
|
## update
|
|
174
176
|
|
|
175
177
|
Update a tag in the workspace.
|
|
@@ -193,7 +195,6 @@ async function run() {
|
|
|
193
195
|
run();
|
|
194
196
|
```
|
|
195
197
|
|
|
196
|
-
|
|
197
198
|
### Standalone function
|
|
198
199
|
|
|
199
200
|
The standalone function version of this method:
|
|
@@ -234,10 +235,10 @@ run();
|
|
|
234
235
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
235
236
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
236
237
|
|
|
237
|
-
|
|
238
238
|
### Response
|
|
239
239
|
|
|
240
240
|
**Promise\<[components.TagSchema](../../models/components/tagschema.md)\>**
|
|
241
|
+
|
|
241
242
|
### Errors
|
|
242
243
|
|
|
243
244
|
| Error Object | Status Code | Content Type |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Track
|
|
2
2
|
(*track*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [lead](#lead) - Track a lead
|
|
@@ -30,7 +32,6 @@ async function run() {
|
|
|
30
32
|
run();
|
|
31
33
|
```
|
|
32
34
|
|
|
33
|
-
|
|
34
35
|
### Standalone function
|
|
35
36
|
|
|
36
37
|
The standalone function version of this method:
|
|
@@ -70,10 +71,10 @@ run();
|
|
|
70
71
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
71
72
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
72
73
|
|
|
73
|
-
|
|
74
74
|
### Response
|
|
75
75
|
|
|
76
76
|
**Promise\<[operations.TrackLeadResponseBody](../../models/operations/trackleadresponsebody.md)\>**
|
|
77
|
+
|
|
77
78
|
### Errors
|
|
78
79
|
|
|
79
80
|
| Error Object | Status Code | Content Type |
|
|
@@ -89,6 +90,7 @@ run();
|
|
|
89
90
|
| errors.InternalServerError | 500 | application/json |
|
|
90
91
|
| errors.SDKError | 4xx-5xx | */* |
|
|
91
92
|
|
|
93
|
+
|
|
92
94
|
## sale
|
|
93
95
|
|
|
94
96
|
Track a sale for a short link.
|
|
@@ -112,7 +114,6 @@ async function run() {
|
|
|
112
114
|
run();
|
|
113
115
|
```
|
|
114
116
|
|
|
115
|
-
|
|
116
117
|
### Standalone function
|
|
117
118
|
|
|
118
119
|
The standalone function version of this method:
|
|
@@ -152,10 +153,10 @@ run();
|
|
|
152
153
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
153
154
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
154
155
|
|
|
155
|
-
|
|
156
156
|
### Response
|
|
157
157
|
|
|
158
158
|
**Promise\<[operations.TrackSaleResponseBody](../../models/operations/tracksaleresponsebody.md)\>**
|
|
159
|
+
|
|
159
160
|
### Errors
|
|
160
161
|
|
|
161
162
|
| Error Object | Status Code | Content Type |
|
|
@@ -171,6 +172,7 @@ run();
|
|
|
171
172
|
| errors.InternalServerError | 500 | application/json |
|
|
172
173
|
| errors.SDKError | 4xx-5xx | */* |
|
|
173
174
|
|
|
175
|
+
|
|
174
176
|
## customer
|
|
175
177
|
|
|
176
178
|
Track a customer for an authenticated workspace.
|
|
@@ -194,7 +196,6 @@ async function run() {
|
|
|
194
196
|
run();
|
|
195
197
|
```
|
|
196
198
|
|
|
197
|
-
|
|
198
199
|
### Standalone function
|
|
199
200
|
|
|
200
201
|
The standalone function version of this method:
|
|
@@ -234,10 +235,10 @@ run();
|
|
|
234
235
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
235
236
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
236
237
|
|
|
237
|
-
|
|
238
238
|
### Response
|
|
239
239
|
|
|
240
240
|
**Promise\<[operations.TrackCustomerResponseBody](../../models/operations/trackcustomerresponsebody.md)\>**
|
|
241
|
+
|
|
241
242
|
### Errors
|
|
242
243
|
|
|
243
244
|
| Error Object | Status Code | Content Type |
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# Workspaces
|
|
2
2
|
(*workspaces*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
4
6
|
### Available Operations
|
|
5
7
|
|
|
6
8
|
* [get](#get) - Retrieve a workspace
|
|
@@ -31,7 +33,6 @@ async function run() {
|
|
|
31
33
|
run();
|
|
32
34
|
```
|
|
33
35
|
|
|
34
|
-
|
|
35
36
|
### Standalone function
|
|
36
37
|
|
|
37
38
|
The standalone function version of this method:
|
|
@@ -73,10 +74,10 @@ run();
|
|
|
73
74
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
74
75
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
75
76
|
|
|
76
|
-
|
|
77
77
|
### Response
|
|
78
78
|
|
|
79
79
|
**Promise\<[components.WorkspaceSchema](../../models/components/workspaceschema.md)\>**
|
|
80
|
+
|
|
80
81
|
### Errors
|
|
81
82
|
|
|
82
83
|
| Error Object | Status Code | Content Type |
|
|
@@ -92,6 +93,7 @@ run();
|
|
|
92
93
|
| errors.InternalServerError | 500 | application/json |
|
|
93
94
|
| errors.SDKError | 4xx-5xx | */* |
|
|
94
95
|
|
|
96
|
+
|
|
95
97
|
## update
|
|
96
98
|
|
|
97
99
|
Update a workspace by ID or slug.
|
|
@@ -115,7 +117,6 @@ async function run() {
|
|
|
115
117
|
run();
|
|
116
118
|
```
|
|
117
119
|
|
|
118
|
-
|
|
119
120
|
### Standalone function
|
|
120
121
|
|
|
121
122
|
The standalone function version of this method:
|
|
@@ -156,10 +157,10 @@ run();
|
|
|
156
157
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
157
158
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
158
159
|
|
|
159
|
-
|
|
160
160
|
### Response
|
|
161
161
|
|
|
162
162
|
**Promise\<[components.WorkspaceSchema](../../models/components/workspaceschema.md)\>**
|
|
163
|
+
|
|
163
164
|
### Errors
|
|
164
165
|
|
|
165
166
|
| Error Object | Status Code | Content Type |
|
package/package.json
CHANGED
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.36.
|
|
61
|
-
genVersion: "2.
|
|
62
|
-
userAgent: "speakeasy-sdk/typescript 0.36.
|
|
60
|
+
sdkVersion: "0.36.2",
|
|
61
|
+
genVersion: "2.404.3",
|
|
62
|
+
userAgent: "speakeasy-sdk/typescript 0.36.2 2.404.3 0.0.1 dub",
|
|
63
63
|
} as const;
|
|
@@ -47,9 +47,9 @@ export type DomainSchema = {
|
|
|
47
47
|
export const DomainSchema$inboundSchema: z.ZodType<DomainSchema, z.ZodTypeDef, unknown> = z.object({
|
|
48
48
|
id: z.string(),
|
|
49
49
|
slug: z.string(),
|
|
50
|
-
verified: z.boolean(),
|
|
51
|
-
primary: z.boolean(),
|
|
52
|
-
archived: z.boolean(),
|
|
50
|
+
verified: z.boolean().default(false),
|
|
51
|
+
primary: z.boolean().default(false),
|
|
52
|
+
archived: z.boolean().default(false),
|
|
53
53
|
placeholder: z.string().default("https://dub.co/help/article/what-is-dub"),
|
|
54
54
|
expiredUrl: z.nullable(z.string()),
|
|
55
55
|
createdAt: z.string(),
|
|
@@ -418,6 +418,10 @@ export type LinkSchema = {
|
|
|
418
418
|
* [BETA]: The number of sales the short links has generated.
|
|
419
419
|
*/
|
|
420
420
|
sales?: number | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* [BETA]: The total dollar amount of sales the short links has generated (in cents).
|
|
423
|
+
*/
|
|
424
|
+
saleAmount?: number | undefined;
|
|
421
425
|
/**
|
|
422
426
|
* The date and time when the short link was created.
|
|
423
427
|
*/
|
|
@@ -1727,22 +1731,22 @@ export const LinkSchema$inboundSchema: z.ZodType<LinkSchema, z.ZodTypeDef, unkno
|
|
|
1727
1731
|
key: z.string(),
|
|
1728
1732
|
externalId: z.nullable(z.string()),
|
|
1729
1733
|
url: z.string(),
|
|
1730
|
-
trackConversion: z.boolean(),
|
|
1731
|
-
archived: z.boolean(),
|
|
1734
|
+
trackConversion: z.boolean().default(false),
|
|
1735
|
+
archived: z.boolean().default(false),
|
|
1732
1736
|
expiresAt: z.nullable(z.string()),
|
|
1733
1737
|
expiredUrl: z.nullable(z.string()),
|
|
1734
1738
|
password: z.nullable(z.string()),
|
|
1735
|
-
proxy: z.boolean(),
|
|
1739
|
+
proxy: z.boolean().default(false),
|
|
1736
1740
|
title: z.nullable(z.string()),
|
|
1737
1741
|
description: z.nullable(z.string()),
|
|
1738
1742
|
image: z.nullable(z.string()),
|
|
1739
1743
|
video: z.nullable(z.string()),
|
|
1740
|
-
rewrite: z.boolean(),
|
|
1741
|
-
doIndex: z.boolean(),
|
|
1744
|
+
rewrite: z.boolean().default(false),
|
|
1745
|
+
doIndex: z.boolean().default(false),
|
|
1742
1746
|
ios: z.nullable(z.string()),
|
|
1743
1747
|
android: z.nullable(z.string()),
|
|
1744
1748
|
geo: z.nullable(z.lazy(() => Geo$inboundSchema)),
|
|
1745
|
-
publicStats: z.boolean(),
|
|
1749
|
+
publicStats: z.boolean().default(false),
|
|
1746
1750
|
tagId: z.nullable(z.string()),
|
|
1747
1751
|
tags: z.nullable(z.array(TagSchema$inboundSchema)),
|
|
1748
1752
|
comments: z.nullable(z.string()),
|
|
@@ -1759,6 +1763,7 @@ export const LinkSchema$inboundSchema: z.ZodType<LinkSchema, z.ZodTypeDef, unkno
|
|
|
1759
1763
|
lastClicked: z.nullable(z.string()),
|
|
1760
1764
|
leads: z.number().default(0),
|
|
1761
1765
|
sales: z.number().default(0),
|
|
1766
|
+
saleAmount: z.number().default(0),
|
|
1762
1767
|
createdAt: z.string(),
|
|
1763
1768
|
updatedAt: z.string(),
|
|
1764
1769
|
projectId: z.string(),
|
|
@@ -1812,6 +1817,7 @@ export type LinkSchema$Outbound = {
|
|
|
1812
1817
|
lastClicked: string | null;
|
|
1813
1818
|
leads: number;
|
|
1814
1819
|
sales: number;
|
|
1820
|
+
saleAmount: number;
|
|
1815
1821
|
createdAt: string;
|
|
1816
1822
|
updatedAt: string;
|
|
1817
1823
|
projectId: string;
|
|
@@ -1857,6 +1863,7 @@ export const LinkSchema$outboundSchema: z.ZodType<LinkSchema$Outbound, z.ZodType
|
|
|
1857
1863
|
lastClicked: z.nullable(z.string()),
|
|
1858
1864
|
leads: z.number().default(0),
|
|
1859
1865
|
sales: z.number().default(0),
|
|
1866
|
+
saleAmount: z.number().default(0),
|
|
1860
1867
|
createdAt: z.string(),
|
|
1861
1868
|
updatedAt: z.string(),
|
|
1862
1869
|
projectId: z.string(),
|