@codeqr/ts 0.19.3 → 0.24.1

package/src/resources/qrcodes/bulk.ts

@@ -65,7 +65,20 @@ export namespace BulkCreateParams {
     /**
      * 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.
@@ -78,7 +91,8 @@ export namespace BulkCreateParams {
     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;
 
@@ -149,7 +163,8 @@ export namespace BulkCreateParams {
     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;
 
@@ -183,15 +198,26 @@ export namespace BulkCreateParams {
     frameColor?: string;
 
     /**
-     * The text of the frame of the QR code.
+     * Label text rendered inside the frame (e.g. "SCAN ME", a product SKU). Maximum
+     * 200 characters. Word-wraps to multiple lines at larger sizes; the frame bar
+     * grows vertically to fit.
      */
     frameText?: string;
 
     /**
-     * The color of the text inside the frame (hex or CSS keyword). When not set, a
-     * contrasting color is derived from the frame color.
+     * Color of the frame label text (hex `#RRGGBB`, `#RGB`, `#RRGGBBAA`, or a CSS
+     * keyword from the allowlist). When omitted, a contrasting color is derived
+     * automatically from `frameColor`.
      */
-    frameTextColor?: string;
+    frameTextColor?: string | null;
+
+    /**
+     * Typographic styles applied to the frame label text. Every key is enum-gated —
+     * unknown keys or out-of-enum values are rejected to prevent SVG attribute
+     * injection. All fields are optional; omitted keys fall back to the default
+     * (normal weight, normal style, sans family, medium size).
+     */
+    frameTextStyles?: Body.FrameTextStyles | null;
 
     /**
      * Geographic segmentation information for the QR code in the JSON format
@@ -267,6 +293,12 @@ export namespace BulkCreateParams {
      */
     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.
      */
@@ -287,6 +319,11 @@ export namespace BulkCreateParams {
      */
     rewrite?: boolean;
 
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<Body.Rule> | null;
+
     /**
      * The shape of the design around the QR code (none, square, circle).
      */
@@ -333,6 +370,13 @@ export namespace BulkCreateParams {
      */
     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.
      */
@@ -377,6 +421,12 @@ export namespace BulkCreateParams {
      */
     webhookIds?: Array<string> | null;
 
+    /**
+     * The WhatsApp click-to-chat info: E.164 number (digits only) and optional
+     * prefilled message.
+     */
+    whatsapp?: Body.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).
@@ -390,6 +440,40 @@ export namespace BulkCreateParams {
   }
 
   export namespace Body {
+    /**
+     * 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 }`.
@@ -895,6 +979,33 @@ export namespace BulkCreateParams {
 
       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;
+    }
   }
 }
 

package/src/resources/qrcodes/index.ts

@@ -7,7 +7,7 @@ export {
   type QrcodeListResponse,
   type QrcodeDeleteResponse,
   type QrcodeCreateParams,
+  type QrcodeListParams,
   type QrcodeRetrieveParams,
   type QrcodeUpdateParams,
-  type QrcodeListParams,
 } from './qrcodes';