windmill-client 1.770.0 → 1.771.0

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.
@@ -1480,6 +1480,48 @@ export type NewWorkspaceDependencies = {
1480
1480
  description?: string;
1481
1481
  content: string;
1482
1482
  };
1483
+ /**
1484
+ * A row in the merged runnables listing. `type` is the discriminator;
1485
+ * kind-specific fields (hash/language/kind for scripts, execution_mode/
1486
+ * version for apps) are present only for that kind. `edited_at` is the
1487
+ * unified last-updated time (a script's created_at, a flow/app's edit
1488
+ * time).
1489
+ *
1490
+ */
1491
+ export type RunnableItem = {
1492
+ type: 'script' | 'flow' | 'app';
1493
+ path: string;
1494
+ summary?: string;
1495
+ workspace_id?: string;
1496
+ extra_perms?: {
1497
+ [key: string]: (boolean);
1498
+ };
1499
+ starred?: boolean;
1500
+ archived?: boolean;
1501
+ is_draft?: boolean;
1502
+ draft_only?: boolean | null;
1503
+ draft_path?: string;
1504
+ draft_users?: Array<{
1505
+ [key: string]: unknown;
1506
+ }>;
1507
+ labels?: Array<(string)>;
1508
+ inherited_labels?: Array<(string)>;
1509
+ ws_error_handler_muted?: boolean;
1510
+ edited_at?: string;
1511
+ /**
1512
+ * script version hash as a 16-char hex string
1513
+ */
1514
+ hash?: string;
1515
+ language?: string;
1516
+ kind?: string;
1517
+ auto_kind?: string;
1518
+ use_codebase?: boolean;
1519
+ has_deploy_errors?: boolean;
1520
+ raw_app?: boolean;
1521
+ execution_mode?: string;
1522
+ id?: number;
1523
+ version?: number;
1524
+ };
1483
1525
  export type Script = {
1484
1526
  workspace_id?: string;
1485
1527
  hash: string;
@@ -1730,6 +1772,20 @@ export type CompletedJob = {
1730
1772
  aggregate_wait_time_ms?: number;
1731
1773
  preprocessed?: boolean;
1732
1774
  is_retry?: boolean;
1775
+ /**
1776
+ * whether this failure has been marked as handled
1777
+ */
1778
+ resolved?: boolean;
1779
+ /**
1780
+ * who resolved the failure. Enterprise-only, so also absent for a manual resolution outside enterprise; use resolved_automatically to tell the two apart
1781
+ */
1782
+ resolved_by?: string;
1783
+ resolved_at?: string;
1784
+ resolution_note?: string;
1785
+ /**
1786
+ * true when a succeeding retry resolved this rather than a person. Explicit rather than inferred from an absent resolved_by, which is also absent for a manual resolution outside enterprise
1787
+ */
1788
+ resolved_automatically?: boolean;
1733
1789
  worker?: string;
1734
1790
  };
1735
1791
  /**
@@ -10430,6 +10486,47 @@ export type DiffRawScriptsWithDeployedData = {
10430
10486
  workspace: string;
10431
10487
  };
10432
10488
  export type DiffRawScriptsWithDeployedResponse = Array<(string)>;
10489
+ export type ListRunnablesData = {
10490
+ /**
10491
+ * opaque keyset cursor from a previous page's next_cursor
10492
+ */
10493
+ cursor?: string;
10494
+ /**
10495
+ * include library scripts (no runnable main)
10496
+ */
10497
+ includeWithoutMain?: boolean;
10498
+ /**
10499
+ * comma-separated subset of script,flow,app (default all)
10500
+ */
10501
+ kinds?: string;
10502
+ label?: string;
10503
+ /**
10504
+ * sort key: 'updated' (default) or 'name'
10505
+ */
10506
+ orderBy?: 'updated' | 'name';
10507
+ /**
10508
+ * order by desc order (default true)
10509
+ */
10510
+ orderDesc?: boolean;
10511
+ /**
10512
+ * restrict to paths under this prefix
10513
+ */
10514
+ pathStart?: string;
10515
+ /**
10516
+ * number of items to return for a given page (default 30, max 100)
10517
+ */
10518
+ perPage?: number;
10519
+ /**
10520
+ * case-insensitive substring match on summary or path
10521
+ */
10522
+ search?: string;
10523
+ showArchived?: boolean;
10524
+ workspace: string;
10525
+ };
10526
+ export type ListRunnablesResponse = {
10527
+ items: Array<RunnableItem>;
10528
+ next_cursor?: string;
10529
+ };
10433
10530
  export type ListDraftsData = {
10434
10531
  /**
10435
10532
  * List every draft in the workspace (all users), not just the current user's own + legacy rows. Other users' rows come back with `mine=false` (view-only).
@@ -11820,6 +11917,10 @@ export type ListFilteredJobsUuidsData = {
11820
11917
  * number of items to return for a given page (default 30, max 100)
11821
11918
  */
11822
11919
  perPage?: number;
11920
+ /**
11921
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
11922
+ */
11923
+ resolved?: boolean;
11823
11924
  /**
11824
11925
  * filter on jobs containing those result as a json subset (@> in postgres)
11825
11926
  */
@@ -12042,6 +12143,10 @@ export type ListCompletedJobsData = {
12042
12143
  * number of items to return for a given page (default 30, max 100)
12043
12144
  */
12044
12145
  perPage?: number;
12146
+ /**
12147
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12148
+ */
12149
+ resolved?: boolean;
12045
12150
  /**
12046
12151
  * filter on jobs containing those result as a json subset (@> in postgres)
12047
12152
  */
@@ -12209,6 +12314,10 @@ export type ListJobsData = {
12209
12314
  * number of items to return for a given page (default 30, max 100)
12210
12315
  */
12211
12316
  perPage?: number;
12317
+ /**
12318
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12319
+ */
12320
+ resolved?: boolean;
12212
12321
  /**
12213
12322
  * filter on jobs containing those result as a json subset (@> in postgres)
12214
12323
  */
@@ -12491,6 +12600,28 @@ export type DeleteCompletedJobData = {
12491
12600
  workspace: string;
12492
12601
  };
12493
12602
  export type DeleteCompletedJobResponse = CompletedJob;
12603
+ export type ResolveCompletedJobsData = {
12604
+ requestBody: {
12605
+ job_ids: Array<(string)>;
12606
+ /**
12607
+ * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
12608
+ */
12609
+ note?: string;
12610
+ /**
12611
+ * id of a later successful run of the same runnable that supersedes the failure. Verified server-side, and the resulting note is the server's own wording, so it is recorded regardless of licence. A claim that cannot be verified resolves nothing
12612
+ */
12613
+ superseded_by?: string;
12614
+ };
12615
+ workspace: string;
12616
+ };
12617
+ export type ResolveCompletedJobsResponse = Array<(string)>;
12618
+ export type UnresolveCompletedJobsData = {
12619
+ requestBody: {
12620
+ job_ids: Array<(string)>;
12621
+ };
12622
+ workspace: string;
12623
+ };
12624
+ export type UnresolveCompletedJobsResponse = Array<(string)>;
12494
12625
  export type CancelQueuedJobData = {
12495
12626
  id: string;
12496
12627
  /**
@@ -12561,6 +12692,20 @@ export type GetResumeUrlsResponse = {
12561
12692
  resume: string;
12562
12693
  cancel: string;
12563
12694
  };
12695
+ export type GetWacApprovalUrlsData = {
12696
+ approver?: string;
12697
+ id: string;
12698
+ /**
12699
+ * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
12700
+ */
12701
+ stepKey: string;
12702
+ workspace: string;
12703
+ };
12704
+ export type GetWacApprovalUrlsResponse = {
12705
+ approvalPage: string;
12706
+ resume: string;
12707
+ cancel: string;
12708
+ };
12564
12709
  export type GetSlackApprovalPayloadData = {
12565
12710
  approver?: string;
12566
12711
  cancelButtonText?: string;
@@ -12808,6 +12953,10 @@ export type ListExtendedJobsData = {
12808
12953
  * number of items to return for a given page (default 30, max 100)
12809
12954
  */
12810
12955
  perPage?: number;
12956
+ /**
12957
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12958
+ */
12959
+ resolved?: boolean;
12811
12960
  /**
12812
12961
  * filter on jobs containing those result as a json subset (@> in postgres)
12813
12962
  */
@@ -14739,6 +14888,14 @@ export type ListFolderNamesData = {
14739
14888
  * only list the folders the user is member of (default false)
14740
14889
  */
14741
14890
  onlyMemberOf?: boolean;
14891
+ /**
14892
+ * which page to return (start at 1, default 1)
14893
+ */
14894
+ page?: number;
14895
+ /**
14896
+ * number of items to return for a given page (default 30, max 100)
14897
+ */
14898
+ perPage?: number;
14742
14899
  workspace: string;
14743
14900
  };
14744
14901
  export type ListFolderNamesResponse = Array<(string)>;
@@ -16010,6 +16167,22 @@ export type PublishHubRawAppEmbedData = {
16010
16167
  workspace: string;
16011
16168
  };
16012
16169
  export type PublishHubRawAppEmbedResponse = string;
16170
+ export type PublishHubRawAppRecordingData = {
16171
+ /**
16172
+ * workspace folder scoping the Hub publication: a workspace can publish
16173
+ * one Hub project per folder and the Hub-side source key is
16174
+ * `{workspace}:{folder}`
16175
+ *
16176
+ */
16177
+ folder: string;
16178
+ /**
16179
+ * hub id of the raw app
16180
+ */
16181
+ id: number;
16182
+ requestBody: RecordingBody;
16183
+ workspace: string;
16184
+ };
16185
+ export type PublishHubRawAppRecordingResponse = string;
16013
16186
  export type PublishHubScriptRecordingData = {
16014
16187
  /**
16015
16188
  * hub ask id of the script
@@ -23740,6 +23913,56 @@ export type $OpenApiTs = {
23740
23913
  };
23741
23914
  };
23742
23915
  };
23916
+ '/w/{workspace}/runnables/list': {
23917
+ get: {
23918
+ req: {
23919
+ /**
23920
+ * opaque keyset cursor from a previous page's next_cursor
23921
+ */
23922
+ cursor?: string;
23923
+ /**
23924
+ * include library scripts (no runnable main)
23925
+ */
23926
+ includeWithoutMain?: boolean;
23927
+ /**
23928
+ * comma-separated subset of script,flow,app (default all)
23929
+ */
23930
+ kinds?: string;
23931
+ label?: string;
23932
+ /**
23933
+ * sort key: 'updated' (default) or 'name'
23934
+ */
23935
+ orderBy?: 'updated' | 'name';
23936
+ /**
23937
+ * order by desc order (default true)
23938
+ */
23939
+ orderDesc?: boolean;
23940
+ /**
23941
+ * restrict to paths under this prefix
23942
+ */
23943
+ pathStart?: string;
23944
+ /**
23945
+ * number of items to return for a given page (default 30, max 100)
23946
+ */
23947
+ perPage?: number;
23948
+ /**
23949
+ * case-insensitive substring match on summary or path
23950
+ */
23951
+ search?: string;
23952
+ showArchived?: boolean;
23953
+ workspace: string;
23954
+ };
23955
+ res: {
23956
+ /**
23957
+ * a page of merged, ordered runnables
23958
+ */
23959
+ 200: {
23960
+ items: Array<RunnableItem>;
23961
+ next_cursor?: string;
23962
+ };
23963
+ };
23964
+ };
23965
+ };
23743
23966
  '/w/{workspace}/drafts/list': {
23744
23967
  get: {
23745
23968
  req: {
@@ -25646,6 +25869,10 @@ export type $OpenApiTs = {
25646
25869
  * number of items to return for a given page (default 30, max 100)
25647
25870
  */
25648
25871
  perPage?: number;
25872
+ /**
25873
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
25874
+ */
25875
+ resolved?: boolean;
25649
25876
  /**
25650
25877
  * filter on jobs containing those result as a json subset (@> in postgres)
25651
25878
  */
@@ -25904,6 +26131,10 @@ export type $OpenApiTs = {
25904
26131
  * number of items to return for a given page (default 30, max 100)
25905
26132
  */
25906
26133
  perPage?: number;
26134
+ /**
26135
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
26136
+ */
26137
+ resolved?: boolean;
25907
26138
  /**
25908
26139
  * filter on jobs containing those result as a json subset (@> in postgres)
25909
26140
  */
@@ -26125,6 +26356,10 @@ export type $OpenApiTs = {
26125
26356
  * number of items to return for a given page (default 30, max 100)
26126
26357
  */
26127
26358
  perPage?: number;
26359
+ /**
26360
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
26361
+ */
26362
+ resolved?: boolean;
26128
26363
  /**
26129
26364
  * filter on jobs containing those result as a json subset (@> in postgres)
26130
26365
  */
@@ -26603,6 +26838,46 @@ export type $OpenApiTs = {
26603
26838
  };
26604
26839
  };
26605
26840
  };
26841
+ '/w/{workspace}/jobs/completed/resolve': {
26842
+ post: {
26843
+ req: {
26844
+ requestBody: {
26845
+ job_ids: Array<(string)>;
26846
+ /**
26847
+ * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
26848
+ */
26849
+ note?: string;
26850
+ /**
26851
+ * id of a later successful run of the same runnable that supersedes the failure. Verified server-side, and the resulting note is the server's own wording, so it is recorded regardless of licence. A claim that cannot be verified resolves nothing
26852
+ */
26853
+ superseded_by?: string;
26854
+ };
26855
+ workspace: string;
26856
+ };
26857
+ res: {
26858
+ /**
26859
+ * ids of the jobs that were resolved
26860
+ */
26861
+ 200: Array<(string)>;
26862
+ };
26863
+ };
26864
+ };
26865
+ '/w/{workspace}/jobs/completed/unresolve': {
26866
+ post: {
26867
+ req: {
26868
+ requestBody: {
26869
+ job_ids: Array<(string)>;
26870
+ };
26871
+ workspace: string;
26872
+ };
26873
+ res: {
26874
+ /**
26875
+ * ids of the jobs that were unresolved
26876
+ */
26877
+ 200: Array<(string)>;
26878
+ };
26879
+ };
26880
+ };
26606
26881
  '/w/{workspace}/jobs_u/queue/cancel/{id}': {
26607
26882
  post: {
26608
26883
  req: {
@@ -26736,6 +27011,29 @@ export type $OpenApiTs = {
26736
27011
  };
26737
27012
  };
26738
27013
  };
27014
+ '/w/{workspace}/jobs/wac_approval_urls/{id}/{step_key}': {
27015
+ get: {
27016
+ req: {
27017
+ approver?: string;
27018
+ id: string;
27019
+ /**
27020
+ * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
27021
+ */
27022
+ stepKey: string;
27023
+ workspace: string;
27024
+ };
27025
+ res: {
27026
+ /**
27027
+ * url endpoints
27028
+ */
27029
+ 200: {
27030
+ approvalPage: string;
27031
+ resume: string;
27032
+ cancel: string;
27033
+ };
27034
+ };
27035
+ };
27036
+ };
26739
27037
  '/w/{workspace}/jobs/slack_approval/{id}': {
26740
27038
  get: {
26741
27039
  req: {
@@ -27087,6 +27385,10 @@ export type $OpenApiTs = {
27087
27385
  * number of items to return for a given page (default 30, max 100)
27088
27386
  */
27089
27387
  perPage?: number;
27388
+ /**
27389
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
27390
+ */
27391
+ resolved?: boolean;
27090
27392
  /**
27091
27393
  * filter on jobs containing those result as a json subset (@> in postgres)
27092
27394
  */
@@ -30566,6 +30868,14 @@ export type $OpenApiTs = {
30566
30868
  * only list the folders the user is member of (default false)
30567
30869
  */
30568
30870
  onlyMemberOf?: boolean;
30871
+ /**
30872
+ * which page to return (start at 1, default 1)
30873
+ */
30874
+ page?: number;
30875
+ /**
30876
+ * number of items to return for a given page (default 30, max 100)
30877
+ */
30878
+ perPage?: number;
30569
30879
  workspace: string;
30570
30880
  };
30571
30881
  res: {
@@ -32772,6 +33082,31 @@ export type $OpenApiTs = {
32772
33082
  };
32773
33083
  };
32774
33084
  };
33085
+ '/w/{workspace}/hub/raw_apps/{id}/recording': {
33086
+ post: {
33087
+ req: {
33088
+ /**
33089
+ * workspace folder scoping the Hub publication: a workspace can publish
33090
+ * one Hub project per folder and the Hub-side source key is
33091
+ * `{workspace}:{folder}`
33092
+ *
33093
+ */
33094
+ folder: string;
33095
+ /**
33096
+ * hub id of the raw app
33097
+ */
33098
+ id: number;
33099
+ requestBody: RecordingBody;
33100
+ workspace: string;
33101
+ };
33102
+ res: {
33103
+ /**
33104
+ * raw Hub response body (status code is passed through from the Hub)
33105
+ */
33106
+ 200: string;
33107
+ };
33108
+ };
33109
+ };
32775
33110
  '/w/{workspace}/hub/scripts/{ask_id}/recording': {
32776
33111
  post: {
32777
33112
  req: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "windmill-client",
3
3
  "description": "Windmill SDK client for browsers and Node.js",
4
- "version": "1.770.0",
4
+ "version": "1.771.0",
5
5
  "author": "Ruben Fiszel",
6
6
  "license": "Apache 2.0",
7
7
  "homepage": "https://github.com/windmill-labs/windmill/tree/main/typescript-client#readme",