LukeParke/dub-node
1
0
Fork 0
mirror of https://github.com/LukeHagar/dub-node.git synced 2025-12-06 12:27:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #71 from dubinc/speakeasy-sdk-regen-1712829216

Browse Source 
chore: 🐝 Update SDK - Generate
This commit is contained in:
Steven Tey
2024-04-11 03:56:18 -07:00
committed by GitHub
parent cf588faff4 17fb80f60f
commit a977c86652
66 changed files with 1476 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
.speakeasy/gen.lock
View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0
id: f28179cc-ef59-426d-9e85-60cec22fc642
management:
docChecksum: 3ef41873dee5fcca0b0407f423aa20bf
docChecksum: f8ac17a98fb5def350bdc78e5e3d074a
docVersion: 0.0.1
speakeasyVersion: 1.246.1
generationVersion: 2.302.1
releaseVersion: 0.20.3
configChecksum: f00e14281ccef6d45ad59080cff52693
releaseVersion: 0.21.0
configChecksum: 820075540fd62258f8b88385064cd939
repoURL: https://github.com/dubinc/dub-node.git
installationURL: https://github.com/dubinc/dub-node
published: true
@@ -21,6 +21,7 @@ features:
globalServerURLs: 2.82.4
globals: 2.82.1
hiddenGlobals: 0.1.0
methodSecurity: 2.82.4
nameOverrides: 2.81.2
responseFormat: 0.2.3
unions: 2.85.3
@@ -83,6 +84,7 @@ generatedFiles:
- src/models/operations/getrefereranalytics.ts
- src/models/operations/gettoplinks.ts
- src/models/operations/gettopurls.ts
- src/models/operations/getworkspaces.ts
- src/models/operations/createworkspace.ts
- src/models/operations/getworkspace.ts
- src/models/operations/gettags.ts
@@ -126,70 +128,93 @@ generatedFiles:
- docs/models/errors/internalservererrorcode.md
- docs/models/errors/internalservererrorerror.md
- docs/models/errors/internalservererror.md
- docs/models/operations/getlinkssecurity.md
- docs/models/operations/queryparamtagids.md
- docs/models/operations/sort.md
- docs/models/operations/getlinksrequest.md
- docs/models/operations/createlinksecurity.md
- docs/models/operations/tagids.md
- docs/models/operations/createlinkrequestbody.md
- docs/models/operations/getlinkscountsecurity.md
- docs/models/operations/getlinkscountqueryparamtagids.md
- docs/models/operations/two.md
- docs/models/operations/one.md
- docs/models/operations/groupby.md
- docs/models/operations/getlinkscountrequest.md
- docs/models/operations/getlinkinfosecurity.md
- docs/models/operations/getlinkinforequest.md
- docs/models/operations/editlinksecurity.md
- docs/models/operations/editlinktagids.md
- docs/models/operations/editlinkrequestbody.md
- docs/models/operations/editlinkrequest.md
- docs/models/operations/deletelinksecurity.md
- docs/models/operations/deletelinkrequest.md
- docs/models/operations/deletelinkresponsebody.md
- docs/models/operations/bulkcreatelinkssecurity.md
- docs/models/operations/bulkcreatelinkstagids.md
- docs/models/operations/requestbody.md
- docs/models/operations/getqrcodesecurity.md
- docs/models/operations/level.md
- docs/models/operations/getqrcoderequest.md
- docs/models/operations/getclicksanalyticssecurity.md
- docs/models/operations/interval.md
- docs/models/operations/country.md
- docs/models/operations/getclicksanalyticsrequest.md
- docs/models/operations/gettimeseriesanalyticssecurity.md
- docs/models/operations/queryparaminterval.md
- docs/models/operations/queryparamcountry.md
- docs/models/operations/gettimeseriesanalyticsrequest.md
- docs/models/operations/responsebody.md
- docs/models/operations/getcountryanalyticssecurity.md
- docs/models/operations/getcountryanalyticsqueryparaminterval.md
- docs/models/operations/getcountryanalyticsqueryparamcountry.md
- docs/models/operations/getcountryanalyticsrequest.md
- docs/models/operations/getcountryanalyticscountry.md
- docs/models/operations/getcountryanalyticsresponsebody.md
- docs/models/operations/getcityanalyticssecurity.md
- docs/models/operations/getcityanalyticsqueryparaminterval.md
- docs/models/operations/getcityanalyticsqueryparamcountry.md
- docs/models/operations/getcityanalyticsrequest.md
- docs/models/operations/getcityanalyticscountry.md
- docs/models/operations/getcityanalyticsresponsebody.md
- docs/models/operations/getdeviceanalyticssecurity.md
- docs/models/operations/getdeviceanalyticsqueryparaminterval.md
- docs/models/operations/getdeviceanalyticsqueryparamcountry.md
- docs/models/operations/getdeviceanalyticsrequest.md
- docs/models/operations/getdeviceanalyticsresponsebody.md
- docs/models/operations/getbrowseranalyticssecurity.md
- docs/models/operations/getbrowseranalyticsqueryparaminterval.md
- docs/models/operations/getbrowseranalyticsqueryparamcountry.md
- docs/models/operations/getbrowseranalyticsrequest.md
- docs/models/operations/getbrowseranalyticsresponsebody.md
- docs/models/operations/getosanalyticssecurity.md
- docs/models/operations/getosanalyticsqueryparaminterval.md
- docs/models/operations/getosanalyticsqueryparamcountry.md
- docs/models/operations/getosanalyticsrequest.md
- docs/models/operations/getosanalyticsresponsebody.md
- docs/models/operations/getrefereranalyticssecurity.md
- docs/models/operations/getrefereranalyticsqueryparaminterval.md
- docs/models/operations/getrefereranalyticsqueryparamcountry.md
- docs/models/operations/getrefereranalyticsrequest.md
- docs/models/operations/getrefereranalyticsresponsebody.md
- docs/models/operations/gettoplinkssecurity.md
- docs/models/operations/gettoplinksqueryparaminterval.md
- docs/models/operations/gettoplinksqueryparamcountry.md
- docs/models/operations/gettoplinksrequest.md
- docs/models/operations/gettoplinksresponsebody.md
- docs/models/operations/gettopurlssecurity.md
- docs/models/operations/gettopurlsqueryparaminterval.md
- docs/models/operations/gettopurlsqueryparamcountry.md
- docs/models/operations/gettopurlsrequest.md
- docs/models/operations/gettopurlsresponsebody.md
- docs/models/operations/getworkspacessecurity.md
- docs/models/operations/createworkspacesecurity.md
- docs/models/operations/createworkspacerequestbody.md
- docs/models/operations/getworkspacesecurity.md
- docs/models/operations/getworkspacerequest.md
- docs/models/operations/gettagssecurity.md
- docs/models/operations/gettagsrequest.md
- docs/models/operations/createtagsecurity.md
- docs/models/operations/color.md
- docs/models/operations/createtagrequestbody.md
- docs/sdks/dub/README.md

2
.speakeasy/gen.yaml
View File

@@ -12,7 +12,7 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
typescript:
version: 0.20.3
version: 0.21.0
additionalDependencies:
dependencies: {}
devDependencies:

65
README.md
View File

@@ -39,14 +39,18 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.links.list({
tagIds: ["<value>"],
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
// Handle the result
console.log(result);
@@ -126,16 +130,20 @@ import * as errors from "dub/models/errors";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
let result;
try {
result = await sdk.links.list({
tagIds: ["<value>"],
});
result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
} catch (err) {
switch (true) {
case err instanceof errors.SDKValidationError: {
@@ -213,14 +221,18 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
serverIdx: 0,
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.links.list({
tagIds: ["<value>"],
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
// Handle the result
console.log(result);
@@ -241,14 +253,18 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
serverURL: "https://api.dub.co",
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.links.list({
tagIds: ["<value>"],
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
// Handle the result
console.log(result);
@@ -320,19 +336,28 @@ This SDK supports the following security scheme globally:
| `token` | http | HTTP Bearer |
To authenticate with the API the `token` parameter must be set when initializing the SDK client instance. For example:
### Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
```typescript
import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.links.list({
tagIds: ["<value>"],
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
// Handle the result
console.log(result);

12
RELEASES.md
View File

@@ -36,4 +36,14 @@ Based on:
### Generated
- [typescript v0.20.3] .
### Releases
- [NPM v0.20.3] https://www.npmjs.com/package/dub/v/0.20.3 - .
- [NPM v0.20.3] https://www.npmjs.com/package/dub/v/0.20.3 - .
## 2024-04-11 09:53:32
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.246.1 (2.302.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.21.0] .
### Releases
- [NPM v0.21.0] https://www.npmjs.com/package/dub/v/0.21.0 - .

12
USAGE.md
View File

@@ -4,14 +4,18 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.links.list({
tagIds: ["<value>"],
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list(
{
tagIds: ["<value>"],
},
operationSecurity
);
// Handle the result
console.log(result);

8
docs/models/operations/bulkcreatelinkssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# BulkCreateLinksSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/createlinksecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateLinkSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/createtagsecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateTagSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/createworkspacesecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# CreateWorkspaceSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/deletelinksecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# DeleteLinkSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/editlinksecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# EditLinkSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getbrowseranalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetBrowserAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getcityanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetCityAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getclicksanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetClicksAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getcountryanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetCountryAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getdeviceanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetDeviceAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getlinkinforequest.md
View File

@@ -3,7 +3,7 @@
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_check_mark: | The domain of the link to retrieve. E.g. for `d.to/github`, the domain is `d.to`. |
| `key` | *string* | :heavy_check_mark: | The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`. |
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `domain` | *string* | :heavy_check_mark: | N/A |
| `key` | *string* | :heavy_check_mark: | The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`. |

8
docs/models/operations/getlinkinfosecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetLinkInfoSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getlinkscountsecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetLinksCountSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getlinkssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetLinksSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getosanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetOSAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getqrcodesecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetQRCodeSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getrefereranalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetRefererAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/gettagssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTagsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/gettimeseriesanalyticssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTimeseriesAnalyticsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/gettoplinkssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTopLinksSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/gettopurlssecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetTopURLsSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getworkspacesecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetWorkspaceSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

8
docs/models/operations/getworkspacessecurity.md Normal file
View File

@@ -0,0 +1,8 @@
# GetWorkspacesSecurity
## Fields
| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `token` | *string* | :heavy_minus_sign: | N/A |

60
docs/sdks/analytics/README.md
View File

@@ -25,12 +25,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.clicks({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.clicks({}, operationSecurity);
// Handle the result
console.log(result)
@@ -44,6 +45,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetClicksAnalyticsRequest](../../models/operations/getclicksanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetClicksAnalyticsSecurity](../../models/operations/getclicksanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -77,12 +79,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.timeseries({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.timeseries({}, operationSecurity);
// Handle the result
console.log(result)
@@ -96,6 +99,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTimeseriesAnalyticsRequest](../../models/operations/gettimeseriesanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetTimeseriesAnalyticsSecurity](../../models/operations/gettimeseriesanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -129,12 +133,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.countries({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.countries({}, operationSecurity);
// Handle the result
console.log(result)
@@ -148,6 +153,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetCountryAnalyticsRequest](../../models/operations/getcountryanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetCountryAnalyticsSecurity](../../models/operations/getcountryanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -181,12 +187,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.cities({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.cities({}, operationSecurity);
// Handle the result
console.log(result)
@@ -200,6 +207,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetCityAnalyticsRequest](../../models/operations/getcityanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetCityAnalyticsSecurity](../../models/operations/getcityanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -233,12 +241,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.devices({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.devices({}, operationSecurity);
// Handle the result
console.log(result)
@@ -252,6 +261,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetDeviceAnalyticsRequest](../../models/operations/getdeviceanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetDeviceAnalyticsSecurity](../../models/operations/getdeviceanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -285,12 +295,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.browsers({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.browsers({}, operationSecurity);
// Handle the result
console.log(result)
@@ -304,6 +315,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetBrowserAnalyticsRequest](../../models/operations/getbrowseranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetBrowserAnalyticsSecurity](../../models/operations/getbrowseranalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -337,12 +349,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.os({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.os({}, operationSecurity);
// Handle the result
console.log(result)
@@ -356,6 +369,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetOSAnalyticsRequest](../../models/operations/getosanalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetOSAnalyticsSecurity](../../models/operations/getosanalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -389,12 +403,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.referers({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.referers({}, operationSecurity);
// Handle the result
console.log(result)
@@ -408,6 +423,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetRefererAnalyticsRequest](../../models/operations/getrefereranalyticsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetRefererAnalyticsSecurity](../../models/operations/getrefereranalyticssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -441,12 +457,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.topLinks({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.topLinks({}, operationSecurity);
// Handle the result
console.log(result)
@@ -460,6 +477,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTopLinksRequest](../../models/operations/gettoplinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetTopLinksSecurity](../../models/operations/gettoplinkssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -493,12 +511,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.analytics.topUrls({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.analytics.topUrls({}, operationSecurity);
// Handle the result
console.log(result)
@@ -512,6 +531,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTopURLsRequest](../../models/operations/gettopurlsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetTopURLsSecurity](../../models/operations/gettopurlssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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
docs/sdks/links/README.md
View File

@@ -22,16 +22,17 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.list({
tagIds: [
"<value>",
],
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -45,6 +46,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetLinksRequest](../../models/operations/getlinksrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetLinksSecurity](../../models/operations/getlinkssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -78,18 +80,19 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.create({
url: "http://limp-pastry.org",
geo: {
"key": "<value>",
},
tagIds: "<value>",
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -103,6 +106,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.CreateLinkRequestBody](../../models/operations/createlinkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.CreateLinkSecurity](../../models/operations/createlinksecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -137,15 +141,16 @@ import { One } from "dub/models/operations";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.count({
tagIds: "<value>",
groupBy: One.Domain,
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -159,6 +164,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetLinksCountRequest](../../models/operations/getlinkscountrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetLinksCountSecurity](../../models/operations/getlinkscountsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -192,15 +198,16 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.get({
domain: "ringed-blow.name",
key: "<key>",
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -214,6 +221,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetLinkInfoRequest](../../models/operations/getlinkinforequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetLinkInfoSecurity](../../models/operations/getlinkinfosecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -247,7 +255,6 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
@@ -260,8 +267,9 @@ async function run() {
},
tagIds: "<value>",
};
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.update(linkId, requestBody);
const result = await sdk.links.update(operationSecurity, linkId, requestBody);
// Handle the result
console.log(result)
@@ -274,6 +282,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `security` | [operations.EditLinkSecurity](../../models/operations/editlinksecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `linkId` | *string* | :heavy_check_mark: | The id of the link to edit. You can get this via the `getLinkInfo` endpoint. |
| `requestBody` | [operations.EditLinkRequestBody](../../models/operations/editlinkrequestbody.md) | :heavy_minus_sign: | N/A |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
@@ -309,14 +318,14 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const linkId = "<value>";
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.delete(linkId);
const result = await sdk.links.delete(operationSecurity, linkId);
// Handle the result
console.log(result)
@@ -329,6 +338,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `security` | [operations.DeleteLinkSecurity](../../models/operations/deletelinksecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `linkId` | *string* | :heavy_check_mark: | The id of the link to delete. You can get this via the `getLinkInfo` endpoint. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -363,11 +373,12 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.links.createMany([
{
url: "https://positive-plane.info",
@@ -378,7 +389,7 @@ async function run() {
"<value>",
],
},
]);
], operationSecurity);
// Handle the result
console.log(result)
@@ -392,6 +403,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.RequestBody[]](../../models/.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.BulkCreateLinksSecurity](../../models/operations/bulkcreatelinkssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |

6
docs/sdks/qrcodes/README.md
View File

@@ -16,12 +16,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.qrCodes.get({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.qrCodes.get({}, operationSecurity);
// Handle the result
console.log(result)
@@ -35,6 +36,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetQRCodeRequest](../../models/operations/getqrcoderequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetQRCodeSecurity](../../models/operations/getqrcodesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |

12
docs/sdks/tags/README.md
View File

@@ -17,12 +17,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.tags.list({});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.tags.list({}, operationSecurity);
// Handle the result
console.log(result)
@@ -36,6 +37,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetTagsRequest](../../models/operations/gettagsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetTagsSecurity](../../models/operations/gettagssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -69,14 +71,15 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.tags.create({
tag: "<value>",
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -90,6 +93,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.CreateTagRequestBody](../../models/operations/createtagrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.CreateTagSecurity](../../models/operations/createtagsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |

18
docs/sdks/workspaces/README.md
View File

@@ -18,12 +18,13 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const result = await sdk.workspaces.list();
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.workspaces.list(operationSecurity);
// Handle the result
console.log(result)
@@ -36,6 +37,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `security` | [operations.GetWorkspacesSecurity](../../models/operations/getworkspacessecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -69,15 +71,16 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.workspaces.create({
name: "<value>",
slug: "<value>",
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -91,6 +94,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.CreateWorkspaceRequestBody](../../models/operations/createworkspacerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.CreateWorkspaceSecurity](../../models/operations/createworkspacesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |
@@ -124,14 +128,15 @@ import { Dub } from "dub";
async function run() {
const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>",
projectSlug: "<value>",
});
const operationSecurity = "<YOUR_BEARER_TOKEN_HERE>";
const result = await sdk.workspaces.get({
idOrSlug: "<value>",
});
}, operationSecurity);
// Handle the result
console.log(result)
@@ -145,6 +150,7 @@ run();
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [operations.GetWorkspaceRequest](../../models/operations/getworkspacerequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `security` | [operations.GetWorkspaceSecurity](../../models/operations/getworkspacesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `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. |

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "dub",
"version": "0.20.3",
"version": "0.21.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "dub",
"version": "0.20.3",
"version": "0.21.0",
"devDependencies": {
"@types/jsonpath": "^0.2.4",
"@types/node": "^20.12.7",

2
package.json
View File

@@ -1,6 +1,6 @@
{
"name": "dub",
"version": "0.20.3",
"version": "0.21.0",
"author": "Dub",
"main": "./index.js",
"sideEffects": false,

4
src/lib/config.ts
View File

@@ -64,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
export const SDK_METADATA = Object.freeze({
language: "typescript",
openapiDocVersion: "0.0.1",
sdkVersion: "0.20.3",
sdkVersion: "0.21.0",
genVersion: "2.302.1",
userAgent: "speakeasy-sdk/typescript 0.20.3 2.302.1 0.0.1 dub",
userAgent: "speakeasy-sdk/typescript 0.21.0 2.302.1 0.0.1 dub",
});

35
src/models/operations/bulkcreatelinks.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type BulkCreateLinksSecurity = {
token?: string | undefined;
};
/**
* The unique IDs of the tags assigned to the short link.
*/
@@ -94,6 +98,37 @@ export type RequestBody = {
comments?: string | null | undefined;
};
/** @internal */
export namespace BulkCreateLinksSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<BulkCreateLinksSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, BulkCreateLinksSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace BulkCreateLinksTagIds$ {
export type Inbound = string | Array<string>;

35
src/models/operations/createlink.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type CreateLinkSecurity = {
token?: string | undefined;
};
/**
* The unique IDs of the tags assigned to the short link.
*/
@@ -94,6 +98,37 @@ export type CreateLinkRequestBody = {
comments?: string | null | undefined;
};
/** @internal */
export namespace CreateLinkSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<CreateLinkSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateLinkSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace TagIds$ {
export type Inbound = string | Array<string>;

35
src/models/operations/createtag.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type CreateTagSecurity = {
token?: string | undefined;
};
/**
* The color of the tag. If not provided, a random color will be used from the list: red, yellow, green, blue, purple, pink, brown.
*/
@@ -28,6 +32,37 @@ export type CreateTagRequestBody = {
color?: Color | undefined;
};
/** @internal */
export namespace CreateTagSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<CreateTagSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateTagSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const Color$ = z.nativeEnum(Color);

35
src/models/operations/createworkspace.ts
View File

@@ -4,12 +4,47 @@
import * as z from "zod";
export type CreateWorkspaceSecurity = {
token?: string | undefined;
};
export type CreateWorkspaceRequestBody = {
name: string;
slug: string;
domain?: string | undefined;
};
/** @internal */
export namespace CreateWorkspaceSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<CreateWorkspaceSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, CreateWorkspaceSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace CreateWorkspaceRequestBody$ {
export type Inbound = {

35
src/models/operations/deletelink.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type DeleteLinkSecurity = {
token?: string | undefined;
};
export type DeleteLinkRequest = {
/**
* The id of the link to delete. You can get this via the `getLinkInfo` endpoint.
@@ -21,6 +25,37 @@ export type DeleteLinkResponseBody = {
id: string;
};
/** @internal */
export namespace DeleteLinkSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<DeleteLinkSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, DeleteLinkSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace DeleteLinkRequest$ {
export type Inbound = {

35
src/models/operations/editlink.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type EditLinkSecurity = {
token?: string | undefined;
};
/**
* The unique IDs of the tags assigned to the short link.
*/
@@ -102,6 +106,37 @@ export type EditLinkRequest = {
requestBody?: EditLinkRequestBody | undefined;
};
/** @internal */
export namespace EditLinkSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<EditLinkSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, EditLinkSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace EditLinkTagIds$ {
export type Inbound = string | Array<string>;

35
src/models/operations/getbrowseranalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetBrowserAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetBrowserAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetBrowserAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetBrowserAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetBrowserAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetBrowserAnalyticsQueryParamInterval$ = z.nativeEnum(
GetBrowserAnalyticsQueryParamInterval

35
src/models/operations/getcityanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetCityAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -594,6 +598,37 @@ export type GetCityAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetCityAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetCityAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCityAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetCityAnalyticsQueryParamInterval$ = z.nativeEnum(GetCityAnalyticsQueryParamInterval);

35
src/models/operations/getclicksanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetClicksAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -323,6 +327,37 @@ export type GetClicksAnalyticsRequest = {
tagId?: string | undefined;
};
/** @internal */
export namespace GetClicksAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetClicksAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetClicksAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const Interval$ = z.nativeEnum(Interval);

35
src/models/operations/getcountryanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetCountryAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -590,6 +594,37 @@ export type GetCountryAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetCountryAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetCountryAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCountryAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetCountryAnalyticsQueryParamInterval$ = z.nativeEnum(
GetCountryAnalyticsQueryParamInterval

35
src/models/operations/getdeviceanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetDeviceAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetDeviceAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetDeviceAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetDeviceAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetDeviceAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetDeviceAnalyticsQueryParamInterval$ = z.nativeEnum(
GetDeviceAnalyticsQueryParamInterval

38
src/models/operations/getlinkinfo.ts
View File

@@ -4,10 +4,11 @@
import * as z from "zod";
export type GetLinkInfoSecurity = {
token?: string | undefined;
};
export type GetLinkInfoRequest = {
/**
* The domain of the link to retrieve. E.g. for `d.to/github`, the domain is `d.to`.
*/
domain: string;
/**
* The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`.
@@ -15,6 +16,37 @@ export type GetLinkInfoRequest = {
key: string;
};
/** @internal */
export namespace GetLinkInfoSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetLinkInfoSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetLinkInfoSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace GetLinkInfoRequest$ {
export type Inbound = {

35
src/models/operations/getlinks.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetLinksSecurity = {
token?: string | undefined;
};
/**
* The tag IDs to filter the links by.
*/
@@ -57,6 +61,37 @@ export type GetLinksRequest = {
page?: number | undefined;
};
/** @internal */
export namespace GetLinksSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetLinksSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetLinksSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace QueryParamTagIds$ {
export type Inbound = string | Array<string>;

35
src/models/operations/getlinkscount.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetLinksCountSecurity = {
token?: string | undefined;
};
/**
* The tag IDs to filter the links by.
*/
@@ -57,6 +61,37 @@ export type GetLinksCountRequest = {
groupBy?: One | Two | undefined;
};
/** @internal */
export namespace GetLinksCountSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetLinksCountSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetLinksCountSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace GetLinksCountQueryParamTagIds$ {
export type Inbound = string | Array<string>;

35
src/models/operations/getosanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetOSAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetOSAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetOSAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetOSAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetOSAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetOSAnalyticsQueryParamInterval$ = z.nativeEnum(GetOSAnalyticsQueryParamInterval);

35
src/models/operations/getqrcode.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetQRCodeSecurity = {
token?: string | undefined;
};
/**
* The level of error correction to use for the QR code. Defaults to `L` if not provided.
*/
@@ -41,6 +45,37 @@ export type GetQRCodeRequest = {
includeMargin?: boolean | undefined;
};
/** @internal */
export namespace GetQRCodeSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetQRCodeSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetQRCodeSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const Level$ = z.nativeEnum(Level);

35
src/models/operations/getrefereranalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetRefererAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetRefererAnalyticsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetRefererAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetRefererAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetRefererAnalyticsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetRefererAnalyticsQueryParamInterval$ = z.nativeEnum(
GetRefererAnalyticsQueryParamInterval

35
src/models/operations/gettags.ts
View File

@@ -4,8 +4,43 @@
import * as z from "zod";
export type GetTagsSecurity = {
token?: string | undefined;
};
export type GetTagsRequest = {};
/** @internal */
export namespace GetTagsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetTagsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTagsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace GetTagsRequest$ {
export type Inbound = {};

36
src/models/operations/gettimeseriesanalytics.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetTimeseriesAnalyticsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,38 @@ export type ResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetTimeseriesAnalyticsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetTimeseriesAnalyticsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTimeseriesAnalyticsSecurity> =
z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const QueryParamInterval$ = z.nativeEnum(QueryParamInterval);

35
src/models/operations/gettoplinks.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetTopLinksSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetTopLinksResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetTopLinksSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetTopLinksSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopLinksSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetTopLinksQueryParamInterval$ = z.nativeEnum(GetTopLinksQueryParamInterval);

35
src/models/operations/gettopurls.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetTopURLsSecurity = {
token?: string | undefined;
};
/**
* The interval to retrieve analytics for.
*/
@@ -334,6 +338,37 @@ export type GetTopURLsResponseBody = {
clicks: number;
};
/** @internal */
export namespace GetTopURLsSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetTopURLsSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopURLsSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export const GetTopURLsQueryParamInterval$ = z.nativeEnum(GetTopURLsQueryParamInterval);

35
src/models/operations/getworkspace.ts
View File

@@ -4,6 +4,10 @@
import * as z from "zod";
export type GetWorkspaceSecurity = {
token?: string | undefined;
};
export type GetWorkspaceRequest = {
/**
* The ID or slug of the workspace.
@@ -11,6 +15,37 @@ export type GetWorkspaceRequest = {
idOrSlug: string;
};
/** @internal */
export namespace GetWorkspaceSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetWorkspaceSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetWorkspaceSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}
/** @internal */
export namespace GetWorkspaceRequest$ {
export type Inbound = {

40
src/models/operations/getworkspaces.ts Normal file
View File

@@ -0,0 +1,40 @@
/*
* Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
*/
import * as z from "zod";
export type GetWorkspacesSecurity = {
token?: string | undefined;
};
/** @internal */
export namespace GetWorkspacesSecurity$ {
export type Inbound = {
token?: string | undefined;
};
export const inboundSchema: z.ZodType<GetWorkspacesSecurity, z.ZodTypeDef, Inbound> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
export type Outbound = {
token?: string | undefined;
};
export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetWorkspacesSecurity> = z
.object({
token: z.string().optional(),
})
.transform((v) => {
return {
...(v.token === undefined ? null : { token: v.token }),
};
});
}

1
src/models/operations/index.ts
View File

@@ -24,3 +24,4 @@ export * from "./gettimeseriesanalytics";
export * from "./gettoplinks";
export * from "./gettopurls";
export * from "./getworkspace";
export * from "./getworkspaces";

229
src/sdk/analytics.ts
View File

@@ -8,6 +8,7 @@ import * as enc$ from "../lib/encodings";
import { HTTPClient } from "../lib/http";
import * as schemas$ from "../lib/schemas";
import { ClientSDK, RequestOptions } from "../lib/sdks";
import { SecurityInput } from "../lib/security";
import * as errors from "../models/errors";
import * as operations from "../models/operations";
import * as z from "zod";
@@ -47,6 +48,7 @@ export class Analytics extends ClientSDK {
*/
async clicks(
input: operations.GetClicksAnalyticsRequest,
security: operations.GetClicksAnalyticsSecurity,
options?: RequestOptions
): Promise<number> {
const headers$ = new Headers();
@@ -102,20 +104,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getClicksAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -295,6 +298,7 @@ export class Analytics extends ClientSDK {
*/
async timeseries(
input: operations.GetTimeseriesAnalyticsRequest,
security: operations.GetTimeseriesAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.ResponseBody>> {
const headers$ = new Headers();
@@ -350,20 +354,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getTimeseriesAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -543,6 +548,7 @@ export class Analytics extends ClientSDK {
*/
async countries(
input: operations.GetCountryAnalyticsRequest,
security: operations.GetCountryAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetCountryAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -598,20 +604,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getCountryAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -793,6 +800,7 @@ export class Analytics extends ClientSDK {
*/
async cities(
input: operations.GetCityAnalyticsRequest,
security: operations.GetCityAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetCityAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -848,20 +856,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getCityAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -1043,6 +1052,7 @@ export class Analytics extends ClientSDK {
*/
async devices(
input: operations.GetDeviceAnalyticsRequest,
security: operations.GetDeviceAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetDeviceAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -1098,20 +1108,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getDeviceAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -1293,6 +1304,7 @@ export class Analytics extends ClientSDK {
*/
async browsers(
input: operations.GetBrowserAnalyticsRequest,
security: operations.GetBrowserAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetBrowserAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -1348,20 +1360,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getBrowserAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -1543,6 +1556,7 @@ export class Analytics extends ClientSDK {
*/
async os(
input: operations.GetOSAnalyticsRequest,
security: operations.GetOSAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetOSAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -1598,20 +1612,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getOSAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -1793,6 +1808,7 @@ export class Analytics extends ClientSDK {
*/
async referers(
input: operations.GetRefererAnalyticsRequest,
security: operations.GetRefererAnalyticsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetRefererAnalyticsResponseBody>> {
const headers$ = new Headers();
@@ -1848,20 +1864,21 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getRefererAnalytics",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -2043,6 +2060,7 @@ export class Analytics extends ClientSDK {
*/
async topLinks(
input: operations.GetTopLinksRequest,
security: operations.GetTopLinksSecurity,
options?: RequestOptions
): Promise<Array<operations.GetTopLinksResponseBody>> {
const headers$ = new Headers();
@@ -2098,20 +2116,17 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getTopLinks",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getTopLinks", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -2291,6 +2306,7 @@ export class Analytics extends ClientSDK {
*/
async topUrls(
input: operations.GetTopURLsRequest,
security: operations.GetTopURLsSecurity,
options?: RequestOptions
): Promise<Array<operations.GetTopURLsResponseBody>> {
const headers$ = new Headers();
@@ -2346,20 +2362,17 @@ export class Analytics extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getTopURLs",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getTopURLs", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,

180
src/sdk/links.ts
View File

@@ -8,6 +8,7 @@ import * as enc$ from "../lib/encodings";
import { HTTPClient } from "../lib/http";
import * as schemas$ from "../lib/schemas";
import { ClientSDK, RequestOptions } from "../lib/sdks";
import { SecurityInput } from "../lib/security";
import * as components from "../models/components";
import * as errors from "../models/errors";
import * as operations from "../models/operations";
@@ -48,6 +49,7 @@ export class Links extends ClientSDK {
*/
async list(
input: operations.GetLinksRequest,
security: operations.GetLinksSecurity,
options?: RequestOptions
): Promise<Array<components.LinkSchema>> {
const headers$ = new Headers();
@@ -91,20 +93,17 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getLinks",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getLinks", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -284,6 +283,7 @@ export class Links extends ClientSDK {
*/
async create(
input: operations.CreateLinkRequestBody | undefined,
security: operations.CreateLinkSecurity,
options?: RequestOptions
): Promise<components.LinkSchema> {
const headers$ = new Headers();
@@ -314,20 +314,17 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "createLink",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "createLink", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -505,7 +502,11 @@ export class Links extends ClientSDK {
* @remarks
* Retrieve the number of links for the authenticated workspace. The provided query parameters allow filtering the returned links.
*/
async count(input: operations.GetLinksCountRequest, options?: RequestOptions): Promise<number> {
async count(
input: operations.GetLinksCountRequest,
security: operations.GetLinksCountSecurity,
options?: RequestOptions
): Promise<number> {
const headers$ = new Headers();
headers$.set("user-agent", SDK_METADATA.userAgent);
headers$.set("Accept", "application/json");
@@ -549,20 +550,21 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getLinksCount",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -742,6 +744,7 @@ export class Links extends ClientSDK {
*/
async get(
input: operations.GetLinkInfoRequest,
security: operations.GetLinkInfoSecurity,
options?: RequestOptions
): Promise<components.LinkSchema> {
const headers$ = new Headers();
@@ -772,20 +775,17 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getLinkInfo",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getLinkInfo", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -964,6 +964,7 @@ export class Links extends ClientSDK {
* Edit a link for the authenticated workspace.
*/
async update(
security: operations.EditLinkSecurity,
linkId: string,
requestBody?: operations.EditLinkRequestBody | undefined,
options?: RequestOptions
@@ -1005,20 +1006,17 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "editLink",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "editLink", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -1197,6 +1195,7 @@ export class Links extends ClientSDK {
* Delete a link for the authenticated workspace.
*/
async delete(
security: operations.DeleteLinkSecurity,
linkId: string,
options?: RequestOptions
): Promise<operations.DeleteLinkResponseBody> {
@@ -1235,20 +1234,17 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "deleteLink",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "deleteLink", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -1428,6 +1424,7 @@ export class Links extends ClientSDK {
*/
async createMany(
input: Array<operations.RequestBody> | undefined,
security: operations.BulkCreateLinksSecurity,
options?: RequestOptions
): Promise<Array<components.LinkSchema>> {
const headers$ = new Headers();
@@ -1458,20 +1455,21 @@ export class Links extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "bulkCreateLinks",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,

27
src/sdk/qrcodes.ts
View File

@@ -8,6 +8,7 @@ import * as enc$ from "../lib/encodings";
import { HTTPClient } from "../lib/http";
import * as schemas$ from "../lib/schemas";
import { ClientSDK, RequestOptions } from "../lib/sdks";
import { SecurityInput } from "../lib/security";
import * as errors from "../models/errors";
import * as operations from "../models/operations";
import * as z from "zod";
@@ -52,6 +53,7 @@ export class QRCodes extends ClientSDK {
*/
async get(
input: operations.GetQRCodeRequest,
security: operations.GetQRCodeSecurity,
options?: RequestOptions & { acceptHeaderOverride?: GetAcceptEnum }
): Promise<string> {
const headers$ = new Headers();
@@ -89,20 +91,17 @@ export class QRCodes extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getQRCode",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getQRCode", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,

53
src/sdk/tags.ts
View File

@@ -8,6 +8,7 @@ import * as enc$ from "../lib/encodings";
import { HTTPClient } from "../lib/http";
import * as schemas$ from "../lib/schemas";
import { ClientSDK, RequestOptions } from "../lib/sdks";
import { SecurityInput } from "../lib/security";
import * as components from "../models/components";
import * as errors from "../models/errors";
import * as operations from "../models/operations";
@@ -48,6 +49,7 @@ export class Tags extends ClientSDK {
*/
async list(
_input: operations.GetTagsRequest,
security: operations.GetTagsSecurity,
options?: RequestOptions
): Promise<Array<components.TagSchema>> {
const headers$ = new Headers();
@@ -69,20 +71,17 @@ export class Tags extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "getTags",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "getTags", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,
@@ -261,6 +260,7 @@ export class Tags extends ClientSDK {
*/
async create(
input: operations.CreateTagRequestBody | undefined,
security: operations.CreateTagSecurity,
options?: RequestOptions
): Promise<components.TagSchema> {
const headers$ = new Headers();
@@ -291,20 +291,17 @@ export class Tags extends ClientSDK {
.filter(Boolean)
.join("&");
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const context = {
operationID: "createTag",
oAuth2Scopes: [],
securitySource: this.options$.token,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = { operationID: "createTag", oAuth2Scopes: [], securitySource: security$ };
const doOptions = {
context,

71
src/sdk/workspaces.ts
View File

@@ -8,6 +8,7 @@ import * as enc$ from "../lib/encodings";
import { HTTPClient } from "../lib/http";
import * as schemas$ from "../lib/schemas";
import { ClientSDK, RequestOptions } from "../lib/sdks";
import { SecurityInput } from "../lib/security";
import * as components from "../models/components";
import * as errors from "../models/errors";
import * as operations from "../models/operations";
@@ -46,7 +47,10 @@ export class Workspaces extends ClientSDK {
* @remarks
* Retrieve a list of workspaces for the authenticated user.
*/
async list(options?: RequestOptions): Promise<Array<components.WorkspaceSchema>> {
async list(
security: operations.GetWorkspacesSecurity,
options?: RequestOptions
): Promise<Array<components.WorkspaceSchema>> {
const headers$ = new Headers();
headers$.set("user-agent", SDK_METADATA.userAgent);
headers$.set("Accept", "application/json");
@@ -55,20 +59,21 @@ export class Workspaces extends ClientSDK {
const query$ = "";
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getWorkspaces",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -247,6 +252,7 @@ export class Workspaces extends ClientSDK {
*/
async create(
input: operations.CreateWorkspaceRequestBody | undefined,
security: operations.CreateWorkspaceSecurity,
options?: RequestOptions
): Promise<components.WorkspaceSchema> {
const headers$ = new Headers();
@@ -267,20 +273,21 @@ export class Workspaces extends ClientSDK {
const query$ = "";
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "createWorkspace",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,
@@ -460,6 +467,7 @@ export class Workspaces extends ClientSDK {
*/
async get(
input: operations.GetWorkspaceRequest,
security: operations.GetWorkspaceSecurity,
options?: RequestOptions
): Promise<components.WorkspaceSchema> {
const headers$ = new Headers();
@@ -483,20 +491,21 @@ export class Workspaces extends ClientSDK {
const query$ = "";
let security$;
if (typeof this.options$.token === "function") {
security$ = { token: await this.options$.token() };
} else if (this.options$.token) {
security$ = { token: this.options$.token };
} else {
security$ = {};
}
const security$: SecurityInput[][] = [
[
{
fieldName: "Authorization",
type: "http:bearer",
value: security?.token,
},
],
];
const securitySettings$ = this.resolveSecurity(...security$);
const context = {
operationID: "getWorkspace",
oAuth2Scopes: [],
securitySource: this.options$.token,
securitySource: security$,
};
const securitySettings$ = this.resolveGlobalSecurity(security$);
const doOptions = {
context,