@codeqr/ts 0.24.1 → 0.25.0

package/src/client.ts

@@ -160,9 +160,9 @@ export interface ClientOptions {
 }
 
 /**
- * API Client for interfacing with the Codeqr API.
+ * API Client for interfacing with the CodeQR API.
  */
-export class Codeqr {
+export class CodeQR {
   apiKey: string;
 
   baseURL: string;
@@ -178,7 +178,7 @@ export class Codeqr {
   private _options: ClientOptions;
 
   /**
-   * API Client for interfacing with the Codeqr API.
+   * API Client for interfacing with the CodeQR API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['CODEQR_API_KEY'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['CODEQR_BASE_URL'] ?? https://api.codeqr.io] - Override the default base URL for the API.
@@ -195,8 +195,8 @@ export class Codeqr {
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
-      throw new Errors.CodeqrError(
-        "The CODEQR_API_KEY environment variable is missing or empty; either provide it, or instantiate the Codeqr client with an apiKey option, like new Codeqr({ apiKey: 'My API Key' }).",
+      throw new Errors.CodeQRError(
+        "The CODEQR_API_KEY environment variable is missing or empty; either provide it, or instantiate the CodeQR client with an apiKey option, like new CodeQR({ apiKey: 'My API Key' }).",
       );
     }
 
@@ -207,7 +207,7 @@ export class Codeqr {
     };
 
     this.baseURL = options.baseURL!;
-    this.timeout = options.timeout ?? Codeqr.DEFAULT_TIMEOUT /* 1 minute */;
+    this.timeout = options.timeout ?? CodeQR.DEFAULT_TIMEOUT /* 1 minute */;
     this.logger = options.logger ?? console;
     const defaultLogLevel = 'warn';
     // Set default logLevel early so that we can log a warning in parseLogLevel.
@@ -769,10 +769,10 @@ export class Codeqr {
     }
   }
 
-  static Codeqr = this;
+  static CodeQR = this;
   static DEFAULT_TIMEOUT = 60000; // 1 minute
 
-  static CodeqrError = Errors.CodeqrError;
+  static CodeQRError = Errors.CodeQRError;
   static APIError = Errors.APIError;
   static APIConnectionError = Errors.APIConnectionError;
   static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
@@ -798,16 +798,16 @@ export class Codeqr {
   projects: API.Projects = new API.Projects(this);
 }
 
-Codeqr.Links = Links;
-Codeqr.Qrcodes = Qrcodes;
-Codeqr.Analytics = Analytics;
-Codeqr.Events = Events;
-Codeqr.Tags = Tags;
-Codeqr.Domains = Domains;
-Codeqr.Track = Track;
-Codeqr.Projects = Projects;
+CodeQR.Links = Links;
+CodeQR.Qrcodes = Qrcodes;
+CodeQR.Analytics = Analytics;
+CodeQR.Events = Events;
+CodeQR.Tags = Tags;
+CodeQR.Domains = Domains;
+CodeQR.Track = Track;
+CodeQR.Projects = Projects;
 
-export declare namespace Codeqr {
+export declare namespace CodeQR {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
@@ -816,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 {
@@ -827,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 {
@@ -852,8 +852,8 @@ export declare namespace Codeqr {
     type TagListResponse as TagListResponse,
     type TagDeleteResponse as TagDeleteResponse,
     type TagCreateParams as TagCreateParams,
-    type TagListParams as TagListParams,
     type TagUpdateParams as TagUpdateParams,
+    type TagListParams as TagListParams,
   };
 
   export {
@@ -862,8 +862,8 @@ export declare namespace Codeqr {
     type DomainListResponse as DomainListResponse,
     type DomainDeleteResponse as DomainDeleteResponse,
     type DomainCreateParams as DomainCreateParams,
-    type DomainListParams as DomainListParams,
     type DomainUpdateParams as DomainUpdateParams,
+    type DomainListParams as DomainListParams,
   };
 
   export {

package/src/core/api-promise.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { type Codeqr } from '../client';
+import { type CodeQR } from '../client';
 
 import { type PromiseOrValue } from '../internal/types';
 import { APIResponseProps, defaultParseResponse } from '../internal/parse';
@@ -11,13 +11,13 @@ import { APIResponseProps, defaultParseResponse } from '../internal/parse';
  */
 export class APIPromise<T> extends Promise<T> {
   private parsedPromise: Promise<T> | undefined;
-  #client: Codeqr;
+  #client: CodeQR;
 
   constructor(
-    client: Codeqr,
+    client: CodeQR,
     private responsePromise: Promise<APIResponseProps>,
     private parseResponse: (
-      client: Codeqr,
+      client: CodeQR,
       props: APIResponseProps,
     ) => PromiseOrValue<T> = defaultParseResponse,
   ) {

package/src/core/error.ts

@@ -2,13 +2,13 @@
 
 import { castToError } from '../internal/errors';
 
-export class CodeqrError extends Error {}
+export class CodeQRError extends Error {}
 
 export class APIError<
   TStatus extends number | undefined = number | undefined,
   THeaders extends Headers | undefined = Headers | undefined,
   TError extends Object | undefined = Object | undefined,
-> extends CodeqrError {
+> extends CodeQRError {
   /** HTTP status for the response that caused the error */
   readonly status: TStatus;
   /** HTTP headers for the response that caused the error */

package/src/core/resource.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import type { Codeqr } from '../client';
+import type { CodeQR } from '../client';
 
 export abstract class APIResource {
-  protected _client: Codeqr;
+  protected _client: CodeQR;
 
-  constructor(client: Codeqr) {
+  constructor(client: CodeQR) {
     this._client = client;
   }
 }

package/src/index.ts

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Codeqr as default } from './client';
+export { CodeQR as default } from './client';
 
 export { type Uploadable, toFile } from './core/uploads';
 export { APIPromise } from './core/api-promise';
-export { Codeqr, type ClientOptions } from './client';
+export { CodeQR, type ClientOptions } from './client';
 export {
-  CodeqrError,
+  CodeQRError,
   APIError,
   APIConnectionError,
   APIConnectionTimeoutError,

package/src/internal/parse.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import type { FinalRequestOptions } from './request-options';
-import { type Codeqr } from '../client';
+import { type CodeQR } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
 export type APIResponseProps = {
@@ -13,7 +13,7 @@ export type APIResponseProps = {
   startTime: number;
 };
 
-export async function defaultParseResponse<T>(client: Codeqr, props: APIResponseProps): Promise<T> {
+export async function defaultParseResponse<T>(client: CodeQR, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
     // fetch refuses to read the body when the status code is 204.

package/src/internal/shims.ts

@@ -16,7 +16,7 @@ export function getDefaultFetch(): Fetch {
   }
 
   throw new Error(
-    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new Codeqr({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
+    '`fetch` is not defined as a global; Either pass `fetch` to the client, `new CodeQR({ fetch })` or polyfill the global, `globalThis.fetch = fetch`',
   );
 }
 

package/src/internal/uploads.ts

@@ -1,6 +1,6 @@
 import { type RequestOptions } from './request-options';
 import type { FilePropertyBag, Fetch } from './builtin-types';
-import type { Codeqr } from '../client';
+import type { CodeQR } from '../client';
 import { ReadableStreamFrom } from './shims';
 
 export type BlobPart = string | ArrayBuffer | ArrayBufferView | Blob | DataView;
@@ -74,7 +74,7 @@ export const isAsyncIterable = (value: any): value is AsyncIterable<any> =>
  */
 export const maybeMultipartFormRequestOptions = async (
   opts: RequestOptions,
-  fetch: Codeqr | Fetch,
+  fetch: CodeQR | Fetch,
 ): Promise<RequestOptions> => {
   if (!hasUploadableValue(opts.body)) return opts;
 
@@ -85,7 +85,7 @@ type MultipartFormRequestOptions = Omit<RequestOptions, 'body'> & { body: unknow
 
 export const multipartFormRequestOptions = async (
   opts: MultipartFormRequestOptions,
-  fetch: Codeqr | Fetch,
+  fetch: CodeQR | Fetch,
 ): Promise<RequestOptions> => {
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
@@ -98,7 +98,7 @@ const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>
  * This function detects if the fetch function provided supports the global FormData object to avoid
  * confusing error messages later on.
  */
-function supportsFormData(fetchObject: Codeqr | Fetch): Promise<boolean> {
+function supportsFormData(fetchObject: CodeQR | Fetch): Promise<boolean> {
   const fetch: Fetch = typeof fetchObject === 'function' ? fetchObject : (fetchObject as any).fetch;
   const cached = supportsFormDataMap.get(fetch);
   if (cached) return cached;
@@ -124,7 +124,7 @@ function supportsFormData(fetchObject: Codeqr | Fetch): Promise<boolean> {
 
 export const createForm = async <T = Record<string, unknown>>(
   body: T | undefined,
-  fetch: Codeqr | Fetch,
+  fetch: CodeQR | Fetch,
 ): Promise<FormData> => {
   if (!(await supportsFormData(fetch))) {
     throw new TypeError(

package/src/internal/utils/base64.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { CodeqrError } from '../../core/error';
+import { CodeQRError } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 
 export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
@@ -18,7 +18,7 @@ export const toBase64 = (data: string | Uint8Array | null | undefined): string =
     return btoa(String.fromCharCode.apply(null, data as any));
   }
 
-  throw new CodeqrError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+  throw new CodeQRError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
 };
 
 export const fromBase64 = (str: string): Uint8Array => {
@@ -36,5 +36,5 @@ export const fromBase64 = (str: string): Uint8Array => {
     return buf;
   }
 
-  throw new CodeqrError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+  throw new CodeQRError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
 };

package/src/internal/utils/log.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { hasOwn } from './values';
-import { type Codeqr } from '../../client';
+import { type CodeQR } from '../../client';
 import { RequestOptions } from '../request-options';
 
 type LogFn = (message: string, ...rest: unknown[]) => void;
@@ -24,7 +24,7 @@ const levelNumbers = {
 export const parseLogLevel = (
   maybeLevel: string | undefined,
   sourceName: string,
-  client: Codeqr,
+  client: CodeQR,
 ): LogLevel | undefined => {
   if (!maybeLevel) {
     return undefined;
@@ -60,7 +60,7 @@ const noopLogger = {
 
 let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
-export function loggerFor(client: Codeqr): Logger {
+export function loggerFor(client: CodeQR): Logger {
   const logger = client.logger;
   const logLevel = client.logLevel ?? 'off';
   if (!logger) {

package/src/internal/utils/path.ts

@@ -1,4 +1,4 @@
-import { CodeqrError } from '../../core/error';
+import { CodeQRError } from '../../core/error';
 
 /**
  * Percent-encode everything that isn't safe to have in a path without encoding safe chars.
@@ -72,7 +72,7 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
         return acc + spaces + arrows;
       }, '');
 
-      throw new CodeqrError(
+      throw new CodeQRError(
         `Path parameters result in path with invalid segments:\n${invalidSegments
           .map((e) => e.error)
           .join('\n')}\n${path}\n${underline}`,

package/src/internal/utils/values.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { CodeqrError } from '../../core/error';
+import { CodeQRError } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string
 const startsWithSchemeRegexp = /^[a-z][a-z0-9+.-]*:/i;
@@ -39,7 +39,7 @@ export function isObj(obj: unknown): obj is Record<string, unknown> {
 
 export const ensurePresent = <T>(value: T | null | undefined): T => {
   if (value == null) {
-    throw new CodeqrError(`Expected a value to be given but received ${value} instead.`);
+    throw new CodeQRError(`Expected a value to be given but received ${value} instead.`);
   }
 
   return value;
@@ -47,10 +47,10 @@ export const ensurePresent = <T>(value: T | null | undefined): T => {
 
 export const validatePositiveInteger = (name: string, n: unknown): number => {
   if (typeof n !== 'number' || !Number.isInteger(n)) {
-    throw new CodeqrError(`${name} must be an integer`);
+    throw new CodeQRError(`${name} must be an integer`);
   }
   if (n < 0) {
-    throw new CodeqrError(`${name} must be a positive integer`);
+    throw new CodeQRError(`${name} must be a positive integer`);
   }
   return n;
 };
@@ -59,14 +59,14 @@ export const coerceInteger = (value: unknown): number => {
   if (typeof value === 'number') return Math.round(value);
   if (typeof value === 'string') return parseInt(value, 10);
 
-  throw new CodeqrError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new CodeQRError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceFloat = (value: unknown): number => {
   if (typeof value === 'number') return value;
   if (typeof value === 'string') return parseFloat(value);
 
-  throw new CodeqrError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
+  throw new CodeQRError(`Could not coerce ${value} (type: ${typeof value}) into a number`);
 };
 
 export const coerceBoolean = (value: unknown): boolean => {

package/src/resources/analytics.ts

@@ -290,7 +290,8 @@ export type AnalyticsRetrieveResponse =
   | Array<AnalyticsRetrieveResponse.AnalyticsReferer>
   | Array<AnalyticsRetrieveResponse.AnalyticsRefererURL>
   | Array<AnalyticsRetrieveResponse.AnalyticsTopLink>
-  | Array<AnalyticsRetrieveResponse.AnalyticsTopURL>;
+  | Array<AnalyticsRetrieveResponse.AnalyticsTopURL>
+  | Array<AnalyticsRetrieveResponse.AnalyticsTrigger>;
 
 export namespace AnalyticsRetrieveResponse {
   export interface AnalyticsCount {
@@ -1330,7 +1331,8 @@ export namespace AnalyticsRetrieveResponse {
     leads: number;
 
     /**
-     * The name of the referer. If unknown, this will be `(direct)`
+     * The name of the referer. If unknown, this will be `(direct)`. `nfc` marks an
+     * access whose URL carried the chip marker (`?nfc=1`) and had no web referer.
      */
     referer: string;
 
@@ -1445,6 +1447,36 @@ export namespace AnalyticsRetrieveResponse {
      */
     url: string;
   }
+
+  export interface AnalyticsTrigger {
+    /**
+     * The number of clicks from this trigger method
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this trigger method
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this trigger method, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this trigger method
+     */
+    sales: number;
+
+    /**
+     * How the visitor reached the item: `nfc` when the URL carried the chip marker
+     * (`?nfc=1`), `qr` for a QR Code scan, `link` otherwise (pages included). The
+     * channel is declared by the URL written to the tag; it does not prove a physical
+     * tap.
+     */
+    trigger: 'link' | 'qr' | 'nfc';
+  }
 }
 
 export interface AnalyticsRetrieveParams {
@@ -1502,7 +1534,12 @@ export interface AnalyticsRetrieveParams {
 
   /**
    * The parameter to group the analytics data points by. Defaults to 'count' if
-   * undefined.
+   * undefined. Some values depend on the workspace plan and answer 403 `forbidden`
+   * on a plan without them: `referers` and `referer_urls` need the Starter, Pro,
+   * Business, Scale, or Enterprise plan; `devices`, `browsers`, and `os` need the
+   * Starter, Pro, Business, Scale, or Enterprise plan; `utm_sources`, `utm_mediums`,
+   * `utm_campaigns`, `utm_contents`, and `utm_terms` need the Pro, Business, Scale,
+   * or Enterprise plan.
    */
   groupBy?:
     | 'timeseries'
@@ -1537,7 +1574,8 @@ export interface AnalyticsRetrieveParams {
     | 'utm_mediums'
     | 'utm_campaigns'
     | 'utm_contents'
-    | 'utm_terms';
+    | 'utm_terms'
+    | 'trigger';
 
   /**
    * The interval to retrieve analytics for. Takes precedence over start and end.
@@ -1607,7 +1645,9 @@ export interface AnalyticsRetrieveParams {
   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/domains.ts

@@ -21,34 +21,34 @@ export class Domains extends APIResource {
   }
 
   /**
-   * 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 });
   }
 
   /**
-   * 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 });
   }
 
   /**
@@ -166,29 +166,6 @@ 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
@@ -223,13 +200,36 @@ 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 DomainListParams as DomainListParams,
     type DomainUpdateParams as DomainUpdateParams,
+    type DomainListParams as DomainListParams,
   };
 }