@dazl/internal-api-client 1.1.2 → 1.2.0

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/src/types.gen.ts CHANGED
@@ -232,7 +232,7 @@ export type GetBalanceByDazlIdErrors = {
232
232
  */
233
233
  400: {
234
234
  message: string;
235
- issues: string;
235
+ issues?: string;
236
236
  };
237
237
  /**
238
238
  * Unauthorized
@@ -240,6 +240,18 @@ export type GetBalanceByDazlIdErrors = {
240
240
  401: {
241
241
  message: string;
242
242
  };
243
+ /**
244
+ * Forbidden
245
+ */
246
+ 403: {
247
+ message: string;
248
+ };
249
+ /**
250
+ * Not Found
251
+ */
252
+ 404: {
253
+ message: string;
254
+ };
243
255
  /**
244
256
  * Internal server error
245
257
  */
@@ -279,7 +291,7 @@ export type GetHasSufficientCreditsByDazlIdErrors = {
279
291
  */
280
292
  400: {
281
293
  message: string;
282
- issues: string;
294
+ issues?: string;
283
295
  };
284
296
  /**
285
297
  * Unauthorized
@@ -287,6 +299,18 @@ export type GetHasSufficientCreditsByDazlIdErrors = {
287
299
  401: {
288
300
  message: string;
289
301
  };
302
+ /**
303
+ * Forbidden
304
+ */
305
+ 403: {
306
+ message: string;
307
+ };
308
+ /**
309
+ * Not Found
310
+ */
311
+ 404: {
312
+ message: string;
313
+ };
290
314
  /**
291
315
  * Internal server error
292
316
  */
@@ -321,7 +345,7 @@ export type GetAllProductsErrors = {
321
345
  */
322
346
  400: {
323
347
  message: string;
324
- issues: string;
348
+ issues?: string;
325
349
  };
326
350
  /**
327
351
  * Unauthorized
@@ -329,6 +353,18 @@ export type GetAllProductsErrors = {
329
353
  401: {
330
354
  message: string;
331
355
  };
356
+ /**
357
+ * Forbidden
358
+ */
359
+ 403: {
360
+ message: string;
361
+ };
362
+ /**
363
+ * Not Found
364
+ */
365
+ 404: {
366
+ message: string;
367
+ };
332
368
  /**
333
369
  * Internal server error
334
370
  */
@@ -365,7 +401,7 @@ export type GetPriceByPriceIdErrors = {
365
401
  */
366
402
  400: {
367
403
  message: string;
368
- issues: string;
404
+ issues?: string;
369
405
  };
370
406
  /**
371
407
  * Unauthorized
@@ -373,6 +409,18 @@ export type GetPriceByPriceIdErrors = {
373
409
  401: {
374
410
  message: string;
375
411
  };
412
+ /**
413
+ * Forbidden
414
+ */
415
+ 403: {
416
+ message: string;
417
+ };
418
+ /**
419
+ * Not Found
420
+ */
421
+ 404: {
422
+ message: string;
423
+ };
376
424
  /**
377
425
  * Internal server error
378
426
  */
@@ -405,7 +453,7 @@ export type GetMaxCreditsForDefaultFreeErrors = {
405
453
  */
406
454
  400: {
407
455
  message: string;
408
- issues: string;
456
+ issues?: string;
409
457
  };
410
458
  /**
411
459
  * Unauthorized
@@ -413,6 +461,18 @@ export type GetMaxCreditsForDefaultFreeErrors = {
413
461
  401: {
414
462
  message: string;
415
463
  };
464
+ /**
465
+ * Forbidden
466
+ */
467
+ 403: {
468
+ message: string;
469
+ };
470
+ /**
471
+ * Not Found
472
+ */
473
+ 404: {
474
+ message: string;
475
+ };
416
476
  /**
417
477
  * Internal server error
418
478
  */
@@ -449,7 +509,7 @@ export type GetCustomerInfoByDazlIdErrors = {
449
509
  */
450
510
  400: {
451
511
  message: string;
452
- issues: string;
512
+ issues?: string;
453
513
  };
454
514
  /**
455
515
  * Unauthorized
@@ -457,6 +517,18 @@ export type GetCustomerInfoByDazlIdErrors = {
457
517
  401: {
458
518
  message: string;
459
519
  };
520
+ /**
521
+ * Forbidden
522
+ */
523
+ 403: {
524
+ message: string;
525
+ };
526
+ /**
527
+ * Not Found
528
+ */
529
+ 404: {
530
+ message: string;
531
+ };
460
532
  /**
461
533
  * Internal server error
462
534
  */
@@ -494,7 +566,7 @@ export type UpdateUserSubscriptionErrors = {
494
566
  */
495
567
  400: {
496
568
  message: string;
497
- issues: string;
569
+ issues?: string;
498
570
  };
499
571
  /**
500
572
  * Unauthorized
@@ -502,6 +574,18 @@ export type UpdateUserSubscriptionErrors = {
502
574
  401: {
503
575
  message: string;
504
576
  };
577
+ /**
578
+ * Forbidden
579
+ */
580
+ 403: {
581
+ message: string;
582
+ };
583
+ /**
584
+ * Not Found
585
+ */
586
+ 404: {
587
+ message: string;
588
+ };
505
589
  /**
506
590
  * Internal server error
507
591
  */
@@ -544,7 +628,7 @@ export type CancelScheduledUpdateByDazlIdErrors = {
544
628
  */
545
629
  400: {
546
630
  message: string;
547
- issues: string;
631
+ issues?: string;
548
632
  };
549
633
  /**
550
634
  * Unauthorized
@@ -552,6 +636,18 @@ export type CancelScheduledUpdateByDazlIdErrors = {
552
636
  401: {
553
637
  message: string;
554
638
  };
639
+ /**
640
+ * Forbidden
641
+ */
642
+ 403: {
643
+ message: string;
644
+ };
645
+ /**
646
+ * Not Found
647
+ */
648
+ 404: {
649
+ message: string;
650
+ };
555
651
  /**
556
652
  * Internal server error
557
653
  */
@@ -589,7 +685,7 @@ export type CreateCustomerPortalSessionErrors = {
589
685
  */
590
686
  400: {
591
687
  message: string;
592
- issues: string;
688
+ issues?: string;
593
689
  };
594
690
  /**
595
691
  * Unauthorized
@@ -597,6 +693,18 @@ export type CreateCustomerPortalSessionErrors = {
597
693
  401: {
598
694
  message: string;
599
695
  };
696
+ /**
697
+ * Forbidden
698
+ */
699
+ 403: {
700
+ message: string;
701
+ };
702
+ /**
703
+ * Not Found
704
+ */
705
+ 404: {
706
+ message: string;
707
+ };
600
708
  /**
601
709
  * Internal server error
602
710
  */
@@ -640,7 +748,7 @@ export type CreateCustomerWithDefaultSubscriptionErrors = {
640
748
  */
641
749
  400: {
642
750
  message: string;
643
- issues: string;
751
+ issues?: string;
644
752
  };
645
753
  /**
646
754
  * Unauthorized
@@ -648,6 +756,18 @@ export type CreateCustomerWithDefaultSubscriptionErrors = {
648
756
  401: {
649
757
  message: string;
650
758
  };
759
+ /**
760
+ * Forbidden
761
+ */
762
+ 403: {
763
+ message: string;
764
+ };
765
+ /**
766
+ * Not Found
767
+ */
768
+ 404: {
769
+ message: string;
770
+ };
651
771
  /**
652
772
  * Internal server error
653
773
  */
@@ -685,7 +805,7 @@ export type GetUserInfoByDazlIdErrors = {
685
805
  */
686
806
  400: {
687
807
  message: string;
688
- issues: string;
808
+ issues?: string;
689
809
  };
690
810
  /**
691
811
  * Unauthorized
@@ -693,6 +813,18 @@ export type GetUserInfoByDazlIdErrors = {
693
813
  401: {
694
814
  message: string;
695
815
  };
816
+ /**
817
+ * Forbidden
818
+ */
819
+ 403: {
820
+ message: string;
821
+ };
822
+ /**
823
+ * Not Found
824
+ */
825
+ 404: {
826
+ message: string;
827
+ };
696
828
  /**
697
829
  * Internal server error
698
830
  */
@@ -755,7 +887,7 @@ export type GetUploadConfigurationErrors = {
755
887
  */
756
888
  400: {
757
889
  message: string;
758
- issues: string;
890
+ issues?: string;
759
891
  };
760
892
  /**
761
893
  * Unauthorized
@@ -836,7 +968,7 @@ export type ListFilesErrors = {
836
968
  */
837
969
  400: {
838
970
  message: string;
839
- issues: string;
971
+ issues?: string;
840
972
  };
841
973
  /**
842
974
  * Unauthorized
@@ -919,7 +1051,7 @@ export type CreateMediaErrors = {
919
1051
  */
920
1052
  400: {
921
1053
  message: string;
922
- issues: string;
1054
+ issues?: string;
923
1055
  };
924
1056
  /**
925
1057
  * Unauthorized
@@ -969,7 +1101,7 @@ export type GetAccountScreenshotsErrors = {
969
1101
  */
970
1102
  400: {
971
1103
  message: string;
972
- issues: string;
1104
+ issues?: string;
973
1105
  };
974
1106
  /**
975
1107
  * Unauthorized
@@ -1026,7 +1158,7 @@ export type GetProjectScreenshotsErrors = {
1026
1158
  */
1027
1159
  400: {
1028
1160
  message: string;
1029
- issues: string;
1161
+ issues?: string;
1030
1162
  };
1031
1163
  /**
1032
1164
  * Unauthorized
@@ -1064,3 +1196,377 @@ export type GetProjectScreenshotsResponses = {
1064
1196
  };
1065
1197
 
1066
1198
  export type GetProjectScreenshotsResponse = GetProjectScreenshotsResponses[keyof GetProjectScreenshotsResponses];
1199
+
1200
+ export type TakeScreenshotData = {
1201
+ body: {
1202
+ /**
1203
+ * URL of the page to capture
1204
+ */
1205
+ url: string;
1206
+ /**
1207
+ * Viewport width in pixels
1208
+ */
1209
+ width?: number;
1210
+ /**
1211
+ * Viewport height in pixels
1212
+ */
1213
+ height?: number;
1214
+ /**
1215
+ * Screenshot image format
1216
+ */
1217
+ imageType?: 'png' | 'jpeg';
1218
+ /**
1219
+ * Project identifier
1220
+ */
1221
+ projectId?: string;
1222
+ /**
1223
+ * Custom storage path for the screenshot
1224
+ */
1225
+ storagePath?: string;
1226
+ /**
1227
+ * Git commit hash to associate with the screenshot
1228
+ */
1229
+ commitHash?: string;
1230
+ /**
1231
+ * User's Dazl ID (required for internal API calls)
1232
+ */
1233
+ dazlId?: string;
1234
+ };
1235
+ path?: never;
1236
+ query?: never;
1237
+ url: '/capture/screenshot';
1238
+ };
1239
+
1240
+ export type TakeScreenshotErrors = {
1241
+ /**
1242
+ * Bad request - Invalid parameters or malformed JSON
1243
+ */
1244
+ 400: {
1245
+ message: string;
1246
+ issues?: string;
1247
+ };
1248
+ /**
1249
+ * Unauthorized
1250
+ */
1251
+ 401: {
1252
+ message: string;
1253
+ };
1254
+ /**
1255
+ * Forbidden - Permission denied
1256
+ */
1257
+ 403: {
1258
+ message: string;
1259
+ };
1260
+ /**
1261
+ * Not found
1262
+ */
1263
+ 404: {
1264
+ message: string;
1265
+ };
1266
+ /**
1267
+ * Internal server error
1268
+ */
1269
+ 500: {
1270
+ message: string;
1271
+ };
1272
+ };
1273
+
1274
+ export type TakeScreenshotError = TakeScreenshotErrors[keyof TakeScreenshotErrors];
1275
+
1276
+ export type TakeScreenshotResponses = {
1277
+ /**
1278
+ * Screenshot captured successfully
1279
+ */
1280
+ 200: {
1281
+ /**
1282
+ * Whether the operation succeeded
1283
+ */
1284
+ success: boolean;
1285
+ /**
1286
+ * Unique identifier for the screenshot
1287
+ */
1288
+ screenshotId: string;
1289
+ /**
1290
+ * Public URL of the screenshot
1291
+ */
1292
+ imageUrl: string;
1293
+ /**
1294
+ * Storage provider used
1295
+ */
1296
+ storageProvider: string;
1297
+ /**
1298
+ * Screenshot metadata
1299
+ */
1300
+ metadata: {
1301
+ /**
1302
+ * Original URL that was captured
1303
+ */
1304
+ sourceUrl: string;
1305
+ /**
1306
+ * Viewport width used
1307
+ */
1308
+ width: number;
1309
+ /**
1310
+ * Viewport height used
1311
+ */
1312
+ height: number;
1313
+ /**
1314
+ * Image format
1315
+ */
1316
+ imageType: 'png' | 'jpeg';
1317
+ /**
1318
+ * ISO timestamp of capture
1319
+ */
1320
+ timestamp: string;
1321
+ /**
1322
+ * Associated project ID
1323
+ */
1324
+ projectId: string;
1325
+ /**
1326
+ * Storage key/path
1327
+ */
1328
+ storageKey: string;
1329
+ };
1330
+ };
1331
+ };
1332
+
1333
+ export type TakeScreenshotResponse = TakeScreenshotResponses[keyof TakeScreenshotResponses];
1334
+
1335
+ export type FetchPageContentData = {
1336
+ body: {
1337
+ /**
1338
+ * URL of the page to fetch
1339
+ */
1340
+ url: string;
1341
+ /**
1342
+ * Viewport width in pixels
1343
+ */
1344
+ width?: number;
1345
+ /**
1346
+ * Viewport height in pixels
1347
+ */
1348
+ height?: number;
1349
+ /**
1350
+ * Wait condition before capturing content
1351
+ */
1352
+ waitUntil?: 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
1353
+ /**
1354
+ * User's Dazl ID (optional, for user identification)
1355
+ */
1356
+ dazlId?: string;
1357
+ };
1358
+ path?: never;
1359
+ query?: never;
1360
+ url: '/capture/page-content';
1361
+ };
1362
+
1363
+ export type FetchPageContentErrors = {
1364
+ /**
1365
+ * Bad request - Invalid parameters or malformed JSON
1366
+ */
1367
+ 400: {
1368
+ message: string;
1369
+ issues?: string;
1370
+ };
1371
+ /**
1372
+ * Unauthorized
1373
+ */
1374
+ 401: {
1375
+ message: string;
1376
+ };
1377
+ /**
1378
+ * Forbidden - Permission denied
1379
+ */
1380
+ 403: {
1381
+ message: string;
1382
+ };
1383
+ /**
1384
+ * Not found
1385
+ */
1386
+ 404: {
1387
+ message: string;
1388
+ };
1389
+ /**
1390
+ * Internal server error
1391
+ */
1392
+ 500: {
1393
+ message: string;
1394
+ };
1395
+ };
1396
+
1397
+ export type FetchPageContentError = FetchPageContentErrors[keyof FetchPageContentErrors];
1398
+
1399
+ export type FetchPageContentResponses = {
1400
+ /**
1401
+ * Page content fetched successfully
1402
+ */
1403
+ 200: {
1404
+ /**
1405
+ * Whether the operation succeeded
1406
+ */
1407
+ success: boolean;
1408
+ /**
1409
+ * Page HTML content
1410
+ */
1411
+ html: string;
1412
+ /**
1413
+ * Captured CSS styles
1414
+ */
1415
+ styles: Array<{
1416
+ /**
1417
+ * URL of the CSS file
1418
+ */
1419
+ url: string;
1420
+ /**
1421
+ * CSS content
1422
+ */
1423
+ content: string;
1424
+ }>;
1425
+ /**
1426
+ * Page content metadata
1427
+ */
1428
+ metadata: {
1429
+ /**
1430
+ * Original URL that was fetched
1431
+ */
1432
+ sourceUrl: string;
1433
+ /**
1434
+ * Viewport width used
1435
+ */
1436
+ width: number;
1437
+ /**
1438
+ * Viewport height used
1439
+ */
1440
+ height: number;
1441
+ /**
1442
+ * Wait condition used
1443
+ */
1444
+ waitUntil: string;
1445
+ /**
1446
+ * ISO timestamp of capture
1447
+ */
1448
+ timestamp: string;
1449
+ /**
1450
+ * Whether CSS styles were captured
1451
+ */
1452
+ stylesCaptured: boolean;
1453
+ };
1454
+ };
1455
+ };
1456
+
1457
+ export type FetchPageContentResponse = FetchPageContentResponses[keyof FetchPageContentResponses];
1458
+
1459
+ export type ExtractDesignSystemData = {
1460
+ body: {
1461
+ /**
1462
+ * URL of the page to analyze
1463
+ */
1464
+ url: string;
1465
+ /**
1466
+ * Capture in dark mode
1467
+ */
1468
+ darkMode?: boolean;
1469
+ /**
1470
+ * Use mobile viewport
1471
+ */
1472
+ mobile?: boolean;
1473
+ /**
1474
+ * Wait longer for slow sites
1475
+ */
1476
+ slow?: boolean;
1477
+ /**
1478
+ * Enable debug output
1479
+ */
1480
+ debug?: boolean;
1481
+ /**
1482
+ * Include verbose color information
1483
+ */
1484
+ verboseColors?: boolean;
1485
+ /**
1486
+ * User's Dazl ID (optional, for user identification)
1487
+ */
1488
+ dazlId?: string;
1489
+ };
1490
+ path?: never;
1491
+ query?: never;
1492
+ url: '/capture/design-system';
1493
+ };
1494
+
1495
+ export type ExtractDesignSystemErrors = {
1496
+ /**
1497
+ * Bad request - Invalid parameters or malformed JSON
1498
+ */
1499
+ 400: {
1500
+ message: string;
1501
+ issues?: string;
1502
+ };
1503
+ /**
1504
+ * Unauthorized
1505
+ */
1506
+ 401: {
1507
+ message: string;
1508
+ };
1509
+ /**
1510
+ * Forbidden - Permission denied
1511
+ */
1512
+ 403: {
1513
+ message: string;
1514
+ };
1515
+ /**
1516
+ * Not found
1517
+ */
1518
+ 404: {
1519
+ message: string;
1520
+ };
1521
+ /**
1522
+ * Internal server error
1523
+ */
1524
+ 500: {
1525
+ message: string;
1526
+ };
1527
+ };
1528
+
1529
+ export type ExtractDesignSystemError = ExtractDesignSystemErrors[keyof ExtractDesignSystemErrors];
1530
+
1531
+ export type ExtractDesignSystemResponses = {
1532
+ /**
1533
+ * Design system extracted successfully
1534
+ */
1535
+ 200: {
1536
+ /**
1537
+ * Whether the operation succeeded
1538
+ */
1539
+ success: boolean;
1540
+ /**
1541
+ * Design system data
1542
+ */
1543
+ data: {
1544
+ [key: string]: unknown;
1545
+ };
1546
+ /**
1547
+ * Design system metadata
1548
+ */
1549
+ metadata: {
1550
+ /**
1551
+ * Original URL that was analyzed
1552
+ */
1553
+ sourceUrl: string;
1554
+ /**
1555
+ * ISO timestamp of analysis
1556
+ */
1557
+ timestamp: string;
1558
+ /**
1559
+ * Options used for analysis
1560
+ */
1561
+ options: {
1562
+ darkMode: boolean;
1563
+ mobile: boolean;
1564
+ slow: boolean;
1565
+ debug: boolean;
1566
+ verboseColors: boolean;
1567
+ };
1568
+ };
1569
+ };
1570
+ };
1571
+
1572
+ export type ExtractDesignSystemResponse = ExtractDesignSystemResponses[keyof ExtractDesignSystemResponses];