dub 0.28.1 → 0.29.2

package/src/models/operations/{getclicksanalytics.ts → getclickscount.ts}

@@ -2,10 +2,11 @@
  * 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 Interval = {
     Oneh: "1h",
@@ -13,12 +14,14 @@ export const Interval = {
     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 Interval = (typeof Interval)[keyof typeof Interval];
+export type Interval = ClosedEnum<typeof Interval>;
 
 /**
  * The country to retrieve analytics for.
@@ -278,11 +281,11 @@ export const Country = {
 /**
  * The country to retrieve analytics for.
  */
-export type Country = (typeof Country)[keyof typeof Country];
+export type Country = ClosedEnum<typeof Country>;
 
-export type GetClicksAnalyticsRequest = {
+export type GetClicksCountRequest = {
     /**
-     * The domain of the short link.
+     * The domain to filter analytics for.
      */
     domain?: string | undefined;
     /**
@@ -298,9 +301,17 @@ export type GetClicksAnalyticsRequest = {
      */
     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?: Interval | 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.
      */
@@ -344,39 +355,29 @@ export type GetClicksAnalyticsRequest = {
 };
 
 /** @internal */
-export const Interval$: z.ZodNativeEnum<typeof Interval> = z.nativeEnum(Interval);
+export namespace Interval$ {
+    export const inboundSchema = z.nativeEnum(Interval);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export const Country$: z.ZodNativeEnum<typeof Country> = z.nativeEnum(Country);
+export namespace Country$ {
+    export const inboundSchema = z.nativeEnum(Country);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetClicksAnalyticsRequest$ {
-    export type Inbound = {
-        domain?: string | undefined;
-        key?: string | undefined;
-        linkId?: string | undefined;
-        externalId?: string | undefined;
-        interval?: Interval | undefined;
-        country?: Country | 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<GetClicksAnalyticsRequest, z.ZodTypeDef, Inbound> = z
+export namespace GetClicksCountRequest$ {
+    export const inboundSchema: z.ZodType<GetClicksCountRequest, z.ZodTypeDef, unknown> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: Interval$.optional(),
-            country: Country$.optional(),
+            interval: Interval$.inboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: Country$.inboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -393,7 +394,9 @@ export namespace GetClicksAnalyticsRequest$ {
                 ...(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 }),
@@ -412,8 +415,10 @@ export namespace GetClicksAnalyticsRequest$ {
         key?: string | undefined;
         linkId?: string | undefined;
         externalId?: string | undefined;
-        interval?: Interval | undefined;
-        country?: Country | undefined;
+        interval: string;
+        start?: string | undefined;
+        end?: string | undefined;
+        country?: string | undefined;
         city?: string | undefined;
         device?: string | undefined;
         browser?: string | undefined;
@@ -425,14 +430,16 @@ export namespace GetClicksAnalyticsRequest$ {
         root?: boolean | undefined;
     };
 
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetClicksAnalyticsRequest> = z
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetClicksCountRequest> = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: Interval$.optional(),
-            country: Country$.optional(),
+            interval: Interval$.outboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: Country$.outboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -449,7 +456,9 @@ export namespace GetClicksAnalyticsRequest$ {
                 ...(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 }),

package/src/models/operations/{gettimeseriesanalytics.ts → getclickscountdeprecated.ts}

@@ -2,28 +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 QueryParamInterval = {
+export const GetClicksCountDeprecatedQueryParamInterval = {
     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 QueryParamInterval = (typeof QueryParamInterval)[keyof typeof QueryParamInterval];
+export type GetClicksCountDeprecatedQueryParamInterval = ClosedEnum<
+    typeof GetClicksCountDeprecatedQueryParamInterval
+>;
 
 /**
  * The country to retrieve analytics for.
  */
-export const QueryParamCountry = {
+export const GetClicksCountDeprecatedQueryParamCountry = {
     Af: "AF",
     Al: "AL",
     Dz: "DZ",
@@ -278,11 +283,13 @@ export const QueryParamCountry = {
 /**
  * The country to retrieve analytics for.
  */
-export type QueryParamCountry = (typeof QueryParamCountry)[keyof typeof QueryParamCountry];
+export type GetClicksCountDeprecatedQueryParamCountry = ClosedEnum<
+    typeof GetClicksCountDeprecatedQueryParamCountry
+>;
 
-export type GetTimeseriesAnalyticsRequest = {
+export type GetClicksCountDeprecatedRequest = {
     /**
-     * The domain of the short link.
+     * The domain to filter analytics for.
      */
     domain?: string | undefined;
     /**
@@ -298,13 +305,21 @@ export type GetTimeseriesAnalyticsRequest = {
      */
     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?: QueryParamInterval | undefined;
+    interval?: GetClicksCountDeprecatedQueryParamInterval | 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?: QueryParamCountry | undefined;
+    country?: GetClicksCountDeprecatedQueryParamCountry | undefined;
     /**
      * The city to retrieve analytics for.
      */
@@ -343,34 +358,72 @@ export type GetTimeseriesAnalyticsRequest = {
     root?: boolean | undefined;
 };
 
-export type ResponseBody = {
-    /**
-     * The starting timestamp of the interval
-     */
-    start: string;
-    /**
-     * The number of clicks in the interval
-     */
-    clicks: number;
-};
-
 /** @internal */
-export const QueryParamInterval$: z.ZodNativeEnum<typeof QueryParamInterval> =
-    z.nativeEnum(QueryParamInterval);
+export namespace GetClicksCountDeprecatedQueryParamInterval$ {
+    export const inboundSchema = z.nativeEnum(GetClicksCountDeprecatedQueryParamInterval);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export const QueryParamCountry$: z.ZodNativeEnum<typeof QueryParamCountry> =
-    z.nativeEnum(QueryParamCountry);
+export namespace GetClicksCountDeprecatedQueryParamCountry$ {
+    export const inboundSchema = z.nativeEnum(GetClicksCountDeprecatedQueryParamCountry);
+    export const outboundSchema = inboundSchema;
+}
 
 /** @internal */
-export namespace GetTimeseriesAnalyticsRequest$ {
-    export type Inbound = {
+export namespace GetClicksCountDeprecatedRequest$ {
+    export const inboundSchema: z.ZodType<GetClicksCountDeprecatedRequest, z.ZodTypeDef, unknown> =
+        z
+            .object({
+                domain: z.string().optional(),
+                key: z.string().optional(),
+                linkId: z.string().optional(),
+                externalId: z.string().optional(),
+                interval: GetClicksCountDeprecatedQueryParamInterval$.inboundSchema.default("24h"),
+                start: z.string().optional(),
+                end: z.string().optional(),
+                country: GetClicksCountDeprecatedQueryParamCountry$.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(),
+            })
+            .transform((v) => {
+                return {
+                    ...(v.domain === undefined ? null : { domain: v.domain }),
+                    ...(v.key === undefined ? null : { key: v.key }),
+                    ...(v.linkId === undefined ? null : { linkId: v.linkId }),
+                    ...(v.externalId === undefined ? null : { externalId: v.externalId }),
+                    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 }),
+                    ...(v.browser === undefined ? null : { browser: v.browser }),
+                    ...(v.os === undefined ? null : { os: v.os }),
+                    ...(v.referer === undefined ? null : { referer: v.referer }),
+                    ...(v.url === undefined ? null : { url: v.url }),
+                    ...(v.tagId === undefined ? null : { tagId: v.tagId }),
+                    ...(v.qr === undefined ? null : { qr: v.qr }),
+                    ...(v.root === undefined ? null : { root: v.root }),
+                };
+            });
+
+    export type Outbound = {
         domain?: string | undefined;
         key?: string | undefined;
         linkId?: string | undefined;
         externalId?: string | undefined;
-        interval?: QueryParamInterval | undefined;
-        country?: QueryParamCountry | undefined;
+        interval: string;
+        start?: string | undefined;
+        end?: string | undefined;
+        country?: string | undefined;
         city?: string | undefined;
         device?: string | undefined;
         browser?: string | undefined;
@@ -382,14 +435,20 @@ export namespace GetTimeseriesAnalyticsRequest$ {
         root?: boolean | undefined;
     };
 
-    export const inboundSchema: z.ZodType<GetTimeseriesAnalyticsRequest, z.ZodTypeDef, Inbound> = z
+    export const outboundSchema: z.ZodType<
+        Outbound,
+        z.ZodTypeDef,
+        GetClicksCountDeprecatedRequest
+    > = z
         .object({
             domain: z.string().optional(),
             key: z.string().optional(),
             linkId: z.string().optional(),
             externalId: z.string().optional(),
-            interval: QueryParamInterval$.optional(),
-            country: QueryParamCountry$.optional(),
+            interval: GetClicksCountDeprecatedQueryParamInterval$.outboundSchema.default("24h"),
+            start: z.string().optional(),
+            end: z.string().optional(),
+            country: GetClicksCountDeprecatedQueryParamCountry$.outboundSchema.optional(),
             city: z.string().optional(),
             device: z.string().optional(),
             browser: z.string().optional(),
@@ -406,7 +465,9 @@ export namespace GetTimeseriesAnalyticsRequest$ {
                 ...(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 }),
@@ -419,98 +480,4 @@ export namespace GetTimeseriesAnalyticsRequest$ {
                 ...(v.root === undefined ? null : { root: v.root }),
             };
         });
-
-    export type Outbound = {
-        domain?: string | undefined;
-        key?: string | undefined;
-        linkId?: string | undefined;
-        externalId?: string | undefined;
-        interval?: QueryParamInterval | undefined;
-        country?: QueryParamCountry | 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 outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetTimeseriesAnalyticsRequest> =
-        z
-            .object({
-                domain: z.string().optional(),
-                key: z.string().optional(),
-                linkId: z.string().optional(),
-                externalId: z.string().optional(),
-                interval: QueryParamInterval$.optional(),
-                country: QueryParamCountry$.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(),
-            })
-            .transform((v) => {
-                return {
-                    ...(v.domain === undefined ? null : { domain: v.domain }),
-                    ...(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 }),
-                    ...(v.country === undefined ? null : { country: v.country }),
-                    ...(v.city === undefined ? null : { city: v.city }),
-                    ...(v.device === undefined ? null : { device: v.device }),
-                    ...(v.browser === undefined ? null : { browser: v.browser }),
-                    ...(v.os === undefined ? null : { os: v.os }),
-                    ...(v.referer === undefined ? null : { referer: v.referer }),
-                    ...(v.url === undefined ? null : { url: v.url }),
-                    ...(v.tagId === undefined ? null : { tagId: v.tagId }),
-                    ...(v.qr === undefined ? null : { qr: v.qr }),
-                    ...(v.root === undefined ? null : { root: v.root }),
-                };
-            });
-}
-
-/** @internal */
-export namespace ResponseBody$ {
-    export type Inbound = {
-        start: string;
-        clicks: number;
-    };
-
-    export const inboundSchema: z.ZodType<ResponseBody, z.ZodTypeDef, Inbound> = z
-        .object({
-            start: z.string(),
-            clicks: z.number(),
-        })
-        .transform((v) => {
-            return {
-                start: v.start,
-                clicks: v.clicks,
-            };
-        });
-
-    export type Outbound = {
-        start: string;
-        clicks: number;
-    };
-
-    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, ResponseBody> = z
-        .object({
-            start: z.string(),
-            clicks: z.number(),
-        })
-        .transform((v) => {
-            return {
-                start: v.start,
-                clicks: v.clicks,
-            };
-        });
 }