@codeqr/ts 0.24.1 → 0.25.0

package/src/resources/qrcodes/bulk.ts

@@ -86,7 +86,8 @@ export namespace BulkCreateParams {
     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;
 
@@ -101,15 +102,10 @@ export namespace BulkCreateParams {
      */
     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?: Body.Crypto | null;
 
     /**
      * The description of the QR code generated via `api.codeqr.io/metatags`. Will be
@@ -264,7 +260,8 @@ export namespace BulkCreateParams {
     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;
 
@@ -293,6 +290,11 @@ export namespace BulkCreateParams {
      */
     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.
@@ -366,7 +368,8 @@ export namespace BulkCreateParams {
     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>;
 
@@ -404,9 +407,9 @@ export namespace BulkCreateParams {
     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;
 
@@ -415,6 +418,19 @@ export namespace BulkCreateParams {
      */
     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?: Body.WalletPass | null;
+
     /**
      * An array of webhook IDs to trigger when the link is clicked. These webhooks will
      * receive click event data.
@@ -440,6 +456,27 @@ export namespace BulkCreateParams {
   }
 
   export namespace Body {
+    /**
+     * 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
@@ -981,20 +1018,69 @@ export namespace BulkCreateParams {
     }
 
     export interface Rule {
-      attribute:
+      attribute?:
         | 'device'
         | 'country'
         | 'utm_source'
         | 'utm_medium'
         | 'utm_campaign'
         | 'referrer'
-        | 'language';
+        | 'language'
+        | 'city'
+        | 'region'
+        | 'continent'
+        | 'utm_term'
+        | 'utm_content';
+
+      operator?: 'equals' | 'not_equals';
+
+      split?: Array<Rule.Split>;
 
-      operator: 'equals' | 'not_equals';
+      url?: string;
 
-      url: string;
+      value?: string;
+    }
+
+    export namespace Rule {
+      export interface Split {
+        url: string;
 
-      value: 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;
+
+      /**
+       * 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;
     }
 
     /**

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';