dub 0.70.0 → 0.71.0

package/src/models/operations/createpartner.ts

@@ -237,6 +237,117 @@ export const BannedReason = {
  */
 export type BannedReason = ClosedEnum<typeof BannedReason>;
 
+export type Eight = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "phone";
+};
+
+export type Seven = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "number";
+};
+
+export type FieldsOptions = {
+  label: string;
+  value: string;
+};
+
+export type Six = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "multiSelect";
+  options: Array<FieldsOptions>;
+};
+
+export type Five = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "date";
+};
+
+export type Fields4 = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "country";
+};
+
+export type Options = {
+  label: string;
+  value: string;
+};
+
+export type Fields3 = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "select";
+  options: Array<Options>;
+};
+
+export type FieldsConstraints = {
+  maxLength?: number | undefined;
+};
+
+export type Fields2 = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "textarea";
+  constraints?: FieldsConstraints | undefined;
+};
+
+export type Constraints = {
+  maxLength?: number | undefined;
+  pattern?: string | undefined;
+};
+
+export type Fields1 = {
+  key: string;
+  label: string;
+  required: boolean;
+  locked: boolean;
+  position: number;
+  type: "text";
+  constraints?: Constraints | undefined;
+};
+
+export type Fields =
+  | Fields1
+  | Fields2
+  | Fields3
+  | Fields4
+  | Five
+  | Six
+  | Seven
+  | Eight;
+
+export type ReferralFormData = {
+  fields: Array<
+    Fields1 | Fields2 | Fields3 | Fields4 | Five | Six | Seven | Eight
+  >;
+};
+
 /**
  * The created or updated partner
  */
@@ -330,6 +441,7 @@ export type CreatePartnerResponseBody = {
    * If the partner was banned from the program, this is the reason for the ban.
    */
   bannedReason?: BannedReason | null | undefined;
+  referralFormData?: ReferralFormData | null | undefined;
   /**
    * The total number of clicks on the partner's links
    */
@@ -600,6 +712,307 @@ export function linksFromJSON(
 export const BannedReason$inboundSchema: z.ZodNativeEnum<typeof BannedReason> =
   z.nativeEnum(BannedReason);
 
+/** @internal */
+export const Eight$inboundSchema: z.ZodType<Eight, z.ZodTypeDef, unknown> = z
+  .object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("phone"),
+  });
+
+export function eightFromJSON(
+  jsonString: string,
+): SafeParseResult<Eight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Eight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Eight' from JSON`,
+  );
+}
+
+/** @internal */
+export const Seven$inboundSchema: z.ZodType<Seven, z.ZodTypeDef, unknown> = z
+  .object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("number"),
+  });
+
+export function sevenFromJSON(
+  jsonString: string,
+): SafeParseResult<Seven, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Seven$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Seven' from JSON`,
+  );
+}
+
+/** @internal */
+export const FieldsOptions$inboundSchema: z.ZodType<
+  FieldsOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  label: z.string(),
+  value: z.string(),
+});
+
+export function fieldsOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<FieldsOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FieldsOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FieldsOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const Six$inboundSchema: z.ZodType<Six, z.ZodTypeDef, unknown> = z
+  .object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("multiSelect"),
+    options: z.array(z.lazy(() => FieldsOptions$inboundSchema)),
+  });
+
+export function sixFromJSON(
+  jsonString: string,
+): SafeParseResult<Six, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Six$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Six' from JSON`,
+  );
+}
+
+/** @internal */
+export const Five$inboundSchema: z.ZodType<Five, z.ZodTypeDef, unknown> = z
+  .object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("date"),
+  });
+
+export function fiveFromJSON(
+  jsonString: string,
+): SafeParseResult<Five, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Five$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Five' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fields4$inboundSchema: z.ZodType<Fields4, z.ZodTypeDef, unknown> =
+  z.object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("country"),
+  });
+
+export function fields4FromJSON(
+  jsonString: string,
+): SafeParseResult<Fields4, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fields4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fields4' from JSON`,
+  );
+}
+
+/** @internal */
+export const Options$inboundSchema: z.ZodType<Options, z.ZodTypeDef, unknown> =
+  z.object({
+    label: z.string(),
+    value: z.string(),
+  });
+
+export function optionsFromJSON(
+  jsonString: string,
+): SafeParseResult<Options, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Options$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Options' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fields3$inboundSchema: z.ZodType<Fields3, z.ZodTypeDef, unknown> =
+  z.object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("select"),
+    options: z.array(z.lazy(() => Options$inboundSchema)),
+  });
+
+export function fields3FromJSON(
+  jsonString: string,
+): SafeParseResult<Fields3, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fields3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fields3' from JSON`,
+  );
+}
+
+/** @internal */
+export const FieldsConstraints$inboundSchema: z.ZodType<
+  FieldsConstraints,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  maxLength: z.number().int().optional(),
+});
+
+export function fieldsConstraintsFromJSON(
+  jsonString: string,
+): SafeParseResult<FieldsConstraints, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FieldsConstraints$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FieldsConstraints' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fields2$inboundSchema: z.ZodType<Fields2, z.ZodTypeDef, unknown> =
+  z.object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("textarea"),
+    constraints: z.lazy(() => FieldsConstraints$inboundSchema).optional(),
+  });
+
+export function fields2FromJSON(
+  jsonString: string,
+): SafeParseResult<Fields2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fields2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fields2' from JSON`,
+  );
+}
+
+/** @internal */
+export const Constraints$inboundSchema: z.ZodType<
+  Constraints,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  maxLength: z.number().int().optional(),
+  pattern: z.string().optional(),
+});
+
+export function constraintsFromJSON(
+  jsonString: string,
+): SafeParseResult<Constraints, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Constraints$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Constraints' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fields1$inboundSchema: z.ZodType<Fields1, z.ZodTypeDef, unknown> =
+  z.object({
+    key: z.string(),
+    label: z.string(),
+    required: z.boolean(),
+    locked: z.boolean(),
+    position: z.number().int(),
+    type: z.literal("text"),
+    constraints: z.lazy(() => Constraints$inboundSchema).optional(),
+  });
+
+export function fields1FromJSON(
+  jsonString: string,
+): SafeParseResult<Fields1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fields1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fields1' from JSON`,
+  );
+}
+
+/** @internal */
+export const Fields$inboundSchema: z.ZodType<Fields, z.ZodTypeDef, unknown> = z
+  .union([
+    z.lazy(() => Fields1$inboundSchema),
+    z.lazy(() => Fields2$inboundSchema),
+    z.lazy(() => Fields3$inboundSchema),
+    z.lazy(() => Fields4$inboundSchema),
+    z.lazy(() => Five$inboundSchema),
+    z.lazy(() => Six$inboundSchema),
+    z.lazy(() => Seven$inboundSchema),
+    z.lazy(() => Eight$inboundSchema),
+  ]);
+
+export function fieldsFromJSON(
+  jsonString: string,
+): SafeParseResult<Fields, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Fields$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Fields' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReferralFormData$inboundSchema: z.ZodType<
+  ReferralFormData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fields: z.array(
+    z.union([
+      z.lazy(() => Fields1$inboundSchema),
+      z.lazy(() => Fields2$inboundSchema),
+      z.lazy(() => Fields3$inboundSchema),
+      z.lazy(() => Fields4$inboundSchema),
+      z.lazy(() => Five$inboundSchema),
+      z.lazy(() => Six$inboundSchema),
+      z.lazy(() => Seven$inboundSchema),
+      z.lazy(() => Eight$inboundSchema),
+    ]),
+  ),
+});
+
+export function referralFormDataFromJSON(
+  jsonString: string,
+): SafeParseResult<ReferralFormData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReferralFormData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReferralFormData' from JSON`,
+  );
+}
+
 /** @internal */
 export const CreatePartnerResponseBody$inboundSchema: z.ZodType<
   CreatePartnerResponseBody,
@@ -632,6 +1045,8 @@ export const CreatePartnerResponseBody$inboundSchema: z.ZodType<
   applicationId: z.nullable(z.string()).optional(),
   bannedAt: z.nullable(z.string()).optional(),
   bannedReason: z.nullable(BannedReason$inboundSchema).optional(),
+  referralFormData: z.nullable(z.lazy(() => ReferralFormData$inboundSchema))
+    .optional(),
   totalClicks: z.number().default(0),
   totalLeads: z.number().default(0),
   totalConversions: z.number().default(0),

package/src/models/operations/deactivatepartner.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DeactivatePartnerRequestBody = {
+  /**
+   * The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.
+   */
+  partnerId?: string | null | undefined;
+  /**
+   * The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.
+   */
+  tenantId?: string | null | undefined;
+};
+
+/**
+ * The deactivated partner
+ */
+export type DeactivatePartnerResponseBody = {
+  /**
+   * The ID of the deactivated partner.
+   */
+  partnerId: string;
+};
+
+/** @internal */
+export type DeactivatePartnerRequestBody$Outbound = {
+  partnerId?: string | null | undefined;
+  tenantId?: string | null | undefined;
+};
+
+/** @internal */
+export const DeactivatePartnerRequestBody$outboundSchema: z.ZodType<
+  DeactivatePartnerRequestBody$Outbound,
+  z.ZodTypeDef,
+  DeactivatePartnerRequestBody
+> = z.object({
+  partnerId: z.nullable(z.string()).optional(),
+  tenantId: z.nullable(z.string()).optional(),
+});
+
+export function deactivatePartnerRequestBodyToJSON(
+  deactivatePartnerRequestBody: DeactivatePartnerRequestBody,
+): string {
+  return JSON.stringify(
+    DeactivatePartnerRequestBody$outboundSchema.parse(
+      deactivatePartnerRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export const DeactivatePartnerResponseBody$inboundSchema: z.ZodType<
+  DeactivatePartnerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  partnerId: z.string(),
+});
+
+export function deactivatePartnerResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<DeactivatePartnerResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeactivatePartnerResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeactivatePartnerResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getcustomer.ts

@@ -90,10 +90,6 @@ export type GetCustomerResponseBody = {
    * The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
    */
   id: string;
-  /**
-   * Unique identifier for the customer in the client's app.
-   */
-  externalId: string;
   /**
    * Name of the customer.
    */
@@ -106,6 +102,14 @@ export type GetCustomerResponseBody = {
    * Avatar URL of the customer.
    */
   avatar?: string | null | undefined;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred the customer.
+   */
+  stripeCustomerId?: string | null | undefined;
   /**
    * Country of the customer.
    */
@@ -119,9 +123,17 @@ export type GetCustomerResponseBody = {
    */
   saleAmount?: number | null | undefined;
   /**
-   * The date the customer was created.
+   * The date the customer was created (usually the signup date or trial start date).
    */
   createdAt: string;
+  /**
+   * The date the customer made their first sale. Useful for calculating the time to first sale and LTV.
+   */
+  firstSaleAt?: string | null | undefined;
+  /**
+   * The date the customer canceled their subscription. Useful for calculating LTV and churn rate.
+   */
+  subscriptionCanceledAt?: string | null | undefined;
   link?: GetCustomerLink | null | undefined;
   programId?: string | null | undefined;
   partner?: GetCustomerPartner | null | undefined;
@@ -236,14 +248,17 @@ export const GetCustomerResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  externalId: z.string(),
   name: z.string(),
   email: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
+  externalId: z.string(),
+  stripeCustomerId: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()).optional(),
   sales: z.nullable(z.number()).optional(),
   saleAmount: z.nullable(z.number()).optional(),
   createdAt: z.string(),
+  firstSaleAt: z.nullable(z.string()).optional(),
+  subscriptionCanceledAt: z.nullable(z.string()).optional(),
   link: z.nullable(z.lazy(() => GetCustomerLink$inboundSchema)).optional(),
   programId: z.nullable(z.string()).optional(),
   partner: z.nullable(z.lazy(() => GetCustomerPartner$inboundSchema))

package/src/models/operations/getcustomers.ts

@@ -14,6 +14,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export const GetCustomersQueryParamSortBy = {
   CreatedAt: "createdAt",
   SaleAmount: "saleAmount",
+  FirstSaleAt: "firstSaleAt",
+  SubscriptionCanceledAt: "subscriptionCanceledAt",
 } as const;
 /**
  * The field to sort the customers by. The default is `createdAt`.
@@ -155,10 +157,6 @@ export type GetCustomersResponseBody = {
    * The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
    */
   id: string;
-  /**
-   * Unique identifier for the customer in the client's app.
-   */
-  externalId: string;
   /**
    * Name of the customer.
    */
@@ -171,6 +169,14 @@ export type GetCustomersResponseBody = {
    * Avatar URL of the customer.
    */
   avatar?: string | null | undefined;
+  /**
+   * Unique identifier for the customer in the client's app.
+   */
+  externalId: string;
+  /**
+   * The customer's Stripe customer ID. This is useful for attributing recurring sale events to the partner who referred the customer.
+   */
+  stripeCustomerId?: string | null | undefined;
   /**
    * Country of the customer.
    */
@@ -184,9 +190,17 @@ export type GetCustomersResponseBody = {
    */
   saleAmount?: number | null | undefined;
   /**
-   * The date the customer was created.
+   * The date the customer was created (usually the signup date or trial start date).
    */
   createdAt: string;
+  /**
+   * The date the customer made their first sale. Useful for calculating the time to first sale and LTV.
+   */
+  firstSaleAt?: string | null | undefined;
+  /**
+   * The date the customer canceled their subscription. Useful for calculating LTV and churn rate.
+   */
+  subscriptionCanceledAt?: string | null | undefined;
   link?: GetCustomersLink | null | undefined;
   programId?: string | null | undefined;
   partner?: GetCustomersPartner | null | undefined;
@@ -331,14 +345,17 @@ export const GetCustomersResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  externalId: z.string(),
   name: z.string(),
   email: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
+  externalId: z.string(),
+  stripeCustomerId: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()).optional(),
   sales: z.nullable(z.number()).optional(),
   saleAmount: z.nullable(z.number()).optional(),
   createdAt: z.string(),
+  firstSaleAt: z.nullable(z.string()).optional(),
+  subscriptionCanceledAt: z.nullable(z.string()).optional(),
   link: z.nullable(z.lazy(() => GetCustomersLink$inboundSchema)).optional(),
   programId: z.nullable(z.string()).optional(),
   partner: z.nullable(z.lazy(() => GetCustomersPartner$inboundSchema))

package/src/models/operations/index.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./approvebountysubmission.js";
 export * from "./banpartner.js";
 export * from "./bulkcreatelinks.js";
 export * from "./bulkdeletelinks.js";
@@ -14,6 +15,7 @@ export * from "./createpartner.js";
 export * from "./createpartnerlink.js";
 export * from "./createreferralsembedtoken.js";
 export * from "./createtag.js";
+export * from "./deactivatepartner.js";
 export * from "./deletecustomer.js";
 export * from "./deletedomain.js";
 export * from "./deletefolder.js";
@@ -26,13 +28,14 @@ export * from "./getlinks.js";
 export * from "./getlinkscount.js";
 export * from "./getqrcode.js";
 export * from "./gettags.js";
-export * from "./getworkspace.js";
+export * from "./listbountysubmissions.js";
 export * from "./listcommissions.js";
 export * from "./listdomains.js";
 export * from "./listevents.js";
 export * from "./listfolders.js";
 export * from "./listpartners.js";
 export * from "./registerdomain.js";
+export * from "./rejectbountysubmission.js";
 export * from "./retrieveanalytics.js";
 export * from "./retrievelinks.js";
 export * from "./retrievepartneranalytics.js";
@@ -44,6 +47,5 @@ export * from "./updatedomain.js";
 export * from "./updatefolder.js";
 export * from "./updatelink.js";
 export * from "./updatetag.js";
-export * from "./updateworkspace.js";
 export * from "./upsertlink.js";
 export * from "./upsertpartnerlink.js";