dub 0.64.1 → 0.64.3

package/docs/sdks/partners/README.md

@@ -6,6 +6,7 @@
 ### Available Operations
 
 * [create](#create) - Create a partner
+* [list](#list) - List all partners
 * [createLink](#createlink) - Create a link for a partner
 * [retrieveLinks](#retrievelinks) - Retrieve a partner's links.
 * [upsertLink](#upsertlink) - Upsert a link for a partner
@@ -17,6 +18,7 @@ Create a partner for a program. If partner exists, automatically enrolls them.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createPartner" method="post" path="/partners" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -88,12 +90,91 @@ run();
 | errors.InternalServerError | 500                        | application/json           |
 | errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
 
+## list
+
+List all partners for a partner program.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listPartners" method="get" path="/partners" -->
+```typescript
+import { Dub } from "dub";
+
+const dub = new Dub({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const result = await dub.partners.list();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DubCore } from "dub/core.js";
+import { partnersList } from "dub/funcs/partnersList.js";
+
+// Use `DubCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const dub = new DubCore({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const res = await partnersList(dub);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("partnersList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListPartnersRequest](../../models/operations/listpartnersrequest.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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.ListPartnersResponseBody[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.BadRequest          | 400                        | application/json           |
+| errors.Unauthorized        | 401                        | application/json           |
+| errors.Forbidden           | 403                        | application/json           |
+| errors.NotFound            | 404                        | application/json           |
+| errors.Conflict            | 409                        | application/json           |
+| errors.InviteExpired       | 410                        | application/json           |
+| errors.UnprocessableEntity | 422                        | application/json           |
+| errors.RateLimitExceeded   | 429                        | application/json           |
+| errors.InternalServerError | 500                        | application/json           |
+| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |
+
 ## createLink
 
 Create a link for a partner that is enrolled in your program.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createPartnerLink" method="post" path="/partners/links" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -171,6 +252,7 @@ Retrieve a partner's links by their partner ID or tenant ID.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="retrieveLinks" method="get" path="/partners/links" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -248,6 +330,7 @@ Upsert a link for a partner that is enrolled in your program. If a link with the
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="upsertPartnerLink" method="put" path="/partners/links/upsert" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -325,6 +408,7 @@ Retrieve analytics for a partner within a program. The response type vary based
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="retrievePartnerAnalytics" method="get" path="/partners/analytics" -->
 ```typescript
 import { Dub } from "dub";
 

package/docs/sdks/qrcodes/README.md

@@ -13,6 +13,7 @@ Retrieve a QR code for a link.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getQRCode" method="get" path="/qr" -->
 ```typescript
 import { Dub } from "dub";
 

package/docs/sdks/tags/README.md

@@ -16,6 +16,7 @@ Create a tag for the authenticated workspace.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="createTag" method="post" path="/tags" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -93,6 +94,7 @@ Retrieve a list of tags for the authenticated workspace.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTags" method="get" path="/tags" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -170,6 +172,7 @@ Update a tag in the workspace.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="updateTag" method="patch" path="/tags/{id}" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -248,6 +251,7 @@ Delete a tag from the workspace. All existing links will still work, but they wi
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteTag" method="delete" path="/tags/{id}" -->
 ```typescript
 import { Dub } from "dub";
 

package/docs/sdks/track/README.md

@@ -14,6 +14,7 @@ Track a lead for a short link.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="trackLead" method="post" path="/track/lead" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -91,6 +92,7 @@ Track a sale for a short link.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="trackSale" method="post" path="/track/sale" -->
 ```typescript
 import { Dub } from "dub";
 

package/docs/sdks/workspaces/README.md

@@ -14,6 +14,7 @@ Retrieve a workspace for the authenticated user.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getWorkspace" method="get" path="/workspaces/{idOrSlug}" -->
 ```typescript
 import { Dub } from "dub";
 
@@ -95,6 +96,7 @@ Update a workspace by ID or slug.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="updateWorkspace" method="patch" path="/workspaces/{idOrSlug}" -->
 ```typescript
 import { Dub } from "dub";
 

package/examples/README.md

@@ -24,3 +24,8 @@ To run an example file from the examples directory:
 npm run build && npx tsx example.ts
 ```
 
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/linksCreate.example.ts

@@ -2,6 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import dotenv from "dotenv";
+dotenv.config();
 /**
  * Example usage of the dub SDK
  *

package/examples/package-lock.json

@@ -18,7 +18,10 @@
     },
     "..": {
       "name": "dub",
-      "version": "0.64.1",
+      "version": "0.64.3",
+      "dependencies": {
+        "zod": "^3.20.0"
+      },
       "bin": {
         "mcp": "bin/mcp-server.js"
       },
@@ -36,12 +39,10 @@
         "tshy": "^2.0.0",
         "typescript": "^5.4.5",
         "typescript-eslint": "^8.22.0",
-        "vitest": "1.4.0",
-        "zod": "^3.25.17"
+        "vitest": "1.4.0"
       },
       "peerDependencies": {
-        "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
-        "zod": "^3"
+        "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0"
       },
       "peerDependenciesMeta": {
         "@modelcontextprotocol/sdk": {

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "dub",
-  "version": "0.64.1",
+  "version": "0.64.3",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dub",
-  "version": "0.64.1",
+  "version": "0.64.3",
   "author": "Dub",
   "type": "module",
   "bin": {
@@ -33,8 +33,7 @@
     "prepublishOnly": "npm run build"
   },
   "peerDependencies": {
-    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
-    "zod": "^3"
+    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0"
   },
   "peerDependenciesMeta": {
     "@modelcontextprotocol/sdk": {
@@ -55,10 +54,11 @@
     "tshy": "^2.0.0",
     "typescript": "^5.4.5",
     "typescript-eslint": "^8.22.0",
-    "vitest": "1.4.0",
-    "zod": "^3.25.17"
+    "vitest": "1.4.0"
+  },
+  "dependencies": {
+    "zod": "^3.20.0"
   },
-  "dependencies": {},
   "exports": {
     ".": {
       "import": {

package/src/funcs/analyticsRetrieve.ts

@@ -129,10 +129,12 @@ async function $do(
     "partnerId": payload?.partnerId,
     "programId": payload?.programId,
     "qr": payload?.qr,
+    "query": payload?.query,
     "referer": payload?.referer,
     "refererUrl": payload?.refererUrl,
     "region": payload?.region,
     "root": payload?.root,
+    "saleType": payload?.saleType,
     "start": payload?.start,
     "tagId": payload?.tagId,
     "tagIds": payload?.tagIds,

package/src/funcs/eventsList.ts

@@ -130,10 +130,12 @@ async function $do(
     "partnerId": payload?.partnerId,
     "programId": payload?.programId,
     "qr": payload?.qr,
+    "query": payload?.query,
     "referer": payload?.referer,
     "refererUrl": payload?.refererUrl,
     "region": payload?.region,
     "root": payload?.root,
+    "saleType": payload?.saleType,
     "sortBy": payload?.sortBy,
     "sortOrder": payload?.sortOrder,
     "start": payload?.start,

package/src/funcs/partnersList.ts

@@ -0,0 +1,227 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { DubCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { DubError } from "../models/errors/duberror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List all partners
+ *
+ * @remarks
+ * List all partners for a partner program.
+ */
+export function partnersList(
+  client: DubCore,
+  request?: operations.ListPartnersRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<operations.ListPartnersResponseBody>,
+    | errors.BadRequest
+    | errors.Unauthorized
+    | errors.Forbidden
+    | errors.NotFound
+    | errors.Conflict
+    | errors.InviteExpired
+    | errors.UnprocessableEntity
+    | errors.RateLimitExceeded
+    | errors.InternalServerError
+    | DubError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: DubCore,
+  request?: operations.ListPartnersRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<operations.ListPartnersResponseBody>,
+      | errors.BadRequest
+      | errors.Unauthorized
+      | errors.Forbidden
+      | errors.NotFound
+      | errors.Conflict
+      | errors.InviteExpired
+      | errors.UnprocessableEntity
+      | errors.RateLimitExceeded
+      | errors.InternalServerError
+      | DubError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListPartnersRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/partners")();
+
+  const query = encodeFormQuery({
+    "country": payload?.country,
+    "includeExpandedFields": payload?.includeExpandedFields,
+    "page": payload?.page,
+    "pageSize": payload?.pageSize,
+    "search": payload?.search,
+    "sortBy": payload?.sortBy,
+    "sortOrder": payload?.sortOrder,
+    "status": payload?.status,
+    "tenantId": payload?.tenantId,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.token);
+  const securityInput = secConfig == null ? {} : { token: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listPartners",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.token,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: [
+      "400",
+      "401",
+      "403",
+      "404",
+      "409",
+      "410",
+      "422",
+      "429",
+      "4XX",
+      "500",
+      "5XX",
+    ],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    Array<operations.ListPartnersResponseBody>,
+    | errors.BadRequest
+    | errors.Unauthorized
+    | errors.Forbidden
+    | errors.NotFound
+    | errors.Conflict
+    | errors.InviteExpired
+    | errors.UnprocessableEntity
+    | errors.RateLimitExceeded
+    | errors.InternalServerError
+    | DubError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, z.array(operations.ListPartnersResponseBody$inboundSchema)),
+    M.jsonErr(400, errors.BadRequest$inboundSchema),
+    M.jsonErr(401, errors.Unauthorized$inboundSchema),
+    M.jsonErr(403, errors.Forbidden$inboundSchema),
+    M.jsonErr(404, errors.NotFound$inboundSchema),
+    M.jsonErr(409, errors.Conflict$inboundSchema),
+    M.jsonErr(410, errors.InviteExpired$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableEntity$inboundSchema),
+    M.jsonErr(429, errors.RateLimitExceeded$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
-  sdkVersion: "0.64.1",
-  genVersion: "2.656.5",
-  userAgent: "speakeasy-sdk/typescript 0.64.1 2.656.5 0.0.1 dub",
+  sdkVersion: "0.64.3",
+  genVersion: "2.672.0",
+  userAgent: "speakeasy-sdk/typescript 0.64.3 2.672.0 0.0.1 dub",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.64.1",
+    currentVersion: "0.64.3",
   },
 });
 

package/src/mcp-server/server.ts

@@ -46,6 +46,7 @@ import { tool$linksUpsert } from "./tools/linksUpsert.js";
 import { tool$partnersAnalytics } from "./tools/partnersAnalytics.js";
 import { tool$partnersCreate } from "./tools/partnersCreate.js";
 import { tool$partnersCreateLink } from "./tools/partnersCreateLink.js";
+import { tool$partnersList } from "./tools/partnersList.js";
 import { tool$partnersRetrieveLinks } from "./tools/partnersRetrieveLinks.js";
 import { tool$partnersUpsertLink } from "./tools/partnersUpsertLink.js";
 import { tool$qrCodesGet } from "./tools/qrCodesGet.js";
@@ -68,7 +69,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Dub",
-    version: "0.64.1",
+    version: "0.64.3",
   });
 
   const client = new DubCore({
@@ -132,6 +133,7 @@ export function createMCPServer(deps: {
   tool(tool$customersUpdate);
   tool(tool$customersDelete);
   tool(tool$partnersCreate);
+  tool(tool$partnersList);
   tool(tool$partnersCreateLink);
   tool(tool$partnersRetrieveLinks);
   tool(tool$partnersUpsertLink);

package/src/mcp-server/tools/partnersList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { partnersList } from "../../funcs/partnersList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListPartnersRequest$inboundSchema.optional(),
+};
+
+export const tool$partnersList: ToolDefinition<typeof args> = {
+  name: "partners-list",
+  description: `List all partners
+
+List all partners for a partner program.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await partnersList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/analyticstriggers.ts

@@ -14,6 +14,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export const Trigger = {
   Qr: "qr",
   Link: "link",
+  Pageview: "pageview",
+  Deeplink: "deeplink",
 } as const;
 /**
  * The type of trigger method: link click or QR scan