@codeqr/ts 0.1.2

package/src/resources/events.ts

@@ -0,0 +1,1026 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AnalyticsAPI from './analytics';
+import * as TagsAPI from './tags';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Events extends APIResource {
+  /**
+   * Retrieve a paginated list of events for the authenticated workspace.
+   */
+  list(
+    query: EventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EventListResponse> {
+    return this._client.get('/events', { query, ...options });
+  }
+}
+
+export type EventListResponse = Array<
+  EventListResponse.ClickEvent | EventListResponse.LeadEvent | EventListResponse.SaleEvent
+>;
+
+export namespace EventListResponse {
+  export interface ClickEvent {
+    /**
+     * @deprecated Deprecated. Use `click.browser` instead.
+     */
+    browser: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.city` instead.
+     */
+    city: string;
+
+    click: ClickEvent.Click;
+
+    /**
+     * @deprecated Deprecated. Use `click.id` instead.
+     */
+    click_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.continent` instead.
+     */
+    continent: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.country` instead.
+     */
+    country: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.device` instead.
+     */
+    device: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.domain` instead.
+     */
+    domain: string;
+
+    event: 'click';
+
+    /**
+     * @deprecated Deprecated. Use `click.ip` instead.
+     */
+    ip: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.key` instead.
+     */
+    key: string;
+
+    link: ClickEvent.Link;
+
+    /**
+     * @deprecated Deprecated. Use `link.id` instead.
+     */
+    link_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.os` instead.
+     */
+    os: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.qr` instead.
+     */
+    type: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.url` instead.
+     */
+    url: string;
+
+    timestamp?: string;
+  }
+
+  export namespace ClickEvent {
+    export interface Click {
+      id: string;
+
+      browser: string;
+
+      city: string;
+
+      continent: string;
+
+      country: string;
+
+      device: string;
+
+      ip: string;
+
+      os: string;
+
+      referer: string;
+
+      refererUrl: string;
+
+      type: string;
+
+      url: string;
+    }
+
+    export interface Link {
+      /**
+       * O ID único do link curto.
+       */
+      id: string;
+
+      /**
+       * A URL de destino do Android para o link curto para segmentação de dispositivos
+       * Android.
+       */
+      android: string | null;
+
+      /**
+       * O número de cliques no link curto.
+       */
+      clicks: number;
+
+      /**
+       * Os comentários para o link curto.
+       */
+      comments: string | null;
+
+      createdAt: string;
+
+      /**
+       * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      description: string | null;
+
+      /**
+       * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
+       * será usado (ou `codeqr.link` se o projeto não tiver domínios).
+       */
+      domain: string;
+
+      /**
+       * A URL para redirecionar quando o link curto expirar.
+       */
+      expiredUrl: string | null;
+
+      /**
+       * Este é o ID do link no seu banco de dados.
+       */
+      externalId: string | null;
+
+      /**
+       * Whether the link is filled or not.
+       */
+      filled: boolean;
+
+      /**
+       * Se o link curto é flexível.
+       */
+      flexible: boolean;
+
+      /**
+       * Informações de segmentação geográfica para o link curto no formato JSON
+       * `{[PAÍS]: https://exemplo.com }`. Saiba mais: https://codeqr.link/geo
+       */
+      geo: { [key: string]: string } | null;
+
+      /**
+       * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      image: string | null;
+
+      /**
+       * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+       */
+      ios: string | null;
+
+      /**
+       * If the form is mandatory for the page.
+       */
+      isFormMandatory: boolean;
+
+      /**
+       * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
+       * será gerado.
+       */
+      key: string;
+
+      lastClicked: string;
+
+      /**
+       * O número de leads gerados pelo link curto.
+       */
+      leads: number;
+
+      /**
+       * O token de notificação do link curto.
+       */
+      notificationToken: string | null;
+
+      /**
+       * A senha necessária para acessar a URL de destino do link curto.
+       */
+      password: string | null;
+
+      /**
+       * Se o link curto tem pré-redirecionamento.
+       */
+      preRedirection: boolean;
+
+      /**
+       * O ID do projeto do link curto.
+       */
+      projectId: string;
+
+      /**
+       * The amount of the sale generated by the link.
+       */
+      saleAmount: number;
+
+      /**
+       * O número de vendas geradas pelo link curto.
+       */
+      sales: number;
+
+      /**
+       * @deprecated [DESCONTINUADO (use `tags` em vez disso)]: O ID único da tag
+       * atribuída ao link curto.
+       */
+      tagId: string | null;
+
+      /**
+       * As tags atribuídas ao link curto.
+       */
+      tags: Array<TagsAPI.Tag> | null;
+
+      /**
+       * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      title: string | null;
+
+      updatedAt: string;
+
+      userId: string | null;
+
+      /**
+       * A campanha UTM do link curto.
+       */
+      utm_campaign: string | null;
+
+      /**
+       * O conteúdo UTM do link curto.
+       */
+      utm_content: string | null;
+
+      /**
+       * O meio UTM do link curto.
+       */
+      utm_medium: string | null;
+
+      /**
+       * A fonte UTM do link curto.
+       */
+      utm_source: string | null;
+
+      /**
+       * O termo UTM do link curto.
+       */
+      utm_term: string | null;
+
+      /**
+       * O vídeo do link curto.
+       */
+      video: string | null;
+
+      archived?: boolean;
+
+      doIndex?: boolean;
+
+      expiresAt?: string;
+
+      /**
+       * The ID of the page to redirect to before the link destination.
+       */
+      pageId?: string | null;
+
+      /**
+       * The URL of the page to redirect to before the link destination.
+       */
+      pageUrl?: string | null;
+
+      proxy?: boolean;
+
+      publicStats?: boolean;
+
+      /**
+       * A URL completa do código QR para o link curto (por exemplo,
+       * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
+       */
+      qrCode?: string;
+
+      rewrite?: boolean;
+
+      /**
+       * A URL completa do link curto, incluindo o protocolo https (por exemplo,
+       * `https://codeqr.link/try`).
+       */
+      shortLink?: string;
+
+      trackConversion?: boolean;
+
+      url?: string;
+    }
+  }
+
+  export interface LeadEvent {
+    /**
+     * @deprecated Deprecated. Use `click.browser` instead.
+     */
+    browser: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.city` instead.
+     */
+    city: string;
+
+    click: LeadEvent.Click;
+
+    /**
+     * @deprecated Deprecated. Use `click.id` instead.
+     */
+    click_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.continent` instead.
+     */
+    continent: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.country` instead.
+     */
+    country: string;
+
+    customer: LeadEvent.Customer;
+
+    /**
+     * @deprecated Deprecated. Use `click.device` instead.
+     */
+    device: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.domain` instead.
+     */
+    domain: string;
+
+    event: 'lead';
+
+    eventId: string;
+
+    eventName: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.ip` instead.
+     */
+    ip: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.key` instead.
+     */
+    key: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.id` instead.
+     */
+    link_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.os` instead.
+     */
+    os: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.qr` instead.
+     */
+    type: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.url` instead.
+     */
+    url: string;
+
+    link?: unknown;
+
+    timestamp?: string;
+  }
+
+  export namespace LeadEvent {
+    export interface Click {
+      id: string;
+
+      browser: string;
+
+      city: string;
+
+      continent: string;
+
+      country: string;
+
+      device: string;
+
+      ip: string;
+
+      os: string;
+
+      referer: string;
+
+      refererUrl: string;
+
+      type: string;
+
+      url: string;
+    }
+
+    export interface Customer {
+      id: string;
+
+      avatar: string;
+
+      email: string;
+
+      name: string;
+    }
+  }
+
+  export interface SaleEvent {
+    /**
+     * @deprecated Deprecated. Use `click.browser` instead.
+     */
+    browser: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.city` instead.
+     */
+    city: string;
+
+    click: SaleEvent.Click;
+
+    /**
+     * @deprecated Deprecated. Use `click.id` instead.
+     */
+    click_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.continent` instead.
+     */
+    continent: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.country` instead.
+     */
+    country: string;
+
+    customer: SaleEvent.Customer;
+
+    /**
+     * @deprecated Deprecated. Use `click.device` instead.
+     */
+    device: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.domain` instead.
+     */
+    domain: string;
+
+    event: 'sale';
+
+    eventId: string;
+
+    eventName: string;
+
+    /**
+     * @deprecated Deprecated. Use `sale.invoiceId` instead.
+     */
+    invoice_id: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.ip` instead.
+     */
+    ip: string;
+
+    /**
+     * @deprecated Deprecated. Use `link.key` instead.
+     */
+    key: string;
+
+    link: SaleEvent.Link;
+
+    /**
+     * @deprecated Deprecated. Use `link.id` instead.
+     */
+    link_id: string;
+
+    metadata: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.os` instead.
+     */
+    os: string;
+
+    /**
+     * Deprecated. Use `sale.paymentProcessor` instead.
+     */
+    payment_processor: string;
+
+    sale: SaleEvent.Sale;
+
+    /**
+     * @deprecated Deprecated. Use `sale.amount` instead.
+     */
+    saleAmount: number;
+
+    /**
+     * @deprecated Deprecated. Use `click.qr` instead.
+     */
+    type: string;
+
+    /**
+     * @deprecated Deprecated. Use `click.url` instead.
+     */
+    url: string;
+
+    timestamp?: string;
+  }
+
+  export namespace SaleEvent {
+    export interface Click {
+      id: string;
+
+      browser: string;
+
+      city: string;
+
+      continent: string;
+
+      country: string;
+
+      device: string;
+
+      ip: string;
+
+      os: string;
+
+      referer: string;
+
+      refererUrl: string;
+
+      type: string;
+
+      url: string;
+    }
+
+    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;
+
+      /**
+       * Unique identifier for the customer in the client's app.
+       */
+      externalId: 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 {
+        /**
+         * O ID único do link curto.
+         */
+        id: string;
+
+        /**
+         * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
+         * será usado (ou `codeqr.link` se o projeto não tiver domínios).
+         */
+        domain: string;
+
+        /**
+         * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
+         * será gerado.
+         */
+        key: string;
+
+        /**
+         * A URL completa do link curto, incluindo o protocolo https (por exemplo,
+         * `https://codeqr.link/try`).
+         */
+        shortLink?: string;
+      }
+    }
+
+    export interface Link {
+      /**
+       * O ID único do link curto.
+       */
+      id: string;
+
+      /**
+       * A URL de destino do Android para o link curto para segmentação de dispositivos
+       * Android.
+       */
+      android: string | null;
+
+      /**
+       * O número de cliques no link curto.
+       */
+      clicks: number;
+
+      /**
+       * Os comentários para o link curto.
+       */
+      comments: string | null;
+
+      createdAt: string;
+
+      /**
+       * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      description: string | null;
+
+      /**
+       * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
+       * será usado (ou `codeqr.link` se o projeto não tiver domínios).
+       */
+      domain: string;
+
+      /**
+       * A URL para redirecionar quando o link curto expirar.
+       */
+      expiredUrl: string | null;
+
+      /**
+       * Este é o ID do link no seu banco de dados.
+       */
+      externalId: string | null;
+
+      /**
+       * Whether the link is filled or not.
+       */
+      filled: boolean;
+
+      /**
+       * Se o link curto é flexível.
+       */
+      flexible: boolean;
+
+      /**
+       * Informações de segmentação geográfica para o link curto no formato JSON
+       * `{[PAÍS]: https://exemplo.com }`. Saiba mais: https://codeqr.link/geo
+       */
+      geo: { [key: string]: string } | null;
+
+      /**
+       * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      image: string | null;
+
+      /**
+       * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+       */
+      ios: string | null;
+
+      /**
+       * If the form is mandatory for the page.
+       */
+      isFormMandatory: boolean;
+
+      /**
+       * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
+       * será gerado.
+       */
+      key: string;
+
+      lastClicked: string;
+
+      /**
+       * O número de leads gerados pelo link curto.
+       */
+      leads: number;
+
+      /**
+       * O token de notificação do link curto.
+       */
+      notificationToken: string | null;
+
+      /**
+       * A senha necessária para acessar a URL de destino do link curto.
+       */
+      password: string | null;
+
+      /**
+       * Se o link curto tem pré-redirecionamento.
+       */
+      preRedirection: boolean;
+
+      /**
+       * O ID do projeto do link curto.
+       */
+      projectId: string;
+
+      /**
+       * The amount of the sale generated by the link.
+       */
+      saleAmount: number;
+
+      /**
+       * O número de vendas geradas pelo link curto.
+       */
+      sales: number;
+
+      /**
+       * @deprecated [DESCONTINUADO (use `tags` em vez disso)]: O ID único da tag
+       * atribuída ao link curto.
+       */
+      tagId: string | null;
+
+      /**
+       * As tags atribuídas ao link curto.
+       */
+      tags: Array<TagsAPI.Tag> | null;
+
+      /**
+       * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
+       * Visualização de link personalizado se `proxy` for verdadeiro.
+       */
+      title: string | null;
+
+      updatedAt: string;
+
+      userId: string | null;
+
+      /**
+       * A campanha UTM do link curto.
+       */
+      utm_campaign: string | null;
+
+      /**
+       * O conteúdo UTM do link curto.
+       */
+      utm_content: string | null;
+
+      /**
+       * O meio UTM do link curto.
+       */
+      utm_medium: string | null;
+
+      /**
+       * A fonte UTM do link curto.
+       */
+      utm_source: string | null;
+
+      /**
+       * O termo UTM do link curto.
+       */
+      utm_term: string | null;
+
+      /**
+       * O vídeo do link curto.
+       */
+      video: string | null;
+
+      archived?: boolean;
+
+      doIndex?: boolean;
+
+      expiresAt?: string;
+
+      /**
+       * The ID of the page to redirect to before the link destination.
+       */
+      pageId?: string | null;
+
+      /**
+       * The URL of the page to redirect to before the link destination.
+       */
+      pageUrl?: string | null;
+
+      proxy?: boolean;
+
+      publicStats?: boolean;
+
+      /**
+       * A URL completa do código QR para o link curto (por exemplo,
+       * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
+       */
+      qrCode?: string;
+
+      rewrite?: boolean;
+
+      /**
+       * A URL completa do link curto, incluindo o protocolo https (por exemplo,
+       * `https://codeqr.link/try`).
+       */
+      shortLink?: string;
+
+      trackConversion?: boolean;
+
+      url?: string;
+    }
+
+    export interface Sale {
+      /**
+       * The amount of the sale. Should be passed in cents.
+       */
+      amount: number;
+
+      /**
+       * The invoice ID of the sale.
+       */
+      invoiceId: string | null;
+
+      /**
+       * The payment processor via which the sale was made.
+       */
+      paymentProcessor: 'stripe' | 'shopify' | 'paddle';
+    }
+  }
+}
+
+export interface EventListParams {
+  /**
+   * The browser to retrieve analytics for.
+   */
+  browser?: string;
+
+  /**
+   * The city to retrieve analytics for.
+   */
+  city?: string;
+
+  /**
+   * The continent to retrieve analytics for.
+   */
+  continent?: AnalyticsAPI.ContinentCode;
+
+  /**
+   * The country to retrieve analytics for.
+   */
+  country?: AnalyticsAPI.CountryCode;
+
+  /**
+   * The device to retrieve analytics for.
+   */
+  device?: string;
+
+  /**
+   * The domain of the short link.
+   */
+  domain?: string;
+
+  /**
+   * The end date and time when to retrieve analytics from. If not provided, defaults
+   * to the current date.
+   */
+  end?: string;
+
+  /**
+   * The type of event to retrieve analytics for. Defaults to 'clicks'.
+   */
+  event?: 'clicks' | 'leads' | 'sales' | 'scans' | 'views';
+
+  /**
+   * Whether to exclude the root link from the response.
+   */
+  excludeRoot?: boolean;
+
+  /**
+   * This is the ID of the link in the your database. Must be prefixed with 'ext\_'
+   * when passed as a query parameter.
+   */
+  externalId?: string;
+
+  /**
+   * The interval to retrieve events for. Takes precedence over start and end. If
+   * undefined, defaults to 24h.
+   */
+  interval?: '24h' | '7d' | '30d' | '90d' | 'ytd' | '1y' | 'all';
+
+  /**
+   * The short link slug.
+   */
+  key?: string;
+
+  limit?: number;
+
+  /**
+   * The unique ID of the short link on CodeQR.
+   */
+  linkId?: string;
+
+  order?: 'asc' | 'desc';
+
+  /**
+   * The OS to retrieve analytics for.
+   */
+  os?: string;
+
+  page?: number;
+
+  /**
+   * The unique ID of the page on CodeQR.
+   */
+  pageId?: string;
+
+  /**
+   * The unique ID of the QR code on CodeQR.
+   */
+  qrcodeId?: string;
+
+  /**
+   * The referer to retrieve analytics for.
+   */
+  referer?: string;
+
+  /**
+   * Filter for root domains. If true, filter for domains only. If false, filter for
+   * links only. If undefined, return both.
+   */
+  root?: boolean;
+
+  sortBy?: 'timestamp';
+
+  /**
+   * The start date and time when to retrieve analytics from.
+   */
+  start?: string;
+
+  /**
+   * The tag ID to retrieve analytics for.
+   */
+  tagId?: string;
+
+  /**
+   * The IANA time zone code for aligning timeseries granularity (e.g.
+   * America/New_York). Defaults to UTC.
+   */
+  timezone?: string;
+
+  /**
+   * The type of analytics to retrieve.
+   */
+  type?: string;
+
+  /**
+   * The types of analytics to retrieve.
+   */
+  types?: string;
+
+  /**
+   * The URL to retrieve analytics for.
+   */
+  url?: string;
+}
+
+export declare namespace Events {
+  export { type EventListResponse as EventListResponse, type EventListParams as EventListParams };
+}