@workbuddy/sdk-js-vnext 1.0.32 → 1.0.34

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 +103 -168
  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
1504
  /**
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
1505
+ * Request body.
1531
1506
  */
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
- /**
1584
- * Custom fields as key-value pairs — validated against tenant field definitions
1585
- */
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
  */
@@ -1609,7 +1524,15 @@ export interface WorkBuddySettingsItemsUpsertParams extends WorkBuddyRequestPara
1609
1524
  */
1610
1525
  description?: string;
1611
1526
 
1612
- category?: { categoryId?: string; categoryName?: string; subCategoryId?: string; subCategoryName?: string };
1527
+ category?: {
1528
+ categoryId?: string;
1529
+ categoryName?: string;
1530
+ subCategoryId?: string;
1531
+ subCategoryName?: string;
1532
+ workCategoryId?: string;
1533
+ workCategoryName?: string;
1534
+ createMissingCategory?: boolean;
1535
+ };
1613
1536
  /**
1614
1537
  * Whether the entity is active
1615
1538
  */
@@ -1689,7 +1612,7 @@ export interface WorkBuddySettingsItemsUpdateParams extends WorkBuddyRequestPara
1689
1612
  */
1690
1613
  id: string;
1691
1614
 
1692
- type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
1615
+ type?: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
1693
1616
  /**
1694
1617
  * Display name
1695
1618
  */
@@ -1705,7 +1628,15 @@ export interface WorkBuddySettingsItemsUpdateParams extends WorkBuddyRequestPara
1705
1628
  */
1706
1629
  description?: string;
1707
1630
 
1708
- category?: { categoryId?: string; categoryName?: string; subCategoryId?: string; subCategoryName?: string };
1631
+ category?: {
1632
+ categoryId?: string;
1633
+ categoryName?: string;
1634
+ subCategoryId?: string;
1635
+ subCategoryName?: string;
1636
+ workCategoryId?: string;
1637
+ workCategoryName?: string;
1638
+ createMissingCategory?: boolean;
1639
+ };
1709
1640
  /**
1710
1641
  * Whether the entity is active
1711
1642
  */
@@ -1779,7 +1710,20 @@ export interface WorkBuddySettingsItemsDeleteParams extends WorkBuddyRequestPara
1779
1710
  id: string;
1780
1711
  }
1781
1712
 
1782
- export interface WorkBuddySettingsItemCategoriesListParams extends WorkBuddyRequestParams {}
1713
+ export interface WorkBuddySettingsItemCategoriesListParams extends WorkBuddyRequestParams {
1714
+ /**
1715
+ * Alias for search
1716
+ */
1717
+ id?: string;
1718
+ /**
1719
+ * Alias for search
1720
+ */
1721
+ name?: string;
1722
+ /**
1723
+ * Filter by category/sub-category name or id
1724
+ */
1725
+ search?: string;
1726
+ }
1783
1727
 
1784
1728
  export interface WorkBuddySettingsItemCategoriesUpsertParams extends WorkBuddyRequestParams {
1785
1729
  /**
@@ -1841,7 +1785,7 @@ export interface WorkBuddyJobsActivitiesGetParams extends WorkBuddyRequestParams
1841
1785
 
1842
1786
  export interface WorkBuddyJobsActivitiesDeleteParams extends WorkBuddyRequestParams {
1843
1787
  /**
1844
- * Job ID or job number (e.g. J12345)
1788
+ * Job ID
1845
1789
  */
1846
1790
  jobId: string;
1847
1791
  /**
@@ -1959,7 +1903,7 @@ export interface WorkBuddyJobsActivitiesPhoneCreatePhoneParams extends WorkBuddy
1959
1903
  /**
1960
1904
  * call date (ISO 8601 datetime)
1961
1905
  */
1962
- callDate?: string;
1906
+ callDate: string;
1963
1907
  /**
1964
1908
  * Message body content (HTML supported for email)
1965
1909
  */
@@ -2039,7 +1983,9 @@ export interface WorkBuddyJobsStagesActivitiesDeleteParams extends WorkBuddyRequ
2039
1983
  * Activity ID
2040
1984
  */
2041
1985
  id: string;
2042
-
1986
+ /**
1987
+ * Job ID
1988
+ */
2043
1989
  jobId: string;
2044
1990
  }
2045
1991
 
@@ -2162,7 +2108,7 @@ export interface WorkBuddyJobsStagesActivitiesPhoneCreatePhoneParams extends Wor
2162
2108
  /**
2163
2109
  * call date (ISO 8601 datetime)
2164
2110
  */
2165
- callDate?: string;
2111
+ callDate: string;
2166
2112
  /**
2167
2113
  * Message body content (HTML supported for email)
2168
2114
  */
@@ -2713,7 +2659,6 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2713
2659
  suburb?: string;
2714
2660
  state?: string;
2715
2661
  postalCode?: string;
2716
- postcode?: string;
2717
2662
  country?: string;
2718
2663
  lat?: number;
2719
2664
  lgn?: number;
@@ -2723,6 +2668,10 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2723
2668
  * Inline contact object — alternative to contactId
2724
2669
  */
2725
2670
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
2671
+ /**
2672
+ * Additional notes or comments
2673
+ */
2674
+ notes?: string;
2726
2675
  /**
2727
2676
  * Custom fields as key-value pairs — validated against tenant field definitions
2728
2677
  */
@@ -2730,7 +2679,7 @@ export interface WorkBuddyCrmCustomersCreateParams extends WorkBuddyRequestParam
2730
2679
 
2731
2680
  type: 'Service Provider' | 'Business' | 'Residential';
2732
2681
 
2733
- socialNetwork?: Record<string, unknown>;
2682
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2734
2683
  }
2735
2684
 
2736
2685
  export interface WorkBuddyCrmCustomersGetParams extends WorkBuddyRequestParams {
@@ -2773,7 +2722,6 @@ export interface WorkBuddyCrmCustomersUpdateParams extends WorkBuddyRequestParam
2773
2722
  suburb?: string;
2774
2723
  state?: string;
2775
2724
  postalCode?: string;
2776
- postcode?: string;
2777
2725
  country?: string;
2778
2726
  lat?: number;
2779
2727
  lgn?: number;
@@ -2786,15 +2734,15 @@ export interface WorkBuddyCrmCustomersUpdateParams extends WorkBuddyRequestParam
2786
2734
 
2787
2735
  labels?: Record<string, unknown>[];
2788
2736
  /**
2789
- * Detailed description
2737
+ * Additional notes or comments
2790
2738
  */
2791
- description?: string;
2739
+ notes?: string;
2792
2740
  /**
2793
2741
  * Custom fields as key-value pairs — validated against tenant field definitions
2794
2742
  */
2795
2743
  customFields?: Record<string, unknown>;
2796
2744
 
2797
- socialNetwork?: Record<string, unknown>;
2745
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2798
2746
  }
2799
2747
 
2800
2748
  export interface WorkBuddyCrmCustomersStatusUpdateStatusParams extends WorkBuddyRequestParams {
@@ -2885,7 +2833,6 @@ export interface WorkBuddyCrmContractorsCreateParams extends WorkBuddyRequestPar
2885
2833
  suburb?: string;
2886
2834
  state?: string;
2887
2835
  postalCode?: string;
2888
- postcode?: string;
2889
2836
  country?: string;
2890
2837
  lat?: number;
2891
2838
  lgn?: number;
@@ -2895,11 +2842,17 @@ export interface WorkBuddyCrmContractorsCreateParams extends WorkBuddyRequestPar
2895
2842
  * Inline contact object — alternative to contactId
2896
2843
  */
2897
2844
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
2845
+ /**
2846
+ * Additional notes or comments
2847
+ */
2848
+ notes?: string;
2898
2849
  /**
2899
2850
  * Custom fields as key-value pairs — validated against tenant field definitions
2900
2851
  */
2901
2852
  customFields?: Record<string, unknown>;
2902
2853
 
2854
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2855
+
2903
2856
  hidePrices?: boolean;
2904
2857
  }
2905
2858
 
@@ -2943,7 +2896,6 @@ export interface WorkBuddyCrmContractorsUpdateParams extends WorkBuddyRequestPar
2943
2896
  suburb?: string;
2944
2897
  state?: string;
2945
2898
  postalCode?: string;
2946
- postcode?: string;
2947
2899
  country?: string;
2948
2900
  lat?: number;
2949
2901
  lgn?: number;
@@ -2956,14 +2908,16 @@ export interface WorkBuddyCrmContractorsUpdateParams extends WorkBuddyRequestPar
2956
2908
 
2957
2909
  labels?: Record<string, unknown>[];
2958
2910
  /**
2959
- * Detailed description
2911
+ * Additional notes or comments
2960
2912
  */
2961
- description?: string;
2913
+ notes?: string;
2962
2914
  /**
2963
2915
  * Custom fields as key-value pairs — validated against tenant field definitions
2964
2916
  */
2965
2917
  customFields?: Record<string, unknown>;
2966
2918
 
2919
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
2920
+
2967
2921
  zones?: Record<string, unknown>[];
2968
2922
 
2969
2923
  companies?: Record<string, unknown>[];
@@ -3034,7 +2988,6 @@ export interface WorkBuddyCrmSuppliersCreateParams extends WorkBuddyRequestParam
3034
2988
  suburb?: string;
3035
2989
  state?: string;
3036
2990
  postalCode?: string;
3037
- postcode?: string;
3038
2991
  country?: string;
3039
2992
  lat?: number;
3040
2993
  lgn?: number;
@@ -3044,10 +2997,16 @@ export interface WorkBuddyCrmSuppliersCreateParams extends WorkBuddyRequestParam
3044
2997
  * Inline contact object — alternative to contactId
3045
2998
  */
3046
2999
  contact: { firstName: string; lastName: string; mobile?: string; email?: string; title?: string; note?: string };
3000
+ /**
3001
+ * Additional notes or comments
3002
+ */
3003
+ notes?: string;
3047
3004
  /**
3048
3005
  * Custom fields as key-value pairs — validated against tenant field definitions
3049
3006
  */
3050
3007
  customFields?: Record<string, unknown>;
3008
+
3009
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
3051
3010
  /**
3052
3011
  * tax ID
3053
3012
  */
@@ -3094,7 +3053,6 @@ export interface WorkBuddyCrmSuppliersUpdateParams extends WorkBuddyRequestParam
3094
3053
  suburb?: string;
3095
3054
  state?: string;
3096
3055
  postalCode?: string;
3097
- postcode?: string;
3098
3056
  country?: string;
3099
3057
  lat?: number;
3100
3058
  lgn?: number;
@@ -3107,14 +3065,16 @@ export interface WorkBuddyCrmSuppliersUpdateParams extends WorkBuddyRequestParam
3107
3065
 
3108
3066
  labels?: Record<string, unknown>[];
3109
3067
  /**
3110
- * Detailed description
3068
+ * Additional notes or comments
3111
3069
  */
3112
- description?: string;
3070
+ notes?: string;
3113
3071
  /**
3114
3072
  * Custom fields as key-value pairs — validated against tenant field definitions
3115
3073
  */
3116
3074
  customFields?: Record<string, unknown>;
3117
3075
 
3076
+ socialNetwork?: { facebook?: string; twitter?: string; linkedin?: string; instagram?: string };
3077
+
3118
3078
  zones?: Record<string, unknown>[];
3119
3079
 
3120
3080
  workCategories?: Record<string, unknown>[];
@@ -3441,7 +3401,6 @@ export type WorkBuddyJobsSearchResponse = {
3441
3401
  jobId: string;
3442
3402
  job?: { id: string; jobNumber: string; description?: string };
3443
3403
  name?: string;
3444
- description?: string;
3445
3404
  status: { id?: string; name?: string; systemStatus: string };
3446
3405
  sequence?: number;
3447
3406
  owner?: string;
@@ -3454,7 +3413,6 @@ export type WorkBuddyJobsSearchResponse = {
3454
3413
  completedBy?: string;
3455
3414
  completedNote?: string;
3456
3415
  finalisedDate?: string;
3457
- notes?: string;
3458
3416
  tags?: string;
3459
3417
  systemTags?: string;
3460
3418
  schedulingTags?: string;
@@ -3524,7 +3482,6 @@ export type WorkBuddyJobsGetResponse = {
3524
3482
  jobId: string;
3525
3483
  job?: { id: string; jobNumber: string; description?: string };
3526
3484
  name?: string;
3527
- description?: string;
3528
3485
  status: { id?: string; name?: string; systemStatus: string };
3529
3486
  sequence?: number;
3530
3487
  owner?: string;
@@ -3537,7 +3494,6 @@ export type WorkBuddyJobsGetResponse = {
3537
3494
  completedBy?: string;
3538
3495
  completedNote?: string;
3539
3496
  finalisedDate?: string;
3540
- notes?: string;
3541
3497
  tags?: string;
3542
3498
  systemTags?: string;
3543
3499
  schedulingTags?: string;
@@ -3606,7 +3562,6 @@ export type WorkBuddyJobsCreateResponse = {
3606
3562
  jobId: string;
3607
3563
  job?: { id: string; jobNumber: string; description?: string };
3608
3564
  name?: string;
3609
- description?: string;
3610
3565
  status: { id?: string; name?: string; systemStatus: string };
3611
3566
  sequence?: number;
3612
3567
  owner?: string;
@@ -3619,7 +3574,6 @@ export type WorkBuddyJobsCreateResponse = {
3619
3574
  completedBy?: string;
3620
3575
  completedNote?: string;
3621
3576
  finalisedDate?: string;
3622
- notes?: string;
3623
3577
  tags?: string;
3624
3578
  systemTags?: string;
3625
3579
  schedulingTags?: string;
@@ -3687,7 +3641,6 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
3687
3641
  jobId: string;
3688
3642
  job?: { id: string; jobNumber: string; description?: string };
3689
3643
  name?: string;
3690
- description?: string;
3691
3644
  status: { id?: string; name?: string; systemStatus: string };
3692
3645
  sequence?: number;
3693
3646
  owner?: string;
@@ -3700,7 +3653,6 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
3700
3653
  completedBy?: string;
3701
3654
  completedNote?: string;
3702
3655
  finalisedDate?: string;
3703
- notes?: string;
3704
3656
  tags?: string;
3705
3657
  systemTags?: string;
3706
3658
  schedulingTags?: string;
@@ -3768,7 +3720,6 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
3768
3720
  jobId: string;
3769
3721
  job?: { id: string; jobNumber: string; description?: string };
3770
3722
  name?: string;
3771
- description?: string;
3772
3723
  status: { id?: string; name?: string; systemStatus: string };
3773
3724
  sequence?: number;
3774
3725
  owner?: string;
@@ -3781,7 +3732,6 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
3781
3732
  completedBy?: string;
3782
3733
  completedNote?: string;
3783
3734
  finalisedDate?: string;
3784
- notes?: string;
3785
3735
  tags?: string;
3786
3736
  systemTags?: string;
3787
3737
  schedulingTags?: string;
@@ -3849,7 +3799,6 @@ export type WorkBuddyJobsUpdateResponse = {
3849
3799
  jobId: string;
3850
3800
  job?: { id: string; jobNumber: string; description?: string };
3851
3801
  name?: string;
3852
- description?: string;
3853
3802
  status: { id?: string; name?: string; systemStatus: string };
3854
3803
  sequence?: number;
3855
3804
  owner?: string;
@@ -3862,7 +3811,6 @@ export type WorkBuddyJobsUpdateResponse = {
3862
3811
  completedBy?: string;
3863
3812
  completedNote?: string;
3864
3813
  finalisedDate?: string;
3865
- notes?: string;
3866
3814
  tags?: string;
3867
3815
  systemTags?: string;
3868
3816
  schedulingTags?: string;
@@ -3930,7 +3878,6 @@ export type WorkBuddyJobsDispatchResponse = {
3930
3878
  jobId: string;
3931
3879
  job?: { id: string; jobNumber: string; description?: string };
3932
3880
  name?: string;
3933
- description?: string;
3934
3881
  status: { id?: string; name?: string; systemStatus: string };
3935
3882
  sequence?: number;
3936
3883
  owner?: string;
@@ -3943,7 +3890,6 @@ export type WorkBuddyJobsDispatchResponse = {
3943
3890
  completedBy?: string;
3944
3891
  completedNote?: string;
3945
3892
  finalisedDate?: string;
3946
- notes?: string;
3947
3893
  tags?: string;
3948
3894
  systemTags?: string;
3949
3895
  schedulingTags?: string;
@@ -3985,7 +3931,6 @@ export type WorkBuddyJobsStagesListResponse = {
3985
3931
  stageNumber: string;
3986
3932
  jobId: string;
3987
3933
  name?: string;
3988
- description?: string;
3989
3934
  status: { id?: string; name?: string; systemStatus: string };
3990
3935
  sequence?: number;
3991
3936
  contractor?: string;
@@ -4003,7 +3948,6 @@ export type WorkBuddyJobsStagesGetJobStageResponse = {
4003
3948
  jobId: string;
4004
3949
  job?: { id: string; jobNumber: string; description?: string };
4005
3950
  name?: string;
4006
- description?: string;
4007
3951
  status: { id?: string; name?: string; systemStatus: string };
4008
3952
  sequence?: number;
4009
3953
  owner?: string;
@@ -4016,7 +3960,6 @@ export type WorkBuddyJobsStagesGetJobStageResponse = {
4016
3960
  completedBy?: string;
4017
3961
  completedNote?: string;
4018
3962
  finalisedDate?: string;
4019
- notes?: string;
4020
3963
  tags?: string;
4021
3964
  systemTags?: string;
4022
3965
  schedulingTags?: string;
@@ -4160,7 +4103,6 @@ export type WorkBuddyStagesCreateResponse = {
4160
4103
  jobId: string;
4161
4104
  job?: { id: string; jobNumber: string; description?: string };
4162
4105
  name?: string;
4163
- description?: string;
4164
4106
  status: { id?: string; name?: string; systemStatus: string };
4165
4107
  sequence?: number;
4166
4108
  owner?: string;
@@ -4173,7 +4115,6 @@ export type WorkBuddyStagesCreateResponse = {
4173
4115
  completedBy?: string;
4174
4116
  completedNote?: string;
4175
4117
  finalisedDate?: string;
4176
- notes?: string;
4177
4118
  tags?: string;
4178
4119
  systemTags?: string;
4179
4120
  schedulingTags?: string;
@@ -4208,7 +4149,6 @@ export type WorkBuddyStagesUpdateResponse = {
4208
4149
  jobId: string;
4209
4150
  job?: { id: string; jobNumber: string; description?: string };
4210
4151
  name?: string;
4211
- description?: string;
4212
4152
  status: { id?: string; name?: string; systemStatus: string };
4213
4153
  sequence?: number;
4214
4154
  owner?: string;
@@ -4221,7 +4161,6 @@ export type WorkBuddyStagesUpdateResponse = {
4221
4161
  completedBy?: string;
4222
4162
  completedNote?: string;
4223
4163
  finalisedDate?: string;
4224
- notes?: string;
4225
4164
  tags?: string;
4226
4165
  systemTags?: string;
4227
4166
  schedulingTags?: string;
@@ -4257,7 +4196,6 @@ export type WorkBuddyStagesDispatchResponse = {
4257
4196
  jobId: string;
4258
4197
  job?: { id: string; jobNumber: string; description?: string };
4259
4198
  name?: string;
4260
- description?: string;
4261
4199
  status: { id?: string; name?: string; systemStatus: string };
4262
4200
  sequence?: number;
4263
4201
  owner?: string;
@@ -4270,7 +4208,6 @@ export type WorkBuddyStagesDispatchResponse = {
4270
4208
  completedBy?: string;
4271
4209
  completedNote?: string;
4272
4210
  finalisedDate?: string;
4273
- notes?: string;
4274
4211
  tags?: string;
4275
4212
  systemTags?: string;
4276
4213
  schedulingTags?: string;
@@ -4305,7 +4242,6 @@ export type WorkBuddyStagesCompleteCompleteResponse = {
4305
4242
  jobId: string;
4306
4243
  job?: { id: string; jobNumber: string; description?: string };
4307
4244
  name?: string;
4308
- description?: string;
4309
4245
  status: { id?: string; name?: string; systemStatus: string };
4310
4246
  sequence?: number;
4311
4247
  owner?: string;
@@ -4318,7 +4254,6 @@ export type WorkBuddyStagesCompleteCompleteResponse = {
4318
4254
  completedBy?: string;
4319
4255
  completedNote?: string;
4320
4256
  finalisedDate?: string;
4321
- notes?: string;
4322
4257
  tags?: string;
4323
4258
  systemTags?: string;
4324
4259
  schedulingTags?: string;
@@ -4353,7 +4288,6 @@ export type WorkBuddyStagesFinaliseFinaliseResponse = {
4353
4288
  jobId: string;
4354
4289
  job?: { id: string; jobNumber: string; description?: string };
4355
4290
  name?: string;
4356
- description?: string;
4357
4291
  status: { id?: string; name?: string; systemStatus: string };
4358
4292
  sequence?: number;
4359
4293
  owner?: string;
@@ -4366,7 +4300,6 @@ export type WorkBuddyStagesFinaliseFinaliseResponse = {
4366
4300
  completedBy?: string;
4367
4301
  completedNote?: string;
4368
4302
  finalisedDate?: string;
4369
- notes?: string;
4370
4303
  tags?: string;
4371
4304
  systemTags?: string;
4372
4305
  schedulingTags?: string;
@@ -4401,7 +4334,6 @@ export type WorkBuddyStagesCancelCancelResponse = {
4401
4334
  jobId: string;
4402
4335
  job?: { id: string; jobNumber: string; description?: string };
4403
4336
  name?: string;
4404
- description?: string;
4405
4337
  status: { id?: string; name?: string; systemStatus: string };
4406
4338
  sequence?: number;
4407
4339
  owner?: string;
@@ -4414,7 +4346,6 @@ export type WorkBuddyStagesCancelCancelResponse = {
4414
4346
  completedBy?: string;
4415
4347
  completedNote?: string;
4416
4348
  finalisedDate?: string;
4417
- notes?: string;
4418
4349
  tags?: string;
4419
4350
  systemTags?: string;
4420
4351
  schedulingTags?: string;
@@ -4449,7 +4380,6 @@ export type WorkBuddyStagesReverseReverseResponse = {
4449
4380
  jobId: string;
4450
4381
  job?: { id: string; jobNumber: string; description?: string };
4451
4382
  name?: string;
4452
- description?: string;
4453
4383
  status: { id?: string; name?: string; systemStatus: string };
4454
4384
  sequence?: number;
4455
4385
  owner?: string;
@@ -4462,7 +4392,6 @@ export type WorkBuddyStagesReverseReverseResponse = {
4462
4392
  completedBy?: string;
4463
4393
  completedNote?: string;
4464
4394
  finalisedDate?: string;
4465
- notes?: string;
4466
4395
  tags?: string;
4467
4396
  systemTags?: string;
4468
4397
  schedulingTags?: string;
@@ -4566,13 +4495,13 @@ export type WorkBuddySettingsTemplatesSmsListSmsTemplatesResponse = {
4566
4495
  export type WorkBuddySettingsItemsListResponse = {
4567
4496
  items: {
4568
4497
  id: string;
4569
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4498
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4570
4499
  name: string;
4571
4500
  baseUom: string;
4572
4501
  description: string;
4573
4502
  category: string;
4574
4503
  active: boolean;
4575
- integrationId?: string;
4504
+ integrationId: string;
4576
4505
  canOverrideDesc?: boolean;
4577
4506
  longDescription?: string;
4578
4507
  manufacturer?: string;
@@ -4603,13 +4532,13 @@ export type WorkBuddySettingsItemsListResponse = {
4603
4532
  export type WorkBuddySettingsItemsCreateResponse = {
4604
4533
  item: {
4605
4534
  id: string;
4606
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4535
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4607
4536
  name: string;
4608
4537
  baseUom: string;
4609
4538
  description: string;
4610
4539
  category: string;
4611
4540
  active: boolean;
4612
- integrationId?: string;
4541
+ integrationId: string;
4613
4542
  canOverrideDesc?: boolean;
4614
4543
  longDescription?: string;
4615
4544
  manufacturer?: string;
@@ -4639,13 +4568,13 @@ export type WorkBuddySettingsItemsCreateResponse = {
4639
4568
  export type WorkBuddySettingsItemsUpsertResponse = {
4640
4569
  item: {
4641
4570
  id: string;
4642
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4571
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4643
4572
  name: string;
4644
4573
  baseUom: string;
4645
4574
  description: string;
4646
4575
  category: string;
4647
4576
  active: boolean;
4648
- integrationId?: string;
4577
+ integrationId: string;
4649
4578
  canOverrideDesc?: boolean;
4650
4579
  longDescription?: string;
4651
4580
  manufacturer?: string;
@@ -4675,13 +4604,13 @@ export type WorkBuddySettingsItemsUpsertResponse = {
4675
4604
  export type WorkBuddySettingsItemsGetResponse = {
4676
4605
  item: {
4677
4606
  id: string;
4678
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4607
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4679
4608
  name: string;
4680
4609
  baseUom: string;
4681
4610
  description: string;
4682
4611
  category: string;
4683
4612
  active: boolean;
4684
- integrationId?: string;
4613
+ integrationId: string;
4685
4614
  canOverrideDesc?: boolean;
4686
4615
  longDescription?: string;
4687
4616
  manufacturer?: string;
@@ -4711,13 +4640,13 @@ export type WorkBuddySettingsItemsGetResponse = {
4711
4640
  export type WorkBuddySettingsItemsUpdateResponse = {
4712
4641
  item: {
4713
4642
  id: string;
4714
- type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'LABOUR' | 'INCENTIVE';
4643
+ type: 'SERVICE' | 'INVENTORY' | 'NON-INVENTORY' | 'INCENTIVE' | 'KIT' | 'BUNDLE';
4715
4644
  name: string;
4716
4645
  baseUom: string;
4717
4646
  description: string;
4718
4647
  category: string;
4719
4648
  active: boolean;
4720
- integrationId?: string;
4649
+ integrationId: string;
4721
4650
  canOverrideDesc?: boolean;
4722
4651
  longDescription?: string;
4723
4652
  manufacturer?: string;
@@ -4896,7 +4825,7 @@ export type WorkBuddyCrmCustomersCreateResponse = {
4896
4825
  primarySite: string;
4897
4826
  owner: string;
4898
4827
  labels: { id: string; name: string; type?: string; color?: string }[];
4899
- description: string;
4828
+ notes: string;
4900
4829
  customFields: Record<string, unknown>;
4901
4830
  status: string;
4902
4831
  createdAt: string;
@@ -4920,7 +4849,7 @@ export type WorkBuddyCrmCustomersGetResponse = {
4920
4849
  primarySite: string;
4921
4850
  owner: string;
4922
4851
  labels: { id: string; name: string; type?: string; color?: string }[];
4923
- description: string;
4852
+ notes: string;
4924
4853
  customFields: Record<string, unknown>;
4925
4854
  status: string;
4926
4855
  createdAt: string;
@@ -4944,7 +4873,7 @@ export type WorkBuddyCrmCustomersUpdateResponse = {
4944
4873
  primarySite: string;
4945
4874
  owner: string;
4946
4875
  labels: { id: string; name: string; type?: string; color?: string }[];
4947
- description: string;
4876
+ notes: string;
4948
4877
  customFields: Record<string, unknown>;
4949
4878
  status: string;
4950
4879
  createdAt: string;
@@ -4968,7 +4897,7 @@ export type WorkBuddyCrmCustomersStatusUpdateStatusResponse = {
4968
4897
  primarySite: string;
4969
4898
  owner: string;
4970
4899
  labels: { id: string; name: string; type?: string; color?: string }[];
4971
- description: string;
4900
+ notes: string;
4972
4901
  customFields: Record<string, unknown>;
4973
4902
  status: string;
4974
4903
  createdAt: string;
@@ -5047,11 +4976,12 @@ export type WorkBuddyCrmContractorsCreateResponse = {
5047
4976
  primarySite: string;
5048
4977
  owner: string;
5049
4978
  labels: { id: string; name: string; type?: string; color?: string }[];
5050
- description: string;
4979
+ notes: string;
5051
4980
  customFields: Record<string, unknown>;
5052
4981
  status: string;
5053
4982
  createdAt: string;
5054
4983
  updatedAt: string;
4984
+ socialNetwork: string;
5055
4985
  zones: { id: string; name: string; type?: string }[];
5056
4986
  companies: { id: string; name: string; type?: string }[];
5057
4987
  workCategories: { id: string; name: string; type?: string }[];
@@ -5078,11 +5008,12 @@ export type WorkBuddyCrmContractorsGetResponse = {
5078
5008
  primarySite: string;
5079
5009
  owner: string;
5080
5010
  labels: { id: string; name: string; type?: string; color?: string }[];
5081
- description: string;
5011
+ notes: string;
5082
5012
  customFields: Record<string, unknown>;
5083
5013
  status: string;
5084
5014
  createdAt: string;
5085
5015
  updatedAt: string;
5016
+ socialNetwork: string;
5086
5017
  zones: { id: string; name: string; type?: string }[];
5087
5018
  companies: { id: string; name: string; type?: string }[];
5088
5019
  workCategories: { id: string; name: string; type?: string }[];
@@ -5109,11 +5040,12 @@ export type WorkBuddyCrmContractorsUpdateResponse = {
5109
5040
  primarySite: string;
5110
5041
  owner: string;
5111
5042
  labels: { id: string; name: string; type?: string; color?: string }[];
5112
- description: string;
5043
+ notes: string;
5113
5044
  customFields: Record<string, unknown>;
5114
5045
  status: string;
5115
5046
  createdAt: string;
5116
5047
  updatedAt: string;
5048
+ socialNetwork: string;
5117
5049
  zones: { id: string; name: string; type?: string }[];
5118
5050
  companies: { id: string; name: string; type?: string }[];
5119
5051
  workCategories: { id: string; name: string; type?: string }[];
@@ -5140,11 +5072,12 @@ export type WorkBuddyCrmContractorsStatusUpdateStatusResponse = {
5140
5072
  primarySite: string;
5141
5073
  owner: string;
5142
5074
  labels: { id: string; name: string; type?: string; color?: string }[];
5143
- description: string;
5075
+ notes: string;
5144
5076
  customFields: Record<string, unknown>;
5145
5077
  status: string;
5146
5078
  createdAt: string;
5147
5079
  updatedAt: string;
5080
+ socialNetwork: string;
5148
5081
  zones: { id: string; name: string; type?: string }[];
5149
5082
  companies: { id: string; name: string; type?: string }[];
5150
5083
  workCategories: { id: string; name: string; type?: string }[];
@@ -5184,11 +5117,12 @@ export type WorkBuddyCrmSuppliersCreateResponse = {
5184
5117
  primarySite: string;
5185
5118
  owner: string;
5186
5119
  labels: { id: string; name: string; type?: string; color?: string }[];
5187
- description: string;
5120
+ notes: string;
5188
5121
  customFields: Record<string, unknown>;
5189
5122
  status: string;
5190
5123
  createdAt: string;
5191
5124
  updatedAt: string;
5125
+ socialNetwork: string;
5192
5126
  zones: { id: string; name: string; type?: string }[];
5193
5127
  workCategories: { id: string; name: string; type?: string }[];
5194
5128
  taxId: string;
@@ -5216,11 +5150,12 @@ export type WorkBuddyCrmSuppliersGetResponse = {
5216
5150
  primarySite: string;
5217
5151
  owner: string;
5218
5152
  labels: { id: string; name: string; type?: string; color?: string }[];
5219
- description: string;
5153
+ notes: string;
5220
5154
  customFields: Record<string, unknown>;
5221
5155
  status: string;
5222
5156
  createdAt: string;
5223
5157
  updatedAt: string;
5158
+ socialNetwork: string;
5224
5159
  zones: { id: string; name: string; type?: string }[];
5225
5160
  workCategories: { id: string; name: string; type?: string }[];
5226
5161
  taxId: string;
@@ -5248,11 +5183,12 @@ export type WorkBuddyCrmSuppliersUpdateResponse = {
5248
5183
  primarySite: string;
5249
5184
  owner: string;
5250
5185
  labels: { id: string; name: string; type?: string; color?: string }[];
5251
- description: string;
5186
+ notes: string;
5252
5187
  customFields: Record<string, unknown>;
5253
5188
  status: string;
5254
5189
  createdAt: string;
5255
5190
  updatedAt: string;
5191
+ socialNetwork: string;
5256
5192
  zones: { id: string; name: string; type?: string }[];
5257
5193
  workCategories: { id: string; name: string; type?: string }[];
5258
5194
  taxId: string;
@@ -5280,11 +5216,12 @@ export type WorkBuddyCrmSuppliersStatusUpdateStatusResponse = {
5280
5216
  primarySite: string;
5281
5217
  owner: string;
5282
5218
  labels: { id: string; name: string; type?: string; color?: string }[];
5283
- description: string;
5219
+ notes: string;
5284
5220
  customFields: Record<string, unknown>;
5285
5221
  status: string;
5286
5222
  createdAt: string;
5287
5223
  updatedAt: string;
5224
+ socialNetwork: string;
5288
5225
  zones: { id: string; name: string; type?: string }[];
5289
5226
  workCategories: { id: string; name: string; type?: string }[];
5290
5227
  taxId: string;
@@ -5304,7 +5241,6 @@ export type WorkBuddyCrmCompaniesListResponse = {
5304
5241
  integrationId?: string;
5305
5242
  address?: string;
5306
5243
  phone?: string;
5307
- mobile?: string;
5308
5244
  email?: string;
5309
5245
  }[];
5310
5246
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -5317,7 +5253,6 @@ export type WorkBuddyCrmCompaniesGetResponse = {
5317
5253
  integrationId?: string;
5318
5254
  address?: string;
5319
5255
  phone?: string;
5320
- mobile?: string;
5321
5256
  email?: string;
5322
5257
  };
5323
5258
  };
@@ -6228,7 +6163,7 @@ export interface WorkBuddyStagesResource {
6228
6163
  ): Promise<TResponse>;
6229
6164
 
6230
6165
  /**
6231
- * Permanently delete a stage and all associated items/resources. This action cannot be undone.
6166
+ * 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
6167
  * Operation: PublicJobStageController_delete
6233
6168
  */
6234
6169
  delete<TResponse = WorkBuddyStagesDeleteResponse>(
@@ -6518,7 +6453,7 @@ export interface WorkBuddySettingsItemsResource {
6518
6453
 
6519
6454
  export interface WorkBuddySettingsItemCategoriesResource {
6520
6455
  /**
6521
- * Retrieve active item categories and sub-categories.
6456
+ * Retrieve active item categories and sub-categories. Use search, name, or id to filter by category/sub-category name or id.
6522
6457
  * Operation: PublicApiItemCategoryController_list
6523
6458
  */
6524
6459
  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.34",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",