@codeqr/ts 0.1.2 → 0.2.1

package/src/resources/links/bulk.ts

@@ -84,81 +84,80 @@ export interface BulkCreateParams {
 export namespace BulkCreateParams {
   export interface Body {
     /**
-     * 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?: Body.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;
 
@@ -168,8 +167,8 @@ export namespace BulkCreateParams {
     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;
 
@@ -184,67 +183,66 @@ export namespace BulkCreateParams {
     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;
 
@@ -257,8 +255,8 @@ export namespace BulkCreateParams {
 
   export namespace Body {
     /**
-     * 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 }`.
      */
     export interface Geo {
       AD?: string;