@codeqr/ts 0.24.0 → 0.25.0

package/resources/qrcodes/qrcodes.d.ts

@@ -15,15 +15,6 @@ 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.
      *
@@ -47,6 +38,15 @@ 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.
      *
@@ -67,7 +67,8 @@ export interface QrCode {
      */
     android: string | null;
     /**
-     * If the QR code is archived.
+     * If the QR code is archived. Archiving hides it from the default dashboard
+     * listing; the code keeps redirecting and keeps counting scans.
      */
     archived: boolean;
     /**
@@ -199,13 +200,9 @@ export interface QrCode {
      */
     level: string;
     /**
-     * The logo of the QR code.
+     * @deprecated [DEPRECATED (use `src` instead)]: Not read by any renderer.
      */
     logo: string | null;
-    /**
-     * The notification token of the QR code.
-     */
-    notificationToken: string | null;
     /**
      * The password required to access the destination URL of the QR code.
      */
@@ -307,9 +304,9 @@ export interface QrCode {
      */
     url: string | null;
     /**
-     * For dynamic QR codes with phone, email, or sms types: if true (default), shows
-     * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
-     * URI.
+     * Kept for compatibility. A dynamic phone, email or SMS code is always served the
+     * display page, whose buttons open the dialler, the mail client or the SMS app;
+     * setting this to false changes nothing about what a scan gets.
      */
     useDisplayPage: boolean;
     /**
@@ -342,6 +339,13 @@ export interface QrCode {
     vcard: {
         [key: string]: string;
     } | null;
+    /**
+     * The customizations of the wallet passes saved from this QR code (name, logo and
+     * the text under the QR code), or `null` when there are none. Applied only on the
+     * Business plan and above, outside a trial; otherwise the passes use the workspace
+     * branding.
+     */
+    walletPass: QrCode.WalletPass | null;
     /**
      * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
      * prefilled message.
@@ -375,10 +379,38 @@ export interface QrCode {
 }
 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;
+        attribute?: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language' | 'city' | 'region' | 'continent' | 'utm_term' | 'utm_content';
+        operator?: 'equals' | 'not_equals';
+        split?: Array<Rule.Split>;
+        url?: string;
+        value?: string;
+    }
+    namespace Rule {
+        interface Split {
+            url: string;
+            weight: number;
+        }
+    }
+    /**
+     * The customizations of the wallet passes saved from this QR code (name, logo and
+     * the text under the QR code), or `null` when there are none. Applied only on the
+     * Business plan and above, outside a trial; otherwise the passes use the workspace
+     * branding.
+     */
+    interface WalletPass {
+        /**
+         * The text shown under the QR code on the pass.
+         */
+        barcodeText?: string | null;
+        /**
+         * The URL of the logo shown on the pass. Always an image stored by CodeQR: a logo
+         * sent as an external URL is returned as the URL of its copy.
+         */
+        logo?: string | null;
+        /**
+         * The name shown at the top of the pass.
+         */
+        name?: string | null;
     }
     /**
      * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
@@ -418,7 +450,8 @@ export interface QrcodeCreateParams {
      */
     android?: string | null;
     /**
-     * If the QR code is archived.
+     * If the QR code is archived. Archiving hides it from the default dashboard
+     * listing; the code keeps redirecting and keeps counting scans.
      */
     archived?: boolean;
     /**
@@ -430,16 +463,10 @@ export interface QrcodeCreateParams {
      * The comments for the QR code.
      */
     comments?: string | null;
-    /**
-     * The static content of the QR code.
-     */
-    contentStatic?: string | null;
     /**
      * The cryptocurrency information of the QR code.
      */
-    crypto?: {
-        [key: string]: string;
-    } | null;
+    crypto?: QrcodeCreateParams.Crypto | null;
     /**
      * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
      * used for custom link preview if `proxy` is true.
@@ -573,7 +600,8 @@ export interface QrcodeCreateParams {
      */
     level?: string;
     /**
-     * The logo of the QR code.
+     * @deprecated [DEPRECATED (use `src` instead)]: Not read by any renderer. Set
+     * `src` to an image uploaded via `POST /qrcodes/logo`.
      */
     logo?: string | null;
     /**
@@ -596,6 +624,10 @@ export interface QrcodeCreateParams {
      * The phone number of the QR code.
      */
     phone?: string | null;
+    /**
+     * The Pix information of the QR code (key, name, city, amount, description).
+     */
+    pix?: unknown;
     /**
      * The prefix for the randomly generated key. If provided, the key will be prefixed
      * with this value.
@@ -657,7 +689,8 @@ export interface QrcodeCreateParams {
      */
     tagIds?: string | Array<string>;
     /**
-     * The unique name of the tags assigned to the QR code (case insensitive).
+     * The unique name of the tags assigned to the QR code (case insensitive). Ignored
+     * when `tagIds` is also present.
      */
     tagNames?: string | Array<string>;
     /**
@@ -688,9 +721,9 @@ export interface QrcodeCreateParams {
      */
     useAsTemplate?: boolean;
     /**
-     * For dynamic QR codes with phone, email, or sms types: if true (default), shows
-     * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
-     * URI.
+     * Kept for compatibility. A dynamic phone, email or SMS code is always served the
+     * display page, whose buttons open the dialler, the mail client or the SMS app;
+     * setting this to false changes nothing about what a scan gets.
      */
     useDisplayPage?: boolean;
     /**
@@ -699,6 +732,18 @@ export interface QrcodeCreateParams {
     vcard?: {
         [key: string]: string;
     } | null;
+    /**
+     * Customizes the Google Wallet and Apple Wallet passes saved from this QR code.
+     * `name` and `logo` replace the workspace name and logo; left out (or `null`), the
+     * pass shows the workspace value. `barcodeText` sets the text under the QR code.
+     * On update: omit `walletPass` to keep the stored value, send `null` to clear it,
+     * or send an object to replace the stored one as a whole — fields missing from the
+     * object are cleared, not merged. Available on the Business plan and above,
+     * outside a trial: elsewhere a new value is refused with `403 forbidden` (`null`
+     * is always accepted) and a stored value is ignored, so the passes show the
+     * workspace name and logo.
+     */
+    walletPass?: QrcodeCreateParams.WalletPass | null;
     /**
      * An array of webhook IDs to trigger when the link is clicked. These webhooks will
      * receive click event data.
@@ -722,6 +767,22 @@ export interface QrcodeCreateParams {
     } | null;
 }
 export declare namespace QrcodeCreateParams {
+    /**
+     * The cryptocurrency information of the QR code.
+     */
+    interface Crypto {
+        /**
+         * The wallet address, as the display page reads it.
+         */
+        address?: string;
+        amount?: string;
+        cryptocurrency?: 'bitcoin' | 'bitcoincash' | 'ethereum' | 'litecoin' | 'dash' | 'dogecoin';
+        /**
+         * The wallet address.
+         */
+        email?: string;
+        message?: string;
+    }
     /**
      * 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
@@ -1009,10 +1070,48 @@ export declare namespace QrcodeCreateParams {
         ZW?: string;
     }
     interface Rule {
-        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
-        operator: 'equals' | 'not_equals';
-        url: string;
-        value: string;
+        attribute?: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language' | 'city' | 'region' | 'continent' | 'utm_term' | 'utm_content';
+        operator?: 'equals' | 'not_equals';
+        split?: Array<Rule.Split>;
+        url?: string;
+        value?: string;
+    }
+    namespace Rule {
+        interface Split {
+            url: string;
+            weight: number;
+        }
+    }
+    /**
+     * Customizes the Google Wallet and Apple Wallet passes saved from this QR code.
+     * `name` and `logo` replace the workspace name and logo; left out (or `null`), the
+     * pass shows the workspace value. `barcodeText` sets the text under the QR code.
+     * On update: omit `walletPass` to keep the stored value, send `null` to clear it,
+     * or send an object to replace the stored one as a whole — fields missing from the
+     * object are cleared, not merged. Available on the Business plan and above,
+     * outside a trial: elsewhere a new value is refused with `403 forbidden` (`null`
+     * is always accepted) and a stored value is ignored, so the passes show the
+     * workspace name and logo.
+     */
+    interface WalletPass {
+        /**
+         * The text shown under the QR code on the pass, such as the member's name or card
+         * number. The QR code's title is never shown there. Trimmed; 1 to 40 characters.
+         */
+        barcodeText?: string | null;
+        /**
+         * The logo shown on the pass, in place of the workspace logo. Either the URL of an
+         * image uploaded via `POST /qrcodes/logo`, or any https URL serving a PNG, JPEG or
+         * WebP image of up to 2 MB without a redirect. An external image is copied to
+         * CodeQR storage when the QR code is written, and the response returns the URL of
+         * the copy, not the URL sent.
+         */
+        logo?: string | null;
+        /**
+         * The name shown at the top of the pass, in place of the workspace name. Trimmed;
+         * 1 to 64 characters.
+         */
+        name?: string | null;
     }
     /**
      * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
@@ -1023,172 +1122,6 @@ export declare namespace QrcodeCreateParams {
         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 {
     /**
      * The domain of the QR code to be retrieved. For example, for
@@ -1221,7 +1154,8 @@ export interface QrcodeUpdateParams {
      */
     android?: string | null;
     /**
-     * If the QR code is archived.
+     * If the QR code is archived. Archiving hides it from the default dashboard
+     * listing; the code keeps redirecting and keeps counting scans.
      */
     archived?: boolean;
     /**
@@ -1233,16 +1167,10 @@ export interface QrcodeUpdateParams {
      * The comments for the QR code.
      */
     comments?: string | null;
-    /**
-     * The static content of the QR code.
-     */
-    contentStatic?: string | null;
     /**
      * The cryptocurrency information of the QR code.
      */
-    crypto?: {
-        [key: string]: string;
-    } | null;
+    crypto?: QrcodeUpdateParams.Crypto | null;
     /**
      * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
      * used for custom link preview if `proxy` is true.
@@ -1376,7 +1304,8 @@ export interface QrcodeUpdateParams {
      */
     level?: string;
     /**
-     * The logo of the QR code.
+     * @deprecated [DEPRECATED (use `src` instead)]: Not read by any renderer. Set
+     * `src` to an image uploaded via `POST /qrcodes/logo`.
      */
     logo?: string | null;
     /**
@@ -1399,6 +1328,10 @@ export interface QrcodeUpdateParams {
      * The phone number of the QR code.
      */
     phone?: string | null;
+    /**
+     * The Pix information of the QR code (key, name, city, amount, description).
+     */
+    pix?: unknown;
     /**
      * The prefix for the randomly generated key. If provided, the key will be prefixed
      * with this value.
@@ -1460,7 +1393,8 @@ export interface QrcodeUpdateParams {
      */
     tagIds?: string | Array<string>;
     /**
-     * The unique name of the tags assigned to the QR code (case insensitive).
+     * The unique name of the tags assigned to the QR code (case insensitive). Ignored
+     * when `tagIds` is also present.
      */
     tagNames?: string | Array<string>;
     /**
@@ -1495,17 +1429,49 @@ export interface QrcodeUpdateParams {
      */
     useAsTemplate?: boolean;
     /**
-     * For dynamic QR codes with phone, email, or sms types: if true (default), shows
-     * an action page with buttons. If false, redirects directly to tel:/mailto:/sms:
-     * URI.
+     * Kept for compatibility. A dynamic phone, email or SMS code is always served the
+     * display page, whose buttons open the dialler, the mail client or the SMS app;
+     * setting this to false changes nothing about what a scan gets.
      */
     useDisplayPage?: boolean;
+    /**
+     * The utm_campaign of the destination URL.
+     */
+    utm_campaign?: string | null;
+    /**
+     * The utm_content of the destination URL.
+     */
+    utm_content?: string | null;
+    /**
+     * The utm_medium of the destination URL.
+     */
+    utm_medium?: string | null;
+    /**
+     * The utm_source of the destination URL.
+     */
+    utm_source?: string | null;
+    /**
+     * The utm_term of the destination URL.
+     */
+    utm_term?: string | null;
     /**
      * The vCard information of the QR code.
      */
     vcard?: {
         [key: string]: string;
     } | null;
+    /**
+     * Customizes the Google Wallet and Apple Wallet passes saved from this QR code.
+     * `name` and `logo` replace the workspace name and logo; left out (or `null`), the
+     * pass shows the workspace value. `barcodeText` sets the text under the QR code.
+     * On update: omit `walletPass` to keep the stored value, send `null` to clear it,
+     * or send an object to replace the stored one as a whole — fields missing from the
+     * object are cleared, not merged. Available on the Business plan and above,
+     * outside a trial: elsewhere a new value is refused with `403 forbidden` (`null`
+     * is always accepted) and a stored value is ignored, so the passes show the
+     * workspace name and logo.
+     */
+    walletPass?: QrcodeUpdateParams.WalletPass | null;
     /**
      * An array of webhook IDs to trigger when the link is clicked. These webhooks will
      * receive click event data.
@@ -1529,6 +1495,22 @@ export interface QrcodeUpdateParams {
     } | null;
 }
 export declare namespace QrcodeUpdateParams {
+    /**
+     * The cryptocurrency information of the QR code.
+     */
+    interface Crypto {
+        /**
+         * The wallet address, as the display page reads it.
+         */
+        address?: string;
+        amount?: string;
+        cryptocurrency?: 'bitcoin' | 'bitcoincash' | 'ethereum' | 'litecoin' | 'dash' | 'dogecoin';
+        /**
+         * The wallet address.
+         */
+        email?: string;
+        message?: string;
+    }
     /**
      * 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
@@ -1816,10 +1798,48 @@ export declare namespace QrcodeUpdateParams {
         ZW?: string;
     }
     interface Rule {
-        attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
-        operator: 'equals' | 'not_equals';
-        url: string;
-        value: string;
+        attribute?: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language' | 'city' | 'region' | 'continent' | 'utm_term' | 'utm_content';
+        operator?: 'equals' | 'not_equals';
+        split?: Array<Rule.Split>;
+        url?: string;
+        value?: string;
+    }
+    namespace Rule {
+        interface Split {
+            url: string;
+            weight: number;
+        }
+    }
+    /**
+     * Customizes the Google Wallet and Apple Wallet passes saved from this QR code.
+     * `name` and `logo` replace the workspace name and logo; left out (or `null`), the
+     * pass shows the workspace value. `barcodeText` sets the text under the QR code.
+     * On update: omit `walletPass` to keep the stored value, send `null` to clear it,
+     * or send an object to replace the stored one as a whole — fields missing from the
+     * object are cleared, not merged. Available on the Business plan and above,
+     * outside a trial: elsewhere a new value is refused with `403 forbidden` (`null`
+     * is always accepted) and a stored value is ignored, so the passes show the
+     * workspace name and logo.
+     */
+    interface WalletPass {
+        /**
+         * The text shown under the QR code on the pass, such as the member's name or card
+         * number. The QR code's title is never shown there. Trimmed; 1 to 40 characters.
+         */
+        barcodeText?: string | null;
+        /**
+         * The logo shown on the pass, in place of the workspace logo. Either the URL of an
+         * image uploaded via `POST /qrcodes/logo`, or any https URL serving a PNG, JPEG or
+         * WebP image of up to 2 MB without a redirect. An external image is copied to
+         * CodeQR storage when the QR code is written, and the response returns the URL of
+         * the copy, not the URL sent.
+         */
+        logo?: string | null;
+        /**
+         * The name shown at the top of the pass, in place of the workspace name. Trimmed;
+         * 1 to 64 characters.
+         */
+        name?: string | null;
     }
     /**
      * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
@@ -1830,8 +1850,174 @@ export declare namespace QrcodeUpdateParams {
         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 declare namespace Qrcodes {
-    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 { 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 { Bulk as Bulk, type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams, };
 }
 //# sourceMappingURL=qrcodes.d.ts.map