dub 0.71.0 → 0.71.2

package/src/funcs/payoutsList.ts

@@ -0,0 +1,226 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 payouts
+ *
+ * @remarks
+ * Retrieve a list of payouts for your partner program.
+ */
+export function payoutsList(
+  client: DubCore,
+  request?: operations.ListPayoutsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<operations.ListPayoutsResponseBody>,
+    | 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.ListPayoutsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<operations.ListPayoutsResponseBody>,
+      | 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.ListPayoutsRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/payouts")();
+
+  const query = encodeFormQuery({
+    "invoiceId": payload?.invoiceId,
+    "page": payload?.page,
+    "pageSize": payload?.pageSize,
+    "partnerId": payload?.partnerId,
+    "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: "listPayouts",
+    oAuth2Scopes: null,
+
+    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.ListPayoutsResponseBody>,
+    | 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.ListPayoutsResponseBody$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.71.0",
-  genVersion: "2.803.3",
-  userAgent: "speakeasy-sdk/typescript 0.71.0 2.803.3 0.0.1 dub",
+  sdkVersion: "0.71.2",
+  genVersion: "2.814.0",
+  userAgent: "speakeasy-sdk/typescript 0.71.2 2.814.0 0.0.1 dub",
 } as const;

package/src/models/operations/index.ts

@@ -34,6 +34,7 @@ export * from "./listdomains.js";
 export * from "./listevents.js";
 export * from "./listfolders.js";
 export * from "./listpartners.js";
+export * from "./listpayouts.js";
 export * from "./registerdomain.js";
 export * from "./rejectbountysubmission.js";
 export * from "./retrieveanalytics.js";

package/src/models/operations/listbountysubmissions.ts

@@ -54,7 +54,7 @@ export type ListBountySubmissionsQueryParamSortOrder = ClosedEnum<
 
 export type ListBountySubmissionsRequest = {
   /**
-   * The ID of the bounty
+   * The unique ID of the bounty on Dub. Can be found in the URL of the bounty page, prefixed with `bnty_`.
    */
   bountyId: string;
   /**

package/src/models/operations/listpayouts.ts

@@ -0,0 +1,308 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter the list of payouts by their corresponding status.
+ */
+export const ListPayoutsQueryParamStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Processed: "processed",
+  Sent: "sent",
+  Completed: "completed",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+/**
+ * Filter the list of payouts by their corresponding status.
+ */
+export type ListPayoutsQueryParamStatus = ClosedEnum<
+  typeof ListPayoutsQueryParamStatus
+>;
+
+/**
+ * The field to sort the list of payouts by.
+ */
+export const ListPayoutsQueryParamSortBy = {
+  Amount: "amount",
+  InitiatedAt: "initiatedAt",
+  PaidAt: "paidAt",
+} as const;
+/**
+ * The field to sort the list of payouts by.
+ */
+export type ListPayoutsQueryParamSortBy = ClosedEnum<
+  typeof ListPayoutsQueryParamSortBy
+>;
+
+/**
+ * The sort order for the list of payouts.
+ */
+export const ListPayoutsQueryParamSortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * The sort order for the list of payouts.
+ */
+export type ListPayoutsQueryParamSortOrder = ClosedEnum<
+  typeof ListPayoutsQueryParamSortOrder
+>;
+
+export type ListPayoutsRequest = {
+  /**
+   * Filter the list of payouts by their corresponding status.
+   */
+  status?: ListPayoutsQueryParamStatus | undefined;
+  /**
+   * Filter the list of payouts by the associated partner. When specified, takes precedence over `tenantId`.
+   */
+  partnerId?: string | undefined;
+  /**
+   * Filter the list of payouts by the associated partner's `tenantId` (their unique ID within your database).
+   */
+  tenantId?: string | undefined;
+  /**
+   * Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID.
+   */
+  invoiceId?: string | undefined;
+  /**
+   * The field to sort the list of payouts by.
+   */
+  sortBy?: ListPayoutsQueryParamSortBy | undefined;
+  /**
+   * The sort order for the list of payouts.
+   */
+  sortOrder?: ListPayoutsQueryParamSortOrder | undefined;
+  /**
+   * The page number for pagination.
+   */
+  page?: number | undefined;
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number | undefined;
+};
+
+export const ListPayoutsStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Processed: "processed",
+  Sent: "sent",
+  Completed: "completed",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+export type ListPayoutsStatus = ClosedEnum<typeof ListPayoutsStatus>;
+
+export const ListPayoutsMode = {
+  Internal: "internal",
+  External: "external",
+} as const;
+export type ListPayoutsMode = ClosedEnum<typeof ListPayoutsMode>;
+
+export type ListPayoutsPartner = {
+  /**
+   * The partner's unique ID on Dub.
+   */
+  id: string;
+  /**
+   * The partner's full legal name.
+   */
+  name: string;
+  /**
+   * The partner's email address. Should be a unique value across Dub.
+   */
+  email: string | null;
+  /**
+   * The partner's avatar image.
+   */
+  image: string | null;
+  /**
+   * The date when the partner enabled payouts.
+   */
+  payoutsEnabledAt: string | null;
+  /**
+   * The partner's country (required for tax purposes).
+   */
+  country: string | null;
+  /**
+   * The partner's group ID on Dub.
+   */
+  groupId?: string | null | undefined;
+  /**
+   * The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
+   */
+  tenantId: string | null;
+};
+
+export type User = {
+  id: string;
+  name: string | null;
+  email: string | null;
+  image: string | null;
+};
+
+export type ListPayoutsResponseBody = {
+  id: string;
+  invoiceId: string | null;
+  amount: number;
+  currency: string;
+  status: ListPayoutsStatus;
+  description?: string | null | undefined;
+  periodStart: string | null;
+  periodEnd: string | null;
+  createdAt: string;
+  initiatedAt: string | null;
+  paidAt: string | null;
+  failureReason?: string | null | undefined;
+  mode: ListPayoutsMode | null;
+  partner: ListPayoutsPartner;
+  user?: User | null | undefined;
+};
+
+/** @internal */
+export const ListPayoutsQueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ListPayoutsQueryParamStatus
+> = z.nativeEnum(ListPayoutsQueryParamStatus);
+
+/** @internal */
+export const ListPayoutsQueryParamSortBy$outboundSchema: z.ZodNativeEnum<
+  typeof ListPayoutsQueryParamSortBy
+> = z.nativeEnum(ListPayoutsQueryParamSortBy);
+
+/** @internal */
+export const ListPayoutsQueryParamSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof ListPayoutsQueryParamSortOrder
+> = z.nativeEnum(ListPayoutsQueryParamSortOrder);
+
+/** @internal */
+export type ListPayoutsRequest$Outbound = {
+  status?: string | undefined;
+  partnerId?: string | undefined;
+  tenantId?: string | undefined;
+  invoiceId?: string | undefined;
+  sortBy: string;
+  sortOrder: string;
+  page: number;
+  pageSize: number;
+};
+
+/** @internal */
+export const ListPayoutsRequest$outboundSchema: z.ZodType<
+  ListPayoutsRequest$Outbound,
+  z.ZodTypeDef,
+  ListPayoutsRequest
+> = z.object({
+  status: ListPayoutsQueryParamStatus$outboundSchema.optional(),
+  partnerId: z.string().optional(),
+  tenantId: z.string().optional(),
+  invoiceId: z.string().optional(),
+  sortBy: ListPayoutsQueryParamSortBy$outboundSchema.default("amount"),
+  sortOrder: ListPayoutsQueryParamSortOrder$outboundSchema.default("desc"),
+  page: z.number().default(1),
+  pageSize: z.number().default(100),
+});
+
+export function listPayoutsRequestToJSON(
+  listPayoutsRequest: ListPayoutsRequest,
+): string {
+  return JSON.stringify(
+    ListPayoutsRequest$outboundSchema.parse(listPayoutsRequest),
+  );
+}
+
+/** @internal */
+export const ListPayoutsStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListPayoutsStatus
+> = z.nativeEnum(ListPayoutsStatus);
+
+/** @internal */
+export const ListPayoutsMode$inboundSchema: z.ZodNativeEnum<
+  typeof ListPayoutsMode
+> = z.nativeEnum(ListPayoutsMode);
+
+/** @internal */
+export const ListPayoutsPartner$inboundSchema: z.ZodType<
+  ListPayoutsPartner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.nullable(z.string()),
+  image: z.nullable(z.string()),
+  payoutsEnabledAt: z.nullable(z.string()),
+  country: z.nullable(z.string()),
+  groupId: z.nullable(z.string()).optional(),
+  tenantId: z.nullable(z.string()),
+});
+
+export function listPayoutsPartnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPayoutsPartner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPayoutsPartner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPayoutsPartner' from JSON`,
+  );
+}
+
+/** @internal */
+export const User$inboundSchema: z.ZodType<User, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.string(),
+    name: z.nullable(z.string()),
+    email: z.nullable(z.string()),
+    image: z.nullable(z.string()),
+  });
+
+export function userFromJSON(
+  jsonString: string,
+): SafeParseResult<User, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => User$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'User' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListPayoutsResponseBody$inboundSchema: z.ZodType<
+  ListPayoutsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  invoiceId: z.nullable(z.string()),
+  amount: z.number(),
+  currency: z.string(),
+  status: ListPayoutsStatus$inboundSchema,
+  description: z.nullable(z.string()).optional(),
+  periodStart: z.nullable(z.string()),
+  periodEnd: z.nullable(z.string()),
+  createdAt: z.string(),
+  initiatedAt: z.nullable(z.string()),
+  paidAt: z.nullable(z.string()),
+  failureReason: z.nullable(z.string()).optional(),
+  mode: z.nullable(ListPayoutsMode$inboundSchema),
+  partner: z.lazy(() => ListPayoutsPartner$inboundSchema),
+  user: z.nullable(z.lazy(() => User$inboundSchema)).optional(),
+});
+
+export function listPayoutsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPayoutsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPayoutsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPayoutsResponseBody' from JSON`,
+  );
+}

package/src/sdk/bounties.ts

@@ -14,7 +14,7 @@ export class Bounties extends ClientSDK {
    * List bounty submissions
    *
    * @remarks
-   * List all submissions for a specific bounty.
+   * List all submissions for a specific bounty in your partner program.
    */
   async listSubmissions(
     request: operations.ListBountySubmissionsRequest,

package/src/sdk/commissions.ts

@@ -10,10 +10,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Commissions extends ClientSDK {
   /**
-   * Get commissions for a program.
+   * List all commissions
    *
    * @remarks
-   * Retrieve a list of commissions for a program.
+   * Retrieve a list of commissions for your partner program.
    */
   async list(
     request?: operations.ListCommissionsRequest | undefined,

package/src/sdk/payouts.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { payoutsList } from "../funcs/payoutsList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Payouts extends ClientSDK {
+  /**
+   * List all payouts
+   *
+   * @remarks
+   * Retrieve a list of payouts for your partner program.
+   */
+  async list(
+    request?: operations.ListPayoutsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<Array<operations.ListPayoutsResponseBody>> {
+    return unwrapAsync(payoutsList(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -13,6 +13,7 @@ import { Events } from "./events.js";
 import { Folders } from "./folders.js";
 import { Links } from "./links.js";
 import { Partners } from "./partners.js";
+import { Payouts } from "./payouts.js";
 import { QRCodes } from "./qrcodes.js";
 import { Tags } from "./tags.js";
 import { Track } from "./track.js";
@@ -68,6 +69,11 @@ export class Dub extends ClientSDK {
     return (this._commissions ??= new Commissions(this._options));
   }
 
+  private _payouts?: Payouts;
+  get payouts(): Payouts {
+    return (this._payouts ??= new Payouts(this._options));
+  }
+
   private _embedTokens?: EmbedTokens;
   get embedTokens(): EmbedTokens {
     return (this._embedTokens ??= new EmbedTokens(this._options));