dub 0.22.2 → 0.23.0

package/.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: f28179cc-ef59-426d-9e85-60cec22fc642
 management:
-  docChecksum: a7672fcdce994905df2837c38c661ab7
+  docChecksum: 0fd7c7dd60bcd8b21c5a82e77f886ca4
   docVersion: 0.0.1
-  speakeasyVersion: 1.250.0
-  generationVersion: 2.304.1
-  releaseVersion: 0.22.2
-  configChecksum: fa330c5c21c9392968bfd8861ad91570
+  speakeasyVersion: 1.253.1
+  generationVersion: 2.306.0
+  releaseVersion: 0.23.0
+  configChecksum: 42694dd34d8f28936b3acf5fc2011448
   repoURL: https://github.com/dubinc/dub-node.git
   installationURL: https://github.com/dubinc/dub-node
   published: true
@@ -16,6 +16,7 @@ features:
     constsAndDefaults: 0.1.5
     core: 3.7.1
     deprecations: 2.81.1
+    examples: 2.81.3
     flattening: 2.81.1
     globalSecurity: 2.82.9
     globalServerURLs: 2.82.4

package/.speakeasy/gen.yaml

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

package/README.md

@@ -37,14 +37,16 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-    const sdk = new Dub({
-        token: "<YOUR_BEARER_TOKEN_HERE>",
-        workspaceId: "<value>",
-    });
+const dub = new Dub({
+    token: "DUB_API_KEY",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
-        tagIds: ["<value>"],
+async function run() {
+    const result = await dub.links.create({
+        url: "https://google/com",
+        tagIds: ["clux0rgak00011..."],
+        geo: {},
     });
 
     // Handle the result
@@ -127,15 +129,15 @@ Validation errors can also occur when either method arguments or data returned f
 import { Dub } from "dub";
 import * as errors from "dub/models/errors";
 
-async function run() {
-    const sdk = new Dub({
-        token: "<YOUR_BEARER_TOKEN_HERE>",
-        workspaceId: "<value>",
-    });
+const dub = new Dub({
+    token: "DUB_API_KEY",
+    workspaceId: "<value>",
+});
 
+async function run() {
     let result;
     try {
-        result = await sdk.links.list({
+        result = await dub.links.list({
             tagIds: ["<value>"],
         });
     } catch (err) {
@@ -212,14 +214,14 @@ You can override the default server globally by passing a server index to the `s
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-    const sdk = new Dub({
-        serverIdx: 0,
-        token: "<YOUR_BEARER_TOKEN_HERE>",
-        workspaceId: "<value>",
-    });
+const dub = new Dub({
+    serverIdx: 0,
+    token: "DUB_API_KEY",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 
@@ -239,14 +241,14 @@ The default server can also be overridden globally by passing a URL to the `serv
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-    const sdk = new Dub({
-        serverURL: "https://api.dub.co",
-        token: "<YOUR_BEARER_TOKEN_HERE>",
-        workspaceId: "<value>",
-    });
+const dub = new Dub({
+    serverURL: "https://api.dub.co",
+    token: "DUB_API_KEY",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 
@@ -323,13 +325,13 @@ To authenticate with the API the `token` parameter must be set when initializing
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-    const sdk = new Dub({
-        token: "<YOUR_BEARER_TOKEN_HERE>",
-        workspaceId: "<value>",
-    });
+const dub = new Dub({
+    token: "DUB_API_KEY",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 

package/docs/sdks/analytics/README.md

@@ -23,13 +23,13 @@ Retrieve the number of clicks for a link, a domain, or the authenticated workspa
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.clicks({});
+async function run() {
+  const result = await dub.analytics.clicks({});
 
   // Handle the result
   console.log(result)
@@ -74,13 +74,13 @@ Retrieve the number of clicks for a link, a domain, or the authenticated workspa
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.timeseries({});
+async function run() {
+  const result = await dub.analytics.timeseries({});
 
   // Handle the result
   console.log(result)
@@ -125,13 +125,13 @@ Retrieve the top countries by number of clicks for a link, a domain, or the auth
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.countries({});
+async function run() {
+  const result = await dub.analytics.countries({});
 
   // Handle the result
   console.log(result)
@@ -176,13 +176,13 @@ Retrieve the top countries by number of clicks for a link, a domain, or the auth
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.cities({});
+async function run() {
+  const result = await dub.analytics.cities({});
 
   // Handle the result
   console.log(result)
@@ -227,13 +227,13 @@ Retrieve the top devices by number of clicks for a link, a domain, or the authen
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.devices({});
+async function run() {
+  const result = await dub.analytics.devices({});
 
   // Handle the result
   console.log(result)
@@ -278,13 +278,13 @@ Retrieve the top browsers by number of clicks for a link, a domain, or the authe
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.browsers({});
+async function run() {
+  const result = await dub.analytics.browsers({});
 
   // Handle the result
   console.log(result)
@@ -329,13 +329,13 @@ Retrieve the top OS by number of clicks for a link, a domain, or the authenticat
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.os({});
+async function run() {
+  const result = await dub.analytics.os({});
 
   // Handle the result
   console.log(result)
@@ -380,13 +380,13 @@ Retrieve the top referers by number of clicks for a link, a domain, or the authe
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.referers({});
+async function run() {
+  const result = await dub.analytics.referers({});
 
   // Handle the result
   console.log(result)
@@ -431,13 +431,13 @@ Retrieve the top links by number of clicks for a domain or the authenticated wor
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.topLinks({});
+async function run() {
+  const result = await dub.analytics.topLinks({});
 
   // Handle the result
   console.log(result)
@@ -482,13 +482,13 @@ Retrieve the top URLs by number of clicks for a given short link.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.analytics.topUrls({});
+async function run() {
+  const result = await dub.analytics.topUrls({});
 
   // Handle the result
   console.log(result)

package/docs/sdks/links/README.md

@@ -20,13 +20,13 @@ Retrieve a list of links for the authenticated workspace. The list will be pagin
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.list({
+async function run() {
+  const result = await dub.links.list({
   tagIds:     [
         "<value>",
       ],
@@ -75,15 +75,17 @@ Create a new link for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.create({
-    url: "http://limp-pastry.org",
-  tagIds: "<value>",
+async function run() {
+  const result = await dub.links.create({
+    url: "https://google/com",
+  tagIds:     [
+        "clux0rgak00011...",
+      ],
     geo: {},
   });
 
@@ -131,13 +133,13 @@ Retrieve the number of links for the authenticated workspace. The provided query
 import { Dub } from "dub";
 import { One } from "dub/models/operations";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.count({
+async function run() {
+  const result = await dub.links.count({
   tagIds: "<value>",
   groupBy: One.Domain,
   });
@@ -185,13 +187,13 @@ Retrieve the info for a link from their domain and key.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.get({
+async function run() {
+  const result = await dub.links.get({
     domain: "ringed-blow.name",
     key: "<key>",
   });
@@ -239,20 +241,22 @@ Edit a link for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
+async function run() {
   const linkId = "<value>";
   const requestBody = {
-    url: "https://alarming-nondisclosure.com",
-  tagIds: "<value>",
+    url: "https://google/com",
+  tagIds:     [
+        "clux0rgak00011...",
+      ],
     geo: {},
   };
   
-  const result = await sdk.links.update(linkId, requestBody);
+  const result = await dub.links.update(linkId, requestBody);
 
   // Handle the result
   console.log(result)
@@ -298,15 +302,15 @@ Delete a link for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
+async function run() {
   const linkId = "<value>";
   
-  const result = await sdk.links.delete(linkId);
+  const result = await dub.links.delete(linkId);
 
   // Handle the result
   console.log(result)
@@ -351,17 +355,17 @@ Bulk create up to 100 links for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.createMany([
+async function run() {
+  const result = await dub.links.createMany([
     {
-      url: "https://positive-plane.info",
+      url: "https://google/com",
     tagIds:     [
-          "<value>",
+          "clux0rgak00011...",
         ],
       geo: {},
     },

package/docs/sdks/metatags/README.md

@@ -14,13 +14,13 @@ Retrieve the metatags for a URL
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.metatags.get({
+async function run() {
+  const result = await dub.metatags.get({
     url: "https://brief-micronutrient.org",
   });
 

package/docs/sdks/qrcodes/README.md

@@ -14,13 +14,13 @@ Retrieve a QR code for a link.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.qrCodes.get({});
+async function run() {
+  const result = await dub.qrCodes.get({});
 
   // Handle the result
   console.log(result)

package/docs/sdks/tags/README.md

@@ -15,13 +15,13 @@ Retrieve a list of tags for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.tags.list({});
+async function run() {
+  const result = await dub.tags.list({});
 
   // Handle the result
   console.log(result)
@@ -66,13 +66,13 @@ Create a new tag for the authenticated workspace.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.tags.create({
+async function run() {
+  const result = await dub.tags.create({
     tag: "<value>",
   });
 

package/docs/sdks/workspaces/README.md

@@ -16,13 +16,13 @@ Retrieve a list of workspaces for the authenticated user.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.workspaces.list();
+async function run() {
+  const result = await dub.workspaces.list();
 
   // Handle the result
   console.log(result)
@@ -66,13 +66,13 @@ Create a new workspace for the authenticated user.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.workspaces.create({
+async function run() {
+  const result = await dub.workspaces.create({
     name: "<value>",
     slug: "<value>",
   });
@@ -120,13 +120,13 @@ Retrieve a workspace for the authenticated user.
 ```typescript
 import { Dub } from "dub";
 
-async function run() {
-  const sdk = new Dub({
-    token: "<YOUR_BEARER_TOKEN_HERE>",
-    workspaceId: "<value>",
-  });
+const dub = new Dub({
+  token: "DUB_API_KEY",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.workspaces.get({
+async function run() {
+  const result = await dub.workspaces.get({
     idOrSlug: "<value>",
   });
 

package/lib/config.d.ts

@@ -32,8 +32,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: Readonly<{
     language: "typescript";
     openapiDocVersion: "0.0.1";
-    sdkVersion: "0.22.2";
-    genVersion: "2.304.1";
-    userAgent: "speakeasy-sdk/typescript 0.22.2 2.304.1 0.0.1 dub";
+    sdkVersion: "0.23.0";
+    genVersion: "2.306.0";
+    userAgent: "speakeasy-sdk/typescript 0.23.0 2.306.0 0.0.1 dub";
 }>;
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -32,8 +32,8 @@ exports.serverURLFromOptions = serverURLFromOptions;
 exports.SDK_METADATA = Object.freeze({
     language: "typescript",
     openapiDocVersion: "0.0.1",
-    sdkVersion: "0.22.2",
-    genVersion: "2.304.1",
-    userAgent: "speakeasy-sdk/typescript 0.22.2 2.304.1 0.0.1 dub",
+    sdkVersion: "0.23.0",
+    genVersion: "2.306.0",
+    userAgent: "speakeasy-sdk/typescript 0.23.0 2.306.0 0.0.1 dub",
 });
 //# sourceMappingURL=config.js.map

package/package.json

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

package/src/lib/config.ts

@@ -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.22.2",
-    genVersion: "2.304.1",
-    userAgent: "speakeasy-sdk/typescript 0.22.2 2.304.1 0.0.1 dub",
+    sdkVersion: "0.23.0",
+    genVersion: "2.306.0",
+    userAgent: "speakeasy-sdk/typescript 0.23.0 2.306.0 0.0.1 dub",
 });