@sixb/client 0.2.1 → 0.2.5

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 (87) hide show
  1. package/dist/agent-streams.d.ts +1 -1
  2. package/dist/agent-streams.d.ts.map +1 -1
  3. package/dist/artifact-live.d.ts +31 -0
  4. package/dist/artifact-live.d.ts.map +1 -0
  5. package/dist/artifact-live.js +67 -0
  6. package/dist/artifact-live.js.map +10 -0
  7. package/dist/browser.d.ts +5 -0
  8. package/dist/browser.d.ts.map +1 -1
  9. package/dist/browser.js +38 -17
  10. package/dist/browser.js.map +3 -3
  11. package/dist/{chunk-j9t5h44d.js → chunk-15ynvne0.js} +40 -28
  12. package/dist/{chunk-j9t5h44d.js.map → chunk-15ynvne0.js.map} +4 -4
  13. package/dist/{chunk-k2na62sa.js → chunk-60fdvjxa.js} +214 -832
  14. package/dist/chunk-60fdvjxa.js.map +10 -0
  15. package/dist/{chunk-hkn0keqj.js → chunk-br10prhs.js} +4 -4
  16. package/dist/{chunk-hkn0keqj.js.map → chunk-br10prhs.js.map} +1 -1
  17. package/dist/chunk-hj4h6hw6.js +827 -0
  18. package/dist/chunk-hj4h6hw6.js.map +18 -0
  19. package/dist/{chunk-3kfn00we.js → chunk-ktqfenfd.js} +43 -11
  20. package/dist/chunk-ktqfenfd.js.map +10 -0
  21. package/dist/{chunk-r50kxqa5.js → chunk-pn4b10k4.js} +8 -6
  22. package/dist/{chunk-r50kxqa5.js.map → chunk-pn4b10k4.js.map} +2 -2
  23. package/dist/{chunk-rrexv1gk.js → chunk-tm588tr7.js} +6 -6
  24. package/dist/{chunk-rrexv1gk.js.map → chunk-tm588tr7.js.map} +1 -1
  25. package/dist/{chunk-m2rmbshc.js → chunk-y9mhb8x4.js} +3 -1
  26. package/dist/chunk-y9mhb8x4.js.map +10 -0
  27. package/dist/{chunk-0p42gyb5.js → chunk-zta9jf24.js} +30 -21
  28. package/dist/chunk-zta9jf24.js.map +17 -0
  29. package/dist/client-authority.d.ts +11 -0
  30. package/dist/client-authority.d.ts.map +1 -1
  31. package/dist/connectors/connection.d.ts +8 -3
  32. package/dist/connectors/connection.d.ts.map +1 -1
  33. package/dist/connectors/mutations.d.ts +4 -0
  34. package/dist/connectors/mutations.d.ts.map +1 -1
  35. package/dist/connectors/queries.d.ts +98 -0
  36. package/dist/connectors/queries.d.ts.map +1 -1
  37. package/dist/events-builder.d.ts +2 -0
  38. package/dist/events-builder.d.ts.map +1 -1
  39. package/dist/events-provider.d.ts.map +1 -1
  40. package/dist/events-transport.d.ts.map +1 -1
  41. package/dist/file.d.ts +8 -0
  42. package/dist/file.d.ts.map +1 -1
  43. package/dist/generated/@tanstack/react-query.gen.d.ts +3165 -732
  44. package/dist/generated/@tanstack/react-query.gen.d.ts.map +1 -1
  45. package/dist/generated/index.d.ts +2 -2
  46. package/dist/generated/index.d.ts.map +1 -1
  47. package/dist/generated/sdk.gen.d.ts +114 -6
  48. package/dist/generated/sdk.gen.d.ts.map +1 -1
  49. package/dist/generated/types.gen.d.ts +6893 -2935
  50. package/dist/generated/types.gen.d.ts.map +1 -1
  51. package/dist/hooks.js +399 -58
  52. package/dist/hooks.js.map +7 -7
  53. package/dist/index.js +100 -56
  54. package/dist/index.js.map +1 -1
  55. package/dist/logs.js +6 -5
  56. package/dist/logs.js.map +1 -1
  57. package/dist/models.d.ts +5 -2
  58. package/dist/models.d.ts.map +1 -1
  59. package/dist/models.js +49 -7
  60. package/dist/models.js.map +1 -1
  61. package/dist/query.js +6 -5
  62. package/dist/query.js.map +1 -1
  63. package/dist/users-hooks.d.ts.map +1 -1
  64. package/dist/ws-socket.d.ts +17 -2
  65. package/dist/ws-socket.d.ts.map +1 -1
  66. package/package.json +8 -2
  67. package/src/agent-streams.ts +1 -0
  68. package/src/artifact-live.ts +97 -0
  69. package/src/browser.ts +43 -5
  70. package/src/client-authority.ts +21 -0
  71. package/src/connectors/connection.ts +34 -12
  72. package/src/connectors/mutations.ts +8 -2
  73. package/src/connectors/queries.ts +6 -2
  74. package/src/events-builder.ts +9 -8
  75. package/src/events-provider.ts +13 -0
  76. package/src/events-transport.ts +3 -0
  77. package/src/file.ts +17 -0
  78. package/src/generated/@tanstack/react-query.gen.ts +644 -17
  79. package/src/generated/index.ts +125 -6
  80. package/src/generated/sdk.gen.ts +500 -12
  81. package/src/generated/types.gen.ts +8968 -4291
  82. package/src/models.ts +6 -2
  83. package/src/ws-socket.ts +64 -10
  84. package/dist/chunk-0p42gyb5.js.map +0 -17
  85. package/dist/chunk-3kfn00we.js.map +0 -10
  86. package/dist/chunk-k2na62sa.js.map +0 -19
  87. package/dist/chunk-m2rmbshc.js.map +0 -10
@@ -14,6 +14,9 @@ import type {
14
14
  AddAgentThreadParticipantsData,
15
15
  AddAgentThreadParticipantsErrors,
16
16
  AddAgentThreadParticipantsResponses,
17
+ AddArtifactCommentData,
18
+ AddArtifactCommentErrors,
19
+ AddArtifactCommentResponses,
17
20
  AddConnectorConnectionData,
18
21
  AddConnectorConnectionErrors,
19
22
  AddConnectorConnectionResponses,
@@ -80,6 +83,9 @@ import type {
80
83
  DeleteAiLimitPolicyData,
81
84
  DeleteAiLimitPolicyErrors,
82
85
  DeleteAiLimitPolicyResponses,
86
+ DeleteArtifactCommentData,
87
+ DeleteArtifactCommentErrors,
88
+ DeleteArtifactCommentResponses,
83
89
  DeleteArtifactData,
84
90
  DeleteArtifactErrors,
85
91
  DeleteArtifactResponses,
@@ -106,6 +112,9 @@ import type {
106
112
  ForkAgentThreadData,
107
113
  ForkAgentThreadErrors,
108
114
  ForkAgentThreadResponses,
115
+ FreezeArtifactVersionData,
116
+ FreezeArtifactVersionErrors,
117
+ FreezeArtifactVersionResponses,
109
118
  GenerateImagesData,
110
119
  GenerateImagesErrors,
111
120
  GenerateImagesResponses,
@@ -175,15 +184,27 @@ import type {
175
184
  GetAiModelCallFilesData,
176
185
  GetAiModelCallFilesErrors,
177
186
  GetAiModelCallFilesResponses,
187
+ GetArtifactBoardPreviewData,
188
+ GetArtifactBoardPreviewErrors,
189
+ GetArtifactBoardPreviewResponses,
178
190
  GetArtifactData,
179
191
  GetArtifactErrors,
180
192
  GetArtifactFileContentData,
181
193
  GetArtifactFileContentErrors,
182
194
  GetArtifactFileContentResponses,
195
+ GetArtifactPdfData,
196
+ GetArtifactPdfErrors,
197
+ GetArtifactPdfResponses,
183
198
  GetArtifactQueryData,
184
199
  GetArtifactQueryErrors,
185
200
  GetArtifactQueryResponses,
186
201
  GetArtifactResponses,
202
+ GetArtifactRestorePointData,
203
+ GetArtifactRestorePointErrors,
204
+ GetArtifactRestorePointFileContentData,
205
+ GetArtifactRestorePointFileContentErrors,
206
+ GetArtifactRestorePointFileContentResponses,
207
+ GetArtifactRestorePointResponses,
187
208
  GetArtifactStateData,
188
209
  GetArtifactStateErrors,
189
210
  GetArtifactStateResponses,
@@ -222,6 +243,9 @@ import type {
222
243
  GetDatasetVersionLineageErrors,
223
244
  GetDatasetVersionLineageResponses,
224
245
  GetDatasetVersionResponses,
246
+ GetLakeHealthData,
247
+ GetLakeHealthErrors,
248
+ GetLakeHealthResponses,
225
249
  GetLatestTelemetryData,
226
250
  GetLatestTelemetryErrors,
227
251
  GetLatestTelemetryResponses,
@@ -348,6 +372,9 @@ import type {
348
372
  ListAgentApprovalsData,
349
373
  ListAgentApprovalsErrors,
350
374
  ListAgentApprovalsResponses,
375
+ ListAgentComputersData,
376
+ ListAgentComputersErrors,
377
+ ListAgentComputersResponses,
351
378
  ListAgentMemoryRevisionsData,
352
379
  ListAgentMemoryRevisionsErrors,
353
380
  ListAgentMemoryRevisionsResponses,
@@ -357,6 +384,9 @@ import type {
357
384
  ListAgentThreadChildrenData,
358
385
  ListAgentThreadChildrenErrors,
359
386
  ListAgentThreadChildrenResponses,
387
+ ListAgentThreadInboxData,
388
+ ListAgentThreadInboxErrors,
389
+ ListAgentThreadInboxResponses,
360
390
  ListAgentThreadMessagesData,
361
391
  ListAgentThreadMessagesErrors,
362
392
  ListAgentThreadMessagesResponses,
@@ -375,6 +405,15 @@ import type {
375
405
  ListAiModelCallsData,
376
406
  ListAiModelCallsErrors,
377
407
  ListAiModelCallsResponses,
408
+ ListArtifactCommentsData,
409
+ ListArtifactCommentsErrors,
410
+ ListArtifactCommentsResponses,
411
+ ListArtifactHoldersData,
412
+ ListArtifactHoldersErrors,
413
+ ListArtifactHoldersResponses,
414
+ ListArtifactRestorePointsData,
415
+ ListArtifactRestorePointsErrors,
416
+ ListArtifactRestorePointsResponses,
378
417
  ListArtifactsData,
379
418
  ListArtifactsErrors,
380
419
  ListArtifactsResponses,
@@ -481,9 +520,9 @@ import type {
481
520
  PostAgentThreadMessageData,
482
521
  PostAgentThreadMessageErrors,
483
522
  PostAgentThreadMessageResponses,
484
- PublishArtifactVersionData,
485
- PublishArtifactVersionErrors,
486
- PublishArtifactVersionResponses,
523
+ PrintArtifactPdfData,
524
+ PrintArtifactPdfErrors,
525
+ PrintArtifactPdfResponses,
487
526
  QueryObjectLinksData,
488
527
  QueryObjectLinksErrors,
489
528
  QueryObjectLinksResponses,
@@ -520,6 +559,15 @@ import type {
520
559
  RequestWorkflowRunData,
521
560
  RequestWorkflowRunErrors,
522
561
  RequestWorkflowRunResponses,
562
+ ResolveArtifactCommentData,
563
+ ResolveArtifactCommentErrors,
564
+ ResolveArtifactCommentResponses,
565
+ RestoreAgentThreadSandboxData,
566
+ RestoreAgentThreadSandboxErrors,
567
+ RestoreAgentThreadSandboxResponses,
568
+ RestoreArtifactData,
569
+ RestoreArtifactErrors,
570
+ RestoreArtifactResponses,
523
571
  RetryAgentRunData,
524
572
  RetryAgentRunErrors,
525
573
  RetryAgentRunResponses,
@@ -556,6 +604,9 @@ import type {
556
604
  SetArtifactStateData,
557
605
  SetArtifactStateErrors,
558
606
  SetArtifactStateResponses,
607
+ SetSharedAccessGuestNameData,
608
+ SetSharedAccessGuestNameErrors,
609
+ SetSharedAccessGuestNameResponses,
559
610
  SignFileUploadPartData,
560
611
  SignFileUploadPartErrors,
561
612
  SignFileUploadPartResponses,
@@ -586,9 +637,15 @@ import type {
586
637
  UpdateAgentPreferencesData,
587
638
  UpdateAgentPreferencesErrors,
588
639
  UpdateAgentPreferencesResponses,
640
+ UpdateAgentThreadInboxItemData,
641
+ UpdateAgentThreadInboxItemErrors,
642
+ UpdateAgentThreadInboxItemResponses,
589
643
  UpdateAiLimitPolicyData,
590
644
  UpdateAiLimitPolicyErrors,
591
645
  UpdateAiLimitPolicyResponses,
646
+ UpdateArtifactData,
647
+ UpdateArtifactErrors,
648
+ UpdateArtifactResponses,
592
649
  UpdateAuthMemberGroupsData,
593
650
  UpdateAuthMemberGroupsErrors,
594
651
  UpdateAuthMemberGroupsResponses,
@@ -601,6 +658,9 @@ import type {
601
658
  UploadFileRawData,
602
659
  UploadFileRawErrors,
603
660
  UploadFileRawResponses,
661
+ WithdrawAgentThreadInboxItemData,
662
+ WithdrawAgentThreadInboxItemErrors,
663
+ WithdrawAgentThreadInboxItemResponses,
604
664
  } from "./types.gen"
605
665
 
606
666
  export type Options<
@@ -1793,6 +1853,21 @@ export const listDatasetRows = <ThrowOnError extends boolean = false>(
1793
1853
  ...options,
1794
1854
  })
1795
1855
 
1856
+ /**
1857
+ * Describe how the lake stores each dataset, and what its retention does
1858
+ */
1859
+ export const getLakeHealth = <ThrowOnError extends boolean = false>(
1860
+ options?: Options<GetLakeHealthData, ThrowOnError>
1861
+ ) =>
1862
+ (options?.client ?? client).get<GetLakeHealthResponses, GetLakeHealthErrors, ThrowOnError>({
1863
+ security: [
1864
+ { scheme: "bearer", type: "http" },
1865
+ { scheme: "bearer", type: "http" },
1866
+ ],
1867
+ url: "/api/lake/health",
1868
+ ...options,
1869
+ })
1870
+
1796
1871
  /**
1797
1872
  * List registered syncs
1798
1873
  */
@@ -2347,6 +2422,28 @@ export const getSharedAccessSession = <ThrowOnError extends boolean = false>(
2347
2422
  ThrowOnError
2348
2423
  >({ url: "/api/shared-access/{grantId}/session", ...options })
2349
2424
 
2425
+ /**
2426
+ * Name a shared-access session's visitor
2427
+ *
2428
+ * The visitor of a shared link has no account: they give their name once, and their comments and live presence carry it, marked as a guest's. Giving it again replaces it for what comes next; comments keep the name they were written under.
2429
+ */
2430
+ export const setSharedAccessGuestName = <ThrowOnError extends boolean = false>(
2431
+ options: Options<SetSharedAccessGuestNameData, ThrowOnError>
2432
+ ) =>
2433
+ (options.client ?? client).put<
2434
+ SetSharedAccessGuestNameResponses,
2435
+ SetSharedAccessGuestNameErrors,
2436
+ ThrowOnError
2437
+ >({
2438
+ security: [{ name: "x-sixb-csrf", type: "apiKey" }],
2439
+ url: "/api/shared-access/{grantId}/name",
2440
+ ...options,
2441
+ headers: {
2442
+ "Content-Type": "application/json",
2443
+ ...options.headers,
2444
+ },
2445
+ })
2446
+
2350
2447
  /**
2351
2448
  * Sign out a shared-access session
2352
2449
  */
@@ -3018,6 +3115,29 @@ export const recreateAgentThreadSandbox = <ThrowOnError extends boolean = false>
3018
3115
  },
3019
3116
  })
3020
3117
 
3118
+ /**
3119
+ * Explicitly go on in the workspace a failed save left, with its files as they were
3120
+ */
3121
+ export const restoreAgentThreadSandbox = <ThrowOnError extends boolean = false>(
3122
+ options: Options<RestoreAgentThreadSandboxData, ThrowOnError>
3123
+ ) =>
3124
+ (options.client ?? client).post<
3125
+ RestoreAgentThreadSandboxResponses,
3126
+ RestoreAgentThreadSandboxErrors,
3127
+ ThrowOnError
3128
+ >({
3129
+ security: [
3130
+ { name: "x-sixb-csrf", type: "apiKey" },
3131
+ { scheme: "bearer", type: "http" },
3132
+ ],
3133
+ url: "/api/agent-threads/{threadId}/sandbox/restore",
3134
+ ...options,
3135
+ headers: {
3136
+ "Content-Type": "application/json",
3137
+ ...options.headers,
3138
+ },
3139
+ })
3140
+
3021
3141
  /**
3022
3142
  * List agent thread messages
3023
3143
  */
@@ -3098,6 +3218,67 @@ export const headAgentMessageFileContent = <ThrowOnError extends boolean = false
3098
3218
  ...options,
3099
3219
  })
3100
3220
 
3221
+ /**
3222
+ * List agent thread inbox messages
3223
+ */
3224
+ export const listAgentThreadInbox = <ThrowOnError extends boolean = false>(
3225
+ options: Options<ListAgentThreadInboxData, ThrowOnError>
3226
+ ) =>
3227
+ (options.client ?? client).get<
3228
+ ListAgentThreadInboxResponses,
3229
+ ListAgentThreadInboxErrors,
3230
+ ThrowOnError
3231
+ >({
3232
+ security: [
3233
+ { scheme: "bearer", type: "http" },
3234
+ { scheme: "bearer", type: "http" },
3235
+ ],
3236
+ url: "/api/agent-threads/{threadId}/inbox",
3237
+ ...options,
3238
+ })
3239
+
3240
+ /**
3241
+ * Withdraw a waiting agent thread message
3242
+ */
3243
+ export const withdrawAgentThreadInboxItem = <ThrowOnError extends boolean = false>(
3244
+ options: Options<WithdrawAgentThreadInboxItemData, ThrowOnError>
3245
+ ) =>
3246
+ (options.client ?? client).delete<
3247
+ WithdrawAgentThreadInboxItemResponses,
3248
+ WithdrawAgentThreadInboxItemErrors,
3249
+ ThrowOnError
3250
+ >({
3251
+ security: [
3252
+ { name: "x-sixb-csrf", type: "apiKey" },
3253
+ { scheme: "bearer", type: "http" },
3254
+ ],
3255
+ url: "/api/agent-threads/{threadId}/inbox/{itemId}",
3256
+ ...options,
3257
+ })
3258
+
3259
+ /**
3260
+ * Update a waiting agent thread message
3261
+ */
3262
+ export const updateAgentThreadInboxItem = <ThrowOnError extends boolean = false>(
3263
+ options: Options<UpdateAgentThreadInboxItemData, ThrowOnError>
3264
+ ) =>
3265
+ (options.client ?? client).patch<
3266
+ UpdateAgentThreadInboxItemResponses,
3267
+ UpdateAgentThreadInboxItemErrors,
3268
+ ThrowOnError
3269
+ >({
3270
+ security: [
3271
+ { name: "x-sixb-csrf", type: "apiKey" },
3272
+ { scheme: "bearer", type: "http" },
3273
+ ],
3274
+ url: "/api/agent-threads/{threadId}/inbox/{itemId}",
3275
+ ...options,
3276
+ headers: {
3277
+ "Content-Type": "application/json",
3278
+ ...options.headers,
3279
+ },
3280
+ })
3281
+
3101
3282
  /**
3102
3283
  * Cancel an agent thread's active run
3103
3284
  *
@@ -3263,6 +3444,24 @@ export const headAgentChildFileContent = <ThrowOnError extends boolean = false>(
3263
3444
  ...options,
3264
3445
  })
3265
3446
 
3447
+ /**
3448
+ * List your computers with sixb open now
3449
+ *
3450
+ * Each of your computers with a live session, and the folders `sixb` is open in there: a thread created to run in one of them runs there now.
3451
+ */
3452
+ export const listAgentComputers = <ThrowOnError extends boolean = false>(
3453
+ options?: Options<ListAgentComputersData, ThrowOnError>
3454
+ ) =>
3455
+ (options?.client ?? client).get<
3456
+ ListAgentComputersResponses,
3457
+ ListAgentComputersErrors,
3458
+ ThrowOnError
3459
+ >({
3460
+ security: [{ scheme: "bearer", type: "http" }],
3461
+ url: "/api/agent-computers",
3462
+ ...options,
3463
+ })
3464
+
3266
3465
  /**
3267
3466
  * Move a thread from your computer to the cloud
3268
3467
  *
@@ -3764,11 +3963,34 @@ export const getArtifact = <ThrowOnError extends boolean = false>(
3764
3963
  security: [
3765
3964
  { scheme: "bearer", type: "http" },
3766
3965
  { scheme: "bearer", type: "http" },
3966
+ { name: "x-sixb-share-grant", type: "apiKey" },
3767
3967
  ],
3768
3968
  url: "/api/artifacts/{artifactId}",
3769
3969
  ...options,
3770
3970
  })
3771
3971
 
3972
+ /**
3973
+ * List the objects that hold an artifact
3974
+ *
3975
+ * The objects whose property holds the artifact, among those you read with that property, in a stable order. Whoever reads such an object reads the artifact.
3976
+ */
3977
+ export const listArtifactHolders = <ThrowOnError extends boolean = false>(
3978
+ options: Options<ListArtifactHoldersData, ThrowOnError>
3979
+ ) =>
3980
+ (options.client ?? client).get<
3981
+ ListArtifactHoldersResponses,
3982
+ ListArtifactHoldersErrors,
3983
+ ThrowOnError
3984
+ >({
3985
+ security: [
3986
+ { scheme: "bearer", type: "http" },
3987
+ { scheme: "bearer", type: "http" },
3988
+ { name: "x-sixb-share-grant", type: "apiKey" },
3989
+ ],
3990
+ url: "/api/artifacts/{artifactId}/holders",
3991
+ ...options,
3992
+ })
3993
+
3772
3994
  /**
3773
3995
  * Reset what a page keeps
3774
3996
  *
@@ -3851,16 +4073,38 @@ export const setArtifactState = <ThrowOnError extends boolean = false>(
3851
4073
  })
3852
4074
 
3853
4075
  /**
3854
- * Publish an artifact's next version
4076
+ * Update an artifact
3855
4077
  *
3856
- * The kind must be the artifact's. The new version becomes the latest. With baseVersion, it is refused with 409 artifact_moved when another version was published since. With a run token, only an artifact the run's conversation shares or its requester owns; the version is shared in that conversation. A run that lost its execution gets 409 execution_lost.
4078
+ * Writes the artifact's latest version: its content is replaced while the version is open, and the next version opens when it is frozen. Either way the revision grows. The kind must be the artifact's. With baseRevision, it is refused with 409 artifact_moved when the artifact changed since. With a run token, only an artifact the run's conversation shares, its requester owns, or an object its requester edits holds; it is shared in that conversation, and the turn's first write to it keeps a restore point. A run that lost its execution gets 409 execution_lost.
3857
4079
  */
3858
- export const publishArtifactVersion = <ThrowOnError extends boolean = false>(
3859
- options: Options<PublishArtifactVersionData, ThrowOnError>
4080
+ export const updateArtifact = <ThrowOnError extends boolean = false>(
4081
+ options: Options<UpdateArtifactData, ThrowOnError>
4082
+ ) =>
4083
+ (options.client ?? client).put<UpdateArtifactResponses, UpdateArtifactErrors, ThrowOnError>({
4084
+ security: [
4085
+ { name: "x-sixb-csrf", type: "apiKey" },
4086
+ { scheme: "bearer", type: "http" },
4087
+ { scheme: "bearer", type: "http" },
4088
+ ],
4089
+ url: "/api/artifacts/{artifactId}/content",
4090
+ ...options,
4091
+ headers: {
4092
+ "Content-Type": "application/json",
4093
+ ...options.headers,
4094
+ },
4095
+ })
4096
+
4097
+ /**
4098
+ * Create a version
4099
+ *
4100
+ * Freezes the artifact's open latest version: it never changes again, and the next write opens the next version. A latest version already frozen is returned as it is. Whoever may update the artifact may create a version. With baseRevision, it is refused with 409 artifact_moved when the open version changed since.
4101
+ */
4102
+ export const freezeArtifactVersion = <ThrowOnError extends boolean = false>(
4103
+ options: Options<FreezeArtifactVersionData, ThrowOnError>
3860
4104
  ) =>
3861
4105
  (options.client ?? client).post<
3862
- PublishArtifactVersionResponses,
3863
- PublishArtifactVersionErrors,
4106
+ FreezeArtifactVersionResponses,
4107
+ FreezeArtifactVersionErrors,
3864
4108
  ThrowOnError
3865
4109
  >({
3866
4110
  security: [
@@ -3868,7 +4112,187 @@ export const publishArtifactVersion = <ThrowOnError extends boolean = false>(
3868
4112
  { scheme: "bearer", type: "http" },
3869
4113
  { scheme: "bearer", type: "http" },
3870
4114
  ],
3871
- url: "/api/artifacts/{artifactId}/versions",
4115
+ url: "/api/artifacts/{artifactId}/freeze",
4116
+ ...options,
4117
+ headers: {
4118
+ "Content-Type": "application/json",
4119
+ ...options.headers,
4120
+ },
4121
+ })
4122
+
4123
+ /**
4124
+ * List an artifact's comments
4125
+ *
4126
+ * Every comment and reply, oldest first, resolved ones included. Whoever reads the artifact reads them; a shared link's guest reads only the threads started by a guest of the same link, with every reply in them.
4127
+ */
4128
+ export const listArtifactComments = <ThrowOnError extends boolean = false>(
4129
+ options: Options<ListArtifactCommentsData, ThrowOnError>
4130
+ ) =>
4131
+ (options.client ?? client).get<
4132
+ ListArtifactCommentsResponses,
4133
+ ListArtifactCommentsErrors,
4134
+ ThrowOnError
4135
+ >({
4136
+ security: [
4137
+ { scheme: "bearer", type: "http" },
4138
+ { scheme: "bearer", type: "http" },
4139
+ { name: "x-sixb-share-grant", type: "apiKey" },
4140
+ ],
4141
+ url: "/api/artifacts/{artifactId}/comments",
4142
+ ...options,
4143
+ })
4144
+
4145
+ /**
4146
+ * Comment on an artifact
4147
+ *
4148
+ * Adds a comment, or a reply with parentId, as the caller. Whoever reads the artifact may, a shared link's guest included, under the name they gave its session (400 name_required until they give one), and replies only in a thread they read (404 comment_not_found otherwise). A canvas's comment can be about one of its boards, or an element of a board by its address. Readers of the thread receive artifact.commented.
4149
+ */
4150
+ export const addArtifactComment = <ThrowOnError extends boolean = false>(
4151
+ options: Options<AddArtifactCommentData, ThrowOnError>
4152
+ ) =>
4153
+ (options.client ?? client).post<
4154
+ AddArtifactCommentResponses,
4155
+ AddArtifactCommentErrors,
4156
+ ThrowOnError
4157
+ >({
4158
+ security: [
4159
+ { name: "x-sixb-csrf", type: "apiKey" },
4160
+ { scheme: "bearer", type: "http" },
4161
+ { scheme: "bearer", type: "http" },
4162
+ { name: "x-sixb-share-grant", type: "apiKey" },
4163
+ ],
4164
+ url: "/api/artifacts/{artifactId}/comments",
4165
+ ...options,
4166
+ headers: {
4167
+ "Content-Type": "application/json",
4168
+ ...options.headers,
4169
+ },
4170
+ })
4171
+
4172
+ /**
4173
+ * Resolve an artifact's comment
4174
+ *
4175
+ * Marks the comment resolved, or, with resolved false, opens it again. Its author, or whoever may update the artifact, may; anyone else is refused with 403 not_allowed. A guest's comment is resolved only by whoever may update the artifact.
4176
+ */
4177
+ export const resolveArtifactComment = <ThrowOnError extends boolean = false>(
4178
+ options: Options<ResolveArtifactCommentData, ThrowOnError>
4179
+ ) =>
4180
+ (options.client ?? client).post<
4181
+ ResolveArtifactCommentResponses,
4182
+ ResolveArtifactCommentErrors,
4183
+ ThrowOnError
4184
+ >({
4185
+ security: [
4186
+ { name: "x-sixb-csrf", type: "apiKey" },
4187
+ { scheme: "bearer", type: "http" },
4188
+ { scheme: "bearer", type: "http" },
4189
+ ],
4190
+ url: "/api/artifacts/{artifactId}/comments/{commentId}/resolve",
4191
+ ...options,
4192
+ headers: {
4193
+ "Content-Type": "application/json",
4194
+ ...options.headers,
4195
+ },
4196
+ })
4197
+
4198
+ /**
4199
+ * Delete an artifact's comment
4200
+ *
4201
+ * Deletes the comment and its replies. Its author, or whoever may update the artifact, may.
4202
+ */
4203
+ export const deleteArtifactComment = <ThrowOnError extends boolean = false>(
4204
+ options: Options<DeleteArtifactCommentData, ThrowOnError>
4205
+ ) =>
4206
+ (options.client ?? client).delete<
4207
+ DeleteArtifactCommentResponses,
4208
+ DeleteArtifactCommentErrors,
4209
+ ThrowOnError
4210
+ >({
4211
+ security: [
4212
+ { name: "x-sixb-csrf", type: "apiKey" },
4213
+ { scheme: "bearer", type: "http" },
4214
+ { scheme: "bearer", type: "http" },
4215
+ ],
4216
+ url: "/api/artifacts/{artifactId}/comments/{commentId}",
4217
+ ...options,
4218
+ })
4219
+
4220
+ /**
4221
+ * List an artifact's restore points
4222
+ *
4223
+ * What the artifact's latest version held before each Agent turn's first write to it, and before each restore, newest first. They are not versions: restoring one puts its content back in the latest version.
4224
+ */
4225
+ export const listArtifactRestorePoints = <ThrowOnError extends boolean = false>(
4226
+ options: Options<ListArtifactRestorePointsData, ThrowOnError>
4227
+ ) =>
4228
+ (options.client ?? client).get<
4229
+ ListArtifactRestorePointsResponses,
4230
+ ListArtifactRestorePointsErrors,
4231
+ ThrowOnError
4232
+ >({
4233
+ security: [
4234
+ { scheme: "bearer", type: "http" },
4235
+ { scheme: "bearer", type: "http" },
4236
+ ],
4237
+ url: "/api/artifacts/{artifactId}/restore-points",
4238
+ ...options,
4239
+ })
4240
+
4241
+ /**
4242
+ * Get an artifact's restore point
4243
+ *
4244
+ * Its files, outline, and references, as the latest version held them. Read a file's bytes with GET /api/artifacts/{artifactId}/restore-points/{revision}/content.
4245
+ */
4246
+ export const getArtifactRestorePoint = <ThrowOnError extends boolean = false>(
4247
+ options: Options<GetArtifactRestorePointData, ThrowOnError>
4248
+ ) =>
4249
+ (options.client ?? client).get<
4250
+ GetArtifactRestorePointResponses,
4251
+ GetArtifactRestorePointErrors,
4252
+ ThrowOnError
4253
+ >({
4254
+ security: [
4255
+ { scheme: "bearer", type: "http" },
4256
+ { scheme: "bearer", type: "http" },
4257
+ ],
4258
+ url: "/api/artifacts/{artifactId}/restore-points/{revision}",
4259
+ ...options,
4260
+ })
4261
+
4262
+ /**
4263
+ * Get a file of an artifact's restore point
4264
+ */
4265
+ export const getArtifactRestorePointFileContent = <ThrowOnError extends boolean = false>(
4266
+ options: Options<GetArtifactRestorePointFileContentData, ThrowOnError>
4267
+ ) =>
4268
+ (options.client ?? client).get<
4269
+ GetArtifactRestorePointFileContentResponses,
4270
+ GetArtifactRestorePointFileContentErrors,
4271
+ ThrowOnError
4272
+ >({
4273
+ security: [
4274
+ { scheme: "bearer", type: "http" },
4275
+ { scheme: "bearer", type: "http" },
4276
+ ],
4277
+ url: "/api/artifacts/{artifactId}/restore-points/{revision}/content",
4278
+ ...options,
4279
+ })
4280
+
4281
+ /**
4282
+ * Restore an artifact
4283
+ *
4284
+ * Puts a restore point's content back in the latest version, as an update writes it: in place while it is open, as the next version when it is frozen. What it replaces becomes a restore point, so the restore can be undone. Whoever may update the artifact may restore it. With baseRevision, it is refused with 409 artifact_moved when the artifact changed since.
4285
+ */
4286
+ export const restoreArtifact = <ThrowOnError extends boolean = false>(
4287
+ options: Options<RestoreArtifactData, ThrowOnError>
4288
+ ) =>
4289
+ (options.client ?? client).post<RestoreArtifactResponses, RestoreArtifactErrors, ThrowOnError>({
4290
+ security: [
4291
+ { name: "x-sixb-csrf", type: "apiKey" },
4292
+ { scheme: "bearer", type: "http" },
4293
+ { scheme: "bearer", type: "http" },
4294
+ ],
4295
+ url: "/api/artifacts/{artifactId}/restore-points/{revision}/restore",
3872
4296
  ...options,
3873
4297
  headers: {
3874
4298
  "Content-Type": "application/json",
@@ -3879,7 +4303,7 @@ export const publishArtifactVersion = <ThrowOnError extends boolean = false>(
3879
4303
  /**
3880
4304
  * Open a version in a frame
3881
4305
  *
3882
- * A short-lived path that serves the files of a version that opens in a sandboxed frame, as slides do. It expires within an hour. A kind that does not open in a frame is refused with 409 artifact_kind_mismatch.
4306
+ * A short-lived path that serves the files of a version that opens in a sandboxed frame, as slides do, at the revision it has now: once the version is written again, the path serves nothing and a new one is needed. It expires within an hour. A kind that does not open in a frame is refused with 409 artifact_kind_mismatch.
3883
4307
  */
3884
4308
  export const createArtifactFrame = <ThrowOnError extends boolean = false>(
3885
4309
  options: Options<CreateArtifactFrameData, ThrowOnError>
@@ -3893,6 +4317,7 @@ export const createArtifactFrame = <ThrowOnError extends boolean = false>(
3893
4317
  { name: "x-sixb-csrf", type: "apiKey" },
3894
4318
  { scheme: "bearer", type: "http" },
3895
4319
  { scheme: "bearer", type: "http" },
4320
+ { name: "x-sixb-share-grant", type: "apiKey" },
3896
4321
  ],
3897
4322
  url: "/api/artifacts/{artifactId}/versions/{version}/frame",
3898
4323
  ...options,
@@ -3914,15 +4339,75 @@ export const getArtifactVersion = <ThrowOnError extends boolean = false>(
3914
4339
  security: [
3915
4340
  { scheme: "bearer", type: "http" },
3916
4341
  { scheme: "bearer", type: "http" },
4342
+ { name: "x-sixb-share-grant", type: "apiKey" },
3917
4343
  ],
3918
4344
  url: "/api/artifacts/{artifactId}/versions/{version}",
3919
4345
  ...options,
3920
4346
  })
3921
4347
 
4348
+ /**
4349
+ * Get a designed document's PDF
4350
+ *
4351
+ * The version printed to PDF, with the values its fields read as the caller reads them, as a download named after the title it printed with: for a document that shows live data, those its POST's key names. 404 pdf_not_found until it is printed: ask for it with POST first. A frozen version's PDF never changes, and is cached as such.
4352
+ */
4353
+ export const getArtifactPdf = <ThrowOnError extends boolean = false>(
4354
+ options: Options<GetArtifactPdfData, ThrowOnError>
4355
+ ) =>
4356
+ (options.client ?? client).get<GetArtifactPdfResponses, GetArtifactPdfErrors, ThrowOnError>({
4357
+ security: [
4358
+ { scheme: "bearer", type: "http" },
4359
+ { scheme: "bearer", type: "http" },
4360
+ { name: "x-sixb-share-grant", type: "apiKey" },
4361
+ ],
4362
+ url: "/api/artifacts/{artifactId}/versions/{version}/pdf",
4363
+ ...options,
4364
+ })
4365
+
4366
+ /**
4367
+ * Print a designed document to PDF
4368
+ *
4369
+ * Answers ready once the version is printed, and printing until then, having asked for it: ask again after a few seconds, then get it. Failed with why when it could not be printed; retry=true asks again. A document that shows live data answers with a key: ask again and get it with that key, which names the values the first ask printed. It prints as its stylesheets' @page rule lays it out, in a sandbox of the project. Whoever reads the artifact may ask. 400 invalid_artifact when the version is not a designed document; 501 pdf_unavailable in a project without sandboxes.
4370
+ */
4371
+ export const printArtifactPdf = <ThrowOnError extends boolean = false>(
4372
+ options: Options<PrintArtifactPdfData, ThrowOnError>
4373
+ ) =>
4374
+ (options.client ?? client).post<PrintArtifactPdfResponses, PrintArtifactPdfErrors, ThrowOnError>({
4375
+ security: [
4376
+ { name: "x-sixb-csrf", type: "apiKey" },
4377
+ { scheme: "bearer", type: "http" },
4378
+ { scheme: "bearer", type: "http" },
4379
+ { name: "x-sixb-share-grant", type: "apiKey" },
4380
+ ],
4381
+ url: "/api/artifacts/{artifactId}/versions/{version}/pdf",
4382
+ ...options,
4383
+ })
4384
+
4385
+ /**
4386
+ * Get the preview of a canvas's board
4387
+ *
4388
+ * A picture of the board as its version shows it, in the reader's mode: a PNG at its own size, or with size=small a WebP at most 480 pixels wide, which a viewer shows until the board is opened. It shows the data the version's author can see. A frozen version's preview never changes, and is cached as such, as is one asked for at a revision; an open version's otherwise, and "latest", are revalidated. 404 preview_not_found until it is rendered, when it never will be, or when revision is not the version's current one: the version says which.
4389
+ */
4390
+ export const getArtifactBoardPreview = <ThrowOnError extends boolean = false>(
4391
+ options: Options<GetArtifactBoardPreviewData, ThrowOnError>
4392
+ ) =>
4393
+ (options.client ?? client).get<
4394
+ GetArtifactBoardPreviewResponses,
4395
+ GetArtifactBoardPreviewErrors,
4396
+ ThrowOnError
4397
+ >({
4398
+ security: [
4399
+ { scheme: "bearer", type: "http" },
4400
+ { scheme: "bearer", type: "http" },
4401
+ { name: "x-sixb-share-grant", type: "apiKey" },
4402
+ ],
4403
+ url: "/api/artifacts/{artifactId}/versions/{version}/boards/{board}/preview",
4404
+ ...options,
4405
+ })
4406
+
3922
4407
  /**
3923
4408
  * Run an artifact's query
3924
4409
  *
3925
- * Runs the version's queries/<name>.json as the caller, with their rights: a type they cannot view is refused with 403, and a marked property they are not cleared for is left out of each row. Rows are serialized as POST /api/objects/query returns them, beside the schema of what they hold as the caller may view it. Use "latest" for the newest version. A query the ontology no longer admits is refused with 409 query_invalid.
4410
+ * Runs the version's queries/<name>.json as the caller, with their rights: a type they cannot view is refused with 403, and a marked property they are not cleared for is left out of each row. Rows are serialized as POST /api/objects/query returns them, beside the schema of what they hold as the caller may view it. Use "latest" for the newest version. A query the ontology no longer admits is refused with 409 query_invalid. A designed document's "holder" is the object that holds it, of the type it names, with the links its fields read through: 404 holder_not_found when no one such object the caller reads holds it.
3926
4411
  */
3927
4412
  export const getArtifactQuery = <ThrowOnError extends boolean = false>(
3928
4413
  options: Options<GetArtifactQueryData, ThrowOnError>
@@ -3931,6 +4416,7 @@ export const getArtifactQuery = <ThrowOnError extends boolean = false>(
3931
4416
  security: [
3932
4417
  { scheme: "bearer", type: "http" },
3933
4418
  { scheme: "bearer", type: "http" },
4419
+ { name: "x-sixb-share-grant", type: "apiKey" },
3934
4420
  ],
3935
4421
  url: "/api/artifacts/{artifactId}/versions/{version}/queries/{name}",
3936
4422
  ...options,
@@ -3950,6 +4436,7 @@ export const getArtifactFileContent = <ThrowOnError extends boolean = false>(
3950
4436
  security: [
3951
4437
  { scheme: "bearer", type: "http" },
3952
4438
  { scheme: "bearer", type: "http" },
4439
+ { name: "x-sixb-share-grant", type: "apiKey" },
3953
4440
  ],
3954
4441
  url: "/api/artifacts/{artifactId}/versions/{version}/content",
3955
4442
  ...options,
@@ -3969,6 +4456,7 @@ export const headArtifactFileContent = <ThrowOnError extends boolean = false>(
3969
4456
  security: [
3970
4457
  { scheme: "bearer", type: "http" },
3971
4458
  { scheme: "bearer", type: "http" },
4459
+ { name: "x-sixb-share-grant", type: "apiKey" },
3972
4460
  ],
3973
4461
  url: "/api/artifacts/{artifactId}/versions/{version}/content",
3974
4462
  ...options,