dub 0.43.2 → 0.43.4

package/src/models/components/analyticstriggers.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The type of trigger method: link click or QR scan
+ */
+export const Trigger = {
+  Qr: "qr",
+  Link: "link",
+} as const;
+/**
+ * The type of trigger method: link click or QR scan
+ */
+export type Trigger = ClosedEnum<typeof Trigger>;
+
+export type AnalyticsTriggers = {
+  /**
+   * The type of trigger method: link click or QR scan
+   */
+  trigger: Trigger;
+  /**
+   * The number of clicks from this trigger method
+   */
+  clicks?: number | undefined;
+  /**
+   * The number of leads from this trigger method
+   */
+  leads?: number | undefined;
+  /**
+   * The number of sales from this trigger method
+   */
+  sales?: number | undefined;
+  /**
+   * The total amount of sales from this trigger method, in cents
+   */
+  saleAmount?: number | undefined;
+};
+
+/** @internal */
+export const Trigger$inboundSchema: z.ZodNativeEnum<typeof Trigger> = z
+  .nativeEnum(Trigger);
+
+/** @internal */
+export const Trigger$outboundSchema: z.ZodNativeEnum<typeof Trigger> =
+  Trigger$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Trigger$ {
+  /** @deprecated use `Trigger$inboundSchema` instead. */
+  export const inboundSchema = Trigger$inboundSchema;
+  /** @deprecated use `Trigger$outboundSchema` instead. */
+  export const outboundSchema = Trigger$outboundSchema;
+}
+
+/** @internal */
+export const AnalyticsTriggers$inboundSchema: z.ZodType<
+  AnalyticsTriggers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  trigger: Trigger$inboundSchema,
+  clicks: z.number().default(0),
+  leads: z.number().default(0),
+  sales: z.number().default(0),
+  saleAmount: z.number().default(0),
+});
+
+/** @internal */
+export type AnalyticsTriggers$Outbound = {
+  trigger: string;
+  clicks: number;
+  leads: number;
+  sales: number;
+  saleAmount: number;
+};
+
+/** @internal */
+export const AnalyticsTriggers$outboundSchema: z.ZodType<
+  AnalyticsTriggers$Outbound,
+  z.ZodTypeDef,
+  AnalyticsTriggers
+> = z.object({
+  trigger: Trigger$outboundSchema,
+  clicks: z.number().default(0),
+  leads: z.number().default(0),
+  sales: z.number().default(0),
+  saleAmount: z.number().default(0),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AnalyticsTriggers$ {
+  /** @deprecated use `AnalyticsTriggers$inboundSchema` instead. */
+  export const inboundSchema = AnalyticsTriggers$inboundSchema;
+  /** @deprecated use `AnalyticsTriggers$outboundSchema` instead. */
+  export const outboundSchema = AnalyticsTriggers$outboundSchema;
+  /** @deprecated use `AnalyticsTriggers$Outbound` instead. */
+  export type Outbound = AnalyticsTriggers$Outbound;
+}

package/src/models/components/index.ts

@@ -4,14 +4,17 @@
 
 export * from "./analyticsbrowsers.js";
 export * from "./analyticscities.js";
+export * from "./analyticscontinents.js";
 export * from "./analyticscount.js";
 export * from "./analyticscountries.js";
 export * from "./analyticsdevices.js";
 export * from "./analyticsos.js";
 export * from "./analyticsreferers.js";
+export * from "./analyticsrefererurls.js";
 export * from "./analyticstimeseries.js";
 export * from "./analyticstoplinks.js";
 export * from "./analyticstopurls.js";
+export * from "./analyticstriggers.js";
 export * from "./clickevent.js";
 export * from "./continentcode.js";
 export * from "./countrycode.js";

package/src/models/operations/listevents.ts

@@ -36,6 +36,18 @@ export const QueryParamInterval = {
  */
 export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;
 
+/**
+ * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+ */
+export const QueryParamTrigger = {
+  Qr: "qr",
+  Link: "link",
+} as const;
+/**
+ * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+ */
+export type QueryParamTrigger = ClosedEnum<typeof QueryParamTrigger>;
+
 export const Order = {
   Asc: "asc",
   Desc: "desc",
@@ -108,6 +120,10 @@ export type ListEventsRequest = {
    * The OS to retrieve analytics for.
    */
   os?: string | undefined;
+  /**
+   * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+   */
+  trigger?: QueryParamTrigger | undefined;
   /**
    * The referer to retrieve analytics for.
    */
@@ -125,7 +141,7 @@ export type ListEventsRequest = {
    */
   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.
+   * Deprecated. Use the `trigger` field instead. 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;
   /**
@@ -188,6 +204,27 @@ export namespace QueryParamInterval$ {
   export const outboundSchema = QueryParamInterval$outboundSchema;
 }
 
+/** @internal */
+export const QueryParamTrigger$inboundSchema: z.ZodNativeEnum<
+  typeof QueryParamTrigger
+> = z.nativeEnum(QueryParamTrigger);
+
+/** @internal */
+export const QueryParamTrigger$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamTrigger
+> = QueryParamTrigger$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamTrigger$ {
+  /** @deprecated use `QueryParamTrigger$inboundSchema` instead. */
+  export const inboundSchema = QueryParamTrigger$inboundSchema;
+  /** @deprecated use `QueryParamTrigger$outboundSchema` instead. */
+  export const outboundSchema = QueryParamTrigger$outboundSchema;
+}
+
 /** @internal */
 export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
   Order,
@@ -248,6 +285,7 @@ export const ListEventsRequest$inboundSchema: z.ZodType<
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
+  trigger: QueryParamTrigger$inboundSchema.optional(),
   referer: z.string().optional(),
   refererUrl: z.string().optional(),
   url: z.string().optional(),
@@ -277,6 +315,7 @@ export type ListEventsRequest$Outbound = {
   device?: string | undefined;
   browser?: string | undefined;
   os?: string | undefined;
+  trigger?: string | undefined;
   referer?: string | undefined;
   refererUrl?: string | undefined;
   url?: string | undefined;
@@ -310,6 +349,7 @@ export const ListEventsRequest$outboundSchema: z.ZodType<
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
+  trigger: QueryParamTrigger$outboundSchema.optional(),
   referer: z.string().optional(),
   refererUrl: z.string().optional(),
   url: z.string().optional(),

package/src/models/operations/retrieveanalytics.ts

@@ -7,7 +7,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
 /**
- * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ * The type of event to retrieve analytics for. Defaults to `clicks`.
  */
 export const Event = {
   Clicks: "clicks",
@@ -16,12 +16,12 @@ export const Event = {
   Composite: "composite",
 } as const;
 /**
- * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ * The type of event to retrieve analytics for. Defaults to `clicks`.
  */
 export type Event = ClosedEnum<typeof Event>;
 
 /**
- * The parameter to group the analytics data points by. Defaults to 'count' if undefined.
+ * The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
  */
 export const QueryParamGroupBy = {
   Count: "count",
@@ -32,14 +32,15 @@ export const QueryParamGroupBy = {
   Devices: "devices",
   Browsers: "browsers",
   Os: "os",
+  Trigger: "trigger",
+  Triggers: "triggers",
   Referers: "referers",
   RefererUrls: "referer_urls",
   TopLinks: "top_links",
   TopUrls: "top_urls",
-  Trigger: "trigger",
 } as const;
 /**
- * The parameter to group the analytics data points by. Defaults to 'count' if undefined.
+ * The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
  */
 export type QueryParamGroupBy = ClosedEnum<typeof QueryParamGroupBy>;
 
@@ -61,13 +62,25 @@ export const Interval = {
  */
 export type Interval = ClosedEnum<typeof Interval>;
 
+/**
+ * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+ */
+export const Trigger = {
+  Qr: "qr",
+  Link: "link",
+} as const;
+/**
+ * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+ */
+export type Trigger = ClosedEnum<typeof Trigger>;
+
 export type RetrieveAnalyticsRequest = {
   /**
-   * The type of event to retrieve analytics for. Defaults to 'clicks'.
+   * The type of event to retrieve analytics for. Defaults to `clicks`.
    */
   event?: Event | undefined;
   /**
-   * The parameter to group the analytics data points by. Defaults to 'count' if undefined.
+   * The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
    */
   groupBy?: QueryParamGroupBy | undefined;
   /**
@@ -126,6 +139,10 @@ export type RetrieveAnalyticsRequest = {
    * The OS to retrieve analytics for.
    */
   os?: string | undefined;
+  /**
+   * The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+   */
+  trigger?: Trigger | undefined;
   /**
    * The referer to retrieve analytics for.
    */
@@ -143,7 +160,7 @@ export type RetrieveAnalyticsRequest = {
    */
   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.
+   * Deprecated. Use the `trigger` field instead. 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;
   /**
@@ -158,12 +175,15 @@ export type RetrieveAnalyticsRequest = {
 export type RetrieveAnalyticsResponseBody =
   | components.AnalyticsCount
   | Array<components.AnalyticsTimeseries>
+  | Array<components.AnalyticsContinents>
   | Array<components.AnalyticsCountries>
   | Array<components.AnalyticsCities>
   | Array<components.AnalyticsDevices>
   | Array<components.AnalyticsBrowsers>
   | Array<components.AnalyticsOS>
+  | Array<components.AnalyticsTriggers>
   | Array<components.AnalyticsReferers>
+  | Array<components.AnalyticsRefererUrls>
   | Array<components.AnalyticsTopLinks>
   | Array<components.AnalyticsTopUrls>;
 
@@ -227,6 +247,25 @@ export namespace Interval$ {
   export const outboundSchema = Interval$outboundSchema;
 }
 
+/** @internal */
+export const Trigger$inboundSchema: z.ZodNativeEnum<typeof Trigger> = z
+  .nativeEnum(Trigger);
+
+/** @internal */
+export const Trigger$outboundSchema: z.ZodNativeEnum<typeof Trigger> =
+  Trigger$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Trigger$ {
+  /** @deprecated use `Trigger$inboundSchema` instead. */
+  export const inboundSchema = Trigger$inboundSchema;
+  /** @deprecated use `Trigger$outboundSchema` instead. */
+  export const outboundSchema = Trigger$outboundSchema;
+}
+
 /** @internal */
 export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   RetrieveAnalyticsRequest,
@@ -249,6 +288,7 @@ export const RetrieveAnalyticsRequest$inboundSchema: z.ZodType<
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
+  trigger: Trigger$inboundSchema.optional(),
   referer: z.string().optional(),
   refererUrl: z.string().optional(),
   url: z.string().optional(),
@@ -275,6 +315,7 @@ export type RetrieveAnalyticsRequest$Outbound = {
   device?: string | undefined;
   browser?: string | undefined;
   os?: string | undefined;
+  trigger?: string | undefined;
   referer?: string | undefined;
   refererUrl?: string | undefined;
   url?: string | undefined;
@@ -305,6 +346,7 @@ export const RetrieveAnalyticsRequest$outboundSchema: z.ZodType<
   device: z.string().optional(),
   browser: z.string().optional(),
   os: z.string().optional(),
+  trigger: Trigger$outboundSchema.optional(),
   referer: z.string().optional(),
   refererUrl: z.string().optional(),
   url: z.string().optional(),
@@ -334,12 +376,15 @@ export const RetrieveAnalyticsResponseBody$inboundSchema: z.ZodType<
 > = z.union([
   components.AnalyticsCount$inboundSchema,
   z.array(components.AnalyticsTimeseries$inboundSchema),
+  z.array(components.AnalyticsContinents$inboundSchema),
   z.array(components.AnalyticsCountries$inboundSchema),
   z.array(components.AnalyticsCities$inboundSchema),
   z.array(components.AnalyticsDevices$inboundSchema),
   z.array(components.AnalyticsBrowsers$inboundSchema),
   z.array(components.AnalyticsOS$inboundSchema),
+  z.array(components.AnalyticsTriggers$inboundSchema),
   z.array(components.AnalyticsReferers$inboundSchema),
+  z.array(components.AnalyticsRefererUrls$inboundSchema),
   z.array(components.AnalyticsTopLinks$inboundSchema),
   z.array(components.AnalyticsTopUrls$inboundSchema),
 ]);
@@ -348,12 +393,15 @@ export const RetrieveAnalyticsResponseBody$inboundSchema: z.ZodType<
 export type RetrieveAnalyticsResponseBody$Outbound =
   | components.AnalyticsCount$Outbound
   | Array<components.AnalyticsTimeseries$Outbound>
+  | Array<components.AnalyticsContinents$Outbound>
   | Array<components.AnalyticsCountries$Outbound>
   | Array<components.AnalyticsCities$Outbound>
   | Array<components.AnalyticsDevices$Outbound>
   | Array<components.AnalyticsBrowsers$Outbound>
   | Array<components.AnalyticsOS$Outbound>
+  | Array<components.AnalyticsTriggers$Outbound>
   | Array<components.AnalyticsReferers$Outbound>
+  | Array<components.AnalyticsRefererUrls$Outbound>
   | Array<components.AnalyticsTopLinks$Outbound>
   | Array<components.AnalyticsTopUrls$Outbound>;
 
@@ -365,12 +413,15 @@ export const RetrieveAnalyticsResponseBody$outboundSchema: z.ZodType<
 > = z.union([
   components.AnalyticsCount$outboundSchema,
   z.array(components.AnalyticsTimeseries$outboundSchema),
+  z.array(components.AnalyticsContinents$outboundSchema),
   z.array(components.AnalyticsCountries$outboundSchema),
   z.array(components.AnalyticsCities$outboundSchema),
   z.array(components.AnalyticsDevices$outboundSchema),
   z.array(components.AnalyticsBrowsers$outboundSchema),
   z.array(components.AnalyticsOS$outboundSchema),
+  z.array(components.AnalyticsTriggers$outboundSchema),
   z.array(components.AnalyticsReferers$outboundSchema),
+  z.array(components.AnalyticsRefererUrls$outboundSchema),
   z.array(components.AnalyticsTopLinks$outboundSchema),
   z.array(components.AnalyticsTopUrls$outboundSchema),
 ]);