windmill-client 1.770.0 → 1.771.1

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
  /**
@@ -6155,13 +6211,6 @@ export type PublishRawAppBody = {
6155
6211
  source_path?: string;
6156
6212
  project_slug: HubProjectSlug;
6157
6213
  };
6158
- export type RawAppEmbedBody = {
6159
- /**
6160
- * explicit `null` clears the embed (unpublish)
6161
- */
6162
- external_embed_url?: string | null;
6163
- project_slug: HubProjectSlug;
6164
- };
6165
6214
  export type RecordingBody = {
6166
6215
  recording?: {
6167
6216
  [key: string]: unknown;
@@ -10430,6 +10479,47 @@ export type DiffRawScriptsWithDeployedData = {
10430
10479
  workspace: string;
10431
10480
  };
10432
10481
  export type DiffRawScriptsWithDeployedResponse = Array<(string)>;
10482
+ export type ListRunnablesData = {
10483
+ /**
10484
+ * opaque keyset cursor from a previous page's next_cursor
10485
+ */
10486
+ cursor?: string;
10487
+ /**
10488
+ * include library scripts (no runnable main)
10489
+ */
10490
+ includeWithoutMain?: boolean;
10491
+ /**
10492
+ * comma-separated subset of script,flow,app (default all)
10493
+ */
10494
+ kinds?: string;
10495
+ label?: string;
10496
+ /**
10497
+ * sort key: 'updated' (default) or 'name'
10498
+ */
10499
+ orderBy?: 'updated' | 'name';
10500
+ /**
10501
+ * order by desc order (default true)
10502
+ */
10503
+ orderDesc?: boolean;
10504
+ /**
10505
+ * restrict to paths under this prefix
10506
+ */
10507
+ pathStart?: string;
10508
+ /**
10509
+ * number of items to return for a given page (default 30, max 100)
10510
+ */
10511
+ perPage?: number;
10512
+ /**
10513
+ * case-insensitive substring match on summary or path
10514
+ */
10515
+ search?: string;
10516
+ showArchived?: boolean;
10517
+ workspace: string;
10518
+ };
10519
+ export type ListRunnablesResponse = {
10520
+ items: Array<RunnableItem>;
10521
+ next_cursor?: string;
10522
+ };
10433
10523
  export type ListDraftsData = {
10434
10524
  /**
10435
10525
  * 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 +11910,10 @@ export type ListFilteredJobsUuidsData = {
11820
11910
  * number of items to return for a given page (default 30, max 100)
11821
11911
  */
11822
11912
  perPage?: number;
11913
+ /**
11914
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
11915
+ */
11916
+ resolved?: boolean;
11823
11917
  /**
11824
11918
  * filter on jobs containing those result as a json subset (@> in postgres)
11825
11919
  */
@@ -12042,6 +12136,10 @@ export type ListCompletedJobsData = {
12042
12136
  * number of items to return for a given page (default 30, max 100)
12043
12137
  */
12044
12138
  perPage?: number;
12139
+ /**
12140
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12141
+ */
12142
+ resolved?: boolean;
12045
12143
  /**
12046
12144
  * filter on jobs containing those result as a json subset (@> in postgres)
12047
12145
  */
@@ -12209,6 +12307,10 @@ export type ListJobsData = {
12209
12307
  * number of items to return for a given page (default 30, max 100)
12210
12308
  */
12211
12309
  perPage?: number;
12310
+ /**
12311
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12312
+ */
12313
+ resolved?: boolean;
12212
12314
  /**
12213
12315
  * filter on jobs containing those result as a json subset (@> in postgres)
12214
12316
  */
@@ -12491,6 +12593,28 @@ export type DeleteCompletedJobData = {
12491
12593
  workspace: string;
12492
12594
  };
12493
12595
  export type DeleteCompletedJobResponse = CompletedJob;
12596
+ export type ResolveCompletedJobsData = {
12597
+ requestBody: {
12598
+ job_ids: Array<(string)>;
12599
+ /**
12600
+ * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
12601
+ */
12602
+ note?: string;
12603
+ /**
12604
+ * 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
12605
+ */
12606
+ superseded_by?: string;
12607
+ };
12608
+ workspace: string;
12609
+ };
12610
+ export type ResolveCompletedJobsResponse = Array<(string)>;
12611
+ export type UnresolveCompletedJobsData = {
12612
+ requestBody: {
12613
+ job_ids: Array<(string)>;
12614
+ };
12615
+ workspace: string;
12616
+ };
12617
+ export type UnresolveCompletedJobsResponse = Array<(string)>;
12494
12618
  export type CancelQueuedJobData = {
12495
12619
  id: string;
12496
12620
  /**
@@ -12561,6 +12685,20 @@ export type GetResumeUrlsResponse = {
12561
12685
  resume: string;
12562
12686
  cancel: string;
12563
12687
  };
12688
+ export type GetWacApprovalUrlsData = {
12689
+ approver?: string;
12690
+ id: string;
12691
+ /**
12692
+ * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
12693
+ */
12694
+ stepKey: string;
12695
+ workspace: string;
12696
+ };
12697
+ export type GetWacApprovalUrlsResponse = {
12698
+ approvalPage: string;
12699
+ resume: string;
12700
+ cancel: string;
12701
+ };
12564
12702
  export type GetSlackApprovalPayloadData = {
12565
12703
  approver?: string;
12566
12704
  cancelButtonText?: string;
@@ -12808,6 +12946,10 @@ export type ListExtendedJobsData = {
12808
12946
  * number of items to return for a given page (default 30, max 100)
12809
12947
  */
12810
12948
  perPage?: number;
12949
+ /**
12950
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
12951
+ */
12952
+ resolved?: boolean;
12811
12953
  /**
12812
12954
  * filter on jobs containing those result as a json subset (@> in postgres)
12813
12955
  */
@@ -14739,6 +14881,14 @@ export type ListFolderNamesData = {
14739
14881
  * only list the folders the user is member of (default false)
14740
14882
  */
14741
14883
  onlyMemberOf?: boolean;
14884
+ /**
14885
+ * which page to return (start at 1, default 1)
14886
+ */
14887
+ page?: number;
14888
+ /**
14889
+ * number of items to return for a given page (default 30, max 100)
14890
+ */
14891
+ perPage?: number;
14742
14892
  workspace: string;
14743
14893
  };
14744
14894
  export type ListFolderNamesResponse = Array<(string)>;
@@ -15994,7 +16144,7 @@ export type PublishHubRawAppData = {
15994
16144
  workspace: string;
15995
16145
  };
15996
16146
  export type PublishHubRawAppResponse = string;
15997
- export type PublishHubRawAppEmbedData = {
16147
+ export type PublishHubRawAppRecordingData = {
15998
16148
  /**
15999
16149
  * workspace folder scoping the Hub publication: a workspace can publish
16000
16150
  * one Hub project per folder and the Hub-side source key is
@@ -16006,10 +16156,10 @@ export type PublishHubRawAppEmbedData = {
16006
16156
  * hub id of the raw app
16007
16157
  */
16008
16158
  id: number;
16009
- requestBody: RawAppEmbedBody;
16159
+ requestBody: RecordingBody;
16010
16160
  workspace: string;
16011
16161
  };
16012
- export type PublishHubRawAppEmbedResponse = string;
16162
+ export type PublishHubRawAppRecordingResponse = string;
16013
16163
  export type PublishHubScriptRecordingData = {
16014
16164
  /**
16015
16165
  * hub ask id of the script
@@ -23740,6 +23890,56 @@ export type $OpenApiTs = {
23740
23890
  };
23741
23891
  };
23742
23892
  };
23893
+ '/w/{workspace}/runnables/list': {
23894
+ get: {
23895
+ req: {
23896
+ /**
23897
+ * opaque keyset cursor from a previous page's next_cursor
23898
+ */
23899
+ cursor?: string;
23900
+ /**
23901
+ * include library scripts (no runnable main)
23902
+ */
23903
+ includeWithoutMain?: boolean;
23904
+ /**
23905
+ * comma-separated subset of script,flow,app (default all)
23906
+ */
23907
+ kinds?: string;
23908
+ label?: string;
23909
+ /**
23910
+ * sort key: 'updated' (default) or 'name'
23911
+ */
23912
+ orderBy?: 'updated' | 'name';
23913
+ /**
23914
+ * order by desc order (default true)
23915
+ */
23916
+ orderDesc?: boolean;
23917
+ /**
23918
+ * restrict to paths under this prefix
23919
+ */
23920
+ pathStart?: string;
23921
+ /**
23922
+ * number of items to return for a given page (default 30, max 100)
23923
+ */
23924
+ perPage?: number;
23925
+ /**
23926
+ * case-insensitive substring match on summary or path
23927
+ */
23928
+ search?: string;
23929
+ showArchived?: boolean;
23930
+ workspace: string;
23931
+ };
23932
+ res: {
23933
+ /**
23934
+ * a page of merged, ordered runnables
23935
+ */
23936
+ 200: {
23937
+ items: Array<RunnableItem>;
23938
+ next_cursor?: string;
23939
+ };
23940
+ };
23941
+ };
23942
+ };
23743
23943
  '/w/{workspace}/drafts/list': {
23744
23944
  get: {
23745
23945
  req: {
@@ -25646,6 +25846,10 @@ export type $OpenApiTs = {
25646
25846
  * number of items to return for a given page (default 30, max 100)
25647
25847
  */
25648
25848
  perPage?: number;
25849
+ /**
25850
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
25851
+ */
25852
+ resolved?: boolean;
25649
25853
  /**
25650
25854
  * filter on jobs containing those result as a json subset (@> in postgres)
25651
25855
  */
@@ -25904,6 +26108,10 @@ export type $OpenApiTs = {
25904
26108
  * number of items to return for a given page (default 30, max 100)
25905
26109
  */
25906
26110
  perPage?: number;
26111
+ /**
26112
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
26113
+ */
26114
+ resolved?: boolean;
25907
26115
  /**
25908
26116
  * filter on jobs containing those result as a json subset (@> in postgres)
25909
26117
  */
@@ -26125,6 +26333,10 @@ export type $OpenApiTs = {
26125
26333
  * number of items to return for a given page (default 30, max 100)
26126
26334
  */
26127
26335
  perPage?: number;
26336
+ /**
26337
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
26338
+ */
26339
+ resolved?: boolean;
26128
26340
  /**
26129
26341
  * filter on jobs containing those result as a json subset (@> in postgres)
26130
26342
  */
@@ -26603,6 +26815,46 @@ export type $OpenApiTs = {
26603
26815
  };
26604
26816
  };
26605
26817
  };
26818
+ '/w/{workspace}/jobs/completed/resolve': {
26819
+ post: {
26820
+ req: {
26821
+ requestBody: {
26822
+ job_ids: Array<(string)>;
26823
+ /**
26824
+ * a person's explanation of why the failure is considered handled. Enterprise-only: ignored outside enterprise
26825
+ */
26826
+ note?: string;
26827
+ /**
26828
+ * 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
26829
+ */
26830
+ superseded_by?: string;
26831
+ };
26832
+ workspace: string;
26833
+ };
26834
+ res: {
26835
+ /**
26836
+ * ids of the jobs that were resolved
26837
+ */
26838
+ 200: Array<(string)>;
26839
+ };
26840
+ };
26841
+ };
26842
+ '/w/{workspace}/jobs/completed/unresolve': {
26843
+ post: {
26844
+ req: {
26845
+ requestBody: {
26846
+ job_ids: Array<(string)>;
26847
+ };
26848
+ workspace: string;
26849
+ };
26850
+ res: {
26851
+ /**
26852
+ * ids of the jobs that were unresolved
26853
+ */
26854
+ 200: Array<(string)>;
26855
+ };
26856
+ };
26857
+ };
26606
26858
  '/w/{workspace}/jobs_u/queue/cancel/{id}': {
26607
26859
  post: {
26608
26860
  req: {
@@ -26736,6 +26988,29 @@ export type $OpenApiTs = {
26736
26988
  };
26737
26989
  };
26738
26990
  };
26991
+ '/w/{workspace}/jobs/wac_approval_urls/{id}/{step_key}': {
26992
+ get: {
26993
+ req: {
26994
+ approver?: string;
26995
+ id: string;
26996
+ /**
26997
+ * checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
26998
+ */
26999
+ stepKey: string;
27000
+ workspace: string;
27001
+ };
27002
+ res: {
27003
+ /**
27004
+ * url endpoints
27005
+ */
27006
+ 200: {
27007
+ approvalPage: string;
27008
+ resume: string;
27009
+ cancel: string;
27010
+ };
27011
+ };
27012
+ };
27013
+ };
26739
27014
  '/w/{workspace}/jobs/slack_approval/{id}': {
26740
27015
  get: {
26741
27016
  req: {
@@ -27087,6 +27362,10 @@ export type $OpenApiTs = {
27087
27362
  * number of items to return for a given page (default 30, max 100)
27088
27363
  */
27089
27364
  perPage?: number;
27365
+ /**
27366
+ * filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
27367
+ */
27368
+ resolved?: boolean;
27090
27369
  /**
27091
27370
  * filter on jobs containing those result as a json subset (@> in postgres)
27092
27371
  */
@@ -30566,6 +30845,14 @@ export type $OpenApiTs = {
30566
30845
  * only list the folders the user is member of (default false)
30567
30846
  */
30568
30847
  onlyMemberOf?: boolean;
30848
+ /**
30849
+ * which page to return (start at 1, default 1)
30850
+ */
30851
+ page?: number;
30852
+ /**
30853
+ * number of items to return for a given page (default 30, max 100)
30854
+ */
30855
+ perPage?: number;
30569
30856
  workspace: string;
30570
30857
  };
30571
30858
  res: {
@@ -32747,7 +33034,7 @@ export type $OpenApiTs = {
32747
33034
  };
32748
33035
  };
32749
33036
  };
32750
- '/w/{workspace}/hub/raw_apps/{id}/embed': {
33037
+ '/w/{workspace}/hub/raw_apps/{id}/recording': {
32751
33038
  post: {
32752
33039
  req: {
32753
33040
  /**
@@ -32761,7 +33048,7 @@ export type $OpenApiTs = {
32761
33048
  * hub id of the raw app
32762
33049
  */
32763
33050
  id: number;
32764
- requestBody: RawAppEmbedBody;
33051
+ requestBody: RecordingBody;
32765
33052
  workspace: string;
32766
33053
  };
32767
33054
  res: {
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.1",
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",