@workbuddy/sdk-js-vnext 1.0.134 → 1.0.135

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 +59 -0
  2. package/index.js +38 -0
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -134,6 +134,21 @@ export class WorkBuddyClient {
134
134
  getAccessToken(): Promise<string | undefined>;
135
135
  }
136
136
 
137
+ export interface WorkBuddyJobsActionsListParams extends WorkBuddyRequestParams {}
138
+
139
+ export interface WorkBuddyJobsActionsRunParams extends WorkBuddyRequestParams {
140
+ /**
141
+ * Job ID, job number, or external integration ID
142
+ */
143
+ id: string;
144
+ /**
145
+ * Action id from GET /jobs/actions
146
+ */
147
+ actionId: string;
148
+
149
+ input?: string;
150
+ }
151
+
137
152
  export interface WorkBuddyJobsSearchParams extends WorkBuddyRequestParams {
138
153
  /**
139
154
  * Search mode
@@ -3609,6 +3624,8 @@ export interface WorkBuddyJobsActivitiesNoteCreateNoteParams extends WorkBuddyRe
3609
3624
  body: string;
3610
3625
 
3611
3626
  title?: string;
3627
+
3628
+ merge?: boolean;
3612
3629
  /**
3613
3630
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
3614
3631
  */
@@ -3644,6 +3661,8 @@ export interface WorkBuddyJobsActivitiesEmailCreateEmailParams extends WorkBuddy
3644
3661
  * Recipients
3645
3662
  */
3646
3663
  to?: { email: string }[];
3664
+
3665
+ merge?: boolean;
3647
3666
  /**
3648
3667
  * CC recipients
3649
3668
  */
@@ -3683,6 +3702,8 @@ export interface WorkBuddyJobsActivitiesSmsCreateSmsParams extends WorkBuddyRequ
3683
3702
  * Recipients
3684
3703
  */
3685
3704
  to?: { name?: string; mobile: string }[];
3705
+
3706
+ merge?: boolean;
3686
3707
  /**
3687
3708
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
3688
3709
  */
@@ -3714,6 +3735,8 @@ export interface WorkBuddyJobsActivitiesEmailPreviewPreviewEmailParams extends W
3714
3735
  * Recipients
3715
3736
  */
3716
3737
  to?: { email: string }[];
3738
+
3739
+ merge?: boolean;
3717
3740
  /**
3718
3741
  * CC recipients
3719
3742
  */
@@ -3753,6 +3776,8 @@ export interface WorkBuddyJobsActivitiesSmsPreviewPreviewSmsParams extends WorkB
3753
3776
  * Recipients
3754
3777
  */
3755
3778
  to?: { name?: string; mobile: string }[];
3779
+
3780
+ merge?: boolean;
3756
3781
  /**
3757
3782
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
3758
3783
  */
@@ -3910,6 +3935,8 @@ export interface WorkBuddyJobsStagesActivitiesNoteCreateNoteParams extends WorkB
3910
3935
  body: string;
3911
3936
 
3912
3937
  title?: string;
3938
+
3939
+ merge?: boolean;
3913
3940
  /**
3914
3941
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
3915
3942
  */
@@ -3949,6 +3976,8 @@ export interface WorkBuddyJobsStagesActivitiesEmailCreateEmailParams extends Wor
3949
3976
  * Recipients
3950
3977
  */
3951
3978
  to?: { email: string }[];
3979
+
3980
+ merge?: boolean;
3952
3981
  /**
3953
3982
  * CC recipients
3954
3983
  */
@@ -3990,6 +4019,8 @@ export interface WorkBuddyJobsStagesActivitiesSmsCreateSmsParams extends WorkBud
3990
4019
  * Recipients
3991
4020
  */
3992
4021
  to?: { name?: string; mobile: string }[];
4022
+
4023
+ merge?: boolean;
3993
4024
  /**
3994
4025
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
3995
4026
  */
@@ -4023,6 +4054,8 @@ export interface WorkBuddyJobsStagesActivitiesEmailPreviewPreviewEmailParams ext
4023
4054
  * Recipients
4024
4055
  */
4025
4056
  to?: { email: string }[];
4057
+
4058
+ merge?: boolean;
4026
4059
  /**
4027
4060
  * CC recipients
4028
4061
  */
@@ -4064,6 +4097,8 @@ export interface WorkBuddyJobsStagesActivitiesSmsPreviewPreviewSmsParams extends
4064
4097
  * Recipients
4065
4098
  */
4066
4099
  to?: { name?: string; mobile: string }[];
4100
+
4101
+ merge?: boolean;
4067
4102
  /**
4068
4103
  * Array of label/tag IDs to attach (comma-separated, e.g. "id1,id2")
4069
4104
  */
@@ -6194,6 +6229,8 @@ export interface WorkBuddyMcpCreateParams extends WorkBuddyRequestParams {
6194
6229
 
6195
6230
  export interface WorkBuddyMcpDeleteParams extends WorkBuddyRequestParams {}
6196
6231
 
6232
+ export type WorkBuddyJobsActionsListResponse = unknown;
6233
+ export type WorkBuddyJobsActionsRunResponse = unknown;
6197
6234
  export type WorkBuddyJobsSearchResponse = {
6198
6235
  items: {
6199
6236
  id: string;
@@ -14392,6 +14429,8 @@ export type WorkBuddyMcpCreateResponse = unknown;
14392
14429
  export type WorkBuddyMcpDeleteResponse = unknown;
14393
14430
 
14394
14431
  export interface WorkBuddyJobsResource {
14432
+ /** Actions API operations. */
14433
+ actions: WorkBuddyJobsActionsResource;
14395
14434
  /** Template API operations. */
14396
14435
  template: WorkBuddyJobsTemplateResource;
14397
14436
  /** Finance API operations. */
@@ -14472,6 +14511,26 @@ export interface WorkBuddyJobsResource {
14472
14511
  ): Promise<TResponse>;
14473
14512
  }
14474
14513
 
14514
+ export interface WorkBuddyJobsActionsResource {
14515
+ /**
14516
+ * Metadata actions that can run on one Job: commands (change status, add note) and bulk-updatable fields as set-field actions. Each lists its input JSON Schema, required security rights and whether the UI confirms it first.
14517
+ * Operation: PublicApiJobActionController_list
14518
+ */
14519
+ list<TResponse = WorkBuddyJobsActionsListResponse>(
14520
+ params?: WorkBuddyJobsActionsListParams,
14521
+ options?: WorkBuddyRequestOptions
14522
+ ): Promise<TResponse>;
14523
+
14524
+ /**
14525
+ * Runs one action listed by GET /jobs/actions on a single Job, through the same executor as the board. Actions the UI confirms first run without confirmation here; the caller is authorised by its rights.
14526
+ * Operation: PublicApiJobActionController_run
14527
+ */
14528
+ run<TResponse = WorkBuddyJobsActionsRunResponse>(
14529
+ params: WorkBuddyJobsActionsRunParams,
14530
+ options?: WorkBuddyRequestOptions
14531
+ ): Promise<TResponse>;
14532
+ }
14533
+
14475
14534
  export interface WorkBuddyJobsTemplateResource {
14476
14535
  /**
14477
14536
  * Create a job using a job template. Template-owned fields win over request values before final job validation.
package/index.js CHANGED
@@ -34,6 +34,18 @@ export class WorkBuddyClient {
34
34
  }
35
35
 
36
36
  this.jobs = {
37
+ actions: {
38
+ /**
39
+ * Metadata actions that can run on one Job: commands (change status, add note) and bulk-updatable fields as set-field actions. Each lists its input JSON Schema, required security rights and whether the UI confirms it first.
40
+ * Operation: PublicApiJobActionController_list
41
+ */
42
+ list: (params = {}, options = {}) => this.request('PublicApiJobActionController_list', params, options),
43
+ /**
44
+ * Runs one action listed by GET /jobs/actions on a single Job, through the same executor as the board. Actions the UI confirms first run without confirmation here; the caller is authorised by its rights.
45
+ * Operation: PublicApiJobActionController_run
46
+ */
47
+ run: (params = {}, options = {}) => this.request('PublicApiJobActionController_run', params, options),
48
+ },
37
49
  template: {
38
50
  /**
39
51
  * Create a job using a job template. Template-owned fields win over request values before final job validation.
@@ -1737,6 +1749,32 @@ function buildErrorMessage(response, data) {
1737
1749
  }
1738
1750
 
1739
1751
  export const operations = [
1752
+ {
1753
+ operationId: 'PublicApiJobActionController_list',
1754
+ resourcePath: ['jobs', 'actions'],
1755
+ actionName: 'list',
1756
+ displayName: 'List Job actions',
1757
+ description:
1758
+ 'Metadata actions that can run on one Job: commands (change status, add note) and bulk-updatable fields as set-field actions. Each lists its input JSON Schema, required security rights and whether the UI confirms it first.',
1759
+ method: 'GET',
1760
+ path: '/jobs/actions',
1761
+ pathParams: [],
1762
+ queryParams: [],
1763
+ hasRequestBody: false,
1764
+ },
1765
+ {
1766
+ operationId: 'PublicApiJobActionController_run',
1767
+ resourcePath: ['jobs', 'actions'],
1768
+ actionName: 'run',
1769
+ displayName: 'Run a Job action',
1770
+ description:
1771
+ 'Runs one action listed by GET /jobs/actions on a single Job, through the same executor as the board. Actions the UI confirms first run without confirmation here; the caller is authorised by its rights.',
1772
+ method: 'POST',
1773
+ path: '/jobs/{id}/actions/{actionId}',
1774
+ pathParams: ['id', 'actionId'],
1775
+ queryParams: [],
1776
+ hasRequestBody: true,
1777
+ },
1740
1778
  {
1741
1779
  operationId: 'PublicApiJobController_search',
1742
1780
  resourcePath: ['jobs'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workbuddy/sdk-js-vnext",
3
- "version": "1.0.134",
3
+ "version": "1.0.135",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",