dub 0.22.1 → 0.22.3

package/src/models/operations/getlinks.ts

@@ -28,7 +28,7 @@ export type GetLinksRequest = {
      */
     domain?: string | undefined;
     /**
-     * [DEPRECATED] (use tagIds instead): The tag ID to filter the links by.
+     * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
      */
     tagId?: string | undefined;
     /**

package/src/models/operations/getlinkscount.ts

@@ -30,7 +30,7 @@ export type GetLinksCountRequest = {
      */
     domain?: string | undefined;
     /**
-     * [DEPRECATED] (use tagIds instead): The tag ID to filter the links by.
+     * The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
      */
     tagId?: string | undefined;
     /**

package/src/models/operations/getmetatags.ts

@@ -0,0 +1,101 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type GetMetatagsRequest = {
+    url: string;
+};
+
+/**
+ * The retrieved metatags
+ */
+export type GetMetatagsResponseBody = {
+    /**
+     * The meta title tag for the URL
+     */
+    title?: string | undefined;
+    /**
+     * The meta description tag for the URL
+     */
+    description?: string | undefined;
+    /**
+     * The OpenGraph image for the URL
+     */
+    image?: string | undefined;
+};
+
+/** @internal */
+export namespace GetMetatagsRequest$ {
+    export type Inbound = {
+        url: string;
+    };
+
+    export const inboundSchema: z.ZodType<GetMetatagsRequest, z.ZodTypeDef, Inbound> = z
+        .object({
+            url: z.string(),
+        })
+        .transform((v) => {
+            return {
+                url: v.url,
+            };
+        });
+
+    export type Outbound = {
+        url: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetMetatagsRequest> = z
+        .object({
+            url: z.string(),
+        })
+        .transform((v) => {
+            return {
+                url: v.url,
+            };
+        });
+}
+
+/** @internal */
+export namespace GetMetatagsResponseBody$ {
+    export type Inbound = {
+        title?: string | undefined;
+        description?: string | undefined;
+        image?: string | undefined;
+    };
+
+    export const inboundSchema: z.ZodType<GetMetatagsResponseBody, z.ZodTypeDef, Inbound> = z
+        .object({
+            title: z.string().optional(),
+            description: z.string().optional(),
+            image: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.title === undefined ? null : { title: v.title }),
+                ...(v.description === undefined ? null : { description: v.description }),
+                ...(v.image === undefined ? null : { image: v.image }),
+            };
+        });
+
+    export type Outbound = {
+        title?: string | undefined;
+        description?: string | undefined;
+        image?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, GetMetatagsResponseBody> = z
+        .object({
+            title: z.string().optional(),
+            description: z.string().optional(),
+            image: z.string().optional(),
+        })
+        .transform((v) => {
+            return {
+                ...(v.title === undefined ? null : { title: v.title }),
+                ...(v.description === undefined ? null : { description: v.description }),
+                ...(v.image === undefined ? null : { image: v.image }),
+            };
+        });
+}

package/src/models/operations/index.ts

@@ -16,6 +16,7 @@ export * from "./getdeviceanalytics";
 export * from "./getlinkinfo";
 export * from "./getlinks";
 export * from "./getlinkscount";
+export * from "./getmetatags";
 export * from "./getosanalytics";
 export * from "./getqrcode";
 export * from "./getrefereranalytics";

package/src/sdk/metatags.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { SDKHooks } from "../hooks";
+import { SDK_METADATA, SDKOptions, serverURLFromOptions } from "../lib/config";
+import * as enc$ from "../lib/encodings";
+import { HTTPClient } from "../lib/http";
+import * as schemas$ from "../lib/schemas";
+import { ClientSDK, RequestOptions } from "../lib/sdks";
+import * as errors from "../models/errors";
+import * as operations from "../models/operations";
+
+export class Metatags 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 the metatags for a URL
+     *
+     * @remarks
+     * Retrieve the metatags for a URL
+     */
+    async get(
+        input: operations.GetMetatagsRequest,
+        options?: RequestOptions
+    ): Promise<operations.GetMetatagsResponseBody> {
+        const headers$ = new Headers();
+        headers$.set("user-agent", SDK_METADATA.userAgent);
+        headers$.set("Accept", "application/json");
+
+        const payload$ = schemas$.parse(
+            input,
+            (value$) => operations.GetMetatagsRequest$.outboundSchema.parse(value$),
+            "Input validation failed"
+        );
+        const body$ = null;
+
+        const path$ = this.templateURLComponent("/metatags")();
+
+        const query$ = [
+            enc$.encodeForm("url", payload$.url, { explode: true, charEncoding: "percent" }),
+        ]
+            .filter(Boolean)
+            .join("&");
+
+        let security$;
+        if (typeof this.options$.token === "function") {
+            security$ = { token: await this.options$.token() };
+        } else if (this.options$.token) {
+            security$ = { token: this.options$.token };
+        } else {
+            security$ = {};
+        }
+        const context = {
+            operationID: "getMetatags",
+            oAuth2Scopes: [],
+            securitySource: this.options$.token,
+        };
+        const securitySettings$ = this.resolveGlobalSecurity(security$);
+
+        const doOptions = { context, errorCodes: ["4XX", "5XX"] };
+        const request = this.createRequest$(
+            {
+                security: securitySettings$,
+                method: "GET",
+                path: path$,
+                headers: headers$,
+                query: query$,
+                body: body$,
+            },
+            options
+        );
+
+        const response = await this.do$(request, doOptions);
+
+        if (this.matchResponse(response, 200, "application/json")) {
+            const responseBody = await response.json();
+            const result = schemas$.parse(
+                responseBody,
+                (val$) => {
+                    return operations.GetMetatagsResponseBody$.inboundSchema.parse(val$);
+                },
+                "Response validation failed"
+            );
+            return result;
+        } else {
+            const responseBody = await response.text();
+            throw new errors.SDKError("Unexpected API response", response, responseBody);
+        }
+    }
+}

package/src/sdk/sdk.ts

@@ -8,6 +8,7 @@ import { HTTPClient } from "../lib/http";
 import { ClientSDK } from "../lib/sdks";
 import { Analytics } from "./analytics";
 import { Links } from "./links";
+import { Metatags } from "./metatags";
 import { QRCodes } from "./qrcodes";
 import { Tags } from "./tags";
 import { Workspaces } from "./workspaces";
@@ -63,4 +64,9 @@ export class Dub extends ClientSDK {
     get tags() {
         return (this._tags ??= new Tags(this.options$));
     }
+
+    private _metatags?: Metatags;
+    get metatags() {
+        return (this._metatags ??= new Metatags(this.options$));
+    }
 }