@codeqr/ts 0.1.2 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -83,55 +83,54 @@ export declare class Links extends APIResource {
83
83
  }
84
84
  export interface Link {
85
85
  /**
86
- * O ID único do link curto.
86
+ * The unique ID of the short link.
87
87
  */
88
88
  id: string;
89
89
  /**
90
- * A URL de destino do Android para o link curto para segmentação de dispositivos
91
- * Android.
90
+ * The Android destination URL for the short link for Android device targeting.
92
91
  */
93
92
  android: string | null;
94
93
  /**
95
- * Se o link curto está arquivado.
94
+ * Whether the short link is archived.
96
95
  */
97
96
  archived: boolean;
98
97
  /**
99
- * O número de cliques no link curto.
98
+ * The number of clicks on the short link.
100
99
  */
101
100
  clicks: number;
102
101
  /**
103
- * Os comentários para o link curto.
102
+ * The comments for the short link.
104
103
  */
105
104
  comments: string | null;
106
105
  /**
107
- * A data e hora em que o link curto foi criado.
106
+ * The date and time when the short link was created.
108
107
  */
109
108
  createdAt: string;
110
109
  /**
111
- * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
112
- * Visualização de link personalizado se `proxy` for verdadeiro.
110
+ * The description of the short link generated via `api.codeqr.io/metatags`. Will
111
+ * be used for custom link preview if `proxy` is true.
113
112
  */
114
113
  description: string | null;
115
114
  /**
116
- * Se os mecanismos de busca podem indexar o link curto.
115
+ * Whether search engines can index the short link.
117
116
  */
118
117
  doIndex: boolean;
119
118
  /**
120
- * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
121
- * será usado (ou `codeqr.link` se o projeto não tiver domínios).
119
+ * The domain of the short link. If not provided, the main domain of the project
120
+ * will be used (or `codeqr.link` if the project has no domains).
122
121
  */
123
122
  domain: string;
124
123
  /**
125
- * A URL para redirecionar quando o link curto expirar.
124
+ * The URL to redirect to when the short link expires.
126
125
  */
127
126
  expiredUrl: string | null;
128
127
  /**
129
- * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
130
- * futuro.
128
+ * The date and time when the short link will expire in ISO-8601 format. Must be in
129
+ * the future.
131
130
  */
132
131
  expiresAt: string | null;
133
132
  /**
134
- * Este é o ID do link no seu banco de dados.
133
+ * This is the ID of the link in your database.
135
134
  */
136
135
  externalId: string | null;
137
136
  /**
@@ -139,23 +138,23 @@ export interface Link {
139
138
  */
140
139
  filled: boolean;
141
140
  /**
142
- * Se o link curto é flexível.
141
+ * Whether the short link is flexible.
143
142
  */
144
143
  flexible: boolean;
145
144
  /**
146
- * Informações de segmentação geográfica para o link curto no formato JSON
147
- * `{[PAÍS]: https://exemplo.com }`. Saiba mais: https://codeqr.link/geo
145
+ * Geographic targeting information for the short link in JSON format
146
+ * `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
148
147
  */
149
148
  geo: {
150
149
  [key: string]: string;
151
150
  } | null;
152
151
  /**
153
- * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
154
- * Visualização de link personalizado se `proxy` for verdadeiro.
152
+ * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
153
+ * for custom link preview if `proxy` is true.
155
154
  */
156
155
  image: string | null;
157
156
  /**
158
- * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
157
+ * The iOS destination URL for the short link for iOS device targeting.
159
158
  */
160
159
  ios: string | null;
161
160
  /**
@@ -163,44 +162,44 @@ export interface Link {
163
162
  */
164
163
  isFormMandatory: boolean;
165
164
  /**
166
- * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
167
- * será gerado.
165
+ * The slug of the short link. If not provided, a random 7-character slug will be
166
+ * generated.
168
167
  */
169
168
  key: string;
170
169
  /**
171
- * A data e hora em que o link curto foi clicado pela última vez.
170
+ * The date and time when the short link was last clicked.
172
171
  */
173
172
  lastClicked: string | null;
174
173
  /**
175
- * O número de leads gerados pelo link curto.
174
+ * The number of leads generated by the short link.
176
175
  */
177
176
  leads: number;
178
177
  /**
179
- * O token de notificação do link curto.
178
+ * The notification token of the short link.
180
179
  */
181
180
  notificationToken: string | null;
182
181
  /**
183
- * A senha necessária para acessar a URL de destino do link curto.
182
+ * The password required to access the short link destination URL.
184
183
  */
185
184
  password: string | null;
186
185
  /**
187
- * Se o link curto tem pré-redirecionamento.
186
+ * Whether the short link has pre-redirection.
188
187
  */
189
188
  preRedirection: boolean;
190
189
  /**
191
- * O ID do projeto do link curto.
190
+ * The ID of the project of the short link.
192
191
  */
193
192
  projectId: string;
194
193
  /**
195
- * Se o link curto usa o recurso de Visualização de link personalizado.
194
+ * Whether the short link uses the custom link preview feature.
196
195
  */
197
196
  proxy: boolean;
198
197
  /**
199
- * Se as estatísticas do link curto são publicamente acessíveis.
198
+ * Whether the short link statistics are publicly accessible.
200
199
  */
201
200
  publicStats: boolean;
202
201
  /**
203
- * Se o link curto usa camuflagem de link.
202
+ * Whether the short link uses link cloaking.
204
203
  */
205
204
  rewrite: boolean;
206
205
  /**
@@ -208,61 +207,61 @@ export interface Link {
208
207
  */
209
208
  saleAmount: number;
210
209
  /**
211
- * O número de vendas geradas pelo link curto.
210
+ * The number of sales generated by the short link.
212
211
  */
213
212
  sales: number;
214
213
  /**
215
- * @deprecated [DESCONTINUADO (use `tags` em vez disso)]: O ID único da tag
216
- * atribuída ao link curto.
214
+ * @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
215
+ * to the short link.
217
216
  */
218
217
  tagId: string | null;
219
218
  /**
220
- * As tags atribuídas ao link curto.
219
+ * The tags assigned to the short link.
221
220
  */
222
221
  tags: Array<TagsAPI.Tag> | null;
223
222
  /**
224
- * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
225
- * Visualização de link personalizado se `proxy` for verdadeiro.
223
+ * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
224
+ * for custom link preview if `proxy` is true.
226
225
  */
227
226
  title: string | null;
228
227
  /**
229
- * [BETA] Se deve rastrear conversões para o link curto.
228
+ * [BETA] Whether to track conversions for the short link.
230
229
  */
231
230
  trackConversion: boolean;
232
231
  /**
233
- * A data e hora em que o link curto foi atualizado pela última vez.
232
+ * The date and time when the short link was last updated.
234
233
  */
235
234
  updatedAt: string;
236
235
  /**
237
- * A URL de destino do link curto.
236
+ * The destination URL of the short link.
238
237
  */
239
238
  url: string;
240
239
  /**
241
- * O ID do usuário que criou o link curto.
240
+ * The ID of the user who created the short link.
242
241
  */
243
242
  userId: string;
244
243
  /**
245
- * A campanha UTM do link curto.
244
+ * The UTM campaign of the short link.
246
245
  */
247
246
  utm_campaign: string | null;
248
247
  /**
249
- * O conteúdo UTM do link curto.
248
+ * The UTM content of the short link.
250
249
  */
251
250
  utm_content: string | null;
252
251
  /**
253
- * O meio UTM do link curto.
252
+ * The UTM medium of the short link.
254
253
  */
255
254
  utm_medium: string | null;
256
255
  /**
257
- * A fonte UTM do link curto.
256
+ * The UTM source of the short link.
258
257
  */
259
258
  utm_source: string | null;
260
259
  /**
261
- * O termo UTM do link curto.
260
+ * The UTM term of the short link.
262
261
  */
263
262
  utm_term: string | null;
264
263
  /**
265
- * O vídeo do link curto.
264
+ * The video of the short link.
266
265
  */
267
266
  video: string | null;
268
267
  /**
@@ -274,12 +273,12 @@ export interface Link {
274
273
  */
275
274
  pageUrl?: string | null;
276
275
  /**
277
- * A URL completa do código QR para o link curto (por exemplo,
276
+ * The complete QR code URL for the short link (for example,
278
277
  * `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
279
278
  */
280
279
  qrCode?: string;
281
280
  /**
282
- * A URL completa do link curto, incluindo o protocolo https (por exemplo,
281
+ * The complete URL of the short link, including the https protocol (for example,
283
282
  * `https://codeqr.link/try`).
284
283
  */
285
284
  shortLink?: string;
@@ -297,68 +296,67 @@ export interface LinkDeleteResponse {
297
296
  export type LinkCountResponse = number;
298
297
  export interface LinkCreateParams {
299
298
  /**
300
- * A URL de destino do link curto.
299
+ * The destination URL of the short link.
301
300
  */
302
301
  url: string;
303
302
  /**
304
- * A URL de destino do Android para o link curto para segmentação de dispositivos
305
- * Android.
303
+ * The Android destination URL for the short link for Android device targeting.
306
304
  */
307
305
  android?: string | null;
308
306
  /**
309
- * Se o link curto está arquivado.
307
+ * Whether the short link is archived.
310
308
  */
311
309
  archived?: boolean;
312
310
  /**
313
- * Os comentários para o link curto.
311
+ * The comments for the short link.
314
312
  */
315
313
  comments?: string | null;
316
314
  /**
317
- * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
318
- * Visualização de link personalizado se `proxy` for verdadeiro.
315
+ * The description of the short link generated via `api.codeqr.io/metatags`. Will
316
+ * be used for custom link preview if `proxy` is true.
319
317
  */
320
318
  description?: string | null;
321
319
  /**
322
- * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
323
- * se não for fornecido. Saiba mais: https://codeqr.link/noindex
320
+ * Allow search engines to index your short link. Default is `false` if not
321
+ * provided. Learn more: https://codeqr.link/noindex
324
322
  */
325
323
  doIndex?: boolean;
326
324
  /**
327
- * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
328
- * será usado (ou `codeqr.link` se o projeto não tiver domínios).
325
+ * The domain of the short link. If not provided, the main domain of the project
326
+ * will be used (or `codeqr.link` if the project has no domains).
329
327
  */
330
328
  domain?: string;
331
329
  /**
332
- * A URL para redirecionar quando o link curto expirar.
330
+ * The URL to redirect to when the short link expires.
333
331
  */
334
332
  expiredUrl?: string | null;
335
333
  /**
336
- * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
337
- * futuro.
334
+ * The date and time when the short link will expire in ISO-8601 format. Must be in
335
+ * the future.
338
336
  */
339
337
  expiresAt?: string | null;
340
338
  /**
341
- * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
342
- * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
343
- * um parâmetro de consulta.
339
+ * This is the ID of the link in your database. If set, it can be used to identify
340
+ * the link in the future. Must be prefixed with `ext_` when passed as a query
341
+ * parameter.
344
342
  */
345
343
  externalId?: string | null;
346
344
  /**
347
- * Se o link curto é flexível.
345
+ * Whether the short link is flexible.
348
346
  */
349
347
  flexible?: boolean;
350
348
  /**
351
- * Informações de segmentação geográfica para o link curto no formato JSON
352
- * `{[PAÍS]: https://exemplo.com }`.
349
+ * Geographic targeting information for the short link in JSON format
350
+ * `{[COUNTRY]: https://example.com }`.
353
351
  */
354
352
  geo?: LinkCreateParams.Geo | null;
355
353
  /**
356
- * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
357
- * Visualização de link personalizado se `proxy` for verdadeiro.
354
+ * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
355
+ * for custom link preview if `proxy` is true.
358
356
  */
359
357
  image?: string | null;
360
358
  /**
361
- * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
359
+ * The iOS destination URL for the short link for iOS device targeting.
362
360
  */
363
361
  ios?: string | null;
364
362
  /**
@@ -366,8 +364,8 @@ export interface LinkCreateParams {
366
364
  */
367
365
  isFormMandatory?: boolean;
368
366
  /**
369
- * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
370
- * será gerado.
367
+ * The slug of the short link. If not provided, a random 7-character slug will be
368
+ * generated.
371
369
  */
372
370
  key?: string;
373
371
  /**
@@ -379,56 +377,55 @@ export interface LinkCreateParams {
379
377
  */
380
378
  pageUrl?: string | null;
381
379
  /**
382
- * A senha necessária para acessar a URL de destino do link curto.
380
+ * The password required to access the short link destination URL.
383
381
  */
384
382
  password?: string | null;
385
383
  /**
386
- * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
387
- * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
388
- * ignorado se `key` for fornecido.
384
+ * The prefix of the short link slug for randomly generated keys (for example, if
385
+ * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
386
+ * be ignored if `key` is provided.
389
387
  */
390
388
  prefix?: string;
391
389
  /**
392
- * Se o link curto tem pré-redirecionamento.
390
+ * Whether the short link has pre-redirection.
393
391
  */
394
392
  preRedirection?: boolean;
395
393
  /**
396
- * Se o link curto usa o recurso de Visualização de link personalizado.
394
+ * Whether the short link uses the custom link preview feature.
397
395
  */
398
396
  proxy?: boolean;
399
397
  /**
400
- * Se as estatísticas do link curto são publicamente acessíveis.
398
+ * Whether the short link statistics are publicly accessible.
401
399
  */
402
400
  publicStats?: boolean;
403
401
  /**
404
- * Se o link curto usa camuflagem de link.
402
+ * Whether the short link uses link cloaking.
405
403
  */
406
404
  rewrite?: boolean;
407
405
  /**
408
- * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
409
- * – use `tagIds` em vez disso.
406
+ * @deprecated The unique ID of the tag assigned to the short link. This field is
407
+ * deprecated – use `tagIds` instead.
410
408
  */
411
409
  tagId?: string | null;
412
410
  /**
413
- * Os IDs únicos das tags atribuídas ao link curto.
411
+ * The unique IDs of the tags assigned to the short link.
414
412
  */
415
413
  tagIds?: string | Array<string>;
416
414
  /**
417
- * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
418
- * minúsculas).
415
+ * The unique name of the tags assigned to the short link (case insensitive).
419
416
  */
420
417
  tagNames?: string | Array<string>;
421
418
  /**
422
- * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
423
- * Visualização de link personalizado se `proxy` for verdadeiro.
419
+ * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
420
+ * for custom link preview if `proxy` is true.
424
421
  */
425
422
  title?: string | null;
426
423
  /**
427
- * Se deve rastrear conversões para o link curto.
424
+ * Whether to track conversions for the short link.
428
425
  */
429
426
  trackConversion?: boolean;
430
427
  /**
431
- * O vídeo do link curto.
428
+ * The video of the short link.
432
429
  */
433
430
  video?: string | null;
434
431
  /**
@@ -439,8 +436,8 @@ export interface LinkCreateParams {
439
436
  }
440
437
  export declare namespace LinkCreateParams {
441
438
  /**
442
- * Informações de segmentação geográfica para o link curto no formato JSON
443
- * `{[PAÍS]: https://exemplo.com }`.
439
+ * Geographic targeting information for the short link in JSON format
440
+ * `{[COUNTRY]: https://example.com }`.
444
441
  */
445
442
  interface Geo {
446
443
  AD?: string;
@@ -697,64 +694,63 @@ export declare namespace LinkCreateParams {
697
694
  }
698
695
  export interface LinkUpdateParams {
699
696
  /**
700
- * A URL de destino do Android para o link curto para segmentação de dispositivos
701
- * Android.
697
+ * The Android destination URL for the short link for Android device targeting.
702
698
  */
703
699
  android?: string | null;
704
700
  /**
705
- * Se o link curto está arquivado.
701
+ * Whether the short link is archived.
706
702
  */
707
703
  archived?: boolean;
708
704
  /**
709
- * Os comentários para o link curto.
705
+ * The comments for the short link.
710
706
  */
711
707
  comments?: string | null;
712
708
  /**
713
- * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
714
- * Visualização de link personalizado se `proxy` for verdadeiro.
709
+ * The description of the short link generated via `api.codeqr.io/metatags`. Will
710
+ * be used for custom link preview if `proxy` is true.
715
711
  */
716
712
  description?: string | null;
717
713
  /**
718
- * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
719
- * se não for fornecido. Saiba mais: https://codeqr.link/noindex
714
+ * Allow search engines to index your short link. Default is `false` if not
715
+ * provided. Learn more: https://codeqr.link/noindex
720
716
  */
721
717
  doIndex?: boolean;
722
718
  /**
723
- * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
724
- * será usado (ou `codeqr.link` se o projeto não tiver domínios).
719
+ * The domain of the short link. If not provided, the main domain of the project
720
+ * will be used (or `codeqr.link` if the project has no domains).
725
721
  */
726
722
  domain?: string;
727
723
  /**
728
- * A URL para redirecionar quando o link curto expirar.
724
+ * The URL to redirect to when the short link expires.
729
725
  */
730
726
  expiredUrl?: string | null;
731
727
  /**
732
- * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
733
- * futuro.
728
+ * The date and time when the short link will expire in ISO-8601 format. Must be in
729
+ * the future.
734
730
  */
735
731
  expiresAt?: string | null;
736
732
  /**
737
- * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
738
- * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
739
- * um parâmetro de consulta.
733
+ * This is the ID of the link in your database. If set, it can be used to identify
734
+ * the link in the future. Must be prefixed with `ext_` when passed as a query
735
+ * parameter.
740
736
  */
741
737
  externalId?: string | null;
742
738
  /**
743
- * Se o link curto é flexível.
739
+ * Whether the short link is flexible.
744
740
  */
745
741
  flexible?: boolean;
746
742
  /**
747
- * Informações de segmentação geográfica para o link curto no formato JSON
748
- * `{[PAÍS]: https://exemplo.com }`.
743
+ * Geographic targeting information for the short link in JSON format
744
+ * `{[COUNTRY]: https://example.com }`.
749
745
  */
750
746
  geo?: LinkUpdateParams.Geo | null;
751
747
  /**
752
- * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
753
- * Visualização de link personalizado se `proxy` for verdadeiro.
748
+ * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
749
+ * for custom link preview if `proxy` is true.
754
750
  */
755
751
  image?: string | null;
756
752
  /**
757
- * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
753
+ * The iOS destination URL for the short link for iOS device targeting.
758
754
  */
759
755
  ios?: string | null;
760
756
  /**
@@ -762,8 +758,8 @@ export interface LinkUpdateParams {
762
758
  */
763
759
  isFormMandatory?: boolean;
764
760
  /**
765
- * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
766
- * será gerado.
761
+ * The slug of the short link. If not provided, a random 7-character slug will be
762
+ * generated.
767
763
  */
768
764
  key?: string;
769
765
  /**
@@ -775,60 +771,59 @@ export interface LinkUpdateParams {
775
771
  */
776
772
  pageUrl?: string | null;
777
773
  /**
778
- * A senha necessária para acessar a URL de destino do link curto.
774
+ * The password required to access the short link destination URL.
779
775
  */
780
776
  password?: string | null;
781
777
  /**
782
- * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
783
- * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
784
- * ignorado se `key` for fornecido.
778
+ * The prefix of the short link slug for randomly generated keys (for example, if
779
+ * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
780
+ * be ignored if `key` is provided.
785
781
  */
786
782
  prefix?: string;
787
783
  /**
788
- * Se o link curto tem pré-redirecionamento.
784
+ * Whether the short link has pre-redirection.
789
785
  */
790
786
  preRedirection?: boolean;
791
787
  /**
792
- * Se o link curto usa o recurso de Visualização de link personalizado.
788
+ * Whether the short link uses the custom link preview feature.
793
789
  */
794
790
  proxy?: boolean;
795
791
  /**
796
- * Se as estatísticas do link curto são publicamente acessíveis.
792
+ * Whether the short link statistics are publicly accessible.
797
793
  */
798
794
  publicStats?: boolean;
799
795
  /**
800
- * Se o link curto usa camuflagem de link.
796
+ * Whether the short link uses link cloaking.
801
797
  */
802
798
  rewrite?: boolean;
803
799
  /**
804
- * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
805
- * – use `tagIds` em vez disso.
800
+ * @deprecated The unique ID of the tag assigned to the short link. This field is
801
+ * deprecated – use `tagIds` instead.
806
802
  */
807
803
  tagId?: string | null;
808
804
  /**
809
- * Os IDs únicos das tags atribuídas ao link curto.
805
+ * The unique IDs of the tags assigned to the short link.
810
806
  */
811
807
  tagIds?: string | Array<string>;
812
808
  /**
813
- * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
814
- * minúsculas).
809
+ * The unique name of the tags assigned to the short link (case insensitive).
815
810
  */
816
811
  tagNames?: string | Array<string>;
817
812
  /**
818
- * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
819
- * Visualização de link personalizado se `proxy` for verdadeiro.
813
+ * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
814
+ * for custom link preview if `proxy` is true.
820
815
  */
821
816
  title?: string | null;
822
817
  /**
823
- * Se deve rastrear conversões para o link curto.
818
+ * Whether to track conversions for the short link.
824
819
  */
825
820
  trackConversion?: boolean;
826
821
  /**
827
- * A URL de destino do link curto.
822
+ * The destination URL of the short link.
828
823
  */
829
824
  url?: string;
830
825
  /**
831
- * O vídeo do link curto.
826
+ * The video of the short link.
832
827
  */
833
828
  video?: string | null;
834
829
  /**
@@ -839,8 +834,8 @@ export interface LinkUpdateParams {
839
834
  }
840
835
  export declare namespace LinkUpdateParams {
841
836
  /**
842
- * Informações de segmentação geográfica para o link curto no formato JSON
843
- * `{[PAÍS]: https://exemplo.com }`.
837
+ * Geographic targeting information for the short link in JSON format
838
+ * `{[COUNTRY]: https://example.com }`.
844
839
  */
845
840
  interface Geo {
846
841
  AD?: string;
@@ -1894,23 +1889,23 @@ export declare namespace LinkCountParams {
1894
1889
  }
1895
1890
  export interface LinkRetrieveInfoParams {
1896
1891
  /**
1897
- * O domínio do link a ser recuperado. Por exemplo, para `codeqr.link/github`, o
1898
- * domínio é `codeqr.link`.
1892
+ * The domain of the link to be retrieved. For example, for `codeqr.link/github`,
1893
+ * the domain is `codeqr.link`.
1899
1894
  */
1900
1895
  domain: string;
1901
1896
  /**
1902
- * A chave do link a ser recuperado. Por exemplo, para `codeqr.link/github`, a
1903
- * chave é `github`.
1897
+ * The key of the link to be retrieved. For example, for `codeqr.link/github`, the
1898
+ * key is `github`.
1904
1899
  */
1905
1900
  key: string;
1906
1901
  /**
1907
- * O slug do projeto ao qual o link pertence. Por exemplo, para
1908
- * `app.codeqr.io/acme`, o projectSlug é `acme`.
1902
+ * The slug of the project to which the link belongs. For example, for
1903
+ * `app.codeqr.io/acme`, the projectSlug is `acme`.
1909
1904
  */
1910
1905
  projectSlug: string;
1911
1906
  /**
1912
- * Este é o ID do link no seu banco de dados. Deve ser prefixado com `ext_` quando
1913
- * passado como um parâmetro de consulta.
1907
+ * This is the ID of the link in your database. Must be prefixed with `ext_` when
1908
+ * passed as a query parameter.
1914
1909
  */
1915
1910
  externalId?: string;
1916
1911
  /**
@@ -1920,68 +1915,67 @@ export interface LinkRetrieveInfoParams {
1920
1915
  }
1921
1916
  export interface LinkUpsertParams {
1922
1917
  /**
1923
- * A URL de destino do link curto.
1918
+ * The destination URL of the short link.
1924
1919
  */
1925
1920
  url: string;
1926
1921
  /**
1927
- * A URL de destino do Android para o link curto para segmentação de dispositivos
1928
- * Android.
1922
+ * The Android destination URL for the short link for Android device targeting.
1929
1923
  */
1930
1924
  android?: string | null;
1931
1925
  /**
1932
- * Se o link curto está arquivado.
1926
+ * Whether the short link is archived.
1933
1927
  */
1934
1928
  archived?: boolean;
1935
1929
  /**
1936
- * Os comentários para o link curto.
1930
+ * The comments for the short link.
1937
1931
  */
1938
1932
  comments?: string | null;
1939
1933
  /**
1940
- * A descrição do link curto gerada via `api.codeqr.io/metatags`. Será usada para
1941
- * Visualização de link personalizado se `proxy` for verdadeiro.
1934
+ * The description of the short link generated via `api.codeqr.io/metatags`. Will
1935
+ * be used for custom link preview if `proxy` is true.
1942
1936
  */
1943
1937
  description?: string | null;
1944
1938
  /**
1945
- * Permitir que os mecanismos de busca indexem seu link curto. O padrão é `false`
1946
- * se não for fornecido. Saiba mais: https://codeqr.link/noindex
1939
+ * Allow search engines to index your short link. Default is `false` if not
1940
+ * provided. Learn more: https://codeqr.link/noindex
1947
1941
  */
1948
1942
  doIndex?: boolean;
1949
1943
  /**
1950
- * O domínio do link curto. Se não for fornecido, o domínio principal do projeto
1951
- * será usado (ou `codeqr.link` se o projeto não tiver domínios).
1944
+ * The domain of the short link. If not provided, the main domain of the project
1945
+ * will be used (or `codeqr.link` if the project has no domains).
1952
1946
  */
1953
1947
  domain?: string;
1954
1948
  /**
1955
- * A URL para redirecionar quando o link curto expirar.
1949
+ * The URL to redirect to when the short link expires.
1956
1950
  */
1957
1951
  expiredUrl?: string | null;
1958
1952
  /**
1959
- * A data e hora em que o link curto expirará no formato ISO-8601. Deve estar no
1960
- * futuro.
1953
+ * The date and time when the short link will expire in ISO-8601 format. Must be in
1954
+ * the future.
1961
1955
  */
1962
1956
  expiresAt?: string | null;
1963
1957
  /**
1964
- * Este é o ID do link no seu banco de dados. Se definido, pode ser usado para
1965
- * identificar o link no futuro. Deve ser prefixado com `ext_` quando passado como
1966
- * um parâmetro de consulta.
1958
+ * This is the ID of the link in your database. If set, it can be used to identify
1959
+ * the link in the future. Must be prefixed with `ext_` when passed as a query
1960
+ * parameter.
1967
1961
  */
1968
1962
  externalId?: string | null;
1969
1963
  /**
1970
- * Se o link curto é flexível.
1964
+ * Whether the short link is flexible.
1971
1965
  */
1972
1966
  flexible?: boolean;
1973
1967
  /**
1974
- * Informações de segmentação geográfica para o link curto no formato JSON
1975
- * `{[PAÍS]: https://exemplo.com }`.
1968
+ * Geographic targeting information for the short link in JSON format
1969
+ * `{[COUNTRY]: https://example.com }`.
1976
1970
  */
1977
1971
  geo?: LinkUpsertParams.Geo | null;
1978
1972
  /**
1979
- * A imagem do link curto gerada via `api.codeqr.io/metatags`. Será usada para
1980
- * Visualização de link personalizado se `proxy` for verdadeiro.
1973
+ * The image of the short link generated via `api.codeqr.io/metatags`. Will be used
1974
+ * for custom link preview if `proxy` is true.
1981
1975
  */
1982
1976
  image?: string | null;
1983
1977
  /**
1984
- * A URL de destino do iOS para o link curto para segmentação de dispositivos iOS.
1978
+ * The iOS destination URL for the short link for iOS device targeting.
1985
1979
  */
1986
1980
  ios?: string | null;
1987
1981
  /**
@@ -1989,8 +1983,8 @@ export interface LinkUpsertParams {
1989
1983
  */
1990
1984
  isFormMandatory?: boolean;
1991
1985
  /**
1992
- * O slug do link curto. Se não for fornecido, um slug aleatório de 7 caracteres
1993
- * será gerado.
1986
+ * The slug of the short link. If not provided, a random 7-character slug will be
1987
+ * generated.
1994
1988
  */
1995
1989
  key?: string;
1996
1990
  /**
@@ -2002,56 +1996,55 @@ export interface LinkUpsertParams {
2002
1996
  */
2003
1997
  pageUrl?: string | null;
2004
1998
  /**
2005
- * A senha necessária para acessar a URL de destino do link curto.
1999
+ * The password required to access the short link destination URL.
2006
2000
  */
2007
2001
  password?: string | null;
2008
2002
  /**
2009
- * O prefixo do slug do link curto para chaves geradas aleatoriamente (por exemplo,
2010
- * se o prefixo for `/c/`, as chaves geradas estarão no formato `/c/:key`). Será
2011
- * ignorado se `key` for fornecido.
2003
+ * The prefix of the short link slug for randomly generated keys (for example, if
2004
+ * the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
2005
+ * be ignored if `key` is provided.
2012
2006
  */
2013
2007
  prefix?: string;
2014
2008
  /**
2015
- * Se o link curto tem pré-redirecionamento.
2009
+ * Whether the short link has pre-redirection.
2016
2010
  */
2017
2011
  preRedirection?: boolean;
2018
2012
  /**
2019
- * Se o link curto usa o recurso de Visualização de link personalizado.
2013
+ * Whether the short link uses the custom link preview feature.
2020
2014
  */
2021
2015
  proxy?: boolean;
2022
2016
  /**
2023
- * Se as estatísticas do link curto são publicamente acessíveis.
2017
+ * Whether the short link statistics are publicly accessible.
2024
2018
  */
2025
2019
  publicStats?: boolean;
2026
2020
  /**
2027
- * Se o link curto usa camuflagem de link.
2021
+ * Whether the short link uses link cloaking.
2028
2022
  */
2029
2023
  rewrite?: boolean;
2030
2024
  /**
2031
- * @deprecated O ID único da tag atribuída ao link curto. Este campo está obsoleto
2032
- * – use `tagIds` em vez disso.
2025
+ * @deprecated The unique ID of the tag assigned to the short link. This field is
2026
+ * deprecated – use `tagIds` instead.
2033
2027
  */
2034
2028
  tagId?: string | null;
2035
2029
  /**
2036
- * Os IDs únicos das tags atribuídas ao link curto.
2030
+ * The unique IDs of the tags assigned to the short link.
2037
2031
  */
2038
2032
  tagIds?: string | Array<string>;
2039
2033
  /**
2040
- * O nome único das tags atribuídas ao link curto (não diferencia maiúsculas de
2041
- * minúsculas).
2034
+ * The unique name of the tags assigned to the short link (case insensitive).
2042
2035
  */
2043
2036
  tagNames?: string | Array<string>;
2044
2037
  /**
2045
- * O título do link curto gerado via `api.codeqr.io/metatags`. Será usado para
2046
- * Visualização de link personalizado se `proxy` for verdadeiro.
2038
+ * The title of the short link generated via `api.codeqr.io/metatags`. Will be used
2039
+ * for custom link preview if `proxy` is true.
2047
2040
  */
2048
2041
  title?: string | null;
2049
2042
  /**
2050
- * Se deve rastrear conversões para o link curto.
2043
+ * Whether to track conversions for the short link.
2051
2044
  */
2052
2045
  trackConversion?: boolean;
2053
2046
  /**
2054
- * O vídeo do link curto.
2047
+ * The video of the short link.
2055
2048
  */
2056
2049
  video?: string | null;
2057
2050
  /**
@@ -2062,8 +2055,8 @@ export interface LinkUpsertParams {
2062
2055
  }
2063
2056
  export declare namespace LinkUpsertParams {
2064
2057
  /**
2065
- * Informações de segmentação geográfica para o link curto no formato JSON
2066
- * `{[PAÍS]: https://exemplo.com }`.
2058
+ * Geographic targeting information for the short link in JSON format
2059
+ * `{[COUNTRY]: https://example.com }`.
2067
2060
  */
2068
2061
  interface Geo {
2069
2062
  AD?: string;