@parallelworks/client 7.112.0 → 7.113.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 +419 -3
  2. package/package.json +1 -1
@@ -1743,6 +1743,28 @@ export interface paths {
1743
1743
  patch?: never;
1744
1744
  trace?: never;
1745
1745
  };
1746
+ "/api/agents/machines/{machine}/sessions/{id}/direction": {
1747
+ parameters: {
1748
+ query?: never;
1749
+ header?: never;
1750
+ path?: never;
1751
+ cookie?: never;
1752
+ };
1753
+ get?: never;
1754
+ put?: never;
1755
+ /**
1756
+ * Steer a pw code session's running turn
1757
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
1758
+ *
1759
+ * Hands text to the turn in flight, which the model reads at its next step rather than after the turn ends, the way typing into a busy pw code terminal does. Not delivered means no turn was running to take it; send it as a message instead.
1760
+ */
1761
+ post: operations["steer-agent-session"];
1762
+ delete?: never;
1763
+ options?: never;
1764
+ head?: never;
1765
+ patch?: never;
1766
+ trace?: never;
1767
+ };
1746
1768
  "/api/agents/machines/{machine}/sessions/{id}/fork": {
1747
1769
  parameters: {
1748
1770
  query?: never;
@@ -2785,6 +2807,72 @@ export interface paths {
2785
2807
  patch?: never;
2786
2808
  trace?: never;
2787
2809
  };
2810
+ "/api/eos/claim": {
2811
+ parameters: {
2812
+ query?: never;
2813
+ header?: never;
2814
+ path?: never;
2815
+ cookie?: never;
2816
+ };
2817
+ get?: never;
2818
+ put?: never;
2819
+ /**
2820
+ * Claim a durable task
2821
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
2822
+ *
2823
+ * Grants the calling worker the lease on the task it was started for, with what its executor needs to run it.
2824
+ */
2825
+ post: operations["claim-durable-task"];
2826
+ delete?: never;
2827
+ options?: never;
2828
+ head?: never;
2829
+ patch?: never;
2830
+ trace?: never;
2831
+ };
2832
+ "/api/eos/complete": {
2833
+ parameters: {
2834
+ query?: never;
2835
+ header?: never;
2836
+ path?: never;
2837
+ cookie?: never;
2838
+ };
2839
+ get?: never;
2840
+ put?: never;
2841
+ /**
2842
+ * Complete a durable task
2843
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
2844
+ *
2845
+ * Records the result of the calling worker's task and ends it.
2846
+ */
2847
+ post: operations["complete-durable-task"];
2848
+ delete?: never;
2849
+ options?: never;
2850
+ head?: never;
2851
+ patch?: never;
2852
+ trace?: never;
2853
+ };
2854
+ "/api/eos/heartbeat": {
2855
+ parameters: {
2856
+ query?: never;
2857
+ header?: never;
2858
+ path?: never;
2859
+ cookie?: never;
2860
+ };
2861
+ get?: never;
2862
+ put?: never;
2863
+ /**
2864
+ * Renew a durable task lease
2865
+ * @description > This is a user-centric route, so the response will always be in the context of the currently authenticated user.
2866
+ *
2867
+ * Renews the calling worker's lease on its task.
2868
+ */
2869
+ post: operations["heartbeat-durable-task"];
2870
+ delete?: never;
2871
+ options?: never;
2872
+ head?: never;
2873
+ patch?: never;
2874
+ trace?: never;
2875
+ };
2788
2876
  "/api/events/resources/{targetType}/{targetId}": {
2789
2877
  parameters: {
2790
2878
  query?: never;
@@ -15133,6 +15221,38 @@ export interface paths {
15133
15221
  patch?: never;
15134
15222
  trace?: never;
15135
15223
  };
15224
+ "/api/settings/admin/app-icon": {
15225
+ parameters: {
15226
+ query?: never;
15227
+ header?: never;
15228
+ path?: never;
15229
+ cookie?: never;
15230
+ };
15231
+ get?: never;
15232
+ /**
15233
+ * Upload the app icon
15234
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
15235
+ *
15236
+ * > This is a platform-admin only route.
15237
+ *
15238
+ * Sets the icon of the installed app. PNG, JPEG, GIF or WebP, at least 192x192 pixels.
15239
+ */
15240
+ put: operations["upload-app-icon"];
15241
+ post?: never;
15242
+ /**
15243
+ * Remove the app icon
15244
+ * @description > This is a system-level route, so the response will be independent of the currently authenticated user.
15245
+ *
15246
+ * > This is a platform-admin only route.
15247
+ *
15248
+ * Returns the installed app to the built-in icon.
15249
+ */
15250
+ delete: operations["delete-app-icon"];
15251
+ options?: never;
15252
+ head?: never;
15253
+ patch?: never;
15254
+ trace?: never;
15255
+ };
15136
15256
  "/api/settings/complete-onboarding": {
15137
15257
  parameters: {
15138
15258
  query?: never;
@@ -17400,6 +17520,14 @@ export interface components {
17400
17520
  compacted: boolean;
17401
17521
  output: string;
17402
17522
  };
17523
+ AgentDirectionBody: {
17524
+ /** @description What to tell the running turn. */
17525
+ text: string;
17526
+ };
17527
+ AgentDirectionDelivered: {
17528
+ /** @description False when no turn was running to take the text; send it as a message instead. */
17529
+ delivered: boolean;
17530
+ };
17403
17531
  AgentMachine: {
17404
17532
  agentVersion?: string;
17405
17533
  error?: string;
@@ -17871,6 +17999,10 @@ export interface components {
17871
17999
  */
17872
18000
  subjectType?: "userId" | "username";
17873
18001
  };
18002
+ AppIconSettingsOutputBody: {
18003
+ /** @description URL of the uploaded app icon. Empty when the built-in icon is used. */
18004
+ appIconUrl: string;
18005
+ };
17874
18006
  AppResponse: {
17875
18007
  /** @description Groups whose members may use the application. Empty means everyone in the organization. */
17876
18008
  allowedGroups: string[] | null;
@@ -21758,6 +21890,8 @@ export interface components {
21758
21890
  default?: boolean;
21759
21891
  /** @description Host name to register; a leading *. label registers a wildcard platform domain */
21760
21892
  domain: string;
21893
+ /** @description Platform host to send session visitors to when the session host has no CNAME record (sessions domains only) */
21894
+ fallbackDomain?: string;
21761
21895
  /** @description Owning organization id; the domain becomes that organization's branded login host */
21762
21896
  organization?: string;
21763
21897
  /** @description PEM private key matching the certificate; never returned by the API */
@@ -22565,6 +22699,37 @@ export interface components {
22565
22699
  /** @description A list of mounts to be used in docker workspaces. */
22566
22700
  mounts: string[] | null;
22567
22701
  };
22702
+ DurableClaimOutputBody: {
22703
+ /** Format: int64 */
22704
+ fencing: number;
22705
+ jobId: string;
22706
+ /** Format: date-time */
22707
+ leaseExpiresAt: string;
22708
+ leaseId: string;
22709
+ payload: unknown;
22710
+ taskId: string;
22711
+ token: string;
22712
+ username: string;
22713
+ };
22714
+ DurableCompleteBody: {
22715
+ error?: string;
22716
+ /** Format: int64 */
22717
+ exitCode: number;
22718
+ /** Format: int64 */
22719
+ fencing: number;
22720
+ leaseId: string;
22721
+ taskId: string;
22722
+ };
22723
+ DurableHeartbeatOutputBody: {
22724
+ /** Format: date-time */
22725
+ leaseExpiresAt: string;
22726
+ };
22727
+ DurableLeaseBody: {
22728
+ /** Format: int64 */
22729
+ fencing: number;
22730
+ leaseId: string;
22731
+ taskId: string;
22732
+ };
22568
22733
  EffectiveProduct: {
22569
22734
  id: string;
22570
22735
  name: string;
@@ -28561,6 +28726,8 @@ export interface components {
28561
28726
  default?: boolean;
28562
28727
  /** @description Lowercase host name; a leading *. label registers a wildcard platform domain */
28563
28728
  domain: string;
28729
+ /** @description Platform host session visitors are sent to when the session host has no CNAME record */
28730
+ fallbackDomain?: string;
28564
28731
  /** @description True when this deployment platform host frames every session; organization canonical origins do not */
28565
28732
  readonly frameAncestor?: boolean;
28566
28733
  /** @description The unique identifier of the registry entry */
@@ -28597,10 +28764,14 @@ export interface components {
28597
28764
  costAlert: components["schemas"]["NotificationChannelSettings"];
28598
28765
  /** @description Settings for general platform notifications. */
28599
28766
  general: components["schemas"]["NotificationChannelSettings"];
28767
+ /** @description Settings for image retirement notifications. */
28768
+ imageRetirement?: components["schemas"]["NotificationChannelSettings"];
28600
28769
  /** @description Settings for orphans alert notifications. */
28601
28770
  orphansAlert?: components["schemas"]["NotificationChannelSettings"];
28602
28771
  /** @description Settings for runtime alert notifications. */
28603
28772
  runtimeAlert: components["schemas"]["NotificationChannelSettings"];
28773
+ /** @description Settings for user workspace failure alert notifications. */
28774
+ workspaceAlert?: components["schemas"]["NotificationChannelSettings"];
28604
28775
  };
28605
28776
  PlatformSettings: {
28606
28777
  /** @description The platform-wide authentication methods available. */
@@ -28725,6 +28896,10 @@ export interface components {
28725
28896
  acmeContactEmail?: string;
28726
28897
  /** @description ACME directory URL for automatic Let's Encrypt certificates. Empty uses Let's Encrypt production. */
28727
28898
  acmeDirectoryUrl?: string;
28899
+ /** @description URL of the uploaded app icon. Empty uses the built-in icon. */
28900
+ appIconUrl?: string;
28901
+ /** @description Name of the installed app. Empty uses the platform name. */
28902
+ appName?: string;
28728
28903
  /**
28729
28904
  * Format: int64
28730
28905
  * @description Lifetime in minutes of bucket mount credentials (AWS STS tokens, Azure SAS tokens and service principals). Default 720 (12 hours).
@@ -28735,6 +28910,8 @@ export interface components {
28735
28910
  /** @description Indicates if user files should be deleted when their account is deleted. */
28736
28911
  deleteUserFilesOnDelete?: boolean;
28737
28912
  dockerWorkspaceSettings?: components["schemas"]["DockerWorkspaceSettings"];
28913
+ /** @description Whether jobs with runs-on are submitted to and cleaned up on their compute environments. On by default; turning it off rejects new runs-on runs and fails the ones not yet started, while started jobs finish. */
28914
+ durableExecutionEnabled: boolean;
28738
28915
  /** @description Indicates if the onboarding flow is enabled for new users. */
28739
28916
  enableOnboarding: boolean;
28740
28917
  /** @description Whether GCS bucket HMAC keys are rotated automatically. Off by default: agents older than 7.78.0 never pick up a rotated key, so pair this with minimumAgentVersion. */
@@ -30412,6 +30589,8 @@ export interface components {
30412
30589
  keep?: boolean;
30413
30590
  /** @description Expose this endpoint as an OpenAI-compatible chat model, reachable via the platform's OpenAI API and listed as an AI provider. */
30414
30591
  openAI?: boolean;
30592
+ /** @description Join this endpoint's connection pool instead of taking the name over: processes that PUT an already-pooled endpoint with this flag keep the current key generation, so their tunnels serve together and requests load-balance across them. */
30593
+ pooled?: boolean;
30415
30594
  /** @description Session slug for URL path. */
30416
30595
  slug?: string;
30417
30596
  /** @description Strip the session URL prefix before forwarding to the local app (for apps that serve at root and can't set a base path). */
@@ -31970,6 +32149,8 @@ export interface components {
31970
32149
  readonly nodeHostname?: string;
31971
32150
  /** @description Indicates if this is an OpenAI session. */
31972
32151
  readonly openAI?: boolean;
32152
+ /** @description Whether this endpoint's serving processes form a load-balanced connection pool. */
32153
+ readonly pooled?: boolean;
31973
32154
  /**
31974
32155
  * Format: hostname
31975
32156
  * @description Remote host.
@@ -33062,6 +33243,8 @@ export interface components {
33062
33243
  acmeContactEmail?: string;
33063
33244
  /** @description ACME directory URL for automatic certificates. Empty uses Let's Encrypt production. */
33064
33245
  acmeDirectoryUrl?: string;
33246
+ /** @description Name of the installed app. Empty uses the platform name. */
33247
+ appName?: string;
33065
33248
  /**
33066
33249
  * Format: int64
33067
33250
  * @description Lifetime in minutes of bucket mount credentials (AWS STS tokens, Azure SAS tokens and service principals). Minimum 15 (Vault's STS floor); maximum 720, since an Azure SAS must expire before its cached signing key does.
@@ -33073,6 +33256,8 @@ export interface components {
33073
33256
  deleteUserFilesOnDelete?: boolean;
33074
33257
  /** @description Docker workspace settings. */
33075
33258
  dockerWorkspaceSettings?: components["schemas"]["DockerWorkspaceSettings"];
33259
+ /** @description Whether jobs with runs-on are submitted to and cleaned up on their compute environments. */
33260
+ durableExecutionEnabled?: boolean;
33076
33261
  /** @description Whether to enable the onboarding flow. */
33077
33262
  enableOnboarding?: boolean;
33078
33263
  /** @description Whether to enable the forgot password feature. */
@@ -33385,6 +33570,8 @@ export interface components {
33385
33570
  certificate?: string;
33386
33571
  /** @description Make this the default domain for its role, or step it down */
33387
33572
  default?: boolean;
33573
+ /** @description Platform host to send session visitors to when the session host has no CNAME record (sessions domains only); an empty string clears it */
33574
+ fallbackDomain?: string;
33388
33575
  /** @description Owning organization id; an empty string clears the owner */
33389
33576
  organization?: string;
33390
33577
  /** @description PEM private key matching the certificate; never returned by the API */
@@ -33908,6 +34095,12 @@ export interface components {
33908
34095
  * @example parallelworks
33909
34096
  */
33910
34097
  organization?: string;
34098
+ /**
34099
+ * Format: int32
34100
+ * @description how many times the workspace container has restarted since it was created
34101
+ * @example 0
34102
+ */
34103
+ restarts?: number;
33911
34104
  /**
33912
34105
  * @description the resolved version number of the image the workspace is actually running. Read from the image tag for pinned deployments, or resolved from the running image digest via the workspace's API for 'latest'-tag deployments.
33913
34106
  * @example v7.62.0
@@ -33923,6 +34116,17 @@ export interface components {
33923
34116
  * @example jakethayne
33924
34117
  */
33925
34118
  safeUsername?: string;
34119
+ /**
34120
+ * @description the container status reported by kubernetes or docker
34121
+ * @example Running
34122
+ * @enum {string}
34123
+ */
34124
+ status: "Off" | "Starting" | "Running" | "Stopped" | "Pulling" | "Terminating" | "Restarting" | "Paused" | "Failed" | "Unknown";
34125
+ /**
34126
+ * @description the reason behind the status, such as the crash or scheduling error, if any
34127
+ * @example CrashLoopBackOff: last exit OOMKilled (exit code 137), 5 restarts
34128
+ */
34129
+ statusDetails?: string;
33926
34130
  /**
33927
34131
  * @description type of the user workspace
33928
34132
  * @example docker
@@ -33940,7 +34144,7 @@ export interface components {
33940
34144
  */
33941
34145
  userhost?: string;
33942
34146
  /**
33943
- * @description unique identifier for the user workspace, same as name for docker workspaces
34147
+ * @description unique identifier for the user workspace: the container id for docker workspaces, the pod uid for k8s workspaces
33944
34148
  * @example pw-user-jakethayne
33945
34149
  */
33946
34150
  workspaceId?: string;
@@ -34521,7 +34725,8 @@ export interface components {
34521
34725
  details?: string;
34522
34726
  /** @description Home directory usage. Absent unless the workspace is running and able to report it. */
34523
34727
  homeStorage?: components["schemas"]["WorkspaceHomeStorage"];
34524
- status: string;
34728
+ /** @enum {string} */
34729
+ status: "Off" | "Starting" | "Running" | "Stopped" | "Pulling" | "Terminating" | "Restarting" | "Paused" | "Failed" | "Unknown";
34525
34730
  };
34526
34731
  };
34527
34732
  responses: {
@@ -37460,6 +37665,44 @@ export interface operations {
37460
37665
  };
37461
37666
  };
37462
37667
  };
37668
+ "steer-agent-session": {
37669
+ parameters: {
37670
+ query?: never;
37671
+ header?: never;
37672
+ path: {
37673
+ /** @description Machine id from the machines list. */
37674
+ machine: string;
37675
+ /** @description Session id as the daemon reports it. */
37676
+ id: string;
37677
+ };
37678
+ cookie?: never;
37679
+ };
37680
+ requestBody: {
37681
+ content: {
37682
+ "application/json": components["schemas"]["AgentDirectionBody"];
37683
+ };
37684
+ };
37685
+ responses: {
37686
+ /** @description OK */
37687
+ 200: {
37688
+ headers: {
37689
+ [name: string]: unknown;
37690
+ };
37691
+ content: {
37692
+ "application/json": components["schemas"]["AgentDirectionDelivered"];
37693
+ };
37694
+ };
37695
+ /** @description Error */
37696
+ default: {
37697
+ headers: {
37698
+ [name: string]: unknown;
37699
+ };
37700
+ content: {
37701
+ "application/json": components["schemas"]["Error"];
37702
+ };
37703
+ };
37704
+ };
37705
+ };
37463
37706
  "fork-agent-session": {
37464
37707
  parameters: {
37465
37708
  query?: never;
@@ -39355,6 +39598,108 @@ export interface operations {
39355
39598
  };
39356
39599
  };
39357
39600
  };
39601
+ "claim-durable-task": {
39602
+ parameters: {
39603
+ query?: never;
39604
+ header?: {
39605
+ /** @description Bearer worker token */
39606
+ Authorization?: string;
39607
+ };
39608
+ path?: never;
39609
+ cookie?: never;
39610
+ };
39611
+ requestBody?: never;
39612
+ responses: {
39613
+ /** @description OK */
39614
+ 200: {
39615
+ headers: {
39616
+ [name: string]: unknown;
39617
+ };
39618
+ content: {
39619
+ "application/json": components["schemas"]["DurableClaimOutputBody"];
39620
+ };
39621
+ };
39622
+ /** @description Error */
39623
+ default: {
39624
+ headers: {
39625
+ [name: string]: unknown;
39626
+ };
39627
+ content: {
39628
+ "application/json": components["schemas"]["Error"];
39629
+ };
39630
+ };
39631
+ };
39632
+ };
39633
+ "complete-durable-task": {
39634
+ parameters: {
39635
+ query?: never;
39636
+ header?: {
39637
+ /** @description Bearer worker token */
39638
+ Authorization?: string;
39639
+ };
39640
+ path?: never;
39641
+ cookie?: never;
39642
+ };
39643
+ requestBody: {
39644
+ content: {
39645
+ "application/json": components["schemas"]["DurableCompleteBody"];
39646
+ };
39647
+ };
39648
+ responses: {
39649
+ /** @description No Content */
39650
+ 204: {
39651
+ headers: {
39652
+ [name: string]: unknown;
39653
+ };
39654
+ content?: never;
39655
+ };
39656
+ /** @description Error */
39657
+ default: {
39658
+ headers: {
39659
+ [name: string]: unknown;
39660
+ };
39661
+ content: {
39662
+ "application/json": components["schemas"]["Error"];
39663
+ };
39664
+ };
39665
+ };
39666
+ };
39667
+ "heartbeat-durable-task": {
39668
+ parameters: {
39669
+ query?: never;
39670
+ header?: {
39671
+ /** @description Bearer worker token */
39672
+ Authorization?: string;
39673
+ };
39674
+ path?: never;
39675
+ cookie?: never;
39676
+ };
39677
+ requestBody: {
39678
+ content: {
39679
+ "application/json": components["schemas"]["DurableLeaseBody"];
39680
+ };
39681
+ };
39682
+ responses: {
39683
+ /** @description OK */
39684
+ 200: {
39685
+ headers: {
39686
+ [name: string]: unknown;
39687
+ };
39688
+ content: {
39689
+ "application/json": components["schemas"]["DurableHeartbeatOutputBody"];
39690
+ };
39691
+ };
39692
+ /** @description Error */
39693
+ default: {
39694
+ headers: {
39695
+ [name: string]: unknown;
39696
+ };
39697
+ content: {
39698
+ "application/json": components["schemas"]["Error"];
39699
+ };
39700
+ };
39701
+ };
39702
+ };
39358
39703
  "list-resource-events": {
39359
39704
  parameters: {
39360
39705
  query?: {
@@ -45676,7 +46021,10 @@ export interface operations {
45676
46021
  };
45677
46022
  "delete-organization-cloud-account": {
45678
46023
  parameters: {
45679
- query?: never;
46024
+ query?: {
46025
+ /** @description Skip credential validation. Use when the cloud account is permanently unreachable and networks will be cleaned up out-of-band. */
46026
+ force?: boolean;
46027
+ };
45680
46028
  header?: never;
45681
46029
  path: {
45682
46030
  /** @description The name of the organization. */
@@ -64390,6 +64738,74 @@ export interface operations {
64390
64738
  };
64391
64739
  };
64392
64740
  };
64741
+ "upload-app-icon": {
64742
+ parameters: {
64743
+ query?: never;
64744
+ header?: never;
64745
+ path?: never;
64746
+ cookie?: never;
64747
+ };
64748
+ requestBody?: {
64749
+ content: {
64750
+ "multipart/form-data": {
64751
+ /**
64752
+ * Format: binary
64753
+ * @description Image file (PNG/JPEG/GIF/WEBP, max 5MB by default).
64754
+ */
64755
+ file: string;
64756
+ };
64757
+ };
64758
+ };
64759
+ responses: {
64760
+ /** @description OK */
64761
+ 200: {
64762
+ headers: {
64763
+ [name: string]: unknown;
64764
+ };
64765
+ content: {
64766
+ "application/json": components["schemas"]["AppIconSettingsOutputBody"];
64767
+ };
64768
+ };
64769
+ /** @description Error */
64770
+ default: {
64771
+ headers: {
64772
+ [name: string]: unknown;
64773
+ };
64774
+ content: {
64775
+ "application/json": components["schemas"]["Error"];
64776
+ };
64777
+ };
64778
+ };
64779
+ };
64780
+ "delete-app-icon": {
64781
+ parameters: {
64782
+ query?: never;
64783
+ header?: never;
64784
+ path?: never;
64785
+ cookie?: never;
64786
+ };
64787
+ requestBody?: never;
64788
+ responses: {
64789
+ /** @description OK */
64790
+ 200: {
64791
+ headers: {
64792
+ [name: string]: unknown;
64793
+ };
64794
+ content: {
64795
+ "application/json": components["schemas"]["AppIconSettingsOutputBody"];
64796
+ };
64797
+ };
64798
+ /** @description Error */
64799
+ default: {
64800
+ headers: {
64801
+ [name: string]: unknown;
64802
+ };
64803
+ content: {
64804
+ "application/json": components["schemas"]["Error"];
64805
+ };
64806
+ };
64807
+ };
64808
+ };
64393
64809
  completeOnboarding: {
64394
64810
  parameters: {
64395
64811
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@parallelworks/client",
3
- "version": "7.112.0",
3
+ "version": "7.113.0",
4
4
  "description": "Official TypeScript client for Parallel Works ACTIVATE API",
5
5
  "type": "module",
6
6
  "exports": {