dub 0.64.2 → 0.64.3

package/src/models/components/saleevent.ts

@@ -20,6 +20,37 @@ export const SaleEventEvent = {
 } as const;
 export type SaleEventEvent = ClosedEnum<typeof SaleEventEvent>;
 
+/**
+ * The payment processor via which the sale was made.
+ */
+export const PaymentProcessor = {
+  Stripe: "stripe",
+  Shopify: "shopify",
+  Polar: "polar",
+  Paddle: "paddle",
+  Revenuecat: "revenuecat",
+  Custom: "custom",
+} as const;
+/**
+ * The payment processor via which the sale was made.
+ */
+export type PaymentProcessor = ClosedEnum<typeof PaymentProcessor>;
+
+export type Sale = {
+  /**
+   * The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency
+   */
+  amount: number;
+  /**
+   * The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.
+   */
+  invoiceId?: string | null | undefined;
+  /**
+   * The payment processor via which the sale was made.
+   */
+  paymentProcessor: PaymentProcessor;
+};
+
 /**
  * Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
  */
@@ -351,12 +382,6 @@ export type SaleEventLink = {
    */
   geo: SaleEventGeo | null;
   publicStats: boolean;
-  /**
-   * The unique ID of the tag assigned to the short link. This field is deprecated – use `tags` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  tagId: string | null;
   /**
    * The tags assigned to the short link.
    */
@@ -416,23 +441,33 @@ export type SaleEventLink = {
    * The number of clicks on the short link.
    */
   clicks?: number | undefined;
-  lastClicked: string;
   /**
-   * The number of leads the short links has generated.
+   * The number of leads the short link has generated.
    */
   leads?: number | undefined;
   /**
-   * The number of sales the short links has generated.
+   * The number of leads that converted to paying customers.
+   */
+  conversions?: number | undefined;
+  /**
+   * The total number of sales (includes recurring sales) generated by the short link.
    */
   sales?: number | undefined;
   /**
-   * The total dollar amount of sales the short links has generated (in cents).
+   * The total dollar value of sales (in cents) generated by the short link.
    */
   saleAmount?: number | undefined;
+  lastClicked: string;
   createdAt: string;
   updatedAt: string;
   /**
-   * The project ID of the short link. This field is deprecated – use `workspaceId` instead.
+   * Deprecated: Use `tags` instead. The unique ID of the tag assigned to the short link.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  tagId: string | null;
+  /**
+   * Deprecated: Use `workspaceId` instead. The project ID of the short link.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -450,6 +485,7 @@ export type SaleEventClick = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -495,136 +531,108 @@ export type SaleEventCustomer = {
   createdAt: string;
 };
 
-/**
- * The payment processor via which the sale was made.
- */
-export const PaymentProcessor = {
-  Stripe: "stripe",
-  Shopify: "shopify",
-  Polar: "polar",
-  Paddle: "paddle",
-  Revenuecat: "revenuecat",
-  Custom: "custom",
-} as const;
-/**
- * The payment processor via which the sale was made.
- */
-export type PaymentProcessor = ClosedEnum<typeof PaymentProcessor>;
-
-export type Sale = {
-  /**
-   * The amount of the sale in cents (for all two-decimal currencies). If the sale is in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn more: https://d.to/currency
-   */
-  amount: number;
-  /**
-   * The invoice ID of the sale. Can be used as a idempotency key – only one sale event can be recorded for a given invoice ID.
-   */
-  invoiceId?: string | null | undefined;
-  /**
-   * The payment processor via which the sale was made.
-   */
-  paymentProcessor: PaymentProcessor;
-};
-
 export type SaleEvent = {
   event: SaleEventEvent;
   timestamp: string;
   eventId: string;
   eventName: string;
+  sale: Sale;
+  metadata?: any | null | undefined;
   link: SaleEventLink;
   click: SaleEventClick;
   customer: SaleEventCustomer;
-  sale: Sale;
   /**
-   * Deprecated. Use `sale.amount` instead.
+   * Deprecated: Use `sale.amount` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   saleAmount: number;
   /**
-   * Deprecated. Use `sale.invoiceId` instead.
+   * Deprecated: Use `sale.invoiceId` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   invoiceId: string;
   /**
-   * Deprecated. Use `sale.paymentProcessor` instead.
+   * Deprecated: Use `sale.paymentProcessor` instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   paymentProcessor: string;
   /**
-   * Deprecated. Use `click.id` instead.
+   * Deprecated: Use `click.id` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   clickId: string;
   /**
-   * Deprecated. Use `link.id` instead.
+   * Deprecated: Use `link.id` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   linkId: string;
   /**
-   * Deprecated. Use `link.domain` instead.
+   * Deprecated: Use `link.domain` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   domain: string;
   /**
-   * Deprecated. Use `link.key` instead.
+   * Deprecated: Use `link.key` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   key: string;
   /**
-   * Deprecated. Use `click.url` instead.
+   * Deprecated: Use `click.url` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   url: string;
   /**
-   * Deprecated. Use `click.continent` instead.
+   * Deprecated: Use `click.continent` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   continent: string;
   /**
-   * Deprecated. Use `click.country` instead.
+   * Deprecated: Use `click.country` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   country: string;
   /**
-   * Deprecated. Use `click.city` instead.
+   * Deprecated: Use `click.city` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   city: string;
   /**
-   * Deprecated. Use `click.device` instead.
+   * Deprecated: Use `click.device` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   device: string;
   /**
-   * Deprecated. Use `click.browser` instead.
+   * Deprecated: Use `click.browser` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   browser: string;
   /**
-   * Deprecated. Use `click.os` instead.
+   * Deprecated: Use `click.os` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   os: string;
   /**
-   * Deprecated. Use `click.qr` instead.
+   * Deprecated: Use `click.qr` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   qr: number;
   /**
-   * Deprecated. Use `click.ip` instead.
+   * Deprecated: Use `click.ip` instead.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -652,6 +660,77 @@ export namespace SaleEventEvent$ {
   export const outboundSchema = SaleEventEvent$outboundSchema;
 }
 
+/** @internal */
+export const PaymentProcessor$inboundSchema: z.ZodNativeEnum<
+  typeof PaymentProcessor
+> = z.nativeEnum(PaymentProcessor);
+
+/** @internal */
+export const PaymentProcessor$outboundSchema: z.ZodNativeEnum<
+  typeof PaymentProcessor
+> = PaymentProcessor$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PaymentProcessor$ {
+  /** @deprecated use `PaymentProcessor$inboundSchema` instead. */
+  export const inboundSchema = PaymentProcessor$inboundSchema;
+  /** @deprecated use `PaymentProcessor$outboundSchema` instead. */
+  export const outboundSchema = PaymentProcessor$outboundSchema;
+}
+
+/** @internal */
+export const Sale$inboundSchema: z.ZodType<Sale, z.ZodTypeDef, unknown> = z
+  .object({
+    amount: z.number().int(),
+    invoiceId: z.nullable(z.string()).default(null),
+    paymentProcessor: PaymentProcessor$inboundSchema,
+  });
+
+/** @internal */
+export type Sale$Outbound = {
+  amount: number;
+  invoiceId: string | null;
+  paymentProcessor: string;
+};
+
+/** @internal */
+export const Sale$outboundSchema: z.ZodType<Sale$Outbound, z.ZodTypeDef, Sale> =
+  z.object({
+    amount: z.number().int(),
+    invoiceId: z.nullable(z.string()).default(null),
+    paymentProcessor: PaymentProcessor$outboundSchema,
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Sale$ {
+  /** @deprecated use `Sale$inboundSchema` instead. */
+  export const inboundSchema = Sale$inboundSchema;
+  /** @deprecated use `Sale$outboundSchema` instead. */
+  export const outboundSchema = Sale$outboundSchema;
+  /** @deprecated use `Sale$Outbound` instead. */
+  export type Outbound = Sale$Outbound;
+}
+
+export function saleToJSON(sale: Sale): string {
+  return JSON.stringify(Sale$outboundSchema.parse(sale));
+}
+
+export function saleFromJSON(
+  jsonString: string,
+): SafeParseResult<Sale, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sale$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sale' from JSON`,
+  );
+}
+
 /** @internal */
 export const SaleEventGeo$inboundSchema: z.ZodType<
   SaleEventGeo,
@@ -2042,7 +2121,6 @@ export const SaleEventLink$inboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => SaleEventGeo$inboundSchema)),
   publicStats: z.boolean(),
-  tagId: z.nullable(z.string()),
   tags: z.nullable(z.array(TagSchema$inboundSchema)),
   folderId: z.nullable(z.string()),
   webhookIds: z.array(z.string()),
@@ -2062,12 +2140,14 @@ export const SaleEventLink$inboundSchema: z.ZodType<
   userId: z.nullable(z.string()),
   workspaceId: z.string(),
   clicks: z.number().default(0),
-  lastClicked: z.string(),
   leads: z.number().default(0),
+  conversions: z.number().default(0),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
+  lastClicked: z.string(),
   createdAt: z.string(),
   updatedAt: z.string(),
+  tagId: z.nullable(z.string()),
   projectId: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -2105,7 +2185,6 @@ export type SaleEventLink$Outbound = {
   android: string | null;
   geo: SaleEventGeo$Outbound | null;
   publicStats: boolean;
-  tagId: string | null;
   tags: Array<TagSchema$Outbound> | null;
   folderId: string | null;
   webhookIds: Array<string>;
@@ -2123,12 +2202,14 @@ export type SaleEventLink$Outbound = {
   userId: string | null;
   workspaceId: string;
   clicks: number;
-  lastClicked: string;
   leads: number;
+  conversions: number;
   sales: number;
   saleAmount: number;
+  lastClicked: string;
   createdAt: string;
   updatedAt: string;
+  tagId: string | null;
   projectId: string;
 };
 
@@ -2162,7 +2243,6 @@ export const SaleEventLink$outboundSchema: z.ZodType<
   android: z.nullable(z.string()),
   geo: z.nullable(z.lazy(() => SaleEventGeo$outboundSchema)),
   publicStats: z.boolean(),
-  tagId: z.nullable(z.string()),
   tags: z.nullable(z.array(TagSchema$outboundSchema)),
   folderId: z.nullable(z.string()),
   webhookIds: z.array(z.string()),
@@ -2182,12 +2262,14 @@ export const SaleEventLink$outboundSchema: z.ZodType<
   userId: z.nullable(z.string()),
   workspaceId: z.string(),
   clicks: z.number().default(0),
-  lastClicked: z.string(),
   leads: z.number().default(0),
+  conversions: z.number().default(0),
   sales: z.number().default(0),
   saleAmount: z.number().default(0),
+  lastClicked: z.string(),
   createdAt: z.string(),
   updatedAt: z.string(),
+  tagId: z.nullable(z.string()),
   projectId: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -2242,6 +2324,7 @@ export const SaleEventClick$inboundSchema: z.ZodType<
   device: z.string(),
   browser: z.string(),
   os: z.string(),
+  trigger: z.nullable(z.string()).optional(),
   referer: z.string(),
   refererUrl: z.string(),
   qr: z.boolean(),
@@ -2260,6 +2343,7 @@ export type SaleEventClick$Outbound = {
   device: string;
   browser: string;
   os: string;
+  trigger?: string | null | undefined;
   referer: string;
   refererUrl: string;
   qr: boolean;
@@ -2282,6 +2366,7 @@ export const SaleEventClick$outboundSchema: z.ZodType<
   device: z.string(),
   browser: z.string(),
   os: z.string(),
+  trigger: z.nullable(z.string()).optional(),
   referer: z.string(),
   refererUrl: z.string(),
   qr: z.boolean(),
@@ -2393,77 +2478,6 @@ export function saleEventCustomerFromJSON(
   );
 }
 
-/** @internal */
-export const PaymentProcessor$inboundSchema: z.ZodNativeEnum<
-  typeof PaymentProcessor
-> = z.nativeEnum(PaymentProcessor);
-
-/** @internal */
-export const PaymentProcessor$outboundSchema: z.ZodNativeEnum<
-  typeof PaymentProcessor
-> = PaymentProcessor$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PaymentProcessor$ {
-  /** @deprecated use `PaymentProcessor$inboundSchema` instead. */
-  export const inboundSchema = PaymentProcessor$inboundSchema;
-  /** @deprecated use `PaymentProcessor$outboundSchema` instead. */
-  export const outboundSchema = PaymentProcessor$outboundSchema;
-}
-
-/** @internal */
-export const Sale$inboundSchema: z.ZodType<Sale, z.ZodTypeDef, unknown> = z
-  .object({
-    amount: z.number().int(),
-    invoiceId: z.nullable(z.string()).default(null),
-    paymentProcessor: PaymentProcessor$inboundSchema,
-  });
-
-/** @internal */
-export type Sale$Outbound = {
-  amount: number;
-  invoiceId: string | null;
-  paymentProcessor: string;
-};
-
-/** @internal */
-export const Sale$outboundSchema: z.ZodType<Sale$Outbound, z.ZodTypeDef, Sale> =
-  z.object({
-    amount: z.number().int(),
-    invoiceId: z.nullable(z.string()).default(null),
-    paymentProcessor: PaymentProcessor$outboundSchema,
-  });
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Sale$ {
-  /** @deprecated use `Sale$inboundSchema` instead. */
-  export const inboundSchema = Sale$inboundSchema;
-  /** @deprecated use `Sale$outboundSchema` instead. */
-  export const outboundSchema = Sale$outboundSchema;
-  /** @deprecated use `Sale$Outbound` instead. */
-  export type Outbound = Sale$Outbound;
-}
-
-export function saleToJSON(sale: Sale): string {
-  return JSON.stringify(Sale$outboundSchema.parse(sale));
-}
-
-export function saleFromJSON(
-  jsonString: string,
-): SafeParseResult<Sale, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Sale$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Sale' from JSON`,
-  );
-}
-
 /** @internal */
 export const SaleEvent$inboundSchema: z.ZodType<
   SaleEvent,
@@ -2474,10 +2488,11 @@ export const SaleEvent$inboundSchema: z.ZodType<
   timestamp: z.string(),
   eventId: z.string(),
   eventName: z.string(),
+  sale: z.lazy(() => Sale$inboundSchema),
+  metadata: z.nullable(z.any()).optional(),
   link: z.lazy(() => SaleEventLink$inboundSchema),
   click: z.lazy(() => SaleEventClick$inboundSchema),
   customer: z.lazy(() => SaleEventCustomer$inboundSchema),
-  sale: z.lazy(() => Sale$inboundSchema),
   saleAmount: z.number(),
   invoice_id: z.string(),
   payment_processor: z.string(),
@@ -2509,10 +2524,11 @@ export type SaleEvent$Outbound = {
   timestamp: string;
   eventId: string;
   eventName: string;
+  sale: Sale$Outbound;
+  metadata?: any | null | undefined;
   link: SaleEventLink$Outbound;
   click: SaleEventClick$Outbound;
   customer: SaleEventCustomer$Outbound;
-  sale: Sale$Outbound;
   saleAmount: number;
   invoice_id: string;
   payment_processor: string;
@@ -2541,10 +2557,11 @@ export const SaleEvent$outboundSchema: z.ZodType<
   timestamp: z.string(),
   eventId: z.string(),
   eventName: z.string(),
+  sale: z.lazy(() => Sale$outboundSchema),
+  metadata: z.nullable(z.any()).optional(),
   link: z.lazy(() => SaleEventLink$outboundSchema),
   click: z.lazy(() => SaleEventClick$outboundSchema),
   customer: z.lazy(() => SaleEventCustomer$outboundSchema),
-  sale: z.lazy(() => Sale$outboundSchema),
   saleAmount: z.number(),
   invoiceId: z.string(),
   paymentProcessor: z.string(),

package/src/models/operations/bulkcreatelinks.ts

@@ -69,18 +69,6 @@ export type RequestBody = {
    * Whether the short link is archived. Defaults to `false` if not provided.
    */
   archived?: boolean | undefined;
-  /**
-   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  publicStats?: boolean | undefined;
-  /**
-   * The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
-   *
-   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
-   */
-  tagId?: string | null | undefined;
   /**
    * The unique IDs of the tags assigned to the short link.
    */
@@ -189,6 +177,18 @@ export type RequestBody = {
    * The date and time when the tests were or will be completed.
    */
   testCompletedAt?: string | null | undefined;
+  /**
+   * Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  publicStats?: boolean | undefined;
+  /**
+   * Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  tagId?: string | null | undefined;
 };
 
 export type ResponseBody = components.LinkSchema | components.LinkErrorSchema;
@@ -365,8 +365,6 @@ export const RequestBody$inboundSchema: z.ZodType<
   prefix: z.string().optional(),
   trackConversion: z.boolean().optional(),
   archived: z.boolean().optional(),
-  publicStats: z.boolean().optional(),
-  tagId: z.nullable(z.string()).optional(),
   tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   tagNames: z.union([z.string(), z.array(z.string())]).optional(),
   folderId: z.nullable(z.string()).optional(),
@@ -396,6 +394,8 @@ export const RequestBody$inboundSchema: z.ZodType<
   ).optional(),
   testStartedAt: z.nullable(z.string()).optional(),
   testCompletedAt: z.nullable(z.string()).optional(),
+  publicStats: z.boolean().optional(),
+  tagId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "utm_source": "utmSource",
@@ -419,8 +419,6 @@ export type RequestBody$Outbound = {
   prefix?: string | undefined;
   trackConversion?: boolean | undefined;
   archived?: boolean | undefined;
-  publicStats?: boolean | undefined;
-  tagId?: string | null | undefined;
   tagIds?: string | Array<string> | undefined;
   tagNames?: string | Array<string> | undefined;
   folderId?: string | null | undefined;
@@ -448,6 +446,8 @@ export type RequestBody$Outbound = {
   testVariants?: Array<BulkCreateLinksTestVariants$Outbound> | null | undefined;
   testStartedAt?: string | null | undefined;
   testCompletedAt?: string | null | undefined;
+  publicStats?: boolean | undefined;
+  tagId?: string | null | undefined;
 };
 
 /** @internal */
@@ -467,8 +467,6 @@ export const RequestBody$outboundSchema: z.ZodType<
   prefix: z.string().optional(),
   trackConversion: z.boolean().optional(),
   archived: z.boolean().optional(),
-  publicStats: z.boolean().optional(),
-  tagId: z.nullable(z.string()).optional(),
   tagIds: z.union([z.string(), z.array(z.string())]).optional(),
   tagNames: z.union([z.string(), z.array(z.string())]).optional(),
   folderId: z.nullable(z.string()).optional(),
@@ -498,6 +496,8 @@ export const RequestBody$outboundSchema: z.ZodType<
   ).optional(),
   testStartedAt: z.nullable(z.string()).optional(),
   testCompletedAt: z.nullable(z.string()).optional(),
+  publicStats: z.boolean().optional(),
+  tagId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     utmSource: "utm_source",