dub 0.28.1 → 0.29.2

package/src/models/operations/{getcityanalytics.ts → getcitiesbyclicks.ts}

@@ -2,29 +2,33 @@
  * 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 GetCityAnalyticsQueryParamInterval = {
+export const GetCitiesByClicksQueryParamInterval = {
     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 GetCityAnalyticsQueryParamInterval =
-    (typeof GetCityAnalyticsQueryParamInterval)[keyof typeof GetCityAnalyticsQueryParamInterval];
+export type GetCitiesByClicksQueryParamInterval = ClosedEnum<
+    typeof GetCitiesByClicksQueryParamInterval
+>;
 
 /**
  * The country to retrieve analytics for.
  */
-export const GetCityAnalyticsQueryParamCountry = {
+export const GetCitiesByClicksQueryParamCountry = {
     Af: "AF",
     Al: "AL",
     Dz: "DZ",
@@ -279,12 +283,13 @@ export const GetCityAnalyticsQueryParamCountry = {
 /**
  * The country to retrieve analytics for.
  */
-export type GetCityAnalyticsQueryParamCountry =
-    (typeof GetCityAnalyticsQueryParamCountry)[keyof typeof GetCityAnalyticsQueryParamCountry];
+export type GetCitiesByClicksQueryParamCountry = ClosedEnum<
+    typeof GetCitiesByClicksQueryParamCountry
+>;
 
-export type GetCityAnalyticsRequest = {
+export type GetCitiesByClicksRequest = {
     /**
-     * The domain of the short link.
+     * The domain to filter analytics for.
      */
     domain?: string | undefined;
     /**
@@ -300,13 +305,21 @@ export type GetCityAnalyticsRequest = {
      */
     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?: GetCityAnalyticsQueryParamInterval | undefined;
+    interval?: GetCitiesByClicksQueryParamInterval | 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?: GetCityAnalyticsQueryParamCountry | undefined;
+    country?: GetCitiesByClicksQueryParamCountry | undefined;
     /**
      * The city to retrieve analytics for.
      */
@@ -348,7 +361,7 @@ export type GetCityAnalyticsRequest = {
 /**
  * The 2-letter country code of the city: https://d.to/geo
  */
-export const GetCityAnalyticsCountry = {
+export const GetCitiesByClicksCountry = {
     Af: "AF",
     Al: "AL",
     Dz: "DZ",
@@ -603,10 +616,9 @@ export const GetCityAnalyticsCountry = {
 /**
  * The 2-letter country code of the city: https://d.to/geo
  */
-export type GetCityAnalyticsCountry =
-    (typeof GetCityAnalyticsCountry)[keyof typeof GetCityAnalyticsCountry];
+export type GetCitiesByClicksCountry = ClosedEnum<typeof GetCitiesByClicksCountry>;
 
-export type GetCityAnalyticsResponseBody = {
+export type GetCitiesByClicksResponseBody = {
     /**
      * The name of the city
      */
@@ -614,7 +626,7 @@ export type GetCityAnalyticsResponseBody = {
     /**
      * The 2-letter country code of the city: https://d.to/geo
      */
-    country: GetCityAnalyticsCountry;
+    country: GetCitiesByClicksCountry;
     /**
      * The number of clicks from this city
      */
@@ -622,43 +634,29 @@ export type GetCityAnalyticsResponseBody = {
 };
 
 /** @internal */
-export const GetCityAnalyticsQueryParamInterval$: z.ZodNativeEnum<
-    typeof GetCityAnalyticsQueryParamInterval
-> = z.nativeEnum(GetCityAnalyticsQueryParamInterval);
+export namespace GetCitiesByClicksQueryParamInterval$ {
+    export const inboundSchema = z.nativeEnum(GetCitiesByClicksQueryParamInterval);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export const GetCityAnalyticsQueryParamCountry$: z.ZodNativeEnum<
-    typeof GetCityAnalyticsQueryParamCountry
-> = z.nativeEnum(GetCityAnalyticsQueryParamCountry);
+export namespace GetCitiesByClicksQueryParamCountry$ {
+    export const inboundSchema = z.nativeEnum(GetCitiesByClicksQueryParamCountry);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetCityAnalyticsRequest$ {
-    export type Inbound = {
-        domain?: string | undefined;
-        key?: string | undefined;
-        linkId?: string | undefined;
-        externalId?: string | undefined;
-        interval?: GetCityAnalyticsQueryParamInterval | undefined;
-        country?: GetCityAnalyticsQueryParamCountry | 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<GetCityAnalyticsRequest, z.ZodTypeDef, Inbound> = z
+export namespace GetCitiesByClicksRequest$ {
+    export const inboundSchema: z.ZodType<GetCitiesByClicksRequest, z.ZodTypeDef, unknown> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetCityAnalyticsQueryParamInterval$.optional(),
-            country: GetCityAnalyticsQueryParamCountry$.optional(),
+            interval: GetCitiesByClicksQueryParamInterval$.inboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: GetCitiesByClicksQueryParamCountry$.inboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -675,7 +673,9 @@ export namespace GetCityAnalyticsRequest$ {
                 ...(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 }),
@@ -694,8 +694,10 @@ export namespace GetCityAnalyticsRequest$ {
         key?: string | undefined;
         linkId?: string | undefined;
         externalId?: string | undefined;
-        interval?: GetCityAnalyticsQueryParamInterval | undefined;
-        country?: GetCityAnalyticsQueryParamCountry | undefined;
+        interval: string;
+        start?: string | undefined;
+        end?: string | undefined;
+        country?: string | undefined;
         city?: string | undefined;
         device?: string | undefined;
         browser?: string | undefined;
@@ -707,14 +709,16 @@ export namespace GetCityAnalyticsRequest$ {
         root?: boolean | undefined;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCityAnalyticsRequest> = z
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCitiesByClicksRequest> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetCityAnalyticsQueryParamInterval$.optional(),
-            country: GetCityAnalyticsQueryParamCountry$.optional(),
+            interval: GetCitiesByClicksQueryParamInterval$.outboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: GetCitiesByClicksQueryParamCountry$.outboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -731,7 +735,9 @@ export namespace GetCityAnalyticsRequest$ {
                 ...(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 }),
@@ -747,21 +753,17 @@ export namespace GetCityAnalyticsRequest$ {
 }
 
 /** @internal */
-export const GetCityAnalyticsCountry$: z.ZodNativeEnum<typeof GetCityAnalyticsCountry> =
-    z.nativeEnum(GetCityAnalyticsCountry);
+export namespace GetCitiesByClicksCountry$ {
+    export const inboundSchema = z.nativeEnum(GetCitiesByClicksCountry);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetCityAnalyticsResponseBody$ {
-    export type Inbound = {
-        city: string;
-        country: GetCityAnalyticsCountry;
-        clicks: number;
-    };
-
-    export const inboundSchema: z.ZodType<GetCityAnalyticsResponseBody, z.ZodTypeDef, Inbound> = z
+export namespace GetCitiesByClicksResponseBody$ {
+    export const inboundSchema: z.ZodType<GetCitiesByClicksResponseBody, z.ZodTypeDef, unknown> = z
         .object({
             city: z.string(),
-            country: GetCityAnalyticsCountry$,
+            country: GetCitiesByClicksCountry$.inboundSchema,
             clicks: z.number(),
         })
         .transform((v) => {
@@ -774,21 +776,22 @@ export namespace GetCityAnalyticsResponseBody$ {
 
     export type Outbound = {
         city: string;
-        country: GetCityAnalyticsCountry;
+        country: string;
         clicks: number;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCityAnalyticsResponseBody> = z
-        .object({
-            city: z.string(),
-            country: GetCityAnalyticsCountry$,
-            clicks: z.number(),
-        })
-        .transform((v) => {
-            return {
-                city: v.city,
-                country: v.country,
-                clicks: v.clicks,
-            };
-        });
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetCitiesByClicksResponseBody> =
+        z
+            .object({
+                city: z.string(),
+                country: GetCitiesByClicksCountry$.outboundSchema,
+                clicks: z.number(),
+            })
+            .transform((v) => {
+                return {
+                    city: v.city,
+                    country: v.country,
+                    clicks: v.clicks,
+                };
+            });
 }