@workbuddy/sdk-js-vnext 1.0.146 → 1.0.148
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 +2697 -221
- package/index.js +429 -87
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -103,12 +103,16 @@ export class WorkBuddyClient {
|
|
|
103
103
|
webhooks: WorkBuddyWebhooksResource;
|
|
104
104
|
/** Exports API operations. */
|
|
105
105
|
exports: WorkBuddyExportsResource;
|
|
106
|
-
/**
|
|
107
|
-
|
|
106
|
+
/** Extension Runs API operations. */
|
|
107
|
+
extensionRuns: WorkBuddyExtensionRunsResource;
|
|
108
108
|
/** Flags API operations. */
|
|
109
109
|
flags: WorkBuddyFlagsResource;
|
|
110
110
|
/** Service Plans API operations. */
|
|
111
111
|
servicePlans: WorkBuddyServicePlansResource;
|
|
112
|
+
/** Leads API operations. */
|
|
113
|
+
leads: WorkBuddyLeadsResource;
|
|
114
|
+
/** Opportunities API operations. */
|
|
115
|
+
opportunities: WorkBuddyOpportunitiesResource;
|
|
112
116
|
/** Mcp API operations. */
|
|
113
117
|
mcp: WorkBuddyMcpResource;
|
|
114
118
|
constructor(options: WorkBuddyClientOptions);
|
|
@@ -134,21 +138,6 @@ export class WorkBuddyClient {
|
|
|
134
138
|
getAccessToken(): Promise<string | undefined>;
|
|
135
139
|
}
|
|
136
140
|
|
|
137
|
-
export interface WorkBuddyJobsActionsListParams extends WorkBuddyRequestParams {}
|
|
138
|
-
|
|
139
|
-
export interface WorkBuddyJobsActionsRunParams extends WorkBuddyRequestParams {
|
|
140
|
-
/**
|
|
141
|
-
* Job ID, job number, or external integration ID
|
|
142
|
-
*/
|
|
143
|
-
id: string;
|
|
144
|
-
/**
|
|
145
|
-
* Action id from GET /jobs/actions
|
|
146
|
-
*/
|
|
147
|
-
actionId: string;
|
|
148
|
-
|
|
149
|
-
input?: string;
|
|
150
|
-
}
|
|
151
|
-
|
|
152
141
|
export interface WorkBuddyJobsSearchParams extends WorkBuddyRequestParams {
|
|
153
142
|
/**
|
|
154
143
|
* Search mode
|
|
@@ -1275,6 +1264,13 @@ export interface WorkBuddyJobsStagesItemsDeleteStageItemParams extends WorkBuddy
|
|
|
1275
1264
|
itemId: string;
|
|
1276
1265
|
}
|
|
1277
1266
|
|
|
1267
|
+
export interface WorkBuddyItemsGetParams extends WorkBuddyRequestParams {
|
|
1268
|
+
/**
|
|
1269
|
+
* Entity ID
|
|
1270
|
+
*/
|
|
1271
|
+
id: string;
|
|
1272
|
+
}
|
|
1273
|
+
|
|
1278
1274
|
export interface WorkBuddyItemsListParams extends WorkBuddyRequestParams {
|
|
1279
1275
|
/**
|
|
1280
1276
|
* External integration ID for the line item
|
|
@@ -1443,15 +1439,22 @@ export interface WorkBuddyJobsStagesPendingItemsApproveApproveParams extends Wor
|
|
|
1443
1439
|
itemId: string;
|
|
1444
1440
|
}
|
|
1445
1441
|
|
|
1446
|
-
export interface
|
|
1442
|
+
export interface WorkBuddyStagesGetParams extends WorkBuddyRequestParams {
|
|
1447
1443
|
/**
|
|
1448
|
-
*
|
|
1444
|
+
* Stage ID
|
|
1449
1445
|
*/
|
|
1450
|
-
|
|
1446
|
+
id: string;
|
|
1447
|
+
}
|
|
1448
|
+
|
|
1449
|
+
export interface WorkBuddyStagesUpdateParams extends WorkBuddyRequestParams {
|
|
1450
|
+
/**
|
|
1451
|
+
* Stage ID
|
|
1452
|
+
*/
|
|
1453
|
+
id: string;
|
|
1451
1454
|
/**
|
|
1452
1455
|
* Display name
|
|
1453
1456
|
*/
|
|
1454
|
-
name
|
|
1457
|
+
name?: string;
|
|
1455
1458
|
/**
|
|
1456
1459
|
* Work category ID — use /settings/work-types to look up
|
|
1457
1460
|
*/
|
|
@@ -1464,36 +1467,36 @@ export interface WorkBuddyStagesCreateParams extends WorkBuddyRequestParams {
|
|
|
1464
1467
|
* Due date (ISO 8601 datetime)
|
|
1465
1468
|
*/
|
|
1466
1469
|
dueDate?: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* Tag operation — use set, add, or remove (mutually exclusive: set vs add/remove)
|
|
1472
|
+
*/
|
|
1473
|
+
tags?: { set?: string[]; add?: string[]; remove?: string[] };
|
|
1474
|
+
/**
|
|
1475
|
+
* Scheduling tag operation — use set, add, or remove
|
|
1476
|
+
*/
|
|
1477
|
+
schedulingTags?: { set?: string[]; add?: string[]; remove?: string[] };
|
|
1467
1478
|
/**
|
|
1468
1479
|
* Custom fields as key-value pairs — validated against tenant field definitions
|
|
1469
1480
|
*/
|
|
1470
1481
|
customFields?: Record<string, unknown>;
|
|
1471
|
-
|
|
1472
|
-
finance?: { nonBillable?: boolean; nonPayable?: boolean };
|
|
1473
1482
|
}
|
|
1474
1483
|
|
|
1475
|
-
export interface
|
|
1484
|
+
export interface WorkBuddyStagesDeleteParams extends WorkBuddyRequestParams {
|
|
1476
1485
|
/**
|
|
1477
1486
|
* Stage ID
|
|
1478
1487
|
*/
|
|
1479
1488
|
id: string;
|
|
1480
|
-
|
|
1481
|
-
nonBillable?: boolean;
|
|
1482
|
-
|
|
1483
|
-
nonPayable?: boolean;
|
|
1484
|
-
|
|
1485
|
-
note?: string;
|
|
1486
1489
|
}
|
|
1487
1490
|
|
|
1488
|
-
export interface
|
|
1491
|
+
export interface WorkBuddyStagesCreateParams extends WorkBuddyRequestParams {
|
|
1489
1492
|
/**
|
|
1490
|
-
*
|
|
1493
|
+
* Job ID or job number (e.g. J12345)
|
|
1491
1494
|
*/
|
|
1492
|
-
|
|
1495
|
+
jobId: string;
|
|
1493
1496
|
/**
|
|
1494
1497
|
* Display name
|
|
1495
1498
|
*/
|
|
1496
|
-
name
|
|
1499
|
+
name: string;
|
|
1497
1500
|
/**
|
|
1498
1501
|
* Work category ID — use /settings/work-types to look up
|
|
1499
1502
|
*/
|
|
@@ -1506,25 +1509,25 @@ export interface WorkBuddyStagesUpdateParams extends WorkBuddyRequestParams {
|
|
|
1506
1509
|
* Due date (ISO 8601 datetime)
|
|
1507
1510
|
*/
|
|
1508
1511
|
dueDate?: string;
|
|
1509
|
-
/**
|
|
1510
|
-
* Tag operation — use set, add, or remove (mutually exclusive: set vs add/remove)
|
|
1511
|
-
*/
|
|
1512
|
-
tags?: { set?: string[]; add?: string[]; remove?: string[] };
|
|
1513
|
-
/**
|
|
1514
|
-
* Scheduling tag operation — use set, add, or remove
|
|
1515
|
-
*/
|
|
1516
|
-
schedulingTags?: { set?: string[]; add?: string[]; remove?: string[] };
|
|
1517
1512
|
/**
|
|
1518
1513
|
* Custom fields as key-value pairs — validated against tenant field definitions
|
|
1519
1514
|
*/
|
|
1520
1515
|
customFields?: Record<string, unknown>;
|
|
1516
|
+
|
|
1517
|
+
finance?: { nonBillable?: boolean; nonPayable?: boolean };
|
|
1521
1518
|
}
|
|
1522
1519
|
|
|
1523
|
-
export interface
|
|
1520
|
+
export interface WorkBuddyStagesFinanceUpdateFinanceParams extends WorkBuddyRequestParams {
|
|
1524
1521
|
/**
|
|
1525
1522
|
* Stage ID
|
|
1526
1523
|
*/
|
|
1527
1524
|
id: string;
|
|
1525
|
+
|
|
1526
|
+
nonBillable?: boolean;
|
|
1527
|
+
|
|
1528
|
+
nonPayable?: boolean;
|
|
1529
|
+
|
|
1530
|
+
note?: string;
|
|
1528
1531
|
}
|
|
1529
1532
|
|
|
1530
1533
|
export interface WorkBuddyStagesDispatchParams extends WorkBuddyRequestParams {
|
|
@@ -5731,7 +5734,7 @@ export interface WorkBuddyExportsExportParams extends WorkBuddyRequestParams {
|
|
|
5731
5734
|
page?: number;
|
|
5732
5735
|
}
|
|
5733
5736
|
|
|
5734
|
-
export interface
|
|
5737
|
+
export interface WorkBuddyExtensionRunsEventsIngestEventParams extends WorkBuddyRequestParams {
|
|
5735
5738
|
/**
|
|
5736
5739
|
* run ID
|
|
5737
5740
|
*/
|
|
@@ -5763,7 +5766,7 @@ export interface WorkBuddyAgentHarnessRunsEventsIngestEventParams extends WorkBu
|
|
|
5763
5766
|
payload?: Record<string, unknown>;
|
|
5764
5767
|
}
|
|
5765
5768
|
|
|
5766
|
-
export interface
|
|
5769
|
+
export interface WorkBuddyExtensionRunsActionResolvedResolveActionParams extends WorkBuddyRequestParams {
|
|
5767
5770
|
/**
|
|
5768
5771
|
* run ID
|
|
5769
5772
|
*/
|
|
@@ -5820,6 +5823,21 @@ export interface WorkBuddyFlagsEntityListParams extends WorkBuddyRequestParams {
|
|
|
5820
5823
|
status?: 'Open' | 'Closed';
|
|
5821
5824
|
}
|
|
5822
5825
|
|
|
5826
|
+
export interface WorkBuddyServicePlansListParams extends WorkBuddyRequestParams {
|
|
5827
|
+
/**
|
|
5828
|
+
* Literal case-insensitive name search
|
|
5829
|
+
*/
|
|
5830
|
+
search?: string;
|
|
5831
|
+
/**
|
|
5832
|
+
* Results per page, 1–200 (default 50)
|
|
5833
|
+
*/
|
|
5834
|
+
pageSize?: number;
|
|
5835
|
+
/**
|
|
5836
|
+
* Zero-based page (default 0, maximum 100000)
|
|
5837
|
+
*/
|
|
5838
|
+
page?: number;
|
|
5839
|
+
}
|
|
5840
|
+
|
|
5823
5841
|
export interface WorkBuddyServicePlansCreateParams extends WorkBuddyRequestParams {
|
|
5824
5842
|
/**
|
|
5825
5843
|
* integration ID
|
|
@@ -5829,6 +5847,10 @@ export interface WorkBuddyServicePlansCreateParams extends WorkBuddyRequestParam
|
|
|
5829
5847
|
* Display name
|
|
5830
5848
|
*/
|
|
5831
5849
|
name: string;
|
|
5850
|
+
/**
|
|
5851
|
+
* Detailed description
|
|
5852
|
+
*/
|
|
5853
|
+
description?: string;
|
|
5832
5854
|
/**
|
|
5833
5855
|
* Customer ID — use /crm/customers to look up
|
|
5834
5856
|
*/
|
|
@@ -5843,6 +5865,10 @@ export interface WorkBuddyServicePlansCreateParams extends WorkBuddyRequestParam
|
|
|
5843
5865
|
dateEnd?: string;
|
|
5844
5866
|
|
|
5845
5867
|
workingDays?: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
5868
|
+
|
|
5869
|
+
blackoutRanges?: { id?: string; from: string; to: string; reason?: string }[];
|
|
5870
|
+
|
|
5871
|
+
jobDefaults?: string;
|
|
5846
5872
|
}
|
|
5847
5873
|
|
|
5848
5874
|
export interface WorkBuddyServicePlansGetParams extends WorkBuddyRequestParams {
|
|
@@ -5852,6 +5878,38 @@ export interface WorkBuddyServicePlansGetParams extends WorkBuddyRequestParams {
|
|
|
5852
5878
|
identifier: string;
|
|
5853
5879
|
}
|
|
5854
5880
|
|
|
5881
|
+
export interface WorkBuddyServicePlansPatchParams extends WorkBuddyRequestParams {
|
|
5882
|
+
/**
|
|
5883
|
+
* WorkBuddy Service Plan ID or caller integrationId
|
|
5884
|
+
*/
|
|
5885
|
+
identifier: string;
|
|
5886
|
+
/**
|
|
5887
|
+
* Display name
|
|
5888
|
+
*/
|
|
5889
|
+
name?: string;
|
|
5890
|
+
/**
|
|
5891
|
+
* Detailed description
|
|
5892
|
+
*/
|
|
5893
|
+
description?: string;
|
|
5894
|
+
|
|
5895
|
+
jobDefaults?: string;
|
|
5896
|
+
|
|
5897
|
+
dateStart?: string;
|
|
5898
|
+
|
|
5899
|
+
dateEnd?: string;
|
|
5900
|
+
|
|
5901
|
+
workingDays?: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
5902
|
+
|
|
5903
|
+
blackoutRanges?: { id?: string; from: string; to: string; reason?: string }[];
|
|
5904
|
+
}
|
|
5905
|
+
|
|
5906
|
+
export interface WorkBuddyServicePlansDeleteParams extends WorkBuddyRequestParams {
|
|
5907
|
+
/**
|
|
5908
|
+
* WorkBuddy Service Plan ID or caller integrationId
|
|
5909
|
+
*/
|
|
5910
|
+
identifier: string;
|
|
5911
|
+
}
|
|
5912
|
+
|
|
5855
5913
|
export interface WorkBuddyServicePlansActivateActivateParams extends WorkBuddyRequestParams {
|
|
5856
5914
|
/**
|
|
5857
5915
|
* Entity ID or human-readable number
|
|
@@ -5885,6 +5943,17 @@ export interface WorkBuddyServicePlansArchiveArchiveParams extends WorkBuddyRequ
|
|
|
5885
5943
|
reason?: string;
|
|
5886
5944
|
}
|
|
5887
5945
|
|
|
5946
|
+
export interface WorkBuddyServicePlansRestoreRestoreParams extends WorkBuddyRequestParams {
|
|
5947
|
+
/**
|
|
5948
|
+
* WorkBuddy Service Plan ID or caller integrationId
|
|
5949
|
+
*/
|
|
5950
|
+
identifier: string;
|
|
5951
|
+
/**
|
|
5952
|
+
* Reason for the action (e.g. cancellation reason)
|
|
5953
|
+
*/
|
|
5954
|
+
reason?: string;
|
|
5955
|
+
}
|
|
5956
|
+
|
|
5888
5957
|
export interface WorkBuddyServicePlansLinesListParams extends WorkBuddyRequestParams {
|
|
5889
5958
|
/**
|
|
5890
5959
|
* WorkBuddy Service Plan ID
|
|
@@ -5928,7 +5997,19 @@ export interface WorkBuddyServicePlansLinesCreateParams extends WorkBuddyRequest
|
|
|
5928
5997
|
|
|
5929
5998
|
defaultWindow?: string;
|
|
5930
5999
|
|
|
5931
|
-
workingDays?:
|
|
6000
|
+
workingDays?: string;
|
|
6001
|
+
|
|
6002
|
+
blackoutRanges?: { id?: string; from: string; to: string; reason?: string }[];
|
|
6003
|
+
/**
|
|
6004
|
+
* Owner (employee) ID — use /crm/employees to look up
|
|
6005
|
+
*/
|
|
6006
|
+
ownerId?: string;
|
|
6007
|
+
|
|
6008
|
+
requiresApproval?: boolean;
|
|
6009
|
+
|
|
6010
|
+
overdueGraceDays?: string;
|
|
6011
|
+
|
|
6012
|
+
jobChangeCutoffMinutes?: string;
|
|
5932
6013
|
|
|
5933
6014
|
jobDefaults?: {
|
|
5934
6015
|
name?: string;
|
|
@@ -5990,7 +6071,19 @@ export interface WorkBuddyServicePlansLinesPatchParams extends WorkBuddyRequestP
|
|
|
5990
6071
|
|
|
5991
6072
|
defaultWindow?: string;
|
|
5992
6073
|
|
|
5993
|
-
workingDays?:
|
|
6074
|
+
workingDays?: string;
|
|
6075
|
+
|
|
6076
|
+
blackoutRanges?: { id?: string; from: string; to: string; reason?: string }[];
|
|
6077
|
+
/**
|
|
6078
|
+
* Owner (employee) ID — use /crm/employees to look up
|
|
6079
|
+
*/
|
|
6080
|
+
ownerId?: string;
|
|
6081
|
+
|
|
6082
|
+
requiresApproval?: boolean;
|
|
6083
|
+
|
|
6084
|
+
overdueGraceDays?: string;
|
|
6085
|
+
|
|
6086
|
+
jobChangeCutoffMinutes?: string;
|
|
5994
6087
|
|
|
5995
6088
|
jobDefaults?: {
|
|
5996
6089
|
name?: string;
|
|
@@ -6005,6 +6098,17 @@ export interface WorkBuddyServicePlansLinesPatchParams extends WorkBuddyRequestP
|
|
|
6005
6098
|
};
|
|
6006
6099
|
}
|
|
6007
6100
|
|
|
6101
|
+
export interface WorkBuddyServicePlansLinesDeleteParams extends WorkBuddyRequestParams {
|
|
6102
|
+
/**
|
|
6103
|
+
* WorkBuddy Service Plan ID
|
|
6104
|
+
*/
|
|
6105
|
+
planId: string;
|
|
6106
|
+
/**
|
|
6107
|
+
* WorkBuddy Service Line ID or caller integrationId
|
|
6108
|
+
*/
|
|
6109
|
+
identifier: string;
|
|
6110
|
+
}
|
|
6111
|
+
|
|
6008
6112
|
export interface WorkBuddyServicePlansLinesTasksListParams extends WorkBuddyRequestParams {
|
|
6009
6113
|
/**
|
|
6010
6114
|
* WorkBuddy Service Plan ID
|
|
@@ -6072,10 +6176,7 @@ export interface WorkBuddyServicePlansLinesTasksPatchParams extends WorkBuddyReq
|
|
|
6072
6176
|
|
|
6073
6177
|
schedule?: string;
|
|
6074
6178
|
|
|
6075
|
-
exceptions?:
|
|
6076
|
-
skips?: { date?: string; from?: string; to?: string; reason?: string }[];
|
|
6077
|
-
extras?: { date: string; note?: string }[];
|
|
6078
|
-
};
|
|
6179
|
+
exceptions?: string;
|
|
6079
6180
|
|
|
6080
6181
|
mandatory?: boolean;
|
|
6081
6182
|
|
|
@@ -6114,6 +6215,21 @@ export interface WorkBuddyServicePlansLinesTasksPatchParams extends WorkBuddyReq
|
|
|
6114
6215
|
};
|
|
6115
6216
|
}
|
|
6116
6217
|
|
|
6218
|
+
export interface WorkBuddyServicePlansLinesTasksDeleteParams extends WorkBuddyRequestParams {
|
|
6219
|
+
/**
|
|
6220
|
+
* WorkBuddy Service Plan ID
|
|
6221
|
+
*/
|
|
6222
|
+
planId: string;
|
|
6223
|
+
/**
|
|
6224
|
+
* WorkBuddy Service Line ID or caller integrationId
|
|
6225
|
+
*/
|
|
6226
|
+
lineId: string;
|
|
6227
|
+
/**
|
|
6228
|
+
* WorkBuddy root Task ID or caller integrationId
|
|
6229
|
+
*/
|
|
6230
|
+
identifier: string;
|
|
6231
|
+
}
|
|
6232
|
+
|
|
6117
6233
|
export interface WorkBuddyServicePlansLinesTasksSubtasksListParams extends WorkBuddyRequestParams {
|
|
6118
6234
|
/**
|
|
6119
6235
|
* WorkBuddy Service Plan ID
|
|
@@ -6228,40 +6344,448 @@ export interface WorkBuddyServicePlansLinesTasksSubtasksPatchParams extends Work
|
|
|
6228
6344
|
};
|
|
6229
6345
|
}
|
|
6230
6346
|
|
|
6231
|
-
export interface
|
|
6347
|
+
export interface WorkBuddyServicePlansLinesTasksSubtasksDeleteParams extends WorkBuddyRequestParams {
|
|
6348
|
+
/**
|
|
6349
|
+
* WorkBuddy Service Plan ID
|
|
6350
|
+
*/
|
|
6351
|
+
planId: string;
|
|
6352
|
+
/**
|
|
6353
|
+
* WorkBuddy Service Line ID or caller integrationId
|
|
6354
|
+
*/
|
|
6355
|
+
lineId: string;
|
|
6356
|
+
/**
|
|
6357
|
+
* WorkBuddy root Task ID or caller integrationId
|
|
6358
|
+
*/
|
|
6359
|
+
taskId: string;
|
|
6360
|
+
/**
|
|
6361
|
+
* WorkBuddy Subtask ID or caller integrationId
|
|
6362
|
+
*/
|
|
6363
|
+
identifier: string;
|
|
6364
|
+
}
|
|
6232
6365
|
|
|
6233
|
-
export interface
|
|
6234
|
-
|
|
6366
|
+
export interface WorkBuddyLeadsListParams extends WorkBuddyRequestParams {
|
|
6367
|
+
stage?: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
6235
6368
|
/**
|
|
6236
|
-
*
|
|
6369
|
+
* Search Lead name, prospect account name or account email.
|
|
6237
6370
|
*/
|
|
6238
|
-
|
|
6371
|
+
search?: string;
|
|
6239
6372
|
|
|
6240
|
-
|
|
6373
|
+
cursor?: string;
|
|
6374
|
+
/**
|
|
6375
|
+
* Page size, from 1 to 200. Defaults to 50.
|
|
6376
|
+
*/
|
|
6377
|
+
limit?: number;
|
|
6378
|
+
}
|
|
6241
6379
|
|
|
6242
|
-
|
|
6380
|
+
export interface WorkBuddyLeadsCreateParams extends WorkBuddyRequestParams {
|
|
6381
|
+
/**
|
|
6382
|
+
* Typed-in prospect account details. Updates merge supplied members into the stored snapshot.
|
|
6383
|
+
*/
|
|
6384
|
+
account: {
|
|
6385
|
+
name: string;
|
|
6386
|
+
type?: 'Business' | 'Individual';
|
|
6387
|
+
phone: string;
|
|
6388
|
+
email: string;
|
|
6389
|
+
website?: string;
|
|
6390
|
+
annualRevenue?: string;
|
|
6391
|
+
industry?: string;
|
|
6392
|
+
employees?: string;
|
|
6393
|
+
};
|
|
6394
|
+
/**
|
|
6395
|
+
* Typed-in prospect contact details. Updates merge supplied members into the stored snapshot.
|
|
6396
|
+
*/
|
|
6397
|
+
contact: { firstName: string; lastName: string; title?: string; email?: string; mobile?: string; workPhone?: string };
|
|
6398
|
+
/**
|
|
6399
|
+
* Detailed description
|
|
6400
|
+
*/
|
|
6401
|
+
description?: string;
|
|
6402
|
+
/**
|
|
6403
|
+
* Optional prospect address. Null clears it. No siteId is accepted; an address is required only when converting.
|
|
6404
|
+
*/
|
|
6405
|
+
address?: string;
|
|
6406
|
+
|
|
6407
|
+
amount?: number;
|
|
6408
|
+
/**
|
|
6409
|
+
* Expected close date/time as an ISO 8601 UTC timestamp. Null clears it.
|
|
6410
|
+
*/
|
|
6411
|
+
expectedClose?: string;
|
|
6412
|
+
/**
|
|
6413
|
+
* ID of an active WorkBuddy billing company.
|
|
6414
|
+
*/
|
|
6415
|
+
billingCompanyId: string;
|
|
6416
|
+
/**
|
|
6417
|
+
* ID of an active Employee or Team, matching the legacy Lead owner picker.
|
|
6418
|
+
*/
|
|
6419
|
+
ownerId: string;
|
|
6420
|
+
/**
|
|
6421
|
+
* Job Type ID. Null clears the selection.
|
|
6422
|
+
*/
|
|
6423
|
+
jobTypeId?: string;
|
|
6424
|
+
/**
|
|
6425
|
+
* Lead Source label ID, available from GET /settings/tags?type=lead-source. Null clears it.
|
|
6426
|
+
*/
|
|
6427
|
+
sourceId?: string;
|
|
6428
|
+
/**
|
|
6429
|
+
* Lead label IDs, available from GET /settings/tags?type=lead. Replaces the tag list; null or an empty array clears it.
|
|
6430
|
+
*/
|
|
6431
|
+
tagIds?: string;
|
|
6432
|
+
/**
|
|
6433
|
+
* Creation stage, matching all options in the legacy create picker. Defaults to New.
|
|
6434
|
+
*/
|
|
6435
|
+
stage?: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
6243
6436
|
}
|
|
6244
6437
|
|
|
6245
|
-
export interface
|
|
6438
|
+
export interface WorkBuddyLeadsGetParams extends WorkBuddyRequestParams {
|
|
6439
|
+
/**
|
|
6440
|
+
* WorkBuddy Lead ID
|
|
6441
|
+
*/
|
|
6442
|
+
id: string;
|
|
6443
|
+
}
|
|
6246
6444
|
|
|
6247
|
-
export
|
|
6248
|
-
|
|
6249
|
-
|
|
6250
|
-
|
|
6251
|
-
|
|
6252
|
-
|
|
6253
|
-
|
|
6445
|
+
export interface WorkBuddyLeadsUpdateParams extends WorkBuddyRequestParams {
|
|
6446
|
+
/**
|
|
6447
|
+
* WorkBuddy Lead ID
|
|
6448
|
+
*/
|
|
6449
|
+
id: string;
|
|
6450
|
+
/**
|
|
6451
|
+
* Changed account members, merged with the stored snapshot as in the legacy pipeline.
|
|
6452
|
+
*/
|
|
6453
|
+
account?: {
|
|
6254
6454
|
name?: string;
|
|
6255
|
-
|
|
6256
|
-
|
|
6257
|
-
|
|
6258
|
-
|
|
6259
|
-
|
|
6260
|
-
|
|
6261
|
-
|
|
6262
|
-
|
|
6263
|
-
|
|
6264
|
-
|
|
6455
|
+
type?: 'Business' | 'Individual';
|
|
6456
|
+
phone?: string;
|
|
6457
|
+
email?: string;
|
|
6458
|
+
website?: string;
|
|
6459
|
+
annualRevenue?: string;
|
|
6460
|
+
industry?: string;
|
|
6461
|
+
employees?: string;
|
|
6462
|
+
};
|
|
6463
|
+
/**
|
|
6464
|
+
* Changed contact members, merged with the stored snapshot as in the legacy pipeline.
|
|
6465
|
+
*/
|
|
6466
|
+
contact?: {
|
|
6467
|
+
firstName?: string;
|
|
6468
|
+
lastName?: string;
|
|
6469
|
+
title?: string;
|
|
6470
|
+
email?: string;
|
|
6471
|
+
mobile?: string;
|
|
6472
|
+
workPhone?: string;
|
|
6473
|
+
};
|
|
6474
|
+
/**
|
|
6475
|
+
* Detailed description
|
|
6476
|
+
*/
|
|
6477
|
+
description?: string;
|
|
6478
|
+
/**
|
|
6479
|
+
* Optional prospect address. Null clears it. No siteId is accepted; an address is required only when converting.
|
|
6480
|
+
*/
|
|
6481
|
+
address?: string;
|
|
6482
|
+
|
|
6483
|
+
amount?: number;
|
|
6484
|
+
/**
|
|
6485
|
+
* Expected close date/time as an ISO 8601 UTC timestamp. Null clears it.
|
|
6486
|
+
*/
|
|
6487
|
+
expectedClose?: string;
|
|
6488
|
+
/**
|
|
6489
|
+
* ID of an active WorkBuddy billing company.
|
|
6490
|
+
*/
|
|
6491
|
+
billingCompanyId?: string;
|
|
6492
|
+
/**
|
|
6493
|
+
* ID of an active Employee or Team, matching the legacy Lead owner picker.
|
|
6494
|
+
*/
|
|
6495
|
+
ownerId?: string;
|
|
6496
|
+
/**
|
|
6497
|
+
* Job Type ID. Null clears the selection.
|
|
6498
|
+
*/
|
|
6499
|
+
jobTypeId?: string;
|
|
6500
|
+
/**
|
|
6501
|
+
* Lead Source label ID, available from GET /settings/tags?type=lead-source. Null clears it.
|
|
6502
|
+
*/
|
|
6503
|
+
sourceId?: string;
|
|
6504
|
+
/**
|
|
6505
|
+
* Lead label IDs, available from GET /settings/tags?type=lead. Replaces the tag list; null or an empty array clears it.
|
|
6506
|
+
*/
|
|
6507
|
+
tagIds?: string;
|
|
6508
|
+
|
|
6509
|
+
stage?: 'New' | 'In Progress' | 'Disqualified';
|
|
6510
|
+
}
|
|
6511
|
+
|
|
6512
|
+
export interface WorkBuddyLeadsConvertConvertParams extends WorkBuddyRequestParams {
|
|
6513
|
+
/**
|
|
6514
|
+
* WorkBuddy Lead ID
|
|
6515
|
+
*/
|
|
6516
|
+
id: string;
|
|
6517
|
+
/**
|
|
6518
|
+
* Type of CRM customer to create. Overrides account.type when both are supplied.
|
|
6519
|
+
*/
|
|
6520
|
+
accountType?: 'Business' | 'Individual';
|
|
6521
|
+
/**
|
|
6522
|
+
* Optional replacement prospect account details. Phone and email are optional during conversion. Omit to use the Lead snapshot.
|
|
6523
|
+
*/
|
|
6524
|
+
account?: {
|
|
6525
|
+
name: string;
|
|
6526
|
+
type?: 'Business' | 'Individual';
|
|
6527
|
+
phone?: string;
|
|
6528
|
+
email?: string;
|
|
6529
|
+
website?: string;
|
|
6530
|
+
annualRevenue?: string;
|
|
6531
|
+
industry?: string;
|
|
6532
|
+
employees?: string;
|
|
6533
|
+
};
|
|
6534
|
+
/**
|
|
6535
|
+
* Inline contact object — alternative to contactId
|
|
6536
|
+
*/
|
|
6537
|
+
contact?: {
|
|
6538
|
+
firstName: string;
|
|
6539
|
+
lastName: string;
|
|
6540
|
+
title?: string;
|
|
6541
|
+
email?: string;
|
|
6542
|
+
mobile?: string;
|
|
6543
|
+
workPhone?: string;
|
|
6544
|
+
};
|
|
6545
|
+
/**
|
|
6546
|
+
* Conversion address override. When omitted, the stored Lead address is used; one of those addresses must be present.
|
|
6547
|
+
*/
|
|
6548
|
+
address?: {
|
|
6549
|
+
name?: string;
|
|
6550
|
+
street1?: string;
|
|
6551
|
+
street2?: string;
|
|
6552
|
+
suburb?: string;
|
|
6553
|
+
state?: string;
|
|
6554
|
+
postalCode?: string;
|
|
6555
|
+
country?: string;
|
|
6556
|
+
lat?: number;
|
|
6557
|
+
lgn?: number;
|
|
6558
|
+
timezone?: string;
|
|
6559
|
+
};
|
|
6560
|
+
/**
|
|
6561
|
+
* Include a name to also create an Opportunity. Omit to create only the customer and qualify the Lead.
|
|
6562
|
+
*/
|
|
6563
|
+
opportunity?: { name: string };
|
|
6564
|
+
}
|
|
6565
|
+
|
|
6566
|
+
export interface WorkBuddyOpportunitiesListParams extends WorkBuddyRequestParams {
|
|
6567
|
+
/**
|
|
6568
|
+
* Configured Opportunity stage ID.
|
|
6569
|
+
*/
|
|
6570
|
+
stageId?: string;
|
|
6571
|
+
/**
|
|
6572
|
+
* Search Opportunity number, name or customer name.
|
|
6573
|
+
*/
|
|
6574
|
+
search?: string;
|
|
6575
|
+
|
|
6576
|
+
cursor?: string;
|
|
6577
|
+
|
|
6578
|
+
limit?: number;
|
|
6579
|
+
}
|
|
6580
|
+
|
|
6581
|
+
export interface WorkBuddyOpportunitiesCreateParams extends WorkBuddyRequestParams {
|
|
6582
|
+
/**
|
|
6583
|
+
* Opportunity name; required by the legacy form.
|
|
6584
|
+
*/
|
|
6585
|
+
name: string;
|
|
6586
|
+
/**
|
|
6587
|
+
* Existing active customer ID.
|
|
6588
|
+
*/
|
|
6589
|
+
customerId: string;
|
|
6590
|
+
/**
|
|
6591
|
+
* WorkBuddy billing company ID, not a CRM Company account ID.
|
|
6592
|
+
*/
|
|
6593
|
+
billingCompanyId: string;
|
|
6594
|
+
/**
|
|
6595
|
+
* Employee owner ID, matching the legacy Opportunity owner picker.
|
|
6596
|
+
*/
|
|
6597
|
+
ownerId: string;
|
|
6598
|
+
/**
|
|
6599
|
+
* area manager ID
|
|
6600
|
+
*/
|
|
6601
|
+
areaManagerId?: string;
|
|
6602
|
+
/**
|
|
6603
|
+
* Detailed description
|
|
6604
|
+
*/
|
|
6605
|
+
description?: string;
|
|
6606
|
+
|
|
6607
|
+
amount?: number;
|
|
6608
|
+
/**
|
|
6609
|
+
* Estimated probability. Stage changes use the selected stage probability, as in the UI.
|
|
6610
|
+
*/
|
|
6611
|
+
probability?: number;
|
|
6612
|
+
|
|
6613
|
+
expectedClose?: string;
|
|
6614
|
+
/**
|
|
6615
|
+
* job type ID
|
|
6616
|
+
*/
|
|
6617
|
+
jobTypeId?: string;
|
|
6618
|
+
/**
|
|
6619
|
+
* Lead Source label ID from GET /settings/tags?type=lead-source.
|
|
6620
|
+
*/
|
|
6621
|
+
sourceId?: string;
|
|
6622
|
+
/**
|
|
6623
|
+
* Opportunity label IDs from GET /settings/tags?type=opportunity. Null or [] clears the selection.
|
|
6624
|
+
*/
|
|
6625
|
+
tagIds?: string;
|
|
6626
|
+
/**
|
|
6627
|
+
* Optional CRM site belonging to the selected customer. Use site instead for an ad-hoc address.
|
|
6628
|
+
*/
|
|
6629
|
+
siteId?: string;
|
|
6630
|
+
/**
|
|
6631
|
+
* Optional ad-hoc site snapshot. Does not create a CRM site. Cannot be supplied with siteId.
|
|
6632
|
+
*/
|
|
6633
|
+
site?: string;
|
|
6634
|
+
/**
|
|
6635
|
+
* Optional contact belonging to the customer or selected site.
|
|
6636
|
+
*/
|
|
6637
|
+
contactId?: string;
|
|
6638
|
+
/**
|
|
6639
|
+
* Site-contact snapshot from a contact belonging to the customer or selected site. Null clears it.
|
|
6640
|
+
*/
|
|
6641
|
+
siteContactId?: string;
|
|
6642
|
+
/**
|
|
6643
|
+
* Optional name-only ad-hoc contact snapshot, matching the stored Opportunity contact. Cannot be supplied with contactId. Create richer contacts through the CRM API and supply contactId.
|
|
6644
|
+
*/
|
|
6645
|
+
contact?: string;
|
|
6646
|
+
/**
|
|
6647
|
+
* Optional customer-side address site ID belonging to the selected customer.
|
|
6648
|
+
*/
|
|
6649
|
+
customerSiteId?: string;
|
|
6650
|
+
/**
|
|
6651
|
+
* Open Opportunity stage ID from GET /opportunities/stages. Omit to use the existing New-stage pipeline default.
|
|
6652
|
+
*/
|
|
6653
|
+
stageId?: string;
|
|
6654
|
+
}
|
|
6655
|
+
|
|
6656
|
+
export interface WorkBuddyOpportunitiesStagesStagesParams extends WorkBuddyRequestParams {}
|
|
6657
|
+
|
|
6658
|
+
export interface WorkBuddyOpportunitiesGetParams extends WorkBuddyRequestParams {
|
|
6659
|
+
/**
|
|
6660
|
+
* WorkBuddy Opportunity ID or Opportunity number
|
|
6661
|
+
*/
|
|
6662
|
+
id: string;
|
|
6663
|
+
}
|
|
6664
|
+
|
|
6665
|
+
export interface WorkBuddyOpportunitiesUpdateParams extends WorkBuddyRequestParams {
|
|
6666
|
+
/**
|
|
6667
|
+
* WorkBuddy Opportunity ID
|
|
6668
|
+
*/
|
|
6669
|
+
id: string;
|
|
6670
|
+
/**
|
|
6671
|
+
* Opportunity name; required by the legacy form.
|
|
6672
|
+
*/
|
|
6673
|
+
name?: string;
|
|
6674
|
+
/**
|
|
6675
|
+
* Existing active customer ID.
|
|
6676
|
+
*/
|
|
6677
|
+
customerId?: string;
|
|
6678
|
+
/**
|
|
6679
|
+
* WorkBuddy billing company ID, not a CRM Company account ID.
|
|
6680
|
+
*/
|
|
6681
|
+
billingCompanyId?: string;
|
|
6682
|
+
/**
|
|
6683
|
+
* Employee owner ID, matching the legacy Opportunity owner picker.
|
|
6684
|
+
*/
|
|
6685
|
+
ownerId?: string;
|
|
6686
|
+
/**
|
|
6687
|
+
* area manager ID
|
|
6688
|
+
*/
|
|
6689
|
+
areaManagerId?: string;
|
|
6690
|
+
/**
|
|
6691
|
+
* Detailed description
|
|
6692
|
+
*/
|
|
6693
|
+
description?: string;
|
|
6694
|
+
|
|
6695
|
+
amount?: number;
|
|
6696
|
+
/**
|
|
6697
|
+
* Estimated probability. Stage changes use the selected stage probability, as in the UI.
|
|
6698
|
+
*/
|
|
6699
|
+
probability?: number;
|
|
6700
|
+
|
|
6701
|
+
expectedClose?: string;
|
|
6702
|
+
/**
|
|
6703
|
+
* job type ID
|
|
6704
|
+
*/
|
|
6705
|
+
jobTypeId?: string;
|
|
6706
|
+
/**
|
|
6707
|
+
* Lead Source label ID from GET /settings/tags?type=lead-source.
|
|
6708
|
+
*/
|
|
6709
|
+
sourceId?: string;
|
|
6710
|
+
/**
|
|
6711
|
+
* Opportunity label IDs from GET /settings/tags?type=opportunity. Null or [] clears the selection.
|
|
6712
|
+
*/
|
|
6713
|
+
tagIds?: string;
|
|
6714
|
+
/**
|
|
6715
|
+
* Optional CRM site belonging to the selected customer. Use site instead for an ad-hoc address.
|
|
6716
|
+
*/
|
|
6717
|
+
siteId?: string;
|
|
6718
|
+
/**
|
|
6719
|
+
* Optional ad-hoc site snapshot. Does not create a CRM site. Cannot be supplied with siteId.
|
|
6720
|
+
*/
|
|
6721
|
+
site?: string;
|
|
6722
|
+
/**
|
|
6723
|
+
* Optional contact belonging to the customer or selected site.
|
|
6724
|
+
*/
|
|
6725
|
+
contactId?: string;
|
|
6726
|
+
/**
|
|
6727
|
+
* Site-contact snapshot from a contact belonging to the customer or selected site. Null clears it.
|
|
6728
|
+
*/
|
|
6729
|
+
siteContactId?: string;
|
|
6730
|
+
/**
|
|
6731
|
+
* Optional name-only ad-hoc contact snapshot, matching the stored Opportunity contact. Cannot be supplied with contactId. Create richer contacts through the CRM API and supply contactId.
|
|
6732
|
+
*/
|
|
6733
|
+
contact?: string;
|
|
6734
|
+
/**
|
|
6735
|
+
* Optional customer-side address site ID belonging to the selected customer.
|
|
6736
|
+
*/
|
|
6737
|
+
customerSiteId?: string;
|
|
6738
|
+
}
|
|
6739
|
+
|
|
6740
|
+
export interface WorkBuddyOpportunitiesChangeStageChangeStageParams extends WorkBuddyRequestParams {
|
|
6741
|
+
/**
|
|
6742
|
+
* WorkBuddy Opportunity ID
|
|
6743
|
+
*/
|
|
6744
|
+
id: string;
|
|
6745
|
+
/**
|
|
6746
|
+
* Stage ID or stage number
|
|
6747
|
+
*/
|
|
6748
|
+
stageId: string;
|
|
6749
|
+
/**
|
|
6750
|
+
* Opportunity Lost Reason label ID from GET /settings/tags?type=opportunity-lost.
|
|
6751
|
+
*/
|
|
6752
|
+
lostReasonId?: string;
|
|
6753
|
+
|
|
6754
|
+
lostReasonNote?: string;
|
|
6755
|
+
}
|
|
6756
|
+
|
|
6757
|
+
export interface WorkBuddyMcpListParams extends WorkBuddyRequestParams {}
|
|
6758
|
+
|
|
6759
|
+
export interface WorkBuddyMcpCreateParams extends WorkBuddyRequestParams {
|
|
6760
|
+
jsonrpc: '2.0';
|
|
6761
|
+
/**
|
|
6762
|
+
* Entity ID
|
|
6763
|
+
*/
|
|
6764
|
+
id?: string;
|
|
6765
|
+
|
|
6766
|
+
method: string;
|
|
6767
|
+
|
|
6768
|
+
params?: Record<string, unknown>;
|
|
6769
|
+
}
|
|
6770
|
+
|
|
6771
|
+
export interface WorkBuddyMcpDeleteParams extends WorkBuddyRequestParams {}
|
|
6772
|
+
|
|
6773
|
+
export type WorkBuddyJobsSearchResponse = {
|
|
6774
|
+
items: {
|
|
6775
|
+
id: string;
|
|
6776
|
+
integrationId?: string;
|
|
6777
|
+
jobNumber: string;
|
|
6778
|
+
name?: string;
|
|
6779
|
+
description: string;
|
|
6780
|
+
status: { id?: string; name?: string; systemStatus: string };
|
|
6781
|
+
customer: { id: string; name: string };
|
|
6782
|
+
site?: string;
|
|
6783
|
+
contact?: string;
|
|
6784
|
+
customerSupervisor?: string;
|
|
6785
|
+
type?: string;
|
|
6786
|
+
structure: 'basic' | 'advanced' | 'project';
|
|
6787
|
+
priority?: string;
|
|
6788
|
+
owner?: string;
|
|
6265
6789
|
fieldSupervisor?: string;
|
|
6266
6790
|
zones?: { id: string; name: string }[];
|
|
6267
6791
|
tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
|
|
@@ -6327,6 +6851,8 @@ export type WorkBuddyJobsSearchResponse = {
|
|
|
6327
6851
|
customFields?: string;
|
|
6328
6852
|
dueDate?: string;
|
|
6329
6853
|
startDate?: string;
|
|
6854
|
+
completedDate?: string;
|
|
6855
|
+
finalisedDate?: string;
|
|
6330
6856
|
createdAt: string;
|
|
6331
6857
|
updatedAt: string;
|
|
6332
6858
|
}[];
|
|
@@ -6412,6 +6938,8 @@ export type WorkBuddyJobsGetResponse = {
|
|
|
6412
6938
|
customFields?: string;
|
|
6413
6939
|
dueDate?: string;
|
|
6414
6940
|
startDate?: string;
|
|
6941
|
+
completedDate?: string;
|
|
6942
|
+
finalisedDate?: string;
|
|
6415
6943
|
createdAt: string;
|
|
6416
6944
|
updatedAt: string;
|
|
6417
6945
|
};
|
|
@@ -6496,6 +7024,8 @@ export type WorkBuddyJobsCreateResponse = {
|
|
|
6496
7024
|
customFields?: string;
|
|
6497
7025
|
dueDate?: string;
|
|
6498
7026
|
startDate?: string;
|
|
7027
|
+
completedDate?: string;
|
|
7028
|
+
finalisedDate?: string;
|
|
6499
7029
|
createdAt: string;
|
|
6500
7030
|
updatedAt: string;
|
|
6501
7031
|
};
|
|
@@ -6579,6 +7109,8 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
|
|
|
6579
7109
|
customFields?: string;
|
|
6580
7110
|
dueDate?: string;
|
|
6581
7111
|
startDate?: string;
|
|
7112
|
+
completedDate?: string;
|
|
7113
|
+
finalisedDate?: string;
|
|
6582
7114
|
createdAt: string;
|
|
6583
7115
|
updatedAt: string;
|
|
6584
7116
|
};
|
|
@@ -6662,6 +7194,8 @@ export type WorkBuddyJobsFinanceUpdateFinanceResponse = {
|
|
|
6662
7194
|
customFields?: string;
|
|
6663
7195
|
dueDate?: string;
|
|
6664
7196
|
startDate?: string;
|
|
7197
|
+
completedDate?: string;
|
|
7198
|
+
finalisedDate?: string;
|
|
6665
7199
|
createdAt: string;
|
|
6666
7200
|
updatedAt: string;
|
|
6667
7201
|
summary: { itemsUpdated: number; itemsSkipped: number; draftDocumentsDeleted: number; stagesMarked: number };
|
|
@@ -6746,6 +7280,8 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
|
|
|
6746
7280
|
customFields?: string;
|
|
6747
7281
|
dueDate?: string;
|
|
6748
7282
|
startDate?: string;
|
|
7283
|
+
completedDate?: string;
|
|
7284
|
+
finalisedDate?: string;
|
|
6749
7285
|
createdAt: string;
|
|
6750
7286
|
updatedAt: string;
|
|
6751
7287
|
};
|
|
@@ -6829,6 +7365,8 @@ export type WorkBuddyJobsUpdateResponse = {
|
|
|
6829
7365
|
customFields?: string;
|
|
6830
7366
|
dueDate?: string;
|
|
6831
7367
|
startDate?: string;
|
|
7368
|
+
completedDate?: string;
|
|
7369
|
+
finalisedDate?: string;
|
|
6832
7370
|
createdAt: string;
|
|
6833
7371
|
updatedAt: string;
|
|
6834
7372
|
};
|
|
@@ -6912,6 +7450,8 @@ export type WorkBuddyJobsDispatchResponse = {
|
|
|
6912
7450
|
customFields?: string;
|
|
6913
7451
|
dueDate?: string;
|
|
6914
7452
|
startDate?: string;
|
|
7453
|
+
completedDate?: string;
|
|
7454
|
+
finalisedDate?: string;
|
|
6915
7455
|
createdAt: string;
|
|
6916
7456
|
updatedAt: string;
|
|
6917
7457
|
};
|
|
@@ -7070,19 +7610,40 @@ export type WorkBuddyJobsStagesItemsUpdateStageItemResponse = {
|
|
|
7070
7610
|
updatedAt: string;
|
|
7071
7611
|
};
|
|
7072
7612
|
export type WorkBuddyJobsStagesItemsDeleteStageItemResponse = { deleted?: boolean };
|
|
7073
|
-
export type
|
|
7074
|
-
|
|
7075
|
-
|
|
7076
|
-
|
|
7077
|
-
|
|
7078
|
-
|
|
7079
|
-
|
|
7080
|
-
|
|
7081
|
-
|
|
7082
|
-
|
|
7083
|
-
|
|
7084
|
-
|
|
7085
|
-
|
|
7613
|
+
export type WorkBuddyItemsGetResponse = {
|
|
7614
|
+
id: string;
|
|
7615
|
+
jobId: string;
|
|
7616
|
+
stageId: string;
|
|
7617
|
+
integrationId?: string;
|
|
7618
|
+
code?: string;
|
|
7619
|
+
description: string;
|
|
7620
|
+
type?: string;
|
|
7621
|
+
quantity: number;
|
|
7622
|
+
unit?: string;
|
|
7623
|
+
location?: string;
|
|
7624
|
+
note?: string;
|
|
7625
|
+
status?: string;
|
|
7626
|
+
buyPrice?: number;
|
|
7627
|
+
sellPrice?: number;
|
|
7628
|
+
invoicingStatus?: string;
|
|
7629
|
+
payable: boolean;
|
|
7630
|
+
suppliedBySubcontractor: boolean;
|
|
7631
|
+
createdAt: string;
|
|
7632
|
+
updatedAt: string;
|
|
7633
|
+
};
|
|
7634
|
+
export type WorkBuddyItemsListResponse = {
|
|
7635
|
+
items: {
|
|
7636
|
+
id: string;
|
|
7637
|
+
jobId: string;
|
|
7638
|
+
stageId: string;
|
|
7639
|
+
integrationId?: string;
|
|
7640
|
+
code?: string;
|
|
7641
|
+
description: string;
|
|
7642
|
+
type?: string;
|
|
7643
|
+
quantity: number;
|
|
7644
|
+
unit?: string;
|
|
7645
|
+
location?: string;
|
|
7646
|
+
note?: string;
|
|
7086
7647
|
status?: string;
|
|
7087
7648
|
buyPrice?: number;
|
|
7088
7649
|
sellPrice?: number;
|
|
@@ -7256,7 +7817,7 @@ export type WorkBuddyJobsStagesPendingItemsApproveApproveResponse = {
|
|
|
7256
7817
|
createdAt: string;
|
|
7257
7818
|
updatedAt: string;
|
|
7258
7819
|
};
|
|
7259
|
-
export type
|
|
7820
|
+
export type WorkBuddyStagesGetResponse = {
|
|
7260
7821
|
id: string;
|
|
7261
7822
|
stageNumber: string;
|
|
7262
7823
|
jobId: string;
|
|
@@ -7304,7 +7865,7 @@ export type WorkBuddyStagesCreateResponse = {
|
|
|
7304
7865
|
createdAt: string;
|
|
7305
7866
|
updatedAt: string;
|
|
7306
7867
|
};
|
|
7307
|
-
export type
|
|
7868
|
+
export type WorkBuddyStagesUpdateResponse = {
|
|
7308
7869
|
id: string;
|
|
7309
7870
|
stageNumber: string;
|
|
7310
7871
|
jobId: string;
|
|
@@ -7351,9 +7912,9 @@ export type WorkBuddyStagesFinanceUpdateFinanceResponse = {
|
|
|
7351
7912
|
customFields?: string;
|
|
7352
7913
|
createdAt: string;
|
|
7353
7914
|
updatedAt: string;
|
|
7354
|
-
summary: { itemsUpdated: number; itemsSkipped: number; draftDocumentsDeleted: number; stagesMarked: number };
|
|
7355
7915
|
};
|
|
7356
|
-
export type
|
|
7916
|
+
export type WorkBuddyStagesDeleteResponse = { deleted?: boolean };
|
|
7917
|
+
export type WorkBuddyStagesCreateResponse = {
|
|
7357
7918
|
id: string;
|
|
7358
7919
|
stageNumber: string;
|
|
7359
7920
|
jobId: string;
|
|
@@ -7401,7 +7962,55 @@ export type WorkBuddyStagesUpdateResponse = {
|
|
|
7401
7962
|
createdAt: string;
|
|
7402
7963
|
updatedAt: string;
|
|
7403
7964
|
};
|
|
7404
|
-
export type
|
|
7965
|
+
export type WorkBuddyStagesFinanceUpdateFinanceResponse = {
|
|
7966
|
+
id: string;
|
|
7967
|
+
stageNumber: string;
|
|
7968
|
+
jobId: string;
|
|
7969
|
+
job?: { id: string; jobNumber: string; description?: string };
|
|
7970
|
+
name?: string;
|
|
7971
|
+
status: { id?: string; name?: string; systemStatus: string };
|
|
7972
|
+
sequence?: string;
|
|
7973
|
+
owner?: string;
|
|
7974
|
+
contractor?: string;
|
|
7975
|
+
pricebook?: string;
|
|
7976
|
+
resources?: string;
|
|
7977
|
+
startDate?: string;
|
|
7978
|
+
dueDate?: string;
|
|
7979
|
+
completedDate?: string;
|
|
7980
|
+
completedBy?: string;
|
|
7981
|
+
completedNote?: string;
|
|
7982
|
+
finalisedDate?: string;
|
|
7983
|
+
tags?: string;
|
|
7984
|
+
systemTags?: string;
|
|
7985
|
+
schedulingTags?: string;
|
|
7986
|
+
items?: {
|
|
7987
|
+
id: string;
|
|
7988
|
+
jobId: string;
|
|
7989
|
+
stageId: string;
|
|
7990
|
+
integrationId?: string;
|
|
7991
|
+
code?: string;
|
|
7992
|
+
description: string;
|
|
7993
|
+
type?: string;
|
|
7994
|
+
quantity: number;
|
|
7995
|
+
unit?: string;
|
|
7996
|
+
location?: string;
|
|
7997
|
+
note?: string;
|
|
7998
|
+
status?: string;
|
|
7999
|
+
buyPrice?: number;
|
|
8000
|
+
sellPrice?: number;
|
|
8001
|
+
invoicingStatus?: string;
|
|
8002
|
+
payable: boolean;
|
|
8003
|
+
suppliedBySubcontractor: boolean;
|
|
8004
|
+
createdAt: string;
|
|
8005
|
+
updatedAt: string;
|
|
8006
|
+
}[];
|
|
8007
|
+
totals?: { sellTotal: number; buyTotal: number; pendingSellTotal: number; pendingBuyTotal: number };
|
|
8008
|
+
finance: { nonBillable: boolean; nonPayable: boolean };
|
|
8009
|
+
customFields?: string;
|
|
8010
|
+
createdAt: string;
|
|
8011
|
+
updatedAt: string;
|
|
8012
|
+
summary: { itemsUpdated: number; itemsSkipped: number; draftDocumentsDeleted: number; stagesMarked: number };
|
|
8013
|
+
};
|
|
7405
8014
|
export type WorkBuddyStagesDispatchResponse = {
|
|
7406
8015
|
id: string;
|
|
7407
8016
|
stageNumber: string;
|
|
@@ -12964,30 +13573,1218 @@ export type WorkBuddyJobsStagesActivitiesThreadCreateThreadResponse = {
|
|
|
12964
13573
|
attachments?: string;
|
|
12965
13574
|
createdAt?: string;
|
|
12966
13575
|
updatedAt?: string;
|
|
12967
|
-
createdBy?: string;
|
|
12968
|
-
labels?: string;
|
|
12969
|
-
sharing?: string;
|
|
13576
|
+
createdBy?: string;
|
|
13577
|
+
labels?: string;
|
|
13578
|
+
sharing?: string;
|
|
13579
|
+
};
|
|
13580
|
+
export type WorkBuddyJobsFilesListResponse = {
|
|
13581
|
+
items: {
|
|
13582
|
+
id: string;
|
|
13583
|
+
title: string;
|
|
13584
|
+
attachments: {
|
|
13585
|
+
id: string;
|
|
13586
|
+
title: string;
|
|
13587
|
+
fileName: string;
|
|
13588
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13589
|
+
downloadUrl: string;
|
|
13590
|
+
thumbnailUrl?: string;
|
|
13591
|
+
}[];
|
|
13592
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13593
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13594
|
+
createdAt: string;
|
|
13595
|
+
createdBy?: string;
|
|
13596
|
+
updatedAt?: string;
|
|
13597
|
+
}[];
|
|
13598
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
13599
|
+
};
|
|
13600
|
+
export type WorkBuddyJobsFilesCreateResponse = {
|
|
13601
|
+
id: string;
|
|
13602
|
+
title: string;
|
|
13603
|
+
attachments: {
|
|
13604
|
+
id: string;
|
|
13605
|
+
title: string;
|
|
13606
|
+
fileName: string;
|
|
13607
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13608
|
+
downloadUrl: string;
|
|
13609
|
+
thumbnailUrl?: string;
|
|
13610
|
+
}[];
|
|
13611
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13612
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13613
|
+
createdAt: string;
|
|
13614
|
+
createdBy?: string;
|
|
13615
|
+
updatedAt?: string;
|
|
13616
|
+
};
|
|
13617
|
+
export type WorkBuddyJobsFilesGetResponse = {
|
|
13618
|
+
id: string;
|
|
13619
|
+
title: string;
|
|
13620
|
+
attachments: {
|
|
13621
|
+
id: string;
|
|
13622
|
+
title: string;
|
|
13623
|
+
fileName: string;
|
|
13624
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13625
|
+
downloadUrl: string;
|
|
13626
|
+
thumbnailUrl?: string;
|
|
13627
|
+
}[];
|
|
13628
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13629
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13630
|
+
createdAt: string;
|
|
13631
|
+
createdBy?: string;
|
|
13632
|
+
updatedAt?: string;
|
|
13633
|
+
};
|
|
13634
|
+
export type WorkBuddyJobsFilesDeleteResponse = { deleted: boolean };
|
|
13635
|
+
export type WorkBuddyJobsStagesFilesListResponse = {
|
|
13636
|
+
items: {
|
|
13637
|
+
id: string;
|
|
13638
|
+
title: string;
|
|
13639
|
+
attachments: {
|
|
13640
|
+
id: string;
|
|
13641
|
+
title: string;
|
|
13642
|
+
fileName: string;
|
|
13643
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13644
|
+
downloadUrl: string;
|
|
13645
|
+
thumbnailUrl?: string;
|
|
13646
|
+
}[];
|
|
13647
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13648
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13649
|
+
createdAt: string;
|
|
13650
|
+
createdBy?: string;
|
|
13651
|
+
updatedAt?: string;
|
|
13652
|
+
}[];
|
|
13653
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
13654
|
+
};
|
|
13655
|
+
export type WorkBuddyJobsStagesFilesCreateResponse = {
|
|
13656
|
+
id: string;
|
|
13657
|
+
title: string;
|
|
13658
|
+
attachments: {
|
|
13659
|
+
id: string;
|
|
13660
|
+
title: string;
|
|
13661
|
+
fileName: string;
|
|
13662
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13663
|
+
downloadUrl: string;
|
|
13664
|
+
thumbnailUrl?: string;
|
|
13665
|
+
}[];
|
|
13666
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13667
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13668
|
+
createdAt: string;
|
|
13669
|
+
createdBy?: string;
|
|
13670
|
+
updatedAt?: string;
|
|
13671
|
+
};
|
|
13672
|
+
export type WorkBuddyJobsStagesFilesGetResponse = {
|
|
13673
|
+
id: string;
|
|
13674
|
+
title: string;
|
|
13675
|
+
attachments: {
|
|
13676
|
+
id: string;
|
|
13677
|
+
title: string;
|
|
13678
|
+
fileName: string;
|
|
13679
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13680
|
+
downloadUrl: string;
|
|
13681
|
+
thumbnailUrl?: string;
|
|
13682
|
+
}[];
|
|
13683
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13684
|
+
sharing: { sharedWithCustomer: boolean; sharedWithField: boolean; sensitive?: boolean };
|
|
13685
|
+
createdAt: string;
|
|
13686
|
+
createdBy?: string;
|
|
13687
|
+
updatedAt?: string;
|
|
13688
|
+
};
|
|
13689
|
+
export type WorkBuddyJobsStagesFilesDeleteResponse = { deleted: boolean };
|
|
13690
|
+
export type WorkBuddyJobsTasksListResponse = {
|
|
13691
|
+
items: {
|
|
13692
|
+
id: string;
|
|
13693
|
+
name: string;
|
|
13694
|
+
description?: string;
|
|
13695
|
+
status: 'open' | 'completed';
|
|
13696
|
+
taskStatus?: string;
|
|
13697
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
13698
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
13699
|
+
assignee: string;
|
|
13700
|
+
dueDate?: string;
|
|
13701
|
+
completedOn?: string;
|
|
13702
|
+
completedBy: string;
|
|
13703
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13704
|
+
evidenceOptions?: {
|
|
13705
|
+
mandatory?: boolean;
|
|
13706
|
+
signatureEnabled?: boolean;
|
|
13707
|
+
beforePhotoEnabled?: boolean;
|
|
13708
|
+
duringPhotoEnabled?: boolean;
|
|
13709
|
+
afterPhotoEnabled?: boolean;
|
|
13710
|
+
commentEnabled?: boolean;
|
|
13711
|
+
fileEnabled?: boolean;
|
|
13712
|
+
fileTemplate?: { id: string; name: string };
|
|
13713
|
+
formEnabled?: boolean;
|
|
13714
|
+
formTemplate?: { id: string; name: string };
|
|
13715
|
+
evidenceEnforcement?: {
|
|
13716
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13717
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13718
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13719
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13720
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13721
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13722
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13723
|
+
};
|
|
13724
|
+
};
|
|
13725
|
+
evidence?: {
|
|
13726
|
+
signature?: {
|
|
13727
|
+
id: string;
|
|
13728
|
+
title: string;
|
|
13729
|
+
fileName: string;
|
|
13730
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13731
|
+
downloadUrl: string;
|
|
13732
|
+
thumbnailUrl?: string;
|
|
13733
|
+
}[];
|
|
13734
|
+
signatureAttachments?: {
|
|
13735
|
+
id: string;
|
|
13736
|
+
title: string;
|
|
13737
|
+
fileName: string;
|
|
13738
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13739
|
+
downloadUrl: string;
|
|
13740
|
+
thumbnailUrl?: string;
|
|
13741
|
+
}[];
|
|
13742
|
+
beforePhotos?: {
|
|
13743
|
+
id: string;
|
|
13744
|
+
title: string;
|
|
13745
|
+
fileName: string;
|
|
13746
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13747
|
+
downloadUrl: string;
|
|
13748
|
+
thumbnailUrl?: string;
|
|
13749
|
+
}[];
|
|
13750
|
+
duringPhotos?: {
|
|
13751
|
+
id: string;
|
|
13752
|
+
title: string;
|
|
13753
|
+
fileName: string;
|
|
13754
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13755
|
+
downloadUrl: string;
|
|
13756
|
+
thumbnailUrl?: string;
|
|
13757
|
+
}[];
|
|
13758
|
+
afterPhotos?: {
|
|
13759
|
+
id: string;
|
|
13760
|
+
title: string;
|
|
13761
|
+
fileName: string;
|
|
13762
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13763
|
+
downloadUrl: string;
|
|
13764
|
+
thumbnailUrl?: string;
|
|
13765
|
+
}[];
|
|
13766
|
+
comment?: string;
|
|
13767
|
+
fileResponse?: {
|
|
13768
|
+
id: string;
|
|
13769
|
+
title: string;
|
|
13770
|
+
fileName: string;
|
|
13771
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13772
|
+
downloadUrl: string;
|
|
13773
|
+
thumbnailUrl?: string;
|
|
13774
|
+
}[];
|
|
13775
|
+
formResponse?: string;
|
|
13776
|
+
formAttachments?: {
|
|
13777
|
+
id: string;
|
|
13778
|
+
title: string;
|
|
13779
|
+
fileName: string;
|
|
13780
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13781
|
+
downloadUrl: string;
|
|
13782
|
+
thumbnailUrl?: string;
|
|
13783
|
+
}[];
|
|
13784
|
+
additionalFiles?: {
|
|
13785
|
+
id: string;
|
|
13786
|
+
title: string;
|
|
13787
|
+
fileName: string;
|
|
13788
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13789
|
+
downloadUrl: string;
|
|
13790
|
+
thumbnailUrl?: string;
|
|
13791
|
+
}[];
|
|
13792
|
+
};
|
|
13793
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
13794
|
+
sortOrder?: string;
|
|
13795
|
+
createdAt: string;
|
|
13796
|
+
updatedAt?: string;
|
|
13797
|
+
createdBy: string;
|
|
13798
|
+
updatedBy?: string;
|
|
13799
|
+
}[];
|
|
13800
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
13801
|
+
};
|
|
13802
|
+
export type WorkBuddyJobsTasksCreateResponse = {
|
|
13803
|
+
id: string;
|
|
13804
|
+
name: string;
|
|
13805
|
+
description?: string;
|
|
13806
|
+
status: 'open' | 'completed';
|
|
13807
|
+
taskStatus?: string;
|
|
13808
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
13809
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
13810
|
+
assignee: string;
|
|
13811
|
+
dueDate?: string;
|
|
13812
|
+
completedOn?: string;
|
|
13813
|
+
completedBy: string;
|
|
13814
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13815
|
+
evidenceOptions?: {
|
|
13816
|
+
mandatory?: boolean;
|
|
13817
|
+
signatureEnabled?: boolean;
|
|
13818
|
+
beforePhotoEnabled?: boolean;
|
|
13819
|
+
duringPhotoEnabled?: boolean;
|
|
13820
|
+
afterPhotoEnabled?: boolean;
|
|
13821
|
+
commentEnabled?: boolean;
|
|
13822
|
+
fileEnabled?: boolean;
|
|
13823
|
+
fileTemplate?: { id: string; name: string };
|
|
13824
|
+
formEnabled?: boolean;
|
|
13825
|
+
formTemplate?: { id: string; name: string };
|
|
13826
|
+
evidenceEnforcement?: {
|
|
13827
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13828
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13829
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13830
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13831
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13832
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13833
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13834
|
+
};
|
|
13835
|
+
};
|
|
13836
|
+
evidence?: {
|
|
13837
|
+
signature?: {
|
|
13838
|
+
id: string;
|
|
13839
|
+
title: string;
|
|
13840
|
+
fileName: string;
|
|
13841
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13842
|
+
downloadUrl: string;
|
|
13843
|
+
thumbnailUrl?: string;
|
|
13844
|
+
}[];
|
|
13845
|
+
signatureAttachments?: {
|
|
13846
|
+
id: string;
|
|
13847
|
+
title: string;
|
|
13848
|
+
fileName: string;
|
|
13849
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13850
|
+
downloadUrl: string;
|
|
13851
|
+
thumbnailUrl?: string;
|
|
13852
|
+
}[];
|
|
13853
|
+
beforePhotos?: {
|
|
13854
|
+
id: string;
|
|
13855
|
+
title: string;
|
|
13856
|
+
fileName: string;
|
|
13857
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13858
|
+
downloadUrl: string;
|
|
13859
|
+
thumbnailUrl?: string;
|
|
13860
|
+
}[];
|
|
13861
|
+
duringPhotos?: {
|
|
13862
|
+
id: string;
|
|
13863
|
+
title: string;
|
|
13864
|
+
fileName: string;
|
|
13865
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13866
|
+
downloadUrl: string;
|
|
13867
|
+
thumbnailUrl?: string;
|
|
13868
|
+
}[];
|
|
13869
|
+
afterPhotos?: {
|
|
13870
|
+
id: string;
|
|
13871
|
+
title: string;
|
|
13872
|
+
fileName: string;
|
|
13873
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13874
|
+
downloadUrl: string;
|
|
13875
|
+
thumbnailUrl?: string;
|
|
13876
|
+
}[];
|
|
13877
|
+
comment?: string;
|
|
13878
|
+
fileResponse?: {
|
|
13879
|
+
id: string;
|
|
13880
|
+
title: string;
|
|
13881
|
+
fileName: string;
|
|
13882
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13883
|
+
downloadUrl: string;
|
|
13884
|
+
thumbnailUrl?: string;
|
|
13885
|
+
}[];
|
|
13886
|
+
formResponse?: string;
|
|
13887
|
+
formAttachments?: {
|
|
13888
|
+
id: string;
|
|
13889
|
+
title: string;
|
|
13890
|
+
fileName: string;
|
|
13891
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13892
|
+
downloadUrl: string;
|
|
13893
|
+
thumbnailUrl?: string;
|
|
13894
|
+
}[];
|
|
13895
|
+
additionalFiles?: {
|
|
13896
|
+
id: string;
|
|
13897
|
+
title: string;
|
|
13898
|
+
fileName: string;
|
|
13899
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13900
|
+
downloadUrl: string;
|
|
13901
|
+
thumbnailUrl?: string;
|
|
13902
|
+
}[];
|
|
13903
|
+
};
|
|
13904
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
13905
|
+
sortOrder?: string;
|
|
13906
|
+
createdAt: string;
|
|
13907
|
+
updatedAt?: string;
|
|
13908
|
+
createdBy: string;
|
|
13909
|
+
updatedBy?: string;
|
|
13910
|
+
};
|
|
13911
|
+
export type WorkBuddyJobsTasksGetResponse = {
|
|
13912
|
+
id: string;
|
|
13913
|
+
name: string;
|
|
13914
|
+
description?: string;
|
|
13915
|
+
status: 'open' | 'completed';
|
|
13916
|
+
taskStatus?: string;
|
|
13917
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
13918
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
13919
|
+
assignee: string;
|
|
13920
|
+
dueDate?: string;
|
|
13921
|
+
completedOn?: string;
|
|
13922
|
+
completedBy: string;
|
|
13923
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
13924
|
+
evidenceOptions?: {
|
|
13925
|
+
mandatory?: boolean;
|
|
13926
|
+
signatureEnabled?: boolean;
|
|
13927
|
+
beforePhotoEnabled?: boolean;
|
|
13928
|
+
duringPhotoEnabled?: boolean;
|
|
13929
|
+
afterPhotoEnabled?: boolean;
|
|
13930
|
+
commentEnabled?: boolean;
|
|
13931
|
+
fileEnabled?: boolean;
|
|
13932
|
+
fileTemplate?: { id: string; name: string };
|
|
13933
|
+
formEnabled?: boolean;
|
|
13934
|
+
formTemplate?: { id: string; name: string };
|
|
13935
|
+
evidenceEnforcement?: {
|
|
13936
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13937
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13938
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13939
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13940
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13941
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13942
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
13943
|
+
};
|
|
13944
|
+
};
|
|
13945
|
+
evidence?: {
|
|
13946
|
+
signature?: {
|
|
13947
|
+
id: string;
|
|
13948
|
+
title: string;
|
|
13949
|
+
fileName: string;
|
|
13950
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13951
|
+
downloadUrl: string;
|
|
13952
|
+
thumbnailUrl?: string;
|
|
13953
|
+
}[];
|
|
13954
|
+
signatureAttachments?: {
|
|
13955
|
+
id: string;
|
|
13956
|
+
title: string;
|
|
13957
|
+
fileName: string;
|
|
13958
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13959
|
+
downloadUrl: string;
|
|
13960
|
+
thumbnailUrl?: string;
|
|
13961
|
+
}[];
|
|
13962
|
+
beforePhotos?: {
|
|
13963
|
+
id: string;
|
|
13964
|
+
title: string;
|
|
13965
|
+
fileName: string;
|
|
13966
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13967
|
+
downloadUrl: string;
|
|
13968
|
+
thumbnailUrl?: string;
|
|
13969
|
+
}[];
|
|
13970
|
+
duringPhotos?: {
|
|
13971
|
+
id: string;
|
|
13972
|
+
title: string;
|
|
13973
|
+
fileName: string;
|
|
13974
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13975
|
+
downloadUrl: string;
|
|
13976
|
+
thumbnailUrl?: string;
|
|
13977
|
+
}[];
|
|
13978
|
+
afterPhotos?: {
|
|
13979
|
+
id: string;
|
|
13980
|
+
title: string;
|
|
13981
|
+
fileName: string;
|
|
13982
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13983
|
+
downloadUrl: string;
|
|
13984
|
+
thumbnailUrl?: string;
|
|
13985
|
+
}[];
|
|
13986
|
+
comment?: string;
|
|
13987
|
+
fileResponse?: {
|
|
13988
|
+
id: string;
|
|
13989
|
+
title: string;
|
|
13990
|
+
fileName: string;
|
|
13991
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
13992
|
+
downloadUrl: string;
|
|
13993
|
+
thumbnailUrl?: string;
|
|
13994
|
+
}[];
|
|
13995
|
+
formResponse?: string;
|
|
13996
|
+
formAttachments?: {
|
|
13997
|
+
id: string;
|
|
13998
|
+
title: string;
|
|
13999
|
+
fileName: string;
|
|
14000
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14001
|
+
downloadUrl: string;
|
|
14002
|
+
thumbnailUrl?: string;
|
|
14003
|
+
}[];
|
|
14004
|
+
additionalFiles?: {
|
|
14005
|
+
id: string;
|
|
14006
|
+
title: string;
|
|
14007
|
+
fileName: string;
|
|
14008
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14009
|
+
downloadUrl: string;
|
|
14010
|
+
thumbnailUrl?: string;
|
|
14011
|
+
}[];
|
|
14012
|
+
};
|
|
14013
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14014
|
+
sortOrder?: string;
|
|
14015
|
+
createdAt: string;
|
|
14016
|
+
updatedAt?: string;
|
|
14017
|
+
createdBy: string;
|
|
14018
|
+
updatedBy?: string;
|
|
14019
|
+
};
|
|
14020
|
+
export type WorkBuddyJobsTasksUpdateResponse = {
|
|
14021
|
+
id: string;
|
|
14022
|
+
name: string;
|
|
14023
|
+
description?: string;
|
|
14024
|
+
status: 'open' | 'completed';
|
|
14025
|
+
taskStatus?: string;
|
|
14026
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14027
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14028
|
+
assignee: string;
|
|
14029
|
+
dueDate?: string;
|
|
14030
|
+
completedOn?: string;
|
|
14031
|
+
completedBy: string;
|
|
14032
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14033
|
+
evidenceOptions?: {
|
|
14034
|
+
mandatory?: boolean;
|
|
14035
|
+
signatureEnabled?: boolean;
|
|
14036
|
+
beforePhotoEnabled?: boolean;
|
|
14037
|
+
duringPhotoEnabled?: boolean;
|
|
14038
|
+
afterPhotoEnabled?: boolean;
|
|
14039
|
+
commentEnabled?: boolean;
|
|
14040
|
+
fileEnabled?: boolean;
|
|
14041
|
+
fileTemplate?: { id: string; name: string };
|
|
14042
|
+
formEnabled?: boolean;
|
|
14043
|
+
formTemplate?: { id: string; name: string };
|
|
14044
|
+
evidenceEnforcement?: {
|
|
14045
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14046
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14047
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14048
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14049
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14050
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14051
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14052
|
+
};
|
|
14053
|
+
};
|
|
14054
|
+
evidence?: {
|
|
14055
|
+
signature?: {
|
|
14056
|
+
id: string;
|
|
14057
|
+
title: string;
|
|
14058
|
+
fileName: string;
|
|
14059
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14060
|
+
downloadUrl: string;
|
|
14061
|
+
thumbnailUrl?: string;
|
|
14062
|
+
}[];
|
|
14063
|
+
signatureAttachments?: {
|
|
14064
|
+
id: string;
|
|
14065
|
+
title: string;
|
|
14066
|
+
fileName: string;
|
|
14067
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14068
|
+
downloadUrl: string;
|
|
14069
|
+
thumbnailUrl?: string;
|
|
14070
|
+
}[];
|
|
14071
|
+
beforePhotos?: {
|
|
14072
|
+
id: string;
|
|
14073
|
+
title: string;
|
|
14074
|
+
fileName: string;
|
|
14075
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14076
|
+
downloadUrl: string;
|
|
14077
|
+
thumbnailUrl?: string;
|
|
14078
|
+
}[];
|
|
14079
|
+
duringPhotos?: {
|
|
14080
|
+
id: string;
|
|
14081
|
+
title: string;
|
|
14082
|
+
fileName: string;
|
|
14083
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14084
|
+
downloadUrl: string;
|
|
14085
|
+
thumbnailUrl?: string;
|
|
14086
|
+
}[];
|
|
14087
|
+
afterPhotos?: {
|
|
14088
|
+
id: string;
|
|
14089
|
+
title: string;
|
|
14090
|
+
fileName: string;
|
|
14091
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14092
|
+
downloadUrl: string;
|
|
14093
|
+
thumbnailUrl?: string;
|
|
14094
|
+
}[];
|
|
14095
|
+
comment?: string;
|
|
14096
|
+
fileResponse?: {
|
|
14097
|
+
id: string;
|
|
14098
|
+
title: string;
|
|
14099
|
+
fileName: string;
|
|
14100
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14101
|
+
downloadUrl: string;
|
|
14102
|
+
thumbnailUrl?: string;
|
|
14103
|
+
}[];
|
|
14104
|
+
formResponse?: string;
|
|
14105
|
+
formAttachments?: {
|
|
14106
|
+
id: string;
|
|
14107
|
+
title: string;
|
|
14108
|
+
fileName: string;
|
|
14109
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14110
|
+
downloadUrl: string;
|
|
14111
|
+
thumbnailUrl?: string;
|
|
14112
|
+
}[];
|
|
14113
|
+
additionalFiles?: {
|
|
14114
|
+
id: string;
|
|
14115
|
+
title: string;
|
|
14116
|
+
fileName: string;
|
|
14117
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14118
|
+
downloadUrl: string;
|
|
14119
|
+
thumbnailUrl?: string;
|
|
14120
|
+
}[];
|
|
14121
|
+
};
|
|
14122
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14123
|
+
sortOrder?: string;
|
|
14124
|
+
createdAt: string;
|
|
14125
|
+
updatedAt?: string;
|
|
14126
|
+
createdBy: string;
|
|
14127
|
+
updatedBy?: string;
|
|
14128
|
+
};
|
|
14129
|
+
export type WorkBuddyJobsTasksDeleteResponse = { deleted: boolean };
|
|
14130
|
+
export type WorkBuddyJobsTasksEvidenceSubmitEvidenceResponse = {
|
|
14131
|
+
id: string;
|
|
14132
|
+
name: string;
|
|
14133
|
+
description?: string;
|
|
14134
|
+
status: 'open' | 'completed';
|
|
14135
|
+
taskStatus?: string;
|
|
14136
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14137
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14138
|
+
assignee: string;
|
|
14139
|
+
dueDate?: string;
|
|
14140
|
+
completedOn?: string;
|
|
14141
|
+
completedBy: string;
|
|
14142
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14143
|
+
evidenceOptions?: {
|
|
14144
|
+
mandatory?: boolean;
|
|
14145
|
+
signatureEnabled?: boolean;
|
|
14146
|
+
beforePhotoEnabled?: boolean;
|
|
14147
|
+
duringPhotoEnabled?: boolean;
|
|
14148
|
+
afterPhotoEnabled?: boolean;
|
|
14149
|
+
commentEnabled?: boolean;
|
|
14150
|
+
fileEnabled?: boolean;
|
|
14151
|
+
fileTemplate?: { id: string; name: string };
|
|
14152
|
+
formEnabled?: boolean;
|
|
14153
|
+
formTemplate?: { id: string; name: string };
|
|
14154
|
+
evidenceEnforcement?: {
|
|
14155
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14156
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14157
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14158
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14159
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14160
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14161
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14162
|
+
};
|
|
14163
|
+
};
|
|
14164
|
+
evidence?: {
|
|
14165
|
+
signature?: {
|
|
14166
|
+
id: string;
|
|
14167
|
+
title: string;
|
|
14168
|
+
fileName: string;
|
|
14169
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14170
|
+
downloadUrl: string;
|
|
14171
|
+
thumbnailUrl?: string;
|
|
14172
|
+
}[];
|
|
14173
|
+
signatureAttachments?: {
|
|
14174
|
+
id: string;
|
|
14175
|
+
title: string;
|
|
14176
|
+
fileName: string;
|
|
14177
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14178
|
+
downloadUrl: string;
|
|
14179
|
+
thumbnailUrl?: string;
|
|
14180
|
+
}[];
|
|
14181
|
+
beforePhotos?: {
|
|
14182
|
+
id: string;
|
|
14183
|
+
title: string;
|
|
14184
|
+
fileName: string;
|
|
14185
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14186
|
+
downloadUrl: string;
|
|
14187
|
+
thumbnailUrl?: string;
|
|
14188
|
+
}[];
|
|
14189
|
+
duringPhotos?: {
|
|
14190
|
+
id: string;
|
|
14191
|
+
title: string;
|
|
14192
|
+
fileName: string;
|
|
14193
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14194
|
+
downloadUrl: string;
|
|
14195
|
+
thumbnailUrl?: string;
|
|
14196
|
+
}[];
|
|
14197
|
+
afterPhotos?: {
|
|
14198
|
+
id: string;
|
|
14199
|
+
title: string;
|
|
14200
|
+
fileName: string;
|
|
14201
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14202
|
+
downloadUrl: string;
|
|
14203
|
+
thumbnailUrl?: string;
|
|
14204
|
+
}[];
|
|
14205
|
+
comment?: string;
|
|
14206
|
+
fileResponse?: {
|
|
14207
|
+
id: string;
|
|
14208
|
+
title: string;
|
|
14209
|
+
fileName: string;
|
|
14210
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14211
|
+
downloadUrl: string;
|
|
14212
|
+
thumbnailUrl?: string;
|
|
14213
|
+
}[];
|
|
14214
|
+
formResponse?: string;
|
|
14215
|
+
formAttachments?: {
|
|
14216
|
+
id: string;
|
|
14217
|
+
title: string;
|
|
14218
|
+
fileName: string;
|
|
14219
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14220
|
+
downloadUrl: string;
|
|
14221
|
+
thumbnailUrl?: string;
|
|
14222
|
+
}[];
|
|
14223
|
+
additionalFiles?: {
|
|
14224
|
+
id: string;
|
|
14225
|
+
title: string;
|
|
14226
|
+
fileName: string;
|
|
14227
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14228
|
+
downloadUrl: string;
|
|
14229
|
+
thumbnailUrl?: string;
|
|
14230
|
+
}[];
|
|
14231
|
+
};
|
|
14232
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14233
|
+
sortOrder?: string;
|
|
14234
|
+
createdAt: string;
|
|
14235
|
+
updatedAt?: string;
|
|
14236
|
+
createdBy: string;
|
|
14237
|
+
updatedBy?: string;
|
|
14238
|
+
};
|
|
14239
|
+
export type WorkBuddyJobsStagesTasksListResponse = {
|
|
14240
|
+
items: {
|
|
14241
|
+
id: string;
|
|
14242
|
+
name: string;
|
|
14243
|
+
description?: string;
|
|
14244
|
+
status: 'open' | 'completed';
|
|
14245
|
+
taskStatus?: string;
|
|
14246
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14247
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14248
|
+
assignee: string;
|
|
14249
|
+
dueDate?: string;
|
|
14250
|
+
completedOn?: string;
|
|
14251
|
+
completedBy: string;
|
|
14252
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14253
|
+
evidenceOptions?: {
|
|
14254
|
+
mandatory?: boolean;
|
|
14255
|
+
signatureEnabled?: boolean;
|
|
14256
|
+
beforePhotoEnabled?: boolean;
|
|
14257
|
+
duringPhotoEnabled?: boolean;
|
|
14258
|
+
afterPhotoEnabled?: boolean;
|
|
14259
|
+
commentEnabled?: boolean;
|
|
14260
|
+
fileEnabled?: boolean;
|
|
14261
|
+
fileTemplate?: { id: string; name: string };
|
|
14262
|
+
formEnabled?: boolean;
|
|
14263
|
+
formTemplate?: { id: string; name: string };
|
|
14264
|
+
evidenceEnforcement?: {
|
|
14265
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14266
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14267
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14268
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14269
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14270
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14271
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14272
|
+
};
|
|
14273
|
+
};
|
|
14274
|
+
evidence?: {
|
|
14275
|
+
signature?: {
|
|
14276
|
+
id: string;
|
|
14277
|
+
title: string;
|
|
14278
|
+
fileName: string;
|
|
14279
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14280
|
+
downloadUrl: string;
|
|
14281
|
+
thumbnailUrl?: string;
|
|
14282
|
+
}[];
|
|
14283
|
+
signatureAttachments?: {
|
|
14284
|
+
id: string;
|
|
14285
|
+
title: string;
|
|
14286
|
+
fileName: string;
|
|
14287
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14288
|
+
downloadUrl: string;
|
|
14289
|
+
thumbnailUrl?: string;
|
|
14290
|
+
}[];
|
|
14291
|
+
beforePhotos?: {
|
|
14292
|
+
id: string;
|
|
14293
|
+
title: string;
|
|
14294
|
+
fileName: string;
|
|
14295
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14296
|
+
downloadUrl: string;
|
|
14297
|
+
thumbnailUrl?: string;
|
|
14298
|
+
}[];
|
|
14299
|
+
duringPhotos?: {
|
|
14300
|
+
id: string;
|
|
14301
|
+
title: string;
|
|
14302
|
+
fileName: string;
|
|
14303
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14304
|
+
downloadUrl: string;
|
|
14305
|
+
thumbnailUrl?: string;
|
|
14306
|
+
}[];
|
|
14307
|
+
afterPhotos?: {
|
|
14308
|
+
id: string;
|
|
14309
|
+
title: string;
|
|
14310
|
+
fileName: string;
|
|
14311
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14312
|
+
downloadUrl: string;
|
|
14313
|
+
thumbnailUrl?: string;
|
|
14314
|
+
}[];
|
|
14315
|
+
comment?: string;
|
|
14316
|
+
fileResponse?: {
|
|
14317
|
+
id: string;
|
|
14318
|
+
title: string;
|
|
14319
|
+
fileName: string;
|
|
14320
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14321
|
+
downloadUrl: string;
|
|
14322
|
+
thumbnailUrl?: string;
|
|
14323
|
+
}[];
|
|
14324
|
+
formResponse?: string;
|
|
14325
|
+
formAttachments?: {
|
|
14326
|
+
id: string;
|
|
14327
|
+
title: string;
|
|
14328
|
+
fileName: string;
|
|
14329
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14330
|
+
downloadUrl: string;
|
|
14331
|
+
thumbnailUrl?: string;
|
|
14332
|
+
}[];
|
|
14333
|
+
additionalFiles?: {
|
|
14334
|
+
id: string;
|
|
14335
|
+
title: string;
|
|
14336
|
+
fileName: string;
|
|
14337
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14338
|
+
downloadUrl: string;
|
|
14339
|
+
thumbnailUrl?: string;
|
|
14340
|
+
}[];
|
|
14341
|
+
};
|
|
14342
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14343
|
+
sortOrder?: string;
|
|
14344
|
+
createdAt: string;
|
|
14345
|
+
updatedAt?: string;
|
|
14346
|
+
createdBy: string;
|
|
14347
|
+
updatedBy?: string;
|
|
14348
|
+
}[];
|
|
14349
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
14350
|
+
};
|
|
14351
|
+
export type WorkBuddyJobsStagesTasksCreateResponse = {
|
|
14352
|
+
id: string;
|
|
14353
|
+
name: string;
|
|
14354
|
+
description?: string;
|
|
14355
|
+
status: 'open' | 'completed';
|
|
14356
|
+
taskStatus?: string;
|
|
14357
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14358
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14359
|
+
assignee: string;
|
|
14360
|
+
dueDate?: string;
|
|
14361
|
+
completedOn?: string;
|
|
14362
|
+
completedBy: string;
|
|
14363
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14364
|
+
evidenceOptions?: {
|
|
14365
|
+
mandatory?: boolean;
|
|
14366
|
+
signatureEnabled?: boolean;
|
|
14367
|
+
beforePhotoEnabled?: boolean;
|
|
14368
|
+
duringPhotoEnabled?: boolean;
|
|
14369
|
+
afterPhotoEnabled?: boolean;
|
|
14370
|
+
commentEnabled?: boolean;
|
|
14371
|
+
fileEnabled?: boolean;
|
|
14372
|
+
fileTemplate?: { id: string; name: string };
|
|
14373
|
+
formEnabled?: boolean;
|
|
14374
|
+
formTemplate?: { id: string; name: string };
|
|
14375
|
+
evidenceEnforcement?: {
|
|
14376
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14377
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14378
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14379
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14380
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14381
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14382
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14383
|
+
};
|
|
14384
|
+
};
|
|
14385
|
+
evidence?: {
|
|
14386
|
+
signature?: {
|
|
14387
|
+
id: string;
|
|
14388
|
+
title: string;
|
|
14389
|
+
fileName: string;
|
|
14390
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14391
|
+
downloadUrl: string;
|
|
14392
|
+
thumbnailUrl?: string;
|
|
14393
|
+
}[];
|
|
14394
|
+
signatureAttachments?: {
|
|
14395
|
+
id: string;
|
|
14396
|
+
title: string;
|
|
14397
|
+
fileName: string;
|
|
14398
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14399
|
+
downloadUrl: string;
|
|
14400
|
+
thumbnailUrl?: string;
|
|
14401
|
+
}[];
|
|
14402
|
+
beforePhotos?: {
|
|
14403
|
+
id: string;
|
|
14404
|
+
title: string;
|
|
14405
|
+
fileName: string;
|
|
14406
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14407
|
+
downloadUrl: string;
|
|
14408
|
+
thumbnailUrl?: string;
|
|
14409
|
+
}[];
|
|
14410
|
+
duringPhotos?: {
|
|
14411
|
+
id: string;
|
|
14412
|
+
title: string;
|
|
14413
|
+
fileName: string;
|
|
14414
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14415
|
+
downloadUrl: string;
|
|
14416
|
+
thumbnailUrl?: string;
|
|
14417
|
+
}[];
|
|
14418
|
+
afterPhotos?: {
|
|
14419
|
+
id: string;
|
|
14420
|
+
title: string;
|
|
14421
|
+
fileName: string;
|
|
14422
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14423
|
+
downloadUrl: string;
|
|
14424
|
+
thumbnailUrl?: string;
|
|
14425
|
+
}[];
|
|
14426
|
+
comment?: string;
|
|
14427
|
+
fileResponse?: {
|
|
14428
|
+
id: string;
|
|
14429
|
+
title: string;
|
|
14430
|
+
fileName: string;
|
|
14431
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14432
|
+
downloadUrl: string;
|
|
14433
|
+
thumbnailUrl?: string;
|
|
14434
|
+
}[];
|
|
14435
|
+
formResponse?: string;
|
|
14436
|
+
formAttachments?: {
|
|
14437
|
+
id: string;
|
|
14438
|
+
title: string;
|
|
14439
|
+
fileName: string;
|
|
14440
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14441
|
+
downloadUrl: string;
|
|
14442
|
+
thumbnailUrl?: string;
|
|
14443
|
+
}[];
|
|
14444
|
+
additionalFiles?: {
|
|
14445
|
+
id: string;
|
|
14446
|
+
title: string;
|
|
14447
|
+
fileName: string;
|
|
14448
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14449
|
+
downloadUrl: string;
|
|
14450
|
+
thumbnailUrl?: string;
|
|
14451
|
+
}[];
|
|
14452
|
+
};
|
|
14453
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14454
|
+
sortOrder?: string;
|
|
14455
|
+
createdAt: string;
|
|
14456
|
+
updatedAt?: string;
|
|
14457
|
+
createdBy: string;
|
|
14458
|
+
updatedBy?: string;
|
|
14459
|
+
};
|
|
14460
|
+
export type WorkBuddyJobsStagesTasksGetResponse = {
|
|
14461
|
+
id: string;
|
|
14462
|
+
name: string;
|
|
14463
|
+
description?: string;
|
|
14464
|
+
status: 'open' | 'completed';
|
|
14465
|
+
taskStatus?: string;
|
|
14466
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14467
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14468
|
+
assignee: string;
|
|
14469
|
+
dueDate?: string;
|
|
14470
|
+
completedOn?: string;
|
|
14471
|
+
completedBy: string;
|
|
14472
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14473
|
+
evidenceOptions?: {
|
|
14474
|
+
mandatory?: boolean;
|
|
14475
|
+
signatureEnabled?: boolean;
|
|
14476
|
+
beforePhotoEnabled?: boolean;
|
|
14477
|
+
duringPhotoEnabled?: boolean;
|
|
14478
|
+
afterPhotoEnabled?: boolean;
|
|
14479
|
+
commentEnabled?: boolean;
|
|
14480
|
+
fileEnabled?: boolean;
|
|
14481
|
+
fileTemplate?: { id: string; name: string };
|
|
14482
|
+
formEnabled?: boolean;
|
|
14483
|
+
formTemplate?: { id: string; name: string };
|
|
14484
|
+
evidenceEnforcement?: {
|
|
14485
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14486
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14487
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14488
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14489
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14490
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14491
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14492
|
+
};
|
|
14493
|
+
};
|
|
14494
|
+
evidence?: {
|
|
14495
|
+
signature?: {
|
|
14496
|
+
id: string;
|
|
14497
|
+
title: string;
|
|
14498
|
+
fileName: string;
|
|
14499
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14500
|
+
downloadUrl: string;
|
|
14501
|
+
thumbnailUrl?: string;
|
|
14502
|
+
}[];
|
|
14503
|
+
signatureAttachments?: {
|
|
14504
|
+
id: string;
|
|
14505
|
+
title: string;
|
|
14506
|
+
fileName: string;
|
|
14507
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14508
|
+
downloadUrl: string;
|
|
14509
|
+
thumbnailUrl?: string;
|
|
14510
|
+
}[];
|
|
14511
|
+
beforePhotos?: {
|
|
14512
|
+
id: string;
|
|
14513
|
+
title: string;
|
|
14514
|
+
fileName: string;
|
|
14515
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14516
|
+
downloadUrl: string;
|
|
14517
|
+
thumbnailUrl?: string;
|
|
14518
|
+
}[];
|
|
14519
|
+
duringPhotos?: {
|
|
14520
|
+
id: string;
|
|
14521
|
+
title: string;
|
|
14522
|
+
fileName: string;
|
|
14523
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14524
|
+
downloadUrl: string;
|
|
14525
|
+
thumbnailUrl?: string;
|
|
14526
|
+
}[];
|
|
14527
|
+
afterPhotos?: {
|
|
14528
|
+
id: string;
|
|
14529
|
+
title: string;
|
|
14530
|
+
fileName: string;
|
|
14531
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14532
|
+
downloadUrl: string;
|
|
14533
|
+
thumbnailUrl?: string;
|
|
14534
|
+
}[];
|
|
14535
|
+
comment?: string;
|
|
14536
|
+
fileResponse?: {
|
|
14537
|
+
id: string;
|
|
14538
|
+
title: string;
|
|
14539
|
+
fileName: string;
|
|
14540
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14541
|
+
downloadUrl: string;
|
|
14542
|
+
thumbnailUrl?: string;
|
|
14543
|
+
}[];
|
|
14544
|
+
formResponse?: string;
|
|
14545
|
+
formAttachments?: {
|
|
14546
|
+
id: string;
|
|
14547
|
+
title: string;
|
|
14548
|
+
fileName: string;
|
|
14549
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14550
|
+
downloadUrl: string;
|
|
14551
|
+
thumbnailUrl?: string;
|
|
14552
|
+
}[];
|
|
14553
|
+
additionalFiles?: {
|
|
14554
|
+
id: string;
|
|
14555
|
+
title: string;
|
|
14556
|
+
fileName: string;
|
|
14557
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14558
|
+
downloadUrl: string;
|
|
14559
|
+
thumbnailUrl?: string;
|
|
14560
|
+
}[];
|
|
14561
|
+
};
|
|
14562
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14563
|
+
sortOrder?: string;
|
|
14564
|
+
createdAt: string;
|
|
14565
|
+
updatedAt?: string;
|
|
14566
|
+
createdBy: string;
|
|
14567
|
+
updatedBy?: string;
|
|
14568
|
+
};
|
|
14569
|
+
export type WorkBuddyJobsStagesTasksUpdateResponse = {
|
|
14570
|
+
id: string;
|
|
14571
|
+
name: string;
|
|
14572
|
+
description?: string;
|
|
14573
|
+
status: 'open' | 'completed';
|
|
14574
|
+
taskStatus?: string;
|
|
14575
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14576
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14577
|
+
assignee: string;
|
|
14578
|
+
dueDate?: string;
|
|
14579
|
+
completedOn?: string;
|
|
14580
|
+
completedBy: string;
|
|
14581
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14582
|
+
evidenceOptions?: {
|
|
14583
|
+
mandatory?: boolean;
|
|
14584
|
+
signatureEnabled?: boolean;
|
|
14585
|
+
beforePhotoEnabled?: boolean;
|
|
14586
|
+
duringPhotoEnabled?: boolean;
|
|
14587
|
+
afterPhotoEnabled?: boolean;
|
|
14588
|
+
commentEnabled?: boolean;
|
|
14589
|
+
fileEnabled?: boolean;
|
|
14590
|
+
fileTemplate?: { id: string; name: string };
|
|
14591
|
+
formEnabled?: boolean;
|
|
14592
|
+
formTemplate?: { id: string; name: string };
|
|
14593
|
+
evidenceEnforcement?: {
|
|
14594
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14595
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14596
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14597
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14598
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14599
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14600
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14601
|
+
};
|
|
14602
|
+
};
|
|
14603
|
+
evidence?: {
|
|
14604
|
+
signature?: {
|
|
14605
|
+
id: string;
|
|
14606
|
+
title: string;
|
|
14607
|
+
fileName: string;
|
|
14608
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14609
|
+
downloadUrl: string;
|
|
14610
|
+
thumbnailUrl?: string;
|
|
14611
|
+
}[];
|
|
14612
|
+
signatureAttachments?: {
|
|
14613
|
+
id: string;
|
|
14614
|
+
title: string;
|
|
14615
|
+
fileName: string;
|
|
14616
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14617
|
+
downloadUrl: string;
|
|
14618
|
+
thumbnailUrl?: string;
|
|
14619
|
+
}[];
|
|
14620
|
+
beforePhotos?: {
|
|
14621
|
+
id: string;
|
|
14622
|
+
title: string;
|
|
14623
|
+
fileName: string;
|
|
14624
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14625
|
+
downloadUrl: string;
|
|
14626
|
+
thumbnailUrl?: string;
|
|
14627
|
+
}[];
|
|
14628
|
+
duringPhotos?: {
|
|
14629
|
+
id: string;
|
|
14630
|
+
title: string;
|
|
14631
|
+
fileName: string;
|
|
14632
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14633
|
+
downloadUrl: string;
|
|
14634
|
+
thumbnailUrl?: string;
|
|
14635
|
+
}[];
|
|
14636
|
+
afterPhotos?: {
|
|
14637
|
+
id: string;
|
|
14638
|
+
title: string;
|
|
14639
|
+
fileName: string;
|
|
14640
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14641
|
+
downloadUrl: string;
|
|
14642
|
+
thumbnailUrl?: string;
|
|
14643
|
+
}[];
|
|
14644
|
+
comment?: string;
|
|
14645
|
+
fileResponse?: {
|
|
14646
|
+
id: string;
|
|
14647
|
+
title: string;
|
|
14648
|
+
fileName: string;
|
|
14649
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14650
|
+
downloadUrl: string;
|
|
14651
|
+
thumbnailUrl?: string;
|
|
14652
|
+
}[];
|
|
14653
|
+
formResponse?: string;
|
|
14654
|
+
formAttachments?: {
|
|
14655
|
+
id: string;
|
|
14656
|
+
title: string;
|
|
14657
|
+
fileName: string;
|
|
14658
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14659
|
+
downloadUrl: string;
|
|
14660
|
+
thumbnailUrl?: string;
|
|
14661
|
+
}[];
|
|
14662
|
+
additionalFiles?: {
|
|
14663
|
+
id: string;
|
|
14664
|
+
title: string;
|
|
14665
|
+
fileName: string;
|
|
14666
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14667
|
+
downloadUrl: string;
|
|
14668
|
+
thumbnailUrl?: string;
|
|
14669
|
+
}[];
|
|
14670
|
+
};
|
|
14671
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14672
|
+
sortOrder?: string;
|
|
14673
|
+
createdAt: string;
|
|
14674
|
+
updatedAt?: string;
|
|
14675
|
+
createdBy: string;
|
|
14676
|
+
updatedBy?: string;
|
|
14677
|
+
};
|
|
14678
|
+
export type WorkBuddyJobsStagesTasksDeleteResponse = { deleted: boolean };
|
|
14679
|
+
export type WorkBuddyJobsStagesTasksEvidenceSubmitEvidenceResponse = {
|
|
14680
|
+
id: string;
|
|
14681
|
+
name: string;
|
|
14682
|
+
description?: string;
|
|
14683
|
+
status: 'open' | 'completed';
|
|
14684
|
+
taskStatus?: string;
|
|
14685
|
+
mustResolveBefore?: 'notEnforced' | 'stageCompletion' | 'claimSubmission';
|
|
14686
|
+
target?: 'office' | 'supervisor' | 'field';
|
|
14687
|
+
assignee: string;
|
|
14688
|
+
dueDate?: string;
|
|
14689
|
+
completedOn?: string;
|
|
14690
|
+
completedBy: string;
|
|
14691
|
+
tags?: { id: string; name: string; color?: string }[];
|
|
14692
|
+
evidenceOptions?: {
|
|
14693
|
+
mandatory?: boolean;
|
|
14694
|
+
signatureEnabled?: boolean;
|
|
14695
|
+
beforePhotoEnabled?: boolean;
|
|
14696
|
+
duringPhotoEnabled?: boolean;
|
|
14697
|
+
afterPhotoEnabled?: boolean;
|
|
14698
|
+
commentEnabled?: boolean;
|
|
14699
|
+
fileEnabled?: boolean;
|
|
14700
|
+
fileTemplate?: { id: string; name: string };
|
|
14701
|
+
formEnabled?: boolean;
|
|
14702
|
+
formTemplate?: { id: string; name: string };
|
|
14703
|
+
evidenceEnforcement?: {
|
|
14704
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14705
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14706
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14707
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14708
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14709
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14710
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14711
|
+
};
|
|
14712
|
+
};
|
|
14713
|
+
evidence?: {
|
|
14714
|
+
signature?: {
|
|
14715
|
+
id: string;
|
|
14716
|
+
title: string;
|
|
14717
|
+
fileName: string;
|
|
14718
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14719
|
+
downloadUrl: string;
|
|
14720
|
+
thumbnailUrl?: string;
|
|
14721
|
+
}[];
|
|
14722
|
+
signatureAttachments?: {
|
|
14723
|
+
id: string;
|
|
14724
|
+
title: string;
|
|
14725
|
+
fileName: string;
|
|
14726
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14727
|
+
downloadUrl: string;
|
|
14728
|
+
thumbnailUrl?: string;
|
|
14729
|
+
}[];
|
|
14730
|
+
beforePhotos?: {
|
|
14731
|
+
id: string;
|
|
14732
|
+
title: string;
|
|
14733
|
+
fileName: string;
|
|
14734
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14735
|
+
downloadUrl: string;
|
|
14736
|
+
thumbnailUrl?: string;
|
|
14737
|
+
}[];
|
|
14738
|
+
duringPhotos?: {
|
|
14739
|
+
id: string;
|
|
14740
|
+
title: string;
|
|
14741
|
+
fileName: string;
|
|
14742
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14743
|
+
downloadUrl: string;
|
|
14744
|
+
thumbnailUrl?: string;
|
|
14745
|
+
}[];
|
|
14746
|
+
afterPhotos?: {
|
|
14747
|
+
id: string;
|
|
14748
|
+
title: string;
|
|
14749
|
+
fileName: string;
|
|
14750
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14751
|
+
downloadUrl: string;
|
|
14752
|
+
thumbnailUrl?: string;
|
|
14753
|
+
}[];
|
|
14754
|
+
comment?: string;
|
|
14755
|
+
fileResponse?: {
|
|
14756
|
+
id: string;
|
|
14757
|
+
title: string;
|
|
14758
|
+
fileName: string;
|
|
14759
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14760
|
+
downloadUrl: string;
|
|
14761
|
+
thumbnailUrl?: string;
|
|
14762
|
+
}[];
|
|
14763
|
+
formResponse?: string;
|
|
14764
|
+
formAttachments?: {
|
|
14765
|
+
id: string;
|
|
14766
|
+
title: string;
|
|
14767
|
+
fileName: string;
|
|
14768
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14769
|
+
downloadUrl: string;
|
|
14770
|
+
thumbnailUrl?: string;
|
|
14771
|
+
}[];
|
|
14772
|
+
additionalFiles?: {
|
|
14773
|
+
id: string;
|
|
14774
|
+
title: string;
|
|
14775
|
+
fileName: string;
|
|
14776
|
+
type: 'File' | 'Image' | 'Video' | 'Form' | 'Signature';
|
|
14777
|
+
downloadUrl: string;
|
|
14778
|
+
thumbnailUrl?: string;
|
|
14779
|
+
}[];
|
|
14780
|
+
};
|
|
14781
|
+
sharing?: { sharedWithCustomer: boolean; sharedWithField: boolean };
|
|
14782
|
+
sortOrder?: string;
|
|
14783
|
+
createdAt: string;
|
|
14784
|
+
updatedAt?: string;
|
|
14785
|
+
createdBy: string;
|
|
14786
|
+
updatedBy?: string;
|
|
12970
14787
|
};
|
|
12971
|
-
export type WorkBuddyJobsFilesListResponse = unknown;
|
|
12972
|
-
export type WorkBuddyJobsFilesCreateResponse = unknown;
|
|
12973
|
-
export type WorkBuddyJobsFilesGetResponse = unknown;
|
|
12974
|
-
export type WorkBuddyJobsFilesDeleteResponse = unknown;
|
|
12975
|
-
export type WorkBuddyJobsStagesFilesListResponse = unknown;
|
|
12976
|
-
export type WorkBuddyJobsStagesFilesCreateResponse = unknown;
|
|
12977
|
-
export type WorkBuddyJobsStagesFilesGetResponse = unknown;
|
|
12978
|
-
export type WorkBuddyJobsStagesFilesDeleteResponse = unknown;
|
|
12979
|
-
export type WorkBuddyJobsTasksListResponse = unknown;
|
|
12980
|
-
export type WorkBuddyJobsTasksCreateResponse = unknown;
|
|
12981
|
-
export type WorkBuddyJobsTasksGetResponse = unknown;
|
|
12982
|
-
export type WorkBuddyJobsTasksUpdateResponse = unknown;
|
|
12983
|
-
export type WorkBuddyJobsTasksDeleteResponse = unknown;
|
|
12984
|
-
export type WorkBuddyJobsTasksEvidenceSubmitEvidenceResponse = unknown;
|
|
12985
|
-
export type WorkBuddyJobsStagesTasksListResponse = unknown;
|
|
12986
|
-
export type WorkBuddyJobsStagesTasksCreateResponse = unknown;
|
|
12987
|
-
export type WorkBuddyJobsStagesTasksGetResponse = unknown;
|
|
12988
|
-
export type WorkBuddyJobsStagesTasksUpdateResponse = unknown;
|
|
12989
|
-
export type WorkBuddyJobsStagesTasksDeleteResponse = unknown;
|
|
12990
|
-
export type WorkBuddyJobsStagesTasksEvidenceSubmitEvidenceResponse = unknown;
|
|
12991
14788
|
export type WorkBuddyTasksStatusesListResponse = {
|
|
12992
14789
|
items: {
|
|
12993
14790
|
id: string;
|
|
@@ -13998,8 +15795,8 @@ export type WorkBuddyWebhooksRegenerateSecretRegenerateSecretResponse = unknown;
|
|
|
13998
15795
|
export type WorkBuddyWebhooksTestTestResponse = unknown;
|
|
13999
15796
|
export type WorkBuddyWebhooksDeliveriesListResponse = unknown;
|
|
14000
15797
|
export type WorkBuddyExportsExportResponse = unknown;
|
|
14001
|
-
export type
|
|
14002
|
-
export type
|
|
15798
|
+
export type WorkBuddyExtensionRunsEventsIngestEventResponse = unknown;
|
|
15799
|
+
export type WorkBuddyExtensionRunsActionResolvedResolveActionResponse = unknown;
|
|
14003
15800
|
export type WorkBuddyFlagsCreateResponse = {
|
|
14004
15801
|
data: {
|
|
14005
15802
|
id: string;
|
|
@@ -14051,17 +15848,41 @@ export type WorkBuddyFlagsEntityListResponse = {
|
|
|
14051
15848
|
closedBy?: string;
|
|
14052
15849
|
}[];
|
|
14053
15850
|
};
|
|
15851
|
+
export type WorkBuddyServicePlansListResponse = {
|
|
15852
|
+
items: {
|
|
15853
|
+
id: string;
|
|
15854
|
+
integrationId?: string;
|
|
15855
|
+
name: string;
|
|
15856
|
+
description?: string;
|
|
15857
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
15858
|
+
customer: { id: string; name?: string };
|
|
15859
|
+
site: { id: string; name?: string };
|
|
15860
|
+
dateStart: string;
|
|
15861
|
+
dateEnd: string;
|
|
15862
|
+
timezone: string;
|
|
15863
|
+
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15864
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
15865
|
+
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
15866
|
+
active: boolean;
|
|
15867
|
+
createdAt?: string;
|
|
15868
|
+
updatedAt?: string;
|
|
15869
|
+
}[];
|
|
15870
|
+
pagination: { page: number; pageSize: number; total: number; hasMore: boolean };
|
|
15871
|
+
};
|
|
14054
15872
|
export type WorkBuddyServicePlansCreateResponse = {
|
|
14055
15873
|
data: {
|
|
14056
15874
|
id: string;
|
|
14057
15875
|
integrationId?: string;
|
|
14058
15876
|
name: string;
|
|
15877
|
+
description?: string;
|
|
15878
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
14059
15879
|
customer: { id: string; name?: string };
|
|
14060
15880
|
site: { id: string; name?: string };
|
|
14061
15881
|
dateStart: string;
|
|
14062
15882
|
dateEnd: string;
|
|
14063
15883
|
timezone: string;
|
|
14064
15884
|
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15885
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
14065
15886
|
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
14066
15887
|
active: boolean;
|
|
14067
15888
|
createdAt?: string;
|
|
@@ -14073,29 +15894,56 @@ export type WorkBuddyServicePlansGetResponse = {
|
|
|
14073
15894
|
id: string;
|
|
14074
15895
|
integrationId?: string;
|
|
14075
15896
|
name: string;
|
|
15897
|
+
description?: string;
|
|
15898
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
15899
|
+
customer: { id: string; name?: string };
|
|
15900
|
+
site: { id: string; name?: string };
|
|
15901
|
+
dateStart: string;
|
|
15902
|
+
dateEnd: string;
|
|
15903
|
+
timezone: string;
|
|
15904
|
+
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15905
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
15906
|
+
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
15907
|
+
active: boolean;
|
|
15908
|
+
createdAt?: string;
|
|
15909
|
+
updatedAt?: string;
|
|
15910
|
+
};
|
|
15911
|
+
};
|
|
15912
|
+
export type WorkBuddyServicePlansPatchResponse = {
|
|
15913
|
+
data: {
|
|
15914
|
+
id: string;
|
|
15915
|
+
integrationId?: string;
|
|
15916
|
+
name: string;
|
|
15917
|
+
description?: string;
|
|
15918
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
14076
15919
|
customer: { id: string; name?: string };
|
|
14077
15920
|
site: { id: string; name?: string };
|
|
14078
15921
|
dateStart: string;
|
|
14079
15922
|
dateEnd: string;
|
|
14080
15923
|
timezone: string;
|
|
14081
15924
|
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15925
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
14082
15926
|
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
14083
15927
|
active: boolean;
|
|
14084
15928
|
createdAt?: string;
|
|
14085
15929
|
updatedAt?: string;
|
|
14086
15930
|
};
|
|
14087
15931
|
};
|
|
15932
|
+
export type WorkBuddyServicePlansDeleteResponse = { success: boolean; id: string };
|
|
14088
15933
|
export type WorkBuddyServicePlansActivateActivateResponse = {
|
|
14089
15934
|
data: {
|
|
14090
15935
|
id: string;
|
|
14091
15936
|
integrationId?: string;
|
|
14092
15937
|
name: string;
|
|
15938
|
+
description?: string;
|
|
15939
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
14093
15940
|
customer: { id: string; name?: string };
|
|
14094
15941
|
site: { id: string; name?: string };
|
|
14095
15942
|
dateStart: string;
|
|
14096
15943
|
dateEnd: string;
|
|
14097
15944
|
timezone: string;
|
|
14098
15945
|
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15946
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
14099
15947
|
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
14100
15948
|
active: boolean;
|
|
14101
15949
|
createdAt?: string;
|
|
@@ -14107,29 +15955,69 @@ export type WorkBuddyServicePlansSuspendSuspendResponse = {
|
|
|
14107
15955
|
id: string;
|
|
14108
15956
|
integrationId?: string;
|
|
14109
15957
|
name: string;
|
|
15958
|
+
description?: string;
|
|
15959
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
14110
15960
|
customer: { id: string; name?: string };
|
|
14111
15961
|
site: { id: string; name?: string };
|
|
14112
15962
|
dateStart: string;
|
|
14113
15963
|
dateEnd: string;
|
|
14114
15964
|
timezone: string;
|
|
14115
15965
|
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
15966
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
14116
15967
|
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
14117
15968
|
active: boolean;
|
|
14118
15969
|
createdAt?: string;
|
|
14119
15970
|
updatedAt?: string;
|
|
14120
15971
|
};
|
|
15972
|
+
execution: {
|
|
15973
|
+
preservedExecutionCount: number;
|
|
15974
|
+
liveExecutionCount: number;
|
|
15975
|
+
committedVisitCount: number;
|
|
15976
|
+
preservedExecutions: {
|
|
15977
|
+
visitId: string;
|
|
15978
|
+
visitNumber?: string;
|
|
15979
|
+
localDate?: string;
|
|
15980
|
+
executionId?: string;
|
|
15981
|
+
executionNumber?: string;
|
|
15982
|
+
executionStatus?: string;
|
|
15983
|
+
stageIds?: string[];
|
|
15984
|
+
}[];
|
|
15985
|
+
};
|
|
14121
15986
|
};
|
|
14122
15987
|
export type WorkBuddyServicePlansArchiveArchiveResponse = {
|
|
14123
15988
|
data: {
|
|
14124
15989
|
id: string;
|
|
14125
15990
|
integrationId?: string;
|
|
14126
15991
|
name: string;
|
|
15992
|
+
description?: string;
|
|
15993
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
15994
|
+
customer: { id: string; name?: string };
|
|
15995
|
+
site: { id: string; name?: string };
|
|
15996
|
+
dateStart: string;
|
|
15997
|
+
dateEnd: string;
|
|
15998
|
+
timezone: string;
|
|
15999
|
+
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
16000
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
16001
|
+
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
16002
|
+
active: boolean;
|
|
16003
|
+
createdAt?: string;
|
|
16004
|
+
updatedAt?: string;
|
|
16005
|
+
};
|
|
16006
|
+
};
|
|
16007
|
+
export type WorkBuddyServicePlansRestoreRestoreResponse = {
|
|
16008
|
+
data: {
|
|
16009
|
+
id: string;
|
|
16010
|
+
integrationId?: string;
|
|
16011
|
+
name: string;
|
|
16012
|
+
description?: string;
|
|
16013
|
+
jobDefaults?: { contact: string; owner: string; priceBook: string };
|
|
14127
16014
|
customer: { id: string; name?: string };
|
|
14128
16015
|
site: { id: string; name?: string };
|
|
14129
16016
|
dateStart: string;
|
|
14130
16017
|
dateEnd: string;
|
|
14131
16018
|
timezone: string;
|
|
14132
16019
|
workingDays: ('Mon' | 'Tue' | 'Wed' | 'Thu' | 'Fri' | 'Sat' | 'Sun')[];
|
|
16020
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
14133
16021
|
status: { id: string; name: string; systemName?: string; statusType?: string };
|
|
14134
16022
|
active: boolean;
|
|
14135
16023
|
createdAt?: string;
|
|
@@ -14151,6 +16039,11 @@ export type WorkBuddyServicePlansLinesListResponse = {
|
|
|
14151
16039
|
appointment: 'Timed' | 'AnyTime';
|
|
14152
16040
|
defaultWindow: string;
|
|
14153
16041
|
workingDays: string;
|
|
16042
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
16043
|
+
owner?: string;
|
|
16044
|
+
requiresApproval?: boolean;
|
|
16045
|
+
overdueGraceDays?: string;
|
|
16046
|
+
jobChangeCutoffMinutes?: string;
|
|
14154
16047
|
jobDefaults: string;
|
|
14155
16048
|
active: boolean;
|
|
14156
16049
|
createdAt?: string;
|
|
@@ -14173,6 +16066,11 @@ export type WorkBuddyServicePlansLinesCreateResponse = {
|
|
|
14173
16066
|
appointment: 'Timed' | 'AnyTime';
|
|
14174
16067
|
defaultWindow: string;
|
|
14175
16068
|
workingDays: string;
|
|
16069
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
16070
|
+
owner?: string;
|
|
16071
|
+
requiresApproval?: boolean;
|
|
16072
|
+
overdueGraceDays?: string;
|
|
16073
|
+
jobChangeCutoffMinutes?: string;
|
|
14176
16074
|
jobDefaults: string;
|
|
14177
16075
|
active: boolean;
|
|
14178
16076
|
createdAt?: string;
|
|
@@ -14194,6 +16092,11 @@ export type WorkBuddyServicePlansLinesGetResponse = {
|
|
|
14194
16092
|
appointment: 'Timed' | 'AnyTime';
|
|
14195
16093
|
defaultWindow: string;
|
|
14196
16094
|
workingDays: string;
|
|
16095
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
16096
|
+
owner?: string;
|
|
16097
|
+
requiresApproval?: boolean;
|
|
16098
|
+
overdueGraceDays?: string;
|
|
16099
|
+
jobChangeCutoffMinutes?: string;
|
|
14197
16100
|
jobDefaults: string;
|
|
14198
16101
|
active: boolean;
|
|
14199
16102
|
createdAt?: string;
|
|
@@ -14215,12 +16118,18 @@ export type WorkBuddyServicePlansLinesPatchResponse = {
|
|
|
14215
16118
|
appointment: 'Timed' | 'AnyTime';
|
|
14216
16119
|
defaultWindow: string;
|
|
14217
16120
|
workingDays: string;
|
|
16121
|
+
blackoutRanges?: { id: string; from: string; to: string; reason?: string }[];
|
|
16122
|
+
owner?: string;
|
|
16123
|
+
requiresApproval?: boolean;
|
|
16124
|
+
overdueGraceDays?: string;
|
|
16125
|
+
jobChangeCutoffMinutes?: string;
|
|
14218
16126
|
jobDefaults: string;
|
|
14219
16127
|
active: boolean;
|
|
14220
16128
|
createdAt?: string;
|
|
14221
16129
|
updatedAt?: string;
|
|
14222
16130
|
};
|
|
14223
16131
|
};
|
|
16132
|
+
export type WorkBuddyServicePlansLinesDeleteResponse = { success: boolean; id: string };
|
|
14224
16133
|
export type WorkBuddyServicePlansLinesTasksListResponse = {
|
|
14225
16134
|
items: {
|
|
14226
16135
|
id: string;
|
|
@@ -14379,6 +16288,7 @@ export type WorkBuddyServicePlansLinesTasksPatchResponse = {
|
|
|
14379
16288
|
updatedAt?: string;
|
|
14380
16289
|
};
|
|
14381
16290
|
};
|
|
16291
|
+
export type WorkBuddyServicePlansLinesTasksDeleteResponse = { success: boolean; id: string };
|
|
14382
16292
|
export type WorkBuddyServicePlansLinesTasksSubtasksListResponse = {
|
|
14383
16293
|
items: {
|
|
14384
16294
|
id: string;
|
|
@@ -14451,74 +16361,449 @@ export type WorkBuddyServicePlansLinesTasksSubtasksCreateResponse = {
|
|
|
14451
16361
|
};
|
|
14452
16362
|
error?: { field?: string; message: string };
|
|
14453
16363
|
}[];
|
|
14454
|
-
created: number;
|
|
14455
|
-
existing: number;
|
|
14456
|
-
failed: number;
|
|
16364
|
+
created: number;
|
|
16365
|
+
existing: number;
|
|
16366
|
+
failed: number;
|
|
16367
|
+
};
|
|
16368
|
+
export type WorkBuddyServicePlansLinesTasksSubtasksGetResponse = {
|
|
16369
|
+
data: {
|
|
16370
|
+
id: string;
|
|
16371
|
+
integrationId?: string;
|
|
16372
|
+
servicePlanId: string;
|
|
16373
|
+
serviceLineId: string;
|
|
16374
|
+
name: string;
|
|
16375
|
+
description: string;
|
|
16376
|
+
mandatory: boolean;
|
|
16377
|
+
mandatoryForClaiming: boolean;
|
|
16378
|
+
signatureEnabled: boolean;
|
|
16379
|
+
commentEnabled: boolean;
|
|
16380
|
+
beforePhotoEnabled: boolean;
|
|
16381
|
+
duringPhotoEnabled: boolean;
|
|
16382
|
+
afterPhotoEnabled: boolean;
|
|
16383
|
+
fileEnabled: boolean;
|
|
16384
|
+
fileTemplate: string;
|
|
16385
|
+
formEnabled: boolean;
|
|
16386
|
+
formTemplate: string;
|
|
16387
|
+
evidenceEnforcement?: {
|
|
16388
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16389
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16390
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16391
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16392
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16393
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16394
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16395
|
+
};
|
|
16396
|
+
active: boolean;
|
|
16397
|
+
createdAt?: string;
|
|
16398
|
+
updatedAt?: string;
|
|
16399
|
+
};
|
|
16400
|
+
};
|
|
16401
|
+
export type WorkBuddyServicePlansLinesTasksSubtasksPatchResponse = {
|
|
16402
|
+
data: {
|
|
16403
|
+
id: string;
|
|
16404
|
+
integrationId?: string;
|
|
16405
|
+
servicePlanId: string;
|
|
16406
|
+
serviceLineId: string;
|
|
16407
|
+
name: string;
|
|
16408
|
+
description: string;
|
|
16409
|
+
mandatory: boolean;
|
|
16410
|
+
mandatoryForClaiming: boolean;
|
|
16411
|
+
signatureEnabled: boolean;
|
|
16412
|
+
commentEnabled: boolean;
|
|
16413
|
+
beforePhotoEnabled: boolean;
|
|
16414
|
+
duringPhotoEnabled: boolean;
|
|
16415
|
+
afterPhotoEnabled: boolean;
|
|
16416
|
+
fileEnabled: boolean;
|
|
16417
|
+
fileTemplate: string;
|
|
16418
|
+
formEnabled: boolean;
|
|
16419
|
+
formTemplate: string;
|
|
16420
|
+
evidenceEnforcement?: {
|
|
16421
|
+
beforePhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16422
|
+
duringPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16423
|
+
afterPhoto?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16424
|
+
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16425
|
+
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16426
|
+
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16427
|
+
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
16428
|
+
};
|
|
16429
|
+
active: boolean;
|
|
16430
|
+
createdAt?: string;
|
|
16431
|
+
updatedAt?: string;
|
|
16432
|
+
};
|
|
16433
|
+
};
|
|
16434
|
+
export type WorkBuddyServicePlansLinesTasksSubtasksDeleteResponse = { success: boolean; id: string };
|
|
16435
|
+
export type WorkBuddyLeadsListResponse = {
|
|
16436
|
+
items: {
|
|
16437
|
+
id: string;
|
|
16438
|
+
name: string;
|
|
16439
|
+
description: string;
|
|
16440
|
+
stage: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
16441
|
+
account: {
|
|
16442
|
+
name: string;
|
|
16443
|
+
type?: 'Business' | 'Individual';
|
|
16444
|
+
phone?: string;
|
|
16445
|
+
email?: string;
|
|
16446
|
+
website?: string;
|
|
16447
|
+
annualRevenue?: string;
|
|
16448
|
+
industry?: string;
|
|
16449
|
+
employees?: string;
|
|
16450
|
+
};
|
|
16451
|
+
contact: {
|
|
16452
|
+
name?: string;
|
|
16453
|
+
firstName: string;
|
|
16454
|
+
lastName: string;
|
|
16455
|
+
title?: string;
|
|
16456
|
+
email?: string;
|
|
16457
|
+
mobile?: string;
|
|
16458
|
+
workPhone?: string;
|
|
16459
|
+
};
|
|
16460
|
+
address: string;
|
|
16461
|
+
amount: number;
|
|
16462
|
+
expectedClose: string;
|
|
16463
|
+
billingCompany: string;
|
|
16464
|
+
owner: string;
|
|
16465
|
+
jobType: string;
|
|
16466
|
+
source: string;
|
|
16467
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16468
|
+
zones: { id: string; name: string }[];
|
|
16469
|
+
timezone: string;
|
|
16470
|
+
lastActivity: string;
|
|
16471
|
+
stageUpdatedAt: string;
|
|
16472
|
+
createdAt: string;
|
|
16473
|
+
updatedAt: string;
|
|
16474
|
+
}[];
|
|
16475
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
16476
|
+
};
|
|
16477
|
+
export type WorkBuddyLeadsCreateResponse = {
|
|
16478
|
+
item: {
|
|
16479
|
+
id: string;
|
|
16480
|
+
name: string;
|
|
16481
|
+
description: string;
|
|
16482
|
+
stage: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
16483
|
+
account: {
|
|
16484
|
+
name: string;
|
|
16485
|
+
type?: 'Business' | 'Individual';
|
|
16486
|
+
phone?: string;
|
|
16487
|
+
email?: string;
|
|
16488
|
+
website?: string;
|
|
16489
|
+
annualRevenue?: string;
|
|
16490
|
+
industry?: string;
|
|
16491
|
+
employees?: string;
|
|
16492
|
+
};
|
|
16493
|
+
contact: {
|
|
16494
|
+
name?: string;
|
|
16495
|
+
firstName: string;
|
|
16496
|
+
lastName: string;
|
|
16497
|
+
title?: string;
|
|
16498
|
+
email?: string;
|
|
16499
|
+
mobile?: string;
|
|
16500
|
+
workPhone?: string;
|
|
16501
|
+
};
|
|
16502
|
+
address: string;
|
|
16503
|
+
amount: number;
|
|
16504
|
+
expectedClose: string;
|
|
16505
|
+
billingCompany: string;
|
|
16506
|
+
owner: string;
|
|
16507
|
+
jobType: string;
|
|
16508
|
+
source: string;
|
|
16509
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16510
|
+
zones: { id: string; name: string }[];
|
|
16511
|
+
timezone: string;
|
|
16512
|
+
lastActivity: string;
|
|
16513
|
+
stageUpdatedAt: string;
|
|
16514
|
+
createdAt: string;
|
|
16515
|
+
updatedAt: string;
|
|
16516
|
+
};
|
|
16517
|
+
};
|
|
16518
|
+
export type WorkBuddyLeadsGetResponse = {
|
|
16519
|
+
item: {
|
|
16520
|
+
id: string;
|
|
16521
|
+
name: string;
|
|
16522
|
+
description: string;
|
|
16523
|
+
stage: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
16524
|
+
account: {
|
|
16525
|
+
name: string;
|
|
16526
|
+
type?: 'Business' | 'Individual';
|
|
16527
|
+
phone?: string;
|
|
16528
|
+
email?: string;
|
|
16529
|
+
website?: string;
|
|
16530
|
+
annualRevenue?: string;
|
|
16531
|
+
industry?: string;
|
|
16532
|
+
employees?: string;
|
|
16533
|
+
};
|
|
16534
|
+
contact: {
|
|
16535
|
+
name?: string;
|
|
16536
|
+
firstName: string;
|
|
16537
|
+
lastName: string;
|
|
16538
|
+
title?: string;
|
|
16539
|
+
email?: string;
|
|
16540
|
+
mobile?: string;
|
|
16541
|
+
workPhone?: string;
|
|
16542
|
+
};
|
|
16543
|
+
address: string;
|
|
16544
|
+
amount: number;
|
|
16545
|
+
expectedClose: string;
|
|
16546
|
+
billingCompany: string;
|
|
16547
|
+
owner: string;
|
|
16548
|
+
jobType: string;
|
|
16549
|
+
source: string;
|
|
16550
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16551
|
+
zones: { id: string; name: string }[];
|
|
16552
|
+
timezone: string;
|
|
16553
|
+
lastActivity: string;
|
|
16554
|
+
stageUpdatedAt: string;
|
|
16555
|
+
createdAt: string;
|
|
16556
|
+
updatedAt: string;
|
|
16557
|
+
};
|
|
16558
|
+
};
|
|
16559
|
+
export type WorkBuddyLeadsUpdateResponse = {
|
|
16560
|
+
item: {
|
|
16561
|
+
id: string;
|
|
16562
|
+
name: string;
|
|
16563
|
+
description: string;
|
|
16564
|
+
stage: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
16565
|
+
account: {
|
|
16566
|
+
name: string;
|
|
16567
|
+
type?: 'Business' | 'Individual';
|
|
16568
|
+
phone?: string;
|
|
16569
|
+
email?: string;
|
|
16570
|
+
website?: string;
|
|
16571
|
+
annualRevenue?: string;
|
|
16572
|
+
industry?: string;
|
|
16573
|
+
employees?: string;
|
|
16574
|
+
};
|
|
16575
|
+
contact: {
|
|
16576
|
+
name?: string;
|
|
16577
|
+
firstName: string;
|
|
16578
|
+
lastName: string;
|
|
16579
|
+
title?: string;
|
|
16580
|
+
email?: string;
|
|
16581
|
+
mobile?: string;
|
|
16582
|
+
workPhone?: string;
|
|
16583
|
+
};
|
|
16584
|
+
address: string;
|
|
16585
|
+
amount: number;
|
|
16586
|
+
expectedClose: string;
|
|
16587
|
+
billingCompany: string;
|
|
16588
|
+
owner: string;
|
|
16589
|
+
jobType: string;
|
|
16590
|
+
source: string;
|
|
16591
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16592
|
+
zones: { id: string; name: string }[];
|
|
16593
|
+
timezone: string;
|
|
16594
|
+
lastActivity: string;
|
|
16595
|
+
stageUpdatedAt: string;
|
|
16596
|
+
createdAt: string;
|
|
16597
|
+
updatedAt: string;
|
|
16598
|
+
};
|
|
16599
|
+
};
|
|
16600
|
+
export type WorkBuddyLeadsConvertConvertResponse = {
|
|
16601
|
+
item: {
|
|
16602
|
+
id: string;
|
|
16603
|
+
name: string;
|
|
16604
|
+
description: string;
|
|
16605
|
+
stage: 'New' | 'In Progress' | 'Qualified' | 'Disqualified';
|
|
16606
|
+
account: {
|
|
16607
|
+
name: string;
|
|
16608
|
+
type?: 'Business' | 'Individual';
|
|
16609
|
+
phone?: string;
|
|
16610
|
+
email?: string;
|
|
16611
|
+
website?: string;
|
|
16612
|
+
annualRevenue?: string;
|
|
16613
|
+
industry?: string;
|
|
16614
|
+
employees?: string;
|
|
16615
|
+
};
|
|
16616
|
+
contact: {
|
|
16617
|
+
name?: string;
|
|
16618
|
+
firstName: string;
|
|
16619
|
+
lastName: string;
|
|
16620
|
+
title?: string;
|
|
16621
|
+
email?: string;
|
|
16622
|
+
mobile?: string;
|
|
16623
|
+
workPhone?: string;
|
|
16624
|
+
};
|
|
16625
|
+
address: string;
|
|
16626
|
+
amount: number;
|
|
16627
|
+
expectedClose: string;
|
|
16628
|
+
billingCompany: string;
|
|
16629
|
+
owner: string;
|
|
16630
|
+
jobType: string;
|
|
16631
|
+
source: string;
|
|
16632
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16633
|
+
zones: { id: string; name: string }[];
|
|
16634
|
+
timezone: string;
|
|
16635
|
+
lastActivity: string;
|
|
16636
|
+
stageUpdatedAt: string;
|
|
16637
|
+
createdAt: string;
|
|
16638
|
+
updatedAt: string;
|
|
16639
|
+
};
|
|
16640
|
+
customerId: string;
|
|
16641
|
+
opportunityId: string;
|
|
16642
|
+
};
|
|
16643
|
+
export type WorkBuddyOpportunitiesListResponse = {
|
|
16644
|
+
items: {
|
|
16645
|
+
id: string;
|
|
16646
|
+
opportunityNumber: string;
|
|
16647
|
+
name: string;
|
|
16648
|
+
customer: string;
|
|
16649
|
+
contact: string;
|
|
16650
|
+
site: string;
|
|
16651
|
+
customerSite: string;
|
|
16652
|
+
billingCompany: string;
|
|
16653
|
+
owner: string;
|
|
16654
|
+
areaManager: string;
|
|
16655
|
+
stage: string;
|
|
16656
|
+
description: string;
|
|
16657
|
+
amount: number;
|
|
16658
|
+
probability: number;
|
|
16659
|
+
expectedClose: string;
|
|
16660
|
+
jobType: string;
|
|
16661
|
+
source: string;
|
|
16662
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16663
|
+
zones: { id: string; name: string }[];
|
|
16664
|
+
lostReason: string;
|
|
16665
|
+
lostReasonNote: string;
|
|
16666
|
+
convertedJobs: { id: string; name: string; date: string }[];
|
|
16667
|
+
timezone: string;
|
|
16668
|
+
lastActivity: string;
|
|
16669
|
+
stageUpdatedAt: string;
|
|
16670
|
+
createdAt: string;
|
|
16671
|
+
updatedAt: string;
|
|
16672
|
+
}[];
|
|
16673
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
14457
16674
|
};
|
|
14458
|
-
export type
|
|
14459
|
-
|
|
16675
|
+
export type WorkBuddyOpportunitiesCreateResponse = {
|
|
16676
|
+
item: {
|
|
14460
16677
|
id: string;
|
|
14461
|
-
|
|
14462
|
-
servicePlanId: string;
|
|
14463
|
-
serviceLineId: string;
|
|
16678
|
+
opportunityNumber: string;
|
|
14464
16679
|
name: string;
|
|
16680
|
+
customer: string;
|
|
16681
|
+
contact: string;
|
|
16682
|
+
site: string;
|
|
16683
|
+
customerSite: string;
|
|
16684
|
+
billingCompany: string;
|
|
16685
|
+
owner: string;
|
|
16686
|
+
areaManager: string;
|
|
16687
|
+
stage: string;
|
|
14465
16688
|
description: string;
|
|
14466
|
-
|
|
14467
|
-
|
|
14468
|
-
|
|
14469
|
-
|
|
14470
|
-
|
|
14471
|
-
|
|
14472
|
-
|
|
14473
|
-
|
|
14474
|
-
|
|
14475
|
-
|
|
14476
|
-
|
|
14477
|
-
|
|
14478
|
-
|
|
14479
|
-
|
|
14480
|
-
|
|
14481
|
-
form?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14482
|
-
file?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14483
|
-
signature?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14484
|
-
comment?: 'Optional' | 'RequiredExceptionAllowed' | 'RequiredNoExceptions';
|
|
14485
|
-
};
|
|
14486
|
-
active: boolean;
|
|
14487
|
-
createdAt?: string;
|
|
14488
|
-
updatedAt?: string;
|
|
16689
|
+
amount: number;
|
|
16690
|
+
probability: number;
|
|
16691
|
+
expectedClose: string;
|
|
16692
|
+
jobType: string;
|
|
16693
|
+
source: string;
|
|
16694
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16695
|
+
zones: { id: string; name: string }[];
|
|
16696
|
+
lostReason: string;
|
|
16697
|
+
lostReasonNote: string;
|
|
16698
|
+
convertedJobs: { id: string; name: string; date: string }[];
|
|
16699
|
+
timezone: string;
|
|
16700
|
+
lastActivity: string;
|
|
16701
|
+
stageUpdatedAt: string;
|
|
16702
|
+
createdAt: string;
|
|
16703
|
+
updatedAt: string;
|
|
14489
16704
|
};
|
|
14490
16705
|
};
|
|
14491
|
-
export type
|
|
14492
|
-
|
|
16706
|
+
export type WorkBuddyOpportunitiesStagesStagesResponse = {
|
|
16707
|
+
items: {
|
|
14493
16708
|
id: string;
|
|
14494
|
-
integrationId?: string;
|
|
14495
|
-
servicePlanId: string;
|
|
14496
|
-
serviceLineId: string;
|
|
14497
16709
|
name: string;
|
|
14498
16710
|
description: string;
|
|
14499
|
-
|
|
14500
|
-
|
|
14501
|
-
|
|
14502
|
-
|
|
14503
|
-
|
|
14504
|
-
|
|
14505
|
-
|
|
14506
|
-
|
|
14507
|
-
|
|
14508
|
-
|
|
14509
|
-
|
|
14510
|
-
|
|
14511
|
-
|
|
14512
|
-
|
|
14513
|
-
|
|
14514
|
-
|
|
14515
|
-
|
|
14516
|
-
|
|
14517
|
-
|
|
14518
|
-
|
|
14519
|
-
|
|
14520
|
-
|
|
14521
|
-
|
|
16711
|
+
systemStage: string;
|
|
16712
|
+
systemName: string;
|
|
16713
|
+
probability: string;
|
|
16714
|
+
}[];
|
|
16715
|
+
};
|
|
16716
|
+
export type WorkBuddyOpportunitiesGetResponse = {
|
|
16717
|
+
item: {
|
|
16718
|
+
id: string;
|
|
16719
|
+
opportunityNumber: string;
|
|
16720
|
+
name: string;
|
|
16721
|
+
customer: string;
|
|
16722
|
+
contact: string;
|
|
16723
|
+
site: string;
|
|
16724
|
+
customerSite: string;
|
|
16725
|
+
billingCompany: string;
|
|
16726
|
+
owner: string;
|
|
16727
|
+
areaManager: string;
|
|
16728
|
+
stage: string;
|
|
16729
|
+
description: string;
|
|
16730
|
+
amount: number;
|
|
16731
|
+
probability: number;
|
|
16732
|
+
expectedClose: string;
|
|
16733
|
+
jobType: string;
|
|
16734
|
+
source: string;
|
|
16735
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16736
|
+
zones: { id: string; name: string }[];
|
|
16737
|
+
lostReason: string;
|
|
16738
|
+
lostReasonNote: string;
|
|
16739
|
+
convertedJobs: { id: string; name: string; date: string }[];
|
|
16740
|
+
timezone: string;
|
|
16741
|
+
lastActivity: string;
|
|
16742
|
+
stageUpdatedAt: string;
|
|
16743
|
+
createdAt: string;
|
|
16744
|
+
updatedAt: string;
|
|
16745
|
+
};
|
|
16746
|
+
};
|
|
16747
|
+
export type WorkBuddyOpportunitiesUpdateResponse = {
|
|
16748
|
+
item: {
|
|
16749
|
+
id: string;
|
|
16750
|
+
opportunityNumber: string;
|
|
16751
|
+
name: string;
|
|
16752
|
+
customer: string;
|
|
16753
|
+
contact: string;
|
|
16754
|
+
site: string;
|
|
16755
|
+
customerSite: string;
|
|
16756
|
+
billingCompany: string;
|
|
16757
|
+
owner: string;
|
|
16758
|
+
areaManager: string;
|
|
16759
|
+
stage: string;
|
|
16760
|
+
description: string;
|
|
16761
|
+
amount: number;
|
|
16762
|
+
probability: number;
|
|
16763
|
+
expectedClose: string;
|
|
16764
|
+
jobType: string;
|
|
16765
|
+
source: string;
|
|
16766
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16767
|
+
zones: { id: string; name: string }[];
|
|
16768
|
+
lostReason: string;
|
|
16769
|
+
lostReasonNote: string;
|
|
16770
|
+
convertedJobs: { id: string; name: string; date: string }[];
|
|
16771
|
+
timezone: string;
|
|
16772
|
+
lastActivity: string;
|
|
16773
|
+
stageUpdatedAt: string;
|
|
16774
|
+
createdAt: string;
|
|
16775
|
+
updatedAt: string;
|
|
16776
|
+
};
|
|
16777
|
+
};
|
|
16778
|
+
export type WorkBuddyOpportunitiesChangeStageChangeStageResponse = {
|
|
16779
|
+
item: {
|
|
16780
|
+
id: string;
|
|
16781
|
+
opportunityNumber: string;
|
|
16782
|
+
name: string;
|
|
16783
|
+
customer: string;
|
|
16784
|
+
contact: string;
|
|
16785
|
+
site: string;
|
|
16786
|
+
customerSite: string;
|
|
16787
|
+
billingCompany: string;
|
|
16788
|
+
owner: string;
|
|
16789
|
+
areaManager: string;
|
|
16790
|
+
stage: string;
|
|
16791
|
+
description: string;
|
|
16792
|
+
amount: number;
|
|
16793
|
+
probability: number;
|
|
16794
|
+
expectedClose: string;
|
|
16795
|
+
jobType: string;
|
|
16796
|
+
source: string;
|
|
16797
|
+
tags: { id: string; name: string; color?: string }[];
|
|
16798
|
+
zones: { id: string; name: string }[];
|
|
16799
|
+
lostReason: string;
|
|
16800
|
+
lostReasonNote: string;
|
|
16801
|
+
convertedJobs: { id: string; name: string; date: string }[];
|
|
16802
|
+
timezone: string;
|
|
16803
|
+
lastActivity: string;
|
|
16804
|
+
stageUpdatedAt: string;
|
|
16805
|
+
createdAt: string;
|
|
16806
|
+
updatedAt: string;
|
|
14522
16807
|
};
|
|
14523
16808
|
};
|
|
14524
16809
|
export type WorkBuddyMcpListResponse = unknown;
|
|
@@ -14526,8 +16811,6 @@ export type WorkBuddyMcpCreateResponse = unknown;
|
|
|
14526
16811
|
export type WorkBuddyMcpDeleteResponse = unknown;
|
|
14527
16812
|
|
|
14528
16813
|
export interface WorkBuddyJobsResource {
|
|
14529
|
-
/** Actions API operations. */
|
|
14530
|
-
actions: WorkBuddyJobsActionsResource;
|
|
14531
16814
|
/** Template API operations. */
|
|
14532
16815
|
template: WorkBuddyJobsTemplateResource;
|
|
14533
16816
|
/** Finance API operations. */
|
|
@@ -14608,26 +16891,6 @@ export interface WorkBuddyJobsResource {
|
|
|
14608
16891
|
): Promise<TResponse>;
|
|
14609
16892
|
}
|
|
14610
16893
|
|
|
14611
|
-
export interface WorkBuddyJobsActionsResource {
|
|
14612
|
-
/**
|
|
14613
|
-
* Metadata actions that can run on one Job: commands (change status, add note) and bulk-updatable fields as set-field actions. Each lists its input JSON Schema, required security rights and whether the UI confirms it first.
|
|
14614
|
-
* Operation: PublicApiJobActionController_list
|
|
14615
|
-
*/
|
|
14616
|
-
list<TResponse = WorkBuddyJobsActionsListResponse>(
|
|
14617
|
-
params?: WorkBuddyJobsActionsListParams,
|
|
14618
|
-
options?: WorkBuddyRequestOptions
|
|
14619
|
-
): Promise<TResponse>;
|
|
14620
|
-
|
|
14621
|
-
/**
|
|
14622
|
-
* Runs one action listed by GET /jobs/actions on a single Job, through the same executor as the board. Actions the UI confirms first run without confirmation here; the caller is authorised by its rights.
|
|
14623
|
-
* Operation: PublicApiJobActionController_run
|
|
14624
|
-
*/
|
|
14625
|
-
run<TResponse = WorkBuddyJobsActionsRunResponse>(
|
|
14626
|
-
params: WorkBuddyJobsActionsRunParams,
|
|
14627
|
-
options?: WorkBuddyRequestOptions
|
|
14628
|
-
): Promise<TResponse>;
|
|
14629
|
-
}
|
|
14630
|
-
|
|
14631
16894
|
export interface WorkBuddyJobsTemplateResource {
|
|
14632
16895
|
/**
|
|
14633
16896
|
* Create a job using a job template. Template-owned fields win over request values before final job validation.
|
|
@@ -15524,6 +17787,15 @@ export interface WorkBuddyJobsContactsResource {
|
|
|
15524
17787
|
}
|
|
15525
17788
|
|
|
15526
17789
|
export interface WorkBuddyItemsResource {
|
|
17790
|
+
/**
|
|
17791
|
+
* Read a line item and its owning Job and Stage IDs.
|
|
17792
|
+
* Operation: PublicApiJobLineItemController_get
|
|
17793
|
+
*/
|
|
17794
|
+
get<TResponse = WorkBuddyItemsGetResponse>(
|
|
17795
|
+
params: WorkBuddyItemsGetParams,
|
|
17796
|
+
options?: WorkBuddyRequestOptions
|
|
17797
|
+
): Promise<TResponse>;
|
|
17798
|
+
|
|
15527
17799
|
/**
|
|
15528
17800
|
* Find a job line item by external integration ID.
|
|
15529
17801
|
* Operation: PublicApiJobLineItemController_list
|
|
@@ -15563,11 +17835,11 @@ export interface WorkBuddyStagesResource {
|
|
|
15563
17835
|
/** Reissue API operations. */
|
|
15564
17836
|
reissue: WorkBuddyStagesReissueResource;
|
|
15565
17837
|
/**
|
|
15566
|
-
*
|
|
15567
|
-
* Operation:
|
|
17838
|
+
* Read a stage, its owning Job ID and its current concurrency token.
|
|
17839
|
+
* Operation: PublicJobStageController_get
|
|
15568
17840
|
*/
|
|
15569
|
-
|
|
15570
|
-
params:
|
|
17841
|
+
get<TResponse = WorkBuddyStagesGetResponse>(
|
|
17842
|
+
params: WorkBuddyStagesGetParams,
|
|
15571
17843
|
options?: WorkBuddyRequestOptions
|
|
15572
17844
|
): Promise<TResponse>;
|
|
15573
17845
|
|
|
@@ -15589,6 +17861,15 @@ export interface WorkBuddyStagesResource {
|
|
|
15589
17861
|
options?: WorkBuddyRequestOptions
|
|
15590
17862
|
): Promise<TResponse>;
|
|
15591
17863
|
|
|
17864
|
+
/**
|
|
17865
|
+
* Create a new stage (work order) within a job. Stages represent discrete phases of work.
|
|
17866
|
+
* Operation: PublicJobStageController_create
|
|
17867
|
+
*/
|
|
17868
|
+
create<TResponse = WorkBuddyStagesCreateResponse>(
|
|
17869
|
+
params: WorkBuddyStagesCreateParams,
|
|
17870
|
+
options?: WorkBuddyRequestOptions
|
|
17871
|
+
): Promise<TResponse>;
|
|
17872
|
+
|
|
15592
17873
|
/**
|
|
15593
17874
|
* Change stage status to dispatched, making it ready for field work.
|
|
15594
17875
|
* Operation: PublicJobStageController_dispatch
|
|
@@ -16830,36 +19111,31 @@ export interface WorkBuddyExportsResource {
|
|
|
16830
19111
|
): Promise<TResponse>;
|
|
16831
19112
|
}
|
|
16832
19113
|
|
|
16833
|
-
export interface
|
|
16834
|
-
/** Runs API operations. */
|
|
16835
|
-
runs: WorkBuddyAgentHarnessRunsResource;
|
|
16836
|
-
}
|
|
16837
|
-
|
|
16838
|
-
export interface WorkBuddyAgentHarnessRunsResource {
|
|
19114
|
+
export interface WorkBuddyExtensionRunsResource {
|
|
16839
19115
|
/** Events API operations. */
|
|
16840
|
-
events:
|
|
19116
|
+
events: WorkBuddyExtensionRunsEventsResource;
|
|
16841
19117
|
/** Action Resolved API operations. */
|
|
16842
|
-
actionResolved:
|
|
19118
|
+
actionResolved: WorkBuddyExtensionRunsActionResolvedResource;
|
|
16843
19119
|
}
|
|
16844
19120
|
|
|
16845
|
-
export interface
|
|
19121
|
+
export interface WorkBuddyExtensionRunsEventsResource {
|
|
16846
19122
|
/**
|
|
16847
19123
|
* Used by an external agent to report progress, action-required, completed, failed, heartbeat, or message events for an existing run.
|
|
16848
|
-
* Operation:
|
|
19124
|
+
* Operation: PublicApiExtensionRunsController_ingestEvent
|
|
16849
19125
|
*/
|
|
16850
|
-
ingestEvent<TResponse =
|
|
16851
|
-
params:
|
|
19126
|
+
ingestEvent<TResponse = WorkBuddyExtensionRunsEventsIngestEventResponse>(
|
|
19127
|
+
params: WorkBuddyExtensionRunsEventsIngestEventParams,
|
|
16852
19128
|
options?: WorkBuddyRequestOptions
|
|
16853
19129
|
): Promise<TResponse>;
|
|
16854
19130
|
}
|
|
16855
19131
|
|
|
16856
|
-
export interface
|
|
19132
|
+
export interface WorkBuddyExtensionRunsActionResolvedResource {
|
|
16857
19133
|
/**
|
|
16858
19134
|
* Used by an external agent to post the resolution payload for a run that previously entered action-required state.
|
|
16859
|
-
* Operation:
|
|
19135
|
+
* Operation: PublicApiExtensionRunsController_resolveAction
|
|
16860
19136
|
*/
|
|
16861
|
-
resolveAction<TResponse =
|
|
16862
|
-
params:
|
|
19137
|
+
resolveAction<TResponse = WorkBuddyExtensionRunsActionResolvedResolveActionResponse>(
|
|
19138
|
+
params: WorkBuddyExtensionRunsActionResolvedResolveActionParams,
|
|
16863
19139
|
options?: WorkBuddyRequestOptions
|
|
16864
19140
|
): Promise<TResponse>;
|
|
16865
19141
|
}
|
|
@@ -16908,8 +19184,19 @@ export interface WorkBuddyServicePlansResource {
|
|
|
16908
19184
|
suspend: WorkBuddyServicePlansSuspendResource;
|
|
16909
19185
|
/** Archive API operations. */
|
|
16910
19186
|
archive: WorkBuddyServicePlansArchiveResource;
|
|
19187
|
+
/** Restore API operations. */
|
|
19188
|
+
restore: WorkBuddyServicePlansRestoreResource;
|
|
16911
19189
|
/** Lines API operations. */
|
|
16912
19190
|
lines: WorkBuddyServicePlansLinesResource;
|
|
19191
|
+
/**
|
|
19192
|
+
* Lists plans, including archived plans, with literal name search and zero-based page pagination.
|
|
19193
|
+
* Operation: PublicServicePlanController_list
|
|
19194
|
+
*/
|
|
19195
|
+
list<TResponse = WorkBuddyServicePlansListResponse>(
|
|
19196
|
+
params?: WorkBuddyServicePlansListParams,
|
|
19197
|
+
options?: WorkBuddyRequestOptions
|
|
19198
|
+
): Promise<TResponse>;
|
|
19199
|
+
|
|
16913
19200
|
/**
|
|
16914
19201
|
* Creates only the Service Plan contract header. Lines and Tasks are added through their nested endpoints.
|
|
16915
19202
|
* Operation: PublicServicePlanController_create
|
|
@@ -16927,6 +19214,24 @@ export interface WorkBuddyServicePlansResource {
|
|
|
16927
19214
|
params: WorkBuddyServicePlansGetParams,
|
|
16928
19215
|
options?: WorkBuddyRequestOptions
|
|
16929
19216
|
): Promise<TResponse>;
|
|
19217
|
+
|
|
19218
|
+
/**
|
|
19219
|
+
* Edits definition fields and Job defaults while Draft or Paused. Dates must preserve descendant bounds. Empty blackoutRanges clears closures; null dateEnd removes the end date. Null clears a Job default; omitted fields remain unchanged. Customer/site identity and lifecycle fields are not writable here.
|
|
19220
|
+
* Operation: PublicServicePlanController_patch
|
|
19221
|
+
*/
|
|
19222
|
+
patch<TResponse = WorkBuddyServicePlansPatchResponse>(
|
|
19223
|
+
params: WorkBuddyServicePlansPatchParams,
|
|
19224
|
+
options?: WorkBuddyRequestOptions
|
|
19225
|
+
): Promise<TResponse>;
|
|
19226
|
+
|
|
19227
|
+
/**
|
|
19228
|
+
* Deletes a plan and its definitions only when the existing domain operational-history guard permits it. Archive plans with history instead.
|
|
19229
|
+
* Operation: PublicServicePlanController_delete
|
|
19230
|
+
*/
|
|
19231
|
+
delete<TResponse = WorkBuddyServicePlansDeleteResponse>(
|
|
19232
|
+
params: WorkBuddyServicePlansDeleteParams,
|
|
19233
|
+
options?: WorkBuddyRequestOptions
|
|
19234
|
+
): Promise<TResponse>;
|
|
16930
19235
|
}
|
|
16931
19236
|
|
|
16932
19237
|
export interface WorkBuddyServicePlansActivateResource {
|
|
@@ -16942,7 +19247,7 @@ export interface WorkBuddyServicePlansActivateResource {
|
|
|
16942
19247
|
|
|
16943
19248
|
export interface WorkBuddyServicePlansSuspendResource {
|
|
16944
19249
|
/**
|
|
16945
|
-
* Stops future scheduled work while preserving history.
|
|
19250
|
+
* Stops future scheduled work while preserving history. Returns execution impact beside data: existing generated Jobs and booked Visits are not cancelled.
|
|
16946
19251
|
* Operation: PublicServicePlanController_suspend
|
|
16947
19252
|
*/
|
|
16948
19253
|
suspend<TResponse = WorkBuddyServicePlansSuspendSuspendResponse>(
|
|
@@ -16962,6 +19267,17 @@ export interface WorkBuddyServicePlansArchiveResource {
|
|
|
16962
19267
|
): Promise<TResponse>;
|
|
16963
19268
|
}
|
|
16964
19269
|
|
|
19270
|
+
export interface WorkBuddyServicePlansRestoreResource {
|
|
19271
|
+
/**
|
|
19272
|
+
* Restores an archived plan to Paused. Starting it remains a separate activate action.
|
|
19273
|
+
* Operation: PublicServicePlanController_restore
|
|
19274
|
+
*/
|
|
19275
|
+
restore<TResponse = WorkBuddyServicePlansRestoreRestoreResponse>(
|
|
19276
|
+
params: WorkBuddyServicePlansRestoreRestoreParams,
|
|
19277
|
+
options?: WorkBuddyRequestOptions
|
|
19278
|
+
): Promise<TResponse>;
|
|
19279
|
+
}
|
|
19280
|
+
|
|
16965
19281
|
export interface WorkBuddyServicePlansLinesResource {
|
|
16966
19282
|
/** Tasks API operations. */
|
|
16967
19283
|
tasks: WorkBuddyServicePlansLinesTasksResource;
|
|
@@ -17000,6 +19316,15 @@ export interface WorkBuddyServicePlansLinesResource {
|
|
|
17000
19316
|
params: WorkBuddyServicePlansLinesPatchParams,
|
|
17001
19317
|
options?: WorkBuddyRequestOptions
|
|
17002
19318
|
): Promise<TResponse>;
|
|
19319
|
+
|
|
19320
|
+
/**
|
|
19321
|
+
* Deletes the line and its Task, Subtask and planned-item definitions using existing domain cascade rules. Started plans remain read-only.
|
|
19322
|
+
* Operation: PublicServiceLineController_delete
|
|
19323
|
+
*/
|
|
19324
|
+
delete<TResponse = WorkBuddyServicePlansLinesDeleteResponse>(
|
|
19325
|
+
params: WorkBuddyServicePlansLinesDeleteParams,
|
|
19326
|
+
options?: WorkBuddyRequestOptions
|
|
19327
|
+
): Promise<TResponse>;
|
|
17003
19328
|
}
|
|
17004
19329
|
|
|
17005
19330
|
export interface WorkBuddyServicePlansLinesTasksResource {
|
|
@@ -17040,6 +19365,15 @@ export interface WorkBuddyServicePlansLinesTasksResource {
|
|
|
17040
19365
|
params: WorkBuddyServicePlansLinesTasksPatchParams,
|
|
17041
19366
|
options?: WorkBuddyRequestOptions
|
|
17042
19367
|
): Promise<TResponse>;
|
|
19368
|
+
|
|
19369
|
+
/**
|
|
19370
|
+
* Deletes the standing Task subtree and lets the existing domain clean up associated items, Visit exceptions and projections. This is not a Visit-specific exclusion.
|
|
19371
|
+
* Operation: PublicServiceLineTaskController_delete
|
|
19372
|
+
*/
|
|
19373
|
+
delete<TResponse = WorkBuddyServicePlansLinesTasksDeleteResponse>(
|
|
19374
|
+
params: WorkBuddyServicePlansLinesTasksDeleteParams,
|
|
19375
|
+
options?: WorkBuddyRequestOptions
|
|
19376
|
+
): Promise<TResponse>;
|
|
17043
19377
|
}
|
|
17044
19378
|
|
|
17045
19379
|
export interface WorkBuddyServicePlansLinesTasksSubtasksResource {
|
|
@@ -17078,6 +19412,148 @@ export interface WorkBuddyServicePlansLinesTasksSubtasksResource {
|
|
|
17078
19412
|
params: WorkBuddyServicePlansLinesTasksSubtasksPatchParams,
|
|
17079
19413
|
options?: WorkBuddyRequestOptions
|
|
17080
19414
|
): Promise<TResponse>;
|
|
19415
|
+
|
|
19416
|
+
/**
|
|
19417
|
+
* Deletes this standing Subtask and any descendants through the existing domain cascade. The root Task remains unchanged.
|
|
19418
|
+
* Operation: PublicServiceLineSubtaskController_delete
|
|
19419
|
+
*/
|
|
19420
|
+
delete<TResponse = WorkBuddyServicePlansLinesTasksSubtasksDeleteResponse>(
|
|
19421
|
+
params: WorkBuddyServicePlansLinesTasksSubtasksDeleteParams,
|
|
19422
|
+
options?: WorkBuddyRequestOptions
|
|
19423
|
+
): Promise<TResponse>;
|
|
19424
|
+
}
|
|
19425
|
+
|
|
19426
|
+
export interface WorkBuddyLeadsResource {
|
|
19427
|
+
/** Convert API operations. */
|
|
19428
|
+
convert: WorkBuddyLeadsConvertResource;
|
|
19429
|
+
/**
|
|
19430
|
+
* List leads
|
|
19431
|
+
* Operation: PublicLeadController_list
|
|
19432
|
+
*/
|
|
19433
|
+
list<TResponse = WorkBuddyLeadsListResponse>(
|
|
19434
|
+
params?: WorkBuddyLeadsListParams,
|
|
19435
|
+
options?: WorkBuddyRequestOptions
|
|
19436
|
+
): Promise<TResponse>;
|
|
19437
|
+
/** Iterate all items by following cursor pagination for list(). */
|
|
19438
|
+
all<TItem = WorkBuddyPageItem<WorkBuddyLeadsListResponse>>(
|
|
19439
|
+
params?: WorkBuddyLeadsListParams,
|
|
19440
|
+
options?: WorkBuddyRequestOptions
|
|
19441
|
+
): AsyncIterable<TItem>;
|
|
19442
|
+
/** Iterate raw pages by following cursor pagination for list(). */
|
|
19443
|
+
pages<TPage = WorkBuddyLeadsListResponse>(
|
|
19444
|
+
params?: WorkBuddyLeadsListParams,
|
|
19445
|
+
options?: WorkBuddyRequestOptions
|
|
19446
|
+
): AsyncIterable<TPage>;
|
|
19447
|
+
/**
|
|
19448
|
+
* Account name, email, phone and contact first/last names are required, as in the UI. Address is optional until conversion.
|
|
19449
|
+
* Operation: PublicLeadController_create
|
|
19450
|
+
*/
|
|
19451
|
+
create<TResponse = WorkBuddyLeadsCreateResponse>(
|
|
19452
|
+
params: WorkBuddyLeadsCreateParams,
|
|
19453
|
+
options?: WorkBuddyRequestOptions
|
|
19454
|
+
): Promise<TResponse>;
|
|
19455
|
+
|
|
19456
|
+
/**
|
|
19457
|
+
* Get lead
|
|
19458
|
+
* Operation: PublicLeadController_get
|
|
19459
|
+
*/
|
|
19460
|
+
get<TResponse = WorkBuddyLeadsGetResponse>(
|
|
19461
|
+
params: WorkBuddyLeadsGetParams,
|
|
19462
|
+
options?: WorkBuddyRequestOptions
|
|
19463
|
+
): Promise<TResponse>;
|
|
19464
|
+
|
|
19465
|
+
/**
|
|
19466
|
+
* Account/contact members merge into their stored snapshots, as in the legacy pipeline. Qualify a lead with the convert operation rather than writing Qualified.
|
|
19467
|
+
* Operation: PublicLeadController_update
|
|
19468
|
+
*/
|
|
19469
|
+
update<TResponse = WorkBuddyLeadsUpdateResponse>(
|
|
19470
|
+
params: WorkBuddyLeadsUpdateParams,
|
|
19471
|
+
options?: WorkBuddyRequestOptions
|
|
19472
|
+
): Promise<TResponse>;
|
|
19473
|
+
}
|
|
19474
|
+
|
|
19475
|
+
export interface WorkBuddyLeadsConvertResource {
|
|
19476
|
+
/**
|
|
19477
|
+
* Creates a CRM customer and optionally an opportunity. Requires leads:write and customer-create permission (crm:write for application tokens). User-linked tokens remain restricted to their user rights. Uses the current Lead address unless one is supplied.
|
|
19478
|
+
* Operation: PublicLeadController_convert
|
|
19479
|
+
*/
|
|
19480
|
+
convert<TResponse = WorkBuddyLeadsConvertConvertResponse>(
|
|
19481
|
+
params: WorkBuddyLeadsConvertConvertParams,
|
|
19482
|
+
options?: WorkBuddyRequestOptions
|
|
19483
|
+
): Promise<TResponse>;
|
|
19484
|
+
}
|
|
19485
|
+
|
|
19486
|
+
export interface WorkBuddyOpportunitiesResource {
|
|
19487
|
+
/** Stages API operations. */
|
|
19488
|
+
stages: WorkBuddyOpportunitiesStagesResource;
|
|
19489
|
+
/** Change Stage API operations. */
|
|
19490
|
+
changeStage: WorkBuddyOpportunitiesChangeStageResource;
|
|
19491
|
+
/**
|
|
19492
|
+
* List opportunities
|
|
19493
|
+
* Operation: PublicOpportunityController_list
|
|
19494
|
+
*/
|
|
19495
|
+
list<TResponse = WorkBuddyOpportunitiesListResponse>(
|
|
19496
|
+
params?: WorkBuddyOpportunitiesListParams,
|
|
19497
|
+
options?: WorkBuddyRequestOptions
|
|
19498
|
+
): Promise<TResponse>;
|
|
19499
|
+
/** Iterate all items by following cursor pagination for list(). */
|
|
19500
|
+
all<TItem = WorkBuddyPageItem<WorkBuddyOpportunitiesListResponse>>(
|
|
19501
|
+
params?: WorkBuddyOpportunitiesListParams,
|
|
19502
|
+
options?: WorkBuddyRequestOptions
|
|
19503
|
+
): AsyncIterable<TItem>;
|
|
19504
|
+
/** Iterate raw pages by following cursor pagination for list(). */
|
|
19505
|
+
pages<TPage = WorkBuddyOpportunitiesListResponse>(
|
|
19506
|
+
params?: WorkBuddyOpportunitiesListParams,
|
|
19507
|
+
options?: WorkBuddyRequestOptions
|
|
19508
|
+
): AsyncIterable<TPage>;
|
|
19509
|
+
/**
|
|
19510
|
+
* Requires name, customerId, billingCompanyId and ownerId. Site/contact are optional. Omitted stage uses the pipeline New-stage default.
|
|
19511
|
+
* Operation: PublicOpportunityController_create
|
|
19512
|
+
*/
|
|
19513
|
+
create<TResponse = WorkBuddyOpportunitiesCreateResponse>(
|
|
19514
|
+
params: WorkBuddyOpportunitiesCreateParams,
|
|
19515
|
+
options?: WorkBuddyRequestOptions
|
|
19516
|
+
): Promise<TResponse>;
|
|
19517
|
+
|
|
19518
|
+
/**
|
|
19519
|
+
* Get opportunity
|
|
19520
|
+
* Operation: PublicOpportunityController_get
|
|
19521
|
+
*/
|
|
19522
|
+
get<TResponse = WorkBuddyOpportunitiesGetResponse>(
|
|
19523
|
+
params: WorkBuddyOpportunitiesGetParams,
|
|
19524
|
+
options?: WorkBuddyRequestOptions
|
|
19525
|
+
): Promise<TResponse>;
|
|
19526
|
+
|
|
19527
|
+
/**
|
|
19528
|
+
* Updates ordinary fields, including on closed Opportunities. Use change-stage for stage transitions. Sites merge using the existing pipeline behaviour.
|
|
19529
|
+
* Operation: PublicOpportunityController_update
|
|
19530
|
+
*/
|
|
19531
|
+
update<TResponse = WorkBuddyOpportunitiesUpdateResponse>(
|
|
19532
|
+
params: WorkBuddyOpportunitiesUpdateParams,
|
|
19533
|
+
options?: WorkBuddyRequestOptions
|
|
19534
|
+
): Promise<TResponse>;
|
|
19535
|
+
}
|
|
19536
|
+
|
|
19537
|
+
export interface WorkBuddyOpportunitiesStagesResource {
|
|
19538
|
+
/**
|
|
19539
|
+
* Configured Open/Closed stages, including New, Won and Lost. Use these IDs for creation and change-stage.
|
|
19540
|
+
* Operation: PublicOpportunityController_stages
|
|
19541
|
+
*/
|
|
19542
|
+
stages<TResponse = WorkBuddyOpportunitiesStagesStagesResponse>(
|
|
19543
|
+
params?: WorkBuddyOpportunitiesStagesStagesParams,
|
|
19544
|
+
options?: WorkBuddyRequestOptions
|
|
19545
|
+
): Promise<TResponse>;
|
|
19546
|
+
}
|
|
19547
|
+
|
|
19548
|
+
export interface WorkBuddyOpportunitiesChangeStageResource {
|
|
19549
|
+
/**
|
|
19550
|
+
* Supports reopening. Closing requires Mark Opportunities; Lost also requires a Lost Reason. Stage probability and quote-close effects follow the existing pipeline.
|
|
19551
|
+
* Operation: PublicOpportunityController_changeStage
|
|
19552
|
+
*/
|
|
19553
|
+
changeStage<TResponse = WorkBuddyOpportunitiesChangeStageChangeStageResponse>(
|
|
19554
|
+
params: WorkBuddyOpportunitiesChangeStageChangeStageParams,
|
|
19555
|
+
options?: WorkBuddyRequestOptions
|
|
19556
|
+
): Promise<TResponse>;
|
|
17081
19557
|
}
|
|
17082
19558
|
|
|
17083
19559
|
export interface WorkBuddyMcpResource {
|