dub 0.72.0 → 0.72.1

package/src/models/operations/createcommission.ts

@@ -0,0 +1,369 @@
+/*
+ * 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";
+
+/**
+ * The full customer object to associate the commission with. Useful for creating the customer on demand.
+ */
+export type RequestBodyCustomer = {
+  /**
+   * The customer's email address.
+   */
+  email?: string | null | undefined;
+  /**
+   * The customer's name. If not provided, the email address will be used, and if email is not provided, a random name will be generated.
+   */
+  name?: string | null | undefined;
+  /**
+   * The customer's avatar URL. If not provided, a random avatar will be generated.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The customer's unique identifier your database. This is useful for associating subsequent conversion events from Dub's API to your internal systems.
+   */
+  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;
+  /**
+   * The customer's country in ISO 3166-1 alpha-2 format. Updating this field will only affect the customer's country in Dub's system (and has no effect on existing conversion events).
+   */
+  country: string;
+};
+
+export type RequestBody3 = {
+  type: "sale";
+  /**
+   * The ID of the partner to create the commission for.
+   */
+  partnerId: string;
+  /**
+   * The customer ID to associate the commission with. Useful if the customer was already created in a prior operation and you want to associate the commission with it.
+   */
+  customerId?: string | null | undefined;
+  /**
+   * The full customer object to associate the commission with. Useful for creating the customer on demand.
+   */
+  customer?: RequestBodyCustomer | null | undefined;
+  /**
+   * The partner link ID to associate the commission with. If not provided, default to the link with the most revenue.
+   */
+  linkId?: string | null | undefined;
+  /**
+   * When `true`, import all unimported paid Stripe invoices for the customer and create a commission for each. When `false`, create a single manual sale event using `saleAmount`.
+   */
+  importStripeInvoices?: boolean | null | undefined;
+  /**
+   * Required when `importStripeInvoices` is `false`. The sale amount in cents for the manual sale event. Ignored when importing from Stripe.
+   */
+  saleAmount?: number | null | undefined;
+  /**
+   * Only used when `importStripeInvoices` is `false`. The date of the manual sale event. Defaults to the current date and time if not provided.
+   */
+  saleEventDate?: string | null | undefined;
+  /**
+   * Only used when `importStripeInvoices` is `false`. An optional invoice ID to attach to the generated sale event and commission entry for deduplication.
+   */
+  invoiceId?: string | null | undefined;
+  /**
+   * Only used when `importStripeInvoices` is `false`. An optional product ID stored on the sale event metadata – will also impact commission earnings calculation (if a `Sale` `Product ID` modifier is set).
+   */
+  productId?: string | null | undefined;
+};
+
+/**
+ * The full customer object to associate the commission with. Useful for creating the customer on demand.
+ */
+export type Customer = {
+  /**
+   * The customer's email address.
+   */
+  email?: string | null | undefined;
+  /**
+   * The customer's name. If not provided, the email address will be used, and if email is not provided, a random name will be generated.
+   */
+  name?: string | null | undefined;
+  /**
+   * The customer's avatar URL. If not provided, a random avatar will be generated.
+   */
+  avatar?: string | null | undefined;
+  /**
+   * The customer's unique identifier your database. This is useful for associating subsequent conversion events from Dub's API to your internal systems.
+   */
+  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;
+  /**
+   * The customer's country in ISO 3166-1 alpha-2 format. Updating this field will only affect the customer's country in Dub's system (and has no effect on existing conversion events).
+   */
+  country: string;
+};
+
+export type RequestBody2 = {
+  type: "lead";
+  /**
+   * The ID of the partner to create the commission for.
+   */
+  partnerId: string;
+  /**
+   * The customer ID to associate the commission with. Useful if the customer was already created in a prior operation and you want to associate the commission with it.
+   */
+  customerId?: string | null | undefined;
+  /**
+   * The full customer object to associate the commission with. Useful for creating the customer on demand.
+   */
+  customer?: Customer | null | undefined;
+  /**
+   * The partner link ID to associate the commission with. If not provided, default to the link with the most revenue.
+   */
+  linkId?: string | null | undefined;
+  /**
+   * The date and time of the lead event. If not provided, defaults to the current date and time.
+   */
+  leadEventDate?: string | null | undefined;
+  /**
+   * The name of the lead event. If not provided, defaults to 'Sign up'.
+   */
+  leadEventName?: string | null | undefined;
+};
+
+export type RequestBody1 = {
+  type: "custom";
+  /**
+   * The ID of the partner to create the commission for.
+   */
+  partnerId: string;
+  /**
+   * The commission amount in cents.
+   */
+  amount: number;
+  /**
+   * If not provided, the current date will be used.
+   */
+  date?: string | null | undefined;
+  /**
+   * The description of the commission.
+   */
+  description?: string | null | undefined;
+};
+
+export type CreateCommissionRequestBody =
+  | RequestBody1
+  | RequestBody2
+  | RequestBody3;
+
+/**
+ * The request was accepted and commission creation was queued.
+ */
+export type CreateCommissionResponseBody = {
+  success: boolean;
+  message: string;
+};
+
+/** @internal */
+export type RequestBodyCustomer$Outbound = {
+  email?: string | null | undefined;
+  name?: string | null | undefined;
+  avatar?: string | null | undefined;
+  externalId: string;
+  stripeCustomerId?: string | null | undefined;
+  country: string;
+};
+
+/** @internal */
+export const RequestBodyCustomer$outboundSchema: z.ZodType<
+  RequestBodyCustomer$Outbound,
+  z.ZodTypeDef,
+  RequestBodyCustomer
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string(),
+  stripeCustomerId: z.nullable(z.string()).optional(),
+  country: z.string(),
+});
+
+export function requestBodyCustomerToJSON(
+  requestBodyCustomer: RequestBodyCustomer,
+): string {
+  return JSON.stringify(
+    RequestBodyCustomer$outboundSchema.parse(requestBodyCustomer),
+  );
+}
+
+/** @internal */
+export type RequestBody3$Outbound = {
+  type: "sale";
+  partnerId: string;
+  customerId?: string | null | undefined;
+  customer?: RequestBodyCustomer$Outbound | null | undefined;
+  linkId?: string | null | undefined;
+  importStripeInvoices: boolean | null;
+  saleAmount?: number | null | undefined;
+  saleEventDate?: string | null | undefined;
+  invoiceId?: string | null | undefined;
+  productId?: string | null | undefined;
+};
+
+/** @internal */
+export const RequestBody3$outboundSchema: z.ZodType<
+  RequestBody3$Outbound,
+  z.ZodTypeDef,
+  RequestBody3
+> = z.object({
+  type: z.literal("sale"),
+  partnerId: z.string(),
+  customerId: z.nullable(z.string()).optional(),
+  customer: z.nullable(z.lazy(() => RequestBodyCustomer$outboundSchema))
+    .optional(),
+  linkId: z.nullable(z.string()).optional(),
+  importStripeInvoices: z.nullable(z.boolean().default(false)),
+  saleAmount: z.nullable(z.number()).optional(),
+  saleEventDate: z.nullable(z.string()).optional(),
+  invoiceId: z.nullable(z.string()).optional(),
+  productId: z.nullable(z.string()).optional(),
+});
+
+export function requestBody3ToJSON(requestBody3: RequestBody3): string {
+  return JSON.stringify(RequestBody3$outboundSchema.parse(requestBody3));
+}
+
+/** @internal */
+export type Customer$Outbound = {
+  email?: string | null | undefined;
+  name?: string | null | undefined;
+  avatar?: string | null | undefined;
+  externalId: string;
+  stripeCustomerId?: string | null | undefined;
+  country: string;
+};
+
+/** @internal */
+export const Customer$outboundSchema: z.ZodType<
+  Customer$Outbound,
+  z.ZodTypeDef,
+  Customer
+> = z.object({
+  email: z.nullable(z.string()).optional(),
+  name: z.nullable(z.string()).optional(),
+  avatar: z.nullable(z.string()).optional(),
+  externalId: z.string(),
+  stripeCustomerId: z.nullable(z.string()).optional(),
+  country: z.string(),
+});
+
+export function customerToJSON(customer: Customer): string {
+  return JSON.stringify(Customer$outboundSchema.parse(customer));
+}
+
+/** @internal */
+export type RequestBody2$Outbound = {
+  type: "lead";
+  partnerId: string;
+  customerId?: string | null | undefined;
+  customer?: Customer$Outbound | null | undefined;
+  linkId?: string | null | undefined;
+  leadEventDate?: string | null | undefined;
+  leadEventName: string | null;
+};
+
+/** @internal */
+export const RequestBody2$outboundSchema: z.ZodType<
+  RequestBody2$Outbound,
+  z.ZodTypeDef,
+  RequestBody2
+> = z.object({
+  type: z.literal("lead"),
+  partnerId: z.string(),
+  customerId: z.nullable(z.string()).optional(),
+  customer: z.nullable(z.lazy(() => Customer$outboundSchema)).optional(),
+  linkId: z.nullable(z.string()).optional(),
+  leadEventDate: z.nullable(z.string()).optional(),
+  leadEventName: z.nullable(z.string().default("Sign up")),
+});
+
+export function requestBody2ToJSON(requestBody2: RequestBody2): string {
+  return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
+}
+
+/** @internal */
+export type RequestBody1$Outbound = {
+  type: "custom";
+  partnerId: string;
+  amount: number;
+  date?: string | null | undefined;
+  description?: string | null | undefined;
+};
+
+/** @internal */
+export const RequestBody1$outboundSchema: z.ZodType<
+  RequestBody1$Outbound,
+  z.ZodTypeDef,
+  RequestBody1
+> = z.object({
+  type: z.literal("custom"),
+  partnerId: z.string(),
+  amount: z.number(),
+  date: z.nullable(z.string()).optional(),
+  description: z.nullable(z.string()).optional(),
+});
+
+export function requestBody1ToJSON(requestBody1: RequestBody1): string {
+  return JSON.stringify(RequestBody1$outboundSchema.parse(requestBody1));
+}
+
+/** @internal */
+export type CreateCommissionRequestBody$Outbound =
+  | RequestBody1$Outbound
+  | RequestBody2$Outbound
+  | RequestBody3$Outbound;
+
+/** @internal */
+export const CreateCommissionRequestBody$outboundSchema: z.ZodType<
+  CreateCommissionRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateCommissionRequestBody
+> = z.union([
+  z.lazy(() => RequestBody1$outboundSchema),
+  z.lazy(() => RequestBody2$outboundSchema),
+  z.lazy(() => RequestBody3$outboundSchema),
+]);
+
+export function createCommissionRequestBodyToJSON(
+  createCommissionRequestBody: CreateCommissionRequestBody,
+): string {
+  return JSON.stringify(
+    CreateCommissionRequestBody$outboundSchema.parse(
+      createCommissionRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateCommissionResponseBody$inboundSchema: z.ZodType<
+  CreateCommissionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+  message: z.string(),
+});
+
+export function createCommissionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCommissionResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCommissionResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCommissionResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getcustomer.ts

@@ -93,7 +93,7 @@ export type GetCustomerResponseBody = {
   /**
    * Name of the customer.
    */
-  name: string;
+  name?: string | null | undefined;
   /**
    * Email of the customer.
    */
@@ -248,7 +248,7 @@ export const GetCustomerResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  name: z.string(),
+  name: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   externalId: z.string(),

package/src/models/operations/getcustomers.ts

@@ -169,7 +169,7 @@ export type GetCustomersResponseBody = {
   /**
    * Name of the customer.
    */
-  name: string;
+  name?: string | null | undefined;
   /**
    * Email of the customer.
    */
@@ -362,7 +362,7 @@ export const GetCustomersResponseBody$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  name: z.string(),
+  name: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   externalId: z.string(),

package/src/models/operations/getlinks.ts

@@ -5,7 +5,6 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -20,50 +19,6 @@ export type QueryParamTagIds = string | Array<string>;
  */
 export type QueryParamTagNames = string | Array<string>;
 
-/**
- * The field to sort the links by. The default is `createdAt`.
- */
-export const SortBy = {
-  CreatedAt: "createdAt",
-  Clicks: "clicks",
-  SaleAmount: "saleAmount",
-  LastClicked: "lastClicked",
-} as const;
-/**
- * The field to sort the links by. The default is `createdAt`.
- */
-export type SortBy = ClosedEnum<typeof SortBy>;
-
-/**
- * The sort order. The default is `desc`.
- */
-export const SortOrder = {
-  Asc: "asc",
-  Desc: "desc",
-} as const;
-/**
- * The sort order. The default is `desc`.
- */
-export type SortOrder = ClosedEnum<typeof SortOrder>;
-
-/**
- * DEPRECATED. Use `sortBy` instead.
- *
- * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export const Sort = {
-  CreatedAt: "createdAt",
-  Clicks: "clicks",
-  SaleAmount: "saleAmount",
-  LastClicked: "lastClicked",
-} as const;
-/**
- * DEPRECATED. Use `sortBy` instead.
- *
- * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
- */
-export type Sort = ClosedEnum<typeof Sort>;
-
 export type GetLinksRequest = {
   /**
    * The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.
@@ -105,18 +60,6 @@ export type GetLinksRequest = {
    * DEPRECATED. Filter for links that have at least one tag assigned to them.
    */
   withTags?: boolean | undefined;
-  /**
-   * The field to sort the links by. The default is `createdAt`.
-   */
-  sortBy?: SortBy | undefined;
-  /**
-   * The sort order. The default is `desc`.
-   */
-  sortOrder?: SortOrder | undefined;
-  /**
-   * DEPRECATED. Use `sortBy` instead.
-   */
-  sort?: Sort | undefined;
   /**
    * If specified, the query only searches for results before this cursor. Mutually exclusive with `startingAfter`.
    */
@@ -175,19 +118,6 @@ export function queryParamTagNamesToJSON(
   );
 }
 
-/** @internal */
-export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> = z
-  .nativeEnum(SortBy);
-
-/** @internal */
-export const SortOrder$outboundSchema: z.ZodNativeEnum<typeof SortOrder> = z
-  .nativeEnum(SortOrder);
-
-/** @internal */
-export const Sort$outboundSchema: z.ZodNativeEnum<typeof Sort> = z.nativeEnum(
-  Sort,
-);
-
 /** @internal */
 export type GetLinksRequest$Outbound = {
   domain?: string | undefined;
@@ -200,9 +130,6 @@ export type GetLinksRequest$Outbound = {
   tenantId?: string | undefined;
   showArchived: boolean;
   withTags: boolean;
-  sortBy: string;
-  sortOrder: string;
-  sort: string;
   endingBefore?: string | undefined;
   startingAfter?: string | undefined;
   page?: number | undefined;
@@ -225,9 +152,6 @@ export const GetLinksRequest$outboundSchema: z.ZodType<
   tenantId: z.string().optional(),
   showArchived: z.boolean().default(false),
   withTags: z.boolean().default(false),
-  sortBy: SortBy$outboundSchema.default("createdAt"),
-  sortOrder: SortOrder$outboundSchema.default("desc"),
-  sort: Sort$outboundSchema.default("createdAt"),
   endingBefore: z.string().optional(),
   startingAfter: z.string().optional(),
   page: z.number().optional(),

package/src/models/operations/gettags.ts

@@ -8,30 +8,26 @@ import { ClosedEnum } from "../../types/enums.js";
 /**
  * The field to sort the tags by.
  */
-export const GetTagsQueryParamSortBy = {
+export const QueryParamSortBy = {
   Name: "name",
   CreatedAt: "createdAt",
 } as const;
 /**
  * The field to sort the tags by.
  */
-export type GetTagsQueryParamSortBy = ClosedEnum<
-  typeof GetTagsQueryParamSortBy
->;
+export type QueryParamSortBy = ClosedEnum<typeof QueryParamSortBy>;
 
 /**
  * The order to sort the tags by.
  */
-export const GetTagsQueryParamSortOrder = {
+export const QueryParamSortOrder = {
   Asc: "asc",
   Desc: "desc",
 } as const;
 /**
  * The order to sort the tags by.
  */
-export type GetTagsQueryParamSortOrder = ClosedEnum<
-  typeof GetTagsQueryParamSortOrder
->;
+export type QueryParamSortOrder = ClosedEnum<typeof QueryParamSortOrder>;
 
 /**
  * IDs of tags to filter by.
@@ -42,11 +38,11 @@ export type GetTagsRequest = {
   /**
    * The field to sort the tags by.
    */
-  sortBy?: GetTagsQueryParamSortBy | undefined;
+  sortBy?: QueryParamSortBy | undefined;
   /**
    * The order to sort the tags by.
    */
-  sortOrder?: GetTagsQueryParamSortOrder | undefined;
+  sortOrder?: QueryParamSortOrder | undefined;
   /**
    * The search term to filter the tags by.
    */
@@ -66,14 +62,14 @@ export type GetTagsRequest = {
 };
 
 /** @internal */
-export const GetTagsQueryParamSortBy$outboundSchema: z.ZodNativeEnum<
-  typeof GetTagsQueryParamSortBy
-> = z.nativeEnum(GetTagsQueryParamSortBy);
+export const QueryParamSortBy$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamSortBy
+> = z.nativeEnum(QueryParamSortBy);
 
 /** @internal */
-export const GetTagsQueryParamSortOrder$outboundSchema: z.ZodNativeEnum<
-  typeof GetTagsQueryParamSortOrder
-> = z.nativeEnum(GetTagsQueryParamSortOrder);
+export const QueryParamSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamSortOrder
+> = z.nativeEnum(QueryParamSortOrder);
 
 /** @internal */
 export type Ids$Outbound = string | Array<string>;
@@ -102,8 +98,8 @@ export const GetTagsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetTagsRequest
 > = z.object({
-  sortBy: GetTagsQueryParamSortBy$outboundSchema.default("name"),
-  sortOrder: GetTagsQueryParamSortOrder$outboundSchema.default("asc"),
+  sortBy: QueryParamSortBy$outboundSchema.default("name"),
+  sortOrder: QueryParamSortOrder$outboundSchema.default("asc"),
   search: z.string().optional(),
   ids: z.union([z.string(), z.array(z.string())]).optional(),
   page: z.number().optional(),

package/src/models/operations/index.ts

@@ -10,6 +10,7 @@ export * from "./bulkdeletelinks.js";
 export * from "./bulkupdatecommissions.js";
 export * from "./bulkupdatelinks.js";
 export * from "./checkdomainstatus.js";
+export * from "./createcommission.js";
 export * from "./createdomain.js";
 export * from "./createfolder.js";
 export * from "./createlink.js";

package/src/models/operations/listcommissions.ts

@@ -225,7 +225,7 @@ export type ListCommissionsCustomer = {
   /**
    * Name of the customer.
    */
-  name: string;
+  name?: string | null | undefined;
   /**
    * Email of the customer.
    */
@@ -420,7 +420,7 @@ export const ListCommissionsCustomer$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string(),
-  name: z.string(),
+  name: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   externalId: z.string(),