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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.246.0 (#66)

Browse Source 
Co-authored-by: speakeasybot <bot@speakeasyapi.dev>
This commit is contained in:
github-actions[bot]
2024-04-10 17:09:38 +05:30
committed by GitHub
parent db608ece8c
commit e26bb057d1
14 changed files with 63 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
.speakeasy/gen.lock
View File

@@ -1,12 +1,12 @@
lockVersion: 2.0.0 lockVersion: 2.0.0
id: f28179cc-ef59-426d-9e85-60cec22fc642 id: f28179cc-ef59-426d-9e85-60cec22fc642
management: management:
docChecksum: db6d271d5e8675ebdf0c38f4f74ef509 docChecksum: 37d7e2c33b3d71ced9283276b543de34
docVersion: 0.0.1 docVersion: 0.0.1
speakeasyVersion: 1.245.0 speakeasyVersion: 1.246.0
generationVersion: 2.301.3 generationVersion: 2.302.0
releaseVersion: 0.20.1 releaseVersion: 0.20.2
configChecksum: 58fd9ad009187b2c8e2d90444fa8a3a8 configChecksum: cf1d62f46487352bf64eb9d7f549677a
repoURL: https://github.com/dubinc/dub-node.git repoURL: https://github.com/dubinc/dub-node.git
installationURL: https://github.com/dubinc/dub-node installationURL: https://github.com/dubinc/dub-node
published: true published: true
@@ -35,7 +35,6 @@ generatedFiles:
- .npmignore - .npmignore
- RUNTIMES.md - RUNTIMES.md
- package.json - package.json
- src/index.ts
- src/lib/base64.ts - src/lib/base64.ts
- src/lib/config.ts - src/lib/config.ts
- src/lib/encodings.ts - src/lib/encodings.ts

2
.speakeasy/gen.yaml
View File

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

7
README.md
View File

@@ -41,6 +41,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({
@@ -67,7 +68,7 @@ run();
* [get](docs/sdks/links/README.md#get) - Retrieve a link * [get](docs/sdks/links/README.md#get) - Retrieve a link
* [update](docs/sdks/links/README.md#update) - Edit a link * [update](docs/sdks/links/README.md#update) - Edit a link
* [delete](docs/sdks/links/README.md#delete) - Delete a link * [delete](docs/sdks/links/README.md#delete) - Delete a link
* [bulkCreate](docs/sdks/links/README.md#bulkcreate) - Bulk create links * [createMany](docs/sdks/links/README.md#createmany) - Bulk create links
### [qrCodes](docs/sdks/qrcodes/README.md) ### [qrCodes](docs/sdks/qrcodes/README.md)
@@ -127,6 +128,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
let result; let result;
@@ -213,6 +215,7 @@ async function run() {
serverIdx: 0, serverIdx: 0,
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({
@@ -240,6 +243,7 @@ async function run() {
serverURL: "https://api.dub.co", serverURL: "https://api.dub.co",
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({
@@ -323,6 +327,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({

12
RELEASES.md
View File

@@ -16,4 +16,14 @@ Based on:
### Generated ### Generated
- [typescript v0.20.1] . - [typescript v0.20.1] .
### Releases ### Releases
- [NPM v0.20.1] https://www.npmjs.com/package/dub/v/0.20.1 - . - [NPM v0.20.1] https://www.npmjs.com/package/dub/v/0.20.1 - .
## 2024-04-10 11:35:07
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.246.0 (2.302.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.20.2] .
### Releases
- [NPM v0.20.2] https://www.npmjs.com/package/dub/v/0.20.2 - .

1
USAGE.md
View File

@@ -6,6 +6,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({

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

@@ -27,6 +27,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.clicks({}); const result = await sdk.analytics.clicks({});
@@ -78,6 +79,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.timeseries({}); const result = await sdk.analytics.timeseries({});
@@ -129,6 +131,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.countries({}); const result = await sdk.analytics.countries({});
@@ -180,6 +183,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.cities({}); const result = await sdk.analytics.cities({});
@@ -231,6 +235,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.devices({}); const result = await sdk.analytics.devices({});
@@ -282,6 +287,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.browsers({}); const result = await sdk.analytics.browsers({});
@@ -333,6 +339,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.os({}); const result = await sdk.analytics.os({});
@@ -384,6 +391,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.referers({}); const result = await sdk.analytics.referers({});
@@ -435,6 +443,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.topLinks({}); const result = await sdk.analytics.topLinks({});
@@ -486,6 +495,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.analytics.topUrls({}); const result = await sdk.analytics.topUrls({});

15
docs/sdks/links/README.md
View File

@@ -9,7 +9,7 @@
* [get](#get) - Retrieve a link * [get](#get) - Retrieve a link
* [update](#update) - Edit a link * [update](#update) - Edit a link
* [delete](#delete) - Delete a link * [delete](#delete) - Delete a link
* [bulkCreate](#bulkcreate) - Bulk create links * [createMany](#createmany) - Bulk create links
## list ## list
@@ -24,6 +24,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.list({ const result = await sdk.links.list({
@@ -79,6 +80,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.create({ const result = await sdk.links.create({
@@ -137,6 +139,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.count({ const result = await sdk.links.count({
@@ -191,6 +194,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.get({ const result = await sdk.links.get({
@@ -245,6 +249,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const linkId = "<value>"; const linkId = "<value>";
@@ -306,6 +311,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const linkId = "<value>"; const linkId = "<value>";
@@ -346,7 +352,7 @@ run();
| errors.InternalServerError | 500 | application/json | | errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4xx-5xx | */* | | errors.SDKError | 4xx-5xx | */* |
## bulkCreate ## createMany
Bulk create up to 100 links for the authenticated workspace. Bulk create up to 100 links for the authenticated workspace.
@@ -359,11 +365,12 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.links.bulkCreate([ const result = await sdk.links.createMany([
{ {
url: "http://bad-sidecar.net", url: "https://positive-plane.info",
geo: { geo: {
"key": "<value>", "key": "<value>",
}, },

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

@@ -18,6 +18,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.qrCodes.get({}); const result = await sdk.qrCodes.get({});

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

@@ -19,6 +19,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.tags.list({}); const result = await sdk.tags.list({});
@@ -70,6 +71,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.tags.create({ const result = await sdk.tags.create({

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

@@ -20,6 +20,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.workspaces.list(); const result = await sdk.workspaces.list();
@@ -70,6 +71,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.workspaces.create({ const result = await sdk.workspaces.create({
@@ -124,6 +126,7 @@ async function run() {
const sdk = new Dub({ const sdk = new Dub({
token: "<YOUR_BEARER_TOKEN_HERE>", token: "<YOUR_BEARER_TOKEN_HERE>",
workspaceId: "<value>", workspaceId: "<value>",
projectSlug: "<value>",
}); });
const result = await sdk.workspaces.get({ const result = await sdk.workspaces.get({

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "dub", "name": "dub",
"version": "0.20.1", "version": "0.20.2",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "dub", "name": "dub",
"version": "0.20.1", "version": "0.20.2",
"devDependencies": { "devDependencies": {
"@types/jsonpath": "^0.2.4", "@types/jsonpath": "^0.2.4",
"@typescript-eslint/eslint-plugin": "^6.13.2", "@typescript-eslint/eslint-plugin": "^6.13.2",

2
package.json
View File

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

11
src/lib/config.ts
View File

@@ -24,6 +24,11 @@ export type SDKOptions = {
*/ */
workspaceId?: string; workspaceId?: string;
/**
* Allows setting the projectSlug parameter for all supported operations
*/
projectSlug?: string | undefined;
httpClient?: HTTPClient; httpClient?: HTTPClient;
/** /**
* Allows overriding the default server used by the SDK * Allows overriding the default server used by the SDK
@@ -59,7 +64,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
export const SDK_METADATA = Object.freeze({ export const SDK_METADATA = Object.freeze({
language: "typescript", language: "typescript",
openapiDocVersion: "0.0.1", openapiDocVersion: "0.0.1",
sdkVersion: "0.20.1", sdkVersion: "0.20.2",
genVersion: "2.301.3", genVersion: "2.302.0",
userAgent: "speakeasy-sdk/typescript 0.20.1 2.301.3 0.0.1 dub", userAgent: "speakeasy-sdk/typescript 0.20.2 2.302.0 0.0.1 dub",
}); });

2
src/sdk/links.ts
View File

@@ -1402,7 +1402,7 @@ export class Links extends ClientSDK {
* @remarks * @remarks
* Bulk create up to 100 links for the authenticated workspace. * Bulk create up to 100 links for the authenticated workspace.
*/ */
async bulkCreate( async createMany(
input: Array<operations.RequestBody> | undefined, input: Array<operations.RequestBody> | undefined,
options?: RequestOptions options?: RequestOptions
): Promise<Array<components.LinkSchema>> { ): Promise<Array<components.LinkSchema>> {