@codeqr/ts 0.9.0 → 0.24.0

package/src/resources/events.ts

@@ -131,9 +131,6 @@ export namespace EventListResponse {
        */
       id: string;
 
-      /**
-       * The Android destination URL for the short link for Android device targeting.
-       */
       android: string | null;
 
       /**
@@ -141,17 +138,10 @@ export namespace EventListResponse {
        */
       clicks: number;
 
-      /**
-       * The comments for the short link.
-       */
       comments: string | null;
 
       createdAt: string;
 
-      /**
-       * The description of the short link generated via `api.codeqr.io/metatags`. Will
-       * be used for custom link preview if `proxy` is true.
-       */
       description: string | null;
 
       /**
@@ -160,16 +150,8 @@ export namespace EventListResponse {
        */
       domain: string;
 
-      /**
-       * The URL to redirect to when the short link expires.
-       */
       expiredUrl: string | null;
 
-      /**
-       * This is the ID of the link in your database.
-       */
-      externalId: string | null;
-
       /**
        * Whether the link is filled or not.
        */
@@ -180,26 +162,12 @@ 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
-       */
       geo: { [key: string]: string } | null;
 
-      /**
-       * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
-       * for custom link preview if `proxy` is true.
-       */
       image: string | null;
 
-      /**
-       * The iOS destination URL for the short link for iOS device targeting.
-       */
       ios: string | null;
 
       /**
@@ -213,21 +181,13 @@ export namespace EventListResponse {
        */
       key: string;
 
-      lastClicked: string;
-
       /**
        * The number of leads generated by the short link.
        */
       leads: number;
 
-      /**
-       * The notification token of the short link.
-       */
       notificationToken: string | null;
 
-      /**
-       * The password required to access the short link destination URL.
-       */
       password: string | null;
 
       /**
@@ -250,62 +210,40 @@ export namespace EventListResponse {
        */
       sales: number;
 
-      /**
-       * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
-       * to the short link.
-       */
       tagId: string | null;
 
-      /**
-       * The tags assigned to the short link.
-       */
       tags: Array<TagsAPI.Tag> | null;
 
-      /**
-       * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
-       * for custom link preview if `proxy` is true.
-       */
       title: string | null;
 
       updatedAt: string;
 
-      userId: string | null;
-
       /**
-       * The UTM campaign of the short link.
+       * Whether this link should be used as a reusable template.
        */
+      useAsTemplate: boolean;
+
       utm_campaign: string | null;
 
-      /**
-       * The UTM content of the short link.
-       */
       utm_content: string | null;
 
-      /**
-       * The UTM medium of the short link.
-       */
       utm_medium: string | null;
 
-      /**
-       * The UTM source of the short link.
-       */
       utm_source: string | null;
 
-      /**
-       * The UTM term of the short link.
-       */
       utm_term: string | null;
 
-      /**
-       * The video of the short link.
-       */
       video: string | null;
 
       archived?: boolean;
 
       doIndex?: boolean;
 
-      expiresAt?: string;
+      expiresAt?: string | null;
+
+      externalId?: string | null;
+
+      lastClicked?: string | null;
 
       /**
        * The ID of the page to redirect to before the link destination.
@@ -329,6 +267,8 @@ export namespace EventListResponse {
 
       rewrite?: boolean;
 
+      rules?: Array<Link.Rule> | null;
+
       /**
        * The complete URL of the short link, including the https protocol (for example,
        * `https://codeqr.link/try`).
@@ -338,6 +278,27 @@ export namespace EventListResponse {
       trackConversion?: boolean;
 
       url?: string;
+
+      userId?: string | null;
+    }
+
+    export namespace Link {
+      export interface Rule {
+        attribute:
+          | 'device'
+          | 'country'
+          | 'utm_source'
+          | 'utm_medium'
+          | 'utm_campaign'
+          | 'referrer'
+          | 'language';
+
+        operator: 'equals' | 'not_equals';
+
+        url: string;
+
+        value: string;
+      }
     }
   }
 
@@ -666,9 +627,6 @@ export namespace EventListResponse {
        */
       id: string;
 
-      /**
-       * The Android destination URL for the short link for Android device targeting.
-       */
       android: string | null;
 
       /**
@@ -676,17 +634,10 @@ export namespace EventListResponse {
        */
       clicks: number;
 
-      /**
-       * The comments for the short link.
-       */
       comments: string | null;
 
       createdAt: string;
 
-      /**
-       * The description of the short link generated via `api.codeqr.io/metatags`. Will
-       * be used for custom link preview if `proxy` is true.
-       */
       description: string | null;
 
       /**
@@ -695,16 +646,8 @@ export namespace EventListResponse {
        */
       domain: string;
 
-      /**
-       * The URL to redirect to when the short link expires.
-       */
       expiredUrl: string | null;
 
-      /**
-       * This is the ID of the link in your database.
-       */
-      externalId: string | null;
-
       /**
        * Whether the link is filled or not.
        */
@@ -715,26 +658,12 @@ 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
-       */
       geo: { [key: string]: string } | null;
 
-      /**
-       * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
-       * for custom link preview if `proxy` is true.
-       */
       image: string | null;
 
-      /**
-       * The iOS destination URL for the short link for iOS device targeting.
-       */
       ios: string | null;
 
       /**
@@ -748,21 +677,13 @@ export namespace EventListResponse {
        */
       key: string;
 
-      lastClicked: string;
-
       /**
        * The number of leads generated by the short link.
        */
       leads: number;
 
-      /**
-       * The notification token of the short link.
-       */
       notificationToken: string | null;
 
-      /**
-       * The password required to access the short link destination URL.
-       */
       password: string | null;
 
       /**
@@ -785,62 +706,40 @@ export namespace EventListResponse {
        */
       sales: number;
 
-      /**
-       * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
-       * to the short link.
-       */
       tagId: string | null;
 
-      /**
-       * The tags assigned to the short link.
-       */
       tags: Array<TagsAPI.Tag> | null;
 
-      /**
-       * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
-       * for custom link preview if `proxy` is true.
-       */
       title: string | null;
 
       updatedAt: string;
 
-      userId: string | null;
-
       /**
-       * The UTM campaign of the short link.
+       * Whether this link should be used as a reusable template.
        */
+      useAsTemplate: boolean;
+
       utm_campaign: string | null;
 
-      /**
-       * The UTM content of the short link.
-       */
       utm_content: string | null;
 
-      /**
-       * The UTM medium of the short link.
-       */
       utm_medium: string | null;
 
-      /**
-       * The UTM source of the short link.
-       */
       utm_source: string | null;
 
-      /**
-       * The UTM term of the short link.
-       */
       utm_term: string | null;
 
-      /**
-       * The video of the short link.
-       */
       video: string | null;
 
       archived?: boolean;
 
       doIndex?: boolean;
 
-      expiresAt?: string;
+      expiresAt?: string | null;
+
+      externalId?: string | null;
+
+      lastClicked?: string | null;
 
       /**
        * The ID of the page to redirect to before the link destination.
@@ -864,6 +763,8 @@ export namespace EventListResponse {
 
       rewrite?: boolean;
 
+      rules?: Array<Link.Rule> | null;
+
       /**
        * The complete URL of the short link, including the https protocol (for example,
        * `https://codeqr.link/try`).
@@ -873,13 +774,34 @@ export namespace EventListResponse {
       trackConversion?: boolean;
 
       url?: string;
+
+      userId?: string | null;
+    }
+
+    export namespace Link {
+      export interface Rule {
+        attribute:
+          | 'device'
+          | 'country'
+          | 'utm_source'
+          | 'utm_medium'
+          | 'utm_campaign'
+          | 'referrer'
+          | 'language';
+
+        operator: 'equals' | 'not_equals';
+
+        url: string;
+
+        value: string;
+      }
     }
 
     export interface Sale {
       /**
-       * 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
+       * The amount of the sale in the smallest unit of `currency` — cents for
+       * two-decimal currencies, the full integer for zero-decimal ones (e.g. `1437`
+       * JPY), thousandths for three-decimal ones (e.g. `1437` KWD fils).
        */
       amount: number;
 
@@ -1030,6 +952,31 @@ export interface EventListParams {
    * The URL to retrieve analytics for.
    */
   url?: string;
+
+  /**
+   * UTM campaign to filter analytics by.
+   */
+  utm_campaign?: string;
+
+  /**
+   * UTM content to filter analytics by.
+   */
+  utm_content?: string;
+
+  /**
+   * UTM medium to filter analytics by.
+   */
+  utm_medium?: string;
+
+  /**
+   * UTM source to filter analytics by.
+   */
+  utm_source?: string;
+
+  /**
+   * UTM term to filter analytics by.
+   */
+  utm_term?: string;
 }
 
 export declare namespace Events {

package/src/resources/index.ts

@@ -13,8 +13,8 @@ export {
   type DomainListResponse,
   type DomainDeleteResponse,
   type DomainCreateParams,
-  type DomainUpdateParams,
   type DomainListParams,
+  type DomainUpdateParams,
 } from './domains';
 export { Events, type EventListResponse, type EventListParams } from './events';
 export {
@@ -22,13 +22,10 @@ export {
   type Link,
   type LinkListResponse,
   type LinkDeleteResponse,
-  type LinkCountResponse,
   type LinkCreateParams,
-  type LinkUpdateParams,
   type LinkListParams,
-  type LinkCountParams,
   type LinkRetrieveInfoParams,
-  type LinkUpsertParams,
+  type LinkUpdateParams,
 } from './links/links';
 export { Projects, type Project, type ProjectListResponse } from './projects';
 export {
@@ -36,13 +33,10 @@ export {
   type QrCode,
   type QrcodeListResponse,
   type QrcodeDeleteResponse,
-  type QrcodeCountResponse,
   type QrcodeCreateParams,
+  type QrcodeListParams,
   type QrcodeRetrieveParams,
   type QrcodeUpdateParams,
-  type QrcodeListParams,
-  type QrcodeCountParams,
-  type QrcodeUpsertParams,
 } from './qrcodes/qrcodes';
 export {
   Tags,
@@ -50,8 +44,8 @@ export {
   type TagListResponse,
   type TagDeleteResponse,
   type TagCreateParams,
-  type TagUpdateParams,
   type TagListParams,
+  type TagUpdateParams,
 } from './tags';
 export {
   Track,

package/src/resources/links/bulk.ts

@@ -21,21 +21,6 @@ export class Bulk extends APIResource {
     const { body } = params ?? {};
     return this._client.post('/links/bulk', { body: body, ...options });
   }
-
-  /**
-   * Bulk delete up to 100 links for the authenticated workspace.
-   *
-   * @example
-   * ```ts
-   * const bulk = await client.links.bulk.delete({
-   *   linkIds: ['clux0rgak00011...', 'clux0rgak00022...'],
-   * });
-   * ```
-   */
-  delete(params: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkDeleteResponse> {
-    const { linkIds } = params;
-    return this._client.delete('/links/bulk', { query: { linkIds }, ...options });
-  }
 }
 
 export type BulkCreateResponse = Array<LinksAPI.Link | BulkCreateResponse.LinkErrorSchema>;
@@ -56,7 +41,8 @@ export namespace BulkCreateResponse {
       | 'invite_pending'
       | 'exceeded_limit'
       | 'conflict'
-      | 'unprocessable_entity';
+      | 'unprocessable_entity'
+      | 'service_unavailable';
 
     /**
      * The error message.
@@ -70,13 +56,6 @@ export namespace BulkCreateResponse {
   }
 }
 
-export interface BulkDeleteResponse {
-  /**
-   * The number of links deleted.
-   */
-  deletedCount: number;
-}
-
 export interface BulkCreateParams {
   body?: Array<BulkCreateParams.Body>;
 }
@@ -219,6 +198,11 @@ export namespace BulkCreateParams {
      */
     rewrite?: boolean;
 
+    /**
+     * Smart rules for conditional destination routing by request attribute.
+     */
+    rules?: Array<Body.Rule> | null;
+
     /**
      * @deprecated The unique ID of the tag assigned to the short link. This field is
      * deprecated – use `tagIds` instead.
@@ -246,6 +230,11 @@ export namespace BulkCreateParams {
      */
     trackConversion?: boolean;
 
+    /**
+     * Whether this link should be used as a reusable template.
+     */
+    useAsTemplate?: boolean;
+
     /**
      * The video of the short link.
      */
@@ -764,22 +753,26 @@ export namespace BulkCreateParams {
 
       ZW?: string;
     }
-  }
-}
 
-export interface BulkDeleteParams {
-  /**
-   * Comma-separated list of link IDs to delete. Maximum of 100 IDs. Non-existing IDs
-   * will be ignored.
-   */
-  linkIds: Array<string>;
+    export interface Rule {
+      attribute:
+        | 'device'
+        | 'country'
+        | 'utm_source'
+        | 'utm_medium'
+        | 'utm_campaign'
+        | 'referrer'
+        | 'language';
+
+      operator: 'equals' | 'not_equals';
+
+      url: string;
+
+      value: 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/links/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 {
   Links,
   type Link,
   type LinkListResponse,
   type LinkDeleteResponse,
-  type LinkCountResponse,
   type LinkCreateParams,
-  type LinkUpdateParams,
   type LinkListParams,
-  type LinkCountParams,
   type LinkRetrieveInfoParams,
-  type LinkUpsertParams,
+  type LinkUpdateParams,
 } from './links';