@codeqr/ts 0.24.1 → 0.25.0

package/src/resources/events.ts

@@ -284,20 +284,35 @@ export namespace EventListResponse {
 
     export namespace Link {
       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';
+        operator?: 'equals' | 'not_equals';
 
-        url: string;
+        split?: Array<Rule.Split>;
 
-        value: string;
+        url?: string;
+
+        value?: string;
+      }
+
+      export namespace Rule {
+        export interface Split {
+          url: string;
+
+          weight: number;
+        }
       }
     }
   }
@@ -508,6 +523,8 @@ export namespace EventListResponse {
      */
     saleAmount: number;
 
+    timestamp: string;
+
     /**
      * @deprecated Deprecated. Use `click.qr` instead.
      */
@@ -517,8 +534,6 @@ export namespace EventListResponse {
      * @deprecated Deprecated. Use `click.url` instead.
      */
     url: string;
-
-    timestamp?: string;
   }
 
   export namespace SaleEvent {
@@ -549,76 +564,13 @@ export namespace EventListResponse {
     }
 
     export interface Customer {
-      /**
-       * The unique ID of the customer. You may use either the customer's `id` on CodeQR
-       * (obtained via `/customers` endpoint) or their `externalId` (unique ID within
-       * your system, prefixed with `ext_`, e.g. `ext_123`).
-       */
       id: string;
 
-      /**
-       * The date the customer was created.
-       */
-      createdAt: string;
+      avatar: string;
 
-      /**
-       * Unique identifier for the customer in the client's app.
-       */
-      externalId: string;
+      email: string;
 
-      /**
-       * Name of the customer.
-       */
       name: string;
-
-      /**
-       * Avatar URL of the customer.
-       */
-      avatar?: string | null;
-
-      /**
-       * Country of the customer.
-       */
-      country?: string | null;
-
-      /**
-       * Custom fields of the customer.
-       */
-      customFields?: { [key: string]: string } | null;
-
-      /**
-       * Email of the customer.
-       */
-      email?: string | null;
-
-      link?: Customer.Link | null;
-    }
-
-    export namespace Customer {
-      export interface Link {
-        /**
-         * The unique ID of the short link.
-         */
-        id: string;
-
-        /**
-         * The domain of the short link. If not provided, the main domain of the project
-         * will be used (or `codeqr.link` if the project has no domains).
-         */
-        domain: string;
-
-        /**
-         * The slug of the short link. If not provided, a random 7-character slug will be
-         * generated.
-         */
-        key: string;
-
-        /**
-         * The complete URL of the short link, including the https protocol (for example,
-         * `https://codeqr.link/try`).
-         */
-        shortLink?: string;
-      }
     }
 
     export interface Link {
@@ -780,20 +732,35 @@ export namespace EventListResponse {
 
     export namespace Link {
       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';
 
-        operator: 'equals' | 'not_equals';
+        split?: Array<Rule.Split>;
 
-        url: string;
+        url?: string;
 
-        value: string;
+        value?: string;
+      }
+
+      export namespace Rule {
+        export interface Split {
+          url: string;
+
+          weight: number;
+        }
       }
     }
 
@@ -811,10 +778,7 @@ export namespace EventListResponse {
        */
       invoiceId: string | null;
 
-      /**
-       * The payment processor via which the sale was made.
-       */
-      paymentProcessor: 'stripe' | 'shopify' | 'polar' | 'paddle' | 'revenuecat' | 'custom' | 'manual';
+      paymentProcessor: string;
     }
   }
 }
@@ -949,7 +913,9 @@ export interface EventListParams {
   types?: string;
 
   /**
-   * The URL to retrieve analytics for.
+   * The destination URL to retrieve analytics for. Match it without the query params
+   * CodeQR copies off the click (UTM and ad click IDs such as fbclid or gclid):
+   * those differ per visitor, so a URL carrying them matches at most one click.
    */
   url?: string;
 

package/src/resources/index.ts

@@ -13,8 +13,8 @@ export {
   type DomainListResponse,
   type DomainDeleteResponse,
   type DomainCreateParams,
-  type DomainListParams,
   type DomainUpdateParams,
+  type DomainListParams,
 } from './domains';
 export { Events, type EventListResponse, type EventListParams } from './events';
 export {
@@ -23,9 +23,9 @@ export {
   type LinkListResponse,
   type LinkDeleteResponse,
   type LinkCreateParams,
+  type LinkUpdateParams,
   type LinkListParams,
   type LinkRetrieveInfoParams,
-  type LinkUpdateParams,
 } from './links/links';
 export { Projects, type Project, type ProjectListResponse } from './projects';
 export {
@@ -34,9 +34,9 @@ export {
   type QrcodeListResponse,
   type QrcodeDeleteResponse,
   type QrcodeCreateParams,
-  type QrcodeListParams,
   type QrcodeRetrieveParams,
   type QrcodeUpdateParams,
+  type QrcodeListParams,
 } from './qrcodes/qrcodes';
 export {
   Tags,
@@ -44,8 +44,8 @@ export {
   type TagListResponse,
   type TagDeleteResponse,
   type TagCreateParams,
-  type TagListParams,
   type TagUpdateParams,
+  type TagListParams,
 } from './tags';
 export {
   Track,

package/src/resources/links/bulk.ts

@@ -73,7 +73,8 @@ export namespace BulkCreateParams {
     android?: string | null;
 
     /**
-     * Whether the short link is archived.
+     * Whether the short link is archived. Archiving hides it from the default
+     * dashboard listing; the link keeps redirecting and keeps counting clicks.
      */
     archived?: boolean;
 
@@ -216,6 +217,7 @@ export namespace BulkCreateParams {
 
     /**
      * The unique name of the tags assigned to the short link (case insensitive).
+     * Ignored when `tagIds` is also present.
      */
     tagNames?: string | Array<string>;
 
@@ -755,20 +757,35 @@ 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';
+      operator?: 'equals' | 'not_equals';
 
-      url: string;
+      split?: Array<Rule.Split>;
 
-      value: string;
+      url?: string;
+
+      value?: string;
+    }
+
+    export namespace Rule {
+      export interface Split {
+        url: string;
+
+        weight: number;
+      }
     }
   }
 }

package/src/resources/links/index.ts

@@ -7,7 +7,7 @@ export {
   type LinkListResponse,
   type LinkDeleteResponse,
   type LinkCreateParams,
+  type LinkUpdateParams,
   type LinkListParams,
   type LinkRetrieveInfoParams,
-  type LinkUpdateParams,
 } from './links';