dub 0.30.3 → 0.31.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.
- package/README.md +3 -2
- package/docs/sdks/domains/README.md +0 -105
- package/docs/sdks/links/README.md +56 -0
- package/docs/sdks/tags/README.md +54 -3
- package/docs/sdks/workspaces/README.md +53 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/operations/bulkupdatelinks.d.ts +147 -0
- package/models/operations/bulkupdatelinks.d.ts.map +1 -0
- package/models/operations/bulkupdatelinks.js +107 -0
- package/models/operations/bulkupdatelinks.js.map +1 -0
- package/models/operations/createtag.d.ts +9 -2
- package/models/operations/createtag.d.ts.map +1 -1
- package/models/operations/createtag.js +4 -2
- package/models/operations/createtag.js.map +1 -1
- package/models/operations/index.d.ts +3 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/updatetag.d.ts +85 -0
- package/models/operations/updatetag.d.ts.map +1 -0
- package/models/operations/updatetag.js +100 -0
- package/models/operations/updatetag.js.map +1 -0
- package/models/operations/updateworkspace.d.ts +16 -0
- package/models/operations/updateworkspace.d.ts.map +1 -0
- package/models/operations/{setprimarydomain.js → updateworkspace.js} +9 -21
- package/models/operations/updateworkspace.js.map +1 -0
- package/package.json +2 -2
- package/sdk/domains.d.ts +0 -14
- package/sdk/domains.d.ts.map +1 -1
- package/sdk/domains.js +0 -166
- package/sdk/domains.js.map +1 -1
- package/sdk/links.d.ts +7 -0
- package/sdk/links.d.ts.map +1 -1
- package/sdk/links.js +75 -0
- package/sdk/links.js.map +1 -1
- package/sdk/tags.d.ts +7 -0
- package/sdk/tags.d.ts.map +1 -1
- package/sdk/tags.js +81 -0
- package/sdk/tags.js.map +1 -1
- package/sdk/workspaces.d.ts +7 -0
- package/sdk/workspaces.d.ts.map +1 -1
- package/sdk/workspaces.js +80 -0
- package/sdk/workspaces.js.map +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/operations/bulkupdatelinks.ts +222 -0
- package/src/models/operations/createtag.ts +13 -4
- package/src/models/operations/index.ts +3 -2
- package/src/models/operations/updatetag.ts +138 -0
- package/src/models/operations/updateworkspace.ts +30 -0
- package/src/sdk/domains.ts +0 -202
- package/src/sdk/links.ts +96 -0
- package/src/sdk/tags.ts +101 -0
- package/src/sdk/workspaces.ts +99 -0
- package/models/operations/setprimarydomain.d.ts +0 -35
- package/models/operations/setprimarydomain.d.ts.map +0 -1
- package/models/operations/setprimarydomain.js.map +0 -1
- package/models/operations/transferdomain.d.ts +0 -51
- package/models/operations/transferdomain.d.ts.map +0 -1
- package/models/operations/transferdomain.js +0 -78
- package/models/operations/transferdomain.js.map +0 -1
- package/src/models/operations/setprimarydomain.ts +0 -60
- package/src/models/operations/transferdomain.ts +0 -98
package/README.md
CHANGED
|
@@ -108,6 +108,7 @@ run();
|
|
|
108
108
|
* [delete](docs/sdks/links/README.md#delete) - Delete a link
|
|
109
109
|
* [update](docs/sdks/links/README.md#update) - Update a link
|
|
110
110
|
* [createMany](docs/sdks/links/README.md#createmany) - Bulk create links
|
|
111
|
+
* [updateMany](docs/sdks/links/README.md#updatemany) - Bulk update links
|
|
111
112
|
* [upsert](docs/sdks/links/README.md#upsert) - Upsert a link
|
|
112
113
|
|
|
113
114
|
### [qrCodes](docs/sdks/qrcodes/README.md)
|
|
@@ -121,11 +122,13 @@ run();
|
|
|
121
122
|
### [workspaces](docs/sdks/workspaces/README.md)
|
|
122
123
|
|
|
123
124
|
* [get](docs/sdks/workspaces/README.md#get) - Retrieve a workspace
|
|
125
|
+
* [update](docs/sdks/workspaces/README.md#update) - Update a workspace
|
|
124
126
|
|
|
125
127
|
### [tags](docs/sdks/tags/README.md)
|
|
126
128
|
|
|
127
129
|
* [list](docs/sdks/tags/README.md#list) - Retrieve a list of tags
|
|
128
130
|
* [create](docs/sdks/tags/README.md#create) - Create a new tag
|
|
131
|
+
* [update](docs/sdks/tags/README.md#update) - Update a tag
|
|
129
132
|
|
|
130
133
|
### [domains](docs/sdks/domains/README.md)
|
|
131
134
|
|
|
@@ -133,8 +136,6 @@ run();
|
|
|
133
136
|
* [create](docs/sdks/domains/README.md#create) - Create a domain
|
|
134
137
|
* [delete](docs/sdks/domains/README.md#delete) - Delete a domain
|
|
135
138
|
* [update](docs/sdks/domains/README.md#update) - Update a domain
|
|
136
|
-
* [setPrimary](docs/sdks/domains/README.md#setprimary) - Set a domain as primary
|
|
137
|
-
* [transfer](docs/sdks/domains/README.md#transfer) - Transfer a domain
|
|
138
139
|
|
|
139
140
|
### [track](docs/sdks/track/README.md)
|
|
140
141
|
|
|
@@ -7,8 +7,6 @@
|
|
|
7
7
|
* [create](#create) - Create a domain
|
|
8
8
|
* [delete](#delete) - Delete a domain
|
|
9
9
|
* [update](#update) - Update a domain
|
|
10
|
-
* [setPrimary](#setprimary) - Set a domain as primary
|
|
11
|
-
* [transfer](#transfer) - Transfer a domain
|
|
12
10
|
|
|
13
11
|
## list
|
|
14
12
|
|
|
@@ -195,109 +193,6 @@ run();
|
|
|
195
193
|
| `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. | |
|
|
196
194
|
|
|
197
195
|
|
|
198
|
-
### Response
|
|
199
|
-
|
|
200
|
-
**Promise\<[components.DomainSchema](../../models/components/domainschema.md)\>**
|
|
201
|
-
### Errors
|
|
202
|
-
|
|
203
|
-
| Error Object | Status Code | Content Type |
|
|
204
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
205
|
-
| errors.BadRequest | 400 | application/json |
|
|
206
|
-
| errors.Unauthorized | 401 | application/json |
|
|
207
|
-
| errors.Forbidden | 403 | application/json |
|
|
208
|
-
| errors.NotFound | 404 | application/json |
|
|
209
|
-
| errors.Conflict | 409 | application/json |
|
|
210
|
-
| errors.InviteExpired | 410 | application/json |
|
|
211
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
212
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
213
|
-
| errors.InternalServerError | 500 | application/json |
|
|
214
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
215
|
-
|
|
216
|
-
## setPrimary
|
|
217
|
-
|
|
218
|
-
Set a domain as primary for the authenticated workspace.
|
|
219
|
-
|
|
220
|
-
### Example Usage
|
|
221
|
-
|
|
222
|
-
```typescript
|
|
223
|
-
import { Dub } from "dub";
|
|
224
|
-
|
|
225
|
-
const dub = new Dub({
|
|
226
|
-
token: "DUB_API_KEY",
|
|
227
|
-
});
|
|
228
|
-
|
|
229
|
-
async function run() {
|
|
230
|
-
const result = await dub.domains.setPrimary("acme.com");
|
|
231
|
-
|
|
232
|
-
// Handle the result
|
|
233
|
-
console.log(result)
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
run();
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
### Parameters
|
|
240
|
-
|
|
241
|
-
| Parameter | Type | Required | Description | Example |
|
|
242
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
243
|
-
| `slug` | *string* | :heavy_check_mark: | The domain name. | [object Object] |
|
|
244
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
245
|
-
| `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. | |
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
### Response
|
|
249
|
-
|
|
250
|
-
**Promise\<[components.DomainSchema](../../models/components/domainschema.md)\>**
|
|
251
|
-
### Errors
|
|
252
|
-
|
|
253
|
-
| Error Object | Status Code | Content Type |
|
|
254
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
255
|
-
| errors.BadRequest | 400 | application/json |
|
|
256
|
-
| errors.Unauthorized | 401 | application/json |
|
|
257
|
-
| errors.Forbidden | 403 | application/json |
|
|
258
|
-
| errors.NotFound | 404 | application/json |
|
|
259
|
-
| errors.Conflict | 409 | application/json |
|
|
260
|
-
| errors.InviteExpired | 410 | application/json |
|
|
261
|
-
| errors.UnprocessableEntity | 422 | application/json |
|
|
262
|
-
| errors.RateLimitExceeded | 429 | application/json |
|
|
263
|
-
| errors.InternalServerError | 500 | application/json |
|
|
264
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
265
|
-
|
|
266
|
-
## transfer
|
|
267
|
-
|
|
268
|
-
Transfer a domain to another workspace within the authenticated account.
|
|
269
|
-
|
|
270
|
-
### Example Usage
|
|
271
|
-
|
|
272
|
-
```typescript
|
|
273
|
-
import { Dub } from "dub";
|
|
274
|
-
|
|
275
|
-
const dub = new Dub({
|
|
276
|
-
token: "DUB_API_KEY",
|
|
277
|
-
});
|
|
278
|
-
|
|
279
|
-
async function run() {
|
|
280
|
-
const result = await dub.domains.transfer("acme.com", {
|
|
281
|
-
newWorkspaceId: "<value>",
|
|
282
|
-
});
|
|
283
|
-
|
|
284
|
-
// Handle the result
|
|
285
|
-
console.log(result)
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
run();
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
### Parameters
|
|
292
|
-
|
|
293
|
-
| Parameter | Type | Required | Description | Example |
|
|
294
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
295
|
-
| `slug` | *string* | :heavy_check_mark: | The domain name. | [object Object] |
|
|
296
|
-
| `requestBody` | [operations.TransferDomainRequestBody](../../models/operations/transferdomainrequestbody.md) | :heavy_minus_sign: | N/A | |
|
|
297
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
|
|
298
|
-
| `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. | |
|
|
299
|
-
|
|
300
|
-
|
|
301
196
|
### Response
|
|
302
197
|
|
|
303
198
|
**Promise\<[components.DomainSchema](../../models/components/domainschema.md)\>**
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* [delete](#delete) - Delete a link
|
|
11
11
|
* [update](#update) - Update a link
|
|
12
12
|
* [createMany](#createmany) - Bulk create links
|
|
13
|
+
* [updateMany](#updatemany) - Bulk update links
|
|
13
14
|
* [upsert](#upsert) - Upsert a link
|
|
14
15
|
|
|
15
16
|
## list
|
|
@@ -353,6 +354,61 @@ run();
|
|
|
353
354
|
| `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. |
|
|
354
355
|
|
|
355
356
|
|
|
357
|
+
### Response
|
|
358
|
+
|
|
359
|
+
**Promise\<[components.LinkSchema[]](../../models/.md)\>**
|
|
360
|
+
### Errors
|
|
361
|
+
|
|
362
|
+
| Error Object | Status Code | Content Type |
|
|
363
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
364
|
+
| errors.BadRequest | 400 | application/json |
|
|
365
|
+
| errors.Unauthorized | 401 | application/json |
|
|
366
|
+
| errors.Forbidden | 403 | application/json |
|
|
367
|
+
| errors.NotFound | 404 | application/json |
|
|
368
|
+
| errors.Conflict | 409 | application/json |
|
|
369
|
+
| errors.InviteExpired | 410 | application/json |
|
|
370
|
+
| errors.UnprocessableEntity | 422 | application/json |
|
|
371
|
+
| errors.RateLimitExceeded | 429 | application/json |
|
|
372
|
+
| errors.InternalServerError | 500 | application/json |
|
|
373
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
374
|
+
|
|
375
|
+
## updateMany
|
|
376
|
+
|
|
377
|
+
Bulk update up to 100 links with the same data for the authenticated workspace.
|
|
378
|
+
|
|
379
|
+
### Example Usage
|
|
380
|
+
|
|
381
|
+
```typescript
|
|
382
|
+
import { Dub } from "dub";
|
|
383
|
+
|
|
384
|
+
const dub = new Dub({
|
|
385
|
+
token: "DUB_API_KEY",
|
|
386
|
+
});
|
|
387
|
+
|
|
388
|
+
async function run() {
|
|
389
|
+
const result = await dub.links.updateMany({
|
|
390
|
+
linkIds: [
|
|
391
|
+
"<value>",
|
|
392
|
+
],
|
|
393
|
+
data: {},
|
|
394
|
+
});
|
|
395
|
+
|
|
396
|
+
// Handle the result
|
|
397
|
+
console.log(result)
|
|
398
|
+
}
|
|
399
|
+
|
|
400
|
+
run();
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### Parameters
|
|
404
|
+
|
|
405
|
+
| Parameter | Type | Required | Description |
|
|
406
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
407
|
+
| `request` | [operations.BulkUpdateLinksRequestBody](../../models/operations/bulkupdatelinksrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
408
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
409
|
+
| `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. |
|
|
410
|
+
|
|
411
|
+
|
|
356
412
|
### Response
|
|
357
413
|
|
|
358
414
|
**Promise\<[components.LinkSchema[]](../../models/.md)\>**
|
package/docs/sdks/tags/README.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
* [list](#list) - Retrieve a list of tags
|
|
7
7
|
* [create](#create) - Create a new tag
|
|
8
|
+
* [update](#update) - Update a tag
|
|
8
9
|
|
|
9
10
|
## list
|
|
10
11
|
|
|
@@ -70,9 +71,7 @@ const dub = new Dub({
|
|
|
70
71
|
});
|
|
71
72
|
|
|
72
73
|
async function run() {
|
|
73
|
-
const result = await dub.tags.create({
|
|
74
|
-
tag: "<value>",
|
|
75
|
-
});
|
|
74
|
+
const result = await dub.tags.create({});
|
|
76
75
|
|
|
77
76
|
// Handle the result
|
|
78
77
|
console.log(result)
|
|
@@ -90,6 +89,58 @@ run();
|
|
|
90
89
|
| `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. |
|
|
91
90
|
|
|
92
91
|
|
|
92
|
+
### Response
|
|
93
|
+
|
|
94
|
+
**Promise\<[components.TagSchema](../../models/components/tagschema.md)\>**
|
|
95
|
+
### Errors
|
|
96
|
+
|
|
97
|
+
| Error Object | Status Code | Content Type |
|
|
98
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
99
|
+
| errors.BadRequest | 400 | application/json |
|
|
100
|
+
| errors.Unauthorized | 401 | application/json |
|
|
101
|
+
| errors.Forbidden | 403 | application/json |
|
|
102
|
+
| errors.NotFound | 404 | application/json |
|
|
103
|
+
| errors.Conflict | 409 | application/json |
|
|
104
|
+
| errors.InviteExpired | 410 | application/json |
|
|
105
|
+
| errors.UnprocessableEntity | 422 | application/json |
|
|
106
|
+
| errors.RateLimitExceeded | 429 | application/json |
|
|
107
|
+
| errors.InternalServerError | 500 | application/json |
|
|
108
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
109
|
+
|
|
110
|
+
## update
|
|
111
|
+
|
|
112
|
+
Update a tag in the workspace.
|
|
113
|
+
|
|
114
|
+
### Example Usage
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
import { Dub } from "dub";
|
|
118
|
+
|
|
119
|
+
const dub = new Dub({
|
|
120
|
+
token: "DUB_API_KEY",
|
|
121
|
+
});
|
|
122
|
+
|
|
123
|
+
async function run() {
|
|
124
|
+
const result = await dub.tags.update({
|
|
125
|
+
id: "<id>",
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
// Handle the result
|
|
129
|
+
console.log(result)
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
run();
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
| Parameter | Type | Required | Description |
|
|
138
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
139
|
+
| `request` | [operations.UpdateTagRequest](../../models/operations/updatetagrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
140
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
141
|
+
| `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. |
|
|
142
|
+
|
|
143
|
+
|
|
93
144
|
### Response
|
|
94
145
|
|
|
95
146
|
**Promise\<[components.TagSchema](../../models/components/tagschema.md)\>**
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
### Available Operations
|
|
5
5
|
|
|
6
6
|
* [get](#get) - Retrieve a workspace
|
|
7
|
+
* [update](#update) - Update a workspace
|
|
7
8
|
|
|
8
9
|
## get
|
|
9
10
|
|
|
@@ -39,6 +40,58 @@ run();
|
|
|
39
40
|
| `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. |
|
|
40
41
|
|
|
41
42
|
|
|
43
|
+
### Response
|
|
44
|
+
|
|
45
|
+
**Promise\<[components.WorkspaceSchema](../../models/components/workspaceschema.md)\>**
|
|
46
|
+
### Errors
|
|
47
|
+
|
|
48
|
+
| Error Object | Status Code | Content Type |
|
|
49
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
50
|
+
| errors.BadRequest | 400 | application/json |
|
|
51
|
+
| errors.Unauthorized | 401 | application/json |
|
|
52
|
+
| errors.Forbidden | 403 | application/json |
|
|
53
|
+
| errors.NotFound | 404 | application/json |
|
|
54
|
+
| errors.Conflict | 409 | application/json |
|
|
55
|
+
| errors.InviteExpired | 410 | application/json |
|
|
56
|
+
| errors.UnprocessableEntity | 422 | application/json |
|
|
57
|
+
| errors.RateLimitExceeded | 429 | application/json |
|
|
58
|
+
| errors.InternalServerError | 500 | application/json |
|
|
59
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
60
|
+
|
|
61
|
+
## update
|
|
62
|
+
|
|
63
|
+
Update a workspace by ID or slug.
|
|
64
|
+
|
|
65
|
+
### Example Usage
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
import { Dub } from "dub";
|
|
69
|
+
|
|
70
|
+
const dub = new Dub({
|
|
71
|
+
token: "DUB_API_KEY",
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
async function run() {
|
|
75
|
+
const result = await dub.workspaces.update({
|
|
76
|
+
idOrSlug: "<value>",
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
// Handle the result
|
|
80
|
+
console.log(result)
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
run();
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Parameters
|
|
87
|
+
|
|
88
|
+
| Parameter | Type | Required | Description |
|
|
89
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
90
|
+
| `request` | [operations.UpdateWorkspaceRequest](../../models/operations/updateworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
91
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
92
|
+
| `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. |
|
|
93
|
+
|
|
94
|
+
|
|
42
95
|
### Response
|
|
43
96
|
|
|
44
97
|
**Promise\<[components.WorkspaceSchema](../../models/components/workspaceschema.md)\>**
|
package/lib/config.d.ts
CHANGED
|
@@ -32,8 +32,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
32
32
|
export declare const SDK_METADATA: {
|
|
33
33
|
readonly language: "typescript";
|
|
34
34
|
readonly openapiDocVersion: "0.0.1";
|
|
35
|
-
readonly sdkVersion: "0.
|
|
36
|
-
readonly genVersion: "2.
|
|
37
|
-
readonly userAgent: "speakeasy-sdk/typescript 0.
|
|
35
|
+
readonly sdkVersion: "0.31.0";
|
|
36
|
+
readonly genVersion: "2.359.0";
|
|
37
|
+
readonly userAgent: "speakeasy-sdk/typescript 0.31.0 2.359.0 0.0.1 dub";
|
|
38
38
|
};
|
|
39
39
|
//# sourceMappingURL=config.d.ts.map
|
package/lib/config.js
CHANGED
|
@@ -32,8 +32,8 @@ exports.serverURLFromOptions = serverURLFromOptions;
|
|
|
32
32
|
exports.SDK_METADATA = {
|
|
33
33
|
language: "typescript",
|
|
34
34
|
openapiDocVersion: "0.0.1",
|
|
35
|
-
sdkVersion: "0.
|
|
36
|
-
genVersion: "2.
|
|
37
|
-
userAgent: "speakeasy-sdk/typescript 0.
|
|
35
|
+
sdkVersion: "0.31.0",
|
|
36
|
+
genVersion: "2.359.0",
|
|
37
|
+
userAgent: "speakeasy-sdk/typescript 0.31.0 2.359.0 0.0.1 dub",
|
|
38
38
|
};
|
|
39
39
|
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import * as components from "../components/index.js";
|
|
2
|
+
import * as z from "zod";
|
|
3
|
+
/**
|
|
4
|
+
* The unique IDs of the tags assigned to the short link.
|
|
5
|
+
*/
|
|
6
|
+
export type BulkUpdateLinksTagIds = string | Array<string>;
|
|
7
|
+
/**
|
|
8
|
+
* The unique name of the tags assigned to the short link (case insensitive).
|
|
9
|
+
*/
|
|
10
|
+
export type BulkUpdateLinksTagNames = string | Array<string>;
|
|
11
|
+
export type Data = {
|
|
12
|
+
/**
|
|
13
|
+
* The destination URL of the short link.
|
|
14
|
+
*/
|
|
15
|
+
url?: string | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* Whether to track conversions for the short link.
|
|
18
|
+
*/
|
|
19
|
+
trackConversion?: boolean | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* Whether the short link is archived.
|
|
22
|
+
*/
|
|
23
|
+
archived?: boolean | undefined;
|
|
24
|
+
/**
|
|
25
|
+
* Whether the short link's stats are publicly accessible.
|
|
26
|
+
*/
|
|
27
|
+
publicStats?: boolean | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
|
30
|
+
*
|
|
31
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
32
|
+
*/
|
|
33
|
+
tagId?: string | null | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* The unique IDs of the tags assigned to the short link.
|
|
36
|
+
*/
|
|
37
|
+
tagIds?: string | Array<string> | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* The unique name of the tags assigned to the short link (case insensitive).
|
|
40
|
+
*/
|
|
41
|
+
tagNames?: string | Array<string> | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* The comments for the short link.
|
|
44
|
+
*/
|
|
45
|
+
comments?: string | null | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* The date and time when the short link will expire at.
|
|
48
|
+
*/
|
|
49
|
+
expiresAt?: string | null | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* The URL to redirect to when the short link has expired.
|
|
52
|
+
*/
|
|
53
|
+
expiredUrl?: string | null | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* The password required to access the destination URL of the short link.
|
|
56
|
+
*/
|
|
57
|
+
password?: string | null | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Whether the short link uses Custom Social Media Cards feature.
|
|
60
|
+
*/
|
|
61
|
+
proxy?: boolean | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
|
64
|
+
*/
|
|
65
|
+
title?: string | null | undefined;
|
|
66
|
+
/**
|
|
67
|
+
* The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
|
68
|
+
*/
|
|
69
|
+
description?: string | null | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
|
72
|
+
*/
|
|
73
|
+
image?: string | null | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* Whether the short link uses link cloaking.
|
|
76
|
+
*/
|
|
77
|
+
rewrite?: boolean | undefined;
|
|
78
|
+
/**
|
|
79
|
+
* The iOS destination URL for the short link for iOS device targeting.
|
|
80
|
+
*/
|
|
81
|
+
ios?: string | null | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* The Android destination URL for the short link for Android device targeting.
|
|
84
|
+
*/
|
|
85
|
+
android?: string | null | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
|
88
|
+
*/
|
|
89
|
+
geo?: components.LinkGeoTargeting | null | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
|
92
|
+
*/
|
|
93
|
+
doIndex?: boolean | undefined;
|
|
94
|
+
};
|
|
95
|
+
export type BulkUpdateLinksRequestBody = {
|
|
96
|
+
linkIds: Array<string>;
|
|
97
|
+
data: Data;
|
|
98
|
+
};
|
|
99
|
+
/** @internal */
|
|
100
|
+
export declare namespace BulkUpdateLinksTagIds$ {
|
|
101
|
+
const inboundSchema: z.ZodType<BulkUpdateLinksTagIds, z.ZodTypeDef, unknown>;
|
|
102
|
+
type Outbound = string | Array<string>;
|
|
103
|
+
const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, BulkUpdateLinksTagIds>;
|
|
104
|
+
}
|
|
105
|
+
/** @internal */
|
|
106
|
+
export declare namespace BulkUpdateLinksTagNames$ {
|
|
107
|
+
const inboundSchema: z.ZodType<BulkUpdateLinksTagNames, z.ZodTypeDef, unknown>;
|
|
108
|
+
type Outbound = string | Array<string>;
|
|
109
|
+
const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, BulkUpdateLinksTagNames>;
|
|
110
|
+
}
|
|
111
|
+
/** @internal */
|
|
112
|
+
export declare namespace Data$ {
|
|
113
|
+
const inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown>;
|
|
114
|
+
type Outbound = {
|
|
115
|
+
url?: string | undefined;
|
|
116
|
+
trackConversion: boolean;
|
|
117
|
+
archived: boolean;
|
|
118
|
+
publicStats: boolean;
|
|
119
|
+
tagId?: string | null | undefined;
|
|
120
|
+
tagIds?: string | Array<string> | undefined;
|
|
121
|
+
tagNames?: string | Array<string> | undefined;
|
|
122
|
+
comments?: string | null | undefined;
|
|
123
|
+
expiresAt?: string | null | undefined;
|
|
124
|
+
expiredUrl?: string | null | undefined;
|
|
125
|
+
password?: string | null | undefined;
|
|
126
|
+
proxy: boolean;
|
|
127
|
+
title?: string | null | undefined;
|
|
128
|
+
description?: string | null | undefined;
|
|
129
|
+
image?: string | null | undefined;
|
|
130
|
+
rewrite: boolean;
|
|
131
|
+
ios?: string | null | undefined;
|
|
132
|
+
android?: string | null | undefined;
|
|
133
|
+
geo?: components.LinkGeoTargeting$.Outbound | null | undefined;
|
|
134
|
+
doIndex: boolean;
|
|
135
|
+
};
|
|
136
|
+
const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Data>;
|
|
137
|
+
}
|
|
138
|
+
/** @internal */
|
|
139
|
+
export declare namespace BulkUpdateLinksRequestBody$ {
|
|
140
|
+
const inboundSchema: z.ZodType<BulkUpdateLinksRequestBody, z.ZodTypeDef, unknown>;
|
|
141
|
+
type Outbound = {
|
|
142
|
+
linkIds: Array<string>;
|
|
143
|
+
data: Data$.Outbound;
|
|
144
|
+
};
|
|
145
|
+
const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, BulkUpdateLinksRequestBody>;
|
|
146
|
+
}
|
|
147
|
+
//# sourceMappingURL=bulkupdatelinks.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bulkupdatelinks.d.ts","sourceRoot":"","sources":["../../src/models/operations/bulkupdatelinks.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,MAAM,IAAI,GAAG;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAClC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,GAAG,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC;IACrD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACrC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,gBAAgB;AAChB,yBAAiB,sBAAsB,CAAC;IAC7B,MAAM,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAGhF,CAAC;IAEH,KAAY,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE,qBAAqB,CAEnF,CAAC;CACL;AAED,gBAAgB;AAChB,yBAAiB,wBAAwB,CAAC;IAC/B,MAAM,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAEnF,CAAC;IAEF,KAAY,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE,uBAAuB,CACxC,CAAC;CAClD;AAED,gBAAgB;AAChB,yBAAiB,KAAK,CAAC;IACZ,MAAM,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAqB/D,CAAC;IAEH,KAAY,QAAQ,GAAG;QACnB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACzB,eAAe,EAAE,OAAO,CAAC;QACzB,QAAQ,EAAE,OAAO,CAAC;QAClB,WAAW,EAAE,OAAO,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAClC,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QAC5C,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QAC9C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACrC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACtC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACvC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACrC,KAAK,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAClC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACxC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAClC,OAAO,EAAE,OAAO,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QACpC,GAAG,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,QAAQ,GAAG,IAAI,GAAG,SAAS,CAAC;QAC/D,OAAO,EAAE,OAAO,CAAC;KACpB,CAAC;IAEK,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE,IAAI,CAqBjE,CAAC;CACN;AAED,gBAAgB;AAChB,yBAAiB,2BAA2B,CAAC;IAClC,MAAM,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAIjF,CAAC;IAEP,KAAY,QAAQ,GAAG;QACnB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvB,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC;KACxB,CAAC;IAEK,MAAM,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,EAAE,0BAA0B,CAInF,CAAC;CACV"}
|