dub 0.28.1 → 0.29.2

package/src/models/operations/{getrefereranalytics.ts → getreferersbyclicks.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 GetRefererAnalyticsQueryParamInterval = {
+export const GetReferersByClicksQueryParamInterval = {
     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 GetRefererAnalyticsQueryParamInterval =
-    (typeof GetRefererAnalyticsQueryParamInterval)[keyof typeof GetRefererAnalyticsQueryParamInterval];
+export type GetReferersByClicksQueryParamInterval = ClosedEnum<
+    typeof GetReferersByClicksQueryParamInterval
+>;
 
 /**
  * The country to retrieve analytics for.
  */
-export const GetRefererAnalyticsQueryParamCountry = {
+export const GetReferersByClicksQueryParamCountry = {
     Af: "AF",
     Al: "AL",
     Dz: "DZ",
@@ -279,12 +283,13 @@ export const GetRefererAnalyticsQueryParamCountry = {
 /**
  * The country to retrieve analytics for.
  */
-export type GetRefererAnalyticsQueryParamCountry =
-    (typeof GetRefererAnalyticsQueryParamCountry)[keyof typeof GetRefererAnalyticsQueryParamCountry];
+export type GetReferersByClicksQueryParamCountry = ClosedEnum<
+    typeof GetReferersByClicksQueryParamCountry
+>;
 
-export type GetRefererAnalyticsRequest = {
+export type GetReferersByClicksRequest = {
     /**
-     * The domain of the short link.
+     * The domain to filter analytics for.
      */
     domain?: string | undefined;
     /**
@@ -300,13 +305,21 @@ export type GetRefererAnalyticsRequest = {
      */
     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?: GetRefererAnalyticsQueryParamInterval | undefined;
+    interval?: GetReferersByClicksQueryParamInterval | 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?: GetRefererAnalyticsQueryParamCountry | undefined;
+    country?: GetReferersByClicksQueryParamCountry | undefined;
     /**
      * The city to retrieve analytics for.
      */
@@ -345,7 +358,7 @@ export type GetRefererAnalyticsRequest = {
     root?: boolean | undefined;
 };
 
-export type GetRefererAnalyticsResponseBody = {
+export type GetReferersByClicksResponseBody = {
     /**
      * The name of the referer. If unknown, this will be `(direct)`
      */
@@ -357,43 +370,29 @@ export type GetRefererAnalyticsResponseBody = {
 };
 
 /** @internal */
-export const GetRefererAnalyticsQueryParamInterval$: z.ZodNativeEnum<
-    typeof GetRefererAnalyticsQueryParamInterval
-> = z.nativeEnum(GetRefererAnalyticsQueryParamInterval);
+export namespace GetReferersByClicksQueryParamInterval$ {
+    export const inboundSchema = z.nativeEnum(GetReferersByClicksQueryParamInterval);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export const GetRefererAnalyticsQueryParamCountry$: z.ZodNativeEnum<
-    typeof GetRefererAnalyticsQueryParamCountry
-> = z.nativeEnum(GetRefererAnalyticsQueryParamCountry);
+export namespace GetReferersByClicksQueryParamCountry$ {
+    export const inboundSchema = z.nativeEnum(GetReferersByClicksQueryParamCountry);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetRefererAnalyticsRequest$ {
-    export type Inbound = {
-        domain?: string | undefined;
-        key?: string | undefined;
-        linkId?: string | undefined;
-        externalId?: string | undefined;
-        interval?: GetRefererAnalyticsQueryParamInterval | undefined;
-        country?: GetRefererAnalyticsQueryParamCountry | 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<GetRefererAnalyticsRequest, z.ZodTypeDef, Inbound> = z
+export namespace GetReferersByClicksRequest$ {
+    export const inboundSchema: z.ZodType<GetReferersByClicksRequest, z.ZodTypeDef, unknown> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetRefererAnalyticsQueryParamInterval$.optional(),
-            country: GetRefererAnalyticsQueryParamCountry$.optional(),
+            interval: GetReferersByClicksQueryParamInterval$.inboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: GetReferersByClicksQueryParamCountry$.inboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -410,7 +409,9 @@ export namespace GetRefererAnalyticsRequest$ {
                 ...(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 }),
@@ -429,8 +430,10 @@ export namespace GetRefererAnalyticsRequest$ {
         key?: string | undefined;
         linkId?: string | undefined;
         externalId?: string | undefined;
-        interval?: GetRefererAnalyticsQueryParamInterval | undefined;
-        country?: GetRefererAnalyticsQueryParamCountry | undefined;
+        interval: string;
+        start?: string | undefined;
+        end?: string | undefined;
+        country?: string | undefined;
         city?: string | undefined;
         device?: string | undefined;
         browser?: string | undefined;
@@ -442,14 +445,16 @@ export namespace GetRefererAnalyticsRequest$ {
         root?: boolean | undefined;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetRefererAnalyticsRequest> = z
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetReferersByClicksRequest> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: GetRefererAnalyticsQueryParamInterval$.optional(),
-            country: GetRefererAnalyticsQueryParamCountry$.optional(),
+            interval: GetReferersByClicksQueryParamInterval$.outboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: GetReferersByClicksQueryParamCountry$.outboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -466,7 +471,9 @@ export namespace GetRefererAnalyticsRequest$ {
                 ...(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 }),
@@ -482,13 +489,8 @@ export namespace GetRefererAnalyticsRequest$ {
 }
 
 /** @internal */
-export namespace GetRefererAnalyticsResponseBody$ {
-    export type Inbound = {
-        referer: string;
-        clicks: number;
-    };
-
-    export const inboundSchema: z.ZodType<GetRefererAnalyticsResponseBody, z.ZodTypeDef, Inbound> =
+export namespace GetReferersByClicksResponseBody$ {
+    export const inboundSchema: z.ZodType<GetReferersByClicksResponseBody, z.ZodTypeDef, unknown> =
         z
             .object({
                 referer: z.string(),
@@ -509,7 +511,7 @@ export namespace GetRefererAnalyticsResponseBody$ {
     export const outboundSchema: z.ZodType<
         Outbound,
         z.ZodTypeDef,
-        GetRefererAnalyticsResponseBody
+        GetReferersByClicksResponseBody
     > = z
         .object({
             referer: z.string(),