@codeqr/ts 0.9.0 → 0.24.0

package/src/resources/qrcodes/qrcodes.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../core/resource';
 import * as TagsAPI from '../tags';
 import * as BulkAPI from './bulk';
-import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from './bulk';
+import { Bulk, BulkCreateParams, BulkCreateResponse } from './bulk';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -16,16 +16,28 @@ export class Qrcodes extends APIResource {
    *
    * @example
    * ```ts
-   * const qrCode = await client.qrcodes.create({
-   *   folderId: 'folderId',
-   *   type: 'url',
-   * });
+   * const qrCode = await client.qrcodes.create({ type: 'url' });
    * ```
    */
   create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode> {
     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.
    *
@@ -59,21 +71,6 @@ 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.
    *
@@ -85,38 +82,6 @@ export class Qrcodes extends APIResource {
   delete(qrcodeID: string, options?: RequestOptions): APIPromise<QrcodeDeleteResponse> {
     return this._client.delete(path`/qrcodes/${qrcodeID}`, options);
   }
-
-  /**
-   * Retrieve the number of QR Codes for the authenticated workspace.
-   *
-   * @example
-   * ```ts
-   * const response = await client.qrcodes.count();
-   * ```
-   */
-  count(
-    query: QrcodeCountParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<QrcodeCountResponse> {
-    return this._client.get('/qrcodes/count', { query, ...options });
-  }
-
-  /**
-   * Upsert a QR Code for the authenticated workspace by its URL. If a QR Code with
-   * the same URL already exists, return it (or update it if there are any changes).
-   * Otherwise, a new QR Code will be created.
-   *
-   * @example
-   * ```ts
-   * const qrCode = await client.qrcodes.upsert({
-   *   folderId: 'folderId',
-   *   type: 'url',
-   * });
-   * ```
-   */
-  upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode> {
-    return this._client.patch('/qrcodes/upsert', { body, ...options });
-  }
 }
 
 export interface QrCode {
@@ -326,6 +291,11 @@ export interface QrCode {
    */
   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.
    */
@@ -406,8 +376,10 @@ export interface QrCode {
     | 'crypto'
     | 'sms'
     | 'facetime'
+    | 'geo'
     | 'latlog'
-    | 'pix';
+    | 'pix'
+    | 'whatsapp';
 
   /**
    * The date and time the QR code was updated last.
@@ -419,6 +391,13 @@ 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.
+   */
+  useDisplayPage: boolean;
+
   /**
    * The ID of the user that created the QR code.
    */
@@ -454,6 +433,12 @@ 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.
    */
@@ -464,6 +449,14 @@ 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.
    */
@@ -475,6 +468,44 @@ export interface QrCode {
   pageUrl?: string | null;
 }
 
+export namespace QrCode {
+  export 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.
+   */
+  export 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.
+   */
+  export 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 {
@@ -484,21 +515,24 @@ export interface QrcodeDeleteResponse {
   id: string;
 }
 
-/**
- * The number of QR Codes matching the query.
- */
-export type QrcodeCountResponse = number;
-
 export interface QrcodeCreateParams {
-  /**
-   * The unique ID of the folder assigned to the QR code.
-   */
-  folderId: string | null;
-
   /**
    * 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.
@@ -511,7 +545,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;
 
@@ -582,7 +617,8 @@ export interface QrcodeCreateParams {
   facetime?: { [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;
 
@@ -597,20 +633,46 @@ export interface QrcodeCreateParams {
   flexible?: boolean;
 
   /**
-   * The type of frame of the QR code.
+   * 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 of the QR code.
+   * The color of the frame (hex or CSS keyword). Invalid values are coerced to
+   * default.
    */
   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;
 
+  /**
+   * 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?: QrcodeCreateParams.FrameTextStyles | null;
+
   /**
    * Geographic segmentation information for the QR code in the JSON format
    * `{[COUNTRY]: https://example.com }`.
@@ -618,7 +680,8 @@ export interface QrcodeCreateParams {
   geo?: QrcodeCreateParams.Geo | null;
 
   /**
-   * The height of the QR code.
+   * 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;
 
@@ -684,6 +747,12 @@ export interface QrcodeCreateParams {
    */
   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.
    */
@@ -704,6 +773,11 @@ export interface QrcodeCreateParams {
    */
   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).
    */
@@ -750,6 +824,13 @@ export interface QrcodeCreateParams {
    */
   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.
    */
@@ -767,852 +848,21 @@ export interface QrcodeCreateParams {
   trackConversion?: boolean;
 
   /**
-   * The destination URL of the QR code.
-   */
-  url?: string | null;
-
-  /**
-   * The vCard information of the QR code.
-   */
-  vcard?: { [key: string]: 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;
-
-  /**
-   * The width of the QR code.
-   */
-  width?: number;
-
-  /**
-   * The WiFi information of the QR code.
-   */
-  wifi?: { [key: string]: string } | null;
-}
-
-export namespace QrcodeCreateParams {
-  /**
-   * Geographic segmentation information for the QR code in the JSON format
-   * `{[COUNTRY]: https://example.com }`.
-   */
-  export 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 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.
-   */
-  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.
-   */
-  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.
-   */
-  folderId?: string | null;
-
-  /**
-   * The type of frame of the QR code.
-   */
-  frame?: string;
-
-  /**
-   * The color of the frame of the QR code.
-   */
-  frameColor?: string;
-
-  /**
-   * The text of the frame of the QR code.
-   */
-  frameText?: string;
-
-  /**
-   * Geographic segmentation information for the QR code in the JSON format
-   * `{[COUNTRY]: https://example.com }`.
-   */
-  geo?: QrcodeUpdateParams.Geo | null;
-
-  /**
-   * The height of the QR code.
-   */
-  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.
-   */
-  image?: string | null;
-
-  /**
-   * The destination URL for iOS for the QR code for device targeting iOS.
-   */
-  ios?: string | null;
-
-  /**
-   * If the form is mandatory for the page.
-   */
-  isFormMandatory?: boolean;
-
-  /**
-   * The slug of the QR code. If not provided, a random slug of 7 characters will be
-   * generated.
-   */
-  key?: string;
-
-  /**
-   * The latitude and longitude information of the QR code.
-   */
-  latlog?: { [key: string]: string } | null;
-
-  /**
-   * The level of error correction of the QR code.
-   */
-  level?: string;
-
-  /**
-   * The logo of the QR code.
-   */
-  logo?: string | null;
-
-  /**
-   * The ID of the page to redirect to before the QR code destination.
-   */
-  pageId?: string | null;
-
-  /**
-   * The URL of the page to redirect to before the QR code destination.
-   */
-  pageUrl?: string | null;
-
-  /**
-   * The password required to access the destination URL of the QR code.
-   */
-  password?: string | null;
-
-  /**
-   * The pattern of the modules of the QR code.
-   */
-  pattern?: string;
-
-  /**
-   * The phone number of the QR code.
-   */
-  phone?: string | null;
-
-  /**
-   * If the QR code has pre-redirection.
-   */
-  preRedirection?: boolean;
-
-  /**
-   * If the QR code uses the custom link preview feature.
-   */
-  proxy?: boolean;
-
-  /**
-   * If the statistics of the QR code are publicly accessible.
-   */
-  publicStats?: boolean;
-
-  /**
-   * If the QR code uses link cloaking.
-   */
-  rewrite?: boolean;
-
-  /**
-   * The shape of the design around the QR code (none, square, circle).
-   */
-  shape?: string;
-
-  /**
-   * If the logo should be displayed in the QR code.
-   */
-  showLogo?: boolean;
-
-  /**
-   * The size of the QR code.
-   */
-  size?: number;
-
-  /**
-   * The SMS information of the QR code.
-   */
-  sms?: { [key: string]: string } | null;
-
-  /**
-   * The image URL of the QR code.
-   */
-  src?: string | null;
-
-  /**
-   * If the QR code is static.
-   */
-  static?: boolean;
-
-  /**
-   * @deprecated The unique ID of the tag assigned to the QR code. This field is
-   * deprecated – use `tagIds` instead.
-   */
-  tagId?: string | null;
-
-  /**
-   * The unique IDs of the tags assigned to the QR code.
-   */
-  tagIds?: string | Array<string>;
-
-  /**
-   * The unique name of the tags assigned to the QR code (case insensitive).
-   */
-  tagNames?: string | Array<string>;
-
-  /**
-   * The text of the QR code.
-   */
-  text?: string | null;
-
-  /**
-   * The title of the QR code generated via `api.codeqr.io/metatags`. Will be used
-   * for custom link preview if `proxy` is true.
-   */
-  title?: string | null;
-
-  /**
-   * If should track conversions for the QR code.
+   * The destination URL of the QR code.
    */
-  trackConversion?: boolean;
+  url?: string | null;
 
   /**
-   * The type of content of the QR code.
+   * Whether this QR code should be used as a reusable template.
    */
-  type?: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
+  useAsTemplate?: boolean;
 
   /**
-   * The destination URL of the QR code.
+   * 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.
    */
-  url?: string | null;
+  useDisplayPage?: boolean;
 
   /**
    * The vCard information of the QR code.
@@ -1626,7 +876,14 @@ export interface QrcodeUpdateParams {
   webhookIds?: Array<string> | null;
 
   /**
-   * The width of the QR code.
+   * 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).
    */
   width?: number;
 
@@ -1636,7 +893,41 @@ export interface QrcodeUpdateParams {
   wifi?: { [key: string]: string } | null;
 }
 
-export namespace QrcodeUpdateParams {
+export 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).
+   */
+  export 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 }`.
@@ -2142,6 +1433,26 @@ export namespace QrcodeUpdateParams {
 
     ZW?: string;
   }
+
+  export 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.
+   */
+  export interface Whatsapp {
+    number: string;
+
+    message?: string;
+  }
 }
 
 export interface QrcodeListParams {
@@ -2265,7 +1576,7 @@ export interface QrcodeListParams {
 
   /**
    * The search term to filter the QR codes. The search term will be matched against
-   * the QR code slug and the destination URL.
+   * the QR code slug, title, and the destination URL.
    */
   search?: string;
 
@@ -2316,206 +1627,84 @@ export interface QrcodeListParams {
     | 'crypto'
     | 'sms'
     | 'facetime'
+    | 'geo'
     | 'latlog'
-    | 'pix';
-
-  /**
-   * The ID of the user to filter by.
-   */
-  userId?: string;
-
-  /**
-   * If should include tags in the response. The default is `false` if not provided.
-   */
-  withTags?: boolean;
-}
-
-export interface QrcodeCountParams {
-  /**
-   * 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';
+    | 'pix'
+    | 'whatsapp';
 
   /**
-   * The field to group the QR codes.
+   * Filter QR codes marked as templates.
    */
-  groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
+  useAsTemplate?: boolean;
 
   /**
-   * Filter QR codes with/without comments
+   * The ID of the user to filter by.
    */
-  hasComments?: boolean;
+  userId?: string;
 
   /**
-   * Filter QR codes with/without custom social media cards
+   * Filter by UTM campaign value
    */
-  hasCustomSocial?: boolean;
+  utm_campaign?: string;
 
   /**
-   * Filter QR codes with/without device targeting
+   * Filter by UTM content value
    */
-  hasDevice?: boolean;
+  utm_content?: string;
 
   /**
-   * Filter QR codes with/without expiration date
+   * Filter by UTM medium value
    */
-  hasExpiration?: boolean;
+  utm_medium?: string;
 
   /**
-   * Filter QR codes with/without geo-targeting
+   * Filter by UTM source value
    */
-  hasGeo?: boolean;
+  utm_source?: string;
 
   /**
-   * Filter QR codes with/without password protection
+   * Filter by UTM term value
    */
-  hasPassword?: boolean;
+  utm_term?: string;
 
   /**
-   * Filter QR codes with/without tags
+   * If should include tags in the response. The default is `false` if not provided.
    */
-  hasTags?: boolean;
+  withTags?: boolean;
+}
 
+export interface QrcodeRetrieveParams {
   /**
-   * Filter QR codes with/without UTM parameters
+   * The domain of the QR code to be retrieved. For example, for
+   * `codeqr.link/github`, the domain is `codeqr.link`.
    */
-  hasUTM?: boolean;
+  domain: string;
 
   /**
-   * The password to filter by.
+   * The key of the QR code to be retrieved. For example, for `codeqr.link/github`,
+   * the key is `github`.
    */
-  password?: string;
+  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;
-
-  /**
-   * 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;
-
-  /**
-   * @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';
+  projectSlug: string;
 
   /**
-   * The ID of the user to filter by.
+   * This is the ID of the QR code in your database. It must be prefixed with `ext_`
+   * when passed as a query parameter.
    */
-  userId?: string;
+  externalId?: string;
 
   /**
-   * If should include tags in the response. The default is `false` if not provided.
+   * The unique ID of the QR code.
    */
-  withTags?: boolean;
+  qrCodeId?: string;
 }
 
-export interface QrcodeUpsertParams {
-  /**
-   * The unique ID of the folder assigned to the QR code.
-   */
-  folderId: string | null;
-
-  /**
-   * The type of content of the QR code.
-   */
-  type: 'url' | 'text' | 'email' | 'wifi' | 'phone' | 'vcard' | 'crypto' | 'sms' | 'facetime' | 'latlog';
-
+export interface QrcodeUpdateParams {
   /**
    * The destination URL for Android for the QR code for device targeting Android.
    */
@@ -2527,7 +1716,8 @@ export interface QrcodeUpsertParams {
   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;
 
@@ -2598,7 +1788,8 @@ export interface QrcodeUpsertParams {
   facetime?: { [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;
 
@@ -2613,28 +1804,55 @@ export interface QrcodeUpsertParams {
   flexible?: boolean;
 
   /**
-   * The type of frame of the QR code.
+   * 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 of the QR code.
+   * The color of the frame (hex or CSS keyword). Invalid values are coerced to
+   * default.
    */
   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;
 
+  /**
+   * 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?: QrcodeUpsertParams.Geo | null;
+  geo?: QrcodeUpdateParams.Geo | null;
 
   /**
-   * The height of the QR code.
+   * 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;
 
@@ -2700,6 +1918,12 @@ export interface QrcodeUpsertParams {
    */
   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.
    */
@@ -2720,6 +1944,11 @@ export interface QrcodeUpsertParams {
    */
   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).
    */
@@ -2766,6 +1995,13 @@ export interface QrcodeUpsertParams {
    */
   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.
    */
@@ -2782,11 +2018,41 @@ export interface QrcodeUpsertParams {
    */
   trackConversion?: boolean;
 
+  /**
+   * The type of content of the QR code.
+   */
+  type?:
+    | 'url'
+    | 'text'
+    | 'email'
+    | 'wifi'
+    | 'phone'
+    | 'vcard'
+    | 'crypto'
+    | 'sms'
+    | 'facetime'
+    | 'geo'
+    | 'latlog'
+    | 'pix'
+    | 'whatsapp';
+
   /**
    * The destination URL of the QR code.
    */
   url?: string | null;
 
+  /**
+   * Whether this QR code should be used as a reusable template.
+   */
+  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.
+   */
+  useDisplayPage?: boolean;
+
   /**
    * The vCard information of the QR code.
    */
@@ -2799,7 +2065,14 @@ export interface QrcodeUpsertParams {
   webhookIds?: Array<string> | null;
 
   /**
-   * The width of the QR code.
+   * 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).
    */
   width?: number;
 
@@ -2809,7 +2082,41 @@ export interface QrcodeUpsertParams {
   wifi?: { [key: string]: string } | null;
 }
 
-export namespace QrcodeUpsertParams {
+export 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).
+   */
+  export 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 }`.
@@ -3315,6 +2622,26 @@ export namespace QrcodeUpsertParams {
 
     ZW?: string;
   }
+
+  export 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.
+   */
+  export interface Whatsapp {
+    number: string;
+
+    message?: string;
+  }
 }
 
 Qrcodes.Bulk = Bulk;
@@ -3324,20 +2651,15 @@ export declare namespace Qrcodes {
     type QrCode as QrCode,
     type QrcodeListResponse as QrcodeListResponse,
     type QrcodeDeleteResponse as QrcodeDeleteResponse,
-    type QrcodeCountResponse as QrcodeCountResponse,
     type QrcodeCreateParams as QrcodeCreateParams,
+    type QrcodeListParams as QrcodeListParams,
     type QrcodeRetrieveParams as QrcodeRetrieveParams,
     type QrcodeUpdateParams as QrcodeUpdateParams,
-    type QrcodeListParams as QrcodeListParams,
-    type QrcodeCountParams as QrcodeCountParams,
-    type QrcodeUpsertParams as QrcodeUpsertParams,
   };
 
   export {
     Bulk as Bulk,
     type BulkCreateResponse as BulkCreateResponse,
-    type BulkDeleteResponse as BulkDeleteResponse,
     type BulkCreateParams as BulkCreateParams,
-    type BulkDeleteParams as BulkDeleteParams,
   };
 }