@codeqr/ts 0.3.0 → 0.4.0

package/resources/track.js

@@ -10,8 +10,8 @@ class Track extends resource_1.APIResource {
      * @example
      * ```ts
      * const response = await client.track.trackLead({
-     *   clickId: 'x',
-     *   customerId: 'x',
+     *   clickId: 'clickId',
+     *   customerExternalId: 'x',
      *   eventName: 'Sign up',
      * });
      * ```
@@ -25,9 +25,8 @@ class Track extends resource_1.APIResource {
      * @example
      * ```ts
      * const response = await client.track.trackSale({
-     *   amount: 1,
-     *   customerId: 'x',
-     *   paymentProcessor: 'stripe',
+     *   amount: 0,
+     *   customerExternalId: 'x',
      * });
      * ```
      */

package/resources/track.js.map

@@ -1 +1 @@
-{"version":3,"file":"track.js","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAhCD,sBAgCC"}
+{"version":3,"file":"track.js","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AA/BD,sBA+BC"}

package/resources/track.mjs

@@ -7,8 +7,8 @@ export class Track extends APIResource {
      * @example
      * ```ts
      * const response = await client.track.trackLead({
-     *   clickId: 'x',
-     *   customerId: 'x',
+     *   clickId: 'clickId',
+     *   customerExternalId: 'x',
      *   eventName: 'Sign up',
      * });
      * ```
@@ -22,9 +22,8 @@ export class Track extends APIResource {
      * @example
      * ```ts
      * const response = await client.track.trackSale({
-     *   amount: 1,
-     *   customerId: 'x',
-     *   paymentProcessor: 'stripe',
+     *   amount: 0,
+     *   customerExternalId: 'x',
      * });
      * ```
      */

package/resources/track.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"track.mjs","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}
+{"version":3,"file":"track.mjs","sourceRoot":"","sources":["../src/resources/track.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CAAC,IAA0B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF"}

package/src/internal/to-file.ts

@@ -73,7 +73,7 @@ export type ToFileInput =
 
 /**
  * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats
- * @param value the raw content of the file.  Can be an {@link Uploadable}, {@link BlobLikePart}, or {@link AsyncIterable} of {@link BlobLikePart}s
+ * @param value the raw content of the file. Can be an {@link Uploadable}, BlobLikePart, or AsyncIterable of BlobLikeParts
  * @param {string=} name the name of the file. If omitted, toFile will try to determine a file name from bits if possible
  * @param {Object=} options additional properties
  * @param {string=} options.type the MIME type of the content

package/src/resources/events.ts

@@ -180,6 +180,11 @@ export namespace EventListResponse {
        */
       flexible: boolean;
 
+      /**
+       * The unique ID of the folder assigned to the short link.
+       */
+      folderId: string | null;
+
       /**
        * Geographic targeting information for the short link in JSON format
        * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
@@ -710,6 +715,11 @@ export namespace EventListResponse {
        */
       flexible: boolean;
 
+      /**
+       * The unique ID of the folder assigned to the short link.
+       */
+      folderId: string | null;
+
       /**
        * Geographic targeting information for the short link in JSON format
        * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
@@ -867,19 +877,22 @@ export namespace EventListResponse {
 
     export interface Sale {
       /**
-       * The amount of the sale. Should be passed in cents.
+       * The amount of the sale in cents (for all two-decimal currencies). If the sale is
+       * in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn
+       * more: https://d.to/currency
        */
       amount: number;
 
       /**
-       * The invoice ID of the sale.
+       * The invoice ID of the sale. Can be used as a idempotency key – only one sale
+       * event can be recorded for a given invoice ID.
        */
       invoiceId: string | null;
 
       /**
        * The payment processor via which the sale was made.
        */
-      paymentProcessor: 'stripe' | 'shopify' | 'paddle';
+      paymentProcessor: 'stripe' | 'shopify' | 'polar' | 'paddle' | 'revenuecat' | 'custom' | 'manual';
     }
   }
 }

package/src/resources/links/bulk.ts

@@ -144,6 +144,11 @@ export namespace BulkCreateParams {
      */
     flexible?: boolean;
 
+    /**
+     * The unique ID existing folder to assign the short link to.
+     */
+    folderId?: string | null;
+
     /**
      * Geographic targeting information for the short link in JSON format
      * `{[COUNTRY]: https://example.com }`.

package/src/resources/links/links.ts

@@ -191,6 +191,11 @@ export interface Link {
    */
   flexible: boolean;
 
+  /**
+   * The unique ID of the folder assigned to the short link.
+   */
+  folderId: string | null;
+
   /**
    * Geographic targeting information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
@@ -440,6 +445,11 @@ export interface LinkCreateParams {
    */
   flexible?: boolean;
 
+  /**
+   * The unique ID existing folder to assign the short link to.
+   */
+  folderId?: string | null;
+
   /**
    * Geographic targeting information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`.
@@ -1114,6 +1124,11 @@ export interface LinkUpdateParams {
    */
   flexible?: boolean;
 
+  /**
+   * The unique ID existing folder to assign the short link to.
+   */
+  folderId?: string | null;
+
   /**
    * Geographic targeting information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`.
@@ -1789,6 +1804,11 @@ export interface LinkListParams {
    */
   expiresBefore?: string;
 
+  /**
+   * The folder ID to filter the links by.
+   */
+  folderId?: string;
+
   /**
    * Geographic segmentation information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`.
@@ -2478,6 +2498,11 @@ export interface LinkCountParams {
    */
   expiresBefore?: string;
 
+  /**
+   * The folder ID to filter the links by.
+   */
+  folderId?: string;
+
   /**
    * Geographic segmentation information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`.
@@ -2487,7 +2512,7 @@ export interface LinkCountParams {
   /**
    * The field to group the links by.
    */
-  groupBy?: 'domain' | 'tagId' | 'userId';
+  groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
 
   /**
    * Filter links that have comments (any comments)
@@ -3191,6 +3216,11 @@ export interface LinkUpsertParams {
    */
   flexible?: boolean;
 
+  /**
+   * The unique ID existing folder to assign the short link to.
+   */
+  folderId?: string | null;
+
   /**
    * Geographic targeting information for the short link in JSON format
    * `{[COUNTRY]: https://example.com }`.

package/src/resources/qrcodes/bulk.ts

@@ -83,6 +83,11 @@ export interface BulkCreateParams {
 
 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.
      */

package/src/resources/qrcodes/qrcodes.ts

@@ -16,7 +16,10 @@ export class Qrcodes extends APIResource {
    *
    * @example
    * ```ts
-   * const qrCode = await client.qrcodes.create({ type: 'url' });
+   * const qrCode = await client.qrcodes.create({
+   *   folderId: 'folderId',
+   *   type: 'url',
+   * });
    * ```
    */
   create(body: QrcodeCreateParams, options?: RequestOptions): APIPromise<QrCode> {
@@ -105,7 +108,10 @@ export class Qrcodes extends APIResource {
    *
    * @example
    * ```ts
-   * const qrCode = await client.qrcodes.upsert({ type: 'url' });
+   * const qrCode = await client.qrcodes.upsert({
+   *   folderId: 'folderId',
+   *   type: 'url',
+   * });
    * ```
    */
   upsert(body: QrcodeUpsertParams, options?: RequestOptions): APIPromise<QrCode> {
@@ -217,6 +223,11 @@ export interface QrCode {
    */
   flexible: boolean;
 
+  /**
+   * The unique ID of the folder assigned to the QR code.
+   */
+  folderId: string | null;
+
   /**
    * Geographic segmentation information for the QR code in the JSON format
    * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
@@ -479,6 +490,11 @@ export interface QrcodeDeleteResponse {
 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.
    */
@@ -1413,6 +1429,11 @@ export interface QrcodeUpdateParams {
    */
   flexible?: boolean;
 
+  /**
+   * The unique ID of the folder assigned to the QR code.
+   */
+  folderId?: string | null;
+
   /**
    * The type of frame of the QR code.
    */
@@ -2161,6 +2182,11 @@ export interface QrcodeListParams {
    */
   expiresBefore?: string;
 
+  /**
+   * The folder ID to filter the QR codes by.
+   */
+  folderId?: string;
+
   /**
    * Filter by QR code format - static or dynamic
    */
@@ -2342,6 +2368,11 @@ export interface QrcodeCountParams {
    */
   expiresBefore?: string;
 
+  /**
+   * The folder ID to filter the QR codes by.
+   */
+  folderId?: string;
+
   /**
    * Filter by QR code format - static or dynamic
    */
@@ -2350,7 +2381,7 @@ export interface QrcodeCountParams {
   /**
    * The field to group the QR codes.
    */
-  groupBy?: 'domain' | 'tagId' | 'userId';
+  groupBy?: 'domain' | 'tagId' | 'userId' | 'folderId';
 
   /**
    * Filter QR codes with/without comments
@@ -2475,6 +2506,11 @@ export interface QrcodeCountParams {
 }
 
 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.
    */

package/src/resources/track.ts

@@ -11,8 +11,8 @@ export class Track extends APIResource {
    * @example
    * ```ts
    * const response = await client.track.trackLead({
-   *   clickId: 'x',
-   *   customerId: 'x',
+   *   clickId: 'clickId',
+   *   customerExternalId: 'x',
    *   eventName: 'Sign up',
    * });
    * ```
@@ -27,9 +27,8 @@ export class Track extends APIResource {
    * @example
    * ```ts
    * const response = await client.track.trackSale({
-   *   amount: 1,
-   *   customerId: 'x',
-   *   paymentProcessor: 'stripe',
+   *   amount: 0,
+   *   customerExternalId: 'x',
    * });
    * ```
    */
@@ -78,79 +77,135 @@ export interface TrackTrackSaleResponse {
 
 export interface TrackTrackLeadParams {
   /**
-   * The ID of the click in th CodeQR. You can read this value from `cq_id` cookie.
+   * The unique ID of the click that the lead conversion event is attributed to. You
+   * can read this value from `cd_id` cookie. If an empty string is provided, CodeQR
+   * will try to find an existing customer with the provided `customerExternalId` and
+   * use the `clickId` from the customer if found.
    */
   clickId: string;
 
   /**
-   * This is the unique identifier for the customer in the client's app. This is used
-   * to track the customer's journey.
+   * The unique ID of the customer in your system. Will be used to identify and
+   * attribute all future events to this customer.
    */
-  customerId: string;
+  customerExternalId: string;
 
   /**
-   * The name of the event to track.
+   * The name of the lead event to track. Can also be used as a unique identifier to
+   * associate a given lead event for a customer for a subsequent sale event (via the
+   * `leadEventName` prop in `/track/sale`).
    */
   eventName: string;
 
   /**
-   * Avatar of the customer in the client's app.
+   * The avatar URL of the customer.
    */
   customerAvatar?: string | null;
 
   /**
-   * Email of the customer in the client's app.
+   * The email address of the customer.
    */
   customerEmail?: string | null;
 
   /**
-   * Name of the customer in the client's app.
+   * The name of the customer. If not passed, a random name will be generated (e.g.
+   * “Big Red Caribou”).
    */
   customerName?: string | null;
 
   /**
-   * Additional metadata to be stored with the lead event
+   * The numerical value associated with this lead event (e.g., number of provisioned
+   * seats in a free trial). If defined as N, the lead event will be tracked N times.
+   */
+  eventQuantity?: number | null;
+
+  /**
+   * Additional metadata to be stored with the lead event. Max 10,000 characters.
    */
   metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * The mode to use for tracking the lead event. `async` will not block the request;
+   * `wait` will block the request until the lead event is fully recorded in Dub;
+   * `deferred` will defer the lead event creation to a subsequent request.
+   */
+  mode?: 'async' | 'wait' | 'deferred';
 }
 
 export interface TrackTrackSaleParams {
   /**
-   * The amount of the sale. Should be passed in cents.
+   * The amount of the sale in cents (for all two-decimal currencies). If the sale is
+   * in a zero-decimal currency, pass the full integer value (e.g. `1437` JPY). Learn
+   * more: https://d.to/currency
    */
   amount: number;
 
   /**
-   * This is the unique identifier for the customer in the client's app. This is used
-   * to track the customer's journey.
+   * The unique ID of the customer in your system. Will be used to identify and
+   * attribute all future events to this customer.
    */
-  customerId: string;
+  customerExternalId: string;
 
   /**
-   * The payment processor via which the sale was made.
+   * [For direct sale tracking]: The unique ID of the click that the sale conversion
+   * event is attributed to. You can read this value from `dub_id` cookie.
    */
-  paymentProcessor: 'stripe' | 'shopify' | 'paddle';
+  clickId?: string | null;
 
   /**
-   * The currency of the sale. Accepts ISO 4217 currency codes.
+   * The currency of the sale. Accepts ISO 4217 currency codes. Sales will be
+   * automatically converted and stored as USD at the latest exchange rates. Learn
+   * more: https://d.to/currency
    */
   currency?: string;
 
   /**
-   * The name of the sale event. It can be used to track different types of event for
-   * example 'Purchase', 'Upgrade', 'Payment', etc.
+   * [For direct sale tracking]: The avatar URL of the customer.
+   */
+  customerAvatar?: string | null;
+
+  /**
+   * [For direct sale tracking]: The email address of the customer.
+   */
+  customerEmail?: string | null;
+
+  /**
+   * [For direct sale tracking]: The name of the customer. If not passed, a random
+   * name will be generated (e.g. “Big Red Caribou”).
+   */
+  customerName?: string | null;
+
+  /**
+   * The name of the sale event. Recommended format: `Invoice paid` or
+   * `Subscription created`.
    */
   eventName?: string;
 
   /**
-   * The invoice ID of the sale.
+   * The invoice ID of the sale. Can be used as a idempotency key – only one sale
+   * event can be recorded for a given invoice ID.
    */
   invoiceId?: string | null;
 
   /**
-   * Additional metadata to be stored with the sale event.
+   * The name of the lead event that occurred before the sale (case-sensitive). This
+   * is used to associate the sale event with a particular lead event (instead of the
+   * latest lead event for a link-customer combination, which is the default
+   * behavior). For direct sale tracking, this field can also be used to specify the
+   * lead event name.
+   */
+  leadEventName?: string | null;
+
+  /**
+   * Additional metadata to be stored with the sale event. Max 10,000 characters when
+   * stringified.
    */
   metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * The payment processor via which the sale was made.
+   */
+  paymentProcessor?: 'stripe' | 'shopify' | 'polar' | 'paddle' | 'revenuecat' | 'custom' | 'manual';
 }
 
 export declare namespace Track {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.0'; // x-release-please-version
+exports.VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map