@dazl/internal-api-client 1.3.1 → 1.4.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/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/sdk.gen.d.ts +15 -7
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +90 -12
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +641 -331
- package/dist/types.gen.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +2 -2
- package/src/sdk.gen.ts +101 -16
- package/src/types.gen.ts +678 -329
package/src/types.gen.ts
CHANGED
|
@@ -4,6 +4,10 @@ export type ClientOptions = {
|
|
|
4
4
|
baseUrl: `${string}://${string}` | (string & {});
|
|
5
5
|
};
|
|
6
6
|
|
|
7
|
+
export type ErrorResponse = {
|
|
8
|
+
message: string;
|
|
9
|
+
};
|
|
10
|
+
|
|
7
11
|
export type BillingProduct = {
|
|
8
12
|
prices: Array<BillingPrice>;
|
|
9
13
|
product: StripeProduct;
|
|
@@ -70,6 +74,30 @@ export type ScheduledUpdate = {
|
|
|
70
74
|
updateTime: number;
|
|
71
75
|
};
|
|
72
76
|
|
|
77
|
+
export type Deployment = {
|
|
78
|
+
projectId: string;
|
|
79
|
+
netlifyDeployId: string;
|
|
80
|
+
netlifySiteId: string;
|
|
81
|
+
productionURL: string;
|
|
82
|
+
publishedAt: string;
|
|
83
|
+
createdAt: string;
|
|
84
|
+
};
|
|
85
|
+
|
|
86
|
+
export type ProjectRaw = {
|
|
87
|
+
id: string;
|
|
88
|
+
name: string;
|
|
89
|
+
userId: number;
|
|
90
|
+
createdAt: string;
|
|
91
|
+
lastOpenedAt: string | null;
|
|
92
|
+
latestScreenshot: string | null;
|
|
93
|
+
originTemplateId: string | null;
|
|
94
|
+
archivedAt: string | null;
|
|
95
|
+
};
|
|
96
|
+
|
|
97
|
+
export type OwnerDazlId = {
|
|
98
|
+
ownerDazlId: string;
|
|
99
|
+
};
|
|
100
|
+
|
|
73
101
|
export type UploadConfiguration = {
|
|
74
102
|
/**
|
|
75
103
|
* Presigned URL for uploading the file
|
|
@@ -237,27 +265,19 @@ export type GetByDazlIdErrors = {
|
|
|
237
265
|
/**
|
|
238
266
|
* Unauthorized
|
|
239
267
|
*/
|
|
240
|
-
401:
|
|
241
|
-
message: string;
|
|
242
|
-
};
|
|
268
|
+
401: ErrorResponse;
|
|
243
269
|
/**
|
|
244
270
|
* Forbidden
|
|
245
271
|
*/
|
|
246
|
-
403:
|
|
247
|
-
message: string;
|
|
248
|
-
};
|
|
272
|
+
403: ErrorResponse;
|
|
249
273
|
/**
|
|
250
274
|
* Not Found
|
|
251
275
|
*/
|
|
252
|
-
404:
|
|
253
|
-
message: string;
|
|
254
|
-
};
|
|
276
|
+
404: ErrorResponse;
|
|
255
277
|
/**
|
|
256
278
|
* Internal server error
|
|
257
279
|
*/
|
|
258
|
-
500:
|
|
259
|
-
message: string;
|
|
260
|
-
};
|
|
280
|
+
500: ErrorResponse;
|
|
261
281
|
};
|
|
262
282
|
|
|
263
283
|
export type GetByDazlIdError = GetByDazlIdErrors[keyof GetByDazlIdErrors];
|
|
@@ -299,27 +319,19 @@ export type UpdateByDazlIdErrors = {
|
|
|
299
319
|
/**
|
|
300
320
|
* Unauthorized
|
|
301
321
|
*/
|
|
302
|
-
401:
|
|
303
|
-
message: string;
|
|
304
|
-
};
|
|
322
|
+
401: ErrorResponse;
|
|
305
323
|
/**
|
|
306
324
|
* Forbidden
|
|
307
325
|
*/
|
|
308
|
-
403:
|
|
309
|
-
message: string;
|
|
310
|
-
};
|
|
326
|
+
403: ErrorResponse;
|
|
311
327
|
/**
|
|
312
328
|
* Not Found
|
|
313
329
|
*/
|
|
314
|
-
404:
|
|
315
|
-
message: string;
|
|
316
|
-
};
|
|
330
|
+
404: ErrorResponse;
|
|
317
331
|
/**
|
|
318
332
|
* Internal server error
|
|
319
333
|
*/
|
|
320
|
-
500:
|
|
321
|
-
message: string;
|
|
322
|
-
};
|
|
334
|
+
500: ErrorResponse;
|
|
323
335
|
};
|
|
324
336
|
|
|
325
337
|
export type UpdateByDazlIdError = UpdateByDazlIdErrors[keyof UpdateByDazlIdErrors];
|
|
@@ -335,65 +347,6 @@ export type UpdateByDazlIdResponses = {
|
|
|
335
347
|
|
|
336
348
|
export type UpdateByDazlIdResponse = UpdateByDazlIdResponses[keyof UpdateByDazlIdResponses];
|
|
337
349
|
|
|
338
|
-
export type GetBalanceByDazlIdData = {
|
|
339
|
-
body?: never;
|
|
340
|
-
path: {
|
|
341
|
-
dazlId: string;
|
|
342
|
-
};
|
|
343
|
-
query?: never;
|
|
344
|
-
url: '/billing/balance/{dazlId}';
|
|
345
|
-
};
|
|
346
|
-
|
|
347
|
-
export type GetBalanceByDazlIdErrors = {
|
|
348
|
-
/**
|
|
349
|
-
* Bad request - Invalid parameters or malformed JSON
|
|
350
|
-
*/
|
|
351
|
-
400: {
|
|
352
|
-
message: string;
|
|
353
|
-
issues?: string;
|
|
354
|
-
};
|
|
355
|
-
/**
|
|
356
|
-
* Unauthorized
|
|
357
|
-
*/
|
|
358
|
-
401: {
|
|
359
|
-
message: string;
|
|
360
|
-
};
|
|
361
|
-
/**
|
|
362
|
-
* Forbidden
|
|
363
|
-
*/
|
|
364
|
-
403: {
|
|
365
|
-
message: string;
|
|
366
|
-
};
|
|
367
|
-
/**
|
|
368
|
-
* Not Found
|
|
369
|
-
*/
|
|
370
|
-
404: {
|
|
371
|
-
message: string;
|
|
372
|
-
};
|
|
373
|
-
/**
|
|
374
|
-
* Internal server error
|
|
375
|
-
*/
|
|
376
|
-
500: {
|
|
377
|
-
message: string;
|
|
378
|
-
};
|
|
379
|
-
};
|
|
380
|
-
|
|
381
|
-
export type GetBalanceByDazlIdError = GetBalanceByDazlIdErrors[keyof GetBalanceByDazlIdErrors];
|
|
382
|
-
|
|
383
|
-
export type GetBalanceByDazlIdResponses = {
|
|
384
|
-
/**
|
|
385
|
-
* Returns user credit balance
|
|
386
|
-
*/
|
|
387
|
-
200: {
|
|
388
|
-
balance: number;
|
|
389
|
-
productId: string | null;
|
|
390
|
-
priceId: string | null;
|
|
391
|
-
isSubscriptionFree: boolean | null;
|
|
392
|
-
};
|
|
393
|
-
};
|
|
394
|
-
|
|
395
|
-
export type GetBalanceByDazlIdResponse = GetBalanceByDazlIdResponses[keyof GetBalanceByDazlIdResponses];
|
|
396
|
-
|
|
397
350
|
export type GetHasSufficientCreditsByDazlIdData = {
|
|
398
351
|
body?: never;
|
|
399
352
|
path: {
|
|
@@ -414,27 +367,19 @@ export type GetHasSufficientCreditsByDazlIdErrors = {
|
|
|
414
367
|
/**
|
|
415
368
|
* Unauthorized
|
|
416
369
|
*/
|
|
417
|
-
401:
|
|
418
|
-
message: string;
|
|
419
|
-
};
|
|
370
|
+
401: ErrorResponse;
|
|
420
371
|
/**
|
|
421
372
|
* Forbidden
|
|
422
373
|
*/
|
|
423
|
-
403:
|
|
424
|
-
message: string;
|
|
425
|
-
};
|
|
374
|
+
403: ErrorResponse;
|
|
426
375
|
/**
|
|
427
376
|
* Not Found
|
|
428
377
|
*/
|
|
429
|
-
404:
|
|
430
|
-
message: string;
|
|
431
|
-
};
|
|
378
|
+
404: ErrorResponse;
|
|
432
379
|
/**
|
|
433
380
|
* Internal server error
|
|
434
381
|
*/
|
|
435
|
-
500:
|
|
436
|
-
message: string;
|
|
437
|
-
};
|
|
382
|
+
500: ErrorResponse;
|
|
438
383
|
};
|
|
439
384
|
|
|
440
385
|
export type GetHasSufficientCreditsByDazlIdError = GetHasSufficientCreditsByDazlIdErrors[keyof GetHasSufficientCreditsByDazlIdErrors];
|
|
@@ -468,27 +413,19 @@ export type GetAllProductsErrors = {
|
|
|
468
413
|
/**
|
|
469
414
|
* Unauthorized
|
|
470
415
|
*/
|
|
471
|
-
401:
|
|
472
|
-
message: string;
|
|
473
|
-
};
|
|
416
|
+
401: ErrorResponse;
|
|
474
417
|
/**
|
|
475
418
|
* Forbidden
|
|
476
419
|
*/
|
|
477
|
-
403:
|
|
478
|
-
message: string;
|
|
479
|
-
};
|
|
420
|
+
403: ErrorResponse;
|
|
480
421
|
/**
|
|
481
422
|
* Not Found
|
|
482
423
|
*/
|
|
483
|
-
404:
|
|
484
|
-
message: string;
|
|
485
|
-
};
|
|
424
|
+
404: ErrorResponse;
|
|
486
425
|
/**
|
|
487
426
|
* Internal server error
|
|
488
427
|
*/
|
|
489
|
-
500:
|
|
490
|
-
message: string;
|
|
491
|
-
};
|
|
428
|
+
500: ErrorResponse;
|
|
492
429
|
};
|
|
493
430
|
|
|
494
431
|
export type GetAllProductsError = GetAllProductsErrors[keyof GetAllProductsErrors];
|
|
@@ -504,114 +441,6 @@ export type GetAllProductsResponses = {
|
|
|
504
441
|
|
|
505
442
|
export type GetAllProductsResponse = GetAllProductsResponses[keyof GetAllProductsResponses];
|
|
506
443
|
|
|
507
|
-
export type GetPriceByPriceIdData = {
|
|
508
|
-
body?: never;
|
|
509
|
-
path: {
|
|
510
|
-
priceId: string;
|
|
511
|
-
};
|
|
512
|
-
query?: never;
|
|
513
|
-
url: '/billing/price/{priceId}';
|
|
514
|
-
};
|
|
515
|
-
|
|
516
|
-
export type GetPriceByPriceIdErrors = {
|
|
517
|
-
/**
|
|
518
|
-
* Bad request - Invalid parameters or malformed JSON
|
|
519
|
-
*/
|
|
520
|
-
400: {
|
|
521
|
-
message: string;
|
|
522
|
-
issues?: string;
|
|
523
|
-
};
|
|
524
|
-
/**
|
|
525
|
-
* Unauthorized
|
|
526
|
-
*/
|
|
527
|
-
401: {
|
|
528
|
-
message: string;
|
|
529
|
-
};
|
|
530
|
-
/**
|
|
531
|
-
* Forbidden
|
|
532
|
-
*/
|
|
533
|
-
403: {
|
|
534
|
-
message: string;
|
|
535
|
-
};
|
|
536
|
-
/**
|
|
537
|
-
* Not Found
|
|
538
|
-
*/
|
|
539
|
-
404: {
|
|
540
|
-
message: string;
|
|
541
|
-
};
|
|
542
|
-
/**
|
|
543
|
-
* Internal server error
|
|
544
|
-
*/
|
|
545
|
-
500: {
|
|
546
|
-
message: string;
|
|
547
|
-
};
|
|
548
|
-
};
|
|
549
|
-
|
|
550
|
-
export type GetPriceByPriceIdError = GetPriceByPriceIdErrors[keyof GetPriceByPriceIdErrors];
|
|
551
|
-
|
|
552
|
-
export type GetPriceByPriceIdResponses = {
|
|
553
|
-
/**
|
|
554
|
-
* Returns price details
|
|
555
|
-
*/
|
|
556
|
-
200: BillingPrice;
|
|
557
|
-
};
|
|
558
|
-
|
|
559
|
-
export type GetPriceByPriceIdResponse = GetPriceByPriceIdResponses[keyof GetPriceByPriceIdResponses];
|
|
560
|
-
|
|
561
|
-
export type GetMaxCreditsForDefaultFreeData = {
|
|
562
|
-
body?: never;
|
|
563
|
-
path?: never;
|
|
564
|
-
query?: never;
|
|
565
|
-
url: '/billing/max-credits-for-default-free';
|
|
566
|
-
};
|
|
567
|
-
|
|
568
|
-
export type GetMaxCreditsForDefaultFreeErrors = {
|
|
569
|
-
/**
|
|
570
|
-
* Bad request - Invalid parameters or malformed JSON
|
|
571
|
-
*/
|
|
572
|
-
400: {
|
|
573
|
-
message: string;
|
|
574
|
-
issues?: string;
|
|
575
|
-
};
|
|
576
|
-
/**
|
|
577
|
-
* Unauthorized
|
|
578
|
-
*/
|
|
579
|
-
401: {
|
|
580
|
-
message: string;
|
|
581
|
-
};
|
|
582
|
-
/**
|
|
583
|
-
* Forbidden
|
|
584
|
-
*/
|
|
585
|
-
403: {
|
|
586
|
-
message: string;
|
|
587
|
-
};
|
|
588
|
-
/**
|
|
589
|
-
* Not Found
|
|
590
|
-
*/
|
|
591
|
-
404: {
|
|
592
|
-
message: string;
|
|
593
|
-
};
|
|
594
|
-
/**
|
|
595
|
-
* Internal server error
|
|
596
|
-
*/
|
|
597
|
-
500: {
|
|
598
|
-
message: string;
|
|
599
|
-
};
|
|
600
|
-
};
|
|
601
|
-
|
|
602
|
-
export type GetMaxCreditsForDefaultFreeError = GetMaxCreditsForDefaultFreeErrors[keyof GetMaxCreditsForDefaultFreeErrors];
|
|
603
|
-
|
|
604
|
-
export type GetMaxCreditsForDefaultFreeResponses = {
|
|
605
|
-
/**
|
|
606
|
-
* Returns maximum credits for free tier
|
|
607
|
-
*/
|
|
608
|
-
200: {
|
|
609
|
-
maxCreditsForDefaultFree: number;
|
|
610
|
-
};
|
|
611
|
-
};
|
|
612
|
-
|
|
613
|
-
export type GetMaxCreditsForDefaultFreeResponse = GetMaxCreditsForDefaultFreeResponses[keyof GetMaxCreditsForDefaultFreeResponses];
|
|
614
|
-
|
|
615
444
|
export type GetCustomerInfoByDazlIdData = {
|
|
616
445
|
body?: never;
|
|
617
446
|
path: {
|
|
@@ -632,27 +461,19 @@ export type GetCustomerInfoByDazlIdErrors = {
|
|
|
632
461
|
/**
|
|
633
462
|
* Unauthorized
|
|
634
463
|
*/
|
|
635
|
-
401:
|
|
636
|
-
message: string;
|
|
637
|
-
};
|
|
464
|
+
401: ErrorResponse;
|
|
638
465
|
/**
|
|
639
466
|
* Forbidden
|
|
640
467
|
*/
|
|
641
|
-
403:
|
|
642
|
-
message: string;
|
|
643
|
-
};
|
|
468
|
+
403: ErrorResponse;
|
|
644
469
|
/**
|
|
645
470
|
* Not Found
|
|
646
471
|
*/
|
|
647
|
-
404:
|
|
648
|
-
message: string;
|
|
649
|
-
};
|
|
472
|
+
404: ErrorResponse;
|
|
650
473
|
/**
|
|
651
474
|
* Internal server error
|
|
652
475
|
*/
|
|
653
|
-
500:
|
|
654
|
-
message: string;
|
|
655
|
-
};
|
|
476
|
+
500: ErrorResponse;
|
|
656
477
|
};
|
|
657
478
|
|
|
658
479
|
export type GetCustomerInfoByDazlIdError = GetCustomerInfoByDazlIdErrors[keyof GetCustomerInfoByDazlIdErrors];
|
|
@@ -689,27 +510,19 @@ export type UpdateUserSubscriptionErrors = {
|
|
|
689
510
|
/**
|
|
690
511
|
* Unauthorized
|
|
691
512
|
*/
|
|
692
|
-
401:
|
|
693
|
-
message: string;
|
|
694
|
-
};
|
|
513
|
+
401: ErrorResponse;
|
|
695
514
|
/**
|
|
696
515
|
* Forbidden
|
|
697
516
|
*/
|
|
698
|
-
403:
|
|
699
|
-
message: string;
|
|
700
|
-
};
|
|
517
|
+
403: ErrorResponse;
|
|
701
518
|
/**
|
|
702
519
|
* Not Found
|
|
703
520
|
*/
|
|
704
|
-
404:
|
|
705
|
-
message: string;
|
|
706
|
-
};
|
|
521
|
+
404: ErrorResponse;
|
|
707
522
|
/**
|
|
708
523
|
* Internal server error
|
|
709
524
|
*/
|
|
710
|
-
500:
|
|
711
|
-
message: string;
|
|
712
|
-
};
|
|
525
|
+
500: ErrorResponse;
|
|
713
526
|
};
|
|
714
527
|
|
|
715
528
|
export type UpdateUserSubscriptionError = UpdateUserSubscriptionErrors[keyof UpdateUserSubscriptionErrors];
|
|
@@ -751,27 +564,19 @@ export type CancelScheduledUpdateByDazlIdErrors = {
|
|
|
751
564
|
/**
|
|
752
565
|
* Unauthorized
|
|
753
566
|
*/
|
|
754
|
-
401:
|
|
755
|
-
message: string;
|
|
756
|
-
};
|
|
567
|
+
401: ErrorResponse;
|
|
757
568
|
/**
|
|
758
569
|
* Forbidden
|
|
759
570
|
*/
|
|
760
|
-
403:
|
|
761
|
-
message: string;
|
|
762
|
-
};
|
|
571
|
+
403: ErrorResponse;
|
|
763
572
|
/**
|
|
764
573
|
* Not Found
|
|
765
574
|
*/
|
|
766
|
-
404:
|
|
767
|
-
message: string;
|
|
768
|
-
};
|
|
575
|
+
404: ErrorResponse;
|
|
769
576
|
/**
|
|
770
577
|
* Internal server error
|
|
771
578
|
*/
|
|
772
|
-
500:
|
|
773
|
-
message: string;
|
|
774
|
-
};
|
|
579
|
+
500: ErrorResponse;
|
|
775
580
|
};
|
|
776
581
|
|
|
777
582
|
export type CancelScheduledUpdateByDazlIdError = CancelScheduledUpdateByDazlIdErrors[keyof CancelScheduledUpdateByDazlIdErrors];
|
|
@@ -808,27 +613,19 @@ export type CreateCustomerPortalSessionErrors = {
|
|
|
808
613
|
/**
|
|
809
614
|
* Unauthorized
|
|
810
615
|
*/
|
|
811
|
-
401:
|
|
812
|
-
message: string;
|
|
813
|
-
};
|
|
616
|
+
401: ErrorResponse;
|
|
814
617
|
/**
|
|
815
618
|
* Forbidden
|
|
816
619
|
*/
|
|
817
|
-
403:
|
|
818
|
-
message: string;
|
|
819
|
-
};
|
|
620
|
+
403: ErrorResponse;
|
|
820
621
|
/**
|
|
821
622
|
* Not Found
|
|
822
623
|
*/
|
|
823
|
-
404:
|
|
824
|
-
message: string;
|
|
825
|
-
};
|
|
624
|
+
404: ErrorResponse;
|
|
826
625
|
/**
|
|
827
626
|
* Internal server error
|
|
828
627
|
*/
|
|
829
|
-
500:
|
|
830
|
-
message: string;
|
|
831
|
-
};
|
|
628
|
+
500: ErrorResponse;
|
|
832
629
|
};
|
|
833
630
|
|
|
834
631
|
export type CreateCustomerPortalSessionError = CreateCustomerPortalSessionErrors[keyof CreateCustomerPortalSessionErrors];
|
|
@@ -871,27 +668,19 @@ export type CreateCustomerWithDefaultSubscriptionErrors = {
|
|
|
871
668
|
/**
|
|
872
669
|
* Unauthorized
|
|
873
670
|
*/
|
|
874
|
-
401:
|
|
875
|
-
message: string;
|
|
876
|
-
};
|
|
671
|
+
401: ErrorResponse;
|
|
877
672
|
/**
|
|
878
673
|
* Forbidden
|
|
879
674
|
*/
|
|
880
|
-
403:
|
|
881
|
-
message: string;
|
|
882
|
-
};
|
|
675
|
+
403: ErrorResponse;
|
|
883
676
|
/**
|
|
884
677
|
* Not Found
|
|
885
678
|
*/
|
|
886
|
-
404:
|
|
887
|
-
message: string;
|
|
888
|
-
};
|
|
679
|
+
404: ErrorResponse;
|
|
889
680
|
/**
|
|
890
681
|
* Internal server error
|
|
891
682
|
*/
|
|
892
|
-
500:
|
|
893
|
-
message: string;
|
|
894
|
-
};
|
|
683
|
+
500: ErrorResponse;
|
|
895
684
|
};
|
|
896
685
|
|
|
897
686
|
export type CreateCustomerWithDefaultSubscriptionError = CreateCustomerWithDefaultSubscriptionErrors[keyof CreateCustomerWithDefaultSubscriptionErrors];
|
|
@@ -928,27 +717,19 @@ export type GetUserInfoByDazlIdErrors = {
|
|
|
928
717
|
/**
|
|
929
718
|
* Unauthorized
|
|
930
719
|
*/
|
|
931
|
-
401:
|
|
932
|
-
message: string;
|
|
933
|
-
};
|
|
720
|
+
401: ErrorResponse;
|
|
934
721
|
/**
|
|
935
722
|
* Forbidden
|
|
936
723
|
*/
|
|
937
|
-
403:
|
|
938
|
-
message: string;
|
|
939
|
-
};
|
|
724
|
+
403: ErrorResponse;
|
|
940
725
|
/**
|
|
941
726
|
* Not Found
|
|
942
727
|
*/
|
|
943
|
-
404:
|
|
944
|
-
message: string;
|
|
945
|
-
};
|
|
728
|
+
404: ErrorResponse;
|
|
946
729
|
/**
|
|
947
730
|
* Internal server error
|
|
948
731
|
*/
|
|
949
|
-
500:
|
|
950
|
-
message: string;
|
|
951
|
-
};
|
|
732
|
+
500: ErrorResponse;
|
|
952
733
|
};
|
|
953
734
|
|
|
954
735
|
export type GetUserInfoByDazlIdError = GetUserInfoByDazlIdErrors[keyof GetUserInfoByDazlIdErrors];
|
|
@@ -967,14 +748,473 @@ export type GetUserInfoByDazlIdResponses = {
|
|
|
967
748
|
|
|
968
749
|
export type GetUserInfoByDazlIdResponse = GetUserInfoByDazlIdResponses[keyof GetUserInfoByDazlIdResponses];
|
|
969
750
|
|
|
970
|
-
export type
|
|
751
|
+
export type EnsureSiteIdData = {
|
|
971
752
|
body: {
|
|
753
|
+
projectId: string;
|
|
754
|
+
projectName: string;
|
|
972
755
|
/**
|
|
973
|
-
*
|
|
974
|
-
*/
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
756
|
+
* Dazl ID of the project owner to verify ownership
|
|
757
|
+
*/
|
|
758
|
+
dazlId?: string;
|
|
759
|
+
};
|
|
760
|
+
path?: never;
|
|
761
|
+
query?: never;
|
|
762
|
+
url: '/publish/site-id';
|
|
763
|
+
};
|
|
764
|
+
|
|
765
|
+
export type EnsureSiteIdErrors = {
|
|
766
|
+
/**
|
|
767
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
768
|
+
*/
|
|
769
|
+
400: {
|
|
770
|
+
message: string;
|
|
771
|
+
issues?: string;
|
|
772
|
+
};
|
|
773
|
+
/**
|
|
774
|
+
* Unauthorized
|
|
775
|
+
*/
|
|
776
|
+
401: ErrorResponse;
|
|
777
|
+
/**
|
|
778
|
+
* Forbidden
|
|
779
|
+
*/
|
|
780
|
+
403: ErrorResponse;
|
|
781
|
+
/**
|
|
782
|
+
* Not Found
|
|
783
|
+
*/
|
|
784
|
+
404: ErrorResponse;
|
|
785
|
+
/**
|
|
786
|
+
* Internal server error
|
|
787
|
+
*/
|
|
788
|
+
500: ErrorResponse;
|
|
789
|
+
};
|
|
790
|
+
|
|
791
|
+
export type EnsureSiteIdError = EnsureSiteIdErrors[keyof EnsureSiteIdErrors];
|
|
792
|
+
|
|
793
|
+
export type EnsureSiteIdResponses = {
|
|
794
|
+
/**
|
|
795
|
+
* Returns the Netlify site ID for the given project, creates one when missing
|
|
796
|
+
*/
|
|
797
|
+
200: {
|
|
798
|
+
siteId: string;
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
|
|
802
|
+
export type EnsureSiteIdResponse = EnsureSiteIdResponses[keyof EnsureSiteIdResponses];
|
|
803
|
+
|
|
804
|
+
export type GetLatestDeployData = {
|
|
805
|
+
body?: never;
|
|
806
|
+
path?: never;
|
|
807
|
+
query: {
|
|
808
|
+
projectId: string;
|
|
809
|
+
dazlId: string;
|
|
810
|
+
};
|
|
811
|
+
url: '/publish/latest';
|
|
812
|
+
};
|
|
813
|
+
|
|
814
|
+
export type GetLatestDeployErrors = {
|
|
815
|
+
/**
|
|
816
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
817
|
+
*/
|
|
818
|
+
400: {
|
|
819
|
+
message: string;
|
|
820
|
+
issues?: string;
|
|
821
|
+
};
|
|
822
|
+
/**
|
|
823
|
+
* Unauthorized
|
|
824
|
+
*/
|
|
825
|
+
401: ErrorResponse;
|
|
826
|
+
/**
|
|
827
|
+
* Forbidden
|
|
828
|
+
*/
|
|
829
|
+
403: ErrorResponse;
|
|
830
|
+
/**
|
|
831
|
+
* Not Found
|
|
832
|
+
*/
|
|
833
|
+
404: ErrorResponse;
|
|
834
|
+
/**
|
|
835
|
+
* Internal server error
|
|
836
|
+
*/
|
|
837
|
+
500: ErrorResponse;
|
|
838
|
+
};
|
|
839
|
+
|
|
840
|
+
export type GetLatestDeployError = GetLatestDeployErrors[keyof GetLatestDeployErrors];
|
|
841
|
+
|
|
842
|
+
export type GetLatestDeployResponses = {
|
|
843
|
+
/**
|
|
844
|
+
* Returns the latest deployment info for the given project
|
|
845
|
+
*/
|
|
846
|
+
200: Deployment;
|
|
847
|
+
};
|
|
848
|
+
|
|
849
|
+
export type GetLatestDeployResponse = GetLatestDeployResponses[keyof GetLatestDeployResponses];
|
|
850
|
+
|
|
851
|
+
export type UpsertDeployInDbData = {
|
|
852
|
+
body: {
|
|
853
|
+
projectId: string;
|
|
854
|
+
netlifyDeployId: string;
|
|
855
|
+
/**
|
|
856
|
+
* Dazl ID of the project owner to verify ownership
|
|
857
|
+
*/
|
|
858
|
+
dazlId?: string;
|
|
859
|
+
};
|
|
860
|
+
path?: never;
|
|
861
|
+
query?: never;
|
|
862
|
+
url: '/publish/upsert-deploy';
|
|
863
|
+
};
|
|
864
|
+
|
|
865
|
+
export type UpsertDeployInDbErrors = {
|
|
866
|
+
/**
|
|
867
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
868
|
+
*/
|
|
869
|
+
400: {
|
|
870
|
+
message: string;
|
|
871
|
+
issues?: string;
|
|
872
|
+
};
|
|
873
|
+
/**
|
|
874
|
+
* Unauthorized
|
|
875
|
+
*/
|
|
876
|
+
401: ErrorResponse;
|
|
877
|
+
/**
|
|
878
|
+
* Forbidden
|
|
879
|
+
*/
|
|
880
|
+
403: ErrorResponse;
|
|
881
|
+
/**
|
|
882
|
+
* Not Found
|
|
883
|
+
*/
|
|
884
|
+
404: ErrorResponse;
|
|
885
|
+
/**
|
|
886
|
+
* Internal server error
|
|
887
|
+
*/
|
|
888
|
+
500: ErrorResponse;
|
|
889
|
+
};
|
|
890
|
+
|
|
891
|
+
export type UpsertDeployInDbError = UpsertDeployInDbErrors[keyof UpsertDeployInDbErrors];
|
|
892
|
+
|
|
893
|
+
export type UpsertDeployInDbResponses = {
|
|
894
|
+
/**
|
|
895
|
+
* Successfully created or updated deployment record in the database
|
|
896
|
+
*/
|
|
897
|
+
200: Deployment;
|
|
898
|
+
};
|
|
899
|
+
|
|
900
|
+
export type UpsertDeployInDbResponse = UpsertDeployInDbResponses[keyof UpsertDeployInDbResponses];
|
|
901
|
+
|
|
902
|
+
export type UpdateEnvVarsData = {
|
|
903
|
+
body: {
|
|
904
|
+
siteId: string;
|
|
905
|
+
envVars: {
|
|
906
|
+
[key: string]: string;
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
path?: never;
|
|
910
|
+
query?: never;
|
|
911
|
+
url: '/publish/env-vars';
|
|
912
|
+
};
|
|
913
|
+
|
|
914
|
+
export type UpdateEnvVarsErrors = {
|
|
915
|
+
/**
|
|
916
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
917
|
+
*/
|
|
918
|
+
400: {
|
|
919
|
+
message: string;
|
|
920
|
+
issues?: string;
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* Unauthorized
|
|
924
|
+
*/
|
|
925
|
+
401: ErrorResponse;
|
|
926
|
+
/**
|
|
927
|
+
* Forbidden
|
|
928
|
+
*/
|
|
929
|
+
403: ErrorResponse;
|
|
930
|
+
/**
|
|
931
|
+
* Not Found
|
|
932
|
+
*/
|
|
933
|
+
404: ErrorResponse;
|
|
934
|
+
/**
|
|
935
|
+
* Internal server error
|
|
936
|
+
*/
|
|
937
|
+
500: ErrorResponse;
|
|
938
|
+
};
|
|
939
|
+
|
|
940
|
+
export type UpdateEnvVarsError = UpdateEnvVarsErrors[keyof UpdateEnvVarsErrors];
|
|
941
|
+
|
|
942
|
+
export type UpdateEnvVarsResponses = {
|
|
943
|
+
/**
|
|
944
|
+
* Successfully updated environment variables
|
|
945
|
+
*/
|
|
946
|
+
200: {
|
|
947
|
+
success: boolean;
|
|
948
|
+
};
|
|
949
|
+
};
|
|
950
|
+
|
|
951
|
+
export type UpdateEnvVarsResponse = UpdateEnvVarsResponses[keyof UpdateEnvVarsResponses];
|
|
952
|
+
|
|
953
|
+
export type DuplicateProjectData = {
|
|
954
|
+
body: {
|
|
955
|
+
ownerDazlId: string;
|
|
956
|
+
/**
|
|
957
|
+
* Optional new name for the duplicated project
|
|
958
|
+
*/
|
|
959
|
+
name?: string;
|
|
960
|
+
};
|
|
961
|
+
path: {
|
|
962
|
+
projectId: string;
|
|
963
|
+
};
|
|
964
|
+
query?: never;
|
|
965
|
+
url: '/project/duplicate/{projectId}';
|
|
966
|
+
};
|
|
967
|
+
|
|
968
|
+
export type DuplicateProjectErrors = {
|
|
969
|
+
/**
|
|
970
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
971
|
+
*/
|
|
972
|
+
400: {
|
|
973
|
+
message: string;
|
|
974
|
+
issues?: string;
|
|
975
|
+
};
|
|
976
|
+
/**
|
|
977
|
+
* Unauthorized
|
|
978
|
+
*/
|
|
979
|
+
401: ErrorResponse;
|
|
980
|
+
/**
|
|
981
|
+
* Forbidden
|
|
982
|
+
*/
|
|
983
|
+
403: ErrorResponse;
|
|
984
|
+
/**
|
|
985
|
+
* Not Found
|
|
986
|
+
*/
|
|
987
|
+
404: ErrorResponse;
|
|
988
|
+
/**
|
|
989
|
+
* Internal server error
|
|
990
|
+
*/
|
|
991
|
+
500: ErrorResponse;
|
|
992
|
+
};
|
|
993
|
+
|
|
994
|
+
export type DuplicateProjectError = DuplicateProjectErrors[keyof DuplicateProjectErrors];
|
|
995
|
+
|
|
996
|
+
export type DuplicateProjectResponses = {
|
|
997
|
+
/**
|
|
998
|
+
* Returns the new duplicated project
|
|
999
|
+
*/
|
|
1000
|
+
200: {
|
|
1001
|
+
project: ProjectRaw;
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
|
|
1005
|
+
export type DuplicateProjectResponse = DuplicateProjectResponses[keyof DuplicateProjectResponses];
|
|
1006
|
+
|
|
1007
|
+
export type DeleteProjectData = {
|
|
1008
|
+
body: OwnerDazlId;
|
|
1009
|
+
path: {
|
|
1010
|
+
projectId: string;
|
|
1011
|
+
};
|
|
1012
|
+
query?: never;
|
|
1013
|
+
url: '/project/{projectId}';
|
|
1014
|
+
};
|
|
1015
|
+
|
|
1016
|
+
export type DeleteProjectErrors = {
|
|
1017
|
+
/**
|
|
1018
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
1019
|
+
*/
|
|
1020
|
+
400: {
|
|
1021
|
+
message: string;
|
|
1022
|
+
issues?: string;
|
|
1023
|
+
};
|
|
1024
|
+
/**
|
|
1025
|
+
* Unauthorized
|
|
1026
|
+
*/
|
|
1027
|
+
401: ErrorResponse;
|
|
1028
|
+
/**
|
|
1029
|
+
* Forbidden
|
|
1030
|
+
*/
|
|
1031
|
+
403: ErrorResponse;
|
|
1032
|
+
/**
|
|
1033
|
+
* Not Found
|
|
1034
|
+
*/
|
|
1035
|
+
404: ErrorResponse;
|
|
1036
|
+
/**
|
|
1037
|
+
* Internal server error
|
|
1038
|
+
*/
|
|
1039
|
+
500: ErrorResponse;
|
|
1040
|
+
};
|
|
1041
|
+
|
|
1042
|
+
export type DeleteProjectError = DeleteProjectErrors[keyof DeleteProjectErrors];
|
|
1043
|
+
|
|
1044
|
+
export type DeleteProjectResponses = {
|
|
1045
|
+
/**
|
|
1046
|
+
* Returns the deleted project ID and confirmation message
|
|
1047
|
+
*/
|
|
1048
|
+
200: {
|
|
1049
|
+
projectId: string;
|
|
1050
|
+
};
|
|
1051
|
+
};
|
|
1052
|
+
|
|
1053
|
+
export type DeleteProjectResponse = DeleteProjectResponses[keyof DeleteProjectResponses];
|
|
1054
|
+
|
|
1055
|
+
export type GetProjectByIdData = {
|
|
1056
|
+
body?: never;
|
|
1057
|
+
path: {
|
|
1058
|
+
projectId: string;
|
|
1059
|
+
};
|
|
1060
|
+
query: {
|
|
1061
|
+
ownerDazlId: string;
|
|
1062
|
+
};
|
|
1063
|
+
url: '/project/{projectId}';
|
|
1064
|
+
};
|
|
1065
|
+
|
|
1066
|
+
export type GetProjectByIdErrors = {
|
|
1067
|
+
/**
|
|
1068
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
1069
|
+
*/
|
|
1070
|
+
400: {
|
|
1071
|
+
message: string;
|
|
1072
|
+
issues?: string;
|
|
1073
|
+
};
|
|
1074
|
+
/**
|
|
1075
|
+
* Unauthorized
|
|
1076
|
+
*/
|
|
1077
|
+
401: ErrorResponse;
|
|
1078
|
+
/**
|
|
1079
|
+
* Forbidden
|
|
1080
|
+
*/
|
|
1081
|
+
403: ErrorResponse;
|
|
1082
|
+
/**
|
|
1083
|
+
* Not Found
|
|
1084
|
+
*/
|
|
1085
|
+
404: ErrorResponse;
|
|
1086
|
+
/**
|
|
1087
|
+
* Internal server error
|
|
1088
|
+
*/
|
|
1089
|
+
500: ErrorResponse;
|
|
1090
|
+
};
|
|
1091
|
+
|
|
1092
|
+
export type GetProjectByIdError = GetProjectByIdErrors[keyof GetProjectByIdErrors];
|
|
1093
|
+
|
|
1094
|
+
export type GetProjectByIdResponses = {
|
|
1095
|
+
/**
|
|
1096
|
+
* Returns the requested project
|
|
1097
|
+
*/
|
|
1098
|
+
200: {
|
|
1099
|
+
project: ProjectRaw;
|
|
1100
|
+
};
|
|
1101
|
+
};
|
|
1102
|
+
|
|
1103
|
+
export type GetProjectByIdResponse = GetProjectByIdResponses[keyof GetProjectByIdResponses];
|
|
1104
|
+
|
|
1105
|
+
export type UpdateProjectData = {
|
|
1106
|
+
body: {
|
|
1107
|
+
name?: string;
|
|
1108
|
+
lastOpenedAt?: string | null;
|
|
1109
|
+
latestScreenshot?: string | null;
|
|
1110
|
+
archivedAt?: string | null;
|
|
1111
|
+
ownerDazlId: string;
|
|
1112
|
+
};
|
|
1113
|
+
path: {
|
|
1114
|
+
projectId: string;
|
|
1115
|
+
};
|
|
1116
|
+
query?: never;
|
|
1117
|
+
url: '/project/{projectId}';
|
|
1118
|
+
};
|
|
1119
|
+
|
|
1120
|
+
export type UpdateProjectErrors = {
|
|
1121
|
+
/**
|
|
1122
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
1123
|
+
*/
|
|
1124
|
+
400: {
|
|
1125
|
+
message: string;
|
|
1126
|
+
issues?: string;
|
|
1127
|
+
};
|
|
1128
|
+
/**
|
|
1129
|
+
* Unauthorized
|
|
1130
|
+
*/
|
|
1131
|
+
401: ErrorResponse;
|
|
1132
|
+
/**
|
|
1133
|
+
* Forbidden
|
|
1134
|
+
*/
|
|
1135
|
+
403: ErrorResponse;
|
|
1136
|
+
/**
|
|
1137
|
+
* Not Found
|
|
1138
|
+
*/
|
|
1139
|
+
404: ErrorResponse;
|
|
1140
|
+
/**
|
|
1141
|
+
* Internal server error
|
|
1142
|
+
*/
|
|
1143
|
+
500: ErrorResponse;
|
|
1144
|
+
};
|
|
1145
|
+
|
|
1146
|
+
export type UpdateProjectError = UpdateProjectErrors[keyof UpdateProjectErrors];
|
|
1147
|
+
|
|
1148
|
+
export type UpdateProjectResponses = {
|
|
1149
|
+
/**
|
|
1150
|
+
* Returns the updated project
|
|
1151
|
+
*/
|
|
1152
|
+
200: {
|
|
1153
|
+
project: ProjectRaw;
|
|
1154
|
+
};
|
|
1155
|
+
};
|
|
1156
|
+
|
|
1157
|
+
export type UpdateProjectResponse = UpdateProjectResponses[keyof UpdateProjectResponses];
|
|
1158
|
+
|
|
1159
|
+
export type CreateProjectData = {
|
|
1160
|
+
body: {
|
|
1161
|
+
name: string;
|
|
1162
|
+
userDazlId: string;
|
|
1163
|
+
latestScreenshot?: string | null;
|
|
1164
|
+
originTemplateId?: string | null;
|
|
1165
|
+
};
|
|
1166
|
+
path?: never;
|
|
1167
|
+
query?: never;
|
|
1168
|
+
url: '/project';
|
|
1169
|
+
};
|
|
1170
|
+
|
|
1171
|
+
export type CreateProjectErrors = {
|
|
1172
|
+
/**
|
|
1173
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
1174
|
+
*/
|
|
1175
|
+
400: {
|
|
1176
|
+
message: string;
|
|
1177
|
+
issues?: string;
|
|
1178
|
+
};
|
|
1179
|
+
/**
|
|
1180
|
+
* Unauthorized
|
|
1181
|
+
*/
|
|
1182
|
+
401: ErrorResponse;
|
|
1183
|
+
/**
|
|
1184
|
+
* Forbidden
|
|
1185
|
+
*/
|
|
1186
|
+
403: ErrorResponse;
|
|
1187
|
+
/**
|
|
1188
|
+
* Not Found
|
|
1189
|
+
*/
|
|
1190
|
+
404: ErrorResponse;
|
|
1191
|
+
/**
|
|
1192
|
+
* Internal server error
|
|
1193
|
+
*/
|
|
1194
|
+
500: ErrorResponse;
|
|
1195
|
+
};
|
|
1196
|
+
|
|
1197
|
+
export type CreateProjectError = CreateProjectErrors[keyof CreateProjectErrors];
|
|
1198
|
+
|
|
1199
|
+
export type CreateProjectResponses = {
|
|
1200
|
+
/**
|
|
1201
|
+
* Returns the created project
|
|
1202
|
+
*/
|
|
1203
|
+
200: {
|
|
1204
|
+
project: ProjectRaw;
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
|
|
1208
|
+
export type CreateProjectResponse = CreateProjectResponses[keyof CreateProjectResponses];
|
|
1209
|
+
|
|
1210
|
+
export type GetUploadConfigurationData = {
|
|
1211
|
+
body: {
|
|
1212
|
+
/**
|
|
1213
|
+
* File path within the project
|
|
1214
|
+
*/
|
|
1215
|
+
path: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Project identifier
|
|
978
1218
|
*/
|
|
979
1219
|
projectId: string;
|
|
980
1220
|
/**
|
|
@@ -1010,9 +1250,7 @@ export type GetUploadConfigurationErrors = {
|
|
|
1010
1250
|
/**
|
|
1011
1251
|
* Unauthorized
|
|
1012
1252
|
*/
|
|
1013
|
-
401:
|
|
1014
|
-
message: string;
|
|
1015
|
-
};
|
|
1253
|
+
401: ErrorResponse;
|
|
1016
1254
|
/**
|
|
1017
1255
|
* Forbidden - Permission denied
|
|
1018
1256
|
*/
|
|
@@ -1028,9 +1266,7 @@ export type GetUploadConfigurationErrors = {
|
|
|
1028
1266
|
/**
|
|
1029
1267
|
* Internal server error
|
|
1030
1268
|
*/
|
|
1031
|
-
500:
|
|
1032
|
-
message: string;
|
|
1033
|
-
};
|
|
1269
|
+
500: ErrorResponse;
|
|
1034
1270
|
};
|
|
1035
1271
|
|
|
1036
1272
|
export type GetUploadConfigurationError = GetUploadConfigurationErrors[keyof GetUploadConfigurationErrors];
|
|
@@ -1091,9 +1327,7 @@ export type ListFilesErrors = {
|
|
|
1091
1327
|
/**
|
|
1092
1328
|
* Unauthorized
|
|
1093
1329
|
*/
|
|
1094
|
-
401:
|
|
1095
|
-
message: string;
|
|
1096
|
-
};
|
|
1330
|
+
401: ErrorResponse;
|
|
1097
1331
|
/**
|
|
1098
1332
|
* Forbidden - Permission denied
|
|
1099
1333
|
*/
|
|
@@ -1109,9 +1343,7 @@ export type ListFilesErrors = {
|
|
|
1109
1343
|
/**
|
|
1110
1344
|
* Internal server error
|
|
1111
1345
|
*/
|
|
1112
|
-
500:
|
|
1113
|
-
message: string;
|
|
1114
|
-
};
|
|
1346
|
+
500: ErrorResponse;
|
|
1115
1347
|
};
|
|
1116
1348
|
|
|
1117
1349
|
export type ListFilesError = ListFilesErrors[keyof ListFilesErrors];
|
|
@@ -1174,9 +1406,7 @@ export type CreateMediaErrors = {
|
|
|
1174
1406
|
/**
|
|
1175
1407
|
* Unauthorized
|
|
1176
1408
|
*/
|
|
1177
|
-
401:
|
|
1178
|
-
message: string;
|
|
1179
|
-
};
|
|
1409
|
+
401: ErrorResponse;
|
|
1180
1410
|
/**
|
|
1181
1411
|
* Forbidden - Permission denied
|
|
1182
1412
|
*/
|
|
@@ -1192,9 +1422,7 @@ export type CreateMediaErrors = {
|
|
|
1192
1422
|
/**
|
|
1193
1423
|
* Internal server error
|
|
1194
1424
|
*/
|
|
1195
|
-
500:
|
|
1196
|
-
message: string;
|
|
1197
|
-
};
|
|
1425
|
+
500: ErrorResponse;
|
|
1198
1426
|
};
|
|
1199
1427
|
|
|
1200
1428
|
export type CreateMediaError = CreateMediaErrors[keyof CreateMediaErrors];
|
|
@@ -1229,9 +1457,7 @@ export type GetAccountScreenshotsErrors = {
|
|
|
1229
1457
|
/**
|
|
1230
1458
|
* Unauthorized
|
|
1231
1459
|
*/
|
|
1232
|
-
401:
|
|
1233
|
-
message: string;
|
|
1234
|
-
};
|
|
1460
|
+
401: ErrorResponse;
|
|
1235
1461
|
/**
|
|
1236
1462
|
* Forbidden - Permission denied
|
|
1237
1463
|
*/
|
|
@@ -1247,9 +1473,7 @@ export type GetAccountScreenshotsErrors = {
|
|
|
1247
1473
|
/**
|
|
1248
1474
|
* Internal server error
|
|
1249
1475
|
*/
|
|
1250
|
-
500:
|
|
1251
|
-
message: string;
|
|
1252
|
-
};
|
|
1476
|
+
500: ErrorResponse;
|
|
1253
1477
|
};
|
|
1254
1478
|
|
|
1255
1479
|
export type GetAccountScreenshotsError = GetAccountScreenshotsErrors[keyof GetAccountScreenshotsErrors];
|
|
@@ -1290,9 +1514,7 @@ export type GetProjectScreenshotsErrors = {
|
|
|
1290
1514
|
/**
|
|
1291
1515
|
* Unauthorized
|
|
1292
1516
|
*/
|
|
1293
|
-
401:
|
|
1294
|
-
message: string;
|
|
1295
|
-
};
|
|
1517
|
+
401: ErrorResponse;
|
|
1296
1518
|
/**
|
|
1297
1519
|
* Forbidden - Permission denied
|
|
1298
1520
|
*/
|
|
@@ -1308,9 +1530,7 @@ export type GetProjectScreenshotsErrors = {
|
|
|
1308
1530
|
/**
|
|
1309
1531
|
* Internal server error
|
|
1310
1532
|
*/
|
|
1311
|
-
500:
|
|
1312
|
-
message: string;
|
|
1313
|
-
};
|
|
1533
|
+
500: ErrorResponse;
|
|
1314
1534
|
};
|
|
1315
1535
|
|
|
1316
1536
|
export type GetProjectScreenshotsError = GetProjectScreenshotsErrors[keyof GetProjectScreenshotsErrors];
|
|
@@ -1375,9 +1595,7 @@ export type TakeScreenshotErrors = {
|
|
|
1375
1595
|
/**
|
|
1376
1596
|
* Unauthorized
|
|
1377
1597
|
*/
|
|
1378
|
-
401:
|
|
1379
|
-
message: string;
|
|
1380
|
-
};
|
|
1598
|
+
401: ErrorResponse;
|
|
1381
1599
|
/**
|
|
1382
1600
|
* Forbidden - Permission denied
|
|
1383
1601
|
*/
|
|
@@ -1393,9 +1611,7 @@ export type TakeScreenshotErrors = {
|
|
|
1393
1611
|
/**
|
|
1394
1612
|
* Internal server error
|
|
1395
1613
|
*/
|
|
1396
|
-
500:
|
|
1397
|
-
message: string;
|
|
1398
|
-
};
|
|
1614
|
+
500: ErrorResponse;
|
|
1399
1615
|
};
|
|
1400
1616
|
|
|
1401
1617
|
export type TakeScreenshotError = TakeScreenshotErrors[keyof TakeScreenshotErrors];
|
|
@@ -1450,3 +1666,136 @@ export type TakeScreenshotResponses = {
|
|
|
1450
1666
|
};
|
|
1451
1667
|
|
|
1452
1668
|
export type TakeScreenshotResponse = TakeScreenshotResponses[keyof TakeScreenshotResponses];
|
|
1669
|
+
|
|
1670
|
+
export type ScrapePageContentData = {
|
|
1671
|
+
body: {
|
|
1672
|
+
/**
|
|
1673
|
+
* URL of the page to scrape
|
|
1674
|
+
*/
|
|
1675
|
+
url: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* Only return the main content of the page excluding headers, navs, footers, etc.
|
|
1678
|
+
*/
|
|
1679
|
+
onlyMainContent?: boolean;
|
|
1680
|
+
/**
|
|
1681
|
+
* Emulate scraping from a mobile device
|
|
1682
|
+
*/
|
|
1683
|
+
mobile?: boolean;
|
|
1684
|
+
/**
|
|
1685
|
+
* Fetch external CSS stylesheets and inline them as <style> tags for fully self-contained HTML
|
|
1686
|
+
*/
|
|
1687
|
+
inlineExternalCss?: boolean;
|
|
1688
|
+
/**
|
|
1689
|
+
* Include structured branding/design system data (colors, fonts, typography, spacing, components)
|
|
1690
|
+
*/
|
|
1691
|
+
includeBranding?: boolean;
|
|
1692
|
+
};
|
|
1693
|
+
path?: never;
|
|
1694
|
+
query?: never;
|
|
1695
|
+
url: '/capture/scrape';
|
|
1696
|
+
};
|
|
1697
|
+
|
|
1698
|
+
export type ScrapePageContentErrors = {
|
|
1699
|
+
/**
|
|
1700
|
+
* Bad request - Invalid parameters or malformed JSON
|
|
1701
|
+
*/
|
|
1702
|
+
400: {
|
|
1703
|
+
message: string;
|
|
1704
|
+
issues?: string;
|
|
1705
|
+
};
|
|
1706
|
+
/**
|
|
1707
|
+
* Unauthorized
|
|
1708
|
+
*/
|
|
1709
|
+
401: ErrorResponse;
|
|
1710
|
+
/**
|
|
1711
|
+
* Forbidden - Permission denied
|
|
1712
|
+
*/
|
|
1713
|
+
403: {
|
|
1714
|
+
message: string;
|
|
1715
|
+
};
|
|
1716
|
+
/**
|
|
1717
|
+
* Not found
|
|
1718
|
+
*/
|
|
1719
|
+
404: {
|
|
1720
|
+
message: string;
|
|
1721
|
+
};
|
|
1722
|
+
/**
|
|
1723
|
+
* Internal server error
|
|
1724
|
+
*/
|
|
1725
|
+
500: ErrorResponse;
|
|
1726
|
+
};
|
|
1727
|
+
|
|
1728
|
+
export type ScrapePageContentError = ScrapePageContentErrors[keyof ScrapePageContentErrors];
|
|
1729
|
+
|
|
1730
|
+
export type ScrapePageContentResponses = {
|
|
1731
|
+
/**
|
|
1732
|
+
* Page content scraped successfully
|
|
1733
|
+
*/
|
|
1734
|
+
200: {
|
|
1735
|
+
/**
|
|
1736
|
+
* Whether the operation succeeded
|
|
1737
|
+
*/
|
|
1738
|
+
success: boolean;
|
|
1739
|
+
/**
|
|
1740
|
+
* Cleaned HTML content of the page (processed for readability)
|
|
1741
|
+
*/
|
|
1742
|
+
html: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* Raw HTML content of the page as-is
|
|
1745
|
+
*/
|
|
1746
|
+
rawHtml: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* Page metadata
|
|
1749
|
+
*/
|
|
1750
|
+
metadata?: {
|
|
1751
|
+
title?: string;
|
|
1752
|
+
description?: string;
|
|
1753
|
+
language?: string;
|
|
1754
|
+
sourceURL?: string;
|
|
1755
|
+
keywords?: string;
|
|
1756
|
+
ogLocaleAlternate?: Array<string>;
|
|
1757
|
+
statusCode: number;
|
|
1758
|
+
error?: string;
|
|
1759
|
+
};
|
|
1760
|
+
/**
|
|
1761
|
+
* Structured branding/design system data (when includeBranding is true)
|
|
1762
|
+
*/
|
|
1763
|
+
branding?: {
|
|
1764
|
+
colorScheme?: 'light' | 'dark' | null;
|
|
1765
|
+
logo?: string | null;
|
|
1766
|
+
colors?: {
|
|
1767
|
+
[key: string]: unknown;
|
|
1768
|
+
} | null;
|
|
1769
|
+
fonts?: Array<{
|
|
1770
|
+
[key: string]: unknown;
|
|
1771
|
+
}> | null;
|
|
1772
|
+
typography?: {
|
|
1773
|
+
[key: string]: unknown;
|
|
1774
|
+
} | null;
|
|
1775
|
+
spacing?: {
|
|
1776
|
+
[key: string]: unknown;
|
|
1777
|
+
} | null;
|
|
1778
|
+
components?: {
|
|
1779
|
+
[key: string]: unknown;
|
|
1780
|
+
} | null;
|
|
1781
|
+
images?: {
|
|
1782
|
+
[key: string]: unknown;
|
|
1783
|
+
} | null;
|
|
1784
|
+
[key: string]: unknown | 'light' | 'dark' | null | string | null | {
|
|
1785
|
+
[key: string]: unknown;
|
|
1786
|
+
} | null | Array<{
|
|
1787
|
+
[key: string]: unknown;
|
|
1788
|
+
}> | null | {
|
|
1789
|
+
[key: string]: unknown;
|
|
1790
|
+
} | null | {
|
|
1791
|
+
[key: string]: unknown;
|
|
1792
|
+
} | null | {
|
|
1793
|
+
[key: string]: unknown;
|
|
1794
|
+
} | null | {
|
|
1795
|
+
[key: string]: unknown;
|
|
1796
|
+
} | null | undefined;
|
|
1797
|
+
};
|
|
1798
|
+
};
|
|
1799
|
+
};
|
|
1800
|
+
|
|
1801
|
+
export type ScrapePageContentResponse = ScrapePageContentResponses[keyof ScrapePageContentResponses];
|