@workbuddy/sdk-js-vnext 1.0.58 → 1.0.60

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.
Files changed (3) hide show
  1. package/index.d.ts +236 -423
  2. package/index.js +98 -173
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1235,10 +1235,6 @@ export interface WorkBuddyStagesCreateParams extends WorkBuddyRequestParams {
1235
1235
  * Work category ID — use /settings/work-types to look up
1236
1236
  */
1237
1237
  workCategoryId?: string;
1238
- /**
1239
- * Display order / sequence number
1240
- */
1241
- sequence?: number;
1242
1238
  /**
1243
1239
  * Start date (ISO 8601 datetime)
1244
1240
  */
@@ -1467,9 +1463,9 @@ export interface WorkBuddyJobsStagesResourcesStatusUpdateStatusParams extends Wo
1467
1463
 
1468
1464
  export interface WorkBuddySettingsEntityStatusesListParams extends WorkBuddyRequestParams {
1469
1465
  /**
1470
- * Entity type (customer, contractor, supplier)
1466
+ * Entity type (customer, contractor, supplier, contact, external-user)
1471
1467
  */
1472
- entity: 'customer' | 'contractor' | 'supplier';
1468
+ entity: 'customer' | 'contractor' | 'supplier' | 'contact' | 'external-user';
1473
1469
  }
1474
1470
 
1475
1471
  export interface WorkBuddySettingsJobStatusesListParams extends WorkBuddyRequestParams {}
@@ -1754,6 +1750,10 @@ export interface WorkBuddySettingsCustomFieldsAccountsListAccountCustomFieldsPar
1754
1750
 
1755
1751
  export interface WorkBuddySettingsCustomFieldsItemsListItemCustomFieldsParams extends WorkBuddyRequestParams {}
1756
1752
 
1753
+ export interface WorkBuddySettingsRolesClientPortalListParams extends WorkBuddyRequestParams {}
1754
+
1755
+ export interface WorkBuddySettingsRolesContractorPortalListParams extends WorkBuddyRequestParams {}
1756
+
1757
1757
  export interface WorkBuddyAttachmentsCreateUploadSessionParams extends WorkBuddyRequestParams {
1758
1758
  fileName: string;
1759
1759
 
@@ -2810,52 +2810,8 @@ export interface WorkBuddyCrmCustomersContactsCreateContactParams extends WorkBu
2810
2810
  roleId?: string;
2811
2811
 
2812
2812
  sendEmail?: boolean;
2813
- }
2814
-
2815
- export interface WorkBuddyCrmCustomersContactsGetContactParams extends WorkBuddyRequestParams {
2816
- /**
2817
- * Customer ID
2818
- */
2819
- customerId: string;
2820
- /**
2821
- * Contact ID
2822
- */
2823
- contactId: string;
2824
- }
2825
-
2826
- export interface WorkBuddyCrmCustomersContactsUpdateContactParams extends WorkBuddyRequestParams {
2827
- /**
2828
- * Customer ID
2829
- */
2830
- customerId: string;
2831
- /**
2832
- * Contact ID
2833
- */
2834
- contactId: string;
2835
-
2836
- firstName?: string;
2837
-
2838
- lastName?: string;
2839
- /**
2840
- * Email address
2841
- */
2842
- email?: string;
2843
- /**
2844
- * Phone number
2845
- */
2846
- phone?: string;
2847
- /**
2848
- * Mobile phone number
2849
- */
2850
- mobile?: string;
2851
-
2852
- title?: string;
2853
2813
 
2854
- note?: string;
2855
- /**
2856
- * integration ID
2857
- */
2858
- integrationId?: string;
2814
+ autoDispatch?: boolean;
2859
2815
  }
2860
2816
 
2861
2817
  export interface WorkBuddyCrmCustomersContactsDeleteContactParams extends WorkBuddyRequestParams {
@@ -2885,33 +2841,11 @@ export interface WorkBuddyCrmCustomersContactsInviteInviteContactParams extends
2885
2841
  /**
2886
2842
  * role ID
2887
2843
  */
2888
- roleId?: string;
2844
+ roleId: string;
2889
2845
 
2890
2846
  sendEmail?: boolean;
2891
2847
  }
2892
2848
 
2893
- export interface WorkBuddyCrmCustomersContactsActivateActivateContactParams extends WorkBuddyRequestParams {
2894
- /**
2895
- * Customer ID
2896
- */
2897
- customerId: string;
2898
- /**
2899
- * Contact ID
2900
- */
2901
- contactId: string;
2902
- }
2903
-
2904
- export interface WorkBuddyCrmCustomersContactsDeactivateDeactivateContactParams extends WorkBuddyRequestParams {
2905
- /**
2906
- * Customer ID
2907
- */
2908
- customerId: string;
2909
- /**
2910
- * Contact ID
2911
- */
2912
- contactId: string;
2913
- }
2914
-
2915
2849
  export interface WorkBuddyCrmCustomersSitesListParams extends WorkBuddyRequestParams {
2916
2850
  /**
2917
2851
  * Customer ID
@@ -3139,52 +3073,8 @@ export interface WorkBuddyCrmContractorsContactsCreateContactParams extends Work
3139
3073
  roleId?: string;
3140
3074
 
3141
3075
  sendEmail?: boolean;
3142
- }
3143
-
3144
- export interface WorkBuddyCrmContractorsContactsGetContactParams extends WorkBuddyRequestParams {
3145
- /**
3146
- * Contractor ID
3147
- */
3148
- contractorId: string;
3149
- /**
3150
- * Contact ID
3151
- */
3152
- contactId: string;
3153
- }
3154
-
3155
- export interface WorkBuddyCrmContractorsContactsUpdateContactParams extends WorkBuddyRequestParams {
3156
- /**
3157
- * Contractor ID
3158
- */
3159
- contractorId: string;
3160
- /**
3161
- * Contact ID
3162
- */
3163
- contactId: string;
3164
-
3165
- firstName?: string;
3166
-
3167
- lastName?: string;
3168
- /**
3169
- * Email address
3170
- */
3171
- email?: string;
3172
- /**
3173
- * Phone number
3174
- */
3175
- phone?: string;
3176
- /**
3177
- * Mobile phone number
3178
- */
3179
- mobile?: string;
3180
3076
 
3181
- title?: string;
3182
-
3183
- note?: string;
3184
- /**
3185
- * integration ID
3186
- */
3187
- integrationId?: string;
3077
+ autoDispatch?: boolean;
3188
3078
  }
3189
3079
 
3190
3080
  export interface WorkBuddyCrmContractorsContactsDeleteContactParams extends WorkBuddyRequestParams {
@@ -3214,33 +3104,11 @@ export interface WorkBuddyCrmContractorsContactsInviteInviteContactParams extend
3214
3104
  /**
3215
3105
  * role ID
3216
3106
  */
3217
- roleId?: string;
3107
+ roleId: string;
3218
3108
 
3219
3109
  sendEmail?: boolean;
3220
3110
  }
3221
3111
 
3222
- export interface WorkBuddyCrmContractorsContactsActivateActivateContactParams extends WorkBuddyRequestParams {
3223
- /**
3224
- * Contractor ID
3225
- */
3226
- contractorId: string;
3227
- /**
3228
- * Contact ID
3229
- */
3230
- contactId: string;
3231
- }
3232
-
3233
- export interface WorkBuddyCrmContractorsContactsDeactivateDeactivateContactParams extends WorkBuddyRequestParams {
3234
- /**
3235
- * Contractor ID
3236
- */
3237
- contractorId: string;
3238
- /**
3239
- * Contact ID
3240
- */
3241
- contactId: string;
3242
- }
3243
-
3244
3112
  export interface WorkBuddyCrmSuppliersListParams extends WorkBuddyRequestParams {
3245
3113
  /**
3246
3114
  * Search by name, phone, email or legal name
@@ -3446,6 +3314,52 @@ export interface WorkBuddyCrmContactsGetParams extends WorkBuddyRequestParams {
3446
3314
  id: string;
3447
3315
  }
3448
3316
 
3317
+ export interface WorkBuddyCrmContactsUpdateParams extends WorkBuddyRequestParams {
3318
+ /**
3319
+ * Contact ID
3320
+ */
3321
+ id: string;
3322
+
3323
+ firstName?: string;
3324
+
3325
+ lastName?: string;
3326
+ /**
3327
+ * Email address
3328
+ */
3329
+ email?: string;
3330
+ /**
3331
+ * Phone number
3332
+ */
3333
+ phone?: string;
3334
+ /**
3335
+ * Mobile phone number
3336
+ */
3337
+ mobile?: string;
3338
+
3339
+ title?: string;
3340
+
3341
+ note?: string;
3342
+ /**
3343
+ * integration ID
3344
+ */
3345
+ integrationId?: string;
3346
+
3347
+ autoDispatch?: boolean;
3348
+ }
3349
+
3350
+ export interface WorkBuddyCrmContactsStatusUpdateStatusParams extends WorkBuddyRequestParams {
3351
+ /**
3352
+ * Contact ID
3353
+ */
3354
+ id: string;
3355
+ /**
3356
+ * status ID
3357
+ */
3358
+ statusId: string;
3359
+
3360
+ note?: string;
3361
+ }
3362
+
3449
3363
  export interface WorkBuddyCrmInvitesListParams extends WorkBuddyRequestParams {
3450
3364
  cursor?: string;
3451
3365
 
@@ -3695,7 +3609,7 @@ export type WorkBuddyJobsSearchResponse = {
3695
3609
  job?: { id: string; jobNumber: string; description?: string };
3696
3610
  name?: string;
3697
3611
  status: { id?: string; name?: string; systemStatus: string };
3698
- sequence?: number;
3612
+ sequence?: string;
3699
3613
  owner?: string;
3700
3614
  contractor?: string;
3701
3615
  technician?: string;
@@ -3776,7 +3690,7 @@ export type WorkBuddyJobsGetResponse = {
3776
3690
  job?: { id: string; jobNumber: string; description?: string };
3777
3691
  name?: string;
3778
3692
  status: { id?: string; name?: string; systemStatus: string };
3779
- sequence?: number;
3693
+ sequence?: string;
3780
3694
  owner?: string;
3781
3695
  contractor?: string;
3782
3696
  technician?: string;
@@ -3856,7 +3770,7 @@ export type WorkBuddyJobsCreateResponse = {
3856
3770
  job?: { id: string; jobNumber: string; description?: string };
3857
3771
  name?: string;
3858
3772
  status: { id?: string; name?: string; systemStatus: string };
3859
- sequence?: number;
3773
+ sequence?: string;
3860
3774
  owner?: string;
3861
3775
  contractor?: string;
3862
3776
  technician?: string;
@@ -3935,7 +3849,7 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
3935
3849
  job?: { id: string; jobNumber: string; description?: string };
3936
3850
  name?: string;
3937
3851
  status: { id?: string; name?: string; systemStatus: string };
3938
- sequence?: number;
3852
+ sequence?: string;
3939
3853
  owner?: string;
3940
3854
  contractor?: string;
3941
3855
  technician?: string;
@@ -4014,7 +3928,7 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
4014
3928
  job?: { id: string; jobNumber: string; description?: string };
4015
3929
  name?: string;
4016
3930
  status: { id?: string; name?: string; systemStatus: string };
4017
- sequence?: number;
3931
+ sequence?: string;
4018
3932
  owner?: string;
4019
3933
  contractor?: string;
4020
3934
  technician?: string;
@@ -4093,7 +4007,7 @@ export type WorkBuddyJobsUpdateResponse = {
4093
4007
  job?: { id: string; jobNumber: string; description?: string };
4094
4008
  name?: string;
4095
4009
  status: { id?: string; name?: string; systemStatus: string };
4096
- sequence?: number;
4010
+ sequence?: string;
4097
4011
  owner?: string;
4098
4012
  contractor?: string;
4099
4013
  technician?: string;
@@ -4172,7 +4086,7 @@ export type WorkBuddyJobsDispatchResponse = {
4172
4086
  job?: { id: string; jobNumber: string; description?: string };
4173
4087
  name?: string;
4174
4088
  status: { id?: string; name?: string; systemStatus: string };
4175
- sequence?: number;
4089
+ sequence?: string;
4176
4090
  owner?: string;
4177
4091
  contractor?: string;
4178
4092
  technician?: string;
@@ -4225,7 +4139,7 @@ export type WorkBuddyJobsStagesListResponse = {
4225
4139
  jobId: string;
4226
4140
  name?: string;
4227
4141
  status: { id?: string; name?: string; systemStatus: string };
4228
- sequence?: number;
4142
+ sequence?: string;
4229
4143
  contractor?: string;
4230
4144
  technician?: string;
4231
4145
  startDate?: string;
@@ -4242,7 +4156,7 @@ export type WorkBuddyJobsStagesGetJobStageResponse = {
4242
4156
  job?: { id: string; jobNumber: string; description?: string };
4243
4157
  name?: string;
4244
4158
  status: { id?: string; name?: string; systemStatus: string };
4245
- sequence?: number;
4159
+ sequence?: string;
4246
4160
  owner?: string;
4247
4161
  contractor?: string;
4248
4162
  technician?: string;
@@ -4397,7 +4311,7 @@ export type WorkBuddyStagesCreateResponse = {
4397
4311
  job?: { id: string; jobNumber: string; description?: string };
4398
4312
  name?: string;
4399
4313
  status: { id?: string; name?: string; systemStatus: string };
4400
- sequence?: number;
4314
+ sequence?: string;
4401
4315
  owner?: string;
4402
4316
  contractor?: string;
4403
4317
  technician?: string;
@@ -4443,7 +4357,7 @@ export type WorkBuddyStagesUpdateResponse = {
4443
4357
  job?: { id: string; jobNumber: string; description?: string };
4444
4358
  name?: string;
4445
4359
  status: { id?: string; name?: string; systemStatus: string };
4446
- sequence?: number;
4360
+ sequence?: string;
4447
4361
  owner?: string;
4448
4362
  contractor?: string;
4449
4363
  technician?: string;
@@ -4490,7 +4404,7 @@ export type WorkBuddyStagesDispatchResponse = {
4490
4404
  job?: { id: string; jobNumber: string; description?: string };
4491
4405
  name?: string;
4492
4406
  status: { id?: string; name?: string; systemStatus: string };
4493
- sequence?: number;
4407
+ sequence?: string;
4494
4408
  owner?: string;
4495
4409
  contractor?: string;
4496
4410
  technician?: string;
@@ -4536,7 +4450,7 @@ export type WorkBuddyStagesCompleteCompleteResponse = {
4536
4450
  job?: { id: string; jobNumber: string; description?: string };
4537
4451
  name?: string;
4538
4452
  status: { id?: string; name?: string; systemStatus: string };
4539
- sequence?: number;
4453
+ sequence?: string;
4540
4454
  owner?: string;
4541
4455
  contractor?: string;
4542
4456
  technician?: string;
@@ -4582,7 +4496,7 @@ export type WorkBuddyStagesFinaliseFinaliseResponse = {
4582
4496
  job?: { id: string; jobNumber: string; description?: string };
4583
4497
  name?: string;
4584
4498
  status: { id?: string; name?: string; systemStatus: string };
4585
- sequence?: number;
4499
+ sequence?: string;
4586
4500
  owner?: string;
4587
4501
  contractor?: string;
4588
4502
  technician?: string;
@@ -4628,7 +4542,7 @@ export type WorkBuddyStagesCancelCancelResponse = {
4628
4542
  job?: { id: string; jobNumber: string; description?: string };
4629
4543
  name?: string;
4630
4544
  status: { id?: string; name?: string; systemStatus: string };
4631
- sequence?: number;
4545
+ sequence?: string;
4632
4546
  owner?: string;
4633
4547
  contractor?: string;
4634
4548
  technician?: string;
@@ -4674,7 +4588,7 @@ export type WorkBuddyStagesReverseReverseResponse = {
4674
4588
  job?: { id: string; jobNumber: string; description?: string };
4675
4589
  name?: string;
4676
4590
  status: { id?: string; name?: string; systemStatus: string };
4677
- sequence?: number;
4591
+ sequence?: string;
4678
4592
  owner?: string;
4679
4593
  contractor?: string;
4680
4594
  technician?: string;
@@ -5033,6 +4947,12 @@ export type WorkBuddySettingsCustomFieldsItemsListItemCustomFieldsResponse = {
5033
4947
  sortOrder?: number;
5034
4948
  }[];
5035
4949
  };
4950
+ export type WorkBuddySettingsRolesClientPortalListResponse = {
4951
+ items: { id: string; name: string; type: string; system: boolean }[];
4952
+ };
4953
+ export type WorkBuddySettingsRolesContractorPortalListResponse = {
4954
+ items: { id: string; name: string; type: string; system: boolean }[];
4955
+ };
5036
4956
  export type WorkBuddyAttachmentsCreateUploadSessionResponse = {
5037
4957
  uploadUrl: string;
5038
4958
  headers: { 'x-ms-blob-type': string; 'Content-Type': string };
@@ -5102,9 +5022,11 @@ export type WorkBuddyCrmCustomersListResponse = {
5102
5022
  phone?: string;
5103
5023
  mobile?: string;
5104
5024
  email?: string;
5025
+ username?: string;
5105
5026
  login?: boolean;
5106
5027
  invitePending?: boolean;
5107
- locked?: boolean;
5028
+ autoDispatch?: string;
5029
+ status?: string;
5108
5030
  note?: string;
5109
5031
  }[];
5110
5032
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5218,9 +5140,11 @@ export type WorkBuddyCrmCustomersContactsListResponse = {
5218
5140
  phone?: string;
5219
5141
  mobile?: string;
5220
5142
  email?: string;
5143
+ username?: string;
5221
5144
  login?: boolean;
5222
5145
  invitePending?: boolean;
5223
- locked?: boolean;
5146
+ autoDispatch?: string;
5147
+ status?: string;
5224
5148
  note?: string;
5225
5149
  }[];
5226
5150
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5238,47 +5162,11 @@ export type WorkBuddyCrmCustomersContactsCreateContactResponse = {
5238
5162
  phone?: string;
5239
5163
  mobile?: string;
5240
5164
  email?: string;
5165
+ username?: string;
5241
5166
  login?: boolean;
5242
5167
  invitePending?: boolean;
5243
- locked?: boolean;
5244
- note?: string;
5245
- };
5246
- };
5247
- export type WorkBuddyCrmCustomersContactsGetContactResponse = {
5248
- item: {
5249
- id: string;
5250
- name: string;
5251
- type: string;
5252
- firstName?: string;
5253
- lastName?: string;
5254
- title?: string;
5255
- integrationId?: string;
5256
- address?: string;
5257
- phone?: string;
5258
- mobile?: string;
5259
- email?: string;
5260
- login?: boolean;
5261
- invitePending?: boolean;
5262
- locked?: boolean;
5263
- note?: string;
5264
- };
5265
- };
5266
- export type WorkBuddyCrmCustomersContactsUpdateContactResponse = {
5267
- item: {
5268
- id: string;
5269
- name: string;
5270
- type: string;
5271
- firstName?: string;
5272
- lastName?: string;
5273
- title?: string;
5274
- integrationId?: string;
5275
- address?: string;
5276
- phone?: string;
5277
- mobile?: string;
5278
- email?: string;
5279
- login?: boolean;
5280
- invitePending?: boolean;
5281
- locked?: boolean;
5168
+ autoDispatch?: string;
5169
+ status?: string;
5282
5170
  note?: string;
5283
5171
  };
5284
5172
  };
@@ -5296,47 +5184,11 @@ export type WorkBuddyCrmCustomersContactsInviteInviteContactResponse = {
5296
5184
  phone?: string;
5297
5185
  mobile?: string;
5298
5186
  email?: string;
5187
+ username?: string;
5299
5188
  login?: boolean;
5300
5189
  invitePending?: boolean;
5301
- locked?: boolean;
5302
- note?: string;
5303
- };
5304
- };
5305
- export type WorkBuddyCrmCustomersContactsActivateActivateContactResponse = {
5306
- item: {
5307
- id: string;
5308
- name: string;
5309
- type: string;
5310
- firstName?: string;
5311
- lastName?: string;
5312
- title?: string;
5313
- integrationId?: string;
5314
- address?: string;
5315
- phone?: string;
5316
- mobile?: string;
5317
- email?: string;
5318
- login?: boolean;
5319
- invitePending?: boolean;
5320
- locked?: boolean;
5321
- note?: string;
5322
- };
5323
- };
5324
- export type WorkBuddyCrmCustomersContactsDeactivateDeactivateContactResponse = {
5325
- item: {
5326
- id: string;
5327
- name: string;
5328
- type: string;
5329
- firstName?: string;
5330
- lastName?: string;
5331
- title?: string;
5332
- integrationId?: string;
5333
- address?: string;
5334
- phone?: string;
5335
- mobile?: string;
5336
- email?: string;
5337
- login?: boolean;
5338
- invitePending?: boolean;
5339
- locked?: boolean;
5190
+ autoDispatch?: string;
5191
+ status?: string;
5340
5192
  note?: string;
5341
5193
  };
5342
5194
  };
@@ -5357,9 +5209,11 @@ export type WorkBuddyCrmEmployeesListResponse = {
5357
5209
  phone?: string;
5358
5210
  mobile?: string;
5359
5211
  email?: string;
5212
+ username?: string;
5360
5213
  login?: boolean;
5361
5214
  invitePending?: boolean;
5362
- locked?: boolean;
5215
+ autoDispatch?: string;
5216
+ status?: string;
5363
5217
  note?: string;
5364
5218
  }[];
5365
5219
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5377,9 +5231,11 @@ export type WorkBuddyCrmEmployeesGetResponse = {
5377
5231
  phone?: string;
5378
5232
  mobile?: string;
5379
5233
  email?: string;
5234
+ username?: string;
5380
5235
  login?: boolean;
5381
5236
  invitePending?: boolean;
5382
- locked?: boolean;
5237
+ autoDispatch?: string;
5238
+ status?: string;
5383
5239
  note?: string;
5384
5240
  };
5385
5241
  };
@@ -5396,9 +5252,11 @@ export type WorkBuddyCrmContractorsListResponse = {
5396
5252
  phone?: string;
5397
5253
  mobile?: string;
5398
5254
  email?: string;
5255
+ username?: string;
5399
5256
  login?: boolean;
5400
5257
  invitePending?: boolean;
5401
- locked?: boolean;
5258
+ autoDispatch?: string;
5259
+ status?: string;
5402
5260
  note?: string;
5403
5261
  }[];
5404
5262
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5544,9 +5402,11 @@ export type WorkBuddyCrmContractorsContactsListResponse = {
5544
5402
  phone?: string;
5545
5403
  mobile?: string;
5546
5404
  email?: string;
5405
+ username?: string;
5547
5406
  login?: boolean;
5548
5407
  invitePending?: boolean;
5549
- locked?: boolean;
5408
+ autoDispatch?: string;
5409
+ status?: string;
5550
5410
  note?: string;
5551
5411
  }[];
5552
5412
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5564,47 +5424,11 @@ export type WorkBuddyCrmContractorsContactsCreateContactResponse = {
5564
5424
  phone?: string;
5565
5425
  mobile?: string;
5566
5426
  email?: string;
5427
+ username?: string;
5567
5428
  login?: boolean;
5568
5429
  invitePending?: boolean;
5569
- locked?: boolean;
5570
- note?: string;
5571
- };
5572
- };
5573
- export type WorkBuddyCrmContractorsContactsGetContactResponse = {
5574
- item: {
5575
- id: string;
5576
- name: string;
5577
- type: string;
5578
- firstName?: string;
5579
- lastName?: string;
5580
- title?: string;
5581
- integrationId?: string;
5582
- address?: string;
5583
- phone?: string;
5584
- mobile?: string;
5585
- email?: string;
5586
- login?: boolean;
5587
- invitePending?: boolean;
5588
- locked?: boolean;
5589
- note?: string;
5590
- };
5591
- };
5592
- export type WorkBuddyCrmContractorsContactsUpdateContactResponse = {
5593
- item: {
5594
- id: string;
5595
- name: string;
5596
- type: string;
5597
- firstName?: string;
5598
- lastName?: string;
5599
- title?: string;
5600
- integrationId?: string;
5601
- address?: string;
5602
- phone?: string;
5603
- mobile?: string;
5604
- email?: string;
5605
- login?: boolean;
5606
- invitePending?: boolean;
5607
- locked?: boolean;
5430
+ autoDispatch?: string;
5431
+ status?: string;
5608
5432
  note?: string;
5609
5433
  };
5610
5434
  };
@@ -5622,47 +5446,11 @@ export type WorkBuddyCrmContractorsContactsInviteInviteContactResponse = {
5622
5446
  phone?: string;
5623
5447
  mobile?: string;
5624
5448
  email?: string;
5449
+ username?: string;
5625
5450
  login?: boolean;
5626
5451
  invitePending?: boolean;
5627
- locked?: boolean;
5628
- note?: string;
5629
- };
5630
- };
5631
- export type WorkBuddyCrmContractorsContactsActivateActivateContactResponse = {
5632
- item: {
5633
- id: string;
5634
- name: string;
5635
- type: string;
5636
- firstName?: string;
5637
- lastName?: string;
5638
- title?: string;
5639
- integrationId?: string;
5640
- address?: string;
5641
- phone?: string;
5642
- mobile?: string;
5643
- email?: string;
5644
- login?: boolean;
5645
- invitePending?: boolean;
5646
- locked?: boolean;
5647
- note?: string;
5648
- };
5649
- };
5650
- export type WorkBuddyCrmContractorsContactsDeactivateDeactivateContactResponse = {
5651
- item: {
5652
- id: string;
5653
- name: string;
5654
- type: string;
5655
- firstName?: string;
5656
- lastName?: string;
5657
- title?: string;
5658
- integrationId?: string;
5659
- address?: string;
5660
- phone?: string;
5661
- mobile?: string;
5662
- email?: string;
5663
- login?: boolean;
5664
- invitePending?: boolean;
5665
- locked?: boolean;
5452
+ autoDispatch?: string;
5453
+ status?: string;
5666
5454
  note?: string;
5667
5455
  };
5668
5456
  };
@@ -5679,9 +5467,11 @@ export type WorkBuddyCrmSuppliersListResponse = {
5679
5467
  phone?: string;
5680
5468
  mobile?: string;
5681
5469
  email?: string;
5470
+ username?: string;
5682
5471
  login?: boolean;
5683
5472
  invitePending?: boolean;
5684
- locked?: boolean;
5473
+ autoDispatch?: string;
5474
+ status?: string;
5685
5475
  note?: string;
5686
5476
  }[];
5687
5477
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5830,9 +5620,11 @@ export type WorkBuddyCrmCompaniesListResponse = {
5830
5620
  address?: string;
5831
5621
  phone?: string;
5832
5622
  email?: string;
5623
+ username?: string;
5833
5624
  login?: boolean;
5834
5625
  invitePending?: boolean;
5835
- locked?: boolean;
5626
+ autoDispatch?: string;
5627
+ status?: string;
5836
5628
  note?: string;
5837
5629
  }[];
5838
5630
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5849,9 +5641,11 @@ export type WorkBuddyCrmCompaniesGetResponse = {
5849
5641
  address?: string;
5850
5642
  phone?: string;
5851
5643
  email?: string;
5644
+ username?: string;
5852
5645
  login?: boolean;
5853
5646
  invitePending?: boolean;
5854
- locked?: boolean;
5647
+ autoDispatch?: string;
5648
+ status?: string;
5855
5649
  note?: string;
5856
5650
  };
5857
5651
  };
@@ -5868,9 +5662,11 @@ export type WorkBuddyCrmExternalUsersListResponse = {
5868
5662
  phone?: string;
5869
5663
  mobile?: string;
5870
5664
  email?: string;
5665
+ username?: string;
5871
5666
  login?: boolean;
5872
5667
  invitePending?: boolean;
5873
- locked?: boolean;
5668
+ autoDispatch?: string;
5669
+ status?: string;
5874
5670
  note?: string;
5875
5671
  }[];
5876
5672
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5888,9 +5684,11 @@ export type WorkBuddyCrmExternalUsersGetResponse = {
5888
5684
  phone?: string;
5889
5685
  mobile?: string;
5890
5686
  email?: string;
5687
+ username?: string;
5891
5688
  login?: boolean;
5892
5689
  invitePending?: boolean;
5893
- locked?: boolean;
5690
+ autoDispatch?: string;
5691
+ status?: string;
5894
5692
  note?: string;
5895
5693
  };
5896
5694
  };
@@ -5907,9 +5705,11 @@ export type WorkBuddyCrmContactsListResponse = {
5907
5705
  phone?: string;
5908
5706
  mobile?: string;
5909
5707
  email?: string;
5708
+ username?: string;
5910
5709
  login?: boolean;
5911
5710
  invitePending?: boolean;
5912
- locked?: boolean;
5711
+ autoDispatch?: string;
5712
+ status?: string;
5913
5713
  note?: string;
5914
5714
  }[];
5915
5715
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5927,9 +5727,53 @@ export type WorkBuddyCrmContactsGetResponse = {
5927
5727
  phone?: string;
5928
5728
  mobile?: string;
5929
5729
  email?: string;
5730
+ username?: string;
5731
+ login?: boolean;
5732
+ invitePending?: boolean;
5733
+ autoDispatch?: string;
5734
+ status?: string;
5735
+ note?: string;
5736
+ };
5737
+ };
5738
+ export type WorkBuddyCrmContactsUpdateResponse = {
5739
+ item: {
5740
+ id: string;
5741
+ name: string;
5742
+ type: string;
5743
+ firstName?: string;
5744
+ lastName?: string;
5745
+ title?: string;
5746
+ integrationId?: string;
5747
+ address?: string;
5748
+ phone?: string;
5749
+ mobile?: string;
5750
+ email?: string;
5751
+ username?: string;
5752
+ login?: boolean;
5753
+ invitePending?: boolean;
5754
+ autoDispatch?: string;
5755
+ status?: string;
5756
+ note?: string;
5757
+ };
5758
+ };
5759
+ export type WorkBuddyCrmContactsStatusUpdateStatusResponse = {
5760
+ item: {
5761
+ id: string;
5762
+ name: string;
5763
+ type: string;
5764
+ firstName?: string;
5765
+ lastName?: string;
5766
+ title?: string;
5767
+ integrationId?: string;
5768
+ address?: string;
5769
+ phone?: string;
5770
+ mobile?: string;
5771
+ email?: string;
5772
+ username?: string;
5930
5773
  login?: boolean;
5931
5774
  invitePending?: boolean;
5932
- locked?: boolean;
5775
+ autoDispatch?: string;
5776
+ status?: string;
5933
5777
  note?: string;
5934
5778
  };
5935
5779
  };
@@ -5946,9 +5790,11 @@ export type WorkBuddyCrmInvitesListResponse = {
5946
5790
  phone?: string;
5947
5791
  mobile?: string;
5948
5792
  email?: string;
5793
+ username?: string;
5949
5794
  login?: boolean;
5950
5795
  invitePending?: boolean;
5951
- locked?: boolean;
5796
+ autoDispatch?: string;
5797
+ status?: string;
5952
5798
  note?: string;
5953
5799
  }[];
5954
5800
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5966,9 +5812,11 @@ export type WorkBuddyCrmInvitesGetResponse = {
5966
5812
  phone?: string;
5967
5813
  mobile?: string;
5968
5814
  email?: string;
5815
+ username?: string;
5969
5816
  login?: boolean;
5970
5817
  invitePending?: boolean;
5971
- locked?: boolean;
5818
+ autoDispatch?: string;
5819
+ status?: string;
5972
5820
  note?: string;
5973
5821
  };
5974
5822
  };
@@ -6906,11 +6754,13 @@ export interface WorkBuddySettingsResource {
6906
6754
  uoms: WorkBuddySettingsUomsResource;
6907
6755
  /** Custom Fields API operations. */
6908
6756
  customFields: WorkBuddySettingsCustomFieldsResource;
6757
+ /** Roles API operations. */
6758
+ roles: WorkBuddySettingsRolesResource;
6909
6759
  }
6910
6760
 
6911
6761
  export interface WorkBuddySettingsEntityStatusesResource {
6912
6762
  /**
6913
- * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier
6763
+ * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user
6914
6764
  * Operation: PublicApiEntityStatusController_list
6915
6765
  */
6916
6766
  list<TResponse = WorkBuddySettingsEntityStatusesListResponse>(
@@ -7178,6 +7028,35 @@ export interface WorkBuddySettingsCustomFieldsItemsResource {
7178
7028
  ): Promise<TResponse>;
7179
7029
  }
7180
7030
 
7031
+ export interface WorkBuddySettingsRolesResource {
7032
+ /** Client Portal API operations. */
7033
+ clientPortal: WorkBuddySettingsRolesClientPortalResource;
7034
+ /** Contractor Portal API operations. */
7035
+ contractorPortal: WorkBuddySettingsRolesContractorPortalResource;
7036
+ }
7037
+
7038
+ export interface WorkBuddySettingsRolesClientPortalResource {
7039
+ /**
7040
+ * Roles assignable to customer login contacts (UserType.Client). Includes custom client roles; includes built-in system client roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.
7041
+ * Operation: PublicApiPortalRoleController_listClientPortal
7042
+ */
7043
+ list<TResponse = WorkBuddySettingsRolesClientPortalListResponse>(
7044
+ params?: WorkBuddySettingsRolesClientPortalListParams,
7045
+ options?: WorkBuddyRequestOptions
7046
+ ): Promise<TResponse>;
7047
+ }
7048
+
7049
+ export interface WorkBuddySettingsRolesContractorPortalResource {
7050
+ /**
7051
+ * Roles assignable to contractor login contacts (UserType.Subcontractor). Includes custom contractor roles; includes built-in system contractor roles only when Enable System Security Roles is on for the tenant. Use item.id as roleId when login is true on contact create/invite.
7052
+ * Operation: PublicApiPortalRoleController_listContractorPortal
7053
+ */
7054
+ list<TResponse = WorkBuddySettingsRolesContractorPortalListResponse>(
7055
+ params?: WorkBuddySettingsRolesContractorPortalListParams,
7056
+ options?: WorkBuddyRequestOptions
7057
+ ): Promise<TResponse>;
7058
+ }
7059
+
7181
7060
  export interface WorkBuddyAttachmentsResource {
7182
7061
  /**
7183
7062
  * Creates an upload session and returns a SAS URL for direct upload to Azure Blob Storage.
@@ -7304,10 +7183,6 @@ export interface WorkBuddyCrmCustomersStatusResource {
7304
7183
  export interface WorkBuddyCrmCustomersContactsResource {
7305
7184
  /** Invite API operations. */
7306
7185
  invite: WorkBuddyCrmCustomersContactsInviteResource;
7307
- /** Activate API operations. */
7308
- activate: WorkBuddyCrmCustomersContactsActivateResource;
7309
- /** Deactivate API operations. */
7310
- deactivate: WorkBuddyCrmCustomersContactsDeactivateResource;
7311
7186
  /**
7312
7187
  * List contacts for customer (contacts + external users)
7313
7188
  * Operation: PublicCrmCustomerController_listContacts
@@ -7327,7 +7202,7 @@ export interface WorkBuddyCrmCustomersContactsResource {
7327
7202
  options?: WorkBuddyRequestOptions
7328
7203
  ): AsyncIterable<TPage>;
7329
7204
  /**
7330
- * Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
7205
+ * Create customer contact
7331
7206
  * Operation: PublicCrmCustomerController_createContact
7332
7207
  */
7333
7208
  createContact<TResponse = WorkBuddyCrmCustomersContactsCreateContactResponse>(
@@ -7335,24 +7210,6 @@ export interface WorkBuddyCrmCustomersContactsResource {
7335
7210
  options?: WorkBuddyRequestOptions
7336
7211
  ): Promise<TResponse>;
7337
7212
 
7338
- /**
7339
- * Get customer contact by ID
7340
- * Operation: PublicCrmCustomerController_getContact
7341
- */
7342
- getContact<TResponse = WorkBuddyCrmCustomersContactsGetContactResponse>(
7343
- params: WorkBuddyCrmCustomersContactsGetContactParams,
7344
- options?: WorkBuddyRequestOptions
7345
- ): Promise<TResponse>;
7346
-
7347
- /**
7348
- * Update customer contact
7349
- * Operation: PublicCrmCustomerController_updateContact
7350
- */
7351
- updateContact<TResponse = WorkBuddyCrmCustomersContactsUpdateContactResponse>(
7352
- params: WorkBuddyCrmCustomersContactsUpdateContactParams,
7353
- options?: WorkBuddyRequestOptions
7354
- ): Promise<TResponse>;
7355
-
7356
7213
  /**
7357
7214
  * Delete customer contact
7358
7215
  * Operation: PublicCrmCustomerController_deleteContact
@@ -7365,7 +7222,7 @@ export interface WorkBuddyCrmCustomersContactsResource {
7365
7222
 
7366
7223
  export interface WorkBuddyCrmCustomersContactsInviteResource {
7367
7224
  /**
7368
- * Promote an existing contact to external user and send invite (CRM)
7225
+ * Invite contact (CRM)
7369
7226
  * Operation: PublicCrmCustomerController_inviteContact
7370
7227
  */
7371
7228
  inviteContact<TResponse = WorkBuddyCrmCustomersContactsInviteInviteContactResponse>(
@@ -7374,28 +7231,6 @@ export interface WorkBuddyCrmCustomersContactsInviteResource {
7374
7231
  ): Promise<TResponse>;
7375
7232
  }
7376
7233
 
7377
- export interface WorkBuddyCrmCustomersContactsActivateResource {
7378
- /**
7379
- * Unlock portal login for an external user (CRM)
7380
- * Operation: PublicCrmCustomerController_activateContact
7381
- */
7382
- activateContact<TResponse = WorkBuddyCrmCustomersContactsActivateActivateContactResponse>(
7383
- params: WorkBuddyCrmCustomersContactsActivateActivateContactParams,
7384
- options?: WorkBuddyRequestOptions
7385
- ): Promise<TResponse>;
7386
- }
7387
-
7388
- export interface WorkBuddyCrmCustomersContactsDeactivateResource {
7389
- /**
7390
- * Lock portal login for an external user (CRM)
7391
- * Operation: PublicCrmCustomerController_deactivateContact
7392
- */
7393
- deactivateContact<TResponse = WorkBuddyCrmCustomersContactsDeactivateDeactivateContactResponse>(
7394
- params: WorkBuddyCrmCustomersContactsDeactivateDeactivateContactParams,
7395
- options?: WorkBuddyRequestOptions
7396
- ): Promise<TResponse>;
7397
- }
7398
-
7399
7234
  export interface WorkBuddyCrmCustomersSitesResource {
7400
7235
  /**
7401
7236
  * List sites for customer
@@ -7511,10 +7346,6 @@ export interface WorkBuddyCrmContractorsStatusResource {
7511
7346
  export interface WorkBuddyCrmContractorsContactsResource {
7512
7347
  /** Invite API operations. */
7513
7348
  invite: WorkBuddyCrmContractorsContactsInviteResource;
7514
- /** Activate API operations. */
7515
- activate: WorkBuddyCrmContractorsContactsActivateResource;
7516
- /** Deactivate API operations. */
7517
- deactivate: WorkBuddyCrmContractorsContactsDeactivateResource;
7518
7349
  /**
7519
7350
  * List contacts for contractor (contacts + external users)
7520
7351
  * Operation: PublicCrmContractorController_listContacts
@@ -7534,7 +7365,7 @@ export interface WorkBuddyCrmContractorsContactsResource {
7534
7365
  options?: WorkBuddyRequestOptions
7535
7366
  ): AsyncIterable<TPage>;
7536
7367
  /**
7537
- * Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
7368
+ * Create contractor contact
7538
7369
  * Operation: PublicCrmContractorController_createContact
7539
7370
  */
7540
7371
  createContact<TResponse = WorkBuddyCrmContractorsContactsCreateContactResponse>(
@@ -7542,24 +7373,6 @@ export interface WorkBuddyCrmContractorsContactsResource {
7542
7373
  options?: WorkBuddyRequestOptions
7543
7374
  ): Promise<TResponse>;
7544
7375
 
7545
- /**
7546
- * Get contractor contact by ID
7547
- * Operation: PublicCrmContractorController_getContact
7548
- */
7549
- getContact<TResponse = WorkBuddyCrmContractorsContactsGetContactResponse>(
7550
- params: WorkBuddyCrmContractorsContactsGetContactParams,
7551
- options?: WorkBuddyRequestOptions
7552
- ): Promise<TResponse>;
7553
-
7554
- /**
7555
- * Update contractor contact
7556
- * Operation: PublicCrmContractorController_updateContact
7557
- */
7558
- updateContact<TResponse = WorkBuddyCrmContractorsContactsUpdateContactResponse>(
7559
- params: WorkBuddyCrmContractorsContactsUpdateContactParams,
7560
- options?: WorkBuddyRequestOptions
7561
- ): Promise<TResponse>;
7562
-
7563
7376
  /**
7564
7377
  * Delete contractor contact
7565
7378
  * Operation: PublicCrmContractorController_deleteContact
@@ -7572,7 +7385,7 @@ export interface WorkBuddyCrmContractorsContactsResource {
7572
7385
 
7573
7386
  export interface WorkBuddyCrmContractorsContactsInviteResource {
7574
7387
  /**
7575
- * Promote an existing contact to external user and send invite (CRM > Contractors)
7388
+ * Invite contact (CRM > Contractors)
7576
7389
  * Operation: PublicCrmContractorController_inviteContact
7577
7390
  */
7578
7391
  inviteContact<TResponse = WorkBuddyCrmContractorsContactsInviteInviteContactResponse>(
@@ -7581,28 +7394,6 @@ export interface WorkBuddyCrmContractorsContactsInviteResource {
7581
7394
  ): Promise<TResponse>;
7582
7395
  }
7583
7396
 
7584
- export interface WorkBuddyCrmContractorsContactsActivateResource {
7585
- /**
7586
- * Unlock portal login for an external user (CRM > Contractors)
7587
- * Operation: PublicCrmContractorController_activateContact
7588
- */
7589
- activateContact<TResponse = WorkBuddyCrmContractorsContactsActivateActivateContactResponse>(
7590
- params: WorkBuddyCrmContractorsContactsActivateActivateContactParams,
7591
- options?: WorkBuddyRequestOptions
7592
- ): Promise<TResponse>;
7593
- }
7594
-
7595
- export interface WorkBuddyCrmContractorsContactsDeactivateResource {
7596
- /**
7597
- * Lock portal login for an external user (CRM > Contractors)
7598
- * Operation: PublicCrmContractorController_deactivateContact
7599
- */
7600
- deactivateContact<TResponse = WorkBuddyCrmContractorsContactsDeactivateDeactivateContactResponse>(
7601
- params: WorkBuddyCrmContractorsContactsDeactivateDeactivateContactParams,
7602
- options?: WorkBuddyRequestOptions
7603
- ): Promise<TResponse>;
7604
- }
7605
-
7606
7397
  export interface WorkBuddyCrmSuppliersResource {
7607
7398
  /** Status API operations. */
7608
7399
  status: WorkBuddyCrmSuppliersStatusResource;
@@ -7722,8 +7513,10 @@ export interface WorkBuddyCrmExternalUsersResource {
7722
7513
  }
7723
7514
 
7724
7515
  export interface WorkBuddyCrmContactsResource {
7516
+ /** Status API operations. */
7517
+ status: WorkBuddyCrmContactsStatusResource;
7725
7518
  /**
7726
- * List contacts (Basic and Login contacts)
7519
+ * List contacts (contacts + external users)
7727
7520
  * Operation: PublicCrmContactController_list
7728
7521
  */
7729
7522
  list<TResponse = WorkBuddyCrmContactsListResponse>(
@@ -7748,6 +7541,26 @@ export interface WorkBuddyCrmContactsResource {
7748
7541
  params: WorkBuddyCrmContactsGetParams,
7749
7542
  options?: WorkBuddyRequestOptions
7750
7543
  ): Promise<TResponse>;
7544
+
7545
+ /**
7546
+ * Update contact
7547
+ * Operation: PublicCrmContactController_update
7548
+ */
7549
+ update<TResponse = WorkBuddyCrmContactsUpdateResponse>(
7550
+ params: WorkBuddyCrmContactsUpdateParams,
7551
+ options?: WorkBuddyRequestOptions
7552
+ ): Promise<TResponse>;
7553
+ }
7554
+
7555
+ export interface WorkBuddyCrmContactsStatusResource {
7556
+ /**
7557
+ * Update contact status
7558
+ * Operation: PublicCrmContactController_updateStatus
7559
+ */
7560
+ updateStatus<TResponse = WorkBuddyCrmContactsStatusUpdateStatusResponse>(
7561
+ params: WorkBuddyCrmContactsStatusUpdateStatusParams,
7562
+ options?: WorkBuddyRequestOptions
7563
+ ): Promise<TResponse>;
7751
7564
  }
7752
7565
 
7753
7566
  export interface WorkBuddyCrmInvitesResource {