@workbuddy/sdk-js-vnext 1.0.139 → 1.0.141

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 +117 -20
  2. package/index.js +2 -2
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -862,7 +862,7 @@ export interface WorkBuddyJobsCreateParams extends WorkBuddyRequestParams {
862
862
  status?: 'Normal' | 'Variation' | 'Cancelled' | 'Deleted';
863
863
  buyPrice?: number;
864
864
  sellPrice?: number;
865
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
865
+ invoicingStatus?: 'Billable' | 'Not Billable';
866
866
  payable?: boolean;
867
867
  suppliedBySubcontractor?: boolean;
868
868
  }[];
@@ -986,7 +986,7 @@ export interface WorkBuddyJobsTemplateCreateFromTemplateParams extends WorkBuddy
986
986
  status?: 'Normal' | 'Variation' | 'Cancelled' | 'Deleted';
987
987
  buyPrice?: number;
988
988
  sellPrice?: number;
989
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
989
+ invoicingStatus?: 'Billable' | 'Not Billable';
990
990
  payable?: boolean;
991
991
  suppliedBySubcontractor?: boolean;
992
992
  }[];
@@ -1194,7 +1194,7 @@ export interface WorkBuddyJobsStagesItemsCreateStageItemsParams extends WorkBudd
1194
1194
  status?: 'Normal' | 'Variation' | 'Cancelled' | 'Deleted';
1195
1195
  buyPrice?: number;
1196
1196
  sellPrice?: number;
1197
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
1197
+ invoicingStatus?: 'Billable' | 'Not Billable';
1198
1198
  payable?: boolean;
1199
1199
  suppliedBySubcontractor?: boolean;
1200
1200
  }[];
@@ -1248,8 +1248,12 @@ export interface WorkBuddyJobsStagesItemsUpdateStageItemParams extends WorkBuddy
1248
1248
  * Status filter
1249
1249
  */
1250
1250
  status?: 'Normal' | 'Variation' | 'Cancelled' | 'Deleted';
1251
+ /**
1252
+ * Reason for the action (e.g. cancellation reason)
1253
+ */
1254
+ reason?: string;
1251
1255
 
1252
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
1256
+ invoicingStatus?: 'Billable' | 'Not Billable';
1253
1257
 
1254
1258
  payable?: boolean;
1255
1259
 
@@ -1325,7 +1329,8 @@ export interface WorkBuddyJobsStagesPendingItemsCreateParams extends WorkBuddyRe
1325
1329
  itemStatusId?: string;
1326
1330
  buyPrice?: number;
1327
1331
  sellPrice?: number;
1328
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
1332
+ invoicingStatus?: 'Billable' | 'Not Billable';
1333
+ payable?: boolean;
1329
1334
  suppliedBySubcontractor?: boolean;
1330
1335
  workAlreadyCompleted?: boolean;
1331
1336
  }[];
@@ -1376,7 +1381,9 @@ export interface WorkBuddyJobsStagesPendingItemsUpdateParams extends WorkBuddyRe
1376
1381
 
1377
1382
  sellPrice?: number;
1378
1383
 
1379
- invoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
1384
+ invoicingStatus?: 'Billable' | 'Not Billable';
1385
+
1386
+ payable?: boolean;
1380
1387
 
1381
1388
  suppliedBySubcontractor?: boolean;
1382
1389
 
@@ -1415,6 +1422,10 @@ export interface WorkBuddyJobsStagesPendingItemsStatusUpdateStatusParams extends
1415
1422
  * item status ID
1416
1423
  */
1417
1424
  itemStatusId: string;
1425
+ /**
1426
+ * Reason for the action (e.g. cancellation reason)
1427
+ */
1428
+ reason?: string;
1418
1429
  }
1419
1430
 
1420
1431
  export interface WorkBuddyJobsStagesPendingItemsApproveApproveParams extends WorkBuddyRequestParams {
@@ -1783,9 +1794,9 @@ export interface WorkBuddyJobsStagesAppointmentsUpdateParams extends WorkBuddyRe
1783
1794
 
1784
1795
  export interface WorkBuddySettingsEntityStatusesListParams extends WorkBuddyRequestParams {
1785
1796
  /**
1786
- * Entity type (customer, contractor, supplier, contact, external-user, pending-item)
1797
+ * Entity type (customer, contractor, supplier, contact, external-user, pending-item, item)
1787
1798
  */
1788
- entity: 'customer' | 'contractor' | 'supplier' | 'contact' | 'external-user' | 'pending-item';
1799
+ entity: 'customer' | 'contractor' | 'supplier' | 'contact' | 'external-user' | 'pending-item' | 'item';
1789
1800
  }
1790
1801
 
1791
1802
  export interface WorkBuddySettingsJobStatusesListParams extends WorkBuddyRequestParams {}
@@ -3363,7 +3374,7 @@ export interface WorkBuddySettingsItemsUpsertParams extends WorkBuddyRequestPara
3363
3374
 
3364
3375
  purchaseTaxRateName?: string;
3365
3376
 
3366
- codeInvoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
3377
+ codeInvoicingStatus?: 'Billable' | 'Not Billable';
3367
3378
 
3368
3379
  payable?: boolean;
3369
3380
 
@@ -3380,6 +3391,8 @@ export interface WorkBuddySettingsItemsUpsertParams extends WorkBuddyRequestPara
3380
3391
  trackingCategory2?: string;
3381
3392
 
3382
3393
  uoms?: { uomId?: string; uomName?: string; conversionRate: number }[];
3394
+
3395
+ childCodes?: { id?: string; name?: string; quantity?: number }[];
3383
3396
  }
3384
3397
 
3385
3398
  export interface WorkBuddySettingsItemsGetParams extends WorkBuddyRequestParams {
@@ -3469,7 +3482,7 @@ export interface WorkBuddySettingsItemsUpdateParams extends WorkBuddyRequestPara
3469
3482
 
3470
3483
  purchaseTaxRateName?: string;
3471
3484
 
3472
- codeInvoicingStatus?: 'Billable' | 'No Charge' | 'Not Billable';
3485
+ codeInvoicingStatus?: 'Billable' | 'Not Billable';
3473
3486
 
3474
3487
  payable?: boolean;
3475
3488
 
@@ -3486,6 +3499,8 @@ export interface WorkBuddySettingsItemsUpdateParams extends WorkBuddyRequestPara
3486
3499
  trackingCategory2?: string;
3487
3500
 
3488
3501
  uoms?: { uomId?: string; uomName?: string; conversionRate: number }[];
3502
+
3503
+ childCodes?: { id?: string; name?: string; quantity?: number }[];
3489
3504
  }
3490
3505
 
3491
3506
  export interface WorkBuddySettingsItemsDeleteParams extends WorkBuddyRequestParams {
@@ -6249,7 +6264,7 @@ export type WorkBuddyJobsSearchResponse = {
6249
6264
  owner?: string;
6250
6265
  fieldSupervisor?: string;
6251
6266
  zones?: { id: string; name: string }[];
6252
- tags?: { id: string; name: string; color?: string }[];
6267
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6253
6268
  systemTags?: { id: string; name: string; color?: string }[];
6254
6269
  notes?: string;
6255
6270
  reference?: string;
@@ -6334,7 +6349,7 @@ export type WorkBuddyJobsGetResponse = {
6334
6349
  owner?: string;
6335
6350
  fieldSupervisor?: string;
6336
6351
  zones?: { id: string; name: string }[];
6337
- tags?: { id: string; name: string; color?: string }[];
6352
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6338
6353
  systemTags?: { id: string; name: string; color?: string }[];
6339
6354
  notes?: string;
6340
6355
  reference?: string;
@@ -6418,7 +6433,7 @@ export type WorkBuddyJobsCreateResponse = {
6418
6433
  owner?: string;
6419
6434
  fieldSupervisor?: string;
6420
6435
  zones?: { id: string; name: string }[];
6421
- tags?: { id: string; name: string; color?: string }[];
6436
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6422
6437
  systemTags?: { id: string; name: string; color?: string }[];
6423
6438
  notes?: string;
6424
6439
  reference?: string;
@@ -6501,7 +6516,7 @@ export type WorkBuddyJobsTemplateCreateFromTemplateResponse = {
6501
6516
  owner?: string;
6502
6517
  fieldSupervisor?: string;
6503
6518
  zones?: { id: string; name: string }[];
6504
- tags?: { id: string; name: string; color?: string }[];
6519
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6505
6520
  systemTags?: { id: string; name: string; color?: string }[];
6506
6521
  notes?: string;
6507
6522
  reference?: string;
@@ -6584,7 +6599,7 @@ export type WorkBuddyJobsFinanceUpdateFinanceResponse = {
6584
6599
  owner?: string;
6585
6600
  fieldSupervisor?: string;
6586
6601
  zones?: { id: string; name: string }[];
6587
- tags?: { id: string; name: string; color?: string }[];
6602
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6588
6603
  systemTags?: { id: string; name: string; color?: string }[];
6589
6604
  notes?: string;
6590
6605
  reference?: string;
@@ -6668,7 +6683,7 @@ export type WorkBuddyJobsStatusUpdateStatusResponse = {
6668
6683
  owner?: string;
6669
6684
  fieldSupervisor?: string;
6670
6685
  zones?: { id: string; name: string }[];
6671
- tags?: { id: string; name: string; color?: string }[];
6686
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6672
6687
  systemTags?: { id: string; name: string; color?: string }[];
6673
6688
  notes?: string;
6674
6689
  reference?: string;
@@ -6751,7 +6766,7 @@ export type WorkBuddyJobsUpdateResponse = {
6751
6766
  owner?: string;
6752
6767
  fieldSupervisor?: string;
6753
6768
  zones?: { id: string; name: string }[];
6754
- tags?: { id: string; name: string; color?: string }[];
6769
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6755
6770
  systemTags?: { id: string; name: string; color?: string }[];
6756
6771
  notes?: string;
6757
6772
  reference?: string;
@@ -6834,7 +6849,7 @@ export type WorkBuddyJobsDispatchResponse = {
6834
6849
  owner?: string;
6835
6850
  fieldSupervisor?: string;
6836
6851
  zones?: { id: string; name: string }[];
6837
- tags?: { id: string; name: string; color?: string }[];
6852
+ tags?: { id: string; name: string; color?: string; addedBy?: 'item' }[];
6838
6853
  systemTags?: { id: string; name: string; color?: string }[];
6839
6854
  notes?: string;
6840
6855
  reference?: string;
@@ -7096,6 +7111,7 @@ export type WorkBuddyPendingItemsListResponse = {
7096
7111
  buyPrice?: number;
7097
7112
  sellPrice?: number;
7098
7113
  invoicingStatus?: string;
7114
+ payable: boolean;
7099
7115
  suppliedBySubcontractor: boolean;
7100
7116
  workAlreadyCompleted: boolean;
7101
7117
  createdAt: string;
@@ -7120,6 +7136,7 @@ export type WorkBuddyJobsStagesPendingItemsListResponse = {
7120
7136
  buyPrice?: number;
7121
7137
  sellPrice?: number;
7122
7138
  invoicingStatus?: string;
7139
+ payable: boolean;
7123
7140
  suppliedBySubcontractor: boolean;
7124
7141
  workAlreadyCompleted: boolean;
7125
7142
  createdAt: string;
@@ -7144,6 +7161,7 @@ export type WorkBuddyJobsStagesPendingItemsCreateResponse = {
7144
7161
  buyPrice?: number;
7145
7162
  sellPrice?: number;
7146
7163
  invoicingStatus?: string;
7164
+ payable: boolean;
7147
7165
  suppliedBySubcontractor: boolean;
7148
7166
  workAlreadyCompleted: boolean;
7149
7167
  createdAt: string;
@@ -7166,6 +7184,7 @@ export type WorkBuddyJobsStagesPendingItemsGetResponse = {
7166
7184
  buyPrice?: number;
7167
7185
  sellPrice?: number;
7168
7186
  invoicingStatus?: string;
7187
+ payable: boolean;
7169
7188
  suppliedBySubcontractor: boolean;
7170
7189
  workAlreadyCompleted: boolean;
7171
7190
  createdAt: string;
@@ -7187,6 +7206,7 @@ export type WorkBuddyJobsStagesPendingItemsUpdateResponse = {
7187
7206
  buyPrice?: number;
7188
7207
  sellPrice?: number;
7189
7208
  invoicingStatus?: string;
7209
+ payable: boolean;
7190
7210
  suppliedBySubcontractor: boolean;
7191
7211
  workAlreadyCompleted: boolean;
7192
7212
  createdAt: string;
@@ -7209,6 +7229,7 @@ export type WorkBuddyJobsStagesPendingItemsStatusUpdateStatusResponse = {
7209
7229
  buyPrice?: number;
7210
7230
  sellPrice?: number;
7211
7231
  invoicingStatus?: string;
7232
+ payable: boolean;
7212
7233
  suppliedBySubcontractor: boolean;
7213
7234
  workAlreadyCompleted: boolean;
7214
7235
  createdAt: string;
@@ -7786,17 +7807,88 @@ export type WorkBuddyJobsStagesAppointmentsUpdateResponse = {
7786
7807
  status: 'Open' | 'Enroute' | 'Onsite' | 'Checked Out' | 'Completed' | 'Cancelled';
7787
7808
  integrationId: string;
7788
7809
  };
7789
- export type WorkBuddySettingsEntityStatusesListResponse = { items: { id: string; name: string; statusType: string }[] };
7810
+ export type WorkBuddySettingsEntityStatusesListResponse = {
7811
+ items: {
7812
+ id: string;
7813
+ name: string;
7814
+ statusType: string;
7815
+ reasonRequired?: boolean;
7816
+ reasons?: { id: string; name: string }[];
7817
+ }[];
7818
+ };
7790
7819
  export type WorkBuddySettingsJobStatusesListResponse = { items: { id: string; name: string }[] };
7791
7820
  export type WorkBuddySettingsJobTypesListResponse = {
7792
7821
  items: {
7793
7822
  id: string;
7794
7823
  name: string;
7824
+ color?:
7825
+ | '#1abc9c'
7826
+ | '#16a085'
7827
+ | '#f1c40f'
7828
+ | '#f39c12'
7829
+ | '#2ecc71'
7830
+ | '#27ae60'
7831
+ | '#e67e22'
7832
+ | '#d35400'
7833
+ | '#3498db'
7834
+ | '#2980b9'
7835
+ | '#e74c3c'
7836
+ | '#c0392b'
7837
+ | '#9b59b6'
7838
+ | '#8e44ad'
7839
+ | '#bdc3c7'
7840
+ | '#34495e'
7841
+ | '#2c3e50'
7842
+ | '#95a5a6'
7843
+ | '#7f8c8d'
7844
+ | '#ec87bf'
7845
+ | '#d870ad'
7846
+ | '#f69785'
7847
+ | '#9ba37e'
7848
+ | '#b49255'
7849
+ | '#a94136'
7850
+ | '#dc2127'
7851
+ | '#ff887c'
7852
+ | '#fbd75b'
7853
+ | '#51b749'
7854
+ | '#5484ed';
7795
7855
  sortOrder?: number;
7796
7856
  isDefault?: boolean;
7797
7857
  keywords?: string[];
7798
7858
  defaultStructure?: 'basic' | 'advanced' | 'project';
7799
7859
  }[];
7860
+ colors: (
7861
+ | '#1abc9c'
7862
+ | '#16a085'
7863
+ | '#f1c40f'
7864
+ | '#f39c12'
7865
+ | '#2ecc71'
7866
+ | '#27ae60'
7867
+ | '#e67e22'
7868
+ | '#d35400'
7869
+ | '#3498db'
7870
+ | '#2980b9'
7871
+ | '#e74c3c'
7872
+ | '#c0392b'
7873
+ | '#9b59b6'
7874
+ | '#8e44ad'
7875
+ | '#bdc3c7'
7876
+ | '#34495e'
7877
+ | '#2c3e50'
7878
+ | '#95a5a6'
7879
+ | '#7f8c8d'
7880
+ | '#ec87bf'
7881
+ | '#d870ad'
7882
+ | '#f69785'
7883
+ | '#9ba37e'
7884
+ | '#b49255'
7885
+ | '#a94136'
7886
+ | '#dc2127'
7887
+ | '#ff887c'
7888
+ | '#fbd75b'
7889
+ | '#51b749'
7890
+ | '#5484ed'
7891
+ )[];
7800
7892
  };
7801
7893
  export type WorkBuddySettingsJobTemplatesListResponse = { items: { id: string; name: string }[] };
7802
7894
  export type WorkBuddySettingsPrioritiesListResponse = {
@@ -12132,6 +12224,7 @@ export type WorkBuddySettingsItemsListResponse = {
12132
12224
  trackingCategory1?: string;
12133
12225
  trackingCategory2?: string;
12134
12226
  uoms?: { id?: string; uom: { id: string; name: string; abbreviation?: string }; conversionRate: number }[];
12227
+ childCodes?: { id: string; name: string; quantity: number }[];
12135
12228
  updatedAt?: string;
12136
12229
  }[];
12137
12230
  pagination: { limit: number; hasMore: boolean; nextCursor: string };
@@ -12170,6 +12263,7 @@ export type WorkBuddySettingsItemsCreateResponse = {
12170
12263
  trackingCategory1?: string;
12171
12264
  trackingCategory2?: string;
12172
12265
  uoms?: { id?: string; uom: { id: string; name: string; abbreviation?: string }; conversionRate: number }[];
12266
+ childCodes?: { id: string; name: string; quantity: number }[];
12173
12267
  updatedAt?: string;
12174
12268
  };
12175
12269
  };
@@ -12207,6 +12301,7 @@ export type WorkBuddySettingsItemsUpsertResponse = {
12207
12301
  trackingCategory1?: string;
12208
12302
  trackingCategory2?: string;
12209
12303
  uoms?: { id?: string; uom: { id: string; name: string; abbreviation?: string }; conversionRate: number }[];
12304
+ childCodes?: { id: string; name: string; quantity: number }[];
12210
12305
  updatedAt?: string;
12211
12306
  };
12212
12307
  };
@@ -12244,6 +12339,7 @@ export type WorkBuddySettingsItemsGetResponse = {
12244
12339
  trackingCategory1?: string;
12245
12340
  trackingCategory2?: string;
12246
12341
  uoms?: { id?: string; uom: { id: string; name: string; abbreviation?: string }; conversionRate: number }[];
12342
+ childCodes?: { id: string; name: string; quantity: number }[];
12247
12343
  updatedAt?: string;
12248
12344
  };
12249
12345
  };
@@ -12281,6 +12377,7 @@ export type WorkBuddySettingsItemsUpdateResponse = {
12281
12377
  trackingCategory1?: string;
12282
12378
  trackingCategory2?: string;
12283
12379
  uoms?: { id?: string; uom: { id: string; name: string; abbreviation?: string }; conversionRate: number }[];
12380
+ childCodes?: { id: string; name: string; quantity: number }[];
12284
12381
  updatedAt?: string;
12285
12382
  };
12286
12383
  };
@@ -15627,7 +15724,7 @@ export interface WorkBuddySettingsResource {
15627
15724
 
15628
15725
  export interface WorkBuddySettingsEntityStatusesResource {
15629
15726
  /**
15630
- * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item
15727
+ * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item, item
15631
15728
  * Operation: PublicApiEntityStatusController_list
15632
15729
  */
15633
15730
  list<TResponse = WorkBuddySettingsEntityStatusesListResponse>(
package/index.js CHANGED
@@ -720,7 +720,7 @@ export class WorkBuddyClient {
720
720
  this.settings = {
721
721
  entityStatuses: {
722
722
  /**
723
- * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item
723
+ * Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item, item
724
724
  * Operation: PublicApiEntityStatusController_list
725
725
  */
726
726
  list: (params = {}, options = {}) => this.request('PublicApiEntityStatusController_list', params, options),
@@ -2358,7 +2358,7 @@ export const operations = [
2358
2358
  actionName: 'list',
2359
2359
  displayName: 'List entity statuses',
2360
2360
  description:
2361
- 'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item',
2361
+ 'Retrieve all active statuses for a given entity type. Supported entities: customer, contractor, supplier, contact, external-user, pending-item, item',
2362
2362
  method: 'GET',
2363
2363
  path: '/settings/entity-statuses/{entity}',
2364
2364
  pathParams: ['entity'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workbuddy/sdk-js-vnext",
3
- "version": "1.0.139",
3
+ "version": "1.0.141",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",