@codeqr/ts 0.9.0 → 0.24.0

package/resources/links/links.d.ts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../core/resource.js";
 import * as TagsAPI from "../tags.js";
 import * as BulkAPI from "./bulk.js";
-import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from "./bulk.js";
+import { Bulk, BulkCreateParams, BulkCreateResponse } from "./bulk.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 export declare class Links extends APIResource {
@@ -17,16 +17,6 @@ export declare class Links extends APIResource {
      * ```
      */
     create(body: LinkCreateParams, options?: RequestOptions): APIPromise<Link>;
-    /**
-     * Update a link for the authenticated workspace. If there's no change, returns it
-     * as it is.
-     *
-     * @example
-     * ```ts
-     * const link = await client.links.update('linkId');
-     * ```
-     */
-    update(linkID: string, body?: LinkUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Link>;
     /**
      * Retrieve a paginated list of links for the authenticated workspace.
      *
@@ -36,24 +26,6 @@ export declare class Links extends APIResource {
      * ```
      */
     list(query?: LinkListParams | null | undefined, options?: RequestOptions): APIPromise<LinkListResponse>;
-    /**
-     * Delete a link for the authenticated workspace.
-     *
-     * @example
-     * ```ts
-     * const link = await client.links.delete('linkId');
-     * ```
-     */
-    delete(linkID: string, options?: RequestOptions): APIPromise<LinkDeleteResponse>;
-    /**
-     * Retrieve the number of links for the authenticated workspace.
-     *
-     * @example
-     * ```ts
-     * const response = await client.links.count();
-     * ```
-     */
-    count(query?: LinkCountParams | null | undefined, options?: RequestOptions): APIPromise<LinkCountResponse>;
     /**
      * Retrieve the info for a link.
      *
@@ -68,18 +40,24 @@ export declare class Links extends APIResource {
      */
     retrieveInfo(query: LinkRetrieveInfoParams, options?: RequestOptions): APIPromise<Link>;
     /**
-     * Upsert a link for the authenticated workspace by its URL. If a link with the
-     * same URL already exists, return it (or update it if there are any changes).
-     * Otherwise, a new link will be created.
+     * Update a link for the authenticated workspace. If there's no change, returns it
+     * as it is.
      *
      * @example
      * ```ts
-     * const link = await client.links.upsert({
-     *   url: 'https://google.com',
-     * });
+     * const link = await client.links.update('linkId');
+     * ```
+     */
+    update(linkID: string, body?: LinkUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Link>;
+    /**
+     * Delete a link for the authenticated workspace.
+     *
+     * @example
+     * ```ts
+     * const link = await client.links.delete('linkId');
      * ```
      */
-    upsert(body: LinkUpsertParams, options?: RequestOptions): APIPromise<Link>;
+    delete(linkID: string, options?: RequestOptions): APIPromise<LinkDeleteResponse>;
 }
 export interface Link {
     /**
@@ -206,6 +184,10 @@ export interface Link {
      * Whether the short link uses link cloaking.
      */
     rewrite: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules: Array<Link.Rule> | null;
     /**
      * The amount of the sale generated by the link.
      */
@@ -241,998 +223,194 @@ export interface Link {
      */
     url: string;
     /**
-     * The ID of the user who created the short link.
-     */
-    userId: string;
-    /**
-     * The UTM campaign of the short link.
-     */
-    utm_campaign: string | null;
-    /**
-     * The UTM content of the short link.
-     */
-    utm_content: string | null;
-    /**
-     * The UTM medium of the short link.
-     */
-    utm_medium: string | null;
-    /**
-     * The UTM source of the short link.
-     */
-    utm_source: string | null;
-    /**
-     * The UTM term of the short link.
-     */
-    utm_term: string | null;
-    /**
-     * The video of the short link.
-     */
-    video: string | null;
-    /**
-     * The ID of the page to redirect to before the link destination.
-     */
-    pageId?: string | null;
-    /**
-     * The URL of the page to redirect to before the link destination.
-     */
-    pageUrl?: string | null;
-    /**
-     * The complete QR code URL for the short link (for example,
-     * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
-     */
-    qrCode?: string;
-    /**
-     * The complete URL of the short link, including the https protocol (for example,
-     * `https://codeqr.link/try`).
-     */
-    shortLink?: string;
-}
-export type LinkListResponse = Array<Link>;
-export interface LinkDeleteResponse {
-    /**
-     * The ID of the link.
-     */
-    id: string;
-}
-/**
- * The number of links matching the query.
- */
-export type LinkCountResponse = number;
-export interface LinkCreateParams {
-    /**
-     * The destination URL of the short link.
-     */
-    url: string;
-    /**
-     * The Android destination URL for the short link for Android device targeting.
-     */
-    android?: string | null;
-    /**
-     * Whether the short link is archived.
-     */
-    archived?: boolean;
-    /**
-     * The comments for the short link.
-     */
-    comments?: string | null;
-    /**
-     * The description of the short link generated via `api.codeqr.io/metatags`. Will
-     * be used for custom link preview if `proxy` is true.
-     */
-    description?: string | null;
-    /**
-     * Allow search engines to index your short link. Default is `false` if not
-     * provided. Learn more: https://codeqr.link/noindex
-     */
-    doIndex?: boolean;
-    /**
-     * The domain of the short link. If not provided, the main domain of the project
-     * will be used (or `codeqr.link` if the project has no domains).
-     */
-    domain?: string;
-    /**
-     * The URL to redirect to when the short link expires.
-     */
-    expiredUrl?: string | null;
-    /**
-     * The date and time when the short link will expire in ISO-8601 format. Must be in
-     * the future.
-     */
-    expiresAt?: string | null;
-    /**
-     * This is the ID of the link in your database. If set, it can be used to identify
-     * the link in the future. Must be prefixed with `ext_` when passed as a query
-     * parameter.
-     */
-    externalId?: string | null;
-    /**
-     * Whether the short link is flexible.
-     */
-    flexible?: boolean;
-    /**
-     * The unique ID existing folder to assign the short link to.
-     */
-    folderId?: string | null;
-    /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    geo?: LinkCreateParams.Geo | null;
-    /**
-     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    image?: string | null;
-    /**
-     * The iOS destination URL for the short link for iOS device targeting.
-     */
-    ios?: string | null;
-    /**
-     * If the form is mandatory for the page.
-     */
-    isFormMandatory?: boolean;
-    /**
-     * The slug of the short link. If not provided, a random 7-character slug will be
-     * generated.
-     */
-    key?: string;
-    /**
-     * The ID of the page to redirect to before the link destination.
-     */
-    pageId?: string | null;
-    /**
-     * The URL of the page to redirect to before the link destination.
-     */
-    pageUrl?: string | null;
-    /**
-     * The password required to access the short link destination URL.
-     */
-    password?: string | null;
-    /**
-     * The prefix of the short link slug for randomly generated keys (for example, if
-     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
-     * be ignored if `key` is provided.
-     */
-    prefix?: string;
-    /**
-     * Whether the short link has pre-redirection.
-     */
-    preRedirection?: boolean;
-    /**
-     * Whether the short link uses the custom link preview feature.
-     */
-    proxy?: boolean;
-    /**
-     * Whether the short link statistics are publicly accessible.
-     */
-    publicStats?: boolean;
-    /**
-     * Whether the short link uses link cloaking.
-     */
-    rewrite?: boolean;
-    /**
-     * @deprecated The unique ID of the tag assigned to the short link. This field is
-     * deprecated – use `tagIds` instead.
-     */
-    tagId?: string | null;
-    /**
-     * The unique IDs of the tags assigned to the short link.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * The unique name of the tags assigned to the short link (case insensitive).
-     */
-    tagNames?: string | Array<string>;
-    /**
-     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    title?: string | null;
-    /**
-     * Whether to track conversions for the short link.
-     */
-    trackConversion?: boolean;
-    /**
-     * The video of the short link.
-     */
-    video?: string | null;
-    /**
-     * An array of webhook IDs to trigger when the link is clicked. These webhooks will
-     * receive click event data.
+     * Whether this link should be used as a reusable template.
      */
-    webhookIds?: Array<string> | null;
-}
-export declare namespace LinkCreateParams {
+    useAsTemplate: boolean;
     /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
+     * The ID of the user who created the short link.
      */
-    interface Geo {
-        AD?: string;
-        AE?: string;
-        AF?: string;
-        AG?: string;
-        AI?: string;
-        AL?: string;
-        AM?: string;
-        AO?: string;
-        AQ?: string;
-        AR?: string;
-        AS?: string;
-        AT?: string;
-        AU?: string;
-        AW?: string;
-        AX?: string;
-        AZ?: string;
-        BA?: string;
-        BB?: string;
-        BD?: string;
-        BE?: string;
-        BF?: string;
-        BG?: string;
-        BH?: string;
-        BI?: string;
-        BJ?: string;
-        BL?: string;
-        BM?: string;
-        BN?: string;
-        BO?: string;
-        BQ?: string;
-        BR?: string;
-        BS?: string;
-        BT?: string;
-        BV?: string;
-        BW?: string;
-        BY?: string;
-        BZ?: string;
-        CA?: string;
-        CC?: string;
-        CD?: string;
-        CF?: string;
-        CG?: string;
-        CH?: string;
-        CI?: string;
-        CK?: string;
-        CL?: string;
-        CM?: string;
-        CN?: string;
-        CO?: string;
-        CR?: string;
-        CU?: string;
-        CV?: string;
-        CW?: string;
-        CX?: string;
-        CY?: string;
-        CZ?: string;
-        DE?: string;
-        DJ?: string;
-        DK?: string;
-        DM?: string;
-        DO?: string;
-        DZ?: string;
-        EC?: string;
-        EE?: string;
-        EG?: string;
-        EH?: string;
-        ER?: string;
-        ES?: string;
-        ET?: string;
-        FI?: string;
-        FJ?: string;
-        FK?: string;
-        FM?: string;
-        FO?: string;
-        FR?: string;
-        GA?: string;
-        GB?: string;
-        GD?: string;
-        GE?: string;
-        GF?: string;
-        GG?: string;
-        GH?: string;
-        GI?: string;
-        GL?: string;
-        GM?: string;
-        GN?: string;
-        GP?: string;
-        GQ?: string;
-        GR?: string;
-        GS?: string;
-        GT?: string;
-        GU?: string;
-        GW?: string;
-        GY?: string;
-        HK?: string;
-        HM?: string;
-        HN?: string;
-        HR?: string;
-        HT?: string;
-        HU?: string;
-        ID?: string;
-        IE?: string;
-        IL?: string;
-        IM?: string;
-        IN?: string;
-        IO?: string;
-        IQ?: string;
-        IR?: string;
-        IS?: string;
-        IT?: string;
-        JE?: string;
-        JM?: string;
-        JO?: string;
-        JP?: string;
-        KE?: string;
-        KG?: string;
-        KH?: string;
-        KI?: string;
-        KM?: string;
-        KN?: string;
-        KP?: string;
-        KR?: string;
-        KW?: string;
-        KY?: string;
-        KZ?: string;
-        LA?: string;
-        LB?: string;
-        LC?: string;
-        LI?: string;
-        LK?: string;
-        LR?: string;
-        LS?: string;
-        LT?: string;
-        LU?: string;
-        LV?: string;
-        LY?: string;
-        MA?: string;
-        MC?: string;
-        MD?: string;
-        ME?: string;
-        MF?: string;
-        MG?: string;
-        MH?: string;
-        MK?: string;
-        ML?: string;
-        MM?: string;
-        MN?: string;
-        MO?: string;
-        MP?: string;
-        MQ?: string;
-        MR?: string;
-        MS?: string;
-        MT?: string;
-        MU?: string;
-        MV?: string;
-        MW?: string;
-        MX?: string;
-        MY?: string;
-        MZ?: string;
-        NA?: string;
-        NC?: string;
-        NE?: string;
-        NF?: string;
-        NG?: string;
-        NI?: string;
-        NL?: string;
-        NO?: string;
-        NP?: string;
-        NR?: string;
-        NU?: string;
-        NZ?: string;
-        OM?: string;
-        PA?: string;
-        PE?: string;
-        PF?: string;
-        PG?: string;
-        PH?: string;
-        PK?: string;
-        PL?: string;
-        PM?: string;
-        PN?: string;
-        PR?: string;
-        PS?: string;
-        PT?: string;
-        PW?: string;
-        PY?: string;
-        QA?: string;
-        RE?: string;
-        RO?: string;
-        RS?: string;
-        RU?: string;
-        RW?: string;
-        SA?: string;
-        SB?: string;
-        SC?: string;
-        SD?: string;
-        SE?: string;
-        SG?: string;
-        SH?: string;
-        SI?: string;
-        SJ?: string;
-        SK?: string;
-        SL?: string;
-        SM?: string;
-        SN?: string;
-        SO?: string;
-        SR?: string;
-        SS?: string;
-        ST?: string;
-        SV?: string;
-        SX?: string;
-        SY?: string;
-        SZ?: string;
-        TC?: string;
-        TD?: string;
-        TF?: string;
-        TG?: string;
-        TH?: string;
-        TJ?: string;
-        TK?: string;
-        TL?: string;
-        TM?: string;
-        TN?: string;
-        TO?: string;
-        TR?: string;
-        TT?: string;
-        TV?: string;
-        TW?: string;
-        TZ?: string;
-        UA?: string;
-        UG?: string;
-        UM?: string;
-        US?: string;
-        UY?: string;
-        UZ?: string;
-        VA?: string;
-        VC?: string;
-        VE?: string;
-        VG?: string;
-        VI?: string;
-        VN?: string;
-        VU?: string;
-        WF?: string;
-        WS?: string;
-        XK?: string;
-        YE?: string;
-        YT?: string;
-        ZA?: string;
-        ZM?: string;
-        ZW?: string;
-    }
-}
-export interface LinkUpdateParams {
-    /**
-     * The Android destination URL for the short link for Android device targeting.
-     */
-    android?: string | null;
-    /**
-     * Whether the short link is archived.
-     */
-    archived?: boolean;
-    /**
-     * The comments for the short link.
-     */
-    comments?: string | null;
-    /**
-     * The description of the short link generated via `api.codeqr.io/metatags`. Will
-     * be used for custom link preview if `proxy` is true.
-     */
-    description?: string | null;
-    /**
-     * Allow search engines to index your short link. Default is `false` if not
-     * provided. Learn more: https://codeqr.link/noindex
-     */
-    doIndex?: boolean;
-    /**
-     * The domain of the short link. If not provided, the main domain of the project
-     * will be used (or `codeqr.link` if the project has no domains).
-     */
-    domain?: string;
-    /**
-     * The URL to redirect to when the short link expires.
-     */
-    expiredUrl?: string | null;
-    /**
-     * The date and time when the short link will expire in ISO-8601 format. Must be in
-     * the future.
-     */
-    expiresAt?: string | null;
-    /**
-     * This is the ID of the link in your database. If set, it can be used to identify
-     * the link in the future. Must be prefixed with `ext_` when passed as a query
-     * parameter.
-     */
-    externalId?: string | null;
-    /**
-     * Whether the short link is flexible.
-     */
-    flexible?: boolean;
-    /**
-     * The unique ID existing folder to assign the short link to.
-     */
-    folderId?: string | null;
-    /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    geo?: LinkUpdateParams.Geo | null;
-    /**
-     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    image?: string | null;
-    /**
-     * The iOS destination URL for the short link for iOS device targeting.
-     */
-    ios?: string | null;
-    /**
-     * If the form is mandatory for the page.
-     */
-    isFormMandatory?: boolean;
-    /**
-     * The slug of the short link. If not provided, a random 7-character slug will be
-     * generated.
-     */
-    key?: string;
-    /**
-     * The ID of the page to redirect to before the link destination.
-     */
-    pageId?: string | null;
-    /**
-     * The URL of the page to redirect to before the link destination.
-     */
-    pageUrl?: string | null;
-    /**
-     * The password required to access the short link destination URL.
-     */
-    password?: string | null;
-    /**
-     * The prefix of the short link slug for randomly generated keys (for example, if
-     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
-     * be ignored if `key` is provided.
-     */
-    prefix?: string;
-    /**
-     * Whether the short link has pre-redirection.
-     */
-    preRedirection?: boolean;
-    /**
-     * Whether the short link uses the custom link preview feature.
-     */
-    proxy?: boolean;
-    /**
-     * Whether the short link statistics are publicly accessible.
-     */
-    publicStats?: boolean;
-    /**
-     * Whether the short link uses link cloaking.
-     */
-    rewrite?: boolean;
-    /**
-     * @deprecated The unique ID of the tag assigned to the short link. This field is
-     * deprecated – use `tagIds` instead.
-     */
-    tagId?: string | null;
-    /**
-     * The unique IDs of the tags assigned to the short link.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * The unique name of the tags assigned to the short link (case insensitive).
-     */
-    tagNames?: string | Array<string>;
-    /**
-     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
-     * for custom link preview if `proxy` is true.
-     */
-    title?: string | null;
-    /**
-     * Whether to track conversions for the short link.
-     */
-    trackConversion?: boolean;
-    /**
-     * The destination URL of the short link.
-     */
-    url?: string;
-    /**
-     * The video of the short link.
-     */
-    video?: string | null;
-    /**
-     * An array of webhook IDs to trigger when the link is clicked. These webhooks will
-     * receive click event data.
-     */
-    webhookIds?: Array<string> | null;
-}
-export declare namespace LinkUpdateParams {
-    /**
-     * Geographic targeting information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
-     */
-    interface Geo {
-        AD?: string;
-        AE?: string;
-        AF?: string;
-        AG?: string;
-        AI?: string;
-        AL?: string;
-        AM?: string;
-        AO?: string;
-        AQ?: string;
-        AR?: string;
-        AS?: string;
-        AT?: string;
-        AU?: string;
-        AW?: string;
-        AX?: string;
-        AZ?: string;
-        BA?: string;
-        BB?: string;
-        BD?: string;
-        BE?: string;
-        BF?: string;
-        BG?: string;
-        BH?: string;
-        BI?: string;
-        BJ?: string;
-        BL?: string;
-        BM?: string;
-        BN?: string;
-        BO?: string;
-        BQ?: string;
-        BR?: string;
-        BS?: string;
-        BT?: string;
-        BV?: string;
-        BW?: string;
-        BY?: string;
-        BZ?: string;
-        CA?: string;
-        CC?: string;
-        CD?: string;
-        CF?: string;
-        CG?: string;
-        CH?: string;
-        CI?: string;
-        CK?: string;
-        CL?: string;
-        CM?: string;
-        CN?: string;
-        CO?: string;
-        CR?: string;
-        CU?: string;
-        CV?: string;
-        CW?: string;
-        CX?: string;
-        CY?: string;
-        CZ?: string;
-        DE?: string;
-        DJ?: string;
-        DK?: string;
-        DM?: string;
-        DO?: string;
-        DZ?: string;
-        EC?: string;
-        EE?: string;
-        EG?: string;
-        EH?: string;
-        ER?: string;
-        ES?: string;
-        ET?: string;
-        FI?: string;
-        FJ?: string;
-        FK?: string;
-        FM?: string;
-        FO?: string;
-        FR?: string;
-        GA?: string;
-        GB?: string;
-        GD?: string;
-        GE?: string;
-        GF?: string;
-        GG?: string;
-        GH?: string;
-        GI?: string;
-        GL?: string;
-        GM?: string;
-        GN?: string;
-        GP?: string;
-        GQ?: string;
-        GR?: string;
-        GS?: string;
-        GT?: string;
-        GU?: string;
-        GW?: string;
-        GY?: string;
-        HK?: string;
-        HM?: string;
-        HN?: string;
-        HR?: string;
-        HT?: string;
-        HU?: string;
-        ID?: string;
-        IE?: string;
-        IL?: string;
-        IM?: string;
-        IN?: string;
-        IO?: string;
-        IQ?: string;
-        IR?: string;
-        IS?: string;
-        IT?: string;
-        JE?: string;
-        JM?: string;
-        JO?: string;
-        JP?: string;
-        KE?: string;
-        KG?: string;
-        KH?: string;
-        KI?: string;
-        KM?: string;
-        KN?: string;
-        KP?: string;
-        KR?: string;
-        KW?: string;
-        KY?: string;
-        KZ?: string;
-        LA?: string;
-        LB?: string;
-        LC?: string;
-        LI?: string;
-        LK?: string;
-        LR?: string;
-        LS?: string;
-        LT?: string;
-        LU?: string;
-        LV?: string;
-        LY?: string;
-        MA?: string;
-        MC?: string;
-        MD?: string;
-        ME?: string;
-        MF?: string;
-        MG?: string;
-        MH?: string;
-        MK?: string;
-        ML?: string;
-        MM?: string;
-        MN?: string;
-        MO?: string;
-        MP?: string;
-        MQ?: string;
-        MR?: string;
-        MS?: string;
-        MT?: string;
-        MU?: string;
-        MV?: string;
-        MW?: string;
-        MX?: string;
-        MY?: string;
-        MZ?: string;
-        NA?: string;
-        NC?: string;
-        NE?: string;
-        NF?: string;
-        NG?: string;
-        NI?: string;
-        NL?: string;
-        NO?: string;
-        NP?: string;
-        NR?: string;
-        NU?: string;
-        NZ?: string;
-        OM?: string;
-        PA?: string;
-        PE?: string;
-        PF?: string;
-        PG?: string;
-        PH?: string;
-        PK?: string;
-        PL?: string;
-        PM?: string;
-        PN?: string;
-        PR?: string;
-        PS?: string;
-        PT?: string;
-        PW?: string;
-        PY?: string;
-        QA?: string;
-        RE?: string;
-        RO?: string;
-        RS?: string;
-        RU?: string;
-        RW?: string;
-        SA?: string;
-        SB?: string;
-        SC?: string;
-        SD?: string;
-        SE?: string;
-        SG?: string;
-        SH?: string;
-        SI?: string;
-        SJ?: string;
-        SK?: string;
-        SL?: string;
-        SM?: string;
-        SN?: string;
-        SO?: string;
-        SR?: string;
-        SS?: string;
-        ST?: string;
-        SV?: string;
-        SX?: string;
-        SY?: string;
-        SZ?: string;
-        TC?: string;
-        TD?: string;
-        TF?: string;
-        TG?: string;
-        TH?: string;
-        TJ?: string;
-        TK?: string;
-        TL?: string;
-        TM?: string;
-        TN?: string;
-        TO?: string;
-        TR?: string;
-        TT?: string;
-        TV?: string;
-        TW?: string;
-        TZ?: string;
-        UA?: string;
-        UG?: string;
-        UM?: string;
-        US?: string;
-        UY?: string;
-        UZ?: string;
-        VA?: string;
-        VC?: string;
-        VE?: string;
-        VG?: string;
-        VI?: string;
-        VN?: string;
-        VU?: string;
-        WF?: string;
-        WS?: string;
-        XK?: string;
-        YE?: string;
-        YT?: string;
-        ZA?: string;
-        ZM?: string;
-        ZW?: string;
-    }
-}
-export interface LinkListParams {
+    userId: string;
     /**
-     * The Android device to filter by.
+     * The UTM campaign of the short link.
      */
-    android?: string;
+    utm_campaign: string | null;
     /**
-     * Maximum number of clicks
+     * The UTM content of the short link.
      */
-    clicksMax?: number;
+    utm_content: string | null;
     /**
-     * Minimum number of clicks
+     * The UTM medium of the short link.
      */
-    clicksMin?: number;
+    utm_medium: string | null;
     /**
-     * The comments to filter by.
+     * The UTM source of the short link.
      */
-    comments?: string;
+    utm_source: string | null;
     /**
-     * Created after date (ISO string)
+     * The UTM term of the short link.
      */
-    createdAfter?: string;
+    utm_term: string | null;
     /**
-     * Created before date (ISO string)
+     * The video of the short link.
      */
-    createdBefore?: string;
+    video: string | null;
     /**
-     * The domain to filter the links. For example, `ac.me`. If not provided, all links
-     * of the project will be returned.
+     * The ID of the page to redirect to before the link destination.
      */
-    domain?: string;
+    pageId?: string | null;
     /**
-     * Expires after date (ISO string)
+     * The URL of the page to redirect to before the link destination.
      */
-    expiresAfter?: string;
+    pageUrl?: string | null;
     /**
-     * The date and time the short link will expire in ISO-8601 format. Must be in the
-     * future.
+     * The complete QR code URL for the short link (for example,
+     * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
      */
-    expiresAt?: string | null;
+    qrCode?: string;
     /**
-     * Expires before date (ISO string)
+     * The complete URL of the short link, including the https protocol (for example,
+     * `https://codeqr.link/try`).
      */
-    expiresBefore?: string;
+    shortLink?: string;
+}
+export declare namespace Link {
+    interface Rule {
+        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+        operator: 'equals' | 'not_equals';
+        url: string;
+        value: string;
+    }
+}
+export type LinkListResponse = Array<Link>;
+export interface LinkDeleteResponse {
     /**
-     * The folder ID to filter the links by.
+     * The ID of the link.
      */
-    folderId?: string;
+    id: string;
+}
+export interface LinkCreateParams {
     /**
-     * Geographic segmentation information for the short link in JSON format
-     * `{[COUNTRY]: https://example.com }`.
+     * The destination URL of the short link.
      */
-    geo?: LinkListParams.Geo | null;
+    url: string;
     /**
-     * Filter links that have comments (any comments)
+     * The Android destination URL for the short link for Android device targeting.
      */
-    hasComments?: boolean;
+    android?: string | null;
     /**
-     * Filter links that have custom social media cards
+     * Whether the short link is archived.
      */
-    hasCustomSocial?: boolean;
+    archived?: boolean;
     /**
-     * Filter links that have device targeting
+     * The comments for the short link.
      */
-    hasDevice?: boolean;
+    comments?: string | null;
     /**
-     * Filter links that have expiration date (any expiration)
+     * The description of the short link generated via `api.codeqr.io/metatags`. Will
+     * be used for custom link preview if `proxy` is true.
      */
-    hasExpiration?: boolean;
+    description?: string | null;
     /**
-     * Filter links that have geo-targeting
+     * Allow search engines to index your short link. Default is `false` if not
+     * provided. Learn more: https://codeqr.link/noindex
      */
-    hasGeo?: boolean;
+    doIndex?: boolean;
     /**
-     * Filter links that have password protection (any password)
+     * The domain of the short link. If not provided, the main domain of the project
+     * will be used (or `codeqr.link` if the project has no domains).
      */
-    hasPassword?: boolean;
+    domain?: string;
     /**
-     * Filter links that have tags (any tags)
+     * The URL to redirect to when the short link expires.
      */
-    hasTags?: boolean;
+    expiredUrl?: string | null;
     /**
-     * Filter links that have UTM parameters
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
      */
-    hasUTM?: boolean;
+    expiresAt?: string | null;
     /**
-     * The iOS device to filter by.
+     * This is the ID of the link in your database. If set, it can be used to identify
+     * the link in the future. Must be prefixed with `ext_` when passed as a query
+     * parameter.
      */
-    ios?: string;
+    externalId?: string | null;
     /**
-     * Link IDs to filter by.
+     * Whether the short link is flexible.
      */
-    linkIds?: string | Array<string>;
+    flexible?: boolean;
     /**
-     * The page number for pagination.
+     * The unique ID existing folder to assign the short link to.
      */
-    page?: number;
+    folderId?: string | null;
     /**
-     * The number of items per page.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`.
      */
-    pageSize?: number;
+    geo?: LinkCreateParams.Geo | null;
     /**
-     * The password to filter by.
+     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
-    password?: string;
+    image?: string | null;
     /**
-     * The slug of the project to which the link belongs. For example, for
-     * `app.codeqr.io/acme`, the projectSlug is `acme`.
+     * The iOS destination URL for the short link for iOS device targeting.
      */
-    projectSlug?: string;
+    ios?: string | null;
     /**
-     * The search term to filter the links. The search term will be matched against the
-     * short link slug and the destination URL.
+     * If the form is mandatory for the page.
      */
-    search?: string;
+    isFormMandatory?: boolean;
     /**
-     * If should include archived links in the response. The default is `false` if not
-     * provided.
+     * The slug of the short link. If not provided, a random 7-character slug will be
+     * generated.
      */
-    showArchived?: boolean;
+    key?: string;
     /**
-     * The field to sort the links by. The default is `createdAt`, and sort order is
-     * always descending.
+     * The ID of the page to redirect to before the link destination.
      */
-    sort?: 'createdAt' | 'clicks' | 'lastClicked';
+    pageId?: string | null;
     /**
-     * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
-     * assigned to the short link.
+     * The URL of the page to redirect to before the link destination.
      */
-    tagId?: string;
+    pageUrl?: string | null;
     /**
-     * The IDs of the tags to filter the links.
+     * The password required to access the short link destination URL.
+     */
+    password?: string | null;
+    /**
+     * The prefix of the short link slug for randomly generated keys (for example, if
+     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
+     * be ignored if `key` is provided.
+     */
+    prefix?: string;
+    /**
+     * Whether the short link has pre-redirection.
+     */
+    preRedirection?: boolean;
+    /**
+     * Whether the short link uses the custom link preview feature.
+     */
+    proxy?: boolean;
+    /**
+     * Whether the short link statistics are publicly accessible.
+     */
+    publicStats?: boolean;
+    /**
+     * Whether the short link uses link cloaking.
+     */
+    rewrite?: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<LinkCreateParams.Rule> | null;
+    /**
+     * @deprecated The unique ID of the tag assigned to the short link. This field is
+     * deprecated – use `tagIds` instead.
+     */
+    tagId?: string | null;
+    /**
+     * The unique IDs of the tags assigned to the short link.
      */
     tagIds?: string | Array<string>;
     /**
@@ -1240,22 +418,31 @@ export interface LinkListParams {
      */
     tagNames?: string | Array<string>;
     /**
-     * If should include links with conversion tracking enabled. The default is `false`
-     * if not provided.
+     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
+     */
+    title?: string | null;
+    /**
+     * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
     /**
-     * The ID of the user to filter by.
+     * Whether this link should be used as a reusable template.
      */
-    userId?: string;
+    useAsTemplate?: boolean;
     /**
-     * If should include tags in the response. The default is `false` if not provided.
+     * The video of the short link.
      */
-    withTags?: boolean;
+    video?: string | null;
+    /**
+     * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+     * receive click event data.
+     */
+    webhookIds?: Array<string> | null;
 }
-export declare namespace LinkListParams {
+export declare namespace LinkCreateParams {
     /**
-     * Geographic segmentation information for the short link in JSON format
+     * Geographic targeting information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.
      */
     interface Geo {
@@ -1510,8 +697,14 @@ export declare namespace LinkListParams {
         ZM?: string;
         ZW?: string;
     }
+    interface Rule {
+        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+        operator: 'equals' | 'not_equals';
+        url: string;
+        value: string;
+    }
 }
-export interface LinkCountParams {
+export interface LinkListParams {
     /**
      * The Android device to filter by.
      */
@@ -1562,11 +755,7 @@ export interface LinkCountParams {
      * Geographic segmentation information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.
      */
-    geo?: LinkCountParams.Geo | null;
-    /**
-     * The field to group the links by.
-     */
-    groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
+    geo?: LinkListParams.Geo | null;
     /**
      * Filter links that have comments (any comments)
      */
@@ -1603,6 +792,18 @@ export interface LinkCountParams {
      * The iOS device to filter by.
      */
     ios?: string;
+    /**
+     * Link IDs to filter by.
+     */
+    linkIds?: string | Array<string>;
+    /**
+     * The page number for pagination.
+     */
+    page?: number;
+    /**
+     * The number of items per page.
+     */
+    pageSize?: number;
     /**
      * The password to filter by.
      */
@@ -1622,6 +823,11 @@ export interface LinkCountParams {
      * provided.
      */
     showArchived?: boolean;
+    /**
+     * The field to sort the links by. The default is `createdAt`, and sort order is
+     * always descending.
+     */
+    sort?: 'createdAt' | 'clicks' | 'lastClicked';
     /**
      * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
      * assigned to the short link.
@@ -1640,16 +846,40 @@ export interface LinkCountParams {
      * if not provided.
      */
     trackConversion?: boolean;
+    /**
+     * Filter links marked as templates.
+     */
+    useAsTemplate?: boolean;
     /**
      * The ID of the user to filter by.
      */
     userId?: string;
+    /**
+     * Filter by UTM campaign value
+     */
+    utm_campaign?: string;
+    /**
+     * Filter by UTM content value
+     */
+    utm_content?: string;
+    /**
+     * Filter by UTM medium value
+     */
+    utm_medium?: string;
+    /**
+     * Filter by UTM source value
+     */
+    utm_source?: string;
+    /**
+     * Filter by UTM term value
+     */
+    utm_term?: string;
     /**
      * If should include tags in the response. The default is `false` if not provided.
      */
     withTags?: boolean;
 }
-export declare namespace LinkCountParams {
+export declare namespace LinkListParams {
     /**
      * Geographic segmentation information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -1933,11 +1163,7 @@ export interface LinkRetrieveInfoParams {
      */
     linkId?: string;
 }
-export interface LinkUpsertParams {
-    /**
-     * The destination URL of the short link.
-     */
-    url: string;
+export interface LinkUpdateParams {
     /**
      * The Android destination URL for the short link for Android device targeting.
      */
@@ -1992,7 +1218,7 @@ export interface LinkUpsertParams {
      * Geographic targeting information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.
      */
-    geo?: LinkUpsertParams.Geo | null;
+    geo?: LinkUpdateParams.Geo | null;
     /**
      * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
      * for custom link preview if `proxy` is true.
@@ -2045,6 +1271,10 @@ export interface LinkUpsertParams {
      * Whether the short link uses link cloaking.
      */
     rewrite?: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<LinkUpdateParams.Rule> | null;
     /**
      * @deprecated The unique ID of the tag assigned to the short link. This field is
      * deprecated – use `tagIds` instead.
@@ -2067,6 +1297,14 @@ export interface LinkUpsertParams {
      * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
+    /**
+     * The destination URL of the short link.
+     */
+    url?: string;
+    /**
+     * Whether this link should be used as a reusable template.
+     */
+    useAsTemplate?: boolean;
     /**
      * The video of the short link.
      */
@@ -2077,7 +1315,7 @@ export interface LinkUpsertParams {
      */
     webhookIds?: Array<string> | null;
 }
-export declare namespace LinkUpsertParams {
+export declare namespace LinkUpdateParams {
     /**
      * Geographic targeting information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -2334,9 +1572,15 @@ export declare namespace LinkUpsertParams {
         ZM?: string;
         ZW?: string;
     }
+    interface Rule {
+        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+        operator: 'equals' | 'not_equals';
+        url: string;
+        value: string;
+    }
 }
 export declare namespace Links {
-    export { type Link as Link, type LinkListResponse as LinkListResponse, type LinkDeleteResponse as LinkDeleteResponse, type LinkCountResponse as LinkCountResponse, type LinkCreateParams as LinkCreateParams, type LinkUpdateParams as LinkUpdateParams, type LinkListParams as LinkListParams, type LinkCountParams as LinkCountParams, type LinkRetrieveInfoParams as LinkRetrieveInfoParams, type LinkUpsertParams as LinkUpsertParams, };
-    export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkDeleteResponse as BulkDeleteResponse, type BulkCreateParams as BulkCreateParams, type BulkDeleteParams as BulkDeleteParams, };
+    export { type Link as Link, type LinkListResponse as LinkListResponse, type LinkDeleteResponse as LinkDeleteResponse, type LinkCreateParams as LinkCreateParams, type LinkListParams as LinkListParams, type LinkRetrieveInfoParams as LinkRetrieveInfoParams, type LinkUpdateParams as LinkUpdateParams, };
+    export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams, };
 }
 //# sourceMappingURL=links.d.ts.map