@truepic/vision-api-types 3.85.0 → 3.86.0

package/index.d.ts

@@ -329,7 +329,7 @@ export interface paths {
         put?: never;
         /**
          * Complete an inspection
-         * @description Finish an inspection request and set it to Ready for Review. The inspection request must be In Progress, otherwise a `400` error will be returned.
+         * @description Submit an inspection. The inspection must be Started or In Progress, otherwise a `400` error will be returned. Submitting moves the inspection to Processing while photo/AI processing runs in the background. If no processing is needed, the inspection will be pushed to Ready-for-Review after a short delay. A Ready-for-Review, Closed, or already-Processing inspection is a no-op that returns `200` without changing status.
          */
         post: {
             parameters: {
@@ -343,7 +343,7 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description The inspection request was successfully finished and set to Ready for Review. */
+                /** @description The inspection was successfully submitted or the request was a no-op because the inspection was already Processing, Ready for Review, or Closed. */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -3327,6 +3327,8 @@ export interface components {
                      *     Independent of `disposition`, which reports only whether the answer is wrong or missing and never warns for low confidence alone — so `disposition: 'pass'` with `is_low_confidence: true` means "the answer looks fine but the model was unsure", and the inspection's `ai_status` and alert still flag it for review. A field can be both.
                      */
                     is_low_confidence: boolean;
+                    /** @description True when the model answered a `found` field by selecting its configured "not present" option (VISION-2692) — the row REPORTS ABSENCE, and clients must not render it as a positive finding. Mirrors `SerializedAIItemFieldResult.not_captured_option_selected` in `serializers/ai-inspection-items.ts`. */
+                    not_captured_option_selected: boolean;
                     reasoning: string | null;
                     sources: components["schemas"]["Source"][];
                     status: components["schemas"]["FieldStatus"];
@@ -4707,6 +4709,12 @@ export interface components {
                  * @example 2020-05-01T21:44:40.000Z
                  */
                 expires_at?: string | null;
+                /**
+                 * Format: date-time
+                 * @description The date/time the inspection entered Processing (was submitted). Stamped on every entry into Processing (app-user submit, request-more resubmit, or request expiry), so it repopulates on resubmit. A non-null value is the durable "already submitted" signal consumed by vision-web and the mobile apps. Reset to `null` whenever a request-more moves the inspection back to In-Progress.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                finished_at?: string | null;
                 /**
                  * @description The id of the group this inspection is for.
                  * @example 23
@@ -4782,6 +4790,30 @@ export interface components {
                 photo_uploaded_at?: string;
                 /** @description The platform of our app that the inspection will be / has been performed on. */
                 platform?: components["schemas"]["InspectionPlatform"];
+                /**
+                 * Format: date-time
+                 * @description The date/time the inspection last entered Processing. Per-round token: the finalizer carries the round it was enqueued for and only transitions while this still matches, so a stale finalizer can't finalize a newer round. `null` for legacy inspections. VISION-2718.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                processing_started_at?: string | null;
+                /**
+                 * Format: date-time
+                 * @description The date/time the inspection moved to Ready for Review (processing completed, terminally failed, or timed out), written by the finalizer's transition. Reset to `null` whenever a request-more moves the inspection back to In-Progress and repopulated at the next finalization.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                ready_at?: string | null;
+                /**
+                 * Format: date-time
+                 * @description The date/time the Ready-for-Review assignee email was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                ready_for_review_email_sent_at?: string | null;
+                /**
+                 * Format: date-time
+                 * @description The date/time the Ready-for-Review status webhook was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+                 * @example 2020-05-01T21:44:40.000Z
+                 */
+                ready_for_review_webhook_sent_at?: string | null;
                 /**
                  * Format: date-time
                  * @description The date/time (in UTC) the inspection is scheduled to be sent to the customer
@@ -6730,6 +6762,12 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             expires_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection entered Processing (was submitted). Stamped on every entry into Processing (app-user submit, request-more resubmit, or request expiry), so it repopulates on resubmit. A non-null value is the durable "already submitted" signal consumed by vision-web and the mobile apps. Reset to `null` whenever a request-more moves the inspection back to In-Progress.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            finished_at?: string | null;
             /**
              * @description The id of the group this inspection is for.
              * @example 23
@@ -6805,6 +6843,30 @@ export interface components {
             photo_uploaded_at?: string;
             /** @description The platform of our app that the inspection will be / has been performed on. */
             platform?: components["schemas"]["InspectionPlatform"];
+            /**
+             * Format: date-time
+             * @description The date/time the inspection last entered Processing. Per-round token: the finalizer carries the round it was enqueued for and only transitions while this still matches, so a stale finalizer can't finalize a newer round. `null` for legacy inspections. VISION-2718.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            processing_started_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection moved to Ready for Review (processing completed, terminally failed, or timed out), written by the finalizer's transition. Reset to `null` whenever a request-more moves the inspection back to In-Progress and repopulated at the next finalization.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the Ready-for-Review assignee email was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_for_review_email_sent_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the Ready-for-Review status webhook was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_for_review_webhook_sent_at?: string | null;
             /**
              * Format: date-time
              * @description The date/time (in UTC) the inspection is scheduled to be sent to the customer
@@ -7019,7 +7081,8 @@ export interface components {
              */
             test_pop: boolean;
             /**
-             * @description Whether or not to include the ris test in this alert.
+             * @deprecated
+             * @description Whether or not to include the ris test in this alert. Reverse Image Search is deprecated and no longer runs.
              * @example true
              */
             test_ris: boolean;
@@ -7306,7 +7369,7 @@ export interface components {
          * @description The possible statuses for an inspection.
          * @enum {number}
          */
-        InspectionStatusId: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+        InspectionStatusId: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
         InspectionTruepic: {
             /**
              * @description The accuracy of the GPS coordinates in meters.
@@ -7605,7 +7668,8 @@ export interface components {
              */
             processing_completed_at?: string;
             /**
-             * @description The status of a reverse-image-search test on this Truepic.
+             * @deprecated
+             * @description The status of a reverse-image-search test on this Truepic. Reverse Image Search is deprecated and no longer runs. New captures will have ris_status 'N' (not applicable).
              * @example P
              */
             ris_status: components["schemas"]["TestResult"];
@@ -8746,7 +8810,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" | "dashboard_user_feedback_forms" | "member_homepage" | "reuse_detection" | "restrict_members_to_inspection_details" | "ai_analysis_configuration" | "guided_capture" | "verisk_sso";
+        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" | "dashboard_user_feedback_forms" | "member_homepage" | "reuse_detection" | "restrict_members_to_inspection_details" | "ai_analysis_configuration" | "guided_capture" | "verisk_sso" | "enable_processing_status_for_inspections";
         /** @description A possible outcome for an inspection */
         Outcome: {
             /**
@@ -10059,6 +10123,12 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             expires_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection entered Processing (was submitted). Stamped on every entry into Processing (app-user submit, request-more resubmit, or request expiry), so it repopulates on resubmit. A non-null value is the durable "already submitted" signal consumed by vision-web and the mobile apps. Reset to `null` whenever a request-more moves the inspection back to In-Progress.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            finished_at?: string | null;
             group?: components["schemas"]["Group"];
             /**
              * @description The id of the group this inspection is for.
@@ -10377,6 +10447,30 @@ export interface components {
             photos: components["schemas"]["InspectionTruepic"][];
             /** @description The platform of our app that the inspection will be / has been performed on. */
             platform?: components["schemas"]["InspectionPlatform"];
+            /**
+             * Format: date-time
+             * @description The date/time the inspection last entered Processing. Per-round token: the finalizer carries the round it was enqueued for and only transitions while this still matches, so a stale finalizer can't finalize a newer round. `null` for legacy inspections. VISION-2718.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            processing_started_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the inspection moved to Ready for Review (processing completed, terminally failed, or timed out), written by the finalizer's transition. Reset to `null` whenever a request-more moves the inspection back to In-Progress and repopulated at the next finalization.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the Ready-for-Review assignee email was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_for_review_email_sent_at?: string | null;
+            /**
+             * Format: date-time
+             * @description The date/time the Ready-for-Review status webhook was enqueued by the finalizer. Durable per-channel idempotency marker: `null` means not yet sent. Reset to `null` whenever the inspection (re-)enters Processing.
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            ready_for_review_webhook_sent_at?: string | null;
             /**
              * Format: date-time
              * @description The date/time (in UTC) the inspection is scheduled to be sent to the customer
@@ -11197,6 +11291,17 @@ export interface components {
              * @example false
              */
             mutual_tls: boolean;
+            /**
+             * @description The OAuth `client_secret` Vision presents when requesting an access token from `oauth_config.token_url`. Write-only: it is stored encrypted and is never returned by this API. To set or rotate it, provide the new secret. To remove it, set this to null. To leave it unchanged, omit this field.
+             * @example some-oauth-client-secret
+             */
+            oauth_client_secret?: string | null;
+            /**
+             * @description OAuth 2.0 client credentials configuration. When set, Vision obtains an access token from the configured token endpoint and presents it on the webhook request. Null means the webhook is delivered without OAuth.
+             *
+             *     This is independent of the `truepic-signature` payload signature and of mutual TLS — any combination of the three can be used together.
+             */
+            oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | unknown;
             /**
              * @description The id of the organization.
              * @example 1
@@ -11246,6 +11351,11 @@ export interface components {
              * @example 2023-06-01 17:12:20.097233+00
              */
             disabled_at?: string | null;
+            /**
+             * @description Whether or not the webhook has an OAuth `client_secret` stored.
+             * @example true
+             */
+            has_oauth_client_secret?: boolean;
             /**
              * @description Whether or not the webhook has a secret.
              * @example true
@@ -11267,6 +11377,22 @@ export interface components {
              * @example false
              */
             mutual_tls: boolean;
+            /**
+             * @description The OAuth `client_secret` Vision presents when requesting an access token from `oauth_config.token_url`. Write-only: it is stored encrypted and is never returned by this API. To set or rotate it, provide the new secret. To remove it, set this to null. To leave it unchanged, omit this field.
+             * @example some-oauth-client-secret
+             */
+            oauth_client_secret?: string | null;
+            /**
+             * @description The encrypted OAuth `client_secret` used when requesting an access token.
+             * @example WMHadsfgYQ+348BEPcoyucKSaerwgq34gq34grstXp62P0Svn5VyEAGCKXM+CKcaw==
+             */
+            oauth_client_secret_encrypted?: string | null;
+            /**
+             * @description OAuth 2.0 client credentials configuration. When set, Vision obtains an access token from the configured token endpoint and presents it on the webhook request. Null means the webhook is delivered without OAuth.
+             *
+             *     This is independent of the `truepic-signature` payload signature and of mutual TLS — any combination of the three can be used together.
+             */
+            oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | unknown;
             /**
              * @description The id of the organization.
              * @example 1
@@ -11306,6 +11432,118 @@ export interface components {
              */
             vision_api_version: components["schemas"]["VisionAPIVersion"];
         };
+        /**
+         * @description OAuth 2.0 client credentials configuration for an outbound webhook.
+         *
+         *     When present, Vision exchanges the configured credentials for a short-lived access token before delivering a webhook, and presents that token on the webhook request. The webhook payload itself is unaffected.
+         *
+         *     The `client_secret` is not part of this object — it is supplied through the separate write-only `oauth_client_secret` field on the webhook, stored encrypted, and never returned.
+         *
+         *     Every field other than `token_url` and `client_id` is optional; the defaults describe a standard RFC 6749 §4.4 exchange against an authorization server that returns a standard token response.
+         */
+        TeamWebhookOAuthConfig: {
+            /**
+             * @description The field in the token response that holds the access token, for authorization servers that use a non-standard name.
+             * @default access_token
+             * @example access_token
+             */
+            access_token_field: string;
+            /**
+             * @description Any additional parameters the token endpoint requires beyond the standard set. Sent alongside `grant_type` in the request body.
+             *
+             *     `grant_type`, `client_id`, `client_secret`, `scope`, `audience`, and `resource` are rejected here — they are built from their own configuration fields, and a duplicate would silently replace the configured value.
+             * @example {
+             *       "tenant": "cotality-prod"
+             *     }
+             */
+            additional_token_parameters?: {
+                [key: string]: string;
+            } | unknown;
+            /**
+             * @description The `audience` parameter, if the authorization server requires one.
+             * @example https://your-gateway.example.com/
+             */
+            audience?: string | null;
+            /**
+             * @description The header the access token is presented in on the webhook request, for gateways that expect something other than `Authorization`.
+             * @default Authorization
+             * @example Authorization
+             */
+            authorization_header_name: string;
+            /**
+             * @description The prefix placed before the token in the authorization header. A single space separates it from the token. Set to an empty string to send the bare token with no prefix.
+             * @default Bearer
+             * @example Bearer
+             */
+            authorization_header_prefix: string;
+            /**
+             * @description Whether Vision caches the access token and reuses it across deliveries until shortly before it expires. Set to false to request a fresh token for every delivery — this makes token endpoint load proportional to event volume rather than to token lifetime.
+             * @default true
+             * @example true
+             */
+            cache_tokens: boolean;
+            /**
+             * @description How the client credentials are presented on the token request: in the request body (`client_secret_post`) or as an HTTP Basic authorization header (`client_secret_basic`).
+             * @default client_secret_post
+             * @example client_secret_post
+             */
+            client_auth_method: components["schemas"]["WebhookOAuthClientAuthMethod"];
+            /**
+             * @description The OAuth client identifier issued to Truepic.
+             * @example truepic-vision-webhooks
+             */
+            client_id: string;
+            /**
+             * @description The lifetime Vision assumes when the token response carries no expiry at all. Required in that case — without an expiry and without this, Vision cannot know when to refresh.
+             * @example 3600
+             */
+            default_token_lifetime_seconds?: number | null;
+            /**
+             * @description The field in the token response that holds the expiry as an absolute timestamp (epoch seconds, epoch milliseconds, or an ISO 8601 string) rather than a duration. Takes precedence over `expires_in_field` when set.
+             * @example expires_at
+             */
+            expires_at_field?: string | null;
+            /**
+             * @description The field in the token response that holds the token lifetime as a duration. Read as either a number or a numeric string.
+             * @default expires_in
+             * @example expires_in
+             */
+            expires_in_field: string;
+            /**
+             * @description The unit of the duration in `expires_in_field`.
+             * @default seconds
+             * @example seconds
+             */
+            expires_in_unit: components["schemas"]["WebhookOAuthExpiresInUnit"];
+            /**
+             * @description Whether `grant_type` is sent in the request body (per RFC 6749) or as a query parameter on the token endpoint URL.
+             * @default body
+             * @example body
+             */
+            grant_type_placement: components["schemas"]["WebhookOAuthGrantTypePlacement"];
+            /**
+             * @description The `resource` parameter, if the authorization server requires one.
+             * @example https://your-gateway.example.com/webhooks
+             */
+            resource?: string | null;
+            /**
+             * @description Space-delimited scopes, if the authorization server requires them.
+             * @example webhooks:write
+             */
+            scope?: string | null;
+            /**
+             * @description How long Vision waits for the token endpoint to respond, in milliseconds.
+             * @default 10000
+             * @example 10000
+             */
+            token_request_timeout_ms: number;
+            /**
+             * Format: url
+             * @description The token endpoint Vision exchanges the client credentials at. Must be HTTPS outside of local development.
+             * @example https://your-gateway.example.com/oauth/token
+             */
+            token_url: string;
+        };
         TeamWebhookPayload: {
             /**
              * @description An object containing any custom headers that should be sent in the webhook POST request. If you want a unique request id header to be sent, create a header with a value of "{{ UUID }}". When the webhook is sent, this will be replaced with a unique UUID for each request.
@@ -11326,6 +11564,17 @@ export interface components {
              * @example false
              */
             mutual_tls: boolean;
+            /**
+             * @description The OAuth `client_secret` Vision presents when requesting an access token from `oauth_config.token_url`. Write-only: it is stored encrypted and is never returned by this API. To set or rotate it, provide the new secret. To remove it, set this to null. To leave it unchanged, omit this field.
+             * @example some-oauth-client-secret
+             */
+            oauth_client_secret?: string | null;
+            /**
+             * @description OAuth 2.0 client credentials configuration. When set, Vision obtains an access token from the configured token endpoint and presents it on the webhook request. Null means the webhook is delivered without OAuth.
+             *
+             *     This is independent of the `truepic-signature` payload signature and of mutual TLS — any combination of the three can be used together.
+             */
+            oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | unknown;
             /**
              * @description The secret used for authenticating the webhooks. When we send webhooks to your endpoint, we will add a truepic-signature header to those requests that we generate using this secret. When your endpoint receives a webhook POST request, you can then verify that the request was signed with this secret to ensure that the request is from us. If you want to remove the secret, set this to null. If you want to set a new secret, provide the new secret string. If you don't want to change the secret, omit this field.
              * @example some-secret-string
@@ -11370,6 +11619,11 @@ export interface components {
              * @example 2023-06-01 17:12:20.097233+00
              */
             disabled_at?: string | null;
+            /**
+             * @description Whether or not the webhook has an OAuth `client_secret` stored.
+             * @example true
+             */
+            has_oauth_client_secret?: boolean;
             /**
              * @description Whether or not the webhook has a secret.
              * @example true
@@ -11391,6 +11645,12 @@ export interface components {
              * @example false
              */
             mutual_tls: boolean;
+            /**
+             * @description OAuth 2.0 client credentials configuration. When set, Vision obtains an access token from the configured token endpoint and presents it on the webhook request. Null means the webhook is delivered without OAuth.
+             *
+             *     This is independent of the `truepic-signature` payload signature and of mutual TLS — any combination of the three can be used together.
+             */
+            oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | unknown;
             /**
              * @description The id of the organization.
              * @example 1
@@ -12124,6 +12384,23 @@ export interface components {
             /** @description URI of the page or document the model relied on. One URI per source — multiple supporting URIs become multiple `web_lookup` entries. */
             uri: string;
         };
+        /**
+         * @description How Vision presents the client credentials on the token request.
+         *
+         *     Named after the RFC 6749 §2.3.1 client authentication methods so the value maps directly onto what an authorization server's documentation calls it.
+         * @enum {string}
+         */
+        WebhookOAuthClientAuthMethod: "client_secret_post" | "client_secret_basic";
+        /**
+         * @description The unit the authorization server uses for the token expiry field.
+         * @enum {string}
+         */
+        WebhookOAuthExpiresInUnit: "seconds" | "milliseconds";
+        /**
+         * @description Where Vision places `grant_type` on the token request.
+         * @enum {string}
+         */
+        WebhookOAuthGrantTypePlacement: "body" | "query";
         WebsiteFormBearerSerialized: {
             inspection_types: {
                 /** @description An array of custom fields that are used by this inspection type */

package/package.json

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