@workbuddy/sdk-js-vnext 1.0.32 → 1.0.33

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 +85 -166
  2. package/index.js +7 -5
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -1243,10 +1243,6 @@ export interface WorkBuddyStagesCreateParams extends WorkBuddyRequestParams {
1243
1243
  * Due date (ISO 8601 datetime)
1244
1244
  */
1245
1245
  dueDate?: string;
1246
- /**
1247
- * Additional notes or comments
1248
- */
1249
- notes?: string;
1250
1246
  /**
1251
1247
  * Custom fields as key-value pairs — validated against tenant field definitions
1252
1248
  */
@@ -1274,10 +1270,6 @@ export interface WorkBuddyStagesUpdateParams extends WorkBuddyRequestParams {
1274
1270
  * Due date (ISO 8601 datetime)
1275
1271
  */
1276
1272
  dueDate?: string;
1277
- /**
1278
- * Additional notes or comments
1279
- */
1280
- notes?: string;
1281
1273
  /**
1282
1274
  * Tag operation — use set, add, or remove (mutually exclusive: set vs add/remove)
1283
1275
  */
@@ -1473,7 +1465,7 @@ export interface WorkBuddySettingsEntityStatusesListParams extends WorkBuddyRequ
1473
1465
  /**
1474
1466
  * Entity type (customer, contractor, supplier)
1475
1467
  */
1476
- entity: string;
1468
+ entity: 'customer' | 'contractor' | 'supplier';
1477
1469
  }
1478
1470
 
1479
1471
  export interface WorkBuddySettingsJobStatusesListParams extends WorkBuddyRequestParams {}
@@ -1509,91 +1501,14 @@ export interface WorkBuddySettingsTemplatesSmsListSmsTemplatesParams extends Wor
1509
1501
  export interface WorkBuddySettingsItemsListParams extends WorkBuddyRequestParams {}
1510
1502
 
1511
1503
  export interface WorkBuddySettingsItemsCreateParams extends WorkBuddyRequestParams {
1512
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
1513
- /**
1514
- * Display name
1515
- */
1516
- name: string;
1517
- /**
1518
- * base uom ID
1519
- */
1520
- baseUomId?: string;
1521
-
1522
- baseUomName?: string;
1523
- /**
1524
- * Detailed description
1525
- */
1526
- description: string;
1527
-
1528
- category: { categoryId?: string; categoryName?: string; subCategoryId?: string; subCategoryName?: string };
1529
- /**
1530
- * Whether the entity is active
1531
- */
1532
- active?: boolean;
1533
- /**
1534
- * integration ID
1535
- */
1536
- integrationId?: string;
1537
-
1538
- canOverrideDesc?: boolean;
1539
-
1540
- longDescription?: string;
1541
-
1542
- manufacturer?: string;
1543
-
1544
- retailPrice?: number;
1545
-
1546
- tradePrice?: number;
1547
-
1548
- standardCost?: number;
1549
-
1550
- economicOrderQty?: number;
1551
-
1552
- safetyStockQty?: number;
1553
-
1554
- leadTimeDays?: number;
1555
-
1556
- upc?: string;
1557
-
1558
- itemSold?: boolean;
1559
-
1560
- saleGlCode?: string;
1561
- /**
1562
- * sale tax rate ID
1563
- */
1564
- saleTaxRateId?: string;
1565
-
1566
- saleTaxRateName?: string;
1567
-
1568
- itemPurchased?: boolean;
1569
-
1570
- purchaseGlCode?: string;
1571
- /**
1572
- * purchase tax rate ID
1573
- */
1574
- purchaseTaxRateId?: string;
1575
-
1576
- purchaseTaxRateName?: string;
1577
-
1578
- codeInvoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
1579
-
1580
- suppliedBySubcontractor?: boolean;
1581
-
1582
- autoCreateTask?: boolean;
1583
1504
  /**
1584
- * Custom fields as key-value pairs — validated against tenant field definitions
1505
+ * Request body.
1585
1506
  */
1586
- customFields?: string;
1587
-
1588
- trackingCategory1?: string;
1589
-
1590
- trackingCategory2?: string;
1591
-
1592
- uoms?: { uomId?: string; uomName?: string; conversionRate: number }[];
1507
+ body: unknown;
1593
1508
  }
1594
1509
 
1595
1510
  export interface WorkBuddySettingsItemsUpsertParams extends WorkBuddyRequestParams {
1596
- type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
1511
+ type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
1597
1512
  /**
1598
1513
  * Display name
1599
1514
  */
@@ -1689,7 +1604,7 @@ export interface WorkBuddySettingsItemsUpdateParams extends WorkBuddyRequestPara
1689
1604
  */
1690
1605
  id: string;
1691
1606
 
1692
- type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
1607
+ type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
1693
1608
  /**
1694
1609
  * Display name
1695
1610
  */
@@ -1779,7 +1694,20 @@ export interface WorkBuddySettingsItemsDeleteParams extends WorkBuddyRequestPara
1779
1694
  id: string;
1780
1695
  }
1781
1696
 
1782
- export interface WorkBuddySettingsItemCategoriesListParams extends WorkBuddyRequestParams {}
1697
+ export interface WorkBuddySettingsItemCategoriesListParams extends WorkBuddyRequestParams {
1698
+ /**
1699
+ * Alias for search
1700
+ */
1701
+ id?: string;
1702
+ /**
1703
+ * Alias for search
1704
+ */
1705
+ name?: string;
1706
+ /**
1707
+ * Filter by category/sub-category name or id
1708
+ */
1709
+ search?: string;
1710
+ }
1783
1711
 
1784
1712
  export interface WorkBuddySettingsItemCategoriesUpsertParams extends WorkBuddyRequestParams {
1785
1713
  /**
@@ -1841,7 +1769,7 @@ export interface WorkBuddyJobsActivitiesGetParams extends WorkBuddyRequestParams
1841
1769
 
1842
1770
  export interface WorkBuddyJobsActivitiesDeleteParams extends WorkBuddyRequestParams {
1843
1771
  /**
1844
- * Job ID or job number (e.g. J12345)
1772
+ * Job ID
1845
1773
  */
1846
1774
  jobId: string;
1847
1775
  /**
@@ -1959,7 +1887,7 @@ export interface WorkBuddyJobsActivitiesPhoneCreatePhoneParams extends WorkBuddy
1959
1887
  /**
1960
1888
  * call date (ISO 8601 datetime)
1961
1889
  */
1962
- callDate?: string;
1890
+ callDate: string;
1963
1891
  /**
1964
1892
  * Message body content (HTML supported for email)
1965
1893
  */
@@ -2039,7 +1967,9 @@ export interface WorkBuddyJobsStagesActivitiesDeleteParams extends WorkBuddyRequ
2039
1967
  * Activity ID
2040
1968
  */
2041
1969
  id: string;
2042
-
1970
+ /**
1971
+ * Job ID
1972
+ */
2043
1973
  jobId: string;
2044
1974
  }
2045
1975
 
@@ -2162,7 +2092,7 @@ export interface WorkBuddyJobsStagesActivitiesPhoneCreatePhoneParams extends Wor
2162
2092
  /**
2163
2093
  * call date (ISO 8601 datetime)
2164
2094
  */
2165
- callDate?: string;
2095
+ callDate: string;
2166
2096
  /**
2167
2097
  * Message body content (HTML supported for email)
2168
2098
  */
@@ -2713,7 +2643,6 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2713
2643
  suburb?: string;
2714
2644
  state?: string;
2715
2645
  postalCode?: string;
2716
- postcode?: string;
2717
2646
  country?: string;
2718
2647
  lat?: number;
2719
2648
  lgn?: number;
@@ -2723,6 +2652,10 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2723
2652
  * Inline contact object — alternative to contactId
2724
2653
  */
2725
2654
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
2655
+ /**
2656
+ * Additional notes or comments
2657
+ */
2658
+ notes?: string;
2726
2659
  /**
2727
2660
  * Custom fields as key-value pairs — validated against tenant field definitions
2728
2661
  */
@@ -2730,7 +2663,7 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2730
2663
 
2731
2664
  type: 'Service Provider' | 'Business' | 'Residential';
2732
2665
 
2733
- socialNetwork?: Record<string, unknown>;
2666
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2734
2667
  }
2735
2668
 
2736
2669
  export interface WorkBuddyCrmCustomersGetParams extends WorkBuddyRequestParams {
@@ -2773,7 +2706,6 @@ export interface WorkBuddyCrmCustomersUpdateParams extends WorkBuddyRequestParam
2773
2706
  suburb?: string;
2774
2707
  state?: string;
2775
2708
  postalCode?: string;
2776
- postcode?: string;
2777
2709
  country?: string;
2778
2710
  lat?: number;
2779
2711
  lgn?: number;
@@ -2786,15 +2718,15 @@ export interface WorkBuddyCrmCustomersUpdateParams extends WorkBuddyRequestParam
2786
2718
 
2787
2719
  labels?: Record<string, unknown>[];
2788
2720
  /**
2789
- * Detailed description
2721
+ * Additional notes or comments
2790
2722
  */
2791
- description?: string;
2723
+ notes?: string;
2792
2724
  /**
2793
2725
  * Custom fields as key-value pairs — validated against tenant field definitions
2794
2726
  */
2795
2727
  customFields?: Record<string, unknown>;
2796
2728
 
2797
- socialNetwork?: Record<string, unknown>;
2729
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2798
2730
  }
2799
2731
 
2800
2732
  export interface WorkBuddyCrmCustomersStatusUpdateStatusParams extends WorkBuddyRequestParams {
@@ -2885,7 +2817,6 @@ export interface WorkBuddyCrmContractorsCreateParams extends WorkBuddyRequestPar
2885
2817
  suburb?: string;
2886
2818
  state?: string;
2887
2819
  postalCode?: string;
2888
- postcode?: string;
2889
2820
  country?: string;
2890
2821
  lat?: number;
2891
2822
  lgn?: number;
@@ -2895,11 +2826,17 @@ export interface WorkBuddyCrmContractorsCreateParams extends WorkBuddyRequestPar
2895
2826
  * Inline contact object — alternative to contactId
2896
2827
  */
2897
2828
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
2829
+ /**
2830
+ * Additional notes or comments
2831
+ */
2832
+ notes?: string;
2898
2833
  /**
2899
2834
  * Custom fields as key-value pairs — validated against tenant field definitions
2900
2835
  */
2901
2836
  customFields?: Record<string, unknown>;
2902
2837
 
2838
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2839
+
2903
2840
  hidePrices?: boolean;
2904
2841
  }
2905
2842
 
@@ -2943,7 +2880,6 @@ export interface WorkBuddyCrmContractorsUpdateParams extends WorkBuddyRequestPar
2943
2880
  suburb?: string;
2944
2881
  state?: string;
2945
2882
  postalCode?: string;
2946
- postcode?: string;
2947
2883
  country?: string;
2948
2884
  lat?: number;
2949
2885
  lgn?: number;
@@ -2956,14 +2892,16 @@ export interface WorkBuddyCrmContractorsUpdateParams extends WorkBuddyRequestPar
2956
2892
 
2957
2893
  labels?: Record<string, unknown>[];
2958
2894
  /**
2959
- * Detailed description
2895
+ * Additional notes or comments
2960
2896
  */
2961
- description?: string;
2897
+ notes?: string;
2962
2898
  /**
2963
2899
  * Custom fields as key-value pairs — validated against tenant field definitions
2964
2900
  */
2965
2901
  customFields?: Record<string, unknown>;
2966
2902
 
2903
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2904
+
2967
2905
  zones?: Record<string, unknown>[];
2968
2906
 
2969
2907
  companies?: Record<string, unknown>[];
@@ -3034,7 +2972,6 @@ export interface WorkBuddyCrmSuppliersCreateParams extends WorkBuddyRequestParam
3034
2972
  suburb?: string;
3035
2973
  state?: string;
3036
2974
  postalCode?: string;
3037
- postcode?: string;
3038
2975
  country?: string;
3039
2976
  lat?: number;
3040
2977
  lgn?: number;
@@ -3044,10 +2981,16 @@ export interface WorkBuddyCrmSuppliersCreateParams extends WorkBuddyRequestParam
3044
2981
  * Inline contact object — alternative to contactId
3045
2982
  */
3046
2983
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
2984
+ /**
2985
+ * Additional notes or comments
2986
+ */
2987
+ notes?: string;
3047
2988
  /**
3048
2989
  * Custom fields as key-value pairs — validated against tenant field definitions
3049
2990
  */
3050
2991
  customFields?: Record<string, unknown>;
2992
+
2993
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
3051
2994
  /**
3052
2995
  * tax ID
3053
2996
  */
@@ -3094,7 +3037,6 @@ export interface WorkBuddyCrmSuppliersUpdateParams extends WorkBuddyRequestParam
3094
3037
  suburb?: string;
3095
3038
  state?: string;
3096
3039
  postalCode?: string;
3097
- postcode?: string;
3098
3040
  country?: string;
3099
3041
  lat?: number;
3100
3042
  lgn?: number;
@@ -3107,14 +3049,16 @@ export interface WorkBuddyCrmSuppliersUpdateParams extends WorkBuddyRequestParam
3107
3049
 
3108
3050
  labels?: Record<string, unknown>[];
3109
3051
  /**
3110
- * Detailed description
3052
+ * Additional notes or comments
3111
3053
  */
3112
- description?: string;
3054
+ notes?: string;
3113
3055
  /**
3114
3056
  * Custom fields as key-value pairs — validated against tenant field definitions
3115
3057
  */
3116
3058
  customFields?: Record<string, unknown>;
3117
3059
 
3060
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
3061
+
3118
3062
  zones?: Record<string, unknown>[];
3119
3063
 
3120
3064
  workCategories?: Record<string, unknown>[];
@@ -3441,7 +3385,6 @@ export type WorkBuddyJobsSearchResponse = {
3441
3385
  jobId: string;
3442
3386
  job?: { id: string; jobNumber: string; description?: string };
3443
3387
  name?: string;
3444
- description?: string;
3445
3388
  status: { id?: string; name?: string; systemStatus: string };
3446
3389
  sequence?: number;
3447
3390
  owner?: string;
@@ -3454,7 +3397,6 @@ export type WorkBuddyJobsSearchResponse = {
3454
3397
  completedBy?: string;
3455
3398
  completedNote?: string;
3456
3399
  finalisedDate?: string;
3457
- notes?: string;
3458
3400
  tags?: string;
3459
3401
  systemTags?: string;
3460
3402
  schedulingTags?: string;
@@ -3524,7 +3466,6 @@ export type WorkBuddyJobsGetResponse = {
3524
3466
  jobId: string;
3525
3467
  job?: { id: string; jobNumber: string; description?: string };
3526
3468
  name?: string;
3527
- description?: string;
3528
3469
  status: { id?: string; name?: string; systemStatus: string };
3529
3470
  sequence?: number;
3530
3471
  owner?: string;
@@ -3537,7 +3478,6 @@ export type WorkBuddyJobsGetResponse = {
3537
3478
  completedBy?: string;
3538
3479
  completedNote?: string;
3539
3480
  finalisedDate?: string;
3540
- notes?: string;
3541
3481
  tags?: string;
3542
3482
  systemTags?: string;
3543
3483
  schedulingTags?: string;
@@ -3606,7 +3546,6 @@ export type WorkBuddyJobsCreateResponse = {
3606
3546
  jobId: string;
3607
3547
  job?: { id: string; jobNumber: string; description?: string };
3608
3548
  name?: string;
3609
- description?: string;
3610
3549
  status: { id?: string; name?: string; systemStatus: string };
3611
3550
  sequence?: number;
3612
3551
  owner?: string;
@@ -3619,7 +3558,6 @@ export type WorkBuddyJobsCreateResponse = {
3619
3558
  completedBy?: string;
3620
3559
  completedNote?: string;
3621
3560
  finalisedDate?: string;
3622
- notes?: string;
3623
3561
  tags?: string;
3624
3562
  systemTags?: string;
3625
3563
  schedulingTags?: string;
@@ -3687,7 +3625,6 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
3687
3625
  jobId: string;
3688
3626
  job?: { id: string; jobNumber: string; description?: string };
3689
3627
  name?: string;
3690
- description?: string;
3691
3628
  status: { id?: string; name?: string; systemStatus: string };
3692
3629
  sequence?: number;
3693
3630
  owner?: string;
@@ -3700,7 +3637,6 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
3700
3637
  completedBy?: string;
3701
3638
  completedNote?: string;
3702
3639
  finalisedDate?: string;
3703
- notes?: string;
3704
3640
  tags?: string;
3705
3641
  systemTags?: string;
3706
3642
  schedulingTags?: string;
@@ -3768,7 +3704,6 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
3768
3704
  jobId: string;
3769
3705
  job?: { id: string; jobNumber: string; description?: string };
3770
3706
  name?: string;
3771
- description?: string;
3772
3707
  status: { id?: string; name?: string; systemStatus: string };
3773
3708
  sequence?: number;
3774
3709
  owner?: string;
@@ -3781,7 +3716,6 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
3781
3716
  completedBy?: string;
3782
3717
  completedNote?: string;
3783
3718
  finalisedDate?: string;
3784
- notes?: string;
3785
3719
  tags?: string;
3786
3720
  systemTags?: string;
3787
3721
  schedulingTags?: string;
@@ -3849,7 +3783,6 @@ export type WorkBuddyJobsUpdateResponse = {
3849
3783
  jobId: string;
3850
3784
  job?: { id: string; jobNumber: string; description?: string };
3851
3785
  name?: string;
3852
- description?: string;
3853
3786
  status: { id?: string; name?: string; systemStatus: string };
3854
3787
  sequence?: number;
3855
3788
  owner?: string;
@@ -3862,7 +3795,6 @@ export type WorkBuddyJobsUpdateResponse = {
3862
3795
  completedBy?: string;
3863
3796
  completedNote?: string;
3864
3797
  finalisedDate?: string;
3865
- notes?: string;
3866
3798
  tags?: string;
3867
3799
  systemTags?: string;
3868
3800
  schedulingTags?: string;
@@ -3930,7 +3862,6 @@ export type WorkBuddyJobsDispatchResponse = {
3930
3862
  jobId: string;
3931
3863
  job?: { id: string; jobNumber: string; description?: string };
3932
3864
  name?: string;
3933
- description?: string;
3934
3865
  status: { id?: string; name?: string; systemStatus: string };
3935
3866
  sequence?: number;
3936
3867
  owner?: string;
@@ -3943,7 +3874,6 @@ export type WorkBuddyJobsDispatchResponse = {
3943
3874
  completedBy?: string;
3944
3875
  completedNote?: string;
3945
3876
  finalisedDate?: string;
3946
- notes?: string;
3947
3877
  tags?: string;
3948
3878
  systemTags?: string;
3949
3879
  schedulingTags?: string;
@@ -3985,7 +3915,6 @@ export type WorkBuddyJobsStagesListResponse = {
3985
3915
  stageNumber: string;
3986
3916
  jobId: string;
3987
3917
  name?: string;
3988
- description?: string;
3989
3918
  status: { id?: string; name?: string; systemStatus: string };
3990
3919
  sequence?: number;
3991
3920
  contractor?: string;
@@ -4003,7 +3932,6 @@ export type WorkBuddyJobsStagesGetJobStageResponse = {
4003
3932
  jobId: string;
4004
3933
  job?: { id: string; jobNumber: string; description?: string };
4005
3934
  name?: string;
4006
- description?: string;
4007
3935
  status: { id?: string; name?: string; systemStatus: string };
4008
3936
  sequence?: number;
4009
3937
  owner?: string;
@@ -4016,7 +3944,6 @@ export type WorkBuddyJobsStagesGetJobStageResponse = {
4016
3944
  completedBy?: string;
4017
3945
  completedNote?: string;
4018
3946
  finalisedDate?: string;
4019
- notes?: string;
4020
3947
  tags?: string;
4021
3948
  systemTags?: string;
4022
3949
  schedulingTags?: string;
@@ -4160,7 +4087,6 @@ export type WorkBuddyStagesCreateResponse = {
4160
4087
  jobId: string;
4161
4088
  job?: { id: string; jobNumber: string; description?: string };
4162
4089
  name?: string;
4163
- description?: string;
4164
4090
  status: { id?: string; name?: string; systemStatus: string };
4165
4091
  sequence?: number;
4166
4092
  owner?: string;
@@ -4173,7 +4099,6 @@ export type WorkBuddyStagesCreateResponse = {
4173
4099
  completedBy?: string;
4174
4100
  completedNote?: string;
4175
4101
  finalisedDate?: string;
4176
- notes?: string;
4177
4102
  tags?: string;
4178
4103
  systemTags?: string;
4179
4104
  schedulingTags?: string;
@@ -4208,7 +4133,6 @@ export type WorkBuddyStagesUpdateResponse = {
4208
4133
  jobId: string;
4209
4134
  job?: { id: string; jobNumber: string; description?: string };
4210
4135
  name?: string;
4211
- description?: string;
4212
4136
  status: { id?: string; name?: string; systemStatus: string };
4213
4137
  sequence?: number;
4214
4138
  owner?: string;
@@ -4221,7 +4145,6 @@ export type WorkBuddyStagesUpdateResponse = {
4221
4145
  completedBy?: string;
4222
4146
  completedNote?: string;
4223
4147
  finalisedDate?: string;
4224
- notes?: string;
4225
4148
  tags?: string;
4226
4149
  systemTags?: string;
4227
4150
  schedulingTags?: string;
@@ -4257,7 +4180,6 @@ export type WorkBuddyStagesDispatchResponse = {
4257
4180
  jobId: string;
4258
4181
  job?: { id: string; jobNumber: string; description?: string };
4259
4182
  name?: string;
4260
- description?: string;
4261
4183
  status: { id?: string; name?: string; systemStatus: string };
4262
4184
  sequence?: number;
4263
4185
  owner?: string;
@@ -4270,7 +4192,6 @@ export type WorkBuddyStagesDispatchResponse = {
4270
4192
  completedBy?: string;
4271
4193
  completedNote?: string;
4272
4194
  finalisedDate?: string;
4273
- notes?: string;
4274
4195
  tags?: string;
4275
4196
  systemTags?: string;
4276
4197
  schedulingTags?: string;
@@ -4305,7 +4226,6 @@ export type WorkBuddyStagesCompleteCompleteResponse = {
4305
4226
  jobId: string;
4306
4227
  job?: { id: string; jobNumber: string; description?: string };
4307
4228
  name?: string;
4308
- description?: string;
4309
4229
  status: { id?: string; name?: string; systemStatus: string };
4310
4230
  sequence?: number;
4311
4231
  owner?: string;
@@ -4318,7 +4238,6 @@ export type WorkBuddyStagesCompleteCompleteResponse = {
4318
4238
  completedBy?: string;
4319
4239
  completedNote?: string;
4320
4240
  finalisedDate?: string;
4321
- notes?: string;
4322
4241
  tags?: string;
4323
4242
  systemTags?: string;
4324
4243
  schedulingTags?: string;
@@ -4353,7 +4272,6 @@ export type WorkBuddyStagesFinaliseFinaliseResponse = {
4353
4272
  jobId: string;
4354
4273
  job?: { id: string; jobNumber: string; description?: string };
4355
4274
  name?: string;
4356
- description?: string;
4357
4275
  status: { id?: string; name?: string; systemStatus: string };
4358
4276
  sequence?: number;
4359
4277
  owner?: string;
@@ -4366,7 +4284,6 @@ export type WorkBuddyStagesFinaliseFinaliseResponse = {
4366
4284
  completedBy?: string;
4367
4285
  completedNote?: string;
4368
4286
  finalisedDate?: string;
4369
- notes?: string;
4370
4287
  tags?: string;
4371
4288
  systemTags?: string;
4372
4289
  schedulingTags?: string;
@@ -4401,7 +4318,6 @@ export type WorkBuddyStagesCancelCancelResponse = {
4401
4318
  jobId: string;
4402
4319
  job?: { id: string; jobNumber: string; description?: string };
4403
4320
  name?: string;
4404
- description?: string;
4405
4321
  status: { id?: string; name?: string; systemStatus: string };
4406
4322
  sequence?: number;
4407
4323
  owner?: string;
@@ -4414,7 +4330,6 @@ export type WorkBuddyStagesCancelCancelResponse = {
4414
4330
  completedBy?: string;
4415
4331
  completedNote?: string;
4416
4332
  finalisedDate?: string;
4417
- notes?: string;
4418
4333
  tags?: string;
4419
4334
  systemTags?: string;
4420
4335
  schedulingTags?: string;
@@ -4449,7 +4364,6 @@ export type WorkBuddyStagesReverseReverseResponse = {
4449
4364
  jobId: string;
4450
4365
  job?: { id: string; jobNumber: string; description?: string };
4451
4366
  name?: string;
4452
- description?: string;
4453
4367
  status: { id?: string; name?: string; systemStatus: string };
4454
4368
  sequence?: number;
4455
4369
  owner?: string;
@@ -4462,7 +4376,6 @@ export type WorkBuddyStagesReverseReverseResponse = {
4462
4376
  completedBy?: string;
4463
4377
  completedNote?: string;
4464
4378
  finalisedDate?: string;
4465
- notes?: string;
4466
4379
  tags?: string;
4467
4380
  systemTags?: string;
4468
4381
  schedulingTags?: string;
@@ -4566,13 +4479,13 @@ export type WorkBuddySettingsTemplatesSmsListSmsTemplatesResponse = {
4566
4479
  export type WorkBuddySettingsItemsListResponse = {
4567
4480
  items: {
4568
4481
  id: string;
4569
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4482
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4570
4483
  name: string;
4571
4484
  baseUom: string;
4572
4485
  description: string;
4573
4486
  category: string;
4574
4487
  active: boolean;
4575
- integrationId?: string;
4488
+ integrationId: string;
4576
4489
  canOverrideDesc?: boolean;
4577
4490
  longDescription?: string;
4578
4491
  manufacturer?: string;
@@ -4603,13 +4516,13 @@ export type WorkBuddySettingsItemsListResponse = {
4603
4516
  export type WorkBuddySettingsItemsCreateResponse = {
4604
4517
  item: {
4605
4518
  id: string;
4606
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4519
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4607
4520
  name: string;
4608
4521
  baseUom: string;
4609
4522
  description: string;
4610
4523
  category: string;
4611
4524
  active: boolean;
4612
- integrationId?: string;
4525
+ integrationId: string;
4613
4526
  canOverrideDesc?: boolean;
4614
4527
  longDescription?: string;
4615
4528
  manufacturer?: string;
@@ -4639,13 +4552,13 @@ export type WorkBuddySettingsItemsCreateResponse = {
4639
4552
  export type WorkBuddySettingsItemsUpsertResponse = {
4640
4553
  item: {
4641
4554
  id: string;
4642
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4555
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4643
4556
  name: string;
4644
4557
  baseUom: string;
4645
4558
  description: string;
4646
4559
  category: string;
4647
4560
  active: boolean;
4648
- integrationId?: string;
4561
+ integrationId: string;
4649
4562
  canOverrideDesc?: boolean;
4650
4563
  longDescription?: string;
4651
4564
  manufacturer?: string;
@@ -4675,13 +4588,13 @@ export type WorkBuddySettingsItemsUpsertResponse = {
4675
4588
  export type WorkBuddySettingsItemsGetResponse = {
4676
4589
  item: {
4677
4590
  id: string;
4678
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4591
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4679
4592
  name: string;
4680
4593
  baseUom: string;
4681
4594
  description: string;
4682
4595
  category: string;
4683
4596
  active: boolean;
4684
- integrationId?: string;
4597
+ integrationId: string;
4685
4598
  canOverrideDesc?: boolean;
4686
4599
  longDescription?: string;
4687
4600
  manufacturer?: string;
@@ -4711,13 +4624,13 @@ export type WorkBuddySettingsItemsGetResponse = {
4711
4624
  export type WorkBuddySettingsItemsUpdateResponse = {
4712
4625
  item: {
4713
4626
  id: string;
4714
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4627
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4715
4628
  name: string;
4716
4629
  baseUom: string;
4717
4630
  description: string;
4718
4631
  category: string;
4719
4632
  active: boolean;
4720
- integrationId?: string;
4633
+ integrationId: string;
4721
4634
  canOverrideDesc?: boolean;
4722
4635
  longDescription?: string;
4723
4636
  manufacturer?: string;
@@ -4896,7 +4809,7 @@ export type WorkBuddyCrmCustomersCreateResponse = {
4896
4809
  primarySite: string;
4897
4810
  owner: string;
4898
4811
  labels: { id: string; name: string; type?: string; color?: string }[];
4899
- description: string;
4812
+ notes: string;
4900
4813
  customFields: Record<string, unknown>;
4901
4814
  status: string;
4902
4815
  createdAt: string;
@@ -4920,7 +4833,7 @@ export type WorkBuddyCrmCustomersGetResponse = {
4920
4833
  primarySite: string;
4921
4834
  owner: string;
4922
4835
  labels: { id: string; name: string; type?: string; color?: string }[];
4923
- description: string;
4836
+ notes: string;
4924
4837
  customFields: Record<string, unknown>;
4925
4838
  status: string;
4926
4839
  createdAt: string;
@@ -4944,7 +4857,7 @@ export type WorkBuddyCrmCustomersUpdateResponse = {
4944
4857
  primarySite: string;
4945
4858
  owner: string;
4946
4859
  labels: { id: string; name: string; type?: string; color?: string }[];
4947
- description: string;
4860
+ notes: string;
4948
4861
  customFields: Record<string, unknown>;
4949
4862
  status: string;
4950
4863
  createdAt: string;
@@ -4968,7 +4881,7 @@ export type WorkBuddyCrmCustomersStatusUpdateStatusResponse = {
4968
4881
  primarySite: string;
4969
4882
  owner: string;
4970
4883
  labels: { id: string; name: string; type?: string; color?: string }[];
4971
- description: string;
4884
+ notes: string;
4972
4885
  customFields: Record<string, unknown>;
4973
4886
  status: string;
4974
4887
  createdAt: string;
@@ -5047,11 +4960,12 @@ export type WorkBuddyCrmContractorsCreateResponse = {
5047
4960
  primarySite: string;
5048
4961
  owner: string;
5049
4962
  labels: { id: string; name: string; type?: string; color?: string }[];
5050
- description: string;
4963
+ notes: string;
5051
4964
  customFields: Record<string, unknown>;
5052
4965
  status: string;
5053
4966
  createdAt: string;
5054
4967
  updatedAt: string;
4968
+ socialNetwork: string;
5055
4969
  zones: { id: string; name: string; type?: string }[];
5056
4970
  companies: { id: string; name: string; type?: string }[];
5057
4971
  workCategories: { id: string; name: string; type?: string }[];
@@ -5078,11 +4992,12 @@ export type WorkBuddyCrmContractorsGetResponse = {
5078
4992
  primarySite: string;
5079
4993
  owner: string;
5080
4994
  labels: { id: string; name: string; type?: string; color?: string }[];
5081
- description: string;
4995
+ notes: string;
5082
4996
  customFields: Record<string, unknown>;
5083
4997
  status: string;
5084
4998
  createdAt: string;
5085
4999
  updatedAt: string;
5000
+ socialNetwork: string;
5086
5001
  zones: { id: string; name: string; type?: string }[];
5087
5002
  companies: { id: string; name: string; type?: string }[];
5088
5003
  workCategories: { id: string; name: string; type?: string }[];
@@ -5109,11 +5024,12 @@ export type WorkBuddyCrmContractorsUpdateResponse = {
5109
5024
  primarySite: string;
5110
5025
  owner: string;
5111
5026
  labels: { id: string; name: string; type?: string; color?: string }[];
5112
- description: string;
5027
+ notes: string;
5113
5028
  customFields: Record<string, unknown>;
5114
5029
  status: string;
5115
5030
  createdAt: string;
5116
5031
  updatedAt: string;
5032
+ socialNetwork: string;
5117
5033
  zones: { id: string; name: string; type?: string }[];
5118
5034
  companies: { id: string; name: string; type?: string }[];
5119
5035
  workCategories: { id: string; name: string; type?: string }[];
@@ -5140,11 +5056,12 @@ export type WorkBuddyCrmContractorsStatusUpdateStatusResponse = {
5140
5056
  primarySite: string;
5141
5057
  owner: string;
5142
5058
  labels: { id: string; name: string; type?: string; color?: string }[];
5143
- description: string;
5059
+ notes: string;
5144
5060
  customFields: Record<string, unknown>;
5145
5061
  status: string;
5146
5062
  createdAt: string;
5147
5063
  updatedAt: string;
5064
+ socialNetwork: string;
5148
5065
  zones: { id: string; name: string; type?: string }[];
5149
5066
  companies: { id: string; name: string; type?: string }[];
5150
5067
  workCategories: { id: string; name: string; type?: string }[];
@@ -5184,11 +5101,12 @@ export type WorkBuddyCrmSuppliersCreateResponse = {
5184
5101
  primarySite: string;
5185
5102
  owner: string;
5186
5103
  labels: { id: string; name: string; type?: string; color?: string }[];
5187
- description: string;
5104
+ notes: string;
5188
5105
  customFields: Record<string, unknown>;
5189
5106
  status: string;
5190
5107
  createdAt: string;
5191
5108
  updatedAt: string;
5109
+ socialNetwork: string;
5192
5110
  zones: { id: string; name: string; type?: string }[];
5193
5111
  workCategories: { id: string; name: string; type?: string }[];
5194
5112
  taxId: string;
@@ -5216,11 +5134,12 @@ export type WorkBuddyCrmSuppliersGetResponse = {
5216
5134
  primarySite: string;
5217
5135
  owner: string;
5218
5136
  labels: { id: string; name: string; type?: string; color?: string }[];
5219
- description: string;
5137
+ notes: string;
5220
5138
  customFields: Record<string, unknown>;
5221
5139
  status: string;
5222
5140
  createdAt: string;
5223
5141
  updatedAt: string;
5142
+ socialNetwork: string;
5224
5143
  zones: { id: string; name: string; type?: string }[];
5225
5144
  workCategories: { id: string; name: string; type?: string }[];
5226
5145
  taxId: string;
@@ -5248,11 +5167,12 @@ export type WorkBuddyCrmSuppliersUpdateResponse = {
5248
5167
  primarySite: string;
5249
5168
  owner: string;
5250
5169
  labels: { id: string; name: string; type?: string; color?: string }[];
5251
- description: string;
5170
+ notes: string;
5252
5171
  customFields: Record<string, unknown>;
5253
5172
  status: string;
5254
5173
  createdAt: string;
5255
5174
  updatedAt: string;
5175
+ socialNetwork: string;
5256
5176
  zones: { id: string; name: string; type?: string }[];
5257
5177
  workCategories: { id: string; name: string; type?: string }[];
5258
5178
  taxId: string;
@@ -5280,11 +5200,12 @@ export type WorkBuddyCrmSuppliersStatusUpdateStatusResponse = {
5280
5200
  primarySite: string;
5281
5201
  owner: string;
5282
5202
  labels: { id: string; name: string; type?: string; color?: string }[];
5283
- description: string;
5203
+ notes: string;
5284
5204
  customFields: Record<string, unknown>;
5285
5205
  status: string;
5286
5206
  createdAt: string;
5287
5207
  updatedAt: string;
5208
+ socialNetwork: string;
5288
5209
  zones: { id: string; name: string; type?: string }[];
5289
5210
  workCategories: { id: string; name: string; type?: string }[];
5290
5211
  taxId: string;
@@ -5304,7 +5225,6 @@ export type WorkBuddyCrmCompaniesListResponse = {
5304
5225
  integrationId?: string;
5305
5226
  address?: string;
5306
5227
  phone?: string;
5307
- mobile?: string;
5308
5228
  email?: string;
5309
5229
  }[];
5310
5230
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5317,7 +5237,6 @@ export type WorkBuddyCrmCompaniesGetResponse = {
5317
5237
  integrationId?: string;
5318
5238
  address?: string;
5319
5239
  phone?: string;
5320
- mobile?: string;
5321
5240
  email?: string;
5322
5241
  };
5323
5242
  };
@@ -6228,7 +6147,7 @@ export interface WorkBuddyStagesResource {
6228
6147
  ): Promise<TResponse>;
6229
6148
 
6230
6149
  /**
6231
- * Permanently delete a stage and all associated items/resources. This action cannot be undone.
6150
+ * Delete a stage. If tenant settings are configured to mark stages and items as cancelled on deletion, the stage is cancelled instead of permanently removed.
6232
6151
  * Operation: PublicJobStageController_delete
6233
6152
  */
6234
6153
  delete<TResponse = WorkBuddyStagesDeleteResponse>(
@@ -6518,7 +6437,7 @@ export interface WorkBuddySettingsItemsResource {
6518
6437
 
6519
6438
  export interface WorkBuddySettingsItemCategoriesResource {
6520
6439
  /**
6521
- * Retrieve active item categories and sub-categories.
6440
+ * Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.
6522
6441
  * Operation: PublicApiItemCategoryController_list
6523
6442
  */
6524
6443
  list<TResponse = WorkBuddySettingsItemCategoriesListResponse>(
package/index.js CHANGED
@@ -506,7 +506,7 @@ export class WorkBuddyClient {
506
506
  */
507
507
  update: (params = {}, options = {}) => this.request('PublicJobStageController_update', params, options),
508
508
  /**
509
- * Permanently delete a stage and all associated items/resources. This action cannot be undone.
509
+ * Delete a stage. If tenant settings are configured to mark stages and items as cancelled on deletion, the stage is cancelled instead of permanently removed.
510
510
  * Operation: PublicJobStageController_delete
511
511
  */
512
512
  delete: (params = {}, options = {}) => this.request('PublicJobStageController_delete', params, options),
@@ -633,7 +633,7 @@ export class WorkBuddyClient {
633
633
  },
634
634
  itemCategories: {
635
635
  /**
636
- * Retrieve active item categories and sub-categories.
636
+ * Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.
637
637
  * Operation: PublicApiItemCategoryController_list
638
638
  */
639
639
  list: (params = {}, options = {}) => this.request('PublicApiItemCategoryController_list', params, options),
@@ -1521,7 +1521,8 @@ export const operations = [
1521
1521
  resourcePath: ['stages'],
1522
1522
  actionName: 'delete',
1523
1523
  displayName: 'Delete a stage',
1524
- description: 'Permanently delete a stage and all associated items/resources. This action cannot be undone.',
1524
+ description:
1525
+ 'Delete a stage. If tenant settings are configured to mark stages and items as cancelled on deletion, the stage is cancelled instead of permanently removed.',
1525
1526
  method: 'DELETE',
1526
1527
  path: '/stages/{id}',
1527
1528
  pathParams: ['id'],
@@ -1894,11 +1895,12 @@ export const operations = [
1894
1895
  resourcePath: ['settings', 'itemCategories'],
1895
1896
  actionName: 'list',
1896
1897
  displayName: 'List item categories',
1897
- description: 'Retrieve active item categories and sub-categories.',
1898
+ description:
1899
+ 'Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.',
1898
1900
  method: 'GET',
1899
1901
  path: '/settings/item-categories',
1900
1902
  pathParams: [],
1901
- queryParams: [],
1903
+ queryParams: ['id', 'name', 'search'],
1902
1904
  hasRequestBody: false,
1903
1905
  },
1904
1906
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workbuddy/sdk-js-vnext",
3
- "version": "1.0.32",
3
+ "version": "1.0.33",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",