@codeqr/ts 0.1.2

package/src/resources/links/links.ts

@@ -0,0 +1,3841 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TagsAPI from '../tags';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from './bulk';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Links extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * Create a new link for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const link = await client.links.create({
+   *   url: 'https://google.com',
+   * });
+   * ```
+   */
+  create(body: LinkCreateParams, options?: RequestOptions): APIPromise<Link> {
+    return this._client.post('/links', { body, ...options });
+  }
+
+  /**
+   * Update a link for the authenticated workspace. If there's no change, returns it
+   * as it is.
+   *
+   * @example
+   * ```ts
+   * const link = await client.links.update('linkId');
+   * ```
+   */
+  update(
+    linkID: string,
+    body: LinkUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Link> {
+    return this._client.put(path`/links/${linkID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a paginated list of links for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const links = await client.links.list();
+   * ```
+   */
+  list(
+    query: LinkListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LinkListResponse> {
+    return this._client.get('/links', { query, ...options });
+  }
+
+  /**
+   * Delete a link for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const link = await client.links.delete('linkId');
+   * ```
+   */
+  delete(linkID: string, options?: RequestOptions): APIPromise<LinkDeleteResponse> {
+    return this._client.delete(path`/links/${linkID}`, options);
+  }
+
+  /**
+   * Retrieve the number of links for the authenticated workspace.
+   *
+   * @example
+   * ```ts
+   * const response = await client.links.count();
+   * ```
+   */
+  count(
+    query: LinkCountParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LinkCountResponse> {
+    return this._client.get('/links/count', { query, ...options });
+  }
+
+  /**
+   * Retrieve the info for a link.
+   *
+   * @example
+   * ```ts
+   * const link = await client.links.retrieveInfo({
+   *   domain: 'x',
+   *   key: 'x',
+   *   projectSlug: 'x',
+   * });
+   * ```
+   */
+  retrieveInfo(query: LinkRetrieveInfoParams, options?: RequestOptions): APIPromise<Link> {
+    return this._client.get('/links/info', { query, ...options });
+  }
+
+  /**
+   * Upsert a link for the authenticated workspace by its URL. If a link with the
+   * same URL already exists, return it (or update it if there are any changes).
+   * Otherwise, a new link will be created.
+   *
+   * @example
+   * ```ts
+   * const link = await client.links.upsert({
+   *   url: 'https://google.com',
+   * });
+   * ```
+   */
+  upsert(body: LinkUpsertParams, options?: RequestOptions): APIPromise<Link> {
+    return this._client.patch('/links/update', { body, ...options });
+  }
+}
+
+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;
+
+  /**
+   * Se o link curto está arquivado.
+   */
+  archived: boolean;
+
+  /**
+   * O número de cliques no link curto.
+   */
+  clicks: number;
+
+  /**
+   * Os comentários para o link curto.
+   */
+  comments: string | null;
+
+  /**
+   * A data e hora em que o link curto foi criado.
+   */
+  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;
+
+  /**
+   * Se os mecanismos de busca podem indexar o link curto.
+   */
+  doIndex: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
+   * futuro.
+   */
+  expiresAt: 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;
+
+  /**
+   * A data e hora em que o link curto foi clicado pela última vez.
+   */
+  lastClicked: string | null;
+
+  /**
+   * 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;
+
+  /**
+   * Se o link curto usa o recurso de Visualização de link personalizado.
+   */
+  proxy: boolean;
+
+  /**
+   * Se as estatísticas do link curto são publicamente acessíveis.
+   */
+  publicStats: boolean;
+
+  /**
+   * Se o link curto usa camuflagem de link.
+   */
+  rewrite: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * [BETA] Se deve rastrear conversões para o link curto.
+   */
+  trackConversion: boolean;
+
+  /**
+   * A data e hora em que o link curto foi atualizado pela última vez.
+   */
+  updatedAt: string;
+
+  /**
+   * A URL de destino do link curto.
+   */
+  url: string;
+
+  /**
+   * O ID do usuário que criou o link curto.
+   */
+  userId: string;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * A URL completa do link curto, incluindo o protocolo https (por exemplo,
+   * `https://codeqr.link/try`).
+   */
+  shortLink?: string;
+}
+
+export type LinkListResponse = Array<Link>;
+
+export interface LinkDeleteResponse {
+  /**
+   * The ID of the link.
+   */
+  id: string;
+}
+
+/**
+ * The number of links matching the query.
+ */
+export type LinkCountResponse = number;
+
+export interface LinkCreateParams {
+  /**
+   * A URL de destino do link curto.
+   */
+  url: string;
+
+  /**
+   * A URL de destino do Android para o link curto para segmentação de dispositivos
+   * Android.
+   */
+  android?: string | null;
+
+  /**
+   * Se o link curto está arquivado.
+   */
+  archived?: boolean;
+
+  /**
+   * Os comentários para o link curto.
+   */
+  comments?: string | null;
+
+  /**
+   * 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;
+
+  /**
+   * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
+   * se não for fornecido. Saiba mais: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
+   * futuro.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
+   * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
+   * um parâmetro de consulta.
+   */
+  externalId?: string | null;
+
+  /**
+   * 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 }`.
+   */
+  geo?: LinkCreateParams.Geo | 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;
+
+  /**
+   * 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;
+
+  /**
+   * A senha necessária para acessar a URL de destino do link curto.
+   */
+  password?: string | null;
+
+  /**
+   * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
+   * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
+   * ignorado se `key` for fornecido.
+   */
+  prefix?: string;
+
+  /**
+   * Se o link curto tem pré-redirecionamento.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * Se o link curto usa o recurso de Visualização de link personalizado.
+   */
+  proxy?: boolean;
+
+  /**
+   * Se as estatísticas do link curto são publicamente acessíveis.
+   */
+  publicStats?: boolean;
+
+  /**
+   * Se o link curto usa camuflagem de link.
+   */
+  rewrite?: boolean;
+
+  /**
+   * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
+   * – use `tagIds` em vez disso.
+   */
+  tagId?: string | null;
+
+  /**
+   * Os IDs únicos das tags atribuídas ao link curto.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
+   * minúsculas).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * 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;
+
+  /**
+   * Se deve rastrear conversões para o link curto.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * O vídeo do link curto.
+   */
+  video?: string | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+}
+
+export namespace LinkCreateParams {
+  /**
+   * Informações de segmentação geográfica para o link curto no formato JSON
+   * `{[PAÍS]: https://exemplo.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface LinkUpdateParams {
+  /**
+   * A URL de destino do Android para o link curto para segmentação de dispositivos
+   * Android.
+   */
+  android?: string | null;
+
+  /**
+   * Se o link curto está arquivado.
+   */
+  archived?: boolean;
+
+  /**
+   * Os comentários para o link curto.
+   */
+  comments?: string | null;
+
+  /**
+   * 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;
+
+  /**
+   * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
+   * se não for fornecido. Saiba mais: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
+   * futuro.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
+   * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
+   * um parâmetro de consulta.
+   */
+  externalId?: string | null;
+
+  /**
+   * 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 }`.
+   */
+  geo?: LinkUpdateParams.Geo | 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;
+
+  /**
+   * 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;
+
+  /**
+   * A senha necessária para acessar a URL de destino do link curto.
+   */
+  password?: string | null;
+
+  /**
+   * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
+   * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
+   * ignorado se `key` for fornecido.
+   */
+  prefix?: string;
+
+  /**
+   * Se o link curto tem pré-redirecionamento.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * Se o link curto usa o recurso de Visualização de link personalizado.
+   */
+  proxy?: boolean;
+
+  /**
+   * Se as estatísticas do link curto são publicamente acessíveis.
+   */
+  publicStats?: boolean;
+
+  /**
+   * Se o link curto usa camuflagem de link.
+   */
+  rewrite?: boolean;
+
+  /**
+   * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
+   * – use `tagIds` em vez disso.
+   */
+  tagId?: string | null;
+
+  /**
+   * Os IDs únicos das tags atribuídas ao link curto.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
+   * minúsculas).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * 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;
+
+  /**
+   * Se deve rastrear conversões para o link curto.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * A URL de destino do link curto.
+   */
+  url?: string;
+
+  /**
+   * O vídeo do link curto.
+   */
+  video?: string | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+}
+
+export namespace LinkUpdateParams {
+  /**
+   * Informações de segmentação geográfica para o link curto no formato JSON
+   * `{[PAÍS]: https://exemplo.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface LinkListParams {
+  /**
+   * The Android device to filter by.
+   */
+  android?: string;
+
+  /**
+   * Maximum number of clicks
+   */
+  clicksMax?: number;
+
+  /**
+   * Minimum number of clicks
+   */
+  clicksMin?: number;
+
+  /**
+   * The comments to filter by.
+   */
+  comments?: string;
+
+  /**
+   * Created after date (ISO string)
+   */
+  createdAfter?: string;
+
+  /**
+   * Created before date (ISO string)
+   */
+  createdBefore?: string;
+
+  /**
+   * The domain to filter the links. For example, `ac.me`. If not provided, all links
+   * of the project will be returned.
+   */
+  domain?: string;
+
+  /**
+   * Expires after date (ISO string)
+   */
+  expiresAfter?: string;
+
+  /**
+   * The date and time the short link will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Expires before date (ISO string)
+   */
+  expiresBefore?: string;
+
+  /**
+   * Geographic segmentation information for the short link in JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  geo?: LinkListParams.Geo | null;
+
+  /**
+   * Filter links that have comments (any comments)
+   */
+  hasComments?: boolean;
+
+  /**
+   * Filter links that have custom social media cards
+   */
+  hasCustomSocial?: boolean;
+
+  /**
+   * Filter links that have device targeting
+   */
+  hasDevice?: boolean;
+
+  /**
+   * Filter links that have expiration date (any expiration)
+   */
+  hasExpiration?: boolean;
+
+  /**
+   * Filter links that have geo-targeting
+   */
+  hasGeo?: boolean;
+
+  /**
+   * Filter links that have password protection (any password)
+   */
+  hasPassword?: boolean;
+
+  /**
+   * Filter links that have tags (any tags)
+   */
+  hasTags?: boolean;
+
+  /**
+   * Filter links that have UTM parameters
+   */
+  hasUTM?: boolean;
+
+  /**
+   * The iOS device to filter by.
+   */
+  ios?: string;
+
+  /**
+   * Link IDs to filter by.
+   */
+  linkIds?: string | Array<string>;
+
+  /**
+   * The page number for pagination.
+   */
+  page?: number;
+
+  /**
+   * The number of items per page.
+   */
+  pageSize?: number;
+
+  /**
+   * The password to filter by.
+   */
+  password?: string;
+
+  /**
+   * The slug of the project to which the link belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   */
+  projectSlug?: string;
+
+  /**
+   * The search term to filter the links. The search term will be matched against the
+   * short link slug and the destination URL.
+   */
+  search?: string;
+
+  /**
+   * If should include archived links in the response. The default is `false` if not
+   * provided.
+   */
+  showArchived?: boolean;
+
+  /**
+   * The field to sort the links by. The default is `createdAt`, and sort order is
+   * always descending.
+   */
+  sort?: 'createdAt' | 'clicks' | 'lastClicked';
+
+  /**
+   * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
+   * assigned to the short link.
+   */
+  tagId?: string;
+
+  /**
+   * The IDs of the tags to filter the links.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the short link (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * If should include links with conversion tracking enabled. The default is `false`
+   * if not provided.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * The ID of the user to filter by.
+   */
+  userId?: string;
+
+  /**
+   * If should include tags in the response. The default is `false` if not provided.
+   */
+  withTags?: boolean;
+}
+
+export namespace LinkListParams {
+  /**
+   * Geographic segmentation information for the short link in JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface LinkCountParams {
+  /**
+   * The Android device to filter by.
+   */
+  android?: string;
+
+  /**
+   * Maximum number of clicks
+   */
+  clicksMax?: number;
+
+  /**
+   * Minimum number of clicks
+   */
+  clicksMin?: number;
+
+  /**
+   * The comments to filter by.
+   */
+  comments?: string;
+
+  /**
+   * Created after date (ISO string)
+   */
+  createdAfter?: string;
+
+  /**
+   * Created before date (ISO string)
+   */
+  createdBefore?: string;
+
+  /**
+   * The domain to filter the links. For example, `ac.me`. If not provided, all links
+   * of the project will be returned.
+   */
+  domain?: string;
+
+  /**
+   * Expires after date (ISO string)
+   */
+  expiresAfter?: string;
+
+  /**
+   * The date and time the short link will expire in ISO-8601 format. Must be in the
+   * future.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Expires before date (ISO string)
+   */
+  expiresBefore?: string;
+
+  /**
+   * Geographic segmentation information for the short link in JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  geo?: LinkCountParams.Geo | null;
+
+  /**
+   * The field to group the links by.
+   */
+  groupBy?: 'domain' | 'tagId' | 'userId';
+
+  /**
+   * Filter links that have comments (any comments)
+   */
+  hasComments?: boolean;
+
+  /**
+   * Filter links that have custom social media cards
+   */
+  hasCustomSocial?: boolean;
+
+  /**
+   * Filter links that have device targeting
+   */
+  hasDevice?: boolean;
+
+  /**
+   * Filter links that have expiration date (any expiration)
+   */
+  hasExpiration?: boolean;
+
+  /**
+   * Filter links that have geo-targeting
+   */
+  hasGeo?: boolean;
+
+  /**
+   * Filter links that have password protection (any password)
+   */
+  hasPassword?: boolean;
+
+  /**
+   * Filter links that have tags (any tags)
+   */
+  hasTags?: boolean;
+
+  /**
+   * Filter links that have UTM parameters
+   */
+  hasUTM?: boolean;
+
+  /**
+   * The iOS device to filter by.
+   */
+  ios?: string;
+
+  /**
+   * The password to filter by.
+   */
+  password?: string;
+
+  /**
+   * The slug of the project to which the link belongs. For example, for
+   * `app.codeqr.io/acme`, the projectSlug is `acme`.
+   */
+  projectSlug?: string;
+
+  /**
+   * The search term to filter the links. The search term will be matched against the
+   * short link slug and the destination URL.
+   */
+  search?: string;
+
+  /**
+   * If should include archived links in the response. The default is `false` if not
+   * provided.
+   */
+  showArchived?: boolean;
+
+  /**
+   * @deprecated [OBSOLETO (use tagIds em vez disso)]: The unique ID of the tag
+   * assigned to the short link.
+   */
+  tagId?: string;
+
+  /**
+   * The IDs of the tags to filter the links.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * The unique name of the tags assigned to the short link (case insensitive).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * If should include links with conversion tracking enabled. The default is `false`
+   * if not provided.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * The ID of the user to filter by.
+   */
+  userId?: string;
+
+  /**
+   * If should include tags in the response. The default is `false` if not provided.
+   */
+  withTags?: boolean;
+}
+
+export namespace LinkCountParams {
+  /**
+   * Geographic segmentation information for the short link in JSON format
+   * `{[COUNTRY]: https://example.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+export interface LinkRetrieveInfoParams {
+  /**
+   * O domínio do link a ser recuperado. Por exemplo, para `codeqr.link/github`, o
+   * domínio é `codeqr.link`.
+   */
+  domain: string;
+
+  /**
+   * A chave do link a ser recuperado. Por exemplo, para `codeqr.link/github`, a
+   * chave é `github`.
+   */
+  key: string;
+
+  /**
+   * O slug do projeto ao qual o link pertence. Por exemplo, para
+   * `app.codeqr.io/acme`, o projectSlug é `acme`.
+   */
+  projectSlug: string;
+
+  /**
+   * Este é o ID do link no seu banco de dados. Deve ser prefixado com `ext_` quando
+   * passado como um parâmetro de consulta.
+   */
+  externalId?: string;
+
+  /**
+   * The unique ID of the short link.
+   */
+  linkId?: string;
+}
+
+export interface LinkUpsertParams {
+  /**
+   * A URL de destino do link curto.
+   */
+  url: string;
+
+  /**
+   * A URL de destino do Android para o link curto para segmentação de dispositivos
+   * Android.
+   */
+  android?: string | null;
+
+  /**
+   * Se o link curto está arquivado.
+   */
+  archived?: boolean;
+
+  /**
+   * Os comentários para o link curto.
+   */
+  comments?: string | null;
+
+  /**
+   * 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;
+
+  /**
+   * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
+   * se não for fornecido. Saiba mais: https://codeqr.link/noindex
+   */
+  doIndex?: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
+   * futuro.
+   */
+  expiresAt?: string | null;
+
+  /**
+   * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
+   * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
+   * um parâmetro de consulta.
+   */
+  externalId?: string | null;
+
+  /**
+   * 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 }`.
+   */
+  geo?: LinkUpsertParams.Geo | 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;
+
+  /**
+   * 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;
+
+  /**
+   * A senha necessária para acessar a URL de destino do link curto.
+   */
+  password?: string | null;
+
+  /**
+   * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
+   * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
+   * ignorado se `key` for fornecido.
+   */
+  prefix?: string;
+
+  /**
+   * Se o link curto tem pré-redirecionamento.
+   */
+  preRedirection?: boolean;
+
+  /**
+   * Se o link curto usa o recurso de Visualização de link personalizado.
+   */
+  proxy?: boolean;
+
+  /**
+   * Se as estatísticas do link curto são publicamente acessíveis.
+   */
+  publicStats?: boolean;
+
+  /**
+   * Se o link curto usa camuflagem de link.
+   */
+  rewrite?: boolean;
+
+  /**
+   * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
+   * – use `tagIds` em vez disso.
+   */
+  tagId?: string | null;
+
+  /**
+   * Os IDs únicos das tags atribuídas ao link curto.
+   */
+  tagIds?: string | Array<string>;
+
+  /**
+   * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
+   * minúsculas).
+   */
+  tagNames?: string | Array<string>;
+
+  /**
+   * 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;
+
+  /**
+   * Se deve rastrear conversões para o link curto.
+   */
+  trackConversion?: boolean;
+
+  /**
+   * O vídeo do link curto.
+   */
+  video?: string | null;
+
+  /**
+   * An array of webhook IDs to trigger when the link is clicked. These webhooks will
+   * receive click event data.
+   */
+  webhookIds?: Array<string> | null;
+}
+
+export namespace LinkUpsertParams {
+  /**
+   * Informações de segmentação geográfica para o link curto no formato JSON
+   * `{[PAÍS]: https://exemplo.com }`.
+   */
+  export interface Geo {
+    AD?: string;
+
+    AE?: string;
+
+    AF?: string;
+
+    AG?: string;
+
+    AI?: string;
+
+    AL?: string;
+
+    AM?: string;
+
+    AO?: string;
+
+    AQ?: string;
+
+    AR?: string;
+
+    AS?: string;
+
+    AT?: string;
+
+    AU?: string;
+
+    AW?: string;
+
+    AX?: string;
+
+    AZ?: string;
+
+    BA?: string;
+
+    BB?: string;
+
+    BD?: string;
+
+    BE?: string;
+
+    BF?: string;
+
+    BG?: string;
+
+    BH?: string;
+
+    BI?: string;
+
+    BJ?: string;
+
+    BL?: string;
+
+    BM?: string;
+
+    BN?: string;
+
+    BO?: string;
+
+    BQ?: string;
+
+    BR?: string;
+
+    BS?: string;
+
+    BT?: string;
+
+    BV?: string;
+
+    BW?: string;
+
+    BY?: string;
+
+    BZ?: string;
+
+    CA?: string;
+
+    CC?: string;
+
+    CD?: string;
+
+    CF?: string;
+
+    CG?: string;
+
+    CH?: string;
+
+    CI?: string;
+
+    CK?: string;
+
+    CL?: string;
+
+    CM?: string;
+
+    CN?: string;
+
+    CO?: string;
+
+    CR?: string;
+
+    CU?: string;
+
+    CV?: string;
+
+    CW?: string;
+
+    CX?: string;
+
+    CY?: string;
+
+    CZ?: string;
+
+    DE?: string;
+
+    DJ?: string;
+
+    DK?: string;
+
+    DM?: string;
+
+    DO?: string;
+
+    DZ?: string;
+
+    EC?: string;
+
+    EE?: string;
+
+    EG?: string;
+
+    EH?: string;
+
+    ER?: string;
+
+    ES?: string;
+
+    ET?: string;
+
+    FI?: string;
+
+    FJ?: string;
+
+    FK?: string;
+
+    FM?: string;
+
+    FO?: string;
+
+    FR?: string;
+
+    GA?: string;
+
+    GB?: string;
+
+    GD?: string;
+
+    GE?: string;
+
+    GF?: string;
+
+    GG?: string;
+
+    GH?: string;
+
+    GI?: string;
+
+    GL?: string;
+
+    GM?: string;
+
+    GN?: string;
+
+    GP?: string;
+
+    GQ?: string;
+
+    GR?: string;
+
+    GS?: string;
+
+    GT?: string;
+
+    GU?: string;
+
+    GW?: string;
+
+    GY?: string;
+
+    HK?: string;
+
+    HM?: string;
+
+    HN?: string;
+
+    HR?: string;
+
+    HT?: string;
+
+    HU?: string;
+
+    ID?: string;
+
+    IE?: string;
+
+    IL?: string;
+
+    IM?: string;
+
+    IN?: string;
+
+    IO?: string;
+
+    IQ?: string;
+
+    IR?: string;
+
+    IS?: string;
+
+    IT?: string;
+
+    JE?: string;
+
+    JM?: string;
+
+    JO?: string;
+
+    JP?: string;
+
+    KE?: string;
+
+    KG?: string;
+
+    KH?: string;
+
+    KI?: string;
+
+    KM?: string;
+
+    KN?: string;
+
+    KP?: string;
+
+    KR?: string;
+
+    KW?: string;
+
+    KY?: string;
+
+    KZ?: string;
+
+    LA?: string;
+
+    LB?: string;
+
+    LC?: string;
+
+    LI?: string;
+
+    LK?: string;
+
+    LR?: string;
+
+    LS?: string;
+
+    LT?: string;
+
+    LU?: string;
+
+    LV?: string;
+
+    LY?: string;
+
+    MA?: string;
+
+    MC?: string;
+
+    MD?: string;
+
+    ME?: string;
+
+    MF?: string;
+
+    MG?: string;
+
+    MH?: string;
+
+    MK?: string;
+
+    ML?: string;
+
+    MM?: string;
+
+    MN?: string;
+
+    MO?: string;
+
+    MP?: string;
+
+    MQ?: string;
+
+    MR?: string;
+
+    MS?: string;
+
+    MT?: string;
+
+    MU?: string;
+
+    MV?: string;
+
+    MW?: string;
+
+    MX?: string;
+
+    MY?: string;
+
+    MZ?: string;
+
+    NA?: string;
+
+    NC?: string;
+
+    NE?: string;
+
+    NF?: string;
+
+    NG?: string;
+
+    NI?: string;
+
+    NL?: string;
+
+    NO?: string;
+
+    NP?: string;
+
+    NR?: string;
+
+    NU?: string;
+
+    NZ?: string;
+
+    OM?: string;
+
+    PA?: string;
+
+    PE?: string;
+
+    PF?: string;
+
+    PG?: string;
+
+    PH?: string;
+
+    PK?: string;
+
+    PL?: string;
+
+    PM?: string;
+
+    PN?: string;
+
+    PR?: string;
+
+    PS?: string;
+
+    PT?: string;
+
+    PW?: string;
+
+    PY?: string;
+
+    QA?: string;
+
+    RE?: string;
+
+    RO?: string;
+
+    RS?: string;
+
+    RU?: string;
+
+    RW?: string;
+
+    SA?: string;
+
+    SB?: string;
+
+    SC?: string;
+
+    SD?: string;
+
+    SE?: string;
+
+    SG?: string;
+
+    SH?: string;
+
+    SI?: string;
+
+    SJ?: string;
+
+    SK?: string;
+
+    SL?: string;
+
+    SM?: string;
+
+    SN?: string;
+
+    SO?: string;
+
+    SR?: string;
+
+    SS?: string;
+
+    ST?: string;
+
+    SV?: string;
+
+    SX?: string;
+
+    SY?: string;
+
+    SZ?: string;
+
+    TC?: string;
+
+    TD?: string;
+
+    TF?: string;
+
+    TG?: string;
+
+    TH?: string;
+
+    TJ?: string;
+
+    TK?: string;
+
+    TL?: string;
+
+    TM?: string;
+
+    TN?: string;
+
+    TO?: string;
+
+    TR?: string;
+
+    TT?: string;
+
+    TV?: string;
+
+    TW?: string;
+
+    TZ?: string;
+
+    UA?: string;
+
+    UG?: string;
+
+    UM?: string;
+
+    US?: string;
+
+    UY?: string;
+
+    UZ?: string;
+
+    VA?: string;
+
+    VC?: string;
+
+    VE?: string;
+
+    VG?: string;
+
+    VI?: string;
+
+    VN?: string;
+
+    VU?: string;
+
+    WF?: string;
+
+    WS?: string;
+
+    XK?: string;
+
+    YE?: string;
+
+    YT?: string;
+
+    ZA?: string;
+
+    ZM?: string;
+
+    ZW?: string;
+  }
+}
+
+Links.Bulk = Bulk;
+
+export declare namespace Links {
+  export {
+    type Link as Link,
+    type LinkListResponse as LinkListResponse,
+    type LinkDeleteResponse as LinkDeleteResponse,
+    type LinkCountResponse as LinkCountResponse,
+    type LinkCreateParams as LinkCreateParams,
+    type LinkUpdateParams as LinkUpdateParams,
+    type LinkListParams as LinkListParams,
+    type LinkCountParams as LinkCountParams,
+    type LinkRetrieveInfoParams as LinkRetrieveInfoParams,
+    type LinkUpsertParams as LinkUpsertParams,
+  };
+
+  export {
+    Bulk as Bulk,
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkDeleteParams as BulkDeleteParams,
+  };
+}