dub 0.71.5 → 0.71.7

package/src/models/operations/updatecommission.ts

@@ -10,36 +10,53 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
+ * Useful for marking a commission as pending, refunded, duplicate, canceled, or fraudulent. Takes precedence over `saleAmount` and `modifySaleAmount`. When a commission is marked as pending, refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
  */
 export const Status = {
+  Pending: "pending",
   Refunded: "refunded",
   Duplicate: "duplicate",
   Canceled: "canceled",
   Fraud: "fraud",
 } as const;
 /**
- * Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
+ * Useful for marking a commission as pending, refunded, duplicate, canceled, or fraudulent. Takes precedence over `saleAmount` and `modifySaleAmount`. When a commission is marked as pending, refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
  */
 export type Status = ClosedEnum<typeof Status>;
 
 export type UpdateCommissionRequestBody = {
+  /**
+   * The new earnings amount for the commission. Paid commissions cannot be updated. If provided, will override the earnings calculated based on the sale amount and currency.
+   */
+  earnings?: number | undefined;
   /**
    * The new absolute amount for the sale. Paid commissions cannot be updated.
    */
-  amount?: number | undefined;
+  saleAmount?: number | undefined;
   /**
-   * Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over `amount`. Paid commissions cannot be updated.
+   * Modify the current sale amount: use positive values to increase the amount, negative values to decrease it. Takes precedence over `saleAmount`. Paid commissions cannot be updated.
    */
-  modifyAmount?: number | undefined;
+  modifySaleAmount?: number | undefined;
   /**
    * The currency of the sale amount to update. Accepts ISO 4217 currency codes.
    */
   currency?: string | undefined;
   /**
-   * Useful for marking a commission as refunded, duplicate, canceled, or fraudulent. Takes precedence over `amount` and `modifyAmount`. When a commission is marked as refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
+   * Useful for marking a commission as pending, refunded, duplicate, canceled, or fraudulent. Takes precedence over `saleAmount` and `modifySaleAmount`. When a commission is marked as pending, refunded, duplicate, canceled, or fraudulent, it will be omitted from the payout, and the payout amount will be recalculated accordingly. Paid commissions cannot be updated.
    */
   status?: Status | undefined;
+  /**
+   * Deprecated. Use `saleAmount` instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  amount?: number | undefined;
+  /**
+   * Deprecated. Use `modifySaleAmount` instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  modifyAmount?: number | undefined;
 };
 
 export type UpdateCommissionRequest = {
@@ -183,10 +200,13 @@ export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> = z
 
 /** @internal */
 export type UpdateCommissionRequestBody$Outbound = {
-  amount?: number | undefined;
-  modifyAmount?: number | undefined;
+  earnings?: number | undefined;
+  saleAmount?: number | undefined;
+  modifySaleAmount?: number | undefined;
   currency: string;
   status?: string | undefined;
+  amount?: number | undefined;
+  modifyAmount?: number | undefined;
 };
 
 /** @internal */
@@ -195,10 +215,13 @@ export const UpdateCommissionRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateCommissionRequestBody
 > = z.object({
-  amount: z.number().optional(),
-  modifyAmount: z.number().optional(),
+  earnings: z.number().optional(),
+  saleAmount: z.number().optional(),
+  modifySaleAmount: z.number().optional(),
   currency: z.string().default("usd"),
   status: Status$outboundSchema.optional(),
+  amount: z.number().optional(),
+  modifyAmount: z.number().optional(),
 });
 
 export function updateCommissionRequestBodyToJSON(

package/src/models/operations/upsertpartnerlink.ts

@@ -23,10 +23,6 @@ export type UpsertPartnerLinkTestVariants = {
  * Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner.
  */
 export type UpsertPartnerLinkLinkProps = {
-  /**
-   * The length of the short link slug. Defaults to 7 if not provided. When used with `prefix`, the total length of the key will be `prefix.length + keyLength`.
-   */
-  keyLength?: number | undefined;
   /**
    * The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
    */
@@ -36,7 +32,7 @@ export type UpsertPartnerLinkLinkProps = {
    */
   tenantId?: string | null | undefined;
   /**
-   * The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
+   * Path prefix for each default referral link slug (e.g. `/c/` → `https://{domain}/c/{identity}`). If the group has multiple default links, a short random suffix is appended to the identity segment for uniqueness (e.g. `c/jane-a7f2`).
    */
   prefix?: string | undefined;
   /**
@@ -208,7 +204,6 @@ export function upsertPartnerLinkTestVariantsToJSON(
 
 /** @internal */
 export type UpsertPartnerLinkLinkProps$Outbound = {
-  keyLength?: number | undefined;
   externalId?: string | null | undefined;
   tenantId?: string | null | undefined;
   prefix?: string | undefined;
@@ -242,7 +237,6 @@ export const UpsertPartnerLinkLinkProps$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpsertPartnerLinkLinkProps
 > = z.object({
-  keyLength: z.number().optional(),
   externalId: z.nullable(z.string()).optional(),
   tenantId: z.nullable(z.string()).optional(),
   prefix: z.string().optional(),

package/src/sdk/commissions.ts

@@ -4,22 +4,26 @@
 
 import { commissionsList } from "../funcs/commissionsList.js";
 import { commissionsUpdate } from "../funcs/commissionsUpdate.js";
+import { commissionsUpdateMany } from "../funcs/commissionsUpdateMany.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Commissions extends ClientSDK {
   /**
    * List all commissions
    *
    * @remarks
-   * Retrieve a list of commissions for your partner program.
+   * Retrieve a paginated list of commissions for your partner program.
    */
   async list(
     request?: operations.ListCommissionsRequest | undefined,
     options?: RequestOptions,
-  ): Promise<Array<operations.ListCommissionsResponseBody>> {
-    return unwrapAsync(commissionsList(
+  ): Promise<
+    PageIterator<operations.ListCommissionsResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(commissionsList(
       this,
       request,
       options,
@@ -42,4 +46,21 @@ export class Commissions extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Bulk update commissions
+   *
+   * @remarks
+   * Bulk update up to 100 commissions with the same status.
+   */
+  async updateMany(
+    request?: operations.BulkUpdateCommissionsRequestBody | undefined,
+    options?: RequestOptions,
+  ): Promise<Array<operations.BulkUpdateCommissionsResponseBody>> {
+    return unwrapAsync(commissionsUpdateMany(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/customers.ts

@@ -9,19 +9,22 @@ import { customersUpdate } from "../funcs/customersUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Customers extends ClientSDK {
   /**
-   * Retrieve a list of customers
+   * List all customers
    *
    * @remarks
-   * Retrieve a list of customers for the authenticated workspace.
+   * Retrieve a paginated list of customers for the authenticated workspace.
    */
   async list(
     request?: operations.GetCustomersRequest | undefined,
     options?: RequestOptions,
-  ): Promise<Array<operations.GetCustomersResponseBody>> {
-    return unwrapAsync(customersList(
+  ): Promise<
+    PageIterator<operations.GetCustomersResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(customersList(
       this,
       request,
       options,
@@ -32,7 +35,7 @@ export class Customers extends ClientSDK {
    * Retrieve a customer
    *
    * @remarks
-   * Retrieve a customer by ID for the authenticated workspace.
+   * Retrieve a customer by ID for the authenticated workspace. To retrieve a customer by external ID, prefix the ID with `ext_`.
    */
   async get(
     request: operations.GetCustomerRequest,

package/src/sdk/domains.ts

@@ -16,10 +16,10 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Domains extends ClientSDK {
   /**
-   * Retrieve a list of domains
+   * List all domains
    *
    * @remarks
-   * Retrieve a list of domains associated with the authenticated workspace.
+   * Retrieve a paginated list of domains for the authenticated workspace.
    */
   async list(
     request?: operations.ListDomainsRequest | undefined,

package/src/sdk/embedtokens.ts

@@ -12,7 +12,7 @@ export class EmbedTokens extends ClientSDK {
    * Create a referrals embed token
    *
    * @remarks
-   * Create a referrals embed token for the given partner/tenant.
+   * Create a referrals embed token for the given partner/tenant. The endpoint first attempts to locate an existing enrollment using the provided tenantId. If no enrollment is found, it resolves the partner by email and creates a new enrollment as needed. This results in an upsert-style flow that guarantees a valid enrollment and returns a usable embed token.
    */
   async referrals(
     request?: operations.CreateReferralsEmbedTokenRequestBody | undefined,

package/src/sdk/events.ts

@@ -9,7 +9,7 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Events extends ClientSDK {
   /**
-   * Retrieve a list of events
+   * List all events
    *
    * @remarks
    * Retrieve a paginated list of events for the authenticated workspace.

package/src/sdk/folders.ts

@@ -13,10 +13,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Folders extends ClientSDK {
   /**
-   * Retrieve a list of folders
+   * List all folders
    *
    * @remarks
-   * Retrieve a list of folders for the authenticated workspace.
+   * Retrieve a paginated list of folders for the authenticated workspace.
    */
   async list(
     request?: operations.ListFoldersRequest | undefined,

package/src/sdk/links.ts

@@ -20,7 +20,7 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Links extends ClientSDK {
   /**
-   * Retrieve a list of links
+   * List all links
    *
    * @remarks
    * Retrieve a paginated list of links for the authenticated workspace.

package/src/sdk/partnerapplications.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { partnerApplicationsApprove } from "../funcs/partnerApplicationsApprove.js";
+import { partnerApplicationsList } from "../funcs/partnerApplicationsList.js";
+import { partnerApplicationsReject } from "../funcs/partnerApplicationsReject.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class PartnerApplications extends ClientSDK {
+  /**
+   * List all pending partner applications
+   *
+   * @remarks
+   * Retrieve a paginated list of pending applications for your partner program.
+   */
+  async list(
+    request?: operations.ListPartnerApplicationsRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<Array<operations.ListPartnerApplicationsResponseBody>> {
+    return unwrapAsync(partnerApplicationsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Approve a partner application
+   *
+   * @remarks
+   * Approve a pending partner application to your program. The partner will be enrolled in the specified group and notified of the approval.
+   */
+  async approve(
+    request: operations.ApprovePartnerRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.ApprovePartnerResponseBody> {
+    return unwrapAsync(partnerApplicationsApprove(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Reject a partner application
+   *
+   * @remarks
+   * Reject a pending partner application to your program. The partner will be notified via email that their application was not approved.
+   */
+  async reject(
+    request: operations.RejectPartnerRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.RejectPartnerResponseBody> {
+    return unwrapAsync(partnerApplicationsReject(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/payouts.ts

@@ -12,7 +12,7 @@ export class Payouts extends ClientSDK {
    * List all payouts
    *
    * @remarks
-   * Retrieve a list of payouts for your partner program.
+   * Retrieve a paginated list of payouts for your partner program.
    */
   async list(
     request?: operations.ListPayoutsRequest | undefined,

package/src/sdk/sdk.ts

@@ -12,6 +12,7 @@ import { EmbedTokens } from "./embedtokens.js";
 import { Events } from "./events.js";
 import { Folders } from "./folders.js";
 import { Links } from "./links.js";
+import { PartnerApplications } from "./partnerapplications.js";
 import { Partners } from "./partners.js";
 import { Payouts } from "./payouts.js";
 import { QRCodes } from "./qrcodes.js";
@@ -64,6 +65,13 @@ export class Dub extends ClientSDK {
     return (this._partners ??= new Partners(this._options));
   }
 
+  private _partnerApplications?: PartnerApplications;
+  get partnerApplications(): PartnerApplications {
+    return (this._partnerApplications ??= new PartnerApplications(
+      this._options,
+    ));
+  }
+
   private _commissions?: Commissions;
   get commissions(): Commissions {
     return (this._commissions ??= new Commissions(this._options));

package/src/sdk/tags.ts

@@ -13,10 +13,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Tags extends ClientSDK {
   /**
-   * Retrieve a list of tags
+   * List all tags
    *
    * @remarks
-   * Retrieve a list of tags for the authenticated workspace.
+   * Retrieve a paginated list of tags for the authenticated workspace.
    */
   async list(
     request?: operations.GetTagsRequest | undefined,