@codeqr/ts 0.19.3 → 0.24.0

package/src/client.ts

@@ -221,6 +221,18 @@ export class Codeqr {
     this.fetch = options.fetch ?? Shims.getDefaultFetch();
     this.#encoder = Opts.FallbackEncoder;
 
+    const customHeadersEnv = readEnv('CODEQR_CUSTOM_HEADERS');
+    if (customHeadersEnv) {
+      const parsed: Record<string, string> = {};
+      for (const line of customHeadersEnv.split('\n')) {
+        const colon = line.indexOf(':');
+        if (colon >= 0) {
+          parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+        }
+      }
+      options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+    }
+
     this._options = options;
 
     this.apiKey = apiKey;
@@ -704,11 +716,19 @@ export class Codeqr {
     return () => controller.abort();
   }
 
-  private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
+  private buildBody({ options }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
   } {
+    const { body, headers: rawHeaders } = options;
     if (!body) {
+      // A resource method always passes a `body` key when its operation defines a
+      // request body, even if the caller omitted an optional body param. Keep the
+      // content-type for those, and only elide it for operations with no body at
+      // all (e.g. GET/DELETE).
+      if (body == null && 'body' in options) {
+        return this.#encoder({ body, headers: buildHeaders([rawHeaders]) });
+      }
       return { bodyHeaders: undefined, body: undefined };
     }
     const headers = buildHeaders([rawHeaders]);
@@ -796,9 +816,9 @@ export declare namespace Codeqr {
     type LinkListResponse as LinkListResponse,
     type LinkDeleteResponse as LinkDeleteResponse,
     type LinkCreateParams as LinkCreateParams,
-    type LinkUpdateParams as LinkUpdateParams,
     type LinkListParams as LinkListParams,
     type LinkRetrieveInfoParams as LinkRetrieveInfoParams,
+    type LinkUpdateParams as LinkUpdateParams,
   };
 
   export {
@@ -807,9 +827,9 @@ export declare namespace Codeqr {
     type QrcodeListResponse as QrcodeListResponse,
     type QrcodeDeleteResponse as QrcodeDeleteResponse,
     type QrcodeCreateParams as QrcodeCreateParams,
+    type QrcodeListParams as QrcodeListParams,
     type QrcodeRetrieveParams as QrcodeRetrieveParams,
     type QrcodeUpdateParams as QrcodeUpdateParams,
-    type QrcodeListParams as QrcodeListParams,
   };
 
   export {
@@ -832,8 +852,8 @@ export declare namespace Codeqr {
     type TagListResponse as TagListResponse,
     type TagDeleteResponse as TagDeleteResponse,
     type TagCreateParams as TagCreateParams,
-    type TagUpdateParams as TagUpdateParams,
     type TagListParams as TagListParams,
+    type TagUpdateParams as TagUpdateParams,
   };
 
   export {
@@ -842,8 +862,8 @@ export declare namespace Codeqr {
     type DomainListResponse as DomainListResponse,
     type DomainDeleteResponse as DomainDeleteResponse,
     type DomainCreateParams as DomainCreateParams,
-    type DomainUpdateParams as DomainUpdateParams,
     type DomainListParams as DomainListParams,
+    type DomainUpdateParams as DomainUpdateParams,
   };
 
   export {

package/src/internal/types.ts

@@ -40,7 +40,6 @@ type OverloadedParameters<T> =
   : T extends (...args: infer A) => unknown ? A
   : never;
 
-/* eslint-disable */
 /**
  * These imports attempt to get types from a parent package's dependencies.
  * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
@@ -63,19 +62,18 @@ type OverloadedParameters<T> =
  *
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
  */
-/** @ts-ignore For users with \@types/node */
+/** @ts-ignore For users with \@types/node */ /* prettier-ignore */
 type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
-/** @ts-ignore For users with undici */
+/** @ts-ignore For users with undici */ /* prettier-ignore */
 type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
-/** @ts-ignore For users with \@types/bun */
+/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */
 type BunRequestInit = globalThis.FetchRequestInit;
-/** @ts-ignore For users with node-fetch@2 */
+/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */
 type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
-/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
+/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */
 type NodeFetch3RequestInit =  NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
-/** @ts-ignore For users who use Deno */
+/** @ts-ignore For users who use Deno */ /* prettier-ignore */
 type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
-/* eslint-enable */
 
 type RequestInits =
   | NotAny<UndiciTypesRequestInit>

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/internal/utils/log.ts

@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'api-key' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/resources/analytics.ts

@@ -679,7 +679,7 @@ export namespace AnalyticsRetrieveResponse {
     clicks: number;
 
     /**
-     * The 2-letter country code of the region: https://d.to/geo
+     * The 2-letter ISO 3166-1 alpha-2 country code of the region.
      */
     country:
       | 'AF'
@@ -1532,7 +1532,12 @@ export interface AnalyticsRetrieveParams {
     | 'cities'
     | 'leads'
     | 'sales'
-    | 'composite';
+    | 'composite'
+    | 'utm_sources'
+    | 'utm_mediums'
+    | 'utm_campaigns'
+    | 'utm_contents'
+    | 'utm_terms';
 
   /**
    * The interval to retrieve analytics for. Takes precedence over start and end.
@@ -1605,6 +1610,31 @@ export interface AnalyticsRetrieveParams {
    * 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 Analytics {

package/src/resources/domains.ts

@@ -21,34 +21,34 @@ export class Domains extends APIResource {
   }
 
   /**
-   * Update a domain for the authenticated workspace.
+   * Retrieve a list of domains associated with the authenticated workspace.
    *
    * @example
    * ```ts
-   * const domain = await client.domains.update('acme.com');
+   * const domains = await client.domains.list();
    * ```
    */
-  update(
-    slug: string,
-    body: DomainUpdateParams | null | undefined = {},
+  list(
+    query: DomainListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<Domain> {
-    return this._client.patch(path`/domains/${slug}`, { body, ...options });
+  ): APIPromise<DomainListResponse> {
+    return this._client.get('/domains', { query, ...options });
   }
 
   /**
-   * Retrieve a list of domains associated with the authenticated workspace.
+   * Update a domain for the authenticated workspace.
    *
    * @example
    * ```ts
-   * const domains = await client.domains.list();
+   * const domain = await client.domains.update('acme.com');
    * ```
    */
-  list(
-    query: DomainListParams | null | undefined = {},
+  update(
+    slug: string,
+    body: DomainUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<DomainListResponse> {
-    return this._client.get('/domains', { query, ...options });
+  ): APIPromise<Domain> {
+    return this._client.patch(path`/domains/${slug}`, { body, ...options });
   }
 
   /**
@@ -166,6 +166,29 @@ export interface DomainCreateParams {
   type?: 'redirect' | 'rewrite';
 }
 
+export interface DomainListParams {
+  /**
+   * Whether to include archived domains in the response. Defaults to `false` if not
+   * provided.
+   */
+  archived?: boolean;
+
+  /**
+   * The page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number;
+
+  /**
+   * The search term to filter the domains by.
+   */
+  search?: string;
+}
+
 export interface DomainUpdateParams {
   /**
    * Whether to archive this domain. `false` will unarchive a previously archived
@@ -200,36 +223,13 @@ export interface DomainUpdateParams {
   type?: 'redirect' | 'rewrite';
 }
 
-export interface DomainListParams {
-  /**
-   * Whether to include archived domains in the response. Defaults to `false` if not
-   * provided.
-   */
-  archived?: boolean;
-
-  /**
-   * The page number for pagination.
-   */
-  page?: number;
-
-  /**
-   * The number of items per page.
-   */
-  pageSize?: number;
-
-  /**
-   * The search term to filter the domains by.
-   */
-  search?: string;
-}
-
 export declare namespace Domains {
   export {
     type Domain as Domain,
     type DomainListResponse as DomainListResponse,
     type DomainDeleteResponse as DomainDeleteResponse,
     type DomainCreateParams as DomainCreateParams,
-    type DomainUpdateParams as DomainUpdateParams,
     type DomainListParams as DomainListParams,
+    type DomainUpdateParams as DomainUpdateParams,
   };
 }

package/src/resources/events.ts

@@ -218,6 +218,11 @@ export namespace EventListResponse {
 
       updatedAt: string;
 
+      /**
+       * Whether this link should be used as a reusable template.
+       */
+      useAsTemplate: boolean;
+
       utm_campaign: string | null;
 
       utm_content: string | null;
@@ -262,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`).
@@ -274,6 +281,25 @@ export namespace EventListResponse {
 
       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 LeadEvent {
@@ -688,6 +714,11 @@ export namespace EventListResponse {
 
       updatedAt: string;
 
+      /**
+       * Whether this link should be used as a reusable template.
+       */
+      useAsTemplate: boolean;
+
       utm_campaign: string | null;
 
       utm_content: string | null;
@@ -732,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`).
@@ -745,11 +778,30 @@ export namespace EventListResponse {
       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;
 
@@ -900,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 {
@@ -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 TagUpdateParams,
   type TagListParams,
+  type TagUpdateParams,
 } from './tags';
 export {
   Track,

package/src/resources/links/bulk.ts

@@ -198,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.
@@ -748,6 +753,23 @@ export namespace BulkCreateParams {
 
       ZW?: string;
     }
+
+    export interface Rule {
+      attribute:
+        | 'device'
+        | 'country'
+        | 'utm_source'
+        | 'utm_medium'
+        | 'utm_campaign'
+        | 'referrer'
+        | 'language';
+
+      operator: 'equals' | 'not_equals';
+
+      url: string;
+
+      value: string;
+    }
   }
 }
 

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