@truepic/vision-api-types 3.92.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 +85 -58
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -4136,7 +4136,7 @@ export interface components {
|
|
|
4136
4136
|
item_id: number;
|
|
4137
4137
|
reason?: string | null;
|
|
4138
4138
|
};
|
|
4139
|
-
/** @description Feedback on Content Summary (
|
|
4139
|
+
/** @description Feedback on Content Summary (`inspection_ready`): an overall verdict plus per-item feedback. */
|
|
4140
4140
|
AIInspectionReadyFeedbackSection: {
|
|
4141
4141
|
items: components["schemas"]["AIInspectionFeedbackItem"][];
|
|
4142
4142
|
overall: components["schemas"]["AIInspectionFeedbackOverall"];
|
|
@@ -4529,11 +4529,6 @@ export interface components {
|
|
|
4529
4529
|
* @example false
|
|
4530
4530
|
*/
|
|
4531
4531
|
include_list: boolean;
|
|
4532
|
-
/**
|
|
4533
|
-
* @description The free-form inspection-ready criteria text. At most 10 KB.
|
|
4534
|
-
* @example Capture all rooms and appliances.
|
|
4535
|
-
*/
|
|
4536
|
-
inspection_ready_criteria_text?: string | null;
|
|
4537
4532
|
/**
|
|
4538
4533
|
* @description The ID of the inspection type this inspection is for.
|
|
4539
4534
|
* @example 12
|
|
@@ -4619,11 +4614,6 @@ export interface components {
|
|
|
4619
4614
|
/** @description The complete collection of custom fields. The first field must have `is_required` set to `true`. */
|
|
4620
4615
|
custom_fields: components["schemas"]["InspectionTypeCustomFieldBody"][];
|
|
4621
4616
|
inspection_alert_config_id?: number | (null);
|
|
4622
|
-
/**
|
|
4623
|
-
* @description The inspection-ready criteria text for this inspection type.
|
|
4624
|
-
* @example Capture the VIN plate clearly and include a full odometer photo.
|
|
4625
|
-
*/
|
|
4626
|
-
inspection_ready_criteria_text?: string | null;
|
|
4627
4617
|
/**
|
|
4628
4618
|
* @description Whether an address is required for the inspection.
|
|
4629
4619
|
* @example true
|
|
@@ -4673,11 +4663,6 @@ export interface components {
|
|
|
4673
4663
|
*/
|
|
4674
4664
|
entry_method?: components["schemas"]["CustomFieldEntryMethods"];
|
|
4675
4665
|
inspection_alert_config_id?: number | (null);
|
|
4676
|
-
/**
|
|
4677
|
-
* @description The inspection-ready criteria text for this inspection type.
|
|
4678
|
-
* @example Capture the VIN plate clearly and include a full odometer photo.
|
|
4679
|
-
*/
|
|
4680
|
-
inspection_ready_criteria_text?: string | null;
|
|
4681
4666
|
/**
|
|
4682
4667
|
* @description Whether an address is required for the inspection.
|
|
4683
4668
|
* @example true
|
|
@@ -5511,6 +5496,39 @@ export interface components {
|
|
|
5511
5496
|
*/
|
|
5512
5497
|
lifecycle: "test" | "live";
|
|
5513
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
|
+
};
|
|
5514
5532
|
/** @enum {string} */
|
|
5515
5533
|
InspectionInsightType: "insecure_device" | "falsified_location" | "device_found_other_inspections" | "device_flagged_other_inspections" | "dot_tin_reuse" | "vin_reuse";
|
|
5516
5534
|
/** @description A member summary embedded in an inspection or its timeline. */
|
|
@@ -5946,7 +5964,6 @@ export interface components {
|
|
|
5946
5964
|
type: components["schemas"]["InspectionInsightType"];
|
|
5947
5965
|
}[];
|
|
5948
5966
|
inspection_link?: string | (null);
|
|
5949
|
-
inspection_ready_criteria_text?: (string | null) | (null);
|
|
5950
5967
|
inspection_type?: components["schemas"]["InspectionTypeSerialized"] | (null);
|
|
5951
5968
|
/**
|
|
5952
5969
|
* @description Whether the inspection has expired.
|
|
@@ -6000,11 +6017,15 @@ export interface components {
|
|
|
6000
6017
|
organization_enabled_features?: components["schemas"]["OrganizationEnabledFeature"][];
|
|
6001
6018
|
organization_team?: {
|
|
6002
6019
|
/**
|
|
6003
|
-
* @
|
|
6004
|
-
* @
|
|
6005
|
-
* @example
|
|
6020
|
+
* @deprecated
|
|
6021
|
+
* @description No longer used. Always `false`, and a value sent is ignored. A list item's own `capture_max` sets its limit.
|
|
6022
|
+
* @example false
|
|
6023
|
+
*/
|
|
6024
|
+
allow_list_item_capture_max?: boolean;
|
|
6025
|
+
/**
|
|
6026
|
+
* @deprecated
|
|
6027
|
+
* @description No longer used. Always `null`.
|
|
6006
6028
|
*/
|
|
6007
|
-
allow_list_item_capture_max: boolean;
|
|
6008
6029
|
default_list_item_capture_max?: number | null;
|
|
6009
6030
|
distance_from_customer_address_threshold?: number | null;
|
|
6010
6031
|
/**
|
|
@@ -6115,6 +6136,10 @@ export interface components {
|
|
|
6115
6136
|
created_at: string;
|
|
6116
6137
|
customer_user_id?: number | (null);
|
|
6117
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"][];
|
|
6118
6143
|
comment?: string | null;
|
|
6119
6144
|
flags?: string[];
|
|
6120
6145
|
list_item_id?: number | null;
|
|
@@ -6187,7 +6212,6 @@ export interface components {
|
|
|
6187
6212
|
/** @description The alert settings when expanded, or `null` when none is assigned. */
|
|
6188
6213
|
inspection_alert_config?: components["schemas"]["AlertConfigSerialized"] | (null);
|
|
6189
6214
|
inspection_alert_config_id?: number | (null);
|
|
6190
|
-
inspection_ready_criteria_text?: (string | null) | (null);
|
|
6191
6215
|
/**
|
|
6192
6216
|
* @description Whether an address is required for the inspection.
|
|
6193
6217
|
* @example true
|
|
@@ -6222,7 +6246,7 @@ export interface components {
|
|
|
6222
6246
|
created_at: string;
|
|
6223
6247
|
/**
|
|
6224
6248
|
* @description The message template for messages sent as reminders for started but unfinished inspection requests.
|
|
6225
|
-
* @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}}
|
|
6226
6250
|
*/
|
|
6227
6251
|
finish_reminder?: string;
|
|
6228
6252
|
/**
|
|
@@ -6258,7 +6282,7 @@ export interface components {
|
|
|
6258
6282
|
name: string;
|
|
6259
6283
|
/**
|
|
6260
6284
|
* @description The message template for messages sent for new inspection requests.
|
|
6261
|
-
* @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}}
|
|
6262
6286
|
*/
|
|
6263
6287
|
new_request: string;
|
|
6264
6288
|
/**
|
|
@@ -6268,7 +6292,7 @@ export interface components {
|
|
|
6268
6292
|
new_request_subject: string;
|
|
6269
6293
|
/**
|
|
6270
6294
|
* @description The message template for messages sent to request additional items on an inspection request.
|
|
6271
|
-
* @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}}
|
|
6272
6296
|
*/
|
|
6273
6297
|
request_more: string;
|
|
6274
6298
|
/**
|
|
@@ -6278,7 +6302,7 @@ export interface components {
|
|
|
6278
6302
|
request_more_subject: string;
|
|
6279
6303
|
/**
|
|
6280
6304
|
* @description The message template for messages sent as reminders for pending inspection requests.
|
|
6281
|
-
* @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}}
|
|
6282
6306
|
*/
|
|
6283
6307
|
request_reminder: string;
|
|
6284
6308
|
/**
|
|
@@ -6643,7 +6667,10 @@ export interface components {
|
|
|
6643
6667
|
};
|
|
6644
6668
|
/** @description A list summary or expanded list. The items and relationships returned depend on the endpoint. */
|
|
6645
6669
|
ListSerialized: {
|
|
6646
|
-
/**
|
|
6670
|
+
/**
|
|
6671
|
+
* @deprecated
|
|
6672
|
+
* @description No longer used, and not returned.
|
|
6673
|
+
*/
|
|
6647
6674
|
allow_list_item_capture_max?: boolean;
|
|
6648
6675
|
/**
|
|
6649
6676
|
* Format: date-time
|
|
@@ -6651,7 +6678,10 @@ export interface components {
|
|
|
6651
6678
|
* @example 2020-05-01T21:44:40.000Z
|
|
6652
6679
|
*/
|
|
6653
6680
|
created_at: string;
|
|
6654
|
-
/**
|
|
6681
|
+
/**
|
|
6682
|
+
* @deprecated
|
|
6683
|
+
* @description No longer used, and not returned.
|
|
6684
|
+
*/
|
|
6655
6685
|
default_list_item_capture_max?: number | null;
|
|
6656
6686
|
/** @description The group definitions, keyed by group ID. An empty legacy list can return `[]` or `null`. */
|
|
6657
6687
|
groups?: {
|
|
@@ -6705,7 +6735,7 @@ export interface components {
|
|
|
6705
6735
|
created_at: string;
|
|
6706
6736
|
/**
|
|
6707
6737
|
* @description The message template for messages sent as reminders for started but unfinished inspection requests.
|
|
6708
|
-
* @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}}
|
|
6709
6739
|
*/
|
|
6710
6740
|
finish_reminder?: string;
|
|
6711
6741
|
/**
|
|
@@ -6747,7 +6777,7 @@ export interface components {
|
|
|
6747
6777
|
name: string;
|
|
6748
6778
|
/**
|
|
6749
6779
|
* @description The message template for messages sent for new inspection requests.
|
|
6750
|
-
* @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}}
|
|
6751
6781
|
*/
|
|
6752
6782
|
new_request: string;
|
|
6753
6783
|
/**
|
|
@@ -6757,7 +6787,7 @@ export interface components {
|
|
|
6757
6787
|
new_request_subject: string;
|
|
6758
6788
|
/**
|
|
6759
6789
|
* @description The message template for messages sent to request additional items on an inspection request.
|
|
6760
|
-
* @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}}
|
|
6761
6791
|
*/
|
|
6762
6792
|
request_more: string;
|
|
6763
6793
|
/**
|
|
@@ -6767,7 +6797,7 @@ export interface components {
|
|
|
6767
6797
|
request_more_subject: string;
|
|
6768
6798
|
/**
|
|
6769
6799
|
* @description The message template for messages sent as reminders for pending inspection requests.
|
|
6770
|
-
* @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}}
|
|
6771
6801
|
*/
|
|
6772
6802
|
request_reminder: string;
|
|
6773
6803
|
/**
|
|
@@ -7003,7 +7033,7 @@ export interface components {
|
|
|
7003
7033
|
updated_by_user_id: number | null;
|
|
7004
7034
|
};
|
|
7005
7035
|
/** @enum {string} */
|
|
7006
|
-
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";
|
|
7007
7037
|
/** @description An outcome set expanded into its selectable outcomes. */
|
|
7008
7038
|
OutcomeSetSerialized: {
|
|
7009
7039
|
created_at?: string;
|
|
@@ -7272,7 +7302,7 @@ export interface components {
|
|
|
7272
7302
|
};
|
|
7273
7303
|
/** @description Evidence produced by an AI analysis tool, such as a decoded barcode. */
|
|
7274
7304
|
PublishedToolSource: components["schemas"]["BarcodeDecodedSource"];
|
|
7275
|
-
/** @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. */
|
|
7276
7306
|
RequestMessageTemplate: string;
|
|
7277
7307
|
/** @description The generic format for Vision API responses. */
|
|
7278
7308
|
ResponseData: {
|
|
@@ -7494,6 +7524,12 @@ export interface components {
|
|
|
7494
7524
|
};
|
|
7495
7525
|
/** @description A user, serialized for the client. This is usually the object the API returns, and is used for client-side rendering. */
|
|
7496
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;
|
|
7497
7533
|
/**
|
|
7498
7534
|
* @description The user's default team. Always `null`.
|
|
7499
7535
|
* @example null
|
|
@@ -7654,11 +7690,11 @@ export interface components {
|
|
|
7654
7690
|
*/
|
|
7655
7691
|
allow_image_deletes: boolean;
|
|
7656
7692
|
/**
|
|
7657
|
-
* @
|
|
7658
|
-
* @
|
|
7659
|
-
* @example
|
|
7693
|
+
* @deprecated
|
|
7694
|
+
* @description No longer used. Always `false`, and a value sent is ignored. A list item's own `capture_max` sets its limit.
|
|
7695
|
+
* @example false
|
|
7660
7696
|
*/
|
|
7661
|
-
allow_list_item_capture_max
|
|
7697
|
+
allow_list_item_capture_max?: boolean;
|
|
7662
7698
|
app_success_message?: string | (null);
|
|
7663
7699
|
auto_finish_reminder_duration?: string | (null);
|
|
7664
7700
|
auto_reminder_duration?: string | (null);
|
|
@@ -7786,8 +7822,9 @@ export interface components {
|
|
|
7786
7822
|
*/
|
|
7787
7823
|
slug?: string;
|
|
7788
7824
|
/**
|
|
7789
|
-
* @
|
|
7790
|
-
* @
|
|
7825
|
+
* @deprecated
|
|
7826
|
+
* @description No longer used. Always the team's `shortname`.
|
|
7827
|
+
* @example acme-claims
|
|
7791
7828
|
*/
|
|
7792
7829
|
theme_slug?: string;
|
|
7793
7830
|
/**
|
|
@@ -8106,7 +8143,7 @@ export interface components {
|
|
|
8106
8143
|
*/
|
|
8107
8144
|
secret?: string | null;
|
|
8108
8145
|
/**
|
|
8109
|
-
* @description The ID of the team.
|
|
8146
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8110
8147
|
* @example 12
|
|
8111
8148
|
*/
|
|
8112
8149
|
team_id: number;
|
|
@@ -8187,7 +8224,7 @@ export interface components {
|
|
|
8187
8224
|
*/
|
|
8188
8225
|
oauth_config?: components["schemas"]["TeamWebhookOAuthConfig"] | (null);
|
|
8189
8226
|
/**
|
|
8190
|
-
* @description The ID of the team.
|
|
8227
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8191
8228
|
* @example 12
|
|
8192
8229
|
*/
|
|
8193
8230
|
team_id: number;
|
|
@@ -8405,11 +8442,6 @@ export interface components {
|
|
|
8405
8442
|
* @example false
|
|
8406
8443
|
*/
|
|
8407
8444
|
include_list: boolean;
|
|
8408
|
-
/**
|
|
8409
|
-
* @description The free-form inspection-ready criteria text. At most 10 KB.
|
|
8410
|
-
* @example Capture all rooms and appliances.
|
|
8411
|
-
*/
|
|
8412
|
-
inspection_ready_criteria_text?: string | null;
|
|
8413
8445
|
/**
|
|
8414
8446
|
* @description The ID of the inspection status this inspection is in.
|
|
8415
8447
|
* @example 4
|
|
@@ -8519,11 +8551,6 @@ export interface components {
|
|
|
8519
8551
|
*/
|
|
8520
8552
|
entry_method?: components["schemas"]["CustomFieldEntryMethods"];
|
|
8521
8553
|
inspection_alert_config_id?: number | (null);
|
|
8522
|
-
/**
|
|
8523
|
-
* @description The inspection-ready criteria text for this inspection type.
|
|
8524
|
-
* @example Capture the VIN plate clearly and include a full odometer photo.
|
|
8525
|
-
*/
|
|
8526
|
-
inspection_ready_criteria_text?: string | null;
|
|
8527
8554
|
/**
|
|
8528
8555
|
* @description Whether an address is required for the inspection.
|
|
8529
8556
|
* @example true
|
|
@@ -8664,11 +8691,11 @@ export interface components {
|
|
|
8664
8691
|
*/
|
|
8665
8692
|
allow_image_deletes: boolean;
|
|
8666
8693
|
/**
|
|
8667
|
-
* @
|
|
8668
|
-
* @
|
|
8669
|
-
* @example
|
|
8694
|
+
* @deprecated
|
|
8695
|
+
* @description No longer used. Always `false`, and a value sent is ignored. A list item's own `capture_max` sets its limit.
|
|
8696
|
+
* @example false
|
|
8670
8697
|
*/
|
|
8671
|
-
allow_list_item_capture_max
|
|
8698
|
+
allow_list_item_capture_max?: boolean;
|
|
8672
8699
|
app_success_message?: string | (null);
|
|
8673
8700
|
auto_finish_reminder_duration?: string | (null);
|
|
8674
8701
|
auto_reminder_duration?: string | (null);
|
|
@@ -8807,7 +8834,7 @@ export interface components {
|
|
|
8807
8834
|
*/
|
|
8808
8835
|
secret?: string | null;
|
|
8809
8836
|
/**
|
|
8810
|
-
* @description The ID of the team.
|
|
8837
|
+
* @description The ID of the team. A team can have multiple webhooks, each with a different URL.
|
|
8811
8838
|
* @example 12
|
|
8812
8839
|
*/
|
|
8813
8840
|
team_id?: number;
|
|
@@ -8923,7 +8950,7 @@ export interface components {
|
|
|
8923
8950
|
* @description An event an outbound Vision webhook can be subscribed to via `enabled_events`.
|
|
8924
8951
|
* @enum {string}
|
|
8925
8952
|
*/
|
|
8926
|
-
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";
|
|
8927
8954
|
/**
|
|
8928
8955
|
* @description How Vision presents the client credentials on the token request.
|
|
8929
8956
|
*
|