@wakata-dev/api-client 0.3.3 → 0.5.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.cjs +384 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2754 -489
- package/dist/index.d.ts +2754 -489
- package/dist/index.js +384 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -388,6 +388,39 @@ type CreateConfigItemDto = {
|
|
|
388
388
|
*/
|
|
389
389
|
description?: string;
|
|
390
390
|
};
|
|
391
|
+
type CreateCustomerDto = {
|
|
392
|
+
/**
|
|
393
|
+
* Customer name
|
|
394
|
+
*/
|
|
395
|
+
name: string;
|
|
396
|
+
/**
|
|
397
|
+
* ABN
|
|
398
|
+
*/
|
|
399
|
+
abn?: string;
|
|
400
|
+
/**
|
|
401
|
+
* Street address
|
|
402
|
+
*/
|
|
403
|
+
address?: string;
|
|
404
|
+
city?: string;
|
|
405
|
+
state?: string;
|
|
406
|
+
postcode?: string;
|
|
407
|
+
country?: string;
|
|
408
|
+
phone?: string;
|
|
409
|
+
email?: string;
|
|
410
|
+
website?: string;
|
|
411
|
+
/**
|
|
412
|
+
* Default payment terms in days
|
|
413
|
+
*/
|
|
414
|
+
default_payment_terms?: number;
|
|
415
|
+
/**
|
|
416
|
+
* Free-text notes
|
|
417
|
+
*/
|
|
418
|
+
notes?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Status
|
|
421
|
+
*/
|
|
422
|
+
status?: string;
|
|
423
|
+
};
|
|
391
424
|
type CreateDocumentDto = {
|
|
392
425
|
/**
|
|
393
426
|
* Parent entity publicId (UUID) the document belongs to. Required for all types except company documents (which are scoped to your company).
|
|
@@ -418,6 +451,59 @@ type CreateDocumentDto = {
|
|
|
418
451
|
*/
|
|
419
452
|
attachment_file?: string;
|
|
420
453
|
};
|
|
454
|
+
type CreateGroupDto = {
|
|
455
|
+
/**
|
|
456
|
+
* Group name
|
|
457
|
+
*/
|
|
458
|
+
name: string;
|
|
459
|
+
/**
|
|
460
|
+
* Site publicId (UUID) to scope the group to, or omit for company-wide
|
|
461
|
+
*/
|
|
462
|
+
site_id?: string;
|
|
463
|
+
/**
|
|
464
|
+
* Auto-include all users
|
|
465
|
+
*/
|
|
466
|
+
include_all_users?: boolean;
|
|
467
|
+
/**
|
|
468
|
+
* Auto-include all assets
|
|
469
|
+
*/
|
|
470
|
+
include_all_assets?: boolean;
|
|
471
|
+
/**
|
|
472
|
+
* Auto-include all checklists
|
|
473
|
+
*/
|
|
474
|
+
include_all_checklists?: boolean;
|
|
475
|
+
};
|
|
476
|
+
type CreateProjectDto = {
|
|
477
|
+
/**
|
|
478
|
+
* Project name
|
|
479
|
+
*/
|
|
480
|
+
name: string;
|
|
481
|
+
/**
|
|
482
|
+
* Site publicId (UUID) the project belongs to
|
|
483
|
+
*/
|
|
484
|
+
site_id: string;
|
|
485
|
+
/**
|
|
486
|
+
* Project code (unique per company)
|
|
487
|
+
*/
|
|
488
|
+
project_code: string;
|
|
489
|
+
/**
|
|
490
|
+
* Start date (ISO)
|
|
491
|
+
*/
|
|
492
|
+
started_at: string;
|
|
493
|
+
/**
|
|
494
|
+
* Description
|
|
495
|
+
*/
|
|
496
|
+
description?: string;
|
|
497
|
+
/**
|
|
498
|
+
* BigInt as string. Project category id (config_items.id, numeric string)
|
|
499
|
+
*/
|
|
500
|
+
project_category_id?: string;
|
|
501
|
+
status?: 'active' | 'suspended' | 'completed';
|
|
502
|
+
/**
|
|
503
|
+
* Expected end date (ISO)
|
|
504
|
+
*/
|
|
505
|
+
expected_end_date?: string;
|
|
506
|
+
};
|
|
421
507
|
type CreateSiteDto = {
|
|
422
508
|
/**
|
|
423
509
|
* Site name
|
|
@@ -448,6 +534,79 @@ type CreateSiteDto = {
|
|
|
448
534
|
*/
|
|
449
535
|
public_id?: string;
|
|
450
536
|
};
|
|
537
|
+
type CreateZoneDto = {
|
|
538
|
+
/**
|
|
539
|
+
* Zone name
|
|
540
|
+
*/
|
|
541
|
+
name: string;
|
|
542
|
+
/**
|
|
543
|
+
* Site publicId (UUID) the zone belongs to
|
|
544
|
+
*/
|
|
545
|
+
site_id: string;
|
|
546
|
+
/**
|
|
547
|
+
* Parent zone publicId (UUID) for nesting, or omit for a top-level zone
|
|
548
|
+
*/
|
|
549
|
+
parent_zone_id?: string;
|
|
550
|
+
/**
|
|
551
|
+
* Description
|
|
552
|
+
*/
|
|
553
|
+
description?: string;
|
|
554
|
+
/**
|
|
555
|
+
* Latitude
|
|
556
|
+
*/
|
|
557
|
+
lat?: number;
|
|
558
|
+
/**
|
|
559
|
+
* Longitude
|
|
560
|
+
*/
|
|
561
|
+
lng?: number;
|
|
562
|
+
/**
|
|
563
|
+
* GeoJSON polygon (object) describing the zone boundary
|
|
564
|
+
*/
|
|
565
|
+
boundary?: {
|
|
566
|
+
[key: string]: unknown;
|
|
567
|
+
};
|
|
568
|
+
};
|
|
569
|
+
type CustomerResponseDto = {
|
|
570
|
+
public_id: string;
|
|
571
|
+
name: string;
|
|
572
|
+
abn: {
|
|
573
|
+
[key: string]: unknown;
|
|
574
|
+
} | null;
|
|
575
|
+
address: {
|
|
576
|
+
[key: string]: unknown;
|
|
577
|
+
} | null;
|
|
578
|
+
city: {
|
|
579
|
+
[key: string]: unknown;
|
|
580
|
+
} | null;
|
|
581
|
+
state: {
|
|
582
|
+
[key: string]: unknown;
|
|
583
|
+
} | null;
|
|
584
|
+
postcode: {
|
|
585
|
+
[key: string]: unknown;
|
|
586
|
+
} | null;
|
|
587
|
+
country: {
|
|
588
|
+
[key: string]: unknown;
|
|
589
|
+
} | null;
|
|
590
|
+
phone: {
|
|
591
|
+
[key: string]: unknown;
|
|
592
|
+
} | null;
|
|
593
|
+
email: {
|
|
594
|
+
[key: string]: unknown;
|
|
595
|
+
} | null;
|
|
596
|
+
website: {
|
|
597
|
+
[key: string]: unknown;
|
|
598
|
+
} | null;
|
|
599
|
+
default_payment_terms: {
|
|
600
|
+
[key: string]: unknown;
|
|
601
|
+
} | null;
|
|
602
|
+
notes: {
|
|
603
|
+
[key: string]: unknown;
|
|
604
|
+
} | null;
|
|
605
|
+
status: string;
|
|
606
|
+
created_at: string;
|
|
607
|
+
updated_at: string;
|
|
608
|
+
customer_properties: Array<EmbeddedCustomerPropertyDto>;
|
|
609
|
+
};
|
|
451
610
|
type DeleteAssetClassPropertyResponseDto = {
|
|
452
611
|
message: string;
|
|
453
612
|
/**
|
|
@@ -465,10 +624,22 @@ type DeleteAssetPropertyResponseDto = {
|
|
|
465
624
|
*/
|
|
466
625
|
id: string;
|
|
467
626
|
};
|
|
627
|
+
type DeleteCustomerResponseDto = {
|
|
628
|
+
message: string;
|
|
629
|
+
public_id: string;
|
|
630
|
+
};
|
|
468
631
|
type DeleteDocumentResponseDto = {
|
|
469
632
|
message: string;
|
|
470
633
|
id: string;
|
|
471
634
|
};
|
|
635
|
+
type DeleteGroupResponseDto = {
|
|
636
|
+
message: string;
|
|
637
|
+
public_id: string;
|
|
638
|
+
};
|
|
639
|
+
type DeleteProjectResponseDto = {
|
|
640
|
+
message: string;
|
|
641
|
+
public_id: string;
|
|
642
|
+
};
|
|
472
643
|
type DeleteSiteResponseDto = {
|
|
473
644
|
/**
|
|
474
645
|
* Success message
|
|
@@ -489,6 +660,54 @@ type DeleteUserPropertyResponseDto = {
|
|
|
489
660
|
*/
|
|
490
661
|
id: string;
|
|
491
662
|
};
|
|
663
|
+
type DeleteZoneResponseDto = {
|
|
664
|
+
message: string;
|
|
665
|
+
public_id: string;
|
|
666
|
+
};
|
|
667
|
+
type DeviceResponseDto = {
|
|
668
|
+
public_id: string;
|
|
669
|
+
name: string;
|
|
670
|
+
status: string;
|
|
671
|
+
last_sync_at: {
|
|
672
|
+
[key: string]: unknown;
|
|
673
|
+
} | null;
|
|
674
|
+
activated_at: {
|
|
675
|
+
[key: string]: unknown;
|
|
676
|
+
} | null;
|
|
677
|
+
app_version: {
|
|
678
|
+
[key: string]: unknown;
|
|
679
|
+
} | null;
|
|
680
|
+
os: {
|
|
681
|
+
[key: string]: unknown;
|
|
682
|
+
} | null;
|
|
683
|
+
os_version: {
|
|
684
|
+
[key: string]: unknown;
|
|
685
|
+
} | null;
|
|
686
|
+
device_model: {
|
|
687
|
+
[key: string]: unknown;
|
|
688
|
+
} | null;
|
|
689
|
+
/**
|
|
690
|
+
* Battery level (0-1 or 0-100)
|
|
691
|
+
*/
|
|
692
|
+
battery_level: {
|
|
693
|
+
[key: string]: unknown;
|
|
694
|
+
} | null;
|
|
695
|
+
lat: {
|
|
696
|
+
[key: string]: unknown;
|
|
697
|
+
} | null;
|
|
698
|
+
lng: {
|
|
699
|
+
[key: string]: unknown;
|
|
700
|
+
} | null;
|
|
701
|
+
last_known_lat: {
|
|
702
|
+
[key: string]: unknown;
|
|
703
|
+
} | null;
|
|
704
|
+
last_known_lng: {
|
|
705
|
+
[key: string]: unknown;
|
|
706
|
+
} | null;
|
|
707
|
+
location_sharing_status: string;
|
|
708
|
+
created_at: string;
|
|
709
|
+
updated_at: string;
|
|
710
|
+
};
|
|
492
711
|
type DocumentResponseDto = {
|
|
493
712
|
/**
|
|
494
713
|
* Document ID
|
|
@@ -667,6 +886,64 @@ type EmbeddedAssetPropertyDto = {
|
|
|
667
886
|
[key: string]: unknown;
|
|
668
887
|
} | null;
|
|
669
888
|
};
|
|
889
|
+
type EmbeddedCustomerPropertyDto = {
|
|
890
|
+
/**
|
|
891
|
+
* BigInt as string. Property definition id (config_items.id)
|
|
892
|
+
*/
|
|
893
|
+
property_id: string;
|
|
894
|
+
/**
|
|
895
|
+
* BigInt as string. Property value row id — pass to PATCH/DELETE /customer-property/:id
|
|
896
|
+
*/
|
|
897
|
+
customer_property_id: string;
|
|
898
|
+
property_name: string;
|
|
899
|
+
text_value: {
|
|
900
|
+
[key: string]: unknown;
|
|
901
|
+
} | null;
|
|
902
|
+
numeric_value: {
|
|
903
|
+
[key: string]: unknown;
|
|
904
|
+
} | null;
|
|
905
|
+
date_value: {
|
|
906
|
+
[key: string]: unknown;
|
|
907
|
+
} | null;
|
|
908
|
+
updated_at: {
|
|
909
|
+
[key: string]: unknown;
|
|
910
|
+
} | null;
|
|
911
|
+
updated_by: {
|
|
912
|
+
[key: string]: unknown;
|
|
913
|
+
} | null;
|
|
914
|
+
updated_by_name: {
|
|
915
|
+
[key: string]: unknown;
|
|
916
|
+
} | null;
|
|
917
|
+
};
|
|
918
|
+
type EmbeddedProjectPropertyDto = {
|
|
919
|
+
/**
|
|
920
|
+
* BigInt as string. Property definition id (config_items.id)
|
|
921
|
+
*/
|
|
922
|
+
property_id: string;
|
|
923
|
+
/**
|
|
924
|
+
* BigInt as string. Property value row id — definition lives on config_items
|
|
925
|
+
*/
|
|
926
|
+
project_property_id: string;
|
|
927
|
+
property_name: string;
|
|
928
|
+
text_value: {
|
|
929
|
+
[key: string]: unknown;
|
|
930
|
+
} | null;
|
|
931
|
+
numeric_value: {
|
|
932
|
+
[key: string]: unknown;
|
|
933
|
+
} | null;
|
|
934
|
+
date_value: {
|
|
935
|
+
[key: string]: unknown;
|
|
936
|
+
} | null;
|
|
937
|
+
updated_at: {
|
|
938
|
+
[key: string]: unknown;
|
|
939
|
+
} | null;
|
|
940
|
+
updated_by: {
|
|
941
|
+
[key: string]: unknown;
|
|
942
|
+
} | null;
|
|
943
|
+
updated_by_name: {
|
|
944
|
+
[key: string]: unknown;
|
|
945
|
+
} | null;
|
|
946
|
+
};
|
|
670
947
|
type EmbeddedUserPropertyDto = {
|
|
671
948
|
/**
|
|
672
949
|
* Property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
@@ -695,6 +972,27 @@ type EmbeddedUserPropertyDto = {
|
|
|
695
972
|
[key: string]: unknown;
|
|
696
973
|
} | null;
|
|
697
974
|
};
|
|
975
|
+
type GroupResponseDto = {
|
|
976
|
+
public_id: string;
|
|
977
|
+
/**
|
|
978
|
+
* Site publicId, or null for a company-wide group
|
|
979
|
+
*/
|
|
980
|
+
site_id: {
|
|
981
|
+
[key: string]: unknown;
|
|
982
|
+
} | null;
|
|
983
|
+
/**
|
|
984
|
+
* Site name
|
|
985
|
+
*/
|
|
986
|
+
site_name: {
|
|
987
|
+
[key: string]: unknown;
|
|
988
|
+
} | null;
|
|
989
|
+
name: string;
|
|
990
|
+
include_all_users: boolean;
|
|
991
|
+
include_all_assets: boolean;
|
|
992
|
+
include_all_checklists: boolean;
|
|
993
|
+
created_at: string;
|
|
994
|
+
updated_at: string;
|
|
995
|
+
};
|
|
698
996
|
type InspectionResponseDto = {
|
|
699
997
|
/**
|
|
700
998
|
* Inspection public ID (UUID)
|
|
@@ -1199,6 +1497,20 @@ type ListConfigTablesResponseDto = {
|
|
|
1199
1497
|
total: number;
|
|
1200
1498
|
total_pages: number;
|
|
1201
1499
|
};
|
|
1500
|
+
type ListCustomersResponseDto = {
|
|
1501
|
+
data: Array<CustomerResponseDto>;
|
|
1502
|
+
page: number;
|
|
1503
|
+
per_page: number;
|
|
1504
|
+
total: number;
|
|
1505
|
+
total_pages: number;
|
|
1506
|
+
};
|
|
1507
|
+
type ListDevicesResponseDto = {
|
|
1508
|
+
data: Array<DeviceResponseDto>;
|
|
1509
|
+
page: number;
|
|
1510
|
+
per_page: number;
|
|
1511
|
+
total: number;
|
|
1512
|
+
total_pages: number;
|
|
1513
|
+
};
|
|
1202
1514
|
type ListDocumentsResponseDto = {
|
|
1203
1515
|
data: Array<DocumentResponseDto>;
|
|
1204
1516
|
page: number;
|
|
@@ -1206,6 +1518,13 @@ type ListDocumentsResponseDto = {
|
|
|
1206
1518
|
total: number;
|
|
1207
1519
|
total_pages: number;
|
|
1208
1520
|
};
|
|
1521
|
+
type ListGroupsResponseDto = {
|
|
1522
|
+
data: Array<GroupResponseDto>;
|
|
1523
|
+
page: number;
|
|
1524
|
+
per_page: number;
|
|
1525
|
+
total: number;
|
|
1526
|
+
total_pages: number;
|
|
1527
|
+
};
|
|
1209
1528
|
type ListInspectionsResponseDto = {
|
|
1210
1529
|
/**
|
|
1211
1530
|
* List of inspections
|
|
@@ -1250,6 +1569,27 @@ type ListIssuesResponseDto = {
|
|
|
1250
1569
|
*/
|
|
1251
1570
|
total_pages: number;
|
|
1252
1571
|
};
|
|
1572
|
+
type ListProjectAssetsResponseDto = {
|
|
1573
|
+
data: Array<ProjectAssetDto>;
|
|
1574
|
+
page: number;
|
|
1575
|
+
per_page: number;
|
|
1576
|
+
total: number;
|
|
1577
|
+
total_pages: number;
|
|
1578
|
+
};
|
|
1579
|
+
type ListProjectUsersResponseDto = {
|
|
1580
|
+
data: Array<ProjectUserDto>;
|
|
1581
|
+
page: number;
|
|
1582
|
+
per_page: number;
|
|
1583
|
+
total: number;
|
|
1584
|
+
total_pages: number;
|
|
1585
|
+
};
|
|
1586
|
+
type ListProjectsResponseDto = {
|
|
1587
|
+
data: Array<ProjectResponseDto>;
|
|
1588
|
+
page: number;
|
|
1589
|
+
per_page: number;
|
|
1590
|
+
total: number;
|
|
1591
|
+
total_pages: number;
|
|
1592
|
+
};
|
|
1253
1593
|
type ListSitesResponseDto = {
|
|
1254
1594
|
/**
|
|
1255
1595
|
* List of sites
|
|
@@ -1272,23 +1612,155 @@ type ListSitesResponseDto = {
|
|
|
1272
1612
|
*/
|
|
1273
1613
|
total_pages: number;
|
|
1274
1614
|
};
|
|
1275
|
-
type
|
|
1615
|
+
type ListTimesheetsResponseDto = {
|
|
1616
|
+
data: Array<TimesheetSummaryDto>;
|
|
1617
|
+
page: number;
|
|
1618
|
+
per_page: number;
|
|
1619
|
+
total: number;
|
|
1620
|
+
total_pages: number;
|
|
1621
|
+
};
|
|
1622
|
+
type ListZonesResponseDto = {
|
|
1623
|
+
data: Array<ZoneResponseDto>;
|
|
1624
|
+
page: number;
|
|
1625
|
+
per_page: number;
|
|
1626
|
+
total: number;
|
|
1627
|
+
total_pages: number;
|
|
1628
|
+
};
|
|
1629
|
+
type ProjectAssetDto = {
|
|
1276
1630
|
/**
|
|
1277
|
-
*
|
|
1631
|
+
* Assignment (approval) row publicId
|
|
1278
1632
|
*/
|
|
1279
|
-
|
|
1633
|
+
project_asset_approval_id: string;
|
|
1280
1634
|
/**
|
|
1281
|
-
* Asset
|
|
1635
|
+
* Asset publicId
|
|
1282
1636
|
*/
|
|
1283
|
-
|
|
1637
|
+
asset_id: string;
|
|
1284
1638
|
/**
|
|
1285
|
-
*
|
|
1639
|
+
* Asset number
|
|
1286
1640
|
*/
|
|
1287
|
-
|
|
1288
|
-
};
|
|
1289
|
-
type SiteResponseDto = {
|
|
1641
|
+
asset_number: string;
|
|
1290
1642
|
/**
|
|
1291
|
-
*
|
|
1643
|
+
* Assignment approval status
|
|
1644
|
+
*/
|
|
1645
|
+
approval_status: 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'returned';
|
|
1646
|
+
approval_number: {
|
|
1647
|
+
[key: string]: unknown;
|
|
1648
|
+
} | null;
|
|
1649
|
+
approval_date: {
|
|
1650
|
+
[key: string]: unknown;
|
|
1651
|
+
} | null;
|
|
1652
|
+
expiry_date: {
|
|
1653
|
+
[key: string]: unknown;
|
|
1654
|
+
} | null;
|
|
1655
|
+
rejection_reason: {
|
|
1656
|
+
[key: string]: unknown;
|
|
1657
|
+
} | null;
|
|
1658
|
+
created_at: string;
|
|
1659
|
+
updated_at: string;
|
|
1660
|
+
};
|
|
1661
|
+
type ProjectResponseDto = {
|
|
1662
|
+
public_id: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* Site publicId
|
|
1665
|
+
*/
|
|
1666
|
+
site_id: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* Site name
|
|
1669
|
+
*/
|
|
1670
|
+
site_name: {
|
|
1671
|
+
[key: string]: unknown;
|
|
1672
|
+
} | null;
|
|
1673
|
+
name: string;
|
|
1674
|
+
project_code: string;
|
|
1675
|
+
description: {
|
|
1676
|
+
[key: string]: unknown;
|
|
1677
|
+
} | null;
|
|
1678
|
+
/**
|
|
1679
|
+
* Category config-item id
|
|
1680
|
+
*/
|
|
1681
|
+
project_category_id: {
|
|
1682
|
+
[key: string]: unknown;
|
|
1683
|
+
} | null;
|
|
1684
|
+
/**
|
|
1685
|
+
* Category name
|
|
1686
|
+
*/
|
|
1687
|
+
project_category: {
|
|
1688
|
+
[key: string]: unknown;
|
|
1689
|
+
} | null;
|
|
1690
|
+
status: 'active' | 'suspended' | 'completed';
|
|
1691
|
+
suspended_reason: {
|
|
1692
|
+
[key: string]: unknown;
|
|
1693
|
+
} | null;
|
|
1694
|
+
started_at: string;
|
|
1695
|
+
expected_end_date: {
|
|
1696
|
+
[key: string]: unknown;
|
|
1697
|
+
} | null;
|
|
1698
|
+
completed_at: {
|
|
1699
|
+
[key: string]: unknown;
|
|
1700
|
+
} | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Count of approved asset assignments
|
|
1703
|
+
*/
|
|
1704
|
+
asset_count: number;
|
|
1705
|
+
/**
|
|
1706
|
+
* Count of approved user assignments
|
|
1707
|
+
*/
|
|
1708
|
+
user_count: number;
|
|
1709
|
+
created_at: string;
|
|
1710
|
+
updated_at: string;
|
|
1711
|
+
project_properties: Array<EmbeddedProjectPropertyDto>;
|
|
1712
|
+
};
|
|
1713
|
+
type ProjectUserDto = {
|
|
1714
|
+
/**
|
|
1715
|
+
* Assignment (approval) row publicId
|
|
1716
|
+
*/
|
|
1717
|
+
project_user_approval_id: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* User publicId
|
|
1720
|
+
*/
|
|
1721
|
+
user_id: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* User full name
|
|
1724
|
+
*/
|
|
1725
|
+
user_name: {
|
|
1726
|
+
[key: string]: unknown;
|
|
1727
|
+
} | null;
|
|
1728
|
+
/**
|
|
1729
|
+
* Assignment approval status
|
|
1730
|
+
*/
|
|
1731
|
+
approval_status: 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'returned';
|
|
1732
|
+
approval_number: {
|
|
1733
|
+
[key: string]: unknown;
|
|
1734
|
+
} | null;
|
|
1735
|
+
approval_date: {
|
|
1736
|
+
[key: string]: unknown;
|
|
1737
|
+
} | null;
|
|
1738
|
+
expiry_date: {
|
|
1739
|
+
[key: string]: unknown;
|
|
1740
|
+
} | null;
|
|
1741
|
+
rejection_reason: {
|
|
1742
|
+
[key: string]: unknown;
|
|
1743
|
+
} | null;
|
|
1744
|
+
created_at: string;
|
|
1745
|
+
updated_at: string;
|
|
1746
|
+
};
|
|
1747
|
+
type PublicCreateAssetDto = {
|
|
1748
|
+
/**
|
|
1749
|
+
* Asset number
|
|
1750
|
+
*/
|
|
1751
|
+
asset_number: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* Asset class public ID
|
|
1754
|
+
*/
|
|
1755
|
+
asset_class: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Site public ID
|
|
1758
|
+
*/
|
|
1759
|
+
site_id: string;
|
|
1760
|
+
};
|
|
1761
|
+
type SiteResponseDto = {
|
|
1762
|
+
/**
|
|
1763
|
+
* Site public ID (UUID)
|
|
1292
1764
|
*/
|
|
1293
1765
|
site_public_id: string;
|
|
1294
1766
|
/**
|
|
@@ -1360,6 +1832,145 @@ type SiteResponseDto = {
|
|
|
1360
1832
|
[key: string]: unknown;
|
|
1361
1833
|
};
|
|
1362
1834
|
};
|
|
1835
|
+
type TimesheetDetailDto = {
|
|
1836
|
+
public_id: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* User publicId
|
|
1839
|
+
*/
|
|
1840
|
+
user_id: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* User full name
|
|
1843
|
+
*/
|
|
1844
|
+
user_name: {
|
|
1845
|
+
[key: string]: unknown;
|
|
1846
|
+
} | null;
|
|
1847
|
+
/**
|
|
1848
|
+
* Period start (Monday)
|
|
1849
|
+
*/
|
|
1850
|
+
period_start: string;
|
|
1851
|
+
/**
|
|
1852
|
+
* Period end (Sunday)
|
|
1853
|
+
*/
|
|
1854
|
+
period_end: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* draft, submitted, in_approval, approved, rejected, info_required
|
|
1857
|
+
*/
|
|
1858
|
+
status: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* Total seconds across all lines
|
|
1861
|
+
*/
|
|
1862
|
+
duration: {
|
|
1863
|
+
[key: string]: unknown;
|
|
1864
|
+
} | null;
|
|
1865
|
+
submitted_at: {
|
|
1866
|
+
[key: string]: unknown;
|
|
1867
|
+
} | null;
|
|
1868
|
+
current_approval_level: {
|
|
1869
|
+
[key: string]: unknown;
|
|
1870
|
+
} | null;
|
|
1871
|
+
total_approval_levels: {
|
|
1872
|
+
[key: string]: unknown;
|
|
1873
|
+
} | null;
|
|
1874
|
+
created_at: string;
|
|
1875
|
+
updated_at: string;
|
|
1876
|
+
lines: Array<TimesheetLineDto>;
|
|
1877
|
+
};
|
|
1878
|
+
type TimesheetLineDto = {
|
|
1879
|
+
public_id: string;
|
|
1880
|
+
line_date: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* Activity (time line) publicId
|
|
1883
|
+
*/
|
|
1884
|
+
activity_id: {
|
|
1885
|
+
[key: string]: unknown;
|
|
1886
|
+
} | null;
|
|
1887
|
+
/**
|
|
1888
|
+
* Activity (time line) name
|
|
1889
|
+
*/
|
|
1890
|
+
activity_name: {
|
|
1891
|
+
[key: string]: unknown;
|
|
1892
|
+
} | null;
|
|
1893
|
+
/**
|
|
1894
|
+
* Duration in seconds
|
|
1895
|
+
*/
|
|
1896
|
+
duration: {
|
|
1897
|
+
[key: string]: unknown;
|
|
1898
|
+
} | null;
|
|
1899
|
+
start_time: {
|
|
1900
|
+
[key: string]: unknown;
|
|
1901
|
+
} | null;
|
|
1902
|
+
end_time: {
|
|
1903
|
+
[key: string]: unknown;
|
|
1904
|
+
} | null;
|
|
1905
|
+
/**
|
|
1906
|
+
* Site publicId
|
|
1907
|
+
*/
|
|
1908
|
+
site_id: {
|
|
1909
|
+
[key: string]: unknown;
|
|
1910
|
+
} | null;
|
|
1911
|
+
/**
|
|
1912
|
+
* Asset publicId
|
|
1913
|
+
*/
|
|
1914
|
+
asset_id: {
|
|
1915
|
+
[key: string]: unknown;
|
|
1916
|
+
} | null;
|
|
1917
|
+
/**
|
|
1918
|
+
* Project publicId
|
|
1919
|
+
*/
|
|
1920
|
+
project_id: {
|
|
1921
|
+
[key: string]: unknown;
|
|
1922
|
+
} | null;
|
|
1923
|
+
/**
|
|
1924
|
+
* Customer publicId
|
|
1925
|
+
*/
|
|
1926
|
+
customer_id: {
|
|
1927
|
+
[key: string]: unknown;
|
|
1928
|
+
} | null;
|
|
1929
|
+
created_at: string;
|
|
1930
|
+
updated_at: string;
|
|
1931
|
+
};
|
|
1932
|
+
type TimesheetSummaryDto = {
|
|
1933
|
+
public_id: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* User publicId
|
|
1936
|
+
*/
|
|
1937
|
+
user_id: string;
|
|
1938
|
+
/**
|
|
1939
|
+
* User full name
|
|
1940
|
+
*/
|
|
1941
|
+
user_name: {
|
|
1942
|
+
[key: string]: unknown;
|
|
1943
|
+
} | null;
|
|
1944
|
+
/**
|
|
1945
|
+
* Period start (Monday)
|
|
1946
|
+
*/
|
|
1947
|
+
period_start: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* Period end (Sunday)
|
|
1950
|
+
*/
|
|
1951
|
+
period_end: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* draft, submitted, in_approval, approved, rejected, info_required
|
|
1954
|
+
*/
|
|
1955
|
+
status: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* Total seconds across all lines
|
|
1958
|
+
*/
|
|
1959
|
+
duration: {
|
|
1960
|
+
[key: string]: unknown;
|
|
1961
|
+
} | null;
|
|
1962
|
+
submitted_at: {
|
|
1963
|
+
[key: string]: unknown;
|
|
1964
|
+
} | null;
|
|
1965
|
+
current_approval_level: {
|
|
1966
|
+
[key: string]: unknown;
|
|
1967
|
+
} | null;
|
|
1968
|
+
total_approval_levels: {
|
|
1969
|
+
[key: string]: unknown;
|
|
1970
|
+
} | null;
|
|
1971
|
+
created_at: string;
|
|
1972
|
+
updated_at: string;
|
|
1973
|
+
};
|
|
1363
1974
|
type UpdateAssetClassDto = {
|
|
1364
1975
|
/**
|
|
1365
1976
|
* Asset class name (make)
|
|
@@ -1444,6 +2055,58 @@ type UpdateConfigItemDto = {
|
|
|
1444
2055
|
[key: string]: unknown;
|
|
1445
2056
|
} | null;
|
|
1446
2057
|
};
|
|
2058
|
+
type UpdateCustomerDto = {
|
|
2059
|
+
/**
|
|
2060
|
+
* Customer name
|
|
2061
|
+
*/
|
|
2062
|
+
name?: string;
|
|
2063
|
+
/**
|
|
2064
|
+
* ABN
|
|
2065
|
+
*/
|
|
2066
|
+
abn?: {
|
|
2067
|
+
[key: string]: unknown;
|
|
2068
|
+
} | null;
|
|
2069
|
+
/**
|
|
2070
|
+
* Street address
|
|
2071
|
+
*/
|
|
2072
|
+
address?: {
|
|
2073
|
+
[key: string]: unknown;
|
|
2074
|
+
} | null;
|
|
2075
|
+
city?: {
|
|
2076
|
+
[key: string]: unknown;
|
|
2077
|
+
} | null;
|
|
2078
|
+
state?: {
|
|
2079
|
+
[key: string]: unknown;
|
|
2080
|
+
} | null;
|
|
2081
|
+
postcode?: {
|
|
2082
|
+
[key: string]: unknown;
|
|
2083
|
+
} | null;
|
|
2084
|
+
country?: {
|
|
2085
|
+
[key: string]: unknown;
|
|
2086
|
+
} | null;
|
|
2087
|
+
phone?: {
|
|
2088
|
+
[key: string]: unknown;
|
|
2089
|
+
} | null;
|
|
2090
|
+
email?: {
|
|
2091
|
+
[key: string]: unknown;
|
|
2092
|
+
} | null;
|
|
2093
|
+
website?: {
|
|
2094
|
+
[key: string]: unknown;
|
|
2095
|
+
} | null;
|
|
2096
|
+
/**
|
|
2097
|
+
* Default payment terms in days
|
|
2098
|
+
*/
|
|
2099
|
+
default_payment_terms?: {
|
|
2100
|
+
[key: string]: unknown;
|
|
2101
|
+
} | null;
|
|
2102
|
+
notes?: {
|
|
2103
|
+
[key: string]: unknown;
|
|
2104
|
+
} | null;
|
|
2105
|
+
/**
|
|
2106
|
+
* Status
|
|
2107
|
+
*/
|
|
2108
|
+
status?: string;
|
|
2109
|
+
};
|
|
1447
2110
|
type UpdateDocumentDto = {
|
|
1448
2111
|
/**
|
|
1449
2112
|
* Document name
|
|
@@ -1476,6 +2139,30 @@ type UpdateDocumentDto = {
|
|
|
1476
2139
|
*/
|
|
1477
2140
|
attachment_file?: string;
|
|
1478
2141
|
};
|
|
2142
|
+
type UpdateGroupDto = {
|
|
2143
|
+
/**
|
|
2144
|
+
* Group name
|
|
2145
|
+
*/
|
|
2146
|
+
name?: string;
|
|
2147
|
+
/**
|
|
2148
|
+
* Site publicId (UUID), or null to make the group company-wide
|
|
2149
|
+
*/
|
|
2150
|
+
site_id?: {
|
|
2151
|
+
[key: string]: unknown;
|
|
2152
|
+
} | null;
|
|
2153
|
+
/**
|
|
2154
|
+
* Auto-include all users
|
|
2155
|
+
*/
|
|
2156
|
+
include_all_users?: boolean;
|
|
2157
|
+
/**
|
|
2158
|
+
* Auto-include all assets
|
|
2159
|
+
*/
|
|
2160
|
+
include_all_assets?: boolean;
|
|
2161
|
+
/**
|
|
2162
|
+
* Auto-include all checklists
|
|
2163
|
+
*/
|
|
2164
|
+
include_all_checklists?: boolean;
|
|
2165
|
+
};
|
|
1479
2166
|
type UpdateIssueDto = {
|
|
1480
2167
|
/**
|
|
1481
2168
|
* Issue title
|
|
@@ -1538,6 +2225,51 @@ type UpdateIssueDto = {
|
|
|
1538
2225
|
*/
|
|
1539
2226
|
user_id: string;
|
|
1540
2227
|
};
|
|
2228
|
+
type UpdateProjectDto = {
|
|
2229
|
+
/**
|
|
2230
|
+
* Project name
|
|
2231
|
+
*/
|
|
2232
|
+
name?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* Project code (unique per company)
|
|
2235
|
+
*/
|
|
2236
|
+
project_code?: string;
|
|
2237
|
+
/**
|
|
2238
|
+
* Description
|
|
2239
|
+
*/
|
|
2240
|
+
description?: {
|
|
2241
|
+
[key: string]: unknown;
|
|
2242
|
+
} | null;
|
|
2243
|
+
/**
|
|
2244
|
+
* Project category id (numeric)
|
|
2245
|
+
*/
|
|
2246
|
+
project_category_id?: {
|
|
2247
|
+
[key: string]: unknown;
|
|
2248
|
+
} | null;
|
|
2249
|
+
status?: 'active' | 'suspended' | 'completed';
|
|
2250
|
+
/**
|
|
2251
|
+
* Reason when status is suspended
|
|
2252
|
+
*/
|
|
2253
|
+
suspended_reason?: {
|
|
2254
|
+
[key: string]: unknown;
|
|
2255
|
+
} | null;
|
|
2256
|
+
/**
|
|
2257
|
+
* Start date (ISO)
|
|
2258
|
+
*/
|
|
2259
|
+
started_at?: string;
|
|
2260
|
+
/**
|
|
2261
|
+
* Expected end date (ISO)
|
|
2262
|
+
*/
|
|
2263
|
+
expected_end_date?: {
|
|
2264
|
+
[key: string]: unknown;
|
|
2265
|
+
} | null;
|
|
2266
|
+
/**
|
|
2267
|
+
* Completed date (ISO)
|
|
2268
|
+
*/
|
|
2269
|
+
completed_at?: {
|
|
2270
|
+
[key: string]: unknown;
|
|
2271
|
+
} | null;
|
|
2272
|
+
};
|
|
1541
2273
|
type UpdateSiteDto = {
|
|
1542
2274
|
/**
|
|
1543
2275
|
* Site name
|
|
@@ -1572,7 +2304,43 @@ type UpdateUserPropertyDto = {
|
|
|
1572
2304
|
[key: string]: unknown;
|
|
1573
2305
|
};
|
|
1574
2306
|
};
|
|
1575
|
-
type
|
|
2307
|
+
type UpdateZoneDto = {
|
|
2308
|
+
/**
|
|
2309
|
+
* Zone name
|
|
2310
|
+
*/
|
|
2311
|
+
name?: string;
|
|
2312
|
+
/**
|
|
2313
|
+
* Parent zone publicId (UUID), or null to make it top-level
|
|
2314
|
+
*/
|
|
2315
|
+
parent_zone_id?: {
|
|
2316
|
+
[key: string]: unknown;
|
|
2317
|
+
} | null;
|
|
2318
|
+
/**
|
|
2319
|
+
* Description
|
|
2320
|
+
*/
|
|
2321
|
+
description?: {
|
|
2322
|
+
[key: string]: unknown;
|
|
2323
|
+
} | null;
|
|
2324
|
+
/**
|
|
2325
|
+
* Latitude
|
|
2326
|
+
*/
|
|
2327
|
+
lat?: {
|
|
2328
|
+
[key: string]: unknown;
|
|
2329
|
+
} | null;
|
|
2330
|
+
/**
|
|
2331
|
+
* Longitude
|
|
2332
|
+
*/
|
|
2333
|
+
lng?: {
|
|
2334
|
+
[key: string]: unknown;
|
|
2335
|
+
} | null;
|
|
2336
|
+
/**
|
|
2337
|
+
* GeoJSON polygon (object), or null to clear
|
|
2338
|
+
*/
|
|
2339
|
+
boundary?: {
|
|
2340
|
+
[key: string]: unknown;
|
|
2341
|
+
} | null;
|
|
2342
|
+
};
|
|
2343
|
+
type UserPropertyResponseDto = {
|
|
1576
2344
|
/**
|
|
1577
2345
|
* User property ID. Serialized as a string in public API responses (BigInt-safe).
|
|
1578
2346
|
*/
|
|
@@ -1714,6 +2482,43 @@ type UserResponseDto = {
|
|
|
1714
2482
|
*/
|
|
1715
2483
|
user_properties: Array<EmbeddedUserPropertyDto>;
|
|
1716
2484
|
};
|
|
2485
|
+
type ZoneResponseDto = {
|
|
2486
|
+
public_id: string;
|
|
2487
|
+
/**
|
|
2488
|
+
* Site publicId
|
|
2489
|
+
*/
|
|
2490
|
+
site_id: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* Site name
|
|
2493
|
+
*/
|
|
2494
|
+
site_name: {
|
|
2495
|
+
[key: string]: unknown;
|
|
2496
|
+
} | null;
|
|
2497
|
+
/**
|
|
2498
|
+
* Parent zone publicId, or null for a top-level zone
|
|
2499
|
+
*/
|
|
2500
|
+
parent_zone_id: {
|
|
2501
|
+
[key: string]: unknown;
|
|
2502
|
+
} | null;
|
|
2503
|
+
name: string;
|
|
2504
|
+
description: {
|
|
2505
|
+
[key: string]: unknown;
|
|
2506
|
+
} | null;
|
|
2507
|
+
lat: {
|
|
2508
|
+
[key: string]: unknown;
|
|
2509
|
+
} | null;
|
|
2510
|
+
lng: {
|
|
2511
|
+
[key: string]: unknown;
|
|
2512
|
+
} | null;
|
|
2513
|
+
/**
|
|
2514
|
+
* GeoJSON polygon boundary
|
|
2515
|
+
*/
|
|
2516
|
+
boundary: {
|
|
2517
|
+
[key: string]: unknown;
|
|
2518
|
+
} | null;
|
|
2519
|
+
created_at: string;
|
|
2520
|
+
updated_at: string;
|
|
2521
|
+
};
|
|
1717
2522
|
type AssetControllerCreateAssetPublicData = {
|
|
1718
2523
|
/**
|
|
1719
2524
|
* Asset creation data with entity public IDs
|
|
@@ -3917,9 +4722,1279 @@ type AssetDocumentControllerListData = {
|
|
|
3917
4722
|
*/
|
|
3918
4723
|
document_date_updated_to?: string;
|
|
3919
4724
|
};
|
|
3920
|
-
url: '/asset-document/list';
|
|
4725
|
+
url: '/asset-document/list';
|
|
4726
|
+
};
|
|
4727
|
+
type AssetDocumentControllerListErrors = {
|
|
4728
|
+
/**
|
|
4729
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4730
|
+
*/
|
|
4731
|
+
400: ApiErrorResponse;
|
|
4732
|
+
/**
|
|
4733
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4734
|
+
*/
|
|
4735
|
+
401: ApiErrorResponse;
|
|
4736
|
+
/**
|
|
4737
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4738
|
+
*/
|
|
4739
|
+
403: ApiErrorResponse;
|
|
4740
|
+
/**
|
|
4741
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4742
|
+
*/
|
|
4743
|
+
429: ApiErrorResponse;
|
|
4744
|
+
/**
|
|
4745
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
4746
|
+
*/
|
|
4747
|
+
500: ApiErrorResponse;
|
|
4748
|
+
};
|
|
4749
|
+
type AssetDocumentControllerListError = AssetDocumentControllerListErrors[keyof AssetDocumentControllerListErrors];
|
|
4750
|
+
type AssetDocumentControllerListResponses = {
|
|
4751
|
+
200: ListDocumentsResponseDto;
|
|
4752
|
+
};
|
|
4753
|
+
type AssetDocumentControllerListResponse = AssetDocumentControllerListResponses[keyof AssetDocumentControllerListResponses];
|
|
4754
|
+
type AssetDocumentControllerRemoveData = {
|
|
4755
|
+
body?: never;
|
|
4756
|
+
path: {
|
|
4757
|
+
/**
|
|
4758
|
+
* Document ID (numeric string)
|
|
4759
|
+
*/
|
|
4760
|
+
id: string;
|
|
4761
|
+
};
|
|
4762
|
+
query?: never;
|
|
4763
|
+
url: '/asset-document/{id}';
|
|
4764
|
+
};
|
|
4765
|
+
type AssetDocumentControllerRemoveErrors = {
|
|
4766
|
+
/**
|
|
4767
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4768
|
+
*/
|
|
4769
|
+
400: ApiErrorResponse;
|
|
4770
|
+
/**
|
|
4771
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4772
|
+
*/
|
|
4773
|
+
401: ApiErrorResponse;
|
|
4774
|
+
/**
|
|
4775
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4776
|
+
*/
|
|
4777
|
+
403: ApiErrorResponse;
|
|
4778
|
+
/**
|
|
4779
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
4780
|
+
*/
|
|
4781
|
+
404: ApiErrorResponse;
|
|
4782
|
+
/**
|
|
4783
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4784
|
+
*/
|
|
4785
|
+
429: ApiErrorResponse;
|
|
4786
|
+
/**
|
|
4787
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
4788
|
+
*/
|
|
4789
|
+
500: ApiErrorResponse;
|
|
4790
|
+
};
|
|
4791
|
+
type AssetDocumentControllerRemoveError = AssetDocumentControllerRemoveErrors[keyof AssetDocumentControllerRemoveErrors];
|
|
4792
|
+
type AssetDocumentControllerRemoveResponses = {
|
|
4793
|
+
200: DeleteDocumentResponseDto;
|
|
4794
|
+
};
|
|
4795
|
+
type AssetDocumentControllerRemoveResponse = AssetDocumentControllerRemoveResponses[keyof AssetDocumentControllerRemoveResponses];
|
|
4796
|
+
type AssetDocumentControllerGetData = {
|
|
4797
|
+
body?: never;
|
|
4798
|
+
path: {
|
|
4799
|
+
/**
|
|
4800
|
+
* Document ID (numeric string)
|
|
4801
|
+
*/
|
|
4802
|
+
id: string;
|
|
4803
|
+
};
|
|
4804
|
+
query?: never;
|
|
4805
|
+
url: '/asset-document/{id}';
|
|
4806
|
+
};
|
|
4807
|
+
type AssetDocumentControllerGetErrors = {
|
|
4808
|
+
/**
|
|
4809
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4810
|
+
*/
|
|
4811
|
+
400: ApiErrorResponse;
|
|
4812
|
+
/**
|
|
4813
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4814
|
+
*/
|
|
4815
|
+
401: ApiErrorResponse;
|
|
4816
|
+
/**
|
|
4817
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4818
|
+
*/
|
|
4819
|
+
403: ApiErrorResponse;
|
|
4820
|
+
/**
|
|
4821
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
4822
|
+
*/
|
|
4823
|
+
404: ApiErrorResponse;
|
|
4824
|
+
/**
|
|
4825
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4826
|
+
*/
|
|
4827
|
+
429: ApiErrorResponse;
|
|
4828
|
+
/**
|
|
4829
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
4830
|
+
*/
|
|
4831
|
+
500: ApiErrorResponse;
|
|
4832
|
+
};
|
|
4833
|
+
type AssetDocumentControllerGetError = AssetDocumentControllerGetErrors[keyof AssetDocumentControllerGetErrors];
|
|
4834
|
+
type AssetDocumentControllerGetResponses = {
|
|
4835
|
+
200: DocumentResponseDto;
|
|
4836
|
+
};
|
|
4837
|
+
type AssetDocumentControllerGetResponse = AssetDocumentControllerGetResponses[keyof AssetDocumentControllerGetResponses];
|
|
4838
|
+
type AssetDocumentControllerUpdateData = {
|
|
4839
|
+
body: UpdateDocumentDto;
|
|
4840
|
+
headers?: {
|
|
4841
|
+
/**
|
|
4842
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
4843
|
+
*/
|
|
4844
|
+
'Idempotency-Key'?: string;
|
|
4845
|
+
};
|
|
4846
|
+
path: {
|
|
4847
|
+
/**
|
|
4848
|
+
* Document ID (numeric string)
|
|
4849
|
+
*/
|
|
4850
|
+
id: string;
|
|
4851
|
+
};
|
|
4852
|
+
query?: never;
|
|
4853
|
+
url: '/asset-document/{id}';
|
|
4854
|
+
};
|
|
4855
|
+
type AssetDocumentControllerUpdateErrors = {
|
|
4856
|
+
/**
|
|
4857
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4858
|
+
*/
|
|
4859
|
+
400: ApiErrorResponse;
|
|
4860
|
+
/**
|
|
4861
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4862
|
+
*/
|
|
4863
|
+
401: ApiErrorResponse;
|
|
4864
|
+
/**
|
|
4865
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4866
|
+
*/
|
|
4867
|
+
403: ApiErrorResponse;
|
|
4868
|
+
/**
|
|
4869
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
4870
|
+
*/
|
|
4871
|
+
404: ApiErrorResponse;
|
|
4872
|
+
/**
|
|
4873
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4874
|
+
*/
|
|
4875
|
+
429: ApiErrorResponse;
|
|
4876
|
+
/**
|
|
4877
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
4878
|
+
*/
|
|
4879
|
+
500: ApiErrorResponse;
|
|
4880
|
+
};
|
|
4881
|
+
type AssetDocumentControllerUpdateError = AssetDocumentControllerUpdateErrors[keyof AssetDocumentControllerUpdateErrors];
|
|
4882
|
+
type AssetDocumentControllerUpdateResponses = {
|
|
4883
|
+
200: DocumentResponseDto;
|
|
4884
|
+
};
|
|
4885
|
+
type AssetDocumentControllerUpdateResponse = AssetDocumentControllerUpdateResponses[keyof AssetDocumentControllerUpdateResponses];
|
|
4886
|
+
type AssetDocumentControllerCreateData = {
|
|
4887
|
+
body: CreateDocumentDto;
|
|
4888
|
+
headers?: {
|
|
4889
|
+
/**
|
|
4890
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
4891
|
+
*/
|
|
4892
|
+
'Idempotency-Key'?: string;
|
|
4893
|
+
};
|
|
4894
|
+
path?: never;
|
|
4895
|
+
query?: never;
|
|
4896
|
+
url: '/asset-document';
|
|
4897
|
+
};
|
|
4898
|
+
type AssetDocumentControllerCreateErrors = {
|
|
4899
|
+
/**
|
|
4900
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4901
|
+
*/
|
|
4902
|
+
400: ApiErrorResponse;
|
|
4903
|
+
/**
|
|
4904
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4905
|
+
*/
|
|
4906
|
+
401: ApiErrorResponse;
|
|
4907
|
+
/**
|
|
4908
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4909
|
+
*/
|
|
4910
|
+
403: ApiErrorResponse;
|
|
4911
|
+
/**
|
|
4912
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
4913
|
+
*/
|
|
4914
|
+
404: ApiErrorResponse;
|
|
4915
|
+
/**
|
|
4916
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
4917
|
+
*/
|
|
4918
|
+
409: ApiErrorResponse;
|
|
4919
|
+
/**
|
|
4920
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4921
|
+
*/
|
|
4922
|
+
429: ApiErrorResponse;
|
|
4923
|
+
/**
|
|
4924
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
4925
|
+
*/
|
|
4926
|
+
500: ApiErrorResponse;
|
|
4927
|
+
};
|
|
4928
|
+
type AssetDocumentControllerCreateError = AssetDocumentControllerCreateErrors[keyof AssetDocumentControllerCreateErrors];
|
|
4929
|
+
type AssetDocumentControllerCreateResponses = {
|
|
4930
|
+
201: DocumentResponseDto;
|
|
4931
|
+
};
|
|
4932
|
+
type AssetDocumentControllerCreateResponse = AssetDocumentControllerCreateResponses[keyof AssetDocumentControllerCreateResponses];
|
|
4933
|
+
type AssetClassDocumentControllerListData = {
|
|
4934
|
+
body?: never;
|
|
4935
|
+
path?: never;
|
|
4936
|
+
query?: {
|
|
4937
|
+
/**
|
|
4938
|
+
* Results per page
|
|
4939
|
+
*/
|
|
4940
|
+
per_page?: number;
|
|
4941
|
+
/**
|
|
4942
|
+
* Page number
|
|
4943
|
+
*/
|
|
4944
|
+
page?: number;
|
|
4945
|
+
direction?: 'asc' | 'desc';
|
|
4946
|
+
/**
|
|
4947
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
4948
|
+
*/
|
|
4949
|
+
sort?: string;
|
|
4950
|
+
/**
|
|
4951
|
+
* Filter to one parent by its publicId (UUID)
|
|
4952
|
+
*/
|
|
4953
|
+
parent_id?: string;
|
|
4954
|
+
/**
|
|
4955
|
+
* Filter by document type id (numeric string)
|
|
4956
|
+
*/
|
|
4957
|
+
document_type_id?: string;
|
|
4958
|
+
/**
|
|
4959
|
+
* Filter by name (case-insensitive partial)
|
|
4960
|
+
*/
|
|
4961
|
+
name?: string;
|
|
4962
|
+
/**
|
|
4963
|
+
* Filter: expires_on >= (ISO date)
|
|
4964
|
+
*/
|
|
4965
|
+
expires_on_from?: string;
|
|
4966
|
+
/**
|
|
4967
|
+
* Filter: expires_on <= (ISO date)
|
|
4968
|
+
*/
|
|
4969
|
+
expires_on_to?: string;
|
|
4970
|
+
/**
|
|
4971
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4972
|
+
*/
|
|
4973
|
+
document_date_updated_from?: string;
|
|
4974
|
+
/**
|
|
4975
|
+
* Filter: updated_at <= (ISO)
|
|
4976
|
+
*/
|
|
4977
|
+
document_date_updated_to?: string;
|
|
4978
|
+
};
|
|
4979
|
+
url: '/asset-class-document/list';
|
|
4980
|
+
};
|
|
4981
|
+
type AssetClassDocumentControllerListErrors = {
|
|
4982
|
+
/**
|
|
4983
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4984
|
+
*/
|
|
4985
|
+
400: ApiErrorResponse;
|
|
4986
|
+
/**
|
|
4987
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4988
|
+
*/
|
|
4989
|
+
401: ApiErrorResponse;
|
|
4990
|
+
/**
|
|
4991
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4992
|
+
*/
|
|
4993
|
+
403: ApiErrorResponse;
|
|
4994
|
+
/**
|
|
4995
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4996
|
+
*/
|
|
4997
|
+
429: ApiErrorResponse;
|
|
4998
|
+
/**
|
|
4999
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5000
|
+
*/
|
|
5001
|
+
500: ApiErrorResponse;
|
|
5002
|
+
};
|
|
5003
|
+
type AssetClassDocumentControllerListError = AssetClassDocumentControllerListErrors[keyof AssetClassDocumentControllerListErrors];
|
|
5004
|
+
type AssetClassDocumentControllerListResponses = {
|
|
5005
|
+
200: ListDocumentsResponseDto;
|
|
5006
|
+
};
|
|
5007
|
+
type AssetClassDocumentControllerListResponse = AssetClassDocumentControllerListResponses[keyof AssetClassDocumentControllerListResponses];
|
|
5008
|
+
type AssetClassDocumentControllerRemoveData = {
|
|
5009
|
+
body?: never;
|
|
5010
|
+
path: {
|
|
5011
|
+
/**
|
|
5012
|
+
* Document ID (numeric string)
|
|
5013
|
+
*/
|
|
5014
|
+
id: string;
|
|
5015
|
+
};
|
|
5016
|
+
query?: never;
|
|
5017
|
+
url: '/asset-class-document/{id}';
|
|
5018
|
+
};
|
|
5019
|
+
type AssetClassDocumentControllerRemoveErrors = {
|
|
5020
|
+
/**
|
|
5021
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5022
|
+
*/
|
|
5023
|
+
400: ApiErrorResponse;
|
|
5024
|
+
/**
|
|
5025
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5026
|
+
*/
|
|
5027
|
+
401: ApiErrorResponse;
|
|
5028
|
+
/**
|
|
5029
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5030
|
+
*/
|
|
5031
|
+
403: ApiErrorResponse;
|
|
5032
|
+
/**
|
|
5033
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5034
|
+
*/
|
|
5035
|
+
404: ApiErrorResponse;
|
|
5036
|
+
/**
|
|
5037
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5038
|
+
*/
|
|
5039
|
+
429: ApiErrorResponse;
|
|
5040
|
+
/**
|
|
5041
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5042
|
+
*/
|
|
5043
|
+
500: ApiErrorResponse;
|
|
5044
|
+
};
|
|
5045
|
+
type AssetClassDocumentControllerRemoveError = AssetClassDocumentControllerRemoveErrors[keyof AssetClassDocumentControllerRemoveErrors];
|
|
5046
|
+
type AssetClassDocumentControllerRemoveResponses = {
|
|
5047
|
+
200: DeleteDocumentResponseDto;
|
|
5048
|
+
};
|
|
5049
|
+
type AssetClassDocumentControllerRemoveResponse = AssetClassDocumentControllerRemoveResponses[keyof AssetClassDocumentControllerRemoveResponses];
|
|
5050
|
+
type AssetClassDocumentControllerGetData = {
|
|
5051
|
+
body?: never;
|
|
5052
|
+
path: {
|
|
5053
|
+
/**
|
|
5054
|
+
* Document ID (numeric string)
|
|
5055
|
+
*/
|
|
5056
|
+
id: string;
|
|
5057
|
+
};
|
|
5058
|
+
query?: never;
|
|
5059
|
+
url: '/asset-class-document/{id}';
|
|
5060
|
+
};
|
|
5061
|
+
type AssetClassDocumentControllerGetErrors = {
|
|
5062
|
+
/**
|
|
5063
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5064
|
+
*/
|
|
5065
|
+
400: ApiErrorResponse;
|
|
5066
|
+
/**
|
|
5067
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5068
|
+
*/
|
|
5069
|
+
401: ApiErrorResponse;
|
|
5070
|
+
/**
|
|
5071
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5072
|
+
*/
|
|
5073
|
+
403: ApiErrorResponse;
|
|
5074
|
+
/**
|
|
5075
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5076
|
+
*/
|
|
5077
|
+
404: ApiErrorResponse;
|
|
5078
|
+
/**
|
|
5079
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5080
|
+
*/
|
|
5081
|
+
429: ApiErrorResponse;
|
|
5082
|
+
/**
|
|
5083
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5084
|
+
*/
|
|
5085
|
+
500: ApiErrorResponse;
|
|
5086
|
+
};
|
|
5087
|
+
type AssetClassDocumentControllerGetError = AssetClassDocumentControllerGetErrors[keyof AssetClassDocumentControllerGetErrors];
|
|
5088
|
+
type AssetClassDocumentControllerGetResponses = {
|
|
5089
|
+
200: DocumentResponseDto;
|
|
5090
|
+
};
|
|
5091
|
+
type AssetClassDocumentControllerGetResponse = AssetClassDocumentControllerGetResponses[keyof AssetClassDocumentControllerGetResponses];
|
|
5092
|
+
type AssetClassDocumentControllerUpdateData = {
|
|
5093
|
+
body: UpdateDocumentDto;
|
|
5094
|
+
headers?: {
|
|
5095
|
+
/**
|
|
5096
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5097
|
+
*/
|
|
5098
|
+
'Idempotency-Key'?: string;
|
|
5099
|
+
};
|
|
5100
|
+
path: {
|
|
5101
|
+
/**
|
|
5102
|
+
* Document ID (numeric string)
|
|
5103
|
+
*/
|
|
5104
|
+
id: string;
|
|
5105
|
+
};
|
|
5106
|
+
query?: never;
|
|
5107
|
+
url: '/asset-class-document/{id}';
|
|
5108
|
+
};
|
|
5109
|
+
type AssetClassDocumentControllerUpdateErrors = {
|
|
5110
|
+
/**
|
|
5111
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5112
|
+
*/
|
|
5113
|
+
400: ApiErrorResponse;
|
|
5114
|
+
/**
|
|
5115
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5116
|
+
*/
|
|
5117
|
+
401: ApiErrorResponse;
|
|
5118
|
+
/**
|
|
5119
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5120
|
+
*/
|
|
5121
|
+
403: ApiErrorResponse;
|
|
5122
|
+
/**
|
|
5123
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5124
|
+
*/
|
|
5125
|
+
404: ApiErrorResponse;
|
|
5126
|
+
/**
|
|
5127
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5128
|
+
*/
|
|
5129
|
+
429: ApiErrorResponse;
|
|
5130
|
+
/**
|
|
5131
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5132
|
+
*/
|
|
5133
|
+
500: ApiErrorResponse;
|
|
5134
|
+
};
|
|
5135
|
+
type AssetClassDocumentControllerUpdateError = AssetClassDocumentControllerUpdateErrors[keyof AssetClassDocumentControllerUpdateErrors];
|
|
5136
|
+
type AssetClassDocumentControllerUpdateResponses = {
|
|
5137
|
+
200: DocumentResponseDto;
|
|
5138
|
+
};
|
|
5139
|
+
type AssetClassDocumentControllerUpdateResponse = AssetClassDocumentControllerUpdateResponses[keyof AssetClassDocumentControllerUpdateResponses];
|
|
5140
|
+
type AssetClassDocumentControllerCreateData = {
|
|
5141
|
+
body: CreateDocumentDto;
|
|
5142
|
+
headers?: {
|
|
5143
|
+
/**
|
|
5144
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5145
|
+
*/
|
|
5146
|
+
'Idempotency-Key'?: string;
|
|
5147
|
+
};
|
|
5148
|
+
path?: never;
|
|
5149
|
+
query?: never;
|
|
5150
|
+
url: '/asset-class-document';
|
|
5151
|
+
};
|
|
5152
|
+
type AssetClassDocumentControllerCreateErrors = {
|
|
5153
|
+
/**
|
|
5154
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5155
|
+
*/
|
|
5156
|
+
400: ApiErrorResponse;
|
|
5157
|
+
/**
|
|
5158
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5159
|
+
*/
|
|
5160
|
+
401: ApiErrorResponse;
|
|
5161
|
+
/**
|
|
5162
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5163
|
+
*/
|
|
5164
|
+
403: ApiErrorResponse;
|
|
5165
|
+
/**
|
|
5166
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5167
|
+
*/
|
|
5168
|
+
404: ApiErrorResponse;
|
|
5169
|
+
/**
|
|
5170
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5171
|
+
*/
|
|
5172
|
+
409: ApiErrorResponse;
|
|
5173
|
+
/**
|
|
5174
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5175
|
+
*/
|
|
5176
|
+
429: ApiErrorResponse;
|
|
5177
|
+
/**
|
|
5178
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5179
|
+
*/
|
|
5180
|
+
500: ApiErrorResponse;
|
|
5181
|
+
};
|
|
5182
|
+
type AssetClassDocumentControllerCreateError = AssetClassDocumentControllerCreateErrors[keyof AssetClassDocumentControllerCreateErrors];
|
|
5183
|
+
type AssetClassDocumentControllerCreateResponses = {
|
|
5184
|
+
201: DocumentResponseDto;
|
|
5185
|
+
};
|
|
5186
|
+
type AssetClassDocumentControllerCreateResponse = AssetClassDocumentControllerCreateResponses[keyof AssetClassDocumentControllerCreateResponses];
|
|
5187
|
+
type UserDocumentControllerListData = {
|
|
5188
|
+
body?: never;
|
|
5189
|
+
path?: never;
|
|
5190
|
+
query?: {
|
|
5191
|
+
/**
|
|
5192
|
+
* Results per page
|
|
5193
|
+
*/
|
|
5194
|
+
per_page?: number;
|
|
5195
|
+
/**
|
|
5196
|
+
* Page number
|
|
5197
|
+
*/
|
|
5198
|
+
page?: number;
|
|
5199
|
+
direction?: 'asc' | 'desc';
|
|
5200
|
+
/**
|
|
5201
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5202
|
+
*/
|
|
5203
|
+
sort?: string;
|
|
5204
|
+
/**
|
|
5205
|
+
* Filter to one parent by its publicId (UUID)
|
|
5206
|
+
*/
|
|
5207
|
+
parent_id?: string;
|
|
5208
|
+
/**
|
|
5209
|
+
* Filter by document type id (numeric string)
|
|
5210
|
+
*/
|
|
5211
|
+
document_type_id?: string;
|
|
5212
|
+
/**
|
|
5213
|
+
* Filter by name (case-insensitive partial)
|
|
5214
|
+
*/
|
|
5215
|
+
name?: string;
|
|
5216
|
+
/**
|
|
5217
|
+
* Filter: expires_on >= (ISO date)
|
|
5218
|
+
*/
|
|
5219
|
+
expires_on_from?: string;
|
|
5220
|
+
/**
|
|
5221
|
+
* Filter: expires_on <= (ISO date)
|
|
5222
|
+
*/
|
|
5223
|
+
expires_on_to?: string;
|
|
5224
|
+
/**
|
|
5225
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5226
|
+
*/
|
|
5227
|
+
document_date_updated_from?: string;
|
|
5228
|
+
/**
|
|
5229
|
+
* Filter: updated_at <= (ISO)
|
|
5230
|
+
*/
|
|
5231
|
+
document_date_updated_to?: string;
|
|
5232
|
+
};
|
|
5233
|
+
url: '/user-document/list';
|
|
5234
|
+
};
|
|
5235
|
+
type UserDocumentControllerListErrors = {
|
|
5236
|
+
/**
|
|
5237
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5238
|
+
*/
|
|
5239
|
+
400: ApiErrorResponse;
|
|
5240
|
+
/**
|
|
5241
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5242
|
+
*/
|
|
5243
|
+
401: ApiErrorResponse;
|
|
5244
|
+
/**
|
|
5245
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5246
|
+
*/
|
|
5247
|
+
403: ApiErrorResponse;
|
|
5248
|
+
/**
|
|
5249
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5250
|
+
*/
|
|
5251
|
+
429: ApiErrorResponse;
|
|
5252
|
+
/**
|
|
5253
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5254
|
+
*/
|
|
5255
|
+
500: ApiErrorResponse;
|
|
5256
|
+
};
|
|
5257
|
+
type UserDocumentControllerListError = UserDocumentControllerListErrors[keyof UserDocumentControllerListErrors];
|
|
5258
|
+
type UserDocumentControllerListResponses = {
|
|
5259
|
+
200: ListDocumentsResponseDto;
|
|
5260
|
+
};
|
|
5261
|
+
type UserDocumentControllerListResponse = UserDocumentControllerListResponses[keyof UserDocumentControllerListResponses];
|
|
5262
|
+
type UserDocumentControllerRemoveData = {
|
|
5263
|
+
body?: never;
|
|
5264
|
+
path: {
|
|
5265
|
+
/**
|
|
5266
|
+
* Document ID (numeric string)
|
|
5267
|
+
*/
|
|
5268
|
+
id: string;
|
|
5269
|
+
};
|
|
5270
|
+
query?: never;
|
|
5271
|
+
url: '/user-document/{id}';
|
|
5272
|
+
};
|
|
5273
|
+
type UserDocumentControllerRemoveErrors = {
|
|
5274
|
+
/**
|
|
5275
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5276
|
+
*/
|
|
5277
|
+
400: ApiErrorResponse;
|
|
5278
|
+
/**
|
|
5279
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5280
|
+
*/
|
|
5281
|
+
401: ApiErrorResponse;
|
|
5282
|
+
/**
|
|
5283
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5284
|
+
*/
|
|
5285
|
+
403: ApiErrorResponse;
|
|
5286
|
+
/**
|
|
5287
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5288
|
+
*/
|
|
5289
|
+
404: ApiErrorResponse;
|
|
5290
|
+
/**
|
|
5291
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5292
|
+
*/
|
|
5293
|
+
429: ApiErrorResponse;
|
|
5294
|
+
/**
|
|
5295
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5296
|
+
*/
|
|
5297
|
+
500: ApiErrorResponse;
|
|
5298
|
+
};
|
|
5299
|
+
type UserDocumentControllerRemoveError = UserDocumentControllerRemoveErrors[keyof UserDocumentControllerRemoveErrors];
|
|
5300
|
+
type UserDocumentControllerRemoveResponses = {
|
|
5301
|
+
200: DeleteDocumentResponseDto;
|
|
5302
|
+
};
|
|
5303
|
+
type UserDocumentControllerRemoveResponse = UserDocumentControllerRemoveResponses[keyof UserDocumentControllerRemoveResponses];
|
|
5304
|
+
type UserDocumentControllerGetData = {
|
|
5305
|
+
body?: never;
|
|
5306
|
+
path: {
|
|
5307
|
+
/**
|
|
5308
|
+
* Document ID (numeric string)
|
|
5309
|
+
*/
|
|
5310
|
+
id: string;
|
|
5311
|
+
};
|
|
5312
|
+
query?: never;
|
|
5313
|
+
url: '/user-document/{id}';
|
|
5314
|
+
};
|
|
5315
|
+
type UserDocumentControllerGetErrors = {
|
|
5316
|
+
/**
|
|
5317
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5318
|
+
*/
|
|
5319
|
+
400: ApiErrorResponse;
|
|
5320
|
+
/**
|
|
5321
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5322
|
+
*/
|
|
5323
|
+
401: ApiErrorResponse;
|
|
5324
|
+
/**
|
|
5325
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5326
|
+
*/
|
|
5327
|
+
403: ApiErrorResponse;
|
|
5328
|
+
/**
|
|
5329
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5330
|
+
*/
|
|
5331
|
+
404: ApiErrorResponse;
|
|
5332
|
+
/**
|
|
5333
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5334
|
+
*/
|
|
5335
|
+
429: ApiErrorResponse;
|
|
5336
|
+
/**
|
|
5337
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5338
|
+
*/
|
|
5339
|
+
500: ApiErrorResponse;
|
|
5340
|
+
};
|
|
5341
|
+
type UserDocumentControllerGetError = UserDocumentControllerGetErrors[keyof UserDocumentControllerGetErrors];
|
|
5342
|
+
type UserDocumentControllerGetResponses = {
|
|
5343
|
+
200: DocumentResponseDto;
|
|
5344
|
+
};
|
|
5345
|
+
type UserDocumentControllerGetResponse = UserDocumentControllerGetResponses[keyof UserDocumentControllerGetResponses];
|
|
5346
|
+
type UserDocumentControllerUpdateData = {
|
|
5347
|
+
body: UpdateDocumentDto;
|
|
5348
|
+
headers?: {
|
|
5349
|
+
/**
|
|
5350
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5351
|
+
*/
|
|
5352
|
+
'Idempotency-Key'?: string;
|
|
5353
|
+
};
|
|
5354
|
+
path: {
|
|
5355
|
+
/**
|
|
5356
|
+
* Document ID (numeric string)
|
|
5357
|
+
*/
|
|
5358
|
+
id: string;
|
|
5359
|
+
};
|
|
5360
|
+
query?: never;
|
|
5361
|
+
url: '/user-document/{id}';
|
|
5362
|
+
};
|
|
5363
|
+
type UserDocumentControllerUpdateErrors = {
|
|
5364
|
+
/**
|
|
5365
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5366
|
+
*/
|
|
5367
|
+
400: ApiErrorResponse;
|
|
5368
|
+
/**
|
|
5369
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5370
|
+
*/
|
|
5371
|
+
401: ApiErrorResponse;
|
|
5372
|
+
/**
|
|
5373
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5374
|
+
*/
|
|
5375
|
+
403: ApiErrorResponse;
|
|
5376
|
+
/**
|
|
5377
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5378
|
+
*/
|
|
5379
|
+
404: ApiErrorResponse;
|
|
5380
|
+
/**
|
|
5381
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5382
|
+
*/
|
|
5383
|
+
429: ApiErrorResponse;
|
|
5384
|
+
/**
|
|
5385
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5386
|
+
*/
|
|
5387
|
+
500: ApiErrorResponse;
|
|
5388
|
+
};
|
|
5389
|
+
type UserDocumentControllerUpdateError = UserDocumentControllerUpdateErrors[keyof UserDocumentControllerUpdateErrors];
|
|
5390
|
+
type UserDocumentControllerUpdateResponses = {
|
|
5391
|
+
200: DocumentResponseDto;
|
|
5392
|
+
};
|
|
5393
|
+
type UserDocumentControllerUpdateResponse = UserDocumentControllerUpdateResponses[keyof UserDocumentControllerUpdateResponses];
|
|
5394
|
+
type UserDocumentControllerCreateData = {
|
|
5395
|
+
body: CreateDocumentDto;
|
|
5396
|
+
headers?: {
|
|
5397
|
+
/**
|
|
5398
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5399
|
+
*/
|
|
5400
|
+
'Idempotency-Key'?: string;
|
|
5401
|
+
};
|
|
5402
|
+
path?: never;
|
|
5403
|
+
query?: never;
|
|
5404
|
+
url: '/user-document';
|
|
5405
|
+
};
|
|
5406
|
+
type UserDocumentControllerCreateErrors = {
|
|
5407
|
+
/**
|
|
5408
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5409
|
+
*/
|
|
5410
|
+
400: ApiErrorResponse;
|
|
5411
|
+
/**
|
|
5412
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5413
|
+
*/
|
|
5414
|
+
401: ApiErrorResponse;
|
|
5415
|
+
/**
|
|
5416
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5417
|
+
*/
|
|
5418
|
+
403: ApiErrorResponse;
|
|
5419
|
+
/**
|
|
5420
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5421
|
+
*/
|
|
5422
|
+
404: ApiErrorResponse;
|
|
5423
|
+
/**
|
|
5424
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5425
|
+
*/
|
|
5426
|
+
409: ApiErrorResponse;
|
|
5427
|
+
/**
|
|
5428
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5429
|
+
*/
|
|
5430
|
+
429: ApiErrorResponse;
|
|
5431
|
+
/**
|
|
5432
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5433
|
+
*/
|
|
5434
|
+
500: ApiErrorResponse;
|
|
5435
|
+
};
|
|
5436
|
+
type UserDocumentControllerCreateError = UserDocumentControllerCreateErrors[keyof UserDocumentControllerCreateErrors];
|
|
5437
|
+
type UserDocumentControllerCreateResponses = {
|
|
5438
|
+
201: DocumentResponseDto;
|
|
5439
|
+
};
|
|
5440
|
+
type UserDocumentControllerCreateResponse = UserDocumentControllerCreateResponses[keyof UserDocumentControllerCreateResponses];
|
|
5441
|
+
type SiteDocumentControllerListData = {
|
|
5442
|
+
body?: never;
|
|
5443
|
+
path?: never;
|
|
5444
|
+
query?: {
|
|
5445
|
+
/**
|
|
5446
|
+
* Results per page
|
|
5447
|
+
*/
|
|
5448
|
+
per_page?: number;
|
|
5449
|
+
/**
|
|
5450
|
+
* Page number
|
|
5451
|
+
*/
|
|
5452
|
+
page?: number;
|
|
5453
|
+
direction?: 'asc' | 'desc';
|
|
5454
|
+
/**
|
|
5455
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5456
|
+
*/
|
|
5457
|
+
sort?: string;
|
|
5458
|
+
/**
|
|
5459
|
+
* Filter to one parent by its publicId (UUID)
|
|
5460
|
+
*/
|
|
5461
|
+
parent_id?: string;
|
|
5462
|
+
/**
|
|
5463
|
+
* Filter by document type id (numeric string)
|
|
5464
|
+
*/
|
|
5465
|
+
document_type_id?: string;
|
|
5466
|
+
/**
|
|
5467
|
+
* Filter by name (case-insensitive partial)
|
|
5468
|
+
*/
|
|
5469
|
+
name?: string;
|
|
5470
|
+
/**
|
|
5471
|
+
* Filter: expires_on >= (ISO date)
|
|
5472
|
+
*/
|
|
5473
|
+
expires_on_from?: string;
|
|
5474
|
+
/**
|
|
5475
|
+
* Filter: expires_on <= (ISO date)
|
|
5476
|
+
*/
|
|
5477
|
+
expires_on_to?: string;
|
|
5478
|
+
/**
|
|
5479
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5480
|
+
*/
|
|
5481
|
+
document_date_updated_from?: string;
|
|
5482
|
+
/**
|
|
5483
|
+
* Filter: updated_at <= (ISO)
|
|
5484
|
+
*/
|
|
5485
|
+
document_date_updated_to?: string;
|
|
5486
|
+
};
|
|
5487
|
+
url: '/site-document/list';
|
|
5488
|
+
};
|
|
5489
|
+
type SiteDocumentControllerListErrors = {
|
|
5490
|
+
/**
|
|
5491
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5492
|
+
*/
|
|
5493
|
+
400: ApiErrorResponse;
|
|
5494
|
+
/**
|
|
5495
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5496
|
+
*/
|
|
5497
|
+
401: ApiErrorResponse;
|
|
5498
|
+
/**
|
|
5499
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5500
|
+
*/
|
|
5501
|
+
403: ApiErrorResponse;
|
|
5502
|
+
/**
|
|
5503
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5504
|
+
*/
|
|
5505
|
+
429: ApiErrorResponse;
|
|
5506
|
+
/**
|
|
5507
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5508
|
+
*/
|
|
5509
|
+
500: ApiErrorResponse;
|
|
5510
|
+
};
|
|
5511
|
+
type SiteDocumentControllerListError = SiteDocumentControllerListErrors[keyof SiteDocumentControllerListErrors];
|
|
5512
|
+
type SiteDocumentControllerListResponses = {
|
|
5513
|
+
200: ListDocumentsResponseDto;
|
|
5514
|
+
};
|
|
5515
|
+
type SiteDocumentControllerListResponse = SiteDocumentControllerListResponses[keyof SiteDocumentControllerListResponses];
|
|
5516
|
+
type SiteDocumentControllerRemoveData = {
|
|
5517
|
+
body?: never;
|
|
5518
|
+
path: {
|
|
5519
|
+
/**
|
|
5520
|
+
* Document ID (numeric string)
|
|
5521
|
+
*/
|
|
5522
|
+
id: string;
|
|
5523
|
+
};
|
|
5524
|
+
query?: never;
|
|
5525
|
+
url: '/site-document/{id}';
|
|
5526
|
+
};
|
|
5527
|
+
type SiteDocumentControllerRemoveErrors = {
|
|
5528
|
+
/**
|
|
5529
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5530
|
+
*/
|
|
5531
|
+
400: ApiErrorResponse;
|
|
5532
|
+
/**
|
|
5533
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5534
|
+
*/
|
|
5535
|
+
401: ApiErrorResponse;
|
|
5536
|
+
/**
|
|
5537
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5538
|
+
*/
|
|
5539
|
+
403: ApiErrorResponse;
|
|
5540
|
+
/**
|
|
5541
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5542
|
+
*/
|
|
5543
|
+
404: ApiErrorResponse;
|
|
5544
|
+
/**
|
|
5545
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5546
|
+
*/
|
|
5547
|
+
429: ApiErrorResponse;
|
|
5548
|
+
/**
|
|
5549
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5550
|
+
*/
|
|
5551
|
+
500: ApiErrorResponse;
|
|
5552
|
+
};
|
|
5553
|
+
type SiteDocumentControllerRemoveError = SiteDocumentControllerRemoveErrors[keyof SiteDocumentControllerRemoveErrors];
|
|
5554
|
+
type SiteDocumentControllerRemoveResponses = {
|
|
5555
|
+
200: DeleteDocumentResponseDto;
|
|
5556
|
+
};
|
|
5557
|
+
type SiteDocumentControllerRemoveResponse = SiteDocumentControllerRemoveResponses[keyof SiteDocumentControllerRemoveResponses];
|
|
5558
|
+
type SiteDocumentControllerGetData = {
|
|
5559
|
+
body?: never;
|
|
5560
|
+
path: {
|
|
5561
|
+
/**
|
|
5562
|
+
* Document ID (numeric string)
|
|
5563
|
+
*/
|
|
5564
|
+
id: string;
|
|
5565
|
+
};
|
|
5566
|
+
query?: never;
|
|
5567
|
+
url: '/site-document/{id}';
|
|
5568
|
+
};
|
|
5569
|
+
type SiteDocumentControllerGetErrors = {
|
|
5570
|
+
/**
|
|
5571
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5572
|
+
*/
|
|
5573
|
+
400: ApiErrorResponse;
|
|
5574
|
+
/**
|
|
5575
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5576
|
+
*/
|
|
5577
|
+
401: ApiErrorResponse;
|
|
5578
|
+
/**
|
|
5579
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5580
|
+
*/
|
|
5581
|
+
403: ApiErrorResponse;
|
|
5582
|
+
/**
|
|
5583
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5584
|
+
*/
|
|
5585
|
+
404: ApiErrorResponse;
|
|
5586
|
+
/**
|
|
5587
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5588
|
+
*/
|
|
5589
|
+
429: ApiErrorResponse;
|
|
5590
|
+
/**
|
|
5591
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5592
|
+
*/
|
|
5593
|
+
500: ApiErrorResponse;
|
|
5594
|
+
};
|
|
5595
|
+
type SiteDocumentControllerGetError = SiteDocumentControllerGetErrors[keyof SiteDocumentControllerGetErrors];
|
|
5596
|
+
type SiteDocumentControllerGetResponses = {
|
|
5597
|
+
200: DocumentResponseDto;
|
|
5598
|
+
};
|
|
5599
|
+
type SiteDocumentControllerGetResponse = SiteDocumentControllerGetResponses[keyof SiteDocumentControllerGetResponses];
|
|
5600
|
+
type SiteDocumentControllerUpdateData = {
|
|
5601
|
+
body: UpdateDocumentDto;
|
|
5602
|
+
headers?: {
|
|
5603
|
+
/**
|
|
5604
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5605
|
+
*/
|
|
5606
|
+
'Idempotency-Key'?: string;
|
|
5607
|
+
};
|
|
5608
|
+
path: {
|
|
5609
|
+
/**
|
|
5610
|
+
* Document ID (numeric string)
|
|
5611
|
+
*/
|
|
5612
|
+
id: string;
|
|
5613
|
+
};
|
|
5614
|
+
query?: never;
|
|
5615
|
+
url: '/site-document/{id}';
|
|
5616
|
+
};
|
|
5617
|
+
type SiteDocumentControllerUpdateErrors = {
|
|
5618
|
+
/**
|
|
5619
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5620
|
+
*/
|
|
5621
|
+
400: ApiErrorResponse;
|
|
5622
|
+
/**
|
|
5623
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5624
|
+
*/
|
|
5625
|
+
401: ApiErrorResponse;
|
|
5626
|
+
/**
|
|
5627
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5628
|
+
*/
|
|
5629
|
+
403: ApiErrorResponse;
|
|
5630
|
+
/**
|
|
5631
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5632
|
+
*/
|
|
5633
|
+
404: ApiErrorResponse;
|
|
5634
|
+
/**
|
|
5635
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5636
|
+
*/
|
|
5637
|
+
429: ApiErrorResponse;
|
|
5638
|
+
/**
|
|
5639
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5640
|
+
*/
|
|
5641
|
+
500: ApiErrorResponse;
|
|
5642
|
+
};
|
|
5643
|
+
type SiteDocumentControllerUpdateError = SiteDocumentControllerUpdateErrors[keyof SiteDocumentControllerUpdateErrors];
|
|
5644
|
+
type SiteDocumentControllerUpdateResponses = {
|
|
5645
|
+
200: DocumentResponseDto;
|
|
5646
|
+
};
|
|
5647
|
+
type SiteDocumentControllerUpdateResponse = SiteDocumentControllerUpdateResponses[keyof SiteDocumentControllerUpdateResponses];
|
|
5648
|
+
type SiteDocumentControllerCreateData = {
|
|
5649
|
+
body: CreateDocumentDto;
|
|
5650
|
+
headers?: {
|
|
5651
|
+
/**
|
|
5652
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5653
|
+
*/
|
|
5654
|
+
'Idempotency-Key'?: string;
|
|
5655
|
+
};
|
|
5656
|
+
path?: never;
|
|
5657
|
+
query?: never;
|
|
5658
|
+
url: '/site-document';
|
|
5659
|
+
};
|
|
5660
|
+
type SiteDocumentControllerCreateErrors = {
|
|
5661
|
+
/**
|
|
5662
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5663
|
+
*/
|
|
5664
|
+
400: ApiErrorResponse;
|
|
5665
|
+
/**
|
|
5666
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5667
|
+
*/
|
|
5668
|
+
401: ApiErrorResponse;
|
|
5669
|
+
/**
|
|
5670
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5671
|
+
*/
|
|
5672
|
+
403: ApiErrorResponse;
|
|
5673
|
+
/**
|
|
5674
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5675
|
+
*/
|
|
5676
|
+
404: ApiErrorResponse;
|
|
5677
|
+
/**
|
|
5678
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5679
|
+
*/
|
|
5680
|
+
409: ApiErrorResponse;
|
|
5681
|
+
/**
|
|
5682
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5683
|
+
*/
|
|
5684
|
+
429: ApiErrorResponse;
|
|
5685
|
+
/**
|
|
5686
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5687
|
+
*/
|
|
5688
|
+
500: ApiErrorResponse;
|
|
5689
|
+
};
|
|
5690
|
+
type SiteDocumentControllerCreateError = SiteDocumentControllerCreateErrors[keyof SiteDocumentControllerCreateErrors];
|
|
5691
|
+
type SiteDocumentControllerCreateResponses = {
|
|
5692
|
+
201: DocumentResponseDto;
|
|
5693
|
+
};
|
|
5694
|
+
type SiteDocumentControllerCreateResponse = SiteDocumentControllerCreateResponses[keyof SiteDocumentControllerCreateResponses];
|
|
5695
|
+
type CustomerDocumentControllerListData = {
|
|
5696
|
+
body?: never;
|
|
5697
|
+
path?: never;
|
|
5698
|
+
query?: {
|
|
5699
|
+
/**
|
|
5700
|
+
* Results per page
|
|
5701
|
+
*/
|
|
5702
|
+
per_page?: number;
|
|
5703
|
+
/**
|
|
5704
|
+
* Page number
|
|
5705
|
+
*/
|
|
5706
|
+
page?: number;
|
|
5707
|
+
direction?: 'asc' | 'desc';
|
|
5708
|
+
/**
|
|
5709
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5710
|
+
*/
|
|
5711
|
+
sort?: string;
|
|
5712
|
+
/**
|
|
5713
|
+
* Filter to one parent by its publicId (UUID)
|
|
5714
|
+
*/
|
|
5715
|
+
parent_id?: string;
|
|
5716
|
+
/**
|
|
5717
|
+
* Filter by document type id (numeric string)
|
|
5718
|
+
*/
|
|
5719
|
+
document_type_id?: string;
|
|
5720
|
+
/**
|
|
5721
|
+
* Filter by name (case-insensitive partial)
|
|
5722
|
+
*/
|
|
5723
|
+
name?: string;
|
|
5724
|
+
/**
|
|
5725
|
+
* Filter: expires_on >= (ISO date)
|
|
5726
|
+
*/
|
|
5727
|
+
expires_on_from?: string;
|
|
5728
|
+
/**
|
|
5729
|
+
* Filter: expires_on <= (ISO date)
|
|
5730
|
+
*/
|
|
5731
|
+
expires_on_to?: string;
|
|
5732
|
+
/**
|
|
5733
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5734
|
+
*/
|
|
5735
|
+
document_date_updated_from?: string;
|
|
5736
|
+
/**
|
|
5737
|
+
* Filter: updated_at <= (ISO)
|
|
5738
|
+
*/
|
|
5739
|
+
document_date_updated_to?: string;
|
|
5740
|
+
};
|
|
5741
|
+
url: '/customer-document/list';
|
|
5742
|
+
};
|
|
5743
|
+
type CustomerDocumentControllerListErrors = {
|
|
5744
|
+
/**
|
|
5745
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5746
|
+
*/
|
|
5747
|
+
400: ApiErrorResponse;
|
|
5748
|
+
/**
|
|
5749
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5750
|
+
*/
|
|
5751
|
+
401: ApiErrorResponse;
|
|
5752
|
+
/**
|
|
5753
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5754
|
+
*/
|
|
5755
|
+
403: ApiErrorResponse;
|
|
5756
|
+
/**
|
|
5757
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5758
|
+
*/
|
|
5759
|
+
429: ApiErrorResponse;
|
|
5760
|
+
/**
|
|
5761
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5762
|
+
*/
|
|
5763
|
+
500: ApiErrorResponse;
|
|
5764
|
+
};
|
|
5765
|
+
type CustomerDocumentControllerListError = CustomerDocumentControllerListErrors[keyof CustomerDocumentControllerListErrors];
|
|
5766
|
+
type CustomerDocumentControllerListResponses = {
|
|
5767
|
+
200: ListDocumentsResponseDto;
|
|
5768
|
+
};
|
|
5769
|
+
type CustomerDocumentControllerListResponse = CustomerDocumentControllerListResponses[keyof CustomerDocumentControllerListResponses];
|
|
5770
|
+
type CustomerDocumentControllerRemoveData = {
|
|
5771
|
+
body?: never;
|
|
5772
|
+
path: {
|
|
5773
|
+
/**
|
|
5774
|
+
* Document ID (numeric string)
|
|
5775
|
+
*/
|
|
5776
|
+
id: string;
|
|
5777
|
+
};
|
|
5778
|
+
query?: never;
|
|
5779
|
+
url: '/customer-document/{id}';
|
|
5780
|
+
};
|
|
5781
|
+
type CustomerDocumentControllerRemoveErrors = {
|
|
5782
|
+
/**
|
|
5783
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5784
|
+
*/
|
|
5785
|
+
400: ApiErrorResponse;
|
|
5786
|
+
/**
|
|
5787
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5788
|
+
*/
|
|
5789
|
+
401: ApiErrorResponse;
|
|
5790
|
+
/**
|
|
5791
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5792
|
+
*/
|
|
5793
|
+
403: ApiErrorResponse;
|
|
5794
|
+
/**
|
|
5795
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5796
|
+
*/
|
|
5797
|
+
404: ApiErrorResponse;
|
|
5798
|
+
/**
|
|
5799
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5800
|
+
*/
|
|
5801
|
+
429: ApiErrorResponse;
|
|
5802
|
+
/**
|
|
5803
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5804
|
+
*/
|
|
5805
|
+
500: ApiErrorResponse;
|
|
5806
|
+
};
|
|
5807
|
+
type CustomerDocumentControllerRemoveError = CustomerDocumentControllerRemoveErrors[keyof CustomerDocumentControllerRemoveErrors];
|
|
5808
|
+
type CustomerDocumentControllerRemoveResponses = {
|
|
5809
|
+
200: DeleteDocumentResponseDto;
|
|
5810
|
+
};
|
|
5811
|
+
type CustomerDocumentControllerRemoveResponse = CustomerDocumentControllerRemoveResponses[keyof CustomerDocumentControllerRemoveResponses];
|
|
5812
|
+
type CustomerDocumentControllerGetData = {
|
|
5813
|
+
body?: never;
|
|
5814
|
+
path: {
|
|
5815
|
+
/**
|
|
5816
|
+
* Document ID (numeric string)
|
|
5817
|
+
*/
|
|
5818
|
+
id: string;
|
|
5819
|
+
};
|
|
5820
|
+
query?: never;
|
|
5821
|
+
url: '/customer-document/{id}';
|
|
5822
|
+
};
|
|
5823
|
+
type CustomerDocumentControllerGetErrors = {
|
|
5824
|
+
/**
|
|
5825
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5826
|
+
*/
|
|
5827
|
+
400: ApiErrorResponse;
|
|
5828
|
+
/**
|
|
5829
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5830
|
+
*/
|
|
5831
|
+
401: ApiErrorResponse;
|
|
5832
|
+
/**
|
|
5833
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5834
|
+
*/
|
|
5835
|
+
403: ApiErrorResponse;
|
|
5836
|
+
/**
|
|
5837
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5838
|
+
*/
|
|
5839
|
+
404: ApiErrorResponse;
|
|
5840
|
+
/**
|
|
5841
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5842
|
+
*/
|
|
5843
|
+
429: ApiErrorResponse;
|
|
5844
|
+
/**
|
|
5845
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5846
|
+
*/
|
|
5847
|
+
500: ApiErrorResponse;
|
|
5848
|
+
};
|
|
5849
|
+
type CustomerDocumentControllerGetError = CustomerDocumentControllerGetErrors[keyof CustomerDocumentControllerGetErrors];
|
|
5850
|
+
type CustomerDocumentControllerGetResponses = {
|
|
5851
|
+
200: DocumentResponseDto;
|
|
5852
|
+
};
|
|
5853
|
+
type CustomerDocumentControllerGetResponse = CustomerDocumentControllerGetResponses[keyof CustomerDocumentControllerGetResponses];
|
|
5854
|
+
type CustomerDocumentControllerUpdateData = {
|
|
5855
|
+
body: UpdateDocumentDto;
|
|
5856
|
+
headers?: {
|
|
5857
|
+
/**
|
|
5858
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5859
|
+
*/
|
|
5860
|
+
'Idempotency-Key'?: string;
|
|
5861
|
+
};
|
|
5862
|
+
path: {
|
|
5863
|
+
/**
|
|
5864
|
+
* Document ID (numeric string)
|
|
5865
|
+
*/
|
|
5866
|
+
id: string;
|
|
5867
|
+
};
|
|
5868
|
+
query?: never;
|
|
5869
|
+
url: '/customer-document/{id}';
|
|
5870
|
+
};
|
|
5871
|
+
type CustomerDocumentControllerUpdateErrors = {
|
|
5872
|
+
/**
|
|
5873
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5874
|
+
*/
|
|
5875
|
+
400: ApiErrorResponse;
|
|
5876
|
+
/**
|
|
5877
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5878
|
+
*/
|
|
5879
|
+
401: ApiErrorResponse;
|
|
5880
|
+
/**
|
|
5881
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5882
|
+
*/
|
|
5883
|
+
403: ApiErrorResponse;
|
|
5884
|
+
/**
|
|
5885
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5886
|
+
*/
|
|
5887
|
+
404: ApiErrorResponse;
|
|
5888
|
+
/**
|
|
5889
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5890
|
+
*/
|
|
5891
|
+
429: ApiErrorResponse;
|
|
5892
|
+
/**
|
|
5893
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5894
|
+
*/
|
|
5895
|
+
500: ApiErrorResponse;
|
|
5896
|
+
};
|
|
5897
|
+
type CustomerDocumentControllerUpdateError = CustomerDocumentControllerUpdateErrors[keyof CustomerDocumentControllerUpdateErrors];
|
|
5898
|
+
type CustomerDocumentControllerUpdateResponses = {
|
|
5899
|
+
200: DocumentResponseDto;
|
|
5900
|
+
};
|
|
5901
|
+
type CustomerDocumentControllerUpdateResponse = CustomerDocumentControllerUpdateResponses[keyof CustomerDocumentControllerUpdateResponses];
|
|
5902
|
+
type CustomerDocumentControllerCreateData = {
|
|
5903
|
+
body: CreateDocumentDto;
|
|
5904
|
+
headers?: {
|
|
5905
|
+
/**
|
|
5906
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
5907
|
+
*/
|
|
5908
|
+
'Idempotency-Key'?: string;
|
|
5909
|
+
};
|
|
5910
|
+
path?: never;
|
|
5911
|
+
query?: never;
|
|
5912
|
+
url: '/customer-document';
|
|
5913
|
+
};
|
|
5914
|
+
type CustomerDocumentControllerCreateErrors = {
|
|
5915
|
+
/**
|
|
5916
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5917
|
+
*/
|
|
5918
|
+
400: ApiErrorResponse;
|
|
5919
|
+
/**
|
|
5920
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5921
|
+
*/
|
|
5922
|
+
401: ApiErrorResponse;
|
|
5923
|
+
/**
|
|
5924
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5925
|
+
*/
|
|
5926
|
+
403: ApiErrorResponse;
|
|
5927
|
+
/**
|
|
5928
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5929
|
+
*/
|
|
5930
|
+
404: ApiErrorResponse;
|
|
5931
|
+
/**
|
|
5932
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5933
|
+
*/
|
|
5934
|
+
409: ApiErrorResponse;
|
|
5935
|
+
/**
|
|
5936
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5937
|
+
*/
|
|
5938
|
+
429: ApiErrorResponse;
|
|
5939
|
+
/**
|
|
5940
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5941
|
+
*/
|
|
5942
|
+
500: ApiErrorResponse;
|
|
5943
|
+
};
|
|
5944
|
+
type CustomerDocumentControllerCreateError = CustomerDocumentControllerCreateErrors[keyof CustomerDocumentControllerCreateErrors];
|
|
5945
|
+
type CustomerDocumentControllerCreateResponses = {
|
|
5946
|
+
201: DocumentResponseDto;
|
|
5947
|
+
};
|
|
5948
|
+
type CustomerDocumentControllerCreateResponse = CustomerDocumentControllerCreateResponses[keyof CustomerDocumentControllerCreateResponses];
|
|
5949
|
+
type ProjectDocumentControllerListData = {
|
|
5950
|
+
body?: never;
|
|
5951
|
+
path?: never;
|
|
5952
|
+
query?: {
|
|
5953
|
+
/**
|
|
5954
|
+
* Results per page
|
|
5955
|
+
*/
|
|
5956
|
+
per_page?: number;
|
|
5957
|
+
/**
|
|
5958
|
+
* Page number
|
|
5959
|
+
*/
|
|
5960
|
+
page?: number;
|
|
5961
|
+
direction?: 'asc' | 'desc';
|
|
5962
|
+
/**
|
|
5963
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5964
|
+
*/
|
|
5965
|
+
sort?: string;
|
|
5966
|
+
/**
|
|
5967
|
+
* Filter to one parent by its publicId (UUID)
|
|
5968
|
+
*/
|
|
5969
|
+
parent_id?: string;
|
|
5970
|
+
/**
|
|
5971
|
+
* Filter by document type id (numeric string)
|
|
5972
|
+
*/
|
|
5973
|
+
document_type_id?: string;
|
|
5974
|
+
/**
|
|
5975
|
+
* Filter by name (case-insensitive partial)
|
|
5976
|
+
*/
|
|
5977
|
+
name?: string;
|
|
5978
|
+
/**
|
|
5979
|
+
* Filter: expires_on >= (ISO date)
|
|
5980
|
+
*/
|
|
5981
|
+
expires_on_from?: string;
|
|
5982
|
+
/**
|
|
5983
|
+
* Filter: expires_on <= (ISO date)
|
|
5984
|
+
*/
|
|
5985
|
+
expires_on_to?: string;
|
|
5986
|
+
/**
|
|
5987
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5988
|
+
*/
|
|
5989
|
+
document_date_updated_from?: string;
|
|
5990
|
+
/**
|
|
5991
|
+
* Filter: updated_at <= (ISO)
|
|
5992
|
+
*/
|
|
5993
|
+
document_date_updated_to?: string;
|
|
5994
|
+
};
|
|
5995
|
+
url: '/project-document/list';
|
|
3921
5996
|
};
|
|
3922
|
-
type
|
|
5997
|
+
type ProjectDocumentControllerListErrors = {
|
|
3923
5998
|
/**
|
|
3924
5999
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
3925
6000
|
*/
|
|
@@ -3941,12 +6016,12 @@ type AssetDocumentControllerListErrors = {
|
|
|
3941
6016
|
*/
|
|
3942
6017
|
500: ApiErrorResponse;
|
|
3943
6018
|
};
|
|
3944
|
-
type
|
|
3945
|
-
type
|
|
6019
|
+
type ProjectDocumentControllerListError = ProjectDocumentControllerListErrors[keyof ProjectDocumentControllerListErrors];
|
|
6020
|
+
type ProjectDocumentControllerListResponses = {
|
|
3946
6021
|
200: ListDocumentsResponseDto;
|
|
3947
6022
|
};
|
|
3948
|
-
type
|
|
3949
|
-
type
|
|
6023
|
+
type ProjectDocumentControllerListResponse = ProjectDocumentControllerListResponses[keyof ProjectDocumentControllerListResponses];
|
|
6024
|
+
type ProjectDocumentControllerRemoveData = {
|
|
3950
6025
|
body?: never;
|
|
3951
6026
|
path: {
|
|
3952
6027
|
/**
|
|
@@ -3955,9 +6030,9 @@ type AssetDocumentControllerRemoveData = {
|
|
|
3955
6030
|
id: string;
|
|
3956
6031
|
};
|
|
3957
6032
|
query?: never;
|
|
3958
|
-
url: '/
|
|
6033
|
+
url: '/project-document/{id}';
|
|
3959
6034
|
};
|
|
3960
|
-
type
|
|
6035
|
+
type ProjectDocumentControllerRemoveErrors = {
|
|
3961
6036
|
/**
|
|
3962
6037
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
3963
6038
|
*/
|
|
@@ -3983,12 +6058,12 @@ type AssetDocumentControllerRemoveErrors = {
|
|
|
3983
6058
|
*/
|
|
3984
6059
|
500: ApiErrorResponse;
|
|
3985
6060
|
};
|
|
3986
|
-
type
|
|
3987
|
-
type
|
|
6061
|
+
type ProjectDocumentControllerRemoveError = ProjectDocumentControllerRemoveErrors[keyof ProjectDocumentControllerRemoveErrors];
|
|
6062
|
+
type ProjectDocumentControllerRemoveResponses = {
|
|
3988
6063
|
200: DeleteDocumentResponseDto;
|
|
3989
6064
|
};
|
|
3990
|
-
type
|
|
3991
|
-
type
|
|
6065
|
+
type ProjectDocumentControllerRemoveResponse = ProjectDocumentControllerRemoveResponses[keyof ProjectDocumentControllerRemoveResponses];
|
|
6066
|
+
type ProjectDocumentControllerGetData = {
|
|
3992
6067
|
body?: never;
|
|
3993
6068
|
path: {
|
|
3994
6069
|
/**
|
|
@@ -3997,9 +6072,9 @@ type AssetDocumentControllerGetData = {
|
|
|
3997
6072
|
id: string;
|
|
3998
6073
|
};
|
|
3999
6074
|
query?: never;
|
|
4000
|
-
url: '/
|
|
6075
|
+
url: '/project-document/{id}';
|
|
4001
6076
|
};
|
|
4002
|
-
type
|
|
6077
|
+
type ProjectDocumentControllerGetErrors = {
|
|
4003
6078
|
/**
|
|
4004
6079
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4005
6080
|
*/
|
|
@@ -4025,12 +6100,12 @@ type AssetDocumentControllerGetErrors = {
|
|
|
4025
6100
|
*/
|
|
4026
6101
|
500: ApiErrorResponse;
|
|
4027
6102
|
};
|
|
4028
|
-
type
|
|
4029
|
-
type
|
|
6103
|
+
type ProjectDocumentControllerGetError = ProjectDocumentControllerGetErrors[keyof ProjectDocumentControllerGetErrors];
|
|
6104
|
+
type ProjectDocumentControllerGetResponses = {
|
|
4030
6105
|
200: DocumentResponseDto;
|
|
4031
6106
|
};
|
|
4032
|
-
type
|
|
4033
|
-
type
|
|
6107
|
+
type ProjectDocumentControllerGetResponse = ProjectDocumentControllerGetResponses[keyof ProjectDocumentControllerGetResponses];
|
|
6108
|
+
type ProjectDocumentControllerUpdateData = {
|
|
4034
6109
|
body: UpdateDocumentDto;
|
|
4035
6110
|
headers?: {
|
|
4036
6111
|
/**
|
|
@@ -4045,9 +6120,9 @@ type AssetDocumentControllerUpdateData = {
|
|
|
4045
6120
|
id: string;
|
|
4046
6121
|
};
|
|
4047
6122
|
query?: never;
|
|
4048
|
-
url: '/
|
|
6123
|
+
url: '/project-document/{id}';
|
|
4049
6124
|
};
|
|
4050
|
-
type
|
|
6125
|
+
type ProjectDocumentControllerUpdateErrors = {
|
|
4051
6126
|
/**
|
|
4052
6127
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4053
6128
|
*/
|
|
@@ -4073,12 +6148,12 @@ type AssetDocumentControllerUpdateErrors = {
|
|
|
4073
6148
|
*/
|
|
4074
6149
|
500: ApiErrorResponse;
|
|
4075
6150
|
};
|
|
4076
|
-
type
|
|
4077
|
-
type
|
|
6151
|
+
type ProjectDocumentControllerUpdateError = ProjectDocumentControllerUpdateErrors[keyof ProjectDocumentControllerUpdateErrors];
|
|
6152
|
+
type ProjectDocumentControllerUpdateResponses = {
|
|
4078
6153
|
200: DocumentResponseDto;
|
|
4079
6154
|
};
|
|
4080
|
-
type
|
|
4081
|
-
type
|
|
6155
|
+
type ProjectDocumentControllerUpdateResponse = ProjectDocumentControllerUpdateResponses[keyof ProjectDocumentControllerUpdateResponses];
|
|
6156
|
+
type ProjectDocumentControllerCreateData = {
|
|
4082
6157
|
body: CreateDocumentDto;
|
|
4083
6158
|
headers?: {
|
|
4084
6159
|
/**
|
|
@@ -4088,9 +6163,9 @@ type AssetDocumentControllerCreateData = {
|
|
|
4088
6163
|
};
|
|
4089
6164
|
path?: never;
|
|
4090
6165
|
query?: never;
|
|
4091
|
-
url: '/
|
|
6166
|
+
url: '/project-document';
|
|
4092
6167
|
};
|
|
4093
|
-
type
|
|
6168
|
+
type ProjectDocumentControllerCreateErrors = {
|
|
4094
6169
|
/**
|
|
4095
6170
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4096
6171
|
*/
|
|
@@ -4120,12 +6195,12 @@ type AssetDocumentControllerCreateErrors = {
|
|
|
4120
6195
|
*/
|
|
4121
6196
|
500: ApiErrorResponse;
|
|
4122
6197
|
};
|
|
4123
|
-
type
|
|
4124
|
-
type
|
|
6198
|
+
type ProjectDocumentControllerCreateError = ProjectDocumentControllerCreateErrors[keyof ProjectDocumentControllerCreateErrors];
|
|
6199
|
+
type ProjectDocumentControllerCreateResponses = {
|
|
4125
6200
|
201: DocumentResponseDto;
|
|
4126
6201
|
};
|
|
4127
|
-
type
|
|
4128
|
-
type
|
|
6202
|
+
type ProjectDocumentControllerCreateResponse = ProjectDocumentControllerCreateResponses[keyof ProjectDocumentControllerCreateResponses];
|
|
6203
|
+
type JobDocumentControllerListData = {
|
|
4129
6204
|
body?: never;
|
|
4130
6205
|
path?: never;
|
|
4131
6206
|
query?: {
|
|
@@ -4171,9 +6246,9 @@ type AssetClassDocumentControllerListData = {
|
|
|
4171
6246
|
*/
|
|
4172
6247
|
document_date_updated_to?: string;
|
|
4173
6248
|
};
|
|
4174
|
-
url: '/
|
|
6249
|
+
url: '/job-document/list';
|
|
4175
6250
|
};
|
|
4176
|
-
type
|
|
6251
|
+
type JobDocumentControllerListErrors = {
|
|
4177
6252
|
/**
|
|
4178
6253
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4179
6254
|
*/
|
|
@@ -4195,12 +6270,12 @@ type AssetClassDocumentControllerListErrors = {
|
|
|
4195
6270
|
*/
|
|
4196
6271
|
500: ApiErrorResponse;
|
|
4197
6272
|
};
|
|
4198
|
-
type
|
|
4199
|
-
type
|
|
6273
|
+
type JobDocumentControllerListError = JobDocumentControllerListErrors[keyof JobDocumentControllerListErrors];
|
|
6274
|
+
type JobDocumentControllerListResponses = {
|
|
4200
6275
|
200: ListDocumentsResponseDto;
|
|
4201
6276
|
};
|
|
4202
|
-
type
|
|
4203
|
-
type
|
|
6277
|
+
type JobDocumentControllerListResponse = JobDocumentControllerListResponses[keyof JobDocumentControllerListResponses];
|
|
6278
|
+
type JobDocumentControllerRemoveData = {
|
|
4204
6279
|
body?: never;
|
|
4205
6280
|
path: {
|
|
4206
6281
|
/**
|
|
@@ -4209,9 +6284,9 @@ type AssetClassDocumentControllerRemoveData = {
|
|
|
4209
6284
|
id: string;
|
|
4210
6285
|
};
|
|
4211
6286
|
query?: never;
|
|
4212
|
-
url: '/
|
|
6287
|
+
url: '/job-document/{id}';
|
|
4213
6288
|
};
|
|
4214
|
-
type
|
|
6289
|
+
type JobDocumentControllerRemoveErrors = {
|
|
4215
6290
|
/**
|
|
4216
6291
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4217
6292
|
*/
|
|
@@ -4237,12 +6312,12 @@ type AssetClassDocumentControllerRemoveErrors = {
|
|
|
4237
6312
|
*/
|
|
4238
6313
|
500: ApiErrorResponse;
|
|
4239
6314
|
};
|
|
4240
|
-
type
|
|
4241
|
-
type
|
|
6315
|
+
type JobDocumentControllerRemoveError = JobDocumentControllerRemoveErrors[keyof JobDocumentControllerRemoveErrors];
|
|
6316
|
+
type JobDocumentControllerRemoveResponses = {
|
|
4242
6317
|
200: DeleteDocumentResponseDto;
|
|
4243
6318
|
};
|
|
4244
|
-
type
|
|
4245
|
-
type
|
|
6319
|
+
type JobDocumentControllerRemoveResponse = JobDocumentControllerRemoveResponses[keyof JobDocumentControllerRemoveResponses];
|
|
6320
|
+
type JobDocumentControllerGetData = {
|
|
4246
6321
|
body?: never;
|
|
4247
6322
|
path: {
|
|
4248
6323
|
/**
|
|
@@ -4251,9 +6326,9 @@ type AssetClassDocumentControllerGetData = {
|
|
|
4251
6326
|
id: string;
|
|
4252
6327
|
};
|
|
4253
6328
|
query?: never;
|
|
4254
|
-
url: '/
|
|
6329
|
+
url: '/job-document/{id}';
|
|
4255
6330
|
};
|
|
4256
|
-
type
|
|
6331
|
+
type JobDocumentControllerGetErrors = {
|
|
4257
6332
|
/**
|
|
4258
6333
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4259
6334
|
*/
|
|
@@ -4279,12 +6354,12 @@ type AssetClassDocumentControllerGetErrors = {
|
|
|
4279
6354
|
*/
|
|
4280
6355
|
500: ApiErrorResponse;
|
|
4281
6356
|
};
|
|
4282
|
-
type
|
|
4283
|
-
type
|
|
6357
|
+
type JobDocumentControllerGetError = JobDocumentControllerGetErrors[keyof JobDocumentControllerGetErrors];
|
|
6358
|
+
type JobDocumentControllerGetResponses = {
|
|
4284
6359
|
200: DocumentResponseDto;
|
|
4285
6360
|
};
|
|
4286
|
-
type
|
|
4287
|
-
type
|
|
6361
|
+
type JobDocumentControllerGetResponse = JobDocumentControllerGetResponses[keyof JobDocumentControllerGetResponses];
|
|
6362
|
+
type JobDocumentControllerUpdateData = {
|
|
4288
6363
|
body: UpdateDocumentDto;
|
|
4289
6364
|
headers?: {
|
|
4290
6365
|
/**
|
|
@@ -4299,9 +6374,9 @@ type AssetClassDocumentControllerUpdateData = {
|
|
|
4299
6374
|
id: string;
|
|
4300
6375
|
};
|
|
4301
6376
|
query?: never;
|
|
4302
|
-
url: '/
|
|
6377
|
+
url: '/job-document/{id}';
|
|
4303
6378
|
};
|
|
4304
|
-
type
|
|
6379
|
+
type JobDocumentControllerUpdateErrors = {
|
|
4305
6380
|
/**
|
|
4306
6381
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4307
6382
|
*/
|
|
@@ -4327,12 +6402,12 @@ type AssetClassDocumentControllerUpdateErrors = {
|
|
|
4327
6402
|
*/
|
|
4328
6403
|
500: ApiErrorResponse;
|
|
4329
6404
|
};
|
|
4330
|
-
type
|
|
4331
|
-
type
|
|
6405
|
+
type JobDocumentControllerUpdateError = JobDocumentControllerUpdateErrors[keyof JobDocumentControllerUpdateErrors];
|
|
6406
|
+
type JobDocumentControllerUpdateResponses = {
|
|
4332
6407
|
200: DocumentResponseDto;
|
|
4333
6408
|
};
|
|
4334
|
-
type
|
|
4335
|
-
type
|
|
6409
|
+
type JobDocumentControllerUpdateResponse = JobDocumentControllerUpdateResponses[keyof JobDocumentControllerUpdateResponses];
|
|
6410
|
+
type JobDocumentControllerCreateData = {
|
|
4336
6411
|
body: CreateDocumentDto;
|
|
4337
6412
|
headers?: {
|
|
4338
6413
|
/**
|
|
@@ -4342,9 +6417,9 @@ type AssetClassDocumentControllerCreateData = {
|
|
|
4342
6417
|
};
|
|
4343
6418
|
path?: never;
|
|
4344
6419
|
query?: never;
|
|
4345
|
-
url: '/
|
|
6420
|
+
url: '/job-document';
|
|
4346
6421
|
};
|
|
4347
|
-
type
|
|
6422
|
+
type JobDocumentControllerCreateErrors = {
|
|
4348
6423
|
/**
|
|
4349
6424
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4350
6425
|
*/
|
|
@@ -4374,12 +6449,12 @@ type AssetClassDocumentControllerCreateErrors = {
|
|
|
4374
6449
|
*/
|
|
4375
6450
|
500: ApiErrorResponse;
|
|
4376
6451
|
};
|
|
4377
|
-
type
|
|
4378
|
-
type
|
|
6452
|
+
type JobDocumentControllerCreateError = JobDocumentControllerCreateErrors[keyof JobDocumentControllerCreateErrors];
|
|
6453
|
+
type JobDocumentControllerCreateResponses = {
|
|
4379
6454
|
201: DocumentResponseDto;
|
|
4380
6455
|
};
|
|
4381
|
-
type
|
|
4382
|
-
type
|
|
6456
|
+
type JobDocumentControllerCreateResponse = JobDocumentControllerCreateResponses[keyof JobDocumentControllerCreateResponses];
|
|
6457
|
+
type CompanyDocumentControllerListData = {
|
|
4383
6458
|
body?: never;
|
|
4384
6459
|
path?: never;
|
|
4385
6460
|
query?: {
|
|
@@ -4425,9 +6500,9 @@ type UserDocumentControllerListData = {
|
|
|
4425
6500
|
*/
|
|
4426
6501
|
document_date_updated_to?: string;
|
|
4427
6502
|
};
|
|
4428
|
-
url: '/
|
|
6503
|
+
url: '/company-document/list';
|
|
4429
6504
|
};
|
|
4430
|
-
type
|
|
6505
|
+
type CompanyDocumentControllerListErrors = {
|
|
4431
6506
|
/**
|
|
4432
6507
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4433
6508
|
*/
|
|
@@ -4449,12 +6524,12 @@ type UserDocumentControllerListErrors = {
|
|
|
4449
6524
|
*/
|
|
4450
6525
|
500: ApiErrorResponse;
|
|
4451
6526
|
};
|
|
4452
|
-
type
|
|
4453
|
-
type
|
|
6527
|
+
type CompanyDocumentControllerListError = CompanyDocumentControllerListErrors[keyof CompanyDocumentControllerListErrors];
|
|
6528
|
+
type CompanyDocumentControllerListResponses = {
|
|
4454
6529
|
200: ListDocumentsResponseDto;
|
|
4455
6530
|
};
|
|
4456
|
-
type
|
|
4457
|
-
type
|
|
6531
|
+
type CompanyDocumentControllerListResponse = CompanyDocumentControllerListResponses[keyof CompanyDocumentControllerListResponses];
|
|
6532
|
+
type CompanyDocumentControllerRemoveData = {
|
|
4458
6533
|
body?: never;
|
|
4459
6534
|
path: {
|
|
4460
6535
|
/**
|
|
@@ -4463,9 +6538,9 @@ type UserDocumentControllerRemoveData = {
|
|
|
4463
6538
|
id: string;
|
|
4464
6539
|
};
|
|
4465
6540
|
query?: never;
|
|
4466
|
-
url: '/
|
|
6541
|
+
url: '/company-document/{id}';
|
|
4467
6542
|
};
|
|
4468
|
-
type
|
|
6543
|
+
type CompanyDocumentControllerRemoveErrors = {
|
|
4469
6544
|
/**
|
|
4470
6545
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4471
6546
|
*/
|
|
@@ -4491,12 +6566,12 @@ type UserDocumentControllerRemoveErrors = {
|
|
|
4491
6566
|
*/
|
|
4492
6567
|
500: ApiErrorResponse;
|
|
4493
6568
|
};
|
|
4494
|
-
type
|
|
4495
|
-
type
|
|
6569
|
+
type CompanyDocumentControllerRemoveError = CompanyDocumentControllerRemoveErrors[keyof CompanyDocumentControllerRemoveErrors];
|
|
6570
|
+
type CompanyDocumentControllerRemoveResponses = {
|
|
4496
6571
|
200: DeleteDocumentResponseDto;
|
|
4497
6572
|
};
|
|
4498
|
-
type
|
|
4499
|
-
type
|
|
6573
|
+
type CompanyDocumentControllerRemoveResponse = CompanyDocumentControllerRemoveResponses[keyof CompanyDocumentControllerRemoveResponses];
|
|
6574
|
+
type CompanyDocumentControllerGetData = {
|
|
4500
6575
|
body?: never;
|
|
4501
6576
|
path: {
|
|
4502
6577
|
/**
|
|
@@ -4505,9 +6580,9 @@ type UserDocumentControllerGetData = {
|
|
|
4505
6580
|
id: string;
|
|
4506
6581
|
};
|
|
4507
6582
|
query?: never;
|
|
4508
|
-
url: '/
|
|
6583
|
+
url: '/company-document/{id}';
|
|
4509
6584
|
};
|
|
4510
|
-
type
|
|
6585
|
+
type CompanyDocumentControllerGetErrors = {
|
|
4511
6586
|
/**
|
|
4512
6587
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4513
6588
|
*/
|
|
@@ -4533,12 +6608,12 @@ type UserDocumentControllerGetErrors = {
|
|
|
4533
6608
|
*/
|
|
4534
6609
|
500: ApiErrorResponse;
|
|
4535
6610
|
};
|
|
4536
|
-
type
|
|
4537
|
-
type
|
|
6611
|
+
type CompanyDocumentControllerGetError = CompanyDocumentControllerGetErrors[keyof CompanyDocumentControllerGetErrors];
|
|
6612
|
+
type CompanyDocumentControllerGetResponses = {
|
|
4538
6613
|
200: DocumentResponseDto;
|
|
4539
6614
|
};
|
|
4540
|
-
type
|
|
4541
|
-
type
|
|
6615
|
+
type CompanyDocumentControllerGetResponse = CompanyDocumentControllerGetResponses[keyof CompanyDocumentControllerGetResponses];
|
|
6616
|
+
type CompanyDocumentControllerUpdateData = {
|
|
4542
6617
|
body: UpdateDocumentDto;
|
|
4543
6618
|
headers?: {
|
|
4544
6619
|
/**
|
|
@@ -4553,9 +6628,9 @@ type UserDocumentControllerUpdateData = {
|
|
|
4553
6628
|
id: string;
|
|
4554
6629
|
};
|
|
4555
6630
|
query?: never;
|
|
4556
|
-
url: '/
|
|
6631
|
+
url: '/company-document/{id}';
|
|
4557
6632
|
};
|
|
4558
|
-
type
|
|
6633
|
+
type CompanyDocumentControllerUpdateErrors = {
|
|
4559
6634
|
/**
|
|
4560
6635
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4561
6636
|
*/
|
|
@@ -4581,12 +6656,12 @@ type UserDocumentControllerUpdateErrors = {
|
|
|
4581
6656
|
*/
|
|
4582
6657
|
500: ApiErrorResponse;
|
|
4583
6658
|
};
|
|
4584
|
-
type
|
|
4585
|
-
type
|
|
6659
|
+
type CompanyDocumentControllerUpdateError = CompanyDocumentControllerUpdateErrors[keyof CompanyDocumentControllerUpdateErrors];
|
|
6660
|
+
type CompanyDocumentControllerUpdateResponses = {
|
|
4586
6661
|
200: DocumentResponseDto;
|
|
4587
6662
|
};
|
|
4588
|
-
type
|
|
4589
|
-
type
|
|
6663
|
+
type CompanyDocumentControllerUpdateResponse = CompanyDocumentControllerUpdateResponses[keyof CompanyDocumentControllerUpdateResponses];
|
|
6664
|
+
type CompanyDocumentControllerCreateData = {
|
|
4590
6665
|
body: CreateDocumentDto;
|
|
4591
6666
|
headers?: {
|
|
4592
6667
|
/**
|
|
@@ -4596,9 +6671,9 @@ type UserDocumentControllerCreateData = {
|
|
|
4596
6671
|
};
|
|
4597
6672
|
path?: never;
|
|
4598
6673
|
query?: never;
|
|
4599
|
-
url: '/
|
|
6674
|
+
url: '/company-document';
|
|
4600
6675
|
};
|
|
4601
|
-
type
|
|
6676
|
+
type CompanyDocumentControllerCreateErrors = {
|
|
4602
6677
|
/**
|
|
4603
6678
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4604
6679
|
*/
|
|
@@ -4628,12 +6703,12 @@ type UserDocumentControllerCreateErrors = {
|
|
|
4628
6703
|
*/
|
|
4629
6704
|
500: ApiErrorResponse;
|
|
4630
6705
|
};
|
|
4631
|
-
type
|
|
4632
|
-
type
|
|
6706
|
+
type CompanyDocumentControllerCreateError = CompanyDocumentControllerCreateErrors[keyof CompanyDocumentControllerCreateErrors];
|
|
6707
|
+
type CompanyDocumentControllerCreateResponses = {
|
|
4633
6708
|
201: DocumentResponseDto;
|
|
4634
6709
|
};
|
|
4635
|
-
type
|
|
4636
|
-
type
|
|
6710
|
+
type CompanyDocumentControllerCreateResponse = CompanyDocumentControllerCreateResponses[keyof CompanyDocumentControllerCreateResponses];
|
|
6711
|
+
type ProjectControllerListData = {
|
|
4637
6712
|
body?: never;
|
|
4638
6713
|
path?: never;
|
|
4639
6714
|
query?: {
|
|
@@ -4647,45 +6722,113 @@ type SiteDocumentControllerListData = {
|
|
|
4647
6722
|
page?: number;
|
|
4648
6723
|
direction?: 'asc' | 'desc';
|
|
4649
6724
|
/**
|
|
4650
|
-
* Sort field: name,
|
|
6725
|
+
* Sort field: name, project_code, status, started_at, created_at, updated_at, id (default updated_at)
|
|
4651
6726
|
*/
|
|
4652
6727
|
sort?: string;
|
|
4653
|
-
/**
|
|
4654
|
-
* Filter to one parent by its publicId (UUID)
|
|
4655
|
-
*/
|
|
4656
|
-
parent_id?: string;
|
|
4657
|
-
/**
|
|
4658
|
-
* Filter by document type id (numeric string)
|
|
4659
|
-
*/
|
|
4660
|
-
document_type_id?: string;
|
|
4661
6728
|
/**
|
|
4662
6729
|
* Filter by name (case-insensitive partial)
|
|
4663
6730
|
*/
|
|
4664
6731
|
name?: string;
|
|
4665
6732
|
/**
|
|
4666
|
-
* Filter
|
|
6733
|
+
* Filter by project code (case-insensitive partial)
|
|
4667
6734
|
*/
|
|
4668
|
-
|
|
6735
|
+
project_code?: string;
|
|
4669
6736
|
/**
|
|
4670
|
-
* Filter
|
|
6737
|
+
* Filter by status
|
|
4671
6738
|
*/
|
|
4672
|
-
|
|
6739
|
+
status?: 'active' | 'suspended' | 'completed';
|
|
6740
|
+
/**
|
|
6741
|
+
* Filter to one site by its publicId (UUID)
|
|
6742
|
+
*/
|
|
6743
|
+
site_id?: string;
|
|
4673
6744
|
/**
|
|
4674
6745
|
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4675
6746
|
*/
|
|
4676
|
-
|
|
6747
|
+
project_date_updated_from?: string;
|
|
4677
6748
|
/**
|
|
4678
6749
|
* Filter: updated_at <= (ISO)
|
|
4679
6750
|
*/
|
|
4680
|
-
|
|
6751
|
+
project_date_updated_to?: string;
|
|
6752
|
+
};
|
|
6753
|
+
url: '/project/list';
|
|
6754
|
+
};
|
|
6755
|
+
type ProjectControllerListErrors = {
|
|
6756
|
+
/**
|
|
6757
|
+
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
6758
|
+
*/
|
|
6759
|
+
400: ApiErrorResponse;
|
|
6760
|
+
/**
|
|
6761
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
6762
|
+
*/
|
|
6763
|
+
401: ApiErrorResponse;
|
|
6764
|
+
/**
|
|
6765
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
6766
|
+
*/
|
|
6767
|
+
403: ApiErrorResponse;
|
|
6768
|
+
/**
|
|
6769
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
6770
|
+
*/
|
|
6771
|
+
429: ApiErrorResponse;
|
|
6772
|
+
/**
|
|
6773
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
6774
|
+
*/
|
|
6775
|
+
500: ApiErrorResponse;
|
|
6776
|
+
};
|
|
6777
|
+
type ProjectControllerListError = ProjectControllerListErrors[keyof ProjectControllerListErrors];
|
|
6778
|
+
type ProjectControllerListResponses = {
|
|
6779
|
+
200: ListProjectsResponseDto;
|
|
6780
|
+
};
|
|
6781
|
+
type ProjectControllerListResponse = ProjectControllerListResponses[keyof ProjectControllerListResponses];
|
|
6782
|
+
type ProjectControllerDeleteData = {
|
|
6783
|
+
body?: never;
|
|
6784
|
+
path: {
|
|
6785
|
+
/**
|
|
6786
|
+
* Project public ID
|
|
6787
|
+
*/
|
|
6788
|
+
id: string;
|
|
6789
|
+
};
|
|
6790
|
+
query?: never;
|
|
6791
|
+
url: '/project/{id}';
|
|
6792
|
+
};
|
|
6793
|
+
type ProjectControllerDeleteErrors = {
|
|
6794
|
+
/**
|
|
6795
|
+
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
6796
|
+
*/
|
|
6797
|
+
401: ApiErrorResponse;
|
|
6798
|
+
/**
|
|
6799
|
+
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
6800
|
+
*/
|
|
6801
|
+
403: ApiErrorResponse;
|
|
6802
|
+
/**
|
|
6803
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
6804
|
+
*/
|
|
6805
|
+
404: ApiErrorResponse;
|
|
6806
|
+
/**
|
|
6807
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
6808
|
+
*/
|
|
6809
|
+
429: ApiErrorResponse;
|
|
6810
|
+
/**
|
|
6811
|
+
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
6812
|
+
*/
|
|
6813
|
+
500: ApiErrorResponse;
|
|
6814
|
+
};
|
|
6815
|
+
type ProjectControllerDeleteError = ProjectControllerDeleteErrors[keyof ProjectControllerDeleteErrors];
|
|
6816
|
+
type ProjectControllerDeleteResponses = {
|
|
6817
|
+
200: DeleteProjectResponseDto;
|
|
6818
|
+
};
|
|
6819
|
+
type ProjectControllerDeleteResponse = ProjectControllerDeleteResponses[keyof ProjectControllerDeleteResponses];
|
|
6820
|
+
type ProjectControllerGetData = {
|
|
6821
|
+
body?: never;
|
|
6822
|
+
path: {
|
|
6823
|
+
/**
|
|
6824
|
+
* Project public ID
|
|
6825
|
+
*/
|
|
6826
|
+
id: string;
|
|
4681
6827
|
};
|
|
4682
|
-
|
|
6828
|
+
query?: never;
|
|
6829
|
+
url: '/project/{id}';
|
|
4683
6830
|
};
|
|
4684
|
-
type
|
|
4685
|
-
/**
|
|
4686
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4687
|
-
*/
|
|
4688
|
-
400: ApiErrorResponse;
|
|
6831
|
+
type ProjectControllerGetErrors = {
|
|
4689
6832
|
/**
|
|
4690
6833
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4691
6834
|
*/
|
|
@@ -4694,6 +6837,10 @@ type SiteDocumentControllerListErrors = {
|
|
|
4694
6837
|
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
4695
6838
|
*/
|
|
4696
6839
|
403: ApiErrorResponse;
|
|
6840
|
+
/**
|
|
6841
|
+
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
6842
|
+
*/
|
|
6843
|
+
404: ApiErrorResponse;
|
|
4697
6844
|
/**
|
|
4698
6845
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4699
6846
|
*/
|
|
@@ -4703,23 +6850,29 @@ type SiteDocumentControllerListErrors = {
|
|
|
4703
6850
|
*/
|
|
4704
6851
|
500: ApiErrorResponse;
|
|
4705
6852
|
};
|
|
4706
|
-
type
|
|
4707
|
-
type
|
|
4708
|
-
200:
|
|
6853
|
+
type ProjectControllerGetError = ProjectControllerGetErrors[keyof ProjectControllerGetErrors];
|
|
6854
|
+
type ProjectControllerGetResponses = {
|
|
6855
|
+
200: ProjectResponseDto;
|
|
4709
6856
|
};
|
|
4710
|
-
type
|
|
4711
|
-
type
|
|
4712
|
-
body
|
|
6857
|
+
type ProjectControllerGetResponse = ProjectControllerGetResponses[keyof ProjectControllerGetResponses];
|
|
6858
|
+
type ProjectControllerUpdateData = {
|
|
6859
|
+
body: UpdateProjectDto;
|
|
6860
|
+
headers?: {
|
|
6861
|
+
/**
|
|
6862
|
+
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
6863
|
+
*/
|
|
6864
|
+
'Idempotency-Key'?: string;
|
|
6865
|
+
};
|
|
4713
6866
|
path: {
|
|
4714
6867
|
/**
|
|
4715
|
-
*
|
|
6868
|
+
* Project public ID
|
|
4716
6869
|
*/
|
|
4717
6870
|
id: string;
|
|
4718
6871
|
};
|
|
4719
6872
|
query?: never;
|
|
4720
|
-
url: '/
|
|
6873
|
+
url: '/project/{id}';
|
|
4721
6874
|
};
|
|
4722
|
-
type
|
|
6875
|
+
type ProjectControllerUpdateErrors = {
|
|
4723
6876
|
/**
|
|
4724
6877
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4725
6878
|
*/
|
|
@@ -4736,6 +6889,10 @@ type SiteDocumentControllerRemoveErrors = {
|
|
|
4736
6889
|
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
4737
6890
|
*/
|
|
4738
6891
|
404: ApiErrorResponse;
|
|
6892
|
+
/**
|
|
6893
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
6894
|
+
*/
|
|
6895
|
+
409: ApiErrorResponse;
|
|
4739
6896
|
/**
|
|
4740
6897
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4741
6898
|
*/
|
|
@@ -4745,23 +6902,41 @@ type SiteDocumentControllerRemoveErrors = {
|
|
|
4745
6902
|
*/
|
|
4746
6903
|
500: ApiErrorResponse;
|
|
4747
6904
|
};
|
|
4748
|
-
type
|
|
4749
|
-
type
|
|
4750
|
-
200:
|
|
6905
|
+
type ProjectControllerUpdateError = ProjectControllerUpdateErrors[keyof ProjectControllerUpdateErrors];
|
|
6906
|
+
type ProjectControllerUpdateResponses = {
|
|
6907
|
+
200: ProjectResponseDto;
|
|
4751
6908
|
};
|
|
4752
|
-
type
|
|
4753
|
-
type
|
|
6909
|
+
type ProjectControllerUpdateResponse = ProjectControllerUpdateResponses[keyof ProjectControllerUpdateResponses];
|
|
6910
|
+
type ProjectControllerListAssetsData = {
|
|
4754
6911
|
body?: never;
|
|
4755
6912
|
path: {
|
|
4756
6913
|
/**
|
|
4757
|
-
*
|
|
6914
|
+
* Project public ID
|
|
4758
6915
|
*/
|
|
4759
6916
|
id: string;
|
|
4760
6917
|
};
|
|
4761
|
-
query?:
|
|
4762
|
-
|
|
6918
|
+
query?: {
|
|
6919
|
+
/**
|
|
6920
|
+
* Results per page
|
|
6921
|
+
*/
|
|
6922
|
+
per_page?: number;
|
|
6923
|
+
/**
|
|
6924
|
+
* Page number
|
|
6925
|
+
*/
|
|
6926
|
+
page?: number;
|
|
6927
|
+
direction?: 'asc' | 'desc';
|
|
6928
|
+
/**
|
|
6929
|
+
* Sort field: approval_date, expiry_date, approval_status, created_at, updated_at, id (default updated_at)
|
|
6930
|
+
*/
|
|
6931
|
+
sort?: string;
|
|
6932
|
+
/**
|
|
6933
|
+
* Filter by approval status (e.g. approved)
|
|
6934
|
+
*/
|
|
6935
|
+
approval_status?: 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'returned';
|
|
6936
|
+
};
|
|
6937
|
+
url: '/project/{id}/assets';
|
|
4763
6938
|
};
|
|
4764
|
-
type
|
|
6939
|
+
type ProjectControllerListAssetsErrors = {
|
|
4765
6940
|
/**
|
|
4766
6941
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4767
6942
|
*/
|
|
@@ -4787,29 +6962,41 @@ type SiteDocumentControllerGetErrors = {
|
|
|
4787
6962
|
*/
|
|
4788
6963
|
500: ApiErrorResponse;
|
|
4789
6964
|
};
|
|
4790
|
-
type
|
|
4791
|
-
type
|
|
4792
|
-
200:
|
|
6965
|
+
type ProjectControllerListAssetsError = ProjectControllerListAssetsErrors[keyof ProjectControllerListAssetsErrors];
|
|
6966
|
+
type ProjectControllerListAssetsResponses = {
|
|
6967
|
+
200: ListProjectAssetsResponseDto;
|
|
4793
6968
|
};
|
|
4794
|
-
type
|
|
4795
|
-
type
|
|
4796
|
-
body
|
|
4797
|
-
|
|
6969
|
+
type ProjectControllerListAssetsResponse = ProjectControllerListAssetsResponses[keyof ProjectControllerListAssetsResponses];
|
|
6970
|
+
type ProjectControllerListUsersData = {
|
|
6971
|
+
body?: never;
|
|
6972
|
+
path: {
|
|
4798
6973
|
/**
|
|
4799
|
-
*
|
|
6974
|
+
* Project public ID
|
|
4800
6975
|
*/
|
|
4801
|
-
|
|
6976
|
+
id: string;
|
|
4802
6977
|
};
|
|
4803
|
-
|
|
6978
|
+
query?: {
|
|
4804
6979
|
/**
|
|
4805
|
-
*
|
|
6980
|
+
* Results per page
|
|
4806
6981
|
*/
|
|
4807
|
-
|
|
6982
|
+
per_page?: number;
|
|
6983
|
+
/**
|
|
6984
|
+
* Page number
|
|
6985
|
+
*/
|
|
6986
|
+
page?: number;
|
|
6987
|
+
direction?: 'asc' | 'desc';
|
|
6988
|
+
/**
|
|
6989
|
+
* Sort field: approval_date, expiry_date, approval_status, created_at, updated_at, id (default updated_at)
|
|
6990
|
+
*/
|
|
6991
|
+
sort?: string;
|
|
6992
|
+
/**
|
|
6993
|
+
* Filter by approval status (e.g. approved)
|
|
6994
|
+
*/
|
|
6995
|
+
approval_status?: 'pending' | 'in_review' | 'approved' | 'rejected' | 'expired' | 'returned';
|
|
4808
6996
|
};
|
|
4809
|
-
|
|
4810
|
-
url: '/site-document/{id}';
|
|
6997
|
+
url: '/project/{id}/users';
|
|
4811
6998
|
};
|
|
4812
|
-
type
|
|
6999
|
+
type ProjectControllerListUsersErrors = {
|
|
4813
7000
|
/**
|
|
4814
7001
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4815
7002
|
*/
|
|
@@ -4835,13 +7022,13 @@ type SiteDocumentControllerUpdateErrors = {
|
|
|
4835
7022
|
*/
|
|
4836
7023
|
500: ApiErrorResponse;
|
|
4837
7024
|
};
|
|
4838
|
-
type
|
|
4839
|
-
type
|
|
4840
|
-
200:
|
|
7025
|
+
type ProjectControllerListUsersError = ProjectControllerListUsersErrors[keyof ProjectControllerListUsersErrors];
|
|
7026
|
+
type ProjectControllerListUsersResponses = {
|
|
7027
|
+
200: ListProjectUsersResponseDto;
|
|
4841
7028
|
};
|
|
4842
|
-
type
|
|
4843
|
-
type
|
|
4844
|
-
body:
|
|
7029
|
+
type ProjectControllerListUsersResponse = ProjectControllerListUsersResponses[keyof ProjectControllerListUsersResponses];
|
|
7030
|
+
type ProjectControllerCreateData = {
|
|
7031
|
+
body: CreateProjectDto;
|
|
4845
7032
|
headers?: {
|
|
4846
7033
|
/**
|
|
4847
7034
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -4850,9 +7037,9 @@ type SiteDocumentControllerCreateData = {
|
|
|
4850
7037
|
};
|
|
4851
7038
|
path?: never;
|
|
4852
7039
|
query?: never;
|
|
4853
|
-
url: '/
|
|
7040
|
+
url: '/project';
|
|
4854
7041
|
};
|
|
4855
|
-
type
|
|
7042
|
+
type ProjectControllerCreateErrors = {
|
|
4856
7043
|
/**
|
|
4857
7044
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4858
7045
|
*/
|
|
@@ -4882,12 +7069,12 @@ type SiteDocumentControllerCreateErrors = {
|
|
|
4882
7069
|
*/
|
|
4883
7070
|
500: ApiErrorResponse;
|
|
4884
7071
|
};
|
|
4885
|
-
type
|
|
4886
|
-
type
|
|
4887
|
-
201:
|
|
7072
|
+
type ProjectControllerCreateError = ProjectControllerCreateErrors[keyof ProjectControllerCreateErrors];
|
|
7073
|
+
type ProjectControllerCreateResponses = {
|
|
7074
|
+
201: ProjectResponseDto;
|
|
4888
7075
|
};
|
|
4889
|
-
type
|
|
4890
|
-
type
|
|
7076
|
+
type ProjectControllerCreateResponse = ProjectControllerCreateResponses[keyof ProjectControllerCreateResponses];
|
|
7077
|
+
type CustomerControllerListData = {
|
|
4891
7078
|
body?: never;
|
|
4892
7079
|
path?: never;
|
|
4893
7080
|
query?: {
|
|
@@ -4901,41 +7088,29 @@ type CustomerDocumentControllerListData = {
|
|
|
4901
7088
|
page?: number;
|
|
4902
7089
|
direction?: 'asc' | 'desc';
|
|
4903
7090
|
/**
|
|
4904
|
-
* Sort field: name,
|
|
7091
|
+
* Sort field: name, status, created_at, updated_at, id (default updated_at)
|
|
4905
7092
|
*/
|
|
4906
7093
|
sort?: string;
|
|
4907
|
-
/**
|
|
4908
|
-
* Filter to one parent by its publicId (UUID)
|
|
4909
|
-
*/
|
|
4910
|
-
parent_id?: string;
|
|
4911
|
-
/**
|
|
4912
|
-
* Filter by document type id (numeric string)
|
|
4913
|
-
*/
|
|
4914
|
-
document_type_id?: string;
|
|
4915
7094
|
/**
|
|
4916
7095
|
* Filter by name (case-insensitive partial)
|
|
4917
7096
|
*/
|
|
4918
7097
|
name?: string;
|
|
4919
7098
|
/**
|
|
4920
|
-
* Filter
|
|
4921
|
-
*/
|
|
4922
|
-
expires_on_from?: string;
|
|
4923
|
-
/**
|
|
4924
|
-
* Filter: expires_on <= (ISO date)
|
|
7099
|
+
* Filter by status (e.g. active, inactive)
|
|
4925
7100
|
*/
|
|
4926
|
-
|
|
7101
|
+
status?: string;
|
|
4927
7102
|
/**
|
|
4928
7103
|
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4929
7104
|
*/
|
|
4930
|
-
|
|
7105
|
+
customer_date_updated_from?: string;
|
|
4931
7106
|
/**
|
|
4932
7107
|
* Filter: updated_at <= (ISO)
|
|
4933
7108
|
*/
|
|
4934
|
-
|
|
7109
|
+
customer_date_updated_to?: string;
|
|
4935
7110
|
};
|
|
4936
|
-
url: '/customer
|
|
7111
|
+
url: '/customer/list';
|
|
4937
7112
|
};
|
|
4938
|
-
type
|
|
7113
|
+
type CustomerControllerListErrors = {
|
|
4939
7114
|
/**
|
|
4940
7115
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4941
7116
|
*/
|
|
@@ -4957,27 +7132,23 @@ type CustomerDocumentControllerListErrors = {
|
|
|
4957
7132
|
*/
|
|
4958
7133
|
500: ApiErrorResponse;
|
|
4959
7134
|
};
|
|
4960
|
-
type
|
|
4961
|
-
type
|
|
4962
|
-
200:
|
|
7135
|
+
type CustomerControllerListError = CustomerControllerListErrors[keyof CustomerControllerListErrors];
|
|
7136
|
+
type CustomerControllerListResponses = {
|
|
7137
|
+
200: ListCustomersResponseDto;
|
|
4963
7138
|
};
|
|
4964
|
-
type
|
|
4965
|
-
type
|
|
7139
|
+
type CustomerControllerListResponse = CustomerControllerListResponses[keyof CustomerControllerListResponses];
|
|
7140
|
+
type CustomerControllerDeleteData = {
|
|
4966
7141
|
body?: never;
|
|
4967
7142
|
path: {
|
|
4968
7143
|
/**
|
|
4969
|
-
*
|
|
7144
|
+
* Customer public ID
|
|
4970
7145
|
*/
|
|
4971
7146
|
id: string;
|
|
4972
7147
|
};
|
|
4973
7148
|
query?: never;
|
|
4974
|
-
url: '/customer
|
|
7149
|
+
url: '/customer/{id}';
|
|
4975
7150
|
};
|
|
4976
|
-
type
|
|
4977
|
-
/**
|
|
4978
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
4979
|
-
*/
|
|
4980
|
-
400: ApiErrorResponse;
|
|
7151
|
+
type CustomerControllerDeleteErrors = {
|
|
4981
7152
|
/**
|
|
4982
7153
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
4983
7154
|
*/
|
|
@@ -4999,27 +7170,23 @@ type CustomerDocumentControllerRemoveErrors = {
|
|
|
4999
7170
|
*/
|
|
5000
7171
|
500: ApiErrorResponse;
|
|
5001
7172
|
};
|
|
5002
|
-
type
|
|
5003
|
-
type
|
|
5004
|
-
200:
|
|
7173
|
+
type CustomerControllerDeleteError = CustomerControllerDeleteErrors[keyof CustomerControllerDeleteErrors];
|
|
7174
|
+
type CustomerControllerDeleteResponses = {
|
|
7175
|
+
200: DeleteCustomerResponseDto;
|
|
5005
7176
|
};
|
|
5006
|
-
type
|
|
5007
|
-
type
|
|
7177
|
+
type CustomerControllerDeleteResponse = CustomerControllerDeleteResponses[keyof CustomerControllerDeleteResponses];
|
|
7178
|
+
type CustomerControllerGetData = {
|
|
5008
7179
|
body?: never;
|
|
5009
7180
|
path: {
|
|
5010
7181
|
/**
|
|
5011
|
-
*
|
|
7182
|
+
* Customer public ID
|
|
5012
7183
|
*/
|
|
5013
7184
|
id: string;
|
|
5014
7185
|
};
|
|
5015
7186
|
query?: never;
|
|
5016
|
-
url: '/customer
|
|
7187
|
+
url: '/customer/{id}';
|
|
5017
7188
|
};
|
|
5018
|
-
type
|
|
5019
|
-
/**
|
|
5020
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5021
|
-
*/
|
|
5022
|
-
400: ApiErrorResponse;
|
|
7189
|
+
type CustomerControllerGetErrors = {
|
|
5023
7190
|
/**
|
|
5024
7191
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5025
7192
|
*/
|
|
@@ -5041,13 +7208,13 @@ type CustomerDocumentControllerGetErrors = {
|
|
|
5041
7208
|
*/
|
|
5042
7209
|
500: ApiErrorResponse;
|
|
5043
7210
|
};
|
|
5044
|
-
type
|
|
5045
|
-
type
|
|
5046
|
-
200:
|
|
7211
|
+
type CustomerControllerGetError = CustomerControllerGetErrors[keyof CustomerControllerGetErrors];
|
|
7212
|
+
type CustomerControllerGetResponses = {
|
|
7213
|
+
200: CustomerResponseDto;
|
|
5047
7214
|
};
|
|
5048
|
-
type
|
|
5049
|
-
type
|
|
5050
|
-
body:
|
|
7215
|
+
type CustomerControllerGetResponse = CustomerControllerGetResponses[keyof CustomerControllerGetResponses];
|
|
7216
|
+
type CustomerControllerUpdateData = {
|
|
7217
|
+
body: UpdateCustomerDto;
|
|
5051
7218
|
headers?: {
|
|
5052
7219
|
/**
|
|
5053
7220
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5056,14 +7223,14 @@ type CustomerDocumentControllerUpdateData = {
|
|
|
5056
7223
|
};
|
|
5057
7224
|
path: {
|
|
5058
7225
|
/**
|
|
5059
|
-
*
|
|
7226
|
+
* Customer public ID
|
|
5060
7227
|
*/
|
|
5061
7228
|
id: string;
|
|
5062
7229
|
};
|
|
5063
7230
|
query?: never;
|
|
5064
|
-
url: '/customer
|
|
7231
|
+
url: '/customer/{id}';
|
|
5065
7232
|
};
|
|
5066
|
-
type
|
|
7233
|
+
type CustomerControllerUpdateErrors = {
|
|
5067
7234
|
/**
|
|
5068
7235
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5069
7236
|
*/
|
|
@@ -5080,6 +7247,10 @@ type CustomerDocumentControllerUpdateErrors = {
|
|
|
5080
7247
|
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5081
7248
|
*/
|
|
5082
7249
|
404: ApiErrorResponse;
|
|
7250
|
+
/**
|
|
7251
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
7252
|
+
*/
|
|
7253
|
+
409: ApiErrorResponse;
|
|
5083
7254
|
/**
|
|
5084
7255
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5085
7256
|
*/
|
|
@@ -5089,13 +7260,13 @@ type CustomerDocumentControllerUpdateErrors = {
|
|
|
5089
7260
|
*/
|
|
5090
7261
|
500: ApiErrorResponse;
|
|
5091
7262
|
};
|
|
5092
|
-
type
|
|
5093
|
-
type
|
|
5094
|
-
200:
|
|
7263
|
+
type CustomerControllerUpdateError = CustomerControllerUpdateErrors[keyof CustomerControllerUpdateErrors];
|
|
7264
|
+
type CustomerControllerUpdateResponses = {
|
|
7265
|
+
200: CustomerResponseDto;
|
|
5095
7266
|
};
|
|
5096
|
-
type
|
|
5097
|
-
type
|
|
5098
|
-
body:
|
|
7267
|
+
type CustomerControllerUpdateResponse = CustomerControllerUpdateResponses[keyof CustomerControllerUpdateResponses];
|
|
7268
|
+
type CustomerControllerCreateData = {
|
|
7269
|
+
body: CreateCustomerDto;
|
|
5099
7270
|
headers?: {
|
|
5100
7271
|
/**
|
|
5101
7272
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5104,9 +7275,9 @@ type CustomerDocumentControllerCreateData = {
|
|
|
5104
7275
|
};
|
|
5105
7276
|
path?: never;
|
|
5106
7277
|
query?: never;
|
|
5107
|
-
url: '/customer
|
|
7278
|
+
url: '/customer';
|
|
5108
7279
|
};
|
|
5109
|
-
type
|
|
7280
|
+
type CustomerControllerCreateErrors = {
|
|
5110
7281
|
/**
|
|
5111
7282
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5112
7283
|
*/
|
|
@@ -5119,10 +7290,6 @@ type CustomerDocumentControllerCreateErrors = {
|
|
|
5119
7290
|
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5120
7291
|
*/
|
|
5121
7292
|
403: ApiErrorResponse;
|
|
5122
|
-
/**
|
|
5123
|
-
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5124
|
-
*/
|
|
5125
|
-
404: ApiErrorResponse;
|
|
5126
7293
|
/**
|
|
5127
7294
|
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5128
7295
|
*/
|
|
@@ -5136,12 +7303,12 @@ type CustomerDocumentControllerCreateErrors = {
|
|
|
5136
7303
|
*/
|
|
5137
7304
|
500: ApiErrorResponse;
|
|
5138
7305
|
};
|
|
5139
|
-
type
|
|
5140
|
-
type
|
|
5141
|
-
201:
|
|
7306
|
+
type CustomerControllerCreateError = CustomerControllerCreateErrors[keyof CustomerControllerCreateErrors];
|
|
7307
|
+
type CustomerControllerCreateResponses = {
|
|
7308
|
+
201: CustomerResponseDto;
|
|
5142
7309
|
};
|
|
5143
|
-
type
|
|
5144
|
-
type
|
|
7310
|
+
type CustomerControllerCreateResponse = CustomerControllerCreateResponses[keyof CustomerControllerCreateResponses];
|
|
7311
|
+
type ZoneControllerListData = {
|
|
5145
7312
|
body?: never;
|
|
5146
7313
|
path?: never;
|
|
5147
7314
|
query?: {
|
|
@@ -5155,41 +7322,29 @@ type ProjectDocumentControllerListData = {
|
|
|
5155
7322
|
page?: number;
|
|
5156
7323
|
direction?: 'asc' | 'desc';
|
|
5157
7324
|
/**
|
|
5158
|
-
* Sort field: name,
|
|
7325
|
+
* Sort field: name, created_at, updated_at, id (default updated_at)
|
|
5159
7326
|
*/
|
|
5160
7327
|
sort?: string;
|
|
5161
7328
|
/**
|
|
5162
|
-
* Filter to one
|
|
5163
|
-
*/
|
|
5164
|
-
parent_id?: string;
|
|
5165
|
-
/**
|
|
5166
|
-
* Filter by document type id (numeric string)
|
|
7329
|
+
* Filter to one site by its publicId (UUID)
|
|
5167
7330
|
*/
|
|
5168
|
-
|
|
7331
|
+
site_id?: string;
|
|
5169
7332
|
/**
|
|
5170
7333
|
* Filter by name (case-insensitive partial)
|
|
5171
7334
|
*/
|
|
5172
7335
|
name?: string;
|
|
5173
|
-
/**
|
|
5174
|
-
* Filter: expires_on >= (ISO date)
|
|
5175
|
-
*/
|
|
5176
|
-
expires_on_from?: string;
|
|
5177
|
-
/**
|
|
5178
|
-
* Filter: expires_on <= (ISO date)
|
|
5179
|
-
*/
|
|
5180
|
-
expires_on_to?: string;
|
|
5181
7336
|
/**
|
|
5182
7337
|
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5183
7338
|
*/
|
|
5184
|
-
|
|
7339
|
+
zone_date_updated_from?: string;
|
|
5185
7340
|
/**
|
|
5186
7341
|
* Filter: updated_at <= (ISO)
|
|
5187
7342
|
*/
|
|
5188
|
-
|
|
7343
|
+
zone_date_updated_to?: string;
|
|
5189
7344
|
};
|
|
5190
|
-
url: '/
|
|
7345
|
+
url: '/zone/list';
|
|
5191
7346
|
};
|
|
5192
|
-
type
|
|
7347
|
+
type ZoneControllerListErrors = {
|
|
5193
7348
|
/**
|
|
5194
7349
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5195
7350
|
*/
|
|
@@ -5211,27 +7366,23 @@ type ProjectDocumentControllerListErrors = {
|
|
|
5211
7366
|
*/
|
|
5212
7367
|
500: ApiErrorResponse;
|
|
5213
7368
|
};
|
|
5214
|
-
type
|
|
5215
|
-
type
|
|
5216
|
-
200:
|
|
7369
|
+
type ZoneControllerListError = ZoneControllerListErrors[keyof ZoneControllerListErrors];
|
|
7370
|
+
type ZoneControllerListResponses = {
|
|
7371
|
+
200: ListZonesResponseDto;
|
|
5217
7372
|
};
|
|
5218
|
-
type
|
|
5219
|
-
type
|
|
7373
|
+
type ZoneControllerListResponse = ZoneControllerListResponses[keyof ZoneControllerListResponses];
|
|
7374
|
+
type ZoneControllerDeleteData = {
|
|
5220
7375
|
body?: never;
|
|
5221
7376
|
path: {
|
|
5222
7377
|
/**
|
|
5223
|
-
*
|
|
7378
|
+
* Zone public ID
|
|
5224
7379
|
*/
|
|
5225
7380
|
id: string;
|
|
5226
7381
|
};
|
|
5227
7382
|
query?: never;
|
|
5228
|
-
url: '/
|
|
7383
|
+
url: '/zone/{id}';
|
|
5229
7384
|
};
|
|
5230
|
-
type
|
|
5231
|
-
/**
|
|
5232
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5233
|
-
*/
|
|
5234
|
-
400: ApiErrorResponse;
|
|
7385
|
+
type ZoneControllerDeleteErrors = {
|
|
5235
7386
|
/**
|
|
5236
7387
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5237
7388
|
*/
|
|
@@ -5253,27 +7404,23 @@ type ProjectDocumentControllerRemoveErrors = {
|
|
|
5253
7404
|
*/
|
|
5254
7405
|
500: ApiErrorResponse;
|
|
5255
7406
|
};
|
|
5256
|
-
type
|
|
5257
|
-
type
|
|
5258
|
-
200:
|
|
7407
|
+
type ZoneControllerDeleteError = ZoneControllerDeleteErrors[keyof ZoneControllerDeleteErrors];
|
|
7408
|
+
type ZoneControllerDeleteResponses = {
|
|
7409
|
+
200: DeleteZoneResponseDto;
|
|
5259
7410
|
};
|
|
5260
|
-
type
|
|
5261
|
-
type
|
|
7411
|
+
type ZoneControllerDeleteResponse = ZoneControllerDeleteResponses[keyof ZoneControllerDeleteResponses];
|
|
7412
|
+
type ZoneControllerGetData = {
|
|
5262
7413
|
body?: never;
|
|
5263
7414
|
path: {
|
|
5264
7415
|
/**
|
|
5265
|
-
*
|
|
7416
|
+
* Zone public ID
|
|
5266
7417
|
*/
|
|
5267
7418
|
id: string;
|
|
5268
7419
|
};
|
|
5269
7420
|
query?: never;
|
|
5270
|
-
url: '/
|
|
7421
|
+
url: '/zone/{id}';
|
|
5271
7422
|
};
|
|
5272
|
-
type
|
|
5273
|
-
/**
|
|
5274
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5275
|
-
*/
|
|
5276
|
-
400: ApiErrorResponse;
|
|
7423
|
+
type ZoneControllerGetErrors = {
|
|
5277
7424
|
/**
|
|
5278
7425
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5279
7426
|
*/
|
|
@@ -5295,13 +7442,13 @@ type ProjectDocumentControllerGetErrors = {
|
|
|
5295
7442
|
*/
|
|
5296
7443
|
500: ApiErrorResponse;
|
|
5297
7444
|
};
|
|
5298
|
-
type
|
|
5299
|
-
type
|
|
5300
|
-
200:
|
|
7445
|
+
type ZoneControllerGetError = ZoneControllerGetErrors[keyof ZoneControllerGetErrors];
|
|
7446
|
+
type ZoneControllerGetResponses = {
|
|
7447
|
+
200: ZoneResponseDto;
|
|
5301
7448
|
};
|
|
5302
|
-
type
|
|
5303
|
-
type
|
|
5304
|
-
body:
|
|
7449
|
+
type ZoneControllerGetResponse = ZoneControllerGetResponses[keyof ZoneControllerGetResponses];
|
|
7450
|
+
type ZoneControllerUpdateData = {
|
|
7451
|
+
body: UpdateZoneDto;
|
|
5305
7452
|
headers?: {
|
|
5306
7453
|
/**
|
|
5307
7454
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5310,14 +7457,14 @@ type ProjectDocumentControllerUpdateData = {
|
|
|
5310
7457
|
};
|
|
5311
7458
|
path: {
|
|
5312
7459
|
/**
|
|
5313
|
-
*
|
|
7460
|
+
* Zone public ID
|
|
5314
7461
|
*/
|
|
5315
7462
|
id: string;
|
|
5316
7463
|
};
|
|
5317
7464
|
query?: never;
|
|
5318
|
-
url: '/
|
|
7465
|
+
url: '/zone/{id}';
|
|
5319
7466
|
};
|
|
5320
|
-
type
|
|
7467
|
+
type ZoneControllerUpdateErrors = {
|
|
5321
7468
|
/**
|
|
5322
7469
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5323
7470
|
*/
|
|
@@ -5334,6 +7481,10 @@ type ProjectDocumentControllerUpdateErrors = {
|
|
|
5334
7481
|
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5335
7482
|
*/
|
|
5336
7483
|
404: ApiErrorResponse;
|
|
7484
|
+
/**
|
|
7485
|
+
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
7486
|
+
*/
|
|
7487
|
+
409: ApiErrorResponse;
|
|
5337
7488
|
/**
|
|
5338
7489
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5339
7490
|
*/
|
|
@@ -5343,13 +7494,13 @@ type ProjectDocumentControllerUpdateErrors = {
|
|
|
5343
7494
|
*/
|
|
5344
7495
|
500: ApiErrorResponse;
|
|
5345
7496
|
};
|
|
5346
|
-
type
|
|
5347
|
-
type
|
|
5348
|
-
200:
|
|
7497
|
+
type ZoneControllerUpdateError = ZoneControllerUpdateErrors[keyof ZoneControllerUpdateErrors];
|
|
7498
|
+
type ZoneControllerUpdateResponses = {
|
|
7499
|
+
200: ZoneResponseDto;
|
|
5349
7500
|
};
|
|
5350
|
-
type
|
|
5351
|
-
type
|
|
5352
|
-
body:
|
|
7501
|
+
type ZoneControllerUpdateResponse = ZoneControllerUpdateResponses[keyof ZoneControllerUpdateResponses];
|
|
7502
|
+
type ZoneControllerCreateData = {
|
|
7503
|
+
body: CreateZoneDto;
|
|
5353
7504
|
headers?: {
|
|
5354
7505
|
/**
|
|
5355
7506
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5358,9 +7509,9 @@ type ProjectDocumentControllerCreateData = {
|
|
|
5358
7509
|
};
|
|
5359
7510
|
path?: never;
|
|
5360
7511
|
query?: never;
|
|
5361
|
-
url: '/
|
|
7512
|
+
url: '/zone';
|
|
5362
7513
|
};
|
|
5363
|
-
type
|
|
7514
|
+
type ZoneControllerCreateErrors = {
|
|
5364
7515
|
/**
|
|
5365
7516
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5366
7517
|
*/
|
|
@@ -5390,12 +7541,12 @@ type ProjectDocumentControllerCreateErrors = {
|
|
|
5390
7541
|
*/
|
|
5391
7542
|
500: ApiErrorResponse;
|
|
5392
7543
|
};
|
|
5393
|
-
type
|
|
5394
|
-
type
|
|
5395
|
-
201:
|
|
7544
|
+
type ZoneControllerCreateError = ZoneControllerCreateErrors[keyof ZoneControllerCreateErrors];
|
|
7545
|
+
type ZoneControllerCreateResponses = {
|
|
7546
|
+
201: ZoneResponseDto;
|
|
5396
7547
|
};
|
|
5397
|
-
type
|
|
5398
|
-
type
|
|
7548
|
+
type ZoneControllerCreateResponse = ZoneControllerCreateResponses[keyof ZoneControllerCreateResponses];
|
|
7549
|
+
type GroupControllerListData = {
|
|
5399
7550
|
body?: never;
|
|
5400
7551
|
path?: never;
|
|
5401
7552
|
query?: {
|
|
@@ -5409,41 +7560,29 @@ type JobDocumentControllerListData = {
|
|
|
5409
7560
|
page?: number;
|
|
5410
7561
|
direction?: 'asc' | 'desc';
|
|
5411
7562
|
/**
|
|
5412
|
-
* Sort field: name,
|
|
7563
|
+
* Sort field: name, created_at, updated_at, id (default updated_at)
|
|
5413
7564
|
*/
|
|
5414
7565
|
sort?: string;
|
|
5415
7566
|
/**
|
|
5416
|
-
* Filter to one
|
|
5417
|
-
*/
|
|
5418
|
-
parent_id?: string;
|
|
5419
|
-
/**
|
|
5420
|
-
* Filter by document type id (numeric string)
|
|
7567
|
+
* Filter to one site by its publicId (UUID)
|
|
5421
7568
|
*/
|
|
5422
|
-
|
|
7569
|
+
site_id?: string;
|
|
5423
7570
|
/**
|
|
5424
7571
|
* Filter by name (case-insensitive partial)
|
|
5425
7572
|
*/
|
|
5426
|
-
name?: string;
|
|
5427
|
-
/**
|
|
5428
|
-
* Filter: expires_on >= (ISO date)
|
|
5429
|
-
*/
|
|
5430
|
-
expires_on_from?: string;
|
|
5431
|
-
/**
|
|
5432
|
-
* Filter: expires_on <= (ISO date)
|
|
5433
|
-
*/
|
|
5434
|
-
expires_on_to?: string;
|
|
7573
|
+
name?: string;
|
|
5435
7574
|
/**
|
|
5436
7575
|
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5437
7576
|
*/
|
|
5438
|
-
|
|
7577
|
+
group_date_updated_from?: string;
|
|
5439
7578
|
/**
|
|
5440
7579
|
* Filter: updated_at <= (ISO)
|
|
5441
7580
|
*/
|
|
5442
|
-
|
|
7581
|
+
group_date_updated_to?: string;
|
|
5443
7582
|
};
|
|
5444
|
-
url: '/
|
|
7583
|
+
url: '/group/list';
|
|
5445
7584
|
};
|
|
5446
|
-
type
|
|
7585
|
+
type GroupControllerListErrors = {
|
|
5447
7586
|
/**
|
|
5448
7587
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5449
7588
|
*/
|
|
@@ -5465,27 +7604,23 @@ type JobDocumentControllerListErrors = {
|
|
|
5465
7604
|
*/
|
|
5466
7605
|
500: ApiErrorResponse;
|
|
5467
7606
|
};
|
|
5468
|
-
type
|
|
5469
|
-
type
|
|
5470
|
-
200:
|
|
7607
|
+
type GroupControllerListError = GroupControllerListErrors[keyof GroupControllerListErrors];
|
|
7608
|
+
type GroupControllerListResponses = {
|
|
7609
|
+
200: ListGroupsResponseDto;
|
|
5471
7610
|
};
|
|
5472
|
-
type
|
|
5473
|
-
type
|
|
7611
|
+
type GroupControllerListResponse = GroupControllerListResponses[keyof GroupControllerListResponses];
|
|
7612
|
+
type GroupControllerDeleteData = {
|
|
5474
7613
|
body?: never;
|
|
5475
7614
|
path: {
|
|
5476
7615
|
/**
|
|
5477
|
-
*
|
|
7616
|
+
* Group public ID
|
|
5478
7617
|
*/
|
|
5479
7618
|
id: string;
|
|
5480
7619
|
};
|
|
5481
7620
|
query?: never;
|
|
5482
|
-
url: '/
|
|
7621
|
+
url: '/group/{id}';
|
|
5483
7622
|
};
|
|
5484
|
-
type
|
|
5485
|
-
/**
|
|
5486
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5487
|
-
*/
|
|
5488
|
-
400: ApiErrorResponse;
|
|
7623
|
+
type GroupControllerDeleteErrors = {
|
|
5489
7624
|
/**
|
|
5490
7625
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5491
7626
|
*/
|
|
@@ -5507,27 +7642,23 @@ type JobDocumentControllerRemoveErrors = {
|
|
|
5507
7642
|
*/
|
|
5508
7643
|
500: ApiErrorResponse;
|
|
5509
7644
|
};
|
|
5510
|
-
type
|
|
5511
|
-
type
|
|
5512
|
-
200:
|
|
7645
|
+
type GroupControllerDeleteError = GroupControllerDeleteErrors[keyof GroupControllerDeleteErrors];
|
|
7646
|
+
type GroupControllerDeleteResponses = {
|
|
7647
|
+
200: DeleteGroupResponseDto;
|
|
5513
7648
|
};
|
|
5514
|
-
type
|
|
5515
|
-
type
|
|
7649
|
+
type GroupControllerDeleteResponse = GroupControllerDeleteResponses[keyof GroupControllerDeleteResponses];
|
|
7650
|
+
type GroupControllerGetData = {
|
|
5516
7651
|
body?: never;
|
|
5517
7652
|
path: {
|
|
5518
7653
|
/**
|
|
5519
|
-
*
|
|
7654
|
+
* Group public ID
|
|
5520
7655
|
*/
|
|
5521
7656
|
id: string;
|
|
5522
7657
|
};
|
|
5523
7658
|
query?: never;
|
|
5524
|
-
url: '/
|
|
7659
|
+
url: '/group/{id}';
|
|
5525
7660
|
};
|
|
5526
|
-
type
|
|
5527
|
-
/**
|
|
5528
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5529
|
-
*/
|
|
5530
|
-
400: ApiErrorResponse;
|
|
7661
|
+
type GroupControllerGetErrors = {
|
|
5531
7662
|
/**
|
|
5532
7663
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5533
7664
|
*/
|
|
@@ -5549,13 +7680,13 @@ type JobDocumentControllerGetErrors = {
|
|
|
5549
7680
|
*/
|
|
5550
7681
|
500: ApiErrorResponse;
|
|
5551
7682
|
};
|
|
5552
|
-
type
|
|
5553
|
-
type
|
|
5554
|
-
200:
|
|
7683
|
+
type GroupControllerGetError = GroupControllerGetErrors[keyof GroupControllerGetErrors];
|
|
7684
|
+
type GroupControllerGetResponses = {
|
|
7685
|
+
200: GroupResponseDto;
|
|
5555
7686
|
};
|
|
5556
|
-
type
|
|
5557
|
-
type
|
|
5558
|
-
body:
|
|
7687
|
+
type GroupControllerGetResponse = GroupControllerGetResponses[keyof GroupControllerGetResponses];
|
|
7688
|
+
type GroupControllerUpdateData = {
|
|
7689
|
+
body: UpdateGroupDto;
|
|
5559
7690
|
headers?: {
|
|
5560
7691
|
/**
|
|
5561
7692
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5564,14 +7695,14 @@ type JobDocumentControllerUpdateData = {
|
|
|
5564
7695
|
};
|
|
5565
7696
|
path: {
|
|
5566
7697
|
/**
|
|
5567
|
-
*
|
|
7698
|
+
* Group public ID
|
|
5568
7699
|
*/
|
|
5569
7700
|
id: string;
|
|
5570
7701
|
};
|
|
5571
7702
|
query?: never;
|
|
5572
|
-
url: '/
|
|
7703
|
+
url: '/group/{id}';
|
|
5573
7704
|
};
|
|
5574
|
-
type
|
|
7705
|
+
type GroupControllerUpdateErrors = {
|
|
5575
7706
|
/**
|
|
5576
7707
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5577
7708
|
*/
|
|
@@ -5597,13 +7728,13 @@ type JobDocumentControllerUpdateErrors = {
|
|
|
5597
7728
|
*/
|
|
5598
7729
|
500: ApiErrorResponse;
|
|
5599
7730
|
};
|
|
5600
|
-
type
|
|
5601
|
-
type
|
|
5602
|
-
200:
|
|
7731
|
+
type GroupControllerUpdateError = GroupControllerUpdateErrors[keyof GroupControllerUpdateErrors];
|
|
7732
|
+
type GroupControllerUpdateResponses = {
|
|
7733
|
+
200: GroupResponseDto;
|
|
5603
7734
|
};
|
|
5604
|
-
type
|
|
5605
|
-
type
|
|
5606
|
-
body:
|
|
7735
|
+
type GroupControllerUpdateResponse = GroupControllerUpdateResponses[keyof GroupControllerUpdateResponses];
|
|
7736
|
+
type GroupControllerCreateData = {
|
|
7737
|
+
body: CreateGroupDto;
|
|
5607
7738
|
headers?: {
|
|
5608
7739
|
/**
|
|
5609
7740
|
* Opaque client-generated key (any string up to 255 chars, ULID or UUID recommended) that makes this POST/PATCH safe to retry. The server stores the first successful response under this key for 24 hours; retries with the same key replay the stored response and set `Idempotent-Replayed: true`. Reusing the key with a different body returns `409 idempotency_key_conflict`. Omit on read-only GETs — they are already idempotent.
|
|
@@ -5612,9 +7743,9 @@ type JobDocumentControllerCreateData = {
|
|
|
5612
7743
|
};
|
|
5613
7744
|
path?: never;
|
|
5614
7745
|
query?: never;
|
|
5615
|
-
url: '/
|
|
7746
|
+
url: '/group';
|
|
5616
7747
|
};
|
|
5617
|
-
type
|
|
7748
|
+
type GroupControllerCreateErrors = {
|
|
5618
7749
|
/**
|
|
5619
7750
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5620
7751
|
*/
|
|
@@ -5631,10 +7762,6 @@ type JobDocumentControllerCreateErrors = {
|
|
|
5631
7762
|
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5632
7763
|
*/
|
|
5633
7764
|
404: ApiErrorResponse;
|
|
5634
|
-
/**
|
|
5635
|
-
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5636
|
-
*/
|
|
5637
|
-
409: ApiErrorResponse;
|
|
5638
7765
|
/**
|
|
5639
7766
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5640
7767
|
*/
|
|
@@ -5644,12 +7771,12 @@ type JobDocumentControllerCreateErrors = {
|
|
|
5644
7771
|
*/
|
|
5645
7772
|
500: ApiErrorResponse;
|
|
5646
7773
|
};
|
|
5647
|
-
type
|
|
5648
|
-
type
|
|
5649
|
-
201:
|
|
7774
|
+
type GroupControllerCreateError = GroupControllerCreateErrors[keyof GroupControllerCreateErrors];
|
|
7775
|
+
type GroupControllerCreateResponses = {
|
|
7776
|
+
201: GroupResponseDto;
|
|
5650
7777
|
};
|
|
5651
|
-
type
|
|
5652
|
-
type
|
|
7778
|
+
type GroupControllerCreateResponse = GroupControllerCreateResponses[keyof GroupControllerCreateResponses];
|
|
7779
|
+
type DevicePublicControllerListData = {
|
|
5653
7780
|
body?: never;
|
|
5654
7781
|
path?: never;
|
|
5655
7782
|
query?: {
|
|
@@ -5663,41 +7790,29 @@ type CompanyDocumentControllerListData = {
|
|
|
5663
7790
|
page?: number;
|
|
5664
7791
|
direction?: 'asc' | 'desc';
|
|
5665
7792
|
/**
|
|
5666
|
-
* Sort field: name,
|
|
7793
|
+
* Sort field: name, status, last_sync_at, created_at, updated_at, id (default updated_at)
|
|
5667
7794
|
*/
|
|
5668
7795
|
sort?: string;
|
|
5669
7796
|
/**
|
|
5670
|
-
* Filter
|
|
5671
|
-
*/
|
|
5672
|
-
parent_id?: string;
|
|
5673
|
-
/**
|
|
5674
|
-
* Filter by document type id (numeric string)
|
|
7797
|
+
* Filter by status (e.g. active, pending)
|
|
5675
7798
|
*/
|
|
5676
|
-
|
|
7799
|
+
status?: string;
|
|
5677
7800
|
/**
|
|
5678
7801
|
* Filter by name (case-insensitive partial)
|
|
5679
7802
|
*/
|
|
5680
7803
|
name?: string;
|
|
5681
|
-
/**
|
|
5682
|
-
* Filter: expires_on >= (ISO date)
|
|
5683
|
-
*/
|
|
5684
|
-
expires_on_from?: string;
|
|
5685
|
-
/**
|
|
5686
|
-
* Filter: expires_on <= (ISO date)
|
|
5687
|
-
*/
|
|
5688
|
-
expires_on_to?: string;
|
|
5689
7804
|
/**
|
|
5690
7805
|
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5691
7806
|
*/
|
|
5692
|
-
|
|
7807
|
+
device_date_updated_from?: string;
|
|
5693
7808
|
/**
|
|
5694
7809
|
* Filter: updated_at <= (ISO)
|
|
5695
7810
|
*/
|
|
5696
|
-
|
|
7811
|
+
device_date_updated_to?: string;
|
|
5697
7812
|
};
|
|
5698
|
-
url: '/
|
|
7813
|
+
url: '/device/list';
|
|
5699
7814
|
};
|
|
5700
|
-
type
|
|
7815
|
+
type DevicePublicControllerListErrors = {
|
|
5701
7816
|
/**
|
|
5702
7817
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5703
7818
|
*/
|
|
@@ -5719,27 +7834,23 @@ type CompanyDocumentControllerListErrors = {
|
|
|
5719
7834
|
*/
|
|
5720
7835
|
500: ApiErrorResponse;
|
|
5721
7836
|
};
|
|
5722
|
-
type
|
|
5723
|
-
type
|
|
5724
|
-
200:
|
|
7837
|
+
type DevicePublicControllerListError = DevicePublicControllerListErrors[keyof DevicePublicControllerListErrors];
|
|
7838
|
+
type DevicePublicControllerListResponses = {
|
|
7839
|
+
200: ListDevicesResponseDto;
|
|
5725
7840
|
};
|
|
5726
|
-
type
|
|
5727
|
-
type
|
|
7841
|
+
type DevicePublicControllerListResponse = DevicePublicControllerListResponses[keyof DevicePublicControllerListResponses];
|
|
7842
|
+
type DevicePublicControllerGetData = {
|
|
5728
7843
|
body?: never;
|
|
5729
7844
|
path: {
|
|
5730
7845
|
/**
|
|
5731
|
-
*
|
|
7846
|
+
* Device public ID
|
|
5732
7847
|
*/
|
|
5733
7848
|
id: string;
|
|
5734
7849
|
};
|
|
5735
7850
|
query?: never;
|
|
5736
|
-
url: '/
|
|
7851
|
+
url: '/device/{id}';
|
|
5737
7852
|
};
|
|
5738
|
-
type
|
|
5739
|
-
/**
|
|
5740
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5741
|
-
*/
|
|
5742
|
-
400: ApiErrorResponse;
|
|
7853
|
+
type DevicePublicControllerGetErrors = {
|
|
5743
7854
|
/**
|
|
5744
7855
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5745
7856
|
*/
|
|
@@ -5761,71 +7872,56 @@ type CompanyDocumentControllerRemoveErrors = {
|
|
|
5761
7872
|
*/
|
|
5762
7873
|
500: ApiErrorResponse;
|
|
5763
7874
|
};
|
|
5764
|
-
type
|
|
5765
|
-
type
|
|
5766
|
-
200:
|
|
7875
|
+
type DevicePublicControllerGetError = DevicePublicControllerGetErrors[keyof DevicePublicControllerGetErrors];
|
|
7876
|
+
type DevicePublicControllerGetResponses = {
|
|
7877
|
+
200: DeviceResponseDto;
|
|
5767
7878
|
};
|
|
5768
|
-
type
|
|
5769
|
-
type
|
|
7879
|
+
type DevicePublicControllerGetResponse = DevicePublicControllerGetResponses[keyof DevicePublicControllerGetResponses];
|
|
7880
|
+
type TimesheetPublicControllerListData = {
|
|
5770
7881
|
body?: never;
|
|
5771
|
-
path
|
|
7882
|
+
path?: never;
|
|
7883
|
+
query?: {
|
|
5772
7884
|
/**
|
|
5773
|
-
*
|
|
7885
|
+
* Results per page
|
|
5774
7886
|
*/
|
|
5775
|
-
|
|
5776
|
-
};
|
|
5777
|
-
query?: never;
|
|
5778
|
-
url: '/company-document/{id}';
|
|
5779
|
-
};
|
|
5780
|
-
type CompanyDocumentControllerGetErrors = {
|
|
5781
|
-
/**
|
|
5782
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5783
|
-
*/
|
|
5784
|
-
400: ApiErrorResponse;
|
|
5785
|
-
/**
|
|
5786
|
-
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5787
|
-
*/
|
|
5788
|
-
401: ApiErrorResponse;
|
|
5789
|
-
/**
|
|
5790
|
-
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5791
|
-
*/
|
|
5792
|
-
403: ApiErrorResponse;
|
|
5793
|
-
/**
|
|
5794
|
-
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5795
|
-
*/
|
|
5796
|
-
404: ApiErrorResponse;
|
|
5797
|
-
/**
|
|
5798
|
-
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5799
|
-
*/
|
|
5800
|
-
429: ApiErrorResponse;
|
|
5801
|
-
/**
|
|
5802
|
-
* Something went wrong on our side. The `request_id` field in the response body matches the entry in our logs — include it when reporting the issue.
|
|
5803
|
-
*/
|
|
5804
|
-
500: ApiErrorResponse;
|
|
5805
|
-
};
|
|
5806
|
-
type CompanyDocumentControllerGetError = CompanyDocumentControllerGetErrors[keyof CompanyDocumentControllerGetErrors];
|
|
5807
|
-
type CompanyDocumentControllerGetResponses = {
|
|
5808
|
-
200: DocumentResponseDto;
|
|
5809
|
-
};
|
|
5810
|
-
type CompanyDocumentControllerGetResponse = CompanyDocumentControllerGetResponses[keyof CompanyDocumentControllerGetResponses];
|
|
5811
|
-
type CompanyDocumentControllerUpdateData = {
|
|
5812
|
-
body: UpdateDocumentDto;
|
|
5813
|
-
headers?: {
|
|
7887
|
+
per_page?: number;
|
|
5814
7888
|
/**
|
|
5815
|
-
*
|
|
7889
|
+
* Page number
|
|
5816
7890
|
*/
|
|
5817
|
-
|
|
5818
|
-
|
|
5819
|
-
path: {
|
|
7891
|
+
page?: number;
|
|
7892
|
+
direction?: 'asc' | 'desc';
|
|
5820
7893
|
/**
|
|
5821
|
-
*
|
|
7894
|
+
* Sort field: period_start, status, submitted_at, created_at, updated_at, id (default period_start)
|
|
5822
7895
|
*/
|
|
5823
|
-
|
|
7896
|
+
sort?: string;
|
|
7897
|
+
/**
|
|
7898
|
+
* Filter by status: draft, submitted, in_approval, approved, rejected, info_required
|
|
7899
|
+
*/
|
|
7900
|
+
status?: string;
|
|
7901
|
+
/**
|
|
7902
|
+
* Filter to one user by their publicId (UUID)
|
|
7903
|
+
*/
|
|
7904
|
+
user_id?: string;
|
|
7905
|
+
/**
|
|
7906
|
+
* Filter: period_start >= (ISO date)
|
|
7907
|
+
*/
|
|
7908
|
+
period_start_from?: string;
|
|
7909
|
+
/**
|
|
7910
|
+
* Filter: period_start <= (ISO date)
|
|
7911
|
+
*/
|
|
7912
|
+
period_start_to?: string;
|
|
7913
|
+
/**
|
|
7914
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
7915
|
+
*/
|
|
7916
|
+
timesheet_date_updated_from?: string;
|
|
7917
|
+
/**
|
|
7918
|
+
* Filter: updated_at <= (ISO)
|
|
7919
|
+
*/
|
|
7920
|
+
timesheet_date_updated_to?: string;
|
|
5824
7921
|
};
|
|
5825
|
-
|
|
5826
|
-
url: '/company-document/{id}';
|
|
7922
|
+
url: '/timesheet/list';
|
|
5827
7923
|
};
|
|
5828
|
-
type
|
|
7924
|
+
type TimesheetPublicControllerListErrors = {
|
|
5829
7925
|
/**
|
|
5830
7926
|
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5831
7927
|
*/
|
|
@@ -5838,10 +7934,6 @@ type CompanyDocumentControllerUpdateErrors = {
|
|
|
5838
7934
|
* The Bearer token authenticated successfully but cannot perform this action. Two distinct codes share this status: `forbidden` (missing permission scope) and `ip_not_allowed` (source IP not in the API key's allowlist).
|
|
5839
7935
|
*/
|
|
5840
7936
|
403: ApiErrorResponse;
|
|
5841
|
-
/**
|
|
5842
|
-
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5843
|
-
*/
|
|
5844
|
-
404: ApiErrorResponse;
|
|
5845
7937
|
/**
|
|
5846
7938
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5847
7939
|
*/
|
|
@@ -5851,28 +7943,23 @@ type CompanyDocumentControllerUpdateErrors = {
|
|
|
5851
7943
|
*/
|
|
5852
7944
|
500: ApiErrorResponse;
|
|
5853
7945
|
};
|
|
5854
|
-
type
|
|
5855
|
-
type
|
|
5856
|
-
200:
|
|
7946
|
+
type TimesheetPublicControllerListError = TimesheetPublicControllerListErrors[keyof TimesheetPublicControllerListErrors];
|
|
7947
|
+
type TimesheetPublicControllerListResponses = {
|
|
7948
|
+
200: ListTimesheetsResponseDto;
|
|
5857
7949
|
};
|
|
5858
|
-
type
|
|
5859
|
-
type
|
|
5860
|
-
body
|
|
5861
|
-
|
|
7950
|
+
type TimesheetPublicControllerListResponse = TimesheetPublicControllerListResponses[keyof TimesheetPublicControllerListResponses];
|
|
7951
|
+
type TimesheetPublicControllerGetData = {
|
|
7952
|
+
body?: never;
|
|
7953
|
+
path: {
|
|
5862
7954
|
/**
|
|
5863
|
-
*
|
|
7955
|
+
* Timesheet public ID
|
|
5864
7956
|
*/
|
|
5865
|
-
|
|
7957
|
+
id: string;
|
|
5866
7958
|
};
|
|
5867
|
-
path?: never;
|
|
5868
7959
|
query?: never;
|
|
5869
|
-
url: '/
|
|
7960
|
+
url: '/timesheet/{id}';
|
|
5870
7961
|
};
|
|
5871
|
-
type
|
|
5872
|
-
/**
|
|
5873
|
-
* Validation failed or the request was malformed. The response body will use `code: validation_error` (with `details[]` populated when the failure can be pinpointed to specific fields) or the more generic `code: bad_request`.
|
|
5874
|
-
*/
|
|
5875
|
-
400: ApiErrorResponse;
|
|
7962
|
+
type TimesheetPublicControllerGetErrors = {
|
|
5876
7963
|
/**
|
|
5877
7964
|
* The Bearer token is missing, malformed, or no longer valid. Verify the `Authorization` header is set to `Bearer wk_…` and that the key has not been revoked or rotated out.
|
|
5878
7965
|
*/
|
|
@@ -5885,10 +7972,6 @@ type CompanyDocumentControllerCreateErrors = {
|
|
|
5885
7972
|
* No resource was found at the requested location, or a referenced resource (`publicId` in the body) doesn't exist or is not visible to the calling company.
|
|
5886
7973
|
*/
|
|
5887
7974
|
404: ApiErrorResponse;
|
|
5888
|
-
/**
|
|
5889
|
-
* The request conflicts with current state. Common cases: a unique business identifier already exists (`conflict`), or an `Idempotency-Key` was reused with a different request body (`idempotency_key_conflict`).
|
|
5890
|
-
*/
|
|
5891
|
-
409: ApiErrorResponse;
|
|
5892
7975
|
/**
|
|
5893
7976
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5894
7977
|
*/
|
|
@@ -5898,11 +7981,11 @@ type CompanyDocumentControllerCreateErrors = {
|
|
|
5898
7981
|
*/
|
|
5899
7982
|
500: ApiErrorResponse;
|
|
5900
7983
|
};
|
|
5901
|
-
type
|
|
5902
|
-
type
|
|
5903
|
-
|
|
7984
|
+
type TimesheetPublicControllerGetError = TimesheetPublicControllerGetErrors[keyof TimesheetPublicControllerGetErrors];
|
|
7985
|
+
type TimesheetPublicControllerGetResponses = {
|
|
7986
|
+
200: TimesheetDetailDto;
|
|
5904
7987
|
};
|
|
5905
|
-
type
|
|
7988
|
+
type TimesheetPublicControllerGetResponse = TimesheetPublicControllerGetResponses[keyof TimesheetPublicControllerGetResponses];
|
|
5906
7989
|
type SiteControllerListSitesData = {
|
|
5907
7990
|
body?: never;
|
|
5908
7991
|
path?: never;
|
|
@@ -6121,7 +8204,7 @@ type SiteControllerUpdateSiteResponses = {
|
|
|
6121
8204
|
};
|
|
6122
8205
|
type SiteControllerUpdateSiteResponse = SiteControllerUpdateSiteResponses[keyof SiteControllerUpdateSiteResponses];
|
|
6123
8206
|
type ClientOptions = {
|
|
6124
|
-
baseUrl: 'https://api.wakata.ai' | (string & {});
|
|
8207
|
+
baseUrl: 'https://dev-api.wakata.ai' | (string & {});
|
|
6125
8208
|
};
|
|
6126
8209
|
|
|
6127
8210
|
type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
|
|
@@ -6170,7 +8253,11 @@ declare const assetControllerListAssets: <ThrowOnError extends boolean = false>(
|
|
|
6170
8253
|
data?: Array<{
|
|
6171
8254
|
id?: string;
|
|
6172
8255
|
publicId?: string;
|
|
6173
|
-
assetNumber
|
|
8256
|
+
assetNumber
|
|
8257
|
+
/**
|
|
8258
|
+
* Get a company document
|
|
8259
|
+
*/
|
|
8260
|
+
?: string;
|
|
6174
8261
|
assetClassId?: string;
|
|
6175
8262
|
siteId?: string;
|
|
6176
8263
|
companyId?: string;
|
|
@@ -6510,6 +8597,136 @@ declare const assetDocumentControllerUpdate: <ThrowOnError extends boolean = fal
|
|
|
6510
8597
|
* Create an asset document
|
|
6511
8598
|
*/
|
|
6512
8599
|
declare const assetDocumentControllerCreate: <ThrowOnError extends boolean = false>(options: Options<AssetDocumentControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DocumentResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8600
|
+
/**
|
|
8601
|
+
* List projects
|
|
8602
|
+
* Returns a paginated list of projects for the authenticated company. Filter by name, project_code, status, site (publicId), and an incremental `updated_at` watermark. Each row includes approved asset_count / user_count. Requires project:read.
|
|
8603
|
+
*/
|
|
8604
|
+
declare const projectControllerList: <ThrowOnError extends boolean = false>(options?: Options<ProjectControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListProjectsResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8605
|
+
/**
|
|
8606
|
+
* Delete a project
|
|
8607
|
+
* Soft-deletes a project by its public_id (UUID). Requires project:delete.
|
|
8608
|
+
*/
|
|
8609
|
+
declare const projectControllerDelete: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerDeleteData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteProjectResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8610
|
+
/**
|
|
8611
|
+
* Get a project by public ID
|
|
8612
|
+
* Returns one project (with embedded project_properties[] and approved asset/user counts) by its public_id (UUID). Requires project:read.
|
|
8613
|
+
*/
|
|
8614
|
+
declare const projectControllerGet: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProjectResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8615
|
+
/**
|
|
8616
|
+
* Update a project
|
|
8617
|
+
* Updates a project by its public_id (UUID). Only provided fields are changed. Requires project:update. Supports `Idempotency-Key`.
|
|
8618
|
+
*/
|
|
8619
|
+
declare const projectControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProjectResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8620
|
+
/**
|
|
8621
|
+
* List assets assigned to a project
|
|
8622
|
+
* Returns the asset assignments for a project (read-only). Each row is an approval record carrying approval_status, approval_number, approval_date and expiry_date. Filter by approval_status (e.g. approved). The assign/approve workflow happens in the app. Requires project_asset_approval:read.
|
|
8623
|
+
*/
|
|
8624
|
+
declare const projectControllerListAssets: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerListAssetsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListProjectAssetsResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8625
|
+
/**
|
|
8626
|
+
* List users assigned to a project
|
|
8627
|
+
* Returns the user assignments for a project (read-only). Each row is an approval record carrying approval_status, approval_number, approval_date and expiry_date. Filter by approval_status (e.g. approved). The assign/approve workflow happens in the app. Requires project_user_approval:read.
|
|
8628
|
+
*/
|
|
8629
|
+
declare const projectControllerListUsers: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerListUsersData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListProjectUsersResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8630
|
+
/**
|
|
8631
|
+
* Create a project
|
|
8632
|
+
* Creates a project under a site (by publicId) for the authenticated company. project_code is unique per company — a duplicate returns 409. Requires project:create. Supports `Idempotency-Key`.
|
|
8633
|
+
*/
|
|
8634
|
+
declare const projectControllerCreate: <ThrowOnError extends boolean = false>(options: Options<ProjectControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ProjectResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8635
|
+
/**
|
|
8636
|
+
* List customers
|
|
8637
|
+
* Returns a paginated list of customers for the authenticated company. Supports name/status filters and an incremental `updated_at` watermark. Requires customer:read.
|
|
8638
|
+
*/
|
|
8639
|
+
declare const customerControllerList: <ThrowOnError extends boolean = false>(options?: Options<CustomerControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListCustomersResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8640
|
+
/**
|
|
8641
|
+
* Delete a customer
|
|
8642
|
+
* Soft-deletes a customer by its public_id (UUID). Requires customer:delete.
|
|
8643
|
+
*/
|
|
8644
|
+
declare const customerControllerDelete: <ThrowOnError extends boolean = false>(options: Options<CustomerControllerDeleteData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteCustomerResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8645
|
+
/**
|
|
8646
|
+
* Get a customer by public ID
|
|
8647
|
+
* Returns one customer (with embedded customer_properties[]) by its public_id (UUID). Requires customer:read.
|
|
8648
|
+
*/
|
|
8649
|
+
declare const customerControllerGet: <ThrowOnError extends boolean = false>(options: Options<CustomerControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CustomerResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8650
|
+
/**
|
|
8651
|
+
* Update a customer
|
|
8652
|
+
* Updates a customer by its public_id (UUID). Only provided fields are changed. Requires customer:update. Supports `Idempotency-Key`.
|
|
8653
|
+
*/
|
|
8654
|
+
declare const customerControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<CustomerControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CustomerResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8655
|
+
/**
|
|
8656
|
+
* Create a customer
|
|
8657
|
+
* Creates a customer for the authenticated company. Requires customer:create. Customer names are unique per company (case-insensitive) — a duplicate returns 409. Supports `Idempotency-Key`.
|
|
8658
|
+
*/
|
|
8659
|
+
declare const customerControllerCreate: <ThrowOnError extends boolean = false>(options: Options<CustomerControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CustomerResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8660
|
+
/**
|
|
8661
|
+
* List zones
|
|
8662
|
+
* Returns a paginated list of zones for the authenticated company. Filter by site (publicId), name, and an incremental `updated_at` watermark. Requires zone:read.
|
|
8663
|
+
*/
|
|
8664
|
+
declare const zoneControllerList: <ThrowOnError extends boolean = false>(options?: Options<ZoneControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListZonesResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8665
|
+
/**
|
|
8666
|
+
* Delete a zone
|
|
8667
|
+
* Soft-deletes a zone by its public_id (UUID). Requires zone:delete.
|
|
8668
|
+
*/
|
|
8669
|
+
declare const zoneControllerDelete: <ThrowOnError extends boolean = false>(options: Options<ZoneControllerDeleteData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteZoneResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8670
|
+
/**
|
|
8671
|
+
* Get a zone by public ID
|
|
8672
|
+
* Returns one zone by its public_id (UUID). Requires zone:read.
|
|
8673
|
+
*/
|
|
8674
|
+
declare const zoneControllerGet: <ThrowOnError extends boolean = false>(options: Options<ZoneControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ZoneResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8675
|
+
/**
|
|
8676
|
+
* Update a zone
|
|
8677
|
+
* Updates a zone by its public_id (UUID). Only provided fields are changed; set parent_zone_id to null to make a zone top-level. Requires zone:update. Supports `Idempotency-Key`.
|
|
8678
|
+
*/
|
|
8679
|
+
declare const zoneControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<ZoneControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ZoneResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8680
|
+
/**
|
|
8681
|
+
* Create a zone
|
|
8682
|
+
* Creates a zone under a site for the authenticated company. Reference the site (required) and optional parent zone by their publicId. Zone names are unique per site — a duplicate returns 409. Requires zone:create. Supports `Idempotency-Key`.
|
|
8683
|
+
*/
|
|
8684
|
+
declare const zoneControllerCreate: <ThrowOnError extends boolean = false>(options: Options<ZoneControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ZoneResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8685
|
+
/**
|
|
8686
|
+
* List groups
|
|
8687
|
+
* Returns a paginated list of groups (containers) for the authenticated company. Filter by site (publicId), name, and an incremental `updated_at` watermark. Membership is not included — see the group membership endpoints (coming soon). Requires group:read.
|
|
8688
|
+
*/
|
|
8689
|
+
declare const groupControllerList: <ThrowOnError extends boolean = false>(options?: Options<GroupControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListGroupsResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8690
|
+
/**
|
|
8691
|
+
* Delete a group
|
|
8692
|
+
* Soft-deletes a group container by its public_id (UUID). Requires group:delete.
|
|
8693
|
+
*/
|
|
8694
|
+
declare const groupControllerDelete: <ThrowOnError extends boolean = false>(options: Options<GroupControllerDeleteData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteGroupResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8695
|
+
/**
|
|
8696
|
+
* Get a group by public ID
|
|
8697
|
+
* Returns one group container by its public_id (UUID). Membership is not included. Requires group:read.
|
|
8698
|
+
*/
|
|
8699
|
+
declare const groupControllerGet: <ThrowOnError extends boolean = false>(options: Options<GroupControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GroupResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8700
|
+
/**
|
|
8701
|
+
* Update a group
|
|
8702
|
+
* Updates a group container by its public_id (UUID). Only provided fields are changed; set site_id to null to make it company-wide. Requires group:update. Supports `Idempotency-Key`.
|
|
8703
|
+
*/
|
|
8704
|
+
declare const groupControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<GroupControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GroupResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8705
|
+
/**
|
|
8706
|
+
* Create a group
|
|
8707
|
+
* Creates a group container for the authenticated company. Optionally scope it to a site (by publicId). Requires group:create. Supports `Idempotency-Key`.
|
|
8708
|
+
*/
|
|
8709
|
+
declare const groupControllerCreate: <ThrowOnError extends boolean = false>(options: Options<GroupControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GroupResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8710
|
+
/**
|
|
8711
|
+
* List devices
|
|
8712
|
+
* Returns a paginated inventory of devices for the authenticated company (name, status, last sync, app/OS version, battery, location). Devices are created only via the in-app pairing flow — this endpoint is read-only. Requires device:read.
|
|
8713
|
+
*/
|
|
8714
|
+
declare const devicePublicControllerList: <ThrowOnError extends boolean = false>(options?: Options<DevicePublicControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDevicesResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8715
|
+
/**
|
|
8716
|
+
* Get a device by public ID
|
|
8717
|
+
* Returns one device by its public_id (UUID). Read-only. Requires device:read.
|
|
8718
|
+
*/
|
|
8719
|
+
declare const devicePublicControllerGet: <ThrowOnError extends boolean = false>(options: Options<DevicePublicControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeviceResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8720
|
+
/**
|
|
8721
|
+
* List timesheets
|
|
8722
|
+
* Returns a paginated list of timesheet summaries for the authenticated company. Filter by status, user (publicId), period range, and an incremental `updated_at` watermark. Read-only — timesheets are created in the Wakata app. Requires timesheet:read.
|
|
8723
|
+
*/
|
|
8724
|
+
declare const timesheetPublicControllerList: <ThrowOnError extends boolean = false>(options?: Options<TimesheetPublicControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListTimesheetsResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
8725
|
+
/**
|
|
8726
|
+
* Get a timesheet by public ID
|
|
8727
|
+
* Returns one timesheet (header + line-level rows: date, activity, duration, site/asset/project/customer allocation) by its public_id (UUID). Read-only. Requires timesheet:read.
|
|
8728
|
+
*/
|
|
8729
|
+
declare const timesheetPublicControllerGet: <ThrowOnError extends boolean = false>(options: Options<TimesheetPublicControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<TimesheetDetailDto, ApiErrorResponse, ThrowOnError>;
|
|
6513
8730
|
/**
|
|
6514
8731
|
* List sites
|
|
6515
8732
|
* Returns a paginated list of sites for the authenticated company. Supports filtering by name, category, and date modified. Requires Bearer token authentication with site:read permission.
|
|
@@ -6615,6 +8832,48 @@ interface AssetClassPropertiesResource {
|
|
|
6615
8832
|
update: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerUpdate>>['data']>;
|
|
6616
8833
|
delete: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerRemove>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerRemove>>['data']>;
|
|
6617
8834
|
}
|
|
8835
|
+
interface CustomersResource {
|
|
8836
|
+
list: (options?: WakataMethodOptions<Parameters<typeof customerControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof customerControllerList>>['data']>;
|
|
8837
|
+
get: (options: WakataMethodOptions<Parameters<typeof customerControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof customerControllerGet>>['data']>;
|
|
8838
|
+
create: (options: WakataMethodOptions<Parameters<typeof customerControllerCreate>[0]>) => Promise<Awaited<ReturnType<typeof customerControllerCreate>>['data']>;
|
|
8839
|
+
update: (options: WakataMethodOptions<Parameters<typeof customerControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof customerControllerUpdate>>['data']>;
|
|
8840
|
+
delete: (options: WakataMethodOptions<Parameters<typeof customerControllerDelete>[0]>) => Promise<Awaited<ReturnType<typeof customerControllerDelete>>['data']>;
|
|
8841
|
+
}
|
|
8842
|
+
interface ZonesResource {
|
|
8843
|
+
list: (options?: WakataMethodOptions<Parameters<typeof zoneControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof zoneControllerList>>['data']>;
|
|
8844
|
+
get: (options: WakataMethodOptions<Parameters<typeof zoneControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof zoneControllerGet>>['data']>;
|
|
8845
|
+
create: (options: WakataMethodOptions<Parameters<typeof zoneControllerCreate>[0]>) => Promise<Awaited<ReturnType<typeof zoneControllerCreate>>['data']>;
|
|
8846
|
+
update: (options: WakataMethodOptions<Parameters<typeof zoneControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof zoneControllerUpdate>>['data']>;
|
|
8847
|
+
delete: (options: WakataMethodOptions<Parameters<typeof zoneControllerDelete>[0]>) => Promise<Awaited<ReturnType<typeof zoneControllerDelete>>['data']>;
|
|
8848
|
+
}
|
|
8849
|
+
interface GroupsResource {
|
|
8850
|
+
list: (options?: WakataMethodOptions<Parameters<typeof groupControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof groupControllerList>>['data']>;
|
|
8851
|
+
get: (options: WakataMethodOptions<Parameters<typeof groupControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof groupControllerGet>>['data']>;
|
|
8852
|
+
create: (options: WakataMethodOptions<Parameters<typeof groupControllerCreate>[0]>) => Promise<Awaited<ReturnType<typeof groupControllerCreate>>['data']>;
|
|
8853
|
+
update: (options: WakataMethodOptions<Parameters<typeof groupControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof groupControllerUpdate>>['data']>;
|
|
8854
|
+
delete: (options: WakataMethodOptions<Parameters<typeof groupControllerDelete>[0]>) => Promise<Awaited<ReturnType<typeof groupControllerDelete>>['data']>;
|
|
8855
|
+
}
|
|
8856
|
+
/** Device inventory — read-only (devices are paired in-app). */
|
|
8857
|
+
interface DevicesResource {
|
|
8858
|
+
list: (options?: WakataMethodOptions<Parameters<typeof devicePublicControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof devicePublicControllerList>>['data']>;
|
|
8859
|
+
get: (options: WakataMethodOptions<Parameters<typeof devicePublicControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof devicePublicControllerGet>>['data']>;
|
|
8860
|
+
}
|
|
8861
|
+
/** Timesheets — read-only (created in the Wakata app). */
|
|
8862
|
+
interface TimesheetsResource {
|
|
8863
|
+
list: (options?: WakataMethodOptions<Parameters<typeof timesheetPublicControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof timesheetPublicControllerList>>['data']>;
|
|
8864
|
+
get: (options: WakataMethodOptions<Parameters<typeof timesheetPublicControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof timesheetPublicControllerGet>>['data']>;
|
|
8865
|
+
}
|
|
8866
|
+
interface ProjectsResource {
|
|
8867
|
+
list: (options?: WakataMethodOptions<Parameters<typeof projectControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof projectControllerList>>['data']>;
|
|
8868
|
+
get: (options: WakataMethodOptions<Parameters<typeof projectControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerGet>>['data']>;
|
|
8869
|
+
create: (options: WakataMethodOptions<Parameters<typeof projectControllerCreate>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerCreate>>['data']>;
|
|
8870
|
+
update: (options: WakataMethodOptions<Parameters<typeof projectControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerUpdate>>['data']>;
|
|
8871
|
+
delete: (options: WakataMethodOptions<Parameters<typeof projectControllerDelete>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerDelete>>['data']>;
|
|
8872
|
+
/** Read the asset assignments for a project (filter by approval_status). */
|
|
8873
|
+
assets: (options: WakataMethodOptions<Parameters<typeof projectControllerListAssets>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerListAssets>>['data']>;
|
|
8874
|
+
/** Read the user assignments for a project (filter by approval_status). */
|
|
8875
|
+
users: (options: WakataMethodOptions<Parameters<typeof projectControllerListUsers>[0]>) => Promise<Awaited<ReturnType<typeof projectControllerListUsers>>['data']>;
|
|
8876
|
+
}
|
|
6618
8877
|
/**
|
|
6619
8878
|
* One entity-document type's CRUD. All document types share the same DTOs, so
|
|
6620
8879
|
* the shape is typed against the asset-document operations (structurally
|
|
@@ -6669,6 +8928,12 @@ declare class WakataClient {
|
|
|
6669
8928
|
readonly config: ConfigResource;
|
|
6670
8929
|
readonly assetClassProperties: AssetClassPropertiesResource;
|
|
6671
8930
|
readonly documents: DocumentsResource;
|
|
8931
|
+
readonly customers: CustomersResource;
|
|
8932
|
+
readonly zones: ZonesResource;
|
|
8933
|
+
readonly groups: GroupsResource;
|
|
8934
|
+
readonly devices: DevicesResource;
|
|
8935
|
+
readonly timesheets: TimesheetsResource;
|
|
8936
|
+
readonly projects: ProjectsResource;
|
|
6672
8937
|
constructor(options: WakataClientOptions);
|
|
6673
8938
|
}
|
|
6674
8939
|
|
|
@@ -6842,4 +9107,4 @@ declare const PACKAGE_VERSION = "0.3.3";
|
|
|
6842
9107
|
/** Default base URL for the Wakata Public API (production). */
|
|
6843
9108
|
declare const DEFAULT_BASE_URL = "https://api.wakata.ai/api/v1";
|
|
6844
9109
|
|
|
6845
|
-
export { type ApiErrorBody, type ApiErrorDetail, type ApiErrorResponse, type AssetClassControllerCreateAssetClassData, type AssetClassControllerCreateAssetClassError, type AssetClassControllerCreateAssetClassErrors, type AssetClassControllerCreateAssetClassResponse, type AssetClassControllerCreateAssetClassResponses, type AssetClassControllerGetAssetClassListData, type AssetClassControllerGetAssetClassListError, type AssetClassControllerGetAssetClassListErrors, type AssetClassControllerGetAssetClassListResponse, type AssetClassControllerGetAssetClassListResponses, type AssetClassControllerUpdateAssetClassData, type AssetClassControllerUpdateAssetClassError, type AssetClassControllerUpdateAssetClassErrors, type AssetClassControllerUpdateAssetClassResponse, type AssetClassControllerUpdateAssetClassResponses, type AssetClassDocumentControllerCreateData, type AssetClassDocumentControllerCreateError, type AssetClassDocumentControllerCreateErrors, type AssetClassDocumentControllerCreateResponse, type AssetClassDocumentControllerCreateResponses, type AssetClassDocumentControllerGetData, type AssetClassDocumentControllerGetError, type AssetClassDocumentControllerGetErrors, type AssetClassDocumentControllerGetResponse, type AssetClassDocumentControllerGetResponses, type AssetClassDocumentControllerListData, type AssetClassDocumentControllerListError, type AssetClassDocumentControllerListErrors, type AssetClassDocumentControllerListResponse, type AssetClassDocumentControllerListResponses, type AssetClassDocumentControllerRemoveData, type AssetClassDocumentControllerRemoveError, type AssetClassDocumentControllerRemoveErrors, type AssetClassDocumentControllerRemoveResponse, type AssetClassDocumentControllerRemoveResponses, type AssetClassDocumentControllerUpdateData, type AssetClassDocumentControllerUpdateError, type AssetClassDocumentControllerUpdateErrors, type AssetClassDocumentControllerUpdateResponse, type AssetClassDocumentControllerUpdateResponses, type AssetClassListResponseDto, type AssetClassPropertyControllerRemoveData, type AssetClassPropertyControllerRemoveError, type AssetClassPropertyControllerRemoveErrors, type AssetClassPropertyControllerRemoveResponse, type AssetClassPropertyControllerRemoveResponses, type AssetClassPropertyControllerUpdateData, type AssetClassPropertyControllerUpdateError, type AssetClassPropertyControllerUpdateErrors, type AssetClassPropertyControllerUpdateResponse, type AssetClassPropertyControllerUpdateResponses, type AssetClassPropertyResponseDto, type AssetClassResponseDto, type AssetControllerCreateAssetPublicData, type AssetControllerCreateAssetPublicError, type AssetControllerCreateAssetPublicErrors, type AssetControllerCreateAssetPublicResponse, type AssetControllerCreateAssetPublicResponses, type AssetControllerGetAssetData, type AssetControllerGetAssetError, type AssetControllerGetAssetErrors, type AssetControllerGetAssetResponse, type AssetControllerGetAssetResponses, type AssetControllerListAssetsData, type AssetControllerListAssetsError, type AssetControllerListAssetsErrors, type AssetControllerListAssetsResponse, type AssetControllerListAssetsResponses, type AssetControllerUpdateAssetData, type AssetControllerUpdateAssetError, type AssetControllerUpdateAssetErrors, type AssetControllerUpdateAssetResponse, type AssetControllerUpdateAssetResponses, type AssetDocumentControllerCreateData, type AssetDocumentControllerCreateError, type AssetDocumentControllerCreateErrors, type AssetDocumentControllerCreateResponse, type AssetDocumentControllerCreateResponses, type AssetDocumentControllerGetData, type AssetDocumentControllerGetError, type AssetDocumentControllerGetErrors, type AssetDocumentControllerGetResponse, type AssetDocumentControllerGetResponses, type AssetDocumentControllerListData, type AssetDocumentControllerListError, type AssetDocumentControllerListErrors, type AssetDocumentControllerListResponse, type AssetDocumentControllerListResponses, type AssetDocumentControllerRemoveData, type AssetDocumentControllerRemoveError, type AssetDocumentControllerRemoveErrors, type AssetDocumentControllerRemoveResponse, type AssetDocumentControllerRemoveResponses, type AssetDocumentControllerUpdateData, type AssetDocumentControllerUpdateError, type AssetDocumentControllerUpdateErrors, type AssetDocumentControllerUpdateResponse, type AssetDocumentControllerUpdateResponses, type AssetPropertyControllerDeleteAssetPropertyData, type AssetPropertyControllerDeleteAssetPropertyError, type AssetPropertyControllerDeleteAssetPropertyErrors, type AssetPropertyControllerDeleteAssetPropertyResponse, type AssetPropertyControllerDeleteAssetPropertyResponses, type AssetPropertyControllerUpdateAssetPropertyData, type AssetPropertyControllerUpdateAssetPropertyError, type AssetPropertyControllerUpdateAssetPropertyErrors, type AssetPropertyControllerUpdateAssetPropertyResponse, type AssetPropertyControllerUpdateAssetPropertyResponses, type AssetPropertyResponseDto, type AssetsResource, type ChecklistControllerGetChecklistData, type ChecklistControllerGetChecklistError, type ChecklistControllerGetChecklistErrors, type ChecklistControllerGetChecklistResponse, type ChecklistControllerGetChecklistResponses, type ChecklistControllerListChecklistsData, type ChecklistControllerListChecklistsError, type ChecklistControllerListChecklistsErrors, type ChecklistControllerListChecklistsResponse, type ChecklistControllerListChecklistsResponses, type ChecklistSummaryDto, type ClientOptions, type CompanyDocumentControllerCreateData, type CompanyDocumentControllerCreateError, type CompanyDocumentControllerCreateErrors, type CompanyDocumentControllerCreateResponse, type CompanyDocumentControllerCreateResponses, type CompanyDocumentControllerGetData, type CompanyDocumentControllerGetError, type CompanyDocumentControllerGetErrors, type CompanyDocumentControllerGetResponse, type CompanyDocumentControllerGetResponses, type CompanyDocumentControllerListData, type CompanyDocumentControllerListError, type CompanyDocumentControllerListErrors, type CompanyDocumentControllerListResponse, type CompanyDocumentControllerListResponses, type CompanyDocumentControllerRemoveData, type CompanyDocumentControllerRemoveError, type CompanyDocumentControllerRemoveErrors, type CompanyDocumentControllerRemoveResponse, type CompanyDocumentControllerRemoveResponses, type CompanyDocumentControllerUpdateData, type CompanyDocumentControllerUpdateError, type CompanyDocumentControllerUpdateErrors, type CompanyDocumentControllerUpdateResponse, type CompanyDocumentControllerUpdateResponses, type ConfigItemDto, type ConfigTableDto, type CreateAssetClassDto, type CreateConfigItemDto, type CreateDocumentDto, type CreateSiteDto, type CustomerDocumentControllerCreateData, type CustomerDocumentControllerCreateError, type CustomerDocumentControllerCreateErrors, type CustomerDocumentControllerCreateResponse, type CustomerDocumentControllerCreateResponses, type CustomerDocumentControllerGetData, type CustomerDocumentControllerGetError, type CustomerDocumentControllerGetErrors, type CustomerDocumentControllerGetResponse, type CustomerDocumentControllerGetResponses, type CustomerDocumentControllerListData, type CustomerDocumentControllerListError, type CustomerDocumentControllerListErrors, type CustomerDocumentControllerListResponse, type CustomerDocumentControllerListResponses, type CustomerDocumentControllerRemoveData, type CustomerDocumentControllerRemoveError, type CustomerDocumentControllerRemoveErrors, type CustomerDocumentControllerRemoveResponse, type CustomerDocumentControllerRemoveResponses, type CustomerDocumentControllerUpdateData, type CustomerDocumentControllerUpdateError, type CustomerDocumentControllerUpdateErrors, type CustomerDocumentControllerUpdateResponse, type CustomerDocumentControllerUpdateResponses, DEFAULT_BASE_URL, type DeleteAssetClassPropertyResponseDto, type DeleteAssetPropertyResponseDto, type DeleteDocumentResponseDto, type DeleteSiteResponseDto, type DeleteUserPropertyResponseDto, type DocumentResponseDto, type DocumentUploadControllerUploadUrlData, type DocumentUploadControllerUploadUrlError, type DocumentUploadControllerUploadUrlErrors, type DocumentUploadControllerUploadUrlResponse, type DocumentUploadControllerUploadUrlResponses, type DocumentUploadUrlDto, type DocumentUploadUrlResponseDto, type EmbeddedAssetClassPropertyDto, type EmbeddedAssetPropertyDto, type EmbeddedUserPropertyDto, type ErrorDetail, type InspectionControllerGetPublicInspectionData, type InspectionControllerGetPublicInspectionError, type InspectionControllerGetPublicInspectionErrors, type InspectionControllerGetPublicInspectionResponse, type InspectionControllerGetPublicInspectionResponses, type InspectionControllerListInspectionsData, type InspectionControllerListInspectionsError, type InspectionControllerListInspectionsErrors, type InspectionControllerListInspectionsResponse, type InspectionControllerListInspectionsResponses, type InspectionResponseDto, type InspectionsResource, type IssueControllerGetIssueHistoryPublicData, type IssueControllerGetIssueHistoryPublicError, type IssueControllerGetIssueHistoryPublicErrors, type IssueControllerGetIssueHistoryPublicResponse, type IssueControllerGetIssueHistoryPublicResponses, type IssueControllerGetIssuePublicData, type IssueControllerGetIssuePublicError, type IssueControllerGetIssuePublicErrors, type IssueControllerGetIssuePublicResponse, type IssueControllerGetIssuePublicResponses, type IssueControllerListIssuesData, type IssueControllerListIssuesError, type IssueControllerListIssuesErrors, type IssueControllerListIssuesResponse, type IssueControllerListIssuesResponses, type IssueControllerUpdateIssuePublicData, type IssueControllerUpdateIssuePublicError, type IssueControllerUpdateIssuePublicErrors, type IssueControllerUpdateIssuePublicResponse, type IssueControllerUpdateIssuePublicResponses, type IssueHistoryDto, type IssueHistoryResponseDto, type IssueResponseDto, type IssuesResource, type JobDocumentControllerCreateData, type JobDocumentControllerCreateError, type JobDocumentControllerCreateErrors, type JobDocumentControllerCreateResponse, type JobDocumentControllerCreateResponses, type JobDocumentControllerGetData, type JobDocumentControllerGetError, type JobDocumentControllerGetErrors, type JobDocumentControllerGetResponse, type JobDocumentControllerGetResponses, type JobDocumentControllerListData, type JobDocumentControllerListError, type JobDocumentControllerListErrors, type JobDocumentControllerListResponse, type JobDocumentControllerListResponses, type JobDocumentControllerRemoveData, type JobDocumentControllerRemoveError, type JobDocumentControllerRemoveErrors, type JobDocumentControllerRemoveResponse, type JobDocumentControllerRemoveResponses, type JobDocumentControllerUpdateData, type JobDocumentControllerUpdateError, type JobDocumentControllerUpdateErrors, type JobDocumentControllerUpdateResponse, type JobDocumentControllerUpdateResponses, type ListChecklistsResponseDto, type ListConfigItemsResponseDto, type ListConfigTablesResponseDto, type ListDocumentsResponseDto, type ListInspectionsResponseDto, type ListIssuesResponseDto, type ListSitesResponseDto, PACKAGE_NAME, PACKAGE_VERSION, type ProjectDocumentControllerCreateData, type ProjectDocumentControllerCreateError, type ProjectDocumentControllerCreateErrors, type ProjectDocumentControllerCreateResponse, type ProjectDocumentControllerCreateResponses, type ProjectDocumentControllerGetData, type ProjectDocumentControllerGetError, type ProjectDocumentControllerGetErrors, type ProjectDocumentControllerGetResponse, type ProjectDocumentControllerGetResponses, type ProjectDocumentControllerListData, type ProjectDocumentControllerListError, type ProjectDocumentControllerListErrors, type ProjectDocumentControllerListResponse, type ProjectDocumentControllerListResponses, type ProjectDocumentControllerRemoveData, type ProjectDocumentControllerRemoveError, type ProjectDocumentControllerRemoveErrors, type ProjectDocumentControllerRemoveResponse, type ProjectDocumentControllerRemoveResponses, type ProjectDocumentControllerUpdateData, type ProjectDocumentControllerUpdateError, type ProjectDocumentControllerUpdateErrors, type ProjectDocumentControllerUpdateResponse, type ProjectDocumentControllerUpdateResponses, type PublicConfigControllerCreateConfigItemData, type PublicConfigControllerCreateConfigItemError, type PublicConfigControllerCreateConfigItemErrors, type PublicConfigControllerCreateConfigItemResponse, type PublicConfigControllerCreateConfigItemResponses, type PublicConfigControllerDeleteConfigItemData, type PublicConfigControllerDeleteConfigItemError, type PublicConfigControllerDeleteConfigItemErrors, type PublicConfigControllerDeleteConfigItemResponse, type PublicConfigControllerDeleteConfigItemResponses, type PublicConfigControllerGetConfigItemData, type PublicConfigControllerGetConfigItemError, type PublicConfigControllerGetConfigItemErrors, type PublicConfigControllerGetConfigItemResponse, type PublicConfigControllerGetConfigItemResponses, type PublicConfigControllerListConfigItemsData, type PublicConfigControllerListConfigItemsError, type PublicConfigControllerListConfigItemsErrors, type PublicConfigControllerListConfigItemsResponse, type PublicConfigControllerListConfigItemsResponses, type PublicConfigControllerListConfigTablesData, type PublicConfigControllerListConfigTablesError, type PublicConfigControllerListConfigTablesErrors, type PublicConfigControllerListConfigTablesResponse, type PublicConfigControllerListConfigTablesResponses, type PublicConfigControllerUpdateConfigItemData, type PublicConfigControllerUpdateConfigItemError, type PublicConfigControllerUpdateConfigItemErrors, type PublicConfigControllerUpdateConfigItemResponse, type PublicConfigControllerUpdateConfigItemResponses, type PublicCreateAssetDto, type SiteControllerCreateSiteData, type SiteControllerCreateSiteError, type SiteControllerCreateSiteErrors, type SiteControllerCreateSiteResponse, type SiteControllerCreateSiteResponses, type SiteControllerDeleteSiteData, type SiteControllerDeleteSiteError, type SiteControllerDeleteSiteErrors, type SiteControllerDeleteSiteResponse, type SiteControllerDeleteSiteResponses, type SiteControllerListSitesData, type SiteControllerListSitesError, type SiteControllerListSitesErrors, type SiteControllerListSitesResponse, type SiteControllerListSitesResponses, type SiteControllerUpdateSiteData, type SiteControllerUpdateSiteError, type SiteControllerUpdateSiteErrors, type SiteControllerUpdateSiteResponse, type SiteControllerUpdateSiteResponses, type SiteDocumentControllerCreateData, type SiteDocumentControllerCreateError, type SiteDocumentControllerCreateErrors, type SiteDocumentControllerCreateResponse, type SiteDocumentControllerCreateResponses, type SiteDocumentControllerGetData, type SiteDocumentControllerGetError, type SiteDocumentControllerGetErrors, type SiteDocumentControllerGetResponse, type SiteDocumentControllerGetResponses, type SiteDocumentControllerListData, type SiteDocumentControllerListError, type SiteDocumentControllerListErrors, type SiteDocumentControllerListResponse, type SiteDocumentControllerListResponses, type SiteDocumentControllerRemoveData, type SiteDocumentControllerRemoveError, type SiteDocumentControllerRemoveErrors, type SiteDocumentControllerRemoveResponse, type SiteDocumentControllerRemoveResponses, type SiteDocumentControllerUpdateData, type SiteDocumentControllerUpdateError, type SiteDocumentControllerUpdateErrors, type SiteDocumentControllerUpdateResponse, type SiteDocumentControllerUpdateResponses, type SiteResponseDto, type SitesResource, type UpdateAssetClassDto, type UpdateAssetClassPropertyDto, type UpdateAssetDto, type UpdateAssetPropertyDto, type UpdateConfigItemDto, type UpdateDocumentDto, type UpdateIssueDto, type UpdateSiteDto, type UpdateUserPropertyDto, type UserControllerCreateUserData, type UserControllerCreateUserError, type UserControllerCreateUserErrors, type UserControllerCreateUserResponse, type UserControllerCreateUserResponses, type UserControllerGetUserData, type UserControllerGetUserError, type UserControllerGetUserErrors, type UserControllerGetUserResponse, type UserControllerGetUserResponses, type UserControllerListUsersData, type UserControllerListUsersError, type UserControllerListUsersErrors, type UserControllerListUsersResponse, type UserControllerListUsersResponses, type UserControllerUpdateUserData, type UserControllerUpdateUserError, type UserControllerUpdateUserErrors, type UserControllerUpdateUserResponse, type UserControllerUpdateUserResponses, type UserDocumentControllerCreateData, type UserDocumentControllerCreateError, type UserDocumentControllerCreateErrors, type UserDocumentControllerCreateResponse, type UserDocumentControllerCreateResponses, type UserDocumentControllerGetData, type UserDocumentControllerGetError, type UserDocumentControllerGetErrors, type UserDocumentControllerGetResponse, type UserDocumentControllerGetResponses, type UserDocumentControllerListData, type UserDocumentControllerListError, type UserDocumentControllerListErrors, type UserDocumentControllerListResponse, type UserDocumentControllerListResponses, type UserDocumentControllerRemoveData, type UserDocumentControllerRemoveError, type UserDocumentControllerRemoveErrors, type UserDocumentControllerRemoveResponse, type UserDocumentControllerRemoveResponses, type UserDocumentControllerUpdateData, type UserDocumentControllerUpdateError, type UserDocumentControllerUpdateErrors, type UserDocumentControllerUpdateResponse, type UserDocumentControllerUpdateResponses, type UserPropertiesResource, type UserPropertyControllerDeleteUserPropertyData, type UserPropertyControllerDeleteUserPropertyError, type UserPropertyControllerDeleteUserPropertyErrors, type UserPropertyControllerDeleteUserPropertyResponse, type UserPropertyControllerDeleteUserPropertyResponses, type UserPropertyControllerUpdateUserPropertyData, type UserPropertyControllerUpdateUserPropertyError, type UserPropertyControllerUpdateUserPropertyErrors, type UserPropertyControllerUpdateUserPropertyResponse, type UserPropertyControllerUpdateUserPropertyResponses, type UserPropertyResponseDto, type UserResponseDto, type UsersResource, WakataApiError, WakataAuthError, WakataClient, type WakataClientOptions, WakataConflictError, type WakataErrorEnvelope, WakataNotFoundError, WakataPermissionError, WakataRateLimitError, WakataServerError, WakataValidationError, generateIdempotencyKey, mapApiError };
|
|
9110
|
+
export { type ApiErrorBody, type ApiErrorDetail, type ApiErrorResponse, type AssetClassControllerCreateAssetClassData, type AssetClassControllerCreateAssetClassError, type AssetClassControllerCreateAssetClassErrors, type AssetClassControllerCreateAssetClassResponse, type AssetClassControllerCreateAssetClassResponses, type AssetClassControllerGetAssetClassListData, type AssetClassControllerGetAssetClassListError, type AssetClassControllerGetAssetClassListErrors, type AssetClassControllerGetAssetClassListResponse, type AssetClassControllerGetAssetClassListResponses, type AssetClassControllerUpdateAssetClassData, type AssetClassControllerUpdateAssetClassError, type AssetClassControllerUpdateAssetClassErrors, type AssetClassControllerUpdateAssetClassResponse, type AssetClassControllerUpdateAssetClassResponses, type AssetClassDocumentControllerCreateData, type AssetClassDocumentControllerCreateError, type AssetClassDocumentControllerCreateErrors, type AssetClassDocumentControllerCreateResponse, type AssetClassDocumentControllerCreateResponses, type AssetClassDocumentControllerGetData, type AssetClassDocumentControllerGetError, type AssetClassDocumentControllerGetErrors, type AssetClassDocumentControllerGetResponse, type AssetClassDocumentControllerGetResponses, type AssetClassDocumentControllerListData, type AssetClassDocumentControllerListError, type AssetClassDocumentControllerListErrors, type AssetClassDocumentControllerListResponse, type AssetClassDocumentControllerListResponses, type AssetClassDocumentControllerRemoveData, type AssetClassDocumentControllerRemoveError, type AssetClassDocumentControllerRemoveErrors, type AssetClassDocumentControllerRemoveResponse, type AssetClassDocumentControllerRemoveResponses, type AssetClassDocumentControllerUpdateData, type AssetClassDocumentControllerUpdateError, type AssetClassDocumentControllerUpdateErrors, type AssetClassDocumentControllerUpdateResponse, type AssetClassDocumentControllerUpdateResponses, type AssetClassListResponseDto, type AssetClassPropertyControllerRemoveData, type AssetClassPropertyControllerRemoveError, type AssetClassPropertyControllerRemoveErrors, type AssetClassPropertyControllerRemoveResponse, type AssetClassPropertyControllerRemoveResponses, type AssetClassPropertyControllerUpdateData, type AssetClassPropertyControllerUpdateError, type AssetClassPropertyControllerUpdateErrors, type AssetClassPropertyControllerUpdateResponse, type AssetClassPropertyControllerUpdateResponses, type AssetClassPropertyResponseDto, type AssetClassResponseDto, type AssetControllerCreateAssetPublicData, type AssetControllerCreateAssetPublicError, type AssetControllerCreateAssetPublicErrors, type AssetControllerCreateAssetPublicResponse, type AssetControllerCreateAssetPublicResponses, type AssetControllerGetAssetData, type AssetControllerGetAssetError, type AssetControllerGetAssetErrors, type AssetControllerGetAssetResponse, type AssetControllerGetAssetResponses, type AssetControllerListAssetsData, type AssetControllerListAssetsError, type AssetControllerListAssetsErrors, type AssetControllerListAssetsResponse, type AssetControllerListAssetsResponses, type AssetControllerUpdateAssetData, type AssetControllerUpdateAssetError, type AssetControllerUpdateAssetErrors, type AssetControllerUpdateAssetResponse, type AssetControllerUpdateAssetResponses, type AssetDocumentControllerCreateData, type AssetDocumentControllerCreateError, type AssetDocumentControllerCreateErrors, type AssetDocumentControllerCreateResponse, type AssetDocumentControllerCreateResponses, type AssetDocumentControllerGetData, type AssetDocumentControllerGetError, type AssetDocumentControllerGetErrors, type AssetDocumentControllerGetResponse, type AssetDocumentControllerGetResponses, type AssetDocumentControllerListData, type AssetDocumentControllerListError, type AssetDocumentControllerListErrors, type AssetDocumentControllerListResponse, type AssetDocumentControllerListResponses, type AssetDocumentControllerRemoveData, type AssetDocumentControllerRemoveError, type AssetDocumentControllerRemoveErrors, type AssetDocumentControllerRemoveResponse, type AssetDocumentControllerRemoveResponses, type AssetDocumentControllerUpdateData, type AssetDocumentControllerUpdateError, type AssetDocumentControllerUpdateErrors, type AssetDocumentControllerUpdateResponse, type AssetDocumentControllerUpdateResponses, type AssetPropertyControllerDeleteAssetPropertyData, type AssetPropertyControllerDeleteAssetPropertyError, type AssetPropertyControllerDeleteAssetPropertyErrors, type AssetPropertyControllerDeleteAssetPropertyResponse, type AssetPropertyControllerDeleteAssetPropertyResponses, type AssetPropertyControllerUpdateAssetPropertyData, type AssetPropertyControllerUpdateAssetPropertyError, type AssetPropertyControllerUpdateAssetPropertyErrors, type AssetPropertyControllerUpdateAssetPropertyResponse, type AssetPropertyControllerUpdateAssetPropertyResponses, type AssetPropertyResponseDto, type AssetsResource, type ChecklistControllerGetChecklistData, type ChecklistControllerGetChecklistError, type ChecklistControllerGetChecklistErrors, type ChecklistControllerGetChecklistResponse, type ChecklistControllerGetChecklistResponses, type ChecklistControllerListChecklistsData, type ChecklistControllerListChecklistsError, type ChecklistControllerListChecklistsErrors, type ChecklistControllerListChecklistsResponse, type ChecklistControllerListChecklistsResponses, type ChecklistSummaryDto, type ClientOptions, type CompanyDocumentControllerCreateData, type CompanyDocumentControllerCreateError, type CompanyDocumentControllerCreateErrors, type CompanyDocumentControllerCreateResponse, type CompanyDocumentControllerCreateResponses, type CompanyDocumentControllerGetData, type CompanyDocumentControllerGetError, type CompanyDocumentControllerGetErrors, type CompanyDocumentControllerGetResponse, type CompanyDocumentControllerGetResponses, type CompanyDocumentControllerListData, type CompanyDocumentControllerListError, type CompanyDocumentControllerListErrors, type CompanyDocumentControllerListResponse, type CompanyDocumentControllerListResponses, type CompanyDocumentControllerRemoveData, type CompanyDocumentControllerRemoveError, type CompanyDocumentControllerRemoveErrors, type CompanyDocumentControllerRemoveResponse, type CompanyDocumentControllerRemoveResponses, type CompanyDocumentControllerUpdateData, type CompanyDocumentControllerUpdateError, type CompanyDocumentControllerUpdateErrors, type CompanyDocumentControllerUpdateResponse, type CompanyDocumentControllerUpdateResponses, type ConfigItemDto, type ConfigTableDto, type CreateAssetClassDto, type CreateConfigItemDto, type CreateCustomerDto, type CreateDocumentDto, type CreateGroupDto, type CreateProjectDto, type CreateSiteDto, type CreateZoneDto, type CustomerControllerCreateData, type CustomerControllerCreateError, type CustomerControllerCreateErrors, type CustomerControllerCreateResponse, type CustomerControllerCreateResponses, type CustomerControllerDeleteData, type CustomerControllerDeleteError, type CustomerControllerDeleteErrors, type CustomerControllerDeleteResponse, type CustomerControllerDeleteResponses, type CustomerControllerGetData, type CustomerControllerGetError, type CustomerControllerGetErrors, type CustomerControllerGetResponse, type CustomerControllerGetResponses, type CustomerControllerListData, type CustomerControllerListError, type CustomerControllerListErrors, type CustomerControllerListResponse, type CustomerControllerListResponses, type CustomerControllerUpdateData, type CustomerControllerUpdateError, type CustomerControllerUpdateErrors, type CustomerControllerUpdateResponse, type CustomerControllerUpdateResponses, type CustomerDocumentControllerCreateData, type CustomerDocumentControllerCreateError, type CustomerDocumentControllerCreateErrors, type CustomerDocumentControllerCreateResponse, type CustomerDocumentControllerCreateResponses, type CustomerDocumentControllerGetData, type CustomerDocumentControllerGetError, type CustomerDocumentControllerGetErrors, type CustomerDocumentControllerGetResponse, type CustomerDocumentControllerGetResponses, type CustomerDocumentControllerListData, type CustomerDocumentControllerListError, type CustomerDocumentControllerListErrors, type CustomerDocumentControllerListResponse, type CustomerDocumentControllerListResponses, type CustomerDocumentControllerRemoveData, type CustomerDocumentControllerRemoveError, type CustomerDocumentControllerRemoveErrors, type CustomerDocumentControllerRemoveResponse, type CustomerDocumentControllerRemoveResponses, type CustomerDocumentControllerUpdateData, type CustomerDocumentControllerUpdateError, type CustomerDocumentControllerUpdateErrors, type CustomerDocumentControllerUpdateResponse, type CustomerDocumentControllerUpdateResponses, type CustomerResponseDto, DEFAULT_BASE_URL, type DeleteAssetClassPropertyResponseDto, type DeleteAssetPropertyResponseDto, type DeleteCustomerResponseDto, type DeleteDocumentResponseDto, type DeleteGroupResponseDto, type DeleteProjectResponseDto, type DeleteSiteResponseDto, type DeleteUserPropertyResponseDto, type DeleteZoneResponseDto, type DevicePublicControllerGetData, type DevicePublicControllerGetError, type DevicePublicControllerGetErrors, type DevicePublicControllerGetResponse, type DevicePublicControllerGetResponses, type DevicePublicControllerListData, type DevicePublicControllerListError, type DevicePublicControllerListErrors, type DevicePublicControllerListResponse, type DevicePublicControllerListResponses, type DeviceResponseDto, type DocumentResponseDto, type DocumentUploadControllerUploadUrlData, type DocumentUploadControllerUploadUrlError, type DocumentUploadControllerUploadUrlErrors, type DocumentUploadControllerUploadUrlResponse, type DocumentUploadControllerUploadUrlResponses, type DocumentUploadUrlDto, type DocumentUploadUrlResponseDto, type EmbeddedAssetClassPropertyDto, type EmbeddedAssetPropertyDto, type EmbeddedCustomerPropertyDto, type EmbeddedProjectPropertyDto, type EmbeddedUserPropertyDto, type ErrorDetail, type GroupControllerCreateData, type GroupControllerCreateError, type GroupControllerCreateErrors, type GroupControllerCreateResponse, type GroupControllerCreateResponses, type GroupControllerDeleteData, type GroupControllerDeleteError, type GroupControllerDeleteErrors, type GroupControllerDeleteResponse, type GroupControllerDeleteResponses, type GroupControllerGetData, type GroupControllerGetError, type GroupControllerGetErrors, type GroupControllerGetResponse, type GroupControllerGetResponses, type GroupControllerListData, type GroupControllerListError, type GroupControllerListErrors, type GroupControllerListResponse, type GroupControllerListResponses, type GroupControllerUpdateData, type GroupControllerUpdateError, type GroupControllerUpdateErrors, type GroupControllerUpdateResponse, type GroupControllerUpdateResponses, type GroupResponseDto, type InspectionControllerGetPublicInspectionData, type InspectionControllerGetPublicInspectionError, type InspectionControllerGetPublicInspectionErrors, type InspectionControllerGetPublicInspectionResponse, type InspectionControllerGetPublicInspectionResponses, type InspectionControllerListInspectionsData, type InspectionControllerListInspectionsError, type InspectionControllerListInspectionsErrors, type InspectionControllerListInspectionsResponse, type InspectionControllerListInspectionsResponses, type InspectionResponseDto, type InspectionsResource, type IssueControllerGetIssueHistoryPublicData, type IssueControllerGetIssueHistoryPublicError, type IssueControllerGetIssueHistoryPublicErrors, type IssueControllerGetIssueHistoryPublicResponse, type IssueControllerGetIssueHistoryPublicResponses, type IssueControllerGetIssuePublicData, type IssueControllerGetIssuePublicError, type IssueControllerGetIssuePublicErrors, type IssueControllerGetIssuePublicResponse, type IssueControllerGetIssuePublicResponses, type IssueControllerListIssuesData, type IssueControllerListIssuesError, type IssueControllerListIssuesErrors, type IssueControllerListIssuesResponse, type IssueControllerListIssuesResponses, type IssueControllerUpdateIssuePublicData, type IssueControllerUpdateIssuePublicError, type IssueControllerUpdateIssuePublicErrors, type IssueControllerUpdateIssuePublicResponse, type IssueControllerUpdateIssuePublicResponses, type IssueHistoryDto, type IssueHistoryResponseDto, type IssueResponseDto, type IssuesResource, type JobDocumentControllerCreateData, type JobDocumentControllerCreateError, type JobDocumentControllerCreateErrors, type JobDocumentControllerCreateResponse, type JobDocumentControllerCreateResponses, type JobDocumentControllerGetData, type JobDocumentControllerGetError, type JobDocumentControllerGetErrors, type JobDocumentControllerGetResponse, type JobDocumentControllerGetResponses, type JobDocumentControllerListData, type JobDocumentControllerListError, type JobDocumentControllerListErrors, type JobDocumentControllerListResponse, type JobDocumentControllerListResponses, type JobDocumentControllerRemoveData, type JobDocumentControllerRemoveError, type JobDocumentControllerRemoveErrors, type JobDocumentControllerRemoveResponse, type JobDocumentControllerRemoveResponses, type JobDocumentControllerUpdateData, type JobDocumentControllerUpdateError, type JobDocumentControllerUpdateErrors, type JobDocumentControllerUpdateResponse, type JobDocumentControllerUpdateResponses, type ListChecklistsResponseDto, type ListConfigItemsResponseDto, type ListConfigTablesResponseDto, type ListCustomersResponseDto, type ListDevicesResponseDto, type ListDocumentsResponseDto, type ListGroupsResponseDto, type ListInspectionsResponseDto, type ListIssuesResponseDto, type ListProjectAssetsResponseDto, type ListProjectUsersResponseDto, type ListProjectsResponseDto, type ListSitesResponseDto, type ListTimesheetsResponseDto, type ListZonesResponseDto, PACKAGE_NAME, PACKAGE_VERSION, type ProjectAssetDto, type ProjectControllerCreateData, type ProjectControllerCreateError, type ProjectControllerCreateErrors, type ProjectControllerCreateResponse, type ProjectControllerCreateResponses, type ProjectControllerDeleteData, type ProjectControllerDeleteError, type ProjectControllerDeleteErrors, type ProjectControllerDeleteResponse, type ProjectControllerDeleteResponses, type ProjectControllerGetData, type ProjectControllerGetError, type ProjectControllerGetErrors, type ProjectControllerGetResponse, type ProjectControllerGetResponses, type ProjectControllerListAssetsData, type ProjectControllerListAssetsError, type ProjectControllerListAssetsErrors, type ProjectControllerListAssetsResponse, type ProjectControllerListAssetsResponses, type ProjectControllerListData, type ProjectControllerListError, type ProjectControllerListErrors, type ProjectControllerListResponse, type ProjectControllerListResponses, type ProjectControllerListUsersData, type ProjectControllerListUsersError, type ProjectControllerListUsersErrors, type ProjectControllerListUsersResponse, type ProjectControllerListUsersResponses, type ProjectControllerUpdateData, type ProjectControllerUpdateError, type ProjectControllerUpdateErrors, type ProjectControllerUpdateResponse, type ProjectControllerUpdateResponses, type ProjectDocumentControllerCreateData, type ProjectDocumentControllerCreateError, type ProjectDocumentControllerCreateErrors, type ProjectDocumentControllerCreateResponse, type ProjectDocumentControllerCreateResponses, type ProjectDocumentControllerGetData, type ProjectDocumentControllerGetError, type ProjectDocumentControllerGetErrors, type ProjectDocumentControllerGetResponse, type ProjectDocumentControllerGetResponses, type ProjectDocumentControllerListData, type ProjectDocumentControllerListError, type ProjectDocumentControllerListErrors, type ProjectDocumentControllerListResponse, type ProjectDocumentControllerListResponses, type ProjectDocumentControllerRemoveData, type ProjectDocumentControllerRemoveError, type ProjectDocumentControllerRemoveErrors, type ProjectDocumentControllerRemoveResponse, type ProjectDocumentControllerRemoveResponses, type ProjectDocumentControllerUpdateData, type ProjectDocumentControllerUpdateError, type ProjectDocumentControllerUpdateErrors, type ProjectDocumentControllerUpdateResponse, type ProjectDocumentControllerUpdateResponses, type ProjectResponseDto, type ProjectUserDto, type PublicConfigControllerCreateConfigItemData, type PublicConfigControllerCreateConfigItemError, type PublicConfigControllerCreateConfigItemErrors, type PublicConfigControllerCreateConfigItemResponse, type PublicConfigControllerCreateConfigItemResponses, type PublicConfigControllerDeleteConfigItemData, type PublicConfigControllerDeleteConfigItemError, type PublicConfigControllerDeleteConfigItemErrors, type PublicConfigControllerDeleteConfigItemResponse, type PublicConfigControllerDeleteConfigItemResponses, type PublicConfigControllerGetConfigItemData, type PublicConfigControllerGetConfigItemError, type PublicConfigControllerGetConfigItemErrors, type PublicConfigControllerGetConfigItemResponse, type PublicConfigControllerGetConfigItemResponses, type PublicConfigControllerListConfigItemsData, type PublicConfigControllerListConfigItemsError, type PublicConfigControllerListConfigItemsErrors, type PublicConfigControllerListConfigItemsResponse, type PublicConfigControllerListConfigItemsResponses, type PublicConfigControllerListConfigTablesData, type PublicConfigControllerListConfigTablesError, type PublicConfigControllerListConfigTablesErrors, type PublicConfigControllerListConfigTablesResponse, type PublicConfigControllerListConfigTablesResponses, type PublicConfigControllerUpdateConfigItemData, type PublicConfigControllerUpdateConfigItemError, type PublicConfigControllerUpdateConfigItemErrors, type PublicConfigControllerUpdateConfigItemResponse, type PublicConfigControllerUpdateConfigItemResponses, type PublicCreateAssetDto, type SiteControllerCreateSiteData, type SiteControllerCreateSiteError, type SiteControllerCreateSiteErrors, type SiteControllerCreateSiteResponse, type SiteControllerCreateSiteResponses, type SiteControllerDeleteSiteData, type SiteControllerDeleteSiteError, type SiteControllerDeleteSiteErrors, type SiteControllerDeleteSiteResponse, type SiteControllerDeleteSiteResponses, type SiteControllerListSitesData, type SiteControllerListSitesError, type SiteControllerListSitesErrors, type SiteControllerListSitesResponse, type SiteControllerListSitesResponses, type SiteControllerUpdateSiteData, type SiteControllerUpdateSiteError, type SiteControllerUpdateSiteErrors, type SiteControllerUpdateSiteResponse, type SiteControllerUpdateSiteResponses, type SiteDocumentControllerCreateData, type SiteDocumentControllerCreateError, type SiteDocumentControllerCreateErrors, type SiteDocumentControllerCreateResponse, type SiteDocumentControllerCreateResponses, type SiteDocumentControllerGetData, type SiteDocumentControllerGetError, type SiteDocumentControllerGetErrors, type SiteDocumentControllerGetResponse, type SiteDocumentControllerGetResponses, type SiteDocumentControllerListData, type SiteDocumentControllerListError, type SiteDocumentControllerListErrors, type SiteDocumentControllerListResponse, type SiteDocumentControllerListResponses, type SiteDocumentControllerRemoveData, type SiteDocumentControllerRemoveError, type SiteDocumentControllerRemoveErrors, type SiteDocumentControllerRemoveResponse, type SiteDocumentControllerRemoveResponses, type SiteDocumentControllerUpdateData, type SiteDocumentControllerUpdateError, type SiteDocumentControllerUpdateErrors, type SiteDocumentControllerUpdateResponse, type SiteDocumentControllerUpdateResponses, type SiteResponseDto, type SitesResource, type TimesheetDetailDto, type TimesheetLineDto, type TimesheetPublicControllerGetData, type TimesheetPublicControllerGetError, type TimesheetPublicControllerGetErrors, type TimesheetPublicControllerGetResponse, type TimesheetPublicControllerGetResponses, type TimesheetPublicControllerListData, type TimesheetPublicControllerListError, type TimesheetPublicControllerListErrors, type TimesheetPublicControllerListResponse, type TimesheetPublicControllerListResponses, type TimesheetSummaryDto, type UpdateAssetClassDto, type UpdateAssetClassPropertyDto, type UpdateAssetDto, type UpdateAssetPropertyDto, type UpdateConfigItemDto, type UpdateCustomerDto, type UpdateDocumentDto, type UpdateGroupDto, type UpdateIssueDto, type UpdateProjectDto, type UpdateSiteDto, type UpdateUserPropertyDto, type UpdateZoneDto, type UserControllerCreateUserData, type UserControllerCreateUserError, type UserControllerCreateUserErrors, type UserControllerCreateUserResponse, type UserControllerCreateUserResponses, type UserControllerGetUserData, type UserControllerGetUserError, type UserControllerGetUserErrors, type UserControllerGetUserResponse, type UserControllerGetUserResponses, type UserControllerListUsersData, type UserControllerListUsersError, type UserControllerListUsersErrors, type UserControllerListUsersResponse, type UserControllerListUsersResponses, type UserControllerUpdateUserData, type UserControllerUpdateUserError, type UserControllerUpdateUserErrors, type UserControllerUpdateUserResponse, type UserControllerUpdateUserResponses, type UserDocumentControllerCreateData, type UserDocumentControllerCreateError, type UserDocumentControllerCreateErrors, type UserDocumentControllerCreateResponse, type UserDocumentControllerCreateResponses, type UserDocumentControllerGetData, type UserDocumentControllerGetError, type UserDocumentControllerGetErrors, type UserDocumentControllerGetResponse, type UserDocumentControllerGetResponses, type UserDocumentControllerListData, type UserDocumentControllerListError, type UserDocumentControllerListErrors, type UserDocumentControllerListResponse, type UserDocumentControllerListResponses, type UserDocumentControllerRemoveData, type UserDocumentControllerRemoveError, type UserDocumentControllerRemoveErrors, type UserDocumentControllerRemoveResponse, type UserDocumentControllerRemoveResponses, type UserDocumentControllerUpdateData, type UserDocumentControllerUpdateError, type UserDocumentControllerUpdateErrors, type UserDocumentControllerUpdateResponse, type UserDocumentControllerUpdateResponses, type UserPropertiesResource, type UserPropertyControllerDeleteUserPropertyData, type UserPropertyControllerDeleteUserPropertyError, type UserPropertyControllerDeleteUserPropertyErrors, type UserPropertyControllerDeleteUserPropertyResponse, type UserPropertyControllerDeleteUserPropertyResponses, type UserPropertyControllerUpdateUserPropertyData, type UserPropertyControllerUpdateUserPropertyError, type UserPropertyControllerUpdateUserPropertyErrors, type UserPropertyControllerUpdateUserPropertyResponse, type UserPropertyControllerUpdateUserPropertyResponses, type UserPropertyResponseDto, type UserResponseDto, type UsersResource, WakataApiError, WakataAuthError, WakataClient, type WakataClientOptions, WakataConflictError, type WakataErrorEnvelope, WakataNotFoundError, WakataPermissionError, WakataRateLimitError, WakataServerError, WakataValidationError, type ZoneControllerCreateData, type ZoneControllerCreateError, type ZoneControllerCreateErrors, type ZoneControllerCreateResponse, type ZoneControllerCreateResponses, type ZoneControllerDeleteData, type ZoneControllerDeleteError, type ZoneControllerDeleteErrors, type ZoneControllerDeleteResponse, type ZoneControllerDeleteResponses, type ZoneControllerGetData, type ZoneControllerGetError, type ZoneControllerGetErrors, type ZoneControllerGetResponse, type ZoneControllerGetResponses, type ZoneControllerListData, type ZoneControllerListError, type ZoneControllerListErrors, type ZoneControllerListResponse, type ZoneControllerListResponses, type ZoneControllerUpdateData, type ZoneControllerUpdateError, type ZoneControllerUpdateErrors, type ZoneControllerUpdateResponse, type ZoneControllerUpdateResponses, type ZoneResponseDto, generateIdempotencyKey, mapApiError };
|