@truepic/vision-api-types 3.86.0 → 3.87.0

package/index.d.ts

@@ -4466,7 +4466,7 @@ export interface components {
         /** @enum {string} */
         DeviceFlagType: "rooted_device" | "spoofed_location" | "falsified_time" | "incorrect_location" | "picture_of_photo" | "bad_photo" | "deleted_photos" | "bad_answer" | "other";
         /** @enum {string} */
-        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" | "INVALID_FINGERPRINT_DATA" | "DECRYPT_FINGERPRINT_FAIL" | "FINGERPRINT_CONFIDENCE_LOW";
+        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";
         DiscrepanciesOutputParams: {
             issue_description: string;
             related_item_ids: number[];
@@ -6072,6 +6072,13 @@ export interface components {
                      * @example 2020-05-01T21:44:40.000Z
                      */
                     updated_at: string;
+                    /** @description The use case assigned to this inspection type (populated for super admins only). */
+                    use_case?: components["schemas"]["UseCase"];
+                    /**
+                     * @description The use case assigned to this inspection type by a super admin. References `use_cases.id`.
+                     * @default null
+                     */
+                    use_case_id: number | null;
                     /**
                      * @description When true, there is only one name for the user to fill out rather than a separate first name and last name field
                      * @example true
@@ -7835,6 +7842,11 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             updated_at: string;
+            /**
+             * @description The use case assigned to this inspection type by a super admin. References `use_cases.id`.
+             * @default null
+             */
+            use_case_id: number | null;
             /**
              * @description When true, there is only one name for the user to fill out rather than a separate first name and last name field
              * @example true
@@ -8589,6 +8601,68 @@ export interface components {
              */
             updated_at: string;
         };
+        /**
+         * @description Evidence about the device taking an action, collected by the inspection app and recorded against the resulting activity log entry.
+         *
+         *     Sent as the `metadata` property of the request body, with `fp.request_id` and `fp.sealed_result` always sent together. Endpoints without a request body instead accept the Fingerprint request ID on its own, via the `truepic-fp-request-id` header — one or the other, never both.
+         */
+        Metadata: {
+            /** @description The Fingerprint identification result for the device. */
+            fp?: {
+                /**
+                 * @description The ID of the Fingerprint request the sealed result was issued for.
+                 * @example 1712345678901.AbCdEf
+                 */
+                request_id: string;
+                /** @description The sealed (encrypted) Fingerprint identification result, as issued by the Fingerprint client. Opaque to the caller. */
+                sealed_result: string;
+            };
+            /**
+             * @description The reason the client couldn't collect Fingerprint data, sent instead of `fp`. Known values are `skipped`, `no_api_key`, `no_inspection_id`, `blocked`, and `request_failed`; anything else is recorded as if no reason was sent. Endpoints without a request body instead accept it via the `truepic-fp-reason` header.
+             * @example request_failed
+             */
+            fp_reason?: string;
+            /** @description The location the device reported when the action was taken. */
+            gps?: {
+                /**
+                 * @description The radius of uncertainty around the location, in meters.
+                 * @example 5
+                 */
+                accuracy: number;
+                /**
+                 * @description The altitude of the location, in meters above sea level.
+                 * @example 17
+                 */
+                altitude: number;
+                /**
+                 * @description The latitude of the location, in degrees.
+                 * @example 43.0502488
+                 */
+                latitude: number;
+                /**
+                 * @description The longitude of the location, in degrees.
+                 * @example -77.5873941
+                 */
+                longitude: number;
+                /**
+                 * @description The reason the location is considered spoofed. `0` means the location is not spoofed.
+                 * @example 0
+                 */
+                reason: number;
+                /**
+                 * @description Where the location came from. `system` is the operating system and is most typical, `accessory` is a connected device such as Apple CarPlay, and `software` means it was mocked or simulated.
+                 * @example system
+                 * @enum {string|null}
+                 */
+                source?: "accessory" | "software" | "system" | null;
+                /**
+                 * Format: datetime
+                 * @description When the device reported the location.
+                 * @example 2025-04-14T12:05:51.007Z
+                 */
+                timestamp: string;
+            };
+        };
         /** @enum {string} */
         ObjectDetectionAutomotiveObject: "tire" | "vin_plate" | "dashboard" | "license_plate" | "odometer" | "document";
         /**
@@ -8725,6 +8799,11 @@ export interface components {
              * @example 1413
              */
             created_by_user_id: number;
+            /**
+             * @description The default use case assigned to this organization by a super admin.
+             * @default null
+             */
+            default_use_case_id: number | null;
             /**
              * @description The id of the resource.
              * @example 1843
@@ -9537,6 +9616,13 @@ export interface components {
                  * @example 2020-05-01T21:44:40.000Z
                  */
                 updated_at: string;
+                /** @description The use case assigned to this inspection type (populated for super admins only). */
+                use_case?: components["schemas"]["UseCase"];
+                /**
+                 * @description The use case assigned to this inspection type by a super admin. References `use_cases.id`.
+                 * @default null
+                 */
+                use_case_id: number | null;
                 /**
                  * @description When true, there is only one name for the user to fill out rather than a separate first name and last name field
                  * @example true
@@ -10362,6 +10448,13 @@ export interface components {
                  * @example 2020-05-01T21:44:40.000Z
                  */
                 updated_at: string;
+                /** @description The use case assigned to this inspection type (populated for super admins only). */
+                use_case?: components["schemas"]["UseCase"];
+                /**
+                 * @description The use case assigned to this inspection type by a super admin. References `use_cases.id`.
+                 * @default null
+                 */
+                use_case_id: number | null;
                 /**
                  * @description When true, there is only one name for the user to fill out rather than a separate first name and last name field
                  * @example true
@@ -12284,6 +12377,36 @@ export interface components {
              */
             team_id?: number;
         };
+        /** @description A seeded use case belonging to an industry. */
+        UseCase: {
+            /**
+             * Format: date-time
+             * @description The date/time the resource was created
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            created_at: string;
+            /**
+             * @description The id of the resource.
+             * @example 1
+             */
+            id: number;
+            /**
+             * @description The id of the industry this use case belongs to.
+             * @example 3
+             */
+            industry_id: number;
+            /**
+             * @description The name of the use case.
+             * @example Claims Processing
+             */
+            name: string;
+            /**
+             * Format: date-time
+             * @description The date/time the resource was last updated
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            updated_at: string;
+        };
         /** @description A user of Vision. This could be a Vision website user or mobile app user. */
         User: {
             /**
@@ -12704,6 +12827,18 @@ export interface components {
         userId: number;
         /** @description The unique alphanumeric identifier of the photo/video. */
         verificationCode: string;
+        /**
+         * @description The ID of the Fingerprint request identifying the device taking the action.
+         *
+         *     Used by endpoints that have no request body to carry a `metadata` property. Recorded against the resulting activity log entry.
+         */
+        metadataFingerprintRequestId: string;
+        /**
+         * @description The reason the client could not collect Fingerprint data, sent instead of `truepic-fp-request-id`.
+         *
+         *     Used by endpoints that have no request body to carry a `metadata` property. Recorded against the resulting activity log entry.
+         */
+        metadataFingerprintReason: string;
         /**
          * @description Pagination to limit the number of results returned.
          *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truepic/vision-api-types",
-  "version": "3.86.0",
+  "version": "3.87.0",
   "description": "TypeScript type declarations for Truepic Vision API v3",
   "license": "MIT",
   "types": "index.d.ts",