dub 0.34.2 → 0.36.0

package/src/models/operations/getlinks.ts

@@ -1,8 +1,10 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { remap as remap$ } from "../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
 import * as z from "zod";
 
 /**
@@ -66,9 +68,17 @@ export type GetLinksRequest = {
      */
     sort?: Sort | undefined;
     /**
-     * The page number for pagination (each page contains 100 links).
+     * The page number for pagination.
      */
     page?: number | undefined;
+    /**
+     * The number of items per page.
+     */
+    pageSize?: number | undefined;
+};
+
+export type GetLinksResponse = {
+    result: Array<components.LinkSchema>;
 };
 
 /** @internal */
@@ -157,7 +167,8 @@ export const GetLinksRequest$inboundSchema: z.ZodType<GetLinksRequest, z.ZodType
         showArchived: z.boolean().default(false),
         withTags: z.boolean().default(false),
         sort: Sort$inboundSchema.default("createdAt"),
-        page: z.number().int().optional(),
+        page: z.number().default(1),
+        pageSize: z.number().default(100),
     });
 
 /** @internal */
@@ -171,7 +182,8 @@ export type GetLinksRequest$Outbound = {
     showArchived: boolean;
     withTags: boolean;
     sort: string;
-    page?: number | undefined;
+    page: number;
+    pageSize: number;
 };
 
 /** @internal */
@@ -189,7 +201,8 @@ export const GetLinksRequest$outboundSchema: z.ZodType<
     showArchived: z.boolean().default(false),
     withTags: z.boolean().default(false),
     sort: Sort$outboundSchema.default("createdAt"),
-    page: z.number().int().optional(),
+    page: z.number().default(1),
+    pageSize: z.number().default(100),
 });
 
 /**
@@ -204,3 +217,47 @@ export namespace GetLinksRequest$ {
     /** @deprecated use `GetLinksRequest$Outbound` instead. */
     export type Outbound = GetLinksRequest$Outbound;
 }
+
+/** @internal */
+export const GetLinksResponse$inboundSchema: z.ZodType<GetLinksResponse, z.ZodTypeDef, unknown> = z
+    .object({
+        Result: z.array(components.LinkSchema$inboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            Result: "result",
+        });
+    });
+
+/** @internal */
+export type GetLinksResponse$Outbound = {
+    Result: Array<components.LinkSchema$Outbound>;
+};
+
+/** @internal */
+export const GetLinksResponse$outboundSchema: z.ZodType<
+    GetLinksResponse$Outbound,
+    z.ZodTypeDef,
+    GetLinksResponse
+> = z
+    .object({
+        result: z.array(components.LinkSchema$outboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            result: "Result",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetLinksResponse$ {
+    /** @deprecated use `GetLinksResponse$inboundSchema` instead. */
+    export const inboundSchema = GetLinksResponse$inboundSchema;
+    /** @deprecated use `GetLinksResponse$outboundSchema` instead. */
+    export const outboundSchema = GetLinksResponse$outboundSchema;
+    /** @deprecated use `GetLinksResponse$Outbound` instead. */
+    export type Outbound = GetLinksResponse$Outbound;
+}

package/src/models/operations/getlinkscount.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";
@@ -15,6 +15,11 @@ export type GetLinksCountQueryParamTagIds = string | Array<string>;
  */
 export type GetLinksCountQueryParamTagNames = string | Array<string>;
 
+export const Three = {
+    UserId: "userId",
+} as const;
+export type Three = ClosedEnum<typeof Three>;
+
 export const Two = {
     TagId: "tagId",
 } as const;
@@ -28,7 +33,7 @@ export type One = ClosedEnum<typeof One>;
 /**
  * The field to group the links by.
  */
-export type GroupBy = One | Two;
+export type GroupBy = One | Two | Three;
 
 export type GetLinksCountRequest = {
     /**
@@ -66,7 +71,7 @@ export type GetLinksCountRequest = {
     /**
      * The field to group the links by.
      */
-    groupBy?: One | Two | undefined;
+    groupBy?: One | Two | Three | undefined;
 };
 
 /** @internal */
@@ -129,6 +134,23 @@ export namespace GetLinksCountQueryParamTagNames$ {
     export type Outbound = GetLinksCountQueryParamTagNames$Outbound;
 }
 
+/** @internal */
+export const Three$inboundSchema: z.ZodNativeEnum<typeof Three> = z.nativeEnum(Three);
+
+/** @internal */
+export const Three$outboundSchema: z.ZodNativeEnum<typeof Three> = Three$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Three$ {
+    /** @deprecated use `Three$inboundSchema` instead. */
+    export const inboundSchema = Three$inboundSchema;
+    /** @deprecated use `Three$outboundSchema` instead. */
+    export const outboundSchema = Three$outboundSchema;
+}
+
 /** @internal */
 export const Two$inboundSchema: z.ZodNativeEnum<typeof Two> = z.nativeEnum(Two);
 
@@ -167,15 +189,17 @@ export namespace One$ {
 export const GroupBy$inboundSchema: z.ZodType<GroupBy, z.ZodTypeDef, unknown> = z.union([
     One$inboundSchema,
     Two$inboundSchema,
+    Three$inboundSchema,
 ]);
 
 /** @internal */
-export type GroupBy$Outbound = string | string;
+export type GroupBy$Outbound = string | string | string;
 
 /** @internal */
 export const GroupBy$outboundSchema: z.ZodType<GroupBy$Outbound, z.ZodTypeDef, GroupBy> = z.union([
     One$outboundSchema,
     Two$outboundSchema,
+    Three$outboundSchema,
 ]);
 
 /**
@@ -205,7 +229,7 @@ export const GetLinksCountRequest$inboundSchema: z.ZodType<
     userId: z.string().optional(),
     showArchived: z.boolean().default(false),
     withTags: z.boolean().default(false),
-    groupBy: z.union([One$inboundSchema, Two$inboundSchema]).optional(),
+    groupBy: z.union([One$inboundSchema, Two$inboundSchema, Three$inboundSchema]).optional(),
 });
 
 /** @internal */
@@ -218,7 +242,7 @@ export type GetLinksCountRequest$Outbound = {
     userId?: string | undefined;
     showArchived: boolean;
     withTags: boolean;
-    groupBy?: string | string | undefined;
+    groupBy?: string | string | string | undefined;
 };
 
 /** @internal */
@@ -235,7 +259,7 @@ export const GetLinksCountRequest$outboundSchema: z.ZodType<
     userId: z.string().optional(),
     showArchived: z.boolean().default(false),
     withTags: z.boolean().default(false),
-    groupBy: z.union([One$outboundSchema, Two$outboundSchema]).optional(),
+    groupBy: z.union([One$outboundSchema, Two$outboundSchema, Three$outboundSchema]).optional(),
 });
 
 /**

package/src/models/operations/getmetatags.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/operations/getqrcode.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { ClosedEnum } from "../../types/enums.js";

package/src/models/operations/getworkspace.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/models/operations/index.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 export * from "./bulkcreatelinks.js";
@@ -15,6 +15,8 @@ export * from "./getlinkscount.js";
 export * from "./getmetatags.js";
 export * from "./getqrcode.js";
 export * from "./getworkspace.js";
+export * from "./listdomains.js";
+export * from "./listevents.js";
 export * from "./retrieveanalytics.js";
 export * from "./trackcustomer.js";
 export * from "./tracklead.js";

package/src/models/operations/listdomains.ts

@@ -0,0 +1,123 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+import * as z from "zod";
+
+export type ListDomainsRequest = {
+    /**
+     * Whether to include archived domains in the response. Defaults to `false` if not provided.
+     */
+    archived?: boolean | undefined;
+    /**
+     * The search term to filter the domains by.
+     */
+    search?: string | undefined;
+    /**
+     * The page number for pagination.
+     */
+    page?: number | undefined;
+    /**
+     * The number of items per page.
+     */
+    pageSize?: number | undefined;
+};
+
+export type ListDomainsResponse = {
+    result: Array<components.DomainSchema>;
+};
+
+/** @internal */
+export const ListDomainsRequest$inboundSchema: z.ZodType<
+    ListDomainsRequest,
+    z.ZodTypeDef,
+    unknown
+> = z.object({
+    archived: z.boolean().default(false),
+    search: z.string().optional(),
+    page: z.number().default(1),
+    pageSize: z.number().default(50),
+});
+
+/** @internal */
+export type ListDomainsRequest$Outbound = {
+    archived: boolean;
+    search?: string | undefined;
+    page: number;
+    pageSize: number;
+};
+
+/** @internal */
+export const ListDomainsRequest$outboundSchema: z.ZodType<
+    ListDomainsRequest$Outbound,
+    z.ZodTypeDef,
+    ListDomainsRequest
+> = z.object({
+    archived: z.boolean().default(false),
+    search: z.string().optional(),
+    page: z.number().default(1),
+    pageSize: z.number().default(50),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListDomainsRequest$ {
+    /** @deprecated use `ListDomainsRequest$inboundSchema` instead. */
+    export const inboundSchema = ListDomainsRequest$inboundSchema;
+    /** @deprecated use `ListDomainsRequest$outboundSchema` instead. */
+    export const outboundSchema = ListDomainsRequest$outboundSchema;
+    /** @deprecated use `ListDomainsRequest$Outbound` instead. */
+    export type Outbound = ListDomainsRequest$Outbound;
+}
+
+/** @internal */
+export const ListDomainsResponse$inboundSchema: z.ZodType<
+    ListDomainsResponse,
+    z.ZodTypeDef,
+    unknown
+> = z
+    .object({
+        Result: z.array(components.DomainSchema$inboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            Result: "result",
+        });
+    });
+
+/** @internal */
+export type ListDomainsResponse$Outbound = {
+    Result: Array<components.DomainSchema$Outbound>;
+};
+
+/** @internal */
+export const ListDomainsResponse$outboundSchema: z.ZodType<
+    ListDomainsResponse$Outbound,
+    z.ZodTypeDef,
+    ListDomainsResponse
+> = z
+    .object({
+        result: z.array(components.DomainSchema$outboundSchema),
+    })
+    .transform((v) => {
+        return remap$(v, {
+            result: "Result",
+        });
+    });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListDomainsResponse$ {
+    /** @deprecated use `ListDomainsResponse$inboundSchema` instead. */
+    export const inboundSchema = ListDomainsResponse$inboundSchema;
+    /** @deprecated use `ListDomainsResponse$outboundSchema` instead. */
+    export const outboundSchema = ListDomainsResponse$outboundSchema;
+    /** @deprecated use `ListDomainsResponse$Outbound` instead. */
+    export type Outbound = ListDomainsResponse$Outbound;
+}

package/src/models/operations/listevents.ts

@@ -0,0 +1,312 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+import * as z from "zod";
+
+/**
+ * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ */
+export const QueryParamEvent = {
+    Clicks: "clicks",
+    Leads: "leads",
+    Sales: "sales",
+    Composite: "composite",
+} as const;
+/**
+ * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ */
+export type QueryParamEvent = ClosedEnum<typeof QueryParamEvent>;
+
+/**
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+ */
+export const QueryParamInterval = {
+    TwentyFourh: "24h",
+    Sevend: "7d",
+    Thirtyd: "30d",
+    Ninetyd: "90d",
+    Ytd: "ytd",
+    Oney: "1y",
+    All: "all",
+    AllUnfiltered: "all_unfiltered",
+} as const;
+/**
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+ */
+export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;
+
+export const Order = {
+    Asc: "asc",
+    Desc: "desc",
+} as const;
+export type Order = ClosedEnum<typeof Order>;
+
+export const SortBy = {
+    Timestamp: "timestamp",
+    Amount: "amount",
+} as const;
+export type SortBy = ClosedEnum<typeof SortBy>;
+
+export type ListEventsRequest = {
+    /**
+     * The type of event to retrieve analytics for. Defaults to 'clicks'.
+     */
+    event?: QueryParamEvent | undefined;
+    /**
+     * The domain to filter analytics for.
+     */
+    domain?: string | undefined;
+    /**
+     * The short link slug.
+     */
+    key?: string | undefined;
+    /**
+     * The unique ID of the short link on Dub.
+     */
+    linkId?: string | undefined;
+    /**
+     * This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
+     */
+    externalId?: string | undefined;
+    /**
+     * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+     */
+    interval?: QueryParamInterval | undefined;
+    /**
+     * The start date and time when to retrieve analytics from.
+     */
+    start?: string | undefined;
+    /**
+     * The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
+     */
+    end?: string | undefined;
+    /**
+     * The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
+     */
+    timezone?: string | undefined;
+    /**
+     * The continent to retrieve analytics for.
+     */
+    continent?: components.ContinentCode | undefined;
+    /**
+     * The country to retrieve analytics for.
+     */
+    country?: components.CountryCode | undefined;
+    /**
+     * The city to retrieve analytics for.
+     */
+    city?: string | undefined;
+    /**
+     * The device to retrieve analytics for.
+     */
+    device?: string | undefined;
+    /**
+     * The browser to retrieve analytics for.
+     */
+    browser?: string | undefined;
+    /**
+     * The OS to retrieve analytics for.
+     */
+    os?: string | undefined;
+    /**
+     * The referer to retrieve analytics for.
+     */
+    referer?: string | undefined;
+    /**
+     * The URL to retrieve analytics for.
+     */
+    url?: string | undefined;
+    /**
+     * The tag ID to retrieve analytics for.
+     */
+    tagId?: string | undefined;
+    /**
+     * Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
+     */
+    qr?: boolean | undefined;
+    /**
+     * Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
+     */
+    root?: boolean | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
+    order?: Order | undefined;
+    sortBy?: SortBy | undefined;
+};
+
+/** @internal */
+export const QueryParamEvent$inboundSchema: z.ZodNativeEnum<typeof QueryParamEvent> =
+    z.nativeEnum(QueryParamEvent);
+
+/** @internal */
+export const QueryParamEvent$outboundSchema: z.ZodNativeEnum<typeof QueryParamEvent> =
+    QueryParamEvent$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamEvent$ {
+    /** @deprecated use `QueryParamEvent$inboundSchema` instead. */
+    export const inboundSchema = QueryParamEvent$inboundSchema;
+    /** @deprecated use `QueryParamEvent$outboundSchema` instead. */
+    export const outboundSchema = QueryParamEvent$outboundSchema;
+}
+
+/** @internal */
+export const QueryParamInterval$inboundSchema: z.ZodNativeEnum<typeof QueryParamInterval> =
+    z.nativeEnum(QueryParamInterval);
+
+/** @internal */
+export const QueryParamInterval$outboundSchema: z.ZodNativeEnum<typeof QueryParamInterval> =
+    QueryParamInterval$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamInterval$ {
+    /** @deprecated use `QueryParamInterval$inboundSchema` instead. */
+    export const inboundSchema = QueryParamInterval$inboundSchema;
+    /** @deprecated use `QueryParamInterval$outboundSchema` instead. */
+    export const outboundSchema = QueryParamInterval$outboundSchema;
+}
+
+/** @internal */
+export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(Order);
+
+/** @internal */
+export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> = Order$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Order$ {
+    /** @deprecated use `Order$inboundSchema` instead. */
+    export const inboundSchema = Order$inboundSchema;
+    /** @deprecated use `Order$outboundSchema` instead. */
+    export const outboundSchema = Order$outboundSchema;
+}
+
+/** @internal */
+export const SortBy$inboundSchema: z.ZodNativeEnum<typeof SortBy> = z.nativeEnum(SortBy);
+
+/** @internal */
+export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> = SortBy$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SortBy$ {
+    /** @deprecated use `SortBy$inboundSchema` instead. */
+    export const inboundSchema = SortBy$inboundSchema;
+    /** @deprecated use `SortBy$outboundSchema` instead. */
+    export const outboundSchema = SortBy$outboundSchema;
+}
+
+/** @internal */
+export const ListEventsRequest$inboundSchema: z.ZodType<ListEventsRequest, z.ZodTypeDef, unknown> =
+    z.object({
+        event: QueryParamEvent$inboundSchema.default("clicks"),
+        domain: z.string().optional(),
+        key: z.string().optional(),
+        linkId: z.string().optional(),
+        externalId: z.string().optional(),
+        interval: QueryParamInterval$inboundSchema.optional(),
+        start: z.string().optional(),
+        end: z.string().optional(),
+        timezone: z.string().default("UTC"),
+        continent: components.ContinentCode$inboundSchema.optional(),
+        country: components.CountryCode$inboundSchema.optional(),
+        city: z.string().optional(),
+        device: z.string().optional(),
+        browser: z.string().optional(),
+        os: z.string().optional(),
+        referer: z.string().optional(),
+        url: z.string().optional(),
+        tagId: z.string().optional(),
+        qr: z.boolean().optional(),
+        root: z.boolean().optional(),
+        page: z.number().default(0),
+        limit: z.number().default(100),
+        order: Order$inboundSchema.default("desc"),
+        sortBy: SortBy$inboundSchema.default("timestamp"),
+    });
+
+/** @internal */
+export type ListEventsRequest$Outbound = {
+    event: string;
+    domain?: string | undefined;
+    key?: string | undefined;
+    linkId?: string | undefined;
+    externalId?: string | undefined;
+    interval?: string | undefined;
+    start?: string | undefined;
+    end?: string | undefined;
+    timezone: string;
+    continent?: string | undefined;
+    country?: string | undefined;
+    city?: string | undefined;
+    device?: string | undefined;
+    browser?: string | undefined;
+    os?: string | undefined;
+    referer?: string | undefined;
+    url?: string | undefined;
+    tagId?: string | undefined;
+    qr?: boolean | undefined;
+    root?: boolean | undefined;
+    page: number;
+    limit: number;
+    order: string;
+    sortBy: string;
+};
+
+/** @internal */
+export const ListEventsRequest$outboundSchema: z.ZodType<
+    ListEventsRequest$Outbound,
+    z.ZodTypeDef,
+    ListEventsRequest
+> = z.object({
+    event: QueryParamEvent$outboundSchema.default("clicks"),
+    domain: z.string().optional(),
+    key: z.string().optional(),
+    linkId: z.string().optional(),
+    externalId: z.string().optional(),
+    interval: QueryParamInterval$outboundSchema.optional(),
+    start: z.string().optional(),
+    end: z.string().optional(),
+    timezone: z.string().default("UTC"),
+    continent: components.ContinentCode$outboundSchema.optional(),
+    country: components.CountryCode$outboundSchema.optional(),
+    city: z.string().optional(),
+    device: z.string().optional(),
+    browser: z.string().optional(),
+    os: z.string().optional(),
+    referer: z.string().optional(),
+    url: z.string().optional(),
+    tagId: z.string().optional(),
+    qr: z.boolean().optional(),
+    root: z.boolean().optional(),
+    page: z.number().default(0),
+    limit: z.number().default(100),
+    order: Order$outboundSchema.default("desc"),
+    sortBy: SortBy$outboundSchema.default("timestamp"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListEventsRequest$ {
+    /** @deprecated use `ListEventsRequest$inboundSchema` instead. */
+    export const inboundSchema = ListEventsRequest$inboundSchema;
+    /** @deprecated use `ListEventsRequest$outboundSchema` instead. */
+    export const outboundSchema = ListEventsRequest$outboundSchema;
+    /** @deprecated use `ListEventsRequest$Outbound` instead. */
+    export type Outbound = ListEventsRequest$Outbound;
+}