dub 0.71.6 → 0.71.7

package/src/models/operations/listpartnerapplications.ts

@@ -0,0 +1,236 @@
+/*
+ * 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";
+
+export type ListPartnerApplicationsRequest = {
+  /**
+   * A filter on the list based on the partner's `country` field.
+   */
+  country?: string | undefined;
+  /**
+   * A filter on the list based on the partner's `groupId` field.
+   */
+  groupId?: string | undefined;
+  /**
+   * The page number for pagination.
+   */
+  page?: number | undefined;
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number | undefined;
+};
+
+/**
+ * The status of the partner's enrollment in the program.
+ */
+export const ListPartnerApplicationsStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Rejected: "rejected",
+  Invited: "invited",
+  Declined: "declined",
+  Deactivated: "deactivated",
+  Banned: "banned",
+  Archived: "archived",
+} as const;
+/**
+ * The status of the partner's enrollment in the program.
+ */
+export type ListPartnerApplicationsStatus = ClosedEnum<
+  typeof ListPartnerApplicationsStatus
+>;
+
+export type ListPartnerApplicationsPartner = {
+  /**
+   * The partner's unique ID on Dub.
+   */
+  id: string;
+  /**
+   * The partner's full legal name.
+   */
+  name: string;
+  /**
+   * If the partner profile type is a company, this is the partner's legal company name.
+   */
+  companyName: string | null;
+  /**
+   * The partner's email address. Should be a unique value across Dub.
+   */
+  email: string | null;
+  /**
+   * The partner's avatar image.
+   */
+  image: string | null;
+  /**
+   * A brief description of the partner and their background.
+   */
+  description?: string | null | undefined;
+  /**
+   * The partner's country (required for tax purposes).
+   */
+  country: string | null;
+  /**
+   * The partner's group ID on Dub.
+   */
+  groupId?: string | null | undefined;
+  /**
+   * The status of the partner's enrollment in the program.
+   */
+  status: ListPartnerApplicationsStatus;
+  /**
+   * The partner's website URL (including the https protocol).
+   */
+  website?: string | null | undefined;
+  /**
+   * The partner's YouTube channel username (e.g. `johndoe`).
+   */
+  youtube?: string | null | undefined;
+  /**
+   * The partner's Twitter username (e.g. `johndoe`).
+   */
+  twitter?: string | null | undefined;
+  /**
+   * The partner's LinkedIn username (e.g. `johndoe`).
+   */
+  linkedin?: string | null | undefined;
+  /**
+   * The partner's Instagram username (e.g. `johndoe`).
+   */
+  instagram?: string | null | undefined;
+  /**
+   * The partner's TikTok username (e.g. `johndoe`).
+   */
+  tiktok?: string | null | undefined;
+};
+
+export type ApplicationFormData = {
+  label: string;
+  value: string | null;
+};
+
+export type ListPartnerApplicationsResponseBody = {
+  id: string;
+  createdAt: string;
+  partner: ListPartnerApplicationsPartner;
+  applicationFormData: Array<ApplicationFormData> | null;
+};
+
+/** @internal */
+export type ListPartnerApplicationsRequest$Outbound = {
+  country?: string | undefined;
+  groupId?: string | undefined;
+  page?: number | undefined;
+  pageSize: number;
+};
+
+/** @internal */
+export const ListPartnerApplicationsRequest$outboundSchema: z.ZodType<
+  ListPartnerApplicationsRequest$Outbound,
+  z.ZodTypeDef,
+  ListPartnerApplicationsRequest
+> = z.object({
+  country: z.string().optional(),
+  groupId: z.string().optional(),
+  page: z.number().optional(),
+  pageSize: z.number().default(100),
+});
+
+export function listPartnerApplicationsRequestToJSON(
+  listPartnerApplicationsRequest: ListPartnerApplicationsRequest,
+): string {
+  return JSON.stringify(
+    ListPartnerApplicationsRequest$outboundSchema.parse(
+      listPartnerApplicationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ListPartnerApplicationsStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListPartnerApplicationsStatus
+> = z.nativeEnum(ListPartnerApplicationsStatus);
+
+/** @internal */
+export const ListPartnerApplicationsPartner$inboundSchema: z.ZodType<
+  ListPartnerApplicationsPartner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  companyName: z.nullable(z.string()),
+  email: z.nullable(z.string()),
+  image: z.nullable(z.string()),
+  description: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()),
+  groupId: z.nullable(z.string()).optional(),
+  status: ListPartnerApplicationsStatus$inboundSchema,
+  website: z.nullable(z.string()).optional(),
+  youtube: z.nullable(z.string()).optional(),
+  twitter: z.nullable(z.string()).optional(),
+  linkedin: z.nullable(z.string()).optional(),
+  instagram: z.nullable(z.string()).optional(),
+  tiktok: z.nullable(z.string()).optional(),
+});
+
+export function listPartnerApplicationsPartnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPartnerApplicationsPartner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListPartnerApplicationsPartner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPartnerApplicationsPartner' from JSON`,
+  );
+}
+
+/** @internal */
+export const ApplicationFormData$inboundSchema: z.ZodType<
+  ApplicationFormData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  label: z.string(),
+  value: z.nullable(z.string()),
+});
+
+export function applicationFormDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ApplicationFormData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ApplicationFormData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ApplicationFormData' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListPartnerApplicationsResponseBody$inboundSchema: z.ZodType<
+  ListPartnerApplicationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  createdAt: z.string(),
+  partner: z.lazy(() => ListPartnerApplicationsPartner$inboundSchema),
+  applicationFormData: z.nullable(
+    z.array(z.lazy(() => ApplicationFormData$inboundSchema)),
+  ),
+});
+
+export function listPartnerApplicationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListPartnerApplicationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListPartnerApplicationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListPartnerApplicationsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/listpartners.ts

@@ -394,6 +394,10 @@ export type ListPartnersResponseBody = {
    * The date when the partner received the trusted badge in the partner network.
    */
   trustedAt: string | null;
+  /**
+   * The date when the partner's identity was verified.
+   */
+  identityVerifiedAt: string | null;
   /**
    * The program's unique ID on Dub.
    */
@@ -959,6 +963,7 @@ export const ListPartnersResponseBody$inboundSchema: z.ZodType<
   stripeConnectId: z.nullable(z.string()),
   payoutsEnabledAt: z.nullable(z.string()),
   trustedAt: z.nullable(z.string()),
+  identityVerifiedAt: z.nullable(z.string()),
   programId: z.string(),
   groupId: z.nullable(z.string()).optional(),
   partnerId: z.string(),

package/src/models/operations/rejectbountysubmission.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * The reason for rejecting the submission.
  */
-export const RejectionReason = {
+export const RejectBountySubmissionRejectionReason = {
   InvalidProof: "invalidProof",
   DuplicateSubmission: "duplicateSubmission",
   OutOfTimeWindow: "outOfTimeWindow",
@@ -22,13 +22,15 @@ export const RejectionReason = {
 /**
  * The reason for rejecting the submission.
  */
-export type RejectionReason = ClosedEnum<typeof RejectionReason>;
+export type RejectBountySubmissionRejectionReason = ClosedEnum<
+  typeof RejectBountySubmissionRejectionReason
+>;
 
 export type RejectBountySubmissionRequestBody = {
   /**
    * The reason for rejecting the submission.
    */
-  rejectionReason?: RejectionReason | undefined;
+  rejectionReason?: RejectBountySubmissionRejectionReason | undefined;
   /**
    * The note for rejecting the submission.
    */
@@ -149,9 +151,10 @@ export type RejectBountySubmissionResponseBody = {
 };
 
 /** @internal */
-export const RejectionReason$outboundSchema: z.ZodNativeEnum<
-  typeof RejectionReason
-> = z.nativeEnum(RejectionReason);
+export const RejectBountySubmissionRejectionReason$outboundSchema:
+  z.ZodNativeEnum<typeof RejectBountySubmissionRejectionReason> = z.nativeEnum(
+    RejectBountySubmissionRejectionReason,
+  );
 
 /** @internal */
 export type RejectBountySubmissionRequestBody$Outbound = {
@@ -165,7 +168,8 @@ export const RejectBountySubmissionRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RejectBountySubmissionRequestBody
 > = z.object({
-  rejectionReason: RejectionReason$outboundSchema.optional(),
+  rejectionReason: RejectBountySubmissionRejectionReason$outboundSchema
+    .optional(),
   rejectionNote: z.string().optional(),
 });
 

package/src/models/operations/rejectpartner.ts

@@ -0,0 +1,104 @@
+/*
+ * 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";
+
+/**
+ * The reason for rejecting the partner application. This will be shared with the partner via email.
+ */
+export const RejectionReason = {
+  NeedsMoreDetail: "needsMoreDetail",
+  DoesNotMeetRequirements: "doesNotMeetRequirements",
+  NotTheRightFit: "notTheRightFit",
+  Other: "other",
+} as const;
+/**
+ * The reason for rejecting the partner application. This will be shared with the partner via email.
+ */
+export type RejectionReason = ClosedEnum<typeof RejectionReason>;
+
+export type RejectPartnerRequestBody = {
+  /**
+   * The ID of the partner to reject.
+   */
+  partnerId: string;
+  /**
+   * The reason for rejecting the partner application. This will be shared with the partner via email.
+   */
+  rejectionReason?: RejectionReason | undefined;
+  /**
+   * Additional details about the rejection. This will be shared with the partner via email.
+   */
+  rejectionNote?: string | undefined;
+  /**
+   * When true, pending enrollment is removed so the partner can submit a new application immediately.
+   */
+  allowImmediateReapply?: boolean | undefined;
+};
+
+/**
+ * The rejected partner
+ */
+export type RejectPartnerResponseBody = {
+  /**
+   * The ID of the rejected partner.
+   */
+  partnerId: string;
+};
+
+/** @internal */
+export const RejectionReason$outboundSchema: z.ZodNativeEnum<
+  typeof RejectionReason
+> = z.nativeEnum(RejectionReason);
+
+/** @internal */
+export type RejectPartnerRequestBody$Outbound = {
+  partnerId: string;
+  rejectionReason?: string | undefined;
+  rejectionNote?: string | undefined;
+  allowImmediateReapply: boolean;
+};
+
+/** @internal */
+export const RejectPartnerRequestBody$outboundSchema: z.ZodType<
+  RejectPartnerRequestBody$Outbound,
+  z.ZodTypeDef,
+  RejectPartnerRequestBody
+> = z.object({
+  partnerId: z.string(),
+  rejectionReason: RejectionReason$outboundSchema.optional(),
+  rejectionNote: z.string().optional(),
+  allowImmediateReapply: z.boolean().default(false),
+});
+
+export function rejectPartnerRequestBodyToJSON(
+  rejectPartnerRequestBody: RejectPartnerRequestBody,
+): string {
+  return JSON.stringify(
+    RejectPartnerRequestBody$outboundSchema.parse(rejectPartnerRequestBody),
+  );
+}
+
+/** @internal */
+export const RejectPartnerResponseBody$inboundSchema: z.ZodType<
+  RejectPartnerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  partnerId: z.string(),
+});
+
+export function rejectPartnerResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<RejectPartnerResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RejectPartnerResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RejectPartnerResponseBody' from JSON`,
+  );
+}

package/src/models/operations/updatecommission.ts

@@ -25,6 +25,10 @@ export const Status = {
 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.
    */
@@ -33,10 +37,6 @@ export type UpdateCommissionRequestBody = {
    * 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.
    */
   modifySaleAmount?: number | undefined;
-  /**
-   * The new absolute earnings for the custom commission. Paid commissions cannot be updated.
-   */
-  earnings?: number | undefined;
   /**
    * The currency of the sale amount to update. Accepts ISO 4217 currency codes.
    */
@@ -200,9 +200,9 @@ export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> = z
 
 /** @internal */
 export type UpdateCommissionRequestBody$Outbound = {
+  earnings?: number | undefined;
   saleAmount?: number | undefined;
   modifySaleAmount?: number | undefined;
-  earnings?: number | undefined;
   currency: string;
   status?: string | undefined;
   amount?: number | undefined;
@@ -215,9 +215,9 @@ export const UpdateCommissionRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateCommissionRequestBody
 > = z.object({
+  earnings: z.number().optional(),
   saleAmount: z.number().optional(),
   modifySaleAmount: z.number().optional(),
-  earnings: z.number().optional(),
   currency: z.string().default("usd"),
   status: Status$outboundSchema.optional(),
   amount: z.number().optional(),

package/src/sdk/commissions.ts

@@ -15,7 +15,7 @@ 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,

package/src/sdk/customers.ts

@@ -13,10 +13,10 @@ 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,
@@ -35,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/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,