@codeqr/ts 0.24.1 → 0.25.0

package/src/resources/qrcodes/qrcodes.ts

@@ -23,21 +23,6 @@ export class Qrcodes extends APIResource {
     return this._client.post('/qrcodes', { body, ...options });
   }
 
-  /**
-   * 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> {
-    return this._client.get('/qrcodes', { query, ...options });
-  }
-
   /**
    * Retrieve the info for a QR Code.
    *
@@ -71,6 +56,21 @@ export class Qrcodes extends APIResource {
     return this._client.put(path`/qrcodes/${qrcodeID}`, { body, ...options });
   }
 
+  /**
+   * 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> {
+    return this._client.get('/qrcodes', { query, ...options });
+  }
+
   /**
    * Delete a QR Code for the authenticated workspace.
    *
@@ -96,7 +96,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;
 
@@ -247,15 +248,10 @@ 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.
    */
@@ -392,9 +388,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;
 
@@ -433,6 +429,14 @@ 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.
@@ -470,13 +474,59 @@ export interface QrCode {
 
 export namespace QrCode {
   export interface Rule {
-    attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+    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;
+  }
+
+  export namespace Rule {
+    export interface Split {
+      url: string;
+
+      weight: number;
+    }
+  }
 
-    operator: 'equals' | 'not_equals';
+  /**
+   * 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.
+   */
+  export interface WalletPass {
+    /**
+     * The text shown under the QR code on the pass.
+     */
+    barcodeText?: string | null;
 
-    url: string;
+    /**
+     * 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;
 
-    value: string;
+    /**
+     * The name shown at the top of the pass.
+     */
+    name?: string | null;
   }
 
   /**
@@ -540,7 +590,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;
 
@@ -555,15 +606,10 @@ export interface QrcodeCreateParams {
    */
   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
@@ -718,7 +764,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;
 
@@ -747,6 +794,11 @@ export interface QrcodeCreateParams {
    */
   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.
@@ -820,7 +872,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>;
 
@@ -858,9 +911,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;
 
@@ -869,6 +922,19 @@ 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.
@@ -894,6 +960,27 @@ export interface QrcodeCreateParams {
 }
 
 export namespace QrcodeCreateParams {
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  export 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
@@ -1435,13 +1522,69 @@ export namespace QrcodeCreateParams {
   }
 
   export interface Rule {
-    attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+    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;
+  }
+
+  export namespace Rule {
+    export interface Split {
+      url: string;
+
+      weight: number;
+    }
+  }
 
-    operator: 'equals' | 'not_equals';
+  /**
+   * 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.
+   */
+  export 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;
 
-    url: string;
+    /**
+     * 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;
 
-    value: string;
+    /**
+     * The name shown at the top of the pass, in place of the workspace name. Trimmed;
+     * 1 to 64 characters.
+     */
+    name?: string | null;
   }
 
   /**
@@ -1455,410 +1598,188 @@ export namespace QrcodeCreateParams {
   }
 }
 
-export interface QrcodeListParams {
+export interface QrcodeRetrieveParams {
   /**
-   * The comments to filter by.
+   * The domain of the QR code to be retrieved. For example, for
+   * `codeqr.link/github`, the domain is `codeqr.link`.
    */
-  comments?: string;
+  domain: string;
 
   /**
-   * Filter QR codes created after this date
+   * The key of the QR code to be retrieved. For example, for `codeqr.link/github`,
+   * the key is `github`.
    */
-  createdAfter?: string;
+  key: string;
 
   /**
-   * Filter QR codes created before this date
+   * The slug of the project to which the QR code belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
    */
-  createdBefore?: string;
+  projectSlug: string;
 
   /**
-   * The domain to filter the QR codes. For example, `ac.me`. If not provided, all QR
-   * codes of the project will be returned.
+   * This is the ID of the QR code in your database. It must be prefixed with `ext_`
+   * when passed as a query parameter.
    */
-  domain?: string;
+  externalId?: string;
 
   /**
-   * Filter QR codes expiring after this date
+   * The unique ID of the QR code.
    */
-  expiresAfter?: string;
+  qrCodeId?: string;
+}
 
+export interface QrcodeUpdateParams {
   /**
-   * The date and time the QR code will expire in ISO-8601 format. Must be in the
-   * future.
+   * The destination URL for Android for the QR code for device targeting Android.
    */
-  expiresAt?: string | null;
+  android?: string | null;
 
   /**
-   * Filter QR codes expiring before this date
+   * If the QR code is archived. Archiving hides it from the default dashboard
+   * listing; the code keeps redirecting and keeps counting scans.
    */
-  expiresBefore?: string;
+  archived?: boolean;
 
   /**
-   * The folder ID to filter the QR codes by.
+   * The background color of the QR code (hex or CSS keyword). Invalid values are
+   * coerced to default.
    */
-  folderId?: string;
+  bgColor?: string;
 
   /**
-   * Filter by QR code format - static or dynamic
+   * The comments for the QR code.
    */
-  format?: 'static' | 'dynamic';
+  comments?: string | null;
 
   /**
-   * Filter QR codes with/without comments
+   * The cryptocurrency information of the QR code.
    */
-  hasComments?: boolean;
+  crypto?: QrcodeUpdateParams.Crypto | null;
 
   /**
-   * Filter QR codes with/without custom social media cards
+   * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
+   * used for custom link preview if `proxy` is true.
    */
-  hasCustomSocial?: boolean;
+  description?: string | null;
 
   /**
-   * Filter QR codes with/without device targeting
+   * Allow search engines to index your QR code. The default is `false` if not
+   * provided. Learn more: https://codeqr.link/noindex
    */
-  hasDevice?: boolean;
+  doIndex?: boolean;
 
   /**
-   * Filter QR codes with/without expiration date
+   * The domain of the QR code. If not provided, the main domain of the project will
+   * be used (or `codeqr.link` if the project does not have domains).
    */
-  hasExpiration?: boolean;
+  domain?: string;
 
   /**
-   * Filter QR codes with/without geo-targeting
+   * The email information of the QR code.
    */
-  hasGeo?: boolean;
+  email?: { [key: string]: string } | null;
 
   /**
-   * Filter QR codes with/without password protection
+   * If the QR code should have excavated areas.
    */
-  hasPassword?: boolean;
+  excavate?: boolean;
 
   /**
-   * Filter QR codes with/without tags
+   * The URL to redirect when the QR code expires.
    */
-  hasTags?: boolean;
+  expiredUrl?: string | null;
 
   /**
-   * Filter QR codes with/without UTM parameters
+   * The date and time the QR code will expire in ISO-8601 format. Must be in the
+   * future.
    */
-  hasUTM?: boolean;
+  expiresAt?: string | null;
 
   /**
-   * The page number for pagination.
+   * This is the ID of the QR code in your database. If defined, it can be used to
+   * identify the QR code in the future. It must be prefixed with `ext_` when passed
+   * as a query parameter.
    */
-  page?: number;
+  externalId?: string | null;
 
   /**
-   * The number of items per page.
+   * The FaceTime information of the QR code.
    */
-  pageSize?: number;
+  facetime?: { [key: string]: string } | null;
 
   /**
-   * The password to filter by.
+   * The foreground color of the QR code (hex or CSS keyword). Invalid values are
+   * coerced to default.
    */
-  password?: string;
+  fgColor?: string;
 
   /**
-   * The slug of the project to which the QR code belongs. For example, for
-   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   * If the QR code is filled.
    */
-  projectSlug?: string;
+  filled?: boolean;
 
   /**
-   * Maximum number of scans
+   * If the QR code is flexible.
    */
-  scansMax?: number;
+  flexible?: boolean;
 
   /**
-   * Minimum number of scans
+   * The unique ID of the folder assigned to the QR code. Omit or set to null for no
+   * folder.
    */
-  scansMin?: number;
+  folderId?: string | null;
 
   /**
-   * The search term to filter the QR codes. The search term will be matched against
-   * the QR code slug, title, and the destination URL.
+   * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
+   * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
+   * render.
    */
-  search?: string;
+  frame?: string;
 
   /**
-   * If should include archived QR codes in the response. The default is `false` if
-   * not provided.
+   * The color of the frame (hex or CSS keyword). Invalid values are coerced to
+   * default.
    */
-  showArchived?: boolean;
+  frameColor?: string;
 
   /**
-   * The field to order the QR codes. The default is `createdAt`, and the order of
-   * sorting is always descending.
+   * 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.
    */
-  sort?: 'createdAt' | 'scans' | 'lastClicked';
+  frameText?: string;
 
   /**
-   * @deprecated [DEPRECATED (use tagIds instead)]: The unique ID of the tag assigned
-   * to the QR code.
+   * 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`.
    */
-  tagId?: string;
+  frameTextColor?: string | null;
 
   /**
-   * The IDs of the tags to filter the QR codes.
+   * 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).
    */
-  tagIds?: string | Array<string>;
+  frameTextStyles?: QrcodeUpdateParams.FrameTextStyles | null;
 
   /**
-   * The unique name of the tags assigned to the QR code (case insensitive).
+   * Geographic segmentation information for the QR code in the JSON format
+   * `{[COUNTRY]: https://example.com }`.
    */
-  tagNames?: string | Array<string>;
+  geo?: QrcodeUpdateParams.Geo | null;
 
   /**
-   * If should include QR codes with conversion tracking enabled. The default is
-   * `false` if not provided.
+   * Logo height in pixels. When omitted, a proportional size is used based on the QR
+   * code size (about 10–20% depending on size).
    */
-  trackConversion?: boolean;
+  height?: number;
 
   /**
-   * 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
-   * `codeqr.link/github`, the domain is `codeqr.link`.
-   */
-  domain: string;
-
-  /**
-   * The key of the QR code to be retrieved. For example, for `codeqr.link/github`,
-   * the key is `github`.
-   */
-  key: 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;
-
-  /**
-   * This is the ID of the QR code in your database. It must be prefixed with `ext_`
-   * when passed as a query parameter.
-   */
-  externalId?: string;
-
-  /**
-   * The unique ID of the QR code.
-   */
-  qrCodeId?: string;
-}
-
-export interface QrcodeUpdateParams {
-  /**
-   * The destination URL for Android for the QR code for device targeting Android.
-   */
-  android?: string | null;
-
-  /**
-   * If the QR code is archived.
-   */
-  archived?: boolean;
-
-  /**
-   * The background color of the QR code (hex or CSS keyword). Invalid values are
-   * coerced to default.
-   */
-  bgColor?: string;
-
-  /**
-   * 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;
-
-  /**
-   * The description of the QR code 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 QR code. The default is `false` if not
-   * provided. Learn more: https://codeqr.link/noindex
-   */
-  doIndex?: boolean;
-
-  /**
-   * The domain of the QR code. If not provided, the main domain of the project will
-   * be used (or `codeqr.link` if the project does not have domains).
-   */
-  domain?: string;
-
-  /**
-   * The email information of the QR code.
-   */
-  email?: { [key: string]: string } | null;
-
-  /**
-   * If the QR code should have excavated areas.
-   */
-  excavate?: boolean;
-
-  /**
-   * The URL to redirect when the QR code expires.
-   */
-  expiredUrl?: string | null;
-
-  /**
-   * The date and time the QR code will expire in ISO-8601 format. Must be in the
-   * future.
-   */
-  expiresAt?: string | null;
-
-  /**
-   * This is the ID of the QR code in your database. If defined, it can be used to
-   * identify the QR code in the future. It must be prefixed with `ext_` when passed
-   * as a query parameter.
-   */
-  externalId?: string | null;
-
-  /**
-   * The FaceTime information of the QR code.
-   */
-  facetime?: { [key: string]: string } | null;
-
-  /**
-   * The foreground color of the QR code (hex or CSS keyword). Invalid values are
-   * coerced to default.
-   */
-  fgColor?: string;
-
-  /**
-   * If the QR code is filled.
-   */
-  filled?: boolean;
-
-  /**
-   * If the QR code is flexible.
-   */
-  flexible?: boolean;
-
-  /**
-   * The unique ID of the folder assigned to the QR code. Omit or set to null for no
-   * folder.
-   */
-  folderId?: string | null;
-
-  /**
-   * The type of frame of the QR code (e.g. none, frame-1, frame-2, frame-3, frame-5,
-   * frame-6). frame-5/6 are top-bar variants. Unknown ids fall back to no frame at
-   * render.
-   */
-  frame?: string;
-
-  /**
-   * The color of the frame (hex or CSS keyword). Invalid values are coerced to
-   * default.
-   */
-  frameColor?: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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).
-   */
-  frameTextStyles?: QrcodeUpdateParams.FrameTextStyles | null;
-
-  /**
-   * Geographic segmentation information for the QR code in the JSON format
-   * `{[COUNTRY]: https://example.com }`.
-   */
-  geo?: QrcodeUpdateParams.Geo | null;
-
-  /**
-   * Logo height in pixels. When omitted, a proportional size is used based on the QR
-   * code size (about 10–20% depending on size).
-   */
-  height?: number;
-
-  /**
-   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
-   * for custom link preview if `proxy` is true.
+   * The image of the QR code generated via `api.codeqr.io/metatags`. Will be used
+   * for custom link preview if `proxy` is true.
    */
   image?: string | null;
 
@@ -1889,7 +1810,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;
 
@@ -1918,6 +1840,11 @@ export interface QrcodeUpdateParams {
    */
   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.
@@ -1991,7 +1918,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>;
 
@@ -2047,17 +1975,55 @@ 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.
@@ -2083,6 +2049,27 @@ export interface QrcodeUpdateParams {
 }
 
 export namespace QrcodeUpdateParams {
+  /**
+   * The cryptocurrency information of the QR code.
+   */
+  export 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
@@ -2624,13 +2611,69 @@ export namespace QrcodeUpdateParams {
   }
 
   export interface Rule {
-    attribute: 'device' | 'country' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'referrer' | 'language';
+    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;
+  }
 
-    operator: 'equals' | 'not_equals';
+  export namespace Rule {
+    export interface Split {
+      url: string;
 
-    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.
+   */
+  export 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;
 
-    value: string;
+    /**
+     * 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;
   }
 
   /**
@@ -2644,6 +2687,224 @@ export namespace QrcodeUpdateParams {
   }
 }
 
+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;
+}
+
 Qrcodes.Bulk = Bulk;
 
 export declare namespace Qrcodes {
@@ -2652,9 +2913,9 @@ export declare namespace Qrcodes {
     type QrcodeListResponse as QrcodeListResponse,
     type QrcodeDeleteResponse as QrcodeDeleteResponse,
     type QrcodeCreateParams as QrcodeCreateParams,
-    type QrcodeListParams as QrcodeListParams,
     type QrcodeRetrieveParams as QrcodeRetrieveParams,
     type QrcodeUpdateParams as QrcodeUpdateParams,
+    type QrcodeListParams as QrcodeListParams,
   };
 
   export {