@parallelworks/client 7.96.1 → 7.98.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.
Files changed (2) hide show
  1. package/dist/types/api.d.ts +468 -2
  2. package/package.json +1 -1
@@ -2081,6 +2081,50 @@ export interface paths {
2081
2081
  patch?: never;
2082
2082
  trace?: never;
2083
2083
  };
2084
+ "/api/changelog": {
2085
+ parameters: {
2086
+ query?: never;
2087
+ header?: never;
2088
+ path?: never;
2089
+ cookie?: never;
2090
+ };
2091
+ /**
2092
+ * Get recent changelog entries
2093
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
2094
+ *
2095
+ * Returns the latest published changelog entries for the Changelog page. Serves the live changelog from parallelworks.com unless the platform is configured to use the changelog bundled into the build.
2096
+ */
2097
+ get: operations["get-changelog"];
2098
+ put?: never;
2099
+ post?: never;
2100
+ delete?: never;
2101
+ options?: never;
2102
+ head?: never;
2103
+ patch?: never;
2104
+ trace?: never;
2105
+ };
2106
+ "/api/changelog/authors/{author}/avatar": {
2107
+ parameters: {
2108
+ query?: never;
2109
+ header?: never;
2110
+ path?: never;
2111
+ cookie?: never;
2112
+ };
2113
+ /**
2114
+ * Get a changelog author's avatar
2115
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
2116
+ *
2117
+ * Returns the avatar of a person credited in a changelog entry. The platform fetches and caches the image so browsers never load it from another origin.
2118
+ */
2119
+ get: operations["get-changelog-author-avatar"];
2120
+ put?: never;
2121
+ post?: never;
2122
+ delete?: never;
2123
+ options?: never;
2124
+ head?: never;
2125
+ patch?: never;
2126
+ trace?: never;
2127
+ };
2084
2128
  "/api/cloud-accounts": {
2085
2129
  parameters: {
2086
2130
  query?: never;
@@ -4105,7 +4149,13 @@ export interface paths {
4105
4149
  * Creates a notification. A platform-admin user broadcasts to a target user, organization, or all users.
4106
4150
  */
4107
4151
  post: operations["create-notification"];
4108
- delete?: never;
4152
+ /**
4153
+ * Delete notifications
4154
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
4155
+ *
4156
+ * Deletes the read notifications for the currently authenticated user, or every notification when all is true.
4157
+ */
4158
+ delete: operations["delete-notifications"];
4109
4159
  options?: never;
4110
4160
  head?: never;
4111
4161
  patch?: never;
@@ -5289,6 +5339,34 @@ export interface paths {
5289
5339
  patch?: never;
5290
5340
  trace?: never;
5291
5341
  };
5342
+ "/api/organizations/{organization}/billing-settings": {
5343
+ parameters: {
5344
+ query?: never;
5345
+ header?: never;
5346
+ path?: never;
5347
+ cookie?: never;
5348
+ };
5349
+ /**
5350
+ * Get organization billing settings
5351
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
5352
+ *
5353
+ * Returns the organization's billing settings with defaults applied: the allocation accounting system (legacy by default) and the recurring fiscal year start date.
5354
+ */
5355
+ get: operations["get-organization-billing-settings"];
5356
+ put?: never;
5357
+ post?: never;
5358
+ delete?: never;
5359
+ options?: never;
5360
+ head?: never;
5361
+ /**
5362
+ * Update organization billing settings
5363
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
5364
+ *
5365
+ * Updates the organization's billing settings. Only the fields present in the request change.
5366
+ */
5367
+ patch: operations["patch-organization-billing-settings"];
5368
+ trace?: never;
5369
+ };
5292
5370
  "/api/organizations/{organization}/bootstrap": {
5293
5371
  parameters: {
5294
5372
  query?: never;
@@ -9848,6 +9926,28 @@ export interface paths {
9848
9926
  patch?: never;
9849
9927
  trace?: never;
9850
9928
  };
9929
+ "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/attachable-storages": {
9930
+ parameters: {
9931
+ query?: never;
9932
+ header?: never;
9933
+ path?: never;
9934
+ cookie?: never;
9935
+ };
9936
+ /**
9937
+ * Get Cluster Attachable Storages
9938
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
9939
+ *
9940
+ * Returns the filesystems that can be attached to a cluster, each bucket flagged with whether its mount is forced read-only. Existing clusters have none.
9941
+ */
9942
+ get: operations["get-cluster-attachable-storages"];
9943
+ put?: never;
9944
+ post?: never;
9945
+ delete?: never;
9946
+ options?: never;
9947
+ head?: never;
9948
+ patch?: never;
9949
+ trace?: never;
9950
+ };
9851
9951
  "/api/organizations/{organization}/users/{user}/clusters/{clusterName}/attached-storages": {
9852
9952
  parameters: {
9853
9953
  query?: never;
@@ -14237,6 +14337,28 @@ export interface paths {
14237
14337
  patch?: never;
14238
14338
  trace?: never;
14239
14339
  };
14340
+ "/api/user/changelog-seen": {
14341
+ parameters: {
14342
+ query?: never;
14343
+ header?: never;
14344
+ path?: never;
14345
+ cookie?: never;
14346
+ };
14347
+ get?: never;
14348
+ /**
14349
+ * Mark the Changelog page as seen
14350
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
14351
+ *
14352
+ * Records the newest changelog entry the current user has opened so the Changelog indicator only shows for later releases.
14353
+ */
14354
+ put: operations["set-user-changelog-seen"];
14355
+ post?: never;
14356
+ delete?: never;
14357
+ options?: never;
14358
+ head?: never;
14359
+ patch?: never;
14360
+ trace?: never;
14361
+ };
14240
14362
  "/api/user/favorites/{type}/{id}": {
14241
14363
  parameters: {
14242
14364
  query?: never;
@@ -15962,6 +16084,15 @@ export interface components {
15962
16084
  */
15963
16085
  storageId: string;
15964
16086
  };
16087
+ AttachableStorage: {
16088
+ /**
16089
+ * @description The id of the storage resource.
16090
+ * @example 66f1a2b3c4d5e6f7a8b9c0d1
16091
+ */
16092
+ id: string;
16093
+ /** @description Whether a bucket mount is forced read-only because the caller's or the cluster owner's access to the bucket is read-only. */
16094
+ readOnly: boolean;
16095
+ };
15965
16096
  AttachmentResponse: {
15966
16097
  /** @description MIME type */
15967
16098
  contentType: string;
@@ -16001,6 +16132,8 @@ export interface components {
16001
16132
  avatarEtag?: string;
16002
16133
  /** @description Indicates if the user is a platform billing admin with read-only access to billing data and the admin cloud resource inventory across all organizations. */
16003
16134
  billingAdmin: boolean;
16135
+ /** @description Date (YYYY-MM-DD) of the newest changelog entry the user has opened in the Changelog page; empty when never opened. */
16136
+ changelogSeen?: string;
16004
16137
  /**
16005
16138
  * @description Email address of the user.
16006
16139
  * @example jake.thayne@parallelworks.com
@@ -17780,6 +17913,61 @@ export interface components {
17780
17913
  /** @description Subject of the certificate leaf */
17781
17914
  subject: string;
17782
17915
  };
17916
+ ChangelogAuthor: {
17917
+ /**
17918
+ * @description GitHub username.
17919
+ * @example giraffesyo
17920
+ */
17921
+ github?: string;
17922
+ /**
17923
+ * @description Author handle on the changelog site.
17924
+ * @example giraffesyo
17925
+ */
17926
+ id: string;
17927
+ /**
17928
+ * @description Avatar path, served by the platform.
17929
+ * @example /api/changelog/authors/giraffesyo/avatar
17930
+ */
17931
+ imageUrl?: string;
17932
+ /**
17933
+ * @description LinkedIn profile slug.
17934
+ * @example mcquademichael
17935
+ */
17936
+ linkedin?: string;
17937
+ /**
17938
+ * @description Display name.
17939
+ * @example Michael McQuade
17940
+ */
17941
+ name: string;
17942
+ /**
17943
+ * @description Job title.
17944
+ * @example Director of Engineering
17945
+ */
17946
+ title?: string;
17947
+ /** @description Twitter handle. */
17948
+ twitter?: string;
17949
+ };
17950
+ ChangelogEntry: {
17951
+ /** @description People who contributed to the release. */
17952
+ authors: components["schemas"]["ChangelogAuthor"][] | null;
17953
+ /** @description Curated release notes as markdown. */
17954
+ content: string;
17955
+ /**
17956
+ * @description Release date (YYYY-MM-DD).
17957
+ * @example 2026-08-24
17958
+ */
17959
+ date: string;
17960
+ /**
17961
+ * @description Changelog entry slug, the release date.
17962
+ * @example 2026-08-24
17963
+ */
17964
+ slug: string;
17965
+ /**
17966
+ * @description Platform release the entry describes.
17967
+ * @example v7.92.0
17968
+ */
17969
+ version: string;
17970
+ };
17783
17971
  ChatCompletionChunk: {
17784
17972
  /** @description Completion choices */
17785
17973
  choices: components["schemas"]["Choice"][] | null;
@@ -17954,6 +18142,8 @@ export interface components {
17954
18142
  usersCleaned: number;
17955
18143
  };
17956
18144
  CloudAccountBillingResponse: {
18145
+ /** @description Name of the billing infrastructure. Only set on list responses. */
18146
+ infraName?: string;
17957
18147
  provisionedByOrg: boolean;
17958
18148
  status: string;
17959
18149
  /** Format: date-time */
@@ -18045,6 +18235,7 @@ export interface components {
18045
18235
  };
18046
18236
  };
18047
18237
  CloudAccountListItem: {
18238
+ billing: components["schemas"]["CloudAccountBillingResponse"];
18048
18239
  csp: string;
18049
18240
  cspId: string;
18050
18241
  name: string;
@@ -19788,7 +19979,7 @@ export interface components {
19788
19979
  };
19789
19980
  /** @description Slug of a marketplace item to run */
19790
19981
  marketplace?: string;
19791
- /** @description Run the workflow.yaml at the root of a repository: OWNER/REPO or a github.com URL, or the URL of a project on one of the organization's registered GitLab servers, each with an optional @REF. Read as the caller, treated as third-party code. */
19982
+ /** @description Run a repository's workflow.yaml: OWNER/REPO or a github.com URL, or the URL of a project on one of the organization's registered GitLab servers, each with an optional path to a workflow file or the directory holding one, and an optional @REF. Without a path it is the repository root. Read as the caller, treated as third-party code. */
19792
19983
  repository?: string;
19793
19984
  /** @description Session names */
19794
19985
  sessionNames?: {
@@ -20850,6 +21041,10 @@ export interface components {
20850
21041
  GetBillingDetailsOutputBody: {
20851
21042
  billingDetails: components["schemas"]["BillingDetails"];
20852
21043
  };
21044
+ GetChangelogOutputBody: {
21045
+ /** @description Latest changelog entries, newest first. */
21046
+ entries: components["schemas"]["ChangelogEntry"][] | null;
21047
+ };
20853
21048
  GetClusterMetricsOutputBody: {
20854
21049
  dataPoints: components["schemas"]["ClusterMetricsDataPoint"][] | null;
20855
21050
  };
@@ -23939,6 +24134,8 @@ export interface components {
23939
24134
  mounted: boolean;
23940
24135
  /** @description Name of the cluster or instance the mount points to. */
23941
24136
  name: string;
24137
+ /** @description Why the mount is still pending, such as the cluster not being connected. Empty while mounted or failed. */
24138
+ reason: string;
23942
24139
  /** @description ID of the cluster or instance the mount points to. */
23943
24140
  resourceId: string;
23944
24141
  resourcePath: string;
@@ -25049,6 +25246,20 @@ export interface components {
25049
25246
  */
25050
25247
  threshold: number;
25051
25248
  };
25249
+ OrgBillingSettings: {
25250
+ /**
25251
+ * @description Allocation accounting system the organization uses. Legacy is the default.
25252
+ * @enum {string}
25253
+ */
25254
+ allocationSystem: "legacy" | "flexible";
25255
+ /** @description Username shown on dashboards and reports for cost records without a username tag. Empty when unset. */
25256
+ defaultBillingUsername: string;
25257
+ /**
25258
+ * @description Recurring fiscal year start date as MM-DD. Empty when unset.
25259
+ * @example 10-01
25260
+ */
25261
+ fiscalYearStartDate: string;
25262
+ };
25052
25263
  OrgConnectionPermissionsOutputBody: {
25053
25264
  groups: string[] | null;
25054
25265
  shareWithOrganization: boolean;
@@ -25532,6 +25743,20 @@ export interface components {
25532
25743
  /** @description List of flavor cost updates */
25533
25744
  flavors: components["schemas"]["FlavorCostUpdate"][] | null;
25534
25745
  };
25746
+ PatchOrgBillingSettingsInputBody: {
25747
+ /**
25748
+ * @description Allocation accounting system the organization uses.
25749
+ * @enum {string}
25750
+ */
25751
+ allocationSystem?: "legacy" | "flexible";
25752
+ /** @description Username shown on dashboards and reports for cost records without a username tag. An empty string clears it. */
25753
+ defaultBillingUsername?: string;
25754
+ /**
25755
+ * @description Recurring fiscal year start date as MM-DD. An empty string clears it.
25756
+ * @example 10-01
25757
+ */
25758
+ fiscalYearStartDate?: string;
25759
+ };
25535
25760
  PatchProvisionStatusBody: {
25536
25761
  /**
25537
25762
  * @description Provision status ID to update
@@ -25932,6 +26157,8 @@ export interface components {
25932
26157
  stuckRunSweeperEnabled: boolean;
25933
26158
  /** @description Markdown Terms & Conditions shown to new users during onboarding. Empty disables the prompt. */
25934
26159
  termsAndConditions?: string;
26160
+ /** @description Whether the Changelog page serves the changelog bundled into this build instead of fetching the live one from parallelworks.com. Off by default; turn it on for air-gapped deployments. */
26161
+ useBuiltinChangelog: boolean;
25935
26162
  /** @description Indicates if the platform license is valid. */
25936
26163
  validLicense?: boolean;
25937
26164
  /**
@@ -28814,6 +29041,13 @@ export interface components {
28814
29041
  /** @description URL where the icon is served. */
28815
29042
  imageUrl: string;
28816
29043
  };
29044
+ SetChangelogSeenInputBody: {
29045
+ /**
29046
+ * @description Date (YYYY-MM-DD) of the newest changelog entry the user has opened.
29047
+ * @example 2026-08-24
29048
+ */
29049
+ date: string;
29050
+ };
28817
29051
  SetComplimentaryInputBody: {
28818
29052
  /** @description Whether the account is complimentary and consumes no license seat */
28819
29053
  complimentary: boolean;
@@ -29696,6 +29930,8 @@ export interface components {
29696
29930
  stuckRunSweeperEnabled?: boolean;
29697
29931
  /** @description Markdown Terms & Conditions shown to new users during onboarding. Empty disables the prompt. */
29698
29932
  termsAndConditions?: string;
29933
+ /** @description Whether the Changelog page serves the changelog bundled into this build instead of fetching the live one. */
29934
+ useBuiltinChangelog?: boolean;
29699
29935
  /**
29700
29936
  * Format: int64
29701
29937
  * @description Minimum age in days a user workspace container must reach before the hourly scale-down job stops it. 0 scales down regardless of age.
@@ -30964,6 +31200,8 @@ export interface components {
30964
31200
  WorkspaceMountStatus: {
30965
31201
  error: string;
30966
31202
  mounted: boolean;
31203
+ /** @description Why the mount is still pending, if it is neither mounted nor failed. */
31204
+ reason?: string;
30967
31205
  workspacePath: string;
30968
31206
  };
30969
31207
  WorkspaceSettings: {
@@ -34639,6 +34877,69 @@ export interface operations {
34639
34877
  };
34640
34878
  };
34641
34879
  };
34880
+ "get-changelog": {
34881
+ parameters: {
34882
+ query?: never;
34883
+ header?: never;
34884
+ path?: never;
34885
+ cookie?: never;
34886
+ };
34887
+ requestBody?: never;
34888
+ responses: {
34889
+ /** @description OK */
34890
+ 200: {
34891
+ headers: {
34892
+ [name: string]: unknown;
34893
+ };
34894
+ content: {
34895
+ "application/json": components["schemas"]["GetChangelogOutputBody"];
34896
+ };
34897
+ };
34898
+ /** @description Error */
34899
+ default: {
34900
+ headers: {
34901
+ [name: string]: unknown;
34902
+ };
34903
+ content: {
34904
+ "application/json": components["schemas"]["Error"];
34905
+ };
34906
+ };
34907
+ };
34908
+ };
34909
+ "get-changelog-author-avatar": {
34910
+ parameters: {
34911
+ query?: never;
34912
+ header?: never;
34913
+ path: {
34914
+ /** @description Author id from a changelog entry. */
34915
+ author: string;
34916
+ };
34917
+ cookie?: never;
34918
+ };
34919
+ requestBody?: never;
34920
+ responses: {
34921
+ /** @description OK */
34922
+ 200: {
34923
+ headers: {
34924
+ "Cache-Control"?: string;
34925
+ "Content-Type"?: string;
34926
+ [name: string]: unknown;
34927
+ };
34928
+ content: {
34929
+ "application/json": string;
34930
+ };
34931
+ };
34932
+ /** @description Error */
34933
+ default: {
34934
+ headers: {
34935
+ [name: string]: unknown;
34936
+ };
34937
+ content: {
34938
+ "application/json": components["schemas"]["Error"];
34939
+ };
34940
+ };
34941
+ };
34942
+ };
34642
34943
  "list-user-cloud-accounts": {
34643
34944
  parameters: {
34644
34945
  query?: never;
@@ -37987,6 +38288,36 @@ export interface operations {
37987
38288
  };
37988
38289
  };
37989
38290
  };
38291
+ "delete-notifications": {
38292
+ parameters: {
38293
+ query?: {
38294
+ /** @description Set to true to delete every notification. Omitting it deletes only the notifications that have been read. */
38295
+ all?: boolean;
38296
+ };
38297
+ header?: never;
38298
+ path?: never;
38299
+ cookie?: never;
38300
+ };
38301
+ requestBody?: never;
38302
+ responses: {
38303
+ /** @description No Content */
38304
+ 204: {
38305
+ headers: {
38306
+ [name: string]: unknown;
38307
+ };
38308
+ content?: never;
38309
+ };
38310
+ /** @description Error */
38311
+ default: {
38312
+ headers: {
38313
+ [name: string]: unknown;
38314
+ };
38315
+ content: {
38316
+ "application/json": components["schemas"]["Error"];
38317
+ };
38318
+ };
38319
+ };
38320
+ };
37990
38321
  "get-notifications-options": {
37991
38322
  parameters: {
37992
38323
  query?: never;
@@ -40548,6 +40879,74 @@ export interface operations {
40548
40879
  };
40549
40880
  };
40550
40881
  };
40882
+ "get-organization-billing-settings": {
40883
+ parameters: {
40884
+ query?: never;
40885
+ header?: never;
40886
+ path: {
40887
+ /** @description The name of the organization. */
40888
+ organization: string;
40889
+ };
40890
+ cookie?: never;
40891
+ };
40892
+ requestBody?: never;
40893
+ responses: {
40894
+ /** @description OK */
40895
+ 200: {
40896
+ headers: {
40897
+ [name: string]: unknown;
40898
+ };
40899
+ content: {
40900
+ "application/json": components["schemas"]["OrgBillingSettings"];
40901
+ };
40902
+ };
40903
+ /** @description Error */
40904
+ default: {
40905
+ headers: {
40906
+ [name: string]: unknown;
40907
+ };
40908
+ content: {
40909
+ "application/json": components["schemas"]["Error"];
40910
+ };
40911
+ };
40912
+ };
40913
+ };
40914
+ "patch-organization-billing-settings": {
40915
+ parameters: {
40916
+ query?: never;
40917
+ header?: never;
40918
+ path: {
40919
+ /** @description The name of the organization. */
40920
+ organization: string;
40921
+ };
40922
+ cookie?: never;
40923
+ };
40924
+ requestBody: {
40925
+ content: {
40926
+ "application/json": components["schemas"]["PatchOrgBillingSettingsInputBody"];
40927
+ };
40928
+ };
40929
+ responses: {
40930
+ /** @description OK */
40931
+ 200: {
40932
+ headers: {
40933
+ [name: string]: unknown;
40934
+ };
40935
+ content: {
40936
+ "application/json": components["schemas"]["OrgBillingSettings"];
40937
+ };
40938
+ };
40939
+ /** @description Error */
40940
+ default: {
40941
+ headers: {
40942
+ [name: string]: unknown;
40943
+ };
40944
+ content: {
40945
+ "application/json": components["schemas"]["Error"];
40946
+ };
40947
+ };
40948
+ };
40949
+ };
40551
40950
  "get-organization-bootstrap-scripts": {
40552
40951
  parameters: {
40553
40952
  query?: {
@@ -50491,6 +50890,42 @@ export interface operations {
50491
50890
  };
50492
50891
  };
50493
50892
  };
50893
+ "get-cluster-attachable-storages": {
50894
+ parameters: {
50895
+ query?: never;
50896
+ header?: never;
50897
+ path: {
50898
+ /** @description The name of the organization. */
50899
+ organization: string;
50900
+ /** @description The username of the user that owns the cluster */
50901
+ user: string;
50902
+ /** @description The cluster name */
50903
+ clusterName: string;
50904
+ };
50905
+ cookie?: never;
50906
+ };
50907
+ requestBody?: never;
50908
+ responses: {
50909
+ /** @description OK */
50910
+ 200: {
50911
+ headers: {
50912
+ [name: string]: unknown;
50913
+ };
50914
+ content: {
50915
+ "application/json": components["schemas"]["AttachableStorage"][] | null;
50916
+ };
50917
+ };
50918
+ /** @description Error */
50919
+ default: {
50920
+ headers: {
50921
+ [name: string]: unknown;
50922
+ };
50923
+ content: {
50924
+ "application/json": components["schemas"]["Error"];
50925
+ };
50926
+ };
50927
+ };
50928
+ };
50494
50929
  "get-cluster-attached-storages": {
50495
50930
  parameters: {
50496
50931
  query?: never;
@@ -58979,6 +59414,37 @@ export interface operations {
58979
59414
  };
58980
59415
  };
58981
59416
  };
59417
+ "set-user-changelog-seen": {
59418
+ parameters: {
59419
+ query?: never;
59420
+ header?: never;
59421
+ path?: never;
59422
+ cookie?: never;
59423
+ };
59424
+ requestBody: {
59425
+ content: {
59426
+ "application/json": components["schemas"]["SetChangelogSeenInputBody"];
59427
+ };
59428
+ };
59429
+ responses: {
59430
+ /** @description No Content */
59431
+ 204: {
59432
+ headers: {
59433
+ [name: string]: unknown;
59434
+ };
59435
+ content?: never;
59436
+ };
59437
+ /** @description Error */
59438
+ default: {
59439
+ headers: {
59440
+ [name: string]: unknown;
59441
+ };
59442
+ content: {
59443
+ "application/json": components["schemas"]["Error"];
59444
+ };
59445
+ };
59446
+ };
59447
+ };
58982
59448
  "set-user-favorite": {
58983
59449
  parameters: {
58984
59450
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parallelworks/client",
3
- "version": "7.96.1",
3
+ "version": "7.98.0",
4
4
  "description": "Official TypeScript client for Parallel Works ACTIVATE API",
5
5
  "type": "module",
6
6
  "exports": {