@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.
- package/CHANGELOG.md +16 -0
- package/package.json +1 -1
- package/resources/events.d.mts +80 -82
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +80 -82
- package/resources/events.d.ts.map +1 -1
- package/resources/links/bulk.d.mts +42 -44
- package/resources/links/bulk.d.mts.map +1 -1
- package/resources/links/bulk.d.ts +42 -44
- package/resources/links/bulk.d.ts.map +1 -1
- package/resources/links/links.d.mts +184 -191
- package/resources/links/links.d.mts.map +1 -1
- package/resources/links/links.d.ts +184 -191
- package/resources/links/links.d.ts.map +1 -1
- package/resources/links/links.js.map +1 -1
- package/resources/links/links.mjs.map +1 -1
- package/src/resources/events.ts +80 -82
- package/src/resources/links/bulk.ts +42 -44
- package/src/resources/links/links.ts +184 -191
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -119,66 +119,65 @@ export class Links extends APIResource {
|
|
|
119
119
|
|
|
120
120
|
export interface Link {
|
|
121
121
|
/**
|
|
122
|
-
*
|
|
122
|
+
* The unique ID of the short link.
|
|
123
123
|
*/
|
|
124
124
|
id: string;
|
|
125
125
|
|
|
126
126
|
/**
|
|
127
|
-
*
|
|
128
|
-
* Android.
|
|
127
|
+
* The Android destination URL for the short link for Android device targeting.
|
|
129
128
|
*/
|
|
130
129
|
android: string | null;
|
|
131
130
|
|
|
132
131
|
/**
|
|
133
|
-
*
|
|
132
|
+
* Whether the short link is archived.
|
|
134
133
|
*/
|
|
135
134
|
archived: boolean;
|
|
136
135
|
|
|
137
136
|
/**
|
|
138
|
-
*
|
|
137
|
+
* The number of clicks on the short link.
|
|
139
138
|
*/
|
|
140
139
|
clicks: number;
|
|
141
140
|
|
|
142
141
|
/**
|
|
143
|
-
*
|
|
142
|
+
* The comments for the short link.
|
|
144
143
|
*/
|
|
145
144
|
comments: string | null;
|
|
146
145
|
|
|
147
146
|
/**
|
|
148
|
-
*
|
|
147
|
+
* The date and time when the short link was created.
|
|
149
148
|
*/
|
|
150
149
|
createdAt: string;
|
|
151
150
|
|
|
152
151
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
152
|
+
* The description of the short link generated via `api.codeqr.io/metatags`. Will
|
|
153
|
+
* be used for custom link preview if `proxy` is true.
|
|
155
154
|
*/
|
|
156
155
|
description: string | null;
|
|
157
156
|
|
|
158
157
|
/**
|
|
159
|
-
*
|
|
158
|
+
* Whether search engines can index the short link.
|
|
160
159
|
*/
|
|
161
160
|
doIndex: boolean;
|
|
162
161
|
|
|
163
162
|
/**
|
|
164
|
-
*
|
|
165
|
-
*
|
|
163
|
+
* The domain of the short link. If not provided, the main domain of the project
|
|
164
|
+
* will be used (or `codeqr.link` if the project has no domains).
|
|
166
165
|
*/
|
|
167
166
|
domain: string;
|
|
168
167
|
|
|
169
168
|
/**
|
|
170
|
-
*
|
|
169
|
+
* The URL to redirect to when the short link expires.
|
|
171
170
|
*/
|
|
172
171
|
expiredUrl: string | null;
|
|
173
172
|
|
|
174
173
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
174
|
+
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
175
|
+
* the future.
|
|
177
176
|
*/
|
|
178
177
|
expiresAt: string | null;
|
|
179
178
|
|
|
180
179
|
/**
|
|
181
|
-
*
|
|
180
|
+
* This is the ID of the link in your database.
|
|
182
181
|
*/
|
|
183
182
|
externalId: string | null;
|
|
184
183
|
|
|
@@ -188,24 +187,24 @@ export interface Link {
|
|
|
188
187
|
filled: boolean;
|
|
189
188
|
|
|
190
189
|
/**
|
|
191
|
-
*
|
|
190
|
+
* Whether the short link is flexible.
|
|
192
191
|
*/
|
|
193
192
|
flexible: boolean;
|
|
194
193
|
|
|
195
194
|
/**
|
|
196
|
-
*
|
|
197
|
-
* `{[
|
|
195
|
+
* Geographic targeting information for the short link in JSON format
|
|
196
|
+
* `{[COUNTRY]: https://example.com }`. Learn more: https://codeqr.link/geo
|
|
198
197
|
*/
|
|
199
198
|
geo: { [key: string]: string } | null;
|
|
200
199
|
|
|
201
200
|
/**
|
|
202
|
-
*
|
|
203
|
-
*
|
|
201
|
+
* The image of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
202
|
+
* for custom link preview if `proxy` is true.
|
|
204
203
|
*/
|
|
205
204
|
image: string | null;
|
|
206
205
|
|
|
207
206
|
/**
|
|
208
|
-
*
|
|
207
|
+
* The iOS destination URL for the short link for iOS device targeting.
|
|
209
208
|
*/
|
|
210
209
|
ios: string | null;
|
|
211
210
|
|
|
@@ -215,53 +214,53 @@ export interface Link {
|
|
|
215
214
|
isFormMandatory: boolean;
|
|
216
215
|
|
|
217
216
|
/**
|
|
218
|
-
*
|
|
219
|
-
*
|
|
217
|
+
* The slug of the short link. If not provided, a random 7-character slug will be
|
|
218
|
+
* generated.
|
|
220
219
|
*/
|
|
221
220
|
key: string;
|
|
222
221
|
|
|
223
222
|
/**
|
|
224
|
-
*
|
|
223
|
+
* The date and time when the short link was last clicked.
|
|
225
224
|
*/
|
|
226
225
|
lastClicked: string | null;
|
|
227
226
|
|
|
228
227
|
/**
|
|
229
|
-
*
|
|
228
|
+
* The number of leads generated by the short link.
|
|
230
229
|
*/
|
|
231
230
|
leads: number;
|
|
232
231
|
|
|
233
232
|
/**
|
|
234
|
-
*
|
|
233
|
+
* The notification token of the short link.
|
|
235
234
|
*/
|
|
236
235
|
notificationToken: string | null;
|
|
237
236
|
|
|
238
237
|
/**
|
|
239
|
-
*
|
|
238
|
+
* The password required to access the short link destination URL.
|
|
240
239
|
*/
|
|
241
240
|
password: string | null;
|
|
242
241
|
|
|
243
242
|
/**
|
|
244
|
-
*
|
|
243
|
+
* Whether the short link has pre-redirection.
|
|
245
244
|
*/
|
|
246
245
|
preRedirection: boolean;
|
|
247
246
|
|
|
248
247
|
/**
|
|
249
|
-
*
|
|
248
|
+
* The ID of the project of the short link.
|
|
250
249
|
*/
|
|
251
250
|
projectId: string;
|
|
252
251
|
|
|
253
252
|
/**
|
|
254
|
-
*
|
|
253
|
+
* Whether the short link uses the custom link preview feature.
|
|
255
254
|
*/
|
|
256
255
|
proxy: boolean;
|
|
257
256
|
|
|
258
257
|
/**
|
|
259
|
-
*
|
|
258
|
+
* Whether the short link statistics are publicly accessible.
|
|
260
259
|
*/
|
|
261
260
|
publicStats: boolean;
|
|
262
261
|
|
|
263
262
|
/**
|
|
264
|
-
*
|
|
263
|
+
* Whether the short link uses link cloaking.
|
|
265
264
|
*/
|
|
266
265
|
rewrite: boolean;
|
|
267
266
|
|
|
@@ -271,74 +270,74 @@ export interface Link {
|
|
|
271
270
|
saleAmount: number;
|
|
272
271
|
|
|
273
272
|
/**
|
|
274
|
-
*
|
|
273
|
+
* The number of sales generated by the short link.
|
|
275
274
|
*/
|
|
276
275
|
sales: number;
|
|
277
276
|
|
|
278
277
|
/**
|
|
279
|
-
* @deprecated [
|
|
280
|
-
*
|
|
278
|
+
* @deprecated [DEPRECATED (use `tags` instead)]: The unique ID of the tag assigned
|
|
279
|
+
* to the short link.
|
|
281
280
|
*/
|
|
282
281
|
tagId: string | null;
|
|
283
282
|
|
|
284
283
|
/**
|
|
285
|
-
*
|
|
284
|
+
* The tags assigned to the short link.
|
|
286
285
|
*/
|
|
287
286
|
tags: Array<TagsAPI.Tag> | null;
|
|
288
287
|
|
|
289
288
|
/**
|
|
290
|
-
*
|
|
291
|
-
*
|
|
289
|
+
* The title of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
290
|
+
* for custom link preview if `proxy` is true.
|
|
292
291
|
*/
|
|
293
292
|
title: string | null;
|
|
294
293
|
|
|
295
294
|
/**
|
|
296
|
-
* [BETA]
|
|
295
|
+
* [BETA] Whether to track conversions for the short link.
|
|
297
296
|
*/
|
|
298
297
|
trackConversion: boolean;
|
|
299
298
|
|
|
300
299
|
/**
|
|
301
|
-
*
|
|
300
|
+
* The date and time when the short link was last updated.
|
|
302
301
|
*/
|
|
303
302
|
updatedAt: string;
|
|
304
303
|
|
|
305
304
|
/**
|
|
306
|
-
*
|
|
305
|
+
* The destination URL of the short link.
|
|
307
306
|
*/
|
|
308
307
|
url: string;
|
|
309
308
|
|
|
310
309
|
/**
|
|
311
|
-
*
|
|
310
|
+
* The ID of the user who created the short link.
|
|
312
311
|
*/
|
|
313
312
|
userId: string;
|
|
314
313
|
|
|
315
314
|
/**
|
|
316
|
-
*
|
|
315
|
+
* The UTM campaign of the short link.
|
|
317
316
|
*/
|
|
318
317
|
utm_campaign: string | null;
|
|
319
318
|
|
|
320
319
|
/**
|
|
321
|
-
*
|
|
320
|
+
* The UTM content of the short link.
|
|
322
321
|
*/
|
|
323
322
|
utm_content: string | null;
|
|
324
323
|
|
|
325
324
|
/**
|
|
326
|
-
*
|
|
325
|
+
* The UTM medium of the short link.
|
|
327
326
|
*/
|
|
328
327
|
utm_medium: string | null;
|
|
329
328
|
|
|
330
329
|
/**
|
|
331
|
-
*
|
|
330
|
+
* The UTM source of the short link.
|
|
332
331
|
*/
|
|
333
332
|
utm_source: string | null;
|
|
334
333
|
|
|
335
334
|
/**
|
|
336
|
-
*
|
|
335
|
+
* The UTM term of the short link.
|
|
337
336
|
*/
|
|
338
337
|
utm_term: string | null;
|
|
339
338
|
|
|
340
339
|
/**
|
|
341
|
-
*
|
|
340
|
+
* The video of the short link.
|
|
342
341
|
*/
|
|
343
342
|
video: string | null;
|
|
344
343
|
|
|
@@ -353,13 +352,13 @@ export interface Link {
|
|
|
353
352
|
pageUrl?: string | null;
|
|
354
353
|
|
|
355
354
|
/**
|
|
356
|
-
*
|
|
355
|
+
* The complete QR code URL for the short link (for example,
|
|
357
356
|
* `https://api.codeqr.io/qr?url=https://codeqr.link/try`).
|
|
358
357
|
*/
|
|
359
358
|
qrCode?: string;
|
|
360
359
|
|
|
361
360
|
/**
|
|
362
|
-
*
|
|
361
|
+
* The complete URL of the short link, including the https protocol (for example,
|
|
363
362
|
* `https://codeqr.link/try`).
|
|
364
363
|
*/
|
|
365
364
|
shortLink?: string;
|
|
@@ -381,81 +380,80 @@ export type LinkCountResponse = number;
|
|
|
381
380
|
|
|
382
381
|
export interface LinkCreateParams {
|
|
383
382
|
/**
|
|
384
|
-
*
|
|
383
|
+
* The destination URL of the short link.
|
|
385
384
|
*/
|
|
386
385
|
url: string;
|
|
387
386
|
|
|
388
387
|
/**
|
|
389
|
-
*
|
|
390
|
-
* Android.
|
|
388
|
+
* The Android destination URL for the short link for Android device targeting.
|
|
391
389
|
*/
|
|
392
390
|
android?: string | null;
|
|
393
391
|
|
|
394
392
|
/**
|
|
395
|
-
*
|
|
393
|
+
* Whether the short link is archived.
|
|
396
394
|
*/
|
|
397
395
|
archived?: boolean;
|
|
398
396
|
|
|
399
397
|
/**
|
|
400
|
-
*
|
|
398
|
+
* The comments for the short link.
|
|
401
399
|
*/
|
|
402
400
|
comments?: string | null;
|
|
403
401
|
|
|
404
402
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
403
|
+
* The description of the short link generated via `api.codeqr.io/metatags`. Will
|
|
404
|
+
* be used for custom link preview if `proxy` is true.
|
|
407
405
|
*/
|
|
408
406
|
description?: string | null;
|
|
409
407
|
|
|
410
408
|
/**
|
|
411
|
-
*
|
|
412
|
-
*
|
|
409
|
+
* Allow search engines to index your short link. Default is `false` if not
|
|
410
|
+
* provided. Learn more: https://codeqr.link/noindex
|
|
413
411
|
*/
|
|
414
412
|
doIndex?: boolean;
|
|
415
413
|
|
|
416
414
|
/**
|
|
417
|
-
*
|
|
418
|
-
*
|
|
415
|
+
* The domain of the short link. If not provided, the main domain of the project
|
|
416
|
+
* will be used (or `codeqr.link` if the project has no domains).
|
|
419
417
|
*/
|
|
420
418
|
domain?: string;
|
|
421
419
|
|
|
422
420
|
/**
|
|
423
|
-
*
|
|
421
|
+
* The URL to redirect to when the short link expires.
|
|
424
422
|
*/
|
|
425
423
|
expiredUrl?: string | null;
|
|
426
424
|
|
|
427
425
|
/**
|
|
428
|
-
*
|
|
429
|
-
*
|
|
426
|
+
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
427
|
+
* the future.
|
|
430
428
|
*/
|
|
431
429
|
expiresAt?: string | null;
|
|
432
430
|
|
|
433
431
|
/**
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
432
|
+
* This is the ID of the link in your database. If set, it can be used to identify
|
|
433
|
+
* the link in the future. Must be prefixed with `ext_` when passed as a query
|
|
434
|
+
* parameter.
|
|
437
435
|
*/
|
|
438
436
|
externalId?: string | null;
|
|
439
437
|
|
|
440
438
|
/**
|
|
441
|
-
*
|
|
439
|
+
* Whether the short link is flexible.
|
|
442
440
|
*/
|
|
443
441
|
flexible?: boolean;
|
|
444
442
|
|
|
445
443
|
/**
|
|
446
|
-
*
|
|
447
|
-
* `{[
|
|
444
|
+
* Geographic targeting information for the short link in JSON format
|
|
445
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
448
446
|
*/
|
|
449
447
|
geo?: LinkCreateParams.Geo | null;
|
|
450
448
|
|
|
451
449
|
/**
|
|
452
|
-
*
|
|
453
|
-
*
|
|
450
|
+
* The image of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
451
|
+
* for custom link preview if `proxy` is true.
|
|
454
452
|
*/
|
|
455
453
|
image?: string | null;
|
|
456
454
|
|
|
457
455
|
/**
|
|
458
|
-
*
|
|
456
|
+
* The iOS destination URL for the short link for iOS device targeting.
|
|
459
457
|
*/
|
|
460
458
|
ios?: string | null;
|
|
461
459
|
|
|
@@ -465,8 +463,8 @@ export interface LinkCreateParams {
|
|
|
465
463
|
isFormMandatory?: boolean;
|
|
466
464
|
|
|
467
465
|
/**
|
|
468
|
-
*
|
|
469
|
-
*
|
|
466
|
+
* The slug of the short link. If not provided, a random 7-character slug will be
|
|
467
|
+
* generated.
|
|
470
468
|
*/
|
|
471
469
|
key?: string;
|
|
472
470
|
|
|
@@ -481,67 +479,66 @@ export interface LinkCreateParams {
|
|
|
481
479
|
pageUrl?: string | null;
|
|
482
480
|
|
|
483
481
|
/**
|
|
484
|
-
*
|
|
482
|
+
* The password required to access the short link destination URL.
|
|
485
483
|
*/
|
|
486
484
|
password?: string | null;
|
|
487
485
|
|
|
488
486
|
/**
|
|
489
|
-
*
|
|
490
|
-
*
|
|
491
|
-
*
|
|
487
|
+
* The prefix of the short link slug for randomly generated keys (for example, if
|
|
488
|
+
* the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
|
|
489
|
+
* be ignored if `key` is provided.
|
|
492
490
|
*/
|
|
493
491
|
prefix?: string;
|
|
494
492
|
|
|
495
493
|
/**
|
|
496
|
-
*
|
|
494
|
+
* Whether the short link has pre-redirection.
|
|
497
495
|
*/
|
|
498
496
|
preRedirection?: boolean;
|
|
499
497
|
|
|
500
498
|
/**
|
|
501
|
-
*
|
|
499
|
+
* Whether the short link uses the custom link preview feature.
|
|
502
500
|
*/
|
|
503
501
|
proxy?: boolean;
|
|
504
502
|
|
|
505
503
|
/**
|
|
506
|
-
*
|
|
504
|
+
* Whether the short link statistics are publicly accessible.
|
|
507
505
|
*/
|
|
508
506
|
publicStats?: boolean;
|
|
509
507
|
|
|
510
508
|
/**
|
|
511
|
-
*
|
|
509
|
+
* Whether the short link uses link cloaking.
|
|
512
510
|
*/
|
|
513
511
|
rewrite?: boolean;
|
|
514
512
|
|
|
515
513
|
/**
|
|
516
|
-
* @deprecated
|
|
517
|
-
* – use `tagIds`
|
|
514
|
+
* @deprecated The unique ID of the tag assigned to the short link. This field is
|
|
515
|
+
* deprecated – use `tagIds` instead.
|
|
518
516
|
*/
|
|
519
517
|
tagId?: string | null;
|
|
520
518
|
|
|
521
519
|
/**
|
|
522
|
-
*
|
|
520
|
+
* The unique IDs of the tags assigned to the short link.
|
|
523
521
|
*/
|
|
524
522
|
tagIds?: string | Array<string>;
|
|
525
523
|
|
|
526
524
|
/**
|
|
527
|
-
*
|
|
528
|
-
* minúsculas).
|
|
525
|
+
* The unique name of the tags assigned to the short link (case insensitive).
|
|
529
526
|
*/
|
|
530
527
|
tagNames?: string | Array<string>;
|
|
531
528
|
|
|
532
529
|
/**
|
|
533
|
-
*
|
|
534
|
-
*
|
|
530
|
+
* The title of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
531
|
+
* for custom link preview if `proxy` is true.
|
|
535
532
|
*/
|
|
536
533
|
title?: string | null;
|
|
537
534
|
|
|
538
535
|
/**
|
|
539
|
-
*
|
|
536
|
+
* Whether to track conversions for the short link.
|
|
540
537
|
*/
|
|
541
538
|
trackConversion?: boolean;
|
|
542
539
|
|
|
543
540
|
/**
|
|
544
|
-
*
|
|
541
|
+
* The video of the short link.
|
|
545
542
|
*/
|
|
546
543
|
video?: string | null;
|
|
547
544
|
|
|
@@ -554,8 +551,8 @@ export interface LinkCreateParams {
|
|
|
554
551
|
|
|
555
552
|
export namespace LinkCreateParams {
|
|
556
553
|
/**
|
|
557
|
-
*
|
|
558
|
-
* `{[
|
|
554
|
+
* Geographic targeting information for the short link in JSON format
|
|
555
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
559
556
|
*/
|
|
560
557
|
export interface Geo {
|
|
561
558
|
AD?: string;
|
|
@@ -1062,76 +1059,75 @@ export namespace LinkCreateParams {
|
|
|
1062
1059
|
|
|
1063
1060
|
export interface LinkUpdateParams {
|
|
1064
1061
|
/**
|
|
1065
|
-
*
|
|
1066
|
-
* Android.
|
|
1062
|
+
* The Android destination URL for the short link for Android device targeting.
|
|
1067
1063
|
*/
|
|
1068
1064
|
android?: string | null;
|
|
1069
1065
|
|
|
1070
1066
|
/**
|
|
1071
|
-
*
|
|
1067
|
+
* Whether the short link is archived.
|
|
1072
1068
|
*/
|
|
1073
1069
|
archived?: boolean;
|
|
1074
1070
|
|
|
1075
1071
|
/**
|
|
1076
|
-
*
|
|
1072
|
+
* The comments for the short link.
|
|
1077
1073
|
*/
|
|
1078
1074
|
comments?: string | null;
|
|
1079
1075
|
|
|
1080
1076
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
*
|
|
1077
|
+
* The description of the short link generated via `api.codeqr.io/metatags`. Will
|
|
1078
|
+
* be used for custom link preview if `proxy` is true.
|
|
1083
1079
|
*/
|
|
1084
1080
|
description?: string | null;
|
|
1085
1081
|
|
|
1086
1082
|
/**
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1083
|
+
* Allow search engines to index your short link. Default is `false` if not
|
|
1084
|
+
* provided. Learn more: https://codeqr.link/noindex
|
|
1089
1085
|
*/
|
|
1090
1086
|
doIndex?: boolean;
|
|
1091
1087
|
|
|
1092
1088
|
/**
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1089
|
+
* The domain of the short link. If not provided, the main domain of the project
|
|
1090
|
+
* will be used (or `codeqr.link` if the project has no domains).
|
|
1095
1091
|
*/
|
|
1096
1092
|
domain?: string;
|
|
1097
1093
|
|
|
1098
1094
|
/**
|
|
1099
|
-
*
|
|
1095
|
+
* The URL to redirect to when the short link expires.
|
|
1100
1096
|
*/
|
|
1101
1097
|
expiredUrl?: string | null;
|
|
1102
1098
|
|
|
1103
1099
|
/**
|
|
1104
|
-
*
|
|
1105
|
-
*
|
|
1100
|
+
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
1101
|
+
* the future.
|
|
1106
1102
|
*/
|
|
1107
1103
|
expiresAt?: string | null;
|
|
1108
1104
|
|
|
1109
1105
|
/**
|
|
1110
|
-
*
|
|
1111
|
-
*
|
|
1112
|
-
*
|
|
1106
|
+
* This is the ID of the link in your database. If set, it can be used to identify
|
|
1107
|
+
* the link in the future. Must be prefixed with `ext_` when passed as a query
|
|
1108
|
+
* parameter.
|
|
1113
1109
|
*/
|
|
1114
1110
|
externalId?: string | null;
|
|
1115
1111
|
|
|
1116
1112
|
/**
|
|
1117
|
-
*
|
|
1113
|
+
* Whether the short link is flexible.
|
|
1118
1114
|
*/
|
|
1119
1115
|
flexible?: boolean;
|
|
1120
1116
|
|
|
1121
1117
|
/**
|
|
1122
|
-
*
|
|
1123
|
-
* `{[
|
|
1118
|
+
* Geographic targeting information for the short link in JSON format
|
|
1119
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
1124
1120
|
*/
|
|
1125
1121
|
geo?: LinkUpdateParams.Geo | null;
|
|
1126
1122
|
|
|
1127
1123
|
/**
|
|
1128
|
-
*
|
|
1129
|
-
*
|
|
1124
|
+
* The image of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
1125
|
+
* for custom link preview if `proxy` is true.
|
|
1130
1126
|
*/
|
|
1131
1127
|
image?: string | null;
|
|
1132
1128
|
|
|
1133
1129
|
/**
|
|
1134
|
-
*
|
|
1130
|
+
* The iOS destination URL for the short link for iOS device targeting.
|
|
1135
1131
|
*/
|
|
1136
1132
|
ios?: string | null;
|
|
1137
1133
|
|
|
@@ -1141,8 +1137,8 @@ export interface LinkUpdateParams {
|
|
|
1141
1137
|
isFormMandatory?: boolean;
|
|
1142
1138
|
|
|
1143
1139
|
/**
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1140
|
+
* The slug of the short link. If not provided, a random 7-character slug will be
|
|
1141
|
+
* generated.
|
|
1146
1142
|
*/
|
|
1147
1143
|
key?: string;
|
|
1148
1144
|
|
|
@@ -1157,72 +1153,71 @@ export interface LinkUpdateParams {
|
|
|
1157
1153
|
pageUrl?: string | null;
|
|
1158
1154
|
|
|
1159
1155
|
/**
|
|
1160
|
-
*
|
|
1156
|
+
* The password required to access the short link destination URL.
|
|
1161
1157
|
*/
|
|
1162
1158
|
password?: string | null;
|
|
1163
1159
|
|
|
1164
1160
|
/**
|
|
1165
|
-
*
|
|
1166
|
-
*
|
|
1167
|
-
*
|
|
1161
|
+
* The prefix of the short link slug for randomly generated keys (for example, if
|
|
1162
|
+
* the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
|
|
1163
|
+
* be ignored if `key` is provided.
|
|
1168
1164
|
*/
|
|
1169
1165
|
prefix?: string;
|
|
1170
1166
|
|
|
1171
1167
|
/**
|
|
1172
|
-
*
|
|
1168
|
+
* Whether the short link has pre-redirection.
|
|
1173
1169
|
*/
|
|
1174
1170
|
preRedirection?: boolean;
|
|
1175
1171
|
|
|
1176
1172
|
/**
|
|
1177
|
-
*
|
|
1173
|
+
* Whether the short link uses the custom link preview feature.
|
|
1178
1174
|
*/
|
|
1179
1175
|
proxy?: boolean;
|
|
1180
1176
|
|
|
1181
1177
|
/**
|
|
1182
|
-
*
|
|
1178
|
+
* Whether the short link statistics are publicly accessible.
|
|
1183
1179
|
*/
|
|
1184
1180
|
publicStats?: boolean;
|
|
1185
1181
|
|
|
1186
1182
|
/**
|
|
1187
|
-
*
|
|
1183
|
+
* Whether the short link uses link cloaking.
|
|
1188
1184
|
*/
|
|
1189
1185
|
rewrite?: boolean;
|
|
1190
1186
|
|
|
1191
1187
|
/**
|
|
1192
|
-
* @deprecated
|
|
1193
|
-
* – use `tagIds`
|
|
1188
|
+
* @deprecated The unique ID of the tag assigned to the short link. This field is
|
|
1189
|
+
* deprecated – use `tagIds` instead.
|
|
1194
1190
|
*/
|
|
1195
1191
|
tagId?: string | null;
|
|
1196
1192
|
|
|
1197
1193
|
/**
|
|
1198
|
-
*
|
|
1194
|
+
* The unique IDs of the tags assigned to the short link.
|
|
1199
1195
|
*/
|
|
1200
1196
|
tagIds?: string | Array<string>;
|
|
1201
1197
|
|
|
1202
1198
|
/**
|
|
1203
|
-
*
|
|
1204
|
-
* minúsculas).
|
|
1199
|
+
* The unique name of the tags assigned to the short link (case insensitive).
|
|
1205
1200
|
*/
|
|
1206
1201
|
tagNames?: string | Array<string>;
|
|
1207
1202
|
|
|
1208
1203
|
/**
|
|
1209
|
-
*
|
|
1210
|
-
*
|
|
1204
|
+
* The title of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
1205
|
+
* for custom link preview if `proxy` is true.
|
|
1211
1206
|
*/
|
|
1212
1207
|
title?: string | null;
|
|
1213
1208
|
|
|
1214
1209
|
/**
|
|
1215
|
-
*
|
|
1210
|
+
* Whether to track conversions for the short link.
|
|
1216
1211
|
*/
|
|
1217
1212
|
trackConversion?: boolean;
|
|
1218
1213
|
|
|
1219
1214
|
/**
|
|
1220
|
-
*
|
|
1215
|
+
* The destination URL of the short link.
|
|
1221
1216
|
*/
|
|
1222
1217
|
url?: string;
|
|
1223
1218
|
|
|
1224
1219
|
/**
|
|
1225
|
-
*
|
|
1220
|
+
* The video of the short link.
|
|
1226
1221
|
*/
|
|
1227
1222
|
video?: string | null;
|
|
1228
1223
|
|
|
@@ -1235,8 +1230,8 @@ export interface LinkUpdateParams {
|
|
|
1235
1230
|
|
|
1236
1231
|
export namespace LinkUpdateParams {
|
|
1237
1232
|
/**
|
|
1238
|
-
*
|
|
1239
|
-
* `{[
|
|
1233
|
+
* Geographic targeting information for the short link in JSON format
|
|
1234
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
1240
1235
|
*/
|
|
1241
1236
|
export interface Geo {
|
|
1242
1237
|
AD?: string;
|
|
@@ -3105,26 +3100,26 @@ export namespace LinkCountParams {
|
|
|
3105
3100
|
|
|
3106
3101
|
export interface LinkRetrieveInfoParams {
|
|
3107
3102
|
/**
|
|
3108
|
-
*
|
|
3109
|
-
*
|
|
3103
|
+
* The domain of the link to be retrieved. For example, for `codeqr.link/github`,
|
|
3104
|
+
* the domain is `codeqr.link`.
|
|
3110
3105
|
*/
|
|
3111
3106
|
domain: string;
|
|
3112
3107
|
|
|
3113
3108
|
/**
|
|
3114
|
-
*
|
|
3115
|
-
*
|
|
3109
|
+
* The key of the link to be retrieved. For example, for `codeqr.link/github`, the
|
|
3110
|
+
* key is `github`.
|
|
3116
3111
|
*/
|
|
3117
3112
|
key: string;
|
|
3118
3113
|
|
|
3119
3114
|
/**
|
|
3120
|
-
*
|
|
3121
|
-
* `app.codeqr.io/acme`,
|
|
3115
|
+
* The slug of the project to which the link belongs. For example, for
|
|
3116
|
+
* `app.codeqr.io/acme`, the projectSlug is `acme`.
|
|
3122
3117
|
*/
|
|
3123
3118
|
projectSlug: string;
|
|
3124
3119
|
|
|
3125
3120
|
/**
|
|
3126
|
-
*
|
|
3127
|
-
*
|
|
3121
|
+
* This is the ID of the link in your database. Must be prefixed with `ext_` when
|
|
3122
|
+
* passed as a query parameter.
|
|
3128
3123
|
*/
|
|
3129
3124
|
externalId?: string;
|
|
3130
3125
|
|
|
@@ -3136,81 +3131,80 @@ export interface LinkRetrieveInfoParams {
|
|
|
3136
3131
|
|
|
3137
3132
|
export interface LinkUpsertParams {
|
|
3138
3133
|
/**
|
|
3139
|
-
*
|
|
3134
|
+
* The destination URL of the short link.
|
|
3140
3135
|
*/
|
|
3141
3136
|
url: string;
|
|
3142
3137
|
|
|
3143
3138
|
/**
|
|
3144
|
-
*
|
|
3145
|
-
* Android.
|
|
3139
|
+
* The Android destination URL for the short link for Android device targeting.
|
|
3146
3140
|
*/
|
|
3147
3141
|
android?: string | null;
|
|
3148
3142
|
|
|
3149
3143
|
/**
|
|
3150
|
-
*
|
|
3144
|
+
* Whether the short link is archived.
|
|
3151
3145
|
*/
|
|
3152
3146
|
archived?: boolean;
|
|
3153
3147
|
|
|
3154
3148
|
/**
|
|
3155
|
-
*
|
|
3149
|
+
* The comments for the short link.
|
|
3156
3150
|
*/
|
|
3157
3151
|
comments?: string | null;
|
|
3158
3152
|
|
|
3159
3153
|
/**
|
|
3160
|
-
*
|
|
3161
|
-
*
|
|
3154
|
+
* The description of the short link generated via `api.codeqr.io/metatags`. Will
|
|
3155
|
+
* be used for custom link preview if `proxy` is true.
|
|
3162
3156
|
*/
|
|
3163
3157
|
description?: string | null;
|
|
3164
3158
|
|
|
3165
3159
|
/**
|
|
3166
|
-
*
|
|
3167
|
-
*
|
|
3160
|
+
* Allow search engines to index your short link. Default is `false` if not
|
|
3161
|
+
* provided. Learn more: https://codeqr.link/noindex
|
|
3168
3162
|
*/
|
|
3169
3163
|
doIndex?: boolean;
|
|
3170
3164
|
|
|
3171
3165
|
/**
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3166
|
+
* The domain of the short link. If not provided, the main domain of the project
|
|
3167
|
+
* will be used (or `codeqr.link` if the project has no domains).
|
|
3174
3168
|
*/
|
|
3175
3169
|
domain?: string;
|
|
3176
3170
|
|
|
3177
3171
|
/**
|
|
3178
|
-
*
|
|
3172
|
+
* The URL to redirect to when the short link expires.
|
|
3179
3173
|
*/
|
|
3180
3174
|
expiredUrl?: string | null;
|
|
3181
3175
|
|
|
3182
3176
|
/**
|
|
3183
|
-
*
|
|
3184
|
-
*
|
|
3177
|
+
* The date and time when the short link will expire in ISO-8601 format. Must be in
|
|
3178
|
+
* the future.
|
|
3185
3179
|
*/
|
|
3186
3180
|
expiresAt?: string | null;
|
|
3187
3181
|
|
|
3188
3182
|
/**
|
|
3189
|
-
*
|
|
3190
|
-
*
|
|
3191
|
-
*
|
|
3183
|
+
* This is the ID of the link in your database. If set, it can be used to identify
|
|
3184
|
+
* the link in the future. Must be prefixed with `ext_` when passed as a query
|
|
3185
|
+
* parameter.
|
|
3192
3186
|
*/
|
|
3193
3187
|
externalId?: string | null;
|
|
3194
3188
|
|
|
3195
3189
|
/**
|
|
3196
|
-
*
|
|
3190
|
+
* Whether the short link is flexible.
|
|
3197
3191
|
*/
|
|
3198
3192
|
flexible?: boolean;
|
|
3199
3193
|
|
|
3200
3194
|
/**
|
|
3201
|
-
*
|
|
3202
|
-
* `{[
|
|
3195
|
+
* Geographic targeting information for the short link in JSON format
|
|
3196
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
3203
3197
|
*/
|
|
3204
3198
|
geo?: LinkUpsertParams.Geo | null;
|
|
3205
3199
|
|
|
3206
3200
|
/**
|
|
3207
|
-
*
|
|
3208
|
-
*
|
|
3201
|
+
* The image of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
3202
|
+
* for custom link preview if `proxy` is true.
|
|
3209
3203
|
*/
|
|
3210
3204
|
image?: string | null;
|
|
3211
3205
|
|
|
3212
3206
|
/**
|
|
3213
|
-
*
|
|
3207
|
+
* The iOS destination URL for the short link for iOS device targeting.
|
|
3214
3208
|
*/
|
|
3215
3209
|
ios?: string | null;
|
|
3216
3210
|
|
|
@@ -3220,8 +3214,8 @@ export interface LinkUpsertParams {
|
|
|
3220
3214
|
isFormMandatory?: boolean;
|
|
3221
3215
|
|
|
3222
3216
|
/**
|
|
3223
|
-
*
|
|
3224
|
-
*
|
|
3217
|
+
* The slug of the short link. If not provided, a random 7-character slug will be
|
|
3218
|
+
* generated.
|
|
3225
3219
|
*/
|
|
3226
3220
|
key?: string;
|
|
3227
3221
|
|
|
@@ -3236,67 +3230,66 @@ export interface LinkUpsertParams {
|
|
|
3236
3230
|
pageUrl?: string | null;
|
|
3237
3231
|
|
|
3238
3232
|
/**
|
|
3239
|
-
*
|
|
3233
|
+
* The password required to access the short link destination URL.
|
|
3240
3234
|
*/
|
|
3241
3235
|
password?: string | null;
|
|
3242
3236
|
|
|
3243
3237
|
/**
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3246
|
-
*
|
|
3238
|
+
* The prefix of the short link slug for randomly generated keys (for example, if
|
|
3239
|
+
* the prefix is `/c/`, the generated keys will be in the format `/c/:key`). Will
|
|
3240
|
+
* be ignored if `key` is provided.
|
|
3247
3241
|
*/
|
|
3248
3242
|
prefix?: string;
|
|
3249
3243
|
|
|
3250
3244
|
/**
|
|
3251
|
-
*
|
|
3245
|
+
* Whether the short link has pre-redirection.
|
|
3252
3246
|
*/
|
|
3253
3247
|
preRedirection?: boolean;
|
|
3254
3248
|
|
|
3255
3249
|
/**
|
|
3256
|
-
*
|
|
3250
|
+
* Whether the short link uses the custom link preview feature.
|
|
3257
3251
|
*/
|
|
3258
3252
|
proxy?: boolean;
|
|
3259
3253
|
|
|
3260
3254
|
/**
|
|
3261
|
-
*
|
|
3255
|
+
* Whether the short link statistics are publicly accessible.
|
|
3262
3256
|
*/
|
|
3263
3257
|
publicStats?: boolean;
|
|
3264
3258
|
|
|
3265
3259
|
/**
|
|
3266
|
-
*
|
|
3260
|
+
* Whether the short link uses link cloaking.
|
|
3267
3261
|
*/
|
|
3268
3262
|
rewrite?: boolean;
|
|
3269
3263
|
|
|
3270
3264
|
/**
|
|
3271
|
-
* @deprecated
|
|
3272
|
-
* – use `tagIds`
|
|
3265
|
+
* @deprecated The unique ID of the tag assigned to the short link. This field is
|
|
3266
|
+
* deprecated – use `tagIds` instead.
|
|
3273
3267
|
*/
|
|
3274
3268
|
tagId?: string | null;
|
|
3275
3269
|
|
|
3276
3270
|
/**
|
|
3277
|
-
*
|
|
3271
|
+
* The unique IDs of the tags assigned to the short link.
|
|
3278
3272
|
*/
|
|
3279
3273
|
tagIds?: string | Array<string>;
|
|
3280
3274
|
|
|
3281
3275
|
/**
|
|
3282
|
-
*
|
|
3283
|
-
* minúsculas).
|
|
3276
|
+
* The unique name of the tags assigned to the short link (case insensitive).
|
|
3284
3277
|
*/
|
|
3285
3278
|
tagNames?: string | Array<string>;
|
|
3286
3279
|
|
|
3287
3280
|
/**
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3281
|
+
* The title of the short link generated via `api.codeqr.io/metatags`. Will be used
|
|
3282
|
+
* for custom link preview if `proxy` is true.
|
|
3290
3283
|
*/
|
|
3291
3284
|
title?: string | null;
|
|
3292
3285
|
|
|
3293
3286
|
/**
|
|
3294
|
-
*
|
|
3287
|
+
* Whether to track conversions for the short link.
|
|
3295
3288
|
*/
|
|
3296
3289
|
trackConversion?: boolean;
|
|
3297
3290
|
|
|
3298
3291
|
/**
|
|
3299
|
-
*
|
|
3292
|
+
* The video of the short link.
|
|
3300
3293
|
*/
|
|
3301
3294
|
video?: string | null;
|
|
3302
3295
|
|
|
@@ -3309,8 +3302,8 @@ export interface LinkUpsertParams {
|
|
|
3309
3302
|
|
|
3310
3303
|
export namespace LinkUpsertParams {
|
|
3311
3304
|
/**
|
|
3312
|
-
*
|
|
3313
|
-
* `{[
|
|
3305
|
+
* Geographic targeting information for the short link in JSON format
|
|
3306
|
+
* `{[COUNTRY]: https://example.com }`.
|
|
3314
3307
|
*/
|
|
3315
3308
|
export interface Geo {
|
|
3316
3309
|
AD?: string;
|