@codeqr/ts 0.9.0 → 0.24.0

package/src/resources/projects.ts

@@ -3,16 +3,8 @@
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
 
 export class Projects extends APIResource {
-  /**
-   * Retrieve a project for the authenticated user.
-   */
-  retrieve(projectSlug: string, options?: RequestOptions): APIPromise<Project> {
-    return this._client.get(path`/projects/${projectSlug}`, options);
-  }
-
   /**
    * Retrieve a list of projects for the authenticated user.
    */

package/src/resources/qrcodes/bulk.ts

@@ -21,21 +21,6 @@ export class Bulk extends APIResource {
     const { body } = params ?? {};
     return this._client.post('/qrcodes/bulk', { body: body, ...options });
   }
-
-  /**
-   * Bulk delete up to 100 QR Codes for the authenticated workspace.
-   *
-   * @example
-   * ```ts
-   * const bulk = await client.qrcodes.bulk.delete({
-   *   qrcodeIds: ['clux0rgak00011...', 'clux0rgak00022...'],
-   * });
-   * ```
-   */
-  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkDeleteResponse> {
-    const { qrcodeIds } = params;
-    return this._client.delete('/qrcodes/bulk', { query: { qrcodeIds }, ...options });
-  }
 }
 
 export type BulkCreateResponse = Array<QrcodesAPI.QrCode | BulkCreateResponse.QrCodeErrorSchema>;
@@ -56,7 +41,8 @@ export namespace BulkCreateResponse {
       | 'invite_pending'
       | 'exceeded_limit'
       | 'conflict'
-      | 'unprocessable_entity';
+      | 'unprocessable_entity'
+      | 'service_unavailable';
 
     /**
      * The error message.
@@ -70,28 +56,29 @@ export namespace BulkCreateResponse {
   }
 }
 
-export interface BulkDeleteResponse {
-  /**
-   * The number of QR Codes deleted.
-   */
-  deletedCount: number;
-}
-
 export interface BulkCreateParams {
   body?: Array<BulkCreateParams.Body>;
 }
 
 export namespace BulkCreateParams {
   export interface Body {
-    /**
-     * 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.
@@ -104,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;
 
@@ -175,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;
 
@@ -190,20 +179,46 @@ export namespace BulkCreateParams {
     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?: Body.FrameTextStyles | null;
+
     /**
      * Geographic segmentation information for the QR code in the JSON format
      * `{[COUNTRY]: https://example.com }`.
@@ -211,7 +226,8 @@ export namespace BulkCreateParams {
     geo?: Body.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;
 
@@ -277,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.
      */
@@ -297,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).
      */
@@ -343,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.
      */
@@ -364,6 +398,18 @@ export namespace BulkCreateParams {
      */
     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.
      */
@@ -376,7 +422,14 @@ export namespace BulkCreateParams {
     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?: 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).
      */
     width?: number;
 
@@ -387,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 }`.
@@ -892,22 +979,36 @@ export namespace BulkCreateParams {
 
       ZW?: string;
     }
-  }
-}
 
-export interface BulkDeleteParams {
-  /**
-   * Comma-separated list of QR Code IDs to delete. Maximum of 100 IDs. Non-existing
-   * IDs will be ignored.
-   */
-  qrcodeIds: Array<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 declare namespace Bulk {
-  export {
-    type BulkCreateResponse as BulkCreateResponse,
-    type BulkDeleteResponse as BulkDeleteResponse,
-    type BulkCreateParams as BulkCreateParams,
-    type BulkDeleteParams as BulkDeleteParams,
-  };
+  export { type BulkCreateResponse as BulkCreateResponse, type BulkCreateParams as BulkCreateParams };
 }

package/src/resources/qrcodes/index.ts

@@ -1,22 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Bulk,
-  type BulkCreateResponse,
-  type BulkDeleteResponse,
-  type BulkCreateParams,
-  type BulkDeleteParams,
-} from './bulk';
+export { Bulk, type BulkCreateResponse, type BulkCreateParams } from './bulk';
 export {
   Qrcodes,
   type QrCode,
   type QrcodeListResponse,
   type QrcodeDeleteResponse,
-  type QrcodeCountResponse,
   type QrcodeCreateParams,
+  type QrcodeListParams,
   type QrcodeRetrieveParams,
   type QrcodeUpdateParams,
-  type QrcodeListParams,
-  type QrcodeCountParams,
-  type QrcodeUpsertParams,
 } from './qrcodes';