dub 0.28.1 → 0.29.2

package/src/models/operations/{gettopurls.ts → gettimeseriesbyclicks.ts}

@@ -2,29 +2,31 @@
  * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
  */
 
+import { ClosedEnum } from "../../types";
 import * as z from "zod";
 
 /**
- * The interval to retrieve analytics for.
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
  */
-export const GetTopURLsQueryParamInterval = {
+export const QueryParamInterval = {
     Oneh: "1h",
     TwentyFourh: "24h",
     Sevend: "7d",
     Thirtyd: "30d",
     Ninetyd: "90d",
+    Ytd: "ytd",
+    Oney: "1y",
     All: "all",
 } as const;
 /**
- * The interval to retrieve analytics for.
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
  */
-export type GetTopURLsQueryParamInterval =
-    (typeof GetTopURLsQueryParamInterval)[keyof typeof GetTopURLsQueryParamInterval];
+export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;
 
 /**
  * The country to retrieve analytics for.
  */
-export const GetTopURLsQueryParamCountry = {
+export const QueryParamCountry = {
     Af: "AF",
     Al: "AL",
     Dz: "DZ",
@@ -279,12 +281,11 @@ export const GetTopURLsQueryParamCountry = {
 /**
  * The country to retrieve analytics for.
  */
-export type GetTopURLsQueryParamCountry =
-    (typeof GetTopURLsQueryParamCountry)[keyof typeof GetTopURLsQueryParamCountry];
+export type QueryParamCountry = ClosedEnum<typeof QueryParamCountry>;
 
-export type GetTopURLsRequest = {
+export type GetTimeseriesByClicksRequest = {
     /**
-     * The domain of the short link.
+     * The domain to filter analytics for.
      */
     domain?: string | undefined;
     /**
@@ -300,13 +301,21 @@ export type GetTopURLsRequest = {
      */
     externalId?: string | undefined;
     /**
-     * The interval to retrieve analytics for.
+     * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
      */
-    interval?: GetTopURLsQueryParamInterval | undefined;
+    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 country to retrieve analytics for.
      */
-    country?: GetTopURLsQueryParamCountry | undefined;
+    country?: QueryParamCountry | undefined;
     /**
      * The city to retrieve analytics for.
      */
@@ -345,53 +354,41 @@ export type GetTopURLsRequest = {
     root?: boolean | undefined;
 };
 
-export type GetTopURLsResponseBody = {
+export type ResponseBody = {
     /**
-     * The destination URL
+     * The starting timestamp of the interval
      */
-    url: string;
+    start: string;
     /**
-     * The number of clicks from this URL
+     * The number of clicks in the interval
      */
     clicks: number;
 };
 
 /** @internal */
-export const GetTopURLsQueryParamInterval$: z.ZodNativeEnum<typeof GetTopURLsQueryParamInterval> =
-    z.nativeEnum(GetTopURLsQueryParamInterval);
+export namespace QueryParamInterval$ {
+    export const inboundSchema = z.nativeEnum(QueryParamInterval);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export const GetTopURLsQueryParamCountry$: z.ZodNativeEnum<typeof GetTopURLsQueryParamCountry> =
-    z.nativeEnum(GetTopURLsQueryParamCountry);
+export namespace QueryParamCountry$ {
+    export const inboundSchema = z.nativeEnum(QueryParamCountry);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetTopURLsRequest$ {
-    export type Inbound = {
-        domain?: string | undefined;
-        key?: string | undefined;
-        linkId?: string | undefined;
-        externalId?: string | undefined;
-        interval?: GetTopURLsQueryParamInterval | undefined;
-        country?: GetTopURLsQueryParamCountry | 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;
-    };
-
-    export const inboundSchema: z.ZodType<GetTopURLsRequest, z.ZodTypeDef, Inbound> = z
+export namespace GetTimeseriesByClicksRequest$ {
+    export const inboundSchema: z.ZodType<GetTimeseriesByClicksRequest, z.ZodTypeDef, unknown> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetTopURLsQueryParamInterval$.optional(),
-            country: GetTopURLsQueryParamCountry$.optional(),
+            interval: QueryParamInterval$.inboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: QueryParamCountry$.inboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -408,7 +405,9 @@ export namespace GetTopURLsRequest$ {
                 ...(v.key === undefined ? null : { key: v.key }),
                 ...(v.linkId === undefined ? null : { linkId: v.linkId }),
                 ...(v.externalId === undefined ? null : { externalId: v.externalId }),
-                ...(v.interval === undefined ? null : { interval: v.interval }),
+                interval: v.interval,
+                ...(v.start === undefined ? null : { start: v.start }),
+                ...(v.end === undefined ? null : { end: v.end }),
                 ...(v.country === undefined ? null : { country: v.country }),
                 ...(v.city === undefined ? null : { city: v.city }),
                 ...(v.device === undefined ? null : { device: v.device }),
@@ -427,8 +426,10 @@ export namespace GetTopURLsRequest$ {
         key?: string | undefined;
         linkId?: string | undefined;
         externalId?: string | undefined;
-        interval?: GetTopURLsQueryParamInterval | undefined;
-        country?: GetTopURLsQueryParamCountry | undefined;
+        interval: string;
+        start?: string | undefined;
+        end?: string | undefined;
+        country?: string | undefined;
         city?: string | undefined;
         device?: string | undefined;
         browser?: string | undefined;
@@ -440,14 +441,16 @@ export namespace GetTopURLsRequest$ {
         root?: boolean | undefined;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopURLsRequest> = z
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTimeseriesByClicksRequest> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetTopURLsQueryParamInterval$.optional(),
-            country: GetTopURLsQueryParamCountry$.optional(),
+            interval: QueryParamInterval$.outboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: QueryParamCountry$.outboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -464,7 +467,9 @@ export namespace GetTopURLsRequest$ {
                 ...(v.key === undefined ? null : { key: v.key }),
                 ...(v.linkId === undefined ? null : { linkId: v.linkId }),
                 ...(v.externalId === undefined ? null : { externalId: v.externalId }),
-                ...(v.interval === undefined ? null : { interval: v.interval }),
+                interval: v.interval,
+                ...(v.start === undefined ? null : { start: v.start }),
+                ...(v.end === undefined ? null : { end: v.end }),
                 ...(v.country === undefined ? null : { country: v.country }),
                 ...(v.city === undefined ? null : { city: v.city }),
                 ...(v.device === undefined ? null : { device: v.device }),
@@ -480,37 +485,32 @@ export namespace GetTopURLsRequest$ {
 }
 
 /** @internal */
-export namespace GetTopURLsResponseBody$ {
-    export type Inbound = {
-        url: string;
-        clicks: number;
-    };
-
-    export const inboundSchema: z.ZodType<GetTopURLsResponseBody, z.ZodTypeDef, Inbound> = z
+export namespace ResponseBody$ {
+    export const inboundSchema: z.ZodType<ResponseBody, z.ZodTypeDef, unknown> = z
         .object({
-            url: z.string(),
+            start: z.string(),
             clicks: z.number(),
         })
         .transform((v) => {
             return {
-                url: v.url,
+                start: v.start,
                 clicks: v.clicks,
             };
         });
 
     export type Outbound = {
-        url: string;
+        start: string;
         clicks: number;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTopURLsResponseBody> = z
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ResponseBody> = z
         .object({
-            url: z.string(),
+            start: z.string(),
             clicks: z.number(),
         })
         .transform((v) => {
             return {
-                url: v.url,
+                start: v.start,
                 clicks: v.clicks,
             };
         });