@codeqr/ts 0.1.2 → 0.2.0

package/resources/links/links.d.mts

@@ -83,55 +83,54 @@ export declare class Links extends APIResource {
 }
 export interface Link {
     /**
-     * O ID único do link curto.
+     * The unique ID of the short link.
      */
     id: string;
     /**
-     * A URL de destino do Android para o link curto para segmentação de dispositivos
-     * Android.
+     * The Android destination URL for the short link for Android device targeting.
      */
     android: string | null;
     /**
-     * Se o link curto está arquivado.
+     * Whether the short link is archived.
      */
     archived: boolean;
     /**
-     * O número de cliques no link curto.
+     * The number of clicks on the short link.
      */
     clicks: number;
     /**
-     * Os comentários para o link curto.
+     * The comments for the short link.
      */
     comments: string | null;
     /**
-     * A data e hora em que o link curto foi criado.
+     * The date and time when the short link was created.
      */
     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.
+     * The description of the short link generated via `api.codeqr.io/metatags`. Will
+     * be used for custom link preview if `proxy` is true.
      */
     description: string | null;
     /**
-     * Se os mecanismos de busca podem indexar o link curto.
+     * Whether search engines can index the short link.
      */
     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).
+     * The domain of the short link. If not provided, the main domain of the project
+     * will be used (or `codeqr.link` if the project has no domains).
      */
     domain: string;
     /**
-     * A URL para redirecionar quando o link curto expirar.
+     * The URL to redirect to when the short link expires.
      */
     expiredUrl: string | null;
     /**
-     * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
-     * futuro.
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
      */
     expiresAt: string | null;
     /**
-     * Este é o ID do link no seu banco de dados.
+     * This is the ID of the link in your database.
      */
     externalId: string | null;
     /**
@@ -139,23 +138,23 @@ export interface Link {
      */
     filled: boolean;
     /**
-     * Se o link curto é flexível.
+     * Whether the short link is flexible.
      */
     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
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
      */
     geo: {
         [key: string]: string;
     } | null;
     /**
-     * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
-     * Visualização de link personalizado se `proxy` for verdadeiro.
+     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     image: string | null;
     /**
-     * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+     * The iOS destination URL for the short link for iOS device targeting.
      */
     ios: string | null;
     /**
@@ -163,44 +162,44 @@ export interface Link {
      */
     isFormMandatory: boolean;
     /**
-     * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
-     * será gerado.
+     * The slug of the short link. If not provided, a random 7-character slug will be
+     * generated.
      */
     key: string;
     /**
-     * A data e hora em que o link curto foi clicado pela última vez.
+     * The date and time when the short link was last clicked.
      */
     lastClicked: string | null;
     /**
-     * O número de leads gerados pelo link curto.
+     * The number of leads generated by the short link.
      */
     leads: number;
     /**
-     * O token de notificação do link curto.
+     * The notification token of the short link.
      */
     notificationToken: string | null;
     /**
-     * A senha necessária para acessar a URL de destino do link curto.
+     * The password required to access the short link destination URL.
      */
     password: string | null;
     /**
-     * Se o link curto tem pré-redirecionamento.
+     * Whether the short link has pre-redirection.
      */
     preRedirection: boolean;
     /**
-     * O ID do projeto do link curto.
+     * The ID of the project of the short link.
      */
     projectId: string;
     /**
-     * Se o link curto usa o recurso de Visualização de link personalizado.
+     * Whether the short link uses the custom link preview feature.
      */
     proxy: boolean;
     /**
-     * Se as estatísticas do link curto são publicamente acessíveis.
+     * Whether the short link statistics are publicly accessible.
      */
     publicStats: boolean;
     /**
-     * Se o link curto usa camuflagem de link.
+     * Whether the short link uses link cloaking.
      */
     rewrite: boolean;
     /**
@@ -208,61 +207,61 @@ export interface Link {
      */
     saleAmount: number;
     /**
-     * O número de vendas geradas pelo link curto.
+     * The number of sales generated by the short link.
      */
     sales: number;
     /**
-     * @deprecated [DESCONTINUADO (use `tags` em vez disso)]: O ID único da tag
-     * atribuída ao link curto.
+     * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
+     * to the short link.
      */
     tagId: string | null;
     /**
-     * As tags atribuídas ao link curto.
+     * The tags assigned to the short link.
      */
     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.
+     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     title: string | null;
     /**
-     * [BETA] Se deve rastrear conversões para o link curto.
+     * [BETA] Whether to track conversions for the short link.
      */
     trackConversion: boolean;
     /**
-     * A data e hora em que o link curto foi atualizado pela última vez.
+     * The date and time when the short link was last updated.
      */
     updatedAt: string;
     /**
-     * A URL de destino do link curto.
+     * The destination URL of the short link.
      */
     url: string;
     /**
-     * O ID do usuário que criou o link curto.
+     * The ID of the user who created the short link.
      */
     userId: string;
     /**
-     * A campanha UTM do link curto.
+     * The UTM campaign of the short link.
      */
     utm_campaign: string | null;
     /**
-     * O conteúdo UTM do link curto.
+     * The UTM content of the short link.
      */
     utm_content: string | null;
     /**
-     * O meio UTM do link curto.
+     * The UTM medium of the short link.
      */
     utm_medium: string | null;
     /**
-     * A fonte UTM do link curto.
+     * The UTM source of the short link.
      */
     utm_source: string | null;
     /**
-     * O termo UTM do link curto.
+     * The UTM term of the short link.
      */
     utm_term: string | null;
     /**
-     * O vídeo do link curto.
+     * The video of the short link.
      */
     video: string | null;
     /**
@@ -274,12 +273,12 @@ export interface Link {
      */
     pageUrl?: string | null;
     /**
-     * A URL completa do código QR para o link curto (por exemplo,
+     * The complete QR code URL for the short link (for example,
      * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
      */
     qrCode?: string;
     /**
-     * A URL completa do link curto, incluindo o protocolo https (por exemplo,
+     * The complete URL of the short link, including the https protocol (for example,
      * `https://codeqr.link/try`).
      */
     shortLink?: string;
@@ -297,68 +296,67 @@ export interface LinkDeleteResponse {
 export type LinkCountResponse = number;
 export interface LinkCreateParams {
     /**
-     * A URL de destino do link curto.
+     * The destination URL of the short link.
      */
     url: string;
     /**
-     * A URL de destino do Android para o link curto para segmentação de dispositivos
-     * Android.
+     * The Android destination URL for the short link for Android device targeting.
      */
     android?: string | null;
     /**
-     * Se o link curto está arquivado.
+     * Whether the short link is archived.
      */
     archived?: boolean;
     /**
-     * Os comentários para o link curto.
+     * The comments for the short link.
      */
     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.
+     * The description of the short link generated via `api.codeqr.io/metatags`. Will
+     * be used for custom link preview if `proxy` is true.
      */
     description?: string | null;
     /**
-     * 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
+     * Allow search engines to index your short link. Default is `false` if not
+     * provided. Learn more: 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).
+     * The domain of the short link. If not provided, the main domain of the project
+     * will be used (or `codeqr.link` if the project has no domains).
      */
     domain?: string;
     /**
-     * A URL para redirecionar quando o link curto expirar.
+     * The URL to redirect to when the short link expires.
      */
     expiredUrl?: string | null;
     /**
-     * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
-     * futuro.
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
      */
     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.
+     * This is the ID of the link in your database. If set, it can be used to identify
+     * the link in the future. Must be prefixed with `ext_` when passed as a query
+     * parameter.
      */
     externalId?: string | null;
     /**
-     * Se o link curto é flexível.
+     * Whether the short link is flexible.
      */
     flexible?: boolean;
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.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.
+     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     image?: string | null;
     /**
-     * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+     * The iOS destination URL for the short link for iOS device targeting.
      */
     ios?: string | null;
     /**
@@ -366,8 +364,8 @@ export interface LinkCreateParams {
      */
     isFormMandatory?: boolean;
     /**
-     * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
-     * será gerado.
+     * The slug of the short link. If not provided, a random 7-character slug will be
+     * generated.
      */
     key?: string;
     /**
@@ -379,56 +377,55 @@ export interface LinkCreateParams {
      */
     pageUrl?: string | null;
     /**
-     * A senha necessária para acessar a URL de destino do link curto.
+     * The password required to access the short link destination URL.
      */
     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.
+     * The prefix of the short link slug for randomly generated keys (for example, if
+     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
+     * be ignored if `key` is provided.
      */
     prefix?: string;
     /**
-     * Se o link curto tem pré-redirecionamento.
+     * Whether the short link has pre-redirection.
      */
     preRedirection?: boolean;
     /**
-     * Se o link curto usa o recurso de Visualização de link personalizado.
+     * Whether the short link uses the custom link preview feature.
      */
     proxy?: boolean;
     /**
-     * Se as estatísticas do link curto são publicamente acessíveis.
+     * Whether the short link statistics are publicly accessible.
      */
     publicStats?: boolean;
     /**
-     * Se o link curto usa camuflagem de link.
+     * Whether the short link uses link cloaking.
      */
     rewrite?: boolean;
     /**
-     * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
-     * – use `tagIds` em vez disso.
+     * @deprecated The unique ID of the tag assigned to the short link. This field is
+     * deprecated – use `tagIds` instead.
      */
     tagId?: string | null;
     /**
-     * Os IDs únicos das tags atribuídas ao link curto.
+     * The unique IDs of the tags assigned to the short link.
      */
     tagIds?: string | Array<string>;
     /**
-     * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
-     * minúsculas).
+     * The unique name of the tags assigned to the short link (case insensitive).
      */
     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.
+     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     title?: string | null;
     /**
-     * Se deve rastrear conversões para o link curto.
+     * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
     /**
-     * O vídeo do link curto.
+     * The video of the short link.
      */
     video?: string | null;
     /**
@@ -439,8 +436,8 @@ export interface LinkCreateParams {
 }
 export declare namespace LinkCreateParams {
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`.
      */
     interface Geo {
         AD?: string;
@@ -697,64 +694,63 @@ export declare namespace LinkCreateParams {
 }
 export interface LinkUpdateParams {
     /**
-     * A URL de destino do Android para o link curto para segmentação de dispositivos
-     * Android.
+     * The Android destination URL for the short link for Android device targeting.
      */
     android?: string | null;
     /**
-     * Se o link curto está arquivado.
+     * Whether the short link is archived.
      */
     archived?: boolean;
     /**
-     * Os comentários para o link curto.
+     * The comments for the short link.
      */
     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.
+     * The description of the short link generated via `api.codeqr.io/metatags`. Will
+     * be used for custom link preview if `proxy` is true.
      */
     description?: string | null;
     /**
-     * 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
+     * Allow search engines to index your short link. Default is `false` if not
+     * provided. Learn more: 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).
+     * The domain of the short link. If not provided, the main domain of the project
+     * will be used (or `codeqr.link` if the project has no domains).
      */
     domain?: string;
     /**
-     * A URL para redirecionar quando o link curto expirar.
+     * The URL to redirect to when the short link expires.
      */
     expiredUrl?: string | null;
     /**
-     * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
-     * futuro.
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
      */
     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.
+     * This is the ID of the link in your database. If set, it can be used to identify
+     * the link in the future. Must be prefixed with `ext_` when passed as a query
+     * parameter.
      */
     externalId?: string | null;
     /**
-     * Se o link curto é flexível.
+     * Whether the short link is flexible.
      */
     flexible?: boolean;
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.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.
+     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     image?: string | null;
     /**
-     * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+     * The iOS destination URL for the short link for iOS device targeting.
      */
     ios?: string | null;
     /**
@@ -762,8 +758,8 @@ export interface LinkUpdateParams {
      */
     isFormMandatory?: boolean;
     /**
-     * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
-     * será gerado.
+     * The slug of the short link. If not provided, a random 7-character slug will be
+     * generated.
      */
     key?: string;
     /**
@@ -775,60 +771,59 @@ export interface LinkUpdateParams {
      */
     pageUrl?: string | null;
     /**
-     * A senha necessária para acessar a URL de destino do link curto.
+     * The password required to access the short link destination URL.
      */
     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.
+     * The prefix of the short link slug for randomly generated keys (for example, if
+     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
+     * be ignored if `key` is provided.
      */
     prefix?: string;
     /**
-     * Se o link curto tem pré-redirecionamento.
+     * Whether the short link has pre-redirection.
      */
     preRedirection?: boolean;
     /**
-     * Se o link curto usa o recurso de Visualização de link personalizado.
+     * Whether the short link uses the custom link preview feature.
      */
     proxy?: boolean;
     /**
-     * Se as estatísticas do link curto são publicamente acessíveis.
+     * Whether the short link statistics are publicly accessible.
      */
     publicStats?: boolean;
     /**
-     * Se o link curto usa camuflagem de link.
+     * Whether the short link uses link cloaking.
      */
     rewrite?: boolean;
     /**
-     * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
-     * – use `tagIds` em vez disso.
+     * @deprecated The unique ID of the tag assigned to the short link. This field is
+     * deprecated – use `tagIds` instead.
      */
     tagId?: string | null;
     /**
-     * Os IDs únicos das tags atribuídas ao link curto.
+     * The unique IDs of the tags assigned to the short link.
      */
     tagIds?: string | Array<string>;
     /**
-     * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
-     * minúsculas).
+     * The unique name of the tags assigned to the short link (case insensitive).
      */
     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.
+     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     title?: string | null;
     /**
-     * Se deve rastrear conversões para o link curto.
+     * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
     /**
-     * A URL de destino do link curto.
+     * The destination URL of the short link.
      */
     url?: string;
     /**
-     * O vídeo do link curto.
+     * The video of the short link.
      */
     video?: string | null;
     /**
@@ -839,8 +834,8 @@ export interface LinkUpdateParams {
 }
 export declare namespace LinkUpdateParams {
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`.
      */
     interface Geo {
         AD?: string;
@@ -1894,23 +1889,23 @@ export declare namespace LinkCountParams {
 }
 export interface LinkRetrieveInfoParams {
     /**
-     * O domínio do link a ser recuperado. Por exemplo, para `codeqr.link/github`, o
-     * domínio é `codeqr.link`.
+     * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
+     * the domain is `codeqr.link`.
      */
     domain: string;
     /**
-     * A chave do link a ser recuperado. Por exemplo, para `codeqr.link/github`, a
-     * chave é `github`.
+     * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
+     * key is `github`.
      */
     key: string;
     /**
-     * O slug do projeto ao qual o link pertence. Por exemplo, para
-     * `app.codeqr.io/acme`, o projectSlug é `acme`.
+     * The slug of the project to which the link belongs. For example, for
+     * `app.codeqr.io/acme`, the projectSlug is `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.
+     * This is the ID of the link in your database. Must be prefixed with `ext_` when
+     * passed as a query parameter.
      */
     externalId?: string;
     /**
@@ -1920,68 +1915,67 @@ export interface LinkRetrieveInfoParams {
 }
 export interface LinkUpsertParams {
     /**
-     * A URL de destino do link curto.
+     * The destination URL of the short link.
      */
     url: string;
     /**
-     * A URL de destino do Android para o link curto para segmentação de dispositivos
-     * Android.
+     * The Android destination URL for the short link for Android device targeting.
      */
     android?: string | null;
     /**
-     * Se o link curto está arquivado.
+     * Whether the short link is archived.
      */
     archived?: boolean;
     /**
-     * Os comentários para o link curto.
+     * The comments for the short link.
      */
     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.
+     * The description of the short link generated via `api.codeqr.io/metatags`. Will
+     * be used for custom link preview if `proxy` is true.
      */
     description?: string | null;
     /**
-     * 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
+     * Allow search engines to index your short link. Default is `false` if not
+     * provided. Learn more: 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).
+     * The domain of the short link. If not provided, the main domain of the project
+     * will be used (or `codeqr.link` if the project has no domains).
      */
     domain?: string;
     /**
-     * A URL para redirecionar quando o link curto expirar.
+     * The URL to redirect to when the short link expires.
      */
     expiredUrl?: string | null;
     /**
-     * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
-     * futuro.
+     * The date and time when the short link will expire in ISO-8601 format. Must be in
+     * the future.
      */
     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.
+     * This is the ID of the link in your database. If set, it can be used to identify
+     * the link in the future. Must be prefixed with `ext_` when passed as a query
+     * parameter.
      */
     externalId?: string | null;
     /**
-     * Se o link curto é flexível.
+     * Whether the short link is flexible.
      */
     flexible?: boolean;
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.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.
+     * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     image?: string | null;
     /**
-     * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
+     * The iOS destination URL for the short link for iOS device targeting.
      */
     ios?: string | null;
     /**
@@ -1989,8 +1983,8 @@ export interface LinkUpsertParams {
      */
     isFormMandatory?: boolean;
     /**
-     * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
-     * será gerado.
+     * The slug of the short link. If not provided, a random 7-character slug will be
+     * generated.
      */
     key?: string;
     /**
@@ -2002,56 +1996,55 @@ export interface LinkUpsertParams {
      */
     pageUrl?: string | null;
     /**
-     * A senha necessária para acessar a URL de destino do link curto.
+     * The password required to access the short link destination URL.
      */
     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.
+     * The prefix of the short link slug for randomly generated keys (for example, if
+     * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
+     * be ignored if `key` is provided.
      */
     prefix?: string;
     /**
-     * Se o link curto tem pré-redirecionamento.
+     * Whether the short link has pre-redirection.
      */
     preRedirection?: boolean;
     /**
-     * Se o link curto usa o recurso de Visualização de link personalizado.
+     * Whether the short link uses the custom link preview feature.
      */
     proxy?: boolean;
     /**
-     * Se as estatísticas do link curto são publicamente acessíveis.
+     * Whether the short link statistics are publicly accessible.
      */
     publicStats?: boolean;
     /**
-     * Se o link curto usa camuflagem de link.
+     * Whether the short link uses link cloaking.
      */
     rewrite?: boolean;
     /**
-     * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
-     * – use `tagIds` em vez disso.
+     * @deprecated The unique ID of the tag assigned to the short link. This field is
+     * deprecated – use `tagIds` instead.
      */
     tagId?: string | null;
     /**
-     * Os IDs únicos das tags atribuídas ao link curto.
+     * The unique IDs of the tags assigned to the short link.
      */
     tagIds?: string | Array<string>;
     /**
-     * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
-     * minúsculas).
+     * The unique name of the tags assigned to the short link (case insensitive).
      */
     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.
+     * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
+     * for custom link preview if `proxy` is true.
      */
     title?: string | null;
     /**
-     * Se deve rastrear conversões para o link curto.
+     * Whether to track conversions for the short link.
      */
     trackConversion?: boolean;
     /**
-     * O vídeo do link curto.
+     * The video of the short link.
      */
     video?: string | null;
     /**
@@ -2062,8 +2055,8 @@ export interface LinkUpsertParams {
 }
 export declare namespace LinkUpsertParams {
     /**
-     * Informações de segmentação geográfica para o link curto no formato JSON
-     * `{[PAÍS]: https://exemplo.com }`.
+     * Geographic targeting information for the short link in JSON format
+     * `{[COUNTRY]: https://example.com }`.
      */
     interface Geo {
         AD?: string;