@wakata-dev/api-client 0.3.1 → 0.3.3
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 +660 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2543 -87
- package/dist/index.d.ts +2543 -87
- package/dist/index.js +660 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -66,6 +66,46 @@ type AssetClassListResponseDto = {
|
|
|
66
66
|
*/
|
|
67
67
|
total_pages: number;
|
|
68
68
|
};
|
|
69
|
+
type AssetClassPropertyResponseDto = {
|
|
70
|
+
/**
|
|
71
|
+
* Asset class property value-row ID
|
|
72
|
+
*/
|
|
73
|
+
id: string;
|
|
74
|
+
/**
|
|
75
|
+
* Asset class ID
|
|
76
|
+
*/
|
|
77
|
+
asset_class_id: string;
|
|
78
|
+
/**
|
|
79
|
+
* Field-definition ID (config_items.id)
|
|
80
|
+
*/
|
|
81
|
+
property_id: string;
|
|
82
|
+
/**
|
|
83
|
+
* Text value
|
|
84
|
+
*/
|
|
85
|
+
text_value: {
|
|
86
|
+
[key: string]: unknown;
|
|
87
|
+
} | null;
|
|
88
|
+
/**
|
|
89
|
+
* Numeric value
|
|
90
|
+
*/
|
|
91
|
+
numeric_value: {
|
|
92
|
+
[key: string]: unknown;
|
|
93
|
+
} | null;
|
|
94
|
+
/**
|
|
95
|
+
* Date value
|
|
96
|
+
*/
|
|
97
|
+
date_value: {
|
|
98
|
+
[key: string]: unknown;
|
|
99
|
+
} | null;
|
|
100
|
+
/**
|
|
101
|
+
* How the value was last set
|
|
102
|
+
*/
|
|
103
|
+
update_method: {
|
|
104
|
+
[key: string]: unknown;
|
|
105
|
+
} | null;
|
|
106
|
+
created_at: string;
|
|
107
|
+
updated_at: string;
|
|
108
|
+
};
|
|
69
109
|
type AssetClassResponseDto = {
|
|
70
110
|
/**
|
|
71
111
|
* Asset class public ID (UUID)
|
|
@@ -92,11 +132,17 @@ type AssetClassResponseDto = {
|
|
|
92
132
|
[key: string]: unknown;
|
|
93
133
|
};
|
|
94
134
|
/**
|
|
95
|
-
* Asset class photo file path
|
|
135
|
+
* Asset class photo file path (S3 key)
|
|
96
136
|
*/
|
|
97
137
|
asset_class_photo_file?: {
|
|
98
138
|
[key: string]: unknown;
|
|
99
139
|
};
|
|
140
|
+
/**
|
|
141
|
+
* Signed CloudFront URL for the asset class photo (≈1h lifetime), or null if no photo / signing not configured.
|
|
142
|
+
*/
|
|
143
|
+
asset_class_photo_url?: {
|
|
144
|
+
[key: string]: unknown;
|
|
145
|
+
};
|
|
100
146
|
/**
|
|
101
147
|
* Asset class photo info
|
|
102
148
|
*/
|
|
@@ -342,6 +388,36 @@ type CreateConfigItemDto = {
|
|
|
342
388
|
*/
|
|
343
389
|
description?: string;
|
|
344
390
|
};
|
|
391
|
+
type CreateDocumentDto = {
|
|
392
|
+
/**
|
|
393
|
+
* Parent entity publicId (UUID) the document belongs to. Required for all types except company documents (which are scoped to your company).
|
|
394
|
+
*/
|
|
395
|
+
parent_id?: string;
|
|
396
|
+
/**
|
|
397
|
+
* Document type id (config_items.id, numeric string)
|
|
398
|
+
*/
|
|
399
|
+
document_type_id: string;
|
|
400
|
+
/**
|
|
401
|
+
* Document name
|
|
402
|
+
*/
|
|
403
|
+
name: string;
|
|
404
|
+
/**
|
|
405
|
+
* External identifier / reference number
|
|
406
|
+
*/
|
|
407
|
+
identifier?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Issued-on date (ISO)
|
|
410
|
+
*/
|
|
411
|
+
issued_on?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Expiry date (ISO)
|
|
414
|
+
*/
|
|
415
|
+
expires_on?: string;
|
|
416
|
+
/**
|
|
417
|
+
* S3 key of the uploaded file (from POST /document/upload-url). Omit for a metadata-only document.
|
|
418
|
+
*/
|
|
419
|
+
attachment_file?: string;
|
|
420
|
+
};
|
|
345
421
|
type CreateSiteDto = {
|
|
346
422
|
/**
|
|
347
423
|
* Site name
|
|
@@ -372,6 +448,13 @@ type CreateSiteDto = {
|
|
|
372
448
|
*/
|
|
373
449
|
public_id?: string;
|
|
374
450
|
};
|
|
451
|
+
type DeleteAssetClassPropertyResponseDto = {
|
|
452
|
+
message: string;
|
|
453
|
+
/**
|
|
454
|
+
* Deleted asset class property ID
|
|
455
|
+
*/
|
|
456
|
+
id: string;
|
|
457
|
+
};
|
|
375
458
|
type DeleteAssetPropertyResponseDto = {
|
|
376
459
|
/**
|
|
377
460
|
* Success message
|
|
@@ -382,6 +465,10 @@ type DeleteAssetPropertyResponseDto = {
|
|
|
382
465
|
*/
|
|
383
466
|
id: string;
|
|
384
467
|
};
|
|
468
|
+
type DeleteDocumentResponseDto = {
|
|
469
|
+
message: string;
|
|
470
|
+
id: string;
|
|
471
|
+
};
|
|
385
472
|
type DeleteSiteResponseDto = {
|
|
386
473
|
/**
|
|
387
474
|
* Success message
|
|
@@ -402,6 +489,86 @@ type DeleteUserPropertyResponseDto = {
|
|
|
402
489
|
*/
|
|
403
490
|
id: string;
|
|
404
491
|
};
|
|
492
|
+
type DocumentResponseDto = {
|
|
493
|
+
/**
|
|
494
|
+
* Document ID
|
|
495
|
+
*/
|
|
496
|
+
id: string;
|
|
497
|
+
/**
|
|
498
|
+
* Parent entity publicId (UUID)
|
|
499
|
+
*/
|
|
500
|
+
parent_id: {
|
|
501
|
+
[key: string]: unknown;
|
|
502
|
+
};
|
|
503
|
+
/**
|
|
504
|
+
* Company ID
|
|
505
|
+
*/
|
|
506
|
+
company_id: string;
|
|
507
|
+
/**
|
|
508
|
+
* Document type id
|
|
509
|
+
*/
|
|
510
|
+
document_type_id: string;
|
|
511
|
+
/**
|
|
512
|
+
* Document type name
|
|
513
|
+
*/
|
|
514
|
+
document_type_name: {
|
|
515
|
+
[key: string]: unknown;
|
|
516
|
+
} | null;
|
|
517
|
+
name: string;
|
|
518
|
+
identifier: {
|
|
519
|
+
[key: string]: unknown;
|
|
520
|
+
} | null;
|
|
521
|
+
issued_on: {
|
|
522
|
+
[key: string]: unknown;
|
|
523
|
+
} | null;
|
|
524
|
+
expires_on: {
|
|
525
|
+
[key: string]: unknown;
|
|
526
|
+
} | null;
|
|
527
|
+
/**
|
|
528
|
+
* S3 key of the attachment
|
|
529
|
+
*/
|
|
530
|
+
attachment_file: {
|
|
531
|
+
[key: string]: unknown;
|
|
532
|
+
} | null;
|
|
533
|
+
/**
|
|
534
|
+
* Signed CloudFront URL for the attachment (~1h), or null
|
|
535
|
+
*/
|
|
536
|
+
attachment_url: {
|
|
537
|
+
[key: string]: unknown;
|
|
538
|
+
} | null;
|
|
539
|
+
/**
|
|
540
|
+
* Current approval status (asset & user documents only), else null
|
|
541
|
+
*/
|
|
542
|
+
approval_status: {
|
|
543
|
+
[key: string]: unknown;
|
|
544
|
+
} | null;
|
|
545
|
+
created_at: string;
|
|
546
|
+
updated_at: string;
|
|
547
|
+
};
|
|
548
|
+
type DocumentUploadUrlDto = {
|
|
549
|
+
/**
|
|
550
|
+
* Original file name
|
|
551
|
+
*/
|
|
552
|
+
filename: string;
|
|
553
|
+
/**
|
|
554
|
+
* MIME type
|
|
555
|
+
*/
|
|
556
|
+
content_type?: string;
|
|
557
|
+
};
|
|
558
|
+
type DocumentUploadUrlResponseDto = {
|
|
559
|
+
/**
|
|
560
|
+
* Presigned S3 PUT URL — upload the file here
|
|
561
|
+
*/
|
|
562
|
+
upload_url: string;
|
|
563
|
+
/**
|
|
564
|
+
* Object key — pass as attachment_file when creating the document
|
|
565
|
+
*/
|
|
566
|
+
key: string;
|
|
567
|
+
/**
|
|
568
|
+
* Seconds until the URL expires
|
|
569
|
+
*/
|
|
570
|
+
expires_in: number;
|
|
571
|
+
};
|
|
405
572
|
type EmbeddedAssetClassPropertyDto = {
|
|
406
573
|
/**
|
|
407
574
|
* Custom field-definition ID (config_items.id). String (BigInt-safe).
|
|
@@ -1032,6 +1199,13 @@ type ListConfigTablesResponseDto = {
|
|
|
1032
1199
|
total: number;
|
|
1033
1200
|
total_pages: number;
|
|
1034
1201
|
};
|
|
1202
|
+
type ListDocumentsResponseDto = {
|
|
1203
|
+
data: Array<DocumentResponseDto>;
|
|
1204
|
+
page: number;
|
|
1205
|
+
per_page: number;
|
|
1206
|
+
total: number;
|
|
1207
|
+
total_pages: number;
|
|
1208
|
+
};
|
|
1035
1209
|
type ListInspectionsResponseDto = {
|
|
1036
1210
|
/**
|
|
1037
1211
|
* List of inspections
|
|
@@ -1212,6 +1386,14 @@ type UpdateAssetClassDto = {
|
|
|
1212
1386
|
*/
|
|
1213
1387
|
on_the_fly_enabled?: boolean;
|
|
1214
1388
|
};
|
|
1389
|
+
type UpdateAssetClassPropertyDto = {
|
|
1390
|
+
/**
|
|
1391
|
+
* Property value (string, number, or date depending on the property type defined in config_items).
|
|
1392
|
+
*/
|
|
1393
|
+
value: {
|
|
1394
|
+
[key: string]: unknown;
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1215
1397
|
type UpdateAssetDto = {
|
|
1216
1398
|
/**
|
|
1217
1399
|
* Asset number
|
|
@@ -1262,6 +1444,38 @@ type UpdateConfigItemDto = {
|
|
|
1262
1444
|
[key: string]: unknown;
|
|
1263
1445
|
} | null;
|
|
1264
1446
|
};
|
|
1447
|
+
type UpdateDocumentDto = {
|
|
1448
|
+
/**
|
|
1449
|
+
* Document name
|
|
1450
|
+
*/
|
|
1451
|
+
name?: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* Document type id (numeric string)
|
|
1454
|
+
*/
|
|
1455
|
+
document_type_id?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* External identifier
|
|
1458
|
+
*/
|
|
1459
|
+
identifier?: {
|
|
1460
|
+
[key: string]: unknown;
|
|
1461
|
+
} | null;
|
|
1462
|
+
/**
|
|
1463
|
+
* Issued-on date (ISO)
|
|
1464
|
+
*/
|
|
1465
|
+
issued_on?: {
|
|
1466
|
+
[key: string]: unknown;
|
|
1467
|
+
} | null;
|
|
1468
|
+
/**
|
|
1469
|
+
* Expiry date (ISO)
|
|
1470
|
+
*/
|
|
1471
|
+
expires_on?: {
|
|
1472
|
+
[key: string]: unknown;
|
|
1473
|
+
} | null;
|
|
1474
|
+
/**
|
|
1475
|
+
* Replacement S3 key (from /document/upload-url)
|
|
1476
|
+
*/
|
|
1477
|
+
attachment_file?: string;
|
|
1478
|
+
};
|
|
1265
1479
|
type UpdateIssueDto = {
|
|
1266
1480
|
/**
|
|
1267
1481
|
* Issue title
|
|
@@ -1559,6 +1773,10 @@ type AssetControllerCreateAssetPublicResponses = {
|
|
|
1559
1773
|
companyId?: string;
|
|
1560
1774
|
assetPhotoFile?: string | null;
|
|
1561
1775
|
assetPhotoInfo?: string | null;
|
|
1776
|
+
/**
|
|
1777
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1778
|
+
*/
|
|
1779
|
+
asset_photo_url?: string | null;
|
|
1562
1780
|
lat?: number | null;
|
|
1563
1781
|
lng?: number | null;
|
|
1564
1782
|
createdById?: string;
|
|
@@ -1658,6 +1876,10 @@ type AssetControllerListAssetsResponses = {
|
|
|
1658
1876
|
companyId?: string;
|
|
1659
1877
|
assetPhotoFile?: string | null;
|
|
1660
1878
|
assetPhotoInfo?: string | null;
|
|
1879
|
+
/**
|
|
1880
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1881
|
+
*/
|
|
1882
|
+
asset_photo_url?: string | null;
|
|
1661
1883
|
lat?: number | null;
|
|
1662
1884
|
lng?: number | null;
|
|
1663
1885
|
createdById?: string;
|
|
@@ -1728,6 +1950,10 @@ type AssetControllerGetAssetResponses = {
|
|
|
1728
1950
|
companyId?: string;
|
|
1729
1951
|
assetPhotoFile?: string | null;
|
|
1730
1952
|
assetPhotoInfo?: string | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
1955
|
+
*/
|
|
1956
|
+
asset_photo_url?: string | null;
|
|
1731
1957
|
lat?: number | null;
|
|
1732
1958
|
lng?: number | null;
|
|
1733
1959
|
createdById?: string;
|
|
@@ -1808,6 +2034,10 @@ type AssetControllerUpdateAssetResponses = {
|
|
|
1808
2034
|
companyId?: string;
|
|
1809
2035
|
assetPhotoFile?: string | null;
|
|
1810
2036
|
assetPhotoInfo?: string | null;
|
|
2037
|
+
/**
|
|
2038
|
+
* Signed CloudFront URL for the asset photo (assetPhotoFile is the S3 key). ~1h lifetime; null if no photo / signing not configured.
|
|
2039
|
+
*/
|
|
2040
|
+
asset_photo_url?: string | null;
|
|
1811
2041
|
lat?: number | null;
|
|
1812
2042
|
lng?: number | null;
|
|
1813
2043
|
createdById?: string;
|
|
@@ -3516,54 +3746,18 @@ type PublicConfigControllerCreateConfigItemResponses = {
|
|
|
3516
3746
|
201: ConfigItemDto;
|
|
3517
3747
|
};
|
|
3518
3748
|
type PublicConfigControllerCreateConfigItemResponse = PublicConfigControllerCreateConfigItemResponses[keyof PublicConfigControllerCreateConfigItemResponses];
|
|
3519
|
-
type
|
|
3749
|
+
type AssetClassPropertyControllerRemoveData = {
|
|
3520
3750
|
body?: never;
|
|
3521
|
-
path
|
|
3522
|
-
query?: {
|
|
3523
|
-
/**
|
|
3524
|
-
* Number of results per page (default: 15)
|
|
3525
|
-
*/
|
|
3526
|
-
per_page?: number;
|
|
3527
|
-
/**
|
|
3528
|
-
* Page number (default: 1)
|
|
3529
|
-
*/
|
|
3530
|
-
page?: number;
|
|
3531
|
-
/**
|
|
3532
|
-
* Sort direction (default: asc)
|
|
3533
|
-
*/
|
|
3534
|
-
direction?: 'asc' | 'desc';
|
|
3535
|
-
/**
|
|
3536
|
-
* Field to sort by (name, created_at, updated_at, category)
|
|
3537
|
-
*/
|
|
3538
|
-
sort?: string;
|
|
3539
|
-
/**
|
|
3540
|
-
* Filter by site name (partial match)
|
|
3541
|
-
*/
|
|
3542
|
-
site_name?: string;
|
|
3543
|
-
/**
|
|
3544
|
-
* Filter by site category name
|
|
3545
|
-
*/
|
|
3546
|
-
site_category?: string;
|
|
3547
|
-
/**
|
|
3548
|
-
* BigInt as string. IDs are stringified at the serialization boundary.
|
|
3549
|
-
*/
|
|
3550
|
-
site_category_id?: string;
|
|
3551
|
-
/**
|
|
3552
|
-
* Return sites modified since the date provided
|
|
3553
|
-
*/
|
|
3554
|
-
date_modified_from?: string;
|
|
3751
|
+
path: {
|
|
3555
3752
|
/**
|
|
3556
|
-
*
|
|
3753
|
+
* Asset class property value-row ID (numeric string)
|
|
3557
3754
|
*/
|
|
3558
|
-
|
|
3755
|
+
id: string;
|
|
3559
3756
|
};
|
|
3560
|
-
|
|
3757
|
+
query?: never;
|
|
3758
|
+
url: '/asset-class-property/{id}';
|
|
3561
3759
|
};
|
|
3562
|
-
type
|
|
3563
|
-
/**
|
|
3564
|
-
* 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`.
|
|
3565
|
-
*/
|
|
3566
|
-
400: ApiErrorResponse;
|
|
3760
|
+
type AssetClassPropertyControllerRemoveErrors = {
|
|
3567
3761
|
/**
|
|
3568
3762
|
* 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.
|
|
3569
3763
|
*/
|
|
@@ -3572,6 +3766,10 @@ type SiteControllerListSitesErrors = {
|
|
|
3572
3766
|
* 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).
|
|
3573
3767
|
*/
|
|
3574
3768
|
403: ApiErrorResponse;
|
|
3769
|
+
/**
|
|
3770
|
+
* 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.
|
|
3771
|
+
*/
|
|
3772
|
+
404: ApiErrorResponse;
|
|
3575
3773
|
/**
|
|
3576
3774
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3577
3775
|
*/
|
|
@@ -3581,30 +3779,32 @@ type SiteControllerListSitesErrors = {
|
|
|
3581
3779
|
*/
|
|
3582
3780
|
500: ApiErrorResponse;
|
|
3583
3781
|
};
|
|
3584
|
-
type
|
|
3585
|
-
type
|
|
3782
|
+
type AssetClassPropertyControllerRemoveError = AssetClassPropertyControllerRemoveErrors[keyof AssetClassPropertyControllerRemoveErrors];
|
|
3783
|
+
type AssetClassPropertyControllerRemoveResponses = {
|
|
3586
3784
|
/**
|
|
3587
|
-
*
|
|
3785
|
+
* Asset class property deleted
|
|
3588
3786
|
*/
|
|
3589
|
-
200:
|
|
3787
|
+
200: DeleteAssetClassPropertyResponseDto;
|
|
3590
3788
|
};
|
|
3591
|
-
type
|
|
3592
|
-
type
|
|
3593
|
-
|
|
3594
|
-
* Site creation data
|
|
3595
|
-
*/
|
|
3596
|
-
body: CreateSiteDto;
|
|
3789
|
+
type AssetClassPropertyControllerRemoveResponse = AssetClassPropertyControllerRemoveResponses[keyof AssetClassPropertyControllerRemoveResponses];
|
|
3790
|
+
type AssetClassPropertyControllerUpdateData = {
|
|
3791
|
+
body: UpdateAssetClassPropertyDto;
|
|
3597
3792
|
headers?: {
|
|
3598
3793
|
/**
|
|
3599
3794
|
* 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.
|
|
3600
3795
|
*/
|
|
3601
3796
|
'Idempotency-Key'?: string;
|
|
3602
3797
|
};
|
|
3603
|
-
path
|
|
3798
|
+
path: {
|
|
3799
|
+
/**
|
|
3800
|
+
* Asset class property value-row ID (numeric string)
|
|
3801
|
+
*/
|
|
3802
|
+
id: string;
|
|
3803
|
+
};
|
|
3604
3804
|
query?: never;
|
|
3605
|
-
url: '/
|
|
3805
|
+
url: '/asset-class-property/{id}';
|
|
3606
3806
|
};
|
|
3607
|
-
type
|
|
3807
|
+
type AssetClassPropertyControllerUpdateErrors = {
|
|
3608
3808
|
/**
|
|
3609
3809
|
* 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`.
|
|
3610
3810
|
*/
|
|
@@ -3618,9 +3818,9 @@ type SiteControllerCreateSiteErrors = {
|
|
|
3618
3818
|
*/
|
|
3619
3819
|
403: ApiErrorResponse;
|
|
3620
3820
|
/**
|
|
3621
|
-
*
|
|
3821
|
+
* 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.
|
|
3622
3822
|
*/
|
|
3623
|
-
|
|
3823
|
+
404: ApiErrorResponse;
|
|
3624
3824
|
/**
|
|
3625
3825
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3626
3826
|
*/
|
|
@@ -3630,26 +3830,25 @@ type SiteControllerCreateSiteErrors = {
|
|
|
3630
3830
|
*/
|
|
3631
3831
|
500: ApiErrorResponse;
|
|
3632
3832
|
};
|
|
3633
|
-
type
|
|
3634
|
-
type
|
|
3833
|
+
type AssetClassPropertyControllerUpdateError = AssetClassPropertyControllerUpdateErrors[keyof AssetClassPropertyControllerUpdateErrors];
|
|
3834
|
+
type AssetClassPropertyControllerUpdateResponses = {
|
|
3635
3835
|
/**
|
|
3636
|
-
*
|
|
3836
|
+
* Asset class property updated
|
|
3637
3837
|
*/
|
|
3638
|
-
|
|
3838
|
+
200: AssetClassPropertyResponseDto;
|
|
3639
3839
|
};
|
|
3640
|
-
type
|
|
3641
|
-
type
|
|
3642
|
-
body
|
|
3643
|
-
path
|
|
3644
|
-
/**
|
|
3645
|
-
* Site public ID (UUID)
|
|
3646
|
-
*/
|
|
3647
|
-
id: string;
|
|
3648
|
-
};
|
|
3840
|
+
type AssetClassPropertyControllerUpdateResponse = AssetClassPropertyControllerUpdateResponses[keyof AssetClassPropertyControllerUpdateResponses];
|
|
3841
|
+
type DocumentUploadControllerUploadUrlData = {
|
|
3842
|
+
body: DocumentUploadUrlDto;
|
|
3843
|
+
path?: never;
|
|
3649
3844
|
query?: never;
|
|
3650
|
-
url: '/
|
|
3845
|
+
url: '/document/upload-url';
|
|
3651
3846
|
};
|
|
3652
|
-
type
|
|
3847
|
+
type DocumentUploadControllerUploadUrlErrors = {
|
|
3848
|
+
/**
|
|
3849
|
+
* 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`.
|
|
3850
|
+
*/
|
|
3851
|
+
400: ApiErrorResponse;
|
|
3653
3852
|
/**
|
|
3654
3853
|
* 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.
|
|
3655
3854
|
*/
|
|
@@ -3658,10 +3857,6 @@ type SiteControllerDeleteSiteErrors = {
|
|
|
3658
3857
|
* 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).
|
|
3659
3858
|
*/
|
|
3660
3859
|
403: ApiErrorResponse;
|
|
3661
|
-
/**
|
|
3662
|
-
* 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.
|
|
3663
|
-
*/
|
|
3664
|
-
404: ApiErrorResponse;
|
|
3665
3860
|
/**
|
|
3666
3861
|
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3667
3862
|
*/
|
|
@@ -3671,14 +3866,2206 @@ type SiteControllerDeleteSiteErrors = {
|
|
|
3671
3866
|
*/
|
|
3672
3867
|
500: ApiErrorResponse;
|
|
3673
3868
|
};
|
|
3674
|
-
type
|
|
3675
|
-
type
|
|
3676
|
-
|
|
3677
|
-
* Site successfully deleted
|
|
3678
|
-
*/
|
|
3679
|
-
200: DeleteSiteResponseDto;
|
|
3869
|
+
type DocumentUploadControllerUploadUrlError = DocumentUploadControllerUploadUrlErrors[keyof DocumentUploadControllerUploadUrlErrors];
|
|
3870
|
+
type DocumentUploadControllerUploadUrlResponses = {
|
|
3871
|
+
200: DocumentUploadUrlResponseDto;
|
|
3680
3872
|
};
|
|
3681
|
-
type
|
|
3873
|
+
type DocumentUploadControllerUploadUrlResponse = DocumentUploadControllerUploadUrlResponses[keyof DocumentUploadControllerUploadUrlResponses];
|
|
3874
|
+
type AssetDocumentControllerListData = {
|
|
3875
|
+
body?: never;
|
|
3876
|
+
path?: never;
|
|
3877
|
+
query?: {
|
|
3878
|
+
/**
|
|
3879
|
+
* Results per page
|
|
3880
|
+
*/
|
|
3881
|
+
per_page?: number;
|
|
3882
|
+
/**
|
|
3883
|
+
* Page number
|
|
3884
|
+
*/
|
|
3885
|
+
page?: number;
|
|
3886
|
+
direction?: 'asc' | 'desc';
|
|
3887
|
+
/**
|
|
3888
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
3889
|
+
*/
|
|
3890
|
+
sort?: string;
|
|
3891
|
+
/**
|
|
3892
|
+
* Filter to one parent by its publicId (UUID)
|
|
3893
|
+
*/
|
|
3894
|
+
parent_id?: string;
|
|
3895
|
+
/**
|
|
3896
|
+
* Filter by document type id (numeric string)
|
|
3897
|
+
*/
|
|
3898
|
+
document_type_id?: string;
|
|
3899
|
+
/**
|
|
3900
|
+
* Filter by name (case-insensitive partial)
|
|
3901
|
+
*/
|
|
3902
|
+
name?: string;
|
|
3903
|
+
/**
|
|
3904
|
+
* Filter: expires_on >= (ISO date)
|
|
3905
|
+
*/
|
|
3906
|
+
expires_on_from?: string;
|
|
3907
|
+
/**
|
|
3908
|
+
* Filter: expires_on <= (ISO date)
|
|
3909
|
+
*/
|
|
3910
|
+
expires_on_to?: string;
|
|
3911
|
+
/**
|
|
3912
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
3913
|
+
*/
|
|
3914
|
+
document_date_updated_from?: string;
|
|
3915
|
+
/**
|
|
3916
|
+
* Filter: updated_at <= (ISO)
|
|
3917
|
+
*/
|
|
3918
|
+
document_date_updated_to?: string;
|
|
3919
|
+
};
|
|
3920
|
+
url: '/asset-document/list';
|
|
3921
|
+
};
|
|
3922
|
+
type AssetDocumentControllerListErrors = {
|
|
3923
|
+
/**
|
|
3924
|
+
* 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
|
+
*/
|
|
3926
|
+
400: ApiErrorResponse;
|
|
3927
|
+
/**
|
|
3928
|
+
* 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.
|
|
3929
|
+
*/
|
|
3930
|
+
401: ApiErrorResponse;
|
|
3931
|
+
/**
|
|
3932
|
+
* 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).
|
|
3933
|
+
*/
|
|
3934
|
+
403: ApiErrorResponse;
|
|
3935
|
+
/**
|
|
3936
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3937
|
+
*/
|
|
3938
|
+
429: ApiErrorResponse;
|
|
3939
|
+
/**
|
|
3940
|
+
* 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.
|
|
3941
|
+
*/
|
|
3942
|
+
500: ApiErrorResponse;
|
|
3943
|
+
};
|
|
3944
|
+
type AssetDocumentControllerListError = AssetDocumentControllerListErrors[keyof AssetDocumentControllerListErrors];
|
|
3945
|
+
type AssetDocumentControllerListResponses = {
|
|
3946
|
+
200: ListDocumentsResponseDto;
|
|
3947
|
+
};
|
|
3948
|
+
type AssetDocumentControllerListResponse = AssetDocumentControllerListResponses[keyof AssetDocumentControllerListResponses];
|
|
3949
|
+
type AssetDocumentControllerRemoveData = {
|
|
3950
|
+
body?: never;
|
|
3951
|
+
path: {
|
|
3952
|
+
/**
|
|
3953
|
+
* Document ID (numeric string)
|
|
3954
|
+
*/
|
|
3955
|
+
id: string;
|
|
3956
|
+
};
|
|
3957
|
+
query?: never;
|
|
3958
|
+
url: '/asset-document/{id}';
|
|
3959
|
+
};
|
|
3960
|
+
type AssetDocumentControllerRemoveErrors = {
|
|
3961
|
+
/**
|
|
3962
|
+
* 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
|
+
*/
|
|
3964
|
+
400: ApiErrorResponse;
|
|
3965
|
+
/**
|
|
3966
|
+
* 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.
|
|
3967
|
+
*/
|
|
3968
|
+
401: ApiErrorResponse;
|
|
3969
|
+
/**
|
|
3970
|
+
* 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).
|
|
3971
|
+
*/
|
|
3972
|
+
403: ApiErrorResponse;
|
|
3973
|
+
/**
|
|
3974
|
+
* 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.
|
|
3975
|
+
*/
|
|
3976
|
+
404: ApiErrorResponse;
|
|
3977
|
+
/**
|
|
3978
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
3979
|
+
*/
|
|
3980
|
+
429: ApiErrorResponse;
|
|
3981
|
+
/**
|
|
3982
|
+
* 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.
|
|
3983
|
+
*/
|
|
3984
|
+
500: ApiErrorResponse;
|
|
3985
|
+
};
|
|
3986
|
+
type AssetDocumentControllerRemoveError = AssetDocumentControllerRemoveErrors[keyof AssetDocumentControllerRemoveErrors];
|
|
3987
|
+
type AssetDocumentControllerRemoveResponses = {
|
|
3988
|
+
200: DeleteDocumentResponseDto;
|
|
3989
|
+
};
|
|
3990
|
+
type AssetDocumentControllerRemoveResponse = AssetDocumentControllerRemoveResponses[keyof AssetDocumentControllerRemoveResponses];
|
|
3991
|
+
type AssetDocumentControllerGetData = {
|
|
3992
|
+
body?: never;
|
|
3993
|
+
path: {
|
|
3994
|
+
/**
|
|
3995
|
+
* Document ID (numeric string)
|
|
3996
|
+
*/
|
|
3997
|
+
id: string;
|
|
3998
|
+
};
|
|
3999
|
+
query?: never;
|
|
4000
|
+
url: '/asset-document/{id}';
|
|
4001
|
+
};
|
|
4002
|
+
type AssetDocumentControllerGetErrors = {
|
|
4003
|
+
/**
|
|
4004
|
+
* 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
|
+
*/
|
|
4006
|
+
400: ApiErrorResponse;
|
|
4007
|
+
/**
|
|
4008
|
+
* 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.
|
|
4009
|
+
*/
|
|
4010
|
+
401: ApiErrorResponse;
|
|
4011
|
+
/**
|
|
4012
|
+
* 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).
|
|
4013
|
+
*/
|
|
4014
|
+
403: ApiErrorResponse;
|
|
4015
|
+
/**
|
|
4016
|
+
* 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.
|
|
4017
|
+
*/
|
|
4018
|
+
404: ApiErrorResponse;
|
|
4019
|
+
/**
|
|
4020
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4021
|
+
*/
|
|
4022
|
+
429: ApiErrorResponse;
|
|
4023
|
+
/**
|
|
4024
|
+
* 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.
|
|
4025
|
+
*/
|
|
4026
|
+
500: ApiErrorResponse;
|
|
4027
|
+
};
|
|
4028
|
+
type AssetDocumentControllerGetError = AssetDocumentControllerGetErrors[keyof AssetDocumentControllerGetErrors];
|
|
4029
|
+
type AssetDocumentControllerGetResponses = {
|
|
4030
|
+
200: DocumentResponseDto;
|
|
4031
|
+
};
|
|
4032
|
+
type AssetDocumentControllerGetResponse = AssetDocumentControllerGetResponses[keyof AssetDocumentControllerGetResponses];
|
|
4033
|
+
type AssetDocumentControllerUpdateData = {
|
|
4034
|
+
body: UpdateDocumentDto;
|
|
4035
|
+
headers?: {
|
|
4036
|
+
/**
|
|
4037
|
+
* 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.
|
|
4038
|
+
*/
|
|
4039
|
+
'Idempotency-Key'?: string;
|
|
4040
|
+
};
|
|
4041
|
+
path: {
|
|
4042
|
+
/**
|
|
4043
|
+
* Document ID (numeric string)
|
|
4044
|
+
*/
|
|
4045
|
+
id: string;
|
|
4046
|
+
};
|
|
4047
|
+
query?: never;
|
|
4048
|
+
url: '/asset-document/{id}';
|
|
4049
|
+
};
|
|
4050
|
+
type AssetDocumentControllerUpdateErrors = {
|
|
4051
|
+
/**
|
|
4052
|
+
* 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
|
+
*/
|
|
4054
|
+
400: ApiErrorResponse;
|
|
4055
|
+
/**
|
|
4056
|
+
* 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.
|
|
4057
|
+
*/
|
|
4058
|
+
401: ApiErrorResponse;
|
|
4059
|
+
/**
|
|
4060
|
+
* 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).
|
|
4061
|
+
*/
|
|
4062
|
+
403: ApiErrorResponse;
|
|
4063
|
+
/**
|
|
4064
|
+
* 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.
|
|
4065
|
+
*/
|
|
4066
|
+
404: ApiErrorResponse;
|
|
4067
|
+
/**
|
|
4068
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4069
|
+
*/
|
|
4070
|
+
429: ApiErrorResponse;
|
|
4071
|
+
/**
|
|
4072
|
+
* 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.
|
|
4073
|
+
*/
|
|
4074
|
+
500: ApiErrorResponse;
|
|
4075
|
+
};
|
|
4076
|
+
type AssetDocumentControllerUpdateError = AssetDocumentControllerUpdateErrors[keyof AssetDocumentControllerUpdateErrors];
|
|
4077
|
+
type AssetDocumentControllerUpdateResponses = {
|
|
4078
|
+
200: DocumentResponseDto;
|
|
4079
|
+
};
|
|
4080
|
+
type AssetDocumentControllerUpdateResponse = AssetDocumentControllerUpdateResponses[keyof AssetDocumentControllerUpdateResponses];
|
|
4081
|
+
type AssetDocumentControllerCreateData = {
|
|
4082
|
+
body: CreateDocumentDto;
|
|
4083
|
+
headers?: {
|
|
4084
|
+
/**
|
|
4085
|
+
* 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.
|
|
4086
|
+
*/
|
|
4087
|
+
'Idempotency-Key'?: string;
|
|
4088
|
+
};
|
|
4089
|
+
path?: never;
|
|
4090
|
+
query?: never;
|
|
4091
|
+
url: '/asset-document';
|
|
4092
|
+
};
|
|
4093
|
+
type AssetDocumentControllerCreateErrors = {
|
|
4094
|
+
/**
|
|
4095
|
+
* 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
|
+
*/
|
|
4097
|
+
400: ApiErrorResponse;
|
|
4098
|
+
/**
|
|
4099
|
+
* 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.
|
|
4100
|
+
*/
|
|
4101
|
+
401: ApiErrorResponse;
|
|
4102
|
+
/**
|
|
4103
|
+
* 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).
|
|
4104
|
+
*/
|
|
4105
|
+
403: ApiErrorResponse;
|
|
4106
|
+
/**
|
|
4107
|
+
* 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.
|
|
4108
|
+
*/
|
|
4109
|
+
404: ApiErrorResponse;
|
|
4110
|
+
/**
|
|
4111
|
+
* 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`).
|
|
4112
|
+
*/
|
|
4113
|
+
409: ApiErrorResponse;
|
|
4114
|
+
/**
|
|
4115
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4116
|
+
*/
|
|
4117
|
+
429: ApiErrorResponse;
|
|
4118
|
+
/**
|
|
4119
|
+
* 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.
|
|
4120
|
+
*/
|
|
4121
|
+
500: ApiErrorResponse;
|
|
4122
|
+
};
|
|
4123
|
+
type AssetDocumentControllerCreateError = AssetDocumentControllerCreateErrors[keyof AssetDocumentControllerCreateErrors];
|
|
4124
|
+
type AssetDocumentControllerCreateResponses = {
|
|
4125
|
+
201: DocumentResponseDto;
|
|
4126
|
+
};
|
|
4127
|
+
type AssetDocumentControllerCreateResponse = AssetDocumentControllerCreateResponses[keyof AssetDocumentControllerCreateResponses];
|
|
4128
|
+
type AssetClassDocumentControllerListData = {
|
|
4129
|
+
body?: never;
|
|
4130
|
+
path?: never;
|
|
4131
|
+
query?: {
|
|
4132
|
+
/**
|
|
4133
|
+
* Results per page
|
|
4134
|
+
*/
|
|
4135
|
+
per_page?: number;
|
|
4136
|
+
/**
|
|
4137
|
+
* Page number
|
|
4138
|
+
*/
|
|
4139
|
+
page?: number;
|
|
4140
|
+
direction?: 'asc' | 'desc';
|
|
4141
|
+
/**
|
|
4142
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
4143
|
+
*/
|
|
4144
|
+
sort?: string;
|
|
4145
|
+
/**
|
|
4146
|
+
* Filter to one parent by its publicId (UUID)
|
|
4147
|
+
*/
|
|
4148
|
+
parent_id?: string;
|
|
4149
|
+
/**
|
|
4150
|
+
* Filter by document type id (numeric string)
|
|
4151
|
+
*/
|
|
4152
|
+
document_type_id?: string;
|
|
4153
|
+
/**
|
|
4154
|
+
* Filter by name (case-insensitive partial)
|
|
4155
|
+
*/
|
|
4156
|
+
name?: string;
|
|
4157
|
+
/**
|
|
4158
|
+
* Filter: expires_on >= (ISO date)
|
|
4159
|
+
*/
|
|
4160
|
+
expires_on_from?: string;
|
|
4161
|
+
/**
|
|
4162
|
+
* Filter: expires_on <= (ISO date)
|
|
4163
|
+
*/
|
|
4164
|
+
expires_on_to?: string;
|
|
4165
|
+
/**
|
|
4166
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4167
|
+
*/
|
|
4168
|
+
document_date_updated_from?: string;
|
|
4169
|
+
/**
|
|
4170
|
+
* Filter: updated_at <= (ISO)
|
|
4171
|
+
*/
|
|
4172
|
+
document_date_updated_to?: string;
|
|
4173
|
+
};
|
|
4174
|
+
url: '/asset-class-document/list';
|
|
4175
|
+
};
|
|
4176
|
+
type AssetClassDocumentControllerListErrors = {
|
|
4177
|
+
/**
|
|
4178
|
+
* 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
|
+
*/
|
|
4180
|
+
400: ApiErrorResponse;
|
|
4181
|
+
/**
|
|
4182
|
+
* 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.
|
|
4183
|
+
*/
|
|
4184
|
+
401: ApiErrorResponse;
|
|
4185
|
+
/**
|
|
4186
|
+
* 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).
|
|
4187
|
+
*/
|
|
4188
|
+
403: ApiErrorResponse;
|
|
4189
|
+
/**
|
|
4190
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4191
|
+
*/
|
|
4192
|
+
429: ApiErrorResponse;
|
|
4193
|
+
/**
|
|
4194
|
+
* 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.
|
|
4195
|
+
*/
|
|
4196
|
+
500: ApiErrorResponse;
|
|
4197
|
+
};
|
|
4198
|
+
type AssetClassDocumentControllerListError = AssetClassDocumentControllerListErrors[keyof AssetClassDocumentControllerListErrors];
|
|
4199
|
+
type AssetClassDocumentControllerListResponses = {
|
|
4200
|
+
200: ListDocumentsResponseDto;
|
|
4201
|
+
};
|
|
4202
|
+
type AssetClassDocumentControllerListResponse = AssetClassDocumentControllerListResponses[keyof AssetClassDocumentControllerListResponses];
|
|
4203
|
+
type AssetClassDocumentControllerRemoveData = {
|
|
4204
|
+
body?: never;
|
|
4205
|
+
path: {
|
|
4206
|
+
/**
|
|
4207
|
+
* Document ID (numeric string)
|
|
4208
|
+
*/
|
|
4209
|
+
id: string;
|
|
4210
|
+
};
|
|
4211
|
+
query?: never;
|
|
4212
|
+
url: '/asset-class-document/{id}';
|
|
4213
|
+
};
|
|
4214
|
+
type AssetClassDocumentControllerRemoveErrors = {
|
|
4215
|
+
/**
|
|
4216
|
+
* 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
|
+
*/
|
|
4218
|
+
400: ApiErrorResponse;
|
|
4219
|
+
/**
|
|
4220
|
+
* 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.
|
|
4221
|
+
*/
|
|
4222
|
+
401: ApiErrorResponse;
|
|
4223
|
+
/**
|
|
4224
|
+
* 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).
|
|
4225
|
+
*/
|
|
4226
|
+
403: ApiErrorResponse;
|
|
4227
|
+
/**
|
|
4228
|
+
* 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.
|
|
4229
|
+
*/
|
|
4230
|
+
404: ApiErrorResponse;
|
|
4231
|
+
/**
|
|
4232
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4233
|
+
*/
|
|
4234
|
+
429: ApiErrorResponse;
|
|
4235
|
+
/**
|
|
4236
|
+
* 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.
|
|
4237
|
+
*/
|
|
4238
|
+
500: ApiErrorResponse;
|
|
4239
|
+
};
|
|
4240
|
+
type AssetClassDocumentControllerRemoveError = AssetClassDocumentControllerRemoveErrors[keyof AssetClassDocumentControllerRemoveErrors];
|
|
4241
|
+
type AssetClassDocumentControllerRemoveResponses = {
|
|
4242
|
+
200: DeleteDocumentResponseDto;
|
|
4243
|
+
};
|
|
4244
|
+
type AssetClassDocumentControllerRemoveResponse = AssetClassDocumentControllerRemoveResponses[keyof AssetClassDocumentControllerRemoveResponses];
|
|
4245
|
+
type AssetClassDocumentControllerGetData = {
|
|
4246
|
+
body?: never;
|
|
4247
|
+
path: {
|
|
4248
|
+
/**
|
|
4249
|
+
* Document ID (numeric string)
|
|
4250
|
+
*/
|
|
4251
|
+
id: string;
|
|
4252
|
+
};
|
|
4253
|
+
query?: never;
|
|
4254
|
+
url: '/asset-class-document/{id}';
|
|
4255
|
+
};
|
|
4256
|
+
type AssetClassDocumentControllerGetErrors = {
|
|
4257
|
+
/**
|
|
4258
|
+
* 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
|
+
*/
|
|
4260
|
+
400: ApiErrorResponse;
|
|
4261
|
+
/**
|
|
4262
|
+
* 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.
|
|
4263
|
+
*/
|
|
4264
|
+
401: ApiErrorResponse;
|
|
4265
|
+
/**
|
|
4266
|
+
* 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).
|
|
4267
|
+
*/
|
|
4268
|
+
403: ApiErrorResponse;
|
|
4269
|
+
/**
|
|
4270
|
+
* 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.
|
|
4271
|
+
*/
|
|
4272
|
+
404: ApiErrorResponse;
|
|
4273
|
+
/**
|
|
4274
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4275
|
+
*/
|
|
4276
|
+
429: ApiErrorResponse;
|
|
4277
|
+
/**
|
|
4278
|
+
* 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.
|
|
4279
|
+
*/
|
|
4280
|
+
500: ApiErrorResponse;
|
|
4281
|
+
};
|
|
4282
|
+
type AssetClassDocumentControllerGetError = AssetClassDocumentControllerGetErrors[keyof AssetClassDocumentControllerGetErrors];
|
|
4283
|
+
type AssetClassDocumentControllerGetResponses = {
|
|
4284
|
+
200: DocumentResponseDto;
|
|
4285
|
+
};
|
|
4286
|
+
type AssetClassDocumentControllerGetResponse = AssetClassDocumentControllerGetResponses[keyof AssetClassDocumentControllerGetResponses];
|
|
4287
|
+
type AssetClassDocumentControllerUpdateData = {
|
|
4288
|
+
body: UpdateDocumentDto;
|
|
4289
|
+
headers?: {
|
|
4290
|
+
/**
|
|
4291
|
+
* 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.
|
|
4292
|
+
*/
|
|
4293
|
+
'Idempotency-Key'?: string;
|
|
4294
|
+
};
|
|
4295
|
+
path: {
|
|
4296
|
+
/**
|
|
4297
|
+
* Document ID (numeric string)
|
|
4298
|
+
*/
|
|
4299
|
+
id: string;
|
|
4300
|
+
};
|
|
4301
|
+
query?: never;
|
|
4302
|
+
url: '/asset-class-document/{id}';
|
|
4303
|
+
};
|
|
4304
|
+
type AssetClassDocumentControllerUpdateErrors = {
|
|
4305
|
+
/**
|
|
4306
|
+
* 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
|
+
*/
|
|
4308
|
+
400: ApiErrorResponse;
|
|
4309
|
+
/**
|
|
4310
|
+
* 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.
|
|
4311
|
+
*/
|
|
4312
|
+
401: ApiErrorResponse;
|
|
4313
|
+
/**
|
|
4314
|
+
* 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).
|
|
4315
|
+
*/
|
|
4316
|
+
403: ApiErrorResponse;
|
|
4317
|
+
/**
|
|
4318
|
+
* 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.
|
|
4319
|
+
*/
|
|
4320
|
+
404: ApiErrorResponse;
|
|
4321
|
+
/**
|
|
4322
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4323
|
+
*/
|
|
4324
|
+
429: ApiErrorResponse;
|
|
4325
|
+
/**
|
|
4326
|
+
* 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.
|
|
4327
|
+
*/
|
|
4328
|
+
500: ApiErrorResponse;
|
|
4329
|
+
};
|
|
4330
|
+
type AssetClassDocumentControllerUpdateError = AssetClassDocumentControllerUpdateErrors[keyof AssetClassDocumentControllerUpdateErrors];
|
|
4331
|
+
type AssetClassDocumentControllerUpdateResponses = {
|
|
4332
|
+
200: DocumentResponseDto;
|
|
4333
|
+
};
|
|
4334
|
+
type AssetClassDocumentControllerUpdateResponse = AssetClassDocumentControllerUpdateResponses[keyof AssetClassDocumentControllerUpdateResponses];
|
|
4335
|
+
type AssetClassDocumentControllerCreateData = {
|
|
4336
|
+
body: CreateDocumentDto;
|
|
4337
|
+
headers?: {
|
|
4338
|
+
/**
|
|
4339
|
+
* 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.
|
|
4340
|
+
*/
|
|
4341
|
+
'Idempotency-Key'?: string;
|
|
4342
|
+
};
|
|
4343
|
+
path?: never;
|
|
4344
|
+
query?: never;
|
|
4345
|
+
url: '/asset-class-document';
|
|
4346
|
+
};
|
|
4347
|
+
type AssetClassDocumentControllerCreateErrors = {
|
|
4348
|
+
/**
|
|
4349
|
+
* 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
|
+
*/
|
|
4351
|
+
400: ApiErrorResponse;
|
|
4352
|
+
/**
|
|
4353
|
+
* 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.
|
|
4354
|
+
*/
|
|
4355
|
+
401: ApiErrorResponse;
|
|
4356
|
+
/**
|
|
4357
|
+
* 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).
|
|
4358
|
+
*/
|
|
4359
|
+
403: ApiErrorResponse;
|
|
4360
|
+
/**
|
|
4361
|
+
* 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.
|
|
4362
|
+
*/
|
|
4363
|
+
404: ApiErrorResponse;
|
|
4364
|
+
/**
|
|
4365
|
+
* 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`).
|
|
4366
|
+
*/
|
|
4367
|
+
409: ApiErrorResponse;
|
|
4368
|
+
/**
|
|
4369
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4370
|
+
*/
|
|
4371
|
+
429: ApiErrorResponse;
|
|
4372
|
+
/**
|
|
4373
|
+
* 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.
|
|
4374
|
+
*/
|
|
4375
|
+
500: ApiErrorResponse;
|
|
4376
|
+
};
|
|
4377
|
+
type AssetClassDocumentControllerCreateError = AssetClassDocumentControllerCreateErrors[keyof AssetClassDocumentControllerCreateErrors];
|
|
4378
|
+
type AssetClassDocumentControllerCreateResponses = {
|
|
4379
|
+
201: DocumentResponseDto;
|
|
4380
|
+
};
|
|
4381
|
+
type AssetClassDocumentControllerCreateResponse = AssetClassDocumentControllerCreateResponses[keyof AssetClassDocumentControllerCreateResponses];
|
|
4382
|
+
type UserDocumentControllerListData = {
|
|
4383
|
+
body?: never;
|
|
4384
|
+
path?: never;
|
|
4385
|
+
query?: {
|
|
4386
|
+
/**
|
|
4387
|
+
* Results per page
|
|
4388
|
+
*/
|
|
4389
|
+
per_page?: number;
|
|
4390
|
+
/**
|
|
4391
|
+
* Page number
|
|
4392
|
+
*/
|
|
4393
|
+
page?: number;
|
|
4394
|
+
direction?: 'asc' | 'desc';
|
|
4395
|
+
/**
|
|
4396
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
4397
|
+
*/
|
|
4398
|
+
sort?: string;
|
|
4399
|
+
/**
|
|
4400
|
+
* Filter to one parent by its publicId (UUID)
|
|
4401
|
+
*/
|
|
4402
|
+
parent_id?: string;
|
|
4403
|
+
/**
|
|
4404
|
+
* Filter by document type id (numeric string)
|
|
4405
|
+
*/
|
|
4406
|
+
document_type_id?: string;
|
|
4407
|
+
/**
|
|
4408
|
+
* Filter by name (case-insensitive partial)
|
|
4409
|
+
*/
|
|
4410
|
+
name?: string;
|
|
4411
|
+
/**
|
|
4412
|
+
* Filter: expires_on >= (ISO date)
|
|
4413
|
+
*/
|
|
4414
|
+
expires_on_from?: string;
|
|
4415
|
+
/**
|
|
4416
|
+
* Filter: expires_on <= (ISO date)
|
|
4417
|
+
*/
|
|
4418
|
+
expires_on_to?: string;
|
|
4419
|
+
/**
|
|
4420
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4421
|
+
*/
|
|
4422
|
+
document_date_updated_from?: string;
|
|
4423
|
+
/**
|
|
4424
|
+
* Filter: updated_at <= (ISO)
|
|
4425
|
+
*/
|
|
4426
|
+
document_date_updated_to?: string;
|
|
4427
|
+
};
|
|
4428
|
+
url: '/user-document/list';
|
|
4429
|
+
};
|
|
4430
|
+
type UserDocumentControllerListErrors = {
|
|
4431
|
+
/**
|
|
4432
|
+
* 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
|
+
*/
|
|
4434
|
+
400: ApiErrorResponse;
|
|
4435
|
+
/**
|
|
4436
|
+
* 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.
|
|
4437
|
+
*/
|
|
4438
|
+
401: ApiErrorResponse;
|
|
4439
|
+
/**
|
|
4440
|
+
* 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).
|
|
4441
|
+
*/
|
|
4442
|
+
403: ApiErrorResponse;
|
|
4443
|
+
/**
|
|
4444
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4445
|
+
*/
|
|
4446
|
+
429: ApiErrorResponse;
|
|
4447
|
+
/**
|
|
4448
|
+
* 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.
|
|
4449
|
+
*/
|
|
4450
|
+
500: ApiErrorResponse;
|
|
4451
|
+
};
|
|
4452
|
+
type UserDocumentControllerListError = UserDocumentControllerListErrors[keyof UserDocumentControllerListErrors];
|
|
4453
|
+
type UserDocumentControllerListResponses = {
|
|
4454
|
+
200: ListDocumentsResponseDto;
|
|
4455
|
+
};
|
|
4456
|
+
type UserDocumentControllerListResponse = UserDocumentControllerListResponses[keyof UserDocumentControllerListResponses];
|
|
4457
|
+
type UserDocumentControllerRemoveData = {
|
|
4458
|
+
body?: never;
|
|
4459
|
+
path: {
|
|
4460
|
+
/**
|
|
4461
|
+
* Document ID (numeric string)
|
|
4462
|
+
*/
|
|
4463
|
+
id: string;
|
|
4464
|
+
};
|
|
4465
|
+
query?: never;
|
|
4466
|
+
url: '/user-document/{id}';
|
|
4467
|
+
};
|
|
4468
|
+
type UserDocumentControllerRemoveErrors = {
|
|
4469
|
+
/**
|
|
4470
|
+
* 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
|
+
*/
|
|
4472
|
+
400: ApiErrorResponse;
|
|
4473
|
+
/**
|
|
4474
|
+
* 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.
|
|
4475
|
+
*/
|
|
4476
|
+
401: ApiErrorResponse;
|
|
4477
|
+
/**
|
|
4478
|
+
* 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).
|
|
4479
|
+
*/
|
|
4480
|
+
403: ApiErrorResponse;
|
|
4481
|
+
/**
|
|
4482
|
+
* 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.
|
|
4483
|
+
*/
|
|
4484
|
+
404: ApiErrorResponse;
|
|
4485
|
+
/**
|
|
4486
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4487
|
+
*/
|
|
4488
|
+
429: ApiErrorResponse;
|
|
4489
|
+
/**
|
|
4490
|
+
* 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.
|
|
4491
|
+
*/
|
|
4492
|
+
500: ApiErrorResponse;
|
|
4493
|
+
};
|
|
4494
|
+
type UserDocumentControllerRemoveError = UserDocumentControllerRemoveErrors[keyof UserDocumentControllerRemoveErrors];
|
|
4495
|
+
type UserDocumentControllerRemoveResponses = {
|
|
4496
|
+
200: DeleteDocumentResponseDto;
|
|
4497
|
+
};
|
|
4498
|
+
type UserDocumentControllerRemoveResponse = UserDocumentControllerRemoveResponses[keyof UserDocumentControllerRemoveResponses];
|
|
4499
|
+
type UserDocumentControllerGetData = {
|
|
4500
|
+
body?: never;
|
|
4501
|
+
path: {
|
|
4502
|
+
/**
|
|
4503
|
+
* Document ID (numeric string)
|
|
4504
|
+
*/
|
|
4505
|
+
id: string;
|
|
4506
|
+
};
|
|
4507
|
+
query?: never;
|
|
4508
|
+
url: '/user-document/{id}';
|
|
4509
|
+
};
|
|
4510
|
+
type UserDocumentControllerGetErrors = {
|
|
4511
|
+
/**
|
|
4512
|
+
* 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
|
+
*/
|
|
4514
|
+
400: ApiErrorResponse;
|
|
4515
|
+
/**
|
|
4516
|
+
* 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.
|
|
4517
|
+
*/
|
|
4518
|
+
401: ApiErrorResponse;
|
|
4519
|
+
/**
|
|
4520
|
+
* 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).
|
|
4521
|
+
*/
|
|
4522
|
+
403: ApiErrorResponse;
|
|
4523
|
+
/**
|
|
4524
|
+
* 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.
|
|
4525
|
+
*/
|
|
4526
|
+
404: ApiErrorResponse;
|
|
4527
|
+
/**
|
|
4528
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4529
|
+
*/
|
|
4530
|
+
429: ApiErrorResponse;
|
|
4531
|
+
/**
|
|
4532
|
+
* 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.
|
|
4533
|
+
*/
|
|
4534
|
+
500: ApiErrorResponse;
|
|
4535
|
+
};
|
|
4536
|
+
type UserDocumentControllerGetError = UserDocumentControllerGetErrors[keyof UserDocumentControllerGetErrors];
|
|
4537
|
+
type UserDocumentControllerGetResponses = {
|
|
4538
|
+
200: DocumentResponseDto;
|
|
4539
|
+
};
|
|
4540
|
+
type UserDocumentControllerGetResponse = UserDocumentControllerGetResponses[keyof UserDocumentControllerGetResponses];
|
|
4541
|
+
type UserDocumentControllerUpdateData = {
|
|
4542
|
+
body: UpdateDocumentDto;
|
|
4543
|
+
headers?: {
|
|
4544
|
+
/**
|
|
4545
|
+
* 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.
|
|
4546
|
+
*/
|
|
4547
|
+
'Idempotency-Key'?: string;
|
|
4548
|
+
};
|
|
4549
|
+
path: {
|
|
4550
|
+
/**
|
|
4551
|
+
* Document ID (numeric string)
|
|
4552
|
+
*/
|
|
4553
|
+
id: string;
|
|
4554
|
+
};
|
|
4555
|
+
query?: never;
|
|
4556
|
+
url: '/user-document/{id}';
|
|
4557
|
+
};
|
|
4558
|
+
type UserDocumentControllerUpdateErrors = {
|
|
4559
|
+
/**
|
|
4560
|
+
* 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
|
+
*/
|
|
4562
|
+
400: ApiErrorResponse;
|
|
4563
|
+
/**
|
|
4564
|
+
* 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.
|
|
4565
|
+
*/
|
|
4566
|
+
401: ApiErrorResponse;
|
|
4567
|
+
/**
|
|
4568
|
+
* 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).
|
|
4569
|
+
*/
|
|
4570
|
+
403: ApiErrorResponse;
|
|
4571
|
+
/**
|
|
4572
|
+
* 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.
|
|
4573
|
+
*/
|
|
4574
|
+
404: ApiErrorResponse;
|
|
4575
|
+
/**
|
|
4576
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4577
|
+
*/
|
|
4578
|
+
429: ApiErrorResponse;
|
|
4579
|
+
/**
|
|
4580
|
+
* 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.
|
|
4581
|
+
*/
|
|
4582
|
+
500: ApiErrorResponse;
|
|
4583
|
+
};
|
|
4584
|
+
type UserDocumentControllerUpdateError = UserDocumentControllerUpdateErrors[keyof UserDocumentControllerUpdateErrors];
|
|
4585
|
+
type UserDocumentControllerUpdateResponses = {
|
|
4586
|
+
200: DocumentResponseDto;
|
|
4587
|
+
};
|
|
4588
|
+
type UserDocumentControllerUpdateResponse = UserDocumentControllerUpdateResponses[keyof UserDocumentControllerUpdateResponses];
|
|
4589
|
+
type UserDocumentControllerCreateData = {
|
|
4590
|
+
body: CreateDocumentDto;
|
|
4591
|
+
headers?: {
|
|
4592
|
+
/**
|
|
4593
|
+
* 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.
|
|
4594
|
+
*/
|
|
4595
|
+
'Idempotency-Key'?: string;
|
|
4596
|
+
};
|
|
4597
|
+
path?: never;
|
|
4598
|
+
query?: never;
|
|
4599
|
+
url: '/user-document';
|
|
4600
|
+
};
|
|
4601
|
+
type UserDocumentControllerCreateErrors = {
|
|
4602
|
+
/**
|
|
4603
|
+
* 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
|
+
*/
|
|
4605
|
+
400: ApiErrorResponse;
|
|
4606
|
+
/**
|
|
4607
|
+
* 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.
|
|
4608
|
+
*/
|
|
4609
|
+
401: ApiErrorResponse;
|
|
4610
|
+
/**
|
|
4611
|
+
* 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).
|
|
4612
|
+
*/
|
|
4613
|
+
403: ApiErrorResponse;
|
|
4614
|
+
/**
|
|
4615
|
+
* 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.
|
|
4616
|
+
*/
|
|
4617
|
+
404: ApiErrorResponse;
|
|
4618
|
+
/**
|
|
4619
|
+
* 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`).
|
|
4620
|
+
*/
|
|
4621
|
+
409: ApiErrorResponse;
|
|
4622
|
+
/**
|
|
4623
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4624
|
+
*/
|
|
4625
|
+
429: ApiErrorResponse;
|
|
4626
|
+
/**
|
|
4627
|
+
* 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.
|
|
4628
|
+
*/
|
|
4629
|
+
500: ApiErrorResponse;
|
|
4630
|
+
};
|
|
4631
|
+
type UserDocumentControllerCreateError = UserDocumentControllerCreateErrors[keyof UserDocumentControllerCreateErrors];
|
|
4632
|
+
type UserDocumentControllerCreateResponses = {
|
|
4633
|
+
201: DocumentResponseDto;
|
|
4634
|
+
};
|
|
4635
|
+
type UserDocumentControllerCreateResponse = UserDocumentControllerCreateResponses[keyof UserDocumentControllerCreateResponses];
|
|
4636
|
+
type SiteDocumentControllerListData = {
|
|
4637
|
+
body?: never;
|
|
4638
|
+
path?: never;
|
|
4639
|
+
query?: {
|
|
4640
|
+
/**
|
|
4641
|
+
* Results per page
|
|
4642
|
+
*/
|
|
4643
|
+
per_page?: number;
|
|
4644
|
+
/**
|
|
4645
|
+
* Page number
|
|
4646
|
+
*/
|
|
4647
|
+
page?: number;
|
|
4648
|
+
direction?: 'asc' | 'desc';
|
|
4649
|
+
/**
|
|
4650
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
4651
|
+
*/
|
|
4652
|
+
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
|
+
/**
|
|
4662
|
+
* Filter by name (case-insensitive partial)
|
|
4663
|
+
*/
|
|
4664
|
+
name?: string;
|
|
4665
|
+
/**
|
|
4666
|
+
* Filter: expires_on >= (ISO date)
|
|
4667
|
+
*/
|
|
4668
|
+
expires_on_from?: string;
|
|
4669
|
+
/**
|
|
4670
|
+
* Filter: expires_on <= (ISO date)
|
|
4671
|
+
*/
|
|
4672
|
+
expires_on_to?: string;
|
|
4673
|
+
/**
|
|
4674
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4675
|
+
*/
|
|
4676
|
+
document_date_updated_from?: string;
|
|
4677
|
+
/**
|
|
4678
|
+
* Filter: updated_at <= (ISO)
|
|
4679
|
+
*/
|
|
4680
|
+
document_date_updated_to?: string;
|
|
4681
|
+
};
|
|
4682
|
+
url: '/site-document/list';
|
|
4683
|
+
};
|
|
4684
|
+
type SiteDocumentControllerListErrors = {
|
|
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;
|
|
4689
|
+
/**
|
|
4690
|
+
* 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
|
+
*/
|
|
4692
|
+
401: ApiErrorResponse;
|
|
4693
|
+
/**
|
|
4694
|
+
* 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
|
+
*/
|
|
4696
|
+
403: ApiErrorResponse;
|
|
4697
|
+
/**
|
|
4698
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4699
|
+
*/
|
|
4700
|
+
429: ApiErrorResponse;
|
|
4701
|
+
/**
|
|
4702
|
+
* 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.
|
|
4703
|
+
*/
|
|
4704
|
+
500: ApiErrorResponse;
|
|
4705
|
+
};
|
|
4706
|
+
type SiteDocumentControllerListError = SiteDocumentControllerListErrors[keyof SiteDocumentControllerListErrors];
|
|
4707
|
+
type SiteDocumentControllerListResponses = {
|
|
4708
|
+
200: ListDocumentsResponseDto;
|
|
4709
|
+
};
|
|
4710
|
+
type SiteDocumentControllerListResponse = SiteDocumentControllerListResponses[keyof SiteDocumentControllerListResponses];
|
|
4711
|
+
type SiteDocumentControllerRemoveData = {
|
|
4712
|
+
body?: never;
|
|
4713
|
+
path: {
|
|
4714
|
+
/**
|
|
4715
|
+
* Document ID (numeric string)
|
|
4716
|
+
*/
|
|
4717
|
+
id: string;
|
|
4718
|
+
};
|
|
4719
|
+
query?: never;
|
|
4720
|
+
url: '/site-document/{id}';
|
|
4721
|
+
};
|
|
4722
|
+
type SiteDocumentControllerRemoveErrors = {
|
|
4723
|
+
/**
|
|
4724
|
+
* 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
|
+
*/
|
|
4726
|
+
400: ApiErrorResponse;
|
|
4727
|
+
/**
|
|
4728
|
+
* 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.
|
|
4729
|
+
*/
|
|
4730
|
+
401: ApiErrorResponse;
|
|
4731
|
+
/**
|
|
4732
|
+
* 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).
|
|
4733
|
+
*/
|
|
4734
|
+
403: ApiErrorResponse;
|
|
4735
|
+
/**
|
|
4736
|
+
* 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
|
+
*/
|
|
4738
|
+
404: ApiErrorResponse;
|
|
4739
|
+
/**
|
|
4740
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4741
|
+
*/
|
|
4742
|
+
429: ApiErrorResponse;
|
|
4743
|
+
/**
|
|
4744
|
+
* 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.
|
|
4745
|
+
*/
|
|
4746
|
+
500: ApiErrorResponse;
|
|
4747
|
+
};
|
|
4748
|
+
type SiteDocumentControllerRemoveError = SiteDocumentControllerRemoveErrors[keyof SiteDocumentControllerRemoveErrors];
|
|
4749
|
+
type SiteDocumentControllerRemoveResponses = {
|
|
4750
|
+
200: DeleteDocumentResponseDto;
|
|
4751
|
+
};
|
|
4752
|
+
type SiteDocumentControllerRemoveResponse = SiteDocumentControllerRemoveResponses[keyof SiteDocumentControllerRemoveResponses];
|
|
4753
|
+
type SiteDocumentControllerGetData = {
|
|
4754
|
+
body?: never;
|
|
4755
|
+
path: {
|
|
4756
|
+
/**
|
|
4757
|
+
* Document ID (numeric string)
|
|
4758
|
+
*/
|
|
4759
|
+
id: string;
|
|
4760
|
+
};
|
|
4761
|
+
query?: never;
|
|
4762
|
+
url: '/site-document/{id}';
|
|
4763
|
+
};
|
|
4764
|
+
type SiteDocumentControllerGetErrors = {
|
|
4765
|
+
/**
|
|
4766
|
+
* 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
|
+
*/
|
|
4768
|
+
400: ApiErrorResponse;
|
|
4769
|
+
/**
|
|
4770
|
+
* 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.
|
|
4771
|
+
*/
|
|
4772
|
+
401: ApiErrorResponse;
|
|
4773
|
+
/**
|
|
4774
|
+
* 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).
|
|
4775
|
+
*/
|
|
4776
|
+
403: ApiErrorResponse;
|
|
4777
|
+
/**
|
|
4778
|
+
* 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.
|
|
4779
|
+
*/
|
|
4780
|
+
404: ApiErrorResponse;
|
|
4781
|
+
/**
|
|
4782
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4783
|
+
*/
|
|
4784
|
+
429: ApiErrorResponse;
|
|
4785
|
+
/**
|
|
4786
|
+
* 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.
|
|
4787
|
+
*/
|
|
4788
|
+
500: ApiErrorResponse;
|
|
4789
|
+
};
|
|
4790
|
+
type SiteDocumentControllerGetError = SiteDocumentControllerGetErrors[keyof SiteDocumentControllerGetErrors];
|
|
4791
|
+
type SiteDocumentControllerGetResponses = {
|
|
4792
|
+
200: DocumentResponseDto;
|
|
4793
|
+
};
|
|
4794
|
+
type SiteDocumentControllerGetResponse = SiteDocumentControllerGetResponses[keyof SiteDocumentControllerGetResponses];
|
|
4795
|
+
type SiteDocumentControllerUpdateData = {
|
|
4796
|
+
body: UpdateDocumentDto;
|
|
4797
|
+
headers?: {
|
|
4798
|
+
/**
|
|
4799
|
+
* 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.
|
|
4800
|
+
*/
|
|
4801
|
+
'Idempotency-Key'?: string;
|
|
4802
|
+
};
|
|
4803
|
+
path: {
|
|
4804
|
+
/**
|
|
4805
|
+
* Document ID (numeric string)
|
|
4806
|
+
*/
|
|
4807
|
+
id: string;
|
|
4808
|
+
};
|
|
4809
|
+
query?: never;
|
|
4810
|
+
url: '/site-document/{id}';
|
|
4811
|
+
};
|
|
4812
|
+
type SiteDocumentControllerUpdateErrors = {
|
|
4813
|
+
/**
|
|
4814
|
+
* 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
|
+
*/
|
|
4816
|
+
400: ApiErrorResponse;
|
|
4817
|
+
/**
|
|
4818
|
+
* 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.
|
|
4819
|
+
*/
|
|
4820
|
+
401: ApiErrorResponse;
|
|
4821
|
+
/**
|
|
4822
|
+
* 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).
|
|
4823
|
+
*/
|
|
4824
|
+
403: ApiErrorResponse;
|
|
4825
|
+
/**
|
|
4826
|
+
* 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.
|
|
4827
|
+
*/
|
|
4828
|
+
404: ApiErrorResponse;
|
|
4829
|
+
/**
|
|
4830
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4831
|
+
*/
|
|
4832
|
+
429: ApiErrorResponse;
|
|
4833
|
+
/**
|
|
4834
|
+
* 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.
|
|
4835
|
+
*/
|
|
4836
|
+
500: ApiErrorResponse;
|
|
4837
|
+
};
|
|
4838
|
+
type SiteDocumentControllerUpdateError = SiteDocumentControllerUpdateErrors[keyof SiteDocumentControllerUpdateErrors];
|
|
4839
|
+
type SiteDocumentControllerUpdateResponses = {
|
|
4840
|
+
200: DocumentResponseDto;
|
|
4841
|
+
};
|
|
4842
|
+
type SiteDocumentControllerUpdateResponse = SiteDocumentControllerUpdateResponses[keyof SiteDocumentControllerUpdateResponses];
|
|
4843
|
+
type SiteDocumentControllerCreateData = {
|
|
4844
|
+
body: CreateDocumentDto;
|
|
4845
|
+
headers?: {
|
|
4846
|
+
/**
|
|
4847
|
+
* 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.
|
|
4848
|
+
*/
|
|
4849
|
+
'Idempotency-Key'?: string;
|
|
4850
|
+
};
|
|
4851
|
+
path?: never;
|
|
4852
|
+
query?: never;
|
|
4853
|
+
url: '/site-document';
|
|
4854
|
+
};
|
|
4855
|
+
type SiteDocumentControllerCreateErrors = {
|
|
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
|
+
* 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`).
|
|
4874
|
+
*/
|
|
4875
|
+
409: ApiErrorResponse;
|
|
4876
|
+
/**
|
|
4877
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4878
|
+
*/
|
|
4879
|
+
429: ApiErrorResponse;
|
|
4880
|
+
/**
|
|
4881
|
+
* 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.
|
|
4882
|
+
*/
|
|
4883
|
+
500: ApiErrorResponse;
|
|
4884
|
+
};
|
|
4885
|
+
type SiteDocumentControllerCreateError = SiteDocumentControllerCreateErrors[keyof SiteDocumentControllerCreateErrors];
|
|
4886
|
+
type SiteDocumentControllerCreateResponses = {
|
|
4887
|
+
201: DocumentResponseDto;
|
|
4888
|
+
};
|
|
4889
|
+
type SiteDocumentControllerCreateResponse = SiteDocumentControllerCreateResponses[keyof SiteDocumentControllerCreateResponses];
|
|
4890
|
+
type CustomerDocumentControllerListData = {
|
|
4891
|
+
body?: never;
|
|
4892
|
+
path?: never;
|
|
4893
|
+
query?: {
|
|
4894
|
+
/**
|
|
4895
|
+
* Results per page
|
|
4896
|
+
*/
|
|
4897
|
+
per_page?: number;
|
|
4898
|
+
/**
|
|
4899
|
+
* Page number
|
|
4900
|
+
*/
|
|
4901
|
+
page?: number;
|
|
4902
|
+
direction?: 'asc' | 'desc';
|
|
4903
|
+
/**
|
|
4904
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
4905
|
+
*/
|
|
4906
|
+
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
|
+
/**
|
|
4916
|
+
* Filter by name (case-insensitive partial)
|
|
4917
|
+
*/
|
|
4918
|
+
name?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Filter: expires_on >= (ISO date)
|
|
4921
|
+
*/
|
|
4922
|
+
expires_on_from?: string;
|
|
4923
|
+
/**
|
|
4924
|
+
* Filter: expires_on <= (ISO date)
|
|
4925
|
+
*/
|
|
4926
|
+
expires_on_to?: string;
|
|
4927
|
+
/**
|
|
4928
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
4929
|
+
*/
|
|
4930
|
+
document_date_updated_from?: string;
|
|
4931
|
+
/**
|
|
4932
|
+
* Filter: updated_at <= (ISO)
|
|
4933
|
+
*/
|
|
4934
|
+
document_date_updated_to?: string;
|
|
4935
|
+
};
|
|
4936
|
+
url: '/customer-document/list';
|
|
4937
|
+
};
|
|
4938
|
+
type CustomerDocumentControllerListErrors = {
|
|
4939
|
+
/**
|
|
4940
|
+
* 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
|
+
*/
|
|
4942
|
+
400: ApiErrorResponse;
|
|
4943
|
+
/**
|
|
4944
|
+
* 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.
|
|
4945
|
+
*/
|
|
4946
|
+
401: ApiErrorResponse;
|
|
4947
|
+
/**
|
|
4948
|
+
* 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).
|
|
4949
|
+
*/
|
|
4950
|
+
403: ApiErrorResponse;
|
|
4951
|
+
/**
|
|
4952
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4953
|
+
*/
|
|
4954
|
+
429: ApiErrorResponse;
|
|
4955
|
+
/**
|
|
4956
|
+
* 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.
|
|
4957
|
+
*/
|
|
4958
|
+
500: ApiErrorResponse;
|
|
4959
|
+
};
|
|
4960
|
+
type CustomerDocumentControllerListError = CustomerDocumentControllerListErrors[keyof CustomerDocumentControllerListErrors];
|
|
4961
|
+
type CustomerDocumentControllerListResponses = {
|
|
4962
|
+
200: ListDocumentsResponseDto;
|
|
4963
|
+
};
|
|
4964
|
+
type CustomerDocumentControllerListResponse = CustomerDocumentControllerListResponses[keyof CustomerDocumentControllerListResponses];
|
|
4965
|
+
type CustomerDocumentControllerRemoveData = {
|
|
4966
|
+
body?: never;
|
|
4967
|
+
path: {
|
|
4968
|
+
/**
|
|
4969
|
+
* Document ID (numeric string)
|
|
4970
|
+
*/
|
|
4971
|
+
id: string;
|
|
4972
|
+
};
|
|
4973
|
+
query?: never;
|
|
4974
|
+
url: '/customer-document/{id}';
|
|
4975
|
+
};
|
|
4976
|
+
type CustomerDocumentControllerRemoveErrors = {
|
|
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;
|
|
4981
|
+
/**
|
|
4982
|
+
* 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
|
+
*/
|
|
4984
|
+
401: ApiErrorResponse;
|
|
4985
|
+
/**
|
|
4986
|
+
* 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).
|
|
4987
|
+
*/
|
|
4988
|
+
403: ApiErrorResponse;
|
|
4989
|
+
/**
|
|
4990
|
+
* 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.
|
|
4991
|
+
*/
|
|
4992
|
+
404: ApiErrorResponse;
|
|
4993
|
+
/**
|
|
4994
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
4995
|
+
*/
|
|
4996
|
+
429: ApiErrorResponse;
|
|
4997
|
+
/**
|
|
4998
|
+
* 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.
|
|
4999
|
+
*/
|
|
5000
|
+
500: ApiErrorResponse;
|
|
5001
|
+
};
|
|
5002
|
+
type CustomerDocumentControllerRemoveError = CustomerDocumentControllerRemoveErrors[keyof CustomerDocumentControllerRemoveErrors];
|
|
5003
|
+
type CustomerDocumentControllerRemoveResponses = {
|
|
5004
|
+
200: DeleteDocumentResponseDto;
|
|
5005
|
+
};
|
|
5006
|
+
type CustomerDocumentControllerRemoveResponse = CustomerDocumentControllerRemoveResponses[keyof CustomerDocumentControllerRemoveResponses];
|
|
5007
|
+
type CustomerDocumentControllerGetData = {
|
|
5008
|
+
body?: never;
|
|
5009
|
+
path: {
|
|
5010
|
+
/**
|
|
5011
|
+
* Document ID (numeric string)
|
|
5012
|
+
*/
|
|
5013
|
+
id: string;
|
|
5014
|
+
};
|
|
5015
|
+
query?: never;
|
|
5016
|
+
url: '/customer-document/{id}';
|
|
5017
|
+
};
|
|
5018
|
+
type CustomerDocumentControllerGetErrors = {
|
|
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;
|
|
5023
|
+
/**
|
|
5024
|
+
* 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
|
+
*/
|
|
5026
|
+
401: ApiErrorResponse;
|
|
5027
|
+
/**
|
|
5028
|
+
* 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).
|
|
5029
|
+
*/
|
|
5030
|
+
403: ApiErrorResponse;
|
|
5031
|
+
/**
|
|
5032
|
+
* 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.
|
|
5033
|
+
*/
|
|
5034
|
+
404: ApiErrorResponse;
|
|
5035
|
+
/**
|
|
5036
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5037
|
+
*/
|
|
5038
|
+
429: ApiErrorResponse;
|
|
5039
|
+
/**
|
|
5040
|
+
* 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.
|
|
5041
|
+
*/
|
|
5042
|
+
500: ApiErrorResponse;
|
|
5043
|
+
};
|
|
5044
|
+
type CustomerDocumentControllerGetError = CustomerDocumentControllerGetErrors[keyof CustomerDocumentControllerGetErrors];
|
|
5045
|
+
type CustomerDocumentControllerGetResponses = {
|
|
5046
|
+
200: DocumentResponseDto;
|
|
5047
|
+
};
|
|
5048
|
+
type CustomerDocumentControllerGetResponse = CustomerDocumentControllerGetResponses[keyof CustomerDocumentControllerGetResponses];
|
|
5049
|
+
type CustomerDocumentControllerUpdateData = {
|
|
5050
|
+
body: UpdateDocumentDto;
|
|
5051
|
+
headers?: {
|
|
5052
|
+
/**
|
|
5053
|
+
* 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.
|
|
5054
|
+
*/
|
|
5055
|
+
'Idempotency-Key'?: string;
|
|
5056
|
+
};
|
|
5057
|
+
path: {
|
|
5058
|
+
/**
|
|
5059
|
+
* Document ID (numeric string)
|
|
5060
|
+
*/
|
|
5061
|
+
id: string;
|
|
5062
|
+
};
|
|
5063
|
+
query?: never;
|
|
5064
|
+
url: '/customer-document/{id}';
|
|
5065
|
+
};
|
|
5066
|
+
type CustomerDocumentControllerUpdateErrors = {
|
|
5067
|
+
/**
|
|
5068
|
+
* 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
|
+
*/
|
|
5070
|
+
400: ApiErrorResponse;
|
|
5071
|
+
/**
|
|
5072
|
+
* 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.
|
|
5073
|
+
*/
|
|
5074
|
+
401: ApiErrorResponse;
|
|
5075
|
+
/**
|
|
5076
|
+
* 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).
|
|
5077
|
+
*/
|
|
5078
|
+
403: ApiErrorResponse;
|
|
5079
|
+
/**
|
|
5080
|
+
* 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
|
+
*/
|
|
5082
|
+
404: ApiErrorResponse;
|
|
5083
|
+
/**
|
|
5084
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5085
|
+
*/
|
|
5086
|
+
429: ApiErrorResponse;
|
|
5087
|
+
/**
|
|
5088
|
+
* 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.
|
|
5089
|
+
*/
|
|
5090
|
+
500: ApiErrorResponse;
|
|
5091
|
+
};
|
|
5092
|
+
type CustomerDocumentControllerUpdateError = CustomerDocumentControllerUpdateErrors[keyof CustomerDocumentControllerUpdateErrors];
|
|
5093
|
+
type CustomerDocumentControllerUpdateResponses = {
|
|
5094
|
+
200: DocumentResponseDto;
|
|
5095
|
+
};
|
|
5096
|
+
type CustomerDocumentControllerUpdateResponse = CustomerDocumentControllerUpdateResponses[keyof CustomerDocumentControllerUpdateResponses];
|
|
5097
|
+
type CustomerDocumentControllerCreateData = {
|
|
5098
|
+
body: CreateDocumentDto;
|
|
5099
|
+
headers?: {
|
|
5100
|
+
/**
|
|
5101
|
+
* 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.
|
|
5102
|
+
*/
|
|
5103
|
+
'Idempotency-Key'?: string;
|
|
5104
|
+
};
|
|
5105
|
+
path?: never;
|
|
5106
|
+
query?: never;
|
|
5107
|
+
url: '/customer-document';
|
|
5108
|
+
};
|
|
5109
|
+
type CustomerDocumentControllerCreateErrors = {
|
|
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
|
+
* 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
|
+
*/
|
|
5129
|
+
409: ApiErrorResponse;
|
|
5130
|
+
/**
|
|
5131
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5132
|
+
*/
|
|
5133
|
+
429: ApiErrorResponse;
|
|
5134
|
+
/**
|
|
5135
|
+
* 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.
|
|
5136
|
+
*/
|
|
5137
|
+
500: ApiErrorResponse;
|
|
5138
|
+
};
|
|
5139
|
+
type CustomerDocumentControllerCreateError = CustomerDocumentControllerCreateErrors[keyof CustomerDocumentControllerCreateErrors];
|
|
5140
|
+
type CustomerDocumentControllerCreateResponses = {
|
|
5141
|
+
201: DocumentResponseDto;
|
|
5142
|
+
};
|
|
5143
|
+
type CustomerDocumentControllerCreateResponse = CustomerDocumentControllerCreateResponses[keyof CustomerDocumentControllerCreateResponses];
|
|
5144
|
+
type ProjectDocumentControllerListData = {
|
|
5145
|
+
body?: never;
|
|
5146
|
+
path?: never;
|
|
5147
|
+
query?: {
|
|
5148
|
+
/**
|
|
5149
|
+
* Results per page
|
|
5150
|
+
*/
|
|
5151
|
+
per_page?: number;
|
|
5152
|
+
/**
|
|
5153
|
+
* Page number
|
|
5154
|
+
*/
|
|
5155
|
+
page?: number;
|
|
5156
|
+
direction?: 'asc' | 'desc';
|
|
5157
|
+
/**
|
|
5158
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5159
|
+
*/
|
|
5160
|
+
sort?: string;
|
|
5161
|
+
/**
|
|
5162
|
+
* Filter to one parent by its publicId (UUID)
|
|
5163
|
+
*/
|
|
5164
|
+
parent_id?: string;
|
|
5165
|
+
/**
|
|
5166
|
+
* Filter by document type id (numeric string)
|
|
5167
|
+
*/
|
|
5168
|
+
document_type_id?: string;
|
|
5169
|
+
/**
|
|
5170
|
+
* Filter by name (case-insensitive partial)
|
|
5171
|
+
*/
|
|
5172
|
+
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
|
+
/**
|
|
5182
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5183
|
+
*/
|
|
5184
|
+
document_date_updated_from?: string;
|
|
5185
|
+
/**
|
|
5186
|
+
* Filter: updated_at <= (ISO)
|
|
5187
|
+
*/
|
|
5188
|
+
document_date_updated_to?: string;
|
|
5189
|
+
};
|
|
5190
|
+
url: '/project-document/list';
|
|
5191
|
+
};
|
|
5192
|
+
type ProjectDocumentControllerListErrors = {
|
|
5193
|
+
/**
|
|
5194
|
+
* 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
|
+
*/
|
|
5196
|
+
400: ApiErrorResponse;
|
|
5197
|
+
/**
|
|
5198
|
+
* 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.
|
|
5199
|
+
*/
|
|
5200
|
+
401: ApiErrorResponse;
|
|
5201
|
+
/**
|
|
5202
|
+
* 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).
|
|
5203
|
+
*/
|
|
5204
|
+
403: ApiErrorResponse;
|
|
5205
|
+
/**
|
|
5206
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5207
|
+
*/
|
|
5208
|
+
429: ApiErrorResponse;
|
|
5209
|
+
/**
|
|
5210
|
+
* 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.
|
|
5211
|
+
*/
|
|
5212
|
+
500: ApiErrorResponse;
|
|
5213
|
+
};
|
|
5214
|
+
type ProjectDocumentControllerListError = ProjectDocumentControllerListErrors[keyof ProjectDocumentControllerListErrors];
|
|
5215
|
+
type ProjectDocumentControllerListResponses = {
|
|
5216
|
+
200: ListDocumentsResponseDto;
|
|
5217
|
+
};
|
|
5218
|
+
type ProjectDocumentControllerListResponse = ProjectDocumentControllerListResponses[keyof ProjectDocumentControllerListResponses];
|
|
5219
|
+
type ProjectDocumentControllerRemoveData = {
|
|
5220
|
+
body?: never;
|
|
5221
|
+
path: {
|
|
5222
|
+
/**
|
|
5223
|
+
* Document ID (numeric string)
|
|
5224
|
+
*/
|
|
5225
|
+
id: string;
|
|
5226
|
+
};
|
|
5227
|
+
query?: never;
|
|
5228
|
+
url: '/project-document/{id}';
|
|
5229
|
+
};
|
|
5230
|
+
type ProjectDocumentControllerRemoveErrors = {
|
|
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;
|
|
5235
|
+
/**
|
|
5236
|
+
* 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
|
+
*/
|
|
5238
|
+
401: ApiErrorResponse;
|
|
5239
|
+
/**
|
|
5240
|
+
* 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).
|
|
5241
|
+
*/
|
|
5242
|
+
403: ApiErrorResponse;
|
|
5243
|
+
/**
|
|
5244
|
+
* 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.
|
|
5245
|
+
*/
|
|
5246
|
+
404: ApiErrorResponse;
|
|
5247
|
+
/**
|
|
5248
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5249
|
+
*/
|
|
5250
|
+
429: ApiErrorResponse;
|
|
5251
|
+
/**
|
|
5252
|
+
* 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.
|
|
5253
|
+
*/
|
|
5254
|
+
500: ApiErrorResponse;
|
|
5255
|
+
};
|
|
5256
|
+
type ProjectDocumentControllerRemoveError = ProjectDocumentControllerRemoveErrors[keyof ProjectDocumentControllerRemoveErrors];
|
|
5257
|
+
type ProjectDocumentControllerRemoveResponses = {
|
|
5258
|
+
200: DeleteDocumentResponseDto;
|
|
5259
|
+
};
|
|
5260
|
+
type ProjectDocumentControllerRemoveResponse = ProjectDocumentControllerRemoveResponses[keyof ProjectDocumentControllerRemoveResponses];
|
|
5261
|
+
type ProjectDocumentControllerGetData = {
|
|
5262
|
+
body?: never;
|
|
5263
|
+
path: {
|
|
5264
|
+
/**
|
|
5265
|
+
* Document ID (numeric string)
|
|
5266
|
+
*/
|
|
5267
|
+
id: string;
|
|
5268
|
+
};
|
|
5269
|
+
query?: never;
|
|
5270
|
+
url: '/project-document/{id}';
|
|
5271
|
+
};
|
|
5272
|
+
type ProjectDocumentControllerGetErrors = {
|
|
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;
|
|
5277
|
+
/**
|
|
5278
|
+
* 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
|
+
*/
|
|
5280
|
+
401: ApiErrorResponse;
|
|
5281
|
+
/**
|
|
5282
|
+
* 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).
|
|
5283
|
+
*/
|
|
5284
|
+
403: ApiErrorResponse;
|
|
5285
|
+
/**
|
|
5286
|
+
* 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.
|
|
5287
|
+
*/
|
|
5288
|
+
404: ApiErrorResponse;
|
|
5289
|
+
/**
|
|
5290
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5291
|
+
*/
|
|
5292
|
+
429: ApiErrorResponse;
|
|
5293
|
+
/**
|
|
5294
|
+
* 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.
|
|
5295
|
+
*/
|
|
5296
|
+
500: ApiErrorResponse;
|
|
5297
|
+
};
|
|
5298
|
+
type ProjectDocumentControllerGetError = ProjectDocumentControllerGetErrors[keyof ProjectDocumentControllerGetErrors];
|
|
5299
|
+
type ProjectDocumentControllerGetResponses = {
|
|
5300
|
+
200: DocumentResponseDto;
|
|
5301
|
+
};
|
|
5302
|
+
type ProjectDocumentControllerGetResponse = ProjectDocumentControllerGetResponses[keyof ProjectDocumentControllerGetResponses];
|
|
5303
|
+
type ProjectDocumentControllerUpdateData = {
|
|
5304
|
+
body: UpdateDocumentDto;
|
|
5305
|
+
headers?: {
|
|
5306
|
+
/**
|
|
5307
|
+
* 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.
|
|
5308
|
+
*/
|
|
5309
|
+
'Idempotency-Key'?: string;
|
|
5310
|
+
};
|
|
5311
|
+
path: {
|
|
5312
|
+
/**
|
|
5313
|
+
* Document ID (numeric string)
|
|
5314
|
+
*/
|
|
5315
|
+
id: string;
|
|
5316
|
+
};
|
|
5317
|
+
query?: never;
|
|
5318
|
+
url: '/project-document/{id}';
|
|
5319
|
+
};
|
|
5320
|
+
type ProjectDocumentControllerUpdateErrors = {
|
|
5321
|
+
/**
|
|
5322
|
+
* 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
|
+
*/
|
|
5324
|
+
400: ApiErrorResponse;
|
|
5325
|
+
/**
|
|
5326
|
+
* 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.
|
|
5327
|
+
*/
|
|
5328
|
+
401: ApiErrorResponse;
|
|
5329
|
+
/**
|
|
5330
|
+
* 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).
|
|
5331
|
+
*/
|
|
5332
|
+
403: ApiErrorResponse;
|
|
5333
|
+
/**
|
|
5334
|
+
* 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
|
+
*/
|
|
5336
|
+
404: ApiErrorResponse;
|
|
5337
|
+
/**
|
|
5338
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5339
|
+
*/
|
|
5340
|
+
429: ApiErrorResponse;
|
|
5341
|
+
/**
|
|
5342
|
+
* 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.
|
|
5343
|
+
*/
|
|
5344
|
+
500: ApiErrorResponse;
|
|
5345
|
+
};
|
|
5346
|
+
type ProjectDocumentControllerUpdateError = ProjectDocumentControllerUpdateErrors[keyof ProjectDocumentControllerUpdateErrors];
|
|
5347
|
+
type ProjectDocumentControllerUpdateResponses = {
|
|
5348
|
+
200: DocumentResponseDto;
|
|
5349
|
+
};
|
|
5350
|
+
type ProjectDocumentControllerUpdateResponse = ProjectDocumentControllerUpdateResponses[keyof ProjectDocumentControllerUpdateResponses];
|
|
5351
|
+
type ProjectDocumentControllerCreateData = {
|
|
5352
|
+
body: CreateDocumentDto;
|
|
5353
|
+
headers?: {
|
|
5354
|
+
/**
|
|
5355
|
+
* 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.
|
|
5356
|
+
*/
|
|
5357
|
+
'Idempotency-Key'?: string;
|
|
5358
|
+
};
|
|
5359
|
+
path?: never;
|
|
5360
|
+
query?: never;
|
|
5361
|
+
url: '/project-document';
|
|
5362
|
+
};
|
|
5363
|
+
type ProjectDocumentControllerCreateErrors = {
|
|
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
|
+
* 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`).
|
|
5382
|
+
*/
|
|
5383
|
+
409: ApiErrorResponse;
|
|
5384
|
+
/**
|
|
5385
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5386
|
+
*/
|
|
5387
|
+
429: ApiErrorResponse;
|
|
5388
|
+
/**
|
|
5389
|
+
* 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.
|
|
5390
|
+
*/
|
|
5391
|
+
500: ApiErrorResponse;
|
|
5392
|
+
};
|
|
5393
|
+
type ProjectDocumentControllerCreateError = ProjectDocumentControllerCreateErrors[keyof ProjectDocumentControllerCreateErrors];
|
|
5394
|
+
type ProjectDocumentControllerCreateResponses = {
|
|
5395
|
+
201: DocumentResponseDto;
|
|
5396
|
+
};
|
|
5397
|
+
type ProjectDocumentControllerCreateResponse = ProjectDocumentControllerCreateResponses[keyof ProjectDocumentControllerCreateResponses];
|
|
5398
|
+
type JobDocumentControllerListData = {
|
|
5399
|
+
body?: never;
|
|
5400
|
+
path?: never;
|
|
5401
|
+
query?: {
|
|
5402
|
+
/**
|
|
5403
|
+
* Results per page
|
|
5404
|
+
*/
|
|
5405
|
+
per_page?: number;
|
|
5406
|
+
/**
|
|
5407
|
+
* Page number
|
|
5408
|
+
*/
|
|
5409
|
+
page?: number;
|
|
5410
|
+
direction?: 'asc' | 'desc';
|
|
5411
|
+
/**
|
|
5412
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5413
|
+
*/
|
|
5414
|
+
sort?: string;
|
|
5415
|
+
/**
|
|
5416
|
+
* Filter to one parent by its publicId (UUID)
|
|
5417
|
+
*/
|
|
5418
|
+
parent_id?: string;
|
|
5419
|
+
/**
|
|
5420
|
+
* Filter by document type id (numeric string)
|
|
5421
|
+
*/
|
|
5422
|
+
document_type_id?: string;
|
|
5423
|
+
/**
|
|
5424
|
+
* Filter by name (case-insensitive partial)
|
|
5425
|
+
*/
|
|
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;
|
|
5435
|
+
/**
|
|
5436
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5437
|
+
*/
|
|
5438
|
+
document_date_updated_from?: string;
|
|
5439
|
+
/**
|
|
5440
|
+
* Filter: updated_at <= (ISO)
|
|
5441
|
+
*/
|
|
5442
|
+
document_date_updated_to?: string;
|
|
5443
|
+
};
|
|
5444
|
+
url: '/job-document/list';
|
|
5445
|
+
};
|
|
5446
|
+
type JobDocumentControllerListErrors = {
|
|
5447
|
+
/**
|
|
5448
|
+
* 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
|
+
*/
|
|
5450
|
+
400: ApiErrorResponse;
|
|
5451
|
+
/**
|
|
5452
|
+
* 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.
|
|
5453
|
+
*/
|
|
5454
|
+
401: ApiErrorResponse;
|
|
5455
|
+
/**
|
|
5456
|
+
* 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).
|
|
5457
|
+
*/
|
|
5458
|
+
403: ApiErrorResponse;
|
|
5459
|
+
/**
|
|
5460
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5461
|
+
*/
|
|
5462
|
+
429: ApiErrorResponse;
|
|
5463
|
+
/**
|
|
5464
|
+
* 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.
|
|
5465
|
+
*/
|
|
5466
|
+
500: ApiErrorResponse;
|
|
5467
|
+
};
|
|
5468
|
+
type JobDocumentControllerListError = JobDocumentControllerListErrors[keyof JobDocumentControllerListErrors];
|
|
5469
|
+
type JobDocumentControllerListResponses = {
|
|
5470
|
+
200: ListDocumentsResponseDto;
|
|
5471
|
+
};
|
|
5472
|
+
type JobDocumentControllerListResponse = JobDocumentControllerListResponses[keyof JobDocumentControllerListResponses];
|
|
5473
|
+
type JobDocumentControllerRemoveData = {
|
|
5474
|
+
body?: never;
|
|
5475
|
+
path: {
|
|
5476
|
+
/**
|
|
5477
|
+
* Document ID (numeric string)
|
|
5478
|
+
*/
|
|
5479
|
+
id: string;
|
|
5480
|
+
};
|
|
5481
|
+
query?: never;
|
|
5482
|
+
url: '/job-document/{id}';
|
|
5483
|
+
};
|
|
5484
|
+
type JobDocumentControllerRemoveErrors = {
|
|
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;
|
|
5489
|
+
/**
|
|
5490
|
+
* 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
|
+
*/
|
|
5492
|
+
401: ApiErrorResponse;
|
|
5493
|
+
/**
|
|
5494
|
+
* 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).
|
|
5495
|
+
*/
|
|
5496
|
+
403: ApiErrorResponse;
|
|
5497
|
+
/**
|
|
5498
|
+
* 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.
|
|
5499
|
+
*/
|
|
5500
|
+
404: ApiErrorResponse;
|
|
5501
|
+
/**
|
|
5502
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5503
|
+
*/
|
|
5504
|
+
429: ApiErrorResponse;
|
|
5505
|
+
/**
|
|
5506
|
+
* 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.
|
|
5507
|
+
*/
|
|
5508
|
+
500: ApiErrorResponse;
|
|
5509
|
+
};
|
|
5510
|
+
type JobDocumentControllerRemoveError = JobDocumentControllerRemoveErrors[keyof JobDocumentControllerRemoveErrors];
|
|
5511
|
+
type JobDocumentControllerRemoveResponses = {
|
|
5512
|
+
200: DeleteDocumentResponseDto;
|
|
5513
|
+
};
|
|
5514
|
+
type JobDocumentControllerRemoveResponse = JobDocumentControllerRemoveResponses[keyof JobDocumentControllerRemoveResponses];
|
|
5515
|
+
type JobDocumentControllerGetData = {
|
|
5516
|
+
body?: never;
|
|
5517
|
+
path: {
|
|
5518
|
+
/**
|
|
5519
|
+
* Document ID (numeric string)
|
|
5520
|
+
*/
|
|
5521
|
+
id: string;
|
|
5522
|
+
};
|
|
5523
|
+
query?: never;
|
|
5524
|
+
url: '/job-document/{id}';
|
|
5525
|
+
};
|
|
5526
|
+
type JobDocumentControllerGetErrors = {
|
|
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;
|
|
5531
|
+
/**
|
|
5532
|
+
* 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
|
+
*/
|
|
5534
|
+
401: ApiErrorResponse;
|
|
5535
|
+
/**
|
|
5536
|
+
* 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).
|
|
5537
|
+
*/
|
|
5538
|
+
403: ApiErrorResponse;
|
|
5539
|
+
/**
|
|
5540
|
+
* 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.
|
|
5541
|
+
*/
|
|
5542
|
+
404: ApiErrorResponse;
|
|
5543
|
+
/**
|
|
5544
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5545
|
+
*/
|
|
5546
|
+
429: ApiErrorResponse;
|
|
5547
|
+
/**
|
|
5548
|
+
* 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.
|
|
5549
|
+
*/
|
|
5550
|
+
500: ApiErrorResponse;
|
|
5551
|
+
};
|
|
5552
|
+
type JobDocumentControllerGetError = JobDocumentControllerGetErrors[keyof JobDocumentControllerGetErrors];
|
|
5553
|
+
type JobDocumentControllerGetResponses = {
|
|
5554
|
+
200: DocumentResponseDto;
|
|
5555
|
+
};
|
|
5556
|
+
type JobDocumentControllerGetResponse = JobDocumentControllerGetResponses[keyof JobDocumentControllerGetResponses];
|
|
5557
|
+
type JobDocumentControllerUpdateData = {
|
|
5558
|
+
body: UpdateDocumentDto;
|
|
5559
|
+
headers?: {
|
|
5560
|
+
/**
|
|
5561
|
+
* 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.
|
|
5562
|
+
*/
|
|
5563
|
+
'Idempotency-Key'?: string;
|
|
5564
|
+
};
|
|
5565
|
+
path: {
|
|
5566
|
+
/**
|
|
5567
|
+
* Document ID (numeric string)
|
|
5568
|
+
*/
|
|
5569
|
+
id: string;
|
|
5570
|
+
};
|
|
5571
|
+
query?: never;
|
|
5572
|
+
url: '/job-document/{id}';
|
|
5573
|
+
};
|
|
5574
|
+
type JobDocumentControllerUpdateErrors = {
|
|
5575
|
+
/**
|
|
5576
|
+
* 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
|
+
*/
|
|
5578
|
+
400: ApiErrorResponse;
|
|
5579
|
+
/**
|
|
5580
|
+
* 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.
|
|
5581
|
+
*/
|
|
5582
|
+
401: ApiErrorResponse;
|
|
5583
|
+
/**
|
|
5584
|
+
* 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).
|
|
5585
|
+
*/
|
|
5586
|
+
403: ApiErrorResponse;
|
|
5587
|
+
/**
|
|
5588
|
+
* 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.
|
|
5589
|
+
*/
|
|
5590
|
+
404: ApiErrorResponse;
|
|
5591
|
+
/**
|
|
5592
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5593
|
+
*/
|
|
5594
|
+
429: ApiErrorResponse;
|
|
5595
|
+
/**
|
|
5596
|
+
* 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.
|
|
5597
|
+
*/
|
|
5598
|
+
500: ApiErrorResponse;
|
|
5599
|
+
};
|
|
5600
|
+
type JobDocumentControllerUpdateError = JobDocumentControllerUpdateErrors[keyof JobDocumentControllerUpdateErrors];
|
|
5601
|
+
type JobDocumentControllerUpdateResponses = {
|
|
5602
|
+
200: DocumentResponseDto;
|
|
5603
|
+
};
|
|
5604
|
+
type JobDocumentControllerUpdateResponse = JobDocumentControllerUpdateResponses[keyof JobDocumentControllerUpdateResponses];
|
|
5605
|
+
type JobDocumentControllerCreateData = {
|
|
5606
|
+
body: CreateDocumentDto;
|
|
5607
|
+
headers?: {
|
|
5608
|
+
/**
|
|
5609
|
+
* 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.
|
|
5610
|
+
*/
|
|
5611
|
+
'Idempotency-Key'?: string;
|
|
5612
|
+
};
|
|
5613
|
+
path?: never;
|
|
5614
|
+
query?: never;
|
|
5615
|
+
url: '/job-document';
|
|
5616
|
+
};
|
|
5617
|
+
type JobDocumentControllerCreateErrors = {
|
|
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
|
+
* 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
|
+
/**
|
|
5639
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5640
|
+
*/
|
|
5641
|
+
429: ApiErrorResponse;
|
|
5642
|
+
/**
|
|
5643
|
+
* 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.
|
|
5644
|
+
*/
|
|
5645
|
+
500: ApiErrorResponse;
|
|
5646
|
+
};
|
|
5647
|
+
type JobDocumentControllerCreateError = JobDocumentControllerCreateErrors[keyof JobDocumentControllerCreateErrors];
|
|
5648
|
+
type JobDocumentControllerCreateResponses = {
|
|
5649
|
+
201: DocumentResponseDto;
|
|
5650
|
+
};
|
|
5651
|
+
type JobDocumentControllerCreateResponse = JobDocumentControllerCreateResponses[keyof JobDocumentControllerCreateResponses];
|
|
5652
|
+
type CompanyDocumentControllerListData = {
|
|
5653
|
+
body?: never;
|
|
5654
|
+
path?: never;
|
|
5655
|
+
query?: {
|
|
5656
|
+
/**
|
|
5657
|
+
* Results per page
|
|
5658
|
+
*/
|
|
5659
|
+
per_page?: number;
|
|
5660
|
+
/**
|
|
5661
|
+
* Page number
|
|
5662
|
+
*/
|
|
5663
|
+
page?: number;
|
|
5664
|
+
direction?: 'asc' | 'desc';
|
|
5665
|
+
/**
|
|
5666
|
+
* Sort field: name, issued_on, expires_on, created_at, updated_at, id (default updated_at)
|
|
5667
|
+
*/
|
|
5668
|
+
sort?: string;
|
|
5669
|
+
/**
|
|
5670
|
+
* Filter to one parent by its publicId (UUID)
|
|
5671
|
+
*/
|
|
5672
|
+
parent_id?: string;
|
|
5673
|
+
/**
|
|
5674
|
+
* Filter by document type id (numeric string)
|
|
5675
|
+
*/
|
|
5676
|
+
document_type_id?: string;
|
|
5677
|
+
/**
|
|
5678
|
+
* Filter by name (case-insensitive partial)
|
|
5679
|
+
*/
|
|
5680
|
+
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
|
+
/**
|
|
5690
|
+
* Filter: updated_at >= (ISO) — incremental sync watermark
|
|
5691
|
+
*/
|
|
5692
|
+
document_date_updated_from?: string;
|
|
5693
|
+
/**
|
|
5694
|
+
* Filter: updated_at <= (ISO)
|
|
5695
|
+
*/
|
|
5696
|
+
document_date_updated_to?: string;
|
|
5697
|
+
};
|
|
5698
|
+
url: '/company-document/list';
|
|
5699
|
+
};
|
|
5700
|
+
type CompanyDocumentControllerListErrors = {
|
|
5701
|
+
/**
|
|
5702
|
+
* 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
|
+
*/
|
|
5704
|
+
400: ApiErrorResponse;
|
|
5705
|
+
/**
|
|
5706
|
+
* 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.
|
|
5707
|
+
*/
|
|
5708
|
+
401: ApiErrorResponse;
|
|
5709
|
+
/**
|
|
5710
|
+
* 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).
|
|
5711
|
+
*/
|
|
5712
|
+
403: ApiErrorResponse;
|
|
5713
|
+
/**
|
|
5714
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5715
|
+
*/
|
|
5716
|
+
429: ApiErrorResponse;
|
|
5717
|
+
/**
|
|
5718
|
+
* 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.
|
|
5719
|
+
*/
|
|
5720
|
+
500: ApiErrorResponse;
|
|
5721
|
+
};
|
|
5722
|
+
type CompanyDocumentControllerListError = CompanyDocumentControllerListErrors[keyof CompanyDocumentControllerListErrors];
|
|
5723
|
+
type CompanyDocumentControllerListResponses = {
|
|
5724
|
+
200: ListDocumentsResponseDto;
|
|
5725
|
+
};
|
|
5726
|
+
type CompanyDocumentControllerListResponse = CompanyDocumentControllerListResponses[keyof CompanyDocumentControllerListResponses];
|
|
5727
|
+
type CompanyDocumentControllerRemoveData = {
|
|
5728
|
+
body?: never;
|
|
5729
|
+
path: {
|
|
5730
|
+
/**
|
|
5731
|
+
* Document ID (numeric string)
|
|
5732
|
+
*/
|
|
5733
|
+
id: string;
|
|
5734
|
+
};
|
|
5735
|
+
query?: never;
|
|
5736
|
+
url: '/company-document/{id}';
|
|
5737
|
+
};
|
|
5738
|
+
type CompanyDocumentControllerRemoveErrors = {
|
|
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;
|
|
5743
|
+
/**
|
|
5744
|
+
* 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
|
+
*/
|
|
5746
|
+
401: ApiErrorResponse;
|
|
5747
|
+
/**
|
|
5748
|
+
* 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).
|
|
5749
|
+
*/
|
|
5750
|
+
403: ApiErrorResponse;
|
|
5751
|
+
/**
|
|
5752
|
+
* 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.
|
|
5753
|
+
*/
|
|
5754
|
+
404: ApiErrorResponse;
|
|
5755
|
+
/**
|
|
5756
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5757
|
+
*/
|
|
5758
|
+
429: ApiErrorResponse;
|
|
5759
|
+
/**
|
|
5760
|
+
* 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.
|
|
5761
|
+
*/
|
|
5762
|
+
500: ApiErrorResponse;
|
|
5763
|
+
};
|
|
5764
|
+
type CompanyDocumentControllerRemoveError = CompanyDocumentControllerRemoveErrors[keyof CompanyDocumentControllerRemoveErrors];
|
|
5765
|
+
type CompanyDocumentControllerRemoveResponses = {
|
|
5766
|
+
200: DeleteDocumentResponseDto;
|
|
5767
|
+
};
|
|
5768
|
+
type CompanyDocumentControllerRemoveResponse = CompanyDocumentControllerRemoveResponses[keyof CompanyDocumentControllerRemoveResponses];
|
|
5769
|
+
type CompanyDocumentControllerGetData = {
|
|
5770
|
+
body?: never;
|
|
5771
|
+
path: {
|
|
5772
|
+
/**
|
|
5773
|
+
* Document ID (numeric string)
|
|
5774
|
+
*/
|
|
5775
|
+
id: string;
|
|
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?: {
|
|
5814
|
+
/**
|
|
5815
|
+
* 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.
|
|
5816
|
+
*/
|
|
5817
|
+
'Idempotency-Key'?: string;
|
|
5818
|
+
};
|
|
5819
|
+
path: {
|
|
5820
|
+
/**
|
|
5821
|
+
* Document ID (numeric string)
|
|
5822
|
+
*/
|
|
5823
|
+
id: string;
|
|
5824
|
+
};
|
|
5825
|
+
query?: never;
|
|
5826
|
+
url: '/company-document/{id}';
|
|
5827
|
+
};
|
|
5828
|
+
type CompanyDocumentControllerUpdateErrors = {
|
|
5829
|
+
/**
|
|
5830
|
+
* 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
|
+
*/
|
|
5832
|
+
400: ApiErrorResponse;
|
|
5833
|
+
/**
|
|
5834
|
+
* 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.
|
|
5835
|
+
*/
|
|
5836
|
+
401: ApiErrorResponse;
|
|
5837
|
+
/**
|
|
5838
|
+
* 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
|
+
*/
|
|
5840
|
+
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
|
+
/**
|
|
5846
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5847
|
+
*/
|
|
5848
|
+
429: ApiErrorResponse;
|
|
5849
|
+
/**
|
|
5850
|
+
* 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.
|
|
5851
|
+
*/
|
|
5852
|
+
500: ApiErrorResponse;
|
|
5853
|
+
};
|
|
5854
|
+
type CompanyDocumentControllerUpdateError = CompanyDocumentControllerUpdateErrors[keyof CompanyDocumentControllerUpdateErrors];
|
|
5855
|
+
type CompanyDocumentControllerUpdateResponses = {
|
|
5856
|
+
200: DocumentResponseDto;
|
|
5857
|
+
};
|
|
5858
|
+
type CompanyDocumentControllerUpdateResponse = CompanyDocumentControllerUpdateResponses[keyof CompanyDocumentControllerUpdateResponses];
|
|
5859
|
+
type CompanyDocumentControllerCreateData = {
|
|
5860
|
+
body: CreateDocumentDto;
|
|
5861
|
+
headers?: {
|
|
5862
|
+
/**
|
|
5863
|
+
* 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.
|
|
5864
|
+
*/
|
|
5865
|
+
'Idempotency-Key'?: string;
|
|
5866
|
+
};
|
|
5867
|
+
path?: never;
|
|
5868
|
+
query?: never;
|
|
5869
|
+
url: '/company-document';
|
|
5870
|
+
};
|
|
5871
|
+
type CompanyDocumentControllerCreateErrors = {
|
|
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
|
+
* 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
|
+
/**
|
|
5893
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5894
|
+
*/
|
|
5895
|
+
429: ApiErrorResponse;
|
|
5896
|
+
/**
|
|
5897
|
+
* 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.
|
|
5898
|
+
*/
|
|
5899
|
+
500: ApiErrorResponse;
|
|
5900
|
+
};
|
|
5901
|
+
type CompanyDocumentControllerCreateError = CompanyDocumentControllerCreateErrors[keyof CompanyDocumentControllerCreateErrors];
|
|
5902
|
+
type CompanyDocumentControllerCreateResponses = {
|
|
5903
|
+
201: DocumentResponseDto;
|
|
5904
|
+
};
|
|
5905
|
+
type CompanyDocumentControllerCreateResponse = CompanyDocumentControllerCreateResponses[keyof CompanyDocumentControllerCreateResponses];
|
|
5906
|
+
type SiteControllerListSitesData = {
|
|
5907
|
+
body?: never;
|
|
5908
|
+
path?: never;
|
|
5909
|
+
query?: {
|
|
5910
|
+
/**
|
|
5911
|
+
* Number of results per page (default: 15)
|
|
5912
|
+
*/
|
|
5913
|
+
per_page?: number;
|
|
5914
|
+
/**
|
|
5915
|
+
* Page number (default: 1)
|
|
5916
|
+
*/
|
|
5917
|
+
page?: number;
|
|
5918
|
+
/**
|
|
5919
|
+
* Sort direction (default: asc)
|
|
5920
|
+
*/
|
|
5921
|
+
direction?: 'asc' | 'desc';
|
|
5922
|
+
/**
|
|
5923
|
+
* Field to sort by (name, created_at, updated_at, category)
|
|
5924
|
+
*/
|
|
5925
|
+
sort?: string;
|
|
5926
|
+
/**
|
|
5927
|
+
* Filter by site name (partial match)
|
|
5928
|
+
*/
|
|
5929
|
+
site_name?: string;
|
|
5930
|
+
/**
|
|
5931
|
+
* Filter by site category name
|
|
5932
|
+
*/
|
|
5933
|
+
site_category?: string;
|
|
5934
|
+
/**
|
|
5935
|
+
* BigInt as string. IDs are stringified at the serialization boundary.
|
|
5936
|
+
*/
|
|
5937
|
+
site_category_id?: string;
|
|
5938
|
+
/**
|
|
5939
|
+
* Return sites modified since the date provided
|
|
5940
|
+
*/
|
|
5941
|
+
date_modified_from?: string;
|
|
5942
|
+
/**
|
|
5943
|
+
* Return sites modified to the date provided
|
|
5944
|
+
*/
|
|
5945
|
+
date_modified_to?: string;
|
|
5946
|
+
};
|
|
5947
|
+
url: '/site/list';
|
|
5948
|
+
};
|
|
5949
|
+
type SiteControllerListSitesErrors = {
|
|
5950
|
+
/**
|
|
5951
|
+
* 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`.
|
|
5952
|
+
*/
|
|
5953
|
+
400: ApiErrorResponse;
|
|
5954
|
+
/**
|
|
5955
|
+
* 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.
|
|
5956
|
+
*/
|
|
5957
|
+
401: ApiErrorResponse;
|
|
5958
|
+
/**
|
|
5959
|
+
* 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).
|
|
5960
|
+
*/
|
|
5961
|
+
403: ApiErrorResponse;
|
|
5962
|
+
/**
|
|
5963
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
5964
|
+
*/
|
|
5965
|
+
429: ApiErrorResponse;
|
|
5966
|
+
/**
|
|
5967
|
+
* 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.
|
|
5968
|
+
*/
|
|
5969
|
+
500: ApiErrorResponse;
|
|
5970
|
+
};
|
|
5971
|
+
type SiteControllerListSitesError = SiteControllerListSitesErrors[keyof SiteControllerListSitesErrors];
|
|
5972
|
+
type SiteControllerListSitesResponses = {
|
|
5973
|
+
/**
|
|
5974
|
+
* List of sites with pagination info
|
|
5975
|
+
*/
|
|
5976
|
+
200: ListSitesResponseDto;
|
|
5977
|
+
};
|
|
5978
|
+
type SiteControllerListSitesResponse = SiteControllerListSitesResponses[keyof SiteControllerListSitesResponses];
|
|
5979
|
+
type SiteControllerCreateSiteData = {
|
|
5980
|
+
/**
|
|
5981
|
+
* Site creation data
|
|
5982
|
+
*/
|
|
5983
|
+
body: CreateSiteDto;
|
|
5984
|
+
headers?: {
|
|
5985
|
+
/**
|
|
5986
|
+
* 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.
|
|
5987
|
+
*/
|
|
5988
|
+
'Idempotency-Key'?: string;
|
|
5989
|
+
};
|
|
5990
|
+
path?: never;
|
|
5991
|
+
query?: never;
|
|
5992
|
+
url: '/site';
|
|
5993
|
+
};
|
|
5994
|
+
type SiteControllerCreateSiteErrors = {
|
|
5995
|
+
/**
|
|
5996
|
+
* 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`.
|
|
5997
|
+
*/
|
|
5998
|
+
400: ApiErrorResponse;
|
|
5999
|
+
/**
|
|
6000
|
+
* 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.
|
|
6001
|
+
*/
|
|
6002
|
+
401: ApiErrorResponse;
|
|
6003
|
+
/**
|
|
6004
|
+
* 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).
|
|
6005
|
+
*/
|
|
6006
|
+
403: ApiErrorResponse;
|
|
6007
|
+
/**
|
|
6008
|
+
* 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`).
|
|
6009
|
+
*/
|
|
6010
|
+
409: ApiErrorResponse;
|
|
6011
|
+
/**
|
|
6012
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
6013
|
+
*/
|
|
6014
|
+
429: ApiErrorResponse;
|
|
6015
|
+
/**
|
|
6016
|
+
* 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.
|
|
6017
|
+
*/
|
|
6018
|
+
500: ApiErrorResponse;
|
|
6019
|
+
};
|
|
6020
|
+
type SiteControllerCreateSiteError = SiteControllerCreateSiteErrors[keyof SiteControllerCreateSiteErrors];
|
|
6021
|
+
type SiteControllerCreateSiteResponses = {
|
|
6022
|
+
/**
|
|
6023
|
+
* Site successfully created
|
|
6024
|
+
*/
|
|
6025
|
+
201: SiteResponseDto;
|
|
6026
|
+
};
|
|
6027
|
+
type SiteControllerCreateSiteResponse = SiteControllerCreateSiteResponses[keyof SiteControllerCreateSiteResponses];
|
|
6028
|
+
type SiteControllerDeleteSiteData = {
|
|
6029
|
+
body?: never;
|
|
6030
|
+
path: {
|
|
6031
|
+
/**
|
|
6032
|
+
* Site public ID (UUID)
|
|
6033
|
+
*/
|
|
6034
|
+
id: string;
|
|
6035
|
+
};
|
|
6036
|
+
query?: never;
|
|
6037
|
+
url: '/site/{id}';
|
|
6038
|
+
};
|
|
6039
|
+
type SiteControllerDeleteSiteErrors = {
|
|
6040
|
+
/**
|
|
6041
|
+
* 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.
|
|
6042
|
+
*/
|
|
6043
|
+
401: ApiErrorResponse;
|
|
6044
|
+
/**
|
|
6045
|
+
* 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).
|
|
6046
|
+
*/
|
|
6047
|
+
403: ApiErrorResponse;
|
|
6048
|
+
/**
|
|
6049
|
+
* 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.
|
|
6050
|
+
*/
|
|
6051
|
+
404: ApiErrorResponse;
|
|
6052
|
+
/**
|
|
6053
|
+
* Rate limit exceeded for this API key. Inspect `X-RateLimit-Reset` and `Retry-After` to find out when the window resets.
|
|
6054
|
+
*/
|
|
6055
|
+
429: ApiErrorResponse;
|
|
6056
|
+
/**
|
|
6057
|
+
* 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.
|
|
6058
|
+
*/
|
|
6059
|
+
500: ApiErrorResponse;
|
|
6060
|
+
};
|
|
6061
|
+
type SiteControllerDeleteSiteError = SiteControllerDeleteSiteErrors[keyof SiteControllerDeleteSiteErrors];
|
|
6062
|
+
type SiteControllerDeleteSiteResponses = {
|
|
6063
|
+
/**
|
|
6064
|
+
* Site successfully deleted
|
|
6065
|
+
*/
|
|
6066
|
+
200: DeleteSiteResponseDto;
|
|
6067
|
+
};
|
|
6068
|
+
type SiteControllerDeleteSiteResponse = SiteControllerDeleteSiteResponses[keyof SiteControllerDeleteSiteResponses];
|
|
3682
6069
|
type SiteControllerUpdateSiteData = {
|
|
3683
6070
|
/**
|
|
3684
6071
|
* Site update data
|
|
@@ -3763,6 +6150,7 @@ declare const assetControllerCreateAssetPublic: <ThrowOnError extends boolean =
|
|
|
3763
6150
|
companyId?: string;
|
|
3764
6151
|
assetPhotoFile?: string | null;
|
|
3765
6152
|
assetPhotoInfo?: string | null;
|
|
6153
|
+
asset_photo_url?: string | null;
|
|
3766
6154
|
lat?: number | null;
|
|
3767
6155
|
lng?: number | null;
|
|
3768
6156
|
createdById?: string;
|
|
@@ -3788,6 +6176,7 @@ declare const assetControllerListAssets: <ThrowOnError extends boolean = false>(
|
|
|
3788
6176
|
companyId?: string;
|
|
3789
6177
|
assetPhotoFile?: string | null;
|
|
3790
6178
|
assetPhotoInfo?: string | null;
|
|
6179
|
+
asset_photo_url?: string | null;
|
|
3791
6180
|
lat?: number | null;
|
|
3792
6181
|
lng?: number | null;
|
|
3793
6182
|
createdById?: string;
|
|
@@ -3819,6 +6208,7 @@ declare const assetControllerGetAsset: <ThrowOnError extends boolean = false>(op
|
|
|
3819
6208
|
companyId?: string;
|
|
3820
6209
|
assetPhotoFile?: string | null;
|
|
3821
6210
|
assetPhotoInfo?: string | null;
|
|
6211
|
+
asset_photo_url?: string | null;
|
|
3822
6212
|
lat?: number | null;
|
|
3823
6213
|
lng?: number | null;
|
|
3824
6214
|
createdById?: string;
|
|
@@ -3843,6 +6233,7 @@ declare const assetControllerUpdateAsset: <ThrowOnError extends boolean = false>
|
|
|
3843
6233
|
companyId?: string;
|
|
3844
6234
|
assetPhotoFile?: string | null;
|
|
3845
6235
|
assetPhotoInfo?: string | null;
|
|
6236
|
+
asset_photo_url?: string | null;
|
|
3846
6237
|
lat?: number | null;
|
|
3847
6238
|
lng?: number | null;
|
|
3848
6239
|
createdById?: string;
|
|
@@ -4084,6 +6475,41 @@ declare const publicConfigControllerUpdateConfigItem: <ThrowOnError extends bool
|
|
|
4084
6475
|
* Creates a config item (e.g. a new asset category) under the given config_table_id, which must belong to the authenticated company. Requires company:settings:tables. Supports `Idempotency-Key`.
|
|
4085
6476
|
*/
|
|
4086
6477
|
declare const publicConfigControllerCreateConfigItem: <ThrowOnError extends boolean = false>(options: Options<PublicConfigControllerCreateConfigItemData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ConfigItemDto, ApiErrorResponse, ThrowOnError>;
|
|
6478
|
+
/**
|
|
6479
|
+
* Delete an asset class property by ID
|
|
6480
|
+
* Soft-deletes an asset class custom property value (writes a history record). Company-scoped. Requires asset-class:update.
|
|
6481
|
+
*/
|
|
6482
|
+
declare const assetClassPropertyControllerRemove: <ThrowOnError extends boolean = false>(options: Options<AssetClassPropertyControllerRemoveData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteAssetClassPropertyResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6483
|
+
/**
|
|
6484
|
+
* Update an asset class property value by ID
|
|
6485
|
+
* Updates the value of an asset class custom property. The value is stored in text_value, numeric_value, or date_value based on the property type in config_items, and a history record is written. Company-scoped. Requires asset-class:update. Supports `Idempotency-Key`.
|
|
6486
|
+
*/
|
|
6487
|
+
declare const assetClassPropertyControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<AssetClassPropertyControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AssetClassPropertyResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6488
|
+
/**
|
|
6489
|
+
* Get a presigned URL to upload a document file
|
|
6490
|
+
* Returns a short-lived presigned S3 PUT URL and the resulting key. Upload the file with PUT, then create/update a document referencing the key as `attachment_file`. Any valid API key may request one (the key is scoped to your company folder; creating the document still needs the per-type create permission).
|
|
6491
|
+
*/
|
|
6492
|
+
declare const documentUploadControllerUploadUrl: <ThrowOnError extends boolean = false>(options: Options<DocumentUploadControllerUploadUrlData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DocumentUploadUrlResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6493
|
+
/**
|
|
6494
|
+
* List asset documents
|
|
6495
|
+
*/
|
|
6496
|
+
declare const assetDocumentControllerList: <ThrowOnError extends boolean = false>(options?: Options<AssetDocumentControllerListData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListDocumentsResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6497
|
+
/**
|
|
6498
|
+
* Delete an asset document
|
|
6499
|
+
*/
|
|
6500
|
+
declare const assetDocumentControllerRemove: <ThrowOnError extends boolean = false>(options: Options<AssetDocumentControllerRemoveData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DeleteDocumentResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6501
|
+
/**
|
|
6502
|
+
* Get an asset document
|
|
6503
|
+
*/
|
|
6504
|
+
declare const assetDocumentControllerGet: <ThrowOnError extends boolean = false>(options: Options<AssetDocumentControllerGetData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DocumentResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6505
|
+
/**
|
|
6506
|
+
* Update an asset document
|
|
6507
|
+
*/
|
|
6508
|
+
declare const assetDocumentControllerUpdate: <ThrowOnError extends boolean = false>(options: Options<AssetDocumentControllerUpdateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DocumentResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
6509
|
+
/**
|
|
6510
|
+
* Create an asset document
|
|
6511
|
+
*/
|
|
6512
|
+
declare const assetDocumentControllerCreate: <ThrowOnError extends boolean = false>(options: Options<AssetDocumentControllerCreateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<DocumentResponseDto, ApiErrorResponse, ThrowOnError>;
|
|
4087
6513
|
/**
|
|
4088
6514
|
* List sites
|
|
4089
6515
|
* 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.
|
|
@@ -4185,6 +6611,34 @@ interface UserPropertiesResource {
|
|
|
4185
6611
|
update: (options: WakataMethodOptions<Parameters<typeof userPropertyControllerUpdateUserProperty>[0]>) => Promise<Awaited<ReturnType<typeof userPropertyControllerUpdateUserProperty>>['data']>;
|
|
4186
6612
|
delete: (options: WakataMethodOptions<Parameters<typeof userPropertyControllerDeleteUserProperty>[0]>) => Promise<Awaited<ReturnType<typeof userPropertyControllerDeleteUserProperty>>['data']>;
|
|
4187
6613
|
}
|
|
6614
|
+
interface AssetClassPropertiesResource {
|
|
6615
|
+
update: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerUpdate>>['data']>;
|
|
6616
|
+
delete: (options: WakataMethodOptions<Parameters<typeof assetClassPropertyControllerRemove>[0]>) => Promise<Awaited<ReturnType<typeof assetClassPropertyControllerRemove>>['data']>;
|
|
6617
|
+
}
|
|
6618
|
+
/**
|
|
6619
|
+
* One entity-document type's CRUD. All document types share the same DTOs, so
|
|
6620
|
+
* the shape is typed against the asset-document operations (structurally
|
|
6621
|
+
* identical across types).
|
|
6622
|
+
*/
|
|
6623
|
+
interface DocumentTypeResource {
|
|
6624
|
+
list: (options?: WakataMethodOptions<Parameters<typeof assetDocumentControllerList>[0] extends infer O ? O : never>) => Promise<Awaited<ReturnType<typeof assetDocumentControllerList>>['data']>;
|
|
6625
|
+
get: (options: WakataMethodOptions<Parameters<typeof assetDocumentControllerGet>[0]>) => Promise<Awaited<ReturnType<typeof assetDocumentControllerGet>>['data']>;
|
|
6626
|
+
create: (options: WakataMethodOptions<Parameters<typeof assetDocumentControllerCreate>[0]>) => Promise<Awaited<ReturnType<typeof assetDocumentControllerCreate>>['data']>;
|
|
6627
|
+
update: (options: WakataMethodOptions<Parameters<typeof assetDocumentControllerUpdate>[0]>) => Promise<Awaited<ReturnType<typeof assetDocumentControllerUpdate>>['data']>;
|
|
6628
|
+
delete: (options: WakataMethodOptions<Parameters<typeof assetDocumentControllerRemove>[0]>) => Promise<Awaited<ReturnType<typeof assetDocumentControllerRemove>>['data']>;
|
|
6629
|
+
}
|
|
6630
|
+
interface DocumentsResource {
|
|
6631
|
+
/** Presigned S3 PUT URL + key; upload then create a document with the key. */
|
|
6632
|
+
uploadUrl: (options: WakataMethodOptions<Parameters<typeof documentUploadControllerUploadUrl>[0]>) => Promise<Awaited<ReturnType<typeof documentUploadControllerUploadUrl>>['data']>;
|
|
6633
|
+
asset: DocumentTypeResource;
|
|
6634
|
+
assetClass: DocumentTypeResource;
|
|
6635
|
+
user: DocumentTypeResource;
|
|
6636
|
+
site: DocumentTypeResource;
|
|
6637
|
+
customer: DocumentTypeResource;
|
|
6638
|
+
project: DocumentTypeResource;
|
|
6639
|
+
job: DocumentTypeResource;
|
|
6640
|
+
company: DocumentTypeResource;
|
|
6641
|
+
}
|
|
4188
6642
|
/**
|
|
4189
6643
|
* The main entry point for the Wakata API client.
|
|
4190
6644
|
*
|
|
@@ -4213,6 +6667,8 @@ declare class WakataClient {
|
|
|
4213
6667
|
readonly userProperties: UserPropertiesResource;
|
|
4214
6668
|
readonly checklists: ChecklistsResource;
|
|
4215
6669
|
readonly config: ConfigResource;
|
|
6670
|
+
readonly assetClassProperties: AssetClassPropertiesResource;
|
|
6671
|
+
readonly documents: DocumentsResource;
|
|
4216
6672
|
constructor(options: WakataClientOptions);
|
|
4217
6673
|
}
|
|
4218
6674
|
|
|
@@ -4382,8 +6838,8 @@ declare function generateIdempotencyKey(): string;
|
|
|
4382
6838
|
* See README.md for usage.
|
|
4383
6839
|
*/
|
|
4384
6840
|
declare const PACKAGE_NAME = "@wakata-dev/api-client";
|
|
4385
|
-
declare const PACKAGE_VERSION = "0.3.
|
|
6841
|
+
declare const PACKAGE_VERSION = "0.3.3";
|
|
4386
6842
|
/** Default base URL for the Wakata Public API (production). */
|
|
4387
6843
|
declare const DEFAULT_BASE_URL = "https://api.wakata.ai/api/v1";
|
|
4388
6844
|
|
|
4389
|
-
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 AssetClassListResponseDto, 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 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 ConfigItemDto, type ConfigTableDto, type CreateAssetClassDto, type CreateConfigItemDto, type CreateSiteDto, DEFAULT_BASE_URL, type DeleteAssetPropertyResponseDto, type DeleteSiteResponseDto, type DeleteUserPropertyResponseDto, 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 ListChecklistsResponseDto, type ListConfigItemsResponseDto, type ListConfigTablesResponseDto, type ListInspectionsResponseDto, type ListIssuesResponseDto, type ListSitesResponseDto, PACKAGE_NAME, PACKAGE_VERSION, 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 SiteResponseDto, type SitesResource, type UpdateAssetClassDto, type UpdateAssetDto, type UpdateAssetPropertyDto, type UpdateConfigItemDto, 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 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 };
|
|
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 };
|