@codeqr/ts 0.1.2 → 0.2.0

package/src/resources/events.ts

@@ -127,47 +127,46 @@ export namespace EventListResponse {
 
     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;
 
       /**
-       * 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;
 
       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;
 
       /**
-       * 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;
 
       /**
-       * Este é o ID do link no seu banco de dados.
+       * This is the ID of the link in your database.
        */
       externalId: string | null;
 
@@ -177,24 +176,24 @@ export namespace EventListResponse {
       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;
 
@@ -204,35 +203,35 @@ export namespace EventListResponse {
       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;
 
       lastClicked: string;
 
       /**
-       * 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;
 
@@ -242,24 +241,24 @@ export namespace EventListResponse {
       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;
 
@@ -268,32 +267,32 @@ export namespace EventListResponse {
       userId: string | null;
 
       /**
-       * 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;
 
@@ -318,7 +317,7 @@ export namespace EventListResponse {
       publicStats?: boolean;
 
       /**
-       * 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;
@@ -326,7 +325,7 @@ export namespace EventListResponse {
       rewrite?: boolean;
 
       /**
-       * 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;
@@ -632,24 +631,24 @@ export namespace EventListResponse {
     export namespace Customer {
       export interface Link {
         /**
-         * O ID único do link curto.
+         * The unique ID of the short link.
          */
         id: string;
 
         /**
-         * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
-         * será usado (ou `codeqr.link` se o projeto não tiver domínios).
+         * 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;
 
         /**
-         * 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 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;
@@ -658,47 +657,46 @@ export namespace EventListResponse {
 
     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;
 
       /**
-       * 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;
 
       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;
 
       /**
-       * 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;
 
       /**
-       * Este é o ID do link no seu banco de dados.
+       * This is the ID of the link in your database.
        */
       externalId: string | null;
 
@@ -708,24 +706,24 @@ export namespace EventListResponse {
       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;
 
@@ -735,35 +733,35 @@ export namespace EventListResponse {
       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;
 
       lastClicked: string;
 
       /**
-       * 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;
 
@@ -773,24 +771,24 @@ export namespace EventListResponse {
       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;
 
@@ -799,32 +797,32 @@ export namespace EventListResponse {
       userId: string | null;
 
       /**
-       * 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;
 
@@ -849,7 +847,7 @@ export namespace EventListResponse {
       publicStats?: boolean;
 
       /**
-       * 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;
@@ -857,7 +855,7 @@ export namespace EventListResponse {
       rewrite?: boolean;
 
       /**
-       * 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;