windmill-client 1.769.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.
@@ -7077,6 +7077,42 @@ var ScriptService = class {
7077
7077
  mediaType: "application/json"
7078
7078
  });
7079
7079
  }
7080
+ /**
7081
+ * list runnables (scripts, flows, apps) merged, ordered and keyset-paginated
7082
+ * @param data The data for the request.
7083
+ * @param data.workspace
7084
+ * @param data.orderBy sort key: 'updated' (default) or 'name'
7085
+ * @param data.orderDesc order by desc order (default true)
7086
+ * @param data.kinds comma-separated subset of script,flow,app (default all)
7087
+ * @param data.showArchived
7088
+ * @param data.includeWithoutMain include library scripts (no runnable main)
7089
+ * @param data.pathStart restrict to paths under this prefix
7090
+ * @param data.label
7091
+ * @param data.search case-insensitive substring match on summary or path
7092
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
7093
+ * @param data.cursor opaque keyset cursor from a previous page's next_cursor
7094
+ * @returns unknown a page of merged, ordered runnables
7095
+ * @throws ApiError
7096
+ */
7097
+ static listRunnables(data) {
7098
+ return request(OpenAPI, {
7099
+ method: "GET",
7100
+ url: "/w/{workspace}/runnables/list",
7101
+ path: { workspace: data.workspace },
7102
+ query: {
7103
+ order_by: data.orderBy,
7104
+ order_desc: data.orderDesc,
7105
+ kinds: data.kinds,
7106
+ show_archived: data.showArchived,
7107
+ include_without_main: data.includeWithoutMain,
7108
+ path_start: data.pathStart,
7109
+ label: data.label,
7110
+ search: data.search,
7111
+ per_page: data.perPage,
7112
+ cursor: data.cursor
7113
+ }
7114
+ });
7115
+ }
7080
7116
  };
7081
7117
  var DraftService = class {
7082
7118
  /**
@@ -8607,6 +8643,7 @@ var JobService = class {
8607
8643
  * @param data.page which page to return (start at 1, default 1)
8608
8644
  * @param data.perPage number of items to return for a given page (default 30, max 100)
8609
8645
  * @param data.isSkipped is the job skipped
8646
+ * @param data.resolved filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
8610
8647
  * @param data.isFlowStep is the job a flow step
8611
8648
  * @param data.hasNullParent has null parent
8612
8649
  * @param data.success filter on successful jobs
@@ -8648,6 +8685,7 @@ var JobService = class {
8648
8685
  page: data.page,
8649
8686
  per_page: data.perPage,
8650
8687
  is_skipped: data.isSkipped,
8688
+ resolved: data.resolved,
8651
8689
  is_flow_step: data.isFlowStep,
8652
8690
  has_null_parent: data.hasNullParent,
8653
8691
  success: data.success,
@@ -8785,6 +8823,7 @@ var JobService = class {
8785
8823
  * @param data.page which page to return (start at 1, default 1)
8786
8824
  * @param data.perPage number of items to return for a given page (default 30, max 100)
8787
8825
  * @param data.isSkipped is the job skipped
8826
+ * @param data.resolved filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
8788
8827
  * @param data.isFlowStep is the job a flow step
8789
8828
  * @param data.hasNullParent has null parent
8790
8829
  * @param data.isNotSchedule is not a scheduled job
@@ -8818,6 +8857,7 @@ var JobService = class {
8818
8857
  page: data.page,
8819
8858
  per_page: data.perPage,
8820
8859
  is_skipped: data.isSkipped,
8860
+ resolved: data.resolved,
8821
8861
  is_flow_step: data.isFlowStep,
8822
8862
  has_null_parent: data.hasNullParent,
8823
8863
  is_not_schedule: data.isNotSchedule
@@ -8946,6 +8986,7 @@ var JobService = class {
8946
8986
  * @param data.perPage number of items to return for a given page (default 30, max 100)
8947
8987
  * @param data.triggerKind filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
8948
8988
  * @param data.isSkipped is the job skipped
8989
+ * @param data.resolved filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
8949
8990
  * @param data.isFlowStep is the job a flow step
8950
8991
  * @param data.hasNullParent has null parent
8951
8992
  * @param data.success filter on successful jobs
@@ -8990,6 +9031,7 @@ var JobService = class {
8990
9031
  per_page: data.perPage,
8991
9032
  trigger_kind: data.triggerKind,
8992
9033
  is_skipped: data.isSkipped,
9034
+ resolved: data.resolved,
8993
9035
  is_flow_step: data.isFlowStep,
8994
9036
  has_null_parent: data.hasNullParent,
8995
9037
  success: data.success,
@@ -9428,6 +9470,41 @@ var JobService = class {
9428
9470
  });
9429
9471
  }
9430
9472
  /**
9473
+ * mark failed jobs as resolved
9474
+ * Marks failed jobs as handled so triage surfaces stop showing them as failures. The job status itself is unchanged. Returns the ids actually resolved: ids that are not visible to the caller or did not fail are silently skipped.
9475
+ * @param data The data for the request.
9476
+ * @param data.workspace
9477
+ * @param data.requestBody
9478
+ * @returns string ids of the jobs that were resolved
9479
+ * @throws ApiError
9480
+ */
9481
+ static resolveCompletedJobs(data) {
9482
+ return request(OpenAPI, {
9483
+ method: "POST",
9484
+ url: "/w/{workspace}/jobs/completed/resolve",
9485
+ path: { workspace: data.workspace },
9486
+ body: data.requestBody,
9487
+ mediaType: "application/json"
9488
+ });
9489
+ }
9490
+ /**
9491
+ * remove the resolution of failed jobs
9492
+ * @param data The data for the request.
9493
+ * @param data.workspace
9494
+ * @param data.requestBody
9495
+ * @returns string ids of the jobs that were unresolved
9496
+ * @throws ApiError
9497
+ */
9498
+ static unresolveCompletedJobs(data) {
9499
+ return request(OpenAPI, {
9500
+ method: "POST",
9501
+ url: "/w/{workspace}/jobs/completed/unresolve",
9502
+ path: { workspace: data.workspace },
9503
+ body: data.requestBody,
9504
+ mediaType: "application/json"
9505
+ });
9506
+ }
9507
+ /**
9431
9508
  * cancel queued or running job
9432
9509
  * @param data The data for the request.
9433
9510
  * @param data.workspace
@@ -9575,6 +9652,28 @@ var JobService = class {
9575
9652
  });
9576
9653
  }
9577
9654
  /**
9655
+ * get the resume urls bound to a specific wait_for_approval step of a workflow-as-code job
9656
+ * @param data The data for the request.
9657
+ * @param data.workspace
9658
+ * @param data.id
9659
+ * @param data.stepKey checkpoint key of the wait_for_approval step, as passed to `wait_for_approval(key=...)`
9660
+ * @param data.approver
9661
+ * @returns unknown url endpoints
9662
+ * @throws ApiError
9663
+ */
9664
+ static getWacApprovalUrls(data) {
9665
+ return request(OpenAPI, {
9666
+ method: "GET",
9667
+ url: "/w/{workspace}/jobs/wac_approval_urls/{id}/{step_key}",
9668
+ path: {
9669
+ workspace: data.workspace,
9670
+ id: data.id,
9671
+ step_key: data.stepKey
9672
+ },
9673
+ query: { approver: data.approver }
9674
+ });
9675
+ }
9676
+ /**
9578
9677
  * generate interactive slack approval for suspended job
9579
9678
  * @param data The data for the request.
9580
9679
  * @param data.workspace
@@ -9921,6 +10020,7 @@ var JobService = class {
9921
10020
  * @param data.perPage number of items to return for a given page (default 30, max 100)
9922
10021
  * @param data.triggerKind filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
9923
10022
  * @param data.isSkipped is the job skipped
10023
+ * @param data.resolved filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
9924
10024
  * @param data.isFlowStep is the job a flow step
9925
10025
  * @param data.hasNullParent has null parent
9926
10026
  * @param data.success filter on successful jobs
@@ -9962,6 +10062,7 @@ var JobService = class {
9962
10062
  per_page: data.perPage,
9963
10063
  trigger_kind: data.triggerKind,
9964
10064
  is_skipped: data.isSkipped,
10065
+ resolved: data.resolved,
9965
10066
  is_flow_step: data.isFlowStep,
9966
10067
  has_null_parent: data.hasNullParent,
9967
10068
  success: data.success,
@@ -13489,6 +13590,8 @@ var FolderService = class {
13489
13590
  * list folder names
13490
13591
  * @param data The data for the request.
13491
13592
  * @param data.workspace
13593
+ * @param data.page which page to return (start at 1, default 1)
13594
+ * @param data.perPage number of items to return for a given page (default 30, max 100)
13492
13595
  * @param data.onlyMemberOf only list the folders the user is member of (default false)
13493
13596
  * @returns string folder list
13494
13597
  * @throws ApiError
@@ -13498,7 +13601,11 @@ var FolderService = class {
13498
13601
  method: "GET",
13499
13602
  url: "/w/{workspace}/folders/listnames",
13500
13603
  path: { workspace: data.workspace },
13501
- query: { only_member_of: data.onlyMemberOf }
13604
+ query: {
13605
+ page: data.page,
13606
+ per_page: data.perPage,
13607
+ only_member_of: data.onlyMemberOf
13608
+ }
13502
13609
  });
13503
13610
  }
13504
13611
  /**
@@ -14363,6 +14470,7 @@ var HelpersService = class {
14363
14470
  * @param data The data for the request.
14364
14471
  * @param data.workspace
14365
14472
  * @param data.storage
14473
+ * @param data.s3ResourcePath When set, test the connection of this object storage resource instead of the workspace storage
14366
14474
  * @returns unknown Connection settings
14367
14475
  * @throws ApiError
14368
14476
  */
@@ -14371,7 +14479,10 @@ var HelpersService = class {
14371
14479
  method: "GET",
14372
14480
  url: "/w/{workspace}/job_helpers/test_connection",
14373
14481
  path: { workspace: data.workspace },
14374
- query: { storage: data.storage }
14482
+ query: {
14483
+ storage: data.storage,
14484
+ s3_resource_path: data.s3ResourcePath
14485
+ }
14375
14486
  });
14376
14487
  }
14377
14488
  /**
@@ -14398,6 +14509,7 @@ var HelpersService = class {
14398
14509
  * @param data.marker
14399
14510
  * @param data.prefix
14400
14511
  * @param data.storage
14512
+ * @param data.s3ResourcePath When set, list the files of this object storage resource instead of the workspace storage
14401
14513
  * @returns unknown List of file keys
14402
14514
  * @throws ApiError
14403
14515
  */
@@ -14410,7 +14522,8 @@ var HelpersService = class {
14410
14522
  max_keys: data.maxKeys,
14411
14523
  marker: data.marker,
14412
14524
  prefix: data.prefix,
14413
- storage: data.storage
14525
+ storage: data.storage,
14526
+ s3_resource_path: data.s3ResourcePath
14414
14527
  }
14415
14528
  });
14416
14529
  }
@@ -14420,6 +14533,7 @@ var HelpersService = class {
14420
14533
  * @param data.workspace
14421
14534
  * @param data.fileKey
14422
14535
  * @param data.storage
14536
+ * @param data.s3ResourcePath When set, load the file metadata from this object storage resource instead of the workspace storage
14423
14537
  * @returns WindmillFileMetadata FileMetadata
14424
14538
  * @throws ApiError
14425
14539
  */
@@ -14430,7 +14544,8 @@ var HelpersService = class {
14430
14544
  path: { workspace: data.workspace },
14431
14545
  query: {
14432
14546
  file_key: data.fileKey,
14433
- storage: data.storage
14547
+ storage: data.storage,
14548
+ s3_resource_path: data.s3ResourcePath
14434
14549
  }
14435
14550
  });
14436
14551
  }
@@ -14446,6 +14561,7 @@ var HelpersService = class {
14446
14561
  * @param data.readBytesFrom
14447
14562
  * @param data.readBytesLength
14448
14563
  * @param data.storage
14564
+ * @param data.s3ResourcePath When set, load the file preview from this object storage resource instead of the workspace storage
14449
14565
  * @returns WindmillFilePreview FilePreview
14450
14566
  * @throws ApiError
14451
14567
  */
@@ -14462,7 +14578,8 @@ var HelpersService = class {
14462
14578
  csv_has_header: data.csvHasHeader,
14463
14579
  read_bytes_from: data.readBytesFrom,
14464
14580
  read_bytes_length: data.readBytesLength,
14465
- storage: data.storage
14581
+ storage: data.storage,
14582
+ s3_resource_path: data.s3ResourcePath
14466
14583
  }
14467
14584
  });
14468
14585
  }
@@ -14667,6 +14784,7 @@ var HelpersService = class {
14667
14784
  * @param data.workspace
14668
14785
  * @param data.fileKey
14669
14786
  * @param data.storage
14787
+ * @param data.s3ResourcePath When set, delete the file from this object storage resource instead of the workspace storage
14670
14788
  * @returns unknown Confirmation
14671
14789
  * @throws ApiError
14672
14790
  */
@@ -14677,7 +14795,8 @@ var HelpersService = class {
14677
14795
  path: { workspace: data.workspace },
14678
14796
  query: {
14679
14797
  file_key: data.fileKey,
14680
- storage: data.storage
14798
+ storage: data.storage,
14799
+ s3_resource_path: data.s3ResourcePath
14681
14800
  }
14682
14801
  });
14683
14802
  }
@@ -14688,6 +14807,7 @@ var HelpersService = class {
14688
14807
  * @param data.srcFileKey
14689
14808
  * @param data.destFileKey
14690
14809
  * @param data.storage
14810
+ * @param data.s3ResourcePath When set, move the file within this object storage resource instead of the workspace storage
14691
14811
  * @returns unknown Confirmation
14692
14812
  * @throws ApiError
14693
14813
  */
@@ -14699,7 +14819,8 @@ var HelpersService = class {
14699
14819
  query: {
14700
14820
  src_file_key: data.srcFileKey,
14701
14821
  dest_file_key: data.destFileKey,
14702
- storage: data.storage
14822
+ storage: data.storage,
14823
+ s3_resource_path: data.s3ResourcePath
14703
14824
  }
14704
14825
  });
14705
14826
  }
@@ -14984,6 +15105,7 @@ var ConcurrencyGroupsService = class {
14984
15105
  * @param data.perPage number of items to return for a given page (default 30, max 100)
14985
15106
  * @param data.triggerKind filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
14986
15107
  * @param data.isSkipped is the job skipped
15108
+ * @param data.resolved filter on whether a failure has been marked as handled. true keeps only resolved failures, false hides them
14987
15109
  * @param data.isFlowStep is the job a flow step
14988
15110
  * @param data.hasNullParent has null parent
14989
15111
  * @param data.success filter on successful jobs
@@ -15025,6 +15147,7 @@ var ConcurrencyGroupsService = class {
15025
15147
  per_page: data.perPage,
15026
15148
  trigger_kind: data.triggerKind,
15027
15149
  is_skipped: data.isSkipped,
15150
+ resolved: data.resolved,
15028
15151
  is_flow_step: data.isFlowStep,
15029
15152
  has_null_parent: data.hasNullParent,
15030
15153
  success: data.success,
@@ -15617,6 +15740,36 @@ var HubPublishService = class {
15617
15740
  });
15618
15741
  }
15619
15742
  /**
15743
+ * attach a recorded session to a hub raw app
15744
+ * Requires the caller to be a workspace admin. Forwards the request to the
15745
+ * configured Hub scoped to the `{workspace}:{folder}` source and returns
15746
+ * the Hub's status code and raw response body.
15747
+ *
15748
+ * @param data The data for the request.
15749
+ * @param data.workspace
15750
+ * @param data.id hub id of the raw app
15751
+ * @param data.folder workspace folder scoping the Hub publication: a workspace can publish
15752
+ * one Hub project per folder and the Hub-side source key is
15753
+ * `{workspace}:{folder}`
15754
+ *
15755
+ * @param data.requestBody
15756
+ * @returns string raw Hub response body (status code is passed through from the Hub)
15757
+ * @throws ApiError
15758
+ */
15759
+ static publishHubRawAppRecording(data) {
15760
+ return request(OpenAPI, {
15761
+ method: "POST",
15762
+ url: "/w/{workspace}/hub/raw_apps/{id}/recording",
15763
+ path: {
15764
+ workspace: data.workspace,
15765
+ id: data.id
15766
+ },
15767
+ query: { folder: data.folder },
15768
+ body: data.requestBody,
15769
+ mediaType: "application/json"
15770
+ });
15771
+ }
15772
+ /**
15620
15773
  * attach a recording to a hub script
15621
15774
  * Requires the caller to be a workspace admin. Forwards the request to the
15622
15775
  * configured Hub scoped to the `{workspace}:{folder}` source and returns
@@ -15837,6 +15990,39 @@ var HubPublishService = class {
15837
15990
  });
15838
15991
  }
15839
15992
  /**
15993
+ * set or clear a hub project's custom logo
15994
+ * Requires the caller to be a workspace admin. Sets the project's custom
15995
+ * logo (base64 png/svg, decoded size max 512KB) or clears it when `logo`
15996
+ * is null; the `logo` field itself is required so an empty body cannot
15997
+ * clear the logo by accident. Forwards the request to the configured Hub
15998
+ * scoped to the `{workspace}:{folder}` source and returns the Hub's
15999
+ * status code and raw response body.
16000
+ *
16001
+ * @param data The data for the request.
16002
+ * @param data.workspace
16003
+ * @param data.slug hub project slug
16004
+ * @param data.folder workspace folder scoping the Hub publication: a workspace can publish
16005
+ * one Hub project per folder and the Hub-side source key is
16006
+ * `{workspace}:{folder}`
16007
+ *
16008
+ * @param data.requestBody
16009
+ * @returns string raw Hub response body (status code is passed through from the Hub)
16010
+ * @throws ApiError
16011
+ */
16012
+ static publishHubProjectLogo(data) {
16013
+ return request(OpenAPI, {
16014
+ method: "POST",
16015
+ url: "/w/{workspace}/hub/projects/{slug}/logo",
16016
+ path: {
16017
+ workspace: data.workspace,
16018
+ slug: data.slug
16019
+ },
16020
+ query: { folder: data.folder },
16021
+ body: data.requestBody,
16022
+ mediaType: "application/json"
16023
+ });
16024
+ }
16025
+ /**
15840
16026
  * submit a hub project draft for review
15841
16027
  * Requires the caller to be a workspace admin. Forwards the request to the
15842
16028
  * configured Hub scoped to the `{workspace}:{folder}` source and returns