@truepic/vision-api-types 3.90.0 → 3.91.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +56 -420
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -11,7 +11,7 @@ export interface paths {
11
11
  path?: never;
12
12
  cookie?: never;
13
13
  };
14
- /** Get a list of all landing pages */
14
+ /** Get a list of landing pages */
15
15
  get: {
16
16
  parameters: {
17
17
  query?: never;
@@ -190,7 +190,7 @@ export interface paths {
190
190
  path?: never;
191
191
  cookie?: never;
192
192
  };
193
- /** Get a list of inspection requests */
193
+ /** Get a list of inspections */
194
194
  get: {
195
195
  parameters: {
196
196
  query?: {
@@ -674,65 +674,6 @@ export interface paths {
674
674
  patch?: never;
675
675
  trace?: never;
676
676
  };
677
- "/inspections/{excludeText}": {
678
- parameters: {
679
- query?: never;
680
- header?: never;
681
- path?: never;
682
- cookie?: never;
683
- };
684
- get?: never;
685
- put?: never;
686
- /** Create an inspection */
687
- post: {
688
- parameters: {
689
- query?: {
690
- /**
691
- * @description The top-level `result` fields to include in the response.
692
- *
693
- * If not set, all fields are included by default. If set, `id`, `created_at`, and `updated_at` are always included as a baseline.
694
- */
695
- include?: string[];
696
- };
697
- header?: never;
698
- path: {
699
- /**
700
- * @description When provided, the inspection will be sent but the user will not be notified via text message.
701
- * @example exclude-text
702
- */
703
- excludeText: string;
704
- };
705
- cookie?: never;
706
- };
707
- requestBody: {
708
- content: {
709
- "application/json": components["schemas"]["CreateInspectionBody"];
710
- };
711
- };
712
- responses: {
713
- /** @description Request Successful */
714
- 200: {
715
- headers: {
716
- [name: string]: unknown;
717
- };
718
- content: {
719
- "application/json": components["schemas"]["CreateInspectionResult"];
720
- };
721
- };
722
- 400: components["responses"]["ErrorBadRequest"];
723
- 401: components["responses"]["ErrorUnauthorized"];
724
- 403: components["responses"]["ErrorForbidden"];
725
- 404: components["responses"]["ErrorNotFound"];
726
- 412: components["responses"]["ErrorPreconditionFailed"];
727
- 500: components["responses"]["ErrorUnhandled"];
728
- };
729
- };
730
- delete?: never;
731
- options?: never;
732
- head?: never;
733
- patch?: never;
734
- trace?: never;
735
- };
736
677
  "/inspections/{inspectionId}/complete": {
737
678
  parameters: {
738
679
  query?: never;
@@ -958,11 +899,6 @@ export interface paths {
958
899
  * @example 3.0.0
959
900
  */
960
901
  api_version: string;
961
- /**
962
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
963
- * @example announcement_internal_name_taken
964
- */
965
- error_code?: string;
966
902
  /**
967
903
  * @description The human-readable status of the response
968
904
  * @example Success
@@ -1027,11 +963,6 @@ export interface paths {
1027
963
  * @example 3.0.0
1028
964
  */
1029
965
  api_version: string;
1030
- /**
1031
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
1032
- * @example announcement_internal_name_taken
1033
- */
1034
- error_code?: string;
1035
966
  /**
1036
967
  * @description The human-readable status of the response
1037
968
  * @example Success
@@ -1267,11 +1198,6 @@ export interface paths {
1267
1198
  * @example 3.0.0
1268
1199
  */
1269
1200
  api_version: string;
1270
- /**
1271
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
1272
- * @example announcement_internal_name_taken
1273
- */
1274
- error_code?: string;
1275
1201
  /**
1276
1202
  * @description The human-readable status of the response
1277
1203
  * @example Success
@@ -1334,7 +1260,15 @@ export interface paths {
1334
1260
  "application/json": components["schemas"]["CreateUserResult"];
1335
1261
  };
1336
1262
  };
1337
- 400: components["responses"]["ErrorBadRequest"];
1263
+ /** @description Validation error, or the email's login is already linked to another Vision user (`error_code: auth_zero_account_linked_to_other_user`). */
1264
+ 400: {
1265
+ headers: {
1266
+ [name: string]: unknown;
1267
+ };
1268
+ content: {
1269
+ "application/json": components["schemas"]["ErrorResponseData"];
1270
+ };
1271
+ };
1338
1272
  401: components["responses"]["ErrorUnauthorized"];
1339
1273
  403: components["responses"]["ErrorForbidden"];
1340
1274
  404: components["responses"]["ErrorNotFound"];
@@ -1420,11 +1354,6 @@ export interface paths {
1420
1354
  * @example 3.0.0
1421
1355
  */
1422
1356
  api_version: string;
1423
- /**
1424
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
1425
- * @example announcement_internal_name_taken
1426
- */
1427
- error_code?: string;
1428
1357
  /**
1429
1358
  * @description The ID of the newly created resource
1430
1359
  * @example 5
@@ -1480,11 +1409,6 @@ export interface paths {
1480
1409
  * @example 3.0.0
1481
1410
  */
1482
1411
  api_version: string;
1483
- /**
1484
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
1485
- * @example announcement_internal_name_taken
1486
- */
1487
- error_code?: string;
1488
1412
  /**
1489
1413
  * @description The ID of the newly created resource
1490
1414
  * @example 5
@@ -1689,11 +1613,6 @@ export interface paths {
1689
1613
  * @example 3.0.0
1690
1614
  */
1691
1615
  api_version: string;
1692
- /**
1693
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
1694
- * @example announcement_internal_name_taken
1695
- */
1696
- error_code?: string;
1697
1616
  /**
1698
1617
  * @description The ID of the newly created resource
1699
1618
  * @example 5
@@ -1763,7 +1682,7 @@ export interface paths {
1763
1682
  500: components["responses"]["ErrorUnhandled"];
1764
1683
  };
1765
1684
  };
1766
- /** Update team */
1685
+ /** Update a team */
1767
1686
  put: {
1768
1687
  parameters: {
1769
1688
  query?: never;
@@ -1814,7 +1733,7 @@ export interface paths {
1814
1733
  get?: never;
1815
1734
  put?: never;
1816
1735
  /**
1817
- * Upload team assets
1736
+ * Upload a team logo or icon
1818
1737
  * @description Upload a team logo or icon image. Accepts PNG files only. Logo images must be at least 369x102 (WxH). Icon images must be at least 180x180. Attach one file as the multipart field asset. The file must be nonempty and no larger than 1,000,000 bytes; larger files return 413. The response contains PNG URLs for the generated sizes.
1819
1738
  */
1820
1739
  post: {
@@ -1876,7 +1795,7 @@ export interface paths {
1876
1795
  cookie?: never;
1877
1796
  };
1878
1797
  /**
1879
- * Get a list of teams
1798
+ * Get a list of an organization's teams
1880
1799
  * @deprecated
1881
1800
  */
1882
1801
  get: {
@@ -1968,7 +1887,7 @@ export interface paths {
1968
1887
  path?: never;
1969
1888
  cookie?: never;
1970
1889
  };
1971
- /** Get lists */
1890
+ /** Get a list of lists */
1972
1891
  get: {
1973
1892
  parameters: {
1974
1893
  query?: {
@@ -2063,11 +1982,6 @@ export interface paths {
2063
1982
  * @example 3.0.0
2064
1983
  */
2065
1984
  api_version: string;
2066
- /**
2067
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2068
- * @example announcement_internal_name_taken
2069
- */
2070
- error_code?: string;
2071
1985
  /**
2072
1986
  * @description The human-readable status of the response
2073
1987
  * @example Success
@@ -2214,7 +2128,7 @@ export interface paths {
2214
2128
  path?: never;
2215
2129
  cookie?: never;
2216
2130
  };
2217
- /** Get an existing operation to track its progress */
2131
+ /** Get an operation */
2218
2132
  get: {
2219
2133
  parameters: {
2220
2134
  query?: never;
@@ -2261,7 +2175,7 @@ export interface paths {
2261
2175
  };
2262
2176
  get?: never;
2263
2177
  /**
2264
- * Send the original inspection request via text/email.
2178
+ * Send the original inspection request by text or email
2265
2179
  * @description The inspection must be Created or Started. Generates a new inspection link and optionally updates the list. A 200 response confirms that the operation completed and any enabled delivery jobs were queued; it does not prove delivery. A disabled send_methods channel is skipped, and a queued job may skip sending when no usable recipient is available.
2266
2180
  */
2267
2181
  put: {
@@ -2310,7 +2224,7 @@ export interface paths {
2310
2224
  };
2311
2225
  get?: never;
2312
2226
  /**
2313
- * Send a request for more photos/videos via text/email.
2227
+ * Send a request for more photos or videos by text or email
2314
2228
  * @description The inspection must be Created, Started, In Progress, Processing, or Ready for Review. Processing and Ready for Review move back to In Progress and clear finished_at and ready_at. The operation clears expiration, generates a new inspection link, and optionally replaces list items. To mark an item incomplete, include its existing ID and set incomplete=true. A 200 response confirms that the operation completed and any enabled delivery jobs were queued; it does not prove delivery. A disabled send_methods channel is skipped, and a queued job may skip sending when no usable recipient is available.
2315
2229
  */
2316
2230
  put: {
@@ -2359,7 +2273,7 @@ export interface paths {
2359
2273
  };
2360
2274
  get?: never;
2361
2275
  /**
2362
- * Send a reminder to start the inspection via text/email.
2276
+ * Send a reminder to start the inspection by text or email
2363
2277
  * @description Reuses the current inspection link when available, otherwise generates one, and clears the expiration marker. This route does not restrict the inspection status or change it. A 200 response confirms that the operation completed and any enabled delivery jobs were queued; it does not prove delivery. A disabled send_methods channel is skipped, and a queued job may skip sending when no usable recipient is available.
2364
2278
  */
2365
2279
  put: {
@@ -2408,7 +2322,7 @@ export interface paths {
2408
2322
  };
2409
2323
  get?: never;
2410
2324
  /**
2411
- * Send a reminder to finish the inspection via text/email.
2325
+ * Send a reminder to finish the inspection by text or email
2412
2326
  * @description Reuses the current inspection link when available, otherwise generates one, and clears the expiration marker. This route does not restrict the inspection status or change it. A 200 response confirms that the operation completed and any enabled delivery jobs were queued; it does not prove delivery. A disabled send_methods channel is skipped, and a queued job may skip sending when no usable recipient is available.
2413
2327
  */
2414
2328
  put: {
@@ -2456,7 +2370,7 @@ export interface paths {
2456
2370
  cookie?: never;
2457
2371
  };
2458
2372
  /**
2459
- * Get API Status
2373
+ * Get the API status
2460
2374
  * @description Can also use /online path
2461
2375
  */
2462
2376
  get: {
@@ -2480,11 +2394,6 @@ export interface paths {
2480
2394
  * @example 3.0.0
2481
2395
  */
2482
2396
  api_version: string;
2483
- /**
2484
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2485
- * @example announcement_internal_name_taken
2486
- */
2487
- error_code?: string;
2488
2397
  /**
2489
2398
  * @description The human-readable status of the response
2490
2399
  * @example Success
@@ -2514,102 +2423,6 @@ export interface paths {
2514
2423
  patch?: never;
2515
2424
  trace?: never;
2516
2425
  };
2517
- "/ready": {
2518
- parameters: {
2519
- query?: never;
2520
- header?: never;
2521
- path?: never;
2522
- cookie?: never;
2523
- };
2524
- /**
2525
- * Readiness probe
2526
- * @description Returns 200 when the API is ready to serve traffic (DB reachable), 503 otherwise. Intended for K8s readinessProbe.
2527
- */
2528
- get: {
2529
- parameters: {
2530
- query?: never;
2531
- header?: never;
2532
- path?: never;
2533
- cookie?: never;
2534
- };
2535
- requestBody?: never;
2536
- responses: {
2537
- /** @description Ready */
2538
- 200: {
2539
- headers: {
2540
- [name: string]: unknown;
2541
- };
2542
- content: {
2543
- "application/json": {
2544
- /**
2545
- * @description The current version number of the Vision API
2546
- * @example 3.0.0
2547
- */
2548
- api_version: string;
2549
- /**
2550
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2551
- * @example announcement_internal_name_taken
2552
- */
2553
- error_code?: string;
2554
- /**
2555
- * @description The human-readable status of the response
2556
- * @example Success
2557
- */
2558
- message: string;
2559
- /**
2560
- * @description The HTTP status code of the response
2561
- * @example 200
2562
- */
2563
- response_code: number;
2564
- };
2565
- };
2566
- };
2567
- 400: components["responses"]["ErrorBadRequest"];
2568
- 401: components["responses"]["ErrorUnauthorized"];
2569
- 403: components["responses"]["ErrorForbidden"];
2570
- 404: components["responses"]["ErrorNotFound"];
2571
- 412: components["responses"]["ErrorPreconditionFailed"];
2572
- 500: components["responses"]["ErrorUnhandled"];
2573
- /** @description Not ready */
2574
- 503: {
2575
- headers: {
2576
- [name: string]: unknown;
2577
- };
2578
- content: {
2579
- "application/json": {
2580
- /**
2581
- * @description The current version number of the Vision API
2582
- * @example 3.0.0
2583
- */
2584
- api_version: string;
2585
- /**
2586
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2587
- * @example announcement_internal_name_taken
2588
- */
2589
- error_code?: string;
2590
- /**
2591
- * @description The human-readable status of the response
2592
- * @example Success
2593
- */
2594
- message: string;
2595
- /**
2596
- * @description The HTTP status code of the response
2597
- * @example 200
2598
- */
2599
- response_code: number;
2600
- };
2601
- };
2602
- };
2603
- };
2604
- };
2605
- put?: never;
2606
- post?: never;
2607
- delete?: never;
2608
- options?: never;
2609
- head?: never;
2610
- patch?: never;
2611
- trace?: never;
2612
- };
2613
2426
  "/inspection-types": {
2614
2427
  parameters: {
2615
2428
  query?: never;
@@ -2721,11 +2534,6 @@ export interface paths {
2721
2534
  * @example 3.0.0
2722
2535
  */
2723
2536
  api_version: string;
2724
- /**
2725
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2726
- * @example announcement_internal_name_taken
2727
- */
2728
- error_code?: string;
2729
2537
  /**
2730
2538
  * @description The human-readable status of the response
2731
2539
  * @example Success
@@ -2771,7 +2579,7 @@ export interface paths {
2771
2579
  path?: never;
2772
2580
  cookie?: never;
2773
2581
  };
2774
- /** Get an inspection type by id */
2582
+ /** Get an inspection type */
2775
2583
  get: {
2776
2584
  parameters: {
2777
2585
  query?: never;
@@ -2864,11 +2672,6 @@ export interface paths {
2864
2672
  * @example 3.0.0
2865
2673
  */
2866
2674
  api_version: string;
2867
- /**
2868
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
2869
- * @example announcement_internal_name_taken
2870
- */
2871
- error_code?: string;
2872
2675
  /**
2873
2676
  * @description The human-readable status of the response
2874
2677
  * @example Success
@@ -2997,11 +2800,6 @@ export interface paths {
2997
2800
  * @example 3.0.0
2998
2801
  */
2999
2802
  api_version: string;
3000
- /**
3001
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3002
- * @example announcement_internal_name_taken
3003
- */
3004
- error_code?: string;
3005
2803
  /**
3006
2804
  * @description The human-readable status of the response
3007
2805
  * @example Success
@@ -3038,7 +2836,7 @@ export interface paths {
3038
2836
  path?: never;
3039
2837
  cookie?: never;
3040
2838
  };
3041
- /** Get a message template set by id */
2839
+ /** Get a message template set */
3042
2840
  get: {
3043
2841
  parameters: {
3044
2842
  query?: never;
@@ -3097,11 +2895,6 @@ export interface paths {
3097
2895
  * @example 3.0.0
3098
2896
  */
3099
2897
  api_version: string;
3100
- /**
3101
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3102
- * @example announcement_internal_name_taken
3103
- */
3104
- error_code?: string;
3105
2898
  /**
3106
2899
  * @description The human-readable status of the response
3107
2900
  * @example Success
@@ -3149,11 +2942,6 @@ export interface paths {
3149
2942
  * @example 3.0.0
3150
2943
  */
3151
2944
  api_version: string;
3152
- /**
3153
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3154
- * @example announcement_internal_name_taken
3155
- */
3156
- error_code?: string;
3157
2945
  /**
3158
2946
  * @description The human-readable status of the response
3159
2947
  * @example Success
@@ -3227,7 +3015,7 @@ export interface paths {
3227
3015
  path?: never;
3228
3016
  cookie?: never;
3229
3017
  };
3230
- /** Get a list of all webhooks */
3018
+ /** Get a list of webhooks */
3231
3019
  get: {
3232
3020
  parameters: {
3233
3021
  query?: {
@@ -3266,11 +3054,6 @@ export interface paths {
3266
3054
  * @example 3.0.0
3267
3055
  */
3268
3056
  api_version: string;
3269
- /**
3270
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3271
- * @example announcement_internal_name_taken
3272
- */
3273
- error_code?: string;
3274
3057
  /**
3275
3058
  * @description The human-readable status of the response
3276
3059
  * @example Success
@@ -3336,11 +3119,6 @@ export interface paths {
3336
3119
  * @example 3.0.0
3337
3120
  */
3338
3121
  api_version: string;
3339
- /**
3340
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3341
- * @example announcement_internal_name_taken
3342
- */
3343
- error_code?: string;
3344
3122
  /**
3345
3123
  * @description The human-readable status of the response
3346
3124
  * @example Success
@@ -3377,7 +3155,7 @@ export interface paths {
3377
3155
  path?: never;
3378
3156
  cookie?: never;
3379
3157
  };
3380
- /** Get a specific webhook */
3158
+ /** Get a webhook */
3381
3159
  get: {
3382
3160
  parameters: {
3383
3161
  query?: never;
@@ -3402,11 +3180,6 @@ export interface paths {
3402
3180
  * @example 3.0.0
3403
3181
  */
3404
3182
  api_version: string;
3405
- /**
3406
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3407
- * @example announcement_internal_name_taken
3408
- */
3409
- error_code?: string;
3410
3183
  /**
3411
3184
  * @description The human-readable status of the response
3412
3185
  * @example Success
@@ -3458,11 +3231,6 @@ export interface paths {
3458
3231
  * @example 3.0.0
3459
3232
  */
3460
3233
  api_version: string;
3461
- /**
3462
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3463
- * @example announcement_internal_name_taken
3464
- */
3465
- error_code?: string;
3466
3234
  /**
3467
3235
  * @description The human-readable status of the response
3468
3236
  * @example Success
@@ -3510,11 +3278,6 @@ export interface paths {
3510
3278
  * @example 3.0.0
3511
3279
  */
3512
3280
  api_version: string;
3513
- /**
3514
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3515
- * @example announcement_internal_name_taken
3516
- */
3517
- error_code?: string;
3518
3281
  /**
3519
3282
  * @description The human-readable status of the response
3520
3283
  * @example Success
@@ -3549,7 +3312,7 @@ export interface paths {
3549
3312
  cookie?: never;
3550
3313
  };
3551
3314
  /**
3552
- * List delivery attempts for a webhook
3315
+ * Get a list of a webhook's delivery attempts
3553
3316
  * @description Every attempt to deliver an event to this webhook, newest first, including automatic retries and resends. Deliveries are kept for the number of days in `retention_days`. Request and response bodies are left out; fetch a single delivery to read them.
3554
3317
  */
3555
3318
  get: {
@@ -3593,11 +3356,6 @@ export interface paths {
3593
3356
  * @example 3.0.0
3594
3357
  */
3595
3358
  api_version: string;
3596
- /**
3597
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3598
- * @example announcement_internal_name_taken
3599
- */
3600
- error_code?: string;
3601
3359
  /**
3602
3360
  * @description The human-readable status of the response
3603
3361
  * @example Success
@@ -3657,7 +3415,7 @@ export interface paths {
3657
3415
  cookie?: never;
3658
3416
  };
3659
3417
  /**
3660
- * Get a single webhook delivery attempt
3418
+ * Get a webhook delivery attempt
3661
3419
  * @description One delivery in full, including the exact body that was sent and the body your endpoint responded with.
3662
3420
  */
3663
3421
  get: {
@@ -3686,11 +3444,6 @@ export interface paths {
3686
3444
  * @example 3.0.0
3687
3445
  */
3688
3446
  api_version: string;
3689
- /**
3690
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3691
- * @example announcement_internal_name_taken
3692
- */
3693
- error_code?: string;
3694
3447
  /**
3695
3448
  * @description The human-readable status of the response
3696
3449
  * @example Success
@@ -3760,11 +3513,6 @@ export interface paths {
3760
3513
  * @example 3.0.0
3761
3514
  */
3762
3515
  api_version: string;
3763
- /**
3764
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
3765
- * @example announcement_internal_name_taken
3766
- */
3767
- error_code?: string;
3768
3516
  /**
3769
3517
  * @description The ID of the newly created resource
3770
3518
  * @example 5
@@ -3804,7 +3552,7 @@ export interface paths {
3804
3552
  path?: never;
3805
3553
  cookie?: never;
3806
3554
  };
3807
- /** Get a list of all website forms */
3555
+ /** Get a list of website forms */
3808
3556
  get: {
3809
3557
  parameters: {
3810
3558
  query?: {
@@ -4001,7 +3749,7 @@ export interface paths {
4001
3749
  cookie?: never;
4002
3750
  };
4003
3751
  /**
4004
- * List AI Item Types for the organization
3752
+ * Get a list of AI item types
4005
3753
  * @description Requires the ai_analysis_configuration organization feature. Returns all matching templates without pagination. Unknown top-level query parameters are ignored.
4006
3754
  */
4007
3755
  get: {
@@ -4034,7 +3782,7 @@ export interface paths {
4034
3782
  };
4035
3783
  put?: never;
4036
3784
  /**
4037
- * Create an AI Item Type for the organization
3785
+ * Create an AI item type
4038
3786
  * @description Requires the ai_analysis_configuration organization feature. Creates the complete template and links it to the supplied inspection types in the same organization. This legacy operation immediately publishes their AI configuration. Fields and look-for entries are limited to 20 each; positions are normalized when saved.
4039
3787
  */
4040
3788
  post: {
@@ -4094,7 +3842,7 @@ export interface paths {
4094
3842
  };
4095
3843
  get?: never;
4096
3844
  /**
4097
- * Replace an AI Item Type (replace-by-tree)
3845
+ * Replace an AI item type
4098
3846
  * @description Requires the ai_analysis_configuration organization feature. Replaces the complete tree, including for other inspection types sharing this template. Omitted child collections become empty; omitted children are removed. Keep existing field IDs and look-for UUIDs to retain their identities. Top-level id and inspection_type_ids are forbidden; use the link/unlink endpoints to change associations.
4099
3847
  */
4100
3848
  put: {
@@ -4142,7 +3890,7 @@ export interface paths {
4142
3890
  };
4143
3891
  };
4144
3892
  post?: never;
4145
- /** Delete an AI Item Type */
3893
+ /** Delete an AI item type */
4146
3894
  delete: {
4147
3895
  parameters: {
4148
3896
  query?: never;
@@ -4198,7 +3946,7 @@ export interface paths {
4198
3946
  };
4199
3947
  get?: never;
4200
3948
  put?: never;
4201
- /** Link an AI Item Type to an Inspection Type */
3949
+ /** Link an AI item type to an inspection type */
4202
3950
  post: {
4203
3951
  parameters: {
4204
3952
  query?: never;
@@ -4646,11 +4394,6 @@ export interface components {
4646
4394
  * @example 3.0.0
4647
4395
  */
4648
4396
  api_version: string;
4649
- /**
4650
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
4651
- * @example announcement_internal_name_taken
4652
- */
4653
- error_code?: string;
4654
4397
  /**
4655
4398
  * @description The human-readable status of the response
4656
4399
  * @example Success
@@ -4812,11 +4555,6 @@ export interface components {
4812
4555
  * @example 3.0.0
4813
4556
  */
4814
4557
  api_version: string;
4815
- /**
4816
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
4817
- * @example announcement_internal_name_taken
4818
- */
4819
- error_code?: string;
4820
4558
  /** @description The ID of the newly created inspection. */
4821
4559
  id: number;
4822
4560
  /**
@@ -5172,6 +4910,29 @@ export interface components {
5172
4910
  DeviceFlagType: "rooted_device" | "spoofed_location" | "falsified_time" | "incorrect_location" | "picture_of_photo" | "bad_photo" | "deleted_photos" | "bad_answer" | "other";
5173
4911
  /** @enum {string} */
5174
4912
  DeviceValidationStatus: "VALID" | "REQUEST_ID_MISMATCH" | "REQUEST_ID_MISSING" | "FETCH_FROM_FINGERPRINT_FAILED" | "TIMESTAMP_TOO_FAR_IN_PAST" | "TIMESTAMP_TOO_FAR_IN_FUTURE" | "TIMESTAMP_MISSING" | "TIMESTAMP_INVALID" | "NO_FINGERPRINT_DATA" | "FINGERPRINT_NOT_COLLECTED" | "FINGERPRINT_SKIPPED" | "FINGERPRINT_NO_API_KEY" | "FINGERPRINT_NO_INSPECTION_ID" | "FINGERPRINT_BLOCKED" | "FINGERPRINT_REQUEST_FAILED" | "INVALID_FINGERPRINT_DATA" | "DECRYPT_FINGERPRINT_FAIL" | "FINGERPRINT_CONFIDENCE_LOW";
4913
+ /** @description The format for Vision API 4xx responses */
4914
+ ErrorResponseData: {
4915
+ /**
4916
+ * @description The current version number of the Vision API
4917
+ * @example 3.0.0
4918
+ */
4919
+ api_version: string;
4920
+ /**
4921
+ * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
4922
+ * @example announcement_internal_name_taken
4923
+ */
4924
+ error_code?: string;
4925
+ /**
4926
+ * @description The human-readable status of the response
4927
+ * @example Success
4928
+ */
4929
+ message: string;
4930
+ /**
4931
+ * @description The HTTP status code of the response
4932
+ * @example 200
4933
+ */
4934
+ response_code: number;
4935
+ };
5175
4936
  /** @description Request body for POST /inspections/{inspectionId}/export */
5176
4937
  ExportInspectionPDFBody: {
5177
4938
  /**
@@ -5251,11 +5012,6 @@ export interface components {
5251
5012
  * @example 3.0.0
5252
5013
  */
5253
5014
  api_version: string;
5254
- /**
5255
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5256
- * @example announcement_internal_name_taken
5257
- */
5258
- error_code?: string;
5259
5015
  /**
5260
5016
  * @description The human-readable status of the response
5261
5017
  * @example Success
@@ -5276,11 +5032,6 @@ export interface components {
5276
5032
  * @example 3.0.0
5277
5033
  */
5278
5034
  api_version: string;
5279
- /**
5280
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5281
- * @example announcement_internal_name_taken
5282
- */
5283
- error_code?: string;
5284
5035
  /**
5285
5036
  * @description The human-readable status of the response
5286
5037
  * @example Success
@@ -5302,11 +5053,6 @@ export interface components {
5302
5053
  * @example 3.0.0
5303
5054
  */
5304
5055
  api_version: string;
5305
- /**
5306
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5307
- * @example announcement_internal_name_taken
5308
- */
5309
- error_code?: string;
5310
5056
  /**
5311
5057
  * @description The human-readable status of the response
5312
5058
  * @example Success
@@ -5326,11 +5072,6 @@ export interface components {
5326
5072
  * @example 3.0.0
5327
5073
  */
5328
5074
  api_version: string;
5329
- /**
5330
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5331
- * @example announcement_internal_name_taken
5332
- */
5333
- error_code?: string;
5334
5075
  /**
5335
5076
  * @description The human-readable status of the response
5336
5077
  * @example Success
@@ -5350,11 +5091,6 @@ export interface components {
5350
5091
  * @example 3.0.0
5351
5092
  */
5352
5093
  api_version: string;
5353
- /**
5354
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5355
- * @example announcement_internal_name_taken
5356
- */
5357
- error_code?: string;
5358
5094
  /**
5359
5095
  * @description The human-readable status of the response
5360
5096
  * @example Success
@@ -5389,11 +5125,6 @@ export interface components {
5389
5125
  * @example 3.0.0
5390
5126
  */
5391
5127
  api_version: string;
5392
- /**
5393
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5394
- * @example announcement_internal_name_taken
5395
- */
5396
- error_code?: string;
5397
5128
  /**
5398
5129
  * @description The human-readable status of the response
5399
5130
  * @example Success
@@ -5428,11 +5159,6 @@ export interface components {
5428
5159
  * @example 3.0.0
5429
5160
  */
5430
5161
  api_version: string;
5431
- /**
5432
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5433
- * @example announcement_internal_name_taken
5434
- */
5435
- error_code?: string;
5436
5162
  /**
5437
5163
  * @description The human-readable status of the response
5438
5164
  * @example Success
@@ -5451,11 +5177,6 @@ export interface components {
5451
5177
  * @example 3.0.0
5452
5178
  */
5453
5179
  api_version: string;
5454
- /**
5455
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5456
- * @example announcement_internal_name_taken
5457
- */
5458
- error_code?: string;
5459
5180
  /**
5460
5181
  * @description The human-readable status of the response
5461
5182
  * @example Success
@@ -5490,11 +5211,6 @@ export interface components {
5490
5211
  * @example 3.0.0
5491
5212
  */
5492
5213
  api_version: string;
5493
- /**
5494
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5495
- * @example announcement_internal_name_taken
5496
- */
5497
- error_code?: string;
5498
5214
  /**
5499
5215
  * @description The human-readable status of the response
5500
5216
  * @example Success
@@ -5514,11 +5230,6 @@ export interface components {
5514
5230
  * @example 3.0.0
5515
5231
  */
5516
5232
  api_version: string;
5517
- /**
5518
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5519
- * @example announcement_internal_name_taken
5520
- */
5521
- error_code?: string;
5522
5233
  /**
5523
5234
  * @description The human-readable status of the response
5524
5235
  * @example Success
@@ -5553,11 +5264,6 @@ export interface components {
5553
5264
  * @example 3.0.0
5554
5265
  */
5555
5266
  api_version: string;
5556
- /**
5557
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5558
- * @example announcement_internal_name_taken
5559
- */
5560
- error_code?: string;
5561
5267
  /**
5562
5268
  * @description The human-readable status of the response
5563
5269
  * @example Success
@@ -5577,11 +5283,6 @@ export interface components {
5577
5283
  * @example 3.0.0
5578
5284
  */
5579
5285
  api_version: string;
5580
- /**
5581
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5582
- * @example announcement_internal_name_taken
5583
- */
5584
- error_code?: string;
5585
5286
  /**
5586
5287
  * @description The human-readable status of the response
5587
5288
  * @example Success
@@ -5616,11 +5317,6 @@ export interface components {
5616
5317
  * @example 3.0.0
5617
5318
  */
5618
5319
  api_version: string;
5619
- /**
5620
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5621
- * @example announcement_internal_name_taken
5622
- */
5623
- error_code?: string;
5624
5320
  /**
5625
5321
  * @description The human-readable status of the response
5626
5322
  * @example Success
@@ -5640,11 +5336,6 @@ export interface components {
5640
5336
  * @example 3.0.0
5641
5337
  */
5642
5338
  api_version: string;
5643
- /**
5644
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5645
- * @example announcement_internal_name_taken
5646
- */
5647
- error_code?: string;
5648
5339
  /**
5649
5340
  * @description The human-readable status of the response
5650
5341
  * @example Success
@@ -5663,11 +5354,6 @@ export interface components {
5663
5354
  * @example 3.0.0
5664
5355
  */
5665
5356
  api_version: string;
5666
- /**
5667
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5668
- * @example announcement_internal_name_taken
5669
- */
5670
- error_code?: string;
5671
5357
  /**
5672
5358
  * @description The human-readable status of the response
5673
5359
  * @example Success
@@ -5703,11 +5389,6 @@ export interface components {
5703
5389
  * @example 3.0.0
5704
5390
  */
5705
5391
  api_version: string;
5706
- /**
5707
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5708
- * @example announcement_internal_name_taken
5709
- */
5710
- error_code?: string;
5711
5392
  /**
5712
5393
  * @description The human-readable status of the response
5713
5394
  * @example Success
@@ -5726,11 +5407,6 @@ export interface components {
5726
5407
  * @example 3.0.0
5727
5408
  */
5728
5409
  api_version: string;
5729
- /**
5730
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5731
- * @example announcement_internal_name_taken
5732
- */
5733
- error_code?: string;
5734
5410
  /**
5735
5411
  * @description The human-readable status of the response
5736
5412
  * @example Success
@@ -5749,11 +5425,6 @@ export interface components {
5749
5425
  * @example 3.0.0
5750
5426
  */
5751
5427
  api_version: string;
5752
- /**
5753
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
5754
- * @example announcement_internal_name_taken
5755
- */
5756
- error_code?: string;
5757
5428
  /**
5758
5429
  * @description The human-readable status of the response
5759
5430
  * @example Success
@@ -7503,11 +7174,6 @@ export interface components {
7503
7174
  * @example 3.0.0
7504
7175
  */
7505
7176
  api_version: string;
7506
- /**
7507
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
7508
- * @example announcement_internal_name_taken
7509
- */
7510
- error_code?: string;
7511
7177
  /**
7512
7178
  * @description The human-readable status of the response
7513
7179
  * @example Success
@@ -7530,11 +7196,6 @@ export interface components {
7530
7196
  * @example 3.0.0
7531
7197
  */
7532
7198
  api_version: string;
7533
- /**
7534
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
7535
- * @example announcement_internal_name_taken
7536
- */
7537
- error_code?: string;
7538
7199
  /**
7539
7200
  * @description The human-readable status of the response
7540
7201
  * @example Success
@@ -7561,11 +7222,6 @@ export interface components {
7561
7222
  * @example 3.0.0
7562
7223
  */
7563
7224
  api_version: string;
7564
- /**
7565
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
7566
- * @example announcement_internal_name_taken
7567
- */
7568
- error_code?: string;
7569
7225
  /**
7570
7226
  * @description The human-readable status of the response
7571
7227
  * @example Success
@@ -7691,11 +7347,6 @@ export interface components {
7691
7347
  * @example 3.0.0
7692
7348
  */
7693
7349
  api_version: string;
7694
- /**
7695
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
7696
- * @example announcement_internal_name_taken
7697
- */
7698
- error_code?: string;
7699
7350
  /**
7700
7351
  * @description The human-readable status of the response
7701
7352
  * @example Success
@@ -7911,11 +7562,6 @@ export interface components {
7911
7562
  * @example 3.0.0
7912
7563
  */
7913
7564
  api_version: string;
7914
- /**
7915
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
7916
- * @example announcement_internal_name_taken
7917
- */
7918
- error_code?: string;
7919
7565
  /**
7920
7566
  * @description The ID of the newly created resource
7921
7567
  * @example 5
@@ -8759,11 +8405,6 @@ export interface components {
8759
8405
  * @example 3.0.0
8760
8406
  */
8761
8407
  api_version: string;
8762
- /**
8763
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
8764
- * @example announcement_internal_name_taken
8765
- */
8766
- error_code?: string;
8767
8408
  /** @description The ID of the updated inspection. */
8768
8409
  id: number;
8769
8410
  /**
@@ -8982,11 +8623,6 @@ export interface components {
8982
8623
  * @example 3.0.0
8983
8624
  */
8984
8625
  api_version: string;
8985
- /**
8986
- * @description A stable, machine-readable name for a rejection, sent beside the message on the 4xx responses a client has to act on rather than only display. Absent on success, and on rejections with nothing to branch on — so treat a missing value as "no specific reason given" rather than as an error.
8987
- * @example announcement_internal_name_taken
8988
- */
8989
- error_code?: string;
8990
8626
  /**
8991
8627
  * @description The human-readable status of the response
8992
8628
  * @example Success
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@truepic/vision-api-types",
3
- "version": "3.90.0",
3
+ "version": "3.91.0",
4
4
  "description": "TypeScript type declarations for Truepic Vision API v3",
5
5
  "license": "MIT",
6
6
  "types": "index.d.ts",