@truepic/vision-api-types 3.81.0 → 3.83.0

package/index.d.ts

@@ -478,12 +478,30 @@ export interface paths {
                         /** @description Limit the PDF to a subset of photos/videos. */
                         photos: number[];
                     };
-                    /** @description Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property. */
-                    "include[]"?: "inspectionNote"[];
-                    /** @description Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property. */
-                    "exclude[]"?: ("questions" | "thumbnails" | "imageDetails" | "timeline")[];
+                    /**
+                     * @description Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property.
+                     *
+                     *     Accepts the legacy `inspectionNote` alias and the canonical section ids. The only opt-in section is Inspection Notes; the other ids are accepted for forward-compatibility.
+                     */
+                    "include[]"?: ("inspectionNote" | "cover" | "contents" | "captureLocation" | "inspectionItems" | "imageDetails" | "aiAnalysis" | "inspectionNotes" | "captureDevices" | "timeline")[];
+                    /**
+                     * @description Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property.
+                     *
+                     *     Accepts the legacy tokens (`questions` → Inspection Items, `thumbnails` → no-op, `imageDetails`, `timeline`) and the canonical section ids.
+                     */
+                    "exclude[]"?: ("questions" | "thumbnails" | "cover" | "contents" | "captureLocation" | "inspectionItems" | "imageDetails" | "aiAnalysis" | "inspectionNotes" | "captureDevices" | "timeline")[];
+                    /** @description Whether to include items the customer never submitted (unanswered questions and captures with no upload) in the Inspection Items section. Set to `false` to hide them. */
+                    showUnansweredItems?: boolean;
                     /** @description The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC. */
                     tz?: string;
+                    /**
+                     * @description Which capture-location maps to render in the Image Details section. Omit to render a map for every capture (the default); provide a subset to limit which captures get a map, or an empty array to render no maps.
+                     *
+                     *     - `outside`: captures taken outside the expected address
+                     *     - `within`: captures taken within the expected address
+                     *     - `no_location`: captures with no expected address on the inspection
+                     */
+                    "captureLocationMaps[]"?: ("outside" | "within" | "no_location")[];
                 };
                 header?: never;
                 path: {
@@ -4466,20 +4484,41 @@ export interface components {
              * @default false
              */
             async: boolean;
+            /**
+             * @description Which capture-location maps to render in the Image Details section. Omit to render a map for every capture (the default). Provide a subset to limit it, or an empty array to render no maps.
+             *     - `outside`: captures taken outside the expected address
+             *     - `within`: captures taken within the expected address
+             *     - `no_location`: captures with no expected address on the inspection
+             * @default [
+             *       "outside",
+             *       "within",
+             *       "no_location"
+             *     ]
+             */
+            captureLocationMaps: ("outside" | "within" | "no_location")[];
             /**
              * @description Specific sections to exclude that are included by default. If you do not want to exclude any sections, you can omit this property.
+             *
+             *     Accepts the legacy tokens (`questions` → Inspection Items, `thumbnails` → no-op, `imageDetails`, `timeline`) and the canonical section ids.
              * @default []
              */
-            exclude: ("questions" | "thumbnails" | "imageDetails" | "timeline")[];
+            exclude: ("questions" | "thumbnails" | "cover" | "contents" | "captureLocation" | "inspectionItems" | "imageDetails" | "aiAnalysis" | "inspectionNotes" | "captureDevices" | "timeline")[];
             /** @description Filters which photos/videos are included in the PDF. Once specified, the PDF will only be generated based on the specific list of photos that are listed. By default all photos/videos are included. If you don't want to generate a PDF with a specific set of photos/videos, you can omit this property. */
             filter?: {
                 photos: number[];
             };
             /**
              * @description Additional sections to include that are NOT included by default. If you do not want to include any extra sections, you can omit this property.
+             *
+             *     Accepts the legacy `inspectionNote` alias and the canonical section ids. The only opt-in section is Inspection Notes; the other ids are accepted for forward-compatibility and are no-ops when a section is already included.
              * @default []
              */
-            include: ("inspectionNote" | "")[];
+            include: ("inspectionNote" | "cover" | "contents" | "captureLocation" | "inspectionItems" | "imageDetails" | "aiAnalysis" | "inspectionNotes" | "captureDevices" | "timeline")[];
+            /**
+             * @description Whether to include items the customer never submitted (unanswered questions and captures with no upload) in the Inspection Items section. Set `false` to hide them.
+             * @default true
+             */
+            showUnansweredItems: boolean;
             /**
              * @description The IANA time zone name to use when displaying dates/times in the PDF. Defaults to UTC.
              * @default UTC
@@ -5744,11 +5783,6 @@ 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
@@ -6147,6 +6181,14 @@ export interface components {
                  * @example 2020-05-01T21:44:40.000Z
                  */
                 updated_at: string;
+                /**
+                 * @description Verisk customer codes used to route SSO users to this team. Multiple values are supported so a single team can be addressed by many Verisk custCodes, and a single custCode may be shared across multiple teams within an organization (no uniqueness constraint is enforced). Requires the `verisk_sso` organization feature to be enabled.
+                 * @example [
+                 *       "X50100039",
+                 *       "X50100040"
+                 *     ]
+                 */
+                verisk_cust_codes?: string[] | unknown;
                 /**
                  * @description Whether video is enabled as a capture method in the app.
                  * @default false
@@ -6327,6 +6369,41 @@ export interface components {
              */
             totalResults: number;
         };
+        /** @description Response Body for GET /texts/unsubscribed-phone-number */
+        GetUnsubscribedPhoneNumbersResult: {
+            /**
+             * @description The current version number of the Vision API
+             * @example 3.0.0
+             */
+            api_version: string;
+            /**
+             * @description The human readable-status of the response
+             * @example Success
+             */
+            message: string;
+            /**
+             * @description The total number of pages for the given query
+             * @example 12
+             */
+            pageCount: number;
+            /**
+             * @description The HTTP status code of the response
+             * @example 200
+             */
+            response_code: number;
+            /** @description A paginated list of unsubscribed phone numbers */
+            result: components["schemas"]["UnsubscribedPhoneNumber"][];
+            /**
+             * @description The total number of results for the given page
+             * @example 25
+             */
+            total: number;
+            /**
+             * @description The total number of results for the given query
+             * @example 251
+             */
+            totalResults: number;
+        };
         /** @description Response Body for GET /users/{userId} */
         GetUserResult: {
             /**
@@ -7485,6 +7562,11 @@ export interface components {
              * @example 11.4.1
              */
             os?: string;
+            /**
+             * @description A URL to a PDF-optimized variant (max 720×960, aspect preserved), used by the PDF report engine to cut render time and file size.
+             * @example https://d3tbfdtihunht2.cloudfront.net/qfzkoxugjn_p.jpg?...
+             */
+            pdf_image?: string;
             /**
              * @description Whether the Truepic is still uploading
              * @default false
@@ -8648,7 +8730,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_readiness" | "dashboard_user_feedback_forms" | "member_homepage" | "reuse_detection" | "restrict_members_to_inspection_details" | "ai_analysis_configuration" | "guided_capture";
+        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_readiness" | "dashboard_user_feedback_forms" | "member_homepage" | "reuse_detection" | "restrict_members_to_inspection_details" | "ai_analysis_configuration" | "guided_capture" | "verisk_sso";
         /** @description A possible outcome for an inspection */
         Outcome: {
             /**
@@ -9135,11 +9217,6 @@ 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
@@ -9543,6 +9620,14 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             updated_at: string;
+            /**
+             * @description Verisk customer codes used to route SSO users to this team. Multiple values are supported so a single team can be addressed by many Verisk custCodes, and a single custCode may be shared across multiple teams within an organization (no uniqueness constraint is enforced). Requires the `verisk_sso` organization feature to be enabled.
+             * @example [
+             *       "X50100039",
+             *       "X50100040"
+             *     ]
+             */
+            verisk_cust_codes?: string[] | unknown;
             /**
              * @description Whether video is enabled as a capture method in the app.
              * @default false
@@ -10734,11 +10819,6 @@ 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
@@ -10848,6 +10928,14 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             updated_at: string;
+            /**
+             * @description Verisk customer codes used to route SSO users to this team. Multiple values are supported so a single team can be addressed by many Verisk custCodes, and a single custCode may be shared across multiple teams within an organization (no uniqueness constraint is enforced). Requires the `verisk_sso` organization feature to be enabled.
+             * @example [
+             *       "X50100039",
+             *       "X50100040"
+             *     ]
+             */
+            verisk_cust_codes?: string[] | unknown;
             /**
              * @description Whether video is enabled as a capture method in the app.
              * @default false
@@ -10944,11 +11032,6 @@ 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
@@ -11061,6 +11144,14 @@ export interface components {
              * @example 2020-05-01T21:44:40.000Z
              */
             updated_at?: string;
+            /**
+             * @description Verisk customer codes used to route SSO users to this team. Multiple values are supported so a single team can be addressed by many Verisk custCodes, and a single custCode may be shared across multiple teams within an organization (no uniqueness constraint is enforced). Requires the `verisk_sso` organization feature to be enabled.
+             * @example [
+             *       "X50100039",
+             *       "X50100040"
+             *     ]
+             */
+            verisk_cust_codes?: string[] | unknown;
             /**
              * @description Whether video is enabled as a capture method in the app.
              * @default false
@@ -11436,6 +11527,41 @@ export interface components {
              */
             updated_at: string;
         };
+        /** @description An entry marking a phone number that has unsubscribed from texts from a specific organization. */
+        UnsubscribedPhoneNumber: {
+            /**
+             * 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 1843
+             */
+            id: number;
+            /**
+             * @description The id of the organization that this phone number has unsubscribed from.
+             * @example 532
+             */
+            organization_id: number;
+            /**
+             * @description The ISO 3166-1 alpha-2 country code for the phone number.
+             * @example US
+             */
+            phone_country: string;
+            /**
+             * @description The phone number that has unsubscribed, stored as normalized national digits.
+             * @example 5125551234
+             */
+            phone_number: string;
+            /**
+             * Format: date-time
+             * @description The date/time the resource was last updated
+             * @example 2020-05-01T21:44:40.000Z
+             */
+            updated_at: string;
+        };
         /** @description The request body for PUT /inspections/{inspectionId} */
         UpdateInspectionBody: {
             /**

package/package.json

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