@codeqr/ts 0.19.3 → 0.24.0

package/resources/qrcodes/qrcodes.d.ts

@@ -15,6 +15,15 @@ export declare class Qrcodes extends APIResource {
      * ```
      */
     create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode>;
+    /**
+     * Retrieve a paginated list of QR Codes for the authenticated workspace.
+     *
+     * @example
+     * ```ts
+     * const qrCodes = await client.qrcodes.list();
+     * ```
+     */
+    list(query?: QrcodeListParams | null | undefined, options?: RequestOptions): APIPromise<QrcodeListResponse>;
     /**
      * Retrieve the info for a QR Code.
      *
@@ -38,15 +47,6 @@ export declare class Qrcodes extends APIResource {
      * ```
      */
     update(qrcodeID: string, body?: QrcodeUpdateParams | null | undefined, options?: RequestOptions): APIPromise<QrCode>;
-    /**
-     * Retrieve a paginated list of QR Codes for the authenticated workspace.
-     *
-     * @example
-     * ```ts
-     * const qrCodes = await client.qrcodes.list();
-     * ```
-     */
-    list(query?: QrcodeListParams | null | undefined, options?: RequestOptions): APIPromise<QrcodeListResponse>;
     /**
      * Delete a QR Code for the authenticated workspace.
      *
@@ -234,6 +234,10 @@ export interface QrCode {
      * If the QR code uses link cloaking.
      */
     rewrite: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules: Array<QrCode.Rule> | null;
     /**
      * The amount of the sale generated by the link.
      */
@@ -293,7 +297,7 @@ export interface QrCode {
     /**
      * The type of the QR code.
      */
-    type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
+    type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'geo' | 'latlog' | 'pix' | 'whatsapp';
     /**
      * The date and time the QR code was updated last.
      */
@@ -338,6 +342,11 @@ export interface QrCode {
     vcard: {
         [key: string]: string;
     } | null;
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    whatsapp: QrCode.Whatsapp | null;
     /**
      * The width of the QR code.
      */
@@ -348,6 +357,13 @@ export interface QrCode {
     wifi: {
         [key: string]: string;
     } | null;
+    /**
+     * Typographic styles applied to the frame label text. Object with optional keys:
+     * `weight` (`normal` | `bold`), `style` (`normal` | `italic`), `family` (`sans` |
+     * `sans-condensed` | `serif` | `serif-elegant` | `mono`), `size` (`s` | `m` | `l`
+     * | `xl`). Every field is enum-gated on write; omitted keys render with defaults.
+     */
+    frameTextStyles?: QrCode.FrameTextStyles | null;
     /**
      * The ID of the page to redirect to before the QR code destination.
      */
@@ -357,6 +373,34 @@ export interface QrCode {
      */
     pageUrl?: string | null;
 }
+export declare namespace QrCode {
+    interface Rule {
+        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+        operator: 'equals' | 'not_equals';
+        url: string;
+        value: string;
+    }
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    interface Whatsapp {
+        number: string;
+        message?: string;
+    }
+    /**
+     * Typographic styles applied to the frame label text. Object with optional keys:
+     * `weight` (`normal` | `bold`), `style` (`normal` | `italic`), `family` (`sans` |
+     * `sans-condensed` | `serif` | `serif-elegant` | `mono`), `size` (`s` | `m` | `l`
+     * | `xl`). Every field is enum-gated on write; omitted keys render with defaults.
+     */
+    interface FrameTextStyles {
+        family?: 'sans' | 'sans-condensed' | 'serif' | 'serif-elegant' | 'mono';
+        size?: 's' | 'm' | 'l' | 'xl';
+        style?: 'normal' | 'italic';
+        weight?: 'normal' | 'bold';
+    }
+}
 export type QrcodeListResponse = Array<QrCode>;
 export interface QrcodeDeleteResponse {
     /**
@@ -368,7 +412,7 @@ export interface QrcodeCreateParams {
     /**
      * The type of content of the QR code.
      */
-    type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+    type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'geo' | 'latlog' | 'pix' | 'whatsapp';
     /**
      * The destination URL for Android for the QR code for device targeting Android.
      */
@@ -378,7 +422,8 @@ export interface QrcodeCreateParams {
      */
     archived?: boolean;
     /**
-     * The background color of the QR code.
+     * The background color of the QR code (hex or CSS keyword). Invalid values are
+     * coerced to default.
      */
     bgColor?: string;
     /**
@@ -442,7 +487,8 @@ export interface QrcodeCreateParams {
         [key: string]: string;
     } | null;
     /**
-     * The foreground color of the QR code.
+     * The foreground color of the QR code (hex or CSS keyword). Invalid values are
+     * coerced to default.
      */
     fgColor?: string;
     /**
@@ -470,14 +516,24 @@ export interface QrcodeCreateParams {
      */
     frameColor?: string;
     /**
-     * The text of the frame of the QR code.
+     * Label text rendered inside the frame (e.g. "SCAN ME", a product SKU). Maximum
+     * 200 characters. Word-wraps to multiple lines at larger sizes; the frame bar
+     * grows vertically to fit.
      */
     frameText?: string;
     /**
-     * The color of the text inside the frame (hex or CSS keyword). When not set, a
-     * contrasting color is derived from the frame color.
+     * Color of the frame label text (hex `#RRGGBB`, `#RGB`, `#RRGGBBAA`, or a CSS
+     * keyword from the allowlist). When omitted, a contrasting color is derived
+     * automatically from `frameColor`.
      */
-    frameTextColor?: string;
+    frameTextColor?: string | null;
+    /**
+     * Typographic styles applied to the frame label text. Every key is enum-gated —
+     * unknown keys or out-of-enum values are rejected to prevent SVG attribute
+     * injection. All fields are optional; omitted keys fall back to the default
+     * (normal weight, normal style, sans family, medium size).
+     */
+    frameTextStyles?: QrcodeCreateParams.FrameTextStyles | null;
     /**
      * Geographic segmentation information for the QR code in the JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -540,6 +596,11 @@ export interface QrcodeCreateParams {
      * The phone number of the QR code.
      */
     phone?: string | null;
+    /**
+     * The prefix for the randomly generated key. If provided, the key will be prefixed
+     * with this value.
+     */
+    prefix?: string;
     /**
      * If the QR code has pre-redirection.
      */
@@ -556,6 +617,10 @@ export interface QrcodeCreateParams {
      * If the QR code uses link cloaking.
      */
     rewrite?: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<QrcodeCreateParams.Rule> | null;
     /**
      * The shape of the design around the QR code (none, square, circle).
      */
@@ -595,6 +660,12 @@ export interface QrcodeCreateParams {
      * The unique name of the tags assigned to the QR code (case insensitive).
      */
     tagNames?: string | Array<string>;
+    /**
+     * ID of a QR code (in the same project) marked as a template. Its customization
+     * fields (colors, logo, pattern, shape, frame) will be applied to the new QR code
+     * unless explicitly overridden.
+     */
+    templateId?: string | null;
     /**
      * The text of the QR code.
      */
@@ -633,6 +704,11 @@ export interface QrcodeCreateParams {
      * receive click event data.
      */
     webhookIds?: Array<string> | null;
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    whatsapp?: QrcodeCreateParams.Whatsapp | null;
     /**
      * Logo width in pixels. When omitted, a proportional size is used based on the QR
      * code size (about 10–20% depending on size).
@@ -646,6 +722,36 @@ export interface QrcodeCreateParams {
     } | null;
 }
 export declare namespace QrcodeCreateParams {
+    /**
+     * Typographic styles applied to the frame label text. Every key is enum-gated —
+     * unknown keys or out-of-enum values are rejected to prevent SVG attribute
+     * injection. All fields are optional; omitted keys fall back to the default
+     * (normal weight, normal style, sans family, medium size).
+     */
+    interface FrameTextStyles {
+        /**
+         * Font family used for the frame label text. `sans` = Arial / Helvetica (default).
+         * `sans-condensed` = Arial Narrow. `serif` = Georgia / Times New Roman.
+         * `serif-elegant` = Palatino Linotype / Book Antiqua. `mono` = Courier New. Values
+         * resolve to safe system font stacks on the rendered SVG.
+         */
+        family?: 'sans' | 'sans-condensed' | 'serif' | 'serif-elegant' | 'mono';
+        /**
+         * Font size preset for the frame label. `s` = 60 viewBox units, `m` = 89.1
+         * (default), `l` = 120, `xl` = 150. Larger sizes grow the frame bar vertically to
+         * fit. Extremely long text auto-shrinks to keep within 4 lines (floor 48).
+         */
+        size?: 's' | 'm' | 'l' | 'xl';
+        /**
+         * Font style of the frame label text. `italic` applies `font-style="italic"`.
+         */
+        style?: 'normal' | 'italic';
+        /**
+         * Font weight of the frame label text. `bold` renders at SVG `font-weight="700"`,
+         * `normal` at `400`.
+         */
+        weight?: 'normal' | 'bold';
+    }
     /**
      * Geographic segmentation information for the QR code in the JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -902,6 +1008,186 @@ export declare namespace QrcodeCreateParams {
         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;
+    }
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    interface Whatsapp {
+        number: string;
+        message?: string;
+    }
+}
+export interface QrcodeListParams {
+    /**
+     * The comments to filter by.
+     */
+    comments?: string;
+    /**
+     * Filter QR codes created after this date
+     */
+    createdAfter?: string;
+    /**
+     * Filter QR codes created before this date
+     */
+    createdBefore?: string;
+    /**
+     * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
+     * codes of the project will be returned.
+     */
+    domain?: string;
+    /**
+     * Filter QR codes expiring after this date
+     */
+    expiresAfter?: string;
+    /**
+     * The date and time the QR code will expire in ISO-8601 format. Must be in the
+     * future.
+     */
+    expiresAt?: string | null;
+    /**
+     * Filter QR codes expiring before this date
+     */
+    expiresBefore?: string;
+    /**
+     * The folder ID to filter the QR codes by.
+     */
+    folderId?: string;
+    /**
+     * Filter by QR code format - static or dynamic
+     */
+    format?: 'static' | 'dynamic';
+    /**
+     * Filter QR codes with/without comments
+     */
+    hasComments?: boolean;
+    /**
+     * Filter QR codes with/without custom social media cards
+     */
+    hasCustomSocial?: boolean;
+    /**
+     * Filter QR codes with/without device targeting
+     */
+    hasDevice?: boolean;
+    /**
+     * Filter QR codes with/without expiration date
+     */
+    hasExpiration?: boolean;
+    /**
+     * Filter QR codes with/without geo-targeting
+     */
+    hasGeo?: boolean;
+    /**
+     * Filter QR codes with/without password protection
+     */
+    hasPassword?: boolean;
+    /**
+     * Filter QR codes with/without tags
+     */
+    hasTags?: boolean;
+    /**
+     * Filter QR codes with/without UTM parameters
+     */
+    hasUTM?: boolean;
+    /**
+     * The page number for pagination.
+     */
+    page?: number;
+    /**
+     * The number of items per page.
+     */
+    pageSize?: number;
+    /**
+     * The password to filter by.
+     */
+    password?: string;
+    /**
+     * The slug of the project to which the QR code belongs. For example, for
+     * `app.codeqr.io/acme`, the projectSlug is `acme`.
+     */
+    projectSlug?: string;
+    /**
+     * Maximum number of scans
+     */
+    scansMax?: number;
+    /**
+     * Minimum number of scans
+     */
+    scansMin?: number;
+    /**
+     * The search term to filter the QR codes. The search term will be matched against
+     * the QR code slug, title, and the destination URL.
+     */
+    search?: string;
+    /**
+     * If should include archived QR codes in the response. The default is `false` if
+     * not provided.
+     */
+    showArchived?: boolean;
+    /**
+     * The field to order the QR codes. The default is `createdAt`, and the order of
+     * sorting is always descending.
+     */
+    sort?: 'createdAt' | 'scans' | 'lastClicked';
+    /**
+     * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
+     * to the QR code.
+     */
+    tagId?: string;
+    /**
+     * The IDs of the tags to filter the QR codes.
+     */
+    tagIds?: string | Array<string>;
+    /**
+     * The unique name of the tags assigned to the QR code (case insensitive).
+     */
+    tagNames?: string | Array<string>;
+    /**
+     * If should include QR codes with conversion tracking enabled. The default is
+     * `false` if not provided.
+     */
+    trackConversion?: boolean;
+    /**
+     * Filter by QR code type
+     */
+    type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'geo' | 'latlog' | 'pix' | 'whatsapp';
+    /**
+     * Filter QR codes 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 interface QrcodeRetrieveParams {
     /**
@@ -939,7 +1225,8 @@ export interface QrcodeUpdateParams {
      */
     archived?: boolean;
     /**
-     * The background color of the QR code.
+     * The background color of the QR code (hex or CSS keyword). Invalid values are
+     * coerced to default.
      */
     bgColor?: string;
     /**
@@ -1003,7 +1290,8 @@ export interface QrcodeUpdateParams {
         [key: string]: string;
     } | null;
     /**
-     * The foreground color of the QR code.
+     * The foreground color of the QR code (hex or CSS keyword). Invalid values are
+     * coerced to default.
      */
     fgColor?: string;
     /**
@@ -1031,14 +1319,24 @@ export interface QrcodeUpdateParams {
      */
     frameColor?: string;
     /**
-     * The text of the frame of the QR code.
+     * Label text rendered inside the frame (e.g. "SCAN ME", a product SKU). Maximum
+     * 200 characters. Word-wraps to multiple lines at larger sizes; the frame bar
+     * grows vertically to fit.
      */
     frameText?: string;
     /**
-     * The color of the text inside the frame (hex or CSS keyword). When not set, a
-     * contrasting color is derived from the frame color.
+     * Color of the frame label text (hex `#RRGGBB`, `#RGB`, `#RRGGBBAA`, or a CSS
+     * keyword from the allowlist). When omitted, a contrasting color is derived
+     * automatically from `frameColor`.
+     */
+    frameTextColor?: string | null;
+    /**
+     * Typographic styles applied to the frame label text. Every key is enum-gated —
+     * unknown keys or out-of-enum values are rejected to prevent SVG attribute
+     * injection. All fields are optional; omitted keys fall back to the default
+     * (normal weight, normal style, sans family, medium size).
      */
-    frameTextColor?: string;
+    frameTextStyles?: QrcodeUpdateParams.FrameTextStyles | null;
     /**
      * Geographic segmentation information for the QR code in the JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -1101,6 +1399,11 @@ export interface QrcodeUpdateParams {
      * The phone number of the QR code.
      */
     phone?: string | null;
+    /**
+     * The prefix for the randomly generated key. If provided, the key will be prefixed
+     * with this value.
+     */
+    prefix?: string;
     /**
      * If the QR code has pre-redirection.
      */
@@ -1117,6 +1420,10 @@ export interface QrcodeUpdateParams {
      * If the QR code uses link cloaking.
      */
     rewrite?: boolean;
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<QrcodeUpdateParams.Rule> | null;
     /**
      * The shape of the design around the QR code (none, square, circle).
      */
@@ -1156,6 +1463,12 @@ export interface QrcodeUpdateParams {
      * The unique name of the tags assigned to the QR code (case insensitive).
      */
     tagNames?: string | Array<string>;
+    /**
+     * ID of a QR code (in the same project) marked as a template. Its customization
+     * fields (colors, logo, pattern, shape, frame) will be applied to the new QR code
+     * unless explicitly overridden.
+     */
+    templateId?: string | null;
     /**
      * The text of the QR code.
      */
@@ -1172,7 +1485,7 @@ export interface QrcodeUpdateParams {
     /**
      * The type of content of the QR code.
      */
-    type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+    type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'geo' | 'latlog' | 'pix' | 'whatsapp';
     /**
      * The destination URL of the QR code.
      */
@@ -1198,6 +1511,11 @@ export interface QrcodeUpdateParams {
      * receive click event data.
      */
     webhookIds?: Array<string> | null;
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    whatsapp?: QrcodeUpdateParams.Whatsapp | null;
     /**
      * Logo width in pixels. When omitted, a proportional size is used based on the QR
      * code size (about 10–20% depending on size).
@@ -1211,6 +1529,36 @@ export interface QrcodeUpdateParams {
     } | null;
 }
 export declare namespace QrcodeUpdateParams {
+    /**
+     * Typographic styles applied to the frame label text. Every key is enum-gated —
+     * unknown keys or out-of-enum values are rejected to prevent SVG attribute
+     * injection. All fields are optional; omitted keys fall back to the default
+     * (normal weight, normal style, sans family, medium size).
+     */
+    interface FrameTextStyles {
+        /**
+         * Font family used for the frame label text. `sans` = Arial / Helvetica (default).
+         * `sans-condensed` = Arial Narrow. `serif` = Georgia / Times New Roman.
+         * `serif-elegant` = Palatino Linotype / Book Antiqua. `mono` = Courier New. Values
+         * resolve to safe system font stacks on the rendered SVG.
+         */
+        family?: 'sans' | 'sans-condensed' | 'serif' | 'serif-elegant' | 'mono';
+        /**
+         * Font size preset for the frame label. `s` = 60 viewBox units, `m` = 89.1
+         * (default), `l` = 120, `xl` = 150. Larger sizes grow the frame bar vertically to
+         * fit. Extremely long text auto-shrinks to keep within 4 lines (floor 48).
+         */
+        size?: 's' | 'm' | 'l' | 'xl';
+        /**
+         * Font style of the frame label text. `italic` applies `font-style="italic"`.
+         */
+        style?: 'normal' | 'italic';
+        /**
+         * Font weight of the frame label text. `bold` renders at SVG `font-weight="700"`,
+         * `normal` at `400`.
+         */
+        weight?: 'normal' | 'bold';
+    }
     /**
      * Geographic segmentation information for the QR code in the JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -1467,155 +1815,23 @@ export declare namespace QrcodeUpdateParams {
         ZM?: string;
         ZW?: string;
     }
-}
-export interface QrcodeListParams {
-    /**
-     * The comments to filter by.
-     */
-    comments?: string;
-    /**
-     * Filter QR codes created after this date
-     */
-    createdAfter?: string;
-    /**
-     * Filter QR codes created before this date
-     */
-    createdBefore?: string;
-    /**
-     * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
-     * codes of the project will be returned.
-     */
-    domain?: string;
-    /**
-     * Filter QR codes expiring after this date
-     */
-    expiresAfter?: string;
-    /**
-     * The date and time the QR code will expire in ISO-8601 format. Must be in the
-     * future.
-     */
-    expiresAt?: string | null;
-    /**
-     * Filter QR codes expiring before this date
-     */
-    expiresBefore?: string;
-    /**
-     * The folder ID to filter the QR codes by.
-     */
-    folderId?: string;
-    /**
-     * Filter by QR code format - static or dynamic
-     */
-    format?: 'static' | 'dynamic';
-    /**
-     * Filter QR codes with/without comments
-     */
-    hasComments?: boolean;
-    /**
-     * Filter QR codes with/without custom social media cards
-     */
-    hasCustomSocial?: boolean;
-    /**
-     * Filter QR codes with/without device targeting
-     */
-    hasDevice?: boolean;
-    /**
-     * Filter QR codes with/without expiration date
-     */
-    hasExpiration?: boolean;
-    /**
-     * Filter QR codes with/without geo-targeting
-     */
-    hasGeo?: boolean;
-    /**
-     * Filter QR codes with/without password protection
-     */
-    hasPassword?: boolean;
-    /**
-     * Filter QR codes with/without tags
-     */
-    hasTags?: boolean;
-    /**
-     * Filter QR codes with/without UTM parameters
-     */
-    hasUTM?: boolean;
-    /**
-     * The page number for pagination.
-     */
-    page?: number;
-    /**
-     * The number of items per page.
-     */
-    pageSize?: number;
-    /**
-     * The password to filter by.
-     */
-    password?: string;
-    /**
-     * The slug of the project to which the QR code belongs. For example, for
-     * `app.codeqr.io/acme`, the projectSlug is `acme`.
-     */
-    projectSlug?: string;
-    /**
-     * Maximum number of scans
-     */
-    scansMax?: number;
-    /**
-     * Minimum number of scans
-     */
-    scansMin?: number;
-    /**
-     * The search term to filter the QR codes. The search term will be matched against
-     * the QR code slug and the destination URL.
-     */
-    search?: string;
-    /**
-     * If should include archived QR codes in the response. The default is `false` if
-     * not provided.
-     */
-    showArchived?: boolean;
-    /**
-     * The field to order the QR codes. The default is `createdAt`, and the order of
-     * sorting is always descending.
-     */
-    sort?: 'createdAt' | 'scans' | 'lastClicked';
-    /**
-     * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
-     * to the QR code.
-     */
-    tagId?: string;
-    /**
-     * The IDs of the tags to filter the QR codes.
-     */
-    tagIds?: string | Array<string>;
-    /**
-     * The unique name of the tags assigned to the QR code (case insensitive).
-     */
-    tagNames?: string | Array<string>;
-    /**
-     * If should include QR codes with conversion tracking enabled. The default is
-     * `false` if not provided.
-     */
-    trackConversion?: boolean;
-    /**
-     * Filter by QR code type
-     */
-    type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog' | 'pix';
-    /**
-     * Filter QR codes marked as templates.
-     */
-    useAsTemplate?: boolean;
-    /**
-     * The ID of the user to filter by.
-     */
-    userId?: string;
+    interface Rule {
+        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+        operator: 'equals' | 'not_equals';
+        url: string;
+        value: string;
+    }
     /**
-     * If should include tags in the response. The default is `false` if not provided.
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
      */
-    withTags?: boolean;
+    interface Whatsapp {
+        number: string;
+        message?: string;
+    }
 }
 export declare namespace Qrcodes {
-    export { type QrCode as QrCode, type QrcodeListResponse as QrcodeListResponse, type QrcodeDeleteResponse as QrcodeDeleteResponse, type QrcodeCreateParams as QrcodeCreateParams, type QrcodeRetrieveParams as QrcodeRetrieveParams, type QrcodeUpdateParams as QrcodeUpdateParams, type QrcodeListParams as QrcodeListParams, };
+    export { type QrCode as QrCode, type QrcodeListResponse as QrcodeListResponse, type QrcodeDeleteResponse as QrcodeDeleteResponse, type QrcodeCreateParams as QrcodeCreateParams, type QrcodeListParams as QrcodeListParams, type QrcodeRetrieveParams as QrcodeRetrieveParams, type QrcodeUpdateParams as QrcodeUpdateParams, };
     export { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams, };
 }
 //# sourceMappingURL=qrcodes.d.ts.map