dub 0.22.1 → 0.22.3

package/.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: f28179cc-ef59-426d-9e85-60cec22fc642
 management:
-  docChecksum: f694a42b01f2e867afec56e4fb1fd88d
+  docChecksum: a7672fcdce994905df2837c38c661ab7
   docVersion: 0.0.1
-  speakeasyVersion: 1.250.0
-  generationVersion: 2.304.1
-  releaseVersion: 0.22.1
-  configChecksum: 407efa9ff397852657ab57837eda4e18
+  speakeasyVersion: 1.252.0
+  generationVersion: 2.306.0
+  releaseVersion: 0.22.3
+  configChecksum: 6dfa60cf43b354c2423e7e6cd94d8557
   repoURL: https://github.com/dubinc/dub-node.git
   installationURL: https://github.com/dubinc/dub-node
   published: true
@@ -30,6 +30,7 @@ generatedFiles:
   - src/sdk/analytics.ts
   - src/sdk/workspaces.ts
   - src/sdk/tags.ts
+  - src/sdk/metatags.ts
   - src/sdk/sdk.ts
   - .eslintrc.js
   - .npmignore
@@ -87,9 +88,11 @@ generatedFiles:
   - src/models/operations/getworkspace.ts
   - src/models/operations/gettags.ts
   - src/models/operations/createtag.ts
+  - src/models/operations/getmetatags.ts
   - src/models/errors/index.ts
   - src/models/components/index.ts
   - src/models/operations/index.ts
+  - docs/models/components/geo.md
   - docs/models/components/linkschema.md
   - docs/models/components/color.md
   - docs/models/components/tagschema.md
@@ -130,6 +133,7 @@ generatedFiles:
   - docs/models/operations/sort.md
   - docs/models/operations/getlinksrequest.md
   - docs/models/operations/tagids.md
+  - docs/models/operations/geo.md
   - docs/models/operations/createlinkrequestbody.md
   - docs/models/operations/getlinkscountqueryparamtagids.md
   - docs/models/operations/two.md
@@ -138,11 +142,13 @@ generatedFiles:
   - docs/models/operations/getlinkscountrequest.md
   - docs/models/operations/getlinkinforequest.md
   - docs/models/operations/editlinktagids.md
+  - docs/models/operations/editlinkgeo.md
   - docs/models/operations/editlinkrequestbody.md
   - docs/models/operations/editlinkrequest.md
   - docs/models/operations/deletelinkrequest.md
   - docs/models/operations/deletelinkresponsebody.md
   - docs/models/operations/bulkcreatelinkstagids.md
+  - docs/models/operations/bulkcreatelinksgeo.md
   - docs/models/operations/requestbody.md
   - docs/models/operations/level.md
   - docs/models/operations/getqrcoderequest.md
@@ -192,12 +198,15 @@ generatedFiles:
   - docs/models/operations/gettagsrequest.md
   - docs/models/operations/color.md
   - docs/models/operations/createtagrequestbody.md
+  - docs/models/operations/getmetatagsrequest.md
+  - docs/models/operations/getmetatagsresponsebody.md
   - docs/sdks/dub/README.md
   - docs/sdks/links/README.md
   - docs/sdks/qrcodes/README.md
   - docs/sdks/analytics/README.md
   - docs/sdks/workspaces/README.md
   - docs/sdks/tags/README.md
+  - docs/sdks/metatags/README.md
   - USAGE.md
   - .gitattributes
   - src/hooks/hooks.ts

package/.speakeasy/gen.yaml

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

package/README.md

@@ -37,13 +37,13 @@ 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: "<YOUR_BEARER_TOKEN_HERE>",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 
@@ -96,6 +96,10 @@ run();
 
 * [list](docs/sdks/tags/README.md#list) - Retrieve a list of tags
 * [create](docs/sdks/tags/README.md#create) - Create a new tag
+
+### [metatags](docs/sdks/metatags/README.md)
+
+* [get](docs/sdks/metatags/README.md#get) - Retrieve the metatags for a URL
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Error Handling [errors] -->
@@ -123,15 +127,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: "<YOUR_BEARER_TOKEN_HERE>",
+    workspaceId: "<value>",
+});
 
+async function run() {
     let result;
     try {
-        result = await sdk.links.list({
+        result = await dub.links.list({
             tagIds: ["<value>"],
         });
     } catch (err) {
@@ -208,14 +212,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: "<YOUR_BEARER_TOKEN_HERE>",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 
@@ -235,14 +239,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: "<YOUR_BEARER_TOKEN_HERE>",
+    workspaceId: "<value>",
+});
 
-    const result = await sdk.links.list({
+async function run() {
+    const result = await dub.links.list({
         tagIds: ["<value>"],
     });
 
@@ -319,13 +323,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: "<YOUR_BEARER_TOKEN_HERE>",
+    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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.list({
+async function run() {
+  const result = await dub.links.list({
   tagIds:     [
         "<value>",
       ],
@@ -75,18 +75,16 @@ 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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.create({
+async function run() {
+  const result = await dub.links.create({
     url: "http://limp-pastry.org",
-    geo: {
-      "key": "<value>",
-    },
   tagIds: "<value>",
+    geo: {},
   });
 
   // Handle the result
@@ -133,13 +131,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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.count({
+async function run() {
+  const result = await dub.links.count({
   tagIds: "<value>",
   groupBy: One.Domain,
   });
@@ -187,13 +185,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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.get({
+async function run() {
+  const result = await dub.links.get({
     domain: "ringed-blow.name",
     key: "<key>",
   });
@@ -241,22 +239,20 @@ 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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
+async function run() {
   const linkId = "<value>";
   const requestBody = {
     url: "https://alarming-nondisclosure.com",
-    geo: {
-      "key": "<value>",
-    },
   tagIds: "<value>",
+    geo: {},
   };
   
-  const result = await sdk.links.update(linkId, requestBody);
+  const result = await dub.links.update(linkId, requestBody);
 
   // Handle the result
   console.log(result)
@@ -302,15 +298,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: "<YOUR_BEARER_TOKEN_HERE>",
+  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)
@@ -355,21 +351,19 @@ 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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.links.createMany([
+async function run() {
+  const result = await dub.links.createMany([
     {
       url: "https://positive-plane.info",
-      geo: {
-        "key": "<value>",
-      },
     tagIds:     [
           "<value>",
         ],
+      geo: {},
     },
   ]);
 

package/docs/sdks/metatags/README.md

@@ -0,0 +1,50 @@
+# Metatags
+(*metatags*)
+
+### Available Operations
+
+* [get](#get) - Retrieve the metatags for a URL
+
+## get
+
+Retrieve the metatags for a URL
+
+### Example Usage
+
+```typescript
+import { Dub } from "dub";
+
+const dub = new Dub({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
+
+async function run() {
+  const result = await dub.metatags.get({
+    url: "https://brief-micronutrient.org",
+  });
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetMetatagsRequest](../../models/operations/getmetatagsrequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object 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. |
+
+
+### Response
+
+**Promise<[operations.GetMetatagsResponseBody](../../models/operations/getmetatagsresponsebody.md)>**
+### Errors
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4xx-5xx         | */*             |

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: "<YOUR_BEARER_TOKEN_HERE>",
+  workspaceId: "<value>",
+});
 
-  const result = await sdk.qrCodes.get({});
+async function run() {
+  const result = await dub.qrCodes.get({});
 
   // Handle the result
   console.log(result)