@truepic/vision-api-types 3.76.0 → 3.78.0

package/index.d.ts

@@ -1832,6 +1832,60 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ready": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Readiness probe
+         * @description Returns 200 when the API is ready to serve traffic (DB reachable), 503 otherwise. Intended for K8s readinessProbe.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Ready */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ResponseData"];
+                    };
+                };
+                400: components["responses"]["ErrorBadRequest"];
+                401: components["responses"]["ErrorUnauthorized"];
+                403: components["responses"]["ErrorForbidden"];
+                404: components["responses"]["ErrorNotFound"];
+                412: components["responses"]["ErrorPreconditionFailed"];
+                500: components["responses"]["ErrorUnhandled"];
+                /** @description Not ready */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ResponseData"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/inspection-types": {
         parameters: {
             query?: never;
@@ -2745,7 +2799,7 @@ export interface components {
             overview: components["schemas"]["SubmitOverviewToolCallParams"] | unknown;
             qaDetails: components["schemas"]["SubmitQADetailsToolCallParams"][];
             queryTimeMs: number;
-            totalCostUSD: number;
+            totalCostUSD: number | null;
         };
         AIInspectionCriteriaEvaluationResultV1: {
             cachedTokens: number;
@@ -2757,7 +2811,7 @@ export interface components {
             overview: components["schemas"]["SubmitOverviewToolCallParams"] | unknown;
             qaDetails: components["schemas"]["SubmitQADetailsToolCallParams"][];
             queryTimeMs: number;
-            totalCostUSD: number;
+            totalCostUSD: number | null;
         };
         AIInspectionReadyCriteriaResultV1: {
             cachedTokens: number;
@@ -2766,7 +2820,7 @@ export interface components {
             inputTokens: number;
             outputTokens: number;
             queryTimeMs: number;
-            totalCostUSD: number;
+            totalCostUSD: number | null;
         };
         AIInspectionReadyCriteriaResultV2: {
             cachedTokens: number;
@@ -2775,7 +2829,7 @@ export interface components {
             inputTokens: number;
             outputTokens: number;
             queryTimeMs: number;
-            totalCostUSD: number;
+            totalCostUSD: number | null;
         };
         AIInspectionReadyResult: {
             client_override_date?: string | null;
@@ -4015,6 +4069,12 @@ export interface components {
                  * @example 19
                  */
                 assigned_to_member_user_id?: number;
+                /**
+                 * Format: date-time
+                 * @description The date/time the inspection was closed. `null` if not closed.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                closed_at?: string | null;
                 /**
                  * Format: date-time
                  * @description The date/time the resource was created
@@ -4089,6 +4149,12 @@ export interface components {
                  * @example 2023-01-04 15:11:39.642
                  */
                 email_auto_reply_sent?: string;
+                /**
+                 * Format: date-time
+                 * @description The date/time the inspection token expires. Updated each time a new token is issued.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                expires_at?: string | null;
                 /**
                  * @description The id of the group this inspection is for.
                  * @example 23
@@ -4842,7 +4908,7 @@ export interface components {
                 inspection_id?: number;
                 isActiveUser: boolean;
                 isBot: boolean;
-                isCustomer?: boolean;
+                isCustomer: boolean;
                 isGroupMember: boolean;
                 /**
                  * @description Members can create inspections and review all inspections in assigned teams.
@@ -5162,6 +5228,11 @@ export interface components {
                      */
                     web_camera: boolean;
                 };
+                /**
+                 * @description An identifier from an external system used to reference the team.  It must be unique within an organization when set.
+                 * @example X50100039
+                 */
+                external_id?: string | null;
                 /**
                  * @description The accuracy threshold that GPS coordinates must not exceed in meters.
                  * @example 1500
@@ -5802,52 +5873,7 @@ export interface components {
              * @example 200
              */
             response_code: number;
-            result: {
-                inspection_types: {
-                    /** @description An array of custom fields that are used by this inspection type */
-                    custom_fields: components["schemas"]["CustomField"][];
-                    /**
-                     * @description The id of the inspection type
-                     * @example 1843
-                     */
-                    id: number;
-                    /**
-                     * @description Controls whether an address is required for the inspection or not
-                     * @example 1000
-                     */
-                    is_address_required: boolean;
-                    /**
-                     * @description The name of the inspection type
-                     * @example My Type
-                     */
-                    name: string;
-                    /**
-                     * @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
-                     */
-                    use_single_name_field: boolean;
-                }[];
-                /**
-                 * @description Whether the email field is required on the website form. Defaults to `false`.
-                 * @example false
-                 */
-                is_email_required: boolean;
-                /**
-                 * @description Whether the phone field is required on the website form. Defaults to `false`.
-                 * @example false
-                 */
-                is_phone_required: boolean;
-                /**
-                 * @description Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.
-                 * @example false
-                 */
-                should_show_address: boolean;
-                /**
-                 * @description The unique token used by the website form to authenticate with the API.
-                 * @example -SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC
-                 */
-                token: string;
-            };
+            result: components["schemas"]["WebsiteFormBearerSerialized"];
         };
         GetWebsiteFormResult: {
             /**
@@ -5971,6 +5997,12 @@ export interface components {
              * @example 19
              */
             assigned_to_member_user_id: number;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection was closed. `null` if not closed.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            closed_at?: string | null;
             /**
              * Format: date-time
              * @description The date/time the resource was created
@@ -6045,6 +6077,12 @@ export interface components {
              * @example 2023-01-04 15:11:39.642
              */
             email_auto_reply_sent?: string;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection token expires. Updated each time a new token is issued.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            expires_at?: string | null;
             /**
              * @description The id of the group this inspection is for.
              * @example 23
@@ -6230,6 +6268,12 @@ export interface components {
              * @example true
              */
             test_content_analysis_dot_tin: boolean;
+            /**
+             * @description Whether or not to surface a `dot_tin_reuse` insight as an alert failure. Opt-in per VISION-1424: defaults to false so existing orgs do not start receiving alerts when the org-level reuse_detection feature is enabled.
+             * @default false
+             * @example false
+             */
+            test_content_analysis_dot_tin_reuse: boolean;
             /**
              * @description Whether or not to include the odometer test in this alert.
              * @example true
@@ -6245,6 +6289,12 @@ export interface components {
              * @example true
              */
             test_content_analysis_vin: boolean;
+            /**
+             * @description Whether or not to surface a `vin_reuse` insight as an alert failure. Opt-in per VISION-1425: defaults to false so existing orgs do not start receiving alerts when the org-level reuse_detection feature is enabled.
+             * @default false
+             * @example false
+             */
+            test_content_analysis_vin_reuse: boolean;
             /**
              * @description Whether or not to include the datetime test in this alert.
              * @example true
@@ -6266,7 +6316,7 @@ export interface components {
              * @description Whether or not to include the device integrity test in this alert.
              * @example true
              */
-            test_device_integrity?: boolean;
+            test_device_integrity: boolean;
             /**
              * @description Whether or not to include the distance-from-address test in this alert.
              * @example true
@@ -6282,7 +6332,7 @@ export interface components {
              * @description Whether or not to include the geolocation test in this alert.
              * @example true
              */
-            test_geolocation?: boolean;
+            test_geolocation: boolean;
             /**
              * @description Whether or not to include the jailbroken or rooted device test in this alert.
              * @default true
@@ -6431,7 +6481,7 @@ export interface components {
             updated_at: string;
         };
         /** @enum {string} */
-        InspectionInsightType: "insecure_device" | "falsified_location" | "device_found_other_inspections" | "device_flagged_other_inspections";
+        InspectionInsightType: "insecure_device" | "falsified_location" | "device_found_other_inspections" | "device_flagged_other_inspections" | "dot_tin_reuse" | "vin_reuse";
         InspectionListItemWithPhotos: {
             /**
              * @description Whether or not to accept existing images for this list item.
@@ -6657,8 +6707,8 @@ export interface components {
              * @example 2018-08-06T15:29:47.000Z
              */
             device_time: string;
-            distance_from_customer_address?: number;
-            distance_from_customer_address_exceeds_threshold?: boolean;
+            distance_from_customer_address: number;
+            distance_from_customer_address_exceeds_threshold: boolean;
             /**
              * @description The video duration of this Truepic, if it is a video.
              * @example 0:00:30
@@ -6712,6 +6762,79 @@ export interface components {
              */
             lat: string;
             lens_transfer_done: unknown;
+            /** @description The list item this photo/video was captured for, if any. */
+            list_item?: {
+                /**
+                 * @description The completion status of the list item for this inspection.
+                 * @example 0
+                 */
+                completed: number;
+                /** @description Indicates that the contents of the photo should be analyzed to determine if it contains the correct information. */
+                content_analysis?: components["schemas"]["ContentAnalysisDetails"];
+                /**
+                 * 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 group that this list item is associated with.
+                 * @example 1256
+                 */
+                group_id?: string;
+                /**
+                 * @description The id of the resource.
+                 * @example 1843
+                 */
+                id: number;
+                is_deleted: unknown;
+                is_required: unknown;
+                /**
+                 * @description A description of the requested photo or video when `type` is `IMAGE`, `PHOTO`, or `VIDEO`. A question for the customer to answer when `type` is `QUESTION`. The customer will see this value in the Vision app during the inspection.
+                 * @example Front of car
+                 */
+                name: string;
+                /** @description An object containing information about the expected items in a Truepic. */
+                object_detection?: components["schemas"]["ObjectDetectionConfig"];
+                /**
+                 * @description The numerical order of the list item within the list. Starts at `1`.
+                 * @example 1
+                 */
+                order?: number;
+                /** @description The question associated with this list item, if any. */
+                question?: {
+                    /** @description The answer(s) selected by the user, or null if unanswered */
+                    answer?: (unknown | {
+                        /** @description The user's custom text answer. Used for answer options where `allow_custom` is `true` */
+                        custom?: string;
+                        /**
+                         * @description A selected answer to the question.
+                         * @example Excellent
+                         */
+                        name: string;
+                    }[]) | (string | null) | (string | null);
+                    /** @description The possible choices for this question */
+                    options?: {
+                        allow_multiple: boolean;
+                        choices: components["schemas"]["ListItemQuestionChoice"][];
+                    } | unknown | {
+                        /** @description The latest date that can be selected, in ISO 8601 format */
+                        max?: string;
+                        /** @description The earliest date that can be selected, in ISO 8601 format */
+                        min?: string;
+                    };
+                    /** @description The type of question this list item is. Must be `MULTIPLE_CHOICE`, `TEXT`, or `DATE`. */
+                    type: string;
+                };
+                /** @description The type of the list item. */
+                type: components["schemas"]["ListItemType"];
+                /**
+                 * Format: date-time
+                 * @description The date/time the resource was last updated
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                updated_at: string;
+            };
             /**
              * @description The GPS longitude where the photo/video was taken.
              * @example 33.5565051716316
@@ -7043,13 +7166,7 @@ export interface components {
              * @example Start your application today!
              */
             page_title: string;
-            website_form: {
-                /**
-                 * @description The unique token used by the website form to authenticate with the API.
-                 * @example -SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC
-                 */
-                token: string;
-            };
+            website_form: unknown;
         };
         LandingPageSerialized: {
             /**
@@ -7884,7 +8001,7 @@ export interface components {
             updated_by_user_id: number | null;
         };
         /** @enum {string} */
-        OrganizationEnabledFeatureType: "ai_analysis" | "ask_for_app_review" | "inspection_device_insights" | "device_details" | "risk_network" | "external_risk_network" | "content_analysis_odometer" | "content_analysis_text_matching" | "content_analysis_vin" | "content_analysis_dot_tin" | "object_detection_auto" | "object_detection_jewelry" | "object_detection_real_estate" | "landing_pages" | "inspection_ai_criteria" | "dashboard_user_feedback_forms";
+        OrganizationEnabledFeatureType: "ai_analysis" | "ask_for_app_review" | "inspection_device_insights" | "device_details" | "risk_network" | "external_risk_network" | "content_analysis_odometer" | "content_analysis_text_matching" | "content_analysis_vin" | "content_analysis_dot_tin" | "object_detection_auto" | "object_detection_jewelry" | "object_detection_real_estate" | "landing_pages" | "inspection_ai_criteria" | "dashboard_user_feedback_forms" | "member_homepage" | "reuse_detection";
         /** @description A possible outcome for an inspection */
         Outcome: {
             /**
@@ -8302,6 +8419,11 @@ export interface components {
                  */
                 web_camera: boolean;
             };
+            /**
+             * @description An identifier from an external system used to reference the team.  It must be unique within an organization when set.
+             * @example X50100039
+             */
+            external_id?: string | null;
             /**
              * @description The accuracy threshold that GPS coordinates must not exceed in meters.
              * @example 1500
@@ -8828,6 +8950,24 @@ export interface components {
              */
             response_code: number;
         };
+        /** @description Top-level reuse rollup attached to a populated inspection for one string type (DOT TIN or VIN). Mirrors `flags_other_inspections` in shape; see Vision-UI Contract §1.2. */
+        ReuseRollup: {
+            /** @description Capped at MAX_INSPECTIONS_PER_ROLLUP entries — see VISION-1430 for the cap-value lock. `total_matched_inspections` continues to reflect the true count. */
+            inspections: components["schemas"]["ReuseRollupInspection"][];
+            /** @description Truepic IDs on this inspection that produced ≥1 match. */
+            matched_truepic_ids: number[];
+            total_matched_inspections: number;
+        };
+        /** @description One entry in a reuse rollup's `inspections[]` array — a remote inspection in the same org that shares at least one extracted value with the local inspection. See Vision-UI Contract §1.2. */
+        ReuseRollupInspection: {
+            /** @description UI hint: does the requesting user pass `requires-inspection-access` for the remote inspection? Server-side click-through (the inspection-detail endpoint's existing 403 path) remains the authoritative gate per VISION-1429 H2 — this flag avoids surfacing enabled controls that would 403 on click. */
+            accessible: boolean;
+            /** @description Earliest truepic-capture timestamp across the matching truepics on the remote inspection, ISO 8601. */
+            first_match_at: string;
+            inspection_id: number;
+            /** @description Truepic IDs on **this** inspection whose extracted value triggered this remote match. Always non-empty for entries present in `inspections[]`. */
+            triggered_by_truepic_ids: number[];
+        };
         /** @description The request body for PUT /text/reminder-to-finish */
         SendFinishReminderTextBody: components["schemas"]["SendWelcomeTextBody"];
         /** @description The response body for PUT /text/reminder-to-finish */
@@ -8962,6 +9102,12 @@ export interface components {
              * @example 19
              */
             assigned_to_member_user_id: number;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection was closed. `null` if not closed.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            closed_at?: string | null;
             /**
              * Format: date-time
              * @description The date/time the resource was created
@@ -9023,6 +9169,10 @@ export interface components {
              * @example 3028675309
              */
             customer_phone_number?: string;
+            customer_token_status: {
+                expires?: number | null;
+                is_valid: boolean;
+            };
             /**
              * Format: date-time
              * @description The date/time the inspection was deleted. `null` if not deleted.
@@ -9035,12 +9185,20 @@ export interface components {
              */
             deleted_by_user_id?: number | null;
             devices: components["schemas"]["InspectionDeviceInfo"][];
+            /** @description VISION-1427: in-org DOT TIN reuse rollup. Absent when the `reuse_detection` org feature flag is off or the populator detects no matches. */
+            dot_tin_reuse?: components["schemas"]["ReuseRollup"];
             /**
              * Format: date-time
              * @description The datetime an email automated reply was sent
              * @example 2023-01-04 15:11:39.642
              */
             email_auto_reply_sent?: string;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection token expires. Updated each time a new token is issued.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            expires_at?: string | null;
             group?: components["schemas"]["Group"];
             /**
              * @description The id of the group this inspection is for.
@@ -9506,10 +9664,8 @@ export interface components {
              * @example pass
              */
             verification_result?: components["schemas"]["VerificationResult"];
-            organization_token_status: {
-                expires?: number | null;
-                is_valid: boolean;
-            };
+            /** @description VISION-1427: in-org VIN reuse rollup. Absent when the `reuse_detection` org feature flag is off or the populator detects no matches. */
+            vin_reuse?: components["schemas"]["ReuseRollup"];
         };
         /** @description A user object that's been serialized for the client. This is usually the object returned from the API and is used for client-side rendering. */
         SerializedUser: {
@@ -9780,6 +9936,11 @@ export interface components {
                  */
                 web_camera: boolean;
             };
+            /**
+             * @description An identifier from an external system used to reference the team.  It must be unique within an organization when set.
+             * @example X50100039
+             */
+            external_id?: string | null;
             /**
              * @description The accuracy threshold that GPS coordinates must not exceed in meters.
              * @example 1500
@@ -9970,6 +10131,11 @@ export interface components {
                  */
                 web_camera: boolean;
             };
+            /**
+             * @description An identifier from an external system used to reference the team.  It must be unique within an organization when set.
+             * @example X50100039
+             */
+            external_id?: string | null;
             /**
              * @description The accuracy threshold that GPS coordinates must not exceed in meters.
              * @example 1500
@@ -10453,11 +10619,11 @@ export interface components {
              */
             custom_field_values?: string[];
             /** @description The address where the inspection will be performed. */
-            customer_address?: string;
+            customer_address: string;
             /** @description The latitude of the address where the inspection will be performed. */
-            customer_address_lat?: string;
+            customer_address_lat: string;
             /** @description The longitude of the address where the inspection will be performed. */
-            customer_address_lng?: string;
+            customer_address_lng: string;
             /**
              * Format: email
              * @description The email address of the customer completing the inspection. Required if `send_methods.email` is `true`.
@@ -10885,6 +11051,52 @@ export interface components {
          * @enum {string}
          */
         VisionRole: "SUPER_ADMIN" | "VISION_AGENT_ADMIN" | "VISION_AGENT" | "VISION_CONSUMER" | "AUTH0_BOT" | "WEBSITE_FORM_BOT" | "GROUP_AGENT" | "VISION_AGENT_OWN_INSPECTIONS" | "VIEW_ONLY" | "VISION_AGENT_REPORT";
+        WebsiteFormBearerSerialized: {
+            inspection_types: {
+                /** @description An array of custom fields that are used by this inspection type */
+                custom_fields: components["schemas"]["CustomField"][];
+                /**
+                 * @description The id of the inspection type
+                 * @example 1843
+                 */
+                id: number;
+                /**
+                 * @description Controls whether an address is required for the inspection or not
+                 * @example 1000
+                 */
+                is_address_required: boolean;
+                /**
+                 * @description The name of the inspection type
+                 * @example My Type
+                 */
+                name: string;
+                /**
+                 * @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
+                 */
+                use_single_name_field: boolean;
+            }[];
+            /**
+             * @description Whether the email field is required on the website form. Defaults to `false`.
+             * @example false
+             */
+            is_email_required: boolean;
+            /**
+             * @description Whether the phone field is required on the website form. Defaults to `false`.
+             * @example false
+             */
+            is_phone_required: boolean;
+            /**
+             * @description Whether the address field should be shown on the website form when it is optional. The field is always shown if it is required by the inspection type. Defaults to `false`.
+             * @example false
+             */
+            should_show_address: boolean;
+            /**
+             * @description The unique token used by the website form to authenticate with the API.
+             * @example -SQuSE62r4ISFCE4EOOTtu3yx1SW8i6PE7VMZwvVZ8TNyliC
+             */
+            token: string;
+        };
         WebsiteFormInspectionSerialized: {
             can_email: boolean;
             can_text: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@truepic/vision-api-types",
-  "version": "3.76.0",
+  "version": "3.78.0",
   "description": "TypeScript type declarations for Truepic Vision API v3",
   "bugs": "https://github.com/TRUEPIC/vision-api-types/issues",
   "license": "MIT",