dub 0.35.0 → 0.36.0

package/src/models/operations/listevents.ts

@@ -0,0 +1,312 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+import * as z from "zod";
+
+/**
+ * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ */
+export const QueryParamEvent = {
+    Clicks: "clicks",
+    Leads: "leads",
+    Sales: "sales",
+    Composite: "composite",
+} as const;
+/**
+ * The type of event to retrieve analytics for. Defaults to 'clicks'.
+ */
+export type QueryParamEvent = ClosedEnum<typeof QueryParamEvent>;
+
+/**
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+ */
+export const QueryParamInterval = {
+    TwentyFourh: "24h",
+    Sevend: "7d",
+    Thirtyd: "30d",
+    Ninetyd: "90d",
+    Ytd: "ytd",
+    Oney: "1y",
+    All: "all",
+    AllUnfiltered: "all_unfiltered",
+} as const;
+/**
+ * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+ */
+export type QueryParamInterval = ClosedEnum<typeof QueryParamInterval>;
+
+export const Order = {
+    Asc: "asc",
+    Desc: "desc",
+} as const;
+export type Order = ClosedEnum<typeof Order>;
+
+export const SortBy = {
+    Timestamp: "timestamp",
+    Amount: "amount",
+} as const;
+export type SortBy = ClosedEnum<typeof SortBy>;
+
+export type ListEventsRequest = {
+    /**
+     * The type of event to retrieve analytics for. Defaults to 'clicks'.
+     */
+    event?: QueryParamEvent | undefined;
+    /**
+     * The domain to filter analytics for.
+     */
+    domain?: string | undefined;
+    /**
+     * The short link slug.
+     */
+    key?: string | undefined;
+    /**
+     * The unique ID of the short link on Dub.
+     */
+    linkId?: string | undefined;
+    /**
+     * This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
+     */
+    externalId?: string | undefined;
+    /**
+     * The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
+     */
+    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 IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
+     */
+    timezone?: string | undefined;
+    /**
+     * The continent to retrieve analytics for.
+     */
+    continent?: components.ContinentCode | undefined;
+    /**
+     * The country to retrieve analytics for.
+     */
+    country?: components.CountryCode | undefined;
+    /**
+     * The city to retrieve analytics for.
+     */
+    city?: string | undefined;
+    /**
+     * The device to retrieve analytics for.
+     */
+    device?: string | undefined;
+    /**
+     * The browser to retrieve analytics for.
+     */
+    browser?: string | undefined;
+    /**
+     * The OS to retrieve analytics for.
+     */
+    os?: string | undefined;
+    /**
+     * The referer to retrieve analytics for.
+     */
+    referer?: string | undefined;
+    /**
+     * The URL to retrieve analytics for.
+     */
+    url?: string | undefined;
+    /**
+     * The tag ID to retrieve analytics for.
+     */
+    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.
+     */
+    qr?: boolean | undefined;
+    /**
+     * Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
+     */
+    root?: boolean | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
+    order?: Order | undefined;
+    sortBy?: SortBy | undefined;
+};
+
+/** @internal */
+export const QueryParamEvent$inboundSchema: z.ZodNativeEnum<typeof QueryParamEvent> =
+    z.nativeEnum(QueryParamEvent);
+
+/** @internal */
+export const QueryParamEvent$outboundSchema: z.ZodNativeEnum<typeof QueryParamEvent> =
+    QueryParamEvent$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamEvent$ {
+    /** @deprecated use `QueryParamEvent$inboundSchema` instead. */
+    export const inboundSchema = QueryParamEvent$inboundSchema;
+    /** @deprecated use `QueryParamEvent$outboundSchema` instead. */
+    export const outboundSchema = QueryParamEvent$outboundSchema;
+}
+
+/** @internal */
+export const QueryParamInterval$inboundSchema: z.ZodNativeEnum<typeof QueryParamInterval> =
+    z.nativeEnum(QueryParamInterval);
+
+/** @internal */
+export const QueryParamInterval$outboundSchema: z.ZodNativeEnum<typeof QueryParamInterval> =
+    QueryParamInterval$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace QueryParamInterval$ {
+    /** @deprecated use `QueryParamInterval$inboundSchema` instead. */
+    export const inboundSchema = QueryParamInterval$inboundSchema;
+    /** @deprecated use `QueryParamInterval$outboundSchema` instead. */
+    export const outboundSchema = QueryParamInterval$outboundSchema;
+}
+
+/** @internal */
+export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(Order);
+
+/** @internal */
+export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> = Order$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Order$ {
+    /** @deprecated use `Order$inboundSchema` instead. */
+    export const inboundSchema = Order$inboundSchema;
+    /** @deprecated use `Order$outboundSchema` instead. */
+    export const outboundSchema = Order$outboundSchema;
+}
+
+/** @internal */
+export const SortBy$inboundSchema: z.ZodNativeEnum<typeof SortBy> = z.nativeEnum(SortBy);
+
+/** @internal */
+export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> = SortBy$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SortBy$ {
+    /** @deprecated use `SortBy$inboundSchema` instead. */
+    export const inboundSchema = SortBy$inboundSchema;
+    /** @deprecated use `SortBy$outboundSchema` instead. */
+    export const outboundSchema = SortBy$outboundSchema;
+}
+
+/** @internal */
+export const ListEventsRequest$inboundSchema: z.ZodType<ListEventsRequest, z.ZodTypeDef, unknown> =
+    z.object({
+        event: QueryParamEvent$inboundSchema.default("clicks"),
+        domain: z.string().optional(),
+        key: z.string().optional(),
+        linkId: z.string().optional(),
+        externalId: z.string().optional(),
+        interval: QueryParamInterval$inboundSchema.optional(),
+        start: z.string().optional(),
+        end: z.string().optional(),
+        timezone: z.string().default("UTC"),
+        continent: components.ContinentCode$inboundSchema.optional(),
+        country: components.CountryCode$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(),
+        page: z.number().default(0),
+        limit: z.number().default(100),
+        order: Order$inboundSchema.default("desc"),
+        sortBy: SortBy$inboundSchema.default("timestamp"),
+    });
+
+/** @internal */
+export type ListEventsRequest$Outbound = {
+    event: string;
+    domain?: string | undefined;
+    key?: string | undefined;
+    linkId?: string | undefined;
+    externalId?: string | undefined;
+    interval?: string | undefined;
+    start?: string | undefined;
+    end?: string | undefined;
+    timezone: string;
+    continent?: string | undefined;
+    country?: string | 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;
+    page: number;
+    limit: number;
+    order: string;
+    sortBy: string;
+};
+
+/** @internal */
+export const ListEventsRequest$outboundSchema: z.ZodType<
+    ListEventsRequest$Outbound,
+    z.ZodTypeDef,
+    ListEventsRequest
+> = z.object({
+    event: QueryParamEvent$outboundSchema.default("clicks"),
+    domain: z.string().optional(),
+    key: z.string().optional(),
+    linkId: z.string().optional(),
+    externalId: z.string().optional(),
+    interval: QueryParamInterval$outboundSchema.optional(),
+    start: z.string().optional(),
+    end: z.string().optional(),
+    timezone: z.string().default("UTC"),
+    continent: components.ContinentCode$outboundSchema.optional(),
+    country: components.CountryCode$outboundSchema.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(),
+    page: z.number().default(0),
+    limit: z.number().default(100),
+    order: Order$outboundSchema.default("desc"),
+    sortBy: SortBy$outboundSchema.default("timestamp"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListEventsRequest$ {
+    /** @deprecated use `ListEventsRequest$inboundSchema` instead. */
+    export const inboundSchema = ListEventsRequest$inboundSchema;
+    /** @deprecated use `ListEventsRequest$outboundSchema` instead. */
+    export const outboundSchema = ListEventsRequest$outboundSchema;
+    /** @deprecated use `ListEventsRequest$Outbound` instead. */
+    export type Outbound = ListEventsRequest$Outbound;
+}

package/src/models/operations/updatedomain.ts

@@ -40,7 +40,7 @@ export const UpdateDomainRequestBody$inboundSchema: z.ZodType<
 > = z.object({
     slug: z.string().optional(),
     expiredUrl: z.nullable(z.string()).optional(),
-    archived: z.boolean().default(false),
+    archived: z.boolean(),
     placeholder: z.nullable(z.string().default("https://dub.co/help/article/what-is-dub")),
 });
 

package/src/models/operations/updatelink.ts

@@ -215,9 +215,9 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
         key: z.string().optional(),
         externalId: z.nullable(z.string()).optional(),
         prefix: z.string().optional(),
-        trackConversion: z.boolean().default(false),
-        archived: z.boolean().default(false),
-        publicStats: z.boolean().default(false),
+        trackConversion: z.boolean(),
+        archived: z.boolean(),
+        publicStats: z.boolean(),
         tagId: z.nullable(z.string()).optional(),
         tagIds: z.union([z.string(), z.array(z.string())]).optional(),
         tagNames: z.union([z.string(), z.array(z.string())]).optional(),
@@ -225,16 +225,16 @@ export const UpdateLinkRequestBody$inboundSchema: z.ZodType<
         expiresAt: z.nullable(z.string()).optional(),
         expiredUrl: z.nullable(z.string()).optional(),
         password: z.nullable(z.string()).optional(),
-        proxy: z.boolean().default(false),
+        proxy: z.boolean(),
         title: z.nullable(z.string()).optional(),
         description: z.nullable(z.string()).optional(),
         image: z.nullable(z.string()).optional(),
         video: z.nullable(z.string()).optional(),
-        rewrite: z.boolean().default(false),
+        rewrite: z.boolean(),
         ios: z.nullable(z.string()).optional(),
         android: z.nullable(z.string()).optional(),
         geo: z.nullable(components.LinkGeoTargeting$inboundSchema).optional(),
-        doIndex: z.boolean().default(false),
+        doIndex: z.boolean(),
         utm_source: z.nullable(z.string()).optional(),
         utm_medium: z.nullable(z.string()).optional(),
         utm_campaign: z.nullable(z.string()).optional(),

package/src/models/operations/upsertlink.ts

@@ -210,9 +210,9 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
         key: z.string().optional(),
         externalId: z.nullable(z.string()).optional(),
         prefix: z.string().optional(),
-        trackConversion: z.boolean().default(false),
-        archived: z.boolean().default(false),
-        publicStats: z.boolean().default(false),
+        trackConversion: z.boolean(),
+        archived: z.boolean(),
+        publicStats: z.boolean(),
         tagId: z.nullable(z.string()).optional(),
         tagIds: z.union([z.string(), z.array(z.string())]).optional(),
         tagNames: z.union([z.string(), z.array(z.string())]).optional(),
@@ -220,16 +220,16 @@ export const UpsertLinkRequestBody$inboundSchema: z.ZodType<
         expiresAt: z.nullable(z.string()).optional(),
         expiredUrl: z.nullable(z.string()).optional(),
         password: z.nullable(z.string()).optional(),
-        proxy: z.boolean().default(false),
+        proxy: z.boolean(),
         title: z.nullable(z.string()).optional(),
         description: z.nullable(z.string()).optional(),
         image: z.nullable(z.string()).optional(),
         video: z.nullable(z.string()).optional(),
-        rewrite: z.boolean().default(false),
+        rewrite: z.boolean(),
         ios: z.nullable(z.string()).optional(),
         android: z.nullable(z.string()).optional(),
         geo: z.nullable(components.LinkGeoTargeting$inboundSchema).optional(),
-        doIndex: z.boolean().default(false),
+        doIndex: z.boolean(),
         utm_source: z.nullable(z.string()).optional(),
         utm_medium: z.nullable(z.string()).optional(),
         utm_campaign: z.nullable(z.string()).optional(),

package/src/sdk/analytics.ts

@@ -2,43 +2,12 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { SDKHooks } from "../hooks/hooks.js";
-import { SDKOptions, serverURLFromOptions } from "../lib/config.js";
-import { encodeFormQuery as encodeFormQuery$ } from "../lib/encodings.js";
-import { HTTPClient } from "../lib/http.js";
-import * as schemas$ from "../lib/schemas.js";
+import { analyticsRetrieve } from "../funcs/analyticsRetrieve.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import { extractSecurity } from "../lib/security.js";
-import * as errors from "../models/errors/index.js";
 import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
 
 export class Analytics extends ClientSDK {
-    private readonly options$: SDKOptions & { hooks?: SDKHooks };
-
-    constructor(options: SDKOptions = {}) {
-        const opt = options as unknown;
-        let hooks: SDKHooks;
-        if (
-            typeof opt === "object" &&
-            opt != null &&
-            "hooks" in opt &&
-            opt.hooks instanceof SDKHooks
-        ) {
-            hooks = opt.hooks;
-        } else {
-            hooks = new SDKHooks();
-        }
-
-        super({
-            client: options.httpClient || new HTTPClient(),
-            baseURL: serverURLFromOptions(options),
-            hooks,
-        });
-
-        this.options$ = { ...options, hooks };
-        void this.options$;
-    }
-
     /**
      * Retrieve analytics for a link, a domain, or the authenticated workspace.
      *
@@ -49,105 +18,6 @@ export class Analytics extends ClientSDK {
         request?: operations.RetrieveAnalyticsRequest | undefined,
         options?: RequestOptions
     ): Promise<operations.RetrieveAnalyticsResponseBody> {
-        const input$ = typeof request === "undefined" ? {} : request;
-
-        const payload$ = schemas$.parse(
-            input$,
-            (value$) => operations.RetrieveAnalyticsRequest$outboundSchema.parse(value$),
-            "Input validation failed"
-        );
-        const body$ = null;
-
-        const path$ = this.templateURLComponent("/analytics")();
-
-        const query$ = encodeFormQuery$({
-            browser: payload$.browser,
-            city: payload$.city,
-            continent: payload$.continent,
-            country: payload$.country,
-            device: payload$.device,
-            domain: payload$.domain,
-            end: payload$.end,
-            event: payload$.event,
-            externalId: payload$.externalId,
-            groupBy: payload$.groupBy,
-            interval: payload$.interval,
-            key: payload$.key,
-            linkId: payload$.linkId,
-            os: payload$.os,
-            qr: payload$.qr,
-            referer: payload$.referer,
-            root: payload$.root,
-            start: payload$.start,
-            tagId: payload$.tagId,
-            timezone: payload$.timezone,
-            url: payload$.url,
-        });
-
-        const headers$ = new Headers({
-            Accept: "application/json",
-        });
-
-        const token$ = await extractSecurity(this.options$.token);
-        const security$ = token$ == null ? {} : { token: token$ };
-        const context = {
-            operationID: "retrieveAnalytics",
-            oAuth2Scopes: [],
-            securitySource: this.options$.token,
-        };
-        const securitySettings$ = this.resolveGlobalSecurity(security$);
-
-        const request$ = this.createRequest$(
-            context,
-            {
-                security: securitySettings$,
-                method: "GET",
-                path: path$,
-                headers: headers$,
-                query: query$,
-                body: body$,
-                timeoutMs: options?.timeoutMs || this.options$.timeoutMs || -1,
-            },
-            options
-        );
-
-        const response = await this.do$(request$, {
-            context,
-            errorCodes: [
-                "400",
-                "401",
-                "403",
-                "404",
-                "409",
-                "410",
-                "422",
-                "429",
-                "4XX",
-                "500",
-                "5XX",
-            ],
-            retryConfig: options?.retries || this.options$.retryConfig,
-            retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
-        });
-
-        const responseFields$ = {
-            HttpMeta: { Response: response, Request: request$ },
-        };
-
-        const [result$] = await this.matcher<operations.RetrieveAnalyticsResponseBody>()
-            .json(200, operations.RetrieveAnalyticsResponseBody$inboundSchema)
-            .json(400, errors.BadRequest$inboundSchema, { err: true })
-            .json(401, errors.Unauthorized$inboundSchema, { err: true })
-            .json(403, errors.Forbidden$inboundSchema, { err: true })
-            .json(404, errors.NotFound$inboundSchema, { err: true })
-            .json(409, errors.Conflict$inboundSchema, { err: true })
-            .json(410, errors.InviteExpired$inboundSchema, { err: true })
-            .json(422, errors.UnprocessableEntity$inboundSchema, { err: true })
-            .json(429, errors.RateLimitExceeded$inboundSchema, { err: true })
-            .json(500, errors.InternalServerError$inboundSchema, { err: true })
-            .fail(["4XX", "5XX"])
-            .match(response, { extraFields: responseFields$ });
-
-        return result$;
+        return unwrapAsync(analyticsRetrieve(this, request, options));
     }
 }