@truepic/vision-api-types 3.93.0 → 3.94.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.
- package/index.d.ts +57 -14
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -5496,6 +5496,39 @@ export interface components {
|
|
|
5496
5496
|
*/
|
|
5497
5497
|
lifecycle: "test" | "live";
|
|
5498
5498
|
};
|
|
5499
|
+
/** @description Who made a change to an inspection. The person, when there is one, is the action's `member_user_id`, or its `customer_user_id` for `customer`; Truepic staff show as `truepic`. */
|
|
5500
|
+
InspectionActivityActor: {
|
|
5501
|
+
/** @enum {string} */
|
|
5502
|
+
type: "member" | "truepic" | "system" | "customer";
|
|
5503
|
+
} | {
|
|
5504
|
+
/**
|
|
5505
|
+
* @description The name of the API key used.
|
|
5506
|
+
* @example Acme Insurance Bot
|
|
5507
|
+
*/
|
|
5508
|
+
api_key_name: string | null;
|
|
5509
|
+
/** @enum {string} */
|
|
5510
|
+
type: "api";
|
|
5511
|
+
};
|
|
5512
|
+
/** @description One field changed by an inspection edit, type change, reassignment, reschedule, question answer, test status override or device flag change, with its label and values as they read at the time. */
|
|
5513
|
+
InspectionActivityChange: {
|
|
5514
|
+
/**
|
|
5515
|
+
* @description The changed field. Custom fields are `custom_field_values.<index>`.
|
|
5516
|
+
* @example customer_email_address
|
|
5517
|
+
*/
|
|
5518
|
+
field: string;
|
|
5519
|
+
/** @example Email */
|
|
5520
|
+
label: string;
|
|
5521
|
+
/**
|
|
5522
|
+
* @description Null when the field is now empty.
|
|
5523
|
+
* @example jane.doe@example.com
|
|
5524
|
+
*/
|
|
5525
|
+
new_value: string | null;
|
|
5526
|
+
/**
|
|
5527
|
+
* @description Null when the field was empty.
|
|
5528
|
+
* @example jane@example.com
|
|
5529
|
+
*/
|
|
5530
|
+
old_value: string | null;
|
|
5531
|
+
};
|
|
5499
5532
|
/** @enum {string} */
|
|
5500
5533
|
InspectionInsightType: "insecure_device" | "falsified_location" | "device_found_other_inspections" | "device_flagged_other_inspections" | "dot_tin_reuse" | "vin_reuse";
|
|
5501
5534
|
/** @description A member summary embedded in an inspection or its timeline. */
|
|
@@ -6103,6 +6136,10 @@ export interface components {
|
|
|
6103
6136
|
created_at: string;
|
|
6104
6137
|
customer_user_id?: number | (null);
|
|
6105
6138
|
data?: {
|
|
6139
|
+
/** @description Who made the change, for an edit, type change or assignment. */
|
|
6140
|
+
actor?: components["schemas"]["InspectionActivityActor"];
|
|
6141
|
+
/** @description Each field an edit, type change or reassignment changed. */
|
|
6142
|
+
changes?: components["schemas"]["InspectionActivityChange"][];
|
|
6106
6143
|
comment?: string | null;
|
|
6107
6144
|
flags?: string[];
|
|
6108
6145
|
list_item_id?: number | null;
|
|
@@ -6209,7 +6246,7 @@ export interface components {
|
|
|
6209
6246
|
created_at: string;
|
|
6210
6247
|
/**
|
|
6211
6248
|
* @description The message template for messages sent as reminders for started but unfinished inspection requests.
|
|
6212
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection.
|
|
6249
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. {{CustomNote}} Questions? Call us at {{ClientSupportNumber}}. Tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}}
|
|
6213
6250
|
*/
|
|
6214
6251
|
finish_reminder?: string;
|
|
6215
6252
|
/**
|
|
@@ -6245,7 +6282,7 @@ export interface components {
|
|
|
6245
6282
|
name: string;
|
|
6246
6283
|
/**
|
|
6247
6284
|
* @description The message template for messages sent for new inspection requests.
|
|
6248
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app
|
|
6285
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} reaching out to request photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6249
6286
|
*/
|
|
6250
6287
|
new_request: string;
|
|
6251
6288
|
/**
|
|
@@ -6255,7 +6292,7 @@ export interface components {
|
|
|
6255
6292
|
new_request_subject: string;
|
|
6256
6293
|
/**
|
|
6257
6294
|
* @description The message template for messages sent to request additional items on an inspection request.
|
|
6258
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app
|
|
6295
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} requesting that you upload additional photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6259
6296
|
*/
|
|
6260
6297
|
request_more: string;
|
|
6261
6298
|
/**
|
|
@@ -6265,7 +6302,7 @@ export interface components {
|
|
|
6265
6302
|
request_more_subject: string;
|
|
6266
6303
|
/**
|
|
6267
6304
|
* @description The message template for messages sent as reminders for pending inspection requests.
|
|
6268
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app
|
|
6305
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6269
6306
|
*/
|
|
6270
6307
|
request_reminder: string;
|
|
6271
6308
|
/**
|
|
@@ -6698,7 +6735,7 @@ export interface components {
|
|
|
6698
6735
|
created_at: string;
|
|
6699
6736
|
/**
|
|
6700
6737
|
* @description The message template for messages sent as reminders for started but unfinished inspection requests.
|
|
6701
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection.
|
|
6738
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} from {{CompanyName}} reminding you that you have until {{ExpirationDueDateTime}} to finish your inspection. {{CustomNote}} Questions? Call us at {{ClientSupportNumber}}. Tap the following link to open the Truepic Vision app and return to your inspection: {{SmartLink}}
|
|
6702
6739
|
*/
|
|
6703
6740
|
finish_reminder?: string;
|
|
6704
6741
|
/**
|
|
@@ -6740,7 +6777,7 @@ export interface components {
|
|
|
6740
6777
|
name: string;
|
|
6741
6778
|
/**
|
|
6742
6779
|
* @description The message template for messages sent for new inspection requests.
|
|
6743
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} reaching out to request photos. To begin, click on the following link to download the Truepic Vision app
|
|
6780
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} reaching out to request photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6744
6781
|
*/
|
|
6745
6782
|
new_request: string;
|
|
6746
6783
|
/**
|
|
@@ -6750,7 +6787,7 @@ export interface components {
|
|
|
6750
6787
|
new_request_subject: string;
|
|
6751
6788
|
/**
|
|
6752
6789
|
* @description The message template for messages sent to request additional items on an inspection request.
|
|
6753
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} requesting that you upload additional photos. To begin, click on the following link to download the Truepic Vision app
|
|
6790
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} requesting that you upload additional photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6754
6791
|
*/
|
|
6755
6792
|
request_more: string;
|
|
6756
6793
|
/**
|
|
@@ -6760,7 +6797,7 @@ export interface components {
|
|
|
6760
6797
|
request_more_subject: string;
|
|
6761
6798
|
/**
|
|
6762
6799
|
* @description The message template for messages sent as reminders for pending inspection requests.
|
|
6763
|
-
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. To begin, click on the following link to download the Truepic Vision app
|
|
6800
|
+
* @example Hi {{CustomerFirstName}}, this is {{MemberName}} sending a reminder that you have not yet submitted the requested photos. Please note, this request will expire on {{ExpirationDueDateTime}}. {{CustomNote}} To begin, click on the following link to download the Truepic Vision app and follow the onscreen instructions: {{SmartLink}}
|
|
6764
6801
|
*/
|
|
6765
6802
|
request_reminder: string;
|
|
6766
6803
|
/**
|
|
@@ -6996,7 +7033,7 @@ export interface components {
|
|
|
6996
7033
|
updated_by_user_id: number | null;
|
|
6997
7034
|
};
|
|
6998
7035
|
/** @enum {string} */
|
|
6999
|
-
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" | "disable_selfie_capture";
|
|
7036
|
+
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" | "disable_selfie_capture" | "ai_guide";
|
|
7000
7037
|
/** @description An outcome set expanded into its selectable outcomes. */
|
|
7001
7038
|
OutcomeSetSerialized: {
|
|
7002
7039
|
created_at?: string;
|
|
@@ -7265,7 +7302,7 @@ export interface components {
|
|
|
7265
7302
|
};
|
|
7266
7303
|
/** @description Evidence produced by an AI analysis tool, such as a decoded barcode. */
|
|
7267
7304
|
PublishedToolSource: components["schemas"]["BarcodeDecodedSource"];
|
|
7268
|
-
/** @description The text of a customer request or reminder. Both the `{{SmartLink}}` and `{{CustomNote}}` placeholders are required when writing it. */
|
|
7305
|
+
/** @description The text of a customer request or reminder. Both the `{{SmartLink}}` and `{{CustomNote}}` placeholders are required when writing it, and it must end with its only `{{SmartLink}}`. A template that is not changed by an update is not checked, so sets saved before these rules keep their wording. */
|
|
7269
7306
|
RequestMessageTemplate: string;
|
|
7270
7307
|
/** @description The generic format for Vision API responses. */
|
|
7271
7308
|
ResponseData: {
|
|
@@ -7487,6 +7524,12 @@ export interface components {
|
|
|
7487
7524
|
};
|
|
7488
7525
|
/** @description A user, serialized for the client. This is usually the object the API returns, and is used for client-side rendering. */
|
|
7489
7526
|
SerializedUser: {
|
|
7527
|
+
/**
|
|
7528
|
+
* Format: date-time
|
|
7529
|
+
* @description When the resource was created.
|
|
7530
|
+
* @example 2020-05-01T21:44:40.000Z
|
|
7531
|
+
*/
|
|
7532
|
+
created_at: string;
|
|
7490
7533
|
/**
|
|
7491
7534
|
* @description The user's default team. Always `null`.
|
|
7492
7535
|
* @example null
|
|
@@ -8100,7 +8143,7 @@ export interface components {
|
|
|
8100
8143
|
*/
|
|
8101
8144
|
secret?: string | null;
|
|
8102
8145
|
/**
|
|
8103
|
-
* @description The ID of the team.
|
|
8146
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8104
8147
|
* @example 12
|
|
8105
8148
|
*/
|
|
8106
8149
|
team_id: number;
|
|
@@ -8181,7 +8224,7 @@ export interface components {
|
|
|
8181
8224
|
*/
|
|
8182
8225
|
oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | (null);
|
|
8183
8226
|
/**
|
|
8184
|
-
* @description The ID of the team.
|
|
8227
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8185
8228
|
* @example 12
|
|
8186
8229
|
*/
|
|
8187
8230
|
team_id: number;
|
|
@@ -8791,7 +8834,7 @@ export interface components {
|
|
|
8791
8834
|
*/
|
|
8792
8835
|
secret?: string | null;
|
|
8793
8836
|
/**
|
|
8794
|
-
* @description The ID of the team.
|
|
8837
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8795
8838
|
* @example 12
|
|
8796
8839
|
*/
|
|
8797
8840
|
team_id?: number;
|
|
@@ -8907,7 +8950,7 @@ export interface components {
|
|
|
8907
8950
|
* @description An event an outbound Vision webhook can be subscribed to via `enabled_events`.
|
|
8908
8951
|
* @enum {string}
|
|
8909
8952
|
*/
|
|
8910
|
-
WebhookEventType: "ACTION_INSPECTION_CREATED" | "ACTION_INSPECTION_SCHEDULED" | "ACTION_INSPECTION_RESCHEDULED" | "ACTION_STATUS_STARTED" | "ACTION_STATUS_IN_PROGRESS" | "ACTION_STATUS_PROCESSING" | "ACTION_STATUS_READY_FOR_REVIEW" | "ACTION_INSPECTION_CLOSED" | "ACTION_INSPECTION_CANCELED" | "ACTION_PHOTO_VERIFICATION_PASSED" | "ACTION_PHOTO_VERIFICATION_FAILED" | "ACTION_PHOTO_VERIFICATION_WARN" | "ACTION_PHOTO_DELETED" | "ACTION_QUESTION_ANSWERED" | "ACTION_QUESTION_ANSWER_DELETED" | "ACTION_MESSAGE_WELCOME_TEXT" | "ACTION_MESSAGE_REMINDER_TEXT" | "ACTION_MESSAGE_FINISH_REMINDER_TEXT" | "ACTION_MESSAGE_AUTO_REMINDER_TEXT" | "ACTION_MESSAGE_AUTO_FINISH_REMINDER_TEXT" | "ACTION_MESSAGE_REQUEST_TEXT" | "ACTION_MESSAGE_INSPECTION_FINISHED_TEXT" | "ACTION_CONSUMER_REPLY" | "ACTION_MESSAGE_AUTO_REPLY_TEXT" | "ACTION_MESSAGE_AGENT_REPLY_TEXT" | "ACTION_MESSAGE_RECEIVED" | "ACTION_MESSAGE_FAILED" | "ACTION_MESSAGE_UNDELIVERED" | "ACTION_MESSAGE_TEXT_DROPPED_VIA_UNSUBSCRIBE" | "ACTION_MESSAGE_WELCOME_EMAIL" | "ACTION_MESSAGE_REMINDER_EMAIL" | "ACTION_MESSAGE_FINISH_REMINDER_EMAIL" | "ACTION_MESSAGE_AUTO_REMINDER_EMAIL" | "ACTION_MESSAGE_AUTO_FINISH_REMINDER_EMAIL" | "ACTION_MESSAGE_REQUEST_EMAIL" | "ACTION_MESSAGE_INSPECTION_FINISHED_EMAIL" | "ACTION_MESSAGE_AUTO_REPLY_EMAIL" | "ACTION_MESSAGE_EMAIL_REPLY" | "ACTION_MESSAGE_EMAIL_RECEIVED" | "ACTION_MESSAGE_EMAIL_OPENED" | "ACTION_MESSAGE_EMAIL_BOUNCED" | "ACTION_MESSAGE_EMAIL_DROPPED" | "ACTION_MESSAGE_EMAIL_DROPPED_VIA_UNSUBSCRIBE" | "ACTION_MESSAGE_EMAIL_SPAM_REPORTED" | "ACTION_EMAIL_UNSUBSCRIBED" | "ACTION_EMAIL_RESUBSCRIBED" | "ACTION_APP_OPENED" | "ACTION_PDF_READY" | "ACTION_PDF_FAILED" | "ACTION_AI_ANALYSIS_FAILED";
|
|
8953
|
+
WebhookEventType: "ACTION_INSPECTION_CREATED" | "ACTION_INSPECTION_SCHEDULED" | "ACTION_INSPECTION_RESCHEDULED" | "ACTION_STATUS_STARTED" | "ACTION_STATUS_IN_PROGRESS" | "ACTION_STATUS_PROCESSING" | "ACTION_STATUS_READY_FOR_REVIEW" | "ACTION_INSPECTION_CLOSED" | "ACTION_INSPECTION_CANCELED" | "ACTION_PHOTO_VERIFICATION_PASSED" | "ACTION_PHOTO_VERIFICATION_FAILED" | "ACTION_PHOTO_VERIFICATION_WARN" | "ACTION_PHOTO_DELETED" | "ACTION_QUESTION_ANSWERED" | "ACTION_QUESTION_ANSWER_DELETED" | "ACTION_MESSAGE_WELCOME_TEXT" | "ACTION_MESSAGE_REMINDER_TEXT" | "ACTION_MESSAGE_FINISH_REMINDER_TEXT" | "ACTION_MESSAGE_AUTO_REMINDER_TEXT" | "ACTION_MESSAGE_AUTO_FINISH_REMINDER_TEXT" | "ACTION_MESSAGE_REQUEST_TEXT" | "ACTION_MESSAGE_INSPECTION_FINISHED_TEXT" | "ACTION_CONSUMER_REPLY" | "ACTION_MESSAGE_AUTO_REPLY_TEXT" | "ACTION_MESSAGE_AGENT_REPLY_TEXT" | "ACTION_MESSAGE_RECEIVED" | "ACTION_MESSAGE_FAILED" | "ACTION_MESSAGE_UNDELIVERED" | "ACTION_MESSAGE_TEXT_DROPPED_VIA_UNSUBSCRIBE" | "ACTION_MESSAGE_TEXT_SKIPPED_AFTER_DELIVERY_FAILURE" | "ACTION_MESSAGE_TEXT_DROPPED_VIA_OPT_OUT" | "ACTION_MESSAGE_WELCOME_EMAIL" | "ACTION_MESSAGE_REMINDER_EMAIL" | "ACTION_MESSAGE_FINISH_REMINDER_EMAIL" | "ACTION_MESSAGE_AUTO_REMINDER_EMAIL" | "ACTION_MESSAGE_AUTO_FINISH_REMINDER_EMAIL" | "ACTION_MESSAGE_REQUEST_EMAIL" | "ACTION_MESSAGE_INSPECTION_FINISHED_EMAIL" | "ACTION_MESSAGE_AUTO_REPLY_EMAIL" | "ACTION_MESSAGE_EMAIL_REPLY" | "ACTION_MESSAGE_EMAIL_RECEIVED" | "ACTION_MESSAGE_EMAIL_OPENED" | "ACTION_MESSAGE_EMAIL_BOUNCED" | "ACTION_MESSAGE_EMAIL_DROPPED" | "ACTION_MESSAGE_EMAIL_DROPPED_VIA_UNSUBSCRIBE" | "ACTION_MESSAGE_EMAIL_SPAM_REPORTED" | "ACTION_EMAIL_UNSUBSCRIBED" | "ACTION_EMAIL_RESUBSCRIBED" | "ACTION_APP_OPENED" | "ACTION_PDF_READY" | "ACTION_PDF_FAILED" | "ACTION_AI_ANALYSIS_FAILED";
|
|
8911
8954
|
/**
|
|
8912
8955
|
* @description How Vision presents the client credentials on the token request.
|
|
8913
8956
|
*
|